tuweni / org.apache.tuweni.scuttlebutt.handshake / SecureScuttlebuttHandshakeClient

SecureScuttlebuttHandshakeClient

class SecureScuttlebuttHandshakeClient (source)

Class responsible for performing a Secure Scuttlebutt handshake with a remote peer, as defined in the Secure Scuttlebutt protocol guide

Please note that only handshakes over the Ed25519 curve are supported.

This class manages the state of one handshake. It should not be reused across handshakes. If the handshake fails, a HandshakeException will be thrown.

Functions

create

static fun create(ourKeyPair: KeyPair, networkIdentifier: Bytes32, serverLongTermPublicKey: PublicKey): SecureScuttlebuttHandshakeClient

Creates a new handshake client to connect to a specific remote peer.

createHello

fun createHello(): Bytes

Creates a hello message to be sent to the other party, comprised of our ephemeral public key and an authenticator against our network identifier.

createIdentityMessage

fun createIdentityMessage(): Bytes

Creates a message containing the identity of the client

createStream

fun createStream(): SecureScuttlebuttStreamClient

Creates a stream to allow communication with the other peer after the handshake has completed

fromInvite

static fun fromInvite(networkIdentifier: Bytes32, invite: Invite): SecureScuttlebuttHandshakeClient

Create a new handshake client to connect to the server specified in the invite

readAcceptMessage

fun readAcceptMessage(message: Bytes): Unit

Reads the handshake acceptance message from the server

readHello

fun readHello(message: Bytes): Unit

Validates the initial message's MAC with our network identifier, and returns the peer ephemeral public key.