Safe Haskell	Safe-Inferred
Language	Haskell2010

Crypto.Paseto.Token.Claim

Contents

Claim value types
Claim key
- Unregistered claim key
Claim

Description

PASETO token claim.

Synopsis

newtype Issuer = Issuer {
- unIssuer :: Text
}
newtype Subject = Subject {
- unSubject :: Text
}
newtype Audience = Audience {
- unAudience :: Text
}
newtype Expiration = Expiration {
- unExpiration :: UTCTime
}
renderExpiration :: Expiration -> Text
newtype NotBefore = NotBefore {
- unNotBefore :: UTCTime
}
renderNotBefore :: NotBefore -> Text
newtype IssuedAt = IssuedAt {
- unIssuedAt :: UTCTime
}
renderIssuedAt :: IssuedAt -> Text
newtype TokenIdentifier = TokenIdentifier {
- unTokenIdentifier :: Text
}
data ClaimKey where
- pattern IssuerClaimKey :: ClaimKey
- pattern SubjectClaimKey :: ClaimKey
- pattern AudienceClaimKey :: ClaimKey
- pattern ExpirationClaimKey :: ClaimKey
- pattern NotBeforeClaimKey :: ClaimKey
- pattern IssuedAtClaimKey :: ClaimKey
- pattern TokenIdentifierClaimKey :: ClaimKey
- pattern CustomClaimKey :: UnregisteredClaimKey -> ClaimKey
renderClaimKey :: ClaimKey -> Text
parseClaimKey :: Text -> ClaimKey
registeredClaimKeys :: Set ClaimKey
data UnregisteredClaimKey
mkUnregisteredClaimKey :: Text -> Maybe UnregisteredClaimKey
renderUnregisteredClaimKey :: UnregisteredClaimKey -> Text
data Claim
- = IssuerClaim !Issuer
- | SubjectClaim !Subject
- | AudienceClaim !Audience
- | ExpirationClaim !Expiration
- | NotBeforeClaim !NotBefore
- | IssuedAtClaim !IssuedAt
- | TokenIdentifierClaim !TokenIdentifier
- | CustomClaim !UnregisteredClaimKey !Value
claimKey :: Claim -> ClaimKey
claimToPair :: Claim -> Pair
claimFromJson :: Key -> Value -> Parser Claim

Claim value types

newtype Issuer Source #

Issuer of a token.

Constructors

Issuer
Fields unIssuer :: Text

Instances

Instances details

FromJSON Issuer Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods parseJSON :: Value -> Parser Issuer # parseJSONList :: Value -> Parser [Issuer] # omittedField :: Maybe Issuer #
ToJSON Issuer Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods toJSON :: Issuer -> Value # toEncoding :: Issuer -> Encoding # toJSONList :: [Issuer] -> Value # toEncodingList :: [Issuer] -> Encoding # omitField :: Issuer -> Bool #
Show Issuer Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods showsPrec :: Int -> Issuer -> ShowS # show :: Issuer -> String # showList :: [Issuer] -> ShowS #
Eq Issuer Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods (==) :: Issuer -> Issuer -> Bool # (/=) :: Issuer -> Issuer -> Bool #

newtype Subject Source #

Subject of a token.

Constructors

Subject
Fields unSubject :: Text

Instances

Instances details

FromJSON Subject Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods parseJSON :: Value -> Parser Subject # parseJSONList :: Value -> Parser [Subject] # omittedField :: Maybe Subject #
ToJSON Subject Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods toJSON :: Subject -> Value # toEncoding :: Subject -> Encoding # toJSONList :: [Subject] -> Value # toEncodingList :: [Subject] -> Encoding # omitField :: Subject -> Bool #
Show Subject Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods showsPrec :: Int -> Subject -> ShowS # show :: Subject -> String # showList :: [Subject] -> ShowS #
Eq Subject Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods (==) :: Subject -> Subject -> Bool # (/=) :: Subject -> Subject -> Bool #

newtype Audience Source #

Recipient for which a token is intended.

Constructors

Audience
Fields unAudience :: Text

