ActiveDirectory Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.IPWorksAuth.ActiveDirectory

Remarks

The ActiveDirectory component 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 component will attempt to authenticate the user with the Active Directory server. The component will communicate with the ADHost to obtain a service ticket and populate AuthToken. The following properties are required when calling this method:

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 component with short descriptions. Click on the links for further details.

ADHostThe domain name or IP address of the Active Directory server.
ADPortThe port for the Active Directory server.
AuthMechanismThe authentication mechanism to be used when connecting to the Active Directory server.
AuthTokenThe authentication token.
PasswordThe user's password.
SPNThe Service Principal Name (SPN).
TimeoutThe timeout for the component.
UserThe name and domain of the user to authenticate.

Method List

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

AuthenticateAuthenticates the user.
ChangePasswordChanges the password for the specified user.
ConfigSets or retrieves a configuration setting.
DoEventsThis method processes events from the internal message queue.
InterruptThis method interrupts the current method.
ListComputersLists all computers in the directory.
ListGroupMembersList all members of a group.
ListGroupsList all groups in the directory.
ListUserGroupsLists all groups a user is a part of.
ResetResets the component properties to their default values.

Event List

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

ComputerListFired for each computer entry returned.
ErrorFired when information is available about errors during data delivery.
GroupListFired for each group entry returned.
LogFires once for each log message.
PITrailTraces the messages sent to the server, and the respective replies.
UserListFired once for each user entry returned.

Config Settings

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

CredentialsCacheFileThe credentials cache file.
EncodeAuthTokenWhether to Base64 encode the AuthToken.
EncryptionTypesThe encryption types used during authentication.
IntermediateTGSCountSpecifies the number of intermediate realms.
IntermediateTGSKDCHosts[i]Specifies the domain name or IP address of the Key Distribution Center (KDC) associated with the TGS realm at the specified index.
IntermediateTGSKDCPorts[i]Specifies the port of the Key Distribution Center (KDC) associated with TGS KDC host at the specified index.
IntermediateTGSRealms[i]Specifies an intermediate domain or realm facilitating cross-realm authentication at the specified index.
Krb5ConfigThe clients Kerberos configuration file.
LogKerberosPacketsWhether to include the raw Kerberos packets in PITrail output.
LogLevelThe level of detail that is logged.
TGSKDCHostSpecifies the domain name or IP address of the Key Distribution Center (KDC) associated with the TGS realm.
TGSKDCPortSpecifies the port of the Key Distribution Center (KDC) associated with TGS KDC host.
TGSRealmSpecifies the domain or realm associated with the SPN (or service).
UsePlatformKerberosAPIWhether to use the platform Kerberos API.
UseTCPWhether TCP is used when establishing the connection.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (TCPClient only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableWhether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
UseFIPSCompliantAPITells the component whether or not to use FIPS certified APIs.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

ADHost Property (ActiveDirectory Component)

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

Syntax

public string ADHost { get; set; }

Public Property ADHost As String

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 Component)

The port for the Active Directory server.

Syntax

public int ADPort { get; set; }

Public Property ADPort As Integer

Default Value

88

Remarks

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

AuthMechanism Property (ActiveDirectory Component)

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

Syntax

public ActiveDirectoryAuthMechanisms AuthMechanism { get; set; }

enum ActiveDirectoryAuthMechanisms {
  aamSimple,
  aamDigestMD5,
  aamNegotiate,
  aamKerberos
}

Public Property AuthMechanism As ActivedirectoryAuthMechanisms

Enum ActiveDirectoryAuthMechanisms
  aamSimple
  aamDigestMD5
  aamNegotiate
  aamKerberos
End Enum

Default Value

6

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 Component)

The authentication token.

Syntax

public string AuthToken { get; }
public byte[] AuthTokenB { get; }

Public ReadOnly Property AuthToken As String
Public ReadOnly Property AuthTokenB As Byte()

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 Component)

The user's password.

Syntax

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

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

SPN Property (ActiveDirectory Component)

The Service Principal Name (SPN).

Syntax

public string SPN { get; set; }

Public Property SPN As String

Default Value

""

Remarks

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

Timeout Property (ActiveDirectory Component)

The timeout for the component.

Syntax

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

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 component will wait for the operation to complete before returning control.

