ActiveDirectory Class

Properties Methods Events Config Settings Errors

The ActiveDirectory class can be used to authenticate users against Active Directory using Kerberos 5.0.

Syntax

ipworksauth.Activedirectory

Remarks

The ActiveDirectory class authenticates users against Active Directory. Authentication is performed using the Kerberos protocol defined in RFC 1510 and RFC 4120.

Authentication

When Authenticate is called the class will attempt to authenticate the user with the Active Directory server. The class will communicate with the ADHost to obtain a service ticket and populate AuthToken. The following properties are required when calling this method:

SPN (required)
User (required)
Password (required)
ADHost (required)

A typical sequence of messages would be:

KRB_AS_REQ -> KDC
KRB_AS_REP <- KDC
KRB_TGS_REQ -> KDC
KRB_TGS_REP <- KDC
AuthToken is populated with the constructed KRB_AP_REP message.

Communication with the ADHost can be seen through the PITrail event.

Property List

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


ADHost	The domain name or IP address of the Active Directory server.
ADPort	The port for the Active Directory server.
AuthMechanism	The authentication mechanism to be used when connecting to the Active Directory server.
AuthToken	The authentication token.
Password	The user's password.
SPN	The Service Principal Name (SPN).
Timeout	A timeout for the class.
User	The name and domain of the user to authenticate.

Method List

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


Authenticate	Authenticates the user.
ChangePassword	Changes the password for the specified user.
Config	Sets or retrieves a configuration setting.
DoEvents	Processes events from the internal message queue.
Interrupt	Interrupt the current method.
ListComputers	Lists all computers in the directory.
ListGroupMembers	List all members of a group.
ListGroups	List all groups in the directory.
ListUserGroups	Lists all groups a user is a part of.
Reset	Resets the class properties to their default values.

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.


ComputerList	Fired for each computer entry returned.
Error	Information about errors during data delivery.
GroupList	Fired for each group entry returned.
Log	Fires once for each log message.
PITrail	Traces the messages sent to the server, and the respective replies.
UserList	Fired once for each user entry returned.

Config Settings

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


