# http-auth-utils
> Parse, build and deal with HTTP authorization headers.
Latest version **7.1.0** (published 2026-09-07) · MIT license · 0 weekly downloads
## Install
```sh
npm install http-auth-utils
pnpm add http-auth-utils
yarn add http-auth-utils
bun add http-auth-utils
```
## Health
**Score 70/100 (B)** — status: active.
Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.
Warnings: low downloads.
## Facts
| | |
|---|---|
| Version | 7.1.0 |
| Published | 2026-09-07 |
| First published | 2015-05-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=24.14.0 |
| Dependencies | 1 |
| Unpacked size | 205.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nicolas Froidure |
| Maintainers | nfroidure |
| Keywords | REST, HTTP, auth, authentication, authorization, basic, digest, bearer |
## Links
- npm: https://www.npmjs.com/package/http-auth-utils
- Repository: https://github.com/nfroidure/http-auth-utils
- Issues: https://github.com/nfroidure/http-auth-utils/issues
- Funding: https://github.com/sponsors/nfroidure
- npm.io page: https://npm.io/package/http-auth-utils
## Dependencies (1)
- [yerror](https://npm.io/package/yerror.md) ^11.0.0
## Alternatives
- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
## Recent versions
- 7.1.0 (latest) — 2026-09-07
- 7.0.1 — 2026-04-07
- 7.0.0 — 2026-03-27
- 6.0.1 — 2024-07-15
- 6.0.0 — 2024-01-14
- 5.0.1 — 2023-08-16
- 5.0.0 — 2023-08-12
- 4.0.0 — 2023-03-09
- 3.0.5 — 2023-01-05
- 3.0.4 — 2022-09-01
- 3.0.3 — 2022-05-25
- 3.0.2 — 2021-12-15
- 3.0.1 — 2021-04-09
- 3.0.0 — 2020-12-06
- 2.6.0 — 2020-09-15
- … 11 more at https://npm.io/package/http-auth-utils/versions
## README
[//]: # ( )
[//]: # (This file is automatically generated by a `metapak`)
[//]: # (module. Do not change it except between the)
[//]: # (`content:start/end` flags, your changes would)
[//]: # (be overridden.)
[//]: # ( )
# http-auth-utils
> Parse, build and deal with HTTP authorization headers.
[](https://github.com/nfroidure/http-auth-utils/blob/main/LICENSE)
[//]: # (::contents:start)
This library provide several utilities to parse and build WWW-Authenticate and
Authorization headers as described per the HTTP RFC.
It is intended to be framework agnostic and could be used either on the server
and the client side. It is also pure functions only, no side effect here. The
functions are synchronous since only parsing headers of small size so no need
for streams or anything asynchronous.
The module is easily extensible with new mechanisms, one very common way to
extend it is to create a `FAKE_TOKEN` mechanism for development only that allows
to directly provide the userId that should be authenticated. You can find
[an sample implementation](https://github.com/nfroidure/whook/blob/master/packages/whook-example/src/services/MECHANISMS.ts)
in the Whook's framework repository.
[//]: # (::contents:end)
# API
## Modules
- http-auth-utils
- http-auth-utils/mechanisms/basic
- http-auth-utils/mechanisms/bearer
- http-auth-utils/mechanisms/digest
## http-auth-utils
* [http-auth-utils](#module_http-auth-utils)
* _static_
* [.parseWWWAuthenticateHeader(header, [authMechanisms], [options])](#module_http-auth-utils.parseWWWAuthenticateHeader) ⇒ Object
* [.parseAuthorizationHeader(header, [authMechanisms], [options])](#module_http-auth-utils.parseAuthorizationHeader) ⇒ Object
* [.buildWWWAuthenticateHeader(authMechanism, The)](#module_http-auth-utils.buildWWWAuthenticateHeader) ⇒ string
* [.buildAuthorizationHeader(authMechanism, The)](#module_http-auth-utils.buildAuthorizationHeader) ⇒ string
* _inner_
* [~mechanisms](#module_http-auth-utils..mechanisms) : Array
### http-auth-utils.parseWWWAuthenticateHeader(header, [authMechanisms], [options]) ⇒ Object
Parse HTTP WWW-Authenticate header contents.
**Kind**: static method of [http-auth-utils](#module_http-auth-utils)
**Returns**: Object - Result of the contents parse.
**Api**: public
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| header | string | | The WWW-Authenticate header contents |
| [authMechanisms] | Array | [BASIC, DIGEST, BEARER] | Allow providing custom authentication mechanisms. |
| [options] | Object | | Parsing options |
| [options.strict] | boolean | true | Strictly detect the mechanism type (case sensitive) |
**Example**
```js
assert.deepEqual(
parseWWWAuthenticateHeader('Basic realm="test"'), {
type: 'Basic',
data: {
realm: 'test'
}
}
);
```
### http-auth-utils.parseAuthorizationHeader(header, [authMechanisms], [options]) ⇒ Object
Parse HTTP Authorization header contents.
**Kind**: static method of [http-auth-utils](#module_http-auth-utils)
**Returns**: Object - Result of the contents parse.
**Api**: public
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| header | string | | The Authorization header contents |
| [authMechanisms] | Array | [BASIC, DIGEST, BEARER] | Allow custom authentication mechanisms. |
| [options] | Object | | Parsing options |
| [options.strict] | boolean | true | Strictly detect the mechanism type (case sensitive) |
**Example**
```js
assert.deepEqual(
parseAuthorizationHeader('Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='), {
type: 'Basic',
data: {
hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
}
}
);
```
### http-auth-utils.buildWWWAuthenticateHeader(authMechanism, The) ⇒ string
Build HTTP WWW-Authenticate header value.
**Kind**: static method of [http-auth-utils](#module_http-auth-utils)
**Returns**: string - The header value.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| authMechanism | Object | The mechanism to use |
| The | Object | WWW-Authenticate header contents to base the value on. |
**Example**
```js
assert.deepEqual(
buildWWWAuthenticateHeader(BASIC, {
realm: 'test'
}),
'Basic realm="test"'
);
```
### http-auth-utils.buildAuthorizationHeader(authMechanism, The) ⇒ string
Build HTTP Authorization header value.
**Kind**: static method of [http-auth-utils](#module_http-auth-utils)
**Returns**: string - The header value.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| authMechanism | Object | The mechanism to use |
| The | Object | Authorization header contents to base the value on. |
**Example**
```js
assert.deepEqual(
buildAuthorizationHeader(BASIC, {
realm: 'test'
}),
'Basic realm="test"'
);
```
### http-auth-utils~mechanisms : Array
Natively supported authentication mechanisms.
**Kind**: inner constant of [http-auth-utils](#module_http-auth-utils)
## http-auth-utils/mechanisms/basic
* [http-auth-utils/mechanisms/basic](#module_http-auth-utils/mechanisms/basic)
* [~BASIC](#module_http-auth-utils/mechanisms/basic..BASIC) : Object
* [.type](#module_http-auth-utils/mechanisms/basic..BASIC.type) : String
* [.parseWWWAuthenticateRest(rest)](#module_http-auth-utils/mechanisms/basic..BASIC.parseWWWAuthenticateRest) ⇒ Object
* [.buildWWWAuthenticateRest(data)](#module_http-auth-utils/mechanisms/basic..BASIC.buildWWWAuthenticateRest) ⇒ String
* [.parseAuthorizationRest(rest)](#module_http-auth-utils/mechanisms/basic..BASIC.parseAuthorizationRest) ⇒ Object
* [.buildAuthorizationRest(content)](#module_http-auth-utils/mechanisms/basic..BASIC.buildAuthorizationRest) ⇒ String
* [.computeHash(credentials)](#module_http-auth-utils/mechanisms/basic..BASIC.computeHash) ⇒ String
* [.decodeHash(hash)](#module_http-auth-utils/mechanisms/basic..BASIC.decodeHash) ⇒ Object
### http-auth-utils/mechanisms/basic~BASIC : Object
Basic authentication mechanism.
**Kind**: inner constant of [http-auth-utils/mechanisms/basic](#module_http-auth-utils/mechanisms/basic)
**See**: http://tools.ietf.org/html/rfc2617#section-2
* [~BASIC](#module_http-auth-utils/mechanisms/basic..BASIC) : Object
* [.type](#module_http-auth-utils/mechanisms/basic..BASIC.type) : String
* [.parseWWWAuthenticateRest(rest)](#module_http-auth-utils/mechanisms/basic..BASIC.parseWWWAuthenticateRest) ⇒ Object
* [.buildWWWAuthenticateRest(data)](#module_http-auth-utils/mechanisms/basic..BASIC.buildWWWAuthenticateRest) ⇒ String
* [.parseAuthorizationRest(rest)](#module_http-auth-utils/mechanisms/basic..BASIC.parseAuthorizationRest) ⇒ Object
* [.buildAuthorizationRest(content)](#module_http-auth-utils/mechanisms/basic..BASIC.buildAuthorizationRest) ⇒ String
* [.computeHash(credentials)](#module_http-auth-utils/mechanisms/basic..BASIC.computeHash) ⇒ String
* [.decodeHash(hash)](#module_http-auth-utils/mechanisms/basic..BASIC.decodeHash) ⇒ Object
#### BASIC.type : String
The Basic auth mechanism prefix.
**Kind**: static property of [BASIC](#module_http-auth-utils/mechanisms/basic..BASIC)
#### BASIC.parseWWWAuthenticateRest(rest) ⇒ Object
Parse the WWW Authenticate header rest.
**Kind**: static method of [BASIC](#module_http-auth-utils/mechanisms/basic..BASIC)
**Returns**: Object - Object representing the result of the parse operation.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| rest | String | The header rest (string after the authentication mechanism prefix). |
**Example**
```js
assert.deepEqual(
BASIC.parseWWWAuthenticateRest('realm="perlinpinpin"'), {
realm: 'perlinpinpin'
}
);
```
#### BASIC.buildWWWAuthenticateRest(data) ⇒ String
Build the WWW Authenticate header rest.
**Kind**: static method of [BASIC](#module_http-auth-utils/mechanisms/basic..BASIC)
**Returns**: String - The built rest.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| data | Object | The content from wich to build the rest. |
**Example**
```js
assert.equal(
BASIC.buildWWWAuthenticateRest({
realm: 'perlinpinpin'
}),
'realm="perlinpinpin"'
);
```
#### BASIC.parseAuthorizationRest(rest) ⇒ Object
Parse the Authorization header rest.
**Kind**: static method of [BASIC](#module_http-auth-utils/mechanisms/basic..BASIC)
**Returns**: Object - Object representing the result of the parse operation {hash}.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| rest | String | The header rest (string after the authentication mechanism prefix).) |
**Example**
```js
assert.deepEqual(
BASIC.parseAuthorizationRest('QWxpIEJhYmE6b3BlbiBzZXNhbWU='), {
hash: 'QWxpIEJhYmE6b3BlbiBzZXNhbWU=',
username: 'Ali Baba',
password: 'open sesame'
}
);
```
#### BASIC.buildAuthorizationRest(content) ⇒ String
Build the Authorization header rest.
**Kind**: static method of [BASIC](#module_http-auth-utils/mechanisms/basic..BASIC)
**Returns**: String - The rest built.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| content | Object | The content from wich to build the rest. |
**Example**
```js
assert.equal(
BASIC.buildAuthorizationRest({
hash: 'QWxpIEJhYmE6b3BlbiBzZXNhbWU='
}),
'QWxpIEJhYmE6b3BlbiBzZXNhbWU='
);
```
#### BASIC.computeHash(credentials) ⇒ String
Compute the Basic authentication hash from the given credentials.
**Kind**: static method of [BASIC](#module_http-auth-utils/mechanisms/basic..BASIC)
**Returns**: String - The hash representing the credentials.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| credentials | Object | The credentials to encode {username, password}. |
**Example**
```js
assert.equal(
BASIC.computeHash({
username: 'Ali Baba',
password: 'open sesame'
}),
'QWxpIEJhYmE6b3BlbiBzZXNhbWU='
);
```
#### BASIC.decodeHash(hash) ⇒ Object
Decode the Basic hash and return the corresponding credentials.
**Kind**: static method of [BASIC](#module_http-auth-utils/mechanisms/basic..BASIC)
**Returns**: Object - Object representing the credentials {username, password}.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| hash | String | The hash. |
**Example**
```js
assert.deepEqual(
BASIC.decodeHash('QWxpIEJhYmE6b3BlbiBzZXNhbWU='), {
username: 'Ali Baba',
password: 'open sesame'
}
);
```
## http-auth-utils/mechanisms/bearer
* [http-auth-utils/mechanisms/bearer](#module_http-auth-utils/mechanisms/bearer)
* [~BEARER](#module_http-auth-utils/mechanisms/bearer..BEARER) : Object
* [.type](#module_http-auth-utils/mechanisms/bearer..BEARER.type) : String
* [.parseWWWAuthenticateRest(rest)](#module_http-auth-utils/mechanisms/bearer..BEARER.parseWWWAuthenticateRest) ⇒ Object
* [.buildWWWAuthenticateRest(data)](#module_http-auth-utils/mechanisms/bearer..BEARER.buildWWWAuthenticateRest) ⇒ String
* [.parseAuthorizationRest(rest)](#module_http-auth-utils/mechanisms/bearer..BEARER.parseAuthorizationRest) ⇒ Object
* [.buildAuthorizationRest(content)](#module_http-auth-utils/mechanisms/bearer..BEARER.buildAuthorizationRest) ⇒ String
### http-auth-utils/mechanisms/bearer~BEARER : Object
Bearer authentication mechanism.
**Kind**: inner constant of [http-auth-utils/mechanisms/bearer](#module_http-auth-utils/mechanisms/bearer)
**See**: https://tools.ietf.org/html/rfc6750#section-3
* [~BEARER](#module_http-auth-utils/mechanisms/bearer..BEARER) : Object
* [.type](#module_http-auth-utils/mechanisms/bearer..BEARER.type) : String
* [.parseWWWAuthenticateRest(rest)](#module_http-auth-utils/mechanisms/bearer..BEARER.parseWWWAuthenticateRest) ⇒ Object
* [.buildWWWAuthenticateRest(data)](#module_http-auth-utils/mechanisms/bearer..BEARER.buildWWWAuthenticateRest) ⇒ String
* [.parseAuthorizationRest(rest)](#module_http-auth-utils/mechanisms/bearer..BEARER.parseAuthorizationRest) ⇒ Object
* [.buildAuthorizationRest(content)](#module_http-auth-utils/mechanisms/bearer..BEARER.buildAuthorizationRest) ⇒ String
#### BEARER.type : String
The Bearer auth mechanism prefix.
**Kind**: static property of [BEARER](#module_http-auth-utils/mechanisms/bearer..BEARER)
#### BEARER.parseWWWAuthenticateRest(rest) ⇒ Object
Parse the WWW Authenticate header rest.
**Kind**: static method of [BEARER](#module_http-auth-utils/mechanisms/bearer..BEARER)
**Returns**: Object - Object representing the result of the parse operation.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| rest | String | The header rest (string after the authentication mechanism prefix). |
**Example**
```js
assert.deepEqual(
BEARER.parseWWWAuthenticateRest(
'realm="testrealm@host.com", ' +
'scope="openid profile email"'
), {
realm: 'testrealm@host.com',
scope: 'openid profile email',
}
);
```
#### BEARER.buildWWWAuthenticateRest(data) ⇒ String
Build the WWW Authenticate header rest.
**Kind**: static method of [BEARER](#module_http-auth-utils/mechanisms/bearer..BEARER)
**Returns**: String - The built rest.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| data | Object | The content from wich to build the rest. |
**Example**
```js
assert.equal(
BEARER.buildWWWAuthenticateRest({
realm: 'testrealm@host.com',
error: 'invalid_request',
error_description: 'The access token expired',
}),
'realm="testrealm@host.com", ' +
'error="invalid_request", ' +
'error_description="The access token expired"'
);
```
#### BEARER.parseAuthorizationRest(rest) ⇒ Object
Parse the Authorization header rest.
**Kind**: static method of [BEARER](#module_http-auth-utils/mechanisms/bearer..BEARER)
**Returns**: Object - Object representing the result of the parse operation {hash}.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| rest | String | The header rest (string after the authentication mechanism prefix).) |
**Example**
```js
assert.deepEqual(
BEARER.parseAuthorizationRest('mF_9.B5f-4.1JqM'), {
hash: 'mF_9.B5f-4.1JqM',
}
);
```
#### BEARER.buildAuthorizationRest(content) ⇒ String
Build the Authorization header rest.
**Kind**: static method of [BEARER](#module_http-auth-utils/mechanisms/bearer..BEARER)
**Returns**: String - The rest built.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| content | Object | The content from wich to build the rest. |
**Example**
```js
assert.equal(
BEARER.buildAuthorizationRest({
hash: 'mF_9.B5f-4.1JqM'
}),
'mF_9.B5f-4.1JqM=='
);
```
## http-auth-utils/mechanisms/digest
* [http-auth-utils/mechanisms/digest](#module_http-auth-utils/mechanisms/digest)
* [~DIGEST](#module_http-auth-utils/mechanisms/digest..DIGEST) : Object
* [.type](#module_http-auth-utils/mechanisms/digest..DIGEST.type) : String
* [.parseWWWAuthenticateRest(rest)](#module_http-auth-utils/mechanisms/digest..DIGEST.parseWWWAuthenticateRest) ⇒ Object
* [.buildWWWAuthenticateRest(data)](#module_http-auth-utils/mechanisms/digest..DIGEST.buildWWWAuthenticateRest) ⇒ String
* [.parseAuthorizationRest(rest)](#module_http-auth-utils/mechanisms/digest..DIGEST.parseAuthorizationRest) ⇒ Object
* [.buildAuthorizationRest(data)](#module_http-auth-utils/mechanisms/digest..DIGEST.buildAuthorizationRest) ⇒ String
* [.computeHash(data)](#module_http-auth-utils/mechanisms/digest..DIGEST.computeHash) ⇒ String
### http-auth-utils/mechanisms/digest~DIGEST : Object
Digest authentication mechanism.
**Kind**: inner constant of [http-auth-utils/mechanisms/digest](#module_http-auth-utils/mechanisms/digest)
**See**
- http://tools.ietf.org/html/rfc2617#section-3
- http://tools.ietf.org/html/rfc2069#section-2
* [~DIGEST](#module_http-auth-utils/mechanisms/digest..DIGEST) : Object
* [.type](#module_http-auth-utils/mechanisms/digest..DIGEST.type) : String
* [.parseWWWAuthenticateRest(rest)](#module_http-auth-utils/mechanisms/digest..DIGEST.parseWWWAuthenticateRest) ⇒ Object
* [.buildWWWAuthenticateRest(data)](#module_http-auth-utils/mechanisms/digest..DIGEST.buildWWWAuthenticateRest) ⇒ String
* [.parseAuthorizationRest(rest)](#module_http-auth-utils/mechanisms/digest..DIGEST.parseAuthorizationRest) ⇒ Object
* [.buildAuthorizationRest(data)](#module_http-auth-utils/mechanisms/digest..DIGEST.buildAuthorizationRest) ⇒ String
* [.computeHash(data)](#module_http-auth-utils/mechanisms/digest..DIGEST.computeHash) ⇒ String
#### DIGEST.type : String
The Digest auth mechanism prefix.
**Kind**: static property of [DIGEST](#module_http-auth-utils/mechanisms/digest..DIGEST)
#### DIGEST.parseWWWAuthenticateRest(rest) ⇒ Object
Parse the WWW Authenticate header rest.
**Kind**: static method of [DIGEST](#module_http-auth-utils/mechanisms/digest..DIGEST)
**Returns**: Object - Object representing the result of the parse operation.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| rest | String | The header rest (string after the authentication mechanism prefix). |
**Example**
```js
assert.deepEqual(
DIGEST.parseWWWAuthenticateRest(
'realm="testrealm@host.com", ' +
'qop="auth, auth-int", ' +
'nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093", ' +
'opaque="5ccc069c403ebaf9f0171e9517f40e41"'
), {
realm: 'testrealm@host.com',
qop: 'auth, auth-int',
nonce: 'dcd98b7102dd2f0e8b11d0f600bfb0c093',
opaque: '5ccc069c403ebaf9f0171e9517f40e41'
}
);
```
#### DIGEST.buildWWWAuthenticateRest(data) ⇒ String
Build the WWW Authenticate header rest.
**Kind**: static method of [DIGEST](#module_http-auth-utils/mechanisms/digest..DIGEST)
**Returns**: String - The built rest.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| data | Object | The content from which to build the rest. |
**Example**
```js
assert.equal(
DIGEST.buildWWWAuthenticateRest({
realm: 'testrealm@host.com',
qop: 'auth, auth-int',
nonce: 'dcd98b7102dd2f0e8b11d0f600bfb0c093',
opaque: '5ccc069c403ebaf9f0171e9517f40e41',
stale: 'false',
algorithm: 'MD5'
}),
'realm="testrealm@host.com", ' +
'nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093", ' +
'opaque="5ccc069c403ebaf9f0171e9517f40e41", ' +
'stale=false, ' +
'algorithm=MD5, ' +
'qop="auth, auth-int"'
);
```
#### DIGEST.parseAuthorizationRest(rest) ⇒ Object
Parse the Authorization header rest.
**Kind**: static method of [DIGEST](#module_http-auth-utils/mechanisms/digest..DIGEST)
**Returns**: Object - Object representing the result of the parse operation {hash}.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| rest | String | The header rest (string after the authentication mechanism prefix).) |
**Example**
```js
assert.deepEqual(
DIGEST.parseAuthorizationRest(
'username="Mufasa",' +
'realm="testrealm@host.com",' +
'nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093",' +
'uri="/dir/index.html",' +
'algorithm=MD5,' +
'qop=auth,' +
'nc=00000001,' +
'cnonce="0a4f113b",' +
'response="6629fae49393a05397450978507c4ef1",' +
'opaque="5ccc069c403ebaf9f0171e9517f40e41"'
), {
username: "Mufasa",
realm: 'testrealm@host.com',
nonce: "dcd98b7102dd2f0e8b11d0f600bfb0c093",
uri: "/dir/index.html",
algorithm: 'MD5',
qop: 'auth',
nc: '00000001',
cnonce: "0a4f113b",
response: "6629fae49393a05397450978507c4ef1",
opaque: "5ccc069c403ebaf9f0171e9517f40e41"
}
);
```
#### DIGEST.buildAuthorizationRest(data) ⇒ String
Build the Authorization header rest.
**Kind**: static method of [DIGEST](#module_http-auth-utils/mechanisms/digest..DIGEST)
**Returns**: String - The rest built.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| data | Object | The content from which to build the rest. |
**Example**
```js
assert.equal(
DIGEST.buildAuthorizationRest({
username: "Mufasa",
realm: 'testrealm@host.com',
nonce: "dcd98b7102dd2f0e8b11d0f600bfb0c093",
uri: "/dir/index.html",
algorithm: 'MD5',
qop: 'auth',
nc: '00000001',
cnonce: "0a4f113b",
response: "6629fae49393a05397450978507c4ef1",
opaque: "5ccc069c403ebaf9f0171e9517f40e41"
}),
'username="Mufasa", ' +
'realm="testrealm@host.com", ' +
'nonce="dcd98b7102dd2f0e8b11d0f600bfb0c093", ' +
'uri="/dir/index.html", ' +
'response="6629fae49393a05397450978507c4ef1", ' +
'algorithm=MD5, ' +
'cnonce="0a4f113b", ' +
'opaque="5ccc069c403ebaf9f0171e9517f40e41", ' +
'qop=auth, ' +
'nc=00000001'
);
```
#### DIGEST.computeHash(data) ⇒ String
Compute the Digest authentication hash from the given credentials.
**Kind**: static method of [DIGEST](#module_http-auth-utils/mechanisms/digest..DIGEST)
**Returns**: String - The hash representing the credentials.
**Api**: public
| Param | Type | Description |
| --- | --- | --- |
| data | Object | The credentials to encode and other encoding details. |
**Example**
```js
assert.equal(
DIGEST.computeHash({
username: 'Mufasa',
realm: 'testrealm@host.com',
password: 'Circle Of Life',
method: 'GET',
uri: '/dir/index.html',
nonce: 'dcd98b7102dd2f0e8b11d0f600bfb0c093',
nc: '00000001',
cnonce: '0a4f113b',
qop: 'auth',
algorithm: 'md5'
}),
'6629fae49393a05397450978507c4ef1'
);
```
# Authors
- [Nicolas Froidure](https://insertafter.com/en/index.html)
- [Jake Pruitt](https://github.com/jakepruitt)
- [Corentin Girard](https://github.com/Drarig29)
- [Roman Sokolov](https://github.com/Stillness-2)
# License
[MIT](https://github.com/nfroidure/http-auth-utils/blob/main/LICENSE)
---
_Source: https://npm.io/package/http-auth-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._