The component 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 component throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, 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 Component)

The name and domain of the user to authenticate.

Syntax

public string User { get; set; }

Public Property User As String

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 Component)

Authenticates the user.

Syntax

public void Authenticate();

Async Version
public async Task Authenticate();
public async Task Authenticate(CancellationToken cancellationToken);

Public Sub Authenticate()

Async Version
Public Sub Authenticate() As Task
Public Sub Authenticate(cancellationToken As CancellationToken) As Task

Remarks

This method authenticates the User.

Authentication

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

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 Component)

Changes the password for the specified user.

Syntax

public void ChangePassword(string user, string oldPassword, string newPassword);

Async Version
public async Task ChangePassword(string user, string oldPassword, string newPassword);
public async Task ChangePassword(string user, string oldPassword, string newPassword, CancellationToken cancellationToken);

Public Sub ChangePassword(ByVal user As String, ByVal oldPassword As String, ByVal newPassword As String)

Async Version
Public Sub ChangePassword(ByVal user As String, ByVal oldPassword As String, ByVal newPassword As String) As Task
Public Sub ChangePassword(ByVal user As String, ByVal oldPassword As String, ByVal newPassword As String, cancellationToken As CancellationToken) As Task

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 password 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 Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

This method processes events from the internal message queue.

Syntax

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

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

Interrupt Method (ActiveDirectory Component)

This method interrupts the current method.

Syntax

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

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

ListComputers Method (ActiveDirectory Component)

Lists all computers in the directory.

Syntax

public void ListComputers();

Async Version
public async Task ListComputers();
public async Task ListComputers(CancellationToken cancellationToken);

Public Sub ListComputers()

Async Version
Public Sub ListComputers() As Task
Public Sub ListComputers(cancellationToken As CancellationToken) As Task

Remarks

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

ListGroupMembers Method (ActiveDirectory Component)

List all members of a group.

Syntax

public void ListGroupMembers(string group);

Async Version
public async Task ListGroupMembers(string group);
public async Task ListGroupMembers(string group, CancellationToken cancellationToken);

Public Sub ListGroupMembers(ByVal group As String)

Async Version
Public Sub ListGroupMembers(ByVal group As String) As Task
Public Sub ListGroupMembers(ByVal group As String, cancellationToken As CancellationToken) As Task

Remarks

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

ListGroups Method (ActiveDirectory Component)

List all groups in the directory.

Syntax

public void ListGroups();

Async Version
public async Task ListGroups();
public async Task ListGroups(CancellationToken cancellationToken);

Public Sub ListGroups()

Async Version
Public Sub ListGroups() As Task
Public Sub ListGroups(cancellationToken As CancellationToken) As Task

Remarks

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

ListUserGroups Method (ActiveDirectory Component)

Lists all groups a user is a part of.

Syntax

public void ListUserGroups(string user);

Async Version
public async Task ListUserGroups(string user);
public async Task ListUserGroups(string user, CancellationToken cancellationToken);

Public Sub ListUserGroups(ByVal user As String)

Async Version
Public Sub ListUserGroups(ByVal user As String) As Task
Public Sub ListUserGroups(ByVal user As String, cancellationToken As CancellationToken) As Task

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 Component)

Resets the component properties to their default values.

Syntax

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method resets the properties to their default values.

ComputerList Event (ActiveDirectory Component)

Fired for each computer entry returned.

Syntax

public event OnComputerListHandler OnComputerList;

public delegate void OnComputerListHandler(object sender, ActiveDirectoryComputerListEventArgs e);

public class ActiveDirectoryComputerListEventArgs : EventArgs {
  public string name { get; }
  public string operatingSystem { get; }
  public string lastLogon { get; }
  public int logonCount { get; }
  public string dn { get; }
}

Public Event OnComputerList As OnComputerListHandler

Public Delegate Sub OnComputerListHandler(sender As Object, e As ActiveDirectoryComputerListEventArgs)

Public Class ActiveDirectoryComputerListEventArgs Inherits EventArgs
  Public ReadOnly Property name As String
  Public ReadOnly Property operatingSystem As String
  Public ReadOnly Property lastLogon As String
  Public ReadOnly Property logonCount As Integer
  Public ReadOnly Property dn As String
End Class

