Package org.pac4j.http.credentials
Class DigestCredentials
- java.lang.Object
-
- org.pac4j.core.credentials.Credentials
-
- org.pac4j.core.credentials.TokenCredentials
-
- org.pac4j.http.credentials.DigestCredentials
-
- All Implemented Interfaces:
java.io.Serializable
public class DigestCredentials extends org.pac4j.core.credentials.TokenCredentials
This credentials is retrieved from a HTTP request.
A user profile can be attached with the credentials if it has been created by a
Authenticator
. In that case, theAuthenticatorProfileCreator
must be used to retrieve the attached user profile.- Since:
- 1.9.0
- Author:
- Mircea Carasel
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DigestCredentials(java.lang.String token, java.lang.String httpMethod, java.lang.String username, java.lang.String realm, java.lang.String nonce, java.lang.String uri, java.lang.String cnonce, java.lang.String nc, java.lang.String qop)
the token represents the client response attribute value in digest authorization header
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
calculateServerDigest(boolean passwordAlreadyEncoded, java.lang.String password)
This calculates the server digest value based on user stored password.boolean
equals(java.lang.Object o)
java.lang.String
getUsername()
int
hashCode()
java.lang.String
toString()
-
-
-
Constructor Detail
-
DigestCredentials
public DigestCredentials(java.lang.String token, java.lang.String httpMethod, java.lang.String username, java.lang.String realm, java.lang.String nonce, java.lang.String uri, java.lang.String cnonce, java.lang.String nc, java.lang.String qop)
the token represents the client response attribute value in digest authorization header- Parameters:
token
- the tokenhttpMethod
- the HTTP methodusername
- the user namerealm
- the realmnonce
- nonceuri
- uricnonce
- cnoncenc
- ncqop
- qop
-
-
Method Detail
-
calculateServerDigest
public java.lang.String calculateServerDigest(boolean passwordAlreadyEncoded, java.lang.String password)
This calculates the server digest value based on user stored password. If the server stores password in clear format then passwordAlreadyEncoded should be false. If the server stores the password in ha1, digest then the passwordAlreadyEncoded should be true.- Parameters:
passwordAlreadyEncoded
- false if the server stored password is in clear, true otherwisepassword
- user password stored server-side- Returns:
- digest value. This value must match the client "response" value in the Authorization http header for a successful digest authentication
-
getUsername
public java.lang.String getUsername()
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classorg.pac4j.core.credentials.TokenCredentials
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classorg.pac4j.core.credentials.TokenCredentials
-
toString
public java.lang.String toString()
- Overrides:
toString
in classorg.pac4j.core.credentials.TokenCredentials
-
-