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

Defined in Authenticator.Vault

Methods

showsPrec :: Int -> Mode -> ShowS

show :: Mode -> String

showList :: [Mode] -> ShowS

Generic Mode

Defined in Authenticator.Vault

Associated Types

type Rep Mode :: Type -> Type

Methods

from :: Mode -> Rep Mode x

to :: Rep Mode x -> Mode

ToJSON SomeSecretState

Defined in Authenticator.Vault

Methods

toJSON :: SomeSecretState -> Value

toEncoding :: SomeSecretState -> Encoding

toJSONList :: [SomeSecretState] -> Value

toEncodingList :: [SomeSecretState] -> Encoding

ToJSON Mode

Defined in Authenticator.Vault

Methods

toJSON :: Mode -> Value

toEncoding :: Mode -> Encoding

toJSONList :: [Mode] -> Value

toEncodingList :: [Mode] -> Encoding

Binary SomeSecretState

Defined in Authenticator.Vault

Methods

put :: SomeSecretState -> Put

get :: Get SomeSecretState

putList :: [SomeSecretState] -> Put

Binary Mode

Defined in Authenticator.Vault

Methods

put :: Mode -> Put

get :: Get Mode

putList :: [Mode] -> Put

GShow SMode

Defined in Authenticator.Vault

Methods

gshowsPrec :: Int -> SMode a -> ShowS

type Rep Mode

Defined in Authenticator.Vault

type Rep Mode = D1 (MetaData "Mode" "Authenticator.Vault" "otp-authenticator-0.1.1.0-inplace" False) (C1 (MetaCons "HOTP" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "TOTP" PrefixI False) (U1 :: Type -> Type))

data SMode :: Mode -> Type where

Singleton for Mode

Constructors

SHOTP :: SMode HOTP

STOTP :: SMode TOTP

Instances

ToJSON SomeSecretState

Defined in Authenticator.Vault

Methods

toJSON :: SomeSecretState -> Value

toEncoding :: SomeSecretState -> Encoding

toJSONList :: [SomeSecretState] -> Value

toEncodingList :: [SomeSecretState] -> Encoding

Binary SomeSecretState

Defined in Authenticator.Vault

Methods

put :: SomeSecretState -> Put

get :: Get SomeSecretState

putList :: [SomeSecretState] -> Put

GShow SMode

Defined in Authenticator.Vault

Methods

gshowsPrec :: Int -> SMode a -> ShowS

Show (SMode m)

Defined in Authenticator.Vault

Methods

showsPrec :: Int -> SMode m -> ShowS

show :: SMode m -> String

showList :: [SMode m] -> ShowS

withSMode :: Mode -> (forall m. SMode m -> r) -> r

Reify a Mode to its singleton

fromSMode :: SMode m -> Mode

Reflect a SMode to its value.

data HashAlgo

Which OTP-approved hash algorithm to use?

Constructors

HASHA1

HASHA256

HASHA512

Instances

Show HashAlgo

Defined in Authenticator.Vault

Methods

showsPrec :: Int -> HashAlgo -> ShowS

show :: HashAlgo -> String

showList :: [HashAlgo] -> ShowS

Generic HashAlgo

Defined in Authenticator.Vault

Associated Types

type Rep HashAlgo :: Type -> Type

Methods

from :: HashAlgo -> Rep HashAlgo x

to :: Rep HashAlgo x -> HashAlgo

ToJSON HashAlgo

Defined in Authenticator.Vault

Methods

toJSON :: HashAlgo -> Value

toEncoding :: HashAlgo -> Encoding

toJSONList :: [HashAlgo] -> Value

toEncodingList :: [HashAlgo] -> Encoding

Binary HashAlgo

Defined in Authenticator.Vault

Methods

put :: HashAlgo -> Put

get :: Get HashAlgo

putList :: [HashAlgo] -> Put

type Rep HashAlgo

Defined in Authenticator.Vault

type Rep HashAlgo = D1 (MetaData "HashAlgo" "Authenticator.Vault" "otp-authenticator-0.1.1.0-inplace" False) (C1 (MetaCons "HASHA1" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "HASHA256" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "HASHA512" PrefixI False) (U1 :: Type -> Type)))

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

Fields

• :: { secAccount :: Text
•    , secIssuer :: Maybe Text
•    , secAlgo :: HashAlgo
•    , secDigits :: OTPDigits
•    , secKey :: ByteString
•    } -> Secret m

Instances

ToJSON SomeSecretState

Defined in Authenticator.Vault

Methods

toJSON :: SomeSecretState -> Value

toEncoding :: SomeSecretState -> Encoding

toJSONList :: [SomeSecretState] -> Value

toEncodingList :: [SomeSecretState] -> Encoding

Binary SomeSecretState

Defined in Authenticator.Vault

Methods

put :: SomeSecretState -> Put

get :: Get SomeSecretState

putList :: [SomeSecretState] -> Put

Show (Secret a)

Defined in Authenticator.Vault

Methods

showsPrec :: Int -> Secret a -> ShowS

show :: Secret a -> String

showList :: [Secret a] -> ShowS

Generic (Secret a)

Defined in Authenticator.Vault

Associated Types

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

Methods

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

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

ToJSON (Secret m)

Defined in Authenticator.Vault

Methods

toJSON :: Secret m -> Value

toEncoding :: Secret m -> Encoding

toJSONList :: [Secret m] -> Value

toEncodingList :: [Secret m] -> Encoding

Binary (Secret m)

Defined in Authenticator.Vault

Methods

put :: Secret m -> Put

get :: Get (Secret m)

putList :: [Secret m] -> Put

