]>
git.immae.eu Git - perso/Immae/Projets/Cryptomonnaies/BIP39.git/blob - src/js/entropy.js
2 * Detects entropy from a string.
10 * card [A2-9TJQK][CDHS]
12 * Automatically uses lowest entropy to avoid issues such as interpretting 0101
13 * as hexadecimal which would be 16 bits when really it's only 4 bits of binary
17 window
.Entropy
= new (function() {
19 var TWO
= new BigInteger(2);
21 // matchers returns an array of the matched events for each type of entropy.
23 // matchers.binary("010") returns ["0", "1", "0"]
24 // matchers.binary("a10") returns ["1", "0"]
25 // matchers.hex("a10") returns ["a", "1", "0"]
27 binary: function(str
) {
28 return str
.match(/[0-1]/gi) || [];
30 base6: function(str
) {
31 return str
.match(/[0-5]/gi) || [];
34 return str
.match(/[1-6]/gi) || []; // ie dice numbers
36 base10: function(str
) {
37 return str
.match(/[0-9]/gi) || [];
40 return str
.match(/[0-9A-F]/gi) || [];
43 // Format is NumberSuit, eg
50 return str
.match(/([A2-9TJQK][CDHS])/gi) || [];
54 // Convert array of cards from ["ac", "4d", "ks"]
55 // to numbers between 0 and 51 [0, 16, 51]
56 function convertCardsToInts(cards
) {
58 var values
= "a23456789tjqk";
60 for (var i
=0; i
<cards
.length
; i
++) {
61 var card
= cards
[i
].toLowerCase();
64 var asInt
= 13 * suits
.indexOf(suit
) + values
.indexOf(value
);
70 this.fromString = function(rawEntropyStr
) {
71 // Find type of entropy being used (binary, hex, dice etc)
72 var base
= getBase(rawEntropyStr
);
73 // Convert dice to base6 entropy (ie 1-6 to 0-5)
74 // This is done by changing all 6s to 0s
75 if (base
.str
== "dice") {
78 for (var i
=0; i
<base
.parts
.length
; i
++) {
79 var c
= base
.parts
[i
];
80 if ("12345".indexOf(c
) > -1) {
81 newParts
[i
] = base
.parts
[i
];
82 newInts
[i
] = base
.ints
[i
];
89 base
.str
= "base 6 (dice)";
91 base
.parts
= newParts
;
92 base
.matcher
= matchers
.base6
;
94 // Detect empty entropy
95 if (base
.parts
.length
== 0) {
103 // Convert base.ints to BigInteger.
104 // Due to using unusual bases, eg cards of base52, this is not as simple as
105 // using BigInteger.parse()
106 var entropyInt
= BigInteger
.ZERO
;
107 for (var i
=base
.ints
.length
-1; i
>=0; i
--) {
108 var thisInt
= BigInteger
.parse(base
.ints
[i
]);
109 var power
= (base
.ints
.length
- 1) - i
;
110 var additionalEntropy
= BigInteger
.parse(base
.asInt
).pow(power
).multiply(thisInt
);
111 entropyInt
= entropyInt
.add(additionalEntropy
);
113 // Convert entropy to binary
114 var entropyBin
= entropyInt
.toString(2);
115 // If the first integer is small, it must be padded with zeros.
116 // Otherwise the chance of the first bit being 1 is 100%, which is
117 // obviously incorrect.
118 // This is not perfect for non-2^n bases.
119 var expectedBits
= Math
.floor(base
.parts
.length
* Math
.log2(base
.asInt
));
120 while (entropyBin
.length
< expectedBits
) {
121 entropyBin
= "0" + entropyBin
;
123 // Cards binary must be handled differently, since they're not replaced
124 if (base
.asInt
== 52) {
125 entropyBin
= getCardBinary(base
.parts
);
127 // Supply a 'filtered' entropy string for display purposes
128 var entropyClean
= base
.parts
.join("");
129 var entropyHtml
= base
.parts
.join("");
130 if (base
.asInt
== 52) {
131 entropyClean
= base
.parts
.join(" ").toUpperCase();
132 entropyClean
= entropyClean
.replace(/C
/g
, "\u2663");
133 entropyClean
= entropyClean
.replace(/D
/g
, "\u2666");
134 entropyClean
= entropyClean
.replace(/H
/g
, "\u2665");
135 entropyClean
= entropyClean
.replace(/S
/g
, "\u2660");
136 entropyHtml
= base
.parts
.join(" ").toUpperCase();
137 entropyHtml
= entropyHtml
.replace(/C
/g
, "<span class='card-suit club'>\u2663</span>");
138 entropyHtml
= entropyHtml
.replace(/D
/g
, "<span class='card-suit diamond'>\u2666</span>");
139 entropyHtml
= entropyHtml
.replace(/H
/g
, "<span class='card-suit heart'>\u2665</span>");
140 entropyHtml
= entropyHtml
.replace(/S
/g
, "<span class='card-suit spade'>\u2660</span>");
144 binaryStr: entropyBin
,
145 cleanStr: entropyClean
,
146 cleanHtml: entropyHtml
,
152 function getSortedDeck() {
155 var values
= "A23456789TJQK";
156 for (var i
=0; i
<suits
.length
; i
++) {
157 for (var j
=0; j
<values
.length
; j
++) {
158 s
.push(values
[j
]+suits
[i
]);
164 function getBase(str
) {
165 // Need to get the lowest base for the supplied entropy.
166 // This prevents interpreting, say, dice rolls as hexadecimal.
167 var binaryMatches
= matchers
.binary(str
);
168 var hexMatches
= matchers
.hex(str
);
169 // Find the lowest base that can be used, whilst ignoring any irrelevant chars
170 if (binaryMatches
.length
== hexMatches
.length
&& hexMatches
.length
> 0) {
171 var ints
= binaryMatches
.map(function(i
) { return parseInt(i
, 2) });
174 parts: binaryMatches
,
175 matcher: matchers
.binary
,
180 var cardMatches
= matchers
.card(str
);
181 if (cardMatches
.length
>= hexMatches
.length
/ 2) {
182 var ints
= convertCardsToInts(cardMatches
);
186 matcher: matchers
.card
,
191 var diceMatches
= matchers
.dice(str
);
192 if (diceMatches
.length
== hexMatches
.length
&& hexMatches
.length
> 0) {
193 var ints
= diceMatches
.map(function(i
) { return parseInt(i
) });
197 matcher: matchers
.dice
,
202 var base6Matches
= matchers
.base6(str
);
203 if (base6Matches
.length
== hexMatches
.length
&& hexMatches
.length
> 0) {
204 var ints
= base6Matches
.map(function(i
) { return parseInt(i
) });
208 matcher: matchers
.base6
,
213 var base10Matches
= matchers
.base10(str
);
214 if (base10Matches
.length
== hexMatches
.length
&& hexMatches
.length
> 0) {
215 var ints
= base10Matches
.map(function(i
) { return parseInt(i
) });
218 parts: base10Matches
,
219 matcher: matchers
.base10
,
224 var ints
= hexMatches
.map(function(i
) { return parseInt(i
, 16) });
228 matcher: matchers
.hex
,
234 // Assume cards are NOT replaced.
235 // Additional entropy decreases as more cards are used. This means
236 // total possible entropy is measured using n!, not base^n.
237 // eg the second last card can be only one of two, not one of fifty two
238 // so the added entropy for that card is only one bit at most
239 function getCardBinary(cards
) {
240 // Track how many instances of each card have been used, and thus
241 // how many decks are in use.
243 var numberOfDecks
= 0;
244 // Work out number of decks by max(duplicates)
245 for (var i
=0; i
<cards
.length
; i
++) {
246 // Get the card that was drawn
247 var cardLower
= cards
[i
];
248 var card
= cardLower
.toUpperCase();
249 // Initialize the count for this card if needed
250 if (!(card
in cardCounts
)) {
251 cardCounts
[card
] = 0;
253 cardCounts
[card
] += 1;
254 // See if this is max(duplicates)
255 if (cardCounts
[card
] > numberOfDecks
) {
256 numberOfDecks
= cardCounts
[card
];
259 // Work out the total number of bits for this many decks
260 // See http://crypto.stackexchange.com/q/41886
261 var gainedBits
= Math
.log2(factorial(52 * numberOfDecks
));
262 var lostBits
= 52 * Math
.log2(factorial(numberOfDecks
));
263 var maxBits
= gainedBits
- lostBits
;
264 // Convert the drawn cards to a binary representation.
265 // The exact technique for doing this is unclear.
267 // http://crypto.stackexchange.com/a/41896
268 // "I even doubt that this is well defined (only the average entropy
271 // https://github.com/iancoleman/bip39/issues/33#issuecomment-263021856
272 // "The binary representation can be the first log(permutations,2) bits
273 // of the sha-2 hash of the normalized deck string."
275 // In this specific implementation, the first N bits of the hash of the
276 // normalized cards string is being used. Uppercase, no spaces; eg
277 // sha256("AH8DQSTC2H")
278 var totalCards
= numberOfDecks
* 52;
279 var percentUsed
= cards
.length
/ totalCards
;
280 // Calculate the average number of bits of entropy for the number of
282 var numberOfBits
= Math
.floor(maxBits
* percentUsed
);
283 // Create a normalized string of the selected cards
284 var normalizedCards
= cards
.join("").toUpperCase();
285 // Convert to binary using the SHA256 hash of the normalized cards.
286 // If the number of bits is more than 256, multiple rounds of hashing
287 // are used until the required number of bits is reached.
290 while (entropyBin
.length
< numberOfBits
) {
291 var hashedCards
= sjcl
.hash
.sha256
.hash(normalizedCards
);
292 for (var j
=0; j
<iterations
; j
++) {
293 hashedCards
= sjcl
.hash
.sha256
.hash(hashedCards
);
295 var hashHex
= sjcl
.codec
.hex
.fromBits(hashedCards
);
296 for (var i
=0; i
<hashHex
.length
; i
++) {
297 var decimal = parseInt(hashHex
[i
], 16);
298 var binary
= decimal.toString(2);
299 while (binary
.length
< 4) {
300 binary
= "0" + binary
;
302 entropyBin
= entropyBin
+ binary
;
304 iterations
= iterations
+ 1;
306 // Truncate to the appropriate number of bits.
307 entropyBin
= entropyBin
.substring(0, numberOfBits
);
311 // Polyfill for Math.log2
312 // See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/log2#Polyfill
313 Math
.log2
= Math
.log2
|| function(x
) {
314 // The polyfill isn't good enough because of the poor accuracy of
316 // log2(8) gave 2.9999999999999996 which when floored causes issues.
317 // So instead use the BigInteger library to get it right.
318 return BigInteger
.log(x
) / BigInteger
.log(2);
321 // Depends on BigInteger
322 function factorial(n
) {
327 for (var i
=1; i
<=n
; i
++) {
328 f
= f
.multiply(new BigInteger(i
));