Ntlm Tcl Reference Documentation

Ntlm

Current Version: 9.5.0.73

API for implemeting both client and server sides of the NTLM protocol/algorithm. The Chilkat NTLM API is included as part of the "Chilkat Crypt" license.

Object Creation

set myNtlm [new CkNtlm]

Properties

ClientChallenge
string
# ckStr is a CkString
CkNtlm_get_ClientChallenge $myNtlm $ckStr
set strVal [CkNtlm_get_clientChallenge $myNtlm]
CkNtlm_put_ClientChallenge $myNtlm $strVal

The ClientChallenge is passed in the Type 3 message from the client to the server. It must contain exactly 8 bytes. Because this is a string property, the bytes are get/set in encoded form (such as hex or base64) based on the value of the EncodingMode property. For example, if the EncodingMode property = "hex", then a hex representation of 8 bytes should be used to set the ClientChallenge.

Note: Setting the ClientChallenge is optional. If the ClientChallenge remains unset, it will be automatically set to 8 random bytes when the GenType3 method is called.

top
DebugLogFilePath
string
# ckStr is a CkString
CkNtlm_get_DebugLogFilePath $myNtlm $ckStr
set strVal [CkNtlm_get_debugLogFilePath $myNtlm]
CkNtlm_put_DebugLogFilePath $myNtlm $strVal

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DnsComputerName
string
# ckStr is a CkString
CkNtlm_get_DnsComputerName $myNtlm $ckStr
set strVal [CkNtlm_get_dnsComputerName $myNtlm]
CkNtlm_put_DnsComputerName $myNtlm $strVal

Optional. This is information that would be set by the server for inclusion in the "Target Info" internal portion of the Type 2 message. Note: If any optional "Target Info" fields are provided, then both NetBiosComputerName and NetBiosDomainName must be provided.

top
DnsDomainName
string
# ckStr is a CkString
CkNtlm_get_DnsDomainName $myNtlm $ckStr
set strVal [CkNtlm_get_dnsDomainName $myNtlm]
CkNtlm_put_DnsDomainName $myNtlm $strVal

Optional. This is information that would be set by the server for inclusion in the "Target Info" internal portion of the Type 2 message. Note: If any optional "Target Info" fields are provided, then both NetBiosComputerName and NetBiosDomainName must be provided.

top
Domain
string
# ckStr is a CkString
CkNtlm_get_Domain $myNtlm $ckStr
set strVal [CkNtlm_get_domain $myNtlm]
CkNtlm_put_Domain $myNtlm $strVal

Optional. May be set by the client for inclusion in the Type 1 message.

top
EncodingMode
string
# ckStr is a CkString
CkNtlm_get_EncodingMode $myNtlm $ckStr
set strVal [CkNtlm_get_encodingMode $myNtlm]
CkNtlm_put_EncodingMode $myNtlm $strVal

Determines the encoding mode used for getting/setting various properties, such as ClientChallenge. The valid case-insensitive modes are "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

top
Flags
string
# ckStr is a CkString
CkNtlm_get_Flags $myNtlm $ckStr
set strVal [CkNtlm_get_flags $myNtlm]
CkNtlm_put_Flags $myNtlm $strVal

The negotiate flags that are set in the Type 1 message generated by the client and sent to the server. These flags have a default value and should ONLY be set by a programmer that is an expert in the NTLM protocol and knows what they mean. In general, this property should be left at it's default value.

The flags are represented as a string of letters, where each letter represents a bit. The full set of possible flags (bit values) are shown below:

NegotiateUnicode               0x00000001
NegotiateOEM                   0x00000002
RequestTarget                  0x00000004
NegotiateSign                  0x00000010
NegotiateSeal                  0x00000020
NegotiateDatagramStyle         0x00000040
NegotiateLanManagerKey         0x00000080
NegotiateNetware               0x00000100
NegotiateNTLMKey               0x00000200
NegotiateDomainSupplied        0x00001000
NegotiateWorkstationSupplied   0x00002000
NegotiateLocalCall             0x00004000
NegotiateAlwaysSign            0x00008000
TargetTypeDomain               0x00010000
TargetTypeServer               0x00020000
TargetTypeShare                0x00040000
NegotiateNTLM2Key              0x00080000
RequestInitResponse            0x00100000
RequestAcceptResponse          0x00200000
RequestNonNTSessionKey         0x00400000
NegotiateTargetInfo            0x00800000
Negotiate128                   0x20000000
NegotiateKeyExchange           0x40000000
Negotiate56                    0x80000000
The mapping of letters to bit values are as follows:
0x01 - "A"
0x02 - "B"
0x04 - "C"
0x10 - "D"
0x20 - "E"
0x40 - "F"
0x80 - "G"
0x200 - "H"
0x400 - "I"
0x800 - "J"
0x1000 - "K"
0x2000 - "L"
0x8000 - "M"
0x10000 - "N"
0x20000 - "O"
0x40000 - "P"
0x80000 - "Q"
0x100000 - "R"
0x400000 - "S"
0x800000 - "T"
0x2000000 - "U"
0x20000000 - "V"
0x40000000 - "W"
0x80000000 - "X"
The default Flags value has the following flags set: NegotiateUnicode, NegotiateOEM, RequestTarget, NegotiateNTLMKey, NegotiateAlwaysSign, NegotiateNTLM2Key. The corresponds to the string "ABCHMQ".

