NTLM Class

Properties Methods Events Configuration 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.

Configuration Settings

The following is a list of configuration 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.
UseDaemonThreads	Whether threads created by the class are daemon threads.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.