com.authlete.jaxrs.PushedAuthReqHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of authlete-java-jaxrs Show documentation
Show all versions of authlete-java-jaxrs Show documentation
Authlete library for JAX-RS (Java)
/*
* Copyright (C) 2019-2024 Authlete, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package com.authlete.jaxrs;
import java.io.Serializable;
import java.util.LinkedHashMap;
import java.util.Map;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import com.authlete.common.api.AuthleteApi;
import com.authlete.common.dto.PushedAuthReqResponse;
import com.authlete.common.dto.PushedAuthReqResponse.Action;
/**
* Handler for pushed authorization request endpoint requests.
*
*
* In an implementation of the pushed authorization request endpoint, call
* {@link #handle(Params)} method and use the response as the response from
* the endpoint to the client application. The {@code handle()} method calls
* Authlete's {@code /pushed_auth_req} API, receives a response from the API,
* and dispatches processing according to the {@code action} parameter in the
* response.
*
*
* @see RFC 9126: OAuth 2.0 Pushed Authorization Requests
*
* @since 2.21
*
* @author Justin Richer
*/
public class PushedAuthReqHandler extends BaseHandler
{
/**
* Parameters passed to the {@link PushedAuthReqHandler#handle(Params)}
* method.
*
* @since 2.69
*/
public static class Params implements Serializable
{
private static final long serialVersionUID = 2L;
private MultivaluedMap parameters;
private String authorization;
private String[] clientCertificatePath;
private String dpop;
private String htm;
private String htu;
private String clientAttestation;
private String clientAttestationPop;
/**
* Get the request parameters of the PAR request.
*
* @return
* The request parameters of the PAR request.
*/
public MultivaluedMap getParameters()
{
return parameters;
}
/**
* Set the request parameters of the PAR request.
*
* @param parameters
* The request parameters of the PAR request.
*
* @return
* {@code this} object.
*/
public Params setParameters(MultivaluedMap parameters)
{
this.parameters = parameters;
return this;
}
/**
* Get the value of the {@code Authorization} header in the PAR request.
* A pair of client ID and client secret is embedded there when the
* client authentication method is {@code client_secret_basic}.
*
* @return
* The value of the {@code Authorization} header.
*/
public String getAuthorization()
{
return authorization;
}
/**
* Set the value of the {@code Authorization} header in the PAR request.
* A pair of client ID and client secret is embedded there when the
* client authentication method is {@code client_secret_basic}.
*
* @param authorization
* The value of the {@code Authorization} header.
*
* @return
* {@code this} object.
*/
public Params setAuthorization(String authorization)
{
this.authorization = authorization;
return this;
}
/**
* Get the path of the client's certificate, each in PEM format.
* The first item in the array is the client's certificate itself.
*
* @return
* The path of the client's certificate.
*
* @see RFC 8705: OAuth 2.0 Mutual-TLS Client Authentication and
* Certificate-Bound Access Tokens
*/
public String[] getClientCertificatePath()
{
return clientCertificatePath;
}
/**
* Set the path of the client's certificate, each in PEM format.
* The first item in the array is the client's certificate itself.
*
* @param path
* The path of the client's certificate.
*
* @return
* {@code this} object.
*
* @see RFC 8705: OAuth 2.0 Mutual-TLS Client Authentication and
* Certificate-Bound Access Tokens
*/
public Params setClientCertificatePath(String[] path)
{
this.clientCertificatePath = path;
return this;
}
/**
* Get the DPoP proof JWT (the value of the {@code DPoP} HTTP header).
*
* @return
* The DPoP proof JWT.
*
* @see RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)
*/
public String getDpop()
{
return dpop;
}
/**
* Set the DPoP proof JWT (the value of the {@code DPoP} HTTP header).
*
* @param dpop
* The DPoP proof JWT.
*
* @return
* {@code this} object.
*
* @see RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)
*/
public Params setDpop(String dpop)
{
this.dpop = dpop;
return this;
}
/**
* Get the HTTP method of the PAR request.
*
* @return
* The HTTP method of the PAR request.
*
* @see RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)
*/
public String getHtm()
{
return htm;
}
/**
* Set the HTTP method of the PAR request.
*
*
* The value should be {@code "POST"} unless new specifications
* allowing other HTTP methods at the PAR endpoint are developed.
* If this parameter is omitted, {@code "POST"} is used as the
* default value.
*
*
*
* The value passed here will be used to validate the DPoP proof JWT.
*
*
* @param htm
* The HTTP method of the PAR request.
*
* @return
* {@code this} object.
*
* @see RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)
*/
public Params setHtm(String htm)
{
this.htm = htm;
return this;
}
/**
* Get the URL of the PAR endpoint.
*
* @return
* The URL of the PAR endpoint.
*
* @see RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)
*/
public String getHtu()
{
return htu;
}
/**
* Set the URL of the PAR endpoint.
*
*
* If this parameter is omitted, the {@code pushedAuthReqEndpoint}
* property of {@link Service} will be used as the default value.
*
*
*
* The value passed here will be used to validate the DPoP proof JWT.
*
*
* @param htu
* The URL of the PAR endpoint.
*
* @return
* {@code this} object.
*
* @see RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)
*/
public Params setHtu(String htu)
{
this.htu = htu;
return this;
}
/**
* Get the value of the {@code OAuth-Client-Attestation} HTTP header.
*
* @return
* The value of the {@code OAuth-Client-Attestation} HTTP header.
*
* @since 2.79
* @since Authlete 3.0
*
* @see OAuth 2.0 Attestation-Based Client Authentication
*/
public String getClientAttestation()
{
return clientAttestation;
}
/**
* Set the value of the {@code OAuth-Client-Attestation} HTTP header.
*
* @param jwt
* The value of the {@code OAuth-Client-Attestation} HTTP header.
*
* @return
* {@code this} object.
*
* @since 2.79
* @since Authlete 3.0
*
* @see OAuth 2.0 Attestation-Based Client Authentication
*/
public Params setClientAttestation(String jwt)
{
this.clientAttestation = jwt;
return this;
}
/**
* Get the value of the {@code OAuth-Client-Attestation-PoP} HTTP header.
*
* @return
* The value of the {@code OAuth-Client-Attestation-PoP} HTTP header.
*
* @since 2.79
* @since Authlete 3.0
*
* @see OAuth 2.0 Attestation-Based Client Authentication
*/
public String getClientAttestationPop()
{
return clientAttestationPop;
}
/**
* Set the value of the {@code OAuth-Client-Attestation-PoP} HTTP header.
*
* @param jwt
* The value of the {@code OAuth-Client-Attestation-PoP} HTTP header.
*
* @return
* {@code this} object.
*
* @since 2.79
* @since Authlete 3.0
*
* @see OAuth 2.0 Attestation-Based Client Authentication
*/
public Params setClientAttestationPop(String jwt)
{
this.clientAttestationPop = jwt;
return this;
}
}
/**
* Constructor with an implementation of {@link AuthleteApi} interface.
*
* @param api
* Implementation of {@link AuthleteApi} interface.
*/
public PushedAuthReqHandler(AuthleteApi api)
{
super(api);
}
/**
* Handle a pushed authorization request.
*
* @param parameters
* Request parameters of a pushed authorization request.
*
* @param authorization
* The value of {@code Authorization} header in the pushed
* authorization request. A client application may embed its
* pair of client ID and client secret in a pushed authorization
* request using Basic Authentication.
*
* @param clientCertificatePath
* The path of the client's certificate, each in PEM format.
* The first item in the array is the client's certificate itself.
* May be {@code null} if the client did not send a certificate or path.
*
* @return
* A response that should be returned from the endpoint to the
* client application.
*
* @throws WebApplicationException
* An error occurred.
*/
public Response handle(
MultivaluedMap parameters, String authorization,
String[] clientCertificatePath) throws WebApplicationException
{
Params params = new Params()
.setParameters(parameters)
.setAuthorization(authorization)
.setClientCertificatePath(clientCertificatePath)
;
return handle(params);
}
/**
* Handle a PAR request.
*
* @param params
* Parameters needed to handle the PAR request.
* Must not be {@code null}.
*
* @return
* A response that should be returned from the endpoint to the
* client application.
*
* @throws WebApplicationException
* An error occurred.
*
* @since 2.69
*/
public Response handle(Params params)
{
// The credential of the client application extracted from the
// Authorization header. If available, the first element is the
// client ID and the second element is the client secret.
String[] credential = HandlerUtility
.extractClientCredentialFromAuthorization(params.getAuthorization());
try
{
// Process the given parameters.
return process(params, credential[0], credential[1]);
}
catch (WebApplicationException e)
{
throw e;
}
catch (Throwable t)
{
// Unexpected error.
throw unexpected("Unexpected error in PushedAuthReqHandler", t);
}
}
/**
* Process the parameters of the pushed authorization request.
*/
private Response process(Params params, String clientId, String clientSecret)
{
// The client certificate.
String clientCertificate = HandlerUtility
.extractClientCertificate(params.getClientCertificatePath());
// The second and subsequent elements in the client certificate path.
String[] clientCertificatePath = HandlerUtility
.extractSubsequenceFromClientCertificatePath(params.getClientCertificatePath());
PushedAuthReqResponse response = getApiCaller().callPushedAuthReq(
params.getParameters(), clientId, clientSecret,
clientCertificate, clientCertificatePath,
params.getDpop(), params.getHtm(), params.getHtu(),
params.getClientAttestation(), params.getClientAttestationPop());
// 'action' in the response denotes the next action which
// this service implementation should take.
Action action = response.getAction();
// The content of the response to the client application.
String content = response.getResponseContent();
// Additional HTTP headers.
Map headers = prepareHeaders(response);
// Dispatch according to the action.
switch (action)
{
case BAD_REQUEST:
// 400 Bad Request
return ResponseUtil.badRequest(content, headers);
case CREATED:
// 201 Created
return ResponseUtil.created(content, headers);
case FORBIDDEN:
// 403 forbidden
return ResponseUtil.forbidden(content, headers);
case INTERNAL_SERVER_ERROR:
// 500 Internal Server Error
return ResponseUtil.internalServerError(content, headers);
case PAYLOAD_TOO_LARGE:
// 413 Too Large
return ResponseUtil.tooLarge(content, headers);
case UNAUTHORIZED:
// 401 Unauthorized
return ResponseUtil.unauthorized(content, null, headers);
default:
// This never happens.
throw getApiCaller().unknownAction("/api/pushed_auth_req", action);
}
}
private static Map prepareHeaders(PushedAuthReqResponse response)
{
Map headers = new LinkedHashMap<>();
// DPoP-Nonce
String dpopNonce = response.getDpopNonce();
if (dpopNonce != null)
{
headers.put("DPoP-Nonce", dpopNonce);
}
return headers;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy