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.

Sign up for GitHub

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

Jump to bottom

Support APIKey authentication #5580

Merged

j1m-ryan merged 44 commits into main from feat/api-key

Jun 17, 2024

Contributor

haywoodsh commented May 20, 2024 •

edited

Loading

Proposed changes

Create API Key Policy to allow authentication with API key header or query in request in VirtualServer and VirtualServerRoute.
Add telemetry for API Key Policy.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

I have read the CONTRIBUTING doc
I have added tests that prove my fix is effective or that my feature works
I have checked that all unit tests pass after adding my changes
I have updated necessary documentation
I have rebased my branch onto main
I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

haywoodsh added 2 commits

May 20, 2024 09:25


          always load njs module

ba8f0c2

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>


          accept api key policy yaml

d046e57

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

github-actions bot added enhancement go labels

pre-commit-ci bot and others added 2 commits

May 20, 2024 08:27


          [pre-commit.ci] auto fixes from pre-commit.com hooks

94851fc

for more information, see https://pre-commit.ci


          add njs and nginx config

20f7d06

github-actions bot added the docker label

j1m-ryan and others added 3 commits

May 22, 2024 15:44


          move js import to http

fd33e3b


          update schema and allow update after NIC starts

5ce5ac5

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>


          [pre-commit.ci] auto fixes from pre-commit.com hooks

4d2ee9d

for more information, see https://pre-commit.ci

github-advanced-security bot found potential problems

View reviewed changes

internal/configs/virtualserver.go Fixed Show fixed Hide fixed

j1m-ryan and others added 9 commits

May 24, 2024 16:41


          remove hardcoded variable

c529d8a


          [pre-commit.ci] auto fixes from pre-commit.com hooks

7a579a9

for more information, see https://pre-commit.ci


          add updated njs

30c019d


          move js set outside location


          use nginx.org/apikey secret type

c4b0bdf

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>


          [pre-commit.ci] auto fixes from pre-commit.com hooks

be1b05e

for more information, see https://pre-commit.ci


          simplify njs

2a7f66a


          make query params work

083df06


          clean up template files

512e27b

haywoodsh force-pushed the feat/api-key branch from a86dc41 to 55578a9 Compare

June 6, 2024 10:39


          add api key secret validation to reject duplicated keys, remove repea…

573be80

…ted maps in config, remove reject code, add unit tests

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

haywoodsh force-pushed the feat/api-key branch from ed77b60 to 573be80 Compare

June 6, 2024 10:43


          [pre-commit.ci] auto fixes from pre-commit.com hooks

5a8916b

for more information, see https://pre-commit.ci

github-advanced-security bot found potential problems

View reviewed changes

internal/configs/virtualserver.go Fixed Show fixed Hide fixed

internal/configs/virtualserver.go Fixed Show fixed Hide fixed

haywoodsh and others added 3 commits

June 6, 2024 11:58


          fix linting, remove unused structs, update crds and codegen

8f877e3

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>


          add unit tests, unique map names, add validate apikey location block …

1d91b7c

…to conf only if api key policy is used

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>


          add python tests for vs and vsr

3e53c4b

github-actions bot added python tests labels


          Merge remote-tracking branch 'refs/remotes/origin/feat/api-key' into …

21be26e

…feat/api-key

github-actions bot removed github_actions chore labels

j1m-ryan added 2 commits

June 13, 2024 16:34


          further cleanup

9806d6b


          clean up test

oseoin reviewed

View reviewed changes

internal/configs/version1/nginx-plus.tmpl Show resolved Hide resolved

oseoin reviewed

View reviewed changes

internal/k8s/secrets/validation.go Show resolved Hide resolved

j1m-ryan mentioned this pull request

API Key Auth Policy Docs #5752

Merged

6 tasks

haywoodsh and others added 5 commits

June 14, 2024 11:28


          add unit tests, clean up code

fff5d6d

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>


          remove logs, refactor, add tests

b983616

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>


          remove logs

ec753ce

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>


          Merge branch 'main' into feat/api-key

ec84a05


          add api key auth to telemetry

c6bd588

j1m-ryan mentioned this pull request

APIKey Auth Telemetry #5753

Closed


          Merge branch 'main' into feat/api-key

d415866

j1m-ryan marked this pull request as ready for review

June 14, 2024 15:40

j1m-ryan requested review from a team as code owners

June 14, 2024 15:40

haywoodsh linked an issue

that may be closed by this pull request

Support APIKey authentication - Implementation #5484

Closed

haywoodsh changed the title ~~Feat/api key~~ Support APIKey authentication

oseoin approved these changes

View reviewed changes


          Merge branch 'main' into feat/api-key

fec5a3b

pdabelf5 approved these changes

View reviewed changes

j1m-ryan merged commit dbba378 into main

85 checks passed

j1m-ryan deleted the feat/api-key branch

June 17, 2024 10:54

pdabelf5 pushed a commit that referenced this pull request


          Support APIKey authentication (#5580)

f74d2fe

* always load njs module
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* accept api key policy yaml
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add njs and nginx config

* move js import to http

* update schema and allow update after NIC starts
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* remove hardcoded variable

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add updated njs

* move js set outside location

* use nginx.org/apikey secret type
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* simplify njs

* make query params work

* clean up template files

* add api key secret validation to reject duplicated keys, remove repeated maps in config, remove reject code, add unit tests
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix linting, remove unused structs, update crds and codegen
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* add unit tests, unique map names, add validate apikey location block to conf only if api key policy is used
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* add python tests for vs and vsr

* fix dockerfile merge

* add wait until pods are ready

* update error message
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* test setting same namespace

* custom objects

* add crd print

* add unit tests
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* Add example readme for apikey auth policy

* clean up

* further cleanup

* clean up test

* add unit tests, clean up code
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* remove logs, refactor, add tests
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* remove logs
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* add api key auth to telemetry

---------

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jim Ryan <j.ryan@f5.com>

ssrahul96 pushed a commit to ssrahul96/kubernetes-ingress that referenced this pull request


          Support APIKey authentication (nginxinc#5580)

7ff9005

* always load njs module
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* accept api key policy yaml
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add njs and nginx config

* move js import to http

* update schema and allow update after NIC starts
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* remove hardcoded variable

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add updated njs

* move js set outside location

* use nginx.org/apikey secret type
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* simplify njs

* make query params work

* clean up template files

* add api key secret validation to reject duplicated keys, remove repeated maps in config, remove reject code, add unit tests
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix linting, remove unused structs, update crds and codegen
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* add unit tests, unique map names, add validate apikey location block to conf only if api key policy is used
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* add python tests for vs and vsr

* fix dockerfile merge

* add wait until pods are ready

* update error message
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* test setting same namespace

* custom objects

* add crd print

* add unit tests
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* Add example readme for apikey auth policy

* clean up

* further cleanup

* clean up test

* add unit tests, clean up code
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* remove logs, refactor, add tests
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* remove logs
Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>

* add api key auth to telemetry

---------

Signed-off-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jim Ryan <j.ryan@f5.com>

This was referenced Jul 1, 2024

[DO NOT MERGE] transport server template #5902

Closed

[DO NOT MERGE] transport server template #5903

Closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment