mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-12 15:51:12 +00:00
move substrate-bip39 into polkadot-sdk (#3579)
Moves [substrate-bip39](https://github.com/paritytech/substrate-bip39) into substrate. All git history is preserved. Dependencies have been updated to use the same version as the rest of the repo. Fixes https://github.com/paritytech/polkadot-sdk/issues/1934. --------- Co-authored-by: Maciej Hirsz <maciej.hirsz@gmail.com> Co-authored-by: Maciej Hirsz <1096222+maciejhirsz@users.noreply.github.com> Co-authored-by: Gav Wood <i@gavwood.com> Co-authored-by: Stanislav Tkach <stanislav.tkach@gmail.com> Co-authored-by: Robert Habermeier <rphmeier@gmail.com> Co-authored-by: Pierre Krieger <pierre.krieger1708@gmail.com> Co-authored-by: Demi M. Obenour <demi@parity.io> Co-authored-by: Bastian Köcher <git@kchr.de> Co-authored-by: NikVolf <nikvolf@gmail.com> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> Co-authored-by: Benjamin Kampmann <ben@gnunicorn.org> Co-authored-by: Maciej Hirsz <hello@maciej.codes> Co-authored-by: cheme <emericchevalier.pro@gmail.com> Co-authored-by: adoerr <0xad@gmx.net> Co-authored-by: Jun Jiang <jasl9187@hotmail.com> Co-authored-by: Dan Shields <35669742+NukeManDan@users.noreply.github.com> Co-authored-by: Michal Kucharczyk <1728078+michalkucharczyk@users.noreply.github.com>
This commit is contained in:
André Silva
Generated
+34
-138
@@ -744,12 +744,6 @@ dependencies = [
|
||||
"nodrop",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "arrayvec"
|
||||
version = "0.5.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "23b62fc65de8e4e7f52534fb52b0f3ed04746ae267519eef2a83941e8085068b"
|
||||
|
||||
[[package]]
|
||||
name = "arrayvec"
|
||||
version = "0.7.4"
|
||||
@@ -1334,7 +1328,7 @@ dependencies = [
|
||||
"ark-std 0.4.0",
|
||||
"dleq_vrf",
|
||||
"fflonk",
|
||||
"merlin 3.0.0",
|
||||
"merlin",
|
||||
"rand_chacha 0.3.1",
|
||||
"rand_core 0.6.4",
|
||||
"ring 0.1.0",
|
||||
@@ -1559,18 +1553,6 @@ dependencies = [
|
||||
"constant_time_eq 0.3.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "block-buffer"
|
||||
version = "0.7.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c0940dc441f31689269e10ac70eb1002a3a1d3ad1390e030043662eb7fe4688b"
|
||||
dependencies = [
|
||||
"block-padding",
|
||||
"byte-tools",
|
||||
"byteorder",
|
||||
"generic-array 0.12.4",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "block-buffer"
|
||||
version = "0.9.0"
|
||||
@@ -1589,15 +1571,6 @@ dependencies = [
|
||||
"generic-array 0.14.7",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "block-padding"
|
||||
version = "0.1.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "fa79dedbb091f449f1f39e53edf88d5dbe95f895dae6135a8d7b881fb5af73f5"
|
||||
dependencies = [
|
||||
"byte-tools",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "blocking"
|
||||
version = "1.3.1"
|
||||
@@ -2634,9 +2607,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "clap-num"
|
||||
version = "1.0.2"
|
||||
version = "1.1.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "488557e97528174edaa2ee268b23a809e0c598213a4bbcb4f34575a46fda147e"
|
||||
checksum = "0e063d263364859dc54fb064cedb7c122740cd4733644b14b176c097f51e8ab7"
|
||||
dependencies = [
|
||||
"num-traits",
|
||||
]
|
||||
@@ -2854,11 +2827,10 @@ checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7"
|
||||
|
||||
[[package]]
|
||||
name = "colored"
|
||||
version = "2.0.4"
|
||||
version = "2.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2674ec482fbc38012cf31e6c42ba0177b431a0cb6f15fe40efa5aab1bda516f6"
|
||||
checksum = "cbf2150cce219b664a8a70df7a1f933836724b503f8a413af9365b4dcc4d90b8"
|
||||
dependencies = [
|
||||
"is-terminal",
|
||||
"lazy_static",
|
||||
"windows-sys 0.48.0",
|
||||
]
|
||||
@@ -2886,7 +2858,7 @@ dependencies = [
|
||||
"ark-std 0.4.0",
|
||||
"fflonk",
|
||||
"getrandom_or_panic",
|
||||
"merlin 3.0.0",
|
||||
"merlin",
|
||||
"rand_chacha 0.3.1",
|
||||
]
|
||||
|
||||
@@ -3526,16 +3498,6 @@ dependencies = [
|
||||
"subtle 2.5.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "crypto-mac"
|
||||
version = "0.11.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "25fab6889090c8133f3deb8f73ba3c65a7f456f66436fc012a1b1e272b1e103e"
|
||||
dependencies = [
|
||||
"generic-array 0.14.7",
|
||||
"subtle 2.5.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ctr"
|
||||
version = "0.7.0"
|
||||
@@ -4396,19 +4358,6 @@ dependencies = [
|
||||
"url",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "curve25519-dalek"
|
||||
version = "2.1.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4a9b85542f99a2dfa2a1b8e192662741c9859a846b296bef1c92ef9b58b5a216"
|
||||
dependencies = [
|
||||
"byteorder",
|
||||
"digest 0.8.1",
|
||||
"rand_core 0.5.1",
|
||||
"subtle 2.5.0",
|
||||
"zeroize",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "curve25519-dalek"
|
||||
version = "3.2.0"
|
||||
@@ -5238,12 +5187,6 @@ dependencies = [
|
||||
"once_cell",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "fake-simd"
|
||||
version = "0.1.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e88a8acf291dafb59c2d96e8f59828f3838bb1a70398823ade51a84de6a6deed"
|
||||
|
||||
[[package]]
|
||||
name = "fallible-iterator"
|
||||
version = "0.2.0"
|
||||
@@ -5353,7 +5296,7 @@ dependencies = [
|
||||
"ark-poly",
|
||||
"ark-serialize 0.4.2",
|
||||
"ark-std 0.4.0",
|
||||
"merlin 3.0.0",
|
||||
"merlin",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -6428,16 +6371,6 @@ dependencies = [
|
||||
"digest 0.9.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "hmac"
|
||||
version = "0.11.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2a2a2320eb7ec0ebe8da8f744d7812d9fc4cb4d09344ac01898dbcb6a20ae69b"
|
||||
dependencies = [
|
||||
"crypto-mac 0.11.0",
|
||||
"digest 0.9.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "hmac"
|
||||
version = "0.12.1"
|
||||
@@ -8124,18 +8057,6 @@ dependencies = [
|
||||
"hash-db",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "merlin"
|
||||
version = "2.0.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4e261cf0f8b3c42ded9f7d2bb59dea03aa52bc8a1cbc7482f9fc3fd1229d3b42"
|
||||
dependencies = [
|
||||
"byteorder",
|
||||
"keccak",
|
||||
"rand_core 0.5.1",
|
||||
"zeroize",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "merlin"
|
||||
version = "3.0.0"
|
||||
@@ -11641,21 +11562,23 @@ version = "0.2.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7924d1d0ad836f665c9065e26d016c673ece3993f30d340068b16f282afc1156"
|
||||
|
||||
[[package]]
|
||||
name = "password-hash"
|
||||
version = "0.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "346f04948ba92c43e8469c1ee6736c7563d71012b17d40745260fe106aac2166"
|
||||
dependencies = [
|
||||
"base64ct",
|
||||
"rand_core 0.6.4",
|
||||
"subtle 2.5.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "paste"
|
||||
version = "1.0.14"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "de3145af08024dea9fa9914f381a17b8fc6034dfb00f3a84013f7ff43f29ed4c"
|
||||
|
||||
[[package]]
|
||||
name = "pbkdf2"
|
||||
version = "0.8.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d95f5254224e617595d2cc3cc73ff0a5eaf2637519e25f03388154e9378b6ffa"
|
||||
dependencies = [
|
||||
"crypto-mac 0.11.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "pbkdf2"
|
||||
version = "0.12.2"
|
||||
@@ -11663,6 +11586,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f8ed6a7761f76e3b9f92dfb0a60a6a6477c61024b775147ff0973a02653abaf2"
|
||||
dependencies = [
|
||||
"digest 0.10.7",
|
||||
"password-hash",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -12454,7 +12378,7 @@ dependencies = [
|
||||
"kvdb",
|
||||
"kvdb-memorydb",
|
||||
"log",
|
||||
"merlin 3.0.0",
|
||||
"merlin",
|
||||
"parity-scale-codec",
|
||||
"parking_lot 0.12.1",
|
||||
"polkadot-node-jaeger",
|
||||
@@ -13672,7 +13596,7 @@ dependencies = [
|
||||
"sc-keystore",
|
||||
"sc-network",
|
||||
"sc-service",
|
||||
"schnorrkel 0.9.1",
|
||||
"schnorrkel 0.11.4",
|
||||
"serde",
|
||||
"serde_yaml",
|
||||
"sha1",
|
||||
@@ -14921,7 +14845,7 @@ dependencies = [
|
||||
"blake2 0.10.6",
|
||||
"common",
|
||||
"fflonk",
|
||||
"merlin 3.0.0",
|
||||
"merlin",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -17103,22 +17027,6 @@ dependencies = [
|
||||
"hashbrown 0.13.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "schnorrkel"
|
||||
version = "0.9.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "021b403afe70d81eea68f6ea12f6b3c9588e5d536a94c3bf80f15e7faa267862"
|
||||
dependencies = [
|
||||
"arrayref",
|
||||
"arrayvec 0.5.2",
|
||||
"curve25519-dalek 2.1.3",
|
||||
"merlin 2.0.1",
|
||||
"rand_core 0.5.1",
|
||||
"sha2 0.8.2",
|
||||
"subtle 2.5.0",
|
||||
"zeroize",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "schnorrkel"
|
||||
version = "0.10.2"
|
||||
@@ -17128,7 +17036,7 @@ dependencies = [
|
||||
"arrayref",
|
||||
"arrayvec 0.7.4",
|
||||
"curve25519-dalek-ng",
|
||||
"merlin 3.0.0",
|
||||
"merlin",
|
||||
"rand_core 0.6.4",
|
||||
"sha2 0.9.9",
|
||||
"subtle-ng",
|
||||
@@ -17146,7 +17054,7 @@ dependencies = [
|
||||
"arrayvec 0.7.4",
|
||||
"curve25519-dalek 4.1.2",
|
||||
"getrandom_or_panic",
|
||||
"merlin 3.0.0",
|
||||
"merlin",
|
||||
"rand_core 0.6.4",
|
||||
"serde_bytes",
|
||||
"sha2 0.10.7",
|
||||
@@ -17510,18 +17418,6 @@ dependencies = [
|
||||
"digest 0.10.7",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "sha2"
|
||||
version = "0.8.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a256f46ea78a0c0d9ff00077504903ac881a1dafdc20da66545699e7776b3e69"
|
||||
dependencies = [
|
||||
"block-buffer 0.7.3",
|
||||
"digest 0.8.1",
|
||||
"fake-simd",
|
||||
"opaque-debug 0.2.3",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "sha2"
|
||||
version = "0.9.9"
|
||||
@@ -17756,13 +17652,13 @@ dependencies = [
|
||||
"hmac 0.12.1",
|
||||
"itertools 0.11.0",
|
||||
"libsecp256k1",
|
||||
"merlin 3.0.0",
|
||||
"merlin",
|
||||
"no-std-net",
|
||||
"nom",
|
||||
"num-bigint",
|
||||
"num-rational",
|
||||
"num-traits",
|
||||
"pbkdf2 0.12.2",
|
||||
"pbkdf2",
|
||||
"pin-project",
|
||||
"poly1305 0.8.0",
|
||||
"rand",
|
||||
@@ -18673,7 +18569,7 @@ dependencies = [
|
||||
"lazy_static",
|
||||
"libsecp256k1",
|
||||
"log",
|
||||
"merlin 3.0.0",
|
||||
"merlin",
|
||||
"parity-scale-codec",
|
||||
"parking_lot 0.12.1",
|
||||
"paste",
|
||||
@@ -19829,14 +19725,14 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "substrate-bip39"
|
||||
version = "0.4.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e620c7098893ba667438b47169c00aacdd9e7c10e042250ce2b60b087ec97328"
|
||||
version = "0.4.7"
|
||||
dependencies = [
|
||||
"hmac 0.11.0",
|
||||
"pbkdf2 0.8.0",
|
||||
"schnorrkel 0.9.1",
|
||||
"sha2 0.9.9",
|
||||
"bip39",
|
||||
"hmac 0.12.1",
|
||||
"pbkdf2",
|
||||
"rustc-hex",
|
||||
"schnorrkel 0.11.4",
|
||||
"sha2 0.10.7",
|
||||
"zeroize",
|
||||
]
|
||||
|
||||
|
||||
@@ -496,6 +496,7 @@ members = [
|
||||
"substrate/utils/frame/rpc/system",
|
||||
"substrate/utils/frame/try-runtime/cli",
|
||||
"substrate/utils/prometheus",
|
||||
"substrate/utils/substrate-bip39",
|
||||
"substrate/utils/wasm-builder",
|
||||
|
||||
"templates/minimal/node",
|
||||
|
||||
@@ -35,7 +35,7 @@ sp-consensus = { path = "../../../../substrate/primitives/consensus/common", def
|
||||
sp-consensus-slots = { path = "../../../../substrate/primitives/consensus/slots", default-features = false }
|
||||
sp-application-crypto = { path = "../../../../substrate/primitives/application-crypto", default-features = false, features = ["full_crypto"] }
|
||||
sp-runtime = { path = "../../../../substrate/primitives/runtime", default-features = false }
|
||||
# should match schnorrkel
|
||||
# rand_core should match schnorrkel
|
||||
rand_core = "0.6.2"
|
||||
rand_chacha = { version = "0.3.1" }
|
||||
rand = "0.8.5"
|
||||
|
||||
@@ -78,8 +78,9 @@ sp-consensus-babe = { path = "../../../substrate/primitives/consensus/babe" }
|
||||
sp-runtime = { path = "../../../substrate/primitives/runtime", default-features = false }
|
||||
sp-timestamp = { path = "../../../substrate/primitives/timestamp" }
|
||||
|
||||
schnorrkel = { version = "0.9.1", default-features = false }
|
||||
rand_core = "0.6.2" # should match schnorrkel
|
||||
schnorrkel = { version = "0.11.4", default-features = false }
|
||||
# rand_core should match schnorrkel
|
||||
rand_core = "0.6.2"
|
||||
rand_chacha = { version = "0.3.1" }
|
||||
paste = "1.0.14"
|
||||
orchestra = { version = "0.3.5", default-features = false, features = ["futures_channel"] }
|
||||
|
||||
@@ -27,7 +27,7 @@ hash-db = { version = "0.16.0", default-features = false }
|
||||
hash256-std-hasher = { version = "0.15.2", default-features = false }
|
||||
bs58 = { version = "0.5.0", default-features = false, optional = true }
|
||||
rand = { version = "0.8.5", features = ["small_rng"], optional = true }
|
||||
substrate-bip39 = { version = "0.4.5", optional = true }
|
||||
substrate-bip39 = { path = "../../utils/substrate-bip39", optional = true }
|
||||
bip39 = { version = "2.0.0", default-features = false }
|
||||
zeroize = { version = "1.4.3", default-features = false }
|
||||
secrecy = { version = "0.8.0", default-features = false }
|
||||
@@ -116,7 +116,7 @@ std = [
|
||||
"sp-std/std",
|
||||
"sp-storage/std",
|
||||
"ss58-registry/std",
|
||||
"substrate-bip39",
|
||||
"substrate-bip39/std",
|
||||
"thiserror",
|
||||
"tracing",
|
||||
"w3f-bls?/std",
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
[package]
|
||||
name = "substrate-bip39"
|
||||
version = "0.4.7"
|
||||
license = "Apache-2.0"
|
||||
description = "Converting BIP39 entropy to valid Substrate (sr25519) SecretKeys"
|
||||
documentation = "https://docs.rs/substrate-bip39"
|
||||
authors.workspace = true
|
||||
edition.workspace = true
|
||||
repository.workspace = true
|
||||
|
||||
[dependencies]
|
||||
hmac = "0.12.1"
|
||||
pbkdf2 = { version = "0.12.2", default-features = false }
|
||||
schnorrkel = { version = "0.11.4", default-features = false }
|
||||
sha2 = { version = "0.10.7", default-features = false }
|
||||
zeroize = { version = "1.4.3", default-features = false }
|
||||
|
||||
[dev-dependencies]
|
||||
bip39 = "2.0.0"
|
||||
rustc-hex = "2.1.0"
|
||||
|
||||
[features]
|
||||
default = ["std"]
|
||||
std = [
|
||||
"hmac/std",
|
||||
"pbkdf2/std",
|
||||
"schnorrkel/std",
|
||||
"sha2/std",
|
||||
"zeroize/alloc",
|
||||
"zeroize/std",
|
||||
]
|
||||
@@ -0,0 +1,55 @@
|
||||
# Substrate BIP39
|
||||
|
||||
This is a crate for deriving secret keys for Ristretto compressed Ed25519 (should be compatible with Ed25519 at this
|
||||
time) from BIP39 phrases.
|
||||
|
||||
## Why?
|
||||
|
||||
The natural approach here would be to use the 64-byte seed generated from the BIP39 phrase, and use that to construct
|
||||
the key. This approach, while reasonable and fairly straight forward to implement, also means we would have to inherit
|
||||
all the characteristics of seed generation. Since we are breaking compatibility with both BIP32 and BIP44 anyway (which
|
||||
we are free to do as we are no longer using the Secp256k1 curve), there is also no reason why we should adhere to BIP39
|
||||
seed generation from the mnemonic.
|
||||
|
||||
BIP39 seed generation was designed to be compatible with user supplied brain wallet phrases as well as being extensible
|
||||
to wallets providing their own dictionaries and checksum mechanism. Issues with those two points:
|
||||
|
||||
1. Brain wallets are a horrible idea, simply because humans are bad entropy generators. It's next to impossible to
|
||||
educate users on how to use that feature in a secure manner. The 2048 rounds of PBKDF2 is a mere inconvenience that
|
||||
offers no real protection against dictionary attacks for anyone equipped with modern consumer hardware. Brain wallets
|
||||
have given users false sense of security. _People have lost money_ this way and wallet providers today tend to stick
|
||||
to CSPRNG supplied dictionary phrases.
|
||||
|
||||
2. Providing own dictionaries felt into the _you ain't gonna need it_ anti-pattern category on day 1. Wallet providers
|
||||
(be it hardware or software) typically want their products to be compatibile with other wallets so that users can
|
||||
migrate to their product without having to migrate all their assets.
|
||||
|
||||
To achieve the above phrases have to be precisely encoded in _The One True Canonical Encoding_, for which UTF-8 NFKD was
|
||||
chosen. This is largely irrelevant (and even ignored) for English phrases, as they encode to basically just ASCII in
|
||||
virtualy every character encoding known to mankind, but immedietly becomes a problem for dictionaries that do use
|
||||
non-ASCII characters. Even if the right encoding is used and implemented correctly, there are still [other caveats
|
||||
present for some non-english dictionaries](https://github.com/bitcoin/bips/blob/master/bip-0039/bip-0039-wordlists.md),
|
||||
such as normalizing spaces to a canonical form, or making some latin based characters equivalent to their base in
|
||||
dictionary lookups (eg. Spanish `ñ` and `n` are meant to be interchangeable). Thinking about all of this gives me a
|
||||
headache, and opens doors for disagreements between buggy implementations, breaking compatibility.
|
||||
|
||||
BIP39 does already provide a form of the mnemonic that is free from all of these issues: the entropy byte array. Since
|
||||
veryfing the checksum requires that we recover the entropy from which the phrase was generated, no extra work is
|
||||
actually needed here. Wallet implementators can encode the dictionaries in whatever encoding they find convenient (as
|
||||
long as they are the standard BIP39 dictionaries), no harm in using UTF-16 string primitives that Java and JavaScript
|
||||
provide. Since the dictionary is fixed and known, and the checksum is done on the entropy itself, the exact character
|
||||
encoding used becomes irrelevant, as are the precise codepoints and amount of whitespace around the words. It is thus
|
||||
much harder to create a buggy implementation.
|
||||
|
||||
PBKDF2 was kept in place, along with the password. Using 24 words (with its 256 bits entropy) makes the extra hashing
|
||||
redundant (if you could brute force 256 bit entropy, you can also just brute force secret keys), however some users
|
||||
might be still using 12 word phrases from other applications. There is no good reason to prohibit users from recovering
|
||||
their old wallets using 12 words that I can see, in which case the extra hashing does provide _some_ protection.
|
||||
Passwords are also a feature that some power users find useful - particularly for creating a decoy address with a small
|
||||
balance with empty password, while the funds proper are stored on an address that requires a password to be entered.
|
||||
|
||||
## Why not ditch BIP39 altogether?
|
||||
|
||||
Because there are hardware wallets that use a single phrase for the entire device, and operate multiple accounts on
|
||||
multiple networks using that. A completely different wordlist would make their life much harder when it comes to
|
||||
providing future Substrate support.
|
||||
@@ -0,0 +1,232 @@
|
||||
// Copyright (C) Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
|
||||
#[cfg(not(feature = "std"))]
|
||||
extern crate alloc;
|
||||
#[cfg(not(feature = "std"))]
|
||||
use alloc::string::String;
|
||||
|
||||
use hmac::Hmac;
|
||||
use pbkdf2::pbkdf2;
|
||||
use schnorrkel::keys::MiniSecretKey;
|
||||
use sha2::Sha512;
|
||||
use zeroize::Zeroize;
|
||||
|
||||
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
|
||||
pub enum Error {
|
||||
InvalidEntropy,
|
||||
}
|
||||
|
||||
/// `entropy` should be a byte array from a correctly recovered and checksumed BIP39.
|
||||
///
|
||||
/// This function accepts slices of different length for different word lengths:
|
||||
///
|
||||
/// + 16 bytes for 12 words.
|
||||
/// + 20 bytes for 15 words.
|
||||
/// + 24 bytes for 18 words.
|
||||
/// + 28 bytes for 21 words.
|
||||
/// + 32 bytes for 24 words.
|
||||
///
|
||||
/// Any other length will return an error.
|
||||
///
|
||||
/// `password` is analog to BIP39 seed generation itself, with an empty string being defalt.
|
||||
pub fn mini_secret_from_entropy(entropy: &[u8], password: &str) -> Result<MiniSecretKey, Error> {
|
||||
let seed = seed_from_entropy(entropy, password)?;
|
||||
Ok(MiniSecretKey::from_bytes(&seed[..32]).expect("Length is always correct; qed"))
|
||||
}
|
||||
|
||||
/// Similar to `mini_secret_from_entropy`, except that it provides the 64-byte seed directly.
|
||||
pub fn seed_from_entropy(entropy: &[u8], password: &str) -> Result<[u8; 64], Error> {
|
||||
if entropy.len() < 16 || entropy.len() > 32 || entropy.len() % 4 != 0 {
|
||||
return Err(Error::InvalidEntropy);
|
||||
}
|
||||
|
||||
let mut salt = String::with_capacity(8 + password.len());
|
||||
salt.push_str("mnemonic");
|
||||
salt.push_str(password);
|
||||
|
||||
let mut seed = [0u8; 64];
|
||||
|
||||
pbkdf2::<Hmac<Sha512>>(entropy, salt.as_bytes(), 2048, &mut seed)
|
||||
.map_err(|_| Error::InvalidEntropy)?;
|
||||
|
||||
salt.zeroize();
|
||||
|
||||
Ok(seed)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod test {
|
||||
use super::*;
|
||||
|
||||
#[cfg(not(feature = "std"))]
|
||||
use alloc::vec::Vec;
|
||||
|
||||
use bip39::{Language, Mnemonic};
|
||||
use rustc_hex::FromHex;
|
||||
|
||||
// phrase, entropy, seed, expanded secret_key
|
||||
//
|
||||
// ALL SEEDS GENERATED USING "Substrate" PASSWORD!
|
||||
static VECTORS: &[[&str; 3]] = &[
|
||||
[
|
||||
"abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about",
|
||||
"00000000000000000000000000000000",
|
||||
"44e9d125f037ac1d51f0a7d3649689d422c2af8b1ec8e00d71db4d7bf6d127e33f50c3d5c84fa3e5399c72d6cbbbbc4a49bf76f76d952f479d74655a2ef2d453",
|
||||
],
|
||||
[
|
||||
"legal winner thank year wave sausage worth useful legal winner thank yellow",
|
||||
"7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f",
|
||||
"4313249608fe8ac10fd5886c92c4579007272cb77c21551ee5b8d60b780416850f1e26c1f4b8d88ece681cb058ab66d6182bc2ce5a03181f7b74c27576b5c8bf",
|
||||
],
|
||||
[
|
||||
"letter advice cage absurd amount doctor acoustic avoid letter advice cage above",
|
||||
"80808080808080808080808080808080",
|
||||
"27f3eb595928c60d5bc91a4d747da40ed236328183046892ed6cd5aa9ae38122acd1183adf09a89839acb1e6eaa7fb563cc958a3f9161248d5a036e0d0af533d",
|
||||
],
|
||||
[
|
||||
"zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong",
|
||||
"ffffffffffffffffffffffffffffffff",
|
||||
"227d6256fd4f9ccaf06c45eaa4b2345969640462bbb00c5f51f43cb43418c7a753265f9b1e0c0822c155a9cabc769413ecc14553e135fe140fc50b6722c6b9df",
|
||||
],
|
||||
[
|
||||
"abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon agent",
|
||||
"000000000000000000000000000000000000000000000000",
|
||||
"44e9d125f037ac1d51f0a7d3649689d422c2af8b1ec8e00d71db4d7bf6d127e33f50c3d5c84fa3e5399c72d6cbbbbc4a49bf76f76d952f479d74655a2ef2d453",
|
||||
],
|
||||
[
|
||||
"legal winner thank year wave sausage worth useful legal winner thank year wave sausage worth useful legal will",
|
||||
"7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f",
|
||||
"cb1d50e14101024a88905a098feb1553d4306d072d7460e167a60ccb3439a6817a0afc59060f45d999ddebc05308714733c9e1e84f30feccddd4ad6f95c8a445",
|
||||
],
|
||||
[
|
||||
"letter advice cage absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic avoid letter always",
|
||||
"808080808080808080808080808080808080808080808080",
|
||||
"9ddecf32ce6bee77f867f3c4bb842d1f0151826a145cb4489598fe71ac29e3551b724f01052d1bc3f6d9514d6df6aa6d0291cfdf997a5afdb7b6a614c88ab36a",
|
||||
],
|
||||
[
|
||||
"zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo when",
|
||||
"ffffffffffffffffffffffffffffffffffffffffffffffff",
|
||||
"8971cb290e7117c64b63379c97ed3b5c6da488841bd9f95cdc2a5651ac89571e2c64d391d46e2475e8b043911885457cd23e99a28b5a18535fe53294dc8e1693",
|
||||
],
|
||||
[
|
||||
"abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon art",
|
||||
"0000000000000000000000000000000000000000000000000000000000000000",
|
||||
"44e9d125f037ac1d51f0a7d3649689d422c2af8b1ec8e00d71db4d7bf6d127e33f50c3d5c84fa3e5399c72d6cbbbbc4a49bf76f76d952f479d74655a2ef2d453",
|
||||
],
|
||||
[
|
||||
"legal winner thank year wave sausage worth useful legal winner thank year wave sausage worth useful legal winner thank year wave sausage worth title",
|
||||
"7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f",
|
||||
"3037276a5d05fcd7edf51869eb841bdde27c574dae01ac8cfb1ea476f6bea6ef57ab9afe14aea1df8a48f97ae25b37d7c8326e49289efb25af92ba5a25d09ed3",
|
||||
],
|
||||
[
|
||||
"letter advice cage absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic bless",
|
||||
"8080808080808080808080808080808080808080808080808080808080808080",
|
||||
"2c9c6144a06ae5a855453d98c3dea470e2a8ffb78179c2e9eb15208ccca7d831c97ddafe844ab933131e6eb895f675ede2f4e39837bb5769d4e2bc11df58ac42",
|
||||
],
|
||||
[
|
||||
"zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo vote",
|
||||
"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
|
||||
"047e89ef7739cbfe30da0ad32eb1720d8f62441dd4f139b981b8e2d0bd412ed4eb14b89b5098c49db2301d4e7df4e89c21e53f345138e56a5e7d63fae21c5939",
|
||||
],
|
||||
[
|
||||
"ozone drill grab fiber curtain grace pudding thank cruise elder eight picnic",
|
||||
"9e885d952ad362caeb4efe34a8e91bd2",
|
||||
"f4956be6960bc145cdab782e649a5056598fd07cd3f32ceb73421c3da27833241324dc2c8b0a4d847eee457e6d4c5429f5e625ece22abaa6a976e82f1ec5531d",
|
||||
],
|
||||
[
|
||||
"gravity machine north sort system female filter attitude volume fold club stay feature office ecology stable narrow fog",
|
||||
"6610b25967cdcca9d59875f5cb50b0ea75433311869e930b",
|
||||
"fbcc5229ade0c0ff018cb7a329c5459f91876e4dde2a97ddf03c832eab7f26124366a543f1485479c31a9db0d421bda82d7e1fe562e57f3533cb1733b001d84d",
|
||||
],
|
||||
[
|
||||
"hamster diagram private dutch cause delay private meat slide toddler razor book happy fancy gospel tennis maple dilemma loan word shrug inflict delay length",
|
||||
"68a79eaca2324873eacc50cb9c6eca8cc68ea5d936f98787c60c7ebc74e6ce7c",
|
||||
"7c60c555126c297deddddd59f8cdcdc9e3608944455824dd604897984b5cc369cad749803bb36eb8b786b570c9cdc8db275dbe841486676a6adf389f3be3f076",
|
||||
],
|
||||
[
|
||||
"scheme spot photo card baby mountain device kick cradle pact join borrow",
|
||||
"c0ba5a8e914111210f2bd131f3d5e08d",
|
||||
"c12157bf2506526c4bd1b79a056453b071361538e9e2c19c28ba2cfa39b5f23034b974e0164a1e8acd30f5b4c4de7d424fdb52c0116bfc6a965ba8205e6cc121",
|
||||
],
|
||||
[
|
||||
"horn tenant knee talent sponsor spell gate clip pulse soap slush warm silver nephew swap uncle crack brave",
|
||||
"6d9be1ee6ebd27a258115aad99b7317b9c8d28b6d76431c3",
|
||||
"23766723e970e6b79dec4d5e4fdd627fd27d1ee026eb898feb9f653af01ad22080c6f306d1061656d01c4fe9a14c05f991d2c7d8af8730780de4f94cd99bd819",
|
||||
],
|
||||
[
|
||||
"panda eyebrow bullet gorilla call smoke muffin taste mesh discover soft ostrich alcohol speed nation flash devote level hobby quick inner drive ghost inside",
|
||||
"9f6a2878b2520799a44ef18bc7df394e7061a224d2c33cd015b157d746869863",
|
||||
"f4c83c86617cb014d35cd87d38b5ef1c5d5c3d58a73ab779114438a7b358f457e0462c92bddab5a406fe0e6b97c71905cf19f925f356bc673ceb0e49792f4340",
|
||||
],
|
||||
[
|
||||
"cat swing flag economy stadium alone churn speed unique patch report train",
|
||||
"23db8160a31d3e0dca3688ed941adbf3",
|
||||
"719d4d4de0638a1705bf5237262458983da76933e718b2d64eb592c470f3c5d222e345cc795337bb3da393b94375ff4a56cfcd68d5ea25b577ee9384d35f4246",
|
||||
],
|
||||
[
|
||||
"light rule cinnamon wrap drastic word pride squirrel upgrade then income fatal apart sustain crack supply proud access",
|
||||
"8197a4a47f0425faeaa69deebc05ca29c0a5b5cc76ceacc0",
|
||||
"7ae1291db32d16457c248567f2b101e62c5549d2a64cd2b7605d503ec876d58707a8d663641e99663bc4f6cc9746f4852e75e7e54de5bc1bd3c299c9a113409e",
|
||||
],
|
||||
[
|
||||
"all hour make first leader extend hole alien behind guard gospel lava path output census museum junior mass reopen famous sing advance salt reform",
|
||||
"066dca1a2bb7e8a1db2832148ce9933eea0f3ac9548d793112d9a95c9407efad",
|
||||
"a911a5f4db0940b17ecb79c4dcf9392bf47dd18acaebdd4ef48799909ebb49672947cc15f4ef7e8ef47103a1a91a6732b821bda2c667e5b1d491c54788c69391",
|
||||
],
|
||||
[
|
||||
"vessel ladder alter error federal sibling chat ability sun glass valve picture",
|
||||
"f30f8c1da665478f49b001d94c5fc452",
|
||||
"4e2314ca7d9eebac6fe5a05a5a8d3546bc891785414d82207ac987926380411e559c885190d641ff7e686ace8c57db6f6e4333c1081e3d88d7141a74cf339c8f",
|
||||
],
|
||||
[
|
||||
"scissors invite lock maple supreme raw rapid void congress muscle digital elegant little brisk hair mango congress clump",
|
||||
"c10ec20dc3cd9f652c7fac2f1230f7a3c828389a14392f05",
|
||||
"7a83851102849edc5d2a3ca9d8044d0d4f00e5c4a292753ed3952e40808593251b0af1dd3c9ed9932d46e8608eb0b928216a6160bd4fc775a6e6fbd493d7c6b2",
|
||||
],
|
||||
[
|
||||
"void come effort suffer camp survey warrior heavy shoot primary clutch crush open amazing screen patrol group space point ten exist slush involve unfold",
|
||||
"f585c11aec520db57dd353c69554b21a89b20fb0650966fa0a9d6f74fd989d8f",
|
||||
"938ba18c3f521f19bd4a399c8425b02c716844325b1a65106b9d1593fbafe5e0b85448f523f91c48e331995ff24ae406757cff47d11f240847352b348ff436ed",
|
||||
]
|
||||
];
|
||||
|
||||
#[test]
|
||||
fn vectors_are_correct() {
|
||||
for vector in VECTORS {
|
||||
let phrase = vector[0];
|
||||
|
||||
let expected_entropy: Vec<u8> = vector[1].from_hex().unwrap();
|
||||
let expected_seed: Vec<u8> = vector[2].from_hex().unwrap();
|
||||
|
||||
let mnemonic = Mnemonic::parse_in(Language::English, phrase).unwrap();
|
||||
let seed = seed_from_entropy(&mnemonic.to_entropy(), "Substrate").unwrap();
|
||||
let secret = mini_secret_from_entropy(&mnemonic.to_entropy(), "Substrate")
|
||||
.unwrap()
|
||||
.to_bytes();
|
||||
|
||||
assert_eq!(
|
||||
mnemonic.to_entropy(),
|
||||
&expected_entropy[..],
|
||||
"Entropy is incorrect for {}",
|
||||
phrase
|
||||
);
|
||||
assert_eq!(&seed[..], &expected_seed[..], "Seed is incorrect for {}", phrase);
|
||||
assert_eq!(&secret[..], &expected_seed[..32], "Secret is incorrect for {}", phrase);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user