Authenticator.Vault

Types for storing, serializing, accessing OTP keys. Gratuitous type-level programming here for no reason because I have issues.

Based off of https://github.com/google/google-authenticator.

Documentation

data Mode

OTP generation mode

Constructors

HOTP

Counter-based

TOTP

Time-based

Instances

Show Mode

Methods

showsPrec :: Int -> Mode -> ShowS

show :: Mode -> String

showList :: [Mode] -> ShowS

Generic Mode

Associated Types

type Rep Mode :: * -> *

Methods

from :: Mode -> Rep Mode x

to :: Rep Mode x -> Mode

ToJSON Mode

Methods

toJSON :: Mode -> Value

toEncoding :: Mode -> Encoding

toJSONList :: [Mode] -> Value

toEncodingList :: [Mode] -> Encoding

ToJSON SomeSecretState

Methods

toJSON :: SomeSecretState -> Value

toEncoding :: SomeSecretState -> Encoding

toJSONList :: [SomeSecretState] -> Value

toEncodingList :: [SomeSecretState] -> Encoding

Binary Mode

Methods

put :: Mode -> Put

get :: Get Mode

putList :: [Mode] -> Put

Binary SomeSecretState

Methods

put :: SomeSecretState -> Put

get :: Get SomeSecretState

putList :: [SomeSecretState] -> Put

SingKind Mode

Associated Types

type DemoteRep Mode :: *

Methods

fromSing :: Sing Mode a -> DemoteRep Mode

toSing :: DemoteRep Mode -> SomeSing Mode

SingI Mode HOTP

Methods

sing :: Sing HOTP a

SingI Mode TOTP

Methods

sing :: Sing TOTP a

type Rep Mode

type Rep Mode = D1 (MetaData "Mode" "Authenticator.Vault" "otp-authenticator-0.1.0.1-6m9CjvDGB2e3igWXZqP3sU" False) ((:+:) (C1 (MetaCons "HOTP" PrefixI False) U1) (C1 (MetaCons "TOTP" PrefixI False) U1))

data Sing Mode

data Sing Mode where

• SHOTP :: Sing Mode z
• STOTP :: Sing Mode z

type DemoteRep Mode

type DemoteRep Mode = Mode

data family Sing k (a :: k) :: *

The singleton kind-indexed data family.

Instances

ToJSON SomeSecretState

Methods

toJSON :: SomeSecretState -> Value

toEncoding :: SomeSecretState -> Encoding

toJSONList :: [SomeSecretState] -> Value

toEncodingList :: [SomeSecretState] -> Encoding

Binary SomeSecretState

Methods

put :: SomeSecretState -> Put

get :: Get SomeSecretState

putList :: [SomeSecretState] -> Put

data Sing Bool

data Sing Bool where

• SFalse :: Sing Bool z0
• STrue :: Sing Bool z0

data Sing Ordering

data Sing Ordering where

• SLT :: Sing Ordering z0
• SEQ :: Sing Ordering z0
• SGT :: Sing Ordering z0

data Sing Nat

data Sing Nat where

• SNat :: Sing Nat n

data Sing Symbol

data Sing Symbol where

• SSym :: Sing Symbol n

data Sing ()

data Sing () where

• STuple0 :: Sing () z0

data Sing Mode

data Sing Mode where

• SHOTP :: Sing Mode z
• STOTP :: Sing Mode z

data Sing [a0]

data Sing [a0] where

• SNil :: Sing [a0] z0
• SCons :: Sing [a0] z0

data Sing (Maybe a0)

data Sing (Maybe a0) where

• SNothing :: Sing (Maybe a0) z0
• SJust :: Sing (Maybe a0) z0

data Sing (NonEmpty a0)

data Sing (NonEmpty a0) where

• (:%|) :: Sing (NonEmpty a0) z0

data Sing (Either a0 b0)

data Sing (Either a0 b0) where

• SLeft :: Sing (Either a0 b0) z0
• SRight :: Sing (Either a0 b0) z0

data Sing (a0, b0)

data Sing (a0, b0) where

• STuple2 :: Sing (a0, b0) z0

data Sing ((~>) k1 k2)

data Sing ((~>) k1 k2) = SLambda {

• applySing :: forall t. Sing k1 t -> Sing k2 ((@@) k1 k2 f t)

}

data Sing (a0, b0, c0)

data Sing (a0, b0, c0) where

• STuple3 :: Sing (a0, b0, c0) z0

data Sing (a0, b0, c0, d0)

data Sing (a0, b0, c0, d0) where

• STuple4 :: Sing (a0, b0, c0, d0) z0

data Sing (a0, b0, c0, d0, e0)

data Sing (a0, b0, c0, d0, e0) where

• STuple5 :: Sing (a0, b0, c0, d0, e0) z0

data Sing (a0, b0, c0, d0, e0, f0)

data Sing (a0, b0, c0, d0, e0, f0) where

• STuple6 :: Sing (a0, b0, c0, d0, e0, f0) z0

data Sing (a0, b0, c0, d0, e0, f0, g0)

