Gamgee.Token

Data structures to define and manipulate tokens

Documentation

data TokenType

Type of token TOTP or HOTP (not supported yet)

Constructors

TOTP

Instances

Show TokenType

Defined in Gamgee.Token

Methods

showsPrec :: Int -> TokenType -> ShowS

show :: TokenType -> String

showList :: [TokenType] -> ShowS

ToJSON TokenType

Defined in Gamgee.Token

Methods

toJSON :: TokenType -> Value

toEncoding :: TokenType -> Encoding

toJSONList :: [TokenType] -> Value

toEncodingList :: [TokenType] -> Encoding

FromJSON TokenType

Defined in Gamgee.Token

Methods

parseJSON :: Value -> Parser TokenType

parseJSONList :: Value -> Parser [TokenType]

newtype TokenLabel

Label of the token

Constructors

TokenLabel

Fields

• unTokenLabel :: Text

Instances

Show TokenLabel

Defined in Gamgee.Token

Methods

showsPrec :: Int -> TokenLabel -> ShowS

show :: TokenLabel -> String

showList :: [TokenLabel] -> ShowS

IsString TokenLabel

Defined in Gamgee.Token

Methods

fromString :: String -> TokenLabel

ToJSON TokenLabel

Defined in Gamgee.Token

Methods

toJSON :: TokenLabel -> Value

toEncoding :: TokenLabel -> Encoding

toJSONList :: [TokenLabel] -> Value

toEncodingList :: [TokenLabel] -> Encoding

FromJSON TokenLabel

Defined in Gamgee.Token

Methods

parseJSON :: Value -> Parser TokenLabel

parseJSONList :: Value -> Parser [TokenLabel]

data TokenSecret

Secret used to generate OTPs

Constructors

TokenSecretPlainText Text

TokenSecretAES256

Fields

• tokenSecretAES256IV :: Text
• tokenSecretAES256Data :: Text

Instances

Show TokenSecret

Defined in Gamgee.Token

Methods

showsPrec :: Int -> TokenSecret -> ShowS

show :: TokenSecret -> String

showList :: [TokenSecret] -> ShowS

Generic TokenSecret

Defined in Gamgee.Token

Associated Types

type Rep TokenSecret :: Type -> Type

Methods

from :: TokenSecret -> Rep TokenSecret x

to :: Rep TokenSecret x -> TokenSecret

ToJSON TokenSecret

Defined in Gamgee.Token

Methods

toJSON :: TokenSecret -> Value

toEncoding :: TokenSecret -> Encoding

toJSONList :: [TokenSecret] -> Value

toEncodingList :: [TokenSecret] -> Encoding

FromJSON TokenSecret

Defined in Gamgee.Token

Methods

parseJSON :: Value -> Parser TokenSecret

parseJSONList :: Value -> Parser [TokenSecret]

type Rep TokenSecret

Defined in Gamgee.Token

