net.adamcin.httpsig.api

Class Signer

java.lang.Object

net.adamcin.httpsig.api.Signer

public final class Signer
extends Object

Instance of a Signer, used by an HTTP client to sign a SignatureBuilder and create an Authorization

Constructor Summary

Constructors

Constructor and Description
Signer()
Signer(Keychain keychain)
Signer(Keychain keychain, KeyIdentifier keyIdentifier)

Method Summary

Methods

Modifier and Type	Method and Description
Keychain	getCandidateKeys()
Keychain	getKeychain()
KeyIdentifier	getKeyIdentifier()
boolean	rotateKeys() Call this method to rotate the candidate keys back to the original state.
boolean	rotateKeys(Challenge nextChallenge) Call this method to rotate the candidate keys according to the provided Challenge.
boolean	rotateKeys(Challenge nextChallenge, Authorization failedAuthz) Call this method to rotate the candidate keys
Authorization	sign(SignatureBuilder signatureBuilder) Signs a SignatureBuilder and returns an Authorization header

Methods inherited from class java.lang.Object

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

Constructor Detail

Signer

public Signer()

Signer

public Signer(Keychain keychain)

Signer

public Signer(Keychain keychain,
      KeyIdentifier keyIdentifier)

Method Detail

getKeychain

public Keychain getKeychain()

Returns:

the original keychain supplied to the Signer

getCandidateKeys

public Keychain getCandidateKeys()

Returns:

the Challenge-filtered and rotated Keychain

See Also:

rotateKeys()

getKeyIdentifier

public KeyIdentifier getKeyIdentifier()

rotateKeys

public boolean rotateKeys()

Call this method to rotate the candidate keys back to the original state.

Returns:

true if there is at least one key left after rotation, false otherwise

rotateKeys

public boolean rotateKeys(Challenge nextChallenge)

Call this method to rotate the candidate keys according to the provided Challenge.

Parameters:

nextChallenge - the Challenge header which was returned for the previous failed request.

Returns:

true if there is at least one key left after rotation, false otherwise

rotateKeys

public boolean rotateKeys(Challenge nextChallenge,
                 Authorization failedAuthz)

Call this method to rotate the candidate keys

Parameters:

nextChallenge - the Challenge header which was returned for the previous failed request.

failedAuthz - the Authorization header which failed on the previous request.

Returns:

true if there is at least one key left after rotation, false otherwise

sign

public Authorization sign(SignatureBuilder signatureBuilder)

Signs a SignatureBuilder and returns an Authorization header

Parameters:

signatureBuilder - the Request containing the headers to be signed

Returns:

a signed Authorization header or null if no identities could sign the Challenge