Instances

Instances details

FromJSON Audience Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods parseJSON :: Value -> Parser Audience # parseJSONList :: Value -> Parser [Audience] # omittedField :: Maybe Audience #
ToJSON Audience Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods toJSON :: Audience -> Value # toEncoding :: Audience -> Encoding # toJSONList :: [Audience] -> Value # toEncodingList :: [Audience] -> Encoding # omitField :: Audience -> Bool #
Show Audience Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods showsPrec :: Int -> Audience -> ShowS # show :: Audience -> String # showList :: [Audience] -> ShowS #
Eq Audience Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods (==) :: Audience -> Audience -> Bool # (/=) :: Audience -> Audience -> Bool #

newtype Expiration Source #

Time after which a token expires.

Constructors

Expiration
Fields unExpiration :: UTCTime

Instances

Instances details

FromJSON Expiration Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods parseJSON :: Value -> Parser Expiration # parseJSONList :: Value -> Parser [Expiration] # omittedField :: Maybe Expiration #
ToJSON Expiration Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods toJSON :: Expiration -> Value # toEncoding :: Expiration -> Encoding # toJSONList :: [Expiration] -> Value # toEncodingList :: [Expiration] -> Encoding # omitField :: Expiration -> Bool #
Show Expiration Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods showsPrec :: Int -> Expiration -> ShowS # show :: Expiration -> String # showList :: [Expiration] -> ShowS #
Eq Expiration Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods (==) :: Expiration -> Expiration -> Bool # (/=) :: Expiration -> Expiration -> Bool #

renderExpiration :: Expiration -> Text Source #

Render an Expiration as Text.

newtype NotBefore Source #

Time from which a token should be considered valid.

Constructors

NotBefore
Fields unNotBefore :: UTCTime

Instances

Instances details

FromJSON NotBefore Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods parseJSON :: Value -> Parser NotBefore # parseJSONList :: Value -> Parser [NotBefore] # omittedField :: Maybe NotBefore #
ToJSON NotBefore Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods toJSON :: NotBefore -> Value # toEncoding :: NotBefore -> Encoding # toJSONList :: [NotBefore] -> Value # toEncodingList :: [NotBefore] -> Encoding # omitField :: NotBefore -> Bool #
Show NotBefore Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods showsPrec :: Int -> NotBefore -> ShowS # show :: NotBefore -> String # showList :: [NotBefore] -> ShowS #
Eq NotBefore Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods (==) :: NotBefore -> NotBefore -> Bool # (/=) :: NotBefore -> NotBefore -> Bool #

renderNotBefore :: NotBefore -> Text Source #

Render a NotBefore as Text.

newtype IssuedAt Source #

Time at which a token was issued.

Constructors

IssuedAt
Fields unIssuedAt :: UTCTime

Instances

Instances details

FromJSON IssuedAt Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods parseJSON :: Value -> Parser IssuedAt # parseJSONList :: Value -> Parser [IssuedAt] # omittedField :: Maybe IssuedAt #
ToJSON IssuedAt Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods toJSON :: IssuedAt -> Value # toEncoding :: IssuedAt -> Encoding # toJSONList :: [IssuedAt] -> Value # toEncodingList :: [IssuedAt] -> Encoding # omitField :: IssuedAt -> Bool #
Show IssuedAt Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods showsPrec :: Int -> IssuedAt -> ShowS # show :: IssuedAt -> String # showList :: [IssuedAt] -> ShowS #
Eq IssuedAt Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods (==) :: IssuedAt -> IssuedAt -> Bool # (/=) :: IssuedAt -> IssuedAt -> Bool #

renderIssuedAt :: IssuedAt -> Text Source #

Render an IssuedAt as Text.

newtype TokenIdentifier Source #

Token identifier.

Constructors

TokenIdentifier
Fields unTokenIdentifier :: Text

Instances

Instances details

