NTLM Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksAuth_NTLM

Procedural Interface

 ipworksauth_ntlm_open();
 ipworksauth_ntlm_close($res);
 ipworksauth_ntlm_register_callback($res, $id, $function);
 ipworksauth_ntlm_get_last_error($res);
 ipworksauth_ntlm_get_last_error_code($res);
 ipworksauth_ntlm_set($res, $id, $index, $value);
 ipworksauth_ntlm_get($res, $id, $index);
 ipworksauth_ntlm_do_config($res, $configurationstring);
 ipworksauth_ntlm_do_createauthtoken($res);
 ipworksauth_ntlm_do_createnegotiatetoken($res);
 ipworksauth_ntlm_do_reset($res);

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.

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 (IPWorksAuth_NTLM Class)

The authentication token.

Object Oriented Interface

public function getAuthToken();

Procedural Interface

ipworksauth_ntlm_get($res, 1 );

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 (IPWorksAuth_NTLM Class)

The challenge token.

Object Oriented Interface

public function getChallengeToken();
public function setChallengeToken($value);

Procedural Interface

ipworksauth_ntlm_get($res, 2 );
ipworksauth_ntlm_set($res, 2, $value );

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 (IPWorksAuth_NTLM Class)

The negotiate token.

Object Oriented Interface

public function getNegotiateToken();

Procedural Interface

ipworksauth_ntlm_get($res, 3 );

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 (IPWorksAuth_NTLM Class)

The NTLM version.

Object Oriented Interface

public function getNTLMVersion();
public function setNTLMVersion($value);

Procedural Interface

ipworksauth_ntlm_get($res, 4 );
ipworksauth_ntlm_set($res, 4, $value );

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 (IPWorksAuth_NTLM Class)

The user's password.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

ipworksauth_ntlm_get($res, 5 );
ipworksauth_ntlm_set($res, 5, $value );

Default Value

''

Remarks

This property specifies the user's password.

Data Type

String

SSLServerCertEffectiveDate Property (IPWorksAuth_NTLM Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksauth_ntlm_get($res, 6 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorksAuth_NTLM Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksauth_ntlm_get($res, 7 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorksAuth_NTLM Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksauth_ntlm_get($res, 8 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorksAuth_NTLM Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksauth_ntlm_get($res, 9 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorksAuth_NTLM Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksauth_ntlm_get($res, 10 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorksAuth_NTLM Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksauth_ntlm_get($res, 11 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorksAuth_NTLM Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksauth_ntlm_get($res, 12 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorksAuth_NTLM Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksauth_ntlm_get($res, 13 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorksAuth_NTLM Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksauth_ntlm_get($res, 14 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorksAuth_NTLM Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksauth_ntlm_get($res, 15 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorksAuth_NTLM Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksauth_ntlm_get($res, 16 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorksAuth_NTLM Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksauth_ntlm_get($res, 17 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorksAuth_NTLM Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksauth_ntlm_get($res, 18 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorksAuth_NTLM Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksauth_ntlm_get($res, 19 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorksAuth_NTLM Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksauth_ntlm_get($res, 20 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorksAuth_NTLM Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();
public function setSSLServerCertStore($value);

Procedural Interface

ipworksauth_ntlm_get($res, 21 );
ipworksauth_ntlm_set($res, 21, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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 (IPWorksAuth_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.

Object Oriented Interface

public function getSSLServerCertStorePassword();
public function setSSLServerCertStorePassword($value);

Procedural Interface

ipworksauth_ntlm_get($res, 22 );
ipworksauth_ntlm_set($res, 22, $value );

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 (IPWorksAuth_NTLM Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();
public function setSSLServerCertStoreType($value);

Procedural Interface

ipworksauth_ntlm_get($res, 23 );
ipworksauth_ntlm_set($res, 23, $value );

Default Value

0

Remarks

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

SSLServerCertSubjectAltNames Property (IPWorksAuth_NTLM Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksauth_ntlm_get($res, 24 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksAuth_NTLM Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksauth_ntlm_get($res, 25 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorksAuth_NTLM Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksauth_ntlm_get($res, 26 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorksAuth_NTLM Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksauth_ntlm_get($res, 27 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorksAuth_NTLM Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksauth_ntlm_get($res, 28 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorksAuth_NTLM Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksauth_ntlm_get($res, 29 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorksAuth_NTLM Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksauth_ntlm_get($res, 30 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorksAuth_NTLM Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();
public function setSSLServerCertSubject($value);

Procedural Interface

ipworksauth_ntlm_get($res, 31 );
ipworksauth_ntlm_set($res, 31, $value );

Default Value

''

Remarks

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

SSLServerCertEncoded Property (IPWorksAuth_NTLM Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();
public function setSSLServerCertEncoded($value);

Procedural Interface

ipworksauth_ntlm_get($res, 32 );
ipworksauth_ntlm_set($res, 32, $value );

Default Value

''

Remarks

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

User Property (IPWorksAuth_NTLM Class)

The user.

Object Oriented Interface

public function getUser();
public function setUser($value);

Procedural Interface

ipworksauth_ntlm_get($res, 33 );
ipworksauth_ntlm_set($res, 33, $value );

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 (IPWorksAuth_NTLM Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksauth_ntlm_do_config($res, $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 (IPWorksAuth_NTLM Class)

Creates the authentication token.

Object Oriented Interface

public function doCreateAuthToken();

Procedural Interface

ipworksauth_ntlm_do_createauthtoken($res);

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 (IPWorksAuth_NTLM Class)

Creates the negotiate token.

Object Oriented Interface

public function doCreateNegotiateToken();

Procedural Interface

ipworksauth_ntlm_do_createnegotiatetoken($res);

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 (IPWorksAuth_NTLM Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksauth_ntlm_do_reset($res);

Remarks

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

Error Event (IPWorksAuth_NTLM Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksauth_ntlm_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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)

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

Base Config Settings

Trappable Errors (NTLM Class)

NTLM Errors