Modulejose-0.13GHC2021

Crypto.JOSE.Types

Data types for the JOSE library.

8 types
4 values

Packagejose-0.13
Exports12
LanguageGHC2021
LicenceApache-2.0
SourceTypes.hs

newtypenewtype 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

Instances4Eq, Show, FromJSON, ToJSON

Eq Base64IntegerDefined in jose-0.13 · Crypto.JOSE.Types
Show Base64IntegerDefined in jose-0.13 · Crypto.JOSE.Types
FromJSON Base64IntegerDefined in jose-0.13 · Crypto.JOSE.Types
ToJSON Base64IntegerDefined in jose-0.13 · Crypto.JOSE.Types

value_Base64Integer :: Iso' Base64Integer Integer

datadata 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

Instances4Eq, Show, FromJSON, ToJSON

Eq SizedBase64IntegerDefined in jose-0.13 · Crypto.JOSE.Types
Show SizedBase64IntegerDefined in jose-0.13 · Crypto.JOSE.Types
FromJSON SizedBase64IntegerDefined in jose-0.13 · Crypto.JOSE.Types
ToJSON SizedBase64IntegerDefined in jose-0.13 · Crypto.JOSE.Types

valuemakeSizedBase64Integer :: Integer -> SizedBase64Integer

Create a SizedBase64Integer' from an Integer.

valuecheckSize :: Int -> SizedBase64Integer -> Parser SizedBase64Integer

Parsed a SizedBase64Integer with an expected number of bytes.

newtypenewtype Base64Octets

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

Constructors

Base64Octets ByteString

Instances4Eq, Show, FromJSON, ToJSON

Eq Base64OctetsDefined in jose-0.13 · Crypto.JOSE.Types
Show Base64OctetsDefined in jose-0.13 · Crypto.JOSE.Types
FromJSON Base64OctetsDefined in jose-0.13 · Crypto.JOSE.Types
ToJSON Base64OctetsDefined in jose-0.13 · Crypto.JOSE.Types

newtypenewtype Base64SHA1

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

Constructors

Base64SHA1 ByteString

Instances4Eq, Show, FromJSON, ToJSON

Eq Base64SHA1Defined in jose-0.13 · Crypto.JOSE.Types
Show Base64SHA1Defined in jose-0.13 · Crypto.JOSE.Types
FromJSON Base64SHA1Defined in jose-0.13 · Crypto.JOSE.Types
ToJSON Base64SHA1Defined in jose-0.13 · Crypto.JOSE.Types

newtypenewtype Base64SHA256

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

Constructors

Base64SHA256 ByteString

Instances4Eq, Show, FromJSON, ToJSON

Eq Base64SHA256Defined in jose-0.13 · Crypto.JOSE.Types
Show Base64SHA256Defined in jose-0.13 · Crypto.JOSE.Types
FromJSON Base64SHA256Defined in jose-0.13 · Crypto.JOSE.Types
ToJSON Base64SHA256Defined in jose-0.13 · Crypto.JOSE.Types

newtypenewtype Base64X509

A base64 encoded X.509 certificate.

Constructors

Base64X509 SignedCertificate

Instances4Eq, Show, FromJSON, ToJSON

Eq Base64X509Defined in jose-0.13 · Crypto.JOSE.Types
Show Base64X509Defined in jose-0.13 · Crypto.JOSE.Types
FromJSON Base64X509Defined in jose-0.13 · Crypto.JOSE.Types
ToJSON Base64X509Defined in jose-0.13 · Crypto.JOSE.Types

typetype SignedCertificate = SignedExact Certificate

A Signed Certificate

datadata URI

Represents a general universal resource identifier using its component parts.

For example, for the URI

  foo://anonymous@www.haskell.org:42/ghc?query#frag

the components are:

Instances12Eq, Data, Ord, Show, Generic, NFData, …

Eq URIDefined in network-uri-2.6.4.2 · Network.URI
Data URIDefined in network-uri-2.6.4.2 · Network.URI
Ord URIDefined in network-uri-2.6.4.2 · Network.URI
Show URIDefined in network-uri-2.6.4.2 · Network.URI
Generic URIDefined in network-uri-2.6.4.2 · Network.URI
NFData URIDefined in network-uri-2.6.4.2 · Network.URI
FromJSON URIDefined in aeson-2.3.2.0 · Data.Aeson.Types.FromJSON
FromJSONKey URIDefined in aeson-2.3.2.0 · Data.Aeson.Types.FromJSON
ToJSON URIDefined in aeson-2.3.2.0 · Data.Aeson.Types.ToJSON
ToJSONKey URIDefined in aeson-2.3.2.0 · Data.Aeson.Types.ToJSON
Lift URIDefined in network-uri-2.6.4.2 · Network.URI
type Rep URI = D1 ('MetaData "URI" "Network.URI" "network-uri-2.6.4.2-1QdlAcNSbcxeQT6IyDD14" 'False) (C1 ('MetaCons "URI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "uriScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "uriAuthority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URIAuth))) :*: (S1 ('MetaSel ('Just "uriPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: (S1 ('MetaSel ('Just "uriQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "uriFragment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))Defined in network-uri-2.6.4.2 · Network.URI

valuebase64url :: (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.