# kms-stream

> Encrypt data with Amazon's KMS service

Latest version **1.0.0** (published 2015-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install kms-stream
pnpm add kms-stream
yarn add kms-stream
bun add kms-stream
```

## 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.0 |
| Published | 2015-04-15 |
| First published | 2015-04-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Drew Stokes |
| Maintainers | fullscreen |
| Keywords | kms, crypto, aws |

## Links

- npm: https://www.npmjs.com/package/kms-stream
- Repository: https://github.com/Fullscreen/node-kms-stream
- Issues: https://github.com/Fullscreen/node-kms-stream/issues
- npm.io page: https://npm.io/package/kms-stream

## Dependencies (5)

- [split](https://npm.io/package/split.md) ^0.3.3
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.1.23
- [through](https://npm.io/package/through.md) ^2.3.7
- [duplexer](https://npm.io/package/duplexer.md) ^0.1.1
- [binary-split](https://npm.io/package/binary-split.md) ^0.1.2

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2015-04-15

## README

kms-stream
==========

Encrypt / Decrypt data streams with Amazon's KMS service

example
=======
``` js
var fs = require('fs')
  , kms = require('kms-stream')(/* [ aws_config ] */);

// encrypt
var key;
var encryptStream = kms.encrypt('alias/MyKMSKey');
fs
  .createReadStream('./plaintext_secrets.txt')
  .pipe(encryptStream)
  .pipe(fs.createWriteStream('./encrypted_secrets.txt'));

// save encrypted data key
encryptStream.on('key', function(key) {
  key = key;
});

// decrypt
var myEncryptedDataKey = '...';
fs
  .createReadStream('./encrypted_secrets.txt')
  .pipe(kms.decrypt(myEncryptedDataKey))
  .pipe(process.stdout);
```

install
=======

With [npm](http://npmjs.org) do:

```
npm install kms-stream
```

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