Skip to content

docs: add HTTP header and method based authentication task#7990

Merged
zirain merged 4 commits intoenvoyproxy:mainfrom
Aditya7880900936:docs/http-header-method-auth
Feb 4, 2026
Merged

docs: add HTTP header and method based authentication task#7990
zirain merged 4 commits intoenvoyproxy:mainfrom
Aditya7880900936:docs/http-header-method-auth

Conversation

@Aditya7880900936
Copy link
Copy Markdown
Contributor

Description

This PR adds user documentation for HTTP header and method based authentication.

It describes how to configure authentication rules using SecurityPolicy and
includes examples for:

  • header-based authentication
  • method-based authentication
  • combined header and method matching

Related Issue

Fixes #5452

@Aditya7880900936 Aditya7880900936 requested a review from a team as a code owner January 19, 2026 13:13
@netlify
Copy link
Copy Markdown

netlify bot commented Jan 19, 2026

Deploy Preview for cerulean-figolla-1f9435 ready!

Name Link
🔨 Latest commit 84f1eb8
🔍 Latest deploy log https://app.netlify.com/projects/cerulean-figolla-1f9435/deploys/6979cabd92e3f20008d46922
😎 Deploy Preview https://deploy-preview-7990--cerulean-figolla-1f9435.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Aditya7880900936
Copy link
Copy Markdown
Contributor Author

Friendly Ping @zhaohuabing , Have a Look on this Doc PR

@Aditya7880900936
Copy link
Copy Markdown
Contributor Author

Friendly Ping @zhaohuabing , i have implemented your suggested changes please let me know if anything required

@zirain zirain force-pushed the docs/http-header-method-auth branch from 4351c2e to 12ece26 Compare January 28, 2026 06:05
@zhaohuabing
Copy link
Copy Markdown
Member

zhaohuabing commented Jan 28, 2026

Friendly Ping @zhaohuabing , i have implemented your suggested changes please let me know if anything required

The examples in this PR won't work.

@Aditya7880900936
Copy link
Copy Markdown
Contributor Author

Thanks @zhaohuabing for the review.

I’ve updated the documentation to use SecurityPolicy authorization rules and
aligned the examples with the working testdata configuration (principal headers
and operation methods).

Please let me know if this looks good now.

@Aditya7880900936
Copy link
Copy Markdown
Contributor Author

Friendly Ping @zhaohuabing , i have updated the documentation file as per your suggestion , Have a look on this PR

@zirain zirain merged commit bbd7cde into envoyproxy:main Feb 4, 2026
27 checks passed
cnvergence pushed a commit to cnvergence/gateway that referenced this pull request Feb 5, 2026
…y#7990)

* docs: add HTTP header and method based authentication task

Signed-off-by: Aditya7880900936 <[email protected]>

* docs: replace api-key examples with user header

Signed-off-by: Aditya7880900936 <[email protected]>

* docs: format header and method authentication examples

Signed-off-by: Aditya7880900936 <[email protected]>

* docs: add header and method based authorization examples

Signed-off-by: Aditya7880900936 <[email protected]>

---------

Signed-off-by: Aditya7880900936 <[email protected]>
cnvergence pushed a commit to cnvergence/gateway that referenced this pull request Feb 5, 2026
…y#7990)

* docs: add HTTP header and method based authentication task

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

* docs: replace api-key examples with user header

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

* docs: format header and method authentication examples

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

* docs: add header and method based authorization examples

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

---------

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>
Signed-off-by: Karol Szwaj <[email protected]>
cnvergence pushed a commit to cnvergence/gateway that referenced this pull request Feb 5, 2026
…y#7990)

* docs: add HTTP header and method based authentication task

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

* docs: replace api-key examples with user header

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

* docs: format header and method authentication examples

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

* docs: add header and method based authorization examples

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

