Struct dryoc::keypair::KeyPair

pub struct KeyPair<PublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>> {
    pub public_key: PublicKey,
    pub secret_key: SecretKey,
}

Public/private keypair for use with crate::dryocbox::DryocBox, aka libsodium box

Fields

public_key: PublicKey

Public key

secret_key: SecretKey

Secret key

Implementations

impl KeyPair<Locked<HeapByteArray<CRYPTO_BOX_PUBLICKEYBYTES>>, Locked<HeapByteArray<CRYPTO_BOX_SECRETKEYBYTES>>>

pub fn new_locked_keypair() -> Result<Self, Error>

Available on crate feature nightly only.

Returns a new locked keypair.

pub fn gen_locked_keypair() -> Result<Self, Error>

Available on crate feature nightly only.

Returns a new randomly generated locked keypair.

impl KeyPair<LockedRO<HeapByteArray<CRYPTO_BOX_PUBLICKEYBYTES>>, LockedRO<HeapByteArray<CRYPTO_BOX_SECRETKEYBYTES>>>

pub fn gen_readonly_locked_keypair() -> Result<Self, Error>

Available on crate feature nightly only.

Returns a new randomly generated locked, read-only keypair.

impl<PublicKey: NewByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: NewByteArray<CRYPTO_BOX_SECRETKEYBYTES>> KeyPair<PublicKey, SecretKey>

pub fn new() -> Self

Creates a new, empty keypair.

pub fn gen() -> Self

Generates a random keypair.

pub fn from_secret_key(secret_key: SecretKey) -> Self

Derives a keypair from secret_key, and consumes it, and returns a new keypair.

pub fn from_seed<Seed: Bytes>(seed: &Seed) -> Self

Derives a keypair from seed, returning a new keypair.

impl KeyPair<StackByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, StackByteArray<CRYPTO_BOX_SECRETKEYBYTES>>

pub fn gen_with_defaults() -> Self

Randomly generates a new keypair, using default types (stack-allocated byte arrays). Provided for convenience.

impl<'a, PublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + TryFrom<&'a [u8]>, SecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES> + TryFrom<&'a [u8]>> KeyPair<PublicKey, SecretKey>

pub fn from_slices(
    public_key: &'a [u8],
    secret_key: &'a [u8]
) -> Result<Self, Error>

Constructs a new keypair from key slices, consuming them. Does not check validity or authenticity of keypair.

impl<PublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>> KeyPair<PublicKey, SecretKey>

pub fn kx_new_client_session<SessionKey: NewByteArray<CRYPTO_KX_SESSIONKEYBYTES>>(
    &self,
    server_public_key: &PublicKey
) -> Result<Session<SessionKey>, Error>

Creates new client session keys using this keypair and server_public_key, assuming this keypair is for the client.

pub fn kx_new_server_session<SessionKey: NewByteArray<CRYPTO_KX_SESSIONKEYBYTES>>(
    &self,
    client_public_key: &PublicKey
) -> Result<Session<SessionKey>, Error>

Creates new server session keys using this keypair and client_public_key, assuming this keypair is for the server.

Trait Implementations

impl<PublicKey: Clone + ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: Clone + ByteArray<CRYPTO_BOX_SECRETKEYBYTES>> Clone for KeyPair<PublicKey, SecretKey>

fn clone(&self) -> KeyPair<PublicKey, SecretKey>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<PublicKey: Debug + ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: Debug + ByteArray<CRYPTO_BOX_SECRETKEYBYTES>> Debug for KeyPair<PublicKey, SecretKey>

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

Formats the value using the given formatter.

impl<PublicKey: NewByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: NewByteArray<CRYPTO_BOX_SECRETKEYBYTES>> Default for KeyPair<PublicKey, SecretKey>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, PublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>> Deserialize<'de> for KeyPair<PublicKey, SecretKey>where
    PublicKey: Deserialize<'de>,
    SecretKey: Deserialize<'de>,

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

Deserialize this value from the given Serde deserializer.

impl<PublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>> PartialEq<KeyPair<PublicKey, SecretKey>> for KeyPair<PublicKey, SecretKey>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<PublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>> Serialize for KeyPair<PublicKey, SecretKey>where
    PublicKey: Serialize,
    SecretKey: Serialize,

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

Serialize this value into the given Serde serializer.

impl<PublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>> Zeroize for KeyPair<PublicKey, SecretKey>where
    PublicKey: Zeroize,
    SecretKey: Zeroize,

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.