Struct SignedPublicKey 

pub struct SignedPublicKey {
    pub primary_key: PublicKey,
    pub details: SignedKeyDetails,
    pub public_subkeys: Vec<SignedPublicSubKey>,
}

An OpenPGP public key (“Transferable Public Key”, also known as an “OpenPGP certificate”).

This object combines primary and subkey material, identity components, and a set of self-signatures (and optionally third party signatures).

This format can be used to transfer a public key to other OpenPGP users.

Fields

primary_key: PublicKey

details: SignedKeyDetails

public_subkeys: Vec<SignedPublicSubKey>

Implementations

impl SignedPublicKey

pub fn new( primary_key: PublicKey, details: SignedKeyDetails, public_subkeys: Vec<SignedPublicSubKey>, ) -> SignedPublicKey

pub fn verify_bindings(&self) -> Result<(), Error>

Verifies all stored bindings.

pub fn to_armored_writer( &self, writer: &mut impl Write, opts: ArmorOptions<'_>, ) -> Result<(), Error>

pub fn to_armored_bytes(&self, opts: ArmorOptions<'_>) -> Result<Vec<u8>, Error>

pub fn to_armored_string(&self, opts: ArmorOptions<'_>) -> Result<String, Error>

impl SignedPublicKey

pub fn bind_with_signing_key<R, K>( rng: R, primary_signer: &K, primary_key: PublicKey, details: KeyDetails, key_pw: &Password, public_subkeys: Vec<SignedPublicSubKey>, ) -> Result<SignedPublicKey, Error>

where R: CryptoRng + Rng, K: SigningKey,

This uses a separately provided signing key to bind a set of components (public primary and subkeys, and identities) into a SignedPublicKey.

This is useful when the private key material of the primary key is HSM-backed.

NOTE: When binding signing-capable subkeys to a primary, the caller must ensure that an “Embedded primary key binding signature”, is included. See https://www.rfc-editor.org/rfc/rfc9580.html#sigtype-primary-binding

Trait Implementations

impl Clone for SignedPublicKey

fn clone(&self) -> SignedPublicKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DcKey for SignedPublicKey

fn to_asc(&self, header: Option<(&str, &str)>) -> String

Serialise the key to ASCII-armored representation.

fn is_private() -> bool

Whether the key is private (or public).

fn dc_fingerprint(&self) -> Fingerprint

The fingerprint for the key.

fn key_id(&self) -> KeyId

Returns the OpenPGP Key ID.

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

Create a key from some bytes.

fn from_base64(data: &str) -> Result<Self>

Create a key from a base64 string.

fn from_asc(data: &str) -> Result<Self>

Create a key from an ASCII-armored string.

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

Serialise the key as bytes.

fn to_base64(&self) -> String

Serialise the key to a base64 string.

impl Debug for SignedPublicKey

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

Formats the value using the given formatter.

impl Deserializable for SignedPublicKey

fn from_packets<'a, I>( packets: Peekable<I>, ) -> Box<dyn Iterator<Item = Result<SignedPublicKey, Error>> + 'a>

where I: Iterator<Item = Result<Packet, Error>> + 'a,

Parse a transferable key from packets. Ref: https://www.rfc-editor.org/rfc/rfc9580.html#name-transferable-public-keys

fn matches_block_type(typ: BlockType) -> bool

Check if the given typ is a valid block type for this type.

fn from_bytes<R>(bytes: R) -> Result<Self, Error>

where R: BufRead,

Parse a single byte encoded composition.

fn from_string( input: &str, ) -> Result<(Self, BTreeMap<String, Vec<String>>), Error>

Parse a single armor encoded composition.

fn from_string_many<'a>( input: &'a str, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>> + 'a>, BTreeMap<String, Vec<String>>), Error>

Parse an armor encoded list of compositions.

fn from_armor_single<R>( input: R, ) -> Result<(Self, BTreeMap<String, Vec<String>>), Error>

where R: Read,

Armored ascii data.

fn from_armor_single_buf<R>( input: R, ) -> Result<(Self, BTreeMap<String, Vec<String>>), Error>

where R: BufRead,

Armored ascii data.

fn from_armor_single_buf_with_options<R>( input: R, opt: DearmorOptions, ) -> Result<(Self, BTreeMap<String, Vec<String>>), Error>

where R: BufRead,

Armored ascii data, with explicit options for dearmoring.

fn from_armor_many<'a, R>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>> + 'a>, BTreeMap<String, Vec<String>>), Error>

where R: Read + 'a,

Armored ascii data.

fn from_armor_many_buf<'a, R>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>> + 'a>, BTreeMap<String, Vec<String>>), Error>

where R: BufRead + 'a,

Armored ascii data.

fn from_armor_many_buf_with_options<'a, R>( input: R, opt: DearmorOptions, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>> + 'a>, BTreeMap<String, Vec<String>>), Error>

