Skip to main content

AlgorithmProperties

Struct AlgorithmProperties 

Source
#[non_exhaustive]
pub struct AlgorithmProperties { pub primitive: CryptoPrimitive, pub algorithm_family: Option<String>, pub parameter_set_identifier: Option<String>, pub mode: Option<CryptoMode>, pub padding: Option<CryptoPadding>, pub crypto_functions: Vec<CryptoFunction>, pub execution_environment: Option<ExecutionEnvironment>, pub implementation_platform: Option<ImplementationPlatform>, pub certification_level: Vec<CertificationLevel>, pub classical_security_level: Option<u32>, pub nist_quantum_security_level: Option<u8>, pub elliptic_curve: Option<String>, }
Expand description

Properties of a cryptographic algorithm asset.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§primitive: CryptoPrimitive

Cryptographic primitive category.

§algorithm_family: Option<String>

Algorithm family name (e.g., “AES”, “ML-KEM”, “SHA-2”). CycloneDX 1.7+.

§parameter_set_identifier: Option<String>

Parameter set identifier (e.g., “256”, “1024”, “P-384”).

§mode: Option<CryptoMode>

Block cipher mode of operation.

§padding: Option<CryptoPadding>

Padding scheme.

§crypto_functions: Vec<CryptoFunction>

Cryptographic functions this algorithm supports.

§execution_environment: Option<ExecutionEnvironment>

Execution environment.

§implementation_platform: Option<ImplementationPlatform>

Implementation platform.

§certification_level: Vec<CertificationLevel>

Certification levels achieved.

§classical_security_level: Option<u32>

Classical security level in bits.

§nist_quantum_security_level: Option<u8>

NIST post-quantum security category (0 = vulnerable, 1-5 = increasing resistance).

§elliptic_curve: Option<String>

Elliptic curve identifier (CycloneDX 1.7+, e.g., “secg/secp521r1”).

Implementations§

Source§

impl AlgorithmProperties

Source

pub fn new(primitive: CryptoPrimitive) -> Self

Create new algorithm properties with the given primitive.

Source

pub fn is_quantum_safe(&self) -> bool

Returns true if this algorithm has post-quantum security (nistQuantumSecurityLevel > 0).

Source

pub fn is_hybrid_pqc(&self) -> bool

Returns true if this is a hybrid PQC scheme (combiner primitive).

Source

pub fn is_weak(&self) -> bool

Returns true if the algorithm is considered broken or weak. Checks algorithm_family first, then falls back to matching common weak names in the parameter_set_identifier.

Source

pub fn is_weak_by_name(&self, component_name: &str) -> bool

Returns true if the algorithm is considered broken or weak, using the component name as a fallback when algorithm_family is absent.

Source

pub fn effective_security_bits(&self) -> Option<u32>

Returns the classical security level in bits, if known.

Source

pub fn with_algorithm_family(self, family: String) -> Self

Source

pub fn with_parameter_set_identifier(self, id: String) -> Self

Source

pub fn with_mode(self, mode: CryptoMode) -> Self

Source

pub fn with_padding(self, padding: CryptoPadding) -> Self

Source

pub fn with_crypto_functions(self, funcs: Vec<CryptoFunction>) -> Self

Source

pub fn with_execution_environment(self, env: ExecutionEnvironment) -> Self

Source

pub fn with_implementation_platform( self, platform: ImplementationPlatform, ) -> Self

Source

pub fn with_certification_level(self, levels: Vec<CertificationLevel>) -> Self

Source

pub fn with_classical_security_level(self, bits: u32) -> Self

Source

pub fn with_nist_quantum_security_level(self, level: u8) -> Self

Source

pub fn with_elliptic_curve(self, curve: String) -> Self

Trait Implementations§

Source§

impl Clone for AlgorithmProperties

Source§

fn clone(&self) -> AlgorithmProperties

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AlgorithmProperties

Source§

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

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

impl<'de> Deserialize<'de> for AlgorithmProperties

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for AlgorithmProperties

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Serialize for AlgorithmProperties

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for AlgorithmProperties

Source§

impl StructuralPartialEq for AlgorithmProperties

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,