com.joyent.http.signature.apache.httpclient

Class HttpSignatureAuthScheme

java.lang.Object

com.joyent.http.signature.apache.httpclient.HttpSignatureAuthScheme

All Implemented Interfaces:

org.apache.http.auth.AuthScheme, org.apache.http.auth.ContextAwareAuthScheme

public class HttpSignatureAuthScheme
extends Object
implements org.apache.http.auth.ContextAwareAuthScheme

Apache HTTP Client plugin that allows for HTTP Signature based authentication.

Since:

1.0.0

Author:

Elijah Zupancic

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCHEME_NAME Name of authentication scheme.

Constructor Summary

Constructors

Constructor and Description
HttpSignatureAuthScheme(KeyPair keyPair) Creates a new instance allowing for HTTP signing with default settings.
HttpSignatureAuthScheme(KeyPair keyPair, boolean useNativeCodeToSign) Deprecated. Prefer #HttpSignatureAuthScheme(final KeyPair keyPair, final Signer) if configuration of Signer algorithm, hashes, or providers is required.
HttpSignatureAuthScheme(KeyPair keyPair, ThreadLocalSigner signer) Creates a new instance allowing for HTTP signing.

Method Summary

Modifier and Type	Method and Description
org.apache.http.Header	authenticate(org.apache.http.auth.Credentials credentials, org.apache.http.HttpRequest request)
org.apache.http.Header	authenticate(org.apache.http.auth.Credentials credentials, org.apache.http.HttpRequest request, org.apache.http.protocol.HttpContext context)
String	getParameter(String name)
String	getRealm()
String	getSchemeName()
ThreadLocalSigner	getSigner()
boolean	isComplete()
boolean	isConnectionBased()
void	processChallenge(org.apache.http.Header header)
protected org.apache.http.Header	signRequestHeader(org.apache.http.auth.Credentials credentials, org.apache.http.HttpRequest request) Signs an HttpRequest and returns a header with the signed authorization value.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SCHEME_NAME

public static final String SCHEME_NAME

Name of authentication scheme.

See Also:

Constant Field Values

Constructor Detail

HttpSignatureAuthScheme

public HttpSignatureAuthScheme(KeyPair keyPair)

Creates a new instance allowing for HTTP signing with default settings. An internal ThreadLocalSigner instance will be created.

Parameters:

keyPair - Public/private keypair object used to sign HTTP requests.

HttpSignatureAuthScheme

@Deprecated
public HttpSignatureAuthScheme(KeyPair keyPair,
                                           boolean useNativeCodeToSign)

Deprecated. Prefer #HttpSignatureAuthScheme(final KeyPair keyPair, final Signer) if configuration of Signer algorithm, hashes, or providers is required.

Creates a new instance allowing for HTTP signing with default settings. An internal ThreadLocalSigner instance will be created.

Parameters:

keyPair - Public/private keypair object used to sign HTTP requests.

useNativeCodeToSign - true to enable native code acceleration of cryptographic singing

HttpSignatureAuthScheme

public HttpSignatureAuthScheme(KeyPair keyPair,
                               ThreadLocalSigner signer)

Creates a new instance allowing for HTTP signing.

Parameters:

keyPair - Public/private keypair object used to sign HTTP requests.

signer - ThreadLocalSigner to use for all signed requests.

Method Detail

processChallenge

public void processChallenge(org.apache.http.Header header)
                      throws org.apache.http.auth.MalformedChallengeException

Specified by:

processChallenge in interface org.apache.http.auth.AuthScheme

Throws:

org.apache.http.auth.MalformedChallengeException

getSchemeName

public String getSchemeName()

Specified by:

getSchemeName in interface org.apache.http.auth.AuthScheme

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface org.apache.http.auth.AuthScheme

getRealm

public String getRealm()

Specified by:

getRealm in interface org.apache.http.auth.AuthScheme

isConnectionBased

public boolean isConnectionBased()

Specified by:

isConnectionBased in interface org.apache.http.auth.AuthScheme

isComplete

public boolean isComplete()

Specified by:

isComplete in interface org.apache.http.auth.AuthScheme

authenticate

public org.apache.http.Header authenticate(org.apache.http.auth.Credentials credentials,
                                           org.apache.http.HttpRequest request,
                                           org.apache.http.protocol.HttpContext context)
                                    throws org.apache.http.auth.AuthenticationException

Specified by:

authenticate in interface org.apache.http.auth.ContextAwareAuthScheme

Throws:

org.apache.http.auth.AuthenticationException

authenticate

public org.apache.http.Header authenticate(org.apache.http.auth.Credentials credentials,
                                           org.apache.http.HttpRequest request)
                                    throws org.apache.http.auth.AuthenticationException

Specified by:

authenticate in interface org.apache.http.auth.AuthScheme

Throws:

org.apache.http.auth.AuthenticationException

toString

public String toString()

Overrides:

toString in class Object

signRequestHeader

protected org.apache.http.Header signRequestHeader(org.apache.http.auth.Credentials credentials,
                                                   org.apache.http.HttpRequest request)
                                            throws org.apache.http.auth.AuthenticationException

Signs an HttpRequest and returns a header with the signed authorization value.

Parameters:

credentials - Credentials containing a username

request - The HttpRequest to sign.

Returns:

header with signed authorization value

Throws:

org.apache.http.auth.AuthenticationException - If unable to sign the request.

getSigner

public ThreadLocalSigner getSigner()