OTP.Commons

Auxiliary

data OTP

Since: 3.0.0.0

Constructors

OTP

Fields

• digits :: Word32
• code :: Word32

Instances

Show OTP

Since: 3.0.0.0

Defined in OTP.Commons

Methods

showsPrec :: Int -> OTP -> ShowS

show :: OTP -> String

showList :: [OTP] -> ShowS

Eq OTP

Since: 3.0.0.0

Defined in OTP.Commons

Methods

(==) :: OTP -> OTP -> Bool

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

Ord OTP

Since: 3.0.0.0

Defined in OTP.Commons

Methods

compare :: OTP -> OTP -> Ordering

(<) :: OTP -> OTP -> Bool

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

(>) :: OTP -> OTP -> Bool

(>=) :: OTP -> OTP -> Bool

max :: OTP -> OTP -> OTP

min :: OTP -> OTP -> OTP

Display OTP

Since: 3.0.0.0

Defined in OTP.Commons

Methods

displayBuilder :: OTP -> Builder

displayList :: [OTP] -> Builder

displayPrec :: Int -> OTP -> Builder

data Digits

Since: 3.0.0.0

Instances

Show Digits

Defined in OTP.Commons

Methods

showsPrec :: Int -> Digits -> ShowS

show :: Digits -> String

showList :: [Digits] -> ShowS

Eq Digits

Defined in OTP.Commons

Methods

(==) :: Digits -> Digits -> Bool

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

Ord Digits

Defined in OTP.Commons

Methods

compare :: Digits -> Digits -> Ordering

(<) :: Digits -> Digits -> Bool

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

(>) :: Digits -> Digits -> Bool

(>=) :: Digits -> Digits -> Bool

max :: Digits -> Digits -> Digits

min :: Digits -> Digits -> Digits

Display Digits

Defined in OTP.Commons

Methods

displayBuilder :: Digits -> Builder

displayList :: [Digits] -> Builder

displayPrec :: Int -> Digits -> Builder

data Algorithm

Since: 3.0.0.0

Constructors

HMAC_SHA1

HMAC_SHA256

HMAC_SHA512

Instances

Show Algorithm

Since: 3.0.0.0

Defined in OTP.Commons

Methods

showsPrec :: Int -> Algorithm -> ShowS

show :: Algorithm -> String

showList :: [Algorithm] -> ShowS

Eq Algorithm

Since: 3.0.0.0

Defined in OTP.Commons

Methods

(==) :: Algorithm -> Algorithm -> Bool

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

Ord Algorithm

Since: 3.0.0.0

Defined in OTP.Commons

Methods

compare :: Algorithm -> Algorithm -> Ordering

(<) :: Algorithm -> Algorithm -> Bool

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

(>) :: Algorithm -> Algorithm -> Bool

(>=) :: Algorithm -> Algorithm -> Bool

max :: Algorithm -> Algorithm -> Algorithm

min :: Algorithm -> Algorithm -> Algorithm

Display Algorithm

Since: 3.0.0.0

Defined in OTP.Commons

Methods

displayBuilder :: Algorithm -> Builder

displayList :: [Algorithm] -> Builder

displayPrec :: Int -> Algorithm -> Builder

mkDigits :: Word32 -> Maybe Digits

RFC 4226 §5.3 says "Implementations MUST extract a 6-digit code at a minimum and possibly 7 and 8-digit code".

This function validates that the number of desired digits is equal or greater than 6.

digitsToWord32 :: Digits -> Word32

totpCounter

Arguments

:: Time

Time of totp

-> Timespan

Time range in seconds

-> Word64

Resulting counter

Calculate HOTP counter using time. Starting time (T0 according to RFC6238) is 0 (begining of UNIX epoch) >>> let timestamp = decode "2010-10-10 00:00:30" >>> let timespan = Torsor.scale 30 Chronos.second >>> totpCounter timestamp timespan 42888961

>>> let timestamp2 = decode "2010-10-10 00:00:45"
>>> totpCounter timestamp2 timespan
42888961

>>> let timestamp3 = decode "2010-10-10 00:01:00"
>>> totpCounter timestamp3 timespan
42888962

Since: 3.0.0.0

counterRange

Arguments

:: (Word64, Word64)

Number of counters before and after ideal

-> Word64

Ideal counter value

-> [Word64]

Make a sequence of acceptable counters, protected from arithmetic overflow. Maximum range is limited to 1000 due to huge counter ranges being insecure.

>>> counterRange (0, 0) 9000
[9000]

>>> counterRange (1, 0) 9000
[8999,9000]

>>> length $ counterRange (5000, 0) 9000
501

>>> length $ counterRange (5000, 5000) 9000
1000

>>> counterRange (2, 2) maxBound
[18446744073709551613,18446744073709551614,18446744073709551615]

>>> counterRange (2, 2) minBound
[0,1,2]

>>> counterRange (2, 2) (maxBound `div` 2)
[9223372036854775805,9223372036854775806,9223372036854775807,9223372036854775808,9223372036854775809]

>>> counterRange (5, 5) 9000
[8995,8996,8997,8998,8999,9000,9001,9002,9003,9004,9005]

RFC recommends avoiding excessively large values for counter ranges.

Since: 3.0.0.0

totpCounterRange :: (Word64, Word64) -> Time -> Timespan -> [Word64]

Make a sequence of acceptable periods.

>>> let time = decode "2010-10-10 00:00:30"
>>> let timespan = Torsor.scale 30 Chronos.second
>>> totpCounterRange (1, 1) time timespan
[42888960,42888961,42888962]

Since: 3.0.0.0