Struct SshKeyPairSet

pub struct SshKeyPairSet {
    primary: SshKeyPair,
    secondary: SshKeyPair,
}

A set of two SSH key pairs, used to support key rotation.

When a key pair set is rotated, the secondary key pair becomes the new primary key pair, and a new secondary key pair is generated.

Fields

primary: SshKeyPair

secondary: SshKeyPair

Implementations

impl SshKeyPairSet

pub fn new() -> Result<SshKeyPairSet, Error>

pub fn from_parts(primary: SshKeyPair, secondary: SshKeyPair) -> SshKeyPairSet

Creates a new key pair set from an existing primary and secondary key pair.

pub fn rotate(&self) -> Result<SshKeyPairSet, Error>

Rotate the key pairs in the set.

The rotation promotes the secondary key_pair to primary and generates a new random secondary key pair.

pub fn public_keys(&self) -> (String, String)

Returns the primary and secondary public keys in the set.

pub fn primary(&self) -> &SshKeyPair

Return the primary key pair.

pub fn secondary(&self) -> &SshKeyPair

Returns the secondary pair.

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

Serializes the key pair set to an unspecified encoding.

You can deserialize a key pair set with SshKeyPairSet::deserialize.

pub fn from_bytes(data: &[u8]) -> Result<SshKeyPairSet>

Deserializes a key pair set that was serialized with SshKeyPairSet::serialize.

Trait Implementations

impl Clone for SshKeyPairSet

fn clone(&self) -> SshKeyPairSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SshKeyPairSet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SshKeyPairSet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SshKeyPairSet

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SshKeyPairSet

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SshKeyPairSet

impl StructuralPartialEq for SshKeyPairSet