To help you get started, we've collected the most common ways that http-auth is being used within popular public projects.

mwittig / node-fronius-solar / test / server.js View on Github

"Timestamp": "2019-08-09T07:59:05+02:00"
            }
        }));
    } else {
        console.log("404 Not Found");
        response.writeHead(404, {
            "Content-Type": "text/plain"
        });
        response.write("404 Not Found\n");
        response.end();
        return;
    }
}

if (useDigestAuth) {
    var digest = auth.digest({
        realm: realm
    }, function (username, callback) { // Expecting md5(username:realm:password) in callback.
        if (username === "admin") {
            var hash = crypto.createHash('md5');
            hash.update("admin:" + realm + ":admin");
            callback(hash.digest('hex'));
        } else {
            callback();
        }
    });
    http.createServer(digest, requestListener).listen(parseInt(port, 10));
} else {
    http.createServer(requestListener).listen(parseInt(port, 10));
}

console.log("Server running at\n  => http://localhost:" + parseInt(port, 10) + "/\nCTRL + C to shutdown");

View more ways to use http-auth

http-auth

Node.js package for HTTP basic and digest access authentication.

Installation

Via git (or downloaded tarball):

$ git clone git://github.com/gevorg/http-auth.git

Via npm:

$ npm install http-auth

Usage

// HTTP module
const http = require("http");

// Authentication module.
const auth = require("http-auth");
const basic = auth.basic({
  realm: "Simon Area.",
  file: __dirname + "/../data/users.htpasswd" // gevorg:gpass, Sarah:testpass
});

// Creating new HTTP server.
http
  .createServer(
    basic.check((req, res) => {
      res.end(`Welcome to private area - ${req.user}!`);
    })
  )
  .listen(1337, () => {
    // Log URL.
    console.log("Server running at https://127.0.0.1:1337/");
  });

Please check examples directory for more.

Configurations

• realm - Authentication realm, by default it is Users.
• file - File where user details are stored.
  • Line format is {user:pass} or {user:passHash} for basic access.
  • Line format is {user:realm:passHash} for digest access.
  • Using a callback, it needs to return the same line format, example: file: () => 'adam:adam\neve:eve',
• algorithm - Algorithm that will be used only for digest access authentication.
  • MD5 by default.
  • MD5-sess can be set.
• qop - Quality of protection that is used only for digest access authentication.
  • auth is set by default.
  • none this option is disabling protection.
• msg401 - Message for failed authentication 401 page.
• msg407 - Message for failed authentication 407 page.
• contentType - Content type for failed authentication page.
• skipUser - Set this to true, if you don't want req.user to be filled with authentication info.
• proxy - Set this to true, if you want to use it with http-proxy.

Running tests

It uses mocha, so just run following command in package directory:

$ npm test

Questions

You can also use stackoverflow to ask questions using http-auth tag.

Utilities

• htpasswd - Node.js package for HTTP Basic Authentication password file utility.
• htdigest - Node.js package for HTTP Digest Authentication password file utility.

Integrations

Please check this link for integration packages.

License

The MIT License (MIT)