org.picketlink.json

Interface JsonConstants.COMMON

Enclosing interface:

JsonConstants

public static interface JsonConstants.COMMON

The Interface COMMON represents common JSON Constants used with JSON Web Signature(JWS) and JSON Web Encryption(JWE).

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALG The alg (algorithm) Header Parameter identifies the cryptographic algorithm used to secure the JWS or JWE.
static String	ENC The enc (encryption algorithm) Header Parameter identifies the content encryption algorithm used to encrypt the Plaintext to produce the Ciphertext.
static String	HEADER_CONTENT_TYPE The cty (content type) Header Parameter is used by JWS or JWE applications to declare the MIME Media Type [IANA.MediaTypes] of the secured content (the payload) or encrypted plaintext.
static String	HEADER_JSON_WEB_KEY The jwk (JSON Web Key) Header Parameter is the public key that corresponds to the key used to digitally sign the JWS.
static String	HEADER_JWK_SET_URL The jku (JWK Set URL) Header Parameter is a URI [RFC3986] that refers to a resource for a set of JSON-encoded public keys, one of which corresponds to the key used to digitally sign the JWS or encrypt plaintext using JWE.
static String	HEADER_TYPE The typ (type) Header Parameter is used by JWS or JWE to declare the MIME Media Type [IANA.MediaTypes] of this complete JWS or JWE object.
static String	KEY_ID The kid (key ID) member can be used to match a specific key.
static String	PERIOD The period for serialization of JWS or JWE.

Field Detail

ALG

static final String ALG

The alg (algorithm) Header Parameter identifies the cryptographic algorithm used to secure the JWS or JWE. The signature, MAC, or plaintext value is not valid if the alg value does not represent a supported algorithm, or if there is not a key for use with that algorithm associated with the party that digitally signed or MACed the content. alg values should either be registered in the IANA JSON Web Signature and Encryption Algorithms registry defined in [JWA] or be a value that contains a Collision-Resistant Name. The alg value is a case-sensitive string containing a StringOrURI value.

See Also:

Constant Field Values

ENC

static final String ENC

The enc (encryption algorithm) Header Parameter identifies the content encryption algorithm used to encrypt the Plaintext to produce the Ciphertext. This algorithm MUST be an AEAD algorithm with a specified key length. The recipient MUST reject the JWE if the enc value does not represent a supported algorithm. enc values should either be registered in the IANA JSON Web Signature and Encryption Algorithms registry defined in [JWA] or be a value that contains a Collision-Resistant Name. The enc value is a case-sensitive string containing a StringOrURI value.

See Also:

Constant Field Values

KEY_ID

static final String KEY_ID

The kid (key ID) member can be used to match a specific key. This can be used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the kid value is unspecified. When kid values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct kid values. (One example in which different keys might use the same kid value is if they have different kty (key type) values but are considered to be equivalent alternatives by the application using them.) The kid value is a case-sensitive string. Use of this member is OPTIONAL.

When used with JWS or JWE, the kid value is used to match a JWS or JWE kid Header Parameter value.

See Also:

Constant Field Values

HEADER_TYPE

static final String HEADER_TYPE

The typ (type) Header Parameter is used by JWS or JWE to declare the MIME Media Type [IANA.MediaTypes] of this complete JWS or JWE object. This is intended for use by the application when more than one kind of object could be present in an application data structure that can contain a JWS or JWE object; the application can use this value to disambiguate among the different kinds of objects that might be present. Use of this Header Parameter is OPTIONAL.

See Also:

Constant Field Values

HEADER_CONTENT_TYPE

static final String HEADER_CONTENT_TYPE

The cty (content type) Header Parameter is used by JWS or JWE applications to declare the MIME Media Type [IANA.MediaTypes] of the secured content (the payload) or encrypted plaintext. This is intended for use by the application when more than one kind of object could be present in the JWS payload or JWE encrypted plaintext; the application can use this value to disambiguate among the different kinds of objects that might be present. Use of this Header Parameter is OPTIONAL.

See Also:

Constant Field Values

HEADER_JWK_SET_URL

static final String HEADER_JWK_SET_URL

The jku (JWK Set URL) Header Parameter is a URI [RFC3986] that refers to a resource for a set of JSON-encoded public keys, one of which corresponds to the key used to digitally sign the JWS or encrypt plaintext using JWE. The keys MUST be encoded as a JSON Web Key Set (JWK Set) [JWK]. The protocol used to acquire the resource MUST provide integrity protection; an HTTP GET request to retrieve the JWK Set MUST use TLS [RFC2818, RFC5246]; the identity of the server MUST be validated, as per Section 6 of RFC 6125 [RFC6125]. Use of this Header Parameter is OPTIONAL.

See Also:

Constant Field Values

HEADER_JSON_WEB_KEY

static final String HEADER_JSON_WEB_KEY

The jwk (JSON Web Key) Header Parameter is the public key that corresponds to the key used to digitally sign the JWS. This key is represented as a JSON Web Key [JWK]. Use of this Header Parameter is OPTIONAL.

See Also:

Constant Field Values

PERIOD

static final String PERIOD

The period for serialization of JWS or JWE.

See Also:

Constant Field Values