React Native

NTLM Client and Server Code

See more NTLM Examples

Demonstrates the NTLM authentication algorithm for both client and server. React Native

import { Ntlm } from '@chilkat/react-native'

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

  const ntlmClient = new Ntlm();
  const ntlmServer = new Ntlm();

  // The NTLM protocol begins by the client sending the server
  // a Type1 message. 
  ntlmClient.workstation = 'MyWorkstation';
  const type1Msg = ntlmClient.genType1();

  console.log('Type1 message from client to server:');
  console.log(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..
  const type1Info = ntlmServer.parseType1(type1Msg);

  console.log('---');
  console.log(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.targetName = 'myAuthRealm';

  let type2Msg: string;
  try {
    type2Msg = ntlmServer.genType2(type1Msg);
  } catch {
    console.log(ntlmServer.lastErrorText);
    return;
  }

  console.log('Type2 message from server to client:');
  console.log(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.
  const type2Info = ntlmClient.parseType2(type2Msg);

  console.log('---');
  console.log(type2Info);

  // The client will now generate the final Type3 message to be sent to the server.
  // This requires the Username and Password:
  ntlmClient.userName = 'test123';
  ntlmClient.password = 'myPassword';

  let type3Msg = '';
  try {
    type3Msg = ntlmClient.genType3(type2Msg);
  } catch {
    console.log(ntlmClient.lastErrorText);
    return;
  }

  console.log('Type3 message from client to server:');
  console.log(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.

  try {
    ntlmServer.loadType3(type3Msg);
  } catch {
    console.log(ntlmServer.lastErrorText);
    return;
  }

  // The Username property now contains the username that was embedded within
  // the Type3 message.  It can be used to lookup the password.
  const clientUsername = ntlmServer.userName;

  // 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:
  const expectedType3Msg = ntlmServer.genType3(type2Msg);

  console.log('Expected Type3 Message:');
  console.log(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.
}