npmpackage.info

basic-auth

Generic basic auth Authorization header field parser

2.0.1

702

MIT

JavaScript

1,639,098,511 3.9

Installations

npm install basic-auth

Pull Requests

Open

4

Total

32

Closed

17

Merged

11

Issues

Open

1

Total

27

Closed

26

Releases

2.0.1

v2.0.1

Published on 20 Sept 2018

2.0.0

v2.0.0

Published on 13 Sept 2017

1.1.0

v1.1.0

Published on 18 Nov 2016

1.0.4

v1.0.4

Published on 18 Nov 2016

1.0.3

v1.0.3

Published on 18 Nov 2016

1.0.2

v1.0.2

Published on 18 Nov 2016

View all 9 releases

Developer

jshttp

Developer Guide

BETA

Module System

Unable to determine the module system for this package.

Min. Node Version

>= 0.8

Typescript Support

No

Node Version

8.12.0

NPM Version

6.4.1 Statistics

702 Stars

129 Commits

86 Forks

22 Watching

1 Branches

33 Contributors

Updated on 25 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

1,639,098,511

Last day

-0.5%

1,721,321

Compared to previous day

Last week

3.2%

9,069,048

Compared to previous week

Last month

9.1%

37,211,730

Compared to previous month

Last year

21.9%

380,733,340

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

safe-buffer

Dev Dependencies

mocha eslint istanbul eslint-plugin-node eslint-plugin-import eslint-plugin-promise eslint-config-standard eslint-plugin-markdown eslint-plugin-standard

Versions

basic-auth

Generic basic auth Authorization header field parser for whatever.

Installation

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install basic-auth

API

1var auth = require('basic-auth')

auth(req)

Get the basic auth credentials from the given request. The Authorization header is parsed and if the header is invalid, undefined is returned, otherwise an object with name and pass properties.

auth.parse(string)

Parse a basic auth authorization header string. This will return an object with name and pass properties, or undefined if the string is invalid.

Example

Pass a Node.js request object to the module export. If parsing fails undefined is returned, otherwise an object with .name and .pass.

1var auth = require('basic-auth')
2var user = auth(req)
3// => { name: 'something', pass: 'whatever' }

A header string from any other location can also be parsed with auth.parse, for example a Proxy-Authorization header:

1var auth = require('basic-auth')
2var user = auth.parse(req.getHeader('Proxy-Authorization'))

With vanilla node.js http server

1var http = require('http')
2var auth = require('basic-auth')
3var compare = require('tsscmp')
4
5// Create server
6var server = http.createServer(function (req, res) {
7  var credentials = auth(req)
8
9  // Check credentials
10  // The "check" function will typically be against your user store
11  if (!credentials || !check(credentials.name, credentials.pass)) {
12    res.statusCode = 401
13    res.setHeader('WWW-Authenticate', 'Basic realm="example"')
14    res.end('Access denied')
15  } else {
16    res.end('Access granted')
17  }
18})
19
20// Basic function to validate credentials for example
21function check (name, pass) {
22  var valid = true
23
24  // Simple method to prevent short-circuit and use timing-safe compare
25  valid = compare(name, 'john') && valid
26  valid = compare(pass, 'secret') && valid
27
28  return valid
29}
30
31// Listen
32server.listen(3000)

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

4

Security-Policy

Determines if the project has published a security policy.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.9

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to basic-auth

basic-auth-connect

1.1.0

Basic auth middleware for node and connect

@types/basic-auth

1.1.8

TypeScript definitions for basic-auth

express-basic-auth

1.2.1

Plug & play basic auth middleware for express

@fastify/basic-auth

6.0.1

Fastify basic auth plugin