Package de.kosmos_lab.web.server

Class JWT

java.lang.Object

de.kosmos_lab.web.server.JWT

public class JWT
extends Object

JWT is used to verify and sign JWT

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JWT.Algorithm
static class	JWT.JWTVerifyFailed	The Class JWTVerifyFailed.

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_LIFETIME
protected byte[]	key	The key used
long	lifetime	default lifetime of a JWT

Constructor Summary

Constructors

Constructor	Description
JWT(JWT.Algorithm algorithm, String key, long lifetime)	Instantiates a new jwt.
JWT(String key)
JWT(String key, long lifetime)	Instantiates a new jwt with HS256

Method Summary

Modifier and Type	Method	Description
String	encode(String data)	Encode the payload
static String	extractPayload(String data)	extract the payload from a given data string
String	sign(byte[] head, byte[] payload)	Sign the payload
String	sign(org.json.JSONObject object)	Sign a json payload
static String	trim(String data)	Trims the data, removes trailing =
org.json.JSONObject	verify(String data)	Verify.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LIFETIME

public static final long DEFAULT_LIFETIME

See Also:

Constant Field Values

lifetime

public final long lifetime

default lifetime of a JWT

key

protected byte[] key

The key used

Constructor Detail

JWT

public JWT(String key,
           long lifetime)

Instantiates a new jwt with HS256

Parameters:

key - the key to use

JWT

public JWT(String key)

JWT

public JWT(JWT.Algorithm algorithm,
           String key,
           long lifetime)

Instantiates a new jwt.

Parameters:

algorithm - the algorithm to use

key - the key to use

Method Detail

trim

public static String trim(String data)

Trims the data, removes trailing =

Parameters:

data - data to trim

Returns:

trimmed version of data

encode

public String encode(String data)
              throws InvalidKeyException,
                     NoSuchAlgorithmException,
                     IllegalStateException

Encode the payload

Parameters:

data - the data

Returns:

the string

Throws:

InvalidKeyException - the invalid key exception

NoSuchAlgorithmException - the no such algorithm exception

IllegalStateException - the illegal state exception

sign

public String sign(byte[] head,
                   byte[] payload)
            throws UnsupportedEncodingException,
                   InvalidKeyException,
                   NoSuchAlgorithmException,
                   IllegalStateException

Sign the payload

Parameters:

head - the header

payload - the payload

Returns:

the signed JWT string

Throws:

UnsupportedEncodingException - the unsupported encoding exception

InvalidKeyException - the invalid key exception

NoSuchAlgorithmException - the no such algorithm exception

IllegalStateException - the illegal state exception

sign

public String sign(org.json.JSONObject object)
            throws UnsupportedEncodingException,
                   InvalidKeyException,
                   NoSuchAlgorithmException,
                   IllegalStateException

Sign a json payload

Parameters:

object - the JSON object

Returns:

signed JWT string

Throws:

UnsupportedEncodingException - the unsupported encoding exception

InvalidKeyException - the invalid key exception

NoSuchAlgorithmException - the no such algorithm exception

IllegalStateException - the illegal state exception

verify

public org.json.JSONObject verify(String data)
                           throws InvalidKeyException,
                                  NoSuchAlgorithmException,
                                  IllegalStateException,
                                  UnsupportedEncodingException,
                                  JWT.JWTVerifyFailed

Verify.

Parameters:

data - the data to be verified

Returns:

an JSONObject with the payload

Throws:

InvalidKeyException - if key is invalid

NoSuchAlgorithmException - if algorithm is not supported

IllegalStateException - if state was illegal

UnsupportedEncodingException - if the encoding is not supported

JWT.JWTVerifyFailed - the JWT verify failed

extractPayload

public static String extractPayload(String data)
                             throws JWT.JWTVerifyFailed

extract the payload from a given data string

Parameters:

data -

Returns:

Throws:

JWT.JWTVerifyFailed - will be thrown if it does not appear like a valid JWT