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

ssb-private-group-keys

v1.1.2

Published

A collection of basic box2 functions for SSB

Downloads

1,336

Readme

ssb-private-group-keys

Basic helper functions implementing the private-group spec.

Currently supports classic & bendy butt feed types.

API

directMessageKey(x_dh_secret, x_dh_public, x_feed_id, y_dh_public, y_feed_id) => { key, scheme }

Create a shared key for communication between your feed and another feed.

If you are encrypting a DM, x is your feed, and y is the person you are DM'ing. If you are decrypting a DM, x is your feed, and y is the message author's.

  • NOTE: this is only for the case that the author is someone else, if you're the author, use your own_key

  • x_dh_secret, x_dh_public are feed x's diffie-hellman keys

  • x_feed_id is the feedId of x

  • y_dh_public is feed y's diffie-hellman public key

  • y_feed_id is the feedId of y

All inputs are BFE style buffers.

The output is a key (buffer) and associated scheme (string) which can be passed into an envelope key_slot

directMessageKey.easy(myKeys) => makeKey(feedId) => { key, scheme }

Convenience function which wraps directMessageKey


poBoxKey(x_dh_secret, x_dh_public, x_id, y_dh_public, y_id) => { key, scheme }

If you are encrypting to a P.O. Box, then x is your feed, and y is the P.O. Box. If you are decrypting a message sent to a P.O. Box, then x is the P.O. Box, and y is the message author's feed.

  • x_dh_secret, x_dh_public are x's diffie-hellman keys
  • x_id is the BFE id of x
  • y_dh_public is y's diffie-hellman public key
  • y_id is the BFE id of y

All inputs are BFE style buffers.

The output is a key (buffer) and associated scheme (string) which can be passed into an envelope key_slot

poBoxKey.easy(myKeys) => makeKey(poboxId) => { key, scheme }

Convenience function which wraps poBoxKey


new SecretKey(length?) => secretKey

Create a secret key that can be used for the group or message key.

methods:

  • secretKey.toBuffer() => buffer return raw buffer with the key data in it
  • secretKey.toString() => string returns a base64 encoded string of the key

new SecretKey(buffer) => secretKey

An alternative way to use the constructor, in case you already have the group key bytes as a buffer, is to pass the buffer as the argument. This simply "embodies" the group key as a SecretKey instance, it doesn't generate anything new.


new DiffieHellmanKeys(keys?, opts?) => dhKeys

alias: DHKeys

where:

  • keys Object (optional)
    • is a pair of keys { public, secret? }, each a Buffer or base64 encoded String
      • public is required, secret is optional
    • if not provided, you are expected to call dhKeys.generate() to generate a keypair
  • opts Object (optional)
    • opts.fromEd25519 Boolean sets whether the keys are ed25519 signing keys you would like converted to curve25519 encryption keys.
      • default: false
    • opts.format Integer sets whether the BFE "format" of the encryption key type
      • if opts.fromEd25519 = true was used, it's assumed these are dm keys (format = 0)
      • else format is not set, which is fine as long as you don't call dhKeys.toBFE()
  • dhKeys DiffieHellmanKeys instance with methods:
    • dhKeys.generate() => dhKeys - generates public and private dh keys
    • dhKeys.toBuffer() => { public: Buffer, secret: Buffer } - returns the raw keys as Buffers
    • dhKeys.toBFE() => { public: BFE, secret: BFE } - return BFE encodings of the keys (as Buffers)

DiffieHellmanKeys.scalarMult(A, B) => result

A class method for creating shared encryption keys.

  • A a DHKeys instance, must include secret key
  • B a DHKeys instance
  • result Buffer the result of the scalarMult
    • only useful in advanced cases to conserve memory

NOTE:

  • method also takes appropriately shaped objects, see source code.
  • there's an advanced signature if you need to conserve memory (A, B, result) => result

History

This library was originally extracted from ssb-tribes.