sodium-native
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/sodium-native package

    3.3.0 • Public • Published

    sodium-native

    build status

    Low level bindings for libsodium.

    npm install sodium-native
    

    The goal of this project is to be thin, stable, unopionated wrapper around libsodium.

    All methods exposed are more or less a direct translation of the libsodium c-api. This means that most data types are buffers and you have to manage allocating return values and passing them in as arguments intead of receiving them as return values.

    This makes this API harder to use than other libsodium wrappers out there, but also means that you'll be able to get a lot of perf / memory improvements as you can do stuff like inline encryption / decryption, re-use buffers etc.

    This also makes this library useful as a foundation for more high level crypto abstractions that you want to make.

    Usage

    var sodium = require('sodium-native')
    
    var nonce = Buffer.alloc(sodium.crypto_secretbox_NONCEBYTES)
    var key = sodium.sodium_malloc(sodium.crypto_secretbox_KEYBYTES) // secure buffer
    var message = Buffer.from('Hello, World!')
    var ciphertext = Buffer.alloc(message.length + sodium.crypto_secretbox_MACBYTES)
    
    sodium.randombytes_buf(nonce) // insert random data into nonce
    sodium.randombytes_buf(key)  // insert random data into key
    
    // encrypted message is stored in ciphertext.
    sodium.crypto_secretbox_easy(ciphertext, message, nonce, key)
    
    console.log('Encrypted message:', ciphertext)
    
    var plainText = Buffer.alloc(ciphertext.length - sodium.crypto_secretbox_MACBYTES)
    
    if (!sodium.crypto_secretbox_open_easy(plainText, ciphertext, nonce, key)) {
      console.log('Decryption failed!')
    } else {
      console.log('Decrypted message:', plainText, '(' + plainText.toString() + ')')
    }

    Documentation

    Complete documentation may be found on the sodium-friends website

    License

    MIT

    Keywords

    none

    Install

    npm i sodium-native

    DownloadsWeekly Downloads

    44,397

    Version

    3.3.0

    License

    MIT

    Unpacked Size

    5.1 MB

    Total Files

    50

    Last publish

    Collaborators

    • mafintosh
    • emilbayes