Installations

npm install @stableness/basic-auth

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Min. Node Version

>= 0.8

Node Version

12.18.1

NPM Version

6.14.5 Score

68.8

Supply Chain

98.7

Quality

74.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

1

JavaScript

JavaScript (100%)

Developer

stableness

Download Statistics

Total Downloads

15,146

Last Day

1

Last Week

6

Last Month

17

Last Year

2,949

GitHub Statistics

MIT License

134 Commits

2 Branches

1 Contributors

Updated on Jul 02, 2020

Bundle Size

782.00 B

Minified

449.00 B

Minified + Gzipped

Bundlephobia

Maintainers

1

View All 1 Contributors

Package Meta Information

Latest Version

102.0.1

Package Id

@stableness/basic-auth@102.0.1

Unpacked Size

9.35 kB

Size

3.97 kB

File Count

6

NPM Version

6.14.5

Node Version

12.18.1

Total Downloads

Cumulative downloads

Total Downloads

15,146

Last Day

0%

1

Compared to previous day

Last Week

50%

6

Compared to previous week

Last Month

-29.2%

17

Compared to previous month

Last Year

-5.5%

2,949

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

9

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

Dangerous-Workflow

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

10

Binary-Artifacts

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

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

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

SAST

Determines if the project uses static code analysis.

0

Pinned-Dependencies

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

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

Security-Policy

Determines if the project has published a security policy.

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

3.4

/10

Last Scanned on 2025-04-28

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