The default value for this configuration setting is 1, which means that the component will return one entry at a time in response to a request for a directory listing. Changing this value will allow the component to bundle multiple entries into a single response.

The default value is false. When set to true the component will mask passwords that would otherwise appear in its logs.

This governs the highest allowable SFTP version to use when negotiating the version with the client. The default value is 3 as this is the most common version. The component supports values from 3 to 6.

When set to True (default), this configuration setting will allow the component to determine the user name from the Unix-like user identifier, and the group name from the Unix-like group identifier. When set to False, the component will return the Unix-like user and group identifiers instead.

NOTE: This functionality is not available in Mono.

When True, this setting will restrict the user to the path specified by the "HomeDir" parameter in the SSHUserAuthRequest event. When False (default), the user will be able to navigate outside of the home directory. "ConnectionId" specifies the connection to which the restriction applies.

sftpserver.Config("RestrictUserToHomeDir[" + e.ConnectionId + "]=true");

Example

If the RootDirectory property of a certain SFTP server is set to /, then the directory structure of the server might look like this...

Root Directory: /

bin
boot
etc
home
  user1
    testfolder

Home Directory: /home/user1

/testfolder

This setting is used to inform the connecting client what line endings are used in the files on the system. This is only applicable when ProtocolVersion is set to 4 or higher and a connecting client negotiates protocol version 4 or higher. When a client negotiates version 4 or higher this value is reported using the "newline" protocol convention. The client may use that to transform line endings when downloading. The default value is CrLF.

If an SFTP operation would return an error to the client (e.g., permission denied, file does not exist, etc) then this configuration option can be used to specify the error message to be returned to the client. This configuration option is only effective when set within an event that uses the "StatusCode" field.

When set to a subdirectory of the server root, this setting will override the server RootDirectory for a particular user. The "HomeDir" parameter of the SSHUserAuthRequest event will represent the initial path of the client relative to the UserRootDirectory. "ConnectionId" specifies the connection to which the restriction applies.

sftpserver.Config("UserRootDirectory[" + e.ConnectionId + "]=" + userRootDirectory );

Example

If the RootDirectory property of a certain SFTP server is set to /, then the directory structure of the server might look like this...

Root Directory: /

bin
boot
etc
home
  user1
    testfolder

Home Directory: /

/testfolder

This configuration setting controls the size of the following arrays:

• AltSSHCertStore
• AltSSHCertStorePassword
• AltSSHCertStoreType
• AltSSHCertSubject

The array indices start at 0 and end at AltSSHCertCount - 1.

The AltSSHCert configuration settings are used to specify alternative digital certificates to the one set using the SSHCert. The server will determine the certificate to use during SSH negotiation based on the public key algorithm requested by the connecting client. A certificate with a private key is required for session authentication and encryption.

These are the server's certificates, and must be set prior to setting Listening to True.

The name of the certificate store. This is used when specifying an alternative SSHCert.

The AltSSHCertStoreType specifies the type of the certificate store specified by AltSSHCertStore. IF the store is password protected, specify the password in the AltSSHCertStorePassword.

AltSSHCertStore is used in conjunction with the AltSSHCertSubject field in order to specify the certificate.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

If the certificate store is of a type that requires a password, this setting can be used to specify that password. This is used when specifying an alternative SSHCert

This specifies the type of certificate store. This is used when specifying an alternate SSHCert. Possible values are:

The subject of the certificate. This is used when specifying an alternative SSHCert.

This property specifies the idle timeout (in seconds) for clients. When set to a positive value the component will disconnect idle clients after the specified timeout.

If set to 0 (default) no idle timeout is applied.

By default, setting the KeyboardInteractivePrompts property will cause those prompts to be used for every user attempting to connect. This setting can be used to override the KeyboardInteractivePrompts property and provide unique prompts for certain connections.

This setting takes a list of prompts to display to the client, and each prompt includes an 'echo' parameter to specify whether or not to echo the client's response to the prompt. The prompt itself and the echo parameter should be separated by a comma (","), and each prompt should be separated by a semi-colon (";"). For example:

"KeyboardInteractivePrompts[connId]=First prompt,echo=false;Second prompt,echo=true"

This config can be set anywhere in code, but it is necessary to know the ConnectionId for the specific connection beforehand; as such, it is generally recommended to set this config inside the SSHUserAuthRequest event. Since connecting clients initially attempt to connect with and AuthMethod of 'none' (with the understanding that this attempt will fail, and the SSH server will advertise which authentication methods it supports), It is recommended to check the AuthMethod, User, and ConnectionId parameters of the SSHUserAuthRequest event and set this config accordingly.

When SSHDaemon displays keyboard-interactive prompts, it will first check to see if this config is populated for the current ConnectionId. If it is, the prompts set here will be used instead of those set in the KeyboardInteractivePrompts property. Otherwise, the KeyboardInteractivePrompts property will function as normal.

This property allows you to specify the threshold, in the number of bytes, for the SSH Key Renegotiation. The default value for this property is set to 1 GB.

Example (for setting the threshold to 500 MB):

SSHComponent.Config("KeyRenegotiationThreshold=524288000")

This setting controls the level of detail that is logged through the Log event. Possible values are:

This setting specifies the maximum amount of authentication attempts that will be allowed before forcibly disconnecting the client.

This setting specifies the version string value that is sent to all connecting clients. This may be set to specify server specific information. The default value is "SSH-2.0-IPWorks SSH Daemon 2016". When setting your own value it must begin with "SSH-2.0-" as this is a standard format that specifies the supported SSH version.