top
LastErrorHtml
string
# ckStr is a CkString
CkNtlm_get_LastErrorHtml $myNtlm $ckStr
set strVal [CkNtlm_get_lastErrorHtml $myNtlm]

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
string
# ckStr is a CkString
CkNtlm_get_LastErrorText $myNtlm $ckStr
set strVal [CkNtlm_get_lastErrorText $myNtlm]

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
string
# ckStr is a CkString
CkNtlm_get_LastErrorXml $myNtlm $ckStr
set strVal [CkNtlm_get_lastErrorXml $myNtlm]

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkNtlm_get_LastMethodSuccess $myNtlm]
CkNtlm_put_LastMethodSuccess $myNtlm $boolVal
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NetBiosComputerName
string
# ckStr is a CkString
CkNtlm_get_NetBiosComputerName $myNtlm $ckStr
set strVal [CkNtlm_get_netBiosComputerName $myNtlm]
CkNtlm_put_NetBiosComputerName $myNtlm $strVal

Optional. This is information that would be set by the server for inclusion in the "Target Info" internal portion of the Type 2 message. Note: If any optional "Target Info" fields are provided, then both NetBiosComputerName and NetBiosDomainName must be provided.

top
NetBiosDomainName
string
# ckStr is a CkString
CkNtlm_get_NetBiosDomainName $myNtlm $ckStr
set strVal [CkNtlm_get_netBiosDomainName $myNtlm]
CkNtlm_put_NetBiosDomainName $myNtlm $strVal

Optional. This is information that would be set by the server for inclusion in the "Target Info" internal portion of the Type 2 message. Note: If any optional "Target Info" fields are provided, then both NetBiosComputerName and NetBiosDomainName must be provided.

top
NtlmVersion
integer
set intVal [CkNtlm_get_NtlmVersion $myNtlm]
CkNtlm_put_NtlmVersion $myNtlm $intVal

The version of the NTLM protocol to be used. Must be set to either 1 or 2. The default value is 1 (for NTLMv1). Setting this property equal to 2 selects NTLMv2.

top
OemCodePage
integer
set intVal [CkNtlm_get_OemCodePage $myNtlm]
CkNtlm_put_OemCodePage $myNtlm $intVal

If the "A" flag is unset, then Unicode strings are not used internally in the NTLM messages. Strings are instead represented using the OEM code page (i.e. charset, or character encoding) as specified here. In general, given that the Flags property should rarely be modified, and given that the "A" flag is set by default (meaning that Unicode is used), the OemCodePage property will not apply. The default value is the default OEM code page of the local computer.

top
Password
string
# ckStr is a CkString
CkNtlm_get_Password $myNtlm $ckStr
set strVal [CkNtlm_get_password $myNtlm]
CkNtlm_put_Password $myNtlm $strVal

The password corresponding to the username of the account to be authenticated. This must be set by the client prior to generating and sending the Type 3 message.

top
ServerChallenge
string
# ckStr is a CkString
CkNtlm_get_ServerChallenge $myNtlm $ckStr
set strVal [CkNtlm_get_serverChallenge $myNtlm]
CkNtlm_put_ServerChallenge $myNtlm $strVal

This is similar to the ClientChallenge in that it must contain 8 bytes.

The ServerChallenge is passed in the Type 2 message from the server to the client. Because this is a string property, the bytes are get/set in encoded form (such as hex or base64) based on the value of the EncodingMode property. For example, if the EncodingMode property = "hex", then a hex representation of 8 bytes should be used to set the ServerChallenge.

Note: Setting the ServerChallenge is optional. If the ServerChallenge remains unset, it will be automatically set to 8 random bytes when the GenType2 method is called.

top
TargetName
string
# ckStr is a CkString
CkNtlm_get_TargetName $myNtlm $ckStr
set strVal [CkNtlm_get_targetName $myNtlm]
CkNtlm_put_TargetName $myNtlm $strVal

The authentication realm in which the authenticating account has membership, such as a domain for domain accounts, or a server name for local machine accounts. The TargetName is used in the Type2 message sent from the server to the client.

top
UserName
string
# ckStr is a CkString
CkNtlm_get_UserName $myNtlm $ckStr
set strVal [CkNtlm_get_userName $myNtlm]
CkNtlm_put_UserName $myNtlm $strVal

The username of the account to be authenticated. This must be set by the client prior to generating and sending the Type 3 message.

