Permalink
Browse files

add LICENSE and README

  • Loading branch information...
1 parent 3cf3078 commit db799339559c30597a0ae56645c56552201fdf61 akdubya committed Dec 12, 2010
Showing with 61 additions and 0 deletions.
  1. +19 −0 LICENSE
  2. +42 −0 README.md
View
19 LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2010 Aleksander Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.
View
@@ -0,0 +1,42 @@
+rbytes
+======
+
+> Generates cryptographically secure random byte sequences
+
+rbytes generates cryptographically secure random byte sequences using native bindings to OpenSSL's [pseudo random number generator](http://www.openssl.org/docs/crypto/rand.html). Use rbytes to generate session keys, UUIDs or anything else that requires fast generation of blocks of random data.
+
+Synopsis
+--------
+
+Create a buffer holding 16 random bytes:
+
+ var rbytes = require('rbytes');
+
+ var rbuff = rbytes.randomBytes(16);
+ // <Buffer 69 5d 5d f6 42 04 1b 86 f2 77 5d 2b 4f 0f 72 26>
+
+rbytes adds two convenience methods to Node's Buffer class for easy conversion between Buffers and hex strings:
+
+ rbuff.toHex();
+ // '695d5df642041b86f2775d2b4f0f7226'
+
+ var buff = Buffer(1);
+ buff.writeHex('f);
+ // <Buffer 0f>
+
+ buff.writeHex('g);
+ // TypeError: Invalid hex string
+
+Installation
+------------
+
+Via npm:
+
+ $ npm install rbytes
+
+Notes
+-----
+
+rbytes binds to OpenSSL's [RAND_bytes](http://www.openssl.org/docs/crypto/RAND_bytes.html) function, which generates cryptographically strong pseudorandom bytes. This function does not block, however it will throw an error if there isn't enough random seed data on your system. Support is planned for RAND_pseudo_bytes, which are guaranteed to be available at the cost of being (potentially) less secure.
+
+Simple random number generation (like Math.rand()) is planned for a future version.

0 comments on commit db79933

Please sign in to comment.