Crypto.JOSE.Types

Data types for the JOSE library.

Documentation

newtype Base64Integer

A base64url encoded octet sequence interpreted as an integer.

The value is encoded in the minimum number of octets (no leading zeros) with the exception of 0 which is encoded as AA. A leading zero when decoding is an error.

Constructors

Base64Integer Integer

Instances

Eq Base64Integer

Methods

(==) :: Base64Integer -> Base64Integer -> Bool

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

Show Base64Integer

Methods

showsPrec :: Int -> Base64Integer -> ShowS

show :: Base64Integer -> String

showList :: [Base64Integer] -> ShowS

Arbitrary Base64Integer

Methods

arbitrary :: Gen Base64Integer

shrink :: Base64Integer -> [Base64Integer]

ToJSON Base64Integer

Methods

toJSON :: Base64Integer -> Value

toEncoding :: Base64Integer -> Encoding

FromJSON Base64Integer

Methods

parseJSON :: Value -> Parser Base64Integer

_Base64Integer :: Iso' Base64Integer Integer

data SizedBase64Integer

A base64url encoded octet sequence interpreted as an integer and where the number of octets carries explicit bit-length information.

Constructors

SizedBase64Integer Int Integer

Instances

Eq SizedBase64Integer

Methods

(==) :: SizedBase64Integer -> SizedBase64Integer -> Bool

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

Show SizedBase64Integer

Methods

showsPrec :: Int -> SizedBase64Integer -> ShowS

show :: SizedBase64Integer -> String

showList :: [SizedBase64Integer] -> ShowS

Arbitrary SizedBase64Integer

Methods

arbitrary :: Gen SizedBase64Integer

shrink :: SizedBase64Integer -> [SizedBase64Integer]

ToJSON SizedBase64Integer

Methods

toJSON :: SizedBase64Integer -> Value

toEncoding :: SizedBase64Integer -> Encoding

FromJSON SizedBase64Integer

Methods

parseJSON :: Value -> Parser SizedBase64Integer

genSizedBase64IntegerOf :: Int -> Gen SizedBase64Integer

Generate a SizedBase64Integer of the given number of bytes

checkSize :: Int -> SizedBase64Integer -> Parser SizedBase64Integer

Parsed a SizedBase64Integer with an expected number of bytes.

newtype Base64Octets

A base64url encoded octet sequence. Used for payloads, signatures, symmetric keys, salts, initialisation vectors, etc.

Constructors

Base64Octets ByteString

Instances

Eq Base64Octets

Methods

(==) :: Base64Octets -> Base64Octets -> Bool

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

Show Base64Octets

Methods

showsPrec :: Int -> Base64Octets -> ShowS

show :: Base64Octets -> String

showList :: [Base64Octets] -> ShowS

Arbitrary Base64Octets

Methods

arbitrary :: Gen Base64Octets

shrink :: Base64Octets -> [Base64Octets]

ToJSON Base64Octets

Methods

toJSON :: Base64Octets -> Value

toEncoding :: Base64Octets -> Encoding

FromJSON Base64Octets

Methods

parseJSON :: Value -> Parser Base64Octets

newtype Base64SHA1

A base64url encoded SHA-1 digest. Used for X.509 certificate thumbprints.

Constructors

Base64SHA1 ByteString

Instances

Eq Base64SHA1

Methods

(==) :: Base64SHA1 -> Base64SHA1 -> Bool

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

Show Base64SHA1

Methods

showsPrec :: Int -> Base64SHA1 -> ShowS

show :: Base64SHA1 -> String

showList :: [Base64SHA1] -> ShowS

Arbitrary Base64SHA1

Methods

arbitrary :: Gen Base64SHA1

shrink :: Base64SHA1 -> [Base64SHA1]

ToJSON Base64SHA1

Methods

toJSON :: Base64SHA1 -> Value

toEncoding :: Base64SHA1 -> Encoding

FromJSON Base64SHA1

Methods

parseJSON :: Value -> Parser Base64SHA1

newtype Base64SHA256

A base64url encoded SHA-256 digest. Used for X.509 certificate thumbprints.

Constructors

Base64SHA256 ByteString

Instances

Eq Base64SHA256

Methods

(==) :: Base64SHA256 -> Base64SHA256 -> Bool

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

Show Base64SHA256

Methods

showsPrec :: Int -> Base64SHA256 -> ShowS

show :: Base64SHA256 -> String

showList :: [Base64SHA256] -> ShowS

Arbitrary Base64SHA256

Methods

arbitrary :: Gen Base64SHA256

shrink :: Base64SHA256 -> [Base64SHA256]

ToJSON Base64SHA256

Methods

toJSON :: Base64SHA256 -> Value

toEncoding :: Base64SHA256 -> Encoding

FromJSON Base64SHA256

Methods

parseJSON :: Value -> Parser Base64SHA256

newtype Base64X509

A base64 encoded X.509 certificate.

Constructors

Base64X509 SignedCertificate

Instances

Eq Base64X509

Methods

(==) :: Base64X509 -> Base64X509 -> Bool

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

Show Base64X509

Methods

showsPrec :: Int -> Base64X509 -> ShowS

show :: Base64X509 -> String

showList :: [Base64X509] -> ShowS

ToJSON Base64X509

Methods

toJSON :: Base64X509 -> Value

toEncoding :: Base64X509 -> Encoding

FromJSON Base64X509

Methods

parseJSON :: Value -> Parser Base64X509

data URI :: *

Represents a general universal resource identifier using its component parts.

For example, for the URI

  foo://[e-mail]:42/ghc?query#frag

the components are:

Instances

Eq URI

Methods

(==) :: URI -> URI -> Bool

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

Data URI

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> URI -> c URI

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c URI

toConstr :: URI -> Constr

dataTypeOf :: URI -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c URI)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c URI)

gmapT :: (forall b. Data b => b -> b) -> URI -> URI

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> URI -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> URI -> r

gmapQ :: (forall d. Data d => d -> u) -> URI -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> URI -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> URI -> m URI

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> URI -> m URI

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> URI -> m URI

Ord URI

Methods

compare :: URI -> URI -> Ordering

(<) :: URI -> URI -> Bool

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

(>) :: URI -> URI -> Bool

(>=) :: URI -> URI -> Bool

max :: URI -> URI -> URI

min :: URI -> URI -> URI

Show URI

Methods

showsPrec :: Int -> URI -> ShowS

show :: URI -> String

showList :: [URI] -> ShowS

Generic URI

Associated Types

type Rep URI :: * -> *

Methods

from :: URI -> Rep URI x

to :: Rep URI x -> URI

NFData URI

Methods

rnf :: URI -> ()

type Rep URI

type Rep URI = D1 * (MetaData "URI" "Network.URI" "network-uri-2.6.1.0-RmiO7Es4EVIxdXQfHHaUt" False) (C1 * (MetaCons "URI" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "uriScheme") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String)) (S1 * (MetaSel (Just Symbol "uriAuthority") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe URIAuth)))) ((:*:) * (S1 * (MetaSel (Just Symbol "uriPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String)) ((:*:) * (S1 * (MetaSel (Just Symbol "uriQuery") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String)) (S1 * (MetaSel (Just Symbol "uriFragment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String))))))

base64url :: (AsEmpty s1, AsEmpty s2, Cons s1 s1 Word8 Word8, Cons s2 s2 Word8 Word8) => Prism' s1 s2

Prism for encoding / decoding base64url.

To encode, review base64url. To decode, preview base64url.

Works with any combinations of strict/lazy ByteString.