Skip to content

x509-cert: add a CRL builder #1759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 122 additions & 2 deletions x509-cert/src/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,13 @@ use spki::{
use crate::{
AlgorithmIdentifier, SubjectPublicKeyInfo,
certificate::{Certificate, TbsCertificate, Version},
ext::{AsExtension, Extensions},
crl::{CertificateList, RevokedCert, TbsCertList},
ext::{
AsExtension, Extensions,
pkix::{AuthorityKeyIdentifier, CrlNumber, SubjectKeyIdentifier},
},
serial_number::SerialNumber,
time::Validity,
time::{Time, Validity},
};

pub mod profile;
Expand Down Expand Up @@ -410,3 +414,119 @@ where
<T as Builder>::finalize(self, signer)
}
}

/// X.509 CRL builder
pub struct CrlBuilder {
tbs: TbsCertList,
}

impl CrlBuilder {
/// Create a `CrlBuilder` with the given issuer and the given monotonic [`CrlNumber`]
#[cfg(feature = "std")]
pub fn new(issuer: &Certificate, crl_number: CrlNumber) -> der::Result<Self> {
let this_update = Time::now()?;
Self::new_with_this_update(issuer, crl_number, this_update)
}

/// Create a `CrlBuilder` with the given issuer, a given monotonic [`CrlNumber`], and valid
/// from the given `this_update` start validity date.
pub fn new_with_this_update(
issuer: &Certificate,
crl_number: CrlNumber,
this_update: Time,
) -> der::Result<Self> {
// Replaced later when the finalize is called
let signature_alg = AlgorithmIdentifier {
oid: NULL_OID,
parameters: None,
};

let issuer_name = issuer.tbs_certificate.subject().clone();

let mut crl_extensions = Extensions::new();
crl_extensions.push(crl_number.to_extension(&issuer_name, &crl_extensions)?);
let aki = match issuer
.tbs_certificate
.get_extension::<AuthorityKeyIdentifier>()?
{
Some((_, aki)) => aki,
None => {
let ski = SubjectKeyIdentifier::try_from(
issuer
.tbs_certificate
.subject_public_key_info()
.owned_to_ref(),
)?;
AuthorityKeyIdentifier {
// KeyIdentifier must be the same as subjectKeyIdentifier
key_identifier: Some(ski.0.clone()),
// other fields must not be present.
..Default::default()
}
}
};
crl_extensions.push(aki.to_extension(&issuer_name, &crl_extensions)?);

let tbs = TbsCertList {
version: Version::V2,
signature: signature_alg,
issuer: issuer_name,
this_update,
next_update: None,
revoked_certificates: None,
crl_extensions: Some(crl_extensions),
};

Ok(Self { tbs })
}

/// Make the CRL valid until the given `next_update`
pub fn with_next_update(mut self, next_update: Option<Time>) -> Self {
self.tbs.next_update = next_update;
self
}

/// Add certificates to the revocation list
pub fn with_certificates<I>(mut self, revoked: I) -> Self
where
I: Iterator<Item = RevokedCert>,
{
let certificates = self
.tbs
.revoked_certificates
.get_or_insert_with(vec::Vec::new);

let mut revoked: vec::Vec<RevokedCert> = revoked.collect();
certificates.append(&mut revoked);

self
}
}

impl Builder for CrlBuilder {
type Output = CertificateList;

fn finalize<S>(&mut self, cert_signer: &S) -> Result<vec::Vec<u8>>
where
S: Keypair + DynSignatureAlgorithmIdentifier,
S::VerifyingKey: EncodePublicKey,
{
self.tbs.signature = cert_signer.signature_algorithm_identifier()?;

self.tbs.to_der().map_err(Error::from)
}

fn assemble<S>(self, signature: BitString, _signer: &S) -> Result<Self::Output>
where
S: Keypair + DynSignatureAlgorithmIdentifier,
S::VerifyingKey: EncodePublicKey,
{
let signature_algorithm = self.tbs.signature.clone();

Ok(CertificateList {
tbs_cert_list: self.tbs,
signature_algorithm,
signature,
})
}
}
8 changes: 8 additions & 0 deletions x509-cert/src/crl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ use alloc::vec::Vec;
use der::asn1::BitString;
use der::{Sequence, ValueOrd};

#[cfg(feature = "pem")]
use der::pem::PemLabel;