Remarks

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

Error Event (ActiveDirectory Component)

Fired when information is available about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, ActiveDirectoryErrorEventArgs e);

public class ActiveDirectoryErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As ActiveDirectoryErrorEventArgs)

Public Class ActiveDirectoryErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component 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 Component)

Fired for each group entry returned.

Syntax

public event OnGroupListHandler OnGroupList;

public delegate void OnGroupListHandler(object sender, ActiveDirectoryGroupListEventArgs e);

public class ActiveDirectoryGroupListEventArgs : EventArgs {
  public string name { get; }
  public string description { get; }
  public string dn { get; }
}

Public Event OnGroupList As OnGroupListHandler

Public Delegate Sub OnGroupListHandler(sender As Object, e As ActiveDirectoryGroupListEventArgs)

Public Class ActiveDirectoryGroupListEventArgs Inherits EventArgs
  Public ReadOnly Property name As String
  Public ReadOnly Property description As String
  Public ReadOnly Property dn As String
End Class

Remarks

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

Log Event (ActiveDirectory Component)

Fires once for each log message.

Syntax

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, ActiveDirectoryLogEventArgs e);

public class ActiveDirectoryLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As ActiveDirectoryLogEventArgs)

Public Class ActiveDirectoryLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

This event fires once for each log message generated by the component. 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 Component)

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

Syntax

public event OnPITrailHandler OnPITrail;

public delegate void OnPITrailHandler(object sender, ActiveDirectoryPITrailEventArgs e);

public class ActiveDirectoryPITrailEventArgs : EventArgs {
  public int Direction { get; }
  public string Message { get; }
}

Public Event OnPITrail As OnPITrailHandler

Public Delegate Sub OnPITrailHandler(sender As Object, e As ActiveDirectoryPITrailEventArgs)

Public Class ActiveDirectoryPITrailEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property Message As String
End Class

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 component code).

UserList Event (ActiveDirectory Component)

Fired once for each user entry returned.

Syntax

public event OnUserListHandler OnUserList;

public delegate void OnUserListHandler(object sender, ActiveDirectoryUserListEventArgs e);

public class ActiveDirectoryUserListEventArgs : EventArgs {
  public string name { get; }
  public string description { get; }
  public string lastLogon { get; }
  public string memberOf { get; }
  public string dn { get; }
}

Public Event OnUserList As OnUserListHandler

Public Delegate Sub OnUserListHandler(sender As Object, e As ActiveDirectoryUserListEventArgs)

Public Class ActiveDirectoryUserListEventArgs Inherits EventArgs
  Public ReadOnly Property name As String
  Public ReadOnly Property description As String
  Public ReadOnly Property lastLogon As String
  Public ReadOnly Property memberOf As String
  Public ReadOnly Property dn As String
End Class

Remarks

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

Config Settings (ActiveDirectory Component)

The component 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 component, 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. For example: C:\\krbccdir\\tkt.txt

Alternatively, this setting can specify the path to a directory containing a collection of credential cache files. When a directory is specified, the path must be prefixed with DIR:. For example: DIR:C:\\krbccdir\\

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".

IntermediateTGSCount:   Specifies the number of intermediate realms.

This configuration is used to specify the number of intermediate realms, or the number of realms facilitating cross-realm authentication, between a user's realm and a service's realm. This is used in conjunction with IntermediateTGSRealms[i], IntermediateTGSKDCHosts[i], and IntermediateTGSKDCPorts[i]. For example:

component.Config("IntermediateTGSCount=2"); component.Config("IntermediateTGSRealms[0]=example2.com"); component.Config("IntermediateTGSKDCHosts[0]=kdc.example2.com"); component.Config("IntermediateTGSKDCPorts[0]=88"); // default component.Config("IntermediateTGSRealms[1]=example4.com"); component.Config("IntermediateTGSKDCHosts[1]=kdc.example4.com"); component.Config("IntermediateTGSKDCPorts[1]=88"); // default

IntermediateTGSKDCHosts[i]:   Specifies the domain name or IP address of the Key Distribution Center (KDC) associated with the TGS realm at the specified index.

This configuration is used to specify the domain name or IP address of the Key Distribution Center (KDC) associated with the IntermediateTGSRealms at the specified index. See IntermediateTGSCount for details.

