pub struct KeyPair { /* private fields */ }
Expand description
General key pair type
This is a type to make it easy to store different types of key pair in the container. Each can contain one of the types supported in this crate.
Key pair is the so-called “private key” which contains both public and private parts of an asymmetry key.
Implementations§
source§impl KeyPair
impl KeyPair
sourcepub fn from_keystr(pem: &str, passphrase: Option<&str>) -> OsshResult<Self>
pub fn from_keystr(pem: &str, passphrase: Option<&str>) -> OsshResult<Self>
Parse a keypair from supporting file types
The passphrase is required if the keypair is encrypted.
OpenSSL PEM
- Begin with
-----BEGIN DSA PRIVATE KEY-----
for dsa key. - Begin with
-----BEGIN RSA PRIVATE KEY-----
for rsa key. - Begin with
-----BEGIN EC PRIVATE KEY-----
for ecdsa key. - Begin with
-----BEGIN PRIVATE KEY-----
for Ed25519 key.
PKCS#8 Format
- Begin with
-----BEGIN PRIVATE KEY-----
Openssh
- Begin with
-----BEGIN OPENSSH PRIVATE KEY-----
This is the new format which is supported since OpenSSH 6.5, and it became the default format in OpenSSH 7.8. The Ed25519 key can only be stored in this type.
sourcepub fn generate(keytype: KeyType, bits: usize) -> OsshResult<Self>
pub fn generate(keytype: KeyType, bits: usize) -> OsshResult<Self>
Generate a key of the specified type and size
Key Size
There are some limitations to the key size:
- RSA: the size should
>= 1024
and<= 16384
bits. - DSA: the size should be
1024
bits. - EcDSA: the size should be
256
,384
, or521
bits. - Ed25519: the size should be
256
bits.
If the key size parameter is zero, then it will use the default size to generate the key
- RSA:
2048
bits - DSA:
1024
bits - EcDSA:
256
bits - Ed25519:
256
bits
sourcepub fn serialize_pem(&self, passphrase: Option<&str>) -> OsshResult<String>
pub fn serialize_pem(&self, passphrase: Option<&str>) -> OsshResult<String>
Serialize the keypair to the OpenSSL PEM format
If the passphrase is given (set to Some(...)
), then the generated PEM key will be encrypted.
sourcepub fn serialize_pkcs8(&self, passphrase: Option<&str>) -> OsshResult<String>
pub fn serialize_pkcs8(&self, passphrase: Option<&str>) -> OsshResult<String>
Serialize the keypair to the OpenSSL PKCS#8 PEM format
If the passphrase is given (set to Some(...)
), then the generated PKCS#8 key will be encrypted.
sourcepub fn serialize_openssh(
&self,
passphrase: Option<&str>,
cipher: Cipher
) -> OsshResult<String>
pub fn serialize_openssh( &self, passphrase: Option<&str>, cipher: Cipher ) -> OsshResult<String>
Serialize the keypair to the OpenSSH private key format
If the passphrase is given (set to Some(...)
) and cipher is not null,
then the generated private key will be encrypted.
sourcepub fn comment_mut(&mut self) -> &mut String
pub fn comment_mut(&mut self) -> &mut String
Get the mutable reference of the key comment
sourcepub fn serialize_publickey(&self) -> OsshResult<String>
pub fn serialize_publickey(&self) -> OsshResult<String>
Get the OpenSSH public key of the public parts
sourcepub fn clone_public_key(&self) -> Result<PublicKey, Error>
pub fn clone_public_key(&self) -> Result<PublicKey, Error>
Clone the public parts of the key pair