Package org.springframework.security.oauth2.server.resource.authentication

Class DPoPAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.oauth2.server.resource.authentication.DPoPAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class DPoPAuthenticationToken
extends AbstractAuthenticationToken

An Authentication representing a protected resource request with a DPoP-bound access token.

Since:

6.5

See Also:

• DPoPAuthenticationProvider
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DPoPAuthenticationToken(String accessToken, String dPoPProof, String method, String resourceUri)	Constructs a DPoPAuthenticationToken using the provided parameters.

Method Summary

Modifier and Type	Method	Description
String	getAccessToken()	Returns the DPoP-bound access token.
Object	getCredentials()	The credentials that prove the principal is correct.
String	getDPoPProof()	Returns the DPoP Proof Jwt.
String	getMethod()	Returns the value of the HTTP method of the request.
Object	getPrincipal()	The identity of the principal being authenticated.
String	getResourceUri()	Returns the value of the HTTP resource URI of the request, without query and fragment parts.

Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Constructor Details

DPoPAuthenticationToken

public DPoPAuthenticationToken(String accessToken,
 String dPoPProof,
 String method,
 String resourceUri)

Constructs a DPoPAuthenticationToken using the provided parameters.

Parameters:

accessToken - the DPoP-bound access token

dPoPProof - the DPoP Proof Jwt

method - the value of the HTTP method of the request

resourceUri - the value of the HTTP resource URI of the request, without query and fragment parts

Method Details

getPrincipal

public Object getPrincipal()

Description copied from interface: Authentication

The identity of the principal being authenticated. In the case of an authentication request with username and password, this would be the username. Callers are expected to populate the principal for an authentication request.

The AuthenticationManager implementation will often return an Authentication containing richer information as the principal for use by the application. Many of the authentication providers will create a UserDetails object as the principal.

Returns:

the Principal being authenticated or the authenticated principal after authentication.

getCredentials

public Object getCredentials()

Description copied from interface: Authentication

The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the AuthenticationManager. Callers are expected to populate the credentials.

Returns:

the credentials that prove the identity of the Principal

getAccessToken

public String getAccessToken()

Returns the DPoP-bound access token.

Returns:

the DPoP-bound access token

getDPoPProof

public String getDPoPProof()

Returns the DPoP Proof Jwt.

Returns:

the DPoP Proof Jwt

getMethod

public String getMethod()

Returns the value of the HTTP method of the request.

Returns:

the value of the HTTP method of the request

getResourceUri

public String getResourceUri()

Returns the value of the HTTP resource URI of the request, without query and fragment parts.

Returns:

the value of the HTTP resource URI of the request