Docs

SecureBlackbox 2022 Java Edition

Version 22.0 [Build 8174]

SFTPServer Class

Properties   Methods   Events   Configuration Settings   Errors  

The SFTPServer class provides server-side functionality for SFTP connections.

Syntax

secureblackbox.Sftpserver

Remarks

TElSFTPServer is an implementation for SSH File Transfer Protocol server. It works over a secure SSH channel, and should not be confused with the FTP/FTPS protocol.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

ActiveSpecifies whether the SFTP server has started and ready to accept connections.
AuthTypesDefines allowed authentication types.
BaseDirSpecifies the server's base (root) directory.
ClientFileEntryA container for file entry details.
CompressionLevelSpecifies the preferable compression level.
ExternalCryptoProvides access to external signing and DC parameters.
FIPSModeReserved.
ForceCompressionThis property specifies whether server explicitly requires data compression.
HostSpecifies server's host name.
KeyContains client's public key.
MaxSFTPVersionMaximum SFTP version supported.
MinSFTPVersionMinimum SFTP version supported.
PinnedClientPopulates the pinned client details.
PortSpecifies the listening port number.
ReadOnlySpecifies whether files on the server are read-only.
ServerKeysThe server's SSH keys.
SocketSettingsManages network connection settings.
SSHSettingsThe SSH connection settings.
UsersA collection of known users.
UseUTF8Specifies whether UTF8 conversion is to be used when parsing file names.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
DropClientTerminates a client connection.
GetClientBufferAcquires a piece of operation data.
GetClientFileEntryAcquires file entry details from the class.
ListClientsEnumerates the connected clients.
PinClientTakes a snapshot of the connection's properties.
SetClientBufferCommits a data buffer to the server class.
SetClientFileEntryCommits the file entry details to the class.
StartStarts SFTP server operation.
StopStops SFTP server.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

AcceptThis event is fired when new incoming connection is accepted.
AfterCreateDirectoryThis event indicates completion of directory creation request.
AfterRemoveThis event indicates completion of file removal request.
AfterRenameFileThis event indicates completion of a file rename operation.
AfterRequestAttributesThis event indicates completion of file attributes request.
AfterSetAttributesThis event indicates completion of a set attributes request.
AuthAttemptReports a user authentication attempt.
AuthFailedReports user authentication failure.
AuthPasswordThis event is fired on password authentication attempt from a client.
AuthPublicKeyThis event is fired on public key authentication attempt from a client.
AuthSucceededReports a successful user authentication.
BeforeCreateDirectoryThis event is fired when a client requests to create a directory.
BeforeDownloadFileThis event is fired when a download file request is received.
BeforeFindThis event is fired when a client requests to find files and folders in Path.
BeforeRemoveThis event is fired when a client requests to delete a file or directory.
BeforeRenameFileThis event is fired when a client requests to rename a file.
BeforeRequestAttributesThis event is fired when a client requests to get file attributes.
BeforeSetAttributesThis event is fired when a client requests to set file attributes.
BeforeUploadFileThis event is fired when an upload file request is received.
CloseFileThis event instructs the application to close an opened file.
ConnectThis event is fired when a remote connection has been established.
CreateDirectoryThis event instructs the application to create a directory.
DisconnectThis event is fired when a client has disconnected.
ErrorInformation about errors during data delivery.
ExternalSignHandles remote or external signing initiated by the server protocol.
FindCloseThis event signifies the completion of a custom file listing operation.
FindFirstThis event signifies the start of the custom file listing retrieval mechanism.
FindNextThis event retrieves the next entry of a custom file listing.
NotificationThis event notifies the application about an underlying control flow event.
OpenFileThis event instructs the application to handle the file open request.
ReadFileThis event is fired when a file read request is received.
RemoveThis event is fired when a client requests to delete a file or directory.
RenameFileThis event is fired when a client requests to rename a file.
RequestAttributesThis event is fired when a get file attributes request is received.
SessionClosedReports session closure.
SessionEstablishedThis event is fired when a new session is established.
SetAttributesThis event is fired when an set file attributes request is received.
WriteFileThis event is fired when a file write request is received.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

CustomDHGroupIndexSets a specific Diffie-Hellman group index to enforce.
DualStackAllows the use of ip4 and ip6 simultaneously.
MaxDHGroupSizeSets the maximal Diffie-Hellman group size.
MinDHGroupSizeSets the minimal Diffie-Hellman group size.
NotifyOnFileOperationsEnables low-level file operation notifications.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
TagAllows to store any custom data.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Active Property (SFTPServer Class)

Specifies whether the SFTP server has started and ready to accept connections.

Syntax


public boolean isActive();


Default Value

False

Remarks

Check this property to find out whether the SFTP server is in active mode. Use Start and Stop methods to activate or deactivate the server.

This property is read-only and not available at design time.

AuthTypes Property (SFTPServer Class)

Defines allowed authentication types.

Syntax


public int getAuthTypes();


public void setAuthTypes(int authTypes);

Default Value

30

Remarks

Use this property to define which authentication types are allowed on the server, set of

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

BaseDir Property (SFTPServer Class)

Specifies the server's base (root) directory.

Syntax


public String getBaseDir();


public void setBaseDir(String baseDir);

Default Value

""

Remarks

Use this property to set the base (root) directory on the server.

ClientFileEntry Property (SFTPServer Class)

A container for file entry details.

Syntax


public SFTPListEntry getClientFileEntry();


public void setClientFileEntry(SFTPListEntry clientFileEntry);

Remarks

This property is a placeholder for file entry details. Use it communicate file details from your code to the server component and back. Pass the contents of ClientFileEntry to the server with SetClientFileEntry method, and retrieve them with GetClientFileEntry method.

This property may come handy when customizing file system operations, such as file listings or attribute requests.

This property is not available at design time.

CompressionLevel Property (SFTPServer Class)

Specifies the preferable compression level.

Syntax


public int getCompressionLevel();


public void setCompressionLevel(int compressionLevel);

Default Value

9

Remarks

Set this property before starting the server. Possible values range from 0 (lowest compression) to 9 (maximum compression). This property is ignored if compression wasn't accepted.

ExternalCrypto Property (SFTPServer Class)

Provides access to external signing and DC parameters.

Syntax


