httpntlm

What is httpntlm?

The httpntlm npm package is used to perform HTTP NTLM (NT LAN Manager) authentication. This is particularly useful for interacting with services that require NTLM authentication, such as certain Microsoft services and APIs.

What are httpntlm's main functionalities?

NTLM Authentication

This feature allows you to perform a GET request with NTLM authentication. You need to provide the URL, username, password, workstation, and domain.

const httpntlm = require('httpntlm');

httpntlm.get({
    url: 'https://example.com/api',
    username: 'yourUsername',
    password: 'yourPassword',
    workstation: 'yourWorkstation',
    domain: 'yourDomain'
}, function (err, res) {
    if (err) return console.log(err);
    console.log(res.headers);
    console.log(res.body);
});

POST Request with NTLM Authentication

This feature allows you to perform a POST request with NTLM authentication. You need to provide the URL, username, password, workstation, domain, request body, and headers.

const httpntlm = require('httpntlm');

httpntlm.post({
    url: 'https://example.com/api',
    username: 'yourUsername',
    password: 'yourPassword',
    workstation: 'yourWorkstation',
    domain: 'yourDomain',
    body: '<xml>yourData</xml>',
    headers: {
        'Content-Type': 'application/xml'
    }
}, function (err, res) {
    if (err) return console.log(err);
    console.log(res.headers);
    console.log(res.body);
});

Other packages similar to httpntlm

axios-ntlm

The axios-ntlm package is an NTLM authentication interceptor for the popular axios HTTP client. It provides similar functionality to httpntlm but integrates with axios, allowing you to use axios' features and syntax while adding NTLM support.

node-http-ntlm

The node-http-ntlm package is another library for NTLM authentication in Node.js. It offers similar capabilities to httpntlm but with a different API design. It is also actively maintained and provides comprehensive documentation.

request-ntlm

The request-ntlm package is an NTLM authentication extension for the request library. It allows you to perform NTLM authenticated requests using the request library's API. This package is useful if you are already using request and need to add NTLM support.

README

httpntlm

httpntlm is a Node.js library to do HTTP NTLM authentication

It's a port from the Python libary python-ntml with added NTLMv2 support.

Donate

Help keep my open source project alive! Your donation, no matter how small, makes a real difference.

Thank you for your support!

Install

You can install httpntlm using the Node Package Manager (npm):

npm install httpntlm

How to use

var httpntlm = require('httpntlm');

httpntlm.get({
    url: "https://someurl.com",
    username: 'm$',
    password: 'stinks',
    workstation: 'choose.something',
    domain: ''
}, function (err, res){
    if(err) return console.log(err);

    console.log(res.headers);
    console.log(res.body);
});

It supports http and https.

pre-encrypt the password

var httpntlm = require('httpntlm');
var ntlm = httpntlm.ntlm;
var lm = ntlm.create_LM_hashed_password('Azx123456');
var nt = ntlm.create_NT_hashed_password('Azx123456');
console.log(lm);
console.log(Array.prototype.slice.call(lm, 0));
lm = Buffer.from([ 183, 180, 19, 95, 163, 5, 118, 130, 30, 146, 159, 252, 1, 57, 81, 39 ]);
console.log(lm);

console.log(nt);
console.log(Array.prototype.slice.call(nt, 0));
nt = Buffer.from([150, 27, 7, 219, 220, 207, 134, 159, 42, 60, 153, 28, 131, 148, 14, 1]);
console.log(nt);


httpntlm.get({
    url: "https://someurl.com",
    username: 'm$',
    lm_password: lm,
    nt_password: nt,
    workstation: 'choose.something',
    domain: ''
}, function (err, res){
    if(err) return console.log(err);

    console.log(res.headers);
    console.log(res.body);
});

/* you can save the array into your code and use it when you need it

<Buffer b7 b4 13 5f a3 05 76 82 1e 92 9f fc 01 39 51 27>// before convert to array
[ 183, 180, 19, 95, 163, 5, 118, 130, 30, 146, 159, 252, 1, 57, 81, 39 ]// convert to array
<Buffer b7 b4 13 5f a3 05 76 82 1e 92 9f fc 01 39 51 27>//convert back to buffer

<Buffer 96 1b 07 db dc cf 86 9f 2a 3c 99 1c 83 94 0e 01>
[ 150, 27, 7, 219, 220, 207, 134, 159, 42, 60, 153, 28, 131, 148, 14, 1 ]
<Buffer 96 1b 07 db dc cf 86 9f 2a 3c 99 1c 83 94 0e 01>
*/

Options

• url: {String} URL to connect. (Required)
• username: {String} Username. (Required)
• password: {String} Password. (Required)
• workstation: {String} Name of workstation or ''.
• domain: {String} Name of domain or ''.

if you already got the encrypted password,you should use this two param to replace the 'password' param.

• lm_password {Buffer} encrypted lm password.(Required)
• nt_password {Buffer} encrypted nt password. (Required)

You can also pass along all other options of httpreq, including custom headers, cookies, body data, ... and use POST, PUT or DELETE instead of GET.

NTLMv2

When NTLMv2 extended security and target information can be negotiated with the server, this library assumes the server supports NTLMv2 and creates responses according to the NTLMv2 specification (the actually supported NTLM version cannot be negotiated). Otherwise, NTLMv1 or NTLMv1 with NTLMv2 extended security will be used.

Advanced

If you want to use the NTLM-functions yourself, you can access the ntlm-library like this (https example):

var ntlm = require('httpntlm').ntlm;
var async = require('async');
var httpreq = require('httpreq');
var HttpsAgent = require('agentkeepalive').HttpsAgent;
var keepaliveAgent = new HttpsAgent();

var options = {
    url: "https://someurl.com",
    username: 'm$',
    password: 'stinks',
    workstation: 'choose.something',
    domain: ''
};

async.waterfall([
    function (callback){
        var type1msg = ntlm.createType1Message(options);

        httpreq.get(options.url, {
            headers:{
                'Connection' : 'keep-alive',
                'Authorization': type1msg
            },
            agent: keepaliveAgent
        }, callback);
    },

    function (res, callback){
        if(!res.headers['www-authenticate'])
            return callback(new Error('www-authenticate not found on response of second request'));

        var type2msg = ntlm.parseType2Message(res.headers['www-authenticate']);
        var type3msg = ntlm.createType3Message(type2msg, options);

        setImmediate(function() {
            httpreq.get(options.url, {
                headers:{
                    'Connection' : 'Close',
                    'Authorization': type3msg
                },
                allowRedirects: false,
                agent: keepaliveAgent
            }, callback);
        });
    }
], function (err, res) {
    if(err) return console.log(err);

    console.log(res.headers);
    console.log(res.body);
});

Download binary files

httpntlm.get({
    url: "https://someurl.com/file.xls",
    username: 'm$',
    password: 'stinks',
    workstation: 'choose.something',
    domain: '',
    binary: true
}, function (err, response) {
    if(err) return console.log(err);
    fs.writeFile("file.xls", response.body, function (err) {
        if(err) return console.log("error writing file");
        console.log("file.xls saved!");
    });
});

More information

• python-ntlm
• NTLM Authentication Scheme for HTTP
• LM hash on Wikipedia

Contributing

Running tests in an open source package is crucial for ensuring the quality and reliability of the codebase. When you submit code changes, it's essential to ensure that these changes don't break existing functionality or introduce new bugs.

To run the tests, simply run

node test.js

All tests should return true

License (MIT)

Copyright (c) Sam Decrock https://github.com/SamDecrock/

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.