Needs Puma Managers

    @anvilco/encryption

    2.0.3 • Public • Published

    Anvil Encryption

    This library is a small wrapper around node's crypto library. It offers convenience methods for encrypting and decrypting arbitrary payloads in both AES and RSA.

    For use encrypting / decrypting payloads in Anvil, you can generate an RSA keypair from your organization's settings page.

    Horizontal Lockupblack Horizontal Lockup copywhite

    Anvil provides easy APIs for all things paperwork.

    1. PDF filling API - fill out a PDF template with a web request and structured JSON data.
    2. PDF generation API - send markdown or HTML and Anvil will render it to a PDF.
    3. Etch E-sign with API - customizable, embeddable, e-signature platform with an API to control the signing process end-to-end.
    4. Anvil Workflows (w/ API) - Webforms + PDF + E-sign with a powerful no-code builder. Easily collect structured data, generate PDFs, and request signatures.

    Learn more about Anvil on our Anvil developer page.

    Install

    yarn add @anvilco/encryption

    Then use it

    // For RSA functions
    import { encryptRSA, decryptRSA } from '@anvilco/encryption'
    
    // For AES functions
    import { generateAESKey, encryptAES, decryptAES } from '@anvilco/encryption'
    
    // Could grab the keys from file (or preferably from environment variables)
    import fs from 'fs'
    const privateKey = fs.readFileSync('path/to/privateKey.pem')
    const publicKey = fs.readFileSync('path/to/publicKey.pem')
    
    
    // RSA
    const message = 'Super secret message'
    const encryptedRSAMessage = encryptRSA(publicKey, message)
    const origRSAMessage = decryptRSA(privateKey, encryptedRSAMessage)
    console.log(origRSAMessage === message) // => true
    
    // AES
    const aesKey = generateAESKey()
    const encryptedAESMessage = encryptAES(aesKey, message)
    const origAESMessage = decryptAES(aesKey, encryptedAESMessage)
    console.log(origAESMessage === message) // => true

    API

    There are two functions for RSA: encryptRSA, decryptRSA, and three for AES: generateAESKey, encryptAES, decryptAES.

    AES

    There are three functions for AES:

    • key = generateAESKey()
    • encryptedMessage = encryptAES(key, plainMessage)
    • plainMessage = decryptAES(key, encryptedMessage)

    encryptAES creates a unique IV for each message encrypted and prepends it to the resulting encrypted payload. So encryptedMessage will be in the format

    <iv>:<aesEncryptedPayload>
    

    RSA

    There are two functions for RSA:

    • encryptedMessage = encryptRSA(publicKey, plainMessage)
    • plainMessage = decryptRSA(privateKey, encryptedMessage)

    These functions encrypt / decrypt with RSA and AES. RSA has an upper limit on how much data it can encrypt. So we create an AES key, encrypt the AES key with RSA, then encrypt the actual message with AES.

    Note the encrypted payload (result of encryptRSA) is in the format:

    <rsaEncryptedAESKey>:<aesEncryptedMessage>
    

    Generating RSA keys

    This library does not have a way to generate RSA keys.

    You could use openssl:

    # This generates a 2048 bit private key to file
    openssl genrsa -out privateKey.pem 2048
    
    # This extracts the public key to file
    openssl rsa -in privateKey.pem -outform PEM -pubout -out publicKey.pem

    You could also use something like node-rsa:

    // Example generating a RSA keypair with node-rsa
    import NodeRSA from 'node-rsa'
    function generateRSAKeypair () {
      const key = new NodeRSA()
      key.generateKeyPair(2048, 65537)
      return {
        publicKey: key.exportKey('pkcs8-public-pem'),
        privateKey: key.exportKey('pkcs8-private-pem'),
      }
    }

    License

    MIT

    Install

    npm i @anvilco/encryption

    DownloadsWeekly Downloads

    633

    Version

    2.0.3

    License

    MIT

    Unpacked Size

    107 kB

    Total Files

    6

    Last publish

    Collaborators

    • allan-anvil
    • benogle
    • anvilbot
    • newhouse
    • winggo
    • fostimus