Struct diem_crypto::x25519::PrivateKey

pub struct PrivateKey(_);

This type should be used to deserialize a received private key

Implementations

impl PrivateKey

pub fn public_key(&self) -> PublicKey

Obtain the public key part of a private key

pub fn diffie_hellman(&self, remote_public_key: &PublicKey) -> [u8; 32]

To perform a key exchange with another public key

pub fn from_ed25519_private_bytes(
    private_slice: &[u8]
) -> Result<Self, CryptoMaterialError>

Deserialize an X25119 PrivateKey given the sha512 pre-image of a hash whose least significant half is a canonical X25519 scalar, following the XEdDSA approach.

This will FAIL if the passed-in byte representation converts to a non-canonical scalar in the X25519 sense (and thus cannot correspond to a X25519 valid key without bit-mangling).

This is meant to compensate for the poor key storage capabilities of some key management solutions, and NOT to promote double usage of keys under several schemes, which would lead to BAD vulnerabilities.

Trait Implementations

impl Debug for PrivateKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PrivateKey

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for PrivateKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&'_ PrivateKey> for PublicKey

fn from(private_key: &PrivateKey) -> Self

Performs the conversion.

impl From<[u8; 32]> for PrivateKey

fn from(private_key_bytes: [u8; 32]) -> Self

Performs the conversion.

impl PrivateKey for PrivateKey

type PublicKeyMaterial = PublicKey

We require public / private types to be coupled, i.e. their associated type is each other.

fn public_key(&self) -> Self::PublicKeyMaterial

Returns the associated public key

impl Serialize for PrivateKey

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ [u8]> for PrivateKey

type Error = CryptoMaterialError

The type returned in the event of a conversion error.

fn try_from(private_key_bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl Uniform for PrivateKey

fn generate<R>(rng: &mut R) -> Self where
    R: RngCore + CryptoRng, 

Generate key material from an RNG. This should generally not be used for production purposes even with a good source of randomness. When possible use hardware crypto to generate and store private keys.

fn generate_for_testing() -> Self where
    Self: Sized, 

Generate a random key using the shared TEST_SEED

impl ValidCryptoMaterial for PrivateKey

fn to_bytes(&self) -> Vec<u8>

Convert the valid crypto material to bytes.