Protocol.Credential

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 Protocol.Credential

Methods

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

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

Show Credential

Defined in Protocol.Credential

Methods

showsPrec :: Int -> Credential -> ShowS

show :: Credential -> String

showList :: [Credential] -> ShowS

credentialAlphabet :: [Char]

tokenBase :: Int

tokenLength :: Int

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

randomCredential generates a random Credential.

readCredential :: Text -> Either CredentialError Credential

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

Type CredentialError

data CredentialError

Constructors

CredentialError_BadChar Char

CredentialError_Checksum

CredentialError_Length

Instances

Eq CredentialError

Defined in Protocol.Credential

Methods

(==) :: CredentialError -> CredentialError -> Bool

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

Show CredentialError

Defined in Protocol.Credential

Methods

showsPrec :: Int -> CredentialError -> ShowS

show :: CredentialError -> String

showList :: [CredentialError] -> ShowS

Type UUID

newtype UUID

Constructors

UUID Text

Instances

Eq UUID

Defined in Protocol.Credential

Methods

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

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

Ord UUID

Defined in 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 Protocol.Credential

Methods

showsPrec :: Int -> UUID -> ShowS

show :: UUID -> String

showList :: [UUID] -> ShowS

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

randomUUID generates a random UUID.

Type SecretKey

type SecretKey = E

secretKey :: SubGroup q => UUID -> Credential -> SecretKey q

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

Type PublicKey

type PublicKey = G

publicKey :: SubGroup q => SecretKey q -> PublicKey q

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