feat: Optionally override Oauth Cookie Names #3274
There are no files selected for viewing
This file contains 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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -30,6 +30,12 @@ type OIDC struct { | |||||
| // +kubebuilder:validation:Required | ||||||
| ClientSecret gwapiv1b1.SecretObjectReference `json:"clientSecret"` | ||||||
|
|
||||||
| // The optional cookie name overrides to be used for Bearer and IdToken cookies in the | ||||||
| // [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). | ||||||
| // If not specified, uses a randomly generated suffix | ||||||
| // +optional | ||||||
| CookieNames *OIDCCookieNames `json:"cookieNames,omitempty"` | ||||||
|
|
||||||
| // The OIDC scopes to be used in the | ||||||
| // [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). | ||||||
| // The "openid" scope is always added to the list of scopes if not already | ||||||
|
|
@@ -75,3 +81,17 @@ type OIDCProvider struct { | |||||
| // +optional | ||||||
| TokenEndpoint *string `json:"tokenEndpoint,omitempty"` | ||||||
| } | ||||||
|
|
||||||
| // OIDCCookieNames defines the names of cookies to use in the Envoy OIDC filter. | ||||||
| type OIDCCookieNames struct { | ||||||
| // The name of the cookie used to store the BearerToken in the | ||||||
| // [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). | ||||||
| // If not specified, defaults to "BearerToken-(randomly generated uid)" | ||||||
| // +optional | ||||||
| BearerToken *string `json:"bearerToken,omitempty"` | ||||||
|
There was a problem hiding this comment. The name
Suggested change
|
||||||
| // The name of the cookie used to store the IdToken in the | ||||||
| // [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest). | ||||||
| // If not specified, defaults to "IdToken-(randomly generated uid)" | ||||||
| // +optional | ||||||
| IDToken *string `json:"idToken,omitempty"` | ||||||
| } | ||||||
This file contains 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 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 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,66 @@ | ||
| secrets: | ||
| - apiVersion: v1 | ||
| kind: Secret | ||
| metadata: | ||
| namespace: envoy-gateway | ||
| name: client1-secret | ||
| data: | ||
| client-secret: Y2xpZW50MTpzZWNyZXQK | ||
| gateways: | ||
| - apiVersion: gateway.networking.k8s.io/v1 | ||
| kind: Gateway | ||
| metadata: | ||
| namespace: envoy-gateway | ||
| name: gateway-1 | ||
| spec: | ||
| gatewayClassName: envoy-gateway-class | ||
| listeners: | ||
| - name: http | ||
| protocol: HTTP | ||
| port: 80 | ||
| allowedRoutes: | ||
| namespaces: | ||
| from: All | ||
| httpRoutes: | ||
| - apiVersion: gateway.networking.k8s.io/v1 | ||
| kind: HTTPRoute | ||
| metadata: | ||
| namespace: default | ||
| name: httproute-1 | ||
| spec: | ||
| hostnames: | ||
| - www.example.com | ||
| parentRefs: | ||
| - namespace: envoy-gateway | ||
| name: gateway-1 | ||
| sectionName: http | ||
| rules: | ||
| - matches: | ||
| - path: | ||
| value: "/foo" | ||
| backendRefs: | ||
| - name: service-1 | ||
| port: 8080 | ||
| securityPolicies: | ||
| - apiVersion: gateway.envoyproxy.io/v1alpha1 | ||
| kind: SecurityPolicy | ||
| metadata: | ||
| namespace: envoy-gateway | ||
| name: policy-for-gateway # This policy should attach httproute-2 | ||
| uid: b8284d0f-de82-4c65-b204-96a0d3f258a1 | ||
| spec: | ||
| targetRef: | ||
| group: gateway.networking.k8s.io | ||
| kind: Gateway | ||
| name: gateway-1 | ||
| oidc: | ||
| provider: | ||
| issuer: "https://accounts.google.com" | ||
| clientID: "client1.apps.googleusercontent.com" | ||
| clientSecret: | ||
| name: "client1-secret" | ||
| redirectURL: "https://www.example.com/bar/oauth2/callback" | ||
| logoutPath: "/bar/logout" | ||
| cookieNames: | ||
| idToken: "CustomIdTokenCookie" | ||
| bearerToken: "CustomBearerTokenCookie" |
This file contains 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,169 @@ | ||
| gateways: | ||
| - apiVersion: gateway.networking.k8s.io/v1 | ||
| kind: Gateway | ||
| metadata: | ||
| creationTimestamp: null | ||
| name: gateway-1 | ||
| namespace: envoy-gateway | ||
| spec: | ||
| gatewayClassName: envoy-gateway-class | ||
| listeners: | ||
| - allowedRoutes: | ||
| namespaces: | ||
| from: All | ||
| name: http | ||
| port: 80 | ||
| protocol: HTTP | ||
| status: | ||
| listeners: | ||
| - attachedRoutes: 1 | ||
| conditions: | ||
| - lastTransitionTime: null | ||
| message: Sending translated listener configuration to the data plane | ||
| reason: Programmed | ||
| status: "True" | ||
| type: Programmed | ||
| - lastTransitionTime: null | ||
| message: Listener has been successfully translated | ||
| reason: Accepted | ||
| status: "True" | ||
| type: Accepted | ||
| - lastTransitionTime: null | ||
| message: Listener references have been resolved | ||
| reason: ResolvedRefs | ||
| status: "True" | ||
| type: ResolvedRefs | ||
| name: http | ||
| supportedKinds: | ||
| - group: gateway.networking.k8s.io | ||
| kind: HTTPRoute | ||
| - group: gateway.networking.k8s.io | ||
| kind: GRPCRoute | ||
| httpRoutes: | ||
| - apiVersion: gateway.networking.k8s.io/v1 | ||
| kind: HTTPRoute | ||
| metadata: | ||
| creationTimestamp: null | ||
| name: httproute-1 | ||
| namespace: default | ||
| spec: | ||
| hostnames: | ||
| - www.example.com | ||
| parentRefs: | ||
| - name: gateway-1 | ||
| namespace: envoy-gateway | ||
| sectionName: http | ||
| rules: | ||
| - backendRefs: | ||
| - name: service-1 | ||
| port: 8080 | ||
| matches: | ||
| - path: | ||
| value: /foo | ||
| status: | ||
| parents: | ||
| - conditions: | ||
| - lastTransitionTime: null | ||
| message: Route is accepted | ||
| reason: Accepted | ||
| status: "True" | ||
| type: Accepted | ||
| - lastTransitionTime: null | ||
| message: Resolved all the Object references for the Route | ||
| reason: ResolvedRefs | ||
| status: "True" | ||
| type: ResolvedRefs | ||
| controllerName: gateway.envoyproxy.io/gatewayclass-controller | ||
| parentRef: | ||
| name: gateway-1 | ||
| namespace: envoy-gateway | ||
| sectionName: http | ||
| infraIR: | ||
| envoy-gateway/gateway-1: | ||
| proxy: | ||
| listeners: | ||
| - address: null | ||
| name: envoy-gateway/gateway-1/http | ||
| ports: | ||
| - containerPort: 10080 | ||
| name: http-80 | ||
| protocol: HTTP | ||
| servicePort: 80 | ||
| metadata: | ||
| labels: | ||
| gateway.envoyproxy.io/owning-gateway-name: gateway-1 | ||
| gateway.envoyproxy.io/owning-gateway-namespace: envoy-gateway | ||
| name: envoy-gateway/gateway-1 | ||
| securityPolicies: | ||
| - apiVersion: gateway.envoyproxy.io/v1alpha1 | ||
| kind: SecurityPolicy | ||
| metadata: | ||
| creationTimestamp: null | ||
| name: policy-for-gateway | ||
| namespace: envoy-gateway | ||
| uid: b8284d0f-de82-4c65-b204-96a0d3f258a1 | ||
| spec: | ||
| oidc: | ||
| clientID: client1.apps.googleusercontent.com | ||
| clientSecret: | ||
| group: null | ||
| kind: null | ||
| name: client1-secret | ||
| cookieNames: | ||
| bearerToken: CustomBearerTokenCookie | ||
| idToken: CustomIdTokenCookie | ||
| logoutPath: /bar/logout | ||
| provider: | ||
| issuer: https://accounts.google.com | ||
| redirectURL: https://www.example.com/bar/oauth2/callback | ||
| targetRef: | ||
| group: gateway.networking.k8s.io | ||
| kind: Gateway | ||
| name: gateway-1 | ||
| status: | ||
| ancestors: | ||
| - ancestorRef: | ||
| group: gateway.networking.k8s.io | ||
| kind: Gateway | ||
| name: gateway-1 | ||
| namespace: envoy-gateway | ||
| conditions: | ||
| - lastTransitionTime: null | ||
| message: HMAC secret envoy-gateway-system/envoy-oidc-hmac not found | ||
|
There was a problem hiding this comment. something is off, |
||
| reason: Invalid | ||
| status: "False" | ||
| type: Accepted | ||
| controllerName: gateway.envoyproxy.io/gatewayclass-controller | ||
| xdsIR: | ||
| envoy-gateway/gateway-1: | ||
| accessLog: | ||
| text: | ||
| - path: /dev/stdout | ||
| http: | ||
| - address: 0.0.0.0 | ||
| hostnames: | ||
| - '*' | ||
| isHTTP2: false | ||
| name: envoy-gateway/gateway-1/http | ||
| path: | ||
| escapedSlashesAction: UnescapeAndRedirect | ||
| mergeSlashes: true | ||
| port: 10080 | ||
| routes: | ||
| - destination: | ||
| name: httproute/default/httproute-1/rule/0 | ||
| settings: | ||
| - addressType: IP | ||
| endpoints: | ||
| - host: 7.7.7.7 | ||
| port: 8080 | ||
| protocol: HTTP | ||
| weight: 1 | ||
| hostname: www.example.com | ||
| isHTTP2: false | ||
| name: httproute/default/httproute-1/rule/0/match/0/www_example_com | ||
| pathMatch: | ||
| distinct: false | ||
| name: "" | ||
| prefix: /foo | ||
| security: {} | ||
This file contains 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.
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.
or even
idTokenName