npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hmac-sign-request

v1.0.9

Published

Sign requests with hmac

Downloads

6

Readme

HMAC Request Sign

This is used to sign request with hmac256 using clientId and secret. This package also contains express middleware to validate such signed requests.

Usage

Add request headers

import {setAuth} from 'hmac-sign-request';
import axios from "axios";
(async () => {
  const res = await axios.get('https://somewhere.com',  {
    headers: setAuth({
      client: 'client',
      secret: 'secret',
    })
  });
  console.log(res);
})();

Sign request

import {signRequest} from 'hmac-sign-request';

let req: Request; // initialize it

signRequest(req, 'client', 'secret');
console.log(req.header('authorization'));
//HMAC-SHA256 credential=client t=1608218828237,v1=644a323b5586d369220fc5efbcaf8c4bae7d74782c44b7ff49945231f8cc9e84

Create signature from object

import {createSignature} from 'hmac-sign-request';

console.log(createSignature('secret', {some: 'object'}));
// t=1608218828237,v1=644a323b5586d369220fc5efbcaf8c4bae7d74782c44b7ff49945231f8cc9e84

Create signature from Request

import {createSignatureFromRequest} from 'hmac-sign-request';

console.log(createSignatureFromRequest(req, 'client', 'secret'));
// t=1608218828237,v1=644a323b5586d369220fc5efbcaf8c4bae7d74782c44b7ff49945231f8cc9e84

Using express middleware

To configure middleware behaviour use environment variables:

# [Optional] 
# Period in minutes when reloading of hmacAuthMiddleware known clients is called.
# Default is 10 minutes
AUTH_CLIENT_REFRESH=10
# [Optional]
# The period of time in minutes while request is considered valid. Based on t= part of the authorization header.
# Default is 5 minutes
AUTH_REQUEST_TTL=5

For hmacAuthMiddleware provide a function that will update known clients Map.

import express from 'express';
import {hmacAuthMiddleware} from 'hmac-sign-request';

const app = express();

app.use(hmacAuthMiddleware((clients) => {
  clients.set('client', 'secret');
}));