Struct kuska_handshake::Handshake

pub struct Handshake<S: State> {
    pub base: HandshakeBase,
    pub state: S,
}

The Handshake type maintains the different states that happen in each step of the handshake, allowing it to advance to completion.

The Handshake follows the typestate pattern.

Fields

base: HandshakeBase

state: S

Implementations

impl Handshake<SendClientHello>

pub fn new_client(
    net_id: Key,
    pk: PublicKey,
    sk: SecretKey
) -> Handshake<SendClientHello>

Create a new handshake client that can send the client hello.

impl Handshake<SendClientHello>

pub fn send_client_hello(
    self,
    send_buf: &mut [u8]
) -> Handshake<RecvServerHello>

Send a client hello and advance to the next client state.

pub const fn send_bytes(&self) -> usize

Number of bytes that will be written to the send_buf in this state.

impl Handshake<RecvServerHello>

pub fn recv_server_hello(
    self,
    recv_buf: &[u8]
) -> Result<Handshake<SendClientAuth>, Error>

Receive a server hello and advance to the next client state.

pub const fn recv_bytes(&self) -> usize

Number of bytes that will be read from the recv_buf in this state.

impl Handshake<SendClientAuth>

pub fn send_client_auth(
    self,
    send_buf: &mut [u8],
    server_pk: PublicKey
) -> Result<Handshake<RecvServerAccept>, Error>

Send a client auth and advance to the next client state.

pub const fn send_bytes(&self) -> usize

Number of bytes that will be written to the send_buf in this state.

impl Handshake<RecvServerAccept>

pub fn recv_server_accept(
    self,
    recv_buf: &mut [u8]
) -> Result<Handshake<Complete>, Error>

pub const fn recv_bytes(&self) -> usize

Number of bytes that will be read from the recv_buf in this state.

impl Handshake<RecvClientHello>

pub fn new_server(
    net_id: Key,
    pk: PublicKey,
    sk: SecretKey
) -> Handshake<RecvClientHello>

Create a new handshake server that can receive the client hello.

impl Handshake<RecvClientHello>

pub fn recv_client_hello(
    self,
    recv_buf: &[u8]
) -> Result<Handshake<SendServerHello>, Error>

Receive a client hello and advance to the next server state.

pub const fn recv_bytes(&self) -> usize

Number of bytes that will be read from the recv_buf in this state.

impl Handshake<SendServerHello>

pub fn send_server_hello(self, send_buf: &mut [u8]) -> Handshake<RecvClientAuth>

Send a server hello and advance to the next server state.

pub const fn send_bytes(&self) -> usize

Number of bytes that will be written to the send_buf in this state.

impl Handshake<RecvClientAuth>

pub fn recv_client_auth(
    self,
    recv_buf: &mut [u8]
) -> Result<Handshake<SendServerAccept>, Error>

Receive a client auth and advance to the next server state.

pub const fn recv_bytes(&self) -> usize

Number of bytes that will be read from the recv_buf in this state.

impl Handshake<SendServerAccept>

pub fn send_server_accept(self, send_buf: &mut [u8]) -> Handshake<Complete>

Send a server accept and advance to the next server state.

pub const fn send_bytes(&self) -> usize

Number of bytes that will be written to the send_buf in this state.

impl Handshake<Complete>

pub fn complete(&self) -> HandshakeComplete

Create a HandshakeComplete out of a Handshake in the Complete state.

Trait Implementations

impl<S: Debug + State> Debug for Handshake<S>

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

Formats the value using the given formatter.