This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Configuration

Configuration file syntax for Rebex Tiny SFTP Server.

Configuration file

Configuration is stored in appSettings section of RebexTinySftpServer.exe.config XML file. All configuration keys are case-sensitive. The file must be in the same folder as the Tiny SFTP Server application.

See details of configuration file format

Sample configuration file:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <appSettings>
    <!-- user credentials and root directory -->
    <add key="userName" value="tester" />
    <add key="userPassword" value="password" />
    <add key="userRootDir" value="data" />
    <!-- port -->
    <add key="sshPort" value="22" />
    <!-- server host keys -->
    <add key="rsaPrivateKeyFile" value="server-private-key-rsa.ppk" />
    <add key="rsaPrivateKeyPassword" value="my-super-secure-password" />
    <add key="dssPrivateKeyFile" value="server-private-key-dss.ppk" />
    <add key="dssPrivateKeyPassword" value="my-super-secure-password" />
  </appSettings>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0" />
  </startup>
</configuration>

All configuration settings

sshPort

Default value: 22

TCP port on which the server runs.

userName

Login name of the SFTP user.

See also:

userPassword

Password of the SFTP user.

userPublicKeyDir

Path to folder with user public keys used for private/public key authentication. Raw or Base-64-encoded SSH2 key format supported. Optional. Leave blank to disable key authentication.

See also:

userRootDir

Root data folder. If the folder does not exist, the server creates it and puts some test data there.

showUserDetailsOnStartup

Default value: ???

If set to true, user name and password are displayed in the application. Set it to false to prevent this.

rsaPrivateKeyFile

Path to the server RSA private key file. PKCS #8, OpenSSH/OpenSSL SSLeay and PuTTY formats are supported. A new key file is generated if it does not exist.

rsaPrivateKeyPassword

Password for the server RSA private key file.

dssPrivateKeyFile

Path to the server DSA private key file. PKCS #8, OpenSSH/OpenSSL SSLeay and PuTTY formats are supported. A new key file is generated if it does not exist.

dssPrivateKeyPassword

Password for the server DSA private key file.

autoStart

Default value: false

If set to true, the server starts when application is started. No need to press the button.

Configuration file format

The file uses standard format of .net application XML configuration. Technical details can be found at Microsoft website in Configure apps by using configuration files and <appSettings> element for <configuration>.

1 - User authentication

Password authentication

Login using username and password.

Warning: The password is stored in clear-text file. The username and password is also displayed in the server main form.

Configuration values:

Key authentication

Login using private and public keys. Both RSA and DSA keys are supported. Private key is stored on client computer. Public key is stored in Tiny SFTP server machine.

Public/private key pair can be generated using PuttyGen (part of Putty SSH Client) or ssh-keygen (part of OpenSSH client). See How to generate SSH Key in Windows 10 for details.

Supported public/private key formats:

  • Raw SSH2
  • Base-64-encoded SSH2

Configuration values:

Tiny Server limitations

Tiny SFTP server is very simple and primarily intended for testing. This is why it’s user management and authentication features are also quite limited. Following list includes example of features that are out-of-scope of the Tiny server:

  • Multiple users
  • Windows authentication
  • User impersonation
  • Single sign-on
  • Per-user access rights
  • Secure password storage (Tiny Server stores the password in clear text file).

To overcome those limits a full-featured SFTP server is needed. One example is a Buru SFTP Server, which is build on the same foundation as Tiny SFTP Server.

See Tiny SFTP and Buru SFTP comparison.