Add a new type of filter to validate API Keys

Signed-off-by: Kévin Lambert <[email protected]>
datawire · Jul 21, 2022 · ddb2e3d · ddb2e3d
1 parent dc3bb5a
commit ddb2e3d
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -129,6 +129,9 @@ Note: Other
   cause the browser to reject the request. This has now been fixed and these endpoints will attach
   the appropriate CORS headers to the response.
 
+- Feature: You can now define a new type of filter to enforce API Keys on top of your services, and provide a
+  Kubernetes secrets as a source for the list of all the keys.
+
 ## [3.0.0] 2022-06-29
 [3.0.0]: https://github.com/datawire/edge-stack/releases/v3.0.0
 

diff --git a/docs/releaseNotes.yml b/docs/releaseNotes.yml
@@ -97,6 +97,12 @@ items:
           and <code>/.ambassador/oauth2/multicookie</code> did not understand CORS or CORS preflight request
           which would cause the browser to reject the request. This has now been fixed and these endpoints will
           attach the appropriate CORS headers to the response.
+      - title: Add a new API Key filter
+        type: feature
+        body: >-
+          You can now define a new type of filter to enforce API Keys on top of your services,
+          and provide a Kubernetes secrets as a source for the list of all the keys.
+
   - version: 3.0.0
     date: '2022-06-29'
     notes:

diff --git a/manifests/edge-stack/aes-crds.yaml b/manifests/edge-stack/aes-crds.yaml
@@ -286,6 +286,27 @@ spec:
             type: object
           spec:
             properties:
+              APIKey:
+                description: FilterAPIKey enforce a set of API Keys.
+                properties:
+                  httpHeader:
+                    type: string
+                  keys:
+                    items:
+                      description: APIKeyItem defines an API Key, and the secrets
+                        it is based on.
+                      properties:
+                        secretName:
+                          type: string
+                        secretNamespace:
+                          type: string
+                        value:
+                          type: string
+                      type: object
+                    type: array
+                required:
+                - keys
+                type: object
               External:
                 description: FilterExternal closely mimics AuthService.getambassador.io.
                 properties:
@@ -589,6 +610,27 @@ spec:
             type: object
           spec:
             properties:
+              APIKey:
+                description: FilterAPIKey enforce a set of API Keys.
+                properties:
+                  httpHeader:
+                    type: string
+                  keys:
+                    items:
+                      description: APIKeyItem defines an API Key, and the secrets
+                        it is based on.
+                      properties:
+                        secretName:
+                          type: string
+                        secretNamespace:
+                          type: string
+                        value:
+                          type: string
+                      type: object
+                    type: array
+                required:
+                - keys
+                type: object
               External:
                 description: FilterExternal closely mimics AuthService.getambassador.io.
                 properties:
@@ -897,6 +939,27 @@ spec:
             type: object
           spec:
             properties:
+              APIKey:
+                description: FilterAPIKey enforce a set of API Keys.
+                properties:
+                  httpHeader:
+                    type: string
+                  keys:
+                    items:
+                      description: APIKeyItem defines an API Key, and the secrets
+                        it is based on.
+                      properties:
+                        secretName:
+                          type: string
+                        secretNamespace:
+                          type: string
+                        value:
+                          type: string
+                      type: object
+                    type: array
+                required:
+                - keys
+                type: object
               External:
                 description: FilterExternal closely mimics AuthService.getambassador.io.
                 properties: