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

SSLServerCertEncoded Property (NTLM Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);
int SetSSLServerCertEncoded(const char* lpSSLServerCertEncoded, int lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
INT SetSSLServerCertEncoded(LPCSTR lpSSLServerCertEncoded, INT lenSSLServerCertEncoded);

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

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

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLServerCertStore Property (NTLM Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertStore(char* &lpSSLServerCertStore, int &lenSSLServerCertStore);
int SetSSLServerCertStore(const char* lpSSLServerCertStore, int lenSSLServerCertStore);

Unicode (Windows)
INT GetSSLServerCertStore(LPSTR &lpSSLServerCertStore, INT &lenSSLServerCertStore);
INT SetSSLServerCertStore(LPCSTR lpSSLServerCertStore, INT lenSSLServerCertStore);

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

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

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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., PKCS#12 certificate store).

Data Type

Binary String

SSLServerCertStorePassword Property (NTLM Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLServerCertStorePassword();
int SetSSLServerCertStorePassword(const char* lpszSSLServerCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLServerCertStorePassword();
INT SetSSLServerCertStorePassword(LPCWSTR lpszSSLServerCertStorePassword);

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

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

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLServerCertStoreType Property (NTLM Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertStoreType();
int SetSSLServerCertStoreType(int iSSLServerCertStoreType);

Unicode (Windows)
INT GetSSLServerCertStoreType();
INT SetSSLServerCertStoreType(INT iSSLServerCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

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

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

Default Value

0

Remarks

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 property can take one of the following values:

Data Type

Integer

SSLServerCertSubject Property (NTLM Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLServerCertSubject();
int SetSSLServerCertSubject(const char* lpszSSLServerCertSubject);

Unicode (Windows)
LPWSTR GetSSLServerCertSubject();
INT SetSSLServerCertSubject(LPCWSTR lpszSSLServerCertSubject);

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

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

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

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 as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

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)

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

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