org.picketlink.json.jose

Class AbstractJWSBuilder<T extends JWS,B extends AbstractJWSBuilder<T,B>>

java.lang.Object

org.picketlink.json.jwt.JWTBuilder<T,B>

org.picketlink.json.jose.AbstractJWSBuilder<T,B>

Type Parameters:

T - the generic type

B - the generic type

Direct Known Subclasses:

JWSBuilder

public abstract class AbstractJWSBuilder<T extends JWS,B extends AbstractJWSBuilder<T,B>>
extends JWTBuilder<T,B>

The Class AbstractJWSBuilder for building JSON Web Signature.

Author:

Pedro Igor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJWSBuilder(Class<T> tokenType) Instantiates a new abstract JWS builder.

Method Summary

Modifier and Type	Method and Description
protected T	build(javax.json.JsonObject headersObject, javax.json.JsonObject claimsObject) Builds the JsonObject of headers and claims set.
T	build(String json) Builds a JWS instance from the given json string representing an encoded JWS.
T	build(String json, byte[] key) Builds a JWS and validates its signatures based on the given encoded public key.
B	hmac256(byte[] key) Sets HMAC using SHA-256 as signature algorithm.
B	hmac384(byte[] key) Sets HMAC using SHA-384 as signature algorithm.
B	hmac512(byte[] key) Sets HMAC using SHA-512 as signature algorithm.
B	keys(JWK... keys) Adds key(s) into the JWKSet.
B	keys(JWKSet keySet) Sets JWKSet key(s) as a JSON Web Key Set for JWS Header.
B	kid(String kid) The kid (key ID) member can be used to match a specific key.
B	rsa256(byte[] key) Sets RSASSA-PKCS-v1_5 using SHA-256 as signature algorithm.
B	rsa384(byte[] key) Sets RSASSA-PKCS-v1_5 using SHA-384 as signature algorithm.
B	rsa512(byte[] key) Sets RSASSA-PKCS-v1_5 using SHA-512 as signature algorithm.

Methods inherited from class org.picketlink.json.jwt.JWTBuilder

audience, build, claim, claim, contentType, expiration, getClaimsBuilder, getHeadersBuilder, getTokenType, header, header, header, header, id, issuedAt, issuer, notBefore, subject, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractJWSBuilder

protected AbstractJWSBuilder(Class<T> tokenType)

Instantiates a new abstract JWS builder.

Parameters:

tokenType - the token type

Method Detail

kid

public B kid(String kid)

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.

Parameters:

kid - the kid

Returns:

the b

hmac256

public B hmac256(byte[] key)

Sets HMAC using SHA-256 as signature algorithm.

Parameters:

key - the key

Returns:

the b

hmac384

public B hmac384(byte[] key)

Sets HMAC using SHA-384 as signature algorithm.

Parameters:

key - the key

Returns:

the b

hmac512

public B hmac512(byte[] key)

Sets HMAC using SHA-512 as signature algorithm.

Parameters:

key - the key

Returns:

the b

rsa256

public B rsa256(byte[] key)

Sets RSASSA-PKCS-v1_5 using SHA-256 as signature algorithm.

Parameters:

key - the key

Returns:

the b

rsa384

public B rsa384(byte[] key)

Sets RSASSA-PKCS-v1_5 using SHA-384 as signature algorithm.

Parameters:

key - the key

Returns:

the b

rsa512

public B rsa512(byte[] key)

Sets RSASSA-PKCS-v1_5 using SHA-512 as signature algorithm.

Parameters:

key - the key

Returns:

the b

keys

public B keys(JWKSet keySet)

Sets JWKSet key(s) as a JSON Web Key Set for JWS Header.

Parameters:

keySet - the key set

Returns:

the b

keys

public B keys(JWK... keys)

Adds key(s) into the JWKSet.

Parameters:

keys - the keys

Returns:

the b

build

protected T build(javax.json.JsonObject headersObject,
                  javax.json.JsonObject claimsObject)

Description copied from class: JWTBuilder

Builds the JsonObject of headers and claims set.

Overrides:

build in class JWTBuilder<T extends JWS,B extends AbstractJWSBuilder<T,B>>

Parameters:

headersObject - the headers object

claimsObject - the claims object

Returns:

See Also:

JWTBuilder.build(javax.json.JsonObject, javax.json.JsonObject)

build

public T build(String json)
        throws JsonException

Builds a JWS instance from the given json string representing an encoded JWS.

This method first tries to check if the given JWS provides any JWK representing the public key that should be used to validate the signature.

If no JWK is found, this method does not validate the signature but returns a JWS instance.

Overrides:

build in class JWTBuilder<T extends JWS,B extends AbstractJWSBuilder<T,B>>

Parameters:

json - The encoded JSON string representing a JWS.

Returns:

A JWS representing the given encoded JSON string.

Throws:

JsonException - the json exception

build

public T build(String json,
               byte[] key)
        throws JsonException

Builds a JWS and validates its signatures based on the given encoded public key.

Parameters:

json - The encoded JSON string representing a JWS.

key - The encoded representation of a public key.

Returns:

A JWS representing the given encoded JSON string.

Throws:

JsonException - the json exception