Crypto.WebAuthn.Cose.SignAlg

This module contains definitions for COSE registry entries that are relevant for Webauthn COSE public keys. All the types in this module implement the Serialise class, mapping them to the respective CBOR values/labels.

This modules sometimes uses this CBOR Grammar to describe CBOR value types corresponding to CBOR parameters

COSE Algorithms

data CoseSignAlg

(spec) All the entries from the COSE Algorithms registry limited to the ones that are currently needed for Webauthn. Notably we only care about asymmetric signature algorithms

Constructors

CoseSignAlgEdDSA

(spec) EdDSA

RFC8032 describes the elliptic curve signature scheme Edwards-curve Digital Signature Algorithm (EdDSA). In that document, the signature algorithm is instantiated using parameters for edwards25519 and edwards448 curves. The document additionally describes two variants of the EdDSA algorithm: Pure EdDSA, where no hash function is applied to the content before signing, and HashEdDSA, where a hash function is applied to the content before signing and the result of that hash function is signed. For EdDSA, the content to be signed (either the message or the pre-hash value) is processed twice inside of the signature algorithm. For use with COSE, only the pure EdDSA version is used.

Security considerations are here

CoseSignAlgECDSA CoseHashAlgECDSA

(spec) ECDSA

ECDSA [DSS] defines a signature algorithm using ECC. Implementations SHOULD use a deterministic version of ECDSA such as the one defined in [RFC6979].

The ECDSA signature algorithm is parameterized with a hash function (h). In the event that the length of the hash function output is greater than the group of the key, the leftmost bytes of the hash output are used. ECDSA w/ SHA-256

This document defines ECDSA to work only with the curves P-256, P-384, and P-521. Future documents may define it to work with other curves and points in the future.

In order to promote interoperability, it is suggested that SHA-256 be used only with curve P-256, SHA-384 be used only with curve P-384, and SHA-512 be used with curve P-521. This is aligned with the recommendation in Section 4 of RFC5480

Security considerations are here

CoseSignAlgRSA CoseHashAlgRSA

(spec) The RSASSA-PKCS1-v1_5 signature algorithm is defined in RFC8017. The RSASSA-PKCS1-v1_5 signature algorithm is parameterized with a hash function (h).

A key of size 2048 bits or larger MUST be used with these algorithms.

Security considerations are here

Bundled Patterns

pattern CoseAlgorithmEdDSA :: CoseSignAlg

(spec) Cose Algorithm registry entry EdDSA. Alias for CoseSignAlgEdDSA

• Name: EdDSA
• Description: EdDSA
• Recommended: Yes

pattern CoseAlgorithmES256 :: CoseSignAlg

(spec) Cose Algorithm registry entry ES256. Alias for CoseSignAlgECDSA CoseHashAlgECDSASHA256

• Name: ES256
• Description: ECDSA w/ SHA-256
• Recommended: Yes

pattern CoseAlgorithmES384 :: CoseSignAlg

(spec) Cose Algorithm registry entry ES384. Alias for CoseSignAlgECDSA CoseHashAlgECDSASHA384

• Name: ES384
• Description: ECDSA w/ SHA-384
• Recommended: Yes

pattern CoseAlgorithmES512 :: CoseSignAlg

(spec) Cose Algorithm registry entry ES512. Alias for CoseSignAlgECDSA CoseHashAlgECDSASHA512

• Name: ES512
• Description: ECDSA w/ SHA-512
• Recommended: Yes

pattern CoseAlgorithmRS256 :: CoseSignAlg

(spec) Cose Algorithm registry entry RS256. Alias for CoseSignAlgRSA CoseHashAlgRSASHA256

• Name: RS256
• Description: RSASSA-PKCS1-v1_5 using SHA-256
• Recommended: No

pattern CoseAlgorithmRS384 :: CoseSignAlg

(spec) Cose Algorithm registry entry RS384. Alias for CoseSignAlgRSA CoseHashAlgRSASHA384

• Name: RS384
• Description: RSASSA-PKCS1-v1_5 using SHA-384
• Recommended: No

pattern CoseAlgorithmRS512 :: CoseSignAlg

(spec) Cose Algorithm registry entry RS512. Alias for CoseSignAlgRSA CoseHashAlgRSASHA512

• Name: RS512
• Description: RSASSA-PKCS1-v1_5 using SHA-512
• Recommended: No

pattern CoseAlgorithmRS1 :: CoseSignAlg

(spec) Cose Algorithm registry entry RS1. Alias for CoseSignAlgRSA CoseHashAlgRSASHA1

• Name: RS1
• Description: RSASSA-PKCS1-v1_5 using SHA-1
• Recommended: Deprecated

Instances

ToJSON CoseSignAlg

An arbitrary and potentially unstable JSON encoding, only intended for logging purposes. To actually encode and decode structures, use the Crypto.WebAuthn.Encoding modules

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

toJSON :: CoseSignAlg -> Value

toEncoding :: CoseSignAlg -> Encoding

toJSONList :: [CoseSignAlg] -> Value

toEncodingList :: [CoseSignAlg] -> Encoding

Generic CoseSignAlg

Defined in Crypto.WebAuthn.Cose.SignAlg

Associated Types

type Rep CoseSignAlg :: Type -> Type

Methods

from :: CoseSignAlg -> Rep CoseSignAlg x

to :: Rep CoseSignAlg x -> CoseSignAlg

Show CoseSignAlg

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

showsPrec :: Int -> CoseSignAlg -> ShowS

show :: CoseSignAlg -> String

showList :: [CoseSignAlg] -> ShowS

Eq CoseSignAlg

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

(==) :: CoseSignAlg -> CoseSignAlg -> Bool

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

Ord CoseSignAlg

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

compare :: CoseSignAlg -> CoseSignAlg -> Ordering

(<) :: CoseSignAlg -> CoseSignAlg -> Bool

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

(>) :: CoseSignAlg -> CoseSignAlg -> Bool

(>=) :: CoseSignAlg -> CoseSignAlg -> Bool

max :: CoseSignAlg -> CoseSignAlg -> CoseSignAlg

min :: CoseSignAlg -> CoseSignAlg -> CoseSignAlg

Serialise CoseSignAlg

Serialises COSE Algorithms using the Value column from the COSE Algorithms registry. This uses the fromCoseSignAlg and toCoseSignAlg functions to do the encoding and decoding respectively.

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

encode :: CoseSignAlg -> Encoding

decode :: Decoder s CoseSignAlg

encodeList :: [CoseSignAlg] -> Encoding

decodeList :: Decoder s [CoseSignAlg]

Encode CoseSignAlg

Defined in Crypto.WebAuthn.Encoding.Internal.WebAuthnJson

Associated Types

type JSON CoseSignAlg

Methods

encode :: CoseSignAlg -> JSON CoseSignAlg

Decode m CoseSignAlg

Defined in Crypto.WebAuthn.Encoding.Internal.WebAuthnJson

Methods

decode :: JSON CoseSignAlg -> m CoseSignAlg

type Rep CoseSignAlg

Defined in Crypto.WebAuthn.Cose.SignAlg

type Rep CoseSignAlg = D1 ('MetaData "CoseSignAlg" "Crypto.WebAuthn.Cose.SignAlg" "webauthn-0.10.0.0-inplace" 'False) (C1 ('MetaCons "CoseSignAlgEdDSA" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CoseSignAlgECDSA" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CoseHashAlgECDSA)) :+: C1 ('MetaCons "CoseSignAlgRSA" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CoseHashAlgRSA))))

type JSON CoseSignAlg

Defined in Crypto.WebAuthn.Encoding.Internal.WebAuthnJson

type JSON CoseSignAlg = Int32

fromCoseSignAlg :: Num p => CoseSignAlg -> p

Converts a CoseSignAlg to the corresponding integer value from the COSE Algorithms registry. The inverse operation is toCoseSignAlg

toCoseSignAlg :: (Eq a, Num a, Show a) => a -> Either Text CoseSignAlg

Converts an integer value to the corresponding CoseSignAlg from the COSE Algorithms registry. Returns an error if the integer doesn't represent a known algorithm. The inverse operation is fromCoseSignAlg

Hash Algorithms

data CoseHashAlgECDSA

Hash algorithms that can be used with the ECDSA signature algorithm

Constructors

CoseHashAlgECDSASHA256

SHA-256

CoseHashAlgECDSASHA384

SHA-384

CoseHashAlgECDSASHA512

SHA-512

Instances

ToJSON CoseHashAlgECDSA

An arbitrary and potentially unstable JSON encoding, only intended for logging purposes. To actually encode and decode structures, use the Crypto.WebAuthn.Encoding modules

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

toJSON :: CoseHashAlgECDSA -> Value

toEncoding :: CoseHashAlgECDSA -> Encoding

toJSONList :: [CoseHashAlgECDSA] -> Value

toEncodingList :: [CoseHashAlgECDSA] -> Encoding

Bounded CoseHashAlgECDSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

minBound :: CoseHashAlgECDSA

maxBound :: CoseHashAlgECDSA

Enum CoseHashAlgECDSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

succ :: CoseHashAlgECDSA -> CoseHashAlgECDSA

pred :: CoseHashAlgECDSA -> CoseHashAlgECDSA

toEnum :: Int -> CoseHashAlgECDSA

fromEnum :: CoseHashAlgECDSA -> Int

enumFrom :: CoseHashAlgECDSA -> [CoseHashAlgECDSA]

enumFromThen :: CoseHashAlgECDSA -> CoseHashAlgECDSA -> [CoseHashAlgECDSA]

enumFromTo :: CoseHashAlgECDSA -> CoseHashAlgECDSA -> [CoseHashAlgECDSA]

enumFromThenTo :: CoseHashAlgECDSA -> CoseHashAlgECDSA -> CoseHashAlgECDSA -> [CoseHashAlgECDSA]

Generic CoseHashAlgECDSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Associated Types

type Rep CoseHashAlgECDSA :: Type -> Type

Methods

from :: CoseHashAlgECDSA -> Rep CoseHashAlgECDSA x

to :: Rep CoseHashAlgECDSA x -> CoseHashAlgECDSA

Show CoseHashAlgECDSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

showsPrec :: Int -> CoseHashAlgECDSA -> ShowS

show :: CoseHashAlgECDSA -> String

showList :: [CoseHashAlgECDSA] -> ShowS

Eq CoseHashAlgECDSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

(==) :: CoseHashAlgECDSA -> CoseHashAlgECDSA -> Bool

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

Ord CoseHashAlgECDSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

compare :: CoseHashAlgECDSA -> CoseHashAlgECDSA -> Ordering

(<) :: CoseHashAlgECDSA -> CoseHashAlgECDSA -> Bool

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

(>) :: CoseHashAlgECDSA -> CoseHashAlgECDSA -> Bool

(>=) :: CoseHashAlgECDSA -> CoseHashAlgECDSA -> Bool

max :: CoseHashAlgECDSA -> CoseHashAlgECDSA -> CoseHashAlgECDSA

min :: CoseHashAlgECDSA -> CoseHashAlgECDSA -> CoseHashAlgECDSA

type Rep CoseHashAlgECDSA

Defined in Crypto.WebAuthn.Cose.SignAlg

type Rep CoseHashAlgECDSA = D1 ('MetaData "CoseHashAlgECDSA" "Crypto.WebAuthn.Cose.SignAlg" "webauthn-0.10.0.0-inplace" 'False) (C1 ('MetaCons "CoseHashAlgECDSASHA256" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CoseHashAlgECDSASHA384" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CoseHashAlgECDSASHA512" 'PrefixI 'False) (U1 :: Type -> Type)))

data CoseHashAlgRSA

Hash algorithms that can be used with the RSA signature algorithm

Constructors

CoseHashAlgRSASHA1

SHA-1 (deprecated)

CoseHashAlgRSASHA256

SHA-256

CoseHashAlgRSASHA384

SHA-384

CoseHashAlgRSASHA512

SHA-512

Instances

ToJSON CoseHashAlgRSA

An arbitrary and potentially unstable JSON encoding, only intended for logging purposes. To actually encode and decode structures, use the Crypto.WebAuthn.Encoding modules

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

toJSON :: CoseHashAlgRSA -> Value

toEncoding :: CoseHashAlgRSA -> Encoding

toJSONList :: [CoseHashAlgRSA] -> Value

toEncodingList :: [CoseHashAlgRSA] -> Encoding

Bounded CoseHashAlgRSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

minBound :: CoseHashAlgRSA

maxBound :: CoseHashAlgRSA

Enum CoseHashAlgRSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

succ :: CoseHashAlgRSA -> CoseHashAlgRSA

pred :: CoseHashAlgRSA -> CoseHashAlgRSA

toEnum :: Int -> CoseHashAlgRSA

fromEnum :: CoseHashAlgRSA -> Int

enumFrom :: CoseHashAlgRSA -> [CoseHashAlgRSA]

enumFromThen :: CoseHashAlgRSA -> CoseHashAlgRSA -> [CoseHashAlgRSA]

enumFromTo :: CoseHashAlgRSA -> CoseHashAlgRSA -> [CoseHashAlgRSA]

enumFromThenTo :: CoseHashAlgRSA -> CoseHashAlgRSA -> CoseHashAlgRSA -> [CoseHashAlgRSA]

Generic CoseHashAlgRSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Associated Types

type Rep CoseHashAlgRSA :: Type -> Type

Methods

from :: CoseHashAlgRSA -> Rep CoseHashAlgRSA x

to :: Rep CoseHashAlgRSA x -> CoseHashAlgRSA

Show CoseHashAlgRSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

showsPrec :: Int -> CoseHashAlgRSA -> ShowS

show :: CoseHashAlgRSA -> String

showList :: [CoseHashAlgRSA] -> ShowS

Eq CoseHashAlgRSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

(==) :: CoseHashAlgRSA -> CoseHashAlgRSA -> Bool

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

Ord CoseHashAlgRSA

Defined in Crypto.WebAuthn.Cose.SignAlg

Methods

compare :: CoseHashAlgRSA -> CoseHashAlgRSA -> Ordering

(<) :: CoseHashAlgRSA -> CoseHashAlgRSA -> Bool

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

(>) :: CoseHashAlgRSA -> CoseHashAlgRSA -> Bool

(>=) :: CoseHashAlgRSA -> CoseHashAlgRSA -> Bool

max :: CoseHashAlgRSA -> CoseHashAlgRSA -> CoseHashAlgRSA

min :: CoseHashAlgRSA -> CoseHashAlgRSA -> CoseHashAlgRSA

type Rep CoseHashAlgRSA

Defined in Crypto.WebAuthn.Cose.SignAlg

type Rep CoseHashAlgRSA = D1 ('MetaData "CoseHashAlgRSA" "Crypto.WebAuthn.Cose.SignAlg" "webauthn-0.10.0.0-inplace" 'False) ((C1 ('MetaCons "CoseHashAlgRSASHA1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CoseHashAlgRSASHA256" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CoseHashAlgRSASHA384" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CoseHashAlgRSASHA512" 'PrefixI 'False) (U1 :: Type -> Type)))