---------

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>
Signed-off-by: Karol Szwaj <[email protected]>
cnvergence added a commit that referenced this pull request Feb 5, 2026
* chore(docs): Update Azure Entra link in OIDC guide (#8167)

Update Azure Entra link in OIDC guide

Signed-off-by: Guy Daich <[email protected]>

* fix: continue processing the remaining xDS with invalid EnvoyPatchPolicies (#8153)

continue processing the remaining xDS with invalid EnvoyPatchPolicies

Signed-off-by: Huabing (Robin) Zhao <[email protected]>
Signed-off-by: Karol Szwaj <[email protected]>

* build(deps): bump the actions group across 1 directory with 2 updates (#8178)

Bumps the actions group with 2 updates in the / directory: [docker/login-action](https://github.com/docker/login-action) and [github/codeql-action](https://github.com/github/codeql-action).

Updates `docker/login-action` from 3.6.0 to 3.7.0
- [Release notes](https://github.com/docker/login-action/releases)
- [Commits](docker/login-action@5e57cd1...c94ce9f)

Updates `github/codeql-action` from 4.32.0 to 4.32.1
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@b20883b...6bc82e0)

---
updated-dependencies:
- dependency-name: docker/login-action
  dependency-version: 3.7.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: actions
- dependency-name: github/codeql-action
  dependency-version: 4.32.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: actions
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Isaac Wilson <[email protected]>
Signed-off-by: Karol Szwaj <[email protected]>

* fix: skip provision when IR Infra is invalid (#7754)

* fix: do not trigger IR deletion when EnvoyProxy is invalid

Signed-off-by: zirain <[email protected]>

* add Invalid to ir.Infra

Signed-off-by: zirain <[email protected]>

* fix gen

Signed-off-by: zirain <[email protected]>

* add e2e

Signed-off-by: zirain <[email protected]>

* remove invalid

Signed-off-by: zirain <[email protected]>

* add comments

Signed-off-by: zirain <[email protected]>

* update

Signed-off-by: zirain <[email protected]>

* merge loop

Signed-off-by: zirain <[email protected]>

* move back

Signed-off-by: zirain <[email protected]>

---------

Signed-off-by: zirain <[email protected]>
Signed-off-by: Karol Szwaj <[email protected]>

* docs: add HTTP header and method based authentication task (#7990)

* docs: add HTTP header and method based authentication task

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

* docs: replace api-key examples with user header

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

* docs: format header and method authentication examples

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

* docs: add header and method based authorization examples

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>

---------

Signed-off-by: Aditya Sanskar Srivastav <[email protected]>
Signed-off-by: Karol Szwaj <[email protected]>

* fix: Validation of XListenerSet certificateRefs (#8168)

Previously, validateTerminateModeAndGetTLSSecrets would always use the
namespace of the listener's gateway when verifying a cross-namespace
ref.

This meant that if the listener were from an XListenerSet, whether or
not the Secret associated with the certificateRef was in the same
namespace as the XListenerSet, it would not be permitted.

Additionally, and relatedly, this fixes an issue where an XListenerSet
could reference a Secret in the gateway's namespace without a
ReferenceGrant being present.

With this change we add a new GetNamespace() method to
gatewayapi.ListenerContext which returns the listener's gateway's
namespace for a listener added directly to the gateway, or the
XListenerSet's namespace otherwise. This is similar to some of the other
methods that were added to ListenerContext in support of XListenerSets.

The new method is used when creating the `crossNamespaceFrom` to
determine if the certificateRef is permitted. If the Secret and
XListenerSet are in the same namespace, it is permitted. If that is not
the case a ReferenceGrant from the XListenerSet to the Secret will be
properly searched for.

Signed-off-by: krishicks <[email protected]>
Signed-off-by: Karol Szwaj <[email protected]>

* fix: Remove whitespace for nodeSelector in deployment YAML - helm chart change (#8185)

Remove whitespace for nodeSelector in deployment YAML

Signed-off-by: Jess Belliveau <[email protected]>
Signed-off-by: Karol Szwaj <[email protected]>

* [release/v1.7.0] release notes (#8188)

Signed-off-by: Karol Szwaj <[email protected]>

---------

Signed-off-by: Guy Daich <[email protected]>
Signed-off-by: Huabing (Robin) Zhao <[email protected]>
Signed-off-by: Karol Szwaj <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: zirain <[email protected]>
Signed-off-by: Aditya Sanskar Srivastav <[email protected]>
Signed-off-by: krishicks <[email protected]>
Signed-off-by: Jess Belliveau <[email protected]>
Co-authored-by: Guy Daich <[email protected]>
Co-authored-by: Huabing (Robin) Zhao <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Isaac Wilson <[email protected]>
Co-authored-by: zirain <[email protected]>
Co-authored-by: Aditya Sanskar Srivastav <[email protected]>
Co-authored-by: krishicks <[email protected]>
Co-authored-by: Jess Belliveau <[email protected]>
Inode1 pushed a commit to Inode1/gateway that referenced this pull request Feb 23, 2026
…y#7990)

* docs: add HTTP header and method based authentication task

Signed-off-by: Aditya7880900936 <[email protected]>

* docs: replace api-key examples with user header

Signed-off-by: Aditya7880900936 <[email protected]>

* docs: format header and method authentication examples

Signed-off-by: Aditya7880900936 <[email protected]>

* docs: add header and method based authorization examples

Signed-off-by: Aditya7880900936 <[email protected]>

---------

Signed-off-by: Aditya7880900936 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: user docs for HTTP Headers and Methods based authentication

3 participants