Skip to main content

SecurityConfig

Struct SecurityConfig 

Source
pub struct SecurityConfig { /* private fields */ }
Expand description

Builder for DDS Security configuration.

Security is enabled by setting specific QoS properties that tell CycloneDDS which plugins to load and where to find certificates, keys, and policy files.

Implementations§

Source§

impl SecurityConfig

Source

pub fn new() -> Self

Create a new security config with default plugin names.

Source

pub fn identity_ca(self, path: impl Into<String>) -> Self

Path to the Identity CA certificate (PEM).

Source

pub fn identity_certificate(self, path: impl Into<String>) -> Self

Path to the participant identity certificate (PEM).

Source

pub fn identity_private_key(self, path: impl Into<String>) -> Self

Path to the participant identity private key (PEM).

Source

pub fn governance(self, path: impl Into<String>) -> Self

Path to the Governance XML document.

Source

pub fn permissions(self, path: impl Into<String>) -> Self

Path to the Permissions XML document.

Source

pub fn permissions_ca(self, path: impl Into<String>) -> Self

Path to the Permissions CA certificate (PEM).

Source

pub fn crl(self, path: impl Into<String>) -> Self

Path to the Certificate Revocation List (CRL) in PEM format.

Source

pub fn auth_plugin(self, name: impl Into<String>) -> Self

Override the authentication plugin name (default: dds.sec.auth.builtin.PKI-DH).

Source

pub fn access_plugin(self, name: impl Into<String>) -> Self

Override the access-control plugin name (default: dds.sec.access.builtin.Access-Permissions).

Source

pub fn crypto_plugin(self, name: impl Into<String>) -> Self

Override the cryptography plugin name (default: dds.sec.crypto.builtin.AES-GCM-GMAC).

Source

pub fn validate(&self) -> DdsResult<()>

Validate that all configured certificate and policy files exist and appear to be valid PEM documents.

Returns Ok(()) if all configured files are present and readable, or Err with a description of the first problem found.

Source

pub fn reload(&self) -> Self

Create a new SecurityConfig with the same settings.

This is a semantic wrapper for certificate hot-reload workflows: after updating certificate files on disk, call reload() and then validate() before recreating the DomainParticipant.

Source

pub fn apply_to(self, builder: QosBuilder) -> QosBuilder

Apply this security configuration to a QosBuilder.

Trait Implementations§

Source§

impl Clone for SecurityConfig

Source§

fn clone(&self) -> Self

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 SecurityConfig

Source§

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

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

impl Default for SecurityConfig

Source§

fn default() -> Self

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

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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