Struct SessionSecuritySettingsBuilder

pub struct SessionSecuritySettingsBuilder { /* private fields */ }

Implementations

impl SessionSecuritySettingsBuilder

pub fn with_security_level( self, security_level: SecurityLevel, ) -> SessionSecuritySettingsBuilder

Sets the maximum security level for the session, allowing the use of multi-layered encryption on a per-message basis as well as increased difficulty in breaking the recursive chain key (default: low)

use citadel_proto::prelude::*;
SessionSecuritySettingsBuilder::default()
.with_security_level(SecurityLevel::Standard)
.build();

pub fn with_secrecy_mode( self, secrecy_mode: SecrecyMode, ) -> SessionSecuritySettingsBuilder

Sets the session secrecy mode. If Perfect is selected, then each message is guaranteed to use only a single symmetric key for encryption (best for high-security protocols that do not need high throughput) If BestEffort is selected, the protocol will attempt to re-key the system at the earliest opportunity, and will not enqueue packets if a re-key has not yet completed (best for high-throughput applications) If high relatively throughput is desired, but additional security is needed, consider coupling BestEffort mode with a higher security level for multi-layered cryptography

use citadel_proto::prelude::{SessionSecuritySettingsBuilder, SecrecyMode};
SessionSecuritySettingsBuilder::default()
.with_secrecy_mode(SecrecyMode::BestEffort)
.build();

pub fn with_crypto_params( self, params: impl Into<CryptoParameters>, ) -> SessionSecuritySettingsBuilder

Default: Firesaber + AES_GCM_256_SIV

use citadel_proto::prelude::*;
use citadel_pqcrypto::prelude::*;
SessionSecuritySettingsBuilder::default()
.with_crypto_params(EncryptionAlgorithm::AES_GCM_256 + KemAlgorithm::Kyber)
.build();

pub fn with_header_obfuscator_settings( self, header_obfuscator_settings: impl Into<HeaderObfuscatorSettings>, ) -> SessionSecuritySettingsBuilder

Default: HeaderObfuscatorSettings::Disabled

use citadel_proto::prelude::*;
use uuid::Uuid;
// Assume `header_psk` is a pre-shared key for only the header block cipher.
// WARNING! This should NOT be derived from any secrets related to any other
// part of the session. IF you are unsure, do not use this feature or use
// `HeaderObfuscatorSettings::Enabled` to generate a random key at the beginning
// of the session
let header_psk = Uuid::new_v4();
SessionSecuritySettingsBuilder::default()
.with_header_obfuscator_settings(header_psk)
.build();

pub fn build(self) -> Result<SessionSecuritySettings, Error>

Constructs the SessionSecuritySettings

Trait Implementations

impl Default for SessionSecuritySettingsBuilder

fn default() -> SessionSecuritySettingsBuilder

Returns the “default value” for a type.