Struct ssh_key::public::PublicKey

pub struct PublicKey { /* private fields */ }

SSH public key.

OpenSSH encoding

The OpenSSH encoding of an SSH public key looks like following:

ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILM+rvN+ot98qgEN796jTiQfZfG1KaT0PtFDJ/XFSqti user@example.com

It consists of the following three parts:

1. Algorithm identifier (in this example ssh-ed25519)
2. Key data encoded as Base64
3. Comment (optional): arbitrary label describing a key. Usually an email address

The PublicKey::from_openssh and PublicKey::to_openssh methods can be used to decode/encode public keys, or alternatively, the FromStr and ToString impls.

serde support

When the serde feature of this crate is enabled, this type receives impls of [Deserialize][serde::Deserialize] and [Serialize][serde::Serialize].

The serialization uses a binary encoding with binary formats like bincode and CBOR, and the OpenSSH string serialization when used with human-readable formats like JSON and TOML.

Implementations

impl PublicKey

pub fn new(key_data: KeyData, comment: impl Into<String>) -> Self

Create a new public key with the given comment.

On no_std platforms, use PublicKey::from(key_data) instead.

pub fn from_openssh(public_key: &str) -> Result<Self>

Parse an OpenSSH-formatted public key.

OpenSSH-formatted public keys look like the following:

ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILM+rvN+ot98qgEN796jTiQfZfG1KaT0PtFDJ/XFSqti foo@bar.com

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Parse a raw binary SSH public key.

pub fn encode_openssh<'o>(&self, out: &'o mut [u8]) -> Result<&'o str>

Encode OpenSSH-formatted public key.

pub fn to_openssh(&self) -> Result<String>

Encode an OpenSSH-formatted public key, allocating a String for the result.

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

Serialize SSH public key as raw bytes.

pub fn read_openssh_file(path: &Path) -> Result<Self>

Read public key from an OpenSSH-formatted file.

pub fn write_openssh_file(&self, path: &Path) -> Result<()>

Write public key as an OpenSSH-formatted file.

pub fn algorithm(&self) -> Algorithm

Get the digital signature Algorithm used by this key.

pub fn comment(&self) -> &str

Comment on the key (e.g. email address).

pub fn key_data(&self) -> &KeyData

Private key data.

pub fn fingerprint(&self, hash_alg: HashAlg) -> Fingerprint

Compute key fingerprint.

Use Default::default() to use the default hash function (SHA-256).

pub fn set_comment(&mut self, comment: impl Into<String>)

Set the comment on the key.

Trait Implementations

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PublicKey

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

Formats the value using the given formatter.

impl From<&PrivateKey> for PublicKey

fn from(private_key: &PrivateKey) -> PublicKey

Converts to this type from the input type.

impl From<&PublicKey> for KeyData

fn from(public_key: &PublicKey) -> KeyData

Converts to this type from the input type.

impl From<DsaPublicKey> for PublicKey

fn from(public_key: DsaPublicKey) -> PublicKey

Converts to this type from the input type.

impl From<EcdsaPublicKey> for PublicKey

fn from(public_key: EcdsaPublicKey) -> PublicKey

Converts to this type from the input type.

impl From<Ed25519PublicKey> for PublicKey

fn from(public_key: Ed25519PublicKey) -> PublicKey

Converts to this type from the input type.

impl From<Entry> for PublicKey

fn from(entry: Entry) -> PublicKey

Converts to this type from the input type.

impl From<Entry> for PublicKey

fn from(entry: Entry) -> PublicKey

Converts to this type from the input type.

impl From<KeyData> for PublicKey

fn from(key_data: KeyData) -> PublicKey

Converts to this type from the input type.

impl From<PrivateKey> for PublicKey

fn from(private_key: PrivateKey) -> PublicKey

Converts to this type from the input type.

impl From<PublicKey> for Entry

fn from(public_key: PublicKey) -> Entry

Converts to this type from the input type.

impl From<PublicKey> for KeyData

fn from(public_key: PublicKey) -> KeyData

Converts to this type from the input type.

impl From<RsaPublicKey> for PublicKey

fn from(public_key: RsaPublicKey) -> PublicKey

Converts to this type from the input type.

impl From<SkEcdsaSha2NistP256> for PublicKey

fn from(public_key: SkEcdsaSha2NistP256) -> PublicKey

Converts to this type from the input type.

impl From<SkEd25519> for PublicKey

fn from(public_key: SkEd25519) -> PublicKey

Converts to this type from the input type.

impl FromStr for PublicKey

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Ord for PublicKey

fn cmp(&self, other: &PublicKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for PublicKey

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

fn partial_cmp(&self, other: &PublicKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ToString for PublicKey

fn to_string(&self) -> String

Converts the given value to a String.

impl Verifier<Signature> for PublicKey

fn verify(&self, message: &[u8], signature: &Signature) -> Result<()>

Use Self to verify that the provided signature for a given message bytestring is authentic.

impl Eq for PublicKey

impl StructuralPartialEq for PublicKey