smoldot 1.1.0

// Smoldot
// Copyright (C) 2019-2022  Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

use alloc::{string::String, vec, vec::Vec};
use core::{cmp, fmt, hash, str::FromStr};

use super::multihash;
use crate::util::protobuf;

/// Public key of a node's identity.
///
/// Libp2p specifies multiple different possible algorithms, but only Ed25519 support is
/// mandatory.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum PublicKey {
    /// An Ed25519 public key.
    Ed25519([u8; 32]),
}

impl PublicKey {
    /// Encode the public key into a Protobuf structure for exchange with other nodes.
    ///
    /// As indicated in the libp2p specification, the encoding is done deterministically despite
    /// the fact that the Protobuf format isn't deterministic.
    ///
    /// See <https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#keys>.
    pub fn to_protobuf_encoding(&self) -> Vec<u8> {
        match self {
            PublicKey::Ed25519(key) => {
                const CAPACITY: usize = 32 + 4;
                let mut out = Vec::with_capacity(CAPACITY);
                for slice in protobuf::enum_tag_encode(1, 1) {
                    out.extend_from_slice(slice.as_ref());
                }
                for slice in protobuf::bytes_tag_encode(2, key) {
                    out.extend_from_slice(slice.as_ref());
                }
                debug_assert_eq!(out.len(), CAPACITY);
                out
            }
        }
    }

    /// Decode a public key from a Protobuf structure, e.g. read from storage or received from
    /// another node.
    pub fn from_protobuf_encoding(bytes: &[u8]) -> Result<PublicKey, FromProtobufEncodingError> {
        struct ErrorWrapper(FromProtobufEncodingError);
        impl<'a> nom::error::ParseError<&'a [u8]> for ErrorWrapper {
            fn from_error_kind(_: &'a [u8], _: nom::error::ErrorKind) -> Self {
                ErrorWrapper(FromProtobufEncodingError::ProtobufDecodeError)
            }
            fn append(_: &'a [u8], _: nom::error::ErrorKind, other: Self) -> Self {
                other
            }
        }
        impl<'a> nom::error::FromExternalError<&'a [u8], FromProtobufEncodingError> for ErrorWrapper {
            fn from_external_error(
                _: &'a [u8],
                _: nom::error::ErrorKind,
                e: FromProtobufEncodingError,
            ) -> Self {
                ErrorWrapper(e)
            }
        }

        // As indicated in the libp2p specification, the public key must be encoded
        // deterministically, and thus the fields are decoded deterministically in a precise order.
        let mut parser =
            nom::combinator::all_consuming::<_, ErrorWrapper, _>(nom::combinator::complete((
                nom::sequence::preceded(
                    nom::combinator::peek(nom::combinator::verify(
                        protobuf::tag_decode,
                        |(field_num, _)| *field_num == 1,
                    )),
                    nom::combinator::map_res(protobuf::enum_tag_decode, |val| match val {
                        0..=3 => Ok(val),
                        _ => Err(FromProtobufEncodingError::UnknownAlgorithm),
                    }),
                ),
                nom::sequence::preceded(
                    nom::combinator::peek(nom::combinator::verify(
                        protobuf::tag_decode,
                        |(field_num, _)| *field_num == 2,
                    )),
                    nom::combinator::map_res(protobuf::bytes_tag_decode, |d| {
                        <[u8; 32]>::try_from(d)
                            .map_err(|_| FromProtobufEncodingError::BadEd25519Key)
                    }),
                ),
            )));

        match nom::Finish::finish(nom::Parser::parse(&mut parser, bytes)) {
            Ok((_, (1, key))) => Ok(PublicKey::Ed25519(key)),
            Ok((_, (_, _))) => Err(FromProtobufEncodingError::UnsupportedAlgorithm),
            Err(err) => Err(err.0),
        }
    }

    /// Convert the [`PublicKey`] into the corresponding [`PeerId`].
    pub fn into_peer_id(self) -> PeerId {
        self.into()
    }

