sskr 0.5.0

Sharded Secret Key Reconstruction (SSKR) for Rust.
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

use crate::{SSKRError, MIN_SECRET_LEN, MAX_SECRET_LEN};

/// A secret to be split into shares.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Secret(Vec<u8>);

impl Secret {
    /// Creates a new `Secret` instance with the given data.
    ///
    /// # Arguments
    ///
    /// * `data` - The secret data to be split into shares.
    ///
    /// # Errors
    ///
    /// Returns an error if the length of the secret is less than `MIN_SECRET_LEN`, greater than `MAX_SECRET_LEN`,
    /// or not even.
    pub fn new<T>(data: T) -> Result<Self, SSKRError>
    where
        T: AsRef<[u8]>,
    {
        let data = data.as_ref();
        let len = data.len();
        if len < MIN_SECRET_LEN {
            return Err(SSKRError::SecretTooShort);
        }
        if len > MAX_SECRET_LEN {
            return Err(SSKRError::SecretTooLong);
        }
        if len & 1 != 0 {
            return Err(SSKRError::SecretLengthNotEven);
        }
        Ok(Self(data.to_vec()))
    }

    /// Returns the length of the secret.
    pub fn len(&self) -> usize {
        self.0.len()
    }

    /// Returns `true` if the secret is empty.
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// Returns a reference to the secret data.
    pub fn data(&self) -> &[u8] {
        &self.0
    }
}

impl AsRef<[u8]> for Secret {
    /// Returns a reference to the secret data.
    fn as_ref(&self) -> &[u8] {
        &self.0
    }
}