[typescript-axios] Add detection for AWS IAM from schema #21356
+1,967
−15
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| generatorName: typescript-axios | ||
| outputDir: samples/client/petstore/typescript-axios/builds/with-aws-iam | ||
| inputSpec: modules/openapi-generator/src/test/resources/3_0/typescript-axios/with-aws-iam.yaml | ||
| templateDir: modules/openapi-generator/src/main/resources/typescript-axios | ||
| additionalProperties: | ||
| npmVersion: 1.0.0 | ||
| npmName: '@openapitools/typescript-axios-with-aws-iam' | ||
| npmRepository: https://skimdb.npmjs.com/registry | ||
| supportsES6: true | ||
| withNodeImports: true | ||
| withSeparateModelsAndApi: true | ||
| apiPackage: client | ||
| modelPackage: models | ||
| enumPropertyNaming: UPPERCASE | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,10 +17,12 @@ | |
|
|
||
| package org.openapitools.codegen.languages; | ||
|
|
||
| import java.io.File; | ||
| import java.util.List; | ||
| import java.util.Locale; | ||
| import java.util.Map; | ||
| import java.util.TreeSet; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.openapitools.codegen.*; | ||
| import org.openapitools.codegen.meta.features.DocumentationFeature; | ||
|
|
@@ -30,12 +32,15 @@ | |
| import org.openapitools.codegen.model.OperationMap; | ||
| import org.openapitools.codegen.model.OperationsMap; | ||
| import org.openapitools.codegen.utils.ModelUtils; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import io.swagger.v3.oas.models.OpenAPI; | ||
| import io.swagger.v3.oas.models.media.Schema; | ||
| import io.swagger.v3.oas.models.security.SecurityScheme; | ||
| import io.swagger.v3.parser.util.SchemaTypeUtil; | ||
| import lombok.Getter; | ||
| import lombok.Setter; | ||
|
|
||
| public class TypeScriptAxiosClientCodegen extends AbstractTypeScriptClientCodegen { | ||
|
|
||
|
|
@@ -53,6 +58,8 @@ public class TypeScriptAxiosClientCodegen extends AbstractTypeScriptClientCodege | |
| public static final String AXIOS_VERSION = "axiosVersion"; | ||
| public static final String DEFAULT_AXIOS_VERSION = "^1.6.1"; | ||
|
|
||
| private final Logger LOGGER = LoggerFactory.getLogger(TypeScriptAxiosClientCodegen.class); | ||
|
|
||
| @Getter @Setter | ||
| protected String npmRepository = null; | ||
| protected Boolean stringEnums = false; | ||
|
|
@@ -121,6 +128,76 @@ private static String getRelativeToRoot(String path) { | |
| return sb.toString(); | ||
| } | ||
|
|
||
| @Override | ||
| public void preprocessOpenAPI(OpenAPI openAPI) { | ||
|
There was a problem hiding this comment. i would suggest to move it to the core, since its not typescript-specific, right? There was a problem hiding this comment. @macjohnny Thanks for your review! It isn't used in the templates yet, I was saving that for a Part 2 in an effort to keep the PR small and to collect feedback early. However, in By moving to "core" do you mean modifying the There was a problem hiding this comment. agreed with johnny suggestion to move it to the "core" : https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java#L5623-L5718 also agreed with your reply to do it in another PR instead to keep this PR small for easier review |
||
| super.preprocessOpenAPI(openAPI); | ||
|
|
||
| boolean hasAwsV4Signature = detectAwsV4Signature(openAPI); | ||
| additionalProperties.put("withAWSV4Signature", hasAwsV4Signature); | ||
| } | ||
|
|
||
| /** | ||
| * Detects if the OpenAPI specification uses AWS V4 signature authentication | ||
| * by checking for common patterns used in AWS API Gateway specifications. | ||
| */ | ||
| private boolean detectAwsV4Signature(OpenAPI openAPI) { | ||
| // Check security schemes for AWS V4 signature patterns | ||
| if (openAPI.getComponents() != null && openAPI.getComponents().getSecuritySchemes() != null) { | ||
| return openAPI.getComponents().getSecuritySchemes().entrySet().stream() | ||
| .anyMatch(entry -> isAwsV4SecurityScheme(entry.getKey(), entry.getValue(), openAPI)); | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * Determines if a security scheme represents AWS V4 signature authentication | ||
| */ | ||
| private boolean isAwsV4SecurityScheme(String schemeName, SecurityScheme scheme, OpenAPI openAPI) { | ||
| if (scheme == null) { | ||
| return false; | ||
| } | ||
|
|
||
| // Pattern 1: Check for AWS-specific extension | ||
| if (scheme.getExtensions() != null) { | ||
| Object authType = scheme.getExtensions().get("x-amazon-apigateway-authtype"); | ||
| if ("awsSigv4".equals(authType)) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| // Pattern 2: Check for common AWS V4 signature scheme names | ||
| String lowerSchemeName = schemeName.toLowerCase(Locale.ROOT); | ||
| if (lowerSchemeName.contains("sigv4") || | ||
| lowerSchemeName.contains("aws") || | ||
| lowerSchemeName.contains("iam")) { | ||
|
|
||
| // Additional validation: should be apiKey type with Authorization header | ||
| if (SecurityScheme.Type.APIKEY.equals(scheme.getType()) && | ||
| "Authorization".equalsIgnoreCase(scheme.getName()) && | ||
| SecurityScheme.In.HEADER.equals(scheme.getIn())) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| // Pattern 3: Check for AWS API Gateway URL patterns in servers | ||
| if (openAPI.getServers() != null) { | ||
| boolean hasAwsApiGatewayUrl = openAPI.getServers().stream() | ||
| .anyMatch(server -> server.getUrl() != null && | ||
| (server.getUrl().contains("execute-api") && server.getUrl().contains("amazonaws.com"))); | ||
|
|
||
| // If we have AWS API Gateway URL and an Authorization header scheme, likely AWS V4 | ||
| if (hasAwsApiGatewayUrl && | ||
| SecurityScheme.Type.APIKEY.equals(scheme.getType()) && | ||
| "Authorization".equalsIgnoreCase(scheme.getName()) && | ||
| SecurityScheme.In.HEADER.equals(scheme.getIn())) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public void processOpts() { | ||
| super.processOpts(); | ||
|
|
@@ -182,7 +259,6 @@ public void processOpts() { | |
| setAxiosVersion(additionalProperties.get(AXIOS_VERSION).toString()); | ||
| } | ||
| additionalProperties.put("axiosVersion", getAxiosVersion()); | ||
| } | ||
|
|
||
| @Override | ||
|
|
@@ -363,4 +439,22 @@ protected void addImport(Schema composed, Schema childSchema, CodegenModel model | |
| // import everything (including child schema of a composed schema) | ||
| addImport(model, modelName); | ||
| } | ||
|
|
||
| @Override | ||
| public List<CodegenSecurity> fromSecurity(Map<String, SecurityScheme> securitySchemeMap) { | ||
| List<CodegenSecurity> securities = super.fromSecurity(securitySchemeMap); | ||
|
|
||
| // Post-process security schemes to detect AWS V4 signature | ||
| for (CodegenSecurity security : securities) { | ||
| if (securitySchemeMap.containsKey(security.name)) { | ||
| SecurityScheme scheme = securitySchemeMap.get(security.name); | ||
| if (isAwsV4SecurityScheme(security.name, scheme, this.openAPI)) { | ||
| security.isAWSV4Signature = true; | ||
| LOGGER.info("Detected AWS V4 signature security scheme: {}", security.name); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return securities; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is my setup, but let me know if you think I should add a specific combination