# secure-destroy-key

> Destroy a Secure Buffer key safely

Latest version **1.0.1** (published 2017-12-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install secure-destroy-key
pnpm add secure-destroy-key
yarn add secure-destroy-key
bun add secure-destroy-key
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-12-20 |
| First published | 2017-12-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Emil Bay |
| Maintainers | emilbayes |

## Links

- npm: https://www.npmjs.com/package/secure-destroy-key
- Repository: https://github.com/emilbayes/secure-destroy-key
- Homepage: https://github.com/emilbayes/secure-destroy-key#readme
- Issues: https://github.com/emilbayes/secure-destroy-key/issues
- npm.io page: https://npm.io/package/secure-destroy-key

## Dependencies (3)

- [nanoassert](https://npm.io/package/nanoassert.md) ^1.1.0
- [sodium-native](https://npm.io/package/sodium-native.md) ^2.1.2
- [is-secure-buffer](https://npm.io/package/is-secure-buffer.md) ^1.0.0

## Recent versions

- 1.0.1 (latest) — 2017-12-20
- 1.0.0 — 2017-12-17

## README

# `secure-destroy-key`

[![Build Status](https://travis-ci.org/emilbayes/secure-destroy-key.svg?branch=master)](https://travis-ci.org/emilbayes/secure-destroy-key)

> Destroy a Secure Buffer key safely

A piece in the puzzle towards [`secure-key-management`](https://github.com/emilbayes/secure-key-management)

## Usage

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

**:warning: 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`](https://github.com/emilbayes/secure-key-management#secure-buffers)
Be wary about using any of the default Buffer operations on this Secure Buffer.

## Install

```sh
npm install secure-destroy-key
```

## License

[ISC](LICENSE)

---
_Source: https://npm.io/package/secure-destroy-key · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._