Struct ssh_key::public::PublicKey

source · [−]

pub struct PublicKey { /* private fields */ }

Expand description

SSH public key.

Implementations

source

impl PublicKey

source

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

This is supported on crate feature alloc only.

Create a new public key with the given comment.

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

source

pub fn from_openssh(input: impl AsRef<[u8 ]>) -> 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

source

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

Encode OpenSSH-formatted public key.

source

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

This is supported on crate feature alloc only.

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

source

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

This is supported on crate feature std only.

Read public key from an OpenSSH-formatted file.

source

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

This is supported on crate feature std only.

Write public key as an OpenSSH-formatted file.

source

pub fn algorithm(&self) -> Algorithm

Get the digital signature Algorithm used by this key.

source

pub fn comment(&self) -> &str

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

source

pub fn key_data(&self) -> &KeyData

Private key data.

source

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

This is supported on crate feature fingerprint only.

Compute key fingerprint.

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

Trait Implementations

source

impl Clone for PublicKey

source

fn clone(&self) -> PublicKey

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for PublicKey

source

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

Formats the value using the given formatter. Read more

source

impl From<&'_ PrivateKey> for PublicKey

source

fn from(private_key: &PrivateKey) -> PublicKey

Performs the conversion.

source

impl From<Entry> for PublicKey

source

fn from(entry: Entry) -> PublicKey

Performs the conversion.

source

impl From<KeyData> for PublicKey

source

fn from(key_data: KeyData) -> PublicKey

Performs the conversion.

source

impl From<PrivateKey> for PublicKey

source

fn from(private_key: PrivateKey) -> PublicKey

Performs the conversion.

source

impl From<PublicKey> for Entry

source

fn from(public_key: PublicKey) -> Entry

Performs the conversion.

source

impl FromStr for PublicKey

type Err = Error

The associated error which can be returned from parsing.

source

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

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

source

impl Ord for PublicKey

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl PartialEq<PublicKey> for PublicKey

source

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

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

source

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

This method tests for !=.

source

impl PartialOrd<PublicKey> for PublicKey

source

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

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

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl ToString for PublicKey

source

fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl TryFrom<&'_ PublicKey> for Sha256Fingerprint

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(public_key: &PublicKey) -> Result<Sha256Fingerprint>

Performs the conversion.

source

impl TryFrom<PublicKey> for Sha256Fingerprint

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(public_key: PublicKey) -> Result<Sha256Fingerprint>

Performs the conversion.

source

impl Eq for PublicKey

source

impl StructuralEq for PublicKey

source

impl StructuralPartialEq for PublicKey

Auto Trait Implementations

impl RefUnwindSafe for PublicKey

impl Send for PublicKey

impl Sync for PublicKey

impl Unpin for PublicKey

impl UnwindSafe for PublicKey

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ssh_key::public::PublicKey

Implementations

impl PublicKey

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

pub fn from_openssh(input: impl AsRef<[u8]>) -> Result<Self>

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

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

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

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

pub fn algorithm(&self) -> Algorithm

pub fn comment(&self) -> &str

pub fn key_data(&self) -> &KeyData

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

Trait Implementations

impl Clone for PublicKey

fn clone(&self) -> PublicKey

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

impl Debug for PublicKey

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

impl From<&'_ PrivateKey> for PublicKey

fn from(private_key: &PrivateKey) -> PublicKey

impl From<Entry> for PublicKey

fn from(entry: Entry) -> PublicKey

impl From<KeyData> for PublicKey

fn from(key_data: KeyData) -> PublicKey

impl From<PrivateKey> for PublicKey

fn from(private_key: PrivateKey) -> PublicKey

impl From<PublicKey> for Entry

fn from(public_key: PublicKey) -> Entry

impl FromStr for PublicKey

type Err = Error

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

impl Ord for PublicKey

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

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

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

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

impl PartialEq<PublicKey> for PublicKey

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

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

impl PartialOrd<PublicKey> for PublicKey

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

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

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

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

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

impl ToString for PublicKey

fn to_string(&self) -> String

impl TryFrom<&'_ PublicKey> for Sha256Fingerprint

type Error = Error

fn try_from(public_key: &PublicKey) -> Result<Sha256Fingerprint>

impl TryFrom<PublicKey> for Sha256Fingerprint

type Error = Error

fn try_from(public_key: PublicKey) -> Result<Sha256Fingerprint>

impl Eq for PublicKey

impl StructuralEq for PublicKey

impl StructuralPartialEq for PublicKey

Auto Trait Implementations

impl RefUnwindSafe for PublicKey

impl Send for PublicKey

impl Sync for PublicKey

impl Unpin for PublicKey

impl UnwindSafe for PublicKey

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

pub fn from_openssh(input: impl AsRef<[u8 ]>) -> Result<Self>

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,