ts-signify

ts-signify is a TypeScript implementation of OpenBSD's signify(1). It provides API for generating a key pair, signing a message with as well as verifying a signature.

This module has no dependency on Node.js built-in modules and doesn't require a polyfill to run in a browser.

Usage

Full example code is available under the /test directory.

Generate a key pair

import { generateKeyPair } from "ts-signify";

let keyPair = generateKeyPair({
  passphrase: "passphrase", // optional
}); // => { publicKey: "...", secretKey: "..." }

Sign a message

import { sign } from "ts-signify";

let signature = sign({
  comment: "verify with mock-key.pub",
  message: "[mock message]" + "\n",
  passphrase: "passphrase",
  secretKey: "...",
}); // => "untrusted comment: ..."

Verify a signature

import { verify } from "ts-signify";

let verified = verify({
  message: "[mock message]" + "\n",
  publicKey: "...",
  signature: "...",
}); // => boolean

API

generateKeyPair({ passphrase? }): KeyPair

Generates a key pair. Returns a KeyPair object that has publicKey and secretKey members.

sign({ comment, message, passphrase, secretKey }): string

Signs the message using the secret key and returns a signature.

verify({ message, publicKey, signature }): boolean

Verifies the signature for the message and returns true if verification succeeded and false if it failed.

Contributions

Contributions are welcome. Submit a pull request on GitHub or send a patch to hirokio@tutanota.com.

License

See LICENSE.