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

@0xpass/key-signer

v2.0.1

Published

The KeySigner library is designed to simplify cryptographic operations involving the generation of digital signatures and the verification of those signatures. Built on top of Node.js's native `crypto` module, it abstracts away some of the complexities in

Downloads

52

Readme

KeySigner Library

The KeySigner library is designed to simplify cryptographic operations involving the generation of digital signatures and the verification of those signatures. Built on top of Node.js's native crypto module, it abstracts away some of the complexities involved in handling keys and performing cryptographic signing and verification.

Installation

npm install @0xpass/key-signer

or

pnpm install @0xpass/key-signer

Usage

Initializing KeySigner

To create a new instance of KeySigner, you need to provide the private key. The private key can be supplied either as a path to a DER-encoded file in PKCS#8 format or as a base64-encoded string. This key can be generated using the openssl command-line tool, or the passport-scope cli passport-scope-cli package.

import { KeySigner } from "./path/to/keysigner";

// Using a file path
const signer = new KeySigner("/path/to/private_key.der");

// Using a base64-encoded string
const signerBase64 = new KeySigner("base64PrivateKeyString", true);

Creating a Signature

To sign data, use the createSignature method with the data you wish to sign as a string. This method returns the signature in a base64-encoded format.

const signature = signer.createSignature("data to be signed");
console.log(signature);

Creating a Signature Header

To create an HTTP header containing the signature, use the createSignatureHeader method. This can be useful for authenticated requests. This can be used for generating and formatting the correct headers for authentication requests to passport.

const { signatureHeaderName, signatureHeaderValue } =
  await signer.createSignatureHeader("data to be signed");
console.log(signatureHeaderName, signatureHeaderValue);

Verifying a Signature

To verify a signature, use the verifySignature static method, providing the original data, the signature to verify, and the public key. The public key can be supplied either as a path to a DER-encoded file in SPKI format or as a base64-encoded string.

const isVerified = KeySigner.verifySignature(
  "data to be signed",
  signature,
  "/path/to/public_key.der"
);
console.log(isVerified); // true or false