Merge pull request #251 from iqlusioninc/hkd32/bip39

hkd32: Merge `tiny-bip39`

Author: tony-iqlusion

Cargo.lock

@@ -14,7 +14,7 @@ homepage    = "https://github.com/iqlusioninc/crates/"
 repository  = "https://github.com/iqlusioninc/crates/tree/develop/hkd32"
 readme      = "README.md"
 categories  = ["cryptography", "no-std"]
-keywords    = ["bip32", "derivation", "hd", "hmac", "key"]
+keywords    = ["crypto", "bip32", "bip39", "derivation", "mnemonic"]
 
 [badges]
 maintenance = { status = "passively-maintained" }
@@ -23,8 +23,9 @@ travis-ci = { repository = "iqlusioninc/crates", branch = "develop" }
 [dependencies]
 getrandom = { version = "0.1", optional = true }
 hmac = { version = "0.7", default-features = false }
+lazy_static = { version = "1", optional = true, default-features = false }
 sha2 = { version = "0.8", default-features = false }
-tiny-bip39 = { version = "0.6", default-features = false, optional = true }
+pbkdf2 = { version = "0.3", optional = true, default-features = false }
 
 [dependencies.subtle-encoding]
 version = "0.4"
@@ -41,7 +42,7 @@ path = "../zeroize"
 default = ["alloc", "bech32", "getrandom"]
 alloc = ["zeroize/alloc"]
 bech32 = ["alloc", "subtle-encoding/bech32-preview"]
-mnemonic = ["alloc", "tiny-bip39"]
+mnemonic = ["alloc", "getrandom", "lazy_static", "pbkdf2"]
 
 [package.metadata.docs.rs]
 all-features = true

hkd32/Cargo.toml

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-2018 Stephen Oliver
+Copyright (c) 2019 iqlusion
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

hkd32/LICENSE-MIT

@@ -4,7 +4,7 @@
 [![Crate][crate-image]][crate-link]
 [![Docs][docs-image]][docs-link]
 [![Apache 2.0 Licensed][license-image]][license-link]
-![Rust 1.36+][rustc-image]
+![MSRV][rustc-image]
 [![Build Status][build-image]][build-link]
 [![Gitter Chat][gitter-image]][gitter-link]
 
@@ -26,17 +26,14 @@ an initial 32-bytes of input key material.
 
 Copyright © 2019 iqlusion
 
-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
+Includes code from the `bip39` crate. Copyright © 2017-2018 Stephen Oliver,
+with contributions by Maciej Hirsz.
 
-    https://www.apache.org/licenses/LICENSE-2.0
+**hkd32** is distributed under the terms of either the MIT license
+or the Apache License (Version 2.0), at your option.
 
-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.
+See [LICENSE] (Apache License, Version 2.0) file in the `iqlusioninc/crates`
+toplevel directory of this repository or [LICENSE-MIT] for details.
 
 ## Contribution
 
@@ -62,3 +59,5 @@ without any additional terms or conditions.
 
 [bip32]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki
 [bip39]: https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki
+[LICENSE]: https://github.com/iqlusioninc/crates/blob/develop/LICENSE
+[LICENSE-MIT]: https://github.com/iqlusioninc/crates/blob/develop/hkd32/LICENSE-MIT

hkd32/README.md

@@ -127,12 +127,6 @@ impl KeyMaterial {
         let b32 = Bech32::default().encode(hrp, self.as_bytes());
         Zeroizing::new(b32)
     }