top
Utf8
boolean 1/0
set boolVal [CkNtlm_get_Utf8 $myNtlm]
CkNtlm_put_Utf8 $myNtlm $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
boolean 1/0
set boolVal [CkNtlm_get_VerboseLogging $myNtlm]
CkNtlm_put_VerboseLogging $myNtlm $boolVal

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
string
# ckStr is a CkString
CkNtlm_get_Version $myNtlm $ckStr
set strVal [CkNtlm_get_version $myNtlm]

Version of the component/library, such as "9.5.0.63"

top
Workstation
string
# ckStr is a CkString
CkNtlm_get_Workstation $myNtlm $ckStr
set strVal [CkNtlm_get_workstation $myNtlm]
CkNtlm_put_Workstation $myNtlm $strVal

The value to be used in the optional workstation field in Type 1 message.

top

Methods

CompareType3
# msg1 is a string
# msg2 is a string
set retBool [CkNtlm_CompareType3 $msg1 $msg2]

Compares the internal contents of two Type3 messages to verify that the LM and NTLM response parts match. A server would typically compute the Type3 message by calling GenType3, and then compare it with the Type3 message received from the client. The method returns 1 if the responses match, and 0 if they do not.

top
GenType1
# outStr is a CkString (output)
set status [CkNtlm_GenType1 $outStr]
set retStr [CkNtlm_genType1 $myNtlm]

Generates the Type 1 message. The Type 1 message is sent from Client to Server and initiates the NTLM authentication exchange.

Returns 1 for success, 0 for failure.

More Information and Examples
top
GenType2
# type1Msg is a string
# outStr is a CkString (output)
set status [CkNtlm_GenType2 $type1Msg $outStr]
set retStr [CkNtlm_genType2 $myNtlm $type1Msg]

Generates a Type2 message from a received Type1 message. The server-side generates the Type2 message and sends it to the client. This is the 2nd step in the NTLM protocol. The 1st step is the client generating the initial Type1 message which is sent to the server.

Returns 1 for success, 0 for failure.

More Information and Examples
top
GenType3
# type2Msg is a string
# outStr is a CkString (output)
set status [CkNtlm_GenType3 $type2Msg $outStr]
set retStr [CkNtlm_genType3 $myNtlm $type2Msg]

Generates the final message in the NTLM authentication exchange. This message is sent from the client to the server. The Type 2 message received from the server is passed to GenType3. The Username and Password properties are finally used here in the generation of the Type 3 message. Note, the Password is never actually sent. It is used to compute a binary response that the server can then check, using the password it has on file, to verify that indeed the client must've used the correct password.

Returns 1 for success, 0 for failure.

More Information and Examples
top
LoadType3
# type3Msg is a string
set status [CkNtlm_LoadType3 $type3Msg]

The server-side should call this method with the Type 3 message received from the client. The LoadType3 method sets the following properties: Username, Domain, Workstation, and ClientChallenge, all of which are embedded within the Type 3 message.

The server-side code may then use the Username to lookup the associated password and then it will itself call the GenType3 method to do the same computation as done by the client. The server then compares it's computed Type 3 message with the Type 3 message received from the client. If the Type 3 messages are exactly the same, then it must be that the client used the correct password, and therefore the client authentication is successful.

Returns 1 for success, 0 for failure.

More Information and Examples
top
ParseType1
# type1Msg is a string
# outStr is a CkString (output)
set status [CkNtlm_ParseType1 $type1Msg $outStr]
set retStr [CkNtlm_parseType1 $myNtlm $type1Msg]

For informational purposes only. Allows for the server-side to parse a Type 1 message to get human-readable information about the contents.

Returns 1 for success, 0 for failure.

More Information and Examples
top
ParseType2
# type2Msg is a string
# outStr is a CkString (output)
set status [CkNtlm_ParseType2 $type2Msg $outStr]
set retStr [CkNtlm_parseType2 $myNtlm $type2Msg]

For informational purposes only. Allows for the client-side to parse a Type 2 message to get human-readable information about the contents.

Returns 1 for success, 0 for failure.

More Information and Examples
top
ParseType3
# type3Msg is a string
# outStr is a CkString (output)
set status [CkNtlm_ParseType3 $type3Msg $outStr]
set retStr [CkNtlm_parseType3 $myNtlm $type3Msg]

For informational purposes only. Allows for the server-side to parse a Type 3 message to get human-readable information about the contents.

Returns 1 for success, 0 for failure.

More Information and Examples
top
SaveLastError
# path is a string
set status [CkNtlm_SaveLastError $path]

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

top
SetFlag
# flagLetter is a string
# onOrOff is a boolean
set status [CkNtlm_SetFlag $flagLetter $onOrOff]

Sets one of the negotiate flags to be used in the Type 1 message sent by the client. It should normally be unnecessary to modify the default flag settings. For more information about flags, see the description for the Flags property above.

Returns 1 for success, 0 for failure.

top
UnlockComponent
# unlockCode is a string
set retBool [CkNtlm_UnlockComponent $unlockCode]

Unlocks the component. This must be called once prior to calling any other method.

top