cacophony-0.10.1: A library implementing the Noise protocol.

Maintainer	John Galt <jgalt@centromere.net>
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Crypto.Noise.Internal.Handshake.Pattern

Description

Synopsis

data Token next
- = 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
- = 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 = HandshakePattern {
- _hpName :: ByteString
- _hpPSKMode :: Bool
- _hpMsgSeq :: MessageSequence ()
}
hpPSKMode :: Lens' HandshakePattern Bool
hpName :: Lens' HandshakePattern ByteString
hpMsgSeq :: Lens' HandshakePattern (MessageSequence ())
newtype HasPSK = HasPSK {
- unPSK :: Bool
}
handshakePattern :: ByteString -> MessageSequence () -> HandshakePattern

Documentation

data Token next Source #

Constructors

E next
S next
Ee next
Es next
Se next
Ss next
Psk next

type MessagePattern = Ap Token Source #

e :: MessagePattern () Source #

s :: MessagePattern () Source #

ee :: MessagePattern () Source #

es :: MessagePattern () Source #

se :: MessagePattern () Source #

ss :: MessagePattern () Source #

psk :: MessagePattern () Source #

data Message next Source #

Constructors

PreInitiator (MessagePattern ()) next
PreResponder (MessagePattern ()) next
Initiator (MessagePattern ()) next
Responder (MessagePattern ()) next

type MessageSequence = Ap Message Source #

preInitiator :: MessagePattern () -> MessageSequence () Source #

preResponder :: MessagePattern () -> MessageSequence () Source #

initiator :: MessagePattern () -> MessageSequence () Source #

responder :: MessagePattern () -> MessageSequence () Source #

data HandshakePattern Source #

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 Source #

hpName :: Lens' HandshakePattern ByteString Source #

hpMsgSeq :: Lens' HandshakePattern (MessageSequence ()) Source #

newtype HasPSK Source #

Constructors

HasPSK
Fields unPSK :: Bool

Instances

Semigroup HasPSK Source #
Instance details Defined in Crypto.Noise.Internal.Handshake.Pattern Methods (<>) :: HasPSK -> HasPSK -> HasPSK # sconcat :: NonEmpty HasPSK -> HasPSK # stimes :: Integral b => b -> HasPSK -> HasPSK #
Monoid HasPSK Source #
Instance details Defined in Crypto.Noise.Internal.Handshake.Pattern Methods mempty :: HasPSK # mappend :: HasPSK -> HasPSK -> HasPSK # mconcat :: [HasPSK] -> HasPSK #

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

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.