Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hex7c0/autokey
autokey stream cipher for Nodejs
https://github.com/hex7c0/autokey
autokey cipher nodejs
Last synced: about 1 month ago
JSON representation
autokey stream cipher for Nodejs
- Host: GitHub
- URL: https://github.com/hex7c0/autokey
- Owner: hex7c0
- License: gpl-3.0
- Created: 2014-07-09T16:05:53.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-09-05T01:02:15.000Z (over 1 year ago)
- Last Synced: 2024-11-17T18:08:58.427Z (about 2 months ago)
- Topics: autokey, cipher, nodejs
- Language: JavaScript
- Homepage: https://github.com/hex7c0/autokey
- Size: 249 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# [autokey](https://github.com/hex7c0/autokey)
[](https://www.npmjs.com/package/autokey)
[](https://travis-ci.org/hex7c0/autokey)
[](https://ci.appveyor.com/project/hex7c0/autokey)
[](https://david-dm.org/hex7c0/autokey)
[](https://coveralls.io/r/hex7c0/autokey)
[Autokey](http://en.wikipedia.org/wiki/Autokey_cipher) stream cipher.
Encode/decode with different [encodings](http://nodejs.org/api/buffer.html#apicontent) _for *String only_, from nodejs doc:
> - 'ascii' - for 7 bit ASCII data only. This encoding method is very fast, and will strip the high bit if set.
> - 'utf8' - Multibyte encoded Unicode characters. Many web pages and other document formats use UTF-8.
> - 'utf16le' - 2 or 4 bytes, little endian encoded Unicode characters. Surrogate pairs (U+10000 to U+10FFFF) are supported.
> - 'ucs2' - Alias of 'utf16le'.
> - 'base64' - Base64 string encoding.
> - 'binary' - A way of encoding raw binary data into strings by using only the first 8 bits of each character. This encoding method is deprecated and should be avoided in favor of Buffer objects where possible. This encoding will be removed in future versions of Node.
> - 'hex' - Encode each byte as two hexadecimal characters.
My original [python code](https://github.com/hex7c0/EncryptoPy/blob/master/modules/autokey.py)
## Installation
Install through NPM
```bash
npm install autokey
```
or
```bash
git clone git://github.com/hex7c0/autokey.git
```
## API
inside nodejs project
```js
var autokey = require('autokey');
var cipher = autokey('secret_key');
var d = cipher.encodeString('ciao');
var e = cipher.decodeString(d);
```
### Methods
change your key (warning)
```js
cipher.change('foo');
cipher.change([30, 31]);
cipher.change(new Buffer('foo'));
```
encode a plaintext string, you can optionally choose input (defaults to 'utf8') and output (defaults to 'hex') [encoding](http://nodejs.org/api/buffer.html#apicontent)
```js
cipher.encodeString(plaintext [, input_encoding] [, output_encoding]]);
cipher.encodeString('string', 'utf8', 'base64');
```
encode a plaintext array
```js
cipher.encodeArray([49, 50, 51]);
```
encode a plaintext buffer data
```js
cipher.encodeBuffer(new Buffer('ciao'));
```
select right function according with plaintext data type. Set input and output [encoding](http://nodejs.org/api/buffer.html#apicontent) only if data is a String
```js
cipher.encode(your_data [, input_encoding] [, output_encoding]]);
```
decode a ciphertext string, you can optionally choose input (defaults to 'hex') and output (defaults to 'utf8') [encoding](http://nodejs.org/api/buffer.html#apicontent)
```js
cipher.decodeString(ciphertext [, input_encoding [, output_encoding]]);
cipher.decodeString('string', 'utf8', 'base64');
```
decode a ciphertext array
```js
cipher.decodeArray([49, 50, 51]);
```
decode a ciphertext buffer data
```js
cipher.decodeBuffer(new Buffer('ciao'));
```
select right function according with ciphertext data type. Set input and output [encoding](http://nodejs.org/api/buffer.html#apicontent) only if data is a String
```js
cipher.decode(your_data [, input_encoding [, output_encoding]]);
```
### autokey(password [, lodash])
#### password
- `password` - **String | Array | Buffer** Your key *(default "throw Error")*
#### [lodash]
- `lodash` - **Boolean** Use [lodash](http://lodash.com/) library (check [benchmark](test/benchmark.js) test for right decision) *(default "disabled")*
## Examples
Take a look at my [examples](examples)
### [License GPLv3](license)