public ExternalCrypto getExternalCrypto();


Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).

This property is read-only.

FIPSMode Property (SFTPServer Class)

Reserved.

Syntax


public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

ForceCompression Property (SFTPServer Class)

This property specifies whether server explicitly requires data compression.

Syntax


public boolean isForceCompression();


public void setForceCompression(boolean forceCompression);

Default Value

False

Remarks

Set this property before starting the server. If it is set to true, the class will explicitly request data compression. If it is set to False, the class will support compression, although compression will be used only if the remote party doesn't support algorithms without compression.

Host Property (SFTPServer Class)

Specifies server's host name.

Syntax


public String getHost();


public void setHost(String host);

Default Value

""

Remarks

Use this property to set the host name for this server.

Key Property (SFTPServer Class)

Contains client's public key.

Syntax


public SSHKey getKey();


Remarks

This property returns the currently pinned client's public key. Call PinClient to propagate the key of a particular client prior to checking this property.

This property is read-only and not available at design time.

MaxSFTPVersion Property (SFTPServer Class)

Maximum SFTP version supported.

Syntax


public int getMaxSFTPVersion();


public void setMaxSFTPVersion(int maxSFTPVersion);

Default Value

6

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions supported by this server.

MinSFTPVersion Property (SFTPServer Class)

Minimum SFTP version supported.

Syntax


public int getMinSFTPVersion();


public void setMinSFTPVersion(int minSFTPVersion);

Default Value

0

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions supported by this server.

PinnedClient Property (SFTPServer Class)

Populates the pinned client details.

Syntax


public SSHClientEntry getPinnedClient();


Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

This property is read-only and not available at design time.

Port Property (SFTPServer Class)

Specifies the listening port number.

Syntax


public int getPort();


public void setPort(int port);

Default Value

22

Remarks

Use this property to specify on which port the class will be listening to client connections.

ReadOnly Property (SFTPServer Class)

Specifies whether files on the server are read-only.

Syntax


public boolean isReadOnly();


public void setReadOnly(boolean readOnly);

Default Value

False

Remarks

Set this property to true to deny all client requests to change files on the server.

ServerKeys Property (SFTPServer Class)

The server's SSH keys.

Syntax


public SSHKeyList getServerKeys();


public void setServerKeys(SSHKeyList serverKeys);

Remarks

Use this property to provide a list of SSH private keys for the server endpoint.

An SSH endpoint needs a private key to be able to accept secure connections. Apart from being employed for the handshake, the key is also used as a unique server identifier.

The collection may include more than one endpoint key. A typical usage scenario is to include two or three keys (ECDSA, RSA, and DSS), to cater for clients with different algorithm preferences.

This property is not available at design time.

SocketSettings Property (SFTPServer Class)

Manages network connection settings.

Syntax


public SocketSettings getSocketSettings();


Remarks

Use this property to tune up network connection parameters.

This property is read-only.

SSHSettings Property (SFTPServer Class)

The SSH connection settings.

Syntax


public SSHSettings getSSHSettings();


Remarks

Use this property to access and tune-up the SSH layer settings.

This property is read-only.

Users Property (SFTPServer Class)

A collection of known users.

Syntax


public UserAccountList getUsers();


public void setUsers(UserAccountList users);

Remarks

This property provides access to registered user database.

This property is not available at design time.

UseUTF8 Property (SFTPServer Class)

Specifies whether UTF8 conversion is to be used when parsing file names.

Syntax


public boolean isUseUTF8();


public void setUseUTF8(boolean useUTF8);

Default Value

False

Remarks

This property specifies whether UTF8 conversion of filenames is used by the server. It is set automatically according to protocol flow, but user could also set it to the desired value.

Config Method (Sftpserver Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (Sftpserver Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

DropClient Method (Sftpserver Class)

Terminates a client connection.

Syntax

public void dropClient(long connectionId, boolean forced);

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

GetClientBuffer Method (Sftpserver Class)

Acquires a piece of operation data.

Syntax

public byte[] getClientBuffer(long connectionID, String handle);

Remarks

Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way.

A typical place to call this method is inside the WriteFile event handler, when implementing customized file transfers.

GetClientFileEntry Method (Sftpserver Class)

Acquires file entry details from the class.

Syntax

public void getClientFileEntry(long connectionID, String handle);

Remarks

Use this method to acquire the details of a file entry from the server in atomic and thread-safe way. After this method completes, the entry details will be propagated in ClientFileEntry property.

When calling this method, pass the client connection ID in ConnectionID property, and the opened file handle (if needed) in Handle property.

ListClients Method (Sftpserver Class)

Enumerates the connected clients.

Syntax

public String listClients();

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

PinClient Method (Sftpserver Class)

Takes a snapshot of the connection's properties.

Syntax

public void pinClient(long connectionId);

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient property.

SetClientBuffer Method (Sftpserver Class)

Commits a data buffer to the server class.

Syntax

public void setClientBuffer(long connectionID, String handle, byte[] value);

Remarks

Use this method to commit a data buffer passed via the Value parameter to the server control in a thread-safe way.

One example where you might need to pass your buffer to the server is when customizing upload operations via ReadFile event.

SetClientFileEntry Method (Sftpserver Class)

Commits the file entry details to the class.

Syntax

public void setClientFileEntry(long connectionID, String handle);

Remarks

Use this method to commit the file entry details configured in ClientFileEntry property to the server object in a thread-safe way. Pass the client's connection ID via ConnectionID property, and the file entry's handle via Handle.

Start Method (Sftpserver Class)

Starts SFTP server operation.

Syntax

public void start();

Remarks

Call this method to start listening to incoming connections.

Stop Method (Sftpserver Class)

Stops SFTP server.

Syntax

public void stop();

Remarks

Call this method to close all connections and stop listening to clients.

Accept Event (Sftpserver Class)

This event is fired when new incoming connection is accepted.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void accept(SftpserverAcceptEvent e) {}
  ...
}

public class SftpserverAcceptEvent {
  public String remoteAddress;

  public int remotePort;

  public boolean accept;

}

Remarks

This event is fired by the class before a new incoming connection is accepted. RemoteAddress contains the IP address of the connecting client. Use the Accept parameter to either accept, or reject the connection.

AfterCreateDirectory Event (Sftpserver Class)

This event indicates completion of directory creation request.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void afterCreateDirectory(SftpserverAfterCreateDirectoryEvent e) {}
  ...
}

