secure-destroy-key

1.0.1 • Public • Published

secure-destroy-key

Build Status

Destroy a Secure Buffer key safely

A piece in the puzzle towards secure-key-management

Usage

var destroyKey = require('secure-destroy-key')
destroyKey(key)

⚠️ Warnings:

  • Once the key is destroyed, any access to it (whether read or write) will crash your program with no mercy

API

destroyKey(secureBuf)

secureBuf must be a Secure Buffer created with sodium-native@2.4 or greater.

Destroying the secureBuf will safely wipe the key from memory and mark it for noaccess, to prevent any accidental misuse.

Note that the secureBuf looks like a normal Buffer, but has some extra properties. You can read more about Secure Buffers on secure-key-management Be wary about using any of the default Buffer operations on this Secure Buffer.

Install

npm install secure-destroy-key

License

ISC

/secure-destroy-key/

    Package Sidebar

    Install

    npm i secure-destroy-key

    Weekly Downloads

    2

    Version

    1.0.1

    License

    ISC

    Last publish

    Collaborators

    • emilbayes