Struct x509_certificate::certificate::X509Certificate
source · [−]pub struct X509Certificate(_);
Expand description
Provides an interface to the RFC 5280 rfc5280::Certificate ASN.1 type.
This type provides the main high-level API that this crate exposes for reading and writing X.509 certificates.
Instances are backed by an actual ASN.1 rfc5280::Certificate instance. Read operations are performed against the raw ASN.1 values. Mutations result in mutations of the ASN.1 data structures.
Instances can be converted to/from rfc5280::Certificate using traits. AsRef/AsMut are implemented to obtain a reference to the backing rfc5280::Certificate.
We have chosen not to implement Deref/DerefMut because we don’t want to pollute the type’s API with lower-level ASN.1 primitives.
This type does not track the original data from which it came. If you want a type that does that, consider CapturedX509Certificate, which implements Deref and therefore behaves like this type.
Implementations
sourceimpl X509Certificate
impl X509Certificate
sourcepub fn from_der(data: impl AsRef<[u8]>) -> Result<Self, Error>
pub fn from_der(data: impl AsRef<[u8]>) -> Result<Self, Error>
Construct an instance by parsing DER encoded ASN.1 data.
sourcepub fn from_ber(data: impl AsRef<[u8]>) -> Result<Self, Error>
pub fn from_ber(data: impl AsRef<[u8]>) -> Result<Self, Error>
Construct an instance by parsing BER encoded ASN.1 data.
X.509 certificates are likely (and should be) using DER encoding. However, some specifications do mandate the use of BER, so this method is provided.
sourcepub fn from_pem(data: impl AsRef<[u8]>) -> Result<Self, Error>
pub fn from_pem(data: impl AsRef<[u8]>) -> Result<Self, Error>
Construct an instance by parsing PEM encoded ASN.1 data.
The data is a human readable string likely containing
--------- BEGIN CERTIFICATE ----------
.
sourcepub fn from_pem_multiple(data: impl AsRef<[u8]>) -> Result<Vec<Self>, Error>
pub fn from_pem_multiple(data: impl AsRef<[u8]>) -> Result<Vec<Self>, Error>
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.
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.
sourcepub fn serial_number_asn1(&self) -> &Integer
pub fn serial_number_asn1(&self) -> &Integer
Obtain the serial number as the ASN.1 Integer type.
sourcepub fn subject_name(&self) -> &Name
pub fn subject_name(&self) -> &Name
Obtain the certificate’s subject, as its ASN.1 Name type.
sourcepub fn subject_common_name(&self) -> Option<String>
pub fn subject_common_name(&self) -> Option<String>
Obtain the Common Name (CN) attribute from the certificate’s subject, if set and decodable.
sourcepub fn issuer_name(&self) -> &Name
pub fn issuer_name(&self) -> &Name
Obtain the certificate’s issuer, as its ASN.1 Name type.
sourcepub fn issuer_common_name(&self) -> Option<String>
pub fn issuer_common_name(&self) -> Option<String>
Obtain the Common Name (CN) attribute from the certificate’s issuer, if set and decodable.
sourcepub fn iter_extensions(&self) -> impl Iterator<Item = &Extension>
pub fn iter_extensions(&self) -> impl Iterator<Item = &Extension>
Iterate over extensions defined in this certificate.
sourcepub fn encode_der_to(&self, fh: &mut impl Write) -> Result<(), Error>
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.
sourcepub fn encode_ber_to(&self, fh: &mut impl Write) -> Result<(), Error>
pub fn encode_ber_to(&self, fh: &mut impl Write) -> Result<(), Error>
Encode the certificate data structure use BER encoding.
sourcepub fn encode_der(&self) -> Result<Vec<u8>, Error>
pub fn encode_der(&self) -> Result<Vec<u8>, Error>
Encode the internal ASN.1 data structures to DER.
sourcepub fn encode_ber(&self) -> Result<Vec<u8>, Error>
pub fn encode_ber(&self) -> Result<Vec<u8>, Error>
Obtain the BER encoded representation of this certificate.
sourcepub fn write_pem(&self, fh: &mut impl Write) -> Result<(), Error>
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.
sourcepub fn encode_pem(&self) -> Result<String, Error>
pub fn encode_pem(&self) -> Result<String, Error>
Encode the certificate to a PEM string.
sourcepub fn key_algorithm(&self) -> Option<KeyAlgorithm>
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.
sourcepub fn key_algorithm_oid(&self) -> &Oid
pub fn key_algorithm_oid(&self) -> &Oid
Obtain the OID of the private key’s algorithm.
sourcepub fn signature_algorithm(&self) -> Option<SignatureAlgorithm>
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).
sourcepub fn signature_algorithm_oid(&self) -> &Oid
pub fn signature_algorithm_oid(&self) -> &Oid
Obtain the OID of the signature algorithm this certificate will use.
sourcepub fn signature_signature_algorithm(&self) -> Option<SignatureAlgorithm>
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).
sourcepub fn signature_signature_algorithm_oid(&self) -> &Oid
pub fn signature_signature_algorithm_oid(&self) -> &Oid
Obtain the OID of the signature algorithm used to sign this certificate.
sourcepub fn public_key_data(&self) -> Bytes
pub fn public_key_data(&self) -> Bytes
Obtain the raw data constituting this certificate’s public key.
A copy of the data is returned.
sourcepub fn rsa_public_key_data(&self) -> Result<RsaPublicKey, Error>
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
.
sourcepub fn compare_issuer(&self, other: &Self) -> Ordering
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.
sourcepub fn subject_is_issuer(&self) -> bool
pub fn subject_is_issuer(&self) -> bool
sourcepub fn fingerprint(&self, algorithm: DigestAlgorithm) -> Result<Digest, Error>
pub fn fingerprint(&self, algorithm: DigestAlgorithm) -> Result<Digest, Error>
Obtain the fingerprint for this certificate given a digest algorithm.
sourcepub fn sha1_fingerprint(&self) -> Result<Digest, Error>
pub fn sha1_fingerprint(&self) -> Result<Digest, Error>
Obtain the SHA-1 fingerprint of this certificate.
sourcepub fn sha256_fingerprint(&self) -> Result<Digest, Error>
pub fn sha256_fingerprint(&self) -> Result<Digest, Error>
Obtain the SHA-256 fingerprint of this certificate.
Trait Implementations
sourceimpl AsMut<Certificate> for X509Certificate
impl AsMut<Certificate> for X509Certificate
sourcefn as_mut(&mut self) -> &mut Certificate
fn as_mut(&mut self) -> &mut Certificate
Converts this type into a mutable reference of the (usually inferred) input type.
sourceimpl AsRef<Certificate> for X509Certificate
impl AsRef<Certificate> for X509Certificate
sourcefn as_ref(&self) -> &Certificate
fn as_ref(&self) -> &Certificate
Converts this type into a shared reference of the (usually inferred) input type.
sourceimpl AsRef<X509Certificate> for CapturedX509Certificate
impl AsRef<X509Certificate> for CapturedX509Certificate
sourcefn as_ref(&self) -> &X509Certificate
fn as_ref(&self) -> &X509Certificate
Converts this type into a shared reference of the (usually inferred) input type.
sourceimpl Clone for X509Certificate
impl Clone for X509Certificate
sourcefn clone(&self) -> X509Certificate
fn clone(&self) -> X509Certificate
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for X509Certificate
impl Debug for X509Certificate
sourceimpl EncodePublicKey for X509Certificate
impl EncodePublicKey for X509Certificate
sourcefn to_public_key_der(&self) -> Result<PublicKeyDocument>
fn to_public_key_der(&self) -> Result<PublicKeyDocument>
Serialize a PublicKeyDocument
containing a SPKI-encoded public key.
sourceimpl From<Certificate> for X509Certificate
impl From<Certificate> for X509Certificate
sourcefn from(v: Certificate) -> Self
fn from(v: Certificate) -> Self
Converts to this type from the input type.
sourceimpl From<X509Certificate> for Certificate
impl From<X509Certificate> for Certificate
sourcefn from(v: X509Certificate) -> Self
fn from(v: X509Certificate) -> Self
Converts to this type from the input type.
sourceimpl PartialEq<X509Certificate> for X509Certificate
impl PartialEq<X509Certificate> for X509Certificate
sourcefn eq(&self, other: &X509Certificate) -> bool
fn eq(&self, other: &X509Certificate) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &X509Certificate) -> bool
fn ne(&self, other: &X509Certificate) -> bool
This method tests for !=
.
sourceimpl TryFrom<&'_ X509Certificate> for CapturedX509Certificate
impl TryFrom<&'_ X509Certificate> for CapturedX509Certificate
type Error = X509CertificateError
type Error = X509CertificateError
The type returned in the event of a conversion error.
sourcefn try_from(cert: &X509Certificate) -> Result<Self, Self::Error>
fn try_from(cert: &X509Certificate) -> Result<Self, Self::Error>
Performs the conversion.
sourceimpl TryFrom<X509Certificate> for CapturedX509Certificate
impl TryFrom<X509Certificate> for CapturedX509Certificate
type Error = X509CertificateError
type Error = X509CertificateError
The type returned in the event of a conversion error.
sourcefn try_from(cert: X509Certificate) -> Result<Self, Self::Error>
fn try_from(cert: X509Certificate) -> Result<Self, Self::Error>
Performs the conversion.
impl Eq for X509Certificate
impl StructuralEq for X509Certificate
impl StructuralPartialEq for X509Certificate
Auto Trait Implementations
impl RefUnwindSafe for X509Certificate
impl Send for X509Certificate
impl Sync for X509Certificate
impl Unpin for X509Certificate
impl UnwindSafe for X509Certificate
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more