generic-ec 0.5.0

General elliptic curve cryptography
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

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(all())))]
mod with_alloc {
    use alloc::sync::Arc;
    use zeroize::{Zeroize, Zeroizing};

    use crate::{Curve, Scalar};

    #[doc = include_str!("docs.md")]
    pub struct SecretScalar<E: Curve>(Arc<Zeroizing<Scalar<E>>>);

    impl<E: Curve> SecretScalar<E> {
        #[doc = include_str!("docs-constructor.md")]
        pub fn new(scalar: &mut Scalar<E>) -> Self {
            let mut scalar_on_heap = Arc::<Zeroizing<Scalar<E>>>::default();
            let scalar_mut = Arc::make_mut(&mut scalar_on_heap);
            core::mem::swap(&mut **scalar_mut, scalar);
            scalar.zeroize();
            Self(scalar_on_heap)
        }
    }

    impl<E: Curve> AsRef<Scalar<E>> for SecretScalar<E> {
        fn as_ref(&self) -> &Scalar<E> {
            &self.0
        }
    }

    impl<E: Curve> Clone for SecretScalar<E> {
        fn clone(&self) -> Self {
            Self(self.0.clone())
        }
    }
}

#[cfg(not(feature = "alloc"))]
#[cfg_attr(docsrs, doc(cfg(all())))]
mod without_alloc {
    use zeroize::{Zeroize, Zeroizing};

    use crate::{Curve, Scalar};

    #[doc = include_str!("docs.md")]
    pub struct SecretScalar<E: Curve>(Zeroizing<Scalar<E>>);

    impl<E: Curve> SecretScalar<E> {
        #[doc = include_str!("docs-constructor.md")]
        pub fn new(scalar: &mut Scalar<E>) -> Self {
            let scalar_new = Self(Zeroizing::new(*scalar));
            scalar.zeroize();
            scalar_new
        }
    }

    impl<E: Curve> AsRef<Scalar<E>> for SecretScalar<E> {
        fn as_ref(&self) -> &Scalar<E> {
            &self.0
        }
    }

    impl<E: Curve> Clone for SecretScalar<E> {
        fn clone(&self) -> Self {
            Self(self.0.clone())
        }
    }
}

mod secret_scalar {
    #[cfg(feature = "alloc")]
    #[cfg_attr(docsrs, doc(cfg(all())))]
    pub use super::with_alloc::SecretScalar;
    #[cfg(not(feature = "alloc"))]
    #[cfg_attr(docsrs, doc(cfg(all())))]
    pub use super::without_alloc::SecretScalar;
}

pub use self::secret_scalar::SecretScalar;