Struct x509_certificate::certificate::CapturedX509Certificate [−][src]
pub struct CapturedX509Certificate { /* fields omitted */ }
Represents an immutable (read-only) X.509 certificate that was parsed from data.
This type implements Deref but not DerefMut, so only functions taking a non-mutable instance are usable.
A copy of the certificate’s raw backing data is stored, facilitating subsequent access.
Implementations
impl CapturedX509Certificate
[src]
impl CapturedX509Certificate
[src]pub fn from_der(data: impl Into<Vec<u8>>) -> Result<Self, Error>
[src]
pub fn from_der(data: impl Into<Vec<u8>>) -> Result<Self, Error>
[src]Construct an instance from DER encoded data.
A copy of this data will be stored in the instance and is guaranteed to be immutable for the lifetime of the instance. The original constructing data can be retrieved later.
pub fn from_ber(data: impl Into<Vec<u8>>) -> Result<Self, Error>
[src]
pub fn from_ber(data: impl Into<Vec<u8>>) -> Result<Self, Error>
[src]Construct an instance from BER encoded data.
A copy of this data will be stored in the instance and is guaranteed to be immutable for the lifetime of the instance, allowing it to be retrieved later.
pub fn from_pem(data: impl AsRef<[u8]>) -> Result<Self, Error>
[src]
pub fn from_pem(data: impl AsRef<[u8]>) -> Result<Self, Error>
[src]Construct an instance by parsing PEM encoded ASN.1 data.
The data is a human readable string likely containing
--------- BEGIN CERTIFICATE ----------
.
pub fn from_pem_multiple(data: impl AsRef<[u8]>) -> Result<Vec<Self>, Error>
[src]
pub fn from_pem_multiple(data: impl AsRef<[u8]>) -> Result<Vec<Self>, Error>
[src]Construct instances by parsing PEM with potentially multiple records.
By default, we only look for --------- BEGIN CERTIFICATE --------
entries and silently ignore unknown ones. If you would like to specify
an alternate set of tags (this is the value after the BEGIN
) to search,
call Self::from_pem_multiple_tags.
pub fn from_pem_multiple_tags(
data: impl AsRef<[u8]>,
tags: &[&str]
) -> Result<Vec<Self>, Error>
[src]
pub fn from_pem_multiple_tags(
data: impl AsRef<[u8]>,
tags: &[&str]
) -> Result<Vec<Self>, Error>
[src]Construct instances by parsing PEM armored DER encoded certificates with specific PEM tags.
This is like Self::from_pem_multiple except you control the filter for
which BEGIN <tag>
values are filtered through to the DER parser.
pub fn constructed_data(&self) -> &[u8]ⓘ
[src]
pub fn constructed_data(&self) -> &[u8]ⓘ
[src]Obtain the DER data that was used to construct this instance.
The data is guaranteed to not have been modified since the instance was constructed.
pub fn encode_pem(&self) -> String
[src]
pub fn encode_pem(&self) -> String
[src]Encode the original contents of this certificate to PEM.
pub fn verify_signed_by_certificate(
&self,
other: impl AsRef<X509Certificate>
) -> Result<(), Error>
[src]
pub fn verify_signed_by_certificate(
&self,
other: impl AsRef<X509Certificate>
) -> Result<(), Error>
[src]Verify that another certificate, other
, signed this certificate.
If this is a self-signed certificate, you can pass self
as the 2nd
argument.
This function isn’t exposed on X509Certificate because the exact bytes constituting the certificate’s internals need to be consulted to verify signatures. And since this type tracks the underlying bytes, we are guaranteed to have a pristine copy.
pub fn verify_signed_by_public_key(
&self,
public_key_data: impl AsRef<[u8]>
) -> Result<(), Error>
[src]
pub fn verify_signed_by_public_key(
&self,
public_key_data: impl AsRef<[u8]>
) -> Result<(), Error>
[src]Verifies that this certificate was cryptographically signed using raw public key data from a signing key.
This function does the low-level work of extracting the signature and verification details from the current certificate and figuring out the correct combination of cryptography settings to apply to perform signature verification.
In many cases, an X.509 certificate is signed by another certificate. And since the public key is embedded in the X.509 certificate, it is easier to go through Self::verify_signed_by_certificate instead.
pub fn find_signing_certificate<'a>(
&self,
certs: impl Iterator<Item = &'a Self>
) -> Option<&'a Self>
[src]
pub fn find_signing_certificate<'a>(
&self,
certs: impl Iterator<Item = &'a Self>
) -> Option<&'a Self>
[src]Attempt to find the issuing certificate of this one.
Given an iterable of certificates, we find the first certificate where we are able to verify that our signature was made by their public key.
This function can yield false negatives for cases where we don’t support the signature algorithm on the incoming certificates.
pub fn resolve_signing_chain<'a>(
&self,
certs: impl Iterator<Item = &'a Self>
) -> Vec<&'a Self>ⓘ
[src]
pub fn resolve_signing_chain<'a>(
&self,
certs: impl Iterator<Item = &'a Self>
) -> Vec<&'a Self>ⓘ
[src]Attempt to resolve the signing chain of this certificate.
Given an iterable of certificates, we recursively resolve the chain of certificates that signed this one until we are no longer able to find any more certificates in the input set.
Like Self::find_signing_certificate, this can yield false negatives (read: an incomplete chain) due to run-time failures, such as lack of support for a certificate’s signature algorithm.
As a certificate is encountered, it is removed from the set of future candidates.
The traversal ends when we get to an identical certificate (its DER data is equivalent) or we couldn’t find a certificate in the remaining set that signed the last one.
Because we need to recursively verify certificates, the incoming iterator is buffered.
Methods from Deref<Target = X509Certificate>
pub fn serial_number_asn1(&self) -> &Integer
[src]
pub fn serial_number_asn1(&self) -> &Integer
[src]Obtain the serial number as the ASN.1 Integer type.
pub fn subject_name(&self) -> &Name
[src]
pub fn subject_name(&self) -> &Name
[src]Obtain the certificate’s subject, as its ASN.1 Name type.
pub fn subject_common_name(&self) -> Option<String>
[src]
pub fn subject_common_name(&self) -> Option<String>
[src]Obtain the Common Name (CN) attribute from the certificate’s subject, if set and decodable.
pub fn issuer_name(&self) -> &Name
[src]
pub fn issuer_name(&self) -> &Name
[src]Obtain the certificate’s issuer, as its ASN.1 Name type.
pub fn encode_der_to(&self, fh: &mut impl Write) -> Result<(), Error>
[src]
pub fn encode_der_to(&self, fh: &mut impl Write) -> Result<(), Error>
[src]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>
[src]
pub fn encode_ber_to(&self, fh: &mut impl Write) -> Result<(), Error>
[src]Encode the certificate data structure use BER encoding.
pub fn encode_der(&self) -> Result<Vec<u8>, Error>
[src]
pub fn encode_der(&self) -> Result<Vec<u8>, Error>
[src]Encode the internal ASN.1 data structures to DER.
pub fn encode_ber(&self) -> Result<Vec<u8>, Error>
[src]
pub fn encode_ber(&self) -> Result<Vec<u8>, Error>
[src]Obtain the BER encoded representation of this certificate.
pub fn write_pem(&self, fh: &mut impl Write) -> Result<(), Error>
[src]
pub fn write_pem(&self, fh: &mut impl Write) -> Result<(), Error>
[src]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>
[src]
pub fn encode_pem(&self) -> Result<String, Error>
[src]Encode the certificate to a PEM string.
pub fn key_algorithm(&self) -> Option<KeyAlgorithm>
[src]
pub fn key_algorithm(&self) -> Option<KeyAlgorithm>
[src]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
[src]
pub fn key_algorithm_oid(&self) -> &Oid
[src]Obtain the OID of the private key’s algorithm.
pub fn signature_algorithm(&self) -> Option<SignatureAlgorithm>
[src]
pub fn signature_algorithm(&self) -> Option<SignatureAlgorithm>
[src]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_algorithm_oid(&self) -> &Oid
[src]
pub fn signature_algorithm_oid(&self) -> &Oid
[src]Obtain the OID of the signature algorithm used to sign this certificate.
pub fn public_key_data(&self) -> Bytes
[src]
pub fn public_key_data(&self) -> Bytes
[src]Obtain the raw data constituting this certificate’s public key.
A copy of the data is returned.
pub fn compare_issuer(&self, other: &Self) -> Ordering
[src]
pub fn compare_issuer(&self, other: &Self) -> Ordering
[src]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
[src]
pub fn subject_is_issuer(&self) -> bool
[src]Trait Implementations
impl AsRef<Certificate> for CapturedX509Certificate
[src]
impl AsRef<Certificate> for CapturedX509Certificate
[src]fn as_ref(&self) -> &Certificate
[src]
fn as_ref(&self) -> &Certificate
[src]Performs the conversion.
impl AsRef<X509Certificate> for CapturedX509Certificate
[src]
impl AsRef<X509Certificate> for CapturedX509Certificate
[src]fn as_ref(&self) -> &X509Certificate
[src]
fn as_ref(&self) -> &X509Certificate
[src]Performs the conversion.
impl Clone for CapturedX509Certificate
[src]
impl Clone for CapturedX509Certificate
[src]fn clone(&self) -> CapturedX509Certificate
[src]
fn clone(&self) -> CapturedX509Certificate
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for CapturedX509Certificate
[src]
impl Debug for CapturedX509Certificate
[src]impl Deref for CapturedX509Certificate
[src]
impl Deref for CapturedX509Certificate
[src]type Target = X509Certificate
type Target = X509Certificate
The resulting type after dereferencing.
impl From<CapturedX509Certificate> for Certificate
[src]
impl From<CapturedX509Certificate> for Certificate
[src]fn from(cert: CapturedX509Certificate) -> Self
[src]
fn from(cert: CapturedX509Certificate) -> Self
[src]Performs the conversion.
impl From<CapturedX509Certificate> for MutableX509Certificate
[src]
impl From<CapturedX509Certificate> for MutableX509Certificate
[src]fn from(cert: CapturedX509Certificate) -> Self
[src]
fn from(cert: CapturedX509Certificate) -> Self
[src]Performs the conversion.
impl Hash for CapturedX509Certificate
[src]
impl Hash for CapturedX509Certificate
[src]impl TryFrom<&'_ X509Certificate> for CapturedX509Certificate
[src]
impl TryFrom<&'_ X509Certificate> for CapturedX509Certificate
[src]impl Eq for CapturedX509Certificate
[src]
Auto Trait Implementations
impl RefUnwindSafe for CapturedX509Certificate
impl Send for CapturedX509Certificate
impl Sync for CapturedX509Certificate
impl Unpin for CapturedX509Certificate
impl UnwindSafe for CapturedX509Certificate
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more