Type Definition sequoia_openpgp::cert::amalgamation::key::ValidPrimaryKeyAmalgamation

type ValidPrimaryKeyAmalgamation<'a, P> = ValidKeyAmalgamation<'a, P, PrimaryRole, ()>;

A Valid primary Key, and its associated data.

A specialized version of ValidKeyAmalgamation.

Implementations

impl<'a, P> ValidPrimaryKeyAmalgamation<'a, P> where
    P: KeyParts, 

pub fn parts_into_public(self) -> ValidPrimaryKeyAmalgamation<'a, PublicParts>

Changes the key’s parts tag to PublicParts.

pub fn parts_as_public(
    &'a self
) -> &'a ValidPrimaryKeyAmalgamation<'a, PublicParts>

Changes the key’s parts tag to PublicParts.

pub fn parts_into_secret(
    self
) -> Result<ValidPrimaryKeyAmalgamation<'a, SecretParts>>

Changes the key’s parts tag to SecretParts.

pub fn parts_as_secret(
    &'a self
) -> Result<&'a ValidPrimaryKeyAmalgamation<'a, SecretParts>>

Changes the key’s parts tag to SecretParts.

pub fn parts_into_unspecified(
    self
) -> ValidPrimaryKeyAmalgamation<'a, UnspecifiedParts>

Changes the key’s parts tag to UnspecifiedParts.

pub fn parts_as_unspecified(
    &'a self
) -> &ValidPrimaryKeyAmalgamation<'a, UnspecifiedParts>

Changes the key’s parts tag to UnspecifiedParts.

impl<'a, P> ValidPrimaryKeyAmalgamation<'a, P> where
    P: 'a + KeyParts, 

pub fn set_expiration_time(
    &self,
    primary_signer: &mut dyn Signer,
    expiration: Option<SystemTime>
) -> Result<Vec<Signature>>

Creates signatures that cause the key to expire at the specified time.

This function creates new binding signatures that cause the key to expire at the specified time when integrated into the certificate. For the primary key, it is necessary to create a new self-signature for each non-revoked User ID, and to create a direct key signature. This is needed, because the primary User ID is first consulted when determining the primary key’s expiration time, and certificates can be distributed with a possibly empty subset of User IDs.

Setting a key’s expiry time means updating an existing binding signature—when looking up information, only one binding signature is normally considered, and we don’t want to drop the other information stored in the current binding signature. This function uses the binding signature determined by ValidKeyAmalgamation’s policy and reference time for this.

Examples

use std::time;
use openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

let vc = cert.with_policy(p, None)?;

// Assert that the primary key is not expired.
assert!(vc.primary_key().alive().is_ok());

// Make the primary key expire in a week.
let t = time::SystemTime::now()
    + time::Duration::from_secs(7 * 24 * 60 * 60);

// We assume that the secret key material is available, and not
// password protected.
let mut signer = vc.primary_key()
    .key().clone().parts_into_secret()?.into_keypair()?;

let sigs = vc.primary_key().set_expiration_time(&mut signer, Some(t))?;
let cert = cert.insert_packets(sigs)?;

// The primary key isn't expired yet.
let vc = cert.with_policy(p, None)?;
assert!(vc.primary_key().alive().is_ok());

// But in two weeks, it will be...
let t = time::SystemTime::now()
    + time::Duration::from_secs(2 * 7 * 24 * 60 * 60);
let vc = cert.with_policy(p, t)?;
assert!(vc.primary_key().alive().is_err());

Trait Implementations

impl<'a> From<&'a ValidKeyAmalgamation<'a, PublicParts, PrimaryRole, ()>> for &'a ValidPrimaryKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: &'a ValidPrimaryKeyAmalgamation<'a, PublicParts>) -> Self

Performs the conversion.

impl<'a> From<&'a ValidKeyAmalgamation<'a, SecretParts, PrimaryRole, ()>> for &'a ValidPrimaryKeyAmalgamation<'a, PublicParts>

fn from(p: &'a ValidPrimaryKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<&'a ValidKeyAmalgamation<'a, SecretParts, PrimaryRole, ()>> for &'a ValidPrimaryKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: &'a ValidPrimaryKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<&'a ValidKeyAmalgamation<'a, UnspecifiedParts, PrimaryRole, ()>> for &'a ValidPrimaryKeyAmalgamation<'a, PublicParts>

fn from(p: &'a ValidPrimaryKeyAmalgamation<'a, UnspecifiedParts>) -> Self

Performs the conversion.

impl<'a> From<ValidKeyAmalgamation<'a, PublicParts, PrimaryRole, ()>> for ValidPrimaryKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: ValidPrimaryKeyAmalgamation<'a, PublicParts>) -> Self

Performs the conversion.

impl<'a> From<ValidKeyAmalgamation<'a, SecretParts, PrimaryRole, ()>> for ValidPrimaryKeyAmalgamation<'a, PublicParts>

fn from(p: ValidPrimaryKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<ValidKeyAmalgamation<'a, SecretParts, PrimaryRole, ()>> for ValidPrimaryKeyAmalgamation<'a, UnspecifiedParts>

fn from(p: ValidPrimaryKeyAmalgamation<'a, SecretParts>) -> Self

Performs the conversion.

impl<'a> From<ValidKeyAmalgamation<'a, UnspecifiedParts, PrimaryRole, ()>> for ValidPrimaryKeyAmalgamation<'a, PublicParts>

fn from(p: ValidPrimaryKeyAmalgamation<'a, UnspecifiedParts>) -> Self

Performs the conversion.

impl<'a, P> PrimaryKey<'a, P, PrimaryRole> for ValidPrimaryKeyAmalgamation<'a, P> where
    P: 'a + KeyParts, 

fn primary(&self) -> bool

Returns whether the key amalgamation is a primary key amalgamation.

impl<'a> TryFrom<&'a ValidKeyAmalgamation<'a, PublicParts, PrimaryRole, ()>> for &'a ValidPrimaryKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: &'a ValidPrimaryKeyAmalgamation<'a, PublicParts>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a ValidKeyAmalgamation<'a, UnspecifiedParts, PrimaryRole, ()>> for &'a ValidPrimaryKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    p: &'a ValidPrimaryKeyAmalgamation<'a, UnspecifiedParts>
) -> Result<Self>

Performs the conversion.

impl<'a, P, P2> TryFrom<ValidKeyAmalgamation<'a, P, UnspecifiedRole, bool>> for ValidPrimaryKeyAmalgamation<'a, P2> where
    P: 'a + KeyParts,
    P2: 'a + KeyParts, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(vka: ValidErasedKeyAmalgamation<'a, P>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<ValidKeyAmalgamation<'a, PublicParts, PrimaryRole, ()>> for ValidPrimaryKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: ValidPrimaryKeyAmalgamation<'a, PublicParts>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<ValidKeyAmalgamation<'a, UnspecifiedParts, PrimaryRole, ()>> for ValidPrimaryKeyAmalgamation<'a, SecretParts>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    p: ValidPrimaryKeyAmalgamation<'a, UnspecifiedParts>
) -> Result<Self>

Performs the conversion.

impl<'a, P> ValidateAmalgamation<'a, Key<P, PrimaryRole>> for ValidPrimaryKeyAmalgamation<'a, P> where
    P: 'a + KeyParts, 

type V = Self

The type returned by with_policy.

fn with_policy<T>(self, policy: &'a dyn Policy, time: T) -> Result<Self::V> where
    T: Into<Option<SystemTime>>,
    Self: Sized, 

Uses the specified Policy and reference time with the amalgamation.