FromJSON TokenIdentifier Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods parseJSON :: Value -> Parser TokenIdentifier # parseJSONList :: Value -> Parser [TokenIdentifier] # omittedField :: Maybe TokenIdentifier #
ToJSON TokenIdentifier Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods toJSON :: TokenIdentifier -> Value # toEncoding :: TokenIdentifier -> Encoding # toJSONList :: [TokenIdentifier] -> Value # toEncodingList :: [TokenIdentifier] -> Encoding # omitField :: TokenIdentifier -> Bool #
Show TokenIdentifier Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods showsPrec :: Int -> TokenIdentifier -> ShowS # show :: TokenIdentifier -> String # showList :: [TokenIdentifier] -> ShowS #
Eq TokenIdentifier Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods (==) :: TokenIdentifier -> TokenIdentifier -> Bool # (/=) :: TokenIdentifier -> TokenIdentifier -> Bool #

Claim key

data ClaimKey where Source #

Token claim key.

Bundled Patterns

pattern IssuerClaimKey :: ClaimKey
pattern SubjectClaimKey :: ClaimKey
pattern AudienceClaimKey :: ClaimKey
pattern ExpirationClaimKey :: ClaimKey
pattern NotBeforeClaimKey :: ClaimKey
pattern IssuedAtClaimKey :: ClaimKey
pattern TokenIdentifierClaimKey :: ClaimKey
pattern CustomClaimKey :: UnregisteredClaimKey -> ClaimKey

Instances

Instances details

Show ClaimKey Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods showsPrec :: Int -> ClaimKey -> ShowS # show :: ClaimKey -> String # showList :: [ClaimKey] -> ShowS #
Eq ClaimKey Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods (==) :: ClaimKey -> ClaimKey -> Bool # (/=) :: ClaimKey -> ClaimKey -> Bool #
Ord ClaimKey Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods compare :: ClaimKey -> ClaimKey -> Ordering # (<) :: ClaimKey -> ClaimKey -> Bool # (<=) :: ClaimKey -> ClaimKey -> Bool # (>) :: ClaimKey -> ClaimKey -> Bool # (>=) :: ClaimKey -> ClaimKey -> Bool # max :: ClaimKey -> ClaimKey -> ClaimKey # min :: ClaimKey -> ClaimKey -> ClaimKey #

renderClaimKey :: ClaimKey -> Text Source #

Render a ClaimKey as Text.

parseClaimKey :: Text -> ClaimKey Source #

Parse a ClaimKey from Text.

registeredClaimKeys :: Set ClaimKey Source #

Registered claims as defined by the PASETO specification.

Unregistered claim key

data UnregisteredClaimKey Source #

Unregistered claim key.

Instances

Instances details

Show UnregisteredClaimKey Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods showsPrec :: Int -> UnregisteredClaimKey -> ShowS # show :: UnregisteredClaimKey -> String # showList :: [UnregisteredClaimKey] -> ShowS #
Eq UnregisteredClaimKey Source #
Instance details Defined in Crypto.Paseto.Token.Claim Methods (==) :: UnregisteredClaimKey -> UnregisteredClaimKey -> Bool # (/=) :: UnregisteredClaimKey -> UnregisteredClaimKey -> Bool #

mkUnregisteredClaimKey :: Text -> Maybe UnregisteredClaimKey Source #

Construct an unregistered claim key.

If the provided Text key matches that of a registered claim (registeredClaimKeys), this function will return Nothing.

renderUnregisteredClaimKey :: UnregisteredClaimKey -> Text Source #

Render an UnregisteredClaimKey as Text.

Claim

data Claim Source #

Token claim.

Constructors

IssuerClaim !Issuer
SubjectClaim !Subject
AudienceClaim !Audience
ExpirationClaim !Expiration
NotBeforeClaim !NotBefore
IssuedAtClaim !IssuedAt
TokenIdentifierClaim !TokenIdentifier
CustomClaim
Fields !UnregisteredClaimKey Claim key. !Value Claim value.

Instances

Instances details

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

claimKey :: Claim -> ClaimKey Source #

Get the JSON object key which corresponds to a Claim.

claimToPair :: Claim -> Pair Source #

claimFromJson :: Key -> Value -> Parser Claim Source #