NTLM Class

Properties   Methods   Events   Config Settings   Errors  

The NTLM class provides a simple API to create the required tokens for NTLM authentication.

Syntax

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>

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.

Method List

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

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.

Config Settings

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

AuthToken Property (NTLM Class)

The authentication token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthToken(char* &lpAuthToken, int &lenAuthToken);

Unicode (Windows)
INT GetAuthToken(LPSTR &lpAuthToken, INT &lenAuthToken);

int ipworksauth_ntlm_getauthtoken(void* lpObj, char** lpAuthToken, int* lenAuthToken);

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

Data Type

Binary String

ChallengeToken Property (NTLM Class)

The challenge token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChallengeToken(char* &lpChallengeToken, int &lenChallengeToken);
int SetChallengeToken(const char* lpChallengeToken, int lenChallengeToken);

Unicode (Windows)
INT GetChallengeToken(LPSTR &lpChallengeToken, INT &lenChallengeToken);
INT SetChallengeToken(LPCSTR lpChallengeToken, INT lenChallengeToken);

int ipworksauth_ntlm_getchallengetoken(void* lpObj, char** lpChallengeToken, int* lenChallengeToken);
int ipworksauth_ntlm_setchallengetoken(void* lpObj, const char* lpChallengeToken, int lenChallengeToken);

QByteArray GetChallengeToken();
int SetChallengeToken(QByteArray qbaChallengeToken);

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.

Data Type

Binary String

NegotiateToken Property (NTLM Class)

The negotiate token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNegotiateToken(char* &lpNegotiateToken, int &lenNegotiateToken);

Unicode (Windows)
INT GetNegotiateToken(LPSTR &lpNegotiateToken, INT &lenNegotiateToken);

int ipworksauth_ntlm_getnegotiatetoken(void* lpObj, char** lpNegotiateToken, int* lenNegotiateToken);

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

Data Type

Binary String

NTLMVersion Property (NTLM Class)

The NTLM version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNTLMVersion();
int SetNTLMVersion(int iNTLMVersion);

Unicode (Windows)
INT GetNTLMVersion();
INT SetNTLMVersion(INT iNTLMVersion);

NT_NTLMV_1(1), 
NT_NTLMV_2(2)

int ipworksauth_ntlm_getntlmversion(void* lpObj);
int ipworksauth_ntlm_setntlmversion(void* lpObj, int iNTLMVersion);

int GetNTLMVersion();
int SetNTLMVersion(int iNTLMVersion);

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

Data Type

Integer

Password Property (NTLM Class)

The user's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksauth_ntlm_getpassword(void* lpObj);
int ipworksauth_ntlm_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property specifies the user's password.

Data Type

String

SSLServerCert Property (NTLM Class)

The server's public certificate.

Syntax

• C++
• C
• Qt

IPWorksAuthCertificate* GetSSLServerCert();
int SetSSLServerCert(IPWorksAuthCertificate* val);

char* ipworksauth_ntlm_getsslservercerteffectivedate(void* lpObj);

char* ipworksauth_ntlm_getsslservercertexpirationdate(void* lpObj);

char* ipworksauth_ntlm_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksauth_ntlm_getsslservercertfingerprint(void* lpObj);

char* ipworksauth_ntlm_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksauth_ntlm_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksauth_ntlm_getsslservercertissuer(void* lpObj);

char* ipworksauth_ntlm_getsslservercertprivatekey(void* lpObj);

int ipworksauth_ntlm_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksauth_ntlm_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksauth_ntlm_getsslservercertpublickey(void* lpObj);

char* ipworksauth_ntlm_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksauth_ntlm_getsslservercertpublickeylength(void* lpObj);

char* ipworksauth_ntlm_getsslservercertserialnumber(void* lpObj);

char* ipworksauth_ntlm_getsslservercertsignaturealgorithm(void* lpObj);

int ipworksauth_ntlm_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);
int ipworksauth_ntlm_setsslservercertstore(void* lpObj, const char* lpSSLServerCertStore, int lenSSLServerCertStore);

char* ipworksauth_ntlm_getsslservercertstorepassword(void* lpObj);
int ipworksauth_ntlm_setsslservercertstorepassword(void* lpObj, const char* lpszSSLServerCertStorePassword);

int ipworksauth_ntlm_getsslservercertstoretype(void* lpObj);
int ipworksauth_ntlm_setsslservercertstoretype(void* lpObj, int iSSLServerCertStoreType);

char* ipworksauth_ntlm_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksauth_ntlm_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksauth_ntlm_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksauth_ntlm_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksauth_ntlm_getsslservercertusage(void* lpObj);

int ipworksauth_ntlm_getsslservercertusageflags(void* lpObj);

char* ipworksauth_ntlm_getsslservercertversion(void* lpObj);

char* ipworksauth_ntlm_getsslservercertsubject(void* lpObj);
int ipworksauth_ntlm_setsslservercertsubject(void* lpObj, const char* lpszSSLServerCertSubject);

int ipworksauth_ntlm_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
int ipworksauth_ntlm_setsslservercertencoded(void* lpObj, const char* lpSSLServerCertEncoded, int lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();
int SetSSLServerCertStore(QByteArray qbaSSLServerCertStore);

QString GetSSLServerCertStorePassword();
int SetSSLServerCertStorePassword(QString qsSSLServerCertStorePassword);

int GetSSLServerCertStoreType();
int SetSSLServerCertStoreType(int iSSLServerCertStoreType);

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();
int SetSSLServerCertSubject(QString qsSSLServerCertSubject);

QByteArray GetSSLServerCertEncoded();
int SetSSLServerCertEncoded(QByteArray qbaSSLServerCertEncoded);

Remarks

This property specifies the server's public certificate. This must be set if the server requires EPA (Extended Protection for Authentication).

Data Type

IPWorksAuthCertificate

User Property (NTLM Class)

The user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworksauth_ntlm_getuser(void* lpObj);
int ipworksauth_ntlm_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

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

Data Type

String

Config Method (NTLM Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksauth_ntlm_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateAuthToken Method (NTLM Class)

Creates the authentication token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateAuthToken();

Unicode (Windows)
INT CreateAuthToken();

int ipworksauth_ntlm_createauthtoken(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateNegotiateToken Method (NTLM Class)

Creates the negotiate token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateNegotiateToken();

Unicode (Windows)
INT CreateNegotiateToken();

int ipworksauth_ntlm_createnegotiatetoken(void* lpObj);

int 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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (NTLM Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksauth_ntlm_reset(void* lpObj);

int Reset();

Remarks

When called, the class will reset all of its properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (NTLM Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(NTLMErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} NTLMErrorEventParams;


Unicode (Windows)
virtual INT FireError(NTLMErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} NTLMErrorEventParams;

#define EID_NTLM_ERROR 1

virtual INT IPWORKSAUTH_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class NTLMErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(NTLMErrorEventParams *e);

// Or, subclass NTLM and override this emitter function.
virtual int FireError(NTLMErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksAuthCertificate (declared in ipworksauth.h)

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

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Config Settings (NTLM Class)

NTLM Config Settings

Base Config Settings

Trappable Errors (NTLM Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

NTLM Errors