@douganderson444/symmetric-proxcryptor-wrapper v0.0.4

Symmetric Proxcryptor Wrapper

Simple library which wraps symmetric encryption around proxy re-encryption to make, share, and retrieve encrypted objects.

Why

The Proxcryptor from @peerpiper/iframe-wallet-sdk (via the browser connector) gives you the ability to:

• selfEncrypt data with your ed25519 private key
• selfDecrypt data with your ed25519 private key
• transformEncrypt data for another ed25519 public
• reDecrypt others' data data with your ed25519 private key

First, if that data is large, you'll likely want to symmetrically encrypt it first, then reEncrypt that symmetric key using transformEncrypt instead of transforming that data directly (since it's faster).

Second, the selfEncrypted key needs to be saved somewhere. JWE gives us the ability to add the key to the JWE object as Additional Authenticated Data (AAD), so the encryptedKey can easily yet securely be found witht the data object, making it convenient to transform for others when desired.

That is what this library does for you. Without this library, you'd have to do all of that manually.

API

import { SymJoseCryptor } from '@douganderson444/symmetric-proxcryptor-wrapper';

// get a `wallet` instance from https://www.npmjs.com/package/@peerpiper/web3-wallet-connector
const cryptor = new SymJoseCryptor(wallet.proxcryptor);

// self-encrypt a secret
const tag = 'MySecret';
const jwe = await cryptor.encryptTagSecrets({ secret: 'shhh just between us' }, tag);

// you can decrypt it yourself
const selfDecrypted = await cryptor.selfDecrypt(jwe);

// Typically, you will pass in another public key (base64, base58 or hex) to grant access to the secret
const theirReEncryptedKey = await cryptor.transform(publicKey, tag, jwe);

// on their machine
// now they can use this library to decrypt it
const decrypted = await cryptor.decrypt(theirReEncryptedKey, jwe); // {secret: 'shhh just between us'}

Integrations

Designed to work with any proxcryptor interoperable with the protocol at @peerpiper/iframe-wallet-sdk