org.pac4j.http.credentials.extractor

Class DigestAuthExtractor

java.lang.Object

org.pac4j.http.credentials.extractor.DigestAuthExtractor

All Implemented Interfaces:

CredentialsExtractor<DigestCredentials>

public class DigestAuthExtractor
extends Object
implements CredentialsExtractor<DigestCredentials>

To extract digest auth header.

Since:

1.9.0

Author:

Mircea Carasel

Constructor Summary

Constructors

Constructor and Description
DigestAuthExtractor(String clientName)
DigestAuthExtractor(String headerName, String prefixHeader, String clientName)

Method Summary

Modifier and Type	Method and Description
DigestCredentials	extract(WebContext context) Extracts digest Authorization header components.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DigestAuthExtractor

public DigestAuthExtractor(String clientName)

DigestAuthExtractor

public DigestAuthExtractor(String headerName,
                           String prefixHeader,
                           String clientName)

Method Detail

extract

public DigestCredentials extract(WebContext context)
                          throws HttpAction

Extracts digest Authorization header components. As per RFC 2617 : username is the user's name in the specified realm qop is quality of protection uri is the request uri response is the client response nonce is a server-specified data string which should be uniquely generated each time a 401 response is made cnonce is the client nonce nc is the nonce count If in the Authorization header it is not specified a username and response, we throw CredentialsException because the client uses an username and a password to authenticate. response is just a MD5 encoded value based on user provided password and RFC 2617 digest authentication encoding rules

Specified by:

extract in interface CredentialsExtractor<DigestCredentials>

Parameters:

context - the current web context

Returns:

the Digest credentials

Throws:

HttpAction - requires a specific HTTP action if necessary

toString

public String toString()

Overrides:

toString in class Object