node-ntlm-client

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

ntlm-client

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

npm install ntlm-client

API

request(options)

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

  • Arguments
    • optionsan object holding below options for the authentication process:
      • urithe target URL
      • methodthe HTTP verb
      • username
      • password
      • requestthis is optional. An object that holds options that should be passed to the request instance
  • Returns
    • Promisewhen resolved, the requestinstance, the result and the response body will be passed

createType1Message([workstation, target])

Creates a type 1 NTLM message to initialize the NTLM handshake

  • Arguments
    • workstationOptional. If undefined, os.hostname()will be used
    • targetOptional. This is the domain/host we are trying to authenticate against.
  • Returns
    • stringComplete NTLM string that should be sent to the server in the Authenticationheader

decodeType2Message(str)

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

  • Arguments
    • strEither the base64 encoded type 2 message, or the complete WWW-Authenticateheader, or an object containg the response headers (http.IncomingMessage)
  • Returns
    • type2MessageAn 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
    • type2MessageThe decoded type 2 message object
    • username
    • password
    • workstationOptional. If falsy, os.hostname()will be used
    • targetOptional. 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
    • stringComplete NTLM string that should be sent to the server in the Authenticationheader

Repository

https://github.com/gautamsi/node-ntlm-client.git


上一篇:node-sp-auth-config
下一篇:cpass

相关推荐

官方社区

扫码加入 JavaScript 社区