/// `CertificateList` as defined in [RFC 5280 Section 5.1].
///
/// ```text
Expand All @@ -33,6 +36,11 @@ pub struct CertificateList<P: Profile = Rfc5280> {
pub signature: BitString,
}

#[cfg(feature = "pem")]
impl<P: Profile> PemLabel for CertificateList<P> {
const PEM_LABEL: &'static str = "X509 CRL";
}

/// Implicit intermediate structure from the ASN.1 definition of `TBSCertList`.
///
/// This type is used for the `revoked_certificates` field of `TbsCertList`.
Expand Down
16 changes: 16 additions & 0 deletions x509-cert/src/ext/pkix/crl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,22 @@ impl AssociatedOid for CrlNumber {
impl_newtype!(CrlNumber, Uint);
impl_extension!(CrlNumber, critical = false);

macro_rules! impl_from_traits {
($($uint:ty),+) => {
$(
impl TryFrom<$uint> for CrlNumber {
type Error = der::Error;

fn try_from(value: $uint) -> der::Result<Self> {
Uint::try_from(value).map(Self)
}
}
)+
}
}

impl_from_traits!(u8, u16, u32, u64, u128);

/// BaseCRLNumber as defined in [RFC 5280 Section 5.2.4].
///
/// ```text
Expand Down
4 changes: 4 additions & 0 deletions x509-cert/test-support/src/openssl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ pub fn check_certificate(pem: &[u8]) -> String {
check_openssl_output(&["x509"], pem)
}

pub fn check_crl(pem: &[u8]) -> String {
check_openssl_output(&["crl"], pem)
}

pub fn check_request(pem: &[u8]) -> String {
check_openssl_output(&["req", "-verify"], pem)
}
67 changes: 67 additions & 0 deletions x509-cert/tests/builder_crl.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
#![cfg(all(feature = "builder", feature = "pem"))]

use std::{str::FromStr, time::Duration};

use der::{EncodePem, pem::LineEnding};
use p256::{NistP256, ecdsa::DerSignature, pkcs8::DecodePrivateKey};
use rand::rng;
use x509_cert::{
SubjectPublicKeyInfo,
builder::{Builder, CertificateBuilder, CrlBuilder, profile},
crl::RevokedCert,
ext::pkix::CrlNumber,
name::Name,
serial_number::SerialNumber,
time::{Time, Validity},
};
use x509_cert_test_support::openssl;

const PKCS8_PUBLIC_KEY_DER: &[u8] = include_bytes!("examples/p256-pub.der");
const PKCS8_PRIVATE_KEY_DER: &[u8] = include_bytes!("examples/p256-priv.der");

fn ecdsa_signer() -> ecdsa::SigningKey<NistP256> {
let secret_key = p256::SecretKey::from_pkcs8_der(PKCS8_PRIVATE_KEY_DER).unwrap();
ecdsa::SigningKey::from(secret_key)
}

#[test]
fn crl_signer() {
let mut rng = rng();
let serial_number = SerialNumber::generate(&mut rng);
let validity = Validity::from_now(Duration::new(5, 0)).unwrap();
let subject =
Name::from_str("CN=World domination corporation,O=World domination Inc,C=US").unwrap();
let profile = profile::cabf::Root::new(false, subject).expect("create root profile");
let pub_key = SubjectPublicKeyInfo::try_from(PKCS8_PUBLIC_KEY_DER).expect("get ecdsa pub key");

let signer = ecdsa_signer();
let builder = CertificateBuilder::new(profile, serial_number, validity, pub_key)
.expect("Create certificate");

let ca_certificate = builder.build::<_, DerSignature>(&signer).unwrap();

let crl_number = CrlNumber::try_from(42u128).unwrap();

let builder = CrlBuilder::new(&ca_certificate, crl_number)
.unwrap()
.with_certificates(
vec![
RevokedCert {
serial_number: SerialNumber::generate(&mut rng),
revocation_date: Time::now().unwrap(),
crl_entry_extensions: None,
},
RevokedCert {
serial_number: SerialNumber::generate(&mut rng),
revocation_date: Time::now().unwrap(),
crl_entry_extensions: None,
},
]
.into_iter(),
);

let crl = builder.build::<_, DerSignature>(&signer).unwrap();

let pem = crl.to_pem(LineEnding::LF).expect("generate pem");
println!("{}", openssl::check_crl(pem.as_bytes()));
}