UNPKG

node-ntlm-client

Version:

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

github.com/gautamsi/node-ntlm-client

gautamsi/node-ntlm-client

62 lines (44 loc) • 2.28 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# 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 `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