public class SftpserverAfterCreateDirectoryEvent {
  public long connectionID;

  public String path;

  public int operationStatus;

}

Remarks

This event is fired to report completion of a directory creation request. The ConnectionID parameter specifies in which session the request was received, the Path specifies the directory path, and the OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterRemove Event (Sftpserver Class)

This event indicates completion of file removal request.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void afterRemove(SftpserverAfterRemoveEvent e) {}
  ...
}

public class SftpserverAfterRemoveEvent {
  public long connectionID;

  public String path;

  public int operationStatus;

}

Remarks

This event is fired when a request to delete a file or directory has been processed by the server. The ConnectionID parameter specifies the session in which the request was received. OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterRenameFile Event (Sftpserver Class)

This event indicates completion of a file rename operation.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void afterRenameFile(SftpserverAfterRenameFileEvent e) {}
  ...
}

public class SftpserverAfterRenameFileEvent {
  public long connectionID;

  public String oldPath;

  public String newPath;

  public int operationStatus;

}

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) has been processed. The ConnectionID parameter specifies in which session the request was received, and OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterRequestAttributes Event (Sftpserver Class)

This event indicates completion of file attributes request.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void afterRequestAttributes(SftpserverAfterRequestAttributesEvent e) {}
  ...
}

public class SftpserverAfterRequestAttributesEvent {
  public long connectionID;

  public String path;

  public int operationStatus;

}

Remarks

This event is fired when a request for get file attributes has been processed by the server. The ConnectionID parameter specifies in which session the request was received. OperationStatus contains the result of the operation.

If needed, you can amend the OperationStatus to return a different operation result:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AfterSetAttributes Event (Sftpserver Class)

This event indicates completion of a set attributes request.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void afterSetAttributes(SftpserverAfterSetAttributesEvent e) {}
  ...
}

public class SftpserverAfterSetAttributesEvent {
  public long connectionID;

  public String path;

  public int operationStatus;

}

Remarks

This event is fired when a request for set file attributes has been processed. The ConnectionID parameter specifies in which session the request was received. The OperationStatus parameter contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

AuthAttempt Event (Sftpserver Class)

Reports a user authentication attempt.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void authAttempt(SftpserverAuthAttemptEvent e) {}
  ...
}

public class SftpserverAuthAttemptEvent {
  public long connectionID;

  public String username;

  public int authType;

  public boolean accept;

}

Remarks

ConnectionID identifies the session, Username specifies client's username, and AuthType specifies the authentication type. Use the Accept parameter to accept or decline the attempt.

Supported authentication types:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

AuthFailed Event (Sftpserver Class)

Reports user authentication failure.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void authFailed(SftpserverAuthFailedEvent e) {}
  ...
}

public class SftpserverAuthFailedEvent {
  public long connectionID;

  public String username;

  public int authType;

}

Remarks

ConnectionID identifies the session, Username specify client's username, and AuthType specifies what authentication type was used.

Supported authentication types:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

AuthPassword Event (Sftpserver Class)

This event is fired on password authentication attempt from a client.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void authPassword(SftpserverAuthPasswordEvent e) {}
  ...
}

public class SftpserverAuthPasswordEvent {
  public long connectionID;

  public String username;

  public String password;

  public boolean accept;

  public boolean forceChangePassword;

}

Remarks

Parameters Username and Password contain user credentials. If they are correct, set Accept to true. You can request password change by setting ForceChangePassword to true.

AuthPublicKey Event (Sftpserver Class)

This event is fired on public key authentication attempt from a client.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void authPublicKey(SftpserverAuthPublicKeyEvent e) {}
  ...
}

public class SftpserverAuthPublicKeyEvent {
  public long connectionID;

  public String username;

  public boolean accept;

}

Remarks

Username specifies client's username, and Accept is used to accept or reject authentication.

AuthSucceeded Event (Sftpserver Class)

Reports a successful user authentication.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void authSucceeded(SftpserverAuthSucceededEvent e) {}
  ...
}

public class SftpserverAuthSucceededEvent {
  public long connectionID;

  public String username;

  public int authType;

}

Remarks

ConnectionID identifies the session, Username specify client's username, and AuthType specifies what authentication type was used.

Supported authentication types:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

BeforeCreateDirectory Event (Sftpserver Class)

This event is fired when a client requests to create a directory.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void beforeCreateDirectory(SftpserverBeforeCreateDirectoryEvent e) {}
  ...
}

public class SftpserverBeforeCreateDirectoryEvent {
  public long connectionID;

  public String path;

  public int action;

}

Remarks

This event is fired when a request to create a directory has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeDownloadFile Event (Sftpserver Class)

This event is fired when a download file request is received.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void beforeDownloadFile(SftpserverBeforeDownloadFileEvent e) {}
  ...
}

public class SftpserverBeforeDownloadFileEvent {
  public long connectionID;

  public String path;

  public int action;

}

Remarks

This event is fired when a request to download file is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeFind Event (Sftpserver Class)

This event is fired when a client requests to find files and folders in Path.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void beforeFind(SftpserverBeforeFindEvent e) {}
  ...
}

public class SftpserverBeforeFindEvent {
  public long connectionID;

  public String path;

  public int action;

}

Remarks

This event is fired when a request to find files and folders in Path has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeRemove Event (Sftpserver Class)

This event is fired when a client requests to delete a file or directory.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void beforeRemove(SftpserverBeforeRemoveEvent e) {}
  ...
}

public class SftpserverBeforeRemoveEvent {
  public long connectionID;

  public String path;

  public int action;

}

Remarks

This event is fired when a request to delete a file or directory is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeRenameFile Event (Sftpserver Class)

This event is fired when a client requests to rename a file.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void beforeRenameFile(SftpserverBeforeRenameFileEvent e) {}
  ...
}

public class SftpserverBeforeRenameFileEvent {
  public long connectionID;

  public String oldPath;

  public String newPath;

  public int action;

}

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeRequestAttributes Event (Sftpserver Class)

This event is fired when a client requests to get file attributes.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void beforeRequestAttributes(SftpserverBeforeRequestAttributesEvent e) {}
  ...
}