-
-    /// Serialize this `KeyMaterial` as a BIP39 mnemonic phrase
-    #[cfg(feature = "mnemonic")]
-    pub fn to_mnemonic(&self, language: mnemonic::Language) -> mnemonic::Phrase {
-        mnemonic::Phrase::from_key_material(self, language)
-    }
 }
 
 impl From<[u8; KEY_SIZE]> for KeyMaterial {

hkd32/src/key_material.rs

@@ -41,7 +41,7 @@
 #![doc(html_root_url = "https://docs.rs/hkd32/0.1.2")]
 
 #[cfg(feature = "alloc")]
-#[cfg_attr(test, macro_use)]
+#[cfg_attr(any(feature = "mnemonic", test), macro_use)]
 extern crate alloc;
 
 mod key_material;

hkd32/src/lib.rs

@@ -1,107 +1,13 @@
-//! Support for BIP39 mnemonics.
+//! Support for BIP39 mnemonic phrases.
 //!
 //! These enable deriving `hkd32::KeyMaterial` from a 24-word BIP39 phrase.
+//!
+//! Adapted from the `bip39` crate.
+//! Copyright © 2017-2018 Stephen Oliver with contributions by Maciej Hirsz.
 
-use crate::{Error, KeyMaterial};
-use alloc::string::String;
-use zeroize::Zeroize;
-
-/// Number of words required for an HKD32-compatible mnemonic phrase
-pub const WORD_COUNT: usize = 24;
-
-/// Supported languages.
-///
-/// Presently only English is specified by the BIP39 standard
-#[derive(Copy, Clone, Debug)]
-pub enum Language {
-    /// English is presently the only supported language
-    English,
-}
-
-impl Default for Language {
-    fn default() -> Language {
-        Language::English
-    }
-}
-
-impl From<Language> for bip39::Language {
-    fn from(language: Language) -> bip39::Language {
-        match language {
-            Language::English => bip39::Language::English,
-        }
-    }
-}
-
-/// 24-word BIP39 Mnemonic phrase
-pub struct Phrase {
-    /// String value containing the phrase
-    string: String,
-
-    /// Associated language for this phrase
-    language: Language,
-}
-
-impl Phrase {
-    /// Create a random BIP39 mnemonic phrase.
-    pub fn random(language: Language) -> Self {
-        Self::from_key_material(&KeyMaterial::random(), language)
-    }
-
-    /// Create a new BIP39 mnemonic phrase from the given string.
-    ///
-    /// Must be a valid 24-word BIP39 mnemonic.
-    pub fn new<S>(phrase: S, language: Language) -> Result<Phrase, Error>
-    where
-        S: AsRef<str>,
-    {
-        let phrase = phrase.as_ref();
-
-        if bip39::Mnemonic::validate(phrase, language.into()).is_err() {
-            return Err(Error);
-        }
-
-        if phrase.split(' ').count() != WORD_COUNT {
-            return Err(Error);
-        }
-
-        Ok(Phrase {
-            string: phrase.into(),
-            language,
-        })
-    }
-
-    /// Create a new BIP39 mnemonic phrase from the given `KeyMaterial`
-    pub(crate) fn from_key_material(key_material: &KeyMaterial, language: Language) -> Self {
-        let mnemonic =
-            bip39::Mnemonic::from_entropy(key_material.as_bytes(), language.into()).unwrap();
-
-        Phrase {
-            string: mnemonic.into_phrase(),
-            language,
-        }
-    }
-
-    /// Borrow this mnemonic phrase as a string.
-    pub fn as_str(&self) -> &str {
-        self.string.as_ref()
-    }
-
-    /// Language this phrase's wordlist is for
-    pub fn language(&self) -> Language {
-        self.language
-    }
-}
-
-impl Drop for Phrase {
-    fn drop(&mut self) {
-        self.string.zeroize();
-    }
-}
+mod bits;
+mod language;
+mod phrase;
+mod seed;
 
-impl From<Phrase> for KeyMaterial {
-    fn from(phrase: Phrase) -> KeyMaterial {
-        let mnemonic =
-            bip39::Mnemonic::from_phrase(&phrase.string, phrase.language.into()).unwrap();
-        Self::from_bytes(mnemonic.entropy()).unwrap()
-    }
-}
+pub use self::{language::Language, phrase::Phrase, seed::Seed};