This setting specifies the maximum number of keep alive packets to send when no response is received. Normally a response to a keep alive packet is received right away. If no response is received the component will continue to send keep alive packets until SSHKeepAliveCountMax is reached. If this is reached the component will assume the connection is broken and disconnect. The default value is 5.

This setting specifies the number of seconds between keep alive packets. If set to a positive value the component will send a SSH keep alive packet after KeepAliveInterval seconds of inactivity. This setting only takes effect when there is no activity, if any data is sent or received over the connection it will reset the timer.

The default value is 0 meaning no keep alives will be sent.

Note: The SSHREVERSETUNNEL component uses a default value of 30.

This may be used to specify the list of supported Key Exchange algorithms used during SSH negotiation. The value should contain a comma separated list of algorithms. Supported algorithms are:

• curve25519-sha256
• curve25519-sha256@libssh.org
• diffie-hellman-group1-sha1
• diffie-hellman-group14-sha1
• diffie-hellman-group14-sha256
• diffie-hellman-group16-sha512
• diffie-hellman-group18-sha512
• diffie-hellman-group-exchange-sha256
• diffie-hellman-group-exchange-sha1
• ecdh-sha2-nistp256
• ecdh-sha2-nistp384
• ecdh-sha2-nistp521

This may be used to specify an alternate list of supported Mac algorithms used during SSH negotiation. This also specifies the order in which the Mac algorithms are preferred. The value should contain a comma separated list of algorithms. Supported algorithms are:

• hmac-sha1
• hmac-md5
• hmac-sha1-96
• hmac-md5-96
• hmac-sha2-256
• hmac-sha2-256-96
• hmac-sha2-512
• hmac-sha2-512-96
• hmac-ripemd160
• hmac-ripemd160-96
• hmac-sha2-256-etm@openssh.com
• hmac-sha2-512-etm@openssh.com

This setting specifies a list of signature algorithms that a client is allowed to use when authenticating to the server using public key authentication. This applies only when public key authentication is performed by the client.

The setting should be a comma separated list of algorithms. When a client connects the server will verify that the client performing public key authentication has used one of the specified signature algorithms. If the client uses a signature algorithm which is not in the list the connection will be rejected.

Possible values are:

• ssh-rsa
• rsa-sha2-256
• rsa-sha2-512
• ssh-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521
• ssh-ed25519
• x509v3-sign-rsa
• x509v3-sign-dss

The default value in Windows is ssh-rsa,rsa-sha2-256,rsa-sha2-512,x509v3-sign-rsa,ssh-dss,x509v3-sign-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519.

This setting specifies the allowed public key algorithms. This list controls only the public key algorithm used when authenticating to the server. This list has no bearing on the public key algorithms that can be used to authenticate the client. The default value is ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss.

This configuration setting specifies the pattern used to accept or deny the remote host's SSH version string. It takes a comma-delimited list of patterns to match. The default value is "*SSH-1.99-*,*SSH-2.0-*" and will accept connections from SSH 1.99 and 2.0 hosts. As an example, the below value would accept connections for SSH 1.99, 2.0, and 2.99 hosts.

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*

This setting specifies a custom user authentication banner, which may be sent to give the client more information regarding an authentication attempt. "connectionId" specifies the particular connection to send the message to. This configuration option is only effective when set within the SSHUserAuthRequest event.

This setting defines a comma-separated list of host names or IPv4 addresses that may access the component. The wildcard character "*" is supported. The default value is "*" and all connections are accepted.

When a client connects, the client's address is checked against the list defined here. If there is no match, the ConnectionRequest event fires with an Accept value set to False. If no action is taken within the ConnectionRequest event, the client will be disconnected.

If this is true (default), the component will bind to the local port with the ExclusiveAddressUse option set, meaning that nothing else can bind to the same port. Also the component will not be able to bind to local ports that are already in use by some other instance and attempts to do so will result in failure.

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

This setting specifies the inactivity (in seconds) to apply to incoming SSL connections. When set to a positive value if the other end is unresponsive for the specified number of seconds the connection will timeout. This is not applicable to the entire handshake, only the inactivity of the connecting client during the handshake if a response is expected and none is received within the timeout window. The default value is 0 and no connection specific timeout is applied.

Note: This is only applicable to incoming SSL connections. This should only be set if there is a specific reason to do so.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

InBufferSize is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. This setting is applicable to all connections.

Note: This value is not applicable in Java or MAC.

By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds. This setting is applicable to all connections.

Note: This value is not applicable in Java.

The maximum number of connections available. This property must be set before Listening is set to True, and once set, it can no longer be changed for the current instance of the component. The maximum value for this setting is 100,000 connections. Use this setting with caution. Extremely large values may impact performance.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

If set to True, when the component creates a thread the thread's IsBackground property will be explicitly set to True. By default this setting is False.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. When set to 2, the component will listen for both IPv4 and IPv6 connections. If IPv6 is not available on the system, only IPv4 will be used. The default value is 0. Possible values are:

When queried, this setting will return a string containing information about the product's build.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

• Product: The product the license is for.
• Product Key: The key the license was generated from.
• License Source: Where the license was found (e.g. RuntimeLicense, License File).
• License Type: The type of license installed (e.g. Royalty Free, Single Server).

By default the component will use the system security libraries to perform cryptographic functions. When set to False calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.