bip0032 0.1.0

Another Rust implementation of BIP-0032 standard
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

//! Curve abstractions and specific curve implementations.

use crate::error::IntoErrorSource;

/// Curve parameters for HD derivation.
pub trait Curve {
    /// HMAC key for master key derivation.
    const HMAC_KEY: &'static [u8];

    /// Curve public key type.
    type PublicKey: CurvePublicKey;
    /// Curve private key type.
    type PrivateKey: CurvePrivateKey<PublicKey = Self::PublicKey>;
}

/// Public key capabilities for a curve.
pub trait CurvePublicKey: Clone {
    /// Backend-specific error type.
    type Error: IntoErrorSource + Send + Sync + 'static;
    /// Serialized key representation.
    type Bytes: AsRef<[u8]> + Clone;

    /// Parses a public key from bytes.
    fn from_bytes(bytes: &Self::Bytes) -> Result<Self, Self::Error>;

    /// Serializes a public key to bytes.
    fn to_bytes(&self) -> Self::Bytes;
}

/// Private key capabilities for a curve.
pub trait CurvePrivateKey: Clone {
    /// Backend-specific error type.
    type Error: IntoErrorSource + Send + Sync + 'static;
    /// Corresponding public key type.
    type PublicKey: CurvePublicKey<Error = Self::Error>;
    /// Serialized key representation.
    type Bytes: AsRef<[u8]> + Clone;

    /// Parses a private key from bytes.
    fn from_bytes(bytes: &Self::Bytes) -> Result<Self, Self::Error>;

    /// Serializes a private key to bytes.
    fn to_bytes(&self) -> Self::Bytes;

    /// Returns the corresponding public key.
    fn to_public(&self) -> Self::PublicKey;

    /// Zeroizes this private key if possible.
    fn zeroize(&mut self) {}
}

/// Keys that support tweak addition.
pub trait TweakableKey: Sized {
    /// Backend-specific error type.
    type Error: IntoErrorSource + Send + Sync + 'static;

    /// Returns a tweaked key.
    fn add_tweak(&self, tweak: &[u8; 32]) -> Result<Self, Self::Error>;
}

/// Marker trait for BIP32-encodable curves.
pub trait Bip32Curve: Curve {}

mod error;
#[cfg(feature = "slip10")]
mod slip10;

pub use self::error::CurveError;
#[cfg(feature = "slip10")]
pub use self::slip10::*;

#[cfg(feature = "slip10")]
pub mod ed25519;
#[cfg(feature = "slip10")]
pub mod nist256p1;
pub mod secp256k1;