Skip to content

x509-cert: rename builder::BuildProfile to avoid confusion #1514

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.

Sign up for GitHub

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

Merged
baloo merged 1 commit into from
Sep 10, 2024
Merged

x509-cert: rename builder::BuildProfile to avoid confusion #1514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions x509-cert/src/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,13 @@ use crate::{

pub mod profile;

use self::profile::Profile;
use self::profile::BuildProfile;

#[deprecated(
since = "0.3.0",
note = "please use `x509_cert::builder::profile::BuildProfile` instead"
)]
pub use self::profile::BuildProfile as Profile;

@baloo baloo Sep 10, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This re-export is where the Profile was placed in x509-cert v0.2


const NULL_OID: ObjectIdentifier = ObjectIdentifier::new_unwrap("0.0.0");

Expand Down Expand Up @@ -146,7 +152,7 @@ pub struct CertificateBuilder<P> {

impl<P> CertificateBuilder<P>
where
P: Profile,
P: BuildProfile,
{
/// Creates a new certificate builder
pub fn new(
Expand Down Expand Up @@ -338,7 +344,7 @@ pub trait Builder: Sized {

impl<P> Builder for CertificateBuilder<P>
where
P: Profile,
P: BuildProfile,
{
type Output = Certificate;

Expand Down
9 changes: 7 additions & 2 deletions x509-cert/src/builder/profile.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! Certificate profiles
//!
//! Profiles need implement by the [`Profile`] trait.
//! Profiles need implement by the [`BuildProfile`] trait.
//! They may then be consumed by a [`builder::CertificateBuilder`].
//!
//!
Expand All @@ -24,7 +24,12 @@ pub mod cabf;
pub mod devid;

/// Profile for certificates
pub trait Profile {
///
/// The profile will define the various extensions to add to a certificate, this may be used to
/// generate a [`cabf::Root`], or a TLS [`cabf::tls::Subscriber`] certificate.
///
/// See [implementors](#implementors) for a full list of existing profiles.
pub trait BuildProfile {
/// Issuer to be used for issued certificates
fn get_issuer(&self, subject: &Name) -> Name;

Expand Down
4 changes: 2 additions & 2 deletions x509-cert/src/builder/profile/cabf.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use alloc::vec;
use std::collections::HashSet;

use crate::{
builder::{Error, Profile, Result},
builder::{BuildProfile, Error, Result},
certificate::TbsCertificate,
ext::{
pkix::{
Expand Down Expand Up @@ -123,7 +123,7 @@ impl Root {
}
}

impl Profile for Root {
impl BuildProfile for Root {
fn get_issuer(&self, subject: &Name) -> Name {
subject.clone()
}
Expand Down
6 changes: 3 additions & 3 deletions x509-cert/src/builder/profile/cabf/tls.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use const_oid::db::rfc5912;

use crate::{
attr::AttributeTypeAndValue,
builder::{Profile, Result},
builder::{BuildProfile, Result},
certificate::TbsCertificate,
ext::{
pkix::{
Expand Down Expand Up @@ -50,7 +50,7 @@ pub struct Subordinate {
pub client_auth: bool,
}

impl Profile for Subordinate {
impl BuildProfile for Subordinate {
fn get_issuer(&self, _subject: &Name) -> Name {
self.issuer.clone()
}
Expand Down Expand Up @@ -231,7 +231,7 @@ pub struct Tls12Options {
pub enable_key_agreement: bool,
}

impl Profile for Subscriber {
impl BuildProfile for Subscriber {
fn get_issuer(&self, _subject: &Name) -> Name {
self.issuer.clone()
}
Expand Down
4 changes: 2 additions & 2 deletions x509-cert/src/builder/profile/devid.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
use alloc::vec;

use crate::{
builder::{Profile, Result},
builder::{BuildProfile, Result},
certificate::TbsCertificate,
ext::{
pkix::{
Expand Down Expand Up @@ -112,7 +112,7 @@ impl DevId {
}
}

impl Profile for DevId {
impl BuildProfile for DevId {
fn get_issuer(&self, _subject: &Name) -> Name {
self.issuer.clone()
}
Expand Down