type Rep (Secret a)

Defined in Authenticator.Vault

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

newtype OTPDigits

Newtype wrapper to provide Eq, Ord, Binary, and ToJSON instances. You can convert to and from this and the Int representation using OTPDigitsInt

Constructors

OTPDigits

Fields

• otpDigits :: OTPDigits

Instances

Eq OTPDigits

Defined in Authenticator.Vault

Methods

(==) :: OTPDigits -> OTPDigits -> Bool

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

Ord OTPDigits

Defined in Authenticator.Vault

Methods

compare :: OTPDigits -> OTPDigits -> Ordering

(<) :: OTPDigits -> OTPDigits -> Bool

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

(>) :: OTPDigits -> OTPDigits -> Bool

(>=) :: OTPDigits -> OTPDigits -> Bool

max :: OTPDigits -> OTPDigits -> OTPDigits

min :: OTPDigits -> OTPDigits -> OTPDigits

Show OTPDigits

Defined in Authenticator.Vault

Methods

showsPrec :: Int -> OTPDigits -> ShowS

show :: OTPDigits -> String

showList :: [OTPDigits] -> ShowS

ToJSON OTPDigits

Defined in Authenticator.Vault

Methods

toJSON :: OTPDigits -> Value

toEncoding :: OTPDigits -> Encoding

toJSONList :: [OTPDigits] -> Value

toEncodingList :: [OTPDigits] -> Encoding

Binary OTPDigits

Defined in Authenticator.Vault

Methods

put :: OTPDigits -> Put

get :: Get OTPDigits

putList :: [OTPDigits] -> Put

pattern OTPDigitsInt :: OTPDigits -> Int

data family ModeState :: Mode -> Type

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

Instances

ToJSON SomeSecretState

Defined in Authenticator.Vault

Methods

toJSON :: SomeSecretState -> Value

toEncoding :: SomeSecretState -> Encoding

toJSONList :: [SomeSecretState] -> Value

toEncodingList :: [SomeSecretState] -> Encoding

Binary SomeSecretState

Defined in Authenticator.Vault

Methods

put :: SomeSecretState -> Put

get :: Get SomeSecretState

putList :: [SomeSecretState] -> Put

Show (ModeState HOTP)

Defined in Authenticator.Vault

Methods

showsPrec :: Int -> ModeState HOTP -> ShowS

show :: ModeState HOTP -> String

showList :: [ModeState HOTP] -> ShowS

Show (ModeState TOTP)

Defined in Authenticator.Vault

Methods

showsPrec :: Int -> ModeState TOTP -> ShowS

show :: ModeState TOTP -> String

showList :: [ModeState TOTP] -> ShowS

Generic (ModeState HOTP)

Defined in Authenticator.Vault

Associated Types

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

Methods

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

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

Generic (ModeState TOTP)

Defined in Authenticator.Vault

Associated Types

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

Methods

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

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

ToJSON (ModeState HOTP)

Defined in Authenticator.Vault

Methods

toJSON :: ModeState HOTP -> Value

toEncoding :: ModeState HOTP -> Encoding

toJSONList :: [ModeState HOTP] -> Value

toEncodingList :: [ModeState HOTP] -> Encoding

ToJSON (ModeState TOTP)

Defined in Authenticator.Vault

Methods

toJSON :: ModeState TOTP -> Value

toEncoding :: ModeState TOTP -> Encoding

toJSONList :: [ModeState TOTP] -> Value

toEncodingList :: [ModeState TOTP] -> Encoding

Binary (ModeState HOTP)

Defined in Authenticator.Vault

Methods

put :: ModeState HOTP -> Put

get :: Get (ModeState HOTP)

putList :: [ModeState HOTP] -> Put

Binary (ModeState TOTP)

Defined in Authenticator.Vault

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.

Defined in Authenticator.Vault

data ModeState HOTP = HOTPState {

• hotpCounter :: Word64

}

data ModeState TOTP

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

Defined in Authenticator.Vault

data ModeState TOTP = TOTPState

type Rep (ModeState HOTP)

Defined in Authenticator.Vault

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

type Rep (ModeState TOTP)

Defined in Authenticator.Vault

type Rep (ModeState TOTP) = D1 (MetaData "ModeState" "Authenticator.Vault" "otp-authenticator-0.1.1.0-inplace" False) (C1 (MetaCons "TOTPState" PrefixI False) (U1 :: Type -> Type))

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

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

newtype Vault

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

Constructors

Vault

Fields

• vaultList :: [SomeSecretState]

Instances

Generic Vault

Defined in Authenticator.Vault

Associated Types

type Rep Vault :: Type -> Type

Methods

from :: Vault -> Rep Vault x

to :: Rep Vault x -> Vault

ToJSON Vault

Defined in Authenticator.Vault

Methods

toJSON :: Vault -> Value

toEncoding :: Vault -> Encoding

toJSONList :: [Vault] -> Value

toEncodingList :: [Vault] -> Encoding

Binary Vault

Defined in Authenticator.Vault

Methods

put :: Vault -> Put

get :: Get Vault

putList :: [Vault] -> Put

type Rep Vault

Defined in Authenticator.Vault

type Rep Vault = D1 (MetaData "Vault" "Authenticator.Vault" "otp-authenticator-0.1.1.0-inplace" True) (C1 (MetaCons "Vault" PrefixI True) (S1 (MetaSel (Just "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 -> POSIXTime -> Text

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

otp :: SMode m -> Secret m -> ModeState m -> IO (Text, ModeState m)

Abstract over both hotp and totp.

someSecret :: Functor f => (forall m. SMode 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. SMode 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