walleth 0.1.0

A (WIP) Rust library for easily create, manage, use and protect Ethereum accounts.
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

use crate::{ChaCha20Poly1305Cipher, CipherKey};

/// A safe is a container for encrypted data.
/// It holds some metadata and encrypted bytes.
///
/// The metadata is not encrypted and can be used to
/// store information about the encrypted data.
///
/// The encrypted bytes are encrypted and can be used
/// to store sensitive information.
///
/// # Example
///
/// ```
/// use walleth::Safe;
///
/// let safe = Safe::new("metadata", &[0, 1, 2, 3]);
///
/// assert_eq!(safe.metadata, "metadata");
/// assert_eq!(safe.get_bytes(), &[0, 1, 2, 3]);
///
/// let safe = Safe::from_plain_bytes("metadata", &[0, 32], &[0, 1, 2, 3, 4]).unwrap();
///
/// assert_eq!(safe.metadata, "metadata");
/// assert_eq!(safe.get_bytes(), &[0, 1, 2, 3]);
#[derive(Clone)]
pub struct Safe<T> {
	pub metadata: T,
	encrypted_bytes: Box<[u8]>,
	nonce: [u8; 24],
}

impl<T> Safe<T> {
	/// Create a new safe from unencrypted data
	/// Returns a Safe
	///
	/// # Example
	///
	/// ```
	/// use walleth::{Safe, Cipher};
	///
  /// let safe = Safe::from_plain_bytes("metadata", &[0, 32], &[0, 1, 2, 3, 4]).unwrap();
  /// 
  /// assert_eq!(safe.metadata, "metadata");
  /// assert_eq!(safe.get_bytes(), &[0, 1, 2, 3, 4]);
  /// ```
	pub fn from_plain_bytes(
		metadata: T,
		key: &CipherKey,
		plain_bytes: &[u8],
	) -> Result<Self, String> {
		let (encrypted_bytes, nonce) = ChaCha20Poly1305Cipher::encrypt(&key, &plain_bytes)?;

		Ok(Safe {
			metadata,
			encrypted_bytes: encrypted_bytes.into_boxed_slice(),
			nonce,
		})
	}

  /// Decrypt the safe with a key. Returns the decrypted bytes.
  /// 
  /// # Example
  /// 
  /// ```
  /// use walleth::{Safe, Cipher};
  /// 
  /// let safe = Safe::from_plain_bytes("metadata", &[0, 32], &[0, 1, 2, 3, 4]).unwrap();
  /// 
  /// let decrypted_bytes = safe.decrypt(&[0, 32]).unwrap();
  /// ```
	pub fn decrypt(&self, key: &CipherKey) -> Result<Vec<u8>, String>	{
		Ok(ChaCha20Poly1305Cipher::decrypt(&key, &self.nonce, &self.encrypted_bytes)?)
	}

	/// Get the encrypted bytes
	pub fn get_bytes(&self) -> &[u8] {
		&self.encrypted_bytes
	}
}