mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-06-09 16:11:20 +00:00
14938043cf
`Keypair` and `Publickey` are rendered opaque: - `Keypair` is replaced by a private `KeyPairInner` enum that is encapsulated inside the `Keypair` `pub struct` - `Publickey` is replaced by a private `PublickeyInner` enum that is encapsulated inside the `Publickey` `pub struct` Resolves #3860. Pull-Request: #3866.
136 lines
4.5 KiB
Rust
136 lines
4.5 KiB
Rust
// Copyright 2019 Parity Technologies (UK) Ltd.
|
|
// Copyright 2023 Protocol Labs.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
//! A node's network identity keys.
|
|
//!
|
|
//! Such identity keys can be randomly generated on every startup,
|
|
//! but using already existing, fixed keys is usually required.
|
|
//! Though libp2p uses other crates (e.g. `ed25519_dalek`) internally,
|
|
//! such details are not exposed as part of libp2p's public interface
|
|
//! to keep them easily upgradable or replaceable (e.g. to `ed25519_zebra`).
|
|
//! Consequently, keys of external ed25519 or secp256k1 crates cannot be
|
|
//! directly converted into libp2p network identities.
|
|
//! Instead, loading fixed keys must use the standard, thus more portable
|
|
//! binary representation of the specific key type
|
|
//! (e.g. [ed25519 binary format](https://datatracker.ietf.org/doc/html/rfc8032#section-5.1.5)).
|
|
//! All key types have functions to enable conversion to/from their binary representations.
|
|
|
|
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
|
|
|
|
#[cfg(any(
|
|
feature = "ecdsa",
|
|
feature = "secp256k1",
|
|
feature = "ed25519",
|
|
feature = "rsa"
|
|
))]
|
|
mod proto {
|
|
#![allow(unreachable_pub)]
|
|
include!("generated/mod.rs");
|
|
pub(crate) use self::keys_proto::*;
|
|
}
|
|
|
|
#[cfg(feature = "ecdsa")]
|
|
pub mod ecdsa;
|
|
|
|
#[cfg(feature = "ed25519")]
|
|
pub mod ed25519;
|
|
|
|
#[cfg(all(feature = "rsa", not(target_arch = "wasm32")))]
|
|
pub mod rsa;
|
|
|
|
#[cfg(feature = "secp256k1")]
|
|
pub mod secp256k1;
|
|
|
|
mod error;
|
|
mod keypair;
|
|
#[cfg(feature = "peerid")]
|
|
mod peer_id;
|
|
|
|
#[cfg(any(
|
|
feature = "ecdsa",
|
|
feature = "secp256k1",
|
|
feature = "ed25519",
|
|
feature = "rsa"
|
|
))]
|
|
impl zeroize::Zeroize for proto::PrivateKey {
|
|
fn zeroize(&mut self) {
|
|
self.Data.zeroize();
|
|
}
|
|
}
|
|
|
|
#[cfg(any(
|
|
feature = "ecdsa",
|
|
feature = "secp256k1",
|
|
feature = "ed25519",
|
|
feature = "rsa"
|
|
))]
|
|
impl From<&PublicKey> for proto::PublicKey {
|
|
fn from(key: &PublicKey) -> Self {
|
|
match &key.publickey {
|
|
#[cfg(feature = "ed25519")]
|
|
keypair::PublicKeyInner::Ed25519(key) => proto::PublicKey {
|
|
Type: proto::KeyType::Ed25519,
|
|
Data: key.to_bytes().to_vec(),
|
|
},
|
|
#[cfg(all(feature = "rsa", not(target_arch = "wasm32")))]
|
|
keypair::PublicKeyInner::Rsa(key) => proto::PublicKey {
|
|
Type: proto::KeyType::RSA,
|
|
Data: key.encode_x509(),
|
|
},
|
|
#[cfg(feature = "secp256k1")]
|
|
keypair::PublicKeyInner::Secp256k1(key) => proto::PublicKey {
|
|
Type: proto::KeyType::Secp256k1,
|
|
Data: key.to_bytes().to_vec(),
|
|
},
|
|
#[cfg(feature = "ecdsa")]
|
|
keypair::PublicKeyInner::Ecdsa(key) => proto::PublicKey {
|
|
Type: proto::KeyType::ECDSA,
|
|
Data: key.encode_der(),
|
|
},
|
|
}
|
|
}
|
|
}
|
|
|
|
pub use error::{DecodingError, OtherVariantError, SigningError};
|
|
pub use keypair::{Keypair, PublicKey};
|
|
#[cfg(feature = "peerid")]
|
|
pub use peer_id::{ParseError, PeerId};
|
|
|
|
#[derive(Debug, PartialEq, Eq)]
|
|
/// The type of key a `KeyPair` is holding.
|
|
pub enum KeyType {
|
|
Ed25519,
|
|
RSA,
|
|
Secp256k1,
|
|
Ecdsa,
|
|
}
|
|
|
|
impl std::fmt::Display for KeyType {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
match self {
|
|
KeyType::Ed25519 => f.write_str("Ed25519"),
|
|
KeyType::RSA => f.write_str("RSA"),
|
|
KeyType::Secp256k1 => f.write_str("Secp256k1"),
|
|
KeyType::Ecdsa => f.write_str("Ecdsa"),
|
|
}
|
|
}
|
|
}
|