[!CAUTION] NOTICE OF BREAKING CHANGE.

This library is under active development. Breaking changes may occur between versions.

LibSignal Plugins is a Rust + NAPI-RS library for cryptographic operations like key generation, signature verification, group encryption, and more, compatible with Node.js via TypeScript bindings.

Usage & Guide

[!IMPORTANT] The guide is a work in progress. Expect incomplete pages/content. Report missing or incorrect content.

You can also access the auto-generated TypeScript definitions here:

import {
  calculateAgreement,
  curve25519Sign,
  generateKeyPair,
  generatePreKey,
  generateRegistrationId,
  keyPair,
  sharedSecret,
  verify,
  verifySignature
} from 'libsignal-plugins';

examples

generate a keypair!

const keys = generateKeyPair();
console.log(keys.pubKey, keys.privKey);
// pub key is always a 33 bytes key, the first byte is always the version (5)

sharedSecret

const secret = sharedSecret(pubKeyBuffer, privKeyBuffer);
console.log(secret.toString('hex'));

signature Verification

const valid = verify(sigBuffer, pubKeyBuffer, messageBuffer);
console.log(valid); // true or false