]> git.immae.eu Git - perso/Immae/Projets/Cryptomonnaies/BIP39.git/blobdiff - tests.js
Card entropy calculation bugfix
[perso/Immae/Projets/Cryptomonnaies/BIP39.git] / tests.js
index f672cbd86ad374dc68b2044d15d3231305850cb4..0ce34bdbb9ba688ed1dafb33d73db65a9e14c8da 100644 (file)
--- a/tests.js
+++ b/tests.js
@@ -4,7 +4,7 @@
 
 var page = require('webpage').create();
 var url = 'src/index.html';
-var testMaxTime = 5000;
+var testMaxTime = 10000;
 
 page.onResourceError = function(e) {
     console.log("Error loading " + e.url);
@@ -80,7 +80,7 @@ function waitForEntropyFeedback(fn, maxTime) {
         maxTime = testMaxTime;
     }
     var origFeedback = page.evaluate(function() {
-        return $(".entropy-feedback").text();
+        return $(".entropy-container").text();
     });
     var start = new Date().getTime();
     var wait = function keepWaiting() {
@@ -92,7 +92,7 @@ function waitForEntropyFeedback(fn, maxTime) {
             return;
         }
         var feedback = page.evaluate(function() {
-            return $(".entropy-feedback").text();
+            return $(".entropy-container").text();
         });
         var hasFinished = feedback != origFeedback;
         if (hasFinished) {
@@ -2185,10 +2185,9 @@ page.open(url, function(status) {
         try {
             var cards = [
                 [ "ac", "00000" ],
-                [ "acac", "00000000000" ],
-                [ "acac2c", "00000000000000001" ],
-                [ "acks", "00000110011" ],
-                [ "acacks", "00000000000110011" ],
+                [ "acqs", "00001100011" ],
+                [ "acks", "00001100100" ],
+                [ "2cac", "00001100101" ],
                 [ "2c", "00001" ],
                 [ "3d", "01111" ],
                 [ "4h", "11101" ],
@@ -2201,8 +2200,8 @@ page.open(url, function(status) {
                 [ "jd", "10111" ],
                 [ "qh", "100101" ],
                 [ "ks", "110011" ],
-                [ "ks2c", "101001011101" ],
-                [ "KS2C", "101001011101" ],
+                [ "ks2c", "101001011100" ],
+                [ "KS2C", "101001011100" ],
             ];
             for (var i=0; i<cards.length; i++) {
                 var card = cards[i][0];
@@ -2210,7 +2209,7 @@ page.open(url, function(status) {
                 e = Entropy.fromString(card);
                 console.log(e.binary + " " + result);
                 if (e.binaryStr !== result) {
-                    return "card entropy not parsed correctly: " + result + " != " + e.binaryStr;
+                    return "card entropy " + card + " not parsed correctly: " + result + " != " + e.binaryStr;
                 }
             }
         }
@@ -2503,6 +2502,7 @@ page.open(url, function(status) {
         [ "222F", "16" ],
         [ "FFFF", "16" ],
         [ "0000101017", "33" ], // 10 events at 3.32 bits per event
+        [ "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9stsjsqsks", "225" ], // cards are not replaced, so a full deck is not 52^52 entropy which is 296 bits, it's 52!, which is 225 bits
     ]
     // use entropy
     page.evaluate(function(e) {
@@ -2519,7 +2519,7 @@ page.open(url, function(status) {
         // check the number of bits of entropy is shown
         waitForEntropyFeedback(function() {
             var entropyText = page.evaluate(function() {
-                return $(".entropy-feedback").text();
+                return $(".entropy-container").text();
             });
             if (entropyText.replace(/\s/g,"").indexOf("Bits" + expected) == -1) {
                 console.log("Accumulated entropy is not shown correctly for " + entropy);
@@ -2594,11 +2594,20 @@ page.open(url, function(status) {
             events: 32,
             bits: 128,
             words: 12,
+            strength: "easily cracked",
+        },
+        {
+            entropy: "AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDA",
+            filtered: "AAAAAAAABBBBBBBBCCCCCCCCDDDDDDDA",
+            type: "hexadecimal",
+            events: 32,
+            bits: 128,
+            words: 12,
             strength: "strong",
         },
         {
-            entropy: "AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDD EEEEEEEE",
-            filtered: "AAAAAAAABBBBBBBBCCCCCCCCDDDDDDDDEEEEEEEE",
+            entropy: "AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDA EEEEEEEE",
+            filtered: "AAAAAAAABBBBBBBBCCCCCCCCDDDDDDDAEEEEEEEE",
             type: "hexadecimal",
             events: 40,
             bits: 160,
@@ -2606,14 +2615,245 @@ page.open(url, function(status) {
             strength: "very strong",
         },
         {
-            entropy: "AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDD EEEEEEEE FFFFFFFF",
-            filtered: "AAAAAAAABBBBBBBBCCCCCCCCDDDDDDDDEEEEEEEEFFFFFFFF",
+            entropy: "AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDA EEEEEEEE FFFFFFFF",
+            filtered: "AAAAAAAABBBBBBBBCCCCCCCCDDDDDDDAEEEEEEEEFFFFFFFF",
             type: "hexadecimal",
             events: 48,
             bits: 192,
             words: 18,
             strength: "extremely strong",
         },
+        {
+            entropy: "7d",
+            type: "card",
+            events: 1,
+            bits: 5,
+            words: 0,
+            strength: "extremely weak",
+        },
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9stsjsqsks",
+            type: "card (full deck)",
+            events: 52,
+            bits: 225,
+            words: 21,
+            strength: "extremely strong",
+        },
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9stsjsqsks3d",
+            type: "card (full deck, 1 duplicate: 3d)",
+            events: 53,
+            bits: 231,
+            words: 21,
+            strength: "extremely strong",
+        },
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9stsjsqs3d4d",
+            type: "card (2 duplicates: 3d 4d, 1 missing: KS)",
+            events: 53,
+            bits: 231,
+            words: 21,
+            strength: "extremely strong",
+        },
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9stsjsqs3d4d5d6d",
+            type: "card (4 duplicates: 3d 4d 5d..., 1 missing: KS)",
+            events: 53,
+            bits: 242,
+            words: 21,
+            strength: "extremely strong",
+        },
+        // Next test was throwing uncaught error in zxcvbn
+        // Also tests 451 bits, ie Math.log2(52!)*2 = 225.58 * 2
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9stsjsqsksac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9stsjsqsks",
+            type: "card (full deck, 52 duplicates: ac 2c 3c...)",
+            events: 104,
+            bits: 451,
+            words: 42,
+            strength: "extremely strong",
+        },
+        // Case insensitivity to duplicate cards
+        {
+            entropy: "asAS",
+            type: "card (1 duplicate: AS)",
+            events: 2,
+            bits: 12,
+            words: 0,
+            strength: "extremely weak",
+        },
+        {
+            entropy: "ASas",
+            type: "card (1 duplicate: as)",
+            events: 2,
+            bits: 12,
+            words: 0,
+            strength: "extremely weak",
+        },
+        // Missing cards are detected
+        {
+            entropy: "ac2c3c4c5c6c7c8c  tcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9stsjsqsks",
+            type: "card (1 missing: 9C)",
+            events: 51,
+            bits: 225,
+            words: 21,
+            strength: "extremely strong",
+        },
+        {
+            entropy: "ac2c3c4c5c6c7c8c  tcjcqckcad2d3d4d  6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9stsjsqsks",
+            type: "card (2 missing: 9C 5D)",
+            events: 50,
+            bits: 224,
+            words: 21,
+            strength: "extremely strong",
+        },
+        {
+            entropy: "ac2c3c4c5c6c7c8c  tcjcqckcad2d3d4d  6d7d8d9dtdjd  kdah2h3h  5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9stsjsqsks",
+            type: "card (4 missing: 9C 5D QD...)",
+            events: 48,
+            bits: 220,
+            words: 18,
+            strength: "extremely strong",
+        },
+        // More than six missing cards does not show message
+        {
+            entropy: "ac2c3c4c5c6c7c8c  tcjcqckcad2d3d4d  6d  8d9d  jd  kdah2h3h  5h6h7h8h9hthjhqhkh  2s3s4s5s6s7s8s9stsjsqsks",
+            type: "card",
+            events: 45,
+            bits: 213,
+            words: 18,
+            strength: "extremely strong",
+        },
+        // Additional entropy from each card decreases as deck is depleted.
+        // Check the boundaries of this depletion
+        // See table at https://github.com/iancoleman/bip39/issues/33#issuecomment-262855862
+        // for following values of 'events, bits, words'
+        // 2 cards remaining = 21 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9stsjs",
+            type: "card (2 missing: QS KS)",
+            events: 50,
+            bits: 224,
+            words: 21,
+            strength: "extremely strong",
+        },
+        // 3 cards remaining = 18 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkhas2s3s4s5s6s7s8s9sts",
+            type: "card (3 missing: JS QS KS)",
+            events: 49,
+            bits: 222, // table uses different rounding - 222.99604
+            words: 18,
+            strength: "extremely strong",
+        },
+        // 13 cards remaining = 18 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqhkh",
+            type: "card",
+            events: 39,
+            bits: 193,
+            words: 18,
+            strength: "extremely strong",
+        },
+        // 14 cards remaining = 15 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h6h7h8h9hthjhqh",
+            type: "card",
+            events: 38,
+            bits: 189,
+            words: 15,
+            strength: "very strong",
+        },
+        // 21 cards remaining = 15 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h5h",
+            type: "card",
+            events: 31,
+            bits: 160,
+            words: 15,
+            strength: "very strong",
+        },
+        // 22 cards remaining = 12 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqdkdah2h3h4h",
+            type: "card",
+            events: 30,
+            bits: 155,
+            words: 12,
+            strength: "strong",
+        },
+        // 27 cards remaining = 12 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjdqd",
+            type: "card",
+            events: 25,
+            bits: 132,
+            words: 12,
+            strength: "strong",
+        },
+        // 28 cards remaining = 9 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d6d7d8d9dtdjd",
+            type: "card",
+            events: 24,
+            bits: 127,
+            words: 9,
+            strength: "weak",
+        },
+        // 34 cards remaining = 9 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d5d",
+            type: "card",
+            events: 18,
+            bits: 97,
+            words: 9,
+            strength: "weak",
+        },
+        // 35 cards remaining = 6 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqckcad2d3d4d",
+            type: "card",
+            events: 17,
+            bits: 92,
+            words: 6,
+            strength: "very weak",
+        },
+        // 40 cards remaining = 6 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjcqc",
+            type: "card",
+            events: 12,
+            bits: 66,
+            words: 6,
+            strength: "very weak",
+        },
+        // 41 cards remaining = 3 words
+        {
+            entropy: "ac2c3c4c5c6c7c8c9ctcjc",
+            type: "card",
+            events: 11,
+            bits: 61,
+            words: 3,
+            strength: "extremely weak",
+        },
+        // 46 cards remaining = 3 words
+        {
+            entropy: "ac2c3c4c5c6c",
+            type: "card",
+            events: 6,
+            bits: 33,
+            words: 3,
+            strength: "extremely weak",
+        },
+        // 47 cards remaining = 0 words
+        {
+            entropy: "ac2c3c4c5c",
+            type: "card",
+            events: 5,
+            bits: 28,
+            words: 0,
+            strength: "extremely weak",
+        },
     ];
     // use entropy
     page.evaluate(function() {
@@ -2621,7 +2861,7 @@ page.open(url, function(status) {
     });
     var nextTest = function runNextTest(i) {
         function getFeedbackError(expected, actual) {
-            if (actual.indexOf(expected.filtered) == -1) {
+            if ("filtered" in expected && actual.indexOf(expected.filtered) == -1) {
                 return "Filtered value not in feedback";
             }
             if (actual.indexOf(expected.type) == -1) {
@@ -2665,7 +2905,7 @@ page.open(url, function(status) {
             }
             // check feedback
             var feedback = page.evaluate(function() {
-                return $(".entropy-feedback").text();
+                return $(".entropy-container").text();
             });
             var feedbackError = getFeedbackError(test, feedback);
             if (feedbackError) {
@@ -2687,15 +2927,15 @@ page.open(url, function(status) {
 });
 },
 
-// 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
@@ -2746,8 +2986,6 @@ page.open(url, function(status) {
 // 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) {
@@ -2838,6 +3076,46 @@ page.open(url, function(status) {
 });
 },
 
+// Github issue 33
+// https://github.com/iancoleman/bip39/issues/33
+// Final cards should contribute entropy
+function() {
+page.open(url, function(status) {
+    // use entropy
+    page.evaluate(function() {
+        $(".use-entropy").prop("checked", true).trigger("change");
+        $(".entropy").val("7S 9H 9S QH 8C KS AS 7D 7C QD 4S 4D TC 2D 5S JS 3D 8S 8H 4C 3C AC 3S QC 9C JC 7H AD TD JD 6D KH 5C QS 2S 6S 6H JH KD 9D-6C TS TH 4H KC 5H 2H AH 2C 8D 3H 5D").trigger("input");
+    });
+    // get the mnemonic
+    waitForGenerate(function() {
+        var originalPhrase = page.evaluate(function() {
+            return $(".phrase").val();
+        });
+        // Set the last 12 cards to be AS
+        page.evaluate(function() {
+            $(".addresses").empty();
+            $(".entropy").val("7S 9H 9S QH 8C KS AS 7D 7C QD 4S 4D TC 2D 5S JS 3D 8S 8H 4C 3C AC 3S QC 9C JC 7H AD TD JD 6D KH 5C QS 2S 6S 6H JH KD 9D-AS AS AS AS AS AS AS AS AS AS AS AS").trigger("input");
+        });
+        // get the new mnemonic
+        waitForGenerate(function() {
+            var newPhrase = page.evaluate(function() {
+                return $(".phrase").val();
+            });
+            if (newPhrase == originalPhrase) {
+                console.log("Changing last 12 cards does not change mnemonic");
+                console.log("Original:");
+                console.log(originalPhrase);
+                console.log("New:");
+                console.log(newPhrase);
+                fail();
+            }
+            next();
+        });
+    });
+});
+},
+
+
 // If you wish to add more tests, do so here...
 
 // Here is a blank test template