Merge pull request #3603 from mevan-karu/api_key_impl

Add temporary API Key authenticator impl
wso2 · Oct 21, 2024 · 8504e88 · 8504e88
2 parents c7f4486 + 4d464c5
commit 8504e88
Show file tree

Hide file tree

Showing 15 changed files with 357 additions and 29 deletions.
diff --git a/adapter/config/default_config.go b/adapter/config/default_config.go
@@ -228,7 +228,8 @@ var defaultConfig = &Config{
 				DropConsoleTestHeaders:     true,
 			},
 			APIKeyConfig: apiKeyConfig{
-				OAuthAgentURL: "https://localhost:9443",
+				InternalAPIKeyHeader: "Choreo-API-Key",
+				OAuthAgentURL:        "https://localhost:9443",
 			},
 			PATConfig: patConfig{
 				TokenExpiryTimeSkew: 1,

diff --git a/adapter/config/types.go b/adapter/config/types.go
@@ -500,7 +500,8 @@ type authHeader struct {
 }
 
 type apiKeyConfig struct {
-	OAuthAgentURL string `toml:"oauthAgentURL"`
+	InternalAPIKeyHeader string `toml:"internalAPIKeyHeader"`
+	OAuthAgentURL        string `toml:"oauthAgentURL"`
 }
 
 type patConfig struct {

diff --git a/adapter/internal/discovery/xds/marshaller.go b/adapter/internal/discovery/xds/marshaller.go
@@ -219,7 +219,8 @@ func MarshalConfig(config *config.Config) *enforcer.Config {
 				DropConsoleTestHeaders:     config.Enforcer.Security.AuthHeader.DropConsoleTestHeaders,
 			},
 			ApiKeyConfig: &enforcer.APIKeyConfig{
-				OauthAgentURL: config.Enforcer.Security.APIKeyConfig.OAuthAgentURL,
+				InternalAPIKeyHeader: config.Enforcer.Security.APIKeyConfig.InternalAPIKeyHeader,
+				OauthAgentURL:        config.Enforcer.Security.APIKeyConfig.OAuthAgentURL,
 			},
 			PatConfig: &enforcer.PATConfig{
 				TokenExpiryTimeSkew: config.Enforcer.Security.PATConfig.TokenExpiryTimeSkew,

diff --git a/adapter/pkg/discovery/api/wso2/discovery/config/enforcer/api_key_config.pb.go b/adapter/pkg/discovery/api/wso2/discovery/config/enforcer/api_key_config.pb.go
diff --git a/api/proto/wso2/discovery/config/enforcer/api_key_config.proto b/api/proto/wso2/discovery/config/enforcer/api_key_config.proto
@@ -9,4 +9,5 @@ option java_multiple_files = true;
 
 message APIKeyConfig {
     string oauthAgentURL = 1;
+    string internalAPIKeyHeader = 2;
 }
diff --git a/...enforcer/src/main/gen/org/wso2/choreo/connect/discovery/config/enforcer/APIKeyConfig.java b/...enforcer/src/main/gen/org/wso2/choreo/connect/discovery/config/enforcer/APIKeyConfig.java
diff --git a/...src/main/gen/org/wso2/choreo/connect/discovery/config/enforcer/APIKeyConfigOrBuilder.java b/...src/main/gen/org/wso2/choreo/connect/discovery/config/enforcer/APIKeyConfigOrBuilder.java
diff --git a/...cer/src/main/gen/org/wso2/choreo/connect/discovery/config/enforcer/APIKeyConfigProto.java b/...cer/src/main/gen/org/wso2/choreo/connect/discovery/config/enforcer/APIKeyConfigProto.java
diff --git a/...r-parent/enforcer/src/main/java/org/wso2/choreo/connect/enforcer/config/ConfigHolder.java b/...r-parent/enforcer/src/main/java/org/wso2/choreo/connect/enforcer/config/ConfigHolder.java
@@ -224,6 +224,7 @@ private void populateAuthHeaderConfigurations(AuthHeader authHeader) {
 
     private void populateAPIKeyConfigs(APIKeyConfig apiKeyConfig) {
         APIKeyDTO apiKeyDTO = new APIKeyDTO();
+        apiKeyDTO.setApiKeyInternalHeader(apiKeyConfig.getInternalAPIKeyHeader());
         apiKeyDTO.setOauthAgentURL(apiKeyConfig.getOauthAgentURL());
         config.setApiKeyConfig(apiKeyDTO);
     }

diff --git a/...-parent/enforcer/src/main/java/org/wso2/choreo/connect/enforcer/config/dto/APIKeyDTO.java b/...-parent/enforcer/src/main/java/org/wso2/choreo/connect/enforcer/config/dto/APIKeyDTO.java
@@ -23,8 +23,17 @@
  */
 public class APIKeyDTO {
 
+    private String apiKeyInternalHeader;
     private String oauthAgentURL;
 
+    public String getApiKeyInternalHeader() {
+        return apiKeyInternalHeader;
+    }
+
+    public void setApiKeyInternalHeader(String apiKeyInternalHeader) {
+        this.apiKeyInternalHeader = apiKeyInternalHeader;
+    }
+
     public String getOauthAgentURL() {
         return oauthAgentURL;
     }

diff --git a/...arent/enforcer/src/main/java/org/wso2/choreo/connect/enforcer/constants/APIConstants.java b/...arent/enforcer/src/main/java/org/wso2/choreo/connect/enforcer/constants/APIConstants.java
@@ -48,6 +48,7 @@ public class APIConstants {
     public static final String API_SECURITY_MUTUAL_SSL = "mutualssl";
     public static final String API_SECURITY_BASIC_AUTH = "basic_auth";
     public static final String SWAGGER_API_KEY_AUTH_TYPE_NAME = "apiKey";
+    public static final String API_SECURITY_CHOREO_API_KEY = "api_key";
     public static final String SWAGGER_API_KEY_IN_HEADER = "header";
     public static final String SWAGGER_API_KEY_IN_QUERY = "query";
     public static final String API_SECURITY_MUTUAL_SSL_MANDATORY = "mutualssl_mandatory";