ssh_key/public/
ed25519.rs

1//! Ed25519 public keys.
2//!
3//! Edwards Digital Signature Algorithm (EdDSA) over Curve25519.
4
5use crate::{
6    checked::CheckedSum, decode::Decode, encode::Encode, reader::Reader, writer::Writer, Error,
7    Result,
8};
9use core::fmt;
10
11/// Ed25519 public key.
12// TODO(tarcieri): use `ed25519::PublicKey`? (doesn't exist yet)
13#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
14pub struct Ed25519PublicKey(pub [u8; Self::BYTE_SIZE]);
15
16impl Ed25519PublicKey {
17    /// Size of an Ed25519 public key in bytes.
18    pub const BYTE_SIZE: usize = 32;
19}
20
21impl AsRef<[u8; Self::BYTE_SIZE]> for Ed25519PublicKey {
22    fn as_ref(&self) -> &[u8; Self::BYTE_SIZE] {
23        &self.0
24    }
25}
26
27impl Decode for Ed25519PublicKey {
28    fn decode(reader: &mut impl Reader) -> Result<Self> {
29        let mut bytes = [0u8; Self::BYTE_SIZE];
30        reader.read_nested(|reader| reader.read(&mut bytes))?;
31        Ok(Self(bytes))
32    }
33}
34
35impl Encode for Ed25519PublicKey {
36    fn encoded_len(&self) -> Result<usize> {
37        [4, Self::BYTE_SIZE].checked_sum()
38    }
39
40    fn encode(&self, writer: &mut impl Writer) -> Result<()> {
41        self.0.encode(writer)
42    }
43}
44
45impl TryFrom<&[u8]> for Ed25519PublicKey {
46    type Error = Error;
47
48    fn try_from(bytes: &[u8]) -> Result<Self> {
49        Ok(Self(bytes.try_into()?))
50    }
51}
52
53impl fmt::Display for Ed25519PublicKey {
54    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
55        write!(f, "{:X}", self)
56    }
57}
58
59impl fmt::LowerHex for Ed25519PublicKey {
60    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
61        for byte in self.as_ref() {
62            write!(f, "{:02x}", byte)?;
63        }
64        Ok(())
65    }
66}
67
68impl fmt::UpperHex for Ed25519PublicKey {
69    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
70        for byte in self.as_ref() {
71            write!(f, "{:02X}", byte)?;
72        }
73        Ok(())
74    }
75}
76
77#[cfg(feature = "ed25519")]
78#[cfg_attr(docsrs, doc(cfg(feature = "ed25519")))]
79impl TryFrom<Ed25519PublicKey> for ed25519_dalek::PublicKey {
80    type Error = Error;
81
82    fn try_from(key: Ed25519PublicKey) -> Result<ed25519_dalek::PublicKey> {
83        ed25519_dalek::PublicKey::try_from(&key)
84    }
85}
86
87#[cfg(feature = "ed25519")]
88#[cfg_attr(docsrs, doc(cfg(feature = "ed25519")))]
89impl TryFrom<&Ed25519PublicKey> for ed25519_dalek::PublicKey {
90    type Error = Error;
91
92    fn try_from(key: &Ed25519PublicKey) -> Result<ed25519_dalek::PublicKey> {
93        ed25519_dalek::PublicKey::from_bytes(key.as_ref()).map_err(|_| Error::Crypto)
94    }
95}
96
97#[cfg(feature = "ed25519")]
98#[cfg_attr(docsrs, doc(cfg(feature = "ed25519")))]
99impl From<ed25519_dalek::PublicKey> for Ed25519PublicKey {
100    fn from(key: ed25519_dalek::PublicKey) -> Ed25519PublicKey {
101        Ed25519PublicKey::from(&key)
102    }
103}
104
105#[cfg(feature = "ed25519")]
106#[cfg_attr(docsrs, doc(cfg(feature = "ed25519")))]
107impl From<&ed25519_dalek::PublicKey> for Ed25519PublicKey {
108    fn from(key: &ed25519_dalek::PublicKey) -> Ed25519PublicKey {
109        Ed25519PublicKey(key.to_bytes())
110    }
111}