data Sing (a0, b0, c0, d0, e0, f0, g0) where

• STuple7 :: Sing (a0, b0, c0, d0, e0, f0, g0) z0

type SMode = (Sing :: Mode -> Type)

type HOTPSym0 = HOTP

type TOTPSym0 = TOTP

data HashAlgo

Which OTP-approved hash algorithm to use?

Constructors

HASHA1

HASHA256

HASHA512

Instances

Show HashAlgo

Methods

showsPrec :: Int -> HashAlgo -> ShowS

show :: HashAlgo -> String

showList :: [HashAlgo] -> ShowS

Generic HashAlgo

Associated Types

type Rep HashAlgo :: * -> *

Methods

from :: HashAlgo -> Rep HashAlgo x

to :: Rep HashAlgo x -> HashAlgo

ToJSON HashAlgo

Methods

toJSON :: HashAlgo -> Value

toEncoding :: HashAlgo -> Encoding

toJSONList :: [HashAlgo] -> Value

toEncodingList :: [HashAlgo] -> Encoding

Binary HashAlgo

Methods

put :: HashAlgo -> Put

get :: Get HashAlgo

putList :: [HashAlgo] -> Put

type Rep HashAlgo

type Rep HashAlgo = D1 (MetaData "HashAlgo" "Authenticator.Vault" "otp-authenticator-0.1.0.1-6m9CjvDGB2e3igWXZqP3sU" False) ((:+:) (C1 (MetaCons "HASHA1" PrefixI False) U1) ((:+:) (C1 (MetaCons "HASHA256" PrefixI False) U1) (C1 (MetaCons "HASHA512" PrefixI False) U1)))

parseAlgo :: String -> Maybe HashAlgo

Parse a hash algorithm string into the appropriate HashAlgo.

data Secret :: Mode -> Type where

A standards-compliant secret key type. Well, almost. It doesn't include configuration for the time period if it's time-based.

Constructors

Sec :: {..} -> Secret m

Fields

• secAccount :: Text
• secIssuer :: Maybe Text
• secAlgo :: HashAlgo
• secDigits :: Word
• secKey :: ByteString

Instances

ToJSON SomeSecretState

Methods

toJSON :: SomeSecretState -> Value

toEncoding :: SomeSecretState -> Encoding

toJSONList :: [SomeSecretState] -> Value

toEncodingList :: [SomeSecretState] -> Encoding

Binary SomeSecretState

Methods

put :: SomeSecretState -> Put

get :: Get SomeSecretState

putList :: [SomeSecretState] -> Put

Show (Secret a)

Methods

showsPrec :: Int -> Secret a -> ShowS

show :: Secret a -> String

showList :: [Secret a] -> ShowS

Generic (Secret a)

Associated Types

type Rep (Secret a) :: * -> *

Methods

from :: Secret a -> Rep (Secret a) x

to :: Rep (Secret a) x -> Secret a

ToJSON (Secret m)

Methods

toJSON :: Secret m -> Value

toEncoding :: Secret m -> Encoding

toJSONList :: [Secret m] -> Value

toEncodingList :: [Secret m] -> Encoding

Binary (Secret m)

Methods

put :: Secret m -> Put

get :: Get (Secret m)

putList :: [Secret m] -> Put

type Rep (Secret a)

type Rep (Secret a) = D1 (MetaData "Secret" "Authenticator.Vault" "otp-authenticator-0.1.0.1-6m9CjvDGB2e3igWXZqP3sU" False) (C1 (MetaCons "Sec" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "secAccount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "secIssuer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "secAlgo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HashAlgo)) ((:*:) (S1 (MetaSel (Just Symbol "secDigits") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word)) (S1 (MetaSel (Just Symbol "secKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString))))))

data family ModeState :: Mode -> Type

A data family consisting of the state required by each mode.

Instances

ToJSON SomeSecretState

Methods

toJSON :: SomeSecretState -> Value

toEncoding :: SomeSecretState -> Encoding

toJSONList :: [SomeSecretState] -> Value

toEncodingList :: [SomeSecretState] -> Encoding

Binary SomeSecretState

Methods

put :: SomeSecretState -> Put

get :: Get SomeSecretState

putList :: [SomeSecretState] -> Put

Show (ModeState HOTP)

Methods

showsPrec :: Int -> ModeState HOTP -> ShowS

show :: ModeState HOTP -> String

showList :: [ModeState HOTP] -> ShowS

Show (ModeState TOTP)

Methods

showsPrec :: Int -> ModeState TOTP -> ShowS

show :: ModeState TOTP -> String

showList :: [ModeState TOTP] -> ShowS

Generic (ModeState HOTP)

Associated Types

type Rep (ModeState HOTP) :: * -> *

Methods

from :: ModeState HOTP -> Rep (ModeState HOTP) x

to :: Rep (ModeState HOTP) x -> ModeState HOTP

Generic (ModeState TOTP)

Associated Types

type Rep (ModeState TOTP) :: * -> *

Methods

from :: ModeState TOTP -> Rep (ModeState TOTP) x