public class SftpserverBeforeRequestAttributesEvent {
  public long connectionID;

  public String path;

  public int action;

}

Remarks

This event is fired when a request to get file attributes has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeSetAttributes Event (Sftpserver Class)

This event is fired when a client requests to set file attributes.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void beforeSetAttributes(SftpserverBeforeSetAttributesEvent e) {}
  ...
}

public class SftpserverBeforeSetAttributesEvent {
  public long connectionID;

  public String path;

  public int action;

}

Remarks

This event is fired when a request to set file attributes has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

BeforeUploadFile Event (Sftpserver Class)

This event is fired when an upload file request is received.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void beforeUploadFile(SftpserverBeforeUploadFileEvent e) {}
  ...
}

public class SftpserverBeforeUploadFileEvent {
  public long connectionID;

  public String path;

  public int action;

}

Remarks

This event is fired when an upload file request is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the location on the server where the file needs to be saved.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

CloseFile Event (Sftpserver Class)

This event instructs the application to close an opened file.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void closeFile(SftpserverCloseFileEvent e) {}
  ...
}

public class SftpserverCloseFileEvent {
  public long connectionID;

  public String handle;

  public int operationStatus;

}

Remarks

This event is fired upon receipt of a close-file packet from a client. Servers implementing virtualized transfers must close the previously opened local file referenced by Handle in this event handler. No further operations are allowed with the closed file.

Set OperationStatus to one of the following values to report the result of this operation to the client:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

Connect Event (Sftpserver Class)

This event is fired when a remote connection has been established.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void connect(SftpserverConnectEvent e) {}
  ...
}

public class SftpserverConnectEvent {
  public long connectionID;

  public String remoteAddress;

  public int remotePort;

}

Remarks

ConnectionID contains a session identifier, and RemoteAddress specifies the client's IP address.

CreateDirectory Event (Sftpserver Class)

This event instructs the application to create a directory.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void createDirectory(SftpserverCreateDirectoryEvent e) {}
  ...
}

public class SftpserverCreateDirectoryEvent {
  public long connectionID;

  public String path;

  public int operationStatus;

}

Remarks

This event is fired when a request to create a directory has been received and needs to be served (virtualized) by the application. The ConnectionID parameter specifies the session that has communicated the request, and Path contains the name of the directory to be created.

Set OperationStatus to one of the below values according to the outcome of the request processing:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

Disconnect Event (Sftpserver Class)

This event is fired when a client has disconnected.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void disconnect(SftpserverDisconnectEvent e) {}
  ...
}

public class SftpserverDisconnectEvent {
  public long connectionID;

}

Remarks

This event reports loss of connection to the client within the session specified by ConnectionID.

Error Event (Sftpserver Class)

Information about errors during data delivery.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void error(SftpserverErrorEvent e) {}
  ...
}

public class SftpserverErrorEvent {
  public int errorCode;

  public String description;

}

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the SFTP section.

ExternalSign Event (Sftpserver Class)

Handles remote or external signing initiated by the server protocol.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void externalSign(SftpserverExternalSignEvent e) {}
  ...
}

public class SftpserverExternalSignEvent {
  public long connectionID;

  public String operationId;

  public String hashAlgorithm;

  public String pars;

  public String data;

  public String signedData;

}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

FindClose Event (Sftpserver Class)

This event signifies the completion of a custom file listing operation.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void findClose(SftpserverFindCloseEvent e) {}
  ...
}

public class SftpserverFindCloseEvent {
  public long connectionID;

  public String handle;

  public int operationStatus;

}

Remarks

FindClose notifies your code about the completion of a custom file listing request. Use it in conjunction with FindFirst and FindNext to handle file listing requests manually.

See FindFirst topic for the details on implementing customized file listing request processing.

Set OperationStatus to one of the below values according to the outcome of the request processing:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

FindFirst Event (Sftpserver Class)

This event signifies the start of the custom file listing retrieval mechanism.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void findFirst(SftpserverFindFirstEvent e) {}
  ...
}

public class SftpserverFindFirstEvent {
  public long connectionID;

  public String path;

  public int operationStatus;

  public String handle;

}

Remarks

FindFirst, FindNext, and FindClose events represent a mechanism for providing customized file listings to class. They are only fired if Action parameter of the preceding BeforeFind event was set to fraCustom.

The behaviour of these events mimics that of the standard FindFirst/FindNext/FindClose functions found in many operating systems/frameworks. FindFirst fires once to request the first list entry; FindNext then fires continuously in a loop to request all subsequent entries. To indicate that the listing is over, set OperationStatus parameter to ostEOF. Not doing so may lead to an endless loop and session freeze, as the component would continue firing FindNext infinitely waiting for the EOF marker.

The handlers for both FindFirst and FindNext events should be implemented in the following way: if there are more entries in the directory to pass back to the server component,

When all the entries from the requested directory have been passed to the server component, set OperationStatus to ostEOF. The server will then fire FindClose event to notify your code that the file listing is completed.

Use the by-ref Handle parameter to assign a handle (a unique identifier) to the file listing procedure inside the FindFirst event handler. This identifier will then be passed to all subsequent FindNext and FindClose calls to let your code chain the events together.

The ConnectionID parameter specifies in which SFTP session the request was received, and Path indicates the requested directory.

The following operation status constants are available, besides the ones referenced above:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

FindNext Event (Sftpserver Class)

This event retrieves the next entry of a custom file listing.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void findNext(SftpserverFindNextEvent e) {}
  ...
}

public class SftpserverFindNextEvent {
  public long connectionID;

  public String handle;

  public int operationStatus;

}

Remarks

This event is fired repeatedly after FindFirst to retrieve the directory contents entry-by-entry. Please see the FindFirst topic for more details about implementing a handler of this event.

Remember to set OperationStatus to ostEOF when there are no more entries left to close the listing operation. If there are more entries to pass, set it to ostOK. Other possible values are given in the table below:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

Notification Event (Sftpserver Class)

This event notifies the application about an underlying control flow event.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void notification(SftpserverNotificationEvent e) {}
  ...
}

public class SftpserverNotificationEvent {
  public String eventID;

  public String eventParam;

}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:

FileOpenNotifies your code about the file being opened, which is typically an indicator of the initiation of the transfer operation. The EventParam value passed with this EventID is a string of the following format:

ConnectionID=3;Path=/dir/file;Handle=x5DshAk8;Modes=48;Access=0;DesiredAccess=8

This EventID only fires if the NotifyOnFileOperations configuration property is set to true.

FileReadNotifies your code about the file chunk being requested. The EventParam value passed with this EventID is a string of the following format:

ConnectionID=7;Handle=x5DshAk8;Offset=2048;Count=1024;Read=1021

This EventID only fires if the NotifyOnFileOperations configuration property is set to true.

FileWriteNotifies your code about the file chunk being received. The EventParam value passed with this EventID is a string of the following format:

ConnectionID=7;Handle=x5DshAk8;Offset=2048;Count=1024

This EventID only fires if the NotifyOnFileOperations configuration property is set to true.

FileCloseNotifies your code about the closure of an opened file. The EventParam value passed with this EventID is a string of the following format:

ConnectionID=7;Handle=x5DshAk8;Modes=48

This EventID only fires if the NotifyOnFileOperations configuration property is set to true.

OpenShellNotifies your code about an opened shell tunnel. The EventParam has the following format: ConnectionID=9;LocalChannel=1;RemoteChannel=2
OpenCommandNotifies your code about an opened command tunnel. The EventParam value has the following format:

ConnectionID=8;LocalChannel=3;RemoteChannel=3;Command=ls -l

CloseShellIndicates the closure of a shell tunnel. The EventParam format is the same as with the OpenShell event ID.
CloseCommandIndicates the closure of a command tunnel. The EventParam format is the same as with the OpenCommand event ID.

OpenFile Event (Sftpserver Class)

This event instructs the application to handle the file open request.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void openFile(SftpserverOpenFileEvent e) {}
  ...
}

public class SftpserverOpenFileEvent {
  public long connectionID;

  public String path;

  public int modes;

  public int access;

  public int operationStatus;

  public String handle;

}

Remarks

This event is fired when a file open request is received from the client and needs to be handled (virtualized) by the server. The ConnectionID parameter specifies in which session the request was received, and Path specifies the location of the file.

Modes can be a combination of one or several file open mode flags:

cfmRead1
cfmWrite2
cfmAppend4
cfmCreate8
cfmTruncate16
cfmExcl32
cfmText64
cfmOpenOrCreate128
cfmAppendAtomic256
cfmNoFollow512
cfmDeleteOnClose1024

Different client applications may provide different selections of mode flags. For example, some clients specify (cfmCreate + cfmTruncate) when overwriting files, whereas others would specify cfmOpenOrCreate. Please make sure your code is prepared to receive different combinations of flags here and handles them gracefully.

The Access parameter provides additional file access modifiers:

cfaReadLock1
cfaWriteLock2
cfaDeleteLock4
cfaBlockAdvisory8

These parameter may also contain a combination of the above flags. Access modifiers are only supported in SFTPv6, and in practice are rarely used by client applications.

The Handle string represents a unique identifier of the opened file, similar to file handles used in Windows or Unix APIs. Handles are unique across all files opened at the same time. Class generates handles automatically, but you can update the auto-generated values with your own in this event handler (just remember to keep them unique).

Set OperationStatus parameter in accordance with the outcome of the operation to one of the values given below:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

ReadFile Event (Sftpserver Class)

This event is fired when a file read request is received.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void readFile(SftpserverReadFileEvent e) {}
  ...
}

public class SftpserverReadFileEvent {
  public long connectionID;

  public String handle;

  public int offset;

  public int size;

  public int operationStatus;

}

Remarks

This event is fired when a request to read block from a file is received from the client. The ConnectionID parameter specifies in which session the request was received, and Handle indicates an opened file handle. Offset and Size denote the location and size of the file piece.

Inside the event handler, pass the appropriate file chunk to the component via SetClientBuffer method.

Set OperationStatus to one of the below values according to the outcome of the request processing:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

Remove Event (Sftpserver Class)

This event is fired when a client requests to delete a file or directory.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void remove(SftpserverRemoveEvent e) {}
  ...
}

public class SftpserverRemoveEvent {
  public long connectionID;

  public String path;

  public int operationStatus;

}

Remarks

This event is fired when a request to delete a file or directory is received from the client. The ConnectionID parameter specifies in which session the request was received.

Set OperationStatus to one of the below values according to the outcome of the request processing:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

RenameFile Event (Sftpserver Class)

This event is fired when a client requests to rename a file.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void renameFile(SftpserverRenameFileEvent e) {}
  ...
}

public class SftpserverRenameFileEvent {
  public long connectionID;

  public String oldPath;

  public String newPath;

  public int operationStatus;

}

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) is received from the client. The ConnectionID parameter specifies in which session the request was received.

Set OperationStatus to one of the below values according to the outcome of the request processing:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

RequestAttributes Event (Sftpserver Class)

This event is fired when a get file attributes request is received.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void requestAttributes(SftpserverRequestAttributesEvent e) {}
  ...
}

public class SftpserverRequestAttributesEvent {
  public long connectionID;

  public String path;

  public String handle;

  public int operationStatus;

}

Remarks

This event is fired when a request to get file attributes is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the file location where the attributes need to be retrieved.

Set OperationStatus to one of the below values according to the outcome of the request processing:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

SessionClosed Event (Sftpserver Class)

Reports session closure.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void sessionClosed(SftpserverSessionClosedEvent e) {}
  ...
}

public class SftpserverSessionClosedEvent {
  public long connectionID;

}

Remarks

This event is fired when a connection identified by ConnectionID has been gracefully closed.

SessionEstablished Event (Sftpserver Class)

This event is fired when a new session is established.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void sessionEstablished(SftpserverSessionEstablishedEvent e) {}
  ...
}

public class SftpserverSessionEstablishedEvent {
  public long connectionID;

}

Remarks

This event is fired when a new connection identified by ConnectionID has been established with a client.

SetAttributes Event (Sftpserver Class)

This event is fired when an set file attributes request is received.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void setAttributes(SftpserverSetAttributesEvent e) {}
  ...
}

public class SftpserverSetAttributesEvent {
  public long connectionID;

  public String path;

  public String handle;

  public int operationStatus;

}

Remarks

