(PureBasic) NTLM Client and Server Code

Demonstrates the NTLM authentication algorithm for both client and server.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkNtlm.pb"

Procedure ChilkatExample()

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

    ntlmClient.i = CkNtlm::ckCreate()
    If ntlmClient.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ntlmServer.i = CkNtlm::ckCreate()
    If ntlmServer.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; The NTLM protocol begins by the client sending the server
    ; a Type1 message. 
    type1Msg.s
    CkNtlm::setCkWorkstation(ntlmClient, "MyWorkstation")
    type1Msg = CkNtlm::ckGenType1(ntlmClient)

    Debug "Type1 message from client to server:"
    Debug 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..
    type1Info.s = CkNtlm::ckParseType1(ntlmServer,type1Msg)

    Debug "---"
    Debug 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).
    CkNtlm::setCkTargetName(ntlmServer, "myAuthRealm")

    type2Msg.s = CkNtlm::ckGenType2(ntlmServer,type1Msg)
    If CkNtlm::ckLastMethodSuccess(ntlmServer) <> 1
        Debug CkNtlm::ckLastErrorText(ntlmServer)
        CkNtlm::ckDispose(ntlmClient)
        CkNtlm::ckDispose(ntlmServer)
        ProcedureReturn
    EndIf

    Debug "Type2 message from server to client:"
    Debug 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.
    type2Info.s = CkNtlm::ckParseType2(ntlmClient,type2Msg)

    Debug "---"
    Debug type2Info

    ; The client will now generate the final Type3 message to be sent to the server.
    ; This requires the Username and Password:
    CkNtlm::setCkUserName(ntlmClient, "test123")
    CkNtlm::setCkPassword(ntlmClient, "myPassword")

    type3Msg.s
    type3Msg = CkNtlm::ckGenType3(ntlmClient,type2Msg)
    If CkNtlm::ckLastMethodSuccess(ntlmClient) <> 1
        Debug CkNtlm::ckLastErrorText(ntlmClient)
        CkNtlm::ckDispose(ntlmClient)
        CkNtlm::ckDispose(ntlmServer)
        ProcedureReturn
    EndIf

    Debug "Type3 message from client to server:"
    Debug 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.

    success.i = CkNtlm::ckLoadType3(ntlmServer,type3Msg)
    If success <> 1
        Debug CkNtlm::ckLastErrorText(ntlmServer)
        CkNtlm::ckDispose(ntlmClient)
        CkNtlm::ckDispose(ntlmServer)
        ProcedureReturn
    EndIf

    ; The Username property now contains the username that was embedded within
    ; the Type3 message.  It can be used to lookup the password.
    clientUsername.s = CkNtlm::ckUserName(ntlmServer)

    ; For this example, we'll simply set the password to a literal string:
    CkNtlm::setCkPassword(ntlmServer, "myPassword")

    ; The server may generate the Type3 message again, using the client's correct
    ; password:
    expectedType3Msg.s = CkNtlm::ckGenType3(ntlmServer,type2Msg)

    Debug "Expected Type3 Message:"
    Debug 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


    CkNtlm::ckDispose(ntlmClient)
    CkNtlm::ckDispose(ntlmServer)


    ProcedureReturn
EndProcedure