5 stable releases
1.1.1 | May 15, 2024 |
---|---|
1.1.0 | Jul 26, 2021 |
1.0.2 | Jul 18, 2021 |
1.0.0 | Jul 13, 2021 |
#10 in #32-byte
24 downloads per month
Used in 2 crates
58KB
745 lines
bip38
Rust implementation of bip-0038 to be used as a dependency (crate).
Functionalities
Encrypt and decrypt bitcoin private keys with bip-0038 standard.
This crate can handle bitcoin private keys as raw 32 bytes ([u8; 32]
) and encoded in the wif
format.
Basic examples
Encryption
use bip38::{Encrypt, EncryptWif, Error};
// true => compress
assert_eq!(
[0x11; 32].encrypt("strong_pass", true).unwrap(),
"6PYMgbeR64ypE4g8ZQhGo7ScudV5BLz1vMFUCs49AWpW3jVNWfH6cAdTi2"
);
// false => uncompress
assert_eq!(
[0x11; 32].encrypt("strong_pass", false).unwrap(),
"6PRVo8whLAhpRwSM5tJfmbAbZ9mCxjyZExaTXt6EMSXw3f5QJxMDFQQND2"
);
// [0x00; 32] is an invalid private key and cannot generate a valid bitcoin address
assert_eq!([0x00; 32].encrypt("strong_pass", true), Err(Error::PrvKey));
assert_eq!([0x00; 32].encrypt("strong_pass", false), Err(Error::PrvKey));
// wif
assert_eq!(
"KwntMbt59tTsj8xqpqYqRRWufyjGunvhSyeMo3NTYpFYzZbXJ5Hp".encrypt_wif("strong_pass"),
Ok(String::from("6PYMgbeR64ypE4g8ZQhGo7ScudV5BLz1vMFUCs49AWpW3jVNWfH6cAdTi2"))
);
assert_eq!(
"5HwoXVkHoRM8sL2KmNRS217n1g8mPPBomrY7yehCuXC1115WWsh".encrypt_wif("strong_pass"),
Ok(String::from("6PRVo8whLAhpRwSM5tJfmbAbZ9mCxjyZExaTXt6EMSXw3f5QJxMDFQQND2"))
);
Decryption
use bip38::{Decrypt, Error};
assert_eq!(
"6PYMgbeR64ypE4g8ZQhGo7ScudV5BLz1vMFUCs49AWpW3jVNWfH6cAdTi2".decrypt("strong_pass"),
Ok(([0x11; 32], true)) // compress
);
assert_eq!(
"6PRVo8whLAhpRwSM5tJfmbAbZ9mCxjyZExaTXt6EMSXw3f5QJxMDFQQND2".decrypt("strong_pass"),
Ok(([0x11; 32], false)) // uncompress
);
assert_eq!(
"6PRVo8whLAhpRwSM5tJfmbAbZ9mCxjyZExaTXt6EMSXw3f5QJxMDFQQND2".decrypt("wrong_pass"),
Err(Error::Pass)
);
// wif
assert_eq!(
"6PYMgbeR64ypE4g8ZQhGo7ScudV5BLz1vMFUCs49AWpW3jVNWfH6cAdTi2"
.decrypt_to_wif("strong_pass"),
Ok(String::from("KwntMbt59tTsj8xqpqYqRRWufyjGunvhSyeMo3NTYpFYzZbXJ5Hp"))
);
assert_eq!(
"6PRVo8whLAhpRwSM5tJfmbAbZ9mCxjyZExaTXt6EMSXw3f5QJxMDFQQND2"
.decrypt_to_wif("strong_pass"),
Ok(String::from("5HwoXVkHoRM8sL2KmNRS217n1g8mPPBomrY7yehCuXC1115WWsh"))
);
Generation (elliptic curve multiplication, not deterministic)
use bip38::{Decrypt, Generate};
// true => compress
assert!("passphrase".generate(true).unwrap().starts_with("6Pn"));
// false => uncompress
assert!("passphrase".generate(false).unwrap().starts_with("6Pf"));
// ぽー
assert!("バンドメイド".generate(true).unwrap().decrypt("バンドメイド").is_ok());
Boolean flag
true
always signify: use the public key of this private keycompressed
(33 bytes).false
always signify: use the public key of this private keyuncompressed
(65 bytes).
Obs: the use of uncompressed public keys is deprecated and discouraged. For new private keys always
choose the true
flag.
Normalization
This crate handle the normalization (nfc
) of the passphrase as specified on bip-0038
.
use bip38::{Decrypt, Encrypt};
assert_eq!(
[0xba; 32].encrypt("ΜΟΛΩΝ ΛΑΒΕ", true).unwrap().decrypt("ΜΟΛΩΝ ΛΑΒΕ").unwrap(),
([0xba; 32], true)
);
Testing
Please always run cargo test
with --release
flag. Without the optimizations of a release build
running tests can consume long time (the encryption algorithm is, by design, heavy on cpu).
Usage
You can use this crate in your project by adding the following to your Cargo.toml
:
[dependencies]
bip38 = "1.1.1"
For more details and examples please go to the documentation.
Dependencies
~7MB
~101K SLoC