digest-fetch

What is digest-fetch?

The digest-fetch npm package is a library that provides HTTP Digest Access Authentication for making HTTP requests. It is particularly useful for interacting with APIs that require digest authentication, which is a more secure method compared to basic authentication.

What are digest-fetch's main functionalities?

Basic Usage

This feature demonstrates how to create a DigestFetch client with a username and password, and make a simple authenticated GET request.

const DigestFetch = require('digest-fetch');
const client = new DigestFetch('username', 'password');

client.fetch('http://httpbin.org/digest-auth/auth/user/pass').then(response => response.json()).then(data => console.log(data));

Custom Headers

This feature shows how to add custom headers to the request. The headers are specified in the options object passed to the fetch method.

const DigestFetch = require('digest-fetch');
const client = new DigestFetch('username', 'password');

const options = {
  headers: {
    'Custom-Header': 'CustomValue'
  }
};

client.fetch('http://httpbin.org/digest-auth/auth/user/pass', options).then(response => response.json()).then(data => console.log(data));

POST Request

This feature demonstrates how to make a POST request with a JSON body. The method and body are specified in the options object passed to the fetch method.

const DigestFetch = require('digest-fetch');
const client = new DigestFetch('username', 'password');

const options = {
  method: 'POST',
  body: JSON.stringify({ key: 'value' }),
  headers: {
    'Content-Type': 'application/json'
  }
};

client.fetch('http://httpbin.org/digest-auth/auth/user/pass', options).then(response => response.json()).then(data => console.log(data));

Other packages similar to digest-fetch

axios

Axios is a popular HTTP client for Node.js and the browser. While it does not natively support digest authentication, it can be extended with custom interceptors to handle digest authentication. Axios is more versatile and widely used compared to digest-fetch.

node-fetch

Node-fetch is a lightweight module that brings window.fetch to Node.js. Similar to axios, it does not natively support digest authentication but can be extended with custom logic. Node-fetch is simpler and more lightweight compared to digest-fetch.

request

Request is a comprehensive HTTP client for Node.js that supports various authentication methods, including digest authentication. However, it is now deprecated and not recommended for new projects. Request is more feature-rich but less maintained compared to digest-fetch.

README

digest-fetch

digest auth request plugin for fetch/node-fetch.

Installation

// dependencies for node
npm install node-fetch

// for browers, if to use it directly, please indcude file `digest-fetch.js` in a <script/> 
<script type="application/javascript" src="path-to-digest-fetch.js'></script>

Get Started

const DigestFetch = require('digest-fetch')
// In browser: const DigestFetch = window.DigestFetch;

Initialize with option and credential

const digestOptions = {
  cnonceSize: 32,    // length of cnonce, default: 32
  logger: console,   // logger for debug, default: none
  algorithm: 'MD5',  // algorithm to be used, 'MD5' or 'MD5-sess'

  // Custom authentication failure code for avoiding browser prompt:
  // https://stackoverflow.com/questions/9859627/how-to-prevent-browser-to-invoke-basic-auth-popup-and-handle-401-error-using-jqu
  statusCode: 401    // default 401
}

const client = new DigestFetch('user', 'password', digestOptions) 

Do request same way as fetch or node-fetch

const url = ''
const options = {}
client.fetch(url, options)
  .then(resp=>resp.json())
  .then(data=>console.log(data))
  .catch(e=>console.error(e))

Pass in refresh request options factory function for conditions options needs be refreshed when trying again. For example when posting with file stream:

const factory = () => ({ method: 'post', body: fs.createReadStream('path-to-file') })
client.fetch(url, {factory})
  .then(resp=>resp.json())
  .then(data=>console.log(data))
  .catch(e=>console.error(e))

Please open issues if you find bugs and meet problems during using this plugin.