type Rep TokenSecret = D1 ('MetaData "TokenSecret" "Gamgee.Token" "gamgee-1.2.2-J40rGWe8DSNLUE2qXWQxyM" 'False) (C1 ('MetaCons "TokenSecretPlainText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "TokenSecretAES256" 'PrefixI 'True) (S1 ('MetaSel ('Just "tokenSecretAES256IV") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "tokenSecretAES256Data") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype TokenIssuer

Optional issuer of this token

Constructors

TokenIssuer

Fields

• unTokenIssuer :: Text

Instances

Show TokenIssuer

Defined in Gamgee.Token

Methods

showsPrec :: Int -> TokenIssuer -> ShowS

show :: TokenIssuer -> String

showList :: [TokenIssuer] -> ShowS

IsString TokenIssuer

Defined in Gamgee.Token

Methods

fromString :: String -> TokenIssuer

ToJSON TokenIssuer

Defined in Gamgee.Token

Methods

toJSON :: TokenIssuer -> Value

toEncoding :: TokenIssuer -> Encoding

toJSONList :: [TokenIssuer] -> Value

toEncodingList :: [TokenIssuer] -> Encoding

FromJSON TokenIssuer

Defined in Gamgee.Token

Methods

parseJSON :: Value -> Parser TokenIssuer

parseJSONList :: Value -> Parser [TokenIssuer]

data TokenAlgorithm

Constructors

AlgorithmSHA1

AlgorithmSHA256

AlgorithmSHA512

Instances

Show TokenAlgorithm

Defined in Gamgee.Token

Methods

showsPrec :: Int -> TokenAlgorithm -> ShowS

show :: TokenAlgorithm -> String

showList :: [TokenAlgorithm] -> ShowS

Generic TokenAlgorithm

Defined in Gamgee.Token

Associated Types

type Rep TokenAlgorithm :: Type -> Type

Methods

from :: TokenAlgorithm -> Rep TokenAlgorithm x

to :: Rep TokenAlgorithm x -> TokenAlgorithm

ToJSON TokenAlgorithm

Defined in Gamgee.Token

Methods

toJSON :: TokenAlgorithm -> Value

toEncoding :: TokenAlgorithm -> Encoding

toJSONList :: [TokenAlgorithm] -> Value

toEncodingList :: [TokenAlgorithm] -> Encoding

FromJSON TokenAlgorithm

Defined in Gamgee.Token

Methods

parseJSON :: Value -> Parser TokenAlgorithm

parseJSONList :: Value -> Parser [TokenAlgorithm]

type Rep TokenAlgorithm

Defined in Gamgee.Token

type Rep TokenAlgorithm = D1 ('MetaData "TokenAlgorithm" "Gamgee.Token" "gamgee-1.2.2-J40rGWe8DSNLUE2qXWQxyM" 'False) (C1 ('MetaCons "AlgorithmSHA1" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AlgorithmSHA256" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AlgorithmSHA512" 'PrefixI 'False) (U1 :: Type -> Type)))

data TokenDigits

Constructors

Digits6

Digits8

Instances

Show TokenDigits

Defined in Gamgee.Token

Methods

showsPrec :: Int -> TokenDigits -> ShowS

show :: TokenDigits -> String

showList :: [TokenDigits] -> ShowS

ToJSON TokenDigits

Defined in Gamgee.Token

Methods

toJSON :: TokenDigits -> Value

toEncoding :: TokenDigits -> Encoding

toJSONList :: [TokenDigits] -> Value

toEncodingList :: [TokenDigits] -> Encoding

FromJSON TokenDigits

Defined in Gamgee.Token

Methods

parseJSON :: Value -> Parser TokenDigits

parseJSONList :: Value -> Parser [TokenDigits]

newtype TokenPeriod

Refresh interval of the token in seconds

Constructors

TokenPeriod

Fields

• unTokenPeriod :: Word16

Instances

Enum TokenPeriod

Defined in Gamgee.Token

Methods

succ :: TokenPeriod -> TokenPeriod

pred :: TokenPeriod -> TokenPeriod

toEnum :: Int -> TokenPeriod

fromEnum :: TokenPeriod -> Int

enumFrom :: TokenPeriod -> [TokenPeriod]

enumFromThen :: TokenPeriod -> TokenPeriod -> [TokenPeriod]

enumFromTo :: TokenPeriod -> TokenPeriod -> [TokenPeriod]

enumFromThenTo :: TokenPeriod -> TokenPeriod -> TokenPeriod -> [TokenPeriod]

Eq TokenPeriod

Defined in Gamgee.Token

Methods

(==) :: TokenPeriod -> TokenPeriod -> Bool

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

Integral TokenPeriod

Defined in Gamgee.Token

Methods

quot :: TokenPeriod -> TokenPeriod -> TokenPeriod

rem :: TokenPeriod -> TokenPeriod -> TokenPeriod

div :: TokenPeriod -> TokenPeriod -> TokenPeriod

mod :: TokenPeriod -> TokenPeriod -> TokenPeriod

quotRem :: TokenPeriod -> TokenPeriod -> (TokenPeriod, TokenPeriod)

divMod :: TokenPeriod -> TokenPeriod -> (TokenPeriod, TokenPeriod)

toInteger :: TokenPeriod -> Integer

Num TokenPeriod

Defined in Gamgee.Token

Methods

(+) :: TokenPeriod -> TokenPeriod -> TokenPeriod

(-) :: TokenPeriod -> TokenPeriod -> TokenPeriod

(*) :: TokenPeriod -> TokenPeriod -> TokenPeriod

negate :: TokenPeriod -> TokenPeriod

abs :: TokenPeriod -> TokenPeriod

signum :: TokenPeriod -> TokenPeriod

fromInteger :: Integer -> TokenPeriod

Ord TokenPeriod

Defined in Gamgee.Token

Methods

compare :: TokenPeriod -> TokenPeriod -> Ordering

(<) :: TokenPeriod -> TokenPeriod -> Bool

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

(>) :: TokenPeriod -> TokenPeriod -> Bool

(>=) :: TokenPeriod -> TokenPeriod -> Bool

max :: TokenPeriod -> TokenPeriod -> TokenPeriod

min :: TokenPeriod -> TokenPeriod -> TokenPeriod

Real TokenPeriod

Defined in Gamgee.Token

Methods

toRational :: TokenPeriod -> Rational

Show TokenPeriod

Defined in Gamgee.Token

Methods

showsPrec :: Int -> TokenPeriod -> ShowS

show :: TokenPeriod -> String

showList :: [TokenPeriod] -> ShowS

ToJSON TokenPeriod

Defined in Gamgee.Token

Methods

toJSON :: TokenPeriod -> Value

toEncoding :: TokenPeriod -> Encoding

toJSONList :: [TokenPeriod] -> Value

toEncodingList :: [TokenPeriod] -> Encoding

FromJSON TokenPeriod

Defined in Gamgee.Token

Methods

parseJSON :: Value -> Parser TokenPeriod

parseJSONList :: Value -> Parser [TokenPeriod]

data TokenSpec

Constructors

TokenSpec

Fields

• tokenType :: TokenType

  TOTP/HOTP token

• tokenLabel :: TokenLabel

  A short unique label for this token used to identify it

• tokenSecret :: TokenSecret

  The secret provided by the issuer to generate tokens

• tokenIssuer :: TokenIssuer

  The name of the issuer

• tokenAlgorithm :: TokenAlgorithm

  SHA algorithm used to generate tokens

• tokenDigits :: TokenDigits

  Number of digits in the token - 6 or 8

• tokenPeriod :: TokenPeriod

  Refresh interval of the token - typically 30 sec

Instances

Show TokenSpec

Defined in Gamgee.Token

Methods

showsPrec :: Int -> TokenSpec -> ShowS

show :: TokenSpec -> String

showList :: [TokenSpec] -> ShowS

Generic TokenSpec

Defined in Gamgee.Token

Associated Types

type Rep TokenSpec :: Type -> Type

Methods

from :: TokenSpec -> Rep TokenSpec x

to :: Rep TokenSpec x -> TokenSpec

ToJSON TokenSpec

Defined in Gamgee.Token

Methods

toJSON :: TokenSpec -> Value

toEncoding :: TokenSpec -> Encoding

toJSONList :: [TokenSpec] -> Value

toEncodingList :: [TokenSpec] -> Encoding

FromJSON TokenSpec

Defined in Gamgee.Token

Methods

parseJSON :: Value -> Parser TokenSpec

parseJSONList :: Value -> Parser [TokenSpec]

type Rep TokenSpec

Defined in Gamgee.Token

type Rep TokenSpec = D1 ('MetaData "TokenSpec" "Gamgee.Token" "gamgee-1.2.2-J40rGWe8DSNLUE2qXWQxyM" 'False) (C1 ('MetaCons "TokenSpec" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tokenType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenType) :*: (S1 ('MetaSel ('Just "tokenLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenLabel) :*: S1 ('MetaSel ('Just "tokenSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenSecret))) :*: ((S1 ('MetaSel ('Just "tokenIssuer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenIssuer) :*: S1 ('MetaSel ('Just "tokenAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenAlgorithm)) :*: (S1 ('MetaSel ('Just "tokenDigits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenDigits) :*: S1 ('MetaSel ('Just "tokenPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenPeriod)))))

newtype TokenIdentifier

Constructors

TokenIdentifier

Fields

• unTokenIdentifier :: Text

Instances

Eq TokenIdentifier

Defined in Gamgee.Token

Methods

(==) :: TokenIdentifier -> TokenIdentifier -> Bool

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

Show TokenIdentifier

Defined in Gamgee.Token

Methods

showsPrec :: Int -> TokenIdentifier -> ShowS

show :: TokenIdentifier -> String

showList :: [TokenIdentifier] -> ShowS

IsString TokenIdentifier

Defined in Gamgee.Token

Methods

fromString :: String -> TokenIdentifier

Semigroup TokenIdentifier

Defined in Gamgee.Token

Methods

(<>) :: TokenIdentifier -> TokenIdentifier -> TokenIdentifier

sconcat :: NonEmpty TokenIdentifier -> TokenIdentifier

stimes :: Integral b => b -> TokenIdentifier -> TokenIdentifier

Hashable TokenIdentifier

Defined in Gamgee.Token

Methods

hashWithSalt :: Int -> TokenIdentifier -> Int

hash :: TokenIdentifier -> Int

ToJSON TokenIdentifier

Defined in Gamgee.Token

Methods

toJSON :: TokenIdentifier -> Value

toEncoding :: TokenIdentifier -> Encoding

toJSONList :: [TokenIdentifier] -> Value

toEncodingList :: [TokenIdentifier] -> Encoding

ToJSONKey TokenIdentifier

Defined in Gamgee.Token

Methods

toJSONKey :: ToJSONKeyFunction TokenIdentifier

toJSONKeyList :: ToJSONKeyFunction [TokenIdentifier]

FromJSON TokenIdentifier

Defined in Gamgee.Token

Methods

parseJSON :: Value -> Parser TokenIdentifier

parseJSONList :: Value -> Parser [TokenIdentifier]

FromJSONKey TokenIdentifier

Defined in Gamgee.Token

Methods

fromJSONKey :: FromJSONKeyFunction TokenIdentifier

fromJSONKeyList :: FromJSONKeyFunction [TokenIdentifier]

ToString TokenIdentifier

Defined in Gamgee.Token

Methods

toString :: TokenIdentifier -> String

type Tokens = HashMap TokenIdentifier TokenSpec

data Config

Constructors

Config

Fields

• configVersion :: Word32
• configTokens :: Tokens

Instances

Generic Config

Defined in Gamgee.Token

Associated Types

type Rep Config :: Type -> Type

Methods

from :: Config -> Rep Config x

to :: Rep Config x -> Config

ToJSON Config

Defined in Gamgee.Token

Methods

toJSON :: Config -> Value

toEncoding :: Config -> Encoding

toJSONList :: [Config] -> Value

toEncodingList :: [Config] -> Encoding

FromJSON Config

Defined in Gamgee.Token

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

type Rep Config

Defined in Gamgee.Token

type Rep Config = D1 ('MetaData "Config" "Gamgee.Token" "gamgee-1.2.2-J40rGWe8DSNLUE2qXWQxyM" 'False) (C1 ('MetaCons "Config" 'PrefixI 'True) (S1 ('MetaSel ('Just "configVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32) :*: S1 ('MetaSel ('Just "configTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tokens)))

getIdentifier :: TokenSpec -> TokenIdentifier

currentConfigVersion :: Word32

initialConfig :: Config