-
Notifications
You must be signed in to change notification settings - Fork 5.3k
api config: Refactor jwt_auth filter config #3428
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,12 @@ | ||
| load("//bazel:api_build_system.bzl", "api_proto_library") | ||
|
|
||
| licenses(["notice"]) # Apache 2 | ||
|
|
||
| api_proto_library( | ||
| name = "common", | ||
| srcs = ["config.proto"], | ||
| deps = [ | ||
| "//envoy/api/v2/core:base", | ||
| "//envoy/api/v2/core:http_uri", | ||
| ], | ||
| ) |
243 changes: 243 additions & 0 deletions
243
api/envoy/config/filter/http/common/v1alpha/config.proto
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,243 @@ | ||
| syntax = "proto3"; | ||
|
|
||
| package envoy.config.filter.http.common.v1alpha; | ||
|
|
||
| import "envoy/api/v2/core/base.proto"; | ||
| import "envoy/api/v2/core/http_uri.proto"; | ||
| import "google/protobuf/duration.proto"; | ||
| import "validate/validate.proto"; | ||
|
|
||
| // This message specifies how a JSON Web Token (JWT) can be both verified and how/whether to forward it or not. | ||
| // | ||
| // Example: | ||
| // | ||
| // .. code-block:: yaml | ||
| // | ||
| // verifier: | ||
| // issuer: accounts.google.com | ||
| // audiences: | ||
| // - bookstore_android.apps.googleusercontent.com | ||
| // bookstore_web.apps.googleusercontent.com | ||
| // remote_jwks: | ||
| // - http_uri: | ||
| // - uri: https://accounts.google.com/.well-known/openid-configuration | ||
| // cluster: google_jwks_cluster | ||
| // cache_duration: | ||
| // - seconds: 300 | ||
| // forwarder: | ||
| // forward: true | ||
| // forward_payload_header: x-authorization | ||
| // | ||
| message JwtRule { | ||
| // Describes the rules for verifying a JWT. | ||
| JwtVerificationRule verifier = 1; | ||
| // Describes how to treat a successfuly verified JWT. | ||
| JwtForwardingRule forwarder = 2; | ||
| } | ||
|
|
||
| // This message specifies how a JSON Web Token (JWT) can be verified. JWT format is defined | ||
| // `here <https://tools.ietf.org/html/rfc7519>`_. Please see `OAuth2.0 | ||
| // <https://tools.ietf.org/html/rfc6749>`_ and `OIDC1.0 <http://openid.net/connect>`_ for | ||
| // the authentication flow. | ||
| // | ||
| // Example: | ||
| // | ||
| // .. code-block:: yaml | ||
| // | ||
| // issuer: https://example.com | ||
| // audiences: | ||
| // - bookstore_android.apps.googleusercontent.com | ||
| // bookstore_web.apps.googleusercontent.com | ||
| // remote_jwks: | ||
| // - http_uri: | ||
| // - uri: https://example.com/.well-known/jwks.json | ||
| // cluster: example_jwks_cluster | ||
| // cache_duration: | ||
| // - seconds: 300 | ||
| // | ||
| // [#not-implemented-hide:] | ||
| message JwtVerificationRule { | ||
| // Identifies the principal that issued the JWT. See `here | ||
| // <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_. Usually a URL or an email address. | ||
| // | ||
| // Example: https://securetoken.google.com | ||
| // Example: 1234567-compute@developer.gserviceaccount.com | ||
| // | ||
| string issuer = 1 [(validate.rules).string.min_bytes = 1]; | ||
|
|
||
| // The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_. that are | ||
| // allowed to access. A JWT containing any of these audiences will be accepted. If not specified, | ||
| // will not check audiences in the token. | ||
| // | ||
| // Example: | ||
| // | ||
| // .. code-block:: yaml | ||
| // | ||
| // audiences: | ||
| // - bookstore_android.apps.googleusercontent.com | ||
| // bookstore_web.apps.googleusercontent.com | ||
| // | ||
| repeated string audiences = 2; | ||
|
|
||
| // `JSON Web Key Set <https://tools.ietf.org/html/rfc7517#appendix-A>`_ is needed. to validate | ||
| // signature of the JWT. This field specifies where to fetch JWKS. | ||
| oneof jwks_source_specifier { | ||
| option (validate.required) = true; | ||
|
|
||
| // JWKS can be fetched from remote server via HTTP/HTTPS. This field specifies the remote HTTP | ||
| // URI and how the fetched JWKS should be cached. | ||
| // | ||
| // Example: | ||
| // | ||
| // .. code-block:: yaml | ||
| // | ||
| // remote_jwks: | ||
| // - http_uri: | ||
| // - uri: https://www.googleapis.com/oauth2/v1/certs | ||
| // cluster: jwt.www.googleapis.com|443 | ||
| // cache_duration: | ||
| // - seconds: 300 | ||
| // | ||
| RemoteJwks remote_jwks = 3; | ||
|
|
||
| // JWKS is in local data source. It could be either in a local file or embedded in the | ||
| // inline_string. | ||
| // | ||
| // Example: local file | ||
| // | ||
| // .. code-block:: yaml | ||
| // | ||
| // local_jwks: | ||
| // - filename: /etc/envoy/jwks/jwks1.txt | ||
| // | ||
| // Example: inline_string | ||
| // | ||
| // .. code-block:: yaml | ||
| // | ||
| // local_jwks: | ||
| // - inline_string: "ACADADADADA" | ||
| // | ||
| envoy.api.v2.core.DataSource local_jwks = 4; | ||
| } | ||
|
|
||
| // Two fields below define where to extract the JWT from an HTTP request. | ||
| // | ||
| // If no explicit location is specified, the following default locations are tried in order: | ||
| // | ||
| // 1. The Authorization header using the Bearer schema. See `here | ||
| // <https://tools.ietf.org/html/rfc6750#section-2.1>`_. Example: | ||
| // | ||
| // Authorization: Bearer <token>. | ||
| // | ||
| // 2. `access_token` query parameter. See `this | ||
| // <https://tools.ietf.org/html/rfc6750#section-2.3>`_ | ||
| // | ||
|
|
||
| // Multiple JWTs can be verified for a request. Each JWT has to be extracted from the locations | ||
| // its issuer specified or from the default locations. | ||
|
|
||
| // Specify the HTTP headers to extract JWT token. For examples, following config: | ||
| // | ||
| // .. code-block:: yaml | ||
| // | ||
| // from_headers: | ||
| // - name: x-goog-iap-jwt-assertion | ||
| // | ||
| // can be used to extract token from header:: | ||
| // | ||
| // x-goog-iap-jwt-assertion: <JWT>. | ||
| // | ||
| repeated JwtHeader from_headers = 5; | ||
|
|
||
| // JWT is sent in a query parameter. `jwt_params` represents the query parameter names. | ||
| // | ||
| // For example, if config is: | ||
| // | ||
| // .. code-block:: yaml | ||
| // | ||
| // from_params: | ||
| // - jwt_token | ||
| // | ||
| // The JWT format in query parameter is:: | ||
| // | ||
| // /path?jwt_token=<JWT> | ||
| // | ||
| repeated string from_params = 6; | ||
| } | ||
|
|
||
| // This message specifies how a JSON Web Token (JWT) should be forwarded or removed from a request. | ||
| // | ||
| // Example: | ||
| // | ||
| // .. code-block:: yaml | ||
| // | ||
| // forward: true | ||
| // forward_payload_header: x-authorization | ||
| // | ||
| // [#not-implemented-hide:] | ||
| message JwtForwardingRule { | ||
| // If false, the JWT is removed in the request after a success verification. If true, the JWT is | ||
| // not removed in the request. Default value is false. | ||
| bool forward = 1; | ||
| // This field specifies the header name to forward a successfully verified JWT payload to the | ||
| // backend. The forwarded data is:: | ||
| // | ||
| // base64_encoded(jwt_payload_in_JSON) | ||
| // | ||
| // If it is not specified, the payload will not be forwarded. | ||
| // Multiple JWTs in a request from different issuers will be supported. Multiple JWTs from the | ||
| // same issuer will not be supported. Each issuer can config this `forward_payload_header`. If | ||
| // multiple JWTs from different issuers want to forward their payloads, their | ||
| // `forward_payload_header` should be different. | ||
| string forward_payload_header = 2; | ||
| } | ||
|
|
||
| // This message specifies how to fetch JWKS from remote and how to cache it. | ||
| message RemoteJwks { | ||
| // The HTTP URI to fetch the JWKS. For example: | ||
| // | ||
| // .. code-block:: yaml | ||
| // | ||
| // http_uri: | ||
| // - uri: https://www.googleapis.com/oauth2/v1/certs | ||
| // cluster: jwt.www.googleapis.com|443 | ||
| // | ||
| envoy.api.v2.core.HttpUri http_uri = 1; | ||
|
|
||
| // Duration after which the cached JWKS should be expired. If not specified, default cache | ||
| // duration is 5 minutes. | ||
| google.protobuf.Duration cache_duration = 2; | ||
| } | ||
|
|
||
| // This message specifies a header location to extract JWT token. | ||
| message JwtHeader { | ||
| // The HTTP header name. | ||
| string name = 1 [(validate.rules).string.min_bytes = 1]; | ||
|
|
||
| // The value prefix. The value format is "value_prefix<token>" | ||
| // For example, for "Authorization: Bearer <token>", value_prefix="Bearer " with a space at the | ||
| // end. | ||
| string value_prefix = 2; | ||
| } | ||
|
|
||
| // This message specifies a 256-bit secret encoded in base64 form (44 ASCII characters including trailing '='). | ||
| message Secret256 { | ||
| string value = 1 [(validate.rules).string.min_bytes = 44, (validate.rules).string.max_bytes = 44]; | ||
| } | ||
|
|
||
| // This message specifies a secret that can be used for protecting a session token. | ||
| // Example: | ||
| // | ||
| // .. code-block:: yaml | ||
| // | ||
| // secret: | ||
| // aesgcm256: | ||
| // value: "YWJjZGVmMDEyMzQ1Njc4OWFiY2RlZjAxMjM0NTY3ODk=" | ||
| // | ||
| // [#not-implemented-hide:] | ||
| message SessionSecret { | ||
| oneof secret { | ||
| // Key for authentically encrypting and decrypting Session Tokens using AES-GCM. | ||
| Secret256 aesgcm256 = 1; | ||
| } | ||
| } | ||
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 |
|---|---|---|
| @@ -1,13 +1,12 @@ | ||
| licenses(["notice"]) # Apache 2 | ||
|
|
||
| load("//bazel:api_build_system.bzl", "api_proto_library") | ||
|
|
||
| licenses(["notice"]) # Apache 2 | ||
|
|
||
| api_proto_library( | ||
| name = "jwt_authn", | ||
| srcs = ["config.proto"], | ||
| deps = [ | ||
| "//envoy/api/v2/core:base", | ||
| "//envoy/api/v2/core:http_uri", | ||
| "//envoy/api/v2/route", | ||
| "//envoy/config/filter/http/common/v1alpha:common", | ||
| ], | ||
| ) |
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.
super quit drive by nit: Please put this in a more specific namespace/file/directory than "envoy.config.filter.http.common.v1alpha"