mirror of
https://github.com/0glabs/0g-storage-node.git
synced 2025-11-04 08:37:27 +00:00
109 lines
3.4 KiB
Rust
109 lines
3.4 KiB
Rust
//! This module provides the [`EnrKey`] and [`EnrPublicKey`] traits. User's wishing to implement their
|
|
//! own signing schemes can implement these traits and apply them to a [`Enr`].
|
|
//!
|
|
//! [`EnrKey`]: crate::EnrKey
|
|
//! [`EnrPublicKey`]: crate::EnrPublicKey
|
|
//! [`Enr`]: crate::Enr
|
|
|
|
#[cfg(all(feature = "ed25519", feature = "k256"))]
|
|
mod combined;
|
|
#[cfg(feature = "ed25519")]
|
|
mod ed25519;
|
|
#[cfg(any(feature = "k256"))]
|
|
mod k256_key;
|
|
#[cfg(feature = "rust-secp256k1")]
|
|
mod rust_secp256k1;
|
|
|
|
#[cfg(all(feature = "ed25519", feature = "k256"))]
|
|
pub use combined::{CombinedKey, CombinedPublicKey};
|
|
#[cfg(feature = "ed25519")]
|
|
pub use ed25519_dalek;
|
|
#[cfg(any(feature = "k256"))]
|
|
pub use k256;
|
|
#[cfg(feature = "rust-secp256k1")]
|
|
pub use secp256k1;
|
|
|
|
use crate::Key;
|
|
use bytes::Bytes;
|
|
use rlp::DecoderError;
|
|
use std::{
|
|
collections::BTreeMap,
|
|
error::Error,
|
|
fmt::{self, Debug, Display},
|
|
};
|
|
|
|
/// The trait required for a key to sign and modify an ENR record.
|
|
pub trait EnrKey: Send + Sync + Unpin + 'static {
|
|
type PublicKey: EnrPublicKey + Clone;
|
|
|
|
/// Performs ENR-specific signing for the `v4` identity scheme.
|
|
fn sign_v4(&self, msg: &[u8]) -> Result<Vec<u8>, SigningError>;
|
|
|
|
/// Returns the public key associated with current key pair.
|
|
fn public(&self) -> Self::PublicKey;
|
|
|
|
/// Provides a method to decode a raw public key from an ENR `BTreeMap` to a usable public key.
|
|
///
|
|
/// This method allows a key type to decode the raw bytes in an ENR to a usable
|
|
/// `EnrPublicKey`. It takes the ENR's `BTreeMap` and returns a public key.
|
|
///
|
|
/// Note: This specifies the supported key schemes for an ENR.
|
|
fn enr_to_public(content: &BTreeMap<Key, Bytes>) -> Result<Self::PublicKey, DecoderError>;
|
|
}
|
|
|
|
/// Trait for keys that are uniquely represented
|
|
pub trait EnrKeyUnambiguous: EnrKey {
|
|
/// Decode raw bytes as corresponding public key.
|
|
fn decode_public(bytes: &[u8]) -> Result<Self::PublicKey, DecoderError>;
|
|
}
|
|
|
|
/// The trait required for a `PublicKey` to verify an ENR record.
|
|
pub trait EnrPublicKey: Clone + Debug + Send + Sync + Unpin + 'static {
|
|
type Raw: AsRef<[u8]>;
|
|
type RawUncompressed: AsRef<[u8]>;
|
|
|
|
/// Verify an ENR signature for the `v4` identity scheme.
|
|
fn verify_v4(&self, msg: &[u8], sig: &[u8]) -> bool;
|
|
|
|
/// Encodes the public key to bytes in compressed form, if possible.
|
|
fn encode(&self) -> Self::Raw;
|
|
|
|
/// Encodes the public key in uncompressed form.
|
|
// For compatible keys, encode in uncompressed form. Necessary for generating the node-id
|
|
fn encode_uncompressed(&self) -> Self::RawUncompressed;
|
|
|
|
/// Returns the ENR key identifier for the public key type. For `secp256k1` keys this
|
|
/// is `secp256k1`.
|
|
fn enr_key(&self) -> Key;
|
|
}
|
|
|
|
/// An error during signing of a message.
|
|
#[derive(Debug)]
|
|
pub struct SigningError {
|
|
msg: String,
|
|
source: Option<Box<dyn Error + Send + Sync>>,
|
|
}
|
|
|
|
/// An error during encoding of key material.
|
|
#[allow(dead_code)]
|
|
impl SigningError {
|
|
pub(crate) fn new<S: Display>(msg: S) -> Self {
|
|
Self {
|
|
msg: msg.to_string(),
|
|
source: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl fmt::Display for SigningError {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
write!(f, "Key signing error: {}", self.msg)
|
|
}
|
|
}
|
|
|
|
impl Error for SigningError {
|
|
fn source(&self) -> Option<&(dyn Error + 'static)> {
|
|
self.source.as_ref().map(|s| &**s as &dyn Error)
|
|
}
|
|
}
|