• API Reference
Show / Hide Table of Contents
  • Noise
    • CipherFunction
    • DhFunction
    • HandshakePattern
    • HandshakeState
    • HashFunction
    • KeyPair
    • MessagePattern
    • PatternModifiers
    • PreMessagePattern
    • Protocol
    • ProtocolConfig
    • Token
    • Transport

Namespace Noise

Classes

CipherFunction

Constants representing the available cipher functions.

DhFunction

Constants representing the available DH functions.

HandshakePattern

A handshake pattern consists of a pre-message pattern for the initiator, a pre-message pattern for the responder, and a sequence of message patterns for the actual handshake messages.

HashFunction

Constants representing the available hash functions.

KeyPair

A Diffie-Hellman private/public key pair.

MessagePattern

A message pattern is some sequence of tokens from the set ("e", "s", "ee", "es", "se", "ss", "psk").

PreMessagePattern

A pre-message pattern is one of the following sequences of tokens: "e", "s", "e, s", or empty.

Protocol

A concrete Noise protocol (e.g. Noise_XX_25519_AESGCM_SHA256 or Noise_IK_25519_ChaChaPoly_BLAKE2b).

ProtocolConfig

A set of parameters used to instantiate an initial HandshakeState from a concrete Protocol.

Interfaces

HandshakeState

A HandshakeState object contains a SymmetricState plus the local and remote keys (any of which may be empty), a boolean indicating the initiator or responder role, and the remaining portion of the handshake pattern.

Transport

A pair of CipherState objects for encrypting transport messages.

Enums

PatternModifiers

Pattern modifiers specify arbitrary extensions or modifications to the behavior specified by the handshake pattern.

Token

The smallest unit of the Noise handshake language.

Back to top Generated by DocFX