Crypto.Noise.Internal.Handshake.State

Documentation

data HandshakeRole

Represents the side of the conversation upon which a party resides.

Constructors

InitiatorRole

ResponderRole

Instances

Show HandshakeRole

Defined in Crypto.Noise.Internal.Handshake.State

Methods

showsPrec :: Int -> HandshakeRole -> ShowS

show :: HandshakeRole -> String

showList :: [HandshakeRole] -> ShowS

Eq HandshakeRole

Defined in Crypto.Noise.Internal.Handshake.State

Methods

(==) :: HandshakeRole -> HandshakeRole -> Bool

(/=) :: HandshakeRole -> HandshakeRole -> Bool

data HandshakeOpts d

Represents the various options and keys for a handshake parameterized by the DH method.

Constructors

HandshakeOpts

Fields

• _hoRole :: HandshakeRole
• _hoPrologue :: Plaintext
• _hoLocalEphemeral :: Maybe (KeyPair d)
• _hoLocalStatic :: Maybe (KeyPair d)
• _hoRemoteEphemeral :: Maybe (PublicKey d)
• _hoRemoteStatic :: Maybe (PublicKey d)

hoRole :: forall d. Lens' (HandshakeOpts d) HandshakeRole

hoRemoteStatic :: forall d. Lens' (HandshakeOpts d) (Maybe (PublicKey d))

hoRemoteEphemeral :: forall d. Lens' (HandshakeOpts d) (Maybe (PublicKey d))

hoPrologue :: forall d. Lens' (HandshakeOpts d) Plaintext

hoLocalStatic :: forall d. Lens' (HandshakeOpts d) (Maybe (KeyPair d))

hoLocalEphemeral :: forall d. Lens' (HandshakeOpts d) (Maybe (KeyPair d))

data HandshakeState c d h

Holds all state associated with the interpreter.

Constructors

HandshakeState

Fields

• _hsSymmetricState :: SymmetricState c h
• _hsOpts :: HandshakeOpts d
• _hsPSKMode :: Bool
• _hsMsgBuffer :: ScrubbedBytes

Instances

MonadState (HandshakeState c d h) (Handshake c d h)

Defined in Crypto.Noise.Internal.Handshake.State

Methods

get :: Handshake c d h (HandshakeState c d h)

put :: HandshakeState c d h -> Handshake c d h ()

state :: (HandshakeState c d h -> (a, HandshakeState c d h)) -> Handshake c d h a

hsSymmetricState :: forall c d h c h. Lens (HandshakeState c d h) (HandshakeState c d h) (SymmetricState c h) (SymmetricState c h)

hsPSKMode :: forall c d h. Lens' (HandshakeState c d h) Bool

hsOpts :: forall c d h d. Lens (HandshakeState c d h) (HandshakeState c d h) (HandshakeOpts d) (HandshakeOpts d)

hsMsgBuffer :: forall c d h. Lens' (HandshakeState c d h) ScrubbedBytes

data HandshakeResult

This data structure is yielded by the coroutine when more data is needed.

Constructors

HandshakeResultMessage ScrubbedBytes

HandshakeResultNeedPSK

newtype Handshake c d h r

All HandshakePattern interpreters run within this Monad.

Constructors

Handshake

Fields

• runHandshake :: Coroutine (Request HandshakeResult ScrubbedBytes) (StateT (HandshakeState c d h) Catch) r

Instances

Applicative (Handshake c d h)

Defined in Crypto.Noise.Internal.Handshake.State

Methods

pure :: a -> Handshake c d h a

(<*>) :: Handshake c d h (a -> b) -> Handshake c d h a -> Handshake c d h b

liftA2 :: (a -> b -> c0) -> Handshake c d h a -> Handshake c d h b -> Handshake c d h c0

(*>) :: Handshake c d h a -> Handshake c d h b -> Handshake c d h b

(<*) :: Handshake c d h a -> Handshake c d h b -> Handshake c d h a

Functor (Handshake c d h)

Defined in Crypto.Noise.Internal.Handshake.State

Methods

fmap :: (a -> b) -> Handshake c d h a -> Handshake c d h b

(<$) :: a -> Handshake c d h b -> Handshake c d h a

Monad (Handshake c d h)

Defined in Crypto.Noise.Internal.Handshake.State

Methods

(>>=) :: Handshake c d h a -> (a -> Handshake c d h b) -> Handshake c d h b

(>>) :: Handshake c d h a -> Handshake c d h b -> Handshake c d h b

return :: a -> Handshake c d h a

MonadThrow (Handshake c d h)

Defined in Crypto.Noise.Internal.Handshake.State

Methods

throwM :: (HasCallStack, Exception e) => e -> Handshake c d h a

MonadState (HandshakeState c d h) (Handshake c d h)

Defined in Crypto.Noise.Internal.Handshake.State

Methods

get :: Handshake c d h (HandshakeState c d h)

put :: HandshakeState c d h -> Handshake c d h ()

state :: (HandshakeState c d h -> (a, HandshakeState c d h)) -> Handshake c d h a

defaultHandshakeOpts :: HandshakeRole -> Plaintext -> HandshakeOpts d

defaultHandshakeOpts role prologue returns a default set of handshake options. All keys are set to Nothing.

setLocalEphemeral :: Maybe (KeyPair d) -> HandshakeOpts d -> HandshakeOpts d

Sets the local ephemeral key.

setLocalStatic :: Maybe (KeyPair d) -> HandshakeOpts d -> HandshakeOpts d

Sets the local static key.

setRemoteEphemeral :: Maybe (PublicKey d) -> HandshakeOpts d -> HandshakeOpts d

Sets the remote ephemeral key (rarely needed).

setRemoteStatic :: Maybe (PublicKey d) -> HandshakeOpts d -> HandshakeOpts d

Sets the remote static key.

mkHandshakeName :: forall c d h proxy. (Cipher c, DH d, Hash h) => ByteString -> proxy (c, d, h) -> ScrubbedBytes

Given a protocol name, returns the full handshake name according to the rules in section 8.

handshakeState :: forall c d h. (Cipher c, DH d, Hash h) => HandshakeOpts d -> HandshakePattern -> HandshakeState c d h

Constructs a HandshakeState from a given set of options and a protocol name (such as NN or IK).

Orphan instances

(Functor f, MonadState s m) => MonadState s (Coroutine f m)

Methods

get :: Coroutine f m s

put :: s -> Coroutine f m ()

state :: (s -> (a, s)) -> Coroutine f m a

(Functor f, MonadThrow m) => MonadThrow (Coroutine f m)

Methods

throwM :: (HasCallStack, Exception e) => e -> Coroutine f m a