Java playframework: add support for oauth2 accesstoken validation

bin/configs/java-play-framework-fake-endpoints-with-security.yaml

@@ -0,0 +1,6 @@
+generatorName: java-play-framework
+outputDir: samples/server/petstore/java-play-framework-fake-endpoints-with-security
+inputSpec: modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-for-testing-playframework-with-security.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaPlayFramework
+additionalProperties:
+  hideGenerationTimestamp: "true"

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaPlayFrameworkCodegen.java

@@ -18,18 +18,18 @@
 package org.openapitools.codegen.languages;
 
 import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.security.SecurityScheme;
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.languages.features.BeanValidationFeatures;
 import org.openapitools.codegen.meta.features.DocumentationFeature;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.File;
-import java.util.List;
-import java.util.Locale;
-import java.util.Map;
+import java.util.*;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import java.util.stream.Collectors;
 
 import static org.openapitools.codegen.utils.StringUtils.camelize;
 
@@ -45,6 +45,10 @@ public class JavaPlayFrameworkCodegen extends AbstractJavaCodegen implements Bea
     public static final String USE_SWAGGER_UI = "useSwaggerUI";
     public static final String SUPPORT_ASYNC = "supportAsync";
 
+    private static final String X_JWKS_URL = "x-jwksUrl";
+    private static final String X_TOKEN_INTROSPECT_URL = "x-tokenIntrospectUrl";
+
+
     protected String title = "openapi-java-playframework";
     protected String configPackage = "org.openapitools.configuration";
     protected String basePackage = "org.openapitools";
@@ -197,6 +201,7 @@ public void processOpts() {
             supportingFiles.add(new SupportingFile("module.mustache", "app", "Module.java"));
         }
         supportingFiles.add(new SupportingFile("openapiUtils.mustache", "app/openapitools", "OpenAPIUtils.java"));
+        supportingFiles.add(new SupportingFile("securityApiUtils.mustache", "app/openapitools", "SecurityAPIUtils.java"));
         if (this.handleExceptions) {
             supportingFiles.add(new SupportingFile("errorHandler.mustache", "app/openapitools", "ErrorHandler.java"));
         }
@@ -376,4 +381,98 @@ public Map<String, Object> postProcessSupportingFileData(Map<String, Object> obj
         generateJSONSpecFile(objs);
         return super.postProcessSupportingFileData(objs);
     }
