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.
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 | This property includes the timeout for the component. |
User | The 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.
Authenticate | Authenticates the user. |
ChangePassword | Changes the password for the specified user. |
Config | Sets or retrieves a configuration setting. |
DoEvents | This method processes events from the internal message queue. |
Interrupt | This method interrupts 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 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.
ComputerList | Fired for each computer entry returned. |
Error | Fired when information is available 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 component 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. |
IntermediateTGSCount | Specifies 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. |
Krb5Config | The clients Kerberos configuration file. |
LogKerberosPackets | Whether to include the raw Kerberos packets in PITrail output. |
LogLevel | The level of detail that is logged. |
TGSKDCHost | Specifies the domain name or IP address of the Key Distribution Center (KDC) associated with the TGS realm. |
TGSKDCPort | Specifies the port of the Key Distribution Center (KDC) associated with TGS KDC host. |
TGSRealm | Specifies the domain or realm associated with the SPN (or service). |
UsePlatformKerberosAPI | Whether to use the platform Kerberos API. |
UseTCP | Whether TCP is used when establishing the connection. |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component 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 component 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 component 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 | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether 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
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
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
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
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
Default Value
""
Remarks
This property specifies the Service Principal Name (SPN). This must be set before calling Authenticate.
Timeout Property (ActiveDirectory Component)
This property includes the timeout for the component.
Syntax
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
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
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
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\\
- rc4-hmac
- des-cbc-md5
- aes128-cts-hmac-sha1-96
The default value is "des-cbc-md5,rc4-hmac,aes128-cts-hmac-sha1-96".
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
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.
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).
Note: This functionality is only available on Windows.
TCPClient Config Settings
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.
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.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
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 components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
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.
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).
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.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
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.
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
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.
- 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.
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.
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.
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). |