Skip to main content

Capabilities

Struct Capabilities 

Source
pub struct Capabilities {
    pub key_usage: KeyUsages,
    pub basic_constraints: BasicConstraints,
}
Expand description

An abstraction over X.509 Extensions and PKCS#10 Attributes, representing the capabilities of a certificate. Capabilities can be converted from and to both Attributes and Extensions.

This struct only covers the Attributes/Extensions currently relevant to polyproto.

Fields§

§key_usage: KeyUsages

The key usage extension defines the purpose of the key contained in the certificate.

§basic_constraints: BasicConstraints

Extension type that defines whether a given certificate is allowed to sign additional certificates and what path length restrictions may exist.

Implementations§

Source§

impl Capabilities

Source

pub fn default_actor() -> Self

Sane default for actor ID-CSR/ID-Cert Capabilities. Uses the DigitalSignature flag, not the ContentCommitment flag.

Source

pub fn default_home_server() -> Self

Sane default for home server ID-CSR/ID-Cert Capabilities.

Source

pub fn validate(&self) -> Result<(), ConstraintError>

Validates that these capabilities are well-formed according to X.509 and polyproto constraints. This validation is target-independent.

§Errors

Returns a crate::errors::ConstraintError if the capabilities are malformed.

Source

pub fn validate_for_actor(&self) -> Result<(), ConstraintError>

Validates that these capabilities are correct for an actor certificate.

In addition to the base validation, this checks:

  • The CA flag must be false
  • Must have DigitalSignature or ContentCommitment
  • Must not have KeyCertSign
§Errors

Returns a crate::errors::ConstraintError if the capabilities are not valid for an actor.

Source

pub fn validate_for_home_server(&self) -> Result<(), ConstraintError>

Validates that these capabilities are correct for a home server certificate.

In addition to the base validation, this checks:

  • The CA flag must be true
  • Must have KeyCertSign
§Errors

Returns a crate::errors::ConstraintError if the capabilities are not valid for a home server.

Trait Implementations§

Source§

impl Clone for Capabilities

Source§

fn clone(&self) -> Capabilities

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Capabilities

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Capabilities

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Capabilities

Source§

impl From<ActorCapabilities> for Capabilities

Source§

fn from(value: ActorCapabilities) -> Self

Converts to this type from the input type.
Source§

impl From<HomeServerCapabilities> for Capabilities

Source§

fn from(value: HomeServerCapabilities) -> Self

Converts to this type from the input type.
Source§

impl Hash for Capabilities

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Capabilities

Source§

fn cmp(&self, other: &Capabilities) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Capabilities

Source§

fn eq(&self, other: &Capabilities) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Capabilities

Source§

fn partial_cmp(&self, other: &Capabilities) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for Capabilities

Source§

impl TryFrom<Capabilities> for Attributes

Source§

fn try_from(value: Capabilities) -> Result<Self, Self::Error>

Performs the conversion.

Fails, if Capabilities::validate() fails.

Source§

type Error = CertificateConversionError

The type returned in the event of a conversion error.
Source§

impl TryFrom<Capabilities> for Extensions

Source§

fn try_from(value: Capabilities) -> Result<Self, Self::Error>

Performs the conversion.

try_from does not check whether the resulting Extensions are well-formed.

Source§

type Error = CertificateConversionError

The type returned in the event of a conversion error.
Source§

impl TryFrom<Capabilities> for ActorCapabilities

Source§

type Error = ConstraintError

The type returned in the event of a conversion error.
Source§

fn try_from(value: Capabilities) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Capabilities> for HomeServerCapabilities

Source§

type Error = ConstraintError

The type returned in the event of a conversion error.
Source§

fn try_from(value: Capabilities) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<SetOfVec<Attribute>> for Capabilities

Source§

fn try_from(value: Attributes) -> Result<Self, Self::Error>

Performs the conversion.

Fails if the BasicConstraints or KeyUsages are malformed. The constraints returned by this method are not guaranteed to be valid. You should call validate() on the result to ensure that the constraints are valid according to the X.509 standard and the polyproto specification.

Source§

type Error = CertificateConversionError

The type returned in the event of a conversion error.
Source§

impl TryFrom<Vec<Extension>> for Capabilities

Source§

fn try_from(value: Extensions) -> Result<Self, Self::Error>

Performs the conversion.

try_from does not check whether the resulting Capabilities are well-formed. If this property is critical, use the Capabilities::validate() method to verify the well-formedness of these resulting Capabilities.

Source§

type Error = CertificateConversionError

The type returned in the event of a conversion error.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.