IntermediateTGSKDCPorts[i]:   Specifies the port of the Key Distribution Center (KDC) associated with TGS KDC host at the specified index.

This configuration is used to specify the port of the Key Distribution Center (KDC) associated with IntermediateTGSKDCHosts at the specified index. By default, this value will be set to 88 when setting IntermediateTGSCount. See IntermediateTGSCount for details.

IntermediateTGSRealms[i]:   Specifies an intermediate domain or realm facilitating cross-realm authentication at the specified index.

This configuration is used to specify an intermediate domain or realm facilitating cross-realm authentication at the specified index. See IntermediateTGSCount for details.

Krb5Config:   The clients Kerberos configuration file.

This setting specifies the path to the clients Kerberos configuration file (e.g., C:\path\to\krb5.conf).

When specified, the component will parse the default realm present in the configuration file (under the "libdefaults" section), along with all listed realms and KDCs (under the "realms" section). The default realm will be used during authentication, unless a domain/realm is specified in the User property. Note that in this case, the User property may be set to only a username to allow the component to use the appropriate default realm.

Assuming a default realm is found, the primary KDC associated with this realm will be used during authentication, assuming KDCHost is not specified. Additional KDCs will be used only if authentication with the primary KDC fails. Note if no KDCs are specified for a realm and "dns_lookup_kdc" is set to true in the configuration file, the component will perform a DNS query in an attempt to resolve the KDCs host name and port.

All additional realms will be stored as intermediate realms in the case cross-realm authentication is needed.

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).

TGSKDCHost:   Specifies the domain name or IP address of the Key Distribution Center (KDC) associated with the TGS realm.

This configuration is used to specify the domain name or IP address of the Key Distribution Center (KDC) associated with the TGSRealm.

TGSKDCPort:   Specifies the port of the Key Distribution Center (KDC) associated with TGS KDC host.

This configuration is used to specify the port of the Key Distribution Center (KDC) associated with TGSKDCHost.

TGSRealm:   Specifies the domain or realm associated with the SPN (or service).

This configuration is used to specify the domain or realm associated with the SPN (or service). This should be set along with TGSKDCHost and TGSKDCPort.

UsePlatformKerberosAPI:   Whether to use the platform Kerberos API.

This setting determines if the platform's Kerberos API is used. By default the component 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 configuration 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. 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 component will use Timeout for establishing a connection and transmitting/receiving data.

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

This configuration setting is provided for use by components 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 components 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 component 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 component throws an exception.

Note: This setting is provided for use by components 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 components that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

Possible values are as follows:

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

Note: This setting is provided for use by components 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 component throws an exception.

Note: This setting is provided for use by components 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 component 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 multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component 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 multihomed hosts (machines with more than one IP interface).

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

This configuration setting must be set before a connection is attempted. It instructs the component 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 configuration setting is useful when trying to connect to services that require a trusted port on 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 set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component 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 as follows:

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 that 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 User Datagram Protocol (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 Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

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

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. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

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

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 component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

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

LicenseInfo:   Information about the current license.

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

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitiveData:   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 components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

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

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

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all components 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: This setting is applicable only on Windows.

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 component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

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

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

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

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

Trappable Errors (ActiveDirectory Component)

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 component is Active.
107   You cannot change the LocalHost at this time. A connection is in progress.
109   The component must be Active for this operation.
112   You cannot change MaxPacketSize while the component is Active.
113   You cannot change ShareLocalPort option while the component is Active.
114   You cannot change RemoteHost when UseConnection is set and the component Active.
115   You cannot change RemotePort when UseConnection is set and the component is Active.
116   RemotePort cannot be zero when UseConnection is set. Please specify a valid service port number.
117   You cannot change UseConnection while the component is Active.
118   Message cannot 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 nonsocket.
10039   [10039] Destination address required.
10040   [10040] Message is too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol is not supported.
10044   [10044] Socket type is not supported.
10045   [10045] Operation is not supported on socket.
10046   [10046] Protocol family is not supported.
10047   [10047] Address family is not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Cannot 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] Cannot send after socket shutdown.
10059   [10059] Too many references, cannot splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name is too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory is 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 is not loaded yet.
11001   [11001] Host not found.
11002   [11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).