Struct sequoia_openpgp::packet::key::Key4

pub struct Key4 { /* fields omitted */ }

Holds a public key, public subkey, private key or private subkey packet.

See Section 5.5 of RFC 4880 for details.

Methods

impl Key4

pub fn public_cmp(a: &Self, b: &Self) -> Ordering

Compares the public bits of two keys.

This returns Ordering::Equal if the public MPIs, creation time and algorithm of the two Key4s match. This does not consider the packet's encoding, packet's tag or the secret key material.

impl Key4

pub fn new(
    creation_time: Tm,
    pk_algo: PublicKeyAlgorithm,
    mpis: PublicKey,
    secret: Option<SecretKey>
) -> Result<Self>

Creates a new OpenPGP key packet.

pub fn import_public_cv25519<H, S, T>(
    public_key: &[u8],
    hash: H,
    sym: S,
    ctime: T
) -> Result<Self> where
    H: Into<Option<HashAlgorithm>>,
    S: Into<Option<SymmetricAlgorithm>>,
    T: Into<Option<Tm>>, 

Creates a new OpenPGP public key packet for an existing X25519 key.

The ECDH key will use hash algorithm hash and symmetric algorithm sym. If one or both are None secure defaults will be used. The key will have it's creation date set to ctime or the current time if None is given.

pub fn import_secret_cv25519<H, S, T>(
    private_key: &[u8],
    hash: H,
    sym: S,
    ctime: T
) -> Result<Self> where
    H: Into<Option<HashAlgorithm>>,
    S: Into<Option<SymmetricAlgorithm>>,
    T: Into<Option<Tm>>, 

Creates a new OpenPGP secret key packet for an existing X25519 key.

The ECDH key will use hash algorithm hash and symmetric algorithm sym. If one or both are None secure defaults will be used. The key will have it's creation date set to ctime or the current time if None is given.

pub fn import_public_ed25519<T>(public_key: &[u8], ctime: T) -> Result<Self> where
    T: Into<Option<Tm>>, 

Creates a new OpenPGP public key packet for an existing Ed25519 key.

The ECDH key will use hash algorithm hash and symmetric algorithm sym. If one or both are None secure defaults will be used. The key will have it's creation date set to ctime or the current time if None is given.

pub fn import_secret_ed25519<T>(private_key: &[u8], ctime: T) -> Result<Self> where
    T: Into<Option<Tm>>, 

Creates a new OpenPGP secret key packet for an existing Ed25519 key.

The ECDH key will use hash algorithm hash and symmetric algorithm sym. If one or both are None secure defaults will be used. The key will have it's creation date set to ctime or the current time if None is given.

pub fn import_public_rsa<T>(e: &[u8], n: &[u8], ctime: T) -> Result<Self> where
    T: Into<Option<Tm>>, 

Creates a new OpenPGP public key packet for an existing RSA key.

The RSA key will use public exponent e and modulo n. The key will have it's creation date set to ctime or the current time if None is given.

pub fn import_secret_rsa<T>(
    d: &[u8],
    p: &[u8],
    q: &[u8],
    ctime: T
) -> Result<Self> where
    T: Into<Option<Tm>>, 

Creates a new OpenPGP public key packet for an existing RSA key.

The RSA key will use public exponent e and modulo n. The key will have it's creation date set to ctime or the current time if None is given.

pub fn generate_rsa(bits: usize) -> Result<Self>

Generates a new RSA key with a public modulos of size bits.

pub fn generate_ecc(for_signing: bool, curve: Curve) -> Result<Self>

Generates a new ECC key over curve.

If for_signing is false a ECDH key, if it's true either a EdDSA or ECDSA key is generated. Giving for_signing == true and curve == Cv25519 will produce an error. Similar for for_signing == false and curve == Ed25519. signing/encryption

pub fn creation_time(&self) -> &Tm

Gets the key packet's creation time field.

pub fn set_creation_time(&mut self, timestamp: Tm) -> Tm

Sets the key packet's creation time field.

pub fn pk_algo(&self) -> PublicKeyAlgorithm

Gets the public key algorithm.

pub fn set_pk_algo(&mut self, pk_algo: PublicKeyAlgorithm) -> PublicKeyAlgorithm

Sets the public key algorithm.

pub fn mpis(&self) -> &PublicKey

Gets the key packet's MPIs.

pub fn mpis_mut(&mut self) -> &mut PublicKey

Gets a mutable reference to the key packet's MPIs.

pub fn set_mpis(&mut self, mpis: PublicKey) -> PublicKey

Sets the key packet's MPIs.

pub fn secret(&self) -> Option<&SecretKey>

Gets the key packet's SecretKey.

pub fn secret_mut(&mut self) -> Option<&mut SecretKey>

Gets a mutable reference to the key packet's SecretKey.

pub fn set_secret(&mut self, secret: Option<SecretKey>) -> Option<SecretKey>

Sets the key packet's SecretKey.

Returns the old value.

pub fn fingerprint(&self) -> Fingerprint

Computes and returns the key's fingerprint as per Section 12.2 of RFC 4880.

pub fn keyid(&self) -> KeyID

Computes and returns the key's key ID as per Section 12.2 of RFC 4880.

pub fn into_packet(self, tag: Tag) -> Result<Packet>

Convert the Key struct to a Packet.

pub fn into_keypair(self) -> Result<KeyPair>

Converts this packet with an unencrypted secret key into a KeyPair.

Errors

Fails if the secret key is missing, or encrypted.

Trait Implementations

impl Clone for Key4

fn clone(&self) -> Key4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key4

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

Formats the value using the given formatter.

impl Display for Key4

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

Formats the value using the given formatter.

impl Eq for Key4

impl From<Key4> for Key

fn from(p: Key4) -> Self

Performs the conversion.

impl Hash for Key4

fn hash(&self, hash: &mut Context)

Update the Hash with a hash of the key.

impl Hash for Key4

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Key4> for Key4

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

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

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

This method tests for !=.

impl Serialize for Key4

fn serialize(&self, o: &mut dyn Write) -> Result<()>

Writes a serialized version of the object to o.

impl SerializeInto for Key4

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serializes into the given buffer.

fn to_vec(&self) -> Result<Vec<u8>>

Serializes the packet to a vector.

impl StructuralEq for Key4

impl StructuralPartialEq for Key4