View Code? Open in Web Editor NEW

A minimalistic public-key signing framework for TS / JS environments based on TweetNaCl and ED25519.

License: MIT License

TypeScript 94.52% Shell 5.48%

nano-signing's Introduction

nano-signing

A minimalistic public-key signing framework for TS / JS environments based on TweetNaCl and ED25519.

Installation

# Add to your dependencies using yarn
yarn add "nxtep-io/nano-signing";

# Or, using NPM
npm install "github:nxtep-io/nano-signing";

Getting Started

Key Pair Management

Generating a random keypair using the default encoding:

import { NanoSigning } from 'nano-signing';

const helper = new NanoSigning();

// Generates a random signer keypair
const signer = helper.keyPair();

// Dump keys as HEX encoded strings in the console
console.log({
  publicKey: signer.keyPair().publicKey(),
  secretKey: signer.keyPair().secretKey(),
});

// You can also access directly the base `nacl.SignKeyPair` instance
// with the original keys as Uint8Array buffers.
const raw = signer.raw();

Generating a keypair based on existing secretKey.

// Generates a random signer keypair
const signer = helper.keyPair({
  secretKey: myOwnSecret
});

Changing default encoding for the KeyPair.

Supported encodings: ascii, utf8, utf16le/ucs2, base64, binary/latin-1, and hex.

// Generates a random signer keypair
const signer = helper.keyPair({
  encoding: 'base64'
});

Further info at the Node.JS Buffer.toString() official documentation.

Data Signing

Generates simple data signature using a random key pair.

const originalData = { value: 123 }

// Generates a random signer keypair
const signer = helper.keyPair();

// Generates an encoded signature for input data
const signature = signer.sign(originalData, signer);

Validates existing signature against simple data signature using an existing public key.

// Validate candidate signature against the originalData and public key supplied
const signature = signer.verify(originalData, candidateSignature, publicKey);