Module io.inverno.mod.security.http

Package io.inverno.mod.security.http.digest

Class DigestPassword.Encoder

java.lang.Object

io.inverno.mod.security.http.digest.DigestPassword.Encoder

All Implemented Interfaces:

Password.Encoder<DigestPassword,DigestPassword.Encoder>

Enclosing class:

DigestPassword

public class DigestPassword.Encoder
extends Object
implements Password.Encoder<DigestPassword,DigestPassword.Encoder>

An HTTP Digest password encoder implementation as defined by RFC 7616 Section 3.4.2.

The encoded password corresponds to A1 in RFC 7616 which is constant in the HTTP digest authentication process.

Since:

1.5

Author:

Jeremy Kuhn

Constructor Summary

Constructors

Constructor	Description
Encoder(String algorithm, String username, String realm)	Creates a digest password encoder with the specified algorithm, username and realm.

Method Summary

Modifier and Type	Method	Description
DigestPassword	encode(String raw)
String	getAlgorithm()	Returns the algorithm.
String	getRealm()	Returns the realm.
String	getUsername()	Returns the username.
boolean	matches(String raw, String encoded)
DigestPassword	recover(String encoded)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inverno.mod.security.authentication.password.Password.Encoder

matches

Constructor Details

Encoder

public Encoder(String algorithm,
 String username,
 String realm)

Creates a digest password encoder with the specified algorithm, username and realm.

Parameters:

algorithm - the algorithm

username - the username

realm - the realm

Method Details

getAlgorithm

public String getAlgorithm()

Returns the algorithm.

Returns:

the algorithm

getUsername

public String getUsername()

Returns the username.

Returns:

the username

getRealm

public String getRealm()

Returns the realm.

Returns:

the realm

recover

public DigestPassword recover(String encoded)
                       throws PasswordException

Specified by:

recover in interface Password.Encoder<DigestPassword,DigestPassword.Encoder>

Throws:

PasswordException

encode

public DigestPassword encode(String raw)
                      throws PasswordException

Specified by:

encode in interface Password.Encoder<DigestPassword,DigestPassword.Encoder>

Throws:

PasswordException

matches

public boolean matches(String raw,
 String encoded)
                throws PasswordException

Specified by:

matches in interface Password.Encoder<DigestPassword,DigestPassword.Encoder>

Throws:

PasswordException