CredentialsCacheFile	The credentials cache file.
EncodeAuthToken	Whether to Base64 encode the AuthToken.
EncryptionTypes	The encryption types used during authentication.
LogKerberosPackets	Whether to include the raw Kerberos packets in PITrail output.
LogLevel	The level of detail that is logged.
UsePlatformKerberosAPI	Whether to use the platform Kerberos API.
UseTCP	Whether TCP is used when establishing the connection.
CloseStreamAfterTransfer	If true, the class will close the upload or download stream after the transfer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the class binds to a SOCKS firewall as a server (TCPClient only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
UseNTLMv2	Whether to use NTLM V2.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
GUIAvailable	Tells the class whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseDaemonThreads	Whether threads created by the class are daemon threads.
UseFIPSCompliantAPI	Tells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

ADHost Property (ActiveDirectory Class)

The domain name or IP address of the Active Directory server.

Syntax


public String getADHost();


public void setADHost(String ADHost);

Default Value

Remarks

This property specifies the IP address (IP number in dotted internet format) or Domain Name of the Active Directory server.

If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

ADPort Property (ActiveDirectory Class)

The port for the Active Directory server.

Syntax


public int getADPort();


public void setADPort(int ADPort);

Default Value

Remarks

This property specifies the port for the Active Directory server. The default value is 88.

AuthMechanism Property (ActiveDirectory Class)

The authentication mechanism to be used when connecting to the Active Directory server.

Syntax


public int getAuthMechanism();


public void setAuthMechanism(int authMechanism);


Enumerated values:
  public final static int aamSimple = 0;
  public final static int aamDigestMD5 = 1;
  public final static int aamNegotiate = 2;
  public final static int aamKerberos = 6;

Default Value

Remarks

This property specifies the authentication mechanism used. Possible values are:


0 (aamSimple)	Plaintext authentication
1 (aamDigestMD5)	DIGEST-MD5 authentication
2 (aamNegotiate)	NTLM/Negotiate authentication
6 (aamKerbers - default)	Kerberos authentication

AuthToken Property (ActiveDirectory Class)

The authentication token.

Syntax


public byte[] getAuthToken();

Default Value

Remarks

This property holds the authentication token.

This property will be populated after calling Authenticate. This may be used in by another entity to authenticate to the service. For instance this may be used in HTTP to authenticate to a web service.

The content of this property is a KRB_AP_REQ message. This is sometimes referred to as an "Authentication Header". It is comprised of the service ticket that was obtained from the TGS and an encrypted authenticator.

This property is read-only.

Password Property (ActiveDirectory Class)

The user's password.

Syntax


public String getPassword();


public void setPassword(String password);

Default Value

Remarks

This property specifies the user's password. This must be set before calling Authenticate.

SPN Property (ActiveDirectory Class)

The Service Principal Name (SPN).

Syntax


public String getSPN();


public void setSPN(String SPN);

Default Value

Remarks

This property specifies the Service Principal Name (SPN). This must be set before calling Authenticate.

Timeout Property (ActiveDirectory Class)

A timeout for the class.

Syntax


public int getTimeout();


public void setTimeout(int timeout);

Default Value

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

User Property (ActiveDirectory Class)

The name and domain of the user to authenticate.

Syntax


public String getUser();


public void setUser(String user);

Default Value

Remarks

This property specifies the name and realm/domain of the user. The value specified must be in one of the following formats:

user@domain
domain/user

Authenticate Method (Activedirectory Class)

Authenticates the user.

Syntax

public void authenticate();

Remarks

This method authenticates the User.

Authentication

SPN (required)
User (required)
Password (required)
ADHost (required)

A typical sequence of messages would be:

KRB_AS_REQ -> KDC
KRB_AS_REP <- KDC
KRB_TGS_REQ -> KDC
KRB_TGS_REP <- KDC
AuthToken is populated with the constructed KRB_AP_REP message.

Communication with the ADHost can be seen through the PITrail event.

ChangePassword Method (Activedirectory Class)

Changes the password for the specified user.

Syntax

public void changePassword(String user, String oldPassword, String newPassword);

Remarks

This method changes the password for the specified user.

The User parameter is the name of the user for which the password will be changed. OldPassword specifies the current paswsword and NewPassword specifies the new password.

Note: This operation can only be performed over the SSL Port. Set ADPort to the SSL port of the server (typically 636) before calling this method.

Note: If the user is an administrator the old password is not required.

Config Method (Activedirectory 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.

DoEvents Method (Activedirectory Class)

Processes events from the internal message queue.

Syntax

public void doEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (Activedirectory Class)

Interrupt the current method.

Syntax

public void interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListComputers Method (Activedirectory Class)

Lists all computers in the directory.

Syntax

public void listComputers();

Remarks

This method lists all computers in the directory. The ComputerList event will be fired once for each computer returned.

ListGroupMembers Method (Activedirectory Class)

List all members of a group.

Syntax

public void listGroupMembers(String group);

Remarks

This method lists all members of the specified group. The UserList event will be fired once for each member returned.

ListGroups Method (Activedirectory Class)

List all groups in the directory.

Syntax

public void listGroups();

Remarks

This method lists all groups in the directory. The GroupList event will be fired once for each group returned.

ListUserGroups Method (Activedirectory Class)

Lists all groups a user is a part of.

Syntax

public void listUserGroups(String user);

Remarks

This method lists all groups that the user specified by user is a part of. The GroupList event will fire once for each group the user is a part of.

Reset Method (Activedirectory Class)

Resets the class properties to their default values.

Syntax

public void reset();

Remarks

This method resets the properties to their default values.

ComputerList Event (Activedirectory Class)

Fired for each computer entry returned.

Syntax

public class DefaultActivedirectoryEventListener implements ActivedirectoryEventListener {
  ...
  public void computerList(ActivedirectoryComputerListEvent e) {}
  ...
}

public class ActivedirectoryComputerListEvent {
  public String name;
  public String operatingSystem;
  public String lastLogon;
  public int logonCount;
  public String dn;
}

Remarks

This event is fired once for each computer returned when the ListComputers method is called.

Error Event (Activedirectory Class)

Information about errors during data delivery.

Syntax

public class DefaultActivedirectoryEventListener implements ActivedirectoryEventListener {
  ...
  public void error(ActivedirectoryErrorEvent e) {}
  ...
}

public class ActivedirectoryErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

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

GroupList Event (Activedirectory Class)

Fired for each group entry returned.

Syntax

public class DefaultActivedirectoryEventListener implements ActivedirectoryEventListener {
  ...
  public void groupList(ActivedirectoryGroupListEvent e) {}
  ...
}

public class ActivedirectoryGroupListEvent {
  public String name;
  public String description;
  public String dn;
}

Remarks

This event is fired once for each group entry returned when either of the ListGroups or ListUserGroups methods are called.

Log Event (Activedirectory Class)

Fires once for each log message.

Syntax

public class DefaultActivedirectoryEventListener implements ActivedirectoryEventListener {
  ...
  public void log(ActivedirectoryLogEvent e) {}
  ...
}

public class ActivedirectoryLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of the Message. Possible values are:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

LogType identifies the type of log entry. Possible values are:

Info
Verbose
Debug

PITrail Event (Activedirectory Class)

Traces the messages sent to the server, and the respective replies.

Syntax

public class DefaultActivedirectoryEventListener implements ActivedirectoryEventListener {
  ...
  public void PITrail(ActivedirectoryPITrailEvent e) {}
  ...
}

public class ActivedirectoryPITrailEvent {
  public int direction;
  public String message;
}

Remarks

The PITrail event is useful for debugging purposes. It shows all the interaction between the client and the server. To include the raw packets set LogKerberosPackets to True.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:


0 (Client)	The Message originates from the client.
1 (Server)	The Message originates from the server.
2 (Info)	The Message is an informative message originating from the client software (the class code).

UserList Event (Activedirectory Class)

Fired once for each user entry returned.

Syntax

public class DefaultActivedirectoryEventListener implements ActivedirectoryEventListener {
  ...
  public void userList(ActivedirectoryUserListEvent e) {}
  ...
}

public class ActivedirectoryUserListEvent {
  public String name;
  public String description;
  public String lastLogon;
  public String memberOf;
  public String dn;
}

Remarks

This event is fired once for each user entry returned when the ListGroupMembers method is called.

Config Settings (Activedirectory 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.

ActiveDirectory Config Settings

CredentialsCacheFile: The credentials cache file.

This setting specifies the path to a credentials cache file. If specified, the credentials are read from this file.

EncodeAuthToken: Whether to Base64 encode the AuthToken.

This setting specifies whether AuthToken is Base64 encoded after calling Authenticate. The default value is False.

EncryptionTypes: The encryption types used during authentication.

This setting specifies a comma separated list of encryption types used during authentication. Possible values are:

rc4-hmac
des-cbc-md5
aes128-cts-hmac-sha1-96

The default value is "des-cbc-md5,rc4-hmac,aes128-cts-hmac-sha1-96".

LogKerberosPackets: Whether to include the raw Kerberos packets in PITrail output.

This settings specifies whether to include the raw Kerberos packet in the Message parameter of the PITrail event. When True the Kerberos packet will be encoded and present in the Message parameter. The default value is False. This may be enabled for troubleshooting purposes.

LogLevel: The level of detail that is logged.

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


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

UsePlatformKerberosAPI: Whether to use the platform Kerberos API.

This setting determines if the platform's Kerberos API is used. By default the class does not rely on any platform APIs to perform Kerberos authentication. Use of the platform API may be enabled by setting this to True. The default value is False.

Note: This functionality is only available on Windows.

UseTCP: Whether TCP is used when establishing the connection.

This config specifies whether TCP is used as the transport protocol when establishing the connection. By default this config is False and UDP will be used.

TCPClient Config Settings

CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer.

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

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallListener: If true, the component binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

The appropriate values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class throws an exception.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

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

By default, this config is set to false.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:


0	IPv4 Only
1	IPv6 Only
2	IPv6 with IPv4 fallback

UseNTLMv2: Whether to use NTLM V2.

When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

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

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

OutBufferSize: The size in bytes of the outgoing queue of the socket.

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

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

Base Config Settings

BuildInfo: Information about the product's build.

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

GUIAvailable: Whether or not a message loop is available for processing events.

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

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

LicenseInfo: Information about the current license.

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

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseDaemonThreads: Whether threads created by the class are daemon threads.

If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

UseFIPSCompliantAPI: Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

The Java edition requires installation of the FIPS certified Bouncy Castle library regardless of the target operating system. This can be downloaded from https://www.bouncycastle.org/fips-java/. Only the "Provider" library is needed. The jar file should then be installed in a JRE search path.

In the application where the component will be used the following classes must be imported:

import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;

The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode:

System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider());

When UseFIPSCompliantAPI is true, SSL enabled classes can optionally be configured to use the TLS Bouncy Castle library. When SSLProvider is set to sslpAutomatic (default) or sslpInternal an internal TLS implementation is used, but all cryptographic operations are offloaded to the BCFIPS provider in order to achieve FIPS compliant operation. If SSLProvider is set to sslpPlatform the Bouncy Castle JSSE will be used in place of the internal TLS implementation.

To enable the use of the Bouncy Castle JSSE take the following steps in addition to the steps above. Both the Bouncy Castle FIPS provider and the Bouncy Castle JSSE must be configured to use the Bouncy Castle TLS library in FIPS mode. Obtain the Bouncy Castle TLS library from https://www.bouncycastle.org/fips-java/. The jar file should then be installed in a JRE search path.

In the application where the component will be used the following classes must be imported:

import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; //required to use BCJSSE when SSLProvider is set to sslpPlatform import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider;

The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode:

System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider()); //required to use BCJSSE when SSLProvider is set to sslpPlatform Security.addProvider(new BouncyCastleJsseProvider("fips:BCFIPS")); //optional - configure logging level of BCJSSE Logger.getLogger("org.bouncycastle.jsse").setLevel(java.util.logging.Level.OFF); //configure the class to use BCJSSE component.setSSLProvider(1); //platform component.config("UseFIPSCompliantAPI=true"); Note: TLS 1.3 support requires the Bouncy Castle TLS library version 1.0.14 or later.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (Activedirectory Class)

AD Errors


	950 Busy performing other action.
	951 Invalid username.
	952 Received error message. The error message contains the description.
	953 Message integrity check error.
	954 Unsupported encryption type.

UDP Errors


	104 UDP is already Active.
	106 You cannot change the LocalPort while the class is Active.
	107 You cannot change the LocalHost at this time. A connection is in progress.
	109 The class must be Active for this operation.
	112 Cannot change MaxPacketSize while the class is Active.
	113 Cannot change ShareLocalPort option while the class is Active.
	114 Cannot change RemoteHost when UseConnection is set and the class Active.
	115 Cannot change RemotePort when UseConnection is set and the class is Active.
	116 RemotePort can't be zero when UseConnection is set. Please specify a valid service port number.
	117 Cannot change UseConnection while the class is Active.
	118 Message can't be longer than MaxPacketSize.
	119 Message too short.
	434 Unable to convert string to selected CodePage

TCP/IP Errors


	10004 [10004] Interrupted system call.
	10009 [10009] Bad file number.
	10013 [10013] Access denied.
	10014 [10014] Bad address.
	10022 [10022] Invalid argument.
	10024 [10024] Too many open files.
	10035 [10035] Operation would block.
	10036 [10036] Operation now in progress.
	10037 [10037] Operation already in progress.
	10038 [10038] Socket operation on non-socket.
	10039 [10039] Destination address required.
	10040 [10040] Message too long.
	10041 [10041] Protocol wrong type for socket.
	10042 [10042] Bad protocol option.
	10043 [10043] Protocol not supported.
	10044 [10044] Socket type not supported.
	10045 [10045] Operation not supported on socket.
	10046 [10046] Protocol family not supported.
	10047 [10047] Address family not supported by protocol family.
	10048 [10048] Address already in use.
	10049 [10049] Can't assign requested address.
	10050 [10050] Network is down.
	10051 [10051] Network is unreachable.
	10052 [10052] Net dropped connection or reset.
	10053 [10053] Software caused connection abort.
	10054 [10054] Connection reset by peer.
	10055 [10055] No buffer space available.
	10056 [10056] Socket is already connected.
	10057 [10057] Socket is not connected.
	10058 [10058] Can't send after socket shutdown.
	10059 [10059] Too many references, can't splice.
	10060 [10060] Connection timed out.
	10061 [10061] Connection refused.
	10062 [10062] Too many levels of symbolic links.
	10063 [10063] File name too long.
	10064 [10064] Host is down.
	10065 [10065] No route to host.
	10066 [10066] Directory not empty
	10067 [10067] Too many processes.
	10068 [10068] Too many users.
	10069 [10069] Disc Quota Exceeded.
	10070 [10070] Stale NFS file handle.
	10071 [10071] Too many levels of remote in path.
	10091 [10091] Network subsystem is unavailable.
	10092 [10092] WINSOCK DLL Version out of range.
	10093 [10093] Winsock not loaded yet.
	11001 [11001] Host not found.
	11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004 [11004] Valid name, no data record (check DNS setup).