NTLM Class
Properties Methods Events Config Settings Errors
The NTLM class provides a simple API to create the required tokens for NTLM authentication.
Syntax
ipworksauth.Ntlm
Remarks
This class provides a simple API to create the required tokens for NTLM authentication.
The NTLM authentication process is a challenge-response scheme which consists of three messages. These three messages are the negotiation, challenge, and authentication. This class implements only the client side of NTLM and will create the negotiation and authentication tokens. The class does not transmit any data, it simply prepares the tokens for use in other transport protocols such as HTTP. The following steps describe how the component is used.
Create the Negotiate Token
To begin first set User and Password. The user value may contain domain information in the format "DOMAIN\User" or "user@domain".
Next call CreateNegotiateToken to populate NegotiateToken. This token may then be transmitted separately. For instance in HTTP
this would be sent in a request within the Authorization header:
HTTPHeader = "Authorization: NTLM " + NegotiateToken
Create the Auth Token
After sending the negotiate token over the chosen transport protocol, the server will respond with a challenge token. Set ChallengeToken to the token received from the server. For instance, in HTTP the server will respond with the challenge token in the WWW-Authenticate header:
WWW-Authenticate: NTLM <ChallengeToken>After setting User, Password, and ChallengeToken call CreateAuthToken. This will populate AuthToken with the created token. This token may then be transmitted separately. For instance in HTTP this would be sent in the request within the Authorization header:
HTTPHeader = "Authorization: NTLM " + AuthToken
Note: If the server requires EPA (Extended Protection for Authentication), then SSLServerCert must be set to the server's public certificate before calling CreateAuthToken.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AuthToken | The authentication token. |
ChallengeToken | The challenge token. |
NegotiateToken | The negotiate token. |
NTLMVersion | The NTLM version. |
Password | The user's password. |
SSLServerCert | The server's public certificate. |
User | The user. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
CreateAuthToken | Creates the authentication token. |
CreateNegotiateToken | Creates the negotiate token. |
Reset | Resets the class. |
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.
Error | Information about errors during data delivery. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
DecodeToken | Whether to Base64 encode the token. |
EncodeToken | Whether to Base64 encode the token. |
UsePlatformNTLMAPI | Whether to use the platform NTLM API. |
Workstation | The workstation name. |
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. |
AuthToken Property (NTLM Class)
The authentication token.
Syntax
public byte[] getAuthToken();
Default Value
""
Remarks
This property holds the created authentication token. This property is populated after calling CreateAuthToken.
Note: By default this value is Base64 encoded. Set EncodeToken to False before calling CreateAuthToken to obtain the raw value.
This property is read-only.
ChallengeToken Property (NTLM Class)
The challenge token.
Syntax
public byte[] getChallengeToken(); public void setChallengeToken(byte[] challengeToken);
Default Value
""
Remarks
This property specifies the challenge token. This must be set to the challenge token received from the server before calling CreateAuthToken.
Note: By default the class expects the token to be Base64 encoded. To provide a raw value to this property first set DecodeToken to False.
NegotiateToken Property (NTLM Class)
The negotiate token.
Syntax
public byte[] getNegotiateToken();
Default Value
""
Remarks
This property is populated after calling CreateNegotiateToken. By default the value is Base64 encoded. To obtain the raw value set EncodeToken to False before calling CreateNegotiateToken.
This property is read-only.
NTLMVersion Property (NTLM Class)
The NTLM version.
Syntax
public int getNTLMVersion(); public void setNTLMVersion(int NTLMVersion); Enumerated values: public final static int ntNTLMv1 = 1; public final static int ntNTLMv2 = 2;
Default Value
1
Remarks
This property specifies the NTLM version to use. Possible values are:
- 1 (ntNTLMv1 - default)
- 2 (ntNTLMv2)
Note: If the server requires EPA (Extended Protection for Authentication) this property must be set to 2 (ntNTLMv2).
Password Property (NTLM Class)
The user's password.
Syntax
public String getPassword(); public void setPassword(String password);
Default Value
""
Remarks
This property specifies the user's password.
SSLServerCert Property (NTLM Class)
The server's public certificate.
Syntax
public Certificate getSSLServerCert(); public void setSSLServerCert(Certificate SSLServerCert);
Remarks
This property specifies the server's public certificate. This must be set if the server requires EPA (Extended Protection for Authentication).
User Property (NTLM Class)
The user.
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/user
Config Method (Ntlm 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.
CreateAuthToken Method (Ntlm Class)
Creates the authentication token.
Syntax
public void createAuthToken();
Remarks
This method creates the authentication token. After calling this method the AuthToken property will be populated. The following properties are applicable when calling this method:
- User (required)
- Password (required)
- ChallengeToken (required)
- SSLServerCert
- NTLMVersion
Note: SSLServerCert must be set to the server's public certificate if the server requires EPA (Extended Protection for Authentication).
CreateNegotiateToken Method (Ntlm Class)
Creates the negotiate token.
Syntax
public void createNegotiateToken();
Remarks
This method creates the negotiate token. After calling this method the NegotiateToken property is populated. The following properties are applicable when calling this method:
- User (required)
- Password (required)
- NTLMVersion
Reset Method (Ntlm Class)
Resets the class.
Syntax
public void reset();
Remarks
When called, the class will reset all of its properties to their default values.
Error Event (Ntlm Class)
Information about errors during data delivery.
Syntax
public class DefaultNtlmEventListener implements NtlmEventListener { ... public void error(NtlmErrorEvent e) {} ... } public class NtlmErrorEvent { 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.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate String |
This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. |
||||||||||||||||||||||||||||||||||||||||||||||||
Encoded String |
This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate. When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||
EncodedB byte[] |
This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate. When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||
ExpirationDate String |
This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. |
||||||||||||||||||||||||||||||||||||||||||||||||
ExtendedKeyUsage String |
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). |
||||||||||||||||||||||||||||||||||||||||||||||||
Fingerprint String |
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02 |
||||||||||||||||||||||||||||||||||||||||||||||||
FingerprintSHA1 String |
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84 |
||||||||||||||||||||||||||||||||||||||||||||||||
FingerprintSHA256 String |
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53 |
||||||||||||||||||||||||||||||||||||||||||||||||
Issuer String |
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
KeyPassword String |
This is the password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys. Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey. |
||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKey String |
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKeyAvailable boolean |
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication). |
||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKeyContainer String |
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms. |
||||||||||||||||||||||||||||||||||||||||||||||||
PublicKey String |
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data. |
||||||||||||||||||||||||||||||||||||||||||||||||
PublicKeyAlgorithm String |
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. |
||||||||||||||||||||||||||||||||||||||||||||||||
PublicKeyLength int |
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. |
||||||||||||||||||||||||||||||||||||||||||||||||
SerialNumber String |
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. |
||||||||||||||||||||||||||||||||||||||||||||||||
SignatureAlgorithm String |
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. |
||||||||||||||||||||||||||||||||||||||||||||||||
Store String |
This is the name of the certificate store for the client certificate. The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword. Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store). |
||||||||||||||||||||||||||||||||||||||||||||||||
StoreB byte[] |
This is the name of the certificate store for the client certificate. The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword. Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store). |
||||||||||||||||||||||||||||||||||||||||||||||||
StorePassword String |
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
||||||||||||||||||||||||||||||||||||||||||||||||
StoreType int |
This is the type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This field can take one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
Subject String |
This is the subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
If a field value contains a comma it must be quoted. |
||||||||||||||||||||||||||||||||||||||||||||||||
SubjectAltNames String |
This field contains comma-separated lists of alternative subject names for the certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
ThumbprintMD5 String |
This field contains the MD5 hash of the certificate. If the hash does not already exist, it is computed. |
||||||||||||||||||||||||||||||||||||||||||||||||
ThumbprintSHA1 String |
This field contains the SHA-1 hash of the certificate. If the hash does not already exist, it is computed. |
||||||||||||||||||||||||||||||||||||||||||||||||
ThumbprintSHA256 String |
This field contains the SHA-256 hash of the certificate. If the hash does not already exist, it is computed. |
||||||||||||||||||||||||||||||||||||||||||||||||
Usage String |
This field contains the text description of UsageFlags. This value will be of one or more of the following strings and will be separated by commas:
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. |
||||||||||||||||||||||||||||||||||||||||||||||||
UsageFlags int |
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
Please see the Usage field for a text representation of UsageFlags. This functionality currently is not available when the provider is OpenSSL. |
||||||||||||||||||||||||||||||||||||||||||||||||
Version String |
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3". |
Constructors
public Certificate();
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate( certificateFile);
Opens CertificateFile and reads out the contents as an X509 public key.
public Certificate( certificateData);
Parses CertificateData as an X509 public key.
public Certificate( certStoreType, store, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, store, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, store, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
public Certificate( certStoreType, storeBlob, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, storeBlob, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, storeBlob, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
Config Settings (Ntlm 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.NTLM Config Settings |
DecodeToken: Whether to Base64 encode the token.This setting specifies whether to Base64 decode the ChallengeToken. The default value is True. |
EncodeToken: Whether to Base64 encode the token.This setting specifies whether AuthToken and rpChallengeToken are Base64 encoded after calling CreateAuthToken and rmCreateNegotiateToken;. The default value is True. |
UsePlatformNTLMAPI: Whether to use the platform NTLM API.This setting specifies whether to use the platform NTLM API. The default value is False. |
Workstation:
The workstation name.This setting optionally specifies the workstation name of the client. By default
this value is empty and the class will automatically determine the correct value.
Note: This setting is not applicable when UsePlatformNTLMAPI is True. The platform NTLM API will always use the current workstation's name. |
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:
Tells the class 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:
|
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 false.
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:
The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode:
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:
Tells the class 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 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 (Ntlm Class)
NTLM Errors
101 Component is busy. | |
102 Username and password must be specified. | |
103 ChallengeToken must be specified. |