This event is fired when a request to set file attributes is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the file location which the attributes needs to be set.

Set OperationStatus to one of the below values according to the outcome of the request processing:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

WriteFile Event (Sftpserver Class)

This event is fired when a file write request is received.

Syntax

public class DefaultSftpserverEventListener implements SftpserverEventListener {
  ...
  public void writeFile(SftpserverWriteFileEvent e) {}
  ...
}

public class SftpserverWriteFileEvent {
  public long connectionID;

  public String handle;

  public int offset;

  public int operationStatus;

}

Remarks

This event is fired when a request to write a data block to a file is received from the client. The ConnectionID parameter specifies the session the request originates from. The Handle parameter references the opened file where the block should be written to. Offset references the position in the file where the block of data should be written.

Use GetClientBuffer method to obtain the piece of data that should be written to the file.

Set OperationStatus to one of the below values according to the outcome of the request processing:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

AsyncDocumentID
String

Specifies the document ID for SignAsyncEnd() call

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

CustomParams
String

Custom parameters to be passed to the signing service (uninterpreted).

Data
String

Additional data to be included in the async state and mirrored back by the requestor

ExternalHashCalculation
boolean

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

HashAlgorithm
String

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

KeyID
String

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

KeySecret
String

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the KeyID topic.

Method
int

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

asmdPKCS10
asmdPKCS71

Mode
int

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

PublicKeyAlgorithm
String

Provide public key algorithm here if the certificate is not available on the pre-signing stage.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Constructors

public ExternalCrypto();

Creates a new ExternalCrypto object with default field values.

SFTPListEntry Type

A container for filesystem element's attributes.

Remarks

This type contains attributes of a single entry returned by a ListDir command.

The contents of this container may differ for different servers (not all servers support all attributes).

Fields

ATime
String

Contains the last access time for this file, in UTC.

CTime
String

Contains this file's creation time, in UTC.

Directory
boolean

Specifies whether this entry is a directory.

FileType
int

Specifies the type of this entry, one of the following:

cftFile0
cftDirectory1
cftSymblink2
cftSpecial3
cftUnknown4
cftSocket5
cftCharDevice6
cftBlockDevice7
cftFIFO8

GroupExecute
boolean

Controls file execution permission for the group users.

GroupRead
boolean

Controls file read permission for the group users.

GroupWrite
boolean

Controls file write permission for the group users.

LongName
String

Contains the long name of the file (human-readable, ftp-like).

MTime
String

Specifies the last modification time, in UTC.

Name
String

Specifies the file name.

OtherExecute
boolean

Controls file execution permission for other users (users that are neither owners, nor belong to the same group).

OtherRead
boolean

Controls file read permission for other users (users that are neither owners, nor belong to the same group).

OtherWrite
boolean

Controls file write permission for other users (users that are neither owners, nor belong to the same group).

Owner
String

Specifies the owner of the file/directory.

Path
String

Contains the full path to the file.

Size
long

The size of the file in bytes.

UserExecute
boolean

Controls file execution permission for the file owner.

UserRead
boolean

Controls file read permission for the file owner.

UserWrite
boolean

Controls file write permission for the file owner.

Constructors

public SFTPListEntry();

Creates a new SFTPListEntry object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

DNSMode
int

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

DNSPort
int

Specifies the port number to be used for sending queries to the DNS server.

DNSQueryTimeout
int

The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.

DNSServers
String

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

DNSTotalTimeout
int

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.

IncomingSpeedLimit
int

The maximum number of bytes to read from the socket, per second.

LocalAddress
String

The local network interface to bind the socket to.

LocalPort
int

The local port number to bind the socket to.

OutgoingSpeedLimit
int

The maximum number of bytes to write to the socket, per second.

Timeout
int

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

UseIPv6
boolean

Enables or disables IP protocol version 6.

Constructors

public SocketSettings();

Creates a new SocketSettings object.

SSHClientEntry Type

Contains information about an accepted SSH connection.

Remarks

SSHClientEntry object contains information about one accepted SSH connection.

Fields

Address
String

The client's IP address.

ClientKeyAlgorithm
String

Specifies the client's key algorithm.

ClientKeyBits
int

Specifies the length of the client's key.

ClientKeyFingerprint
String

The fingerprint (hash value) of the client's public key.

ClientSoftwareName
String

Returns the name of the SSH software running on the client side.

CloseReason
String

Contains the line sent by the client just before closing the connection. It might contain the error description if the connection was not closed gracefully.

CompressionAlgorithmInbound
String

Compression algorithm for the incoming traffic.

CompressionAlgorithmOutbound
String

Compression algorithm for the outgoing traffic.

EncryptionAlgorithmInbound
String

Encryption algorithm for the incoming traffic.

EncryptionAlgorithmOutbound
String

Encryption algorithm for the outgoing traffic.

ID
long

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

InboundEncryptionKeyBits
int

Specifies the length of the key used to encrypt the incoming traffic.

KexAlgorithm
String

The key exchange algorithm used during the SSH handshake.

KexBits
int

The number of bits used by the key exchange algorithm.

KexLines
String

The contents of the received KexInit packet.

KexInit packet contains the list of algorithms supported by the remote party.

MacAlgorithmInbound
String

MAC algorithm used for the incoming connection.

MacAlgorithmOutbound
String

MAC algorithm used for outbound connection.

OutboundEncryptionKeyBits
int

Specifies the length of the key used to encrypt the outgoing traffic.

Port
int

The remote port of the client connection.

PublicKeyAlgorithm
String

Specifies the public key algorithm which was used during the SSH handshake.

ServerKeyBits
int

Specifies the number of bits in the server's key.

ServerKeyFingerprint
String

The fingerprint (hash value) of the server's public key.

TotalBytesReceived
long

Returns the total number of bytes received over this connection.

TotalBytesSent
long

Returns the total number of bytes sent over this connection.

Version
int

Specifies SSH protocol version.

Constructors

public SSHClientEntry();

Creates an empty object representing a SSH connection entry.

SSHKey Type

SSHKey is used to store information about single compound public-key algorithm (such as RSA or DSA) key.

Remarks

SSH keys are used to secure the SSH protocol flow. They support different algorithms and key lengths, a very typical example being RSA-2048 bits.

Fields

Algorithm
String

