Enum PublicKey

#[non_exhaustive]
pub enum PublicKey {
    RSA {
        e: MPI,
        n: MPI,
    },
    DSA {
        p: MPI,
        q: MPI,
        g: MPI,
        y: MPI,
    },
    ElGamal {
        p: MPI,
        g: MPI,
        y: MPI,
    },
    EdDSA {
        curve: Curve,
        q: MPI,
    },
    ECDSA {
        curve: Curve,
        q: MPI,
    },
    ECDH {
        curve: Curve,
        q: MPI,
        hash: HashAlgorithm,
        sym: SymmetricAlgorithm,
    },
    X25519 {
        u: [u8; 32],
    },
    X448 {
        u: Box<[u8; 56]>,
    },
    Ed25519 {
        a: [u8; 32],
    },
    Ed448 {
        a: Box<[u8; 57]>,
    },
    Unknown {
        mpis: Box<[MPI]>,
        rest: Box<[u8]>,
    },
}

A public key.

Provides a typed and structured way of storing multiple MPIs (and the occasional elliptic curve) in Key packets.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

RSA

RSA public key.

Fields

e: MPI

Public exponent

n: MPI

Public modulo N = pq.

DSA

NIST DSA public key.

Fields

p: MPI

Prime of the ring Zp.

q: MPI

Order of g in Zp.

g: MPI

Public generator of Zp.

y: MPI

Public key g^x mod p.

ElGamal

ElGamal public key.

Fields

p: MPI

Prime of the ring Zp.

g: MPI

Generator of Zp.

y: MPI

Public key g^x mod p.

EdDSA

DJB’s “Twisted” Edwards curve DSA public key.

Fields

curve: Curve

Curve we’re using. Must be curve 25519.

q: MPI

Public point.

ECDSA

NIST’s Elliptic Curve DSA public key.

Fields

curve: Curve

Curve we’re using.

q: MPI

Public point.

ECDH

Elliptic Curve Diffie-Hellman public key.

Fields

curve: Curve

Curve we’re using.

q: MPI

Public point.

hash: HashAlgorithm

Algorithm used to derive the Key Encapsulation Key.

sym: SymmetricAlgorithm

Algorithm used to encapsulate the session key.

X25519

X25519 public key.

Fields

u: [u8; 32]

The public key, an opaque string.

X448

X448 public key.

Fields

u: Box<[u8; 56]>

The public key, an opaque string.

Ed25519

Ed25519 public key.

Fields

a: [u8; 32]

The public key, an opaque string.

Ed448

Ed448 public key.

Fields

a: Box<[u8; 57]>

The public key, an opaque string.

Unknown

Unknown number of MPIs for an unknown algorithm.

Fields

mpis: Box<[MPI]>

The successfully parsed MPIs.

rest: Box<[u8]>

Any data that failed to parse.

Implementations

impl PublicKey

pub fn bits(&self) -> Option<usize>

Returns the length of the public key in bits.

For finite field crypto this returns the size of the field we operate in, for ECC it returns Curve::bits().

Note: This information is useless and should not be used to gauge the security of a particular key. This function exists only because some legacy PGP application like HKP need it.

Returns None for unknown keys and curves.

pub fn algo(&self) -> Option<PublicKeyAlgorithm>

Returns, if known, the public-key algorithm for this public key.

impl PublicKey

pub fn parse<R: Read + Send + Sync>( algo: PublicKeyAlgorithm, reader: R, ) -> Result<Self>

Parses a set of OpenPGP MPIs representing a public key.

See Section 3.2 of RFC 9580 for details.

Trait Implementations

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a duplicate of the value.

const 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 Hash for PublicKey

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Hash for PublicKey

fn hash(&self, hash: &mut Context) -> Result<()>

Updates the given hash with this object.

impl Marshal for PublicKey

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

Writes a serialized version of the object to o.

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

Exports a serialized version of the object to o.

impl MarshalInto for PublicKey

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.

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

Exports into the given buffer.

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

Exports to a vector.

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,

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 ==.

const 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 Eq for PublicKey

impl StructuralPartialEq for PublicKey