Struct MutableX509Certificate

pub struct MutableX509Certificate(/* private fields */);

Provides a mutable wrapper to an X.509 certificate that was parsed from data.

This is like CapturedX509Certificate except it implements DerefMut, enabling you to modify the certificate while still being able to access the raw data the certificate is backed by. However, mutations are only performed against the parsed ASN.1 data structure, not the original data it was constructed with.

Methods from Deref<Target = X509Certificate>

pub fn serial_number_asn1(&self) -> &Integer

Obtain the serial number as the ASN.1 Integer type.

pub fn subject_name(&self) -> &Name

Obtain the certificate’s subject, as its ASN.1 Name type.

pub fn subject_common_name(&self) -> Option<String>

Obtain the Common Name (CN) attribute from the certificate’s subject, if set and decodable.

pub fn issuer_name(&self) -> &Name

Obtain the certificate’s issuer, as its ASN.1 Name type.

pub fn issuer_common_name(&self) -> Option<String>

Obtain the Common Name (CN) attribute from the certificate’s issuer, if set and decodable.

pub fn iter_extensions(&self) -> impl Iterator<Item = &Extension>

Iterate over extensions defined in this certificate.

pub fn encode_der_to(&self, fh: &mut impl Write) -> Result<(), Error>

Encode the certificate data structure using DER encoding.

(This is the common ASN.1 encoding format for X.509 certificates.)

This always serializes the internal ASN.1 data structure. If you call this on a wrapper type that has retained a copy of the original data, this may emit different data than that copy.

pub fn encode_ber_to(&self, fh: &mut impl Write) -> Result<(), Error>

Encode the certificate data structure use BER encoding.

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

Encode the internal ASN.1 data structures to DER.

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

Obtain the BER encoded representation of this certificate.

pub fn write_pem(&self, fh: &mut impl Write) -> Result<(), Error>

Encode the certificate to PEM.

This will write a human-readable string with ------ BEGIN CERTIFICATE ------- armoring. This is a very common method for encoding certificates.

The underlying binary data is DER encoded.

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

Encode the certificate to a PEM string.

pub fn key_algorithm(&self) -> Option<KeyAlgorithm>

Attempt to resolve a known KeyAlgorithm used by the private key associated with this certificate.

If this crate isn’t aware of the OID associated with the key algorithm, None is returned.

pub fn key_algorithm_oid(&self) -> &Oid

Obtain the OID of the private key’s algorithm.

pub fn signature_algorithm(&self) -> Option<SignatureAlgorithm>

Obtain the [SignatureAlgorithm this certificate will use.

Returns None if we failed to resolve an instance (probably because we don’t recognize the algorithm).

pub fn signature_algorithm_oid(&self) -> &Oid

Obtain the OID of the signature algorithm this certificate will use.

pub fn signature_signature_algorithm(&self) -> Option<SignatureAlgorithm>

Obtain the SignatureAlgorithm used to sign this certificate.

Returns None if we failed to resolve an instance (probably because we don’t recognize that algorithm).

pub fn signature_signature_algorithm_oid(&self) -> &Oid

Obtain the OID of the signature algorithm used to sign this certificate.

pub fn public_key_data(&self) -> Bytes

Obtain the raw data constituting this certificate’s public key.

A copy of the data is returned.

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

Attempt to parse the public key data as RsaPublicKey parameters.

Note that the raw integer value for modulus has a leading 0 byte. So its raw length will be 1 greater than key length. e.g. an RSA 2048 key will have value.modulus.as_slice().len() == 257 instead of 256.

pub fn compare_issuer(&self, other: &Self) -> Ordering

Compare 2 instances, sorting them so the issuer comes before the issued.

This function examines the Self::issuer_name and Self::subject_name fields of 2 certificates, attempting to sort them so the issuing certificate comes before the issued certificate.

This function performs a strict compare of the ASN.1 Name data. The assumption here is that the issuing certificate’s subject Name is identical to the issued’s issuer Name. This assumption is often true. But it likely isn’t always true, so this function may not produce reliable results.

pub fn subject_is_issuer(&self) -> bool

Whether the subject Name is also the issuer’s Name.

This might be a way of determining if a certificate is self-signed. But there can likely be false negatives due to differences in ASN.1 encoding of the underlying data. So we don’t claim this is a test for being self-signed.

pub fn fingerprint(&self, algorithm: DigestAlgorithm) -> Result<Digest, Error>

Obtain the fingerprint for this certificate given a digest algorithm.

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

Obtain the SHA-1 fingerprint of this certificate.

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

Obtain the SHA-256 fingerprint of this certificate.

pub fn tbs_certificate(&self) -> &TbsCertificate

Obtain the raw rfc5280::TbsCertificate for this certificate.

pub fn validity_not_before(&self) -> DateTime<Utc>

Obtain the certificate validity “not before” time.

pub fn validity_not_after(&self) -> DateTime<Utc>

Obtain the certificate validity “not after” time.

pub fn time_constraints_valid( &self, compare_time: Option<DateTime<Utc>>, ) -> bool

Determine whether a time is between the validity constraints in the certificate.

i.e. check whether a certificate is “expired.”

Receives a date time to check against.

If None, the current time is used. This relies on the machine’s wall clock to be accurate, of course.

Trait Implementations

impl Clone for MutableX509Certificate

fn clone(&self) -> MutableX509Certificate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MutableX509Certificate

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

Formats the value using the given formatter.

impl Deref for MutableX509Certificate

type Target = X509Certificate

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for MutableX509Certificate

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<CapturedX509Certificate> for MutableX509Certificate

fn from(cert: CapturedX509Certificate) -> Self

Converts to this type from the input type.

impl PartialEq for MutableX509Certificate

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

impl StructuralPartialEq for MutableX509Certificate