    /// Verifies whether the given signature is valid for the given message using `self` as the
    /// public key.
    pub fn verify(&self, message: &[u8], signature: &[u8]) -> Result<(), SignatureVerifyFailed> {
        let PublicKey::Ed25519(public_key) = self;
        let public_key = ed25519_zebra::VerificationKey::try_from(*public_key)
            .map_err(|_| SignatureVerifyFailed())?;
        let signature =
            ed25519_zebra::Signature::try_from(signature).map_err(|_| SignatureVerifyFailed())?;
        public_key
            .verify(&signature, message)
            .map_err(|_| SignatureVerifyFailed())?;
        Ok(())
    }
}

/// Error potentially returned by [`PublicKey::from_protobuf_encoding`].
#[derive(Debug, derive_more::Display, derive_more::Error)]
pub enum FromProtobufEncodingError {
    /// Error decoding the Protobuf message.
    ProtobufDecodeError,
    /// Public key algorithm unknown.
    UnknownAlgorithm,
    /// Ed25519 key doesn't have a correct length.
    BadEd25519Key,
    /// Algorithms other than Ed25519 aren't supported.
    UnsupportedAlgorithm,
}

/// Call to [`PublicKey::verify`] has failed. No reason is provided for security reasons.
#[derive(Debug, derive_more::Display, derive_more::Error)]
pub struct SignatureVerifyFailed();

/// Public keys with byte-lengths smaller than `MAX_INLINE_KEY_LENGTH` will be
/// automatically used as the peer id using an identity multihash.
const MAX_INLINE_KEY_LENGTH: usize = 42;

/// Identifier of a node of the network.
///
/// The data is a multihash of the public key of the peer.
#[derive(Clone, Eq)]
pub struct PeerId {
    /// Always contains a valid multihash.
    multihash: Vec<u8>,
}

impl PeerId {
    /// Builds the [`PeerId`] corresponding to a public key.
    pub fn from_public_key(key: &PublicKey) -> PeerId {
        let key_enc = key.to_protobuf_encoding();

        let out = if key_enc.len() <= MAX_INLINE_KEY_LENGTH {
            multihash::Multihash::identity(&key_enc).into_bytes()
        } else {
            let mut out = vec![0; 34];
            out[0] = 0x12;
            out[1] = 0x32;

            let mut hasher = <sha2::Sha256 as sha2::Digest>::new();
            sha2::Digest::update(&mut hasher, &key_enc);
            sha2::Digest::finalize_into(
                hasher,
                sha2::digest::generic_array::GenericArray::from_mut_slice(&mut out[2..]),
            );

            out
        };

        PeerId { multihash: out }
    }

    /// Checks whether `data` is a valid [`PeerId`].
    ///
    /// In case of error, returns the bytes passed as parameter in addition to the error.
    pub fn from_bytes(data: Vec<u8>) -> Result<PeerId, (FromBytesError, Vec<u8>)> {
        let result = match multihash::Multihash::from_bytes(&data) {
            Ok(hash) => {
                // For a PeerId to be valid, it must use either the "identity" multihash code (0x0)
                // or the "sha256" multihash code (0x12).
                if hash.hash_algorithm_code() == 0 {
                    if let Err(err) = PublicKey::from_protobuf_encoding(hash.data()) {
                        Err(FromBytesError::InvalidPublicKey(err))
                    } else {
                        Ok(())
                    }
                } else if hash.hash_algorithm_code() == 0x12 {
                    Ok(())
                } else {
                    Err(FromBytesError::InvalidMultihashAlgorithm)
                }
            }
            Err((err, _)) => Err(FromBytesError::DecodeError(err)),
        };

        match result {
            Ok(()) => Ok(PeerId { multihash: data }),
            Err(err) => Err((err, data)),
        }
    }

    /// Returns a raw bytes representation of this `PeerId`.
    pub fn into_bytes(self) -> Vec<u8> {
        self.multihash
    }

    /// Returns a raw bytes representation of this `PeerId`.
    pub fn as_bytes(&self) -> &[u8] {
        &self.multihash
    }

    /// Returns a base-58 encoded string of this `PeerId`.
    pub fn to_base58(&self) -> String {
        bs58::encode(self.as_bytes()).into_string()
    }
}

impl<'a> From<&'a PublicKey> for PeerId {
    fn from(public_key: &'a PublicKey) -> PeerId {
        PeerId::from_public_key(public_key)
    }
}

impl From<PublicKey> for PeerId {
    fn from(public_key: PublicKey) -> PeerId {
        PeerId::from_public_key(&public_key)
    }
}

impl fmt::Debug for PeerId {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Display::fmt(self, f)
    }
}

impl fmt::Display for PeerId {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.to_base58().fmt(f)
    }
}

impl cmp::PartialOrd for PeerId {
    fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
        Some(Ord::cmp(self, other))
    }
}

impl cmp::Ord for PeerId {
    fn cmp(&self, other: &Self) -> cmp::Ordering {
        let lhs: &[u8] = self.as_ref();
        let rhs: &[u8] = other.as_ref();
        lhs.cmp(rhs)
    }
}

impl hash::Hash for PeerId {
    fn hash<H>(&self, state: &mut H)
    where
        H: hash::Hasher,
    {
        let digest = self.as_ref() as &[u8];
        hash::Hash::hash(digest, state);
    }
}

impl TryFrom<Vec<u8>> for PeerId {
    type Error = FromBytesError;

    fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
        PeerId::from_bytes(value).map_err(|(err, _)| err)
    }
}

impl PartialEq<PeerId> for PeerId {
    fn eq(&self, other: &PeerId) -> bool {
        let self_digest = self.as_ref() as &[u8];
        let other_digest = other.as_ref() as &[u8];
        self_digest == other_digest
    }
}

impl AsRef<[u8]> for PeerId {
    fn as_ref(&self) -> &[u8] {
        self.as_bytes()
    }
}

impl FromStr for PeerId {
    type Err = ParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let bytes = bs58::decode(s)
            .into_vec()
            .map_err(Bs58DecodeError)
            .map_err(ParseError::Bs58)?;
        PeerId::from_bytes(bytes).map_err(|(err, _)| ParseError::NotPeerId(err))
    }
}

/// Error when turning bytes into a [`PeerId`].
#[derive(Debug, derive_more::Display, derive_more::Error)]
pub enum FromBytesError {
    /// Failed to decode bytes into a multihash.
    DecodeError(multihash::FromBytesError),
    /// The algorithm used in the multihash isn't identity or SHA-256.
    InvalidMultihashAlgorithm,
    /// Multihash uses the identity algorithm, but the data isn't a valid public key.
    #[display("Failed to decode public key protobuf: {_0}")]
    InvalidPublicKey(FromProtobufEncodingError),
}

/// Error when parsing a string to a [`PeerId`].
#[derive(Debug, derive_more::Display, derive_more::Error)]
pub enum ParseError {
    /// Error decoding the Base58 encoding.
    #[display("Base58 decoding error: {_0}")]
    Bs58(Bs58DecodeError),
    /// Decoded bytes aren't a valid [`PeerId`].
    #[display("{_0}")]
    NotPeerId(FromBytesError),
}

/// Error when decoding Base58 encoding.
#[derive(Debug, derive_more::Display, derive_more::Error, derive_more::From)]
#[display("{_0}")]
// TODO: bs58 doesn't implement the Error trait; remove not(source) at some point
pub struct Bs58DecodeError(#[error(not(source))] bs58::decode::Error);

#[cfg(test)]
mod tests {
    #[test]
    fn encode_decode_pubkey() {
        let pub_key = super::PublicKey::Ed25519(rand::random());
        let protobuf = pub_key.to_protobuf_encoding();
        assert_eq!(
            super::PublicKey::from_protobuf_encoding(&protobuf).unwrap(),
            pub_key
        );
    }
}