Crypto.Paseto.Token

Documentation

newtype Footer

Footer consisting of unencrypted free-form data.

The footer's contents may be JSON or some other structured data, but it doesn't have to be.

When a PASETO token is constructed, the footer is authenticated, but not encrypted (i.e. its integrity is protected, but it is not made confidential). In authenticated encryption schemes, this is referred to as "associated data".

Note that this type's Eq instance performs a constant-time equality check.

Constructors

Footer

Fields

• unFooter :: ByteString

Instances

Show Footer

Defined in Crypto.Paseto.Token

Methods

showsPrec :: Int -> Footer -> ShowS

show :: Footer -> String

showList :: [Footer] -> ShowS

Eq Footer

Defined in Crypto.Paseto.Token

Methods

(==) :: Footer -> Footer -> Bool

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

newtype ImplicitAssertion

Unencrypted authenticated data which is not stored in the PASETO token.

When a PASETO token is constructed, the implicit assertion is authenticated, but it is not stored in the token. This is useful if one wants to associate some data that should remain confidential.

Note that this type's Eq instance performs a constant-time equality check.

Constructors

ImplicitAssertion

Fields

• unImplicitAssertion :: ByteString

Instances

Show ImplicitAssertion

Defined in Crypto.Paseto.Token

Methods

showsPrec :: Int -> ImplicitAssertion -> ShowS

show :: ImplicitAssertion -> String

showList :: [ImplicitAssertion] -> ShowS

Eq ImplicitAssertion

Defined in Crypto.Paseto.Token

Methods

(==) :: ImplicitAssertion -> ImplicitAssertion -> Bool

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

newtype Payload

Raw PASETO token payload.

Note that this type's Eq instance performs a constant-time equality check.

Constructors

Payload

Fields

• unPayload :: ByteString

Instances

Show Payload

Defined in Crypto.Paseto.Token

Methods

showsPrec :: Int -> Payload -> ShowS

show :: Payload -> String

showList :: [Payload] -> ShowS

Eq Payload

Defined in Crypto.Paseto.Token

Methods

(==) :: Payload -> Payload -> Bool

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

data Token v p where

PASETO token parameterized by its protocol Version and Purpose.

Constructors

TokenV3Local

PASETO version 3 local token.

Fields

• :: !Payload

  Encrypted token payload.

• -> !(Maybe Footer)

  Optional footer (associated data).

• -> Token V3 Local

TokenV3Public

PASETO version 3 public token.

Fields

• :: !Payload

  Signed token payload.

• -> !(Maybe Footer)

  Optional footer (associated data).

• -> Token V3 Public

TokenV4Local

PASETO version 4 local token.

Fields

• :: !Payload

  Encrypted token payload.

• -> !(Maybe Footer)

  Optional footer (associated data).

• -> Token V4 Local

TokenV4Public

PASETO version 4 public token.

Fields

• :: !Payload

  Signed token payload.

• -> !(Maybe Footer)

  Optional footer (associated data).

• -> Token V4 Public

Instances

Show (Token v p)

Defined in Crypto.Paseto.Token

Methods

showsPrec :: Int -> Token v p -> ShowS

show :: Token v p -> String

showList :: [Token v p] -> ShowS

Eq (Token v p)

Defined in Crypto.Paseto.Token

Methods

(==) :: Token v p -> Token v p -> Bool

(/=) :: Token v p -> Token v p -> Bool

data SomeToken

Some kind of PASETO token.

Constructors

SomeTokenV3Local !(Token V3 Local)

SomeTokenV3Public !(Token V3 Public)

SomeTokenV4Local !(Token V4 Local)

SomeTokenV4Public !(Token V4 Public)

Instances

Show SomeToken

Defined in Crypto.Paseto.Token

Methods

showsPrec :: Int -> SomeToken -> ShowS

show :: SomeToken -> String

showList :: [SomeToken] -> ShowS

Eq SomeToken

Defined in Crypto.Paseto.Token

Methods

(==) :: SomeToken -> SomeToken -> Bool

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

toSomeToken :: Token v p -> SomeToken

Convert a Token to a SomeToken.