to :: Rep (ModeState TOTP) x -> ModeState TOTP

ToJSON (ModeState HOTP)

Methods

toJSON :: ModeState HOTP -> Value

toEncoding :: ModeState HOTP -> Encoding

toJSONList :: [ModeState HOTP] -> Value

toEncodingList :: [ModeState HOTP] -> Encoding

ToJSON (ModeState TOTP)

Methods

toJSON :: ModeState TOTP -> Value

toEncoding :: ModeState TOTP -> Encoding

toJSONList :: [ModeState TOTP] -> Value

toEncodingList :: [ModeState TOTP] -> Encoding

Binary (ModeState HOTP)

Methods

put :: ModeState HOTP -> Put

get :: Get (ModeState HOTP)

putList :: [ModeState HOTP] -> Put

Binary (ModeState TOTP)

Methods

put :: ModeState TOTP -> Put

get :: Get (ModeState TOTP)

putList :: [ModeState TOTP] -> Put

data ModeState HOTP

For HOTP (counter-based) mode, the state is the current counter.

data ModeState HOTP = HOTPState {

• hotpCounter :: Word64

}

data ModeState TOTP

For TOTP (time-based) mode, there is no state.

data ModeState TOTP = TOTPState

type Rep (ModeState HOTP)

type Rep (ModeState HOTP) = D1 (MetaData "ModeState" "Authenticator.Vault" "otp-authenticator-0.1.0.1-6m9CjvDGB2e3igWXZqP3sU" False) (C1 (MetaCons "HOTPState" PrefixI True) (S1 (MetaSel (Just Symbol "hotpCounter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64)))

type Rep (ModeState TOTP)

type Rep (ModeState TOTP) = D1 (MetaData "ModeState" "Authenticator.Vault" "otp-authenticator-0.1.0.1-6m9CjvDGB2e3igWXZqP3sU" False) (C1 (MetaCons "TOTPState" PrefixI False) U1)

type SomeSecretState = DSum SMode (Secret :&: ModeState)

A Secret coupled with its ModeState, existentially quantified over its Mode.

data Vault

A list of secrets and their states, of various modes.

Constructors

Vault

Fields

• vaultList :: [SomeSecretState]

Instances

Generic Vault

Associated Types

type Rep Vault :: * -> *

Methods

from :: Vault -> Rep Vault x

to :: Rep Vault x -> Vault

ToJSON Vault

Methods

toJSON :: Vault -> Value

toEncoding :: Vault -> Encoding

toJSONList :: [Vault] -> Value

toEncodingList :: [Vault] -> Encoding

Binary Vault

Methods

put :: Vault -> Put

get :: Get Vault

putList :: [Vault] -> Put

type Rep Vault

type Rep Vault = D1 (MetaData "Vault" "Authenticator.Vault" "otp-authenticator-0.1.0.1-6m9CjvDGB2e3igWXZqP3sU" False) (C1 (MetaCons "Vault" PrefixI True) (S1 (MetaSel (Just Symbol "vaultList") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SomeSecretState])))

_Vault :: Functor f => ([SomeSecretState] -> f [SomeSecretState]) -> Vault -> f Vault

A lens into the list of SomeSecretStates in a Vault. Should be an Iso but we don't want a lens dependency now, do we.

hotp :: Secret HOTP -> ModeState HOTP -> (Text, ModeState HOTP)

Generate an HTOP (counter-based) code, returning a modified state.

totp :: Secret TOTP -> IO Text

Generate a TOTP (time-based) code in IO for the current time.

totp_ :: Secret TOTP -> UTCTime -> Text

(Purely) generate a TOTP (time-based) code, for a given time.

otp :: forall m. SingI m => Secret m -> ModeState m -> IO (Text, ModeState m)

Abstract over both hotp and totp.

someSecret :: Functor f => (forall m. SingI m => Secret m -> ModeState m -> f (ModeState m)) -> SomeSecretState -> f SomeSecretState

Some sort of RankN lens and traversal over a SomeSecret. Allows you to traverse (effectfully map) over the ModeState in a SomeSecretState, with access to the Secret as well.

With this you can implement getters and setters. It's also used by the library to update the ModeState in IO.

vaultSecrets :: Applicative f => (forall m. SingI m => Secret m -> ModeState m -> f (ModeState m)) -> Vault -> f Vault

A RankN traversal over all of the Secrets and ModeStates in a Vault.

describeSecret :: Secret m -> Text

Print out the metadata (account name and issuer) of a Secret.

secretURI :: Parser SomeSecretState

A parser for a otpauth URI.

parseSecretURI :: String -> Either String SomeSecretState

Parse a valid otpauth URI and initialize its state.

See https://github.com/google/google-authenticator/wiki/Key-Uri-Format

Orphan instances

(Functor f, Functor g) => Functor ((:.:) * * f g)

Methods

fmap :: (a -> b) -> (* :.: *) f g a -> (* :.: *) f g b

(<$) :: a -> (* :.: *) f g b -> (* :.: *) f g a