npmpackage.info

Gathering detailed insights and metrics for basic-auth

Other packages similar to basic-auth

express-basic-auth

1.2.1

Plug & play basic auth middleware for express

basic-auth-connect

1.1.0

Basic auth middleware for node and connect

@types/basic-auth

1.1.8

TypeScript definitions for basic-auth

koa-basic-auth

4.0.0

Blanket basic auth middleware for koa

Gathering detailed insights and metrics for basic-auth

basic-auth - 2.0.1 | npmpackage.info

basic-auth

Generic basic auth Authorization header field parser

2.0.1

702

MIT

JavaScript

663.00 B

1,866,494,407 6.9

Installations

npm install basic-auth

Developer Guide

BETA

Typescript

No

Module System

N/A

Min. Node Version

>= 0.8

Node Version

8.12.0

NPM Version

6.4.1 Score

99.3

Supply Chain

99.4

Quality

81.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

8

Total

46

Closed

17

Merged

21

Issues

Open

3

Total

29

Closed

26

Releases

2.0.1

v2.0.1

Updated on Sep 20, 2018

2.0.0

v2.0.0

Updated on Sep 13, 2017

1.1.0

v1.1.0

Updated on Nov 18, 2016

1.0.4

v1.0.4

Updated on Nov 18, 2016

1.0.3

v1.0.3

Updated on Nov 18, 2016

1.0.2

v1.0.2

Updated on Nov 18, 2016

View All 9 releases

Languages

JavaScript

JavaScript (100%)

Developer

jshttp

Download Statistics

Total Downloads

1,866,494,407

Last Day

470,945

Last Week

8,864,526

Last Month

38,413,196

Last Year

430,172,034

GitHub Statistics

MIT License

702 Stars

139 Commits

89 Forks

21 Watchers

1 Branches

32 Contributors

Updated on Jun 24, 2025

Bundle Size

1.53 kB

Minified

663.00 B

Minified + Gzipped

Bundlephobia

Maintainers

View All 32 Contributors

Package Meta Information

Latest Version

2.0.1

Package Id

basic-auth@2.0.1

Size

3.66 kB

NPM Version

6.4.1

Node Version

8.12.0

Published on

Sep 20, 2018

Total Downloads

Cumulative downloads

Total Downloads

1,866,494,407

Last Day

3.4%

470,945

Compared to previous day

Last Week

-7.3%

8,864,526

Compared to previous week

Last Month

2.2%

38,413,196

Compared to previous month

Last Year

28.1%

430,172,034

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

safe-buffer

Dev Dependencies

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

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-circut 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

Token-Permissions

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

10

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

10

Contributors

Determines if the project has a set of contributors from multiple organizations (e.g., companies).

9

Security-Policy

Determines if the project has published a security policy.

8

SAST

Determines if the project uses static code analysis.

7

Maintained

Determines if the project is "actively maintained".

6

CI-Tests

Determines if the project runs tests before pull requests are merged.

3

Code-Review

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

2

Pinned-Dependencies

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

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.

Score

6.9

/10

Last Scanned on 2025-06-23T21:29:53Z

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