Struct HeldCertificate 

#[non_exhaustive]
pub struct HeldCertificate {
    pub key_fingerprint: String,
    pub key_must_be_replaced: bool,
    pub name: String,
    pub not_after: Option<String>,
    pub profile: Option<String>,
    pub revoked: bool,
    pub usable: bool,
}

A certificate Canopy holds for the asking server, as the server needs to see it: enough to decide whether to renew, and nothing about anyone else.

JSON schema

{
 "description": "A certificate Canopy holds for the asking server, as the server needs to see\nit: enough to decide whether to renew, and nothing about anyone else.",
 "type": "object",
 "required": [
   "key_fingerprint",
   "key_must_be_replaced",
   "name",
   "revoked",
   "usable"
 ],
 "properties": {
   "key_fingerprint": {
     "description": "Hex SHA-256 of the certified key's subject public key info, so an agent\ncan tell whether this covers a key it still holds.",
     "type": "string"
   },
   "key_must_be_replaced": {
     "description": "Whether the key itself is condemned, not just the certificate — the key\npair has to be replaced before asking again.",
     "type": "boolean"
   },
   "name": {
     "description": "The name it covers.",
     "type": "string"
   },
   "not_after": {
     "description": "When it expires.",
     "type": [
       "string",
       "null"
     ]
   },
   "profile": {
     "description": "The profile it was issued under, if the authority named one.",
     "type": [
       "string",
       "null"
     ]
   },
   "revoked": {
     "description": "Whether an operator has revoked it. Stop serving it.",
     "type": "boolean"
   },
   "usable": {
     "description": "Whether it can still be served: not revoked, not expired. True even while\na renewal is under way, the chain in hand staying valid until the new one\nlands.",
     "type": "boolean"
   }
 }
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key_fingerprint: String

Hex SHA-256 of the certified key’s subject public key info, so an agent can tell whether this covers a key it still holds.

key_must_be_replaced: bool

Whether the key itself is condemned, not just the certificate — the key pair has to be replaced before asking again.

name: String

The name it covers.

not_after: Option<String>

When it expires.

profile: Option<String>

The profile it was issued under, if the authority named one.

revoked: bool

Whether an operator has revoked it. Stop serving it.

usable: bool

Whether it can still be served: not revoked, not expired. True even while a renewal is under way, the chain in hand staying valid until the new one lands.

Implementations

impl HeldCertificate

pub fn builder() -> HeldCertificateBuilder

Create an instance of HeldCertificate using the builder syntax

Trait Implementations

impl Clone for HeldCertificate

fn clone(&self) -> HeldCertificate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeldCertificate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HeldCertificate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HeldCertificate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.