Zig

NTLM Client and Server Code

See more NTLM Examples

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

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

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

    const ntlm_client = try chilkat.Ntlm.init();
    defer ntlm_client.deinit();
    const ntlm_server = try chilkat.Ntlm.init();
    defer ntlm_server.deinit();

    // The NTLM protocol begins by the client sending the server
    // a Type1 message.
    ntlm_client.setWorkstation("MyWorkstation");
    const type1_msg = try ntlm_client.genType1(alloc);

    std.debug.print("Type1 message from client to server:\n", .{});
    std.debug.print("{s}\n", .{type1_msg});

    // 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..
    const type1_info = try ntlm_server.parseType1(alloc, type1_msg);

    std.debug.print("---\n", .{});
    std.debug.print("{s}\n", .{type1_info});

    // 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).
    ntlm_server.setTargetName("myAuthRealm");

    const type2_msg = ntlm_server.genType2(alloc, type1_msg) catch {
        std.debug.print("{s}\n", .{try ntlm_server.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("Type2 message from server to client:\n", .{});
    std.debug.print("{s}\n", .{type2_msg});

    // 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.
    const type2_info = try ntlm_client.parseType2(alloc, type2_msg);

    std.debug.print("---\n", .{});
    std.debug.print("{s}\n", .{type2_info});

    // The client will now generate the final Type3 message to be sent to the server.
    // This requires the Username and Password:
    ntlm_client.setUserName("test123");
    ntlm_client.setPassword("myPassword");

    const type3_msg = ntlm_client.genType3(alloc, type2_msg) catch {
        std.debug.print("{s}\n", .{try ntlm_client.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("Type3 message from client to server:\n", .{});
    std.debug.print("{s}\n", .{type3_msg});

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

    ntlm_server.loadType3(type3_msg) catch {
        std.debug.print("{s}\n", .{try ntlm_server.getLastErrorText(alloc)});
        return;
    };

    // The Username property now contains the username that was embedded within
    // the Type3 message.  It can be used to lookup the password.
    _ = try ntlm_server.getUserName(alloc);

    // For this example, we'll simply set the password to a literal string:
    ntlm_server.setPassword("myPassword");

    // The server may generate the Type3 message again, using the client's correct
    // password:
    const expected_type3_msg = try ntlm_server.genType3(alloc, type2_msg);

    std.debug.print("Expected Type3 Message:\n", .{});
    std.debug.print("{s}\n", .{expected_type3_msg});

    // 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.
}