where R: BufRead + 'a,

Armored ascii data, with explicit options for dearmoring.

fn from_bytes_many<'a, R>( bytes: R, ) -> Result<Box<dyn Iterator<Item = Result<Self, Error>> + 'a>, Error>

where R: BufRead + 'a,

Parse a list of compositions in raw byte format.

fn from_file<P>(path: P) -> Result<Self, Error>

where P: AsRef<Path>,

Parse a single binary encoded composition.

fn from_armor_file<P>( path: P, ) -> Result<(Self, BTreeMap<String, Vec<String>>), Error>

where P: AsRef<Path>,

Parse a single armor encoded composition.

fn from_armor_file_many<P>( path: P, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>>>, BTreeMap<String, Vec<String>>), Error>

where P: AsRef<Path>,

Parse a single armor encoded composition.

fn from_file_many<P>( path: P, ) -> Result<Box<dyn Iterator<Item = Result<Self, Error>>>, Error>

where P: AsRef<Path>,

Ready binary packets from the given file.

fn from_reader_single<'a, R>( input: R, ) -> Result<(Self, Option<BTreeMap<String, Vec<String>>>), Error>

where R: Read + 'a,

Parses a single composition, from either ASCII-armored or binary OpenPGP data.

fn from_reader_single_buf<'a, R>( input: R, ) -> Result<(Self, Option<BTreeMap<String, Vec<String>>>), Error>

where R: BufRead + 'a,

fn from_reader_many<'a, R>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>> + 'a>, Option<BTreeMap<String, Vec<String>>>), Error>

where R: Read + 'a,

Parses a list of compositions, from either ASCII-armored or binary OpenPGP data.

fn from_reader_many_buf<'a, R>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>> + 'a>, Option<BTreeMap<String, Vec<String>>>), Error>

where R: BufRead + 'a,

Parses a list of compositions, from either ASCII-armored or binary OpenPGP data.

impl EncryptionKey for SignedPublicKey

fn encrypt<R>( &self, rng: R, plain: &[u8], typ: EskType, ) -> Result<PkeskBytes, Error>

where R: Rng + CryptoRng,

impl From<SignedSecretKey> for SignedPublicKey

fn from(value: SignedSecretKey) -> SignedPublicKey

Converts to this type from the input type.

impl Imprint for SignedPublicKey

fn imprint<D>( &self, ) -> Result<GenericArray<u8, <D as OutputSizeUser>::OutputSize>, Error>

where D: KnownDigest,

Get the [Imprint] for a key.

impl KeyDetails for SignedPublicKey

fn version(&self) -> KeyVersion

Returns the [KeyVersion] of this key.

fn fingerprint(&self) -> Fingerprint

Returns the [Fingerprint] for this key.

fn legacy_key_id(&self) -> KeyId

Returns the [KeyId] for this key.

fn algorithm(&self) -> PublicKeyAlgorithm

Returns the algorithm for this key.

fn created_at(&self) -> Timestamp

fn legacy_v3_expiration_days(&self) -> Option<u16>

Expiration in days after key creation (only applicable to v3 keys!)

fn public_params(&self) -> &PublicParams

Returns the parameters for the public portion of this key.

impl PartialEq for SignedPublicKey

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

fn to_writer<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write,

fn write_len(&self) -> usize

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

impl TryFrom<PublicOrSecret> for SignedPublicKey

type Error = TryFromPublicOrSecretError

The type returned in the event of a conversion error.

fn try_from( public_or_secret: PublicOrSecret, ) -> Result<SignedPublicKey, <SignedPublicKey as TryFrom<PublicOrSecret>>::Error>

Performs the conversion.

impl VerifyingKey for SignedPublicKey

fn verify( &self, hash: HashAlgorithm, data: &[u8], sig: &SignatureBytes, ) -> Result<(), Error>

Verify a signed message. Data will be hashed using hash, before verifying.

impl Eq for SignedPublicKey

impl StructuralPartialEq for SignedPublicKey