Struct SecretConnection 

pub struct SecretConnection<Io> { /* private fields */ }

Encrypted connection between peers in a CometBFT network.

Sending and receiving messages

The SecretConnection type implements a message-oriented interface which can send and receive Protobuf-encoded messages that impl the prost::Message trait.

The ReadMsg and WriteMsg traits can be used for sending/receiving Protobuf messages.

Connection integrity and failures

Due to the underlying encryption mechanism (currently RFC 8439), when a read or write failure occurs, it is necessary to disconnect from the remote peer and attempt to reconnect.

Implementations

impl<Io: Read + Write + Send + Sync + TryCloneIo> SecretConnection<Io>

pub fn new<Identity>(io: Io, identity_key: &Identity) -> Result<Self>

where Identity: Signer<Signature>, VerifyingKey: for<'a> From<&'a Identity>,

Performs a handshake and returns a new SecretConnection, authenticating ourselves with the provided Identity (Ed25519 signing key).

The IdentitySecret type can be used as an identity_key.

Errors

• if sharing of the pubkey fails
• if sharing of the signature fails
• if receiving the signature fails
• if verifying the signature fails

impl<Io: Write> SecretConnection<Io>

pub fn flush(&mut self) -> Result<()>

Flush the underlying I/O object’s write buffer.

impl<Io> SecretConnection<Io>

pub fn local_public_key(&self) -> &PublicKey

Get the local (i.e. our) PublicKey.

pub fn peer_public_key(&self) -> &PublicKey

Returns the remote peer’s PublicKey.

pub fn split(self) -> (SecretReader<Io>, SecretWriter<Io>)

Split this SecretConnection into a SecretReader and SecretWriter which can be used independently of each other.

Trait Implementations

impl<M: Message + Default, Io: Read> ReadMsg<M> for SecretConnection<Io>

fn read_msg(&mut self) -> Result<M>

Read from the underlying I/O object, decoding (and if necessary decrypting) the data to the given Protobuf message.

impl<M: Message, Io: Write> WriteMsg<M> for SecretConnection<Io>

fn write_msg(&mut self, msg: &M) -> Result<()>

Encode the given Protobuf as bytes and write them to the underlying I/O object (and encrypting if necessary).