All Classes and Interfaces
Class
Description
The
AuthorizedDataElements structure.An entry in the
AuthorizedDataElements structure.The
AuthorizedNameSpaces structure.CBOR big integer.
CBOR boolean (major type = 7, additional information = 20 or 21).
CBOR break (major type = 7, additional information = 31).
CBOR byte array (major type = 2).
Constant values used in this CBOR implementation.
A decoder that receives CBOR tokens (
CBORToken) from the CBOR
tokenizer (CBORTokenizer) and constructs CBOR data items
(CBORItem).The base exception for errors that the decoding process may encounter.
Options to control the behavior of the CBOR decoder (
CBORDecoder).The default options for the CBOR decoder (
CBORDecoder).Exception related to the CBOR Diagnostic Notation.
Parser for the CBOR Diagnostic Notation.
CBOR double-precision floating-point number
(major type = 7, additional information = 27).
CBOR single-precision floating-point number
(major type = 7, additional information = 26).
The exception raised when the end of the input stream was reached unexpectedly.
CBOR integer (major type = 0 or 1).
The exception raised when the additional information in the first byte
of a CBOR data item is invalid for the major type.
The exception raised when the value of a simple value is invalid.
CBOR data item.
A class that represents a CBOR array (major type = 4).
A converter that converts Java primitives and instances of common Java
classes into instances of
CBORItem subclasses.CBOR long integer (major type = 0 or 1).
The exception raised when the byte sequence of a text string (major type = 3)
is not a valid UTF-8 byte sequence.
CBOR null (major type = 7, additional information = 22).
The base class for CBOR numbers.
An output stream to write CBOR representations of Java primitives and
instances of common Java classes.
A class that represents a key-value pair of CBOR map.
A class that represents a CBOR map (major type = 5).
Utility to create a list of
CBORPairs.A parser that receives CBOR data items (
CBORItem) from the CBOR
decoder (CBORDecoder) converts them into instances of common
Java classes.CBOR Simple Value (major type = 7, additional information = 0 ~ 19 or 24).
CBOR text string (major type = 3).
A class that represents a CBOR data item wrapped by a tag.
The interface for tag processors.
CBOR token that the CBOR tokenizer (
CBORTokenizer) constructs.A tokenizer that tokenizes the content of an input stream of CBOR data items
so that the CBOR decoder (
CBORDecoder)
can construct CBOR data items (CBORItem).The exception raised when the length or the size of a CBOR data item
is too long.
CBOR undefined (major type = 7, additional information = 23).
CBOR data item whose value is a URI.
A class that represents a CBOR data item that has a value.
COSE Algorithms
Name
Value
Description
RS512
-259
RSASSA-PKCS1-v1_5 using SHA-512
RS384
-258
RSASSA-PKCS1-v1_5 using SHA-384
RS256
-257
RSASSA-PKCS1-v1_5 using SHA-256
ES256K
-47
ECDSA using secp256k1 curve and SHA-256
PS512
-39
RSASSA-PSS w/ SHA-512
PS384
-38
RSASSA-PSS w/ SHA-384
PS256
-37
RSASSA-PSS w/ SHA-256
ES512
-36
ECDSA w/ SHA-512
ES384
-35
ECDSA w/ SHA-384
EdDSA
-8
EdDSA
ES256
-7
ECDSA w/ SHA-256
ECDSA Key
COSE Elliptic Curves
Name
Value
Key Type
Description
P-256
1
EC2
NIST P-256 also known as secp256r1
P-384
2
EC2
NIST P-384 also known as secp384r1
P-521
3
EC2
NIST P-521 also known as secp521r1
X25519
4
OKP
X25519 for use w/ ECDH only
X448
5
OKP
X448 for use w/ ECDH only
Ed25519
6
OKP
Ed25519 for use w/ EdDSA only
Ed448
7
OKP
Ed448 for use w/ EdDSA only
secp256k1
8
EC2
Ed448 for use w/ EdDSA only
COSE_Encrypt
COSE_Encrypt0
General-purpose COSE-related exception
The base class for
COSEProtectedHeaderBuilder and
COSEUnprotectedHeaderBuilder.COSE Header Parameters
Name
Label
Value Type
Description
Reference
alg
1
int / tstr
Cryptographic algorithm to use
RFC 9052
crit
2
[+ label]
Critical headers to be understood
RFC 9052
content type
3
tstr / uint
Content type of the payload
RFC 9052
kid
4
bstr
Key identifier
RFC 9052
IV
5
bstr
Full Initialization Vector
RFC 9052
Partial IV
6
bstr
Partial Initialization Vector
RFC 9052
x5chain
33
COSE_X509
An ordered chain of X.509 certificates
RFC 9360
COSE Key.
A utility to build an instance of
COSEKey or its subclass
(e.g.COSE Key Common Parameters
Name
Label
CBOR Type
Description
kty
1
tstr / int
Identification of the key type
kid
2
bstr
Key identification value - match to kid in message
alg
3
tstr / int
Key usage restriction to this algorithm
key_ops
4
[+ (tstr/int)]
Restrict set of permissible operations
Base IV
5
bstr
Base IV to be XORed with Partial IVs
COSE Key Operations
Name
Value
Description
sign
1
The key is used to create signatures.COSE Key Type Parameters
Key Type
Name
Label
CBOR Type
Description
OKP
crv
-1
int / tstr
EC identifier -- Taken from the "COSE Elliptic Curves" registry
x
-2
bstr
Public key
d
-4
bstr
Private key
EC2
crv
-1
int / tstr
EC identifier -- Taken from the "COSE Elliptic Curves" registry
x
-2
bstr
x-coordinate
y
-3
bstr / bool
y-coordinate
d
-4
bstr
Private key
RSA
n
-1
bstr
The RSA modulus n
e
-2
bstr
The RSA public exponent e
d
-3
bstr
The RSA private exponent d
p
-4
bstr
The prime factor p of n
q
-5
bstr
The prime factor q of n
dP
-6
bstr
dP is d mod (p - 1)
dQ
-7
bstr
dQ is d mod (q - 1)
qInv
-8
bstr
qInv is the CRT coefficient q^(-1) mod p
other
-9
array
Other prime infos, an array
r_i
-10
bstr
A prime factor r_i of n, where i >= 3
d_i
-11
bstr
d_i = d mod (r_i - 1)
t_i
-12
bstr
The CRT coefficient t_i = (r_1 * r_2 * ... * r_(i-1))^(-1) mod r_i
Symmetric
k
-1
bstr
Key value
HSS-LMS
pub
-1
bstr
Public key for HSS/LMS hash-based digital signature
WalnutDSA
N
-1
unit
Group and Matrix (NxN) size
q
-2
unit
Finite field F_q
t-values
-3
array (of unit)
List of T-values, entries in F_q
matrix 1
-4
array (of array of unit)
NxN Matrix of entries in F_q in column-major form
permutation 1
-5
array (of unit)
Permutation associated with matrix 1
matrix 2
-6
array (of array of unit)
NxN Matrix of entries in F_q in column-major form
COSE Key Types
Name
Value
Description
COSEKeyTypes.OKP
1
Octet Key Pair
COSEKeyTypes.EC2
2
Elliptic Curve Keys w/ x- and y-coordinate pair
COSEKeyTypes.RSA
3
RSA Key
Symmetric
4
Symmetric Keys
HSS-LMS
5
Public key for HSS/LMS hash-based digital signature
WalnutDSA
6
WalnutDSA public key
COSE_Mac
COSE_Mac0
COSE Message
A tag processor for COSE messages.
COSE Message Type
COSE Object
OKP Key
COSE Protected Header
A utility to build an instance of
COSEProtectedHeader.COSE_recipient
COSE_Sign
COSE_Sign1
A utility to build an instance of
COSESign1.COSE_Signature
A utility to build an instance of
COSESign.A signer for COSE.
COSE Unprotected Header
A utility to build an instance of
COSEUnprotectedHeader.A verifier for COSE.
A tag processor for the tag number 2 and the tag number 3, which represent
an unsigned bignum and a negative bignum, respectively.
A tag processor that returns a
CBORTaggedItem instance that
has the tag number and the tag content passed as arguments of the
process method.A tag processor that just removes the tag.
A tag processor for the tag number 32, which indicates that the following
text string is a URI.
A CBOR tagged item that represents CWT.
CWT Claims
Claim Name
Claim Key
Claim Value Type
Claim Description
iss
1
text string
Issuer
sub
2
text string
Subject
aud
3
text string
Audience
exp
4
integer or floating-point number
Expiration Time
nbf
5
integer or floating-point number
Not Before
iat
6
integer or floating-point number
Issued At
cti
7
byte string
CWT ID
cnf
8
map
Confirmation
scope
9
byte string or text string
The scope of an access token, as defined in [RFC6749].
Nonce
10
bstr or array
Nonce
status_list
65533
map
A CBOR structure containing up-to-date status information on multiple tokens using the Token Status List mechanism.
ttl
65534
unsigned integer
Time to Live
status
65535
map
A CBOR structure containing a reference to a status mechanism from the CWT Status Mechanisms Registry.
CWT Claims Set
A utility to build an instance of the
CWTClaimsSet class.A utility to generate a CWT key proof, which is defined in the specification
of "OpenID for Verifiable Credential Issuance".
A tag processor for CWT.
A list of data element identifiers.
The
DeviceAuth structure.The
DeviceKeyInfo structure.The
DeviceNameSpaces structure.The
DeviceNameSpacesBytes structure.An entry in the
DeviceNameSpaces structure.The
DeviceResponse structure.The
DeviceSigned structure.The
DeviceSignedItems structure.An entry in the
DeviceSignedItems structure.Pairs of a digest ID and a digest value.
An entry of
DigestIDs; A pair of a digest ID and a digest value.The
Document structure.The
DocumentError structure.An entry in the
DocumentError structure.The
ErrorItems structure.An entry in the
ErrorItems structure.The
Errors structure.An entry in the
Errors structure.The
IssuerNameSpaces structure.An entry in the
IssuerNameSpaces structure.The
IssuerSigned structure.Utility to build an
IssuerSigned instance.The
IssuerSignedItem structure.The
IssuerSignedItemBytes structure.The
KeyAuthorizations structure.Key getter.
The
KeyInfo structure.An entry in the
KeyInfo structure.Claim names of mDL.
Constants for mDL.
The
MobileSecurityObject structure.The
MobileSecurityObjectBytes structure, which is the payload
of the IssuerAuth structure.Sig Signature
A utility to build a
SigStructure instance.Signer to sign a Sig Structure.
The
Status structure.The
StatusList structure.A utility class to construct a
StatusList instance.The
StatusListInfo structure.Status Type values for Referenced Tokens.
A utility class to construct the compressed byte array of a token status list.
The
ValidityInfo structure containing information related to the
validity of the Mobile Security Object and its signature.The
ValueDigests structure.An entry in the
ValueDigests structure.