ytls-traits 0.0.2

yolox TLS traits
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

//! Common Context Impls

use crate::{TlsLeftIn, TlsLeftOut, TlsRight};

/// Marker for Handshake being complete
#[derive(Debug, PartialEq)]
pub struct HandshakeComplete;

use crate::SecretStore;

/// Implement to process handshaking part
pub trait CtxHandshakeProcessor {
    type Error;
    /// Spin Handshake state forward
    /// # Left
    /// The Left is typically the I/O side allowing the state machine
    /// to complete the handshake required
    /// # Evolution
    /// Once handshake is finished, Some(..) is given for the application
    /// state machinery allowing de/encryption.
    #[must_use]
    fn spin_handshake<Li: TlsLeftIn, Lo: TlsLeftOut, Ks: SecretStore>(
        &mut self,
        _left_in: &mut Li,
        _left_out: &mut Lo,
        _ks: &mut Ks,
    ) -> Result<Option<HandshakeComplete>, Self::Error>;
}

/// Marker for Shutdown being complete
#[derive(Debug, PartialEq)]
pub struct ShutdownComplete;

/// Implement to process application data part
pub trait CtxApplicationProcessor {
    type Error;
    /// Spin Application state forward with the given Left and Right sides.
    /// # Left
    /// Same as in handshake the left is typically the I/O allowing the
    /// state machine to uphold the context alive and encrypt & decrypt
    /// the application traffic.
    /// # Right
    /// Right side allows the application to both provide cleartext to the
    /// state machinery to encrypt egress traffic as well as state machine
    /// to provide the cleartext decrypted traffic to application.
    /// # Evolution
    /// Shutdown is provided when the state machinery can be shut down.
    #[must_use]
    fn spin_application<Li: TlsLeftIn, Lo: TlsLeftOut, R: TlsRight>(
        &mut self,
        _left_in: &mut Li,
        _left_out: &mut Lo,
        _right: &mut R,
    ) -> Result<Option<ShutdownComplete>, Self::Error>;
}