Voting.Protocol.Credential

Class Key

class Key crypto where

Methods

cryptoType :: crypto -> Text

Type of cryptography, eg. FFC.

cryptoName :: crypto -> Text

Name of the cryptographic paramaters, eg. Belenios.

randomSecretKey :: Reifies c crypto => Monad m => RandomGen r => StateT r m (SecretKey crypto c)

Generate a random SecretKey.

credentialSecretKey :: Reifies c crypto => UUID -> Credential -> SecretKey crypto c

(credentialSecretKey uuid cred) returns the SecretKey derived from given uuid and cred using fastPBKDF2_SHA256.

publicKey :: Reifies c crypto => SecretKey crypto c -> PublicKey crypto c

(publicKey secKey) returns the PublicKey derived from given SecretKey secKey.

Instances

Key FFC

Defined in Voting.Protocol.FFC

Methods

cryptoType :: FFC -> Text

cryptoName :: FFC -> Text

randomSecretKey :: forall c (m :: Type -> Type) r. (Reifies c FFC, Monad m, RandomGen r) => StateT r m (SecretKey FFC c)

credentialSecretKey :: Reifies c FFC => UUID -> Credential -> SecretKey FFC c

publicKey :: Reifies c FFC => SecretKey FFC c -> PublicKey FFC c

Type Credential

newtype Credential

A Credential is a word of (tokenLength+1 == 15)-characters from a base alphabet of (tokenBase == 58) characters: "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz" (beware the absence of "0", "O", "I", and "l"). The last character is a checksum. The entropy is: (tokenLength * log tokenBase / log 2) == 82.01… bits.

Constructors

Credential Text

Instances

Eq Credential

Defined in Voting.Protocol.Credential

Methods

(==) :: Credential -> Credential -> Bool

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

Show Credential

Defined in Voting.Protocol.Credential

Methods

showsPrec :: Int -> Credential -> ShowS

show :: Credential -> String

showList :: [Credential] -> ShowS

Generic Credential

Defined in Voting.Protocol.Credential

Associated Types

type Rep Credential :: Type -> Type

Methods

from :: Credential -> Rep Credential x

to :: Rep Credential x -> Credential

ToJSON Credential

Defined in Voting.Protocol.Credential

Methods

toJSON :: Credential -> Value

toEncoding :: Credential -> Encoding

toJSONList :: [Credential] -> Value

toEncodingList :: [Credential] -> Encoding

FromJSON Credential

Defined in Voting.Protocol.Credential

Methods

parseJSON :: Value -> Parser Credential

parseJSONList :: Value -> Parser [Credential]

NFData Credential

Defined in Voting.Protocol.Credential

Methods

rnf :: Credential -> ()

type Rep Credential

Defined in Voting.Protocol.Credential

type Rep Credential = D1 ('MetaData "Credential" "Voting.Protocol.Credential" "majurity-protocol-0.0.10.20191104-inplace" 'True) (C1 ('MetaCons "Credential" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

credentialAlphabet :: [Char]

tokenBase :: Int

tokenLength :: Int

randomCredential :: Monad m => RandomGen r => StateT r m Credential

randomCredential generates a random Credential.

readCredential :: Text -> Either ErrorToken Credential

readCredential reads and check the well-formedness of a Credential from raw Text.

Type ErrorToken

data ErrorToken

Constructors

ErrorToken_BadChar Char

ErrorToken_Checksum

ErrorToken_Length

Instances

Eq ErrorToken

Defined in Voting.Protocol.Credential

Methods

(==) :: ErrorToken -> ErrorToken -> Bool

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

Show ErrorToken

Defined in Voting.Protocol.Credential

Methods

showsPrec :: Int -> ErrorToken -> ShowS

show :: ErrorToken -> String

showList :: [ErrorToken] -> ShowS

Generic ErrorToken

Defined in Voting.Protocol.Credential

Associated Types

type Rep ErrorToken :: Type -> Type

Methods

from :: ErrorToken -> Rep ErrorToken x

to :: Rep ErrorToken x -> ErrorToken

NFData ErrorToken

Defined in Voting.Protocol.Credential

Methods

rnf :: ErrorToken -> ()

type Rep ErrorToken

Defined in Voting.Protocol.Credential

type Rep ErrorToken = D1 ('MetaData "ErrorToken" "Voting.Protocol.Credential" "majurity-protocol-0.0.10.20191104-inplace" 'False) (C1 ('MetaCons "ErrorToken_BadChar" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Char)) :+: (C1 ('MetaCons "ErrorToken_Checksum" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ErrorToken_Length" 'PrefixI 'False) (U1 :: Type -> Type)))

Type UUID

newtype UUID

Constructors

UUID Text

Instances

Eq UUID

Defined in Voting.Protocol.Credential

Methods

(==) :: UUID -> UUID -> Bool

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

Ord UUID

Defined in Voting.Protocol.Credential

Methods

compare :: UUID -> UUID -> Ordering

(<) :: UUID -> UUID -> Bool

(<=) :: UUID -> UUID -> Bool

(>) :: UUID -> UUID -> Bool

(>=) :: UUID -> UUID -> Bool

max :: UUID -> UUID -> UUID

min :: UUID -> UUID -> UUID

Show UUID

Defined in Voting.Protocol.Credential

Methods

showsPrec :: Int -> UUID -> ShowS

show :: UUID -> String

showList :: [UUID] -> ShowS

Generic UUID

Defined in Voting.Protocol.Credential

Associated Types

type Rep UUID :: Type -> Type

Methods

from :: UUID -> Rep UUID x

to :: Rep UUID x -> UUID

ToJSON UUID

Defined in Voting.Protocol.Credential

Methods

toJSON :: UUID -> Value

toEncoding :: UUID -> Encoding

toJSONList :: [UUID] -> Value

toEncodingList :: [UUID] -> Encoding

FromJSON UUID

Defined in Voting.Protocol.Credential

Methods

parseJSON :: Value -> Parser UUID

parseJSONList :: Value -> Parser [UUID]

NFData UUID

Defined in Voting.Protocol.Credential

Methods

rnf :: UUID -> ()

type Rep UUID

Defined in Voting.Protocol.Credential

type Rep UUID = D1 ('MetaData "UUID" "Voting.Protocol.Credential" "majurity-protocol-0.0.10.20191104-inplace" 'True) (C1 ('MetaCons "UUID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

randomUUID :: Monad m => RandomGen r => StateT r m UUID

randomUUID generates a random UUID.

readUUID :: Text -> Either ErrorToken UUID

readCredential reads and check the well-formedness of a Credential from raw Text.