org.shredzone.acme4j.challenge

Class GenericChallenge

java.lang.Object

org.shredzone.acme4j.challenge.GenericChallenge

All Implemented Interfaces:

Serializable, Challenge

Direct Known Subclasses:

GenericTokenChallenge

public class GenericChallenge
extends Object
implements Challenge

A generic implementation of Challenge. It can be used as a base class for actual challenge implemenation, but it is also used if the ACME server offers a proprietary challenge that is unknown to acme4j.

Subclasses must override acceptable(String) so it only accepts the own type. respond(ClaimBuilder) should be overridden to put all required data to the response.

Author:

Richard "Shred" Körber

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	KEY_STATUS
protected static String	KEY_TYPE
protected static String	KEY_URI
protected static String	KEY_VALIDATED

Constructor Summary

Constructors

Constructor and Description
GenericChallenge()

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptable(String type) Checks if the type is acceptable to this challenge.
protected <T> T	get(String key) Gets a value from the challenge state.
URI	getLocation() Returns the location URI of the challenge.
Status	getStatus() Returns the current status of the challenge.
String	getType() Returns the challenge type by name (e.g.
Date	getValidated() Returns the validation date, if returned by the server.
static byte[]	jwkThumbprint(PublicKey key) Computes a JWK Thumbprint.
void	respond(ClaimBuilder cb) Exports the response state, as preparation for triggering the challenge.
void	unmarshall(Map<String,Object> map) Sets the challenge state by reading the given JSON map.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_TYPE

protected static final String KEY_TYPE

See Also:

Constant Field Values

KEY_STATUS

protected static final String KEY_STATUS

See Also:

Constant Field Values

KEY_URI

protected static final String KEY_URI

See Also:

Constant Field Values

KEY_VALIDATED

protected static final String KEY_VALIDATED

See Also:

Constant Field Values

Constructor Detail

GenericChallenge

public GenericChallenge()

Method Detail

getType

public String getType()

Description copied from interface: Challenge

Returns the challenge type by name (e.g. "http-01").

Specified by:

getType in interface Challenge

getStatus

public Status getStatus()

Description copied from interface: Challenge

Returns the current status of the challenge.

Specified by:

getStatus in interface Challenge

getLocation

public URI getLocation()

Description copied from interface: Challenge

Returns the location URI of the challenge.

Specified by:

getLocation in interface Challenge

getValidated

public Date getValidated()

Description copied from interface: Challenge

Returns the validation date, if returned by the server.

Specified by:

getValidated in interface Challenge

unmarshall

public void unmarshall(Map<String,Object> map)

Description copied from interface: Challenge

Sets the challenge state by reading the given JSON map.

Specified by:

unmarshall in interface Challenge

Parameters:

map - JSON map containing the challenge data

respond

public void respond(ClaimBuilder cb)

Description copied from interface: Challenge

Exports the response state, as preparation for triggering the challenge.

Specified by:

respond in interface Challenge

Parameters:

cb - ClaimBuilder to copy the response to

acceptable

protected boolean acceptable(String type)

Checks if the type is acceptable to this challenge.

Parameters:

type - Type to check

Returns:

true if acceptable, false if not

get

protected <T> T get(String key)

Gets a value from the challenge state.

Parameters:

key - Key

Returns:

Value, or null if not set

jwkThumbprint

public static byte[] jwkThumbprint(PublicKey key)

Computes a JWK Thumbprint. It is frequently used in responses.

Parameters:

key - PublicKey to create a thumbprint of

Returns:

Thumbprint, SHA-256 hashed

See Also:

RFC 7638