Merge pull request #50 from authlete/misc/vci-endpoints-refactoring

[misc] OID4VCI Endpoints Refactoring

Author: TakahikoKawasaki

pom.xml

@@ -12,8 +12,8 @@
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
-    <authlete.java.common.version>3.81</authlete.java.common.version>
-    <authlete.java.jaxrs.version>2.65</authlete.java.jaxrs.version>
+    <authlete.java.common.version>3.83</authlete.java.common.version>
+    <authlete.java.jaxrs.version>2.66</authlete.java.jaxrs.version>
     <javax.servlet-api.version>3.0.1</javax.servlet-api.version>
     <jersey.version>2.30.1</jersey.version>
     <jetty.version>9.4.27.v20200227</jetty.version>

src/main/java/com/authlete/jaxrs/server/api/vci/AbstractCredentialEndpoint.java

@@ -17,72 +17,299 @@
 package com.authlete.jaxrs.server.api.vci;
 
 
+import java.util.Arrays;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.stream.Collectors;
 import javax.servlet.http.HttpServletRequest;
 import javax.ws.rs.WebApplicationException;
-import javax.ws.rs.core.HttpHeaders;
 import com.authlete.common.api.AuthleteApi;
+import com.authlete.common.dto.CredentialIssuanceOrder;
+import com.authlete.common.dto.CredentialIssuerMetadataRequest;
+import com.authlete.common.dto.CredentialIssuerMetadataResponse;
+import com.authlete.common.dto.CredentialRequestInfo;
 import com.authlete.common.dto.IntrospectionRequest;
 import com.authlete.common.dto.IntrospectionResponse;
+import com.authlete.common.types.ErrorCode;
 import com.authlete.jaxrs.BaseResourceEndpoint;
 import com.authlete.jaxrs.server.util.ExceptionUtil;
+import com.authlete.jaxrs.server.vc.InvalidCredentialRequestException;
+import com.authlete.jaxrs.server.vc.OrderContext;
+import com.authlete.jaxrs.server.vc.OrderFormat;
+import com.authlete.jaxrs.server.vc.UnsupportedCredentialFormatException;
+import com.authlete.jaxrs.server.vc.UnsupportedCredentialTypeException;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
 
 
 public abstract class AbstractCredentialEndpoint extends BaseResourceEndpoint
 {
-    protected String checkContentExtractToken(final HttpServletRequest request,
-                                 final String requestContent)
+    /**
+     * Get the configured value of the endpoint of the credential issuer.
+     * The value is used as the expected value of the {@code htu} claim
+     * in the DPoP proof JWT.
+     *
+     * <p>
+     * When {@code dpop} is null, this method returns null. Otherwise, this
+     * method calls the {@code /vci/metadata} API to get the metadata of the
+     * credential issuer, and extracts the value of the specified endpoint
+     * from the metadata.
+     * </p>
+     *
+     * @param api
+     *         An instance of the {@link AuthleteApi} instance.
+     *
+     * @param dpop
+     *         A DPoP proof JWT, specified by the {@code DPoP} HTTP header.
+     *
+     * @param endpointName
+     *         The name of an endpoint, such as "{@code credential_endpoint}".
+     *
+     * @return
+     *         The configured value of the endpoint. If {@code dpop} is null,
+     *         this method returns null.
+     */
+    protected String computeHtu(AuthleteApi api, String dpop, String endpointName)
     {
-        if (requestContent == null)
+        if (dpop == null)
         {
-            throw ExceptionUtil.badRequestException("Missing request content.");
+            // When a DPoP proof JWT is not available, computing the value
+            // of "htu" is meaningless. We skip the computation to avoid
+            // making a call to the /vci/metadata API.
+            return null;
         }
 
-        final String accessToken = processAccessToken(request);
-        if (accessToken == null)
+        // Get the credential issuer metadata and extract the value of the
+        // endpoint from the metadata.
+        return (String)getCredentialIssuerMetadata(api).get(endpointName);
+    }
+
+
+    /**
+     * Get the credential issuer metadata by calling the {@code /vci/metadata} API.
+     *
+     * @param api
+     *         An instance of the {@link AuthleteApi} instance.
+     *
+     * @return
+     *         The credential issuer metadata.
+     */
+    @SuppressWarnings("unchecked")
+    private Map<String, Object> getCredentialIssuerMetadata(AuthleteApi api)
+    {
+        // Call the /vci/metadata API to get the metadata of the credential issuer.
+        CredentialIssuerMetadataResponse response =
+                api.credentialIssuerMetadata(new CredentialIssuerMetadataRequest());
+
+        // The response content.
+        String content = response.getResponseContent();
+
+        // If something wrong was reported by the /vci/metadata API.
+        if (response.getAction() != CredentialIssuerMetadataResponse.Action.OK)
         {
-            throw ExceptionUtil.badRequestException("Missing access token.");
+            // 500 Internal Server Error + application/json
+            throw ExceptionUtil.internalServerErrorExceptionJson(content);
         }
 
-        return accessToken;
+        // Convert the credential issuer metadata into a Map instance.
+        return new Gson().fromJson(content, Map.class);
     }
 
 
-    private String processAccessToken(final HttpServletRequest request)
+    /**
+     * Validate the access token and get the information about it.
+     *
+     * @param req
+     *         The HTTP request that this endpoint has received.
+     *
+     * @param api
+     *         An instance of the {@link AuthleteApi} interface.
+     *
+     * @param at
+     *         The access token.
+     *
+     * @param dpop
+     *         A DPoP proof JWT, specified by the {@code DPoP} HTTP header.
+     *
+     * @param htu
+     *         The URL of this endpoint, the expected value of the {@code htu}
+     *         claim in the DPoP proof JWT.
+     *
+     * @return
+     *         The response from the {@code /auth/introspection} API.
+     */
+    protected IntrospectionResponse introspect(
+            HttpServletRequest req, AuthleteApi api,
+            String at, String dpop, String htu)
     {
-        // The value of the "Authorization" header.
-        final String authorization = request.getHeader(HttpHeaders.AUTHORIZATION);
+        // The client certificate. This is needed for certificate-bound
+        // access tokens. See RFC 8705 for details.
+        String certificate = extractClientCertificate(req);
 
-        return super.extractAccessToken(authorization, null);
+        // The request to the /auth/introspection API.
+        IntrospectionRequest request =
+            new IntrospectionRequest()
+                .setToken(at)
+                .setClientCertificate(certificate)
+                .setDpop(dpop)
+                .setHtm("POST")
+                .setHtu(htu)
+                ;
+
+        // Validate the access token.
+        return validateAccessToken(api, request);
     }
 
 
-    protected IntrospectionResponse introspect(final AuthleteApi api,
-                                final String accessToken)
-            throws WebApplicationException
+    /**
+     * Prepare additional HTTP headers that the response from this endpoint
+     * should include.
+     *
+     * @param introspection
+     *         The response from the {@code /auth/introspection} API.
+     *
+     * @return
+     *         A map including pairs of a header name and a header value.
+     */
+    protected Map<String, Object> prepareHeaders(IntrospectionResponse introspection)
     {
-        final IntrospectionRequest introspectionRequest = new IntrospectionRequest()
-                .setToken(accessToken);
+        Map<String, Object> headers = new LinkedHashMap<>();
 
-        final IntrospectionResponse response = api.introspection(introspectionRequest);
-        final String content = response.getResponseContent();
+        // The expected nonce value for DPoP proof JWT.
+        String dpopNonce = introspection.getDpopNonce();
+        if (dpopNonce != null)
+        {
+            headers.put("DPoP-Nonce", dpopNonce);
+        }
+
+        return headers;
+    }
 
-        switch (response.getAction())
+
+    /**
+     * Prepare a credential issuance order.
+     *
+     * @param context
+     *         The context in which this method is called.
+     *
+     * @param introspection
+     *         The response from the {@code /auth/introspection} API.
+     *
+     * @param info
+     *         The information about the credential request.
+     *
+     * @param headers
+     *         The additional headers that should be included in the response
+     *         from this endpoint.
+     *
+     * @return
+     *         A credential issuance order.
+     */
+    protected CredentialIssuanceOrder prepareOrder(
+            OrderContext context,
+            IntrospectionResponse introspection, CredentialRequestInfo info,
+            Map<String, Object> headers)
+    {
+        try
         {
-            case BAD_REQUEST:
-                throw ExceptionUtil.badRequestException(content);
+            // Get an OrderFormat instance corresponding to the credential format.
+            OrderFormat format = getOrderFormat(info);
+
+            // Let the processor for the format create a credential issuance
+            // order based on the credential request.
+            return format.getProcessor().toOrder(context, introspection, info);
+        }
+        catch (UnsupportedCredentialFormatException cause)
+        {
+            // 400 Bad Request + "error":"unsupported_credential_format"
+            throw ExceptionUtil.badRequestExceptionJson(
+                    errorJson(ErrorCode.unsupported_credential_format, cause), headers);
+        }
+        catch (UnsupportedCredentialTypeException cause)
+        {
+            // 400 Bad Request + "error":"unsupported_credential_type"
+            throw ExceptionUtil.badRequestExceptionJson(
+                    errorJson(ErrorCode.unsupported_credential_type, cause), headers);
+        }
+        catch (InvalidCredentialRequestException cause)
+        {
+            // 400 Bad Request + "error":"invalid_credential_request"
+            throw ExceptionUtil.badRequestExceptionJson(
+                    errorJson(ErrorCode.invalid_credential_request, cause), headers);
+        }
+        catch (WebApplicationException cause)
+        {
+            throw cause;
+        }
+        catch (Exception cause)
+        {
+            // 500 Internal Server Error + "error":"server_error"
+            throw ExceptionUtil.internalServerErrorExceptionJson(
+                    errorJson(ErrorCode.server_error, cause), headers);
+        }
+    }
+
+
+    /**
+     * Prepare credential issuance orders. The method is supposed to be called
+     * from the implementation of the batch credential endpoint.
+     *
+     * @param introspection
+     *         The response from the {@code /auth/introspection} API.
+     *
+     * @param infos
+     *         The list of credential requests.
+     *
+     * @param headers
+     *         The additional headers that should be included in the response
+     *         from this endpoint.
+     *
+     * @return
+     *         The list of credential issuance orders.
+     */
+    protected CredentialIssuanceOrder[] prepareOrders(
+            IntrospectionResponse introspection, CredentialRequestInfo[] infos,
+            Map<String, Object> headers)
+    {
+        // Convert the array of CredentialRequestInfo instances
+        // into an array of CredentialIssuanceOrder instances.
+        return Arrays.stream(infos)
+                .map(info -> prepareOrder(OrderContext.BATCH, introspection, info, headers))
+                .collect(Collectors.toList())
+                .toArray(new CredentialIssuanceOrder[infos.length]);
+    }
+
+
+    private OrderFormat getOrderFormat(CredentialRequestInfo info) throws UnsupportedCredentialFormatException
+    {
+        // Get an OrderFormat instance that corresponds to the credential format.
+        OrderFormat format = OrderFormat.byId(info.getFormat());
+
+        // If the format is not supported.
+        if (format == null)
+        {
+            throw new UnsupportedCredentialFormatException(String.format(
+                    "The credential format '%s' is not supported.", info.getFormat()));
+        }
+
+        return format;
+    }
 
-            case UNAUTHORIZED:
-                throw ExceptionUtil.unauthorizedException(accessToken, content);
 
-            case FORBIDDEN:
-                throw ExceptionUtil.forbiddenException(content);
+    protected String errorJson(ErrorCode errorCode, Throwable cause)
+    {
+        Map<String, Object> map = new LinkedHashMap<>();
 
-            case OK:
-                return response;
+        // "error"
+        map.put("error", errorCode.name());
 
-            case INTERNAL_SERVER_ERROR:
-            default:
-                throw ExceptionUtil.internalServerErrorException(content);
+        if (cause != null)
+        {
+            // "error_description"
+            map.put("error_description", cause.getMessage());
         }
+
+        // The content of the error response.
+        return new GsonBuilder().setPrettyPrinting().create().toJson(map);
     }
 }