Safe Haskell	Safe-Inferred
Language	GHC2021

Data.ZAuth.Token

Contents

Token
Header
Access body
User body
Bot body
Provider body
LegalHold body

Synopsis

data Token a
signature :: Getter (Token a) Signature
header :: Getter (Token a) Header
body :: Getter (Token a) a
mkToken :: Signature -> Header -> a -> Token a
data Header
version :: Lens' Header Int
key :: Lens' Header Int
time :: Lens' Header Integer
typ :: Lens' Header Type
tag :: Lens' Header (Maybe Tag)
mkHeader :: Int -> Int -> Integer -> Type -> Maybe Tag -> Header
data Type
- = A
- | U
- | B
- | P
- | LA
- | LU
data Tag = S
data Access
userId :: Lens' Access UUID
clientId :: Lens' Access (Maybe Text)
connection :: Lens' Access Word64
mkAccess :: UUID -> Maybe Text -> Word64 -> Access
data User
user :: Lens' User UUID
client :: Lens' User (Maybe Text)
rand :: Lens' User Word32
mkUser :: UUID -> Maybe Text -> Word32 -> User
data Bot
prov :: Lens' Bot UUID
bot :: Lens' Bot UUID
conv :: Lens' Bot UUID
mkBot :: UUID -> UUID -> UUID -> Bot
data Provider
provider :: Iso' Provider UUID
mkProvider :: UUID -> Provider
data LegalHoldUser
legalHoldUser :: Iso' LegalHoldUser User
mkLegalHoldUser :: UUID -> Maybe Text -> Word32 -> LegalHoldUser
data LegalHoldAccess
legalHoldAccess :: Iso' LegalHoldAccess Access
mkLegalHoldAccess :: UUID -> Maybe Text -> Word64 -> LegalHoldAccess
writeData :: ToByteString a => Header -> a -> Builder

Token

data Token a Source #

Instances

Instances details

Show a => Show (Token a) Source #
Instance details Defined in Data.ZAuth.Token Methods showsPrec :: Int -> Token a -> ShowS # show :: Token a -> String # showList :: [Token a] -> ShowS #
FromByteString (Token Access) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token Access) Source #
FromByteString (Token Bot) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token Bot) Source #
FromByteString (Token LegalHoldAccess) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token LegalHoldAccess) Source #
FromByteString (Token LegalHoldUser) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token LegalHoldUser) Source #
FromByteString (Token Provider) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token Provider) Source #
FromByteString (Token User) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token User) Source #
ToByteString a => ToByteString (Token a) Source #
Instance details Defined in Data.ZAuth.Token Methods builder :: Token a -> Builder Source #
Eq a => Eq (Token a) Source #
Instance details Defined in Data.ZAuth.Token Methods (==) :: Token a -> Token a -> Bool # (/=) :: Token a -> Token a -> Bool #

signature :: Getter (Token a) Signature Source #

header :: Getter (Token a) Header Source #

body :: Getter (Token a) a Source #

mkToken :: Signature -> Header -> a -> Token a Source #

Header

data Header Source #

Instances

version :: Lens' Header Int Source #

key :: Lens' Header Int Source #

time :: Lens' Header Integer Source #

typ :: Lens' Header Type Source #

tag :: Lens' Header (Maybe Tag) Source #

mkHeader :: Int -> Int -> Integer -> Type -> Maybe Tag -> Header Source #

data Type Source #

Constructors

A	Access (Used as short-lived token for Users)
U	User (Used as a cookie for Users to refresh access tokens)
B	Bot
P	Provider
LA	LegalHold Access (Used as short-lived token for LegalHold Service)
LU	LegalHold User (Used as a cookie for LegalHold Service to refresh access tokens)

Instances

Instances details

Show Type Source #
Instance details Defined in Data.ZAuth.Token Methods showsPrec :: Int -> Type -> ShowS # show :: Type -> String # showList :: [Type] -> ShowS #
ToByteString Type Source #
Instance details Defined in Data.ZAuth.Token Methods builder :: Type -> Builder Source #
Eq Type Source #
Instance details Defined in Data.ZAuth.Token Methods (==) :: Type -> Type -> Bool # (/=) :: Type -> Type -> Bool #

data Tag Source #

Tag: Tokens for Users with no tag are refreshable themselves and called UserToken Tokens for Users with the tag S are non-refreshable themselves and called SessionToken FUTUREWORK: rename S to SessionTag for clarity

Constructors

S

Instances

Instances details

Show Tag Source #
Instance details Defined in Data.ZAuth.Token Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
ToByteString Tag Source #
Instance details Defined in Data.ZAuth.Token Methods builder :: Tag -> Builder Source #
Eq Tag Source #
Instance details Defined in Data.ZAuth.Token Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #

Access body

data Access Source #

Instances

Instances details

Show Access Source #
Instance details Defined in Data.ZAuth.Token Methods showsPrec :: Int -> Access -> ShowS # show :: Access -> String # showList :: [Access] -> ShowS #
ToByteString Access Source #
Instance details Defined in Data.ZAuth.Token Methods builder :: Access -> Builder Source #
Eq Access Source #
Instance details Defined in Data.ZAuth.Token Methods (==) :: Access -> Access -> Bool # (/=) :: Access -> Access -> Bool #
FromByteString (Token Access) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token Access) Source #

userId :: Lens' Access UUID Source #

clientId :: Lens' Access (Maybe Text) Source #

connection :: Lens' Access Word64 Source #

mkAccess :: UUID -> Maybe Text -> Word64 -> Access Source #

User body

data User Source #

Instances

Instances details

Show User Source #
Instance details Defined in Data.ZAuth.Token Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
ToByteString User Source #
Instance details Defined in Data.ZAuth.Token Methods builder :: User -> Builder Source #
Eq User Source #
Instance details Defined in Data.ZAuth.Token Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
FromByteString (Token User) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token User) Source #

user :: Lens' User UUID Source #

client :: Lens' User (Maybe Text) Source #

rand :: Lens' User Word32 Source #

mkUser :: UUID -> Maybe Text -> Word32 -> User Source #

Bot body

data Bot Source #

Instances

Instances details

Show Bot Source #
Instance details Defined in Data.ZAuth.Token Methods showsPrec :: Int -> Bot -> ShowS # show :: Bot -> String # showList :: [Bot] -> ShowS #
ToByteString Bot Source #
Instance details Defined in Data.ZAuth.Token Methods builder :: Bot -> Builder Source #
Eq Bot Source #
Instance details Defined in Data.ZAuth.Token Methods (==) :: Bot -> Bot -> Bool # (/=) :: Bot -> Bot -> Bool #
FromByteString (Token Bot) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token Bot) Source #

prov :: Lens' Bot UUID Source #

bot :: Lens' Bot UUID Source #

conv :: Lens' Bot UUID Source #

mkBot :: UUID -> UUID -> UUID -> Bot Source #

Provider body

data Provider Source #

Instances

Instances details

Show Provider Source #
Instance details Defined in Data.ZAuth.Token Methods showsPrec :: Int -> Provider -> ShowS # show :: Provider -> String # showList :: [Provider] -> ShowS #
ToByteString Provider Source #
Instance details Defined in Data.ZAuth.Token Methods builder :: Provider -> Builder Source #
Eq Provider Source #
Instance details Defined in Data.ZAuth.Token Methods (==) :: Provider -> Provider -> Bool # (/=) :: Provider -> Provider -> Bool #
FromByteString (Token Provider) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token Provider) Source #

provider :: Iso' Provider UUID Source #

mkProvider :: UUID -> Provider Source #

LegalHold body

data LegalHoldUser Source #

Instances

Instances details

Show LegalHoldUser Source #
Instance details Defined in Data.ZAuth.Token Methods showsPrec :: Int -> LegalHoldUser -> ShowS # show :: LegalHoldUser -> String # showList :: [LegalHoldUser] -> ShowS #
ToByteString LegalHoldUser Source #
Instance details Defined in Data.ZAuth.Token Methods builder :: LegalHoldUser -> Builder Source #
Eq LegalHoldUser Source #
Instance details Defined in Data.ZAuth.Token Methods (==) :: LegalHoldUser -> LegalHoldUser -> Bool # (/=) :: LegalHoldUser -> LegalHoldUser -> Bool #
FromByteString (Token LegalHoldUser) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token LegalHoldUser) Source #

legalHoldUser :: Iso' LegalHoldUser User Source #

mkLegalHoldUser :: UUID -> Maybe Text -> Word32 -> LegalHoldUser Source #

data LegalHoldAccess Source #

Instances

Instances details

Show LegalHoldAccess Source #
Instance details Defined in Data.ZAuth.Token Methods showsPrec :: Int -> LegalHoldAccess -> ShowS # show :: LegalHoldAccess -> String # showList :: [LegalHoldAccess] -> ShowS #
ToByteString LegalHoldAccess Source #
Instance details Defined in Data.ZAuth.Token Methods builder :: LegalHoldAccess -> Builder Source #
Eq LegalHoldAccess Source #
Instance details Defined in Data.ZAuth.Token Methods (==) :: LegalHoldAccess -> LegalHoldAccess -> Bool # (/=) :: LegalHoldAccess -> LegalHoldAccess -> Bool #
FromByteString (Token LegalHoldAccess) Source #
Instance details Defined in Data.ZAuth.Token Methods parser :: Parser (Token LegalHoldAccess) Source #

legalHoldAccess :: Iso' LegalHoldAccess Access Source #

mkLegalHoldAccess :: UUID -> Maybe Text -> Word64 -> LegalHoldAccess Source #

writeData :: ToByteString a => Header -> a -> Builder Source #

Show Header Source #
Instance details Defined in Data.ZAuth.Token Methods showsPrec :: Int -> Header -> ShowS # show :: Header -> String # showList :: [Header] -> ShowS #
Eq Header Source #
Instance details Defined in Data.ZAuth.Token Methods (==) :: Header -> Header -> Bool # (/=) :: Header -> Header -> Bool #