Skip to content

Commit

Permalink
Validate Headers from API Key Metadata: add configuration flag (#10117)
Browse files Browse the repository at this point in the history
Co-authored-by: changelog-bot <changelog-bot>
Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com>
  • Loading branch information
sheidkamp and soloio-bulldozer[bot] authored Sep 30, 2024
1 parent 31b7218 commit bcf0e99
Show file tree
Hide file tree
Showing 9 changed files with 1,198 additions and 1,108 deletions.
7 changes: 7 additions & 0 deletions changelog/v1.18.0-beta24/validate-apikey-data.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
changelog:
- type: NON_USER_FACING
issueLink: https://github.com/solo-io/ext-auth-service/issues/762
resolvesIssue: false
description: >-
Updating extauth APIKey config to add 'skipMetadataValidation', which will allow EE users to turn off data plane valdiation
of headers returned by the APIKey service.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,8 @@ spec:
additionalProperties:
type: string
type: object
skipMetadataValidation:
type: boolean
type: object
basicAuth:
properties:
Expand Down
10 changes: 10 additions & 0 deletions projects/gloo/api/v1/enterprise/options/extauth/v1/extauth.proto
Original file line number Diff line number Diff line change
Expand Up @@ -1166,6 +1166,11 @@ message ApiKeyAuth {
// to the request.
bool required = 2;
}

// API key metadata may contain data is is invalid for a header, such as a newline. By default, this data will be validated
// in the data plane and mitigated in a way that provides a consistent experience for the user and visibility for the operator.
// This validation comes with a performance cost, and can be disabled by setting this field to `true`.
bool skip_metadata_validation = 8;
}
message K8sSecretApiKeyStorage {
// Identify all valid API key secrets that match the provided label selector.<br/>
Expand Down Expand Up @@ -2118,6 +2123,11 @@ message ExtAuthConfig {
K8sSecretApiKeyStorage k8s_secret_apikey_storage = 4;
AerospikeApiKeyStorage aerospike_apikey_storage = 5;
}

// API key metadata may contain data is is invalid for a header, such as a newline. By default, this data will be validated
// in the data plane and mitigated in a way that provides a consistent experience for the user and visibility for the operator.
// This validation comes with a performance cost, and can be disabled by setting this field to `true`.
bool skip_metadata_validation = 6;
}

message OpaAuthConfig {
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit bcf0e99

Please sign in to comment.