Specifies the key algorithm.

Bits
int

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

Comment
String

The comment for the public key.

Curve
String

Specifies the elliptical curve when EC cryptography is used.

DSSG
byte[]

The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.

DSSP
byte[]

The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.

DSSQ
byte[]

The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.

DSSX
byte[]

The X (Private key) parameter of the DSS signature key. The string should contain the binary data of X.

This parameter may be empty if there's no need to sign data with this key (e.g. if the key is a server public key needed only to authenticate the server).

DSSY
byte[]

The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.

ECCD
byte[]

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. The string should contain the binary data of D.

ECCQX
byte[]

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of X.

ECCQY
byte[]

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of Y.

EdPrivate
byte[]

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

EdPublic
byte[]

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

FingerprintMD5
String

Contains the MD5 fingerprint (hash) of the key.

FingerprintSHA1
String

Contains the SHA-1 fingerprint (hash) of the key.

FingerprintSHA256
String

Contains the SHA-256 fingerprint (hash) of the key.

IsExtractable
boolean

Whether the key is extractable (e.g., from a security token), or not.

IsPrivate
boolean

Whether this key is a private key or not.

IsPublic
boolean

Whether this key is a public key or not.

KDFRounds
int

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

KDFSalt
byte[]

The salt value used by the Key Derivation Function (KDF) to generate this key.

KeyFormat
int

Specifies the format in which the key is stored.

ckfOpenSSH0
ckfOpenSSH21
ckfIETF2
ckfPuTTY3
ckfX5094
ckfBinary5
ckfSSH16
ckfPGP7
ckfPKCS88

KeyProtectionAlgorithm
String

Specifies the key protection algorithm.

RSAExponent
byte[]

Returns the e parameter (public exponent) of the RSA key.

RSAIQMP
byte[]

Returns the iqmp parameter of the RSA key.

RSAModulus
byte[]

Returns the m parameter (public modulus) of the RSA key.

RSAP
byte[]

Returns the p parameter (first factor of the common modulus n) of the RSA key.

RSAPrivateExponent
byte[]

Returns the d parameter (private exponent) of the RSA key.

RSAQ
byte[]

Returns the q parameter (second factor of the common modulus n) of the RSA key.

Subject
String

Specifies the public key owner (subject). This property is used only for IETF-keys.

Constructors

public SSHKey(byte[] bytes, int startIndex, int count, String password);

Loads private key from the Bytes buffer. Parameters StartIndex and Count specify the starting index of the key data and its length, correspondingly. Provide a Password to decrypt the key.

public SSHKey(byte[] bytes, int startIndex, int count);

Loads public key from the Bytes buffer. Parameters StartIndex and Count specify the starting index of the key data and its length, correspondingly.

public SSHKey(java.io.InputStream stream, String password);

Loads private key from the stream. Provide a Password to decrypt the key.

public SSHKey(java.io.InputStream stream);

Loads public key from the stream.

public SSHKey(String path, String password);

Loads private key from the file. Provide a Path to the file and Password to decrypt the key.

public SSHKey(String path);

Loads public key from the file specified by Path .

public SSHKey();

Creates a new key.

SSHSettings Type

A container for various SSH protocol settings.

Remarks

SSHSettings stores various settings of SSH client or server.

Fields

AutoAdjustCiphers
boolean

Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.

BaseConfiguration
int

Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.

CompressionAlgorithms
String

A list of session compression algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all compression algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of compression algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported compression algorithms is provided below:

  • none
  • zlib
  • zlib@openssh.com

CompressionLevel
int

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted.

DefaultWindowSize
int

The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.

EncryptionAlgorithms
String

A list of session encryption algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all encryption algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of encryption algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported encryption algorithms is provided below:

  • 3des-cbc
  • blowfish-cbc
  • twofish256-cbc
  • twofish192-cbc
  • twofish128-cbc
  • aes256-cbc
  • aes192-cbc
  • aes128-cbc
  • serpent256-cbc
  • serpent192-cbc
  • serpent128-cbc
  • arcfour
  • idea-cbc
  • cast128-cbc
  • none
  • des-cbc
  • aes128-ctr
  • aes192-ctr
  • aes256-ctr
  • 3des-ctr
  • blowfish-ctr
  • twofish128-ctr
  • twofish192-ctr
  • twofish256-ctr
  • serpent128-ctr
  • serpent192-ctr
  • serpent256-ctr
  • idea-ctr
  • cast128-ctr
  • arcfour128
  • arcfour256
  • aes128-gcm
  • aes256-gcm
  • aes128-gcm@openssh.com
  • aes256-gcm@openssh.com
  • chacha20-poly1305
  • chacha20-poly1305@openssh.com

ForceCompression
boolean

Whether the SSH client should explicitly request compression.

If ForceCompression is False, compression will be used only if the server doesn't support algorithms without compression.

GSSAuthTypes
String

A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex.

GSSDelegateCreds
boolean

Switches credential delegation on or off.

GSSHostname
String

