Copyright	(c) Joseph Abrahamson 2013
License	MIT
Maintainer	me@jspha.com
Stability	experimental
Portability	non-portable
Safe Haskell	Safe
Language	Haskell2010

Crypto.Saltine.Class

Description

Saltine type classes

Synopsis

class IsEncoding a where
class IsNonce n where

Documentation

class IsEncoding a where #

Class for all keys and nonces in Saltine which have a representation as ByteString. encoded is a Prism of type Prism' ByteString a compatible with Control.Lens and is automatically deduced.

Minimal complete definition

encode, decode

Methods

encode :: a -> ByteString #

decode :: ByteString -> Maybe a #

encoded :: (Choice p, Applicative f) => p a (f a) -> p ByteString (f ByteString) #

Instances

IsEncoding Nonce #
Instance details Defined in Crypto.Saltine.Core.Stream Methods encode :: Nonce -> ByteString # decode :: ByteString -> Maybe Nonce # encoded :: (Choice p, Applicative f) => p Nonce (f Nonce) -> p ByteString (f ByteString) #
IsEncoding Key #
Instance details Defined in Crypto.Saltine.Core.Stream Methods encode :: Key -> ByteString # decode :: ByteString -> Maybe Key # encoded :: (Choice p, Applicative f) => p Key (f Key) -> p ByteString (f ByteString) #
IsEncoding PublicKey #
Instance details Defined in Crypto.Saltine.Core.Sign Methods encode :: PublicKey -> ByteString # decode :: ByteString -> Maybe PublicKey # encoded :: (Choice p, Applicative f) => p PublicKey (f PublicKey) -> p ByteString (f ByteString) #
IsEncoding SecretKey #
Instance details Defined in Crypto.Saltine.Core.Sign Methods encode :: SecretKey -> ByteString # decode :: ByteString -> Maybe SecretKey # encoded :: (Choice p, Applicative f) => p SecretKey (f SecretKey) -> p ByteString (f ByteString) #
IsEncoding Nonce #
Instance details Defined in Crypto.Saltine.Core.SecretBox Methods encode :: Nonce -> ByteString # decode :: ByteString -> Maybe Nonce # encoded :: (Choice p, Applicative f) => p Nonce (f Nonce) -> p ByteString (f ByteString) #
IsEncoding Key #
Instance details Defined in Crypto.Saltine.Core.SecretBox Methods encode :: Key -> ByteString # decode :: ByteString -> Maybe Key # encoded :: (Choice p, Applicative f) => p Key (f Key) -> p ByteString (f ByteString) #
IsEncoding Scalar #
Instance details Defined in Crypto.Saltine.Core.ScalarMult Methods encode :: Scalar -> ByteString # decode :: ByteString -> Maybe Scalar # encoded :: (Choice p, Applicative f) => p Scalar (f Scalar) -> p ByteString (f ByteString) #
IsEncoding GroupElement #
Instance details Defined in Crypto.Saltine.Core.ScalarMult Methods encode :: GroupElement -> ByteString # decode :: ByteString -> Maybe GroupElement # encoded :: (Choice p, Applicative f) => p GroupElement (f GroupElement) -> p ByteString (f ByteString) #
IsEncoding Authenticator #
Instance details Defined in Crypto.Saltine.Core.OneTimeAuth Methods encode :: Authenticator -> ByteString # decode :: ByteString -> Maybe Authenticator # encoded :: (Choice p, Applicative f) => p Authenticator (f Authenticator) -> p ByteString (f ByteString) #
IsEncoding Key #
Instance details Defined in Crypto.Saltine.Core.OneTimeAuth Methods encode :: Key -> ByteString # decode :: ByteString -> Maybe Key # encoded :: (Choice p, Applicative f) => p Key (f Key) -> p ByteString (f ByteString) #
IsEncoding ShorthashKey #
Instance details Defined in Crypto.Saltine.Core.Hash Methods encode :: ShorthashKey -> ByteString # decode :: ByteString -> Maybe ShorthashKey # encoded :: (Choice p, Applicative f) => p ShorthashKey (f ShorthashKey) -> p ByteString (f ByteString) #
IsEncoding Nonce #
Instance details Defined in Crypto.Saltine.Core.Box Methods encode :: Nonce -> ByteString # decode :: ByteString -> Maybe Nonce # encoded :: (Choice p, Applicative f) => p Nonce (f Nonce) -> p ByteString (f ByteString) #
IsEncoding CombinedKey #
Instance details Defined in Crypto.Saltine.Core.Box Methods encode :: CombinedKey -> ByteString # decode :: ByteString -> Maybe CombinedKey # encoded :: (Choice p, Applicative f) => p CombinedKey (f CombinedKey) -> p ByteString (f ByteString) #
IsEncoding PublicKey #
Instance details Defined in Crypto.Saltine.Core.Box Methods encode :: PublicKey -> ByteString # decode :: ByteString -> Maybe PublicKey # encoded :: (Choice p, Applicative f) => p PublicKey (f PublicKey) -> p ByteString (f ByteString) #
IsEncoding SecretKey #
Instance details Defined in Crypto.Saltine.Core.Box Methods encode :: SecretKey -> ByteString # decode :: ByteString -> Maybe SecretKey # encoded :: (Choice p, Applicative f) => p SecretKey (f SecretKey) -> p ByteString (f ByteString) #
IsEncoding Authenticator #
Instance details Defined in Crypto.Saltine.Core.Auth Methods encode :: Authenticator -> ByteString # decode :: ByteString -> Maybe Authenticator # encoded :: (Choice p, Applicative f) => p Authenticator (f Authenticator) -> p ByteString (f ByteString) #
IsEncoding Key #
Instance details Defined in Crypto.Saltine.Core.Auth Methods encode :: Key -> ByteString # decode :: ByteString -> Maybe Key # encoded :: (Choice p, Applicative f) => p Key (f Key) -> p ByteString (f ByteString) #
IsEncoding Nonce #
Instance details Defined in Crypto.Saltine.Core.AEAD Methods encode :: Nonce -> ByteString # decode :: ByteString -> Maybe Nonce # encoded :: (Choice p, Applicative f) => p Nonce (f Nonce) -> p ByteString (f ByteString) #
IsEncoding Key #
Instance details Defined in Crypto.Saltine.Core.AEAD Methods encode :: Key -> ByteString # decode :: ByteString -> Maybe Key # encoded :: (Choice p, Applicative f) => p Key (f Key) -> p ByteString (f ByteString) #

class IsNonce n where #

A generic class for interacting with nonces.

Minimal complete definition

zero, nudge

Methods

zero :: n #

Some privileged nonce value.

nudge :: n -> n #

Some perturbation on nonces such that n /= nudge n with high probability. Since nonces are finite, repeats may happen in particularly small cases, but no nonces in Saltine are so small. This is not guaranteed to be difficult to predict---if a nonce had an Enum instance succ would be a good implementation excepting that succ is partial.

Instances

IsNonce Nonce #
Instance details Defined in Crypto.Saltine.Core.Stream Methods zero :: Nonce # nudge :: Nonce -> Nonce #
IsNonce Nonce #
Instance details Defined in Crypto.Saltine.Core.SecretBox Methods zero :: Nonce # nudge :: Nonce -> Nonce #
IsNonce Nonce #
Instance details Defined in Crypto.Saltine.Core.Box Methods zero :: Nonce # nudge :: Nonce -> Nonce #
IsNonce Nonce #
Instance details Defined in Crypto.Saltine.Core.AEAD Methods zero :: Nonce # nudge :: Nonce -> Nonce #