Crypto.Noise.Internal.Handshake.Pattern

Documentation

data Token next

Constructors

E next

S next

Ee next

Es next

Se next

Ss next

Psk next

type MessagePattern = Ap Token

e :: MessagePattern ()

s :: MessagePattern ()

ee :: MessagePattern ()

es :: MessagePattern ()

se :: MessagePattern ()

ss :: MessagePattern ()

psk :: MessagePattern ()

data Message next

Constructors

PreInitiator (MessagePattern ()) next

PreResponder (MessagePattern ()) next

Initiator (MessagePattern ()) next

Responder (MessagePattern ()) next

type MessageSequence = Ap Message

preInitiator :: MessagePattern () -> MessageSequence ()

preResponder :: MessagePattern () -> MessageSequence ()

initiator :: MessagePattern () -> MessageSequence ()

responder :: MessagePattern () -> MessageSequence ()

data HandshakePattern

This type represents a handshake pattern such as Noise_IK. A large set of pre-defined patterns can be found in Crypto.Noise.HandshakePatterns. Expert users are encouraged to define their own custom patterns with care.

Constructors

HandshakePattern

Fields

• _hpName :: ByteString
• _hpPSKMode :: Bool
• _hpMsgSeq :: MessageSequence ()

hpPSKMode :: Lens' HandshakePattern Bool

hpName :: Lens' HandshakePattern ByteString

hpMsgSeq :: Lens' HandshakePattern (MessageSequence ())

newtype HasPSK

Constructors

HasPSK

Fields

• unPSK :: Bool

Instances

Monoid HasPSK

Methods

mempty :: HasPSK

mappend :: HasPSK -> HasPSK -> HasPSK

mconcat :: [HasPSK] -> HasPSK

handshakePattern :: ByteString -> MessageSequence () -> HandshakePattern

Constructs a HandshakePattern given a protocol name (such as XXpsk3) and raw pattern. Please see the README for information about creating your own custom patterns.