README.md

node-rijndael

A native binding to mcrypt's rijndael encryption with a block size of 256 bits. This allows for the encryption and decryption of data generated by Drupal, which uses rijndael-256, despite the AES standard of rijndael-128.

This module enables interfacing between PHP and Node.js, especially where third-party frameworks like Drupal are involved. Drupal uses rijndael-256 by default, and OPENSSL has no support for any block-size of rijndael apart from 128.

Installation

You will need a development version of libmcrypt installed on your system to build node-rijndael.

# for debian derivatives
$ [sudo] apt-get install libmcrypt-dev
# for red hat derivatives
$ [sudo] yum install libmcrypt-devel
# for arch linux
$ [sudo] pacman -S libmcrypt

N.B. if installing node-rijndael fails with an error regarding a "libmcrypt.h" header, this is why.

If you know how to package an external library with a Node Addon, consider submitting a pull request.

npm

$ npm install node-rijndael

github

$ git clone https://github.com/skeggse/node-rijndael.git

Example

A functional example demonstrating PHP and Node compatibility is available in the examples/ directory. A demonstration of the two in a commmand-line example:

$ node
> var key = new Buffer('theonetruesecretkeytorulethemall', 'utf-8').toString('base64');
> var iv = crypto.randomBytes(16).toString('base64');
> iv // we'll use this as the initialization vector for both tests
'UsKguldtsuLm/KrtnctisA=='
> var rijndael = require('./examples/rijndael');
> var plaintext = 'hello, world!';
> var ciphertext = rijndael.encrypt(plaintext, key, iv);
> ciphertext
'50yvJtooiLHUOAbniGgMHmZE18Op99Rhe+Y+G6AjPzM='
> var plaintext = rijndael.decrypt(ciphertext, key, iv);
> plaintext
'hello, world!'

The only changes you'll generally need to make from the example Node implementation are to add the correct padding, as you may need to use PKCS #5 padding or something similar to be compatible with your specific PHP code.

API

As of 0.1.0, node-rijndael will coerce strings into buffers. As of 0.2.0, node-rijndael pads keys and allows key lengths of 16, 24 and 32 bytes.

new Rijndael(key, [options])

The constructor creates a Rijndael object bound to a specific key, with methods for encrypting and decrypting.

The provided key can be either a Buffer or a string, and if a string is provided, the encoding option will be passed to the Buffer constructor.

Options

{
  // the key's encoding (defaults to "binary", but ignored if the key is a buffer)
  "encoding": "binary",
  // the block cipher mode (defaults to Rijndael.MCRYPT_MODE_ECB)
  "mode": Rijndael.MCRYPT_MODE_ECB,
  // the initialization vector (defaults to null, and uses encoding if provided string)
  "iv": null
}

Supported Modes

Rijndael.MCRYPT_MODE_ECB
Rijndael.MCRYPT_MODE_CBC
Rijndael.MCRYPT_MODE_CFB
Rijndael.MCRYPT_MODE_OFB
Rijndael.MCRYPT_MODE_NOFB
Rijndael.MCRYPT_MODE_STREAM

Rijndael#encrypt(plaintext, [input_encoding, [output_encoding]])

Encrypt the provided plaintext with the bound key, and return the encrypted ciphertext. encrypt will return a Buffer by default.

May throw an error if unsupported options provided. Most of the checking should happen in the constructor.

Rijndael#decrypt(ciphertext, [input_encoding, [output_encoding]])

Decrypt the provided ciphertext with the bound key, and return the decrypted plaintext. decrypt will return a Buffer by default.

May throw an error if unsupported options provided. Most of the checking should happen in the constructor.

TODO

A bit more functionality now, needs tests.

See Also

It looks like @tugrul put together a more complete set of bindings for libmcrypt, called node-mcrypt. This module is specifically for rijndael-256. I will not comment on the quality of the bindings.

Unlicense / Public Domain

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>