wait();
}
+function waitForEntropyFeedback(fn, maxTime) {
+ if (!maxTime) {
+ maxTime = testMaxTime;
+ }
+ var origFeedback = page.evaluate(function() {
+ return $(".entropy-container").text();
+ });
+ var start = new Date().getTime();
+ var wait = function keepWaiting() {
+ var now = new Date().getTime();
+ var hasTimedOut = now - start > maxTime;
+ if (hasTimedOut) {
+ console.log("Test timed out");
+ fn();
+ return;
+ }
+ var feedback = page.evaluate(function() {
+ return $(".entropy-container").text();
+ });
+ var hasFinished = feedback != origFeedback;
+ if (hasFinished) {
+ fn();
+ }
+ else {
+ setTimeout(keepWaiting, 100);
+ }
+ }
+ wait();
+}
+
function next() {
if (tests.length > 0) {
var testsStr = tests.length == 1 ? "test" : "tests";
// Entropy unit tests
function() {
page.open(url, function(status) {
- var error = page.evaluate(function() {
+ var response = page.evaluate(function() {
var e;
// binary entropy is detected
- e = Entropy.fromString("01010101");
- if (e.base.str != "binary") {
- return "Binary entropy not detected correctly";
+ try {
+ e = Entropy.fromString("01010101");
+ if (e.base.str != "binary") {
+ return "Binary entropy not detected correctly";
+ }
+ }
+ catch (e) {
+ return e.message;
}
// base6 entropy is detected
- e = Entropy.fromString("012345012345");
- if (e.base.str != "base 6") {
- return "base6 entropy not detected correctly";
+ try {
+ e = Entropy.fromString("012345012345");
+ if (e.base.str != "base 6") {
+ return "base6 entropy not detected correctly";
+ }
+ }
+ catch (e) {
+ return e.message;
}
// dice entropy is detected
- e = Entropy.fromString("123456123456");
- if (e.base.str != "base 6 (dice)") {
- return "dice entropy not detected correctly";
+ try {
+ e = Entropy.fromString("123456123456");
+ if (e.base.str != "base 6 (dice)") {
+ return "dice entropy not detected correctly";
+ }
+ }
+ catch (e) {
+ return e.message;
}
// base10 entropy is detected
- e = Entropy.fromString("0123456789");
- if (e.base.str != "base 10") {
- return "base10 entropy not detected correctly";
+ try {
+ e = Entropy.fromString("0123456789");
+ if (e.base.str != "base 10") {
+ return "base10 entropy not detected correctly";
+ }
+ }
+ catch (e) {
+ return e.message;
}
// hex entropy is detected
- e = Entropy.fromString("0123456789ABCDEF");
- if (e.base.str != "hexadecimal") {
- return "hexadecimal entropy not detected correctly";
+ try {
+ e = Entropy.fromString("0123456789ABCDEF");
+ if (e.base.str != "hexadecimal") {
+ return "hexadecimal entropy not detected correctly";
+ }
+ }
+ catch (e) {
+ return e.message;
+ }
+ // card entropy is detected
+ try {
+ e = Entropy.fromString("AC4DTHKS");
+ if (e.base.str != "card") {
+ return "card entropy not detected correctly";
+ }
+ }
+ catch (e) {
+ return e.message;
}
// entropy is case insensitive
- e = Entropy.fromString("aBcDeF");
- if (e.cleanStr != "aBcDeF") {
- return "Entropy should not be case sensitive";
+ try {
+ e = Entropy.fromString("aBcDeF");
+ if (e.cleanStr != "aBcDeF") {
+ return "Entropy should not be case sensitive";
+ }
+ }
+ catch (e) {
+ return e.message;
}
// dice entropy is converted to base6
- e = Entropy.fromString("123456");
- if (e.cleanStr != "012345") {
- return "Dice entropy is not automatically converted to base6";
+ try {
+ e = Entropy.fromString("123456");
+ if (e.cleanStr != "123450") {
+ return "Dice entropy is not automatically converted to base6";
+ }
+ }
+ catch (e) {
+ return e.message;
}
// dice entropy is preferred to base6 if ambiguous
- e = Entropy.fromString("12345");
- if (e.base.str != "base 6 (dice)") {
- return "dice not used as default over base 6";
+ try {
+ e = Entropy.fromString("12345");
+ if (e.base.str != "base 6 (dice)") {
+ return "dice not used as default over base 6";
+ }
+ }
+ catch (e) {
+ return e.message;
}
// unused characters are ignored
- e = Entropy.fromString("fghijkl");
- if (e.cleanStr != "f") {
- return "additional characters are not ignored";
+ try {
+ e = Entropy.fromString("fghijkl");
+ if (e.cleanStr != "f") {
+ return "additional characters are not ignored";
+ }
+ }
+ catch (e) {
+ return e.message;
}
// the lowest base is used by default
// 7 could be decimal or hexadecimal, but should be detected as decimal
- e = Entropy.fromString("7");
- if (e.base.str != "base 10") {
- return "lowest base is not used";
+ try {
+ e = Entropy.fromString("7");
+ if (e.base.str != "base 10") {
+ return "lowest base is not used";
+ }
}
- // Hexadecimal representation is returned
- e = Entropy.fromString("1010");
- if (e.hexStr != "A") {
- return "Hexadecimal representation not returned";
+ catch (e) {
+ return e.message;
}
// Leading zeros are retained
- e = Entropy.fromString("000A");
- if (e.cleanStr != "000A") {
- return "Leading zeros are not retained";
+ try {
+ e = Entropy.fromString("000A");
+ if (e.cleanStr != "000A") {
+ return "Leading zeros are not retained";
+ }
+ }
+ catch (e) {
+ return e.message;
}
// Leading zeros are correctly preserved for hex in binary string
- e = Entropy.fromString("2A");
- if (e.binaryStr != "00101010") {
- return "Hex leading zeros are not correct in binary";
+ try {
+ e = Entropy.fromString("2A");
+ if (e.binaryStr != "00101010") {
+ return "Hex leading zeros are not correct in binary";
+ }
+ }
+ catch (e) {
+ return e.message;
+ }
+ // Leading zeros for base 6 as binary string
+ // 20 = 2 events at 2.58 bits per event = 5 bits
+ // 20 in base 6 = 12 in base 10 = 1100 in base 2
+ // so it needs 1 bit of padding to be the right bit length
+ try {
+ e = Entropy.fromString("20");
+ if (e.binaryStr != "01100") {
+ return "Base 6 as binary has leading zeros";
+ }
+ }
+ catch (e) {
+ return e.message;
+ }
+ // Leading zeros for base 10 as binary string
+ try {
+ e = Entropy.fromString("17");
+ if (e.binaryStr != "010001") {
+ return "Base 10 as binary has leading zeros";
+ }
+ }
+ catch (e) {
+ return e.message;
+ }
+ // Leading zeros for card entropy as binary string
+ try {
+ e = Entropy.fromString("2c");
+ if (e.binaryStr != "00001") {
+ return "Card entropy as binary has leading zeros";
+ }
+ }
+ catch (e) {
+ return e.message;
}
// Keyboard mashing results in weak entropy
// Despite being a long string, it's less than 30 bits of entropy
- e = Entropy.fromString("aj;se ifj; ask,dfv js;ifj");
- if (e.binaryStr.length >= 30) {
- return "Keyboard mashing should produce weak entropy";
+ try {
+ e = Entropy.fromString("aj;se ifj; ask,dfv js;ifj");
+ if (e.binaryStr.length >= 30) {
+ return "Keyboard mashing should produce weak entropy";
+ }
}
- return false;
+ catch (e) {
+ return e.message;
+ }
+ // Card entropy is used if every pair could be a card
+ try {
+ e = Entropy.fromString("4c3c2c");
+ if (e.base.str != "card") {
+ return "Card entropy not used if all pairs are cards";
+ }
+ }
+ catch (e) {
+ return e.message;
+ }
+ // Card entropy uses base 52
+ // [ cards, binary ]
+ try {
+ var cards = [
+ [ "ac", "00000" ],
+ [ "acac", "00000000000" ],
+ [ "acac2c", "00000000000000001" ],
+ [ "acks", "00000110011" ],
+ [ "acacks", "00000000000110011" ],
+ [ "2c", "00001" ],
+ [ "3d", "01111" ],
+ [ "4h", "11101" ],
+ [ "5s", "101011" ],
+ [ "6c", "00101" ],
+ [ "7d", "10011" ],
+ [ "8h", "100001" ],
+ [ "9s", "101111" ],
+ [ "tc", "01001" ],
+ [ "jd", "10111" ],
+ [ "qh", "100101" ],
+ [ "ks", "110011" ],
+ [ "ks2c", "101001011101" ],
+ [ "KS2C", "101001011101" ],
+ ];
+ for (var i=0; i<cards.length; i++) {
+ var card = cards[i][0];
+ var result = cards[i][1];
+ e = Entropy.fromString(card);
+ console.log(e.binary + " " + result);
+ if (e.binaryStr !== result) {
+ return "card entropy not parsed correctly: " + result + " != " + e.binaryStr;
+ }
+ }
+ }
+ catch (e) {
+ return e.message;
+ }
+ return "PASS";
});
- if (error) {
+ if (response != "PASS") {
console.log("Entropy unit tests");
- console.log(error);
+ console.log(response);
fail();
};
next();
"dice",
"base 10",
"hexadecimal",
+ "cards",
];
for (var i=0; i<options.length; i++) {
var option = options[i];
$(".entropy").val(entropy).trigger("input");
});
// check the actual entropy being used is shown
- waitForGenerate(function() {
+ waitForEntropyFeedback(function() {
var expectedText = "AedEceAA";
var entropyText = page.evaluate(function() {
return $(".entropy-container").text();
$(".entropy").val("01").trigger("input");
});
// check the entropy is shown to be the correct type
- waitForGenerate(function() {
+ waitForEntropyFeedback(function() {
var entropyText = page.evaluate(function() {
return $(".entropy-container").text();
});
$(".entropy").val("012345").trigger("input");
});
// check the entropy is shown to be the correct type
- waitForGenerate(function() {
+ waitForEntropyFeedback(function() {
var entropyText = page.evaluate(function() {
return $(".entropy-container").text();
});
$(".entropy").val("123456").trigger("input");
});
// check the entropy is shown to be the correct type
- waitForGenerate(function() {
+ waitForEntropyFeedback(function() {
var entropyText = page.evaluate(function() {
return $(".entropy-container").text();
});
$(".entropy").val("789").trigger("input");
});
// check the entropy is shown to be the correct type
- waitForGenerate(function() {
+ waitForEntropyFeedback(function() {
var entropyText = page.evaluate(function() {
return $(".entropy-container").text();
});
$(".entropy").val("abcdef").trigger("input");
});
// check the entropy is shown to be the correct type
- waitForGenerate(function() {
+ waitForEntropyFeedback(function() {
var entropyText = page.evaluate(function() {
return $(".entropy-container").text();
});
$(".entropy").val("123456").trigger("input");
});
// check the entropy is shown as base 6, not as the original dice value
- waitForGenerate(function() {
+ waitForEntropyFeedback(function() {
var entropyText = page.evaluate(function() {
return $(".entropy-container").text();
});
- if (entropyText.indexOf("012345") == -1) {
+ if (entropyText.indexOf("123450") == -1) {
console.log("Dice entropy is not shown to user as base 6 value");
fail();
}
// The number of bits of entropy accumulated is shown
function() {
page.open(url, function(status) {
- var tests = {
- "0000 0000 0000 0000 0000": "20",
- "0": "1",
- "0000": "4",
- "6": "3",
- "7": "3",
- "8": "4",
- "F": "4",
- "29": "5",
- "0A": "8",
- "1A": "8", // hex is always multiple of 4 bits of entropy
- "2A": "8",
- "4A": "8",
- "8A": "8",
- "FA": "8",
- "000A": "16",
- "2220": "10",
- "2221": "9", // uses dice, so entropy is actually 1110
- "2227": "12",
- "222F": "16",
- "FFFF": "16",
- }
- // Arrange tests in array so last one can be easily detected
- var entropys = [];
- var results = [];
- for (var entropy in tests) {
- entropys.push(entropy);
- results.push(tests[entropy]);
- }
+ //[ entropy, bits ]
+ var tests = [
+ [ "0000 0000 0000 0000 0000", "20" ],
+ [ "0", "1" ],
+ [ "0000", "4" ],
+ [ "6", "2" ], // 6 in card is 0 in base 6, 0 in base 6 is 2.6 bits (rounded down to 2 bits)
+ [ "7", "3" ], // 7 in base 10 is 111 in base 2, no leading zeros
+ [ "8", "4" ],
+ [ "F", "4" ],
+ [ "29", "6" ],
+ [ "0A", "8" ],
+ [ "1A", "8" ], // hex is always multiple of 4 bits of entropy
+ [ "2A", "8" ],
+ [ "4A", "8" ],
+ [ "8A", "8" ],
+ [ "FA", "8" ],
+ [ "000A", "16" ],
+ [ "5555", "11" ],
+ [ "6666", "10" ], // uses dice, so entropy is actually 0000 in base 6, which is 4 lots of 2.58 bits, which is 10.32 bits (rounded down to 10 bits)
+ [ "2227", "13" ], // Uses base 10, which is 4 lots of 3.32 bits, which is 13.3 bits (rounded down to 13)
+ [ "222F", "16" ],
+ [ "FFFF", "16" ],
+ [ "0000101017", "33" ], // 10 events at 3.32 bits per event
+ ]
// use entropy
page.evaluate(function(e) {
$(".use-entropy").prop("checked", true).trigger("change");
});
// Run each test
var nextTest = function runNextTest(i) {
- var entropy = entropys[i];
- var expected = results[i];
+ var entropy = tests[i][0];
+ var expected = tests[i][1];
// set entropy
page.evaluate(function(e) {
- $(".addresses").empty(); // bit of a hack, but needed for waitForGenerate
$(".entropy").val(e).trigger("input");
}, entropy);
// check the number of bits of entropy is shown
- waitForGenerate(function() {
+ waitForEntropyFeedback(function() {
var entropyText = page.evaluate(function() {
return $(".entropy-container").text();
});
- if (entropyText.indexOf("Have " + expected + " bits of entropy") == -1) {
+ if (entropyText.replace(/\s/g,"").indexOf("Bits" + expected) == -1) {
console.log("Accumulated entropy is not shown correctly for " + entropy);
fail();
}
- var isLastTest = i == results.length - 1;
+ var isLastTest = i == tests.length - 1;
if (isLastTest) {
next();
}
});
},
-// The number of bits of entropy to reach the next mnemonic strength is shown
-function() {
-page.open(url, function(status) {
- // use entropy
- page.evaluate(function() {
- $(".use-entropy").prop("checked", true).trigger("change");
- $(".entropy").val("7654321").trigger("input");
- });
- // check the amount of additional entropy required is shown
- waitForGenerate(function() {
- var entropyText = page.evaluate(function() {
- return $(".entropy-container").text();
- });
- if (entropyText.indexOf("3 more base 10 chars required") == -1) {
- console.log("Additional entropy requirement is not shown");
- fail();
- }
- next();
- });
-});
-},
-
-// The next strength above 0-word mnemonics is considered extremely weak
-// The next strength above 3-word mnemonics is considered very weak
-// The next strength above 6-word mnemonics is considered weak
-// The next strength above 9-word mnemonics is considered strong
-// The next strength above 12-word mnemonics is considered very strong
-// The next strength above 15-word mnemonics is considered extremely strong
+// There is feedback provided about the supplied entropy
function() {
page.open(url, function(status) {
var tests = [
{
entropy: "A",
+ filtered: "A",
+ type: "hexadecimal",
+ events: 1,
+ bits: 4,
words: 0,
- nextStrength: "an extremely weak",
+ strength: "extremely weak",
},
{
entropy: "AAAAAAAA",
+ filtered: "AAAAAAAA",
+ type: "hexadecimal",
+ events: 8,
+ bits: 32,
words: 3,
- nextStrength: "a very weak",
+ strength: "extremely weak",
},
{
entropy: "AAAAAAAA B",
+ filtered: "AAAAAAAAB",
+ type: "hexadecimal",
+ events: 9,
+ bits: 36,
words: 3,
- nextStrength: "a very weak",
+ strength: "extremely weak",
},
{
entropy: "AAAAAAAA BBBBBBBB",
+ filtered: "AAAAAAAABBBBBBBB",
+ type: "hexadecimal",
+ events: 16,
+ bits: 64,
words: 6,
- nextStrength: "a weak",
+ strength: "very weak",
},
{
entropy: "AAAAAAAA BBBBBBBB CCCCCCCC",
+ filtered: "AAAAAAAABBBBBBBBCCCCCCCC",
+ type: "hexadecimal",
+ events: 24,
+ bits: 96,
words: 9,
- nextStrength: "a strong",
+ strength: "weak",
},
{
entropy: "AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDD",
+ filtered: "AAAAAAAABBBBBBBBCCCCCCCCDDDDDDDD",
+ type: "hexadecimal",
+ events: 32,
+ bits: 128,
+ words: 12,
+ strength: "easily cracked",
+ },
+ {
+ entropy: "AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDA",
+ filtered: "AAAAAAAABBBBBBBBCCCCCCCCDDDDDDDA",
+ type: "hexadecimal",
+ events: 32,
+ bits: 128,
words: 12,
- nextStrength: "a very strong",
+ strength: "strong",
},
{
- entropy: "AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDD EEEEEEEE",
+ entropy: "AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDA EEEEEEEE",
+ filtered: "AAAAAAAABBBBBBBBCCCCCCCCDDDDDDDAEEEEEEEE",
+ type: "hexadecimal",
+ events: 40,
+ bits: 160,
words: 15,
- nextStrength: "an extremely strong",
- }
+ strength: "very strong",
+ },
+ {
+ entropy: "AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDA EEEEEEEE FFFFFFFF",
+ filtered: "AAAAAAAABBBBBBBBCCCCCCCCDDDDDDDAEEEEEEEEFFFFFFFF",
+ type: "hexadecimal",
+ events: 48,
+ bits: 192,
+ words: 18,
+ strength: "extremely strong",
+ },
];
// use entropy
page.evaluate(function() {
$(".use-entropy").prop("checked", true).trigger("change");
});
var nextTest = function runNextTest(i) {
+ function getFeedbackError(expected, actual) {
+ if (actual.indexOf(expected.filtered) == -1) {
+ return "Filtered value not in feedback";
+ }
+ if (actual.indexOf(expected.type) == -1) {
+ return "Entropy type not in feedback";
+ }
+ if (actual.indexOf(expected.events) == -1) {
+ return "Event count not in feedback";
+ }
+ if (actual.indexOf(expected.bits) == -1) {
+ return "Bit count not in feedback";
+ }
+ if (actual.indexOf(expected.strength) == -1) {
+ return "Strength not in feedback";
+ }
+ return false;
+ }
test = tests[i];
page.evaluate(function(e) {
$(".addresses").empty();
+ $(".phrase").val("");
$(".entropy").val(e).trigger("input");
}, test.entropy);
- waitForGenerate(function() {
- // check the strength of the current mnemonic
+ waitForEntropyFeedback(function() {
var mnemonic = page.evaluate(function() {
return $(".phrase").val();
});
+ // Check mnemonic length
if (test.words == 0) {
if (mnemonic.length > 0) {
- console.log("Mnemonic length for " + test.nextStrength + " strength is not " + test.words);
+ console.log("Mnemonic length for " + test.strength + " strength is not " + test.words);
console.log("Mnemonic: " + mnemonic);
fail();
}
}
else {
if (mnemonic.split(" ").length != test.words) {
- console.log("Mnemonic length for " + test.nextStrength + " strength is not " + test.words);
+ console.log("Mnemonic length for " + test.strength + " strength is not " + test.words);
console.log("Mnemonic: " + mnemonic);
fail();
}
}
- // check the strength of the next mnemonic is shown
- var entropyText = page.evaluate(function() {
+ // check feedback
+ var feedback = page.evaluate(function() {
return $(".entropy-container").text();
});
- if (entropyText.indexOf("required to generate " + test.nextStrength + " mnemonic") == -1) {
- console.log("Strength indicator for " + test.nextStrength + " mnemonic is incorrect");
+ var feedbackError = getFeedbackError(test, feedback);
+ if (feedbackError) {
+ console.log("Entropy feedback for " + test.entropy + " returned error");
+ console.log(feedbackError);
fail();
}
+ // Run next test
var isLastTest = i == tests.length - 1;
if (isLastTest) {
next();
});
},
-// Entropy is truncated from the right
+// Entropy is truncated from the left
function() {
page.open(url, function(status) {
- var expected = "abandon abandon ability";
+ var expected = "avocado zoo zone";
// use entropy
page.evaluate(function() {
$(".use-entropy").prop("checked", true).trigger("change");
var entropy = "00000000 00000000 00000000 00000000";
- entropy += "11111111 11111111 11111111 1111"; // Missing last byte, only first 8 bytes are used
+ entropy += "11111111 11111111 11111111 1111"; // Missing last byte
$(".entropy").val(entropy).trigger("input");
});
// check the entropy is truncated from the right
// https://bip32jp.github.io/english/index.html
// NOTES:
// Is incompatible with:
-// base 6 with leading zeros
-// base 6 wth 12 words / 53 chars
// base 20
function() {
page.open(url, function(status) {
- var expected = "defy trip fatal jaguar mean rack rifle survey satisfy drift twist champion steel wife state furnace night consider glove olympic oblige donor novel left";
+ var expected = "train then jungle barely whip fiber purpose puppy eagle cloud clump hospital robot brave balcony utility detect estate old green desk skill multiply virus";
// use entropy
page.evaluate(function() {
$(".use-entropy").prop("checked", true).trigger("change");
- var entropy = "123450123450123450123450123450123450123450123450123450123450123450123450123450123450123450123450123";
+ var entropy = "543210543210543210543210543210543210543210543210543210543210543210543210543210543210543210543210543";
$(".entropy").val(entropy).trigger("input");
});
// check the mnemonic matches the expected value from bip32jp
});
},
+// Blank entropy does not generate mnemonic or addresses
+function() {
+page.open(url, function(status) {
+ // use entropy
+ page.evaluate(function() {
+ $(".use-entropy").prop("checked", true).trigger("change");
+ $(".entropy").val("").trigger("input");
+ });
+ waitForFeedback(function() {
+ // check there is no mnemonic
+ var phrase = page.evaluate(function() {
+ return $(".phrase").val();
+ });
+ if (phrase != "") {
+ console.log("Blank entropy does not result in blank mnemonic");
+ console.log("Got: " + phrase);
+ fail();
+ }
+ // check there are no addresses displayed
+ var addresses = page.evaluate(function() {
+ return $(".address").length;
+ });
+ if (addresses != 0) {
+ console.log("Blank entropy does not result in zero addresses");
+ fail();
+ }
+ // Check the feedback says 'blank entropy'
+ var feedback = page.evaluate(function() {
+ return $(".feedback").text();
+ });
+ if (feedback != "Blank entropy") {
+ console.log("Blank entropy does not show feedback message");
+ fail();
+ }
+ next();
+ });
+});
+},
+
+// Mnemonic length can be selected even for weak entropy
+function() {
+page.open(url, function(status) {
+ // use entropy
+ page.evaluate(function() {
+ $(".use-entropy").prop("checked", true).trigger("change");
+ $(".entropy").val("012345");
+ $(".mnemonic-length").val("18").trigger("change");
+ });
+ // check the mnemonic is the correct length
+ waitForGenerate(function() {
+ var phrase = page.evaluate(function() {
+ return $(".phrase").val();
+ });
+ var numberOfWords = phrase.split(/\s/g).length;
+ if (numberOfWords != 18) {
+ console.log("Weak entropy cannot be overridden to give 18 word mnemonic");
+ console.log(phrase);
+ fail();
+ }
+ next();
+ });
+});
+},
+
// If you wish to add more tests, do so here...
// Here is a blank test template