Examples

dingosky · dingosky · commit ef0dd2c993b3 · 2017-08-13T22:06:23.000-07:00
From README
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 node_modules
 *~
 .DS_Store
+examples/dist
diff --git a/README.md b/README.md
diff --git a/dist/lib/random.js b/dist/lib/random.js
@@ -126,7 +126,7 @@ var _stringWithBytes = function _stringWithBytes(entropyBits, bytes, charSet) {
 
   var needed = Math.ceil(count * (bitsPerChar / _bitsPerByte));
   if (bytes.length < needed) {
-    throw new Error('Insufficient bytes. Need ' + needed);
+    throw new Error('Insufficient bytes: need ' + needed + ' and got ' + bytes.length);
   }
 
   var charsPerChunk = charSet.getCharsPerChunk();
diff --git a/entropy-string.js b/entropy-string.js
@@ -1,7 +1,7 @@
 const Random  = require('./dist/lib/random').default
 const Entropy = require('./dist/lib/entropy').default
 const CharSet = require('./dist/lib/charSet').default
-const {charSet2, charSet4, charSet8, charSet16, charSet32, charSet64} = require('./dist/lib/random')
+const {charSet2, charSet4, charSet8, charSet16, charSet32, charSet64} = require('./dist/lib/charSet')
 
 module.exports = {
   Random,
diff --git a/examples.js b/examples.js
diff --git a/examples/charSets.js b/examples/charSets.js
@@ -0,0 +1,8 @@
+import {charSet64, charSet32, charSet16, charSet8, charSet4, charSet2} from './entropy-string'
+
+console.log('\n  charSet64: ' + charSet64.chars())
+console.log('\n  charSet32: ' + charSet32.chars())
+console.log('\n  charSet16: ' + charSet16.chars())
+console.log('\n  charSet8:  ' + charSet8.chars())
+console.log('\n  charSet4:  ' + charSet4.chars())
+console.log('\n  charSet2:  ' + charSet2.chars() + '\n')
diff --git a/examples/custom_bytes.js b/examples/custom_bytes.js
@@ -0,0 +1,14 @@
+import {Random} from './entropy-string'
+
+let random = new Random()
+let bytes = Buffer.from([250, 200, 150, 100])
+let string = random.stringWithBytes(30, bytes)
+console.log('\n  Custom bytes string : ' + string + '\n')
+
+try {
+  string = random.stringWithBytes(32, bytes)
+}
+catch(error) {
+  console.log('  Error: ' + error.message)
+}
+
diff --git a/examples/custom_chars_1.js b/examples/custom_chars_1.js
@@ -0,0 +1,10 @@
+import {Random, charSet2} from './entropy-string'
+
+let random = new Random(charSet2)
+let flips = random.string(10)
+console.log('\n  10 flips: ' + flips + '\n')
+
+random.useChars('HT')
+flips = random.string(10)
+console.log('\n  10 flips: ' + flips + '\n')
+
diff --git a/examples/custom_chars_2.js b/examples/custom_chars_2.js
@@ -0,0 +1,5 @@
+import {Random} from './entropy-string'
+
+let random = new Random('0123456789ABCDEF')
+let string = random.string(48)
+console.log('\n  Uppercase hex: ' + string + '\n')
diff --git a/examples/custom_chars_3.js b/examples/custom_chars_3.js
@@ -0,0 +1,16 @@
+import {Random} from './entropy-string'
+
+try {
+  let random = new Random('123456')
+}
+catch(error) {
+  console.log('Error: ' + error.message)
+}
+
+
+try {
+  let random = new Random('01233210')
+}
+catch(error) {
+  console.log('Error: ' + error.message)
+}
diff --git a/examples/efficiency.js b/examples/efficiency.js
@@ -0,0 +1,9 @@
+import {Random} from './entropy-string'
+
+let random = new Random()
+let string = random.string(80)
+console.log('\n  CSPRNG base 32 80-bit string : ' + string)
+
+string = random.stringRandom(80)
+console.log('\n  PRNG base 32 80-bit string : ' + string + '\n')
+
diff --git a/examples/entropy-string.js b/examples/entropy-string.js
diff --git a/examples/gen5.js b/examples/gen5.js
@@ -0,0 +1,10 @@
+import {Random, Entropy, charSet16} from './entropy-string'
+
+let bits = Entropy.bits(10000, 1000000)
+let random = new Random(charSet16)
+let strings = Array()
+for (let i = 0; i < 5; i++) {
+  let string = random.string(bits)
+  strings.push(string)
+}
+console.log('\n  5 IDs: ' + strings.join(', ') + '\n')
diff --git a/examples/more_1.js b/examples/more_1.js
@@ -0,0 +1,7 @@
+import {Random, Entropy} from './entropy-string'
+
+let bits = Entropy.bits(10000, 1000000)
+let random = new Random()
+let string = random.string(bits)
+console.log('\n  Base 32 string : ' + string + '\n')
+
diff --git a/examples/more_2.js b/examples/more_2.js
@@ -0,0 +1,10 @@
+import {Random, Entropy, charSet16, charSet4} from './entropy-string'
+
+let bits = Entropy.bits(30, 100000)
+let random = new Random(charSet16)
+let string = random.string(bits)
+console.log('\n  Base 16 string : ' + string)
+
+random.use(charSet4)
+string = random.string(bits)
+console.log('\n  Base 4 string : ' + string + '\n')
diff --git a/examples/more_3.js b/examples/more_3.js
@@ -0,0 +1,6 @@
+import {Random, Entropy} from './entropy-string'
+
+let bits = Entropy.bitsWithPowers(10, 12)
+let random = new Random()
+let string = random.string(bits)
+console.log('\n  Base 32 string : ' + string + '\n')
diff --git a/examples/more_4.js b/examples/more_4.js
@@ -0,0 +1,5 @@
+import {Random} from './entropy-string'
+
+let random = new Random()
+let string = random.string(128)
+console.log('\n  Base 32 session ID: ' + string + '\n')
diff --git a/examples/more_5.js b/examples/more_5.js
@@ -0,0 +1,5 @@
+import {Random, charSet64} from './entropy-string'
+
+let random = new Random(charSet64)
+let string = random.sessionID()
+console.log('\n  Base 64 session ID: ' + string + '\n')
diff --git a/examples/tldr.js b/examples/tldr.js
@@ -0,0 +1,28 @@
+import {Random, Entropy, charSet16, charSet32, charSet64} from './entropy-string'
+
+var print = console.log
+
+var random = new Random()
+
+print('\nOWASP session ID using base32 characters: ' + random.sessionID())
+
+print('\nSession ID using file system and URL safe characters: ' + random.sessionID(charSet64))
+
+print('\n192-bit entropy string using base32 characters: ' + random.string(192))
+
+random = new Random(charSet16)
+print('\n48-bit entropy string using hex characters: ' + random.string(48))
+
+random.useChars('1234567890ABCDEF')
+print('\n48-bit entropy string using uppercase hex characters: ' + random.string(48))
+
+random.use(charSet32)
+var bits = Entropy.bits(30, 1000000)
+print('\nBase 32 string with a 1 in a million chance of a repeat in 30 strings: ' +
+      random.string(bits))
+
+bits = Entropy.bitsWithPowers(8, 12)
+print('\nBase 64 string with a 1 in a trillion chance of a repeat in 100 million strings: ' +
+      random.string(bits, charSet64))
+
+print('');
diff --git a/examples/tldr2.js b/examples/tldr2.js
@@ -0,0 +1,6 @@
+import {Random, Entropy} from './entropy-string'
+  
+let bits = Entropy.bitsWithPowers(6,9)
+let random = new Random()
+let string = random.string(bits)
+console.log('\n  Base32 string with a 1 in a billion chance of repeat in a million strings: ' + string + '\n')
diff --git a/examples/tldr_1.js b/examples/tldr_1.js
@@ -0,0 +1,5 @@
+import {Random} from './entropy-string'
+  
+let random = new Random()
+let string = random.sessionID()
+console.log('\n  OWASP session ID using base32 characters: ' + string + '\n')
diff --git a/examples/tldr_2.js b/examples/tldr_2.js
@@ -0,0 +1,5 @@
+import {Random, charSet64} from './entropy-string'
+  
+let random = new Random()
+let string = random.sessionID(charSet64)
+console.log('\n  OWASP session ID using RFC 4648 file system and URL safe characters: ' + string + '\n')
diff --git a/examples/tldr_3.js b/examples/tldr_3.js
@@ -0,0 +1,5 @@
+import {Random, charSet16} from './entropy-string'
+  
+let random = new Random(charSet16)
+let string = random.string(48)
+console.log('\n  48-bit string using hex characters: ' + string  + '\n')
diff --git a/examples/tldr_4.js b/examples/tldr_4.js
@@ -0,0 +1,5 @@
+import {Random} from './entropy-string'
+  
+let random = new Random('0123456789ABCDEF')
+let string = random.string(48)
+console.log('\n  48-bit string using hex characters: ' + string + '\n')
diff --git a/examples/tldr_5.js b/examples/tldr_5.js
@@ -0,0 +1,6 @@
+import {Random, Entropy} from './entropy-string'
+  
+let bits = Entropy.bits(30, 1000000)
+let random = new Random()
+let string = random.string(bits)
+console.log('\n  Base 32 character string with a 1 in a million chance of a repeat in 30 strings: ' + string + '\n')
diff --git a/examples/tldr_6.js b/examples/tldr_6.js
@@ -0,0 +1,6 @@
+import {Random, Entropy, charSet64} from './entropy-string'
+
+let bits = Entropy.bitsWithPowers(7, 12)
+let random = new Random(charSet64)
+let string = random.string(bits)
+console.log('\n  Base 64 character string with a 1 in a trillion chance of a repeat in 100 million strings: ' + string + '\n')
diff --git a/lib/random.js b/lib/random.js
@@ -74,7 +74,7 @@ const _stringWithBytes = (entropyBits,  bytes, charSet) => {
 
   const needed = Math.ceil(count * (bitsPerChar / _bitsPerByte))
   if (bytes.length < needed) {
-    throw new Error('Insufficient bytes. Need ' + needed)
+    throw new Error('Insufficient bytes: need ' + needed + ' and got ' + bytes.length)
   }
 
   const charsPerChunk = charSet.getCharsPerChunk()
diff --git a/package.json b/package.json
@@ -10,7 +10,7 @@
   },
   "scripts": {
     "build": "BABEL_ENV=production babel --out-dir=dist lib/*.js",
-    "examples": "BABEL_ENV=development babel --out-dir=tmp examples.js",
+    "examples": "yarn build && cd examples && BABEL_ENV=development babel --out-dir=dist *.js && cd ..",
     "prepare": "yarn build",
     "test": "ava"
   },
@@ -21,7 +21,9 @@
   "keywords": [
     "entropy",
     "random",
-    "string"
+    "string",
+    "secure",
+    "security"
   ],
   "author": "Paul Rogers <http://knoxen.com>",
   "maintainers": [
diff --git a/tmp/examples.js b/tmp/examples.js

Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ var _stringWithBytes = function _stringWithBytes(entropyBits, bytes, charSet) {`
`126`	`126`
`127`	`127`	`var needed = Math.ceil(count * (bitsPerChar / _bitsPerByte));`
`128`	`128`	`if (bytes.length < needed) {`
`129`		`- throw new Error('Insufficient bytes. Need ' + needed);`
	`129`	`+ throw new Error('Insufficient bytes: need ' + needed + ' and got ' + bytes.length);`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`var charsPerChunk = charSet.getCharsPerChunk();`