Struct sshcerts::ssh::PrivateKey

pub struct PrivateKey {
    pub key_type: KeyType,
    pub kind: PrivateKeyKind,
    pub pubkey: PublicKey,
    pub magic: u32,
    pub comment: String,
}

A type which represents an OpenSSH private key.

Fields

key_type: KeyType

Key type.

kind: PrivateKeyKind

The kind of public key.

pubkey: PublicKey

The corresponding public key

magic: u32

This is the magic value used to ensure decoding happens correctly. We store it so that we can guarantee reserialization of unencrypted keys is bytes for byte.

comment: String

Associated comment. It appears, unlike public keys, private keys must have comments to be valid.

Implementations

impl PrivateKey

pub fn new(kind: KeyTypeKind, comment: &str) -> Result<Self, Error>

Generate a new SSH private key. Currently this only supports Ed25519.

pub fn from_path_with_passphrase<P: AsRef<Path>>( path: P, passphrase: Option<String> ) -> Result<Self, Error>

Reads an OpenSSH private key from a given path and passphrase

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Reads an OpenSSH private key from a given path.

pub fn from_string_with_passphrase( contents: &str, passphrase: Option<String> ) -> Result<Self, Error>

Reads an OpenSSH private key from a given string and passphrase

pub fn from_string(contents: &str) -> Result<PrivateKey, Error>

Reads an OpenSSH private key from a given string.

pub fn from_bytes<T: ?Sized + AsRef<[u8]>>( buffer: &T ) -> Result<PrivateKey, Error>

Create a private key from just the decrypted private bytes

pub fn set_pin(&mut self, pin: &str)

If using an SK key, this allows you set the pin to use when communicating with the external device

pub fn set_device_path(&mut self, path: &str)

If using an SK key, this allows you specify a hardware device path to use for the signing operation

pub fn encode(&self) -> Vec<u8>

Encode the PrivateKey into a bytes representation

pub fn write<W: Write>(&self, w: &mut W) -> Result<()>

Writes the private key to a given writer.

Trait Implementations

impl Clone for PrivateKey

fn clone(&self) -> PrivateKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateKey

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

Formats the value using the given formatter.

impl Display for PrivateKey

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

Formats the value using the given formatter.

impl Drop for PrivateKey

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for PrivateKey

fn eq(&self, other: &PrivateKey) -> 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 SSHCertificateSigner for PrivateKey

fn sign(&self, buffer: &[u8]) -> Option<Vec<u8>>

This function is called when signing an SSH certificate.

impl Eq for PrivateKey

impl StructuralPartialEq for PrivateKey