tightbeam-rs 0.8.0

A secure, high-performance messaging protocol library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! Protocol state management traits
//!
//! This module separates protocol state accessors from I/O operations,
//! following the Single Responsibility Principle.

use core::time::Duration;

#[cfg(not(feature = "std"))]
use alloc::{boxed::Box, sync::Arc, vec::Vec};
#[cfg(feature = "std")]
use std::sync::Arc;

use crate::crypto::aead::RuntimeAead;
use crate::crypto::profiles::CryptoProvider;
use crate::crypto::x509::policy::CertificateValidation;
use crate::crypto::x509::store::CertificateTrust;
use crate::transport::handshake::{
	HandshakeError, HandshakeKeyManager, HandshakeProtocolKind, ServerHandshakeProtocol, TcpHandshakeState,
};
use crate::transport::TransportResult;
use crate::x509::Certificate;

/// Protocol state management for encrypted transports
///
/// This trait provides access to the state fields needed for encrypted transport operations,
/// separating state management from I/O operations.
#[cfg(feature = "x509")]
pub trait EncryptedProtocolState {
	/// The crypto provider used by this transport
	type CryptoProvider: CryptoProvider + Send + Sync + 'static;

	/// Get the encryptor instance (RuntimeAead)
	fn to_encryptor_ref(&self) -> TransportResult<&RuntimeAead>;

	/// Get the decryptor instance (RuntimeAead)
	fn to_decryptor_ref(&self) -> TransportResult<&RuntimeAead>;

	/// Get current handshake state (pure accessor)
	fn to_handshake_state(&self) -> TcpHandshakeState;

	/// Set handshake state (pure mutator)
	fn set_handshake_state(&mut self, state: TcpHandshakeState);

	/// Get server certificate if present (pure accessor)
	fn to_server_certificate_ref(&self) -> Option<&Certificate>;

	/// Get server certificate Arc if present (zero-copy accessor)
	fn to_server_certificate_arc(&self) -> Option<Arc<Certificate>> {
		None
	}

	/// Set symmetric encryption key (pure mutator)
	fn set_symmetric_key(&mut self, key: RuntimeAead);

	/// Helper to clear symmetric key (for circuit breaker)
	fn unset_symmetric_key(&mut self);

	/// Set peer certificate after mutual auth
	fn set_peer_certificate(&mut self, _cert: Certificate);

	/// Maximum allowed size for cleartext envelopes (bytes)
	fn to_max_cleartext_envelope(&self) -> Option<usize> {
		None
	}

	/// Maximum allowed size for encrypted envelopes (bytes)
	fn to_max_encrypted_envelope(&self) -> Option<usize> {
		None
	}

	/// Helper to check if client validators are present
	fn is_client_validators_present(&self) -> bool {
		false
	}

	/// Get handshake protocol kind
	fn to_handshake_protocol_kind(&self) -> HandshakeProtocolKind {
		HandshakeProtocolKind::default()
	}

	/// Get key manager reference
	fn to_key_manager_ref(&self) -> Option<&Arc<HandshakeKeyManager<Self::CryptoProvider>>> {
		None
	}

	/// Get client certificate reference
	fn to_client_certificate_ref(&self) -> Option<&Arc<Certificate>> {
		None
	}

	/// Get trust store reference (for server certificate validation)
	fn to_trust_store_ref(&self) -> Option<&Arc<dyn CertificateTrust>> {
		None
	}

	/// Get mutable reference to server handshake orchestrator
	fn to_server_handshake_mut(
		&mut self,
	) -> &mut Option<Box<dyn ServerHandshakeProtocol<Error = HandshakeError> + Send + Sync>>;

	/// Get handshake timeout
	fn to_handshake_timeout(&self) -> Duration {
		Duration::from_secs(1)
	}

	/// Get client validators
	fn to_client_validators_ref(&self) -> Option<&Arc<Vec<Arc<dyn CertificateValidation>>>> {
		None
	}
}