autokey
v2.4.0
Published
autokey stream cipher
Downloads
1,003
Readme
autokey
Autokey stream cipher.
Encode/decode with different encodings 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
Installation
Install through NPM
npm install autokey
or
git clone git://github.com/hex7c0/autokey.git
API
inside nodejs project
var autokey = require('autokey');
var cipher = autokey('secret_key');
var d = cipher.encodeString('ciao');
var e = cipher.decodeString(d);
Methods
change your key (warning)
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
cipher.encodeString(plaintext [, input_encoding] [, output_encoding]]);
cipher.encodeString('string', 'utf8', 'base64');
encode a plaintext array
cipher.encodeArray([49, 50, 51]);
encode a plaintext buffer data
cipher.encodeBuffer(new Buffer('ciao'));
select right function according with plaintext data type. Set input and output encoding only if data is a String
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
cipher.decodeString(ciphertext [, input_encoding [, output_encoding]]);
cipher.decodeString('string', 'utf8', 'base64');
decode a ciphertext array
cipher.decodeArray([49, 50, 51]);
decode a ciphertext buffer data
cipher.decodeBuffer(new Buffer('ciao'));
select right function according with ciphertext data type. Set input and output encoding only if data is a String
cipher.decode(your_data [, input_encoding [, output_encoding]]);
autokey(password [, lodash])
password
password
- String | Array | Buffer Your key (default "throw Error")
[lodash]
Examples
Take a look at my examples