@elastic.io/ntlm-client

ntlm-client

A node.js NTLM client with support for NTLM and NTLMv2 authentication

npm install ntlm-client

Example Usage

const ntlmRequest = require('@elasticio/ntlm-client').request;

(async function makeExampleRequest() {
  const { response } = await ntlmRequest({
    username: 'MYDOMAIN\SomeUser',
    password: 'P@$$word1!',
    uri: 'https://api.someservice.com',
    method: 'POST',
    request: {
      json: true,   // Example of parameter passed to request.js
      body: {
        foo: 'bar'
      },
      headers: {
        Date: 'Today'
      }
    }
  });
  console.log(`Received status code: ${response.statusCode} Body: ${response.body}`);
})()

API

request(options)

A convenience function that tries to authenticate against a given URL using the request module. If NTLM is not supported, it will fallback to Basic Auth.

• Arguments
  • options an object holding below options for the authentication process:
    • uri the target URL
    • method the HTTP verb
    • username
    • password
    • request this is optional. An object that holds options that should be passed to the request instance
• Returns
  • Promise when resolved, the request instance, the result and the response body will be passed

---

createType1Message([workstation, target])

Creates a type 1 NTLM message to initialize the NTLM handshake

• Arguments
  • workstation Optional. If undefined, os.hostname() will be used
  • target Optional. This is the domain/host we are trying to authenticate against.
• Returns
  • string Complete NTLM string that should be sent to the server in the Authentication header

---

decodeType2Message(str)

Decodes a type 2 message received from the server including the NTLM challenge

• Arguments
  • str Either the base64 encoded type 2 message, or the complete WWW-Authenticate header, or an object containg the response headers (http.IncomingMessage)
• Returns
  • type2Message An object containing the following information about the received type 2 message: flags, encoding, version, challenge, targetName, targetInfo.

---

createType3Message(type2Message, username, password[, workstation, target])

Creates a type 3 message based on the type 2 message received from the server.

• Arguments
  • type2Message The decoded type 2 message object
  • username
  • password
  • workstation Optional. If falsy, os.hostname() will be used
  • target Optional. If falsy, the target name from the type 2 message will be used. This is the domain/host we are trying to authenticate against.
• Returns
  • string Complete NTLM string that should be sent to the server in the Authentication header

Changelog

1.0.0 (March 5, 2020)

• Elastic.io GmbH re-release
• Add integration tests
• Update dependencies
• Don't fail if request object is omitted.
• Add support for usernames of the form 'SomeDomain\SomeUser'.
• Don't mask errors
• Don't supply an Accept header