The GSS host name, in form of a FQDN (e.g. hostname.com), a principal name (e.g. 'host@hostname.com), or a cross-real ticket-granting ticket (e.g. krbtgt/test.com@example.com).

GSSLib
String

A path to the GSS-API library (DLL or SO).

GSSMechanisms
String

A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI.

GSSProtocols
String

A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM.

HandshakeTimeout
int

Specifies the maximal time for the SSH handshake to proceed, in seconds. If the handshake is not completed within this period, the session is aborted.

KexAlgorithms
String

A list of key exchange algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all key exchange algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of key exchange algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported kex algorithms is provided below:

  • diffie-hellman-group-exchange-sha1
  • diffie-hellman-group1-sha1
  • diffie-hellman-group14-sha1
  • diffie-hellman-group-exchange-sha256
  • rsa1024-sha1
  • rsa2048-sha256
  • ecdh-sha2-nistp256
  • ecdh-sha2-nistp384
  • ecdh-sha2-nistp521
  • ecdh-sha2-nistk163
  • ecdh-sha2-nistp192
  • ecdh-sha2-nistp224
  • ecdh-sha2-nistk233
  • ecdh-sha2-nistb233
  • ecdh-sha2-nistk283
  • ecdh-sha2-nistk409
  • ecdh-sha2-nistb409
  • ecdh-sha2-nistt571
  • ecdh-sha2-curve25519
  • curve25519-sha256@libssh.org
  • curve448-sha512@libssh.org

MacAlgorithms
String

A list of MAC (for message authentication code) algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all MAC algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of MAC algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported MAC algorithms is provided below:

  • hmac-sha1
  • hmac-sha1-96
  • hmac-md5
  • hmac-md5-96
  • none
  • hmac-ripemd160
  • hmac-ripemd
  • hmac-ripemd160@openssh.com
  • hmac-sha256@ssh.com
  • hmac-sha256-96@ssh.com
  • umac-32@openssh.com
  • umac-64@openssh.com
  • umac-96@openssh.com
  • umac-128@openssh.com
  • hmac-sha2-256
  • hmac-sha2-512
  • aes128-gcm
  • aes256-gcm
  • chacha20-poly1305@openssh.com
  • hmac-sha2-256-etm@openssh.com
  • hmac-sha2-512-etm@openssh.com

MaxSSHPacketSize
int

Specifies the maximum length of one SSH packet in bytes.

MinWindowSize
int

Specifies the minimal internal window size. When the minimal window size is reached, the 'window extension' request is sent to the server. This request notifies the server that the window was extended, and it can send more data.

ObfuscateHandshake
boolean

Enables or disables handshake obfuscation.

ObfuscationPassword
String

Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.

PublicKeyAlgorithms
String

A list of public key algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all public key algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of public key algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported public key algorithms is provided below:

  • ssh-dss
  • ssh-rsa
  • x509v3-sign-rsa
  • x509v3-sign-dss
  • spki-sign-rsa,
  • spki-sign-dss
  • pgp-sign-rsa
  • pgp-sign-dss
  • ecdsa-sha2-nistp256
  • ecdsa-sha2-nistp384
  • ecdsa-sha2-nistp521
  • ecdsa-sha2-nistk163
  • ecdsa-sha2-nistp192
  • ecdsa-sha2-nistp224
  • ecdsa-sha2-nistk233
  • ecdsa-sha2-nistb233
  • ecdsa-sha2-nistk283
  • ecdsa-sha2-nistk409
  • ecdsa-sha2-nistb409
  • ecdsa-sha2-nistt571,
  • ecdsa-sha2-curve25519
  • x509v3-ssh-rsa
  • x509v3-ssh-dss
  • x509v3-rsa2048-sha256
  • x509v3-ecdsa-sha2-nistp256
  • x509v3-ecdsa-sha2-nistp384
  • x509v3-ecdsa-sha2-nistp521
  • x509v3-ecdsa-sha2-nistk163
  • x509v3-ecdsa-sha2-nistp192
  • x509v3-ecdsa-sha2-nistp224
  • x509v3-ecdsa-sha2-nistk233
  • x509v3-ecdsa-sha2-nistb233
  • x509v3-ecdsa-sha2-nistk283
  • x509v3-ecdsa-sha2-nistk409
  • x509v3-ecdsa-sha2-nistb409
  • x509v3-ecdsa-sha2-nistt571
  • x509v3-ecdsa-sha2-curve25519
  • ssh-ed25519
  • ssh-ed448

RequestPasswordChange
boolean

Whether to request a password change when connecting.

SoftwareName
String

The name to be used by the component to identify itself.

TrustAllKeys
boolean

Enables or disables explicit trust to all server keys. Use with care.

UseAuthAgent
boolean

Enables or disables the use of external key agent, such as Putty key agent.

Versions
int

Specifies enabled SSH protocol versions (1 or 2).

Constructors

public SSHSettings();

Creates a new object with default settings.

UserAccount Type

A container for user account information.

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

Fields

AssociatedData
byte[]

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

BasePath
String

Base path for this user in the server's file system.

Cert
byte[]

Contains the user's certificate.

Data
String

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

HashAlgorithm
String

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

SB_MAC_ALGORITHM_HMAC_SHA1SHA1
SB_MAC_ALGORITHM_HMAC_SHA256SHA256
SB_MAC_ALGORITHM_HMAC_SHA512SHA512

IncomingSpeedLimit
int

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

OtpAlgorithm
int

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

oaHmac0
oaTime1

OtpValue
int

The user's time interval (TOTP) or Counter (HOTP).

OutgoingSpeedLimit
int

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

Password
String

The user's authentication password.

PasswordLen
int

Specifies the length of the user's OTP password.

SharedSecret
byte[]

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

SSHKey
byte[]

Contains the user's SSH key.

Username
String

The registered name (login) of the user.

Constructors

public UserAccount();

Creates a new UserAccount object.

Configuration Settings (Sftpserver Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SFTPServer Configuration Settings

CustomDHGroupIndex:   Sets a specific Diffie-Hellman group index to enforce.

Use this property to specify a specific DH group index to enforce for key exchange. The value of -1 enables automatic group selection, and any value between 0 and 227 specifies a particular DH group supported by SecureBlackbox. This is largely a debug setting, use it with extreme care.

DualStack:   Allows the use of ip4 and ip6 simultaneously.

This setting specifies a socket can use ip4 and ip6 simultaneously.

MaxDHGroupSize:   Sets the maximal Diffie-Hellman group size.

This property specifies the maximal DH group size, in bits. The larger the group size, the strong the key, however, longer groups put extra burden on the computational resources. SecureBlackbox supports groups between 1024 and 8192 bits. The default value is 8192.

MinDHGroupSize:   Sets the minimal Diffie-Hellman group size.

This property specifies the minimal DH group size, in bits. The larger the group size, the strong the key, however, longer groups put extra burden on the computational resources. SecureBlackbox supports groups between 1024 and 8192 bits. The default value is 2048.

NotifyOnFileOperations:   Enables low-level file operation notifications.

If set, the component will report low-level file operations, such as Open, Read, Write, and Close, via its Notification event.

Base Configuration Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching (supported for HTTPClient, RESTClient and SOAPClient only)
globalGlobal caching

Cookies:   Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (Sftpserver Class)

SFTPServer Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
31457281   Unsupported file operation (SB_ERROR_SFTP_UNSUPPORTED_FILEOPERATION)

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2022 Java Edition - Version 22.0 [Build 8174]