willow25 0.4.0

A ready-to-use implementation of the Willow specifications.
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

use core::fmt;

#[cfg(feature = "dev")]
use arbitrary::Arbitrary;

use ed25519_dalek::Signature;

use ufotofu::codec_prelude::*;

wrapper! {
    /// A secure digital signature, issued by a [`SubspaceSecret`](crate::prelude::SubspaceSecret) and verifiable with the corresponding [`SubspaceId`](crate::prelude::SubspaceId).
    ///
    /// This type is a fairly thin wrapper around [`ed25519_dalek::Signature`], use the [`From`] implementations to convert between the two.
    ///
    /// Chances are you never need to interact with this type directly, the [`meadowcap`] module should handle all authentication needs for you.
    #[derive(PartialEq, Eq, Clone)]
    SubspaceSignature; Signature
}

impl fmt::Debug for SubspaceSignature {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl From<[u8; Signature::BYTE_SIZE]> for SubspaceSignature {
    fn from(value: [u8; Signature::BYTE_SIZE]) -> Self {
        Self(Signature::from(value))
    }
}

#[cfg(feature = "dev")]
impl<'a> Arbitrary<'a> for SubspaceSignature {
    fn arbitrary(u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result<Self> {
        Ok(Self(Signature::from_bytes(&Arbitrary::arbitrary(u)?)))
    }
}

/// Implements the identity function (an ed25519 signature is already a byte string).
impl Encodable for SubspaceSignature {
    async fn encode<C>(&self, consumer: &mut C) -> Result<(), C::Error>
    where
        C: BulkConsumer<Item = u8> + ?Sized,
    {
        consumer
            .consume_full_slice(&self.0.to_bytes())
            .await
            .map_err(|err| err.reason)
    }
}

/// Implements the identity function (an ed25519 signature is already a byte string).
impl EncodableKnownLength for SubspaceSignature {
    fn len_of_encoding(&self) -> usize {
        Signature::BYTE_SIZE
    }
}

/// Implements the identity function (an ed25519 signature is already a byte string).
impl Decodable for SubspaceSignature {
    type ErrorReason = Infallible;

    async fn decode<P>(
        producer: &mut P,
    ) -> Result<Self, DecodeError<P::Final, P::Error, Self::ErrorReason>>
    where
        P: BulkProducer<Item = u8> + ?Sized,
        Self: Sized,
    {
        let mut buf = [0; Signature::BYTE_SIZE];
        producer.overwrite_full_slice(&mut buf).await?;
        Ok(Self(Signature::from_bytes(&buf)))
    }
}

/// Implements the identity function (an ed25519 signature is already a byte string).
impl DecodableCanonic for SubspaceSignature {
    type ErrorCanonic = Infallible;

    async fn decode_canonic<P>(
        producer: &mut P,
    ) -> Result<Self, DecodeError<P::Final, P::Error, Self::ErrorCanonic>>
    where
        P: BulkProducer<Item = u8> + ?Sized,
        Self: Sized,
    {
        Self::decode(producer).await
    }
}