bp-wallet 0.12.0-rc.2

Modern, minimalistic & standard-compliant bitcoin wallet
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

// Modern, minimalistic & standard-compliant hot wallet library.
//
// SPDX-License-Identifier: Apache-2.0
//
// Written in 2020-2024 by
//     Dr Maxim Orlovsky <orlovsky@lnp-bp.org>
//
// Copyright (C) 2020-2024 LNP/BP Standards Association. All rights reserved.
// Copyright (C) 2020-2024 Dr Maxim Orlovsky. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

mod seed;
#[cfg(feature = "cli")]
mod command;
#[cfg(feature = "cli")]
pub mod signer;
mod password;

#[cfg(feature = "cli")]
pub use command::{HotArgs, HotCommand};
pub use io::{decrypt, encrypt, DataError, SecureIo};
pub use password::calculate_entropy;
pub use seed::{Seed, SeedType};

mod io {
    use std::io;
    use std::path::Path;

    use aes_gcm::aead::{Aead, Nonce, OsRng};
    use aes_gcm::{AeadCore, Aes256Gcm, KeyInit};
    use amplify::IoError;
    use psbt::{PsbtError, SignError};
    use sha2::{Digest, Sha256};

    pub fn encrypt(source: Vec<u8>, key: impl AsRef<[u8]>) -> Vec<u8> {
        let key = Sha256::digest(key.as_ref());
        let key = aes_gcm::Key::<Aes256Gcm>::from_slice(key.as_slice());

        let nonce = Aes256Gcm::generate_nonce(&mut OsRng);
        let cipher = Aes256Gcm::new(key);

        let ciphered_data = cipher.encrypt(&nonce, source.as_ref()).expect("failed to encrypt");
        debug_assert_eq!(Aes256Gcm::new(key).decrypt(&nonce, &ciphered_data[..]), Ok(source));

        let mut data = nonce.to_vec();
        data.extend(ciphered_data);
        data
    }

    pub fn decrypt(encrypted: &[u8], key: impl AsRef<[u8]>) -> Result<Vec<u8>, aes_gcm::Error> {
        let key = Sha256::digest(key.as_ref());
        let key = aes_gcm::Key::<Aes256Gcm>::from_slice(key.as_slice());
        let nonce = Nonce::<Aes256Gcm>::from_slice(&encrypted[..12]);
        Aes256Gcm::new(key).decrypt(nonce, &encrypted[12..])
    }

    #[derive(Clone, Eq, PartialEq, Debug, Display, Error, From)]
    #[display(inner)]
    pub enum DataError {
        #[from]
        #[from(io::Error)]
        Io(IoError),

        #[display("invalid seed password.")]
        SeedPassword,

        #[display("invalid account key password.")]
        AccountPassword,

        #[from]
        Psbt(PsbtError),

        #[from]
        Sign(SignError),
    }

    pub trait SecureIo {
        fn read<P>(file: P, password: &str) -> Result<Self, DataError>
        where
            P: AsRef<Path>,
            Self: Sized;

        fn write<P>(&self, file: P, password: &str) -> io::Result<()>
        where P: AsRef<Path>;
    }
}