diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..b18b76b --- /dev/null +++ b/.editorconfig @@ -0,0 +1,4 @@ +# see https://editorconfig.org for more options, and setup instructions for yours editor + +[*.rs] +indent_style = tabs diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..07c574b --- /dev/null +++ b/.travis.yml @@ -0,0 +1,30 @@ +language: rust +cache: cargo + +matrix: + include: + - rust: stable + - rust: beta + - rust: nightly + env: BENCHES=true + - rust: 1.24.0 + - rust: 1.22.0 + env: ONLY_LOW_MEMORY=true + +before_install: + - sudo apt-get -qq update + - sudo apt-get install -y binutils-dev libunwind8-dev + +script: + - if not ${ONLY_LOW_MEMORY}; then cargo build --verbose; fi + - if not ${ONLY_LOW_MEMORY}; then cargo test --verbose; fi + - if not ${ONLY_LOW_MEMORY}; then cargo build --verbose --features rand,all-languages; fi + - if not ${ONLY_LOW_MEMORY}; then cargo test --verbose --features rand,all-languages; fi + # low-memory + - cargo build --verbose --features low-memory + - cargo test --verbose --features low-memory + - cargo build --verbose --features low-memory,rand,all-languages + - cargo test --verbose --features low-memory,rand,all-languages + # benchmarks + - if ${BENCHES}; then cargo bench --verbose --features rand; fi + - if ${BENCHES}; then cargo bench --verbose --features rand,japanese; fi diff --git a/Cargo.toml b/Cargo.toml index b813eeb..9b47b45 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -25,6 +25,24 @@ japanese = [] korean = [] spanish = [] +all-languages = [ + "chinese-simplified", + "chinese-traditional", + "czech", + "french", + "italian", + "japanese", + "korean", + "spanish" +] + +# Don't use a map to find words, but iterate through the list. +low-memory = [] + [dependencies] bitcoin_hashes = "0.7.6" unicode-normalization = "=0.1.9" +rand = { version = "0.6.0", optional = true } + +[dev-dependencies] +rand = { version = "0.6.0", optional = false } diff --git a/README.md b/README.md new file mode 100644 index 0000000..0a92f36 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +bip39 +===== + +A Rust implementation of BIP-39 mnemonic codes. + +## MSRV + +This crate supports Rust v1.24 and up. +With the `low-memory` feature, v1.22 and up are supported. + diff --git a/benches/bench.rs b/benches/bench.rs new file mode 100644 index 0000000..e7e1157 --- /dev/null +++ b/benches/bench.rs @@ -0,0 +1,69 @@ +#![feature(test)] + +extern crate bip39; +extern crate test; + +use test::Bencher; + +use bip39::*; + +#[cfg(not(any( + feature = "chinese-simplified", feature = "chinese-traditional", feature = "czech", + feature = "french", feature = "italian", feature = "japanese", feature = "korean", + feature = "spanish" +)))] +const LANG: Language = Language::English; +#[cfg(feature = "chinese-simplified")] +const LANG: Language = Language::SimplifiedChinese; +#[cfg(feature = "chinese-traditional")] +const LANG: Language = Language::TraditionalChinese; +#[cfg(feature = "czech")] +const LANG: Language = Language::Czech; +#[cfg(feature = "french")] +const LANG: Language = Language::French; +#[cfg(feature = "italian")] +const LANG: Language = Language::Italian; +#[cfg(feature = "japanese")] +const LANG: Language = Language::Japanese; +#[cfg(feature = "korean")] +const LANG: Language = Language::Korean; +#[cfg(feature = "spanish")] +const LANG: Language = Language::Spanish; + +#[bench] +fn validate(b: &mut Bencher) { + let entropy = "7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f".as_bytes(); + let mnemonic = Mnemonic::from_entropy_in(LANG, &entropy).unwrap(); + assert_eq!(mnemonic.word_count(), 24); + let phrase = mnemonic.as_str(); + + b.iter(|| { + let _ = Mnemonic::validate_in(Language::English, &phrase); + }); +} + +#[bench] +fn from_entropy(b: &mut Bencher) { + let entropy = "7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f".as_bytes(); + + b.iter(|| { + let _ = Mnemonic::from_entropy_in(LANG, &entropy).unwrap(); + }); +} + +#[bench] +fn new_mnemonic(b: &mut Bencher) { + b.iter(|| { + let _ = Mnemonic::generate_in(LANG, 24); + }); +} + +#[bench] +fn to_seed(b: &mut Bencher) { + let entropy = "7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f".as_bytes(); + let m = Mnemonic::from_entropy_in(LANG, &entropy).unwrap(); + + b.iter(|| { + let _ = m.to_seed(""); + }); +} diff --git a/src/english.rs b/src/english.rs deleted file mode 100644 index e558775..0000000 --- a/src/english.rs +++ /dev/null @@ -1,2050 +0,0 @@ -pub const WORDS: [&str; 2048] = [ - "abandon", - "ability", - "able", - "about", - "above", - "absent", - "absorb", - "abstract", - "absurd", - "abuse", - "access", - "accident", - "account", - "accuse", - "achieve", - "acid", - "acoustic", - "acquire", - "across", - "act", - "action", - "actor", - "actress", - "actual", - "adapt", - "add", - "addict", - "address", - "adjust", - "admit", - "adult", - "advance", - "advice", - "aerobic", - "affair", - "afford", - "afraid", - "again", - "age", - "agent", - "agree", - "ahead", - "aim", - "air", - "airport", - "aisle", - "alarm", - "album", - "alcohol", - "alert", - "alien", - "all", - "alley", - "allow", - "almost", - "alone", - "alpha", - "already", - "also", - "alter", - "always", - "amateur", - "amazing", - "among", - "amount", - "amused", - "analyst", - "anchor", - "ancient", - "anger", - "angle", - "angry", - "animal", - "ankle", - "announce", - "annual", - "another", - "answer", - "antenna", - "antique", - "anxiety", - "any", - "apart", - "apology", - "appear", - "apple", - "approve", - "april", - "arch", - "arctic", - "area", - "arena", - "argue", - "arm", - "armed", - "armor", - "army", - "around", - "arrange", - "arrest", - "arrive", - "arrow", - "art", - "artefact", - "artist", - "artwork", - "ask", - "aspect", - "assault", - "asset", - "assist", - "assume", - "asthma", - "athlete", - "atom", - "attack", - "attend", - "attitude", - "attract", - "auction", - "audit", - "august", - "aunt", - "author", - "auto", - "autumn", - "average", - "avocado", - "avoid", - "awake", - "aware", - "away", - "awesome", - "awful", - "awkward", - "axis", - "baby", - "bachelor", - "bacon", - "badge", - "bag", - "balance", - "balcony", - "ball", - "bamboo", - "banana", - "banner", - "bar", - "barely", - "bargain", - "barrel", - "base", - "basic", - "basket", - "battle", - "beach", - "bean", - "beauty", - "because", - "become", - "beef", - "before", - "begin", - "behave", - "behind", - "believe", - "below", - "belt", - "bench", - "benefit", - "best", - "betray", - "better", - "between", - "beyond", - "bicycle", - "bid", - "bike", - "bind", - "biology", - "bird", - "birth", - "bitter", - "black", - "blade", - "blame", - "blanket", - "blast", - "bleak", - "bless", - "blind", - "blood", - "blossom", - "blouse", - "blue", - "blur", - "blush", - "board", - "boat", - "body", - "boil", - "bomb", - "bone", - "bonus", - "book", - "boost", - "border", - "boring", - "borrow", - "boss", - "bottom", - "bounce", - "box", - "boy", - "bracket", - "brain", - "brand", - "brass", - "brave", - "bread", - "breeze", - "brick", - "bridge", - "brief", - "bright", - "bring", - "brisk", - "broccoli", - "broken", - "bronze", - "broom", - "brother", - "brown", - "brush", - "bubble", - "buddy", - "budget", - "buffalo", - "build", - "bulb", - "bulk", - "bullet", - "bundle", - "bunker", - "burden", - "burger", - "burst", - "bus", - "business", - "busy", - "butter", - "buyer", - "buzz", - "cabbage", - "cabin", - "cable", - "cactus", - "cage", - "cake", - "call", - "calm", - "camera", - "camp", - "can", - "canal", - "cancel", - "candy", - "cannon", - "canoe", - "canvas", - "canyon", - "capable", - "capital", - "captain", - "car", - "carbon", - "card", - "cargo", - "carpet", - "carry", - "cart", - "case", - "cash", - "casino", - "castle", - "casual", - "cat", - "catalog", - "catch", - "category", - "cattle", - "caught", - "cause", - "caution", - "cave", - "ceiling", - "celery", - "cement", - "census", - "century", - "cereal", - "certain", - "chair", - "chalk", - "champion", - "change", - "chaos", - "chapter", - "charge", - "chase", - "chat", - "cheap", - "check", - "cheese", - "chef", - "cherry", - "chest", - "chicken", - "chief", - "child", - "chimney", - "choice", - "choose", - "chronic", - "chuckle", - "chunk", - "churn", - "cigar", - "cinnamon", - "circle", - "citizen", - "city", - "civil", - "claim", - "clap", - "clarify", - "claw", - "clay", - "clean", - "clerk", - "clever", - "click", - "client", - "cliff", - "climb", - "clinic", - "clip", - "clock", - "clog", - "close", - "cloth", - "cloud", - "clown", - "club", - "clump", - "cluster", - "clutch", - "coach", - "coast", - "coconut", - "code", - "coffee", - "coil", - "coin", - "collect", - "color", - "column", - "combine", - "come", - "comfort", - "comic", - "common", - "company", - "concert", - "conduct", - "confirm", - "congress", - "connect", - "consider", - "control", - "convince", - "cook", - "cool", - "copper", - "copy", - "coral", - "core", - "corn", - "correct", - "cost", - "cotton", - "couch", - "country", - "couple", - "course", - "cousin", - "cover", - "coyote", - "crack", - "cradle", - "craft", - "cram", - "crane", - "crash", - "crater", - "crawl", - "crazy", - "cream", - "credit", - "creek", - "crew", - "cricket", - "crime", - "crisp", - "critic", - "crop", - "cross", - "crouch", - "crowd", - "crucial", - "cruel", - "cruise", - "crumble", - "crunch", - "crush", - "cry", - "crystal", - "cube", - "culture", - "cup", - "cupboard", - "curious", - "current", - "curtain", - "curve", - "cushion", - "custom", - "cute", - "cycle", - "dad", - "damage", - "damp", - "dance", - "danger", - "daring", - "dash", - "daughter", - "dawn", - "day", - "deal", - "debate", - "debris", - "decade", - "december", - "decide", - "decline", - "decorate", - "decrease", - "deer", - "defense", - "define", - "defy", - "degree", - "delay", - "deliver", - "demand", - "demise", - "denial", - "dentist", - "deny", - "depart", - "depend", - "deposit", - "depth", - "deputy", - "derive", - "describe", - "desert", - "design", - "desk", - "despair", - "destroy", - "detail", - "detect", - "develop", - "device", - "devote", - "diagram", - "dial", - "diamond", - "diary", - "dice", - "diesel", - "diet", - "differ", - "digital", - "dignity", - "dilemma", - "dinner", - "dinosaur", - "direct", - "dirt", - "disagree", - "discover", - "disease", - "dish", - "dismiss", - "disorder", - "display", - "distance", - "divert", - "divide", - "divorce", - "dizzy", - "doctor", - "document", - "dog", - "doll", - "dolphin", - "domain", - "donate", - "donkey", - "donor", - "door", - "dose", - "double", - "dove", - "draft", - "dragon", - "drama", - "drastic", - "draw", - "dream", - "dress", - "drift", - "drill", - "drink", - "drip", - "drive", - "drop", - "drum", - "dry", - "duck", - "dumb", - "dune", - "during", - "dust", - "dutch", - "duty", - "dwarf", - "dynamic", - "eager", - "eagle", - "early", - "earn", - "earth", - "easily", - "east", - "easy", - "echo", - "ecology", - "economy", - "edge", - "edit", - "educate", - "effort", - "egg", - "eight", - "either", - "elbow", - "elder", - "electric", - "elegant", - "element", - "elephant", - "elevator", - "elite", - "else", - "embark", - "embody", - "embrace", - "emerge", - "emotion", - "employ", - "empower", - "empty", - "enable", - "enact", - "end", - "endless", - "endorse", - "enemy", - "energy", - "enforce", - "engage", - "engine", - "enhance", - "enjoy", - "enlist", - "enough", - "enrich", - "enroll", - "ensure", - "enter", - "entire", - "entry", - "envelope", - "episode", - "equal", - "equip", - "era", - "erase", - "erode", - "erosion", - "error", - "erupt", - "escape", - "essay", - "essence", - "estate", - "eternal", - "ethics", - "evidence", - "evil", - "evoke", - "evolve", - "exact", - "example", - "excess", - "exchange", - "excite", - "exclude", - "excuse", - "execute", - "exercise", - "exhaust", - "exhibit", - "exile", - "exist", - "exit", - "exotic", - "expand", - "expect", - "expire", - "explain", - "expose", - "express", - "extend", - "extra", - "eye", - "eyebrow", - "fabric", - "face", - "faculty", - "fade", - "faint", - "faith", - "fall", - "false", - "fame", - "family", - "famous", - "fan", - "fancy", - "fantasy", - "farm", - "fashion", - "fat", - "fatal", - "father", - "fatigue", - "fault", - "favorite", - "feature", - "february", - "federal", - "fee", - "feed", - "feel", - "female", - "fence", - "festival", - "fetch", - "fever", - "few", - "fiber", - "fiction", - "field", - "figure", - "file", - "film", - "filter", - "final", - "find", - "fine", - "finger", - "finish", - "fire", - "firm", - "first", - "fiscal", - "fish", - "fit", - "fitness", - "fix", - "flag", - "flame", - "flash", - "flat", - "flavor", - "flee", - "flight", - "flip", - "float", - "flock", - "floor", - "flower", - "fluid", - "flush", - "fly", - "foam", - "focus", - "fog", - "foil", - "fold", - "follow", - "food", - "foot", - "force", - "forest", - "forget", - "fork", - "fortune", - "forum", - "forward", - "fossil", - "foster", - "found", - "fox", - "fragile", - "frame", - "frequent", - "fresh", - "friend", - "fringe", - "frog", - "front", - "frost", - "frown", - "frozen", - "fruit", - "fuel", - "fun", - "funny", - "furnace", - "fury", - "future", - "gadget", - "gain", - "galaxy", - "gallery", - "game", - "gap", - "garage", - "garbage", - "garden", - "garlic", - "garment", - "gas", - "gasp", - "gate", - "gather", - "gauge", - "gaze", - "general", - "genius", - "genre", - "gentle", - "genuine", - "gesture", - "ghost", - "giant", - "gift", - "giggle", - "ginger", - "giraffe", - "girl", - "give", - "glad", - "glance", - "glare", - "glass", - "glide", - "glimpse", - "globe", - "gloom", - "glory", - "glove", - "glow", - "glue", - "goat", - "goddess", - "gold", - "good", - "goose", - "gorilla", - "gospel", - "gossip", - "govern", - "gown", - "grab", - "grace", - "grain", - "grant", - "grape", - "grass", - "gravity", - "great", - "green", - "grid", - "grief", - "grit", - "grocery", - "group", - "grow", - "grunt", - "guard", - "guess", - "guide", - "guilt", - "guitar", - "gun", - "gym", - "habit", - "hair", - "half", - "hammer", - "hamster", - "hand", - "happy", - "harbor", - "hard", - "harsh", - "harvest", - "hat", - "have", - "hawk", - "hazard", - "head", - "health", - "heart", - "heavy", - "hedgehog", - "height", - "hello", - "helmet", - "help", - "hen", - "hero", - "hidden", - "high", - "hill", - "hint", - "hip", - "hire", - "history", - "hobby", - "hockey", - "hold", - "hole", - "holiday", - "hollow", - "home", - "honey", - "hood", - "hope", - "horn", - "horror", - "horse", - "hospital", - "host", - "hotel", - "hour", - "hover", - "hub", - "huge", - "human", - "humble", - "humor", - "hundred", - "hungry", - "hunt", - "hurdle", - "hurry", - "hurt", - "husband", - "hybrid", - "ice", - "icon", - "idea", - "identify", - "idle", - "ignore", - "ill", - "illegal", - "illness", - "image", - "imitate", - "immense", - "immune", - "impact", - "impose", - "improve", - "impulse", - "inch", - "include", - "income", - "increase", - "index", - "indicate", - "indoor", - "industry", - "infant", - "inflict", - "inform", - "inhale", - "inherit", - "initial", - "inject", - "injury", - "inmate", - "inner", - "innocent", - "input", - "inquiry", - "insane", - "insect", - "inside", - "inspire", - "install", - "intact", - "interest", - "into", - "invest", - "invite", - "involve", - "iron", - "island", - "isolate", - "issue", - "item", - "ivory", - "jacket", - "jaguar", - "jar", - "jazz", - "jealous", - "jeans", - "jelly", - "jewel", - "job", - "join", - "joke", - "journey", - "joy", - "judge", - "juice", - "jump", - "jungle", - "junior", - "junk", - "just", - "kangaroo", - "keen", - "keep", - "ketchup", - "key", - "kick", - "kid", - "kidney", - "kind", - "kingdom", - "kiss", - "kit", - "kitchen", - "kite", - "kitten", - "kiwi", - "knee", - "knife", - "knock", - "know", - "lab", - "label", - "labor", - "ladder", - "lady", - "lake", - "lamp", - "language", - "laptop", - "large", - "later", - "latin", - "laugh", - "laundry", - "lava", - "law", - "lawn", - "lawsuit", - "layer", - "lazy", - "leader", - "leaf", - "learn", - "leave", - "lecture", - "left", - "leg", - "legal", - "legend", - "leisure", - "lemon", - "lend", - "length", - "lens", - "leopard", - "lesson", - "letter", - "level", - "liar", - "liberty", - "library", - "license", - "life", - "lift", - "light", - "like", - "limb", - "limit", - "link", - "lion", - "liquid", - "list", - "little", - "live", - "lizard", - "load", - "loan", - "lobster", - "local", - "lock", - "logic", - "lonely", - "long", - "loop", - "lottery", - "loud", - "lounge", - "love", - "loyal", - "lucky", - "luggage", - "lumber", - "lunar", - "lunch", - "luxury", - "lyrics", - "machine", - "mad", - "magic", - "magnet", - "maid", - "mail", - "main", - "major", - "make", - "mammal", - "man", - "manage", - "mandate", - "mango", - "mansion", - "manual", - "maple", - "marble", - "march", - "margin", - "marine", - "market", - "marriage", - "mask", - "mass", - "master", - "match", - "material", - "math", - "matrix", - "matter", - "maximum", - "maze", - "meadow", - "mean", - "measure", - "meat", - "mechanic", - "medal", - "media", - "melody", - "melt", - "member", - "memory", - "mention", - "menu", - "mercy", - "merge", - "merit", - "merry", - "mesh", - "message", - "metal", - "method", - "middle", - "midnight", - "milk", - "million", - "mimic", - "mind", - "minimum", - "minor", - "minute", - "miracle", - "mirror", - "misery", - "miss", - "mistake", - "mix", - "mixed", - "mixture", - "mobile", - "model", - "modify", - "mom", - "moment", - "monitor", - "monkey", - "monster", - "month", - "moon", - "moral", - "more", - "morning", - "mosquito", - "mother", - "motion", - "motor", - "mountain", - "mouse", - "move", - "movie", - "much", - "muffin", - "mule", - "multiply", - "muscle", - "museum", - "mushroom", - "music", - "must", - "mutual", - "myself", - "mystery", - "myth", - "naive", - "name", - "napkin", - "narrow", - "nasty", - "nation", - "nature", - "near", - "neck", - "need", - "negative", - "neglect", - "neither", - "nephew", - "nerve", - "nest", - "net", - "network", - "neutral", - "never", - "news", - "next", - "nice", - "night", - "noble", - "noise", - "nominee", - "noodle", - "normal", - "north", - "nose", - "notable", - "note", - "nothing", - "notice", - "novel", - "now", - "nuclear", - "number", - "nurse", - "nut", - "oak", - "obey", - "object", - "oblige", - "obscure", - "observe", - "obtain", - "obvious", - "occur", - "ocean", - "october", - "odor", - "off", - "offer", - "office", - "often", - "oil", - "okay", - "old", - "olive", - "olympic", - "omit", - "once", - "one", - "onion", - "online", - "only", - "open", - "opera", - "opinion", - "oppose", - "option", - "orange", - "orbit", - "orchard", - "order", - "ordinary", - "organ", - "orient", - "original", - "orphan", - "ostrich", - "other", - "outdoor", - "outer", - "output", - "outside", - "oval", - "oven", - "over", - "own", - "owner", - "oxygen", - "oyster", - "ozone", - "pact", - "paddle", - "page", - "pair", - "palace", - "palm", - "panda", - "panel", - "panic", - "panther", - "paper", - "parade", - "parent", - "park", - "parrot", - "party", - "pass", - "patch", - "path", - "patient", - "patrol", - "pattern", - "pause", - "pave", - "payment", - "peace", - "peanut", - "pear", - "peasant", - "pelican", - "pen", - "penalty", - "pencil", - "people", - "pepper", - "perfect", - "permit", - "person", - "pet", - "phone", - "photo", - "phrase", - "physical", - "piano", - "picnic", - "picture", - "piece", - "pig", - "pigeon", - "pill", - "pilot", - "pink", - "pioneer", - "pipe", - "pistol", - "pitch", - "pizza", - "place", - "planet", - "plastic", - "plate", - "play", - "please", - "pledge", - "pluck", - "plug", - "plunge", - "poem", - "poet", - "point", - "polar", - "pole", - "police", - "pond", - "pony", - "pool", - "popular", - "portion", - "position", - "possible", - "post", - "potato", - "pottery", - "poverty", - "powder", - "power", - "practice", - "praise", - "predict", - "prefer", - "prepare", - "present", - "pretty", - "prevent", - "price", - "pride", - "primary", - "print", - "priority", - "prison", - "private", - "prize", - "problem", - "process", - "produce", - "profit", - "program", - "project", - "promote", - "proof", - "property", - "prosper", - "protect", - "proud", - "provide", - "public", - "pudding", - "pull", - "pulp", - "pulse", - "pumpkin", - "punch", - "pupil", - "puppy", - "purchase", - "purity", - "purpose", - "purse", - "push", - "put", - "puzzle", - "pyramid", - "quality", - "quantum", - "quarter", - "question", - "quick", - "quit", - "quiz", - "quote", - "rabbit", - "raccoon", - "race", - "rack", - "radar", - "radio", - "rail", - "rain", - "raise", - "rally", - "ramp", - "ranch", - "random", - "range", - "rapid", - "rare", - "rate", - "rather", - "raven", - "raw", - "razor", - "ready", - "real", - "reason", - "rebel", - "rebuild", - "recall", - "receive", - "recipe", - "record", - "recycle", - "reduce", - "reflect", - "reform", - "refuse", - "region", - "regret", - "regular", - "reject", - "relax", - "release", - "relief", - "rely", - "remain", - "remember", - "remind", - "remove", - "render", - "renew", - "rent", - "reopen", - "repair", - "repeat", - "replace", - "report", - "require", - "rescue", - "resemble", - "resist", - "resource", - "response", - "result", - "retire", - "retreat", - "return", - "reunion", - "reveal", - "review", - "reward", - "rhythm", - "rib", - "ribbon", - "rice", - "rich", - "ride", - "ridge", - "rifle", - "right", - "rigid", - "ring", - "riot", - "ripple", - "risk", - "ritual", - "rival", - "river", - "road", - "roast", - "robot", - "robust", - "rocket", - "romance", - "roof", - "rookie", - "room", - "rose", - "rotate", - "rough", - "round", - "route", - "royal", - "rubber", - "rude", - "rug", - "rule", - "run", - "runway", - "rural", - "sad", - "saddle", - "sadness", - "safe", - "sail", - "salad", - "salmon", - "salon", - "salt", - "salute", - "same", - "sample", - "sand", - "satisfy", - "satoshi", - "sauce", - "sausage", - "save", - "say", - "scale", - "scan", - "scare", - "scatter", - "scene", - "scheme", - "school", - "science", - "scissors", - "scorpion", - "scout", - "scrap", - "screen", - "script", - "scrub", - "sea", - "search", - "season", - "seat", - "second", - "secret", - "section", - "security", - "seed", - "seek", - "segment", - "select", - "sell", - "seminar", - "senior", - "sense", - "sentence", - "series", - "service", - "session", - "settle", - "setup", - "seven", - "shadow", - "shaft", - "shallow", - "share", - "shed", - "shell", - "sheriff", - "shield", - "shift", - "shine", - "ship", - "shiver", - "shock", - "shoe", - "shoot", - "shop", - "short", - "shoulder", - "shove", - "shrimp", - "shrug", - "shuffle", - "shy", - "sibling", - "sick", - "side", - "siege", - "sight", - "sign", - "silent", - "silk", - "silly", - "silver", - "similar", - "simple", - "since", - "sing", - "siren", - "sister", - "situate", - "six", - "size", - "skate", - "sketch", - "ski", - "skill", - "skin", - "skirt", - "skull", - "slab", - "slam", - "sleep", - "slender", - "slice", - "slide", - "slight", - "slim", - "slogan", - "slot", - "slow", - "slush", - "small", - "smart", - "smile", - "smoke", - "smooth", - "snack", - "snake", - "snap", - "sniff", - "snow", - "soap", - "soccer", - "social", - "sock", - "soda", - "soft", - "solar", - "soldier", - "solid", - "solution", - "solve", - "someone", - "song", - "soon", - "sorry", - "sort", - "soul", - "sound", - "soup", - "source", - "south", - "space", - "spare", - "spatial", - "spawn", - "speak", - "special", - "speed", - "spell", - "spend", - "sphere", - "spice", - "spider", - "spike", - "spin", - "spirit", - "split", - "spoil", - "sponsor", - "spoon", - "sport", - "spot", - "spray", - "spread", - "spring", - "spy", - "square", - "squeeze", - "squirrel", - "stable", - "stadium", - "staff", - "stage", - "stairs", - "stamp", - "stand", - "start", - "state", - "stay", - "steak", - "steel", - "stem", - "step", - "stereo", - "stick", - "still", - "sting", - "stock", - "stomach", - "stone", - "stool", - "story", - "stove", - "strategy", - "street", - "strike", - "strong", - "struggle", - "student", - "stuff", - "stumble", - "style", - "subject", - "submit", - "subway", - "success", - "such", - "sudden", - "suffer", - "sugar", - "suggest", - "suit", - "summer", - "sun", - "sunny", - "sunset", - "super", - "supply", - "supreme", - "sure", - "surface", - "surge", - "surprise", - "surround", - "survey", - "suspect", - "sustain", - "swallow", - "swamp", - "swap", - "swarm", - "swear", - "sweet", - "swift", - "swim", - "swing", - "switch", - "sword", - "symbol", - "symptom", - "syrup", - "system", - "table", - "tackle", - "tag", - "tail", - "talent", - "talk", - "tank", - "tape", - "target", - "task", - "taste", - "tattoo", - "taxi", - "teach", - "team", - "tell", - "ten", - "tenant", - "tennis", - "tent", - "term", - "test", - "text", - "thank", - "that", - "theme", - "then", - "theory", - "there", - "they", - "thing", - "this", - "thought", - "three", - "thrive", - "throw", - "thumb", - "thunder", - "ticket", - "tide", - "tiger", - "tilt", - "timber", - "time", - "tiny", - "tip", - "tired", - "tissue", - "title", - "toast", - "tobacco", - "today", - "toddler", - "toe", - "together", - "toilet", - "token", - "tomato", - "tomorrow", - "tone", - "tongue", - "tonight", - "tool", - "tooth", - "top", - "topic", - "topple", - "torch", - "tornado", - "tortoise", - "toss", - "total", - "tourist", - "toward", - "tower", - "town", - "toy", - "track", - "trade", - "traffic", - "tragic", - "train", - "transfer", - "trap", - "trash", - "travel", - "tray", - "treat", - "tree", - "trend", - "trial", - "tribe", - "trick", - "trigger", - "trim", - "trip", - "trophy", - "trouble", - "truck", - "true", - "truly", - "trumpet", - "trust", - "truth", - "try", - "tube", - "tuition", - "tumble", - "tuna", - "tunnel", - "turkey", - "turn", - "turtle", - "twelve", - "twenty", - "twice", - "twin", - "twist", - "two", - "type", - "typical", - "ugly", - "umbrella", - "unable", - "unaware", - "uncle", - "uncover", - "under", - "undo", - "unfair", - "unfold", - "unhappy", - "uniform", - "unique", - "unit", - "universe", - "unknown", - "unlock", - "until", - "unusual", - "unveil", - "update", - "upgrade", - "uphold", - "upon", - "upper", - "upset", - "urban", - "urge", - "usage", - "use", - "used", - "useful", - "useless", - "usual", - "utility", - "vacant", - "vacuum", - "vague", - "valid", - "valley", - "valve", - "van", - "vanish", - "vapor", - "various", - "vast", - "vault", - "vehicle", - "velvet", - "vendor", - "venture", - "venue", - "verb", - "verify", - "version", - "very", - "vessel", - "veteran", - "viable", - "vibrant", - "vicious", - "victory", - "video", - "view", - "village", - "vintage", - "violin", - "virtual", - "virus", - "visa", - "visit", - "visual", - "vital", - "vivid", - "vocal", - "voice", - "void", - "volcano", - "volume", - "vote", - "voyage", - "wage", - "wagon", - "wait", - "walk", - "wall", - "walnut", - "want", - "warfare", - "warm", - "warrior", - "wash", - "wasp", - "waste", - "water", - "wave", - "way", - "wealth", - "weapon", - "wear", - "weasel", - "weather", - "web", - "wedding", - "weekend", - "weird", - "welcome", - "west", - "wet", - "whale", - "what", - "wheat", - "wheel", - "when", - "where", - "whip", - "whisper", - "wide", - "width", - "wife", - "wild", - "will", - "win", - "window", - "wine", - "wing", - "wink", - "winner", - "winter", - "wire", - "wisdom", - "wise", - "wish", - "witness", - "wolf", - "woman", - "wonder", - "wood", - "wool", - "word", - "work", - "world", - "worry", - "worth", - "wrap", - "wreck", - "wrestle", - "wrist", - "write", - "wrong", - "yard", - "year", - "yellow", - "you", - "young", - "youth", - "zebra", - "zero", - "zone", - "zoo", -]; diff --git a/src/chinese_simplified.rs b/src/language/chinese_simplified.rs similarity index 100% rename from src/chinese_simplified.rs rename to src/language/chinese_simplified.rs diff --git a/src/chinese_traditional.rs b/src/language/chinese_traditional.rs similarity index 100% rename from src/chinese_traditional.rs rename to src/language/chinese_traditional.rs diff --git a/src/czech.rs b/src/language/czech.rs similarity index 100% rename from src/czech.rs rename to src/language/czech.rs diff --git a/src/language/english.rs b/src/language/english.rs new file mode 100644 index 0000000..0d244aa --- /dev/null +++ b/src/language/english.rs @@ -0,0 +1,2050 @@ +pub const WORDS: [&str; 2048] = [ + "abandon", + "ability", + "able", + "about", + "above", + "absent", + "absorb", + "abstract", + "absurd", + "abuse", + "access", + "accident", + "account", + "accuse", + "achieve", + "acid", + "acoustic", + "acquire", + "across", + "act", + "action", + "actor", + "actress", + "actual", + "adapt", + "add", + "addict", + "address", + "adjust", + "admit", + "adult", + "advance", + "advice", + "aerobic", + "affair", + "afford", + "afraid", + "again", + "age", + "agent", + "agree", + "ahead", + "aim", + "air", + "airport", + "aisle", + "alarm", + "album", + "alcohol", + "alert", + "alien", + "all", + "alley", + "allow", + "almost", + "alone", + "alpha", + "already", + "also", + "alter", + "always", + "amateur", + "amazing", + "among", + "amount", + "amused", + "analyst", + "anchor", + "ancient", + "anger", + "angle", + "angry", + "animal", + "ankle", + "announce", + "annual", + "another", + "answer", + "antenna", + "antique", + "anxiety", + "any", + "apart", + "apology", + "appear", + "apple", + "approve", + "april", + "arch", + "arctic", + "area", + "arena", + "argue", + "arm", + "armed", + "armor", + "army", + "around", + "arrange", + "arrest", + "arrive", + "arrow", + "art", + "artefact", + "artist", + "artwork", + "ask", + "aspect", + "assault", + "asset", + "assist", + "assume", + "asthma", + "athlete", + "atom", + "attack", + "attend", + "attitude", + "attract", + "auction", + "audit", + "august", + "aunt", + "author", + "auto", + "autumn", + "average", + "avocado", + "avoid", + "awake", + "aware", + "away", + "awesome", + "awful", + "awkward", + "axis", + "baby", + "bachelor", + "bacon", + "badge", + "bag", + "balance", + "balcony", + "ball", + "bamboo", + "banana", + "banner", + "bar", + "barely", + "bargain", + "barrel", + "base", + "basic", + "basket", + "battle", + "beach", + "bean", + "beauty", + "because", + "become", + "beef", + "before", + "begin", + "behave", + "behind", + "believe", + "below", + "belt", + "bench", + "benefit", + "best", + "betray", + "better", + "between", + "beyond", + "bicycle", + "bid", + "bike", + "bind", + "biology", + "bird", + "birth", + "bitter", + "black", + "blade", + "blame", + "blanket", + "blast", + "bleak", + "bless", + "blind", + "blood", + "blossom", + "blouse", + "blue", + "blur", + "blush", + "board", + "boat", + "body", + "boil", + "bomb", + "bone", + "bonus", + "book", + "boost", + "border", + "boring", + "borrow", + "boss", + "bottom", + "bounce", + "box", + "boy", + "bracket", + "brain", + "brand", + "brass", + "brave", + "bread", + "breeze", + "brick", + "bridge", + "brief", + "bright", + "bring", + "brisk", + "broccoli", + "broken", + "bronze", + "broom", + "brother", + "brown", + "brush", + "bubble", + "buddy", + "budget", + "buffalo", + "build", + "bulb", + "bulk", + "bullet", + "bundle", + "bunker", + "burden", + "burger", + "burst", + "bus", + "business", + "busy", + "butter", + "buyer", + "buzz", + "cabbage", + "cabin", + "cable", + "cactus", + "cage", + "cake", + "call", + "calm", + "camera", + "camp", + "can", + "canal", + "cancel", + "candy", + "cannon", + "canoe", + "canvas", + "canyon", + "capable", + "capital", + "captain", + "car", + "carbon", + "card", + "cargo", + "carpet", + "carry", + "cart", + "case", + "cash", + "casino", + "castle", + "casual", + "cat", + "catalog", + "catch", + "category", + "cattle", + "caught", + "cause", + "caution", + "cave", + "ceiling", + "celery", + "cement", + "census", + "century", + "cereal", + "certain", + "chair", + "chalk", + "champion", + "change", + "chaos", + "chapter", + "charge", + "chase", + "chat", + "cheap", + "check", + "cheese", + "chef", + "cherry", + "chest", + "chicken", + "chief", + "child", + "chimney", + "choice", + "choose", + "chronic", + "chuckle", + "chunk", + "churn", + "cigar", + "cinnamon", + "circle", + "citizen", + "city", + "civil", + "claim", + "clap", + "clarify", + "claw", + "clay", + "clean", + "clerk", + "clever", + "click", + "client", + "cliff", + "climb", + "clinic", + "clip", + "clock", + "clog", + "close", + "cloth", + "cloud", + "clown", + "club", + "clump", + "cluster", + "clutch", + "coach", + "coast", + "coconut", + "code", + "coffee", + "coil", + "coin", + "collect", + "color", + "column", + "combine", + "come", + "comfort", + "comic", + "common", + "company", + "concert", + "conduct", + "confirm", + "congress", + "connect", + "consider", + "control", + "convince", + "cook", + "cool", + "copper", + "copy", + "coral", + "core", + "corn", + "correct", + "cost", + "cotton", + "couch", + "country", + "couple", + "course", + "cousin", + "cover", + "coyote", + "crack", + "cradle", + "craft", + "cram", + "crane", + "crash", + "crater", + "crawl", + "crazy", + "cream", + "credit", + "creek", + "crew", + "cricket", + "crime", + "crisp", + "critic", + "crop", + "cross", + "crouch", + "crowd", + "crucial", + "cruel", + "cruise", + "crumble", + "crunch", + "crush", + "cry", + "crystal", + "cube", + "culture", + "cup", + "cupboard", + "curious", + "current", + "curtain", + "curve", + "cushion", + "custom", + "cute", + "cycle", + "dad", + "damage", + "damp", + "dance", + "danger", + "daring", + "dash", + "daughter", + "dawn", + "day", + "deal", + "debate", + "debris", + "decade", + "december", + "decide", + "decline", + "decorate", + "decrease", + "deer", + "defense", + "define", + "defy", + "degree", + "delay", + "deliver", + "demand", + "demise", + "denial", + "dentist", + "deny", + "depart", + "depend", + "deposit", + "depth", + "deputy", + "derive", + "describe", + "desert", + "design", + "desk", + "despair", + "destroy", + "detail", + "detect", + "develop", + "device", + "devote", + "diagram", + "dial", + "diamond", + "diary", + "dice", + "diesel", + "diet", + "differ", + "digital", + "dignity", + "dilemma", + "dinner", + "dinosaur", + "direct", + "dirt", + "disagree", + "discover", + "disease", + "dish", + "dismiss", + "disorder", + "display", + "distance", + "divert", + "divide", + "divorce", + "dizzy", + "doctor", + "document", + "dog", + "doll", + "dolphin", + "domain", + "donate", + "donkey", + "donor", + "door", + "dose", + "double", + "dove", + "draft", + "dragon", + "drama", + "drastic", + "draw", + "dream", + "dress", + "drift", + "drill", + "drink", + "drip", + "drive", + "drop", + "drum", + "dry", + "duck", + "dumb", + "dune", + "during", + "dust", + "dutch", + "duty", + "dwarf", + "dynamic", + "eager", + "eagle", + "early", + "earn", + "earth", + "easily", + "east", + "easy", + "echo", + "ecology", + "economy", + "edge", + "edit", + "educate", + "effort", + "egg", + "eight", + "either", + "elbow", + "elder", + "electric", + "elegant", + "element", + "elephant", + "elevator", + "elite", + "else", + "embark", + "embody", + "embrace", + "emerge", + "emotion", + "employ", + "empower", + "empty", + "enable", + "enact", + "end", + "endless", + "endorse", + "enemy", + "energy", + "enforce", + "engage", + "engine", + "enhance", + "enjoy", + "enlist", + "enough", + "enrich", + "enroll", + "ensure", + "enter", + "entire", + "entry", + "envelope", + "episode", + "equal", + "equip", + "era", + "erase", + "erode", + "erosion", + "error", + "erupt", + "escape", + "essay", + "essence", + "estate", + "eternal", + "ethics", + "evidence", + "evil", + "evoke", + "evolve", + "exact", + "example", + "excess", + "exchange", + "excite", + "exclude", + "excuse", + "execute", + "exercise", + "exhaust", + "exhibit", + "exile", + "exist", + "exit", + "exotic", + "expand", + "expect", + "expire", + "explain", + "expose", + "express", + "extend", + "extra", + "eye", + "eyebrow", + "fabric", + "face", + "faculty", + "fade", + "faint", + "faith", + "fall", + "false", + "fame", + "family", + "famous", + "fan", + "fancy", + "fantasy", + "farm", + "fashion", + "fat", + "fatal", + "father", + "fatigue", + "fault", + "favorite", + "feature", + "february", + "federal", + "fee", + "feed", + "feel", + "female", + "fence", + "festival", + "fetch", + "fever", + "few", + "fiber", + "fiction", + "field", + "figure", + "file", + "film", + "filter", + "final", + "find", + "fine", + "finger", + "finish", + "fire", + "firm", + "first", + "fiscal", + "fish", + "fit", + "fitness", + "fix", + "flag", + "flame", + "flash", + "flat", + "flavor", + "flee", + "flight", + "flip", + "float", + "flock", + "floor", + "flower", + "fluid", + "flush", + "fly", + "foam", + "focus", + "fog", + "foil", + "fold", + "follow", + "food", + "foot", + "force", + "forest", + "forget", + "fork", + "fortune", + "forum", + "forward", + "fossil", + "foster", + "found", + "fox", + "fragile", + "frame", + "frequent", + "fresh", + "friend", + "fringe", + "frog", + "front", + "frost", + "frown", + "frozen", + "fruit", + "fuel", + "fun", + "funny", + "furnace", + "fury", + "future", + "gadget", + "gain", + "galaxy", + "gallery", + "game", + "gap", + "garage", + "garbage", + "garden", + "garlic", + "garment", + "gas", + "gasp", + "gate", + "gather", + "gauge", + "gaze", + "general", + "genius", + "genre", + "gentle", + "genuine", + "gesture", + "ghost", + "giant", + "gift", + "giggle", + "ginger", + "giraffe", + "girl", + "give", + "glad", + "glance", + "glare", + "glass", + "glide", + "glimpse", + "globe", + "gloom", + "glory", + "glove", + "glow", + "glue", + "goat", + "goddess", + "gold", + "good", + "goose", + "gorilla", + "gospel", + "gossip", + "govern", + "gown", + "grab", + "grace", + "grain", + "grant", + "grape", + "grass", + "gravity", + "great", + "green", + "grid", + "grief", + "grit", + "grocery", + "group", + "grow", + "grunt", + "guard", + "guess", + "guide", + "guilt", + "guitar", + "gun", + "gym", + "habit", + "hair", + "half", + "hammer", + "hamster", + "hand", + "happy", + "harbor", + "hard", + "harsh", + "harvest", + "hat", + "have", + "hawk", + "hazard", + "head", + "health", + "heart", + "heavy", + "hedgehog", + "height", + "hello", + "helmet", + "help", + "hen", + "hero", + "hidden", + "high", + "hill", + "hint", + "hip", + "hire", + "history", + "hobby", + "hockey", + "hold", + "hole", + "holiday", + "hollow", + "home", + "honey", + "hood", + "hope", + "horn", + "horror", + "horse", + "hospital", + "host", + "hotel", + "hour", + "hover", + "hub", + "huge", + "human", + "humble", + "humor", + "hundred", + "hungry", + "hunt", + "hurdle", + "hurry", + "hurt", + "husband", + "hybrid", + "ice", + "icon", + "idea", + "identify", + "idle", + "ignore", + "ill", + "illegal", + "illness", + "image", + "imitate", + "immense", + "immune", + "impact", + "impose", + "improve", + "impulse", + "inch", + "include", + "income", + "increase", + "index", + "indicate", + "indoor", + "industry", + "infant", + "inflict", + "inform", + "inhale", + "inherit", + "initial", + "inject", + "injury", + "inmate", + "inner", + "innocent", + "input", + "inquiry", + "insane", + "insect", + "inside", + "inspire", + "install", + "intact", + "interest", + "into", + "invest", + "invite", + "involve", + "iron", + "island", + "isolate", + "issue", + "item", + "ivory", + "jacket", + "jaguar", + "jar", + "jazz", + "jealous", + "jeans", + "jelly", + "jewel", + "job", + "join", + "joke", + "journey", + "joy", + "judge", + "juice", + "jump", + "jungle", + "junior", + "junk", + "just", + "kangaroo", + "keen", + "keep", + "ketchup", + "key", + "kick", + "kid", + "kidney", + "kind", + "kingdom", + "kiss", + "kit", + "kitchen", + "kite", + "kitten", + "kiwi", + "knee", + "knife", + "knock", + "know", + "lab", + "label", + "labor", + "ladder", + "lady", + "lake", + "lamp", + "language", + "laptop", + "large", + "later", + "latin", + "laugh", + "laundry", + "lava", + "law", + "lawn", + "lawsuit", + "layer", + "lazy", + "leader", + "leaf", + "learn", + "leave", + "lecture", + "left", + "leg", + "legal", + "legend", + "leisure", + "lemon", + "lend", + "length", + "lens", + "leopard", + "lesson", + "letter", + "level", + "liar", + "liberty", + "library", + "license", + "life", + "lift", + "light", + "like", + "limb", + "limit", + "link", + "lion", + "liquid", + "list", + "little", + "live", + "lizard", + "load", + "loan", + "lobster", + "local", + "lock", + "logic", + "lonely", + "long", + "loop", + "lottery", + "loud", + "lounge", + "love", + "loyal", + "lucky", + "luggage", + "lumber", + "lunar", + "lunch", + "luxury", + "lyrics", + "machine", + "mad", + "magic", + "magnet", + "maid", + "mail", + "main", + "major", + "make", + "mammal", + "man", + "manage", + "mandate", + "mango", + "mansion", + "manual", + "maple", + "marble", + "march", + "margin", + "marine", + "market", + "marriage", + "mask", + "mass", + "master", + "match", + "material", + "math", + "matrix", + "matter", + "maximum", + "maze", + "meadow", + "mean", + "measure", + "meat", + "mechanic", + "medal", + "media", + "melody", + "melt", + "member", + "memory", + "mention", + "menu", + "mercy", + "merge", + "merit", + "merry", + "mesh", + "message", + "metal", + "method", + "middle", + "midnight", + "milk", + "million", + "mimic", + "mind", + "minimum", + "minor", + "minute", + "miracle", + "mirror", + "misery", + "miss", + "mistake", + "mix", + "mixed", + "mixture", + "mobile", + "model", + "modify", + "mom", + "moment", + "monitor", + "monkey", + "monster", + "month", + "moon", + "moral", + "more", + "morning", + "mosquito", + "mother", + "motion", + "motor", + "mountain", + "mouse", + "move", + "movie", + "much", + "muffin", + "mule", + "multiply", + "muscle", + "museum", + "mushroom", + "music", + "must", + "mutual", + "myself", + "mystery", + "myth", + "naive", + "name", + "napkin", + "narrow", + "nasty", + "nation", + "nature", + "near", + "neck", + "need", + "negative", + "neglect", + "neither", + "nephew", + "nerve", + "nest", + "net", + "network", + "neutral", + "never", + "news", + "next", + "nice", + "night", + "noble", + "noise", + "nominee", + "noodle", + "normal", + "north", + "nose", + "notable", + "note", + "nothing", + "notice", + "novel", + "now", + "nuclear", + "number", + "nurse", + "nut", + "oak", + "obey", + "object", + "oblige", + "obscure", + "observe", + "obtain", + "obvious", + "occur", + "ocean", + "october", + "odor", + "off", + "offer", + "office", + "often", + "oil", + "okay", + "old", + "olive", + "olympic", + "omit", + "once", + "one", + "onion", + "online", + "only", + "open", + "opera", + "opinion", + "oppose", + "option", + "orange", + "orbit", + "orchard", + "order", + "ordinary", + "organ", + "orient", + "original", + "orphan", + "ostrich", + "other", + "outdoor", + "outer", + "output", + "outside", + "oval", + "oven", + "over", + "own", + "owner", + "oxygen", + "oyster", + "ozone", + "pact", + "paddle", + "page", + "pair", + "palace", + "palm", + "panda", + "panel", + "panic", + "panther", + "paper", + "parade", + "parent", + "park", + "parrot", + "party", + "pass", + "patch", + "path", + "patient", + "patrol", + "pattern", + "pause", + "pave", + "payment", + "peace", + "peanut", + "pear", + "peasant", + "pelican", + "pen", + "penalty", + "pencil", + "people", + "pepper", + "perfect", + "permit", + "person", + "pet", + "phone", + "photo", + "phrase", + "physical", + "piano", + "picnic", + "picture", + "piece", + "pig", + "pigeon", + "pill", + "pilot", + "pink", + "pioneer", + "pipe", + "pistol", + "pitch", + "pizza", + "place", + "planet", + "plastic", + "plate", + "play", + "please", + "pledge", + "pluck", + "plug", + "plunge", + "poem", + "poet", + "point", + "polar", + "pole", + "police", + "pond", + "pony", + "pool", + "popular", + "portion", + "position", + "possible", + "post", + "potato", + "pottery", + "poverty", + "powder", + "power", + "practice", + "praise", + "predict", + "prefer", + "prepare", + "present", + "pretty", + "prevent", + "price", + "pride", + "primary", + "print", + "priority", + "prison", + "private", + "prize", + "problem", + "process", + "produce", + "profit", + "program", + "project", + "promote", + "proof", + "property", + "prosper", + "protect", + "proud", + "provide", + "public", + "pudding", + "pull", + "pulp", + "pulse", + "pumpkin", + "punch", + "pupil", + "puppy", + "purchase", + "purity", + "purpose", + "purse", + "push", + "put", + "puzzle", + "pyramid", + "quality", + "quantum", + "quarter", + "question", + "quick", + "quit", + "quiz", + "quote", + "rabbit", + "raccoon", + "race", + "rack", + "radar", + "radio", + "rail", + "rain", + "raise", + "rally", + "ramp", + "ranch", + "random", + "range", + "rapid", + "rare", + "rate", + "rather", + "raven", + "raw", + "razor", + "ready", + "real", + "reason", + "rebel", + "rebuild", + "recall", + "receive", + "recipe", + "record", + "recycle", + "reduce", + "reflect", + "reform", + "refuse", + "region", + "regret", + "regular", + "reject", + "relax", + "release", + "relief", + "rely", + "remain", + "remember", + "remind", + "remove", + "render", + "renew", + "rent", + "reopen", + "repair", + "repeat", + "replace", + "report", + "require", + "rescue", + "resemble", + "resist", + "resource", + "response", + "result", + "retire", + "retreat", + "return", + "reunion", + "reveal", + "review", + "reward", + "rhythm", + "rib", + "ribbon", + "rice", + "rich", + "ride", + "ridge", + "rifle", + "right", + "rigid", + "ring", + "riot", + "ripple", + "risk", + "ritual", + "rival", + "river", + "road", + "roast", + "robot", + "robust", + "rocket", + "romance", + "roof", + "rookie", + "room", + "rose", + "rotate", + "rough", + "round", + "route", + "royal", + "rubber", + "rude", + "rug", + "rule", + "run", + "runway", + "rural", + "sad", + "saddle", + "sadness", + "safe", + "sail", + "salad", + "salmon", + "salon", + "salt", + "salute", + "same", + "sample", + "sand", + "satisfy", + "satoshi", + "sauce", + "sausage", + "save", + "say", + "scale", + "scan", + "scare", + "scatter", + "scene", + "scheme", + "school", + "science", + "scissors", + "scorpion", + "scout", + "scrap", + "screen", + "script", + "scrub", + "sea", + "search", + "season", + "seat", + "second", + "secret", + "section", + "security", + "seed", + "seek", + "segment", + "select", + "sell", + "seminar", + "senior", + "sense", + "sentence", + "series", + "service", + "session", + "settle", + "setup", + "seven", + "shadow", + "shaft", + "shallow", + "share", + "shed", + "shell", + "sheriff", + "shield", + "shift", + "shine", + "ship", + "shiver", + "shock", + "shoe", + "shoot", + "shop", + "short", + "shoulder", + "shove", + "shrimp", + "shrug", + "shuffle", + "shy", + "sibling", + "sick", + "side", + "siege", + "sight", + "sign", + "silent", + "silk", + "silly", + "silver", + "similar", + "simple", + "since", + "sing", + "siren", + "sister", + "situate", + "six", + "size", + "skate", + "sketch", + "ski", + "skill", + "skin", + "skirt", + "skull", + "slab", + "slam", + "sleep", + "slender", + "slice", + "slide", + "slight", + "slim", + "slogan", + "slot", + "slow", + "slush", + "small", + "smart", + "smile", + "smoke", + "smooth", + "snack", + "snake", + "snap", + "sniff", + "snow", + "soap", + "soccer", + "social", + "sock", + "soda", + "soft", + "solar", + "soldier", + "solid", + "solution", + "solve", + "someone", + "song", + "soon", + "sorry", + "sort", + "soul", + "sound", + "soup", + "source", + "south", + "space", + "spare", + "spatial", + "spawn", + "speak", + "special", + "speed", + "spell", + "spend", + "sphere", + "spice", + "spider", + "spike", + "spin", + "spirit", + "split", + "spoil", + "sponsor", + "spoon", + "sport", + "spot", + "spray", + "spread", + "spring", + "spy", + "square", + "squeeze", + "squirrel", + "stable", + "stadium", + "staff", + "stage", + "stairs", + "stamp", + "stand", + "start", + "state", + "stay", + "steak", + "steel", + "stem", + "step", + "stereo", + "stick", + "still", + "sting", + "stock", + "stomach", + "stone", + "stool", + "story", + "stove", + "strategy", + "street", + "strike", + "strong", + "struggle", + "student", + "stuff", + "stumble", + "style", + "subject", + "submit", + "subway", + "success", + "such", + "sudden", + "suffer", + "sugar", + "suggest", + "suit", + "summer", + "sun", + "sunny", + "sunset", + "super", + "supply", + "supreme", + "sure", + "surface", + "surge", + "surprise", + "surround", + "survey", + "suspect", + "sustain", + "swallow", + "swamp", + "swap", + "swarm", + "swear", + "sweet", + "swift", + "swim", + "swing", + "switch", + "sword", + "symbol", + "symptom", + "syrup", + "system", + "table", + "tackle", + "tag", + "tail", + "talent", + "talk", + "tank", + "tape", + "target", + "task", + "taste", + "tattoo", + "taxi", + "teach", + "team", + "tell", + "ten", + "tenant", + "tennis", + "tent", + "term", + "test", + "text", + "thank", + "that", + "theme", + "then", + "theory", + "there", + "they", + "thing", + "this", + "thought", + "three", + "thrive", + "throw", + "thumb", + "thunder", + "ticket", + "tide", + "tiger", + "tilt", + "timber", + "time", + "tiny", + "tip", + "tired", + "tissue", + "title", + "toast", + "tobacco", + "today", + "toddler", + "toe", + "together", + "toilet", + "token", + "tomato", + "tomorrow", + "tone", + "tongue", + "tonight", + "tool", + "tooth", + "top", + "topic", + "topple", + "torch", + "tornado", + "tortoise", + "toss", + "total", + "tourist", + "toward", + "tower", + "town", + "toy", + "track", + "trade", + "traffic", + "tragic", + "train", + "transfer", + "trap", + "trash", + "travel", + "tray", + "treat", + "tree", + "trend", + "trial", + "tribe", + "trick", + "trigger", + "trim", + "trip", + "trophy", + "trouble", + "truck", + "true", + "truly", + "trumpet", + "trust", + "truth", + "try", + "tube", + "tuition", + "tumble", + "tuna", + "tunnel", + "turkey", + "turn", + "turtle", + "twelve", + "twenty", + "twice", + "twin", + "twist", + "two", + "type", + "typical", + "ugly", + "umbrella", + "unable", + "unaware", + "uncle", + "uncover", + "under", + "undo", + "unfair", + "unfold", + "unhappy", + "uniform", + "unique", + "unit", + "universe", + "unknown", + "unlock", + "until", + "unusual", + "unveil", + "update", + "upgrade", + "uphold", + "upon", + "upper", + "upset", + "urban", + "urge", + "usage", + "use", + "used", + "useful", + "useless", + "usual", + "utility", + "vacant", + "vacuum", + "vague", + "valid", + "valley", + "valve", + "van", + "vanish", + "vapor", + "various", + "vast", + "vault", + "vehicle", + "velvet", + "vendor", + "venture", + "venue", + "verb", + "verify", + "version", + "very", + "vessel", + "veteran", + "viable", + "vibrant", + "vicious", + "victory", + "video", + "view", + "village", + "vintage", + "violin", + "virtual", + "virus", + "visa", + "visit", + "visual", + "vital", + "vivid", + "vocal", + "voice", + "void", + "volcano", + "volume", + "vote", + "voyage", + "wage", + "wagon", + "wait", + "walk", + "wall", + "walnut", + "want", + "warfare", + "warm", + "warrior", + "wash", + "wasp", + "waste", + "water", + "wave", + "way", + "wealth", + "weapon", + "wear", + "weasel", + "weather", + "web", + "wedding", + "weekend", + "weird", + "welcome", + "west", + "wet", + "whale", + "what", + "wheat", + "wheel", + "when", + "where", + "whip", + "whisper", + "wide", + "width", + "wife", + "wild", + "will", + "win", + "window", + "wine", + "wing", + "wink", + "winner", + "winter", + "wire", + "wisdom", + "wise", + "wish", + "witness", + "wolf", + "woman", + "wonder", + "wood", + "wool", + "word", + "work", + "world", + "worry", + "worth", + "wrap", + "wreck", + "wrestle", + "wrist", + "write", + "wrong", + "yard", + "year", + "yellow", + "you", + "young", + "youth", + "zebra", + "zero", + "zone", + "zoo", +]; diff --git a/src/french.rs b/src/language/french.rs similarity index 100% rename from src/french.rs rename to src/language/french.rs diff --git a/src/italian.rs b/src/language/italian.rs similarity index 100% rename from src/italian.rs rename to src/language/italian.rs diff --git a/src/japanese.rs b/src/language/japanese.rs similarity index 100% rename from src/japanese.rs rename to src/language/japanese.rs diff --git a/src/korean.rs b/src/language/korean.rs similarity index 100% rename from src/korean.rs rename to src/language/korean.rs diff --git a/src/language/mod.rs b/src/language/mod.rs new file mode 100644 index 0000000..bd3c95c --- /dev/null +++ b/src/language/mod.rs @@ -0,0 +1,247 @@ + +use std::fmt; + +mod english; +#[cfg(feature = "chinese-simplified")] +mod chinese_simplified; +#[cfg(feature = "chinese-traditional")] +mod chinese_traditional; +#[cfg(feature = "czech")] +mod czech; +#[cfg(feature = "french")] +mod french; +#[cfg(feature = "italian")] +mod italian; +#[cfg(feature = "japanese")] +mod japanese; +#[cfg(feature = "korean")] +mod korean; +#[cfg(feature = "spanish")] +mod spanish; + +#[cfg(not(feature = "low-memory"))] +mod lazy { + use std::cell::Cell; + use std::collections::HashMap; + use std::sync::Once; + + /// Type used to load a word map in a lazy fashion. + pub(crate) struct LazyMap(Cell>>, Once); + + impl LazyMap { + #[allow(deprecated)] + const INIT: Self = LazyMap(Cell::new(None), ::std::sync::ONCE_INIT); + + #[inline(always)] + pub fn get(&'static self, list: &'static [&'static str]) -> &HashMap<&'static str, u16> { + self.1.call_once(|| { + let mut map = HashMap::new(); + for (idx, word) in list.iter().enumerate() { + map.insert(*word, idx as u16); + } + self.0.set(Some(map)); + }); + + // `self.0` is guaranteed to be `Some` by this point + // The `Once` will catch and propagate panics + unsafe { + match *self.0.as_ptr() { + Some(ref x) => x, + None => panic!(), + } + } + } + } + + // This marker impl is required for the Cell to work. + // The LazyMap is an implementation identical to lazy_static's. + // We assume lazy_static's exact same usage is considered safe. + #[cfg(not(feature = "low-memory"))] + unsafe impl Sync for LazyMap {} + + pub(crate) static LAZY_MAP_ENGLISH: LazyMap = LazyMap::INIT; + #[cfg(feature = "chinese-simplified")] + pub(crate) static LAZY_MAP_CHINESE_SIMPLIFIED: LazyMap = LazyMap::INIT; + #[cfg(feature = "chinese-traditional")] + pub(crate) static LAZY_MAP_CHINESE_TRADITIONAL: LazyMap = LazyMap::INIT; + #[cfg(feature = "czech")] + pub(crate) static LAZY_MAP_CZECH: LazyMap = LazyMap::INIT; + #[cfg(feature = "french")] + pub(crate) static LAZY_MAP_FRENCH: LazyMap = LazyMap::INIT; + #[cfg(feature = "italian")] + pub(crate) static LAZY_MAP_ITALIAN: LazyMap = LazyMap::INIT; + #[cfg(feature = "japanese")] + pub(crate) static LAZY_MAP_JAPANESE: LazyMap = LazyMap::INIT; + #[cfg(feature = "korean")] + pub(crate) static LAZY_MAP_KOREAN: LazyMap = LazyMap::INIT; + #[cfg(feature = "spanish")] + pub(crate) static LAZY_MAP_SPANISH: LazyMap = LazyMap::INIT; +} + +/// Language to be used for the mnemonic phrase. +/// +/// The English language is always available, other languages are enabled using +/// the compilation features. +#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)] +pub enum Language { + /// The English language. + English, + #[cfg(feature = "chinese-simplified")] + /// The Simplified Chinese language. + SimplifiedChinese, + #[cfg(feature = "chinese-traditional")] + /// The Traditional Chinese language. + TraditionalChinese, + #[cfg(feature = "czech")] + /// The Czech language. + Czech, + #[cfg(feature = "french")] + /// The French language. + French, + #[cfg(feature = "italian")] + /// The Italian language. + Italian, + #[cfg(feature = "japanese")] + /// The Japanese language. + Japanese, + #[cfg(feature = "korean")] + /// The Korean language. + Korean, + #[cfg(feature = "spanish")] + /// The Spanish language. + Spanish, +} + +impl Language { + /// Get words from the wordlist that start with the given prefix. + pub fn words_by_prefix(self, prefix: &str) -> &[&'static str] { + let first = match self.word_list().iter().position(|w| w.starts_with(prefix)) { + Some(i) => i, + None => return &[], + }; + let count = self.word_list()[first..].iter().take_while(|w| w.starts_with(prefix)).count(); + &self.word_list()[first .. first + count] + } + + /// The word list for this language. + #[inline] + pub(crate) fn word_list(self) -> &'static [&'static str; 2048] { + match self { + Language::English => &english::WORDS, + #[cfg(feature = "chinese-simplified")] + Language::SimplifiedChinese => &chinese_simplified::WORDS, + #[cfg(feature = "chinese-traditional")] + Language::TraditionalChinese => &chinese_traditional::WORDS, + #[cfg(feature = "czech")] + Language::Czech => &czech::WORDS, + #[cfg(feature = "french")] + Language::French => &french::WORDS, + #[cfg(feature = "italian")] + Language::Italian => &italian::WORDS, + #[cfg(feature = "japanese")] + Language::Japanese => &japanese::WORDS, + #[cfg(feature = "korean")] + Language::Korean => &korean::WORDS, + #[cfg(feature = "spanish")] + Language::Spanish => &spanish::WORDS, + } + } + + /// The word map that maps words to the index in the word list for this language. + #[cfg(not(feature = "low-memory"))] + pub(crate) fn word_map(self) -> &'static ::std::collections::HashMap<&'static str, u16> { + match self { + Language::English => lazy::LAZY_MAP_ENGLISH.get(self.word_list()), + #[cfg(feature = "chinese-simplified")] + Language::SimplifiedChinese => lazy::LAZY_MAP_CHINESE_SIMPLIFIED.get(self.word_list()), + #[cfg(feature = "chinese-traditional")] + Language::TraditionalChinese => lazy::LAZY_MAP_CHINESE_TRADITIONAL.get(self.word_list()), + #[cfg(feature = "czech")] + Language::Czech => lazy::LAZY_MAP_CZECH.get(self.word_list()), + #[cfg(feature = "french")] + Language::French => lazy::LAZY_MAP_FRENCH.get(self.word_list()), + #[cfg(feature = "italian")] + Language::Italian => lazy::LAZY_MAP_ITALIAN.get(self.word_list()), + #[cfg(feature = "japanese")] + Language::Japanese => lazy::LAZY_MAP_JAPANESE.get(self.word_list()), + #[cfg(feature = "korean")] + Language::Korean => lazy::LAZY_MAP_KOREAN.get(self.word_list()), + #[cfg(feature = "spanish")] + Language::Spanish => lazy::LAZY_MAP_SPANISH.get(self.word_list()), + } + } +} + +impl fmt::Display for Language { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + fmt::Debug::fmt(self, f) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[cfg(all( + feature = "chinese-simplified", feature = "chinese-traditional", feature = "czech", + feature = "french", feature = "italian", feature = "japanese", feature = "korean", + feature = "spanish" + ))] + #[test] + fn validate_wordlist_checksums() { + //! In this test, we ensure that the wordlists are identical. + //! + //! They are as follows in the bips repository: + //! 5c5942792bd8340cb8b27cd592f1015edf56a8c5b26276ee18a482428e7c5726 chinese_simplified.txt + //! 417b26b3d8500a4ae3d59717d7011952db6fc2fb84b807f3f94ac734e89c1b5f chinese_traditional.txt + //! 7e80e161c3e93d9554c2efb78d4e3cebf8fc727e9c52e03b83b94406bdcc95fc czech.txt + //! 2f5eed53a4727b4bf8880d8f3f199efc90e58503646d9ff8eff3a2ed3b24dbda english.txt + //! ebc3959ab7801a1df6bac4fa7d970652f1df76b683cd2f4003c941c63d517e59 french.txt + //! d392c49fdb700a24cd1fceb237c1f65dcc128f6b34a8aacb58b59384b5c648c2 italian.txt + //! 2eed0aef492291e061633d7ad8117f1a2b03eb80a29d0e4e3117ac2528d05ffd japanese.txt + //! 9e95f86c167de88f450f0aaf89e87f6624a57f973c67b516e338e8e8b8897f60 korean.txt + //! 46846a5a0139d1e3cb77293e521c2865f7bcdb82c44e8d0a06a2cd0ecba48c0b spanish.txt + + use std::io::Write; + use bitcoin_hashes::{sha256, Hash}; + + let checksums = [ + ("5c5942792bd8340cb8b27cd592f1015edf56a8c5b26276ee18a482428e7c5726", Language::SimplifiedChinese), + ("417b26b3d8500a4ae3d59717d7011952db6fc2fb84b807f3f94ac734e89c1b5f", Language::TraditionalChinese), + ("7e80e161c3e93d9554c2efb78d4e3cebf8fc727e9c52e03b83b94406bdcc95fc", Language::Czech), + ("2f5eed53a4727b4bf8880d8f3f199efc90e58503646d9ff8eff3a2ed3b24dbda", Language::English), + ("ebc3959ab7801a1df6bac4fa7d970652f1df76b683cd2f4003c941c63d517e59", Language::French), + ("d392c49fdb700a24cd1fceb237c1f65dcc128f6b34a8aacb58b59384b5c648c2", Language::Italian), + ("2eed0aef492291e061633d7ad8117f1a2b03eb80a29d0e4e3117ac2528d05ffd", Language::Japanese), + ("9e95f86c167de88f450f0aaf89e87f6624a57f973c67b516e338e8e8b8897f60", Language::Korean), + ("46846a5a0139d1e3cb77293e521c2865f7bcdb82c44e8d0a06a2cd0ecba48c0b", Language::Spanish), + ]; + + for &(sum, lang) in &checksums { + let mut digest = sha256::Hash::engine(); + for (_idx, word) in lang.word_list().iter().enumerate() { + assert!(::unicode_normalization::is_nfkd(&word)); + write!(&mut digest, "{}\n", word).unwrap(); + #[cfg(not(feature = "low-memory"))] + assert_eq!(_idx, lang.word_map()[word] as usize); + } + assert_eq!(&sha256::Hash::from_engine(digest).to_string(), sum, + "word list for language {} failed checksum check", lang, + ); + } + } + + #[test] + fn words_by_prefix() { + let lang = Language::English; + + let res = lang.words_by_prefix("woo"); + assert_eq!(res, ["wood","wool"]); + + let res = lang.words_by_prefix(""); + assert_eq!(res.len(), 2048); + + let res = lang.words_by_prefix("woof"); + assert!(res.is_empty()); + } +} diff --git a/src/spanish.rs b/src/language/spanish.rs similarity index 100% rename from src/spanish.rs rename to src/language/spanish.rs diff --git a/src/lib.rs b/src/lib.rs index 797c87f..0e78720 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,6 +1,6 @@ // Rust Bitcoin Library // Written in 2020 by -// Steven Roose +// Steven Roose // To the extent possible under law, the author(s) have dedicated all // copyright and related and neighboring rights to this software to // the public domain worldwide. This software is distributed without @@ -18,48 +18,44 @@ //! https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki //! +#![deny(non_upper_case_globals)] +#![deny(non_camel_case_types)] +#![deny(non_snake_case)] +#![deny(unused_mut)] +#![deny(dead_code)] +#![deny(unused_imports)] +#![deny(missing_docs)] extern crate bitcoin_hashes; extern crate unicode_normalization; +#[cfg(feature = "rand")] +extern crate rand; use std::{error, fmt, str}; +use std::borrow::Cow; use bitcoin_hashes::{sha256, Hash}; use unicode_normalization::UnicodeNormalization; +mod language; mod pbkdf2; -mod english; -#[cfg(feature = "chinese-simplified")] -mod chinese_simplified; -#[cfg(feature = "chinese-traditional")] -mod chinese_traditional; -#[cfg(feature = "czech")] -mod czech; -#[cfg(feature = "french")] -mod french; -#[cfg(feature = "italian")] -mod italian; -#[cfg(feature = "japanese")] -mod japanese; -#[cfg(feature = "korean")] -mod korean; -#[cfg(feature = "spanish")] -mod spanish; +pub use language::Language; -#[cfg(feature = "japanese")] /// The ideagrapic space that should be used for Japanese lists. -const IDEAGRAPHIC_SPACE: char = '　'; +#[cfg(feature = "japanese")] +#[allow(unused)] +const IDEOGRAPHIC_SPACE: char = '　'; /// A BIP39 error. -#[derive(Clone, PartialEq, Eq, Debug)] +#[derive(Clone, PartialEq, Eq)] pub enum Error { /// Mnemonic has a word count that is not a multiple of 6. BadWordCount(usize), /// Mnemonic contains an unknown word. UnknownWord(String), /// Entropy was not a multiple of 32 bits. - /// Parameter is the number of bits in the entropy. + /// Parameter is the number of bits in the entropy. BadEntropyBitCount(usize), /// The mnemonic has an invalid checksum. InvalidChecksum, @@ -69,102 +65,58 @@ impl fmt::Display for Error { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { Error::BadWordCount(c) => write!(f, - "mnemonic has a word count that is not a multiple of 6: {}", c, - ), - Error::UnknownWord(ref w) => write!(f, "mnemonic contains an unknown word: {}", w), + "mnemonic has a word count that is not a multiple of 6: {}", c, + ), + Error::UnknownWord(ref w) => write!(f, + "mnemonic contains an unknown word: {} ({})", + w, bitcoin_hashes::hex::ToHex::to_hex(w.as_bytes()), + ), Error::BadEntropyBitCount(c) => write!(f, - "entropy was not a multiple of 32 bits: {} bits", c, - ), + "entropy was not a multiple of 32 bits: {} bits", c, + ), Error::InvalidChecksum => write!(f, "the mnemonic has an invalid checksum"), } } } +impl fmt::Debug for Error { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + fmt::Display::fmt(self, f) + } +} impl error::Error for Error { fn cause(&self) -> Option<&error::Error> { - None + None } - fn description(&self) -> &str { - "description() is deprecated; use Display" - } -} - -#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)] -pub enum Language { - /// The English language. - English, - #[cfg(feature = "chinese-simplified")] - /// The Simplified Chinese language. - SimplifiedChinese, - #[cfg(feature = "chinese-traditional")] - /// The Traditional Chinese language. - TraditionalChinese, - #[cfg(feature = "czech")] - /// The Czech language. - Czech, - #[cfg(feature = "french")] - /// The French language. - French, - #[cfg(feature = "italian")] - /// The Italian language. - Italian, - #[cfg(feature = "japanese")] - /// The Japanese language. - Japanese, - #[cfg(feature = "korean")] - /// The Korean language. - Korean, - #[cfg(feature = "spanish")] - /// The Spanish language. - Spanish, -} - -impl Language { - /// The word list for this language. - fn word_list(self) -> &'static [&'static str; 2048] { - match self { - Language::English => &english::WORDS, - #[cfg(feature = "chinese-simplified")] - Language::SimplifiedChinese => &chinese_simplified::WORDS, - #[cfg(feature = "chinese-traditional")] - Language::TraditionalChinese => &chinese_traditional::WORDS, - #[cfg(feature = "czech")] - Language::Czech => &czech::WORDS, - #[cfg(feature = "french")] - Language::French => &french::WORDS, - #[cfg(feature = "italian")] - Language::Italian => &italian::WORDS, - #[cfg(feature = "japanese")] - Language::Japanese => &japanese::WORDS, - #[cfg(feature = "korean")] - Language::Korean => &korean::WORDS, - #[cfg(feature = "spanish")] - Language::Spanish => &spanish::WORDS, - } - } - - /// The space to be used for this language. - fn space(self) -> char { - match self { - #[cfg(feature = "japanese")] - Language::Japanese => IDEAGRAPHIC_SPACE, - _ => ' ', - } - } -} - -impl fmt::Display for Language { - fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { - fmt::Debug::fmt(self, f) + fn description(&self) -> &str { + "description() is deprecated; use Display" } } /// A mnemonic code. +/// +/// The [std::str::FromStr] implementation will try to determine the language of the +/// mnemonic from all the supported languages. (Languages have to be explicitly enabled using +/// the Cargo features.) +/// +/// Supported number of words are 6, 12, 18 and 24. #[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)] -pub struct Mnemonic(Language, Vec); +pub struct Mnemonic(String); +// The content of the mnemonic is ensured to be NFKD-normalized UTF-8. impl Mnemonic { + /// Ensure the content of the [Cow] is normalized UTF8. + /// Performing this on a [Cow] means that all allocations for normalization + /// can be avoided for languages without special UTF8 characters. + #[inline] + fn normalize_utf8_cow<'a>(cow: &mut Cow<'a, str>) { + let is_nfkd = unicode_normalization::is_nfkd_quick(cow.as_ref().chars()); + if is_nfkd != unicode_normalization::IsNormalized::Yes { + *cow = Cow::Owned(cow.as_ref().nfkd().to_string()); + } + } + /// Create a new [Mnemonic] in the specified language from the given entropy. /// Entropy must be a multiple of 32 bits (4 bytes). pub fn from_entropy_in(language: Language, entropy: &[u8]) -> Result { @@ -183,7 +135,7 @@ impl Mnemonic { bits[8 * entropy.len() + i] = (check[i / 8] & (1 << (7 - (i % 8)))) > 0; } let mlen = entropy.len() * 3 / 4; - let mut word_idxs = Vec::new(); + let mut words = Vec::new(); for i in 0..mlen { let mut idx = 0; for j in 0..11 { @@ -191,9 +143,10 @@ impl Mnemonic { idx += 1 << (10 - j); } } - word_idxs.push(idx); + words.push(language.word_list()[idx]); } - Ok(Mnemonic(language, word_idxs)) + + Ok(Mnemonic(words.join(" "))) } /// Create a new English [Mnemonic] in from the given entropy. @@ -202,20 +155,46 @@ impl Mnemonic { Mnemonic::from_entropy_in(Language::English, entropy) } - /// Parse a mnemonic in the given language. - pub fn from_str_in(language: Language, s: &str) -> Result { - let word_list = language.word_list(); - let words: Vec<_> = s.split_whitespace().collect(); - if words.len() < 6 || words.len() % 6 != 0 { + /// Generate a new Mnemonic in the given language. + /// For the different supported word counts, see documentation on [Mnemonoc]. + #[cfg(feature = "rand")] + pub fn generate_in(language: Language, word_count: usize) -> Result { + if word_count < 6 || word_count % 6 != 0 || word_count > 24 { + return Err(Error::BadWordCount(word_count)); + } + + let entropy_bytes = (word_count / 3) * 4; + let mut rng = rand::thread_rng(); + let mut entropy = vec![0u8; entropy_bytes]; + rand::RngCore::fill_bytes(&mut rng, &mut entropy); + Mnemonic::from_entropy_in(language, &entropy) + } + + /// Generate a new Mnemonic in English. + /// For the different supported word counts, see documentation on [Mnemonoc]. + #[cfg(feature = "rand")] + pub fn generate(word_count: usize) -> Result { + Mnemonic::generate_in(Language::English, word_count) + } + + /// Static method to validate a mnemonic in a given language. + pub fn validate_in(language: Language, s: &str) -> Result<(), Error> { + #[cfg(not(feature = "low-memory"))] + let word_map = language.word_map(); + + let words: Vec<&str> = s.split_whitespace().collect(); + if words.len() < 6 || words.len() % 6 != 0 || words.len() > 24 { return Err(Error::BadWordCount(words.len())); } - let mut word_idxs = Vec::with_capacity(words.len()); let mut bits = vec![false; words.len() * 11]; for (i, word) in words.iter().enumerate() { - if let Ok(idx) = word_list.binary_search(word) { - word_idxs.push(idx as u16); + #[cfg(not(feature = "low-memory"))] + let found = word_map.get(word); + #[cfg(feature = "low-memory")] + let found = language.word_list().iter().position(|w| w == word); + if let Some(idx) = found { for j in 0..11 { bits[i * 11 + j] = idx >> (10 - j) & 1 == 1; } @@ -239,45 +218,14 @@ impl Mnemonic { return Err(Error::InvalidChecksum); } } - Ok(Mnemonic(language, word_idxs)) - } - - /// Convert this mnemonic to a vector of bytes in UTF-8 NKFD normalized. - pub fn to_bytes(&self) -> Vec { - self.to_string().nfkd().map(|c| c as u8).collect() - } - - /// Convert to seed bytes. - pub fn to_seed(&self, passphrase: &str) -> Vec { - const PBKDF2_ROUNDS: usize = 2048; - const PBKDF2_BYTES: usize = 64; - - let salt = format!("mnemonic{}", passphrase); - let normalized_salt = salt.nfkd().to_string(); - let mut seed = vec![0u8; PBKDF2_BYTES]; - pbkdf2::pbkdf2(&self.to_bytes(), &normalized_salt.as_bytes(), PBKDF2_ROUNDS, &mut seed); - seed - } -} - -impl fmt::Display for Mnemonic { - fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { - let space = self.0.space(); - let word_list = self.0.word_list(); - - let mut words = self.1.iter().map(|i| word_list[*i as usize]); - write!(f, "{}", words.next().expect("wordlist never empty"))?; - for word in words { - write!(f, "{}{}", space, word)?; - } Ok(()) } -} -impl str::FromStr for Mnemonic { - type Err = Error; - - fn from_str(s: &str) -> Result { + /// Guess the language of the mnemonic based on the first word. + /// + /// This works as official word lists are made as such that a word never + /// appears in two different word lists. + pub fn guess_language(s: &str) -> Result { let languages = [ Language::English, #[cfg(feature = "chinese-simplified")] @@ -302,83 +250,132 @@ impl str::FromStr for Mnemonic { return Err(Error::BadWordCount(0)); } for language in &languages { - if language.word_list().binary_search(&first_word).is_ok() { - return Mnemonic::from_str_in(*language, s); + #[cfg(not(feature = "low-memory"))] + let found = language.word_map().get(first_word).is_some(); + #[cfg(feature = "low-memory")] + let found = language.word_list().iter().any(|w| *w == first_word); + + if found { + return Ok(*language); } } Err(Error::UnknownWord(first_word.to_owned())) } + + /// Parse a mnemonic and detect the language from the enabled languages. + pub fn parse<'a, S: Into>>(s: S) -> Result { + let mut cow = s.into(); + Mnemonic::normalize_utf8_cow(&mut cow); + let language = Mnemonic::guess_language(cow.as_ref())?; + Mnemonic::validate_in(language, cow.as_ref())?; + Ok(Mnemonic(cow.into_owned())) + } + + /// Parse a mnemonic in the given language. + pub fn parse_in<'a, S: Into>>(language: Language, s: S) -> Result { + let mut cow = s.into(); + Mnemonic::normalize_utf8_cow(&mut cow); + Mnemonic::validate_in(language, cow.as_ref())?; + Ok(Mnemonic(cow.into_owned())) + } + + /// Get the mnemonic as a [&str]. + pub fn as_str(&self) -> &str { + &self.0 + } + + /// Get the number of words in the mnemonic. + pub fn word_count(&self) -> usize { + self.as_str().split_whitespace().count() + } + + /// Convert to seed bytes. + pub fn to_seed(&self, passphrase: &str) -> Vec { + const PBKDF2_ROUNDS: usize = 2048; + const PBKDF2_BYTES: usize = 64; + + let normalized_salt_cow = { + let mut cow = Cow::Owned(format!("mnemonic{}", passphrase)); + Mnemonic::normalize_utf8_cow(&mut cow); + cow + }; + let normalized_mnemonic_cow = { + let mut cow: Cow = Cow::Borrowed(self.as_str()); + Mnemonic::normalize_utf8_cow(&mut cow); + cow + }; + let mut seed = vec![0u8; PBKDF2_BYTES]; + pbkdf2::pbkdf2( + &normalized_mnemonic_cow.as_ref().as_bytes(), + &normalized_salt_cow.as_ref().as_bytes(), + PBKDF2_ROUNDS, + &mut seed, + ); + seed + } + + /// Convert the mnemonic back to the entropy used to generate it. + pub fn to_entropy(&self) -> Vec { + // We unwrap errors here because this method can only be called on + // values that were already previously validated. + + let language = Mnemonic::guess_language(self.as_str()).unwrap(); + #[cfg(not(feature = "low-memory"))] + let word_map = language.word_map(); + + // Preallocate enough space for the longest possible word list + let mut entropy = Vec::with_capacity(33); + let mut offset = 0; + let mut remainder = 0; + + let words: Vec<&str> = self.as_str().split_whitespace().collect(); + for word in &words { + #[cfg(not(feature = "low-memory"))] + let idx = *word_map.get(word).unwrap(); + #[cfg(feature = "low-memory")] + let idx = language.word_list().iter().position(|w| w == word).unwrap(); + + remainder |= ((idx as u32) << (32 - 11)) >> offset; + offset += 11; + + while offset >= 8 { + entropy.push((remainder >> 24) as u8); + remainder <<= 8; + offset -= 8; + } + } + + if offset != 0 { + entropy.push((remainder >> 24) as u8); + } + + // Truncate to get rid of the byte containing the checksum + let entropy_bytes = (words.len() / 3) * 4; + entropy.truncate(entropy_bytes); + entropy + } +} + +impl fmt::Display for Mnemonic { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + f.write_str(self.as_str()) + } +} + +impl str::FromStr for Mnemonic { + type Err = Error; + + fn from_str(s: &str) -> Result { + Mnemonic::parse(s) + } } #[cfg(test)] -mod test { +mod tests { use super::*; - use std::io::Write; - use std::str::FromStr; - - use bitcoin_hashes::{sha256, Hash}; use bitcoin_hashes::hex::FromHex; - #[cfg(all( - feature = "chinese-simplified", feature = "chinese-traditional", feature = "czech", - feature = "french", feature = "italian", feature = "japanese", feature = "korean", - feature = "spanish" - ))] - #[test] - fn validate_list_checksums() { - //! In this test, we ensure that the wordlists are identical. - //! - //! They are as follows in the bips repository: - //! 5c5942792bd8340cb8b27cd592f1015edf56a8c5b26276ee18a482428e7c5726 chinese_simplified.txt - //! 417b26b3d8500a4ae3d59717d7011952db6fc2fb84b807f3f94ac734e89c1b5f chinese_traditional.txt - //! 7e80e161c3e93d9554c2efb78d4e3cebf8fc727e9c52e03b83b94406bdcc95fc czech.txt - //! 2f5eed53a4727b4bf8880d8f3f199efc90e58503646d9ff8eff3a2ed3b24dbda english.txt - //! ebc3959ab7801a1df6bac4fa7d970652f1df76b683cd2f4003c941c63d517e59 french.txt - //! d392c49fdb700a24cd1fceb237c1f65dcc128f6b34a8aacb58b59384b5c648c2 italian.txt - //! 2eed0aef492291e061633d7ad8117f1a2b03eb80a29d0e4e3117ac2528d05ffd japanese.txt - //! 9e95f86c167de88f450f0aaf89e87f6624a57f973c67b516e338e8e8b8897f60 korean.txt - //! 46846a5a0139d1e3cb77293e521c2865f7bcdb82c44e8d0a06a2cd0ecba48c0b spanish.txt - - let checksums = [ - ("5c5942792bd8340cb8b27cd592f1015edf56a8c5b26276ee18a482428e7c5726", Language::SimplifiedChinese), - ("417b26b3d8500a4ae3d59717d7011952db6fc2fb84b807f3f94ac734e89c1b5f", Language::TraditionalChinese), - ("7e80e161c3e93d9554c2efb78d4e3cebf8fc727e9c52e03b83b94406bdcc95fc", Language::Czech), - ("2f5eed53a4727b4bf8880d8f3f199efc90e58503646d9ff8eff3a2ed3b24dbda", Language::English), - ("ebc3959ab7801a1df6bac4fa7d970652f1df76b683cd2f4003c941c63d517e59", Language::French), - ("d392c49fdb700a24cd1fceb237c1f65dcc128f6b34a8aacb58b59384b5c648c2", Language::Italian), - ("2eed0aef492291e061633d7ad8117f1a2b03eb80a29d0e4e3117ac2528d05ffd", Language::Japanese), - ("9e95f86c167de88f450f0aaf89e87f6624a57f973c67b516e338e8e8b8897f60", Language::Korean), - ("46846a5a0139d1e3cb77293e521c2865f7bcdb82c44e8d0a06a2cd0ecba48c0b", Language::Spanish), - ]; - - for (sum, lang) in &checksums { - let mut digest = sha256::Hash::engine(); - for word in lang.word_list().iter() { - write!(&mut digest, "{}\n", word).unwrap(); - } - assert_eq!(&sha256::Hash::from_engine(digest).to_string(), sum, - "word list for language {} failed checksum check", lang, - ); - } - } - - /// Test a single test vector. - fn test_vector(entropy: &[u8], mnemonic_str: &str, passphrase: &str, seed: &[u8], language: Language) { - let mnemonic = Mnemonic::from_entropy_in(language, &entropy).unwrap(); - - assert_eq!(&mnemonic.to_string(), mnemonic_str, - "failed test vector in language {}: {}", language, mnemonic_str); - assert_eq!(mnemonic, Mnemonic::from_str_in(language, mnemonic_str).unwrap(), - "failed test vector in language {}: {}", language, mnemonic_str); - assert_eq!(mnemonic, Mnemonic::from_str(&mnemonic_str).unwrap(), - "failed test vector in language {}: {}", language, mnemonic_str); - - assert_eq!(seed, &mnemonic.to_seed(passphrase)[..], - "failed test vector in language {}: {}", language, mnemonic_str); - } - - #[test] fn test_vectors_english() { // These vectors are tuples of @@ -508,10 +505,21 @@ mod test { for vector in &test_vectors { let entropy = Vec::::from_hex(&vector.0).unwrap(); - let mnemonic = vector.1; + let mnemonic_str = vector.1; let seed = Vec::::from_hex(&vector.2).unwrap(); - test_vector(&entropy, mnemonic, "TREZOR", &seed, Language::English); + let mnemonic = Mnemonic::from_entropy(&entropy).unwrap(); + + assert_eq!(&mnemonic.to_string(), mnemonic_str, + "failed vector: {}", mnemonic_str); + assert_eq!(mnemonic, Mnemonic::parse_in(Language::English, mnemonic_str).unwrap(), + "failed vector: {}", mnemonic_str); + assert_eq!(mnemonic, Mnemonic::parse(mnemonic_str).unwrap(), + "failed vector: {}", mnemonic_str); + assert_eq!(&entropy, &mnemonic.to_entropy(), + "failed vector: {}", mnemonic_str); + assert_eq!(&seed, &mnemonic.to_seed("TREZOR"), + "failed vector: {}", mnemonic_str); } } @@ -521,31 +529,34 @@ mod test { // "letter advice cage absurd amount doctor acoustic avoid letter advice cage above" assert_eq!( - Mnemonic::from_str( + Mnemonic::parse( "getter advice cage absurd amount doctor acoustic avoid letter advice cage above", ), - Err(Error::UnknownWord("getter".to_owned())), + Err(Error::UnknownWord("getter".to_owned())) ); assert_eq!( - Mnemonic::from_str( + Mnemonic::parse( "advice cage absurd amount doctor acoustic avoid letter advice cage above", ), - Err(Error::BadWordCount(11)), + Err(Error::BadWordCount(11)) ); assert_eq!( - Mnemonic::from_str( + Mnemonic::parse( "primary advice cage absurd amount doctor acoustic avoid letter advice cage above", ), - Err(Error::InvalidChecksum), + Err(Error::InvalidChecksum) ); } #[cfg(feature = "japanese")] #[test] fn test_vectors_japanese() { - assert!(IDEAGRAPHIC_SPACE.is_whitespace()); + //! Test some Japanese language test vectors. + //! For these test vectors, we seem to generate different mnemonic phrases than the test + //! vectors expect us to. However, our generated seeds are correct and tiny-bip39, + //! an alternative implementation of bip39 also does not fulfill the test vectors. // These vectors are tuples of // (entropy, mnemonic, passphrase, seed) @@ -698,11 +709,22 @@ mod test { for vector in &vectors { let entropy = Vec::::from_hex(&vector.0).unwrap(); - let mnemonic = vector.1; + let mnemonic_str = vector.1; let passphrase = vector.2; let seed = Vec::::from_hex(&vector.3).unwrap(); - test_vector(&entropy, mnemonic, passphrase, &seed, Language::Japanese); + let mnemonic = Mnemonic::from_entropy_in(Language::Japanese, &entropy).unwrap(); + assert_eq!(seed, &mnemonic.to_seed(passphrase)[..], + "failed vector: {}", mnemonic_str); + + let rt = Mnemonic::parse_in(Language::Japanese, mnemonic.as_str()) + .expect(&format!("vector: {}", mnemonic_str)); + assert_eq!(seed, &rt.to_seed(passphrase)[..]); + + let mnemonic = Mnemonic::parse_in(Language::Japanese, mnemonic_str) + .expect(&format!("vector: {}", mnemonic_str)); + assert_eq!(seed, &mnemonic.to_seed(passphrase)[..], + "failed vector: {}", mnemonic_str); } } } diff --git a/src/pbkdf2.rs b/src/pbkdf2.rs index 4c0982d..66abe5a 100644 --- a/src/pbkdf2.rs +++ b/src/pbkdf2.rs @@ -15,16 +15,16 @@ fn u32_to_array_be(val: u32) -> [u8; 4] { #[inline] fn xor(res: &mut [u8], salt: &[u8]) { - debug_assert!(salt.len() >= res.len(), "length mismatch in xor"); + debug_assert!(salt.len() >= res.len(), "length mismatch in xor"); - res.iter_mut().zip(salt.iter()).for_each(|(a, b)| *a ^= b); + res.iter_mut().zip(salt.iter()).for_each(|(a, b)| *a ^= b); } /// PBKDF2-HMAC-SHA512 implementation using bitcoin_hashes. pub(crate) fn pbkdf2(passphrase: &[u8], salt: &[u8], c: usize, res: &mut [u8]) { let prf = hmac::HmacEngine::::new(passphrase); - for (i, chunk) in res.chunks_mut(sha512::Hash::LEN).enumerate() { + for (i, chunk) in res.chunks_mut(sha512::Hash::LEN).enumerate() { for v in chunk.iter_mut() { *v = 0; } let mut salt = { @@ -44,5 +44,5 @@ pub(crate) fn pbkdf2(passphrase: &[u8], salt: &[u8], c: usize, res: &mut [u8]) { xor(chunk, &salt); } - } + } }