X-Git-Url: https://git.immae.eu/?p=perso%2FImmae%2FProjets%2FCryptomonnaies%2FBIP39.git;a=blobdiff_plain;f=src%2Fjs%2Findex.js;h=6367c0197fc985bc17d96a8ae15e9387effb89c8;hp=cee8ffbac5d36a557208e6058dd5445420f20d99;hb=32fab2c39507357909438c2be8cd100c6539038f;hpb=0ec5cb47cfcc46b02ae73919c54f315a4ecfeebf diff --git a/src/js/index.js b/src/js/index.js index cee8ffb..6367c01 100644 --- a/src/js/index.js +++ b/src/js/index.js @@ -1,27 +1,59 @@ (function() { - var mnemonic = new Mnemonic("english"); + // mnemonics is populated as required by getLanguage + var mnemonics = { "english": new Mnemonic("english") }; + var mnemonic = mnemonics["english"]; + var seed = null var bip32RootKey = null; var bip32ExtendedKey = null; - var network = Bitcoin.networks.bitcoin; + var network = bitcoin.networks.bitcoin; var addressRowTemplate = $("#address-row-template"); + var showIndex = true; + var showAddress = true; + var showPubKey = true; + var showPrivKey = true; + var showQr = true; + + var entropyChangeTimeoutEvent = null; var phraseChangeTimeoutEvent = null; + var rootKeyChangedTimeoutEvent = null; var DOM = {}; + DOM.network = $(".network"); + DOM.phraseNetwork = $("#network-phrase"); + DOM.useEntropy = $(".use-entropy"); + DOM.entropyContainer = $(".entropy-container"); + DOM.entropy = $(".entropy"); + DOM.entropyFiltered = DOM.entropyContainer.find(".filtered"); + DOM.entropyType = DOM.entropyContainer.find(".type"); + DOM.entropyStrength = DOM.entropyContainer.find(".strength"); + DOM.entropyEventCount = DOM.entropyContainer.find(".event-count"); + DOM.entropyBits = DOM.entropyContainer.find(".bits"); + DOM.entropyBitsPerEvent = DOM.entropyContainer.find(".bits-per-event"); + DOM.entropyWordCount = DOM.entropyContainer.find(".word-count"); + DOM.entropyBinary = DOM.entropyContainer.find(".binary"); + DOM.entropyMnemonicLength = DOM.entropyContainer.find(".mnemonic-length"); DOM.phrase = $(".phrase"); DOM.passphrase = $(".passphrase"); + DOM.generateContainer = $(".generate-container"); DOM.generate = $(".generate"); + DOM.seed = $(".seed"); DOM.rootKey = $(".root-key"); DOM.extendedPrivKey = $(".extended-priv-key"); DOM.extendedPubKey = $(".extended-pub-key"); + DOM.bip32tab = $("#bip32-tab"); + DOM.bip44tab = $("#bip44-tab"); + DOM.bip32panel = $("#bip32"); + DOM.bip44panel = $("#bip44"); DOM.bip32path = $("#bip32-path"); DOM.bip44path = $("#bip44-path"); DOM.bip44purpose = $("#bip44 .purpose"); DOM.bip44coin = $("#bip44 .coin"); DOM.bip44account = $("#bip44 .account"); DOM.bip44change = $("#bip44 .change"); - DOM.strength = $(".strength"); + DOM.generatedStrength = $(".generate-container .strength"); + DOM.hardenedAddresses = $(".hardened-addresses"); DOM.addresses = $(".addresses"); DOM.rowsToAdd = $(".rows-to-add"); DOM.more = $(".more"); @@ -29,32 +61,73 @@ DOM.tab = $(".derivation-type a"); DOM.indexToggle = $(".index-toggle"); DOM.addressToggle = $(".address-toggle"); + DOM.publicKeyToggle = $(".public-key-toggle"); DOM.privateKeyToggle = $(".private-key-toggle"); - - var derivationPath = DOM.bip44path.val(); + DOM.languages = $(".languages a"); + DOM.qrContainer = $(".qr-container"); + DOM.qrImage = DOM.qrContainer.find(".qr-image"); + DOM.qrHint = DOM.qrContainer.find(".qr-hint"); + DOM.showQrEls = $("[data-show-qr]"); function init() { // Events - DOM.phrase.on("keyup", delayedPhraseChanged); - DOM.passphrase.on("keyup", delayedPhraseChanged); + DOM.network.on("change", networkChanged); + DOM.useEntropy.on("change", setEntropyVisibility); + DOM.entropy.on("input", delayedEntropyChanged); + DOM.entropyMnemonicLength.on("change", entropyChanged); + DOM.phrase.on("input", delayedPhraseChanged); + DOM.passphrase.on("input", delayedPhraseChanged); DOM.generate.on("click", generateClicked); DOM.more.on("click", showMore); - DOM.bip32path.on("keyup", bip32Changed); - DOM.bip44purpose.on("keyup", bip44Changed); - DOM.bip44coin.on("keyup", bip44Changed); - DOM.bip44account.on("keyup", bip44Changed); - DOM.bip44change.on("keyup", bip44Changed); - DOM.tab.on("click", tabClicked); + DOM.rootKey.on("input", delayedRootKeyChanged); + DOM.bip32path.on("input", calcForDerivationPath); + DOM.bip44purpose.on("input", calcForDerivationPath); + DOM.bip44coin.on("input", calcForDerivationPath); + DOM.bip44account.on("input", calcForDerivationPath); + DOM.bip44change.on("input", calcForDerivationPath); + DOM.tab.on("shown.bs.tab", calcForDerivationPath); + DOM.hardenedAddresses.on("change", calcForDerivationPath); DOM.indexToggle.on("click", toggleIndexes); DOM.addressToggle.on("click", toggleAddresses); + DOM.publicKeyToggle.on("click", togglePublicKeys); DOM.privateKeyToggle.on("click", togglePrivateKeys); + DOM.languages.on("click", languageChanged); + setQrEvents(DOM.showQrEls); disableForms(); hidePending(); hideValidationError(); + populateNetworkSelect(); } // Event handlers + function networkChanged(e) { + var networkIndex = e.target.value; + networks[networkIndex].onSelect(); + if (seed != null) { + phraseChanged(); + } + else { + rootKeyChanged(); + } + } + + function setEntropyVisibility() { + if (isUsingOwnEntropy()) { + DOM.entropyContainer.removeClass("hidden"); + DOM.generateContainer.addClass("hidden"); + DOM.phrase.prop("readonly", true); + DOM.entropy.focus(); + entropyChanged(); + } + else { + DOM.entropyContainer.addClass("hidden"); + DOM.generateContainer.removeClass("hidden"); + DOM.phrase.prop("readonly", false); + hidePending(); + } + } + function delayedPhraseChanged() { hideValidationError(); showPending(); @@ -67,30 +140,117 @@ function phraseChanged() { showPending(); hideValidationError(); + setMnemonicLanguage(); // Get the mnemonic phrase var phrase = DOM.phrase.val(); - var passphrase = DOM.passphrase.val(); var errorText = findPhraseErrors(phrase); if (errorText) { showValidationError(errorText); return; } - // Get the derivation path - var errorText = findDerivationPathErrors(); + // Calculate and display + var passphrase = DOM.passphrase.val(); + calcBip32RootKeyFromSeed(phrase, passphrase); + calcForDerivationPath(); + hidePending(); + } + + function delayedEntropyChanged() { + hideValidationError(); + showPending(); + if (entropyChangeTimeoutEvent != null) { + clearTimeout(entropyChangeTimeoutEvent); + } + entropyChangeTimeoutEvent = setTimeout(entropyChanged, 400); + } + + function entropyChanged() { + // If blank entropy, clear mnemonic, addresses, errors + if (DOM.entropy.val().trim().length == 0) { + clearDisplay(); + clearEntropyFeedback(); + DOM.phrase.val(""); + showValidationError("Blank entropy"); + return; + } + // Get the current phrase to detect changes + var phrase = DOM.phrase.val(); + // Set the phrase from the entropy + setMnemonicFromEntropy(); + // Recalc addresses if the phrase has changed + var newPhrase = DOM.phrase.val(); + if (newPhrase != phrase) { + if (newPhrase.length == 0) { + clearDisplay(); + } + else { + phraseChanged(); + } + } + else { + hidePending(); + } + } + + function delayedRootKeyChanged() { + // Warn if there is an existing mnemonic or passphrase. + if (DOM.phrase.val().length > 0 || DOM.passphrase.val().length > 0) { + if (!confirm("This will clear existing mnemonic and passphrase")) { + DOM.rootKey.val(bip32RootKey); + return + } + } + hideValidationError(); + showPending(); + // Clear existing mnemonic and passphrase + DOM.phrase.val(""); + DOM.passphrase.val(""); + seed = null; + if (rootKeyChangedTimeoutEvent != null) { + clearTimeout(rootKeyChangedTimeoutEvent); + } + rootKeyChangedTimeoutEvent = setTimeout(rootKeyChanged, 400); + } + + function rootKeyChanged() { + showPending(); + hideValidationError(); + // Validate the root key TODO + var rootKeyBase58 = DOM.rootKey.val(); + var errorText = validateRootKey(rootKeyBase58); if (errorText) { showValidationError(errorText); return; } // Calculate and display - calcBip32Seed(phrase, passphrase, derivationPath); + calcBip32RootKeyFromBase58(rootKeyBase58); + calcForDerivationPath(); + hidePending(); + } + + function calcForDerivationPath() { + showPending(); + hideValidationError(); + // Get the derivation path + var derivationPath = getDerivationPath(); + var errorText = findDerivationPathErrors(derivationPath); + if (errorText) { + showValidationError(errorText); + return; + } + bip32ExtendedKey = calcBip32ExtendedKey(derivationPath); displayBip32Info(); hidePending(); } function generateClicked() { + if (isUsingOwnEntropy()) { + return; + } clearDisplay(); showPending(); setTimeout(function() { + setMnemonicLanguage(); var phrase = generateRandomPhrase(); if (!phrase) { return; @@ -99,36 +259,37 @@ }, 50); } - function tabClicked(e) { - var activePath = $(e.target.getAttribute("href") + " .path"); - derivationPath = activePath.val(); - derivationChanged(); - } - - function derivationChanged() { - delayedPhraseChanged(); - } - - function bip32Changed() { - derivationPath = DOM.bip32path.val(); - derivationChanged(); - } - - function bip44Changed() { - setBip44DerivationPath(); - derivationPath = DOM.bip44path.val(); - derivationChanged(); + function languageChanged() { + setTimeout(function() { + setMnemonicLanguage(); + if (DOM.phrase.val().length > 0) { + var newPhrase = convertPhraseToNewLanguage(); + DOM.phrase.val(newPhrase); + phraseChanged(); + } + else { + DOM.generate.trigger("click"); + } + }, 50); } function toggleIndexes() { + showIndex = !showIndex; $("td.index span").toggleClass("invisible"); } function toggleAddresses() { + showAddress = !showAddress; $("td.address span").toggleClass("invisible"); } + function togglePublicKeys() { + showPubKey = !showPubKey; + $("td.pubkey span").toggleClass("invisible"); + } + function togglePrivateKeys() { + showPrivKey = !showPrivKey; $("td.privkey span").toggleClass("invisible"); } @@ -140,33 +301,24 @@ showValidationError(errorText); return; } - var numWords = parseInt(DOM.strength.val()); - // Check strength is an integer - if (isNaN(numWords)) { - DOM.strength.val("12"); - numWords = 12; - } - // Check strength is a multiple of 32, if not round it down - if (numWords % 3 != 0) { - numWords = Math.floor(numWords / 3) * 3; - DOM.strength.val(numWords); - } - // Check strength is at least 32 - if (numWords == 0) { - numWords = 3; - DOM.strength.val(numWords); - } + var numWords = parseInt(DOM.generatedStrength.val()); var strength = numWords / 3 * 32; var words = mnemonic.generate(strength); DOM.phrase.val(words); return words; } - function calcBip32Seed(phrase, passphrase, path) { - var seed = mnemonic.toSeed(phrase, passphrase); - var seedHash = Bitcoin.crypto.sha256(seed).toString("hex"); - bip32RootKey = Bitcoin.HDNode.fromSeedHex(seedHash, network); - bip32ExtendedKey = bip32RootKey; + function calcBip32RootKeyFromSeed(phrase, passphrase) { + seed = mnemonic.toSeed(phrase, passphrase); + bip32RootKey = bitcoin.HDNode.fromSeedHex(seed, network); + } + + function calcBip32RootKeyFromBase58(rootKeyBase58) { + bip32RootKey = bitcoin.HDNode.fromBase58(rootKeyBase58, network); + } + + function calcBip32ExtendedKey(path) { + var extendedKey = bip32RootKey; // Derive the key from the path var pathBits = path.split("/"); for (var i=0; i 0) { - // TODO check that lowercasing is always valid to do - proper.push(part.toLowerCase()); + phrase = mnemonic.normalizeString(phrase); + var words = phraseToWordArray(phrase); + // Detect blank phrase + if (words.length == 0) { + return "Blank mnemonic"; + } + // Check each word + for (var i=0; i 1) { + if (path[1] != "/") { + return "Separator must be '/'"; + } + var indexes = path.split("/"); + if (indexes.length > maxDepth) { + return "Derivation depth is " + indexes.length + ", must be less than " + maxDepth; + } + for (var depth = 1; depth 0) { + return "Invalid characters " + invalidChars + " found at depth " + depth; + } + var indexValue = parseInt(index.replace("'", "")); + if (isNaN(depth)) { + return "Invalid number at depth " + depth; + } + if (indexValue > maxIndexValue) { + return "Value of " + indexValue + " at depth " + depth + " must be less than " + maxIndexValue; + } + } + } return false; } function displayBip32Info() { // Display the key + DOM.seed.val(seed); var rootKey = bip32RootKey.toBase58(); DOM.rootKey.val(rootKey); var extendedPrivKey = bip32ExtendedKey.toBase58(); @@ -239,12 +466,41 @@ function displayAddresses(start, total) { for (var i=0; i"); + option.attr("value", i); + option.text(network.name); + DOM.phraseNetwork.append(option); + } + } + + function getLanguage() { + var defaultLanguage = "english"; + // Try to get from existing phrase + var language = getLanguageFromPhrase(); + // Try to get from url if not from phrase + if (language.length == 0) { + language = getLanguageFromUrl(); + } + // Default to English if no other option + if (language.length == 0) { + language = defaultLanguage; + } + return language; + } + + function getLanguageFromPhrase(phrase) { + // Check if how many words from existing phrase match a language. + var language = ""; + if (!phrase) { + phrase = DOM.phrase.val(); + } + if (phrase.length > 0) { + var words = phraseToWordArray(phrase); + var languageMatches = {}; + for (l in WORDLISTS) { + // Track how many words match in this language + languageMatches[l] = 0; + for (var i=0; i -1; + if (wordInLanguage) { + languageMatches[l]++; + } + } + // Find languages with most word matches. + // This is made difficult due to commonalities between Chinese + // simplified vs traditional. + var mostMatches = 0; + var mostMatchedLanguages = []; + for (var l in languageMatches) { + var numMatches = languageMatches[l]; + if (numMatches > mostMatches) { + mostMatches = numMatches; + mostMatchedLanguages = [l]; + } + else if (numMatches == mostMatches) { + mostMatchedLanguages.push(l); + } + } + } + if (mostMatchedLanguages.length > 0) { + // Use first language and warn if multiple detected + language = mostMatchedLanguages[0]; + if (mostMatchedLanguages.length > 1) { + console.warn("Multiple possible languages"); + console.warn(mostMatchedLanguages); + } + } + } + return language; + } + + function getLanguageFromUrl() { + for (var language in WORDLISTS) { + if (window.location.hash.indexOf(language) > -1) { + return language; + } + } + return ""; + } + + function setMnemonicLanguage() { + var language = getLanguage(); + // Load the bip39 mnemonic generator for this language if required + if (!(language in mnemonics)) { + mnemonics[language] = new Mnemonic(language); + } + mnemonic = mnemonics[language]; + } + + function convertPhraseToNewLanguage() { + var oldLanguage = getLanguageFromPhrase(); + var newLanguage = getLanguageFromUrl(); + var oldPhrase = DOM.phrase.val(); + var oldWords = phraseToWordArray(oldPhrase); + var newWords = []; + for (var i=0; i 0) { + noBlanks.push(word); + } + } + return noBlanks; + } + + // TODO look at jsbip39 - mnemonic.joinWords + function wordArrayToPhrase(words) { + var phrase = words.join(" "); + var language = getLanguageFromPhrase(phrase); + if (language == "japanese") { + phrase = words.join("\u3000"); + } + return phrase; + } + + function isUsingOwnEntropy() { + return DOM.useEntropy.prop("checked"); + } + + function setMnemonicFromEntropy() { + clearEntropyFeedback(); + // Get entropy value + var entropyStr = DOM.entropy.val(); + // Work out minimum base for entropy + var entropy = Entropy.fromString(entropyStr); + if (entropy.binaryStr.length == 0) { + return; + } + // Show entropy details + showEntropyFeedback(entropy); + // Use entropy hash if not using raw entropy + var bits = entropy.binaryStr; + var mnemonicLength = DOM.entropyMnemonicLength.val(); + if (mnemonicLength != "raw") { + // Get bits by hashing entropy with SHA256 + var hash = sjcl.hash.sha256.hash(entropy.cleanStr); + var hex = sjcl.codec.hex.fromBits(hash); + bits = BigInteger.parse(hex, 16).toString(2); + for (var i=0; i<256-bits.length; i++) { + bits = "0" + bits; + } + // Truncate hash to suit number of words + mnemonicLength = parseInt(mnemonicLength); + var numberOfBits = 32 * mnemonicLength / 3; + bits = bits.substring(0, numberOfBits); + } + // Discard trailing entropy + var bitsToUse = Math.floor(bits.length / 32) * 32; + var start = bits.length - bitsToUse; + var binaryStr = bits.substring(start); + // Convert entropy string to numeric array + var entropyArr = []; + for (var i=0; i= 64) { + strength = "very weak"; + } + if (numberOfBits >= 96) { + strength = "weak"; + } + if (numberOfBits >= 128) { + strength = "strong"; + } + if (numberOfBits >= 160) { + strength = "very strong"; + } + if (numberOfBits >= 192) { + strength = "extremely strong"; + } + // If time to crack is less than one day, and password is considered + // strong or better based on the number of bits, rename strength to + // 'easily cracked'. + try { + var z = zxcvbn(entropy.base.parts.join("")); + var timeToCrack = z.crack_times_seconds.offline_fast_hashing_1e10_per_second; + if (timeToCrack < 86400 && entropy.binaryStr.length >= 128) { + strength = "easily cracked"; + if (z.feedback.warning != "") { + strength = strength + " - " + z.feedback.warning; + }; + } + } + catch (e) { + strength = "unknown"; + console.log("Error detecting entropy strength with zxcvbn:"); + console.log(e); + } + var entropyTypeStr = getEntropyTypeStr(entropy); + var wordCount = Math.floor(numberOfBits / 32) * 3; + var bitsPerEvent = entropy.bitsPerEvent.toFixed(2); + DOM.entropyFiltered.html(entropy.cleanHtml); + DOM.entropyType.text(entropyTypeStr); + DOM.entropyStrength.text(strength); + DOM.entropyEventCount.text(entropy.base.ints.length); + DOM.entropyBits.text(numberOfBits); + DOM.entropyWordCount.text(wordCount); + DOM.entropyBinary.text(entropy.binaryStr); + DOM.entropyBitsPerEvent.text(bitsPerEvent); + } + + function getEntropyTypeStr(entropy) { + var typeStr = entropy.base.str; + // Add some detail if these are cards + if (entropy.base.asInt == 52) { + var cardDetail = []; // array of message strings + // Detect duplicates + var dupes = []; + var dupeTracker = {}; + for (var i=0; i 0) { + var dupeWord = "duplicates"; + if (dupes.length == 1) { + dupeWord = "duplicate"; + } + var msg = dupes.length + " " + dupeWord + ": " + dupes.slice(0,3).join(" "); + if (dupes.length > 3) { + msg += "..."; + } + cardDetail.push(msg); + } + // Detect full deck + var uniqueCards = []; + for (var uniqueCard in dupeTracker) { + uniqueCards.push(uniqueCard); + } + if (uniqueCards.length == 52) { + cardDetail.unshift("full deck"); + } + // Detect missing cards + var values = "A23456789TJQK"; + var suits = "CDHS"; + var missingCards = []; + for (var i=0; i 0 && missingCards.length <= 6) { + var msg = missingCards.length + " missing: " + missingCards.slice(0,3).join(" "); + if (missingCards.length > 3) { + msg += "..."; + } + cardDetail.push(msg); + } + // Add card details to typeStr + if (cardDetail.length > 0) { + typeStr += " (" + cardDetail.join(", ") + ")"; + } + } + return typeStr; + } + + function setQrEvents(els) { + els.on("mouseenter", createQr); + els.on("mouseleave", destroyQr); + els.on("click", toggleQr); + } + + function createQr(e) { + var content = e.target.textContent || e.target.value; + if (content) { + var size = 130; + DOM.qrImage.qrcode({width: size, height: size, text: content}); + if (!showQr) { + DOM.qrImage.addClass("hidden"); + } + DOM.qrContainer.removeClass("hidden"); + } + } + + function destroyQr() { + DOM.qrImage.text(""); + DOM.qrContainer.addClass("hidden"); + } + + function toggleQr() { + showQr = !showQr; + DOM.qrImage.toggleClass("hidden"); + DOM.qrHint.toggleClass("hidden"); + } + + function bip44TabSelected() { + return DOM.bip44tab.hasClass("active"); + } + + function bip32TabSelected() { + return DOM.bip32tab.hasClass("active"); + } + + var networks = [ + { + name: "Bitcoin", + onSelect: function() { + network = bitcoin.networks.bitcoin; + DOM.bip44coin.val(0); + }, + }, + { + name: "Bitcoin Testnet", + onSelect: function() { + network = bitcoin.networks.testnet; + DOM.bip44coin.val(1); + }, + }, + { + name: "Litecoin", + onSelect: function() { + network = bitcoin.networks.litecoin; + DOM.bip44coin.val(2); + }, + }, + { + name: "Dogecoin", + onSelect: function() { + network = bitcoin.networks.dogecoin; + DOM.bip44coin.val(3); + }, + }, + { + name: "ShadowCash", + onSelect: function() { + network = bitcoin.networks.shadow; + DOM.bip44coin.val(35); + }, + }, + { + name: "ShadowCash Testnet", + onSelect: function() { + network = bitcoin.networks.shadowtn; + DOM.bip44coin.val(1); + }, + }, + { + name: "Viacoin", + onSelect: function() { + network = bitcoin.networks.viacoin; + DOM.bip44coin.val(14); + }, + }, + { + name: "Viacoin Testnet", + onSelect: function() { + network = bitcoin.networks.viacointestnet; + DOM.bip44coin.val(1); + }, + }, + { + name: "Jumbucks", + onSelect: function() { + network = bitcoin.networks.jumbucks; + DOM.bip44coin.val(26); + }, + }, + { + name: "CLAM", + onSelect: function() { + network = bitcoin.networks.clam; + DOM.bip44coin.val(23); + }, + }, + { + name: "DASH", + onSelect: function() { + network = bitcoin.networks.dash; + DOM.bip44coin.val(5); + }, + }, + { + name: "Namecoin", + onSelect: function() { + network = bitcoin.networks.namecoin; + DOM.bip44coin.val(7); + }, + }, + { + name: "Peercoin", + onSelect: function() { + network = bitcoin.networks.peercoin; + DOM.bip44coin.val(6); + }, + }, + ] + init(); })();