org.jooby

Class Cookie.Signature

java.lang.Object

org.jooby.Cookie.Signature

Enclosing interface:

Cookie

public static class Cookie.Signature
extends Object

Sign cookies using a HMAC algorithm plus SHA-256 hash. Usage:

   String signed = Signature.sign("hello", "mysecretkey");
   ...
   // is it valid?
   assertEquals(signed, Signature.unsign(signed, "mysecretkey");
 

Since:

0.1.0

Author:

edgar

Field Summary

Fields

Modifier and Type	Field and Description
static String	HMAC_SHA256 Algorithm name.

Constructor Summary

Constructors

Constructor and Description
Signature()

Method Summary

Modifier and Type	Method and Description
static String	sign(String value, String secret) Sign a value using a secret key.
static String	unsign(String value, String secret) Un-sign a value, previously signed with sign(String, String).
static boolean	valid(String value, String secret) True, if the given signed value is valid.

Methods inherited from class java.lang.Object

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

Field Detail

HMAC_SHA256

public static final String HMAC_SHA256

Algorithm name.

See Also:

Constant Field Values

Constructor Detail

Signature

public Signature()

Method Detail

sign

@Nonnull
public static String sign(String value,
                                   String secret)

Sign a value using a secret key. A value and secret key are required. Sign is done with HMAC_SHA256. Signed value looks like:

   [signed value] '|' [raw value]
 

Parameters:

value - A value to sign.

secret - A secret key.

Returns:

A signed value.

unsign

@Nullable
public static String unsign(String value,
                                      String secret)

Un-sign a value, previously signed with sign(String, String). Try valid(String, String) to check for valid signed values.

Parameters:

value - A signed value.

secret - A secret key.

Returns:

A new signed value or null.

valid

public static boolean valid(String value,
                            String secret)

True, if the given signed value is valid.

Parameters:

value - A signed value.

secret - A secret key.

Returns:

True, if the given signed value is valid.