org.apache.commons.httpclient.auth
public class DigestScheme extends RFC2617Scheme
Digest authentication scheme as defined in RFC 2617. Both MD5 (default) and MD5-sess are supported. Currently only qop=auth or no qop is supported. qop=auth-int is unsupported. If auth and auth-int are provided, auth is used.
Credential charset is configured via the
credential
charset
parameter. Since the digest username is included as clear text in the generated
Authentication header, the charset of the username must be compatible with the
http element
charset
.
Constructor Summary | |
---|---|
DigestScheme()
Default constructor for the digest authetication scheme.
| |
DigestScheme(String challenge)
Constructor for the digest authetication scheme.
|
Method Summary | |
---|---|
String | authenticate(Credentials credentials, String method, String uri)
Produces a digest authorization string for the given set of
Credentials, method name and URI.
|
String | authenticate(Credentials credentials, HttpMethod method)
Produces a digest authorization string for the given set of
Credentials, method name and URI.
|
static String | createCnonce()
Creates a random cnonce value based on the current time.
|
String | getID()
Gets an ID based upon the realm and the nonce value. |
String | getSchemeName()
Returns textual designation of the digest authentication scheme.
|
boolean | isComplete()
Tests if the Digest authentication process has been completed.
|
boolean | isConnectionBased()
Returns false. |
void | processChallenge(String challenge)
Processes the Digest challenge.
|
Since: 3.0
Deprecated: Use parameterless constructor and processChallenge method
Constructor for the digest authetication scheme.Parameters: challenge authentication challenge
Throws: MalformedChallengeException is thrown if the authentication challenge is malformed
Deprecated: Use DigestScheme
Produces a digest authorization string for the given set of Credentials, method name and URI.Parameters: credentials A set of credentials to be used for athentication method the name of the method that requires authorization. uri The URI for which authorization is needed.
Returns: a digest authorization string
Throws: InvalidCredentialsException if authentication credentials are not valid or not applicable for this authentication scheme AuthenticationException if authorization string cannot be generated due to an authentication failure
See Also: getName
Parameters: credentials A set of credentials to be used for athentication method The method being authenticated
Returns: a digest authorization string
Throws: InvalidCredentialsException if authentication credentials are not valid or not applicable for this authentication scheme AuthenticationException if authorization string cannot be generated due to an authentication failure
Since: 3.0
Returns: The cnonce value as String.
Throws: HttpClientError if MD5 algorithm is not supported.
Deprecated: no longer used
Gets an ID based upon the realm and the nonce value. This ensures that requests to the same realm with different nonce values will succeed. This differentiation allows servers to request re-authentication using a fresh nonce value.Returns: digest
Returns: true if Digest authorization has been processed, false otherwise.
Since: 3.0
Returns: false.
Since: 3.0
Parameters: challenge the challenge string
Throws: MalformedChallengeException is thrown if the authentication challenge is malformed
Since: 3.0