Lua

NTLM Client and Server Code

See more NTLM Examples

Demonstrates the NTLM authentication algorithm for both client and server. Lua

local chilkat = require("chilkat")

-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local ntlmClient = chilkat.Ntlm.new()
local ntlmServer = chilkat.Ntlm.new()

-- The NTLM protocol begins by the client sending the server
-- a Type1 message.
ntlmClient.workstation = "MyWorkstation"
local type1Msg = ntlmClient:gen_type1()

print("Type1 message from client to server:")
print(type1Msg)

-- If the server wishes to examine the information embedded within the
-- Type1 message, it may call ParseType1.
-- This step is not necessary, it is only for informational purposes..
local type1Info = ntlmServer:parse_type1(type1Msg)

print("---")
print(type1Info)

-- The server now generates a Type2 message to be sent to the client.
-- The Type2 message requires a TargetName.  A TargetName is
-- the authentication realm in which the authenticating account
-- has membership (a domain name for domain accounts, or server name
-- for local machine accounts).
ntlmServer.target_name = "myAuthRealm"

local type2Msg = ntlmServer:gen_type2(type1Msg)
if not ntlmServer.last_method_success then
    print(ntlmServer.last_error_text)
    return
end

print("Type2 message from server to client:")
print(type2Msg)

-- The client may examine the information embedded in the Type2 message
-- by calling ParseType2, which returns XML.  This is only for informational purposes
-- and is not required.
local type2Info = ntlmClient:parse_type2(type2Msg)

print("---")
print(type2Info)

-- The client will now generate the final Type3 message to be sent to the server.
-- This requires the Username and Password:
ntlmClient.user_name = "test123"
ntlmClient.password = "myPassword"

local type3Msg = ntlmClient:gen_type3(type2Msg)
if not ntlmClient.last_method_success then
    print(ntlmClient.last_error_text)
    return
end

print("Type3 message from client to server:")
print(type3Msg)

-- The server may verify the response by first "loading" the Type3 message.
-- This sets the various properties such as Username, Domain, Workstation,
-- and ClientChallenge to the values embedded within theType3 message.
-- The server may then use the Username to lookup the password.
-- Looking up the password is dependent on your infrastructure.  Perhaps your
-- usernames/passwords are stored in a secure database.  If that's the case, you would
-- write code to issue a query to get the password string for the given username.
-- Once the password is obtained, set the Password property and then
-- generate the Type3 response again.  If the server's Type3 response matches
-- the client's Type3 response, then the client's password is correct.

local success = ntlmServer:load_type3(type3Msg)
if not success then
    print(ntlmServer.last_error_text)
    return
end

-- The Username property now contains the username that was embedded within
-- the Type3 message.  It can be used to lookup the password.
local clientUsername = ntlmServer.user_name

-- For this example, we'll simply set the password to a literal string:
ntlmServer.password = "myPassword"

-- The server may generate the Type3 message again, using the client's correct
-- password:
local expectedType3Msg = ntlmServer:gen_type3(type2Msg)

print("Expected Type3 Message:")
print(expectedType3Msg)

-- If the Type3 message received from the client is exactly the same as the
-- expected Type3 message, then the client must've used the same password,
-- and authentication is successful.