A B C D E F G H I K N P R S T U V

A

add(Key) - Method in class net.adamcin.httpsig.api.DefaultKeychain

addAll(Collection<? extends Key>) - Method in class net.adamcin.httpsig.api.DefaultKeychain

addDate(Calendar) - Method in class net.adamcin.httpsig.api.RequestContent.Builder

IMPORTANT: If you call this overload instead of RequestContent.Builder.addHeader(String, String), be sure to retrieve the generated header value to add to your client request using a subsequent call to RequestContent.getDate().

addDate(Date) - Method in class net.adamcin.httpsig.api.RequestContent.Builder

IMPORTANT: If you call this overload instead of RequestContent.Builder.addHeader(String, String), be sure to retrieve the generated header value to add to your client request using a subsequent call to RequestContent.getDate().

addDateNow() - Method in class net.adamcin.httpsig.api.RequestContent.Builder

IMPORTANT: If you call this overload instead of RequestContent.Builder.addHeader(String, String), be sure to retrieve the generated header value to add to your client request using a subsequent call to RequestContent.getDate().

addHeader(String, String) - Method in class net.adamcin.httpsig.api.RequestContent.Builder

Adds a header name and value pair

Algorithm - Enum in net.adamcin.httpsig.api

Enumeration of supported HTTP Signature algorithms

ALGORITHM - Static variable in class net.adamcin.httpsig.api.Constants

Challenge header "algorithm" parameter

ALGORITHMS - Static variable in class net.adamcin.httpsig.api.Constants

Challenge header "algorithms" parameter

ALL_SUPPORTED_ALGORITHMS - Static variable in class net.adamcin.httpsig.api.Constants

Authorization - Class in net.adamcin.httpsig.api

Representation of the "Authorization: Signature..." header sent by the client in response to a Challenge

Authorization(String, String, List<String>, Algorithm) - Constructor for class net.adamcin.httpsig.api.Authorization

Construct an Authorization instance

AUTHORIZATION - Static variable in class net.adamcin.httpsig.api.Constants

Http request header representing client credentials

B

Base64 - Class in net.adamcin.httpsig.api

Encodes and decodes to and from Base64 notation.

build() - Method in class net.adamcin.httpsig.api.RequestContent.Builder

Builder() - Constructor for class net.adamcin.httpsig.api.RequestContent.Builder

C

canSign() - Method in interface net.adamcin.httpsig.api.Key

canVerify() - Method in interface net.adamcin.httpsig.api.Key

Challenge - Class in net.adamcin.httpsig.api

Representation of the "WWW-Authenticate: Signature ..." authentication challenge header sent by the server.

Challenge(String, List<String>, Collection<Algorithm>) - Constructor for class net.adamcin.httpsig.api.Challenge

Construct a Challenge instance

CHALLENGE - Static variable in class net.adamcin.httpsig.api.Constants

Http response header representing a server authentication challenge

CHARSET - Static variable in class net.adamcin.httpsig.api.Constants

Default encoding for header values.

clear() - Method in class net.adamcin.httpsig.api.DefaultKeychain

Constants - Class in net.adamcin.httpsig.api

Constant values used by the Signature Specification

constructRFC2617(Map<String, String>) - Static method in class net.adamcin.httpsig.api.Constants

constructTokensString(List<String>) - Static method in class net.adamcin.httpsig.api.Constants

contains(Object) - Method in class net.adamcin.httpsig.api.DefaultKeychain

containsAll(Collection<?>) - Method in class net.adamcin.httpsig.api.DefaultKeychain

currentKey() - Method in class net.adamcin.httpsig.api.DefaultKeychain

currentKey() - Method in interface net.adamcin.httpsig.api.Keychain

D

DATE_FORMAT - Static variable in class net.adamcin.httpsig.api.RequestContent

Deprecated.

DATE_FORMAT_RFC1123 - Static variable in class net.adamcin.httpsig.api.RequestContent

DEFAULT_HEADERS - Static variable in class net.adamcin.httpsig.api.Constants

DEFAULT_KEY_IDENTIFIER - Static variable in class net.adamcin.httpsig.api.Constants

DEFAULT_SKEW - Static variable in class net.adamcin.httpsig.api.DefaultVerifier

DefaultKeychain - Class in net.adamcin.httpsig.api

Simple implementation of Keychain backed by a HashMap and modified via Collection methods

DefaultKeychain() - Constructor for class net.adamcin.httpsig.api.DefaultKeychain

DefaultKeychain(Collection<? extends Key>) - Constructor for class net.adamcin.httpsig.api.DefaultKeychain

DefaultVerifier - Class in net.adamcin.httpsig.api

The Server-Side component of the protocol which verifies Authorization headers using SSH Public Keys

DefaultVerifier(Keychain) - Constructor for class net.adamcin.httpsig.api.DefaultVerifier

DefaultVerifier(Keychain, KeyId) - Constructor for class net.adamcin.httpsig.api.DefaultVerifier

DefaultVerifier(Keychain, KeyId, long) - Constructor for class net.adamcin.httpsig.api.DefaultVerifier

discard() - Method in class net.adamcin.httpsig.api.DefaultKeychain

discard() - Method in interface net.adamcin.httpsig.api.Keychain

E

equals(Object) - Method in class net.adamcin.httpsig.api.Challenge

F

filterAlgorithms(Collection<Algorithm>) - Method in class net.adamcin.httpsig.api.DefaultKeychain

filterAlgorithms(Collection<Algorithm>) - Method in interface net.adamcin.httpsig.api.Keychain

Filter this keychain by a Collection of supported Algorithms

filterHeaders(List<String>) - Static method in class net.adamcin.httpsig.api.Constants

forName(String) - Static method in enum net.adamcin.httpsig.api.Algorithm

fromBase64(byte[]) - Static method in class net.adamcin.httpsig.api.Base64

fromBase64String(String) - Static method in class net.adamcin.httpsig.api.Base64

G

getAlgorithm() - Method in class net.adamcin.httpsig.api.Authorization

getAlgorithms() - Method in class net.adamcin.httpsig.api.Challenge

getAlgorithms() - Method in class net.adamcin.httpsig.api.DefaultKeychain

getAlgorithms() - Method in interface net.adamcin.httpsig.api.Key

getAlgorithms() - Method in interface net.adamcin.httpsig.api.Keychain

getAlgorithmsString() - Method in class net.adamcin.httpsig.api.Challenge

getBytesToSign(List<String>, Charset) - Method in class net.adamcin.httpsig.api.RequestContent

Returns the request content as a byte array for generating a signature.

getCandidateKeys() - Method in class net.adamcin.httpsig.api.Signer

getContent(List<String>, Charset) - Method in class net.adamcin.httpsig.api.RequestContent

Deprecated.

use RequestContent.getBytesToSign(List, Charset) to include the Constants.HEADER_REQUEST_TARGET prefix in signature content

getContentString(List<String>) - Method in class net.adamcin.httpsig.api.RequestContent

Deprecated.

use RequestContent.getStringToSign(List) to include the Constants.HEADER_REQUEST_TARGET prefix in signature content

getDate() - Method in class net.adamcin.httpsig.api.RequestContent

getDateGMT() - Method in class net.adamcin.httpsig.api.RequestContent

Returns the currently set date header value converted to a Date object in the GMT time zone

getDateTZ(TimeZone) - Method in class net.adamcin.httpsig.api.RequestContent

Returns the currently set date header value converted to a Calendar in the specified timeZone, or in the default timeZone if the parameter is null

getHeaderNames() - Method in class net.adamcin.httpsig.api.RequestContent

getHeaders() - Method in class net.adamcin.httpsig.api.Authorization

getHeaders() - Method in class net.adamcin.httpsig.api.Challenge

getHeaderValue() - Method in class net.adamcin.httpsig.api.Authorization

getHeaderValue() - Method in class net.adamcin.httpsig.api.Challenge

getHeaderValues(String) - Method in class net.adamcin.httpsig.api.RequestContent

getId() - Method in interface net.adamcin.httpsig.api.Key

getId(Key) - Method in interface net.adamcin.httpsig.api.KeyId

getKeychain() - Method in class net.adamcin.httpsig.api.DefaultVerifier

getKeychain() - Method in class net.adamcin.httpsig.api.Signer

getKeyId() - Method in class net.adamcin.httpsig.api.Authorization

getKeyId() - Method in class net.adamcin.httpsig.api.Signer

getName() - Method in enum net.adamcin.httpsig.api.Algorithm

getRealm() - Method in class net.adamcin.httpsig.api.Challenge

getRequestLine() - Method in class net.adamcin.httpsig.api.RequestContent

Deprecated.

getRequestTarget() - Method in class net.adamcin.httpsig.api.RequestContent

getSignature() - Method in class net.adamcin.httpsig.api.Authorization

getSignatureBytes() - Method in class net.adamcin.httpsig.api.Authorization

getSkew() - Method in class net.adamcin.httpsig.api.DefaultVerifier

getSkew() - Method in interface net.adamcin.httpsig.api.Verifier

getStringToSign(List<String>) - Method in class net.adamcin.httpsig.api.RequestContent

Returns the request content as a String for generating a signature.

getUserId() - Method in interface net.adamcin.httpsig.api.UserKey

Get the associated userId

H

hashCode() - Method in class net.adamcin.httpsig.api.Challenge

HEADER_DATE - Static variable in class net.adamcin.httpsig.api.Constants

HEADER_REQUEST_LINE - Static variable in class net.adamcin.httpsig.api.Constants

Deprecated.

HEADER_REQUEST_TARGET - Static variable in class net.adamcin.httpsig.api.Constants

HEADERS - Static variable in class net.adamcin.httpsig.api.Constants

Parameter name for the "headers" authorization parameter

I

IGNORE_HEADERS - Static variable in class net.adamcin.httpsig.api.Constants

List of headers to always exclude from signature calculation

isEmpty() - Method in class net.adamcin.httpsig.api.DefaultKeychain

isEmpty() - Method in interface net.adamcin.httpsig.api.Keychain

iterator() - Method in class net.adamcin.httpsig.api.DefaultKeychain

K

Key - Interface in net.adamcin.httpsig.api

Interface representing an object which can sign content and/or verify signatures

KEY_ID - Static variable in class net.adamcin.httpsig.api.Constants

Parameter name for challenge-selected SSH Public Key Fingerprint

Keychain - Interface in net.adamcin.httpsig.api

Immutable interface for a list of Keys

KeyId - Interface in net.adamcin.httpsig.api

Interface used by a Keychain to generate keyId's from the Keys that it contains

N

net.adamcin.httpsig.api - package net.adamcin.httpsig.api

P

parse(String) - Static method in class net.adamcin.httpsig.api.Authorization

Parse an Authorization header value to construct an Authorization instance

parse(String) - Static method in class net.adamcin.httpsig.api.Challenge

Parse a WWW-Authenticate header value to create a Challenge

parseAlgorithms(String) - Static method in class net.adamcin.httpsig.api.Challenge

parseRFC2617(String) - Static method in class net.adamcin.httpsig.api.Constants

parseTokens(String) - Static method in class net.adamcin.httpsig.api.Constants

PREEMPTIVE_CHALLENGE - Static variable in class net.adamcin.httpsig.api.Constants

R

REALM - Static variable in class net.adamcin.httpsig.api.Constants

Challenge header "realm" parameter

remove(Object) - Method in class net.adamcin.httpsig.api.DefaultKeychain

removeAll(Collection<?>) - Method in class net.adamcin.httpsig.api.DefaultKeychain

RequestContent - Class in net.adamcin.httpsig.api

Object used to pass per-request context, such as Request Line and HTTP Headers in client/server implementation-independent way.

RequestContent.Builder - Class in net.adamcin.httpsig.api

retainAll(Collection<?>) - Method in class net.adamcin.httpsig.api.DefaultKeychain

RFC2617_PARAM - Static variable in class net.adamcin.httpsig.api.Constants

rotateKeys() - Method in class net.adamcin.httpsig.api.Signer

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

rotateKeys(Challenge) - Method in class net.adamcin.httpsig.api.Signer

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

rotateKeys(Challenge, Authorization) - Method in class net.adamcin.httpsig.api.Signer

Call this method to rotate the candidate keys

S

SCHEME - Static variable in class net.adamcin.httpsig.api.Constants

Identifier for the Signature Authentication scheme

selectKey(Authorization) - Method in class net.adamcin.httpsig.api.DefaultVerifier

Selects an appropriate Key from the Keychain matching the keyId specified in the Authorization.

selectKey(Authorization) - Method in interface net.adamcin.httpsig.api.Verifier

Selects an appropriate Key from the Keychain matching the keyId specified in the Authorization.

setRequestLine(String) - Method in class net.adamcin.httpsig.api.RequestContent.Builder

Deprecated.

setRequestTarget(String, String) - Method in class net.adamcin.httpsig.api.RequestContent.Builder

setSkew(long) - Method in class net.adamcin.httpsig.api.DefaultVerifier

Deprecated.

will remove to make the class immutable. use constructor overload instead.

sign(Algorithm, byte[]) - Method in interface net.adamcin.httpsig.api.Key

Signs the challengeHash using the specified signature Algorithm

sign(RequestContent) - Method in class net.adamcin.httpsig.api.Signer

Signs a RequestContent and returns an Authorization header.

sign(RequestContent, List<String>) - Method in class net.adamcin.httpsig.api.Signer

Signs a RequestContent and returns an Authorization header.

SIGNATURE - Static variable in class net.adamcin.httpsig.api.Constants

Parameter name for the "signature" authorization parameter

Signer - Class in net.adamcin.httpsig.api

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

Signer(Keychain) - Constructor for class net.adamcin.httpsig.api.Signer

Signer(Key, KeyId) - Constructor for class net.adamcin.httpsig.api.Signer

Signer(Keychain, KeyId) - Constructor for class net.adamcin.httpsig.api.Signer

size() - Method in class net.adamcin.httpsig.api.DefaultKeychain

T

toArray() - Method in class net.adamcin.httpsig.api.DefaultKeychain

toArray(T[]) - Method in class net.adamcin.httpsig.api.DefaultKeychain

toBase64String(byte[]) - Static method in class net.adamcin.httpsig.api.Base64

toMap(KeyId) - Method in class net.adamcin.httpsig.api.DefaultKeychain

toMap(KeyId) - Method in interface net.adamcin.httpsig.api.Keychain

toString() - Method in class net.adamcin.httpsig.api.Authorization

toString() - Method in class net.adamcin.httpsig.api.Challenge

toString() - Method in class net.adamcin.httpsig.api.RequestContent

tryParseDate(String) - Static method in class net.adamcin.httpsig.api.RequestContent

Sets the literal date header value.

U

UserKey - Interface in net.adamcin.httpsig.api

Extends the base Key interface to add a userId field, which is a common use case for authentication.

V

valueOf(String) - Static method in enum net.adamcin.httpsig.api.Algorithm

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.adamcin.httpsig.api.VerifyResult

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.adamcin.httpsig.api.Algorithm

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.adamcin.httpsig.api.VerifyResult

Returns an array containing the constants of this enum type, in the order they are declared.

Verifier - Interface in net.adamcin.httpsig.api

Limited interface allowing for server-side use of guards and remote service calls

verify(Challenge, RequestContent, Authorization) - Method in class net.adamcin.httpsig.api.DefaultVerifier

Verifies the provided Authorization header against the original Challenge

verify(Algorithm, byte[], byte[]) - Method in interface net.adamcin.httpsig.api.Key

Verifies the signatureBytes against the challengeHash using an underlying public key

verify(Challenge, RequestContent, Authorization) - Method in interface net.adamcin.httpsig.api.Verifier

Verifies the provided Authorization header against the original Challenge

VerifyResult - Enum in net.adamcin.httpsig.api

Enumeration of possible results from Verifier.verifyWithResult(Challenge, RequestContent, Authorization)

verifyWithResult(Challenge, RequestContent, Authorization) - Method in class net.adamcin.httpsig.api.DefaultVerifier

Verifies the provided Authorization header against the original Challenge

verifyWithResult(Challenge, RequestContent, Authorization) - Method in interface net.adamcin.httpsig.api.Verifier

Verifies the provided Authorization header against the original Challenge

A B C D E F G H I K N P R S T U V