Crypto.JOSE.Compact

JWS, JWE and some related specifications provide for "compact" representations of certain types. This module defines classes and functions for working with such data.

Documentation

class FromCompact a where

Data that can be parsed from a compact representation.

Minimal complete definition

fromCompact

Methods

fromCompact :: (AsError e, MonadError e m) => [ByteString] -> m a

Instances

FromCompact JWT

Methods

fromCompact :: (AsError e, MonadError e m) => [ByteString] -> m JWT

FromCompact JWTCrypto

Methods

fromCompact :: (AsError e, MonadError e m) => [ByteString] -> m JWTCrypto

HasParams a => FromCompact (JWS a)

Methods

fromCompact :: (AsError e, MonadError e m) => [ByteString] -> m (JWS a)

decodeCompact :: (FromCompact a, AsError e, MonadError e m) => ByteString -> m a

Decode a compact representation.

class ToCompact a where

Data that can be converted to a compact representation.

Minimal complete definition

toCompact

Methods

toCompact :: (AsError e, MonadError e m) => a -> m [ByteString]

Instances

ToCompact JWT

Methods

toCompact :: (AsError e, MonadError e m) => JWT -> m [ByteString]

ToCompact JWTCrypto

Methods

toCompact :: (AsError e, MonadError e m) => JWTCrypto -> m [ByteString]

HasParams a => ToCompact (JWS a)

Methods

toCompact :: (AsError e, MonadError e m) => JWS a -> m [ByteString]

encodeCompact :: (ToCompact a, AsError e, MonadError e m) => a -> m ByteString

Encode data to a compact representation.