+
+    @Override
+    public List<CodegenSecurity> fromSecurity(Map<String, SecurityScheme> securitySchemeMap) {
+        List<? extends CodegenSecurity> securities = super.fromSecurity(securitySchemeMap);
+        List<CodegenSecurity> extendedSecurities = new ArrayList<>();
+
+        for (CodegenSecurity codegenSecurity : securities) {
+            ExtendedCodegenSecurity extendedCodegenSecurity = new ExtendedCodegenSecurity(codegenSecurity);
+            Object jwksUrl = extendedCodegenSecurity.vendorExtensions.get(X_JWKS_URL);
+
+            if (jwksUrl instanceof String) {
+                extendedCodegenSecurity.jwksUrl = (String) jwksUrl;
+            }
+
+            Object tokenIntrospectUrl = extendedCodegenSecurity.vendorExtensions.get(X_TOKEN_INTROSPECT_URL);
+
+            if (tokenIntrospectUrl instanceof String) {
+                extendedCodegenSecurity.tokenIntrospectUrl = (String) tokenIntrospectUrl;
+            }
+            extendedSecurities.add(extendedCodegenSecurity);
+        }
+
+        return extendedSecurities;
+    }
+
+
+    class ExtendedCodegenSecurity extends CodegenSecurity {
+        public String jwksUrl;
+        public String tokenIntrospectUrl;
+
+        public ExtendedCodegenSecurity(CodegenSecurity cm) {
+            super();
+
+            this.name = cm.name;
+            this.type = cm.type;
+            this.scheme = cm.scheme;
+            this.isBasic = cm.isBasic;
+            this.isOAuth = cm.isOAuth;
+            this.isApiKey = cm.isApiKey;
+            this.isBasicBasic = cm.isBasicBasic;
+            this.isBasicBearer = cm.isBasicBearer;
+            this.isHttpSignature = cm.isHttpSignature;
+            this.bearerFormat = cm.bearerFormat;
+            this.vendorExtensions = new HashMap<String, Object>(cm.vendorExtensions);
+            this.keyParamName = cm.keyParamName;
+            this.isKeyInQuery = cm.isKeyInQuery;
+            this.isKeyInHeader = cm.isKeyInHeader;
+            this.isKeyInCookie = cm.isKeyInCookie;
+            this.flow = cm.flow;
+            this.authorizationUrl = cm.authorizationUrl;
+            this.tokenUrl = cm.tokenUrl;
+            this.refreshUrl = cm.refreshUrl;
+            this.scopes = cm.scopes;
+            this.isCode = cm.isCode;
+            this.isPassword = cm.isPassword;
+            this.isApplication = cm.isApplication;
+            this.isImplicit = cm.isImplicit;
+        }
+
+        @Override
+        public CodegenSecurity filterByScopeNames(List<String> filterScopes) {
+            CodegenSecurity codegenSecurity = super.filterByScopeNames(filterScopes);
+            ExtendedCodegenSecurity extendedCodegenSecurity =  new ExtendedCodegenSecurity(codegenSecurity);
+            extendedCodegenSecurity.jwksUrl = this.jwksUrl;
+            extendedCodegenSecurity.tokenIntrospectUrl = this.tokenIntrospectUrl;
+            return extendedCodegenSecurity;
+        }
+
+        @Override
+        public boolean equals(Object o) {
+            boolean result = super.equals(o);
+            JavaPlayFrameworkCodegen.ExtendedCodegenSecurity that = (JavaPlayFrameworkCodegen.ExtendedCodegenSecurity) o;
+            return result &&
+                    Objects.equals(jwksUrl, that.jwksUrl) &&
+                    Objects.equals(tokenIntrospectUrl, that.tokenIntrospectUrl);
+
+        }
+
+        @Override
+        public int hashCode() {
+            int superHash = super.hashCode();
+            return Objects.hash(superHash, tokenIntrospectUrl, jwksUrl);
+        }
+
+        @Override
+        public String toString() {
+            String superString = super.toString();
+            final StringBuilder sb = new StringBuilder(superString);
+            sb.append(", jwksUrl='").append(jwksUrl).append('\'');
+            sb.append(", tokenIntrospectUrl='").append(tokenIntrospectUrl).append('\'');
+            return sb.toString();
+        }
+
+    }
 }

modules/openapi-generator/src/main/resources/JavaPlayFramework/build.mustache

@@ -13,3 +13,6 @@ libraryDependencies += "org.webjars" % "swagger-ui" % "3.32.5"
 libraryDependencies += "javax.validation" % "validation-api" % "2.0.1.Final"
 {{/useBeanValidation}}
 libraryDependencies += guice
+libraryDependencies += "com.auth0" % "java-jwt" % "3.18.1"
+libraryDependencies += "com.auth0" % "jwks-rsa" % "0.19.0"
+libraryDependencies += "org.apache.httpcomponents" % "httpclient" % "4.5.6"

modules/openapi-generator/src/main/resources/JavaPlayFramework/module.mustache

@@ -1,6 +1,7 @@
 import com.google.inject.AbstractModule;
 
 import {{apiPackage}}.*;
+import openapitools.SecurityAPIUtils;
 
 public class Module extends AbstractModule {
 
@@ -11,5 +12,6 @@ public class Module extends AbstractModule {
         bind({{classname}}ControllerImpInterface.class).to({{classname}}ControllerImp.class);
         {{/apis}}
         {{/apiInfo}}
+        bind(SecurityAPIUtils.class);
     }
 }

modules/openapi-generator/src/main/resources/JavaPlayFramework/newApiController.mustache

@@ -20,6 +20,9 @@ import play.libs.Files.TemporaryFile;
 import java.io.IOException;
 {{/handleExceptions}}
 import openapitools.OpenAPIUtils;
+{{^useInterfaces}}
+import openapitools.SecurityAPIUtils;
+{{/useInterfaces}}
 import com.fasterxml.jackson.core.type.TypeReference;
 {{#supportAsync}}
 
@@ -46,16 +49,22 @@ public class {{classname}}Controller extends Controller {
     {{#useBeanValidation}}
     private final Config configuration;
     {{/useBeanValidation}}
+{{^useInterfaces}}
+    private final SecurityAPIUtils securityAPIUtils;
+{{/useInterfaces}}
 
     @Inject
-    private {{classname}}Controller({{#useBeanValidation}}Config configuration{{^controllerOnly}}, {{/controllerOnly}}{{/useBeanValidation}}{{^controllerOnly}}{{classname}}ControllerImp{{#useInterfaces}}Interface{{/useInterfaces}} imp{{/controllerOnly}}) {
+    private {{classname}}Controller({{#useBeanValidation}}Config configuration{{^controllerOnly}}, {{/controllerOnly}}{{/useBeanValidation}}{{^controllerOnly}}{{classname}}ControllerImp{{#useInterfaces}}Interface{{/useInterfaces}} imp{{/controllerOnly}}{{^useInterfaces}}, SecurityAPIUtils securityAPIUtils{{/useInterfaces}}) {
         {{^controllerOnly}}
         this.imp = imp;
         {{/controllerOnly}}
         mapper = new ObjectMapper();
         {{#useBeanValidation}}
         this.configuration = configuration;
         {{/useBeanValidation}}
+{{^useInterfaces}}
+        this.securityAPIUtils = securityAPIUtils;
+{{/useInterfaces}}
     }
 
 {{#operation}}

modules/openapi-generator/src/main/resources/JavaPlayFramework/newApiInterface.mustache

@@ -14,7 +14,9 @@ import play.mvc.Result;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.JsonNode;
 import openapitools.OpenAPIUtils;
+import openapitools.SecurityAPIUtils;
 import static play.mvc.Results.ok;
+import static play.mvc.Results.unauthorized;
 import play.libs.Files.TemporaryFile;
 {{#supportAsync}}
 import java.util.concurrent.CompletionException;
@@ -32,11 +34,12 @@ public abstract class {{classname}}ControllerImpInterface {
     {{#useBeanValidation}}
     @Inject private Config configuration;
     {{/useBeanValidation}}
+    @Inject private SecurityAPIUtils securityAPIUtils;
     private ObjectMapper mapper = new ObjectMapper();
 
 {{#operation}}
     public {{#supportAsync}}CompletionStage<{{/supportAsync}}Result{{#supportAsync}}>{{/supportAsync}} {{operationId}}Http(Http.Request request{{#hasParams}}, {{/hasParams}}{{#allParams}}{{>pathParams}}{{>queryParams}}{{>bodyParams}}{{>formParams}}{{>headerParams}}{{^-last}}, {{/-last}}{{/allParams}}) {{#handleExceptions}}throws Exception{{/handleExceptions}} {
-        {{>responseToResult}}
+{{>responseToResult}}
     }
 
     public abstract {{^returnType}}void{{/returnType}}{{#returnType}}{{#supportAsync}}CompletionStage<{{/supportAsync}}{{>returnTypesNoVoid}}{{#supportAsync}}>{{/supportAsync}}{{/returnType}} {{operationId}}(Http.Request request{{#hasParams}}, {{/hasParams}}{{#allParams}}{{>pathParams}}{{>queryParams}}{{>bodyParams}}{{>formParams}}{{>headerParams}}{{^-last}}, {{/-last}}{{/allParams}}) {{#handleExceptions}}throws Exception{{/handleExceptions}};

modules/openapi-generator/src/main/resources/JavaPlayFramework/responseToResult.mustache

@@ -1,67 +1,60 @@
 {{^controllerOnly}}
+{{#authMethods.0}}
+{{#isOAuth}}
+        if (!securityAPIUtils.isRequestTokenValid(request, "{{name}}")) {
+            return {{#supportAsync}}CompletableFuture.supplyAsync(play.mvc.Results::unauthorized){{/supportAsync}}{{^supportAsync}}unauthorized(){{/supportAsync}};
+        }
+
+{{/isOAuth}}
+{{/authMethods.0}}
 {{^returnType}}
 {{#supportAsync}}
-CompletableFuture<Result> result = CompletableFuture.supplyAsync(() -> {
+        CompletableFuture<Result> result = CompletableFuture.supplyAsync(() -> {
         try {
 {{/supportAsync}}
 {{/returnType}}
-{{#returnType}}{{#supportAsync}}CompletionStage<{{>returnTypesNoVoid}}> stage = {{/supportAsync}}{{^supportAsync}}{{>returnTypesNoVoid}} obj = {{/supportAsync}}{{/returnType}}{{^returnType}}{{#supportAsync}}    {{/supportAsync}}{{/returnType}}{{^useInterfaces}}imp.{{/useInterfaces}}{{operationId}}(request{{#hasParams}}, {{/hasParams}}{{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}}){{#returnType}}{{#supportAsync}}.thenApply(obj -> { {{/supportAsync}}{{/returnType}}{{^supportAsync}};{{/supportAsync}}{{#supportAsync}}{{^returnType}};{{/returnType}}{{/supportAsync}}
+        {{#returnType}}{{#supportAsync}}CompletionStage<{{>returnTypesNoVoid}}> stage = {{/supportAsync}}{{^supportAsync}}{{>returnTypesNoVoid}} obj = {{/supportAsync}}{{/returnType}}{{^returnType}}{{#supportAsync}}    {{/supportAsync}}{{/returnType}}{{^useInterfaces}}imp.{{/useInterfaces}}{{operationId}}(request{{#hasParams}}, {{/hasParams}}{{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}}){{#returnType}}{{#supportAsync}}.thenApply(obj -> { {{/supportAsync}}{{/returnType}}{{^supportAsync}};{{/supportAsync}}{{#supportAsync}}{{^returnType}};{{/returnType}}{{/supportAsync}}
 {{#returnType}}
 {{^isResponseFile}}
 {{^returnTypeIsPrimitive}}
 {{#useBeanValidation}}
-{{^supportAsync}}
-    if (configuration.getBoolean("useOutputBeanValidation")) {
-        {{#isArray}}
-        for ({{{returnType}}} curItem : obj) {
-            OpenAPIUtils.validate(curItem);
-        }
-        {{/isArray}}
-        {{#isMap}}
-        for (Map.Entry<String, {{{returnType}}}> entry : obj.entrySet()) {
-            OpenAPIUtils.validate(entry.getValue());
-        }
-        {{/isMap}}
-        {{^returnContainer}}
+
+        if (configuration.getBoolean("useOutputBeanValidation")) {
+            {{#isArray}}
+            for ({{{returnType}}} curItem : obj) {
+                OpenAPIUtils.validate(curItem);
+            }
+            {{/isArray}}
+            {{#isMap}}
+            for (Map.Entry<String, {{{returnType}}}> entry : obj.entrySet()) {
+                OpenAPIUtils.validate(entry.getValue());
+            }
+            {{/isMap}}
+            {{^returnContainer}}
             OpenAPIUtils.validate(obj);
-        {{/returnContainer}}
-    }
-{{/supportAsync}}
-{{#supportAsync}}
-    if (configuration.getBoolean("useOutputBeanValidation")) {
-        {{#isArray}}
-        for ({{{returnType}}} curItem : obj) {
-            OpenAPIUtils.validate(curItem);
+            {{/returnContainer}}
         }
-        {{/isArray}}
-        {{#isMap}}
-        for (Map.Entry<String, {{{returnType}}}> entry : obj.entrySet()) {
-            OpenAPIUtils.validate(entry.getValue());
-        }
-        {{/isMap}}
-        {{^returnContainer}}
-        OpenAPIUtils.validate(obj);
-        {{/returnContainer}}
-    }
-{{/supportAsync}}
+
 {{/useBeanValidation}}
 {{/returnTypeIsPrimitive}}
 {{/isResponseFile}}
 {{#supportAsync}}
-    return obj;
-});
+        return obj;
+    });
 {{/supportAsync}}
 {{/returnType}}
 {{#returnType}}
 {{#supportAsync}}
 return stage.thenApply(obj -> {
 {{/supportAsync}}
 {{^isResponseFile}}
-{{#supportAsync}}    {{/supportAsync}}JsonNode result = mapper.valueToTree(obj);
-{{#supportAsync}}    {{/supportAsync}}return ok(result);
+{{#supportAsync}}    {{/supportAsync}}        JsonNode result = mapper.valueToTree(obj);
+
+{{#supportAsync}}    {{/supportAsync}}        return ok(result);
 {{/isResponseFile}}
 {{#isResponseFile}}
-{{#supportAsync}}    {{/supportAsync}}return ok(obj);
+
+{{#supportAsync}}    {{/supportAsync}}        return ok(obj);
 {{/isResponseFile}}
 {{/returnType}}
 {{^returnType}}
@@ -74,15 +67,15 @@ return stage.thenApply(obj -> {
     return result;
 {{/supportAsync}}
 {{^supportAsync}}
-return ok();
+        return ok();
 {{/supportAsync}}
 {{/returnType}}
 {{#returnType}}
 {{#supportAsync}}
-});
+    });
 {{/supportAsync}}
 {{/returnType}}
 {{/controllerOnly}}
 {{#controllerOnly}}
-return ok();
+        return ok();
 {{/controllerOnly}}