Support APIKey authentication #5580

haywoodsh · 2024-05-20T08:26:45Z

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

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

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

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

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

internal/configs/virtualserver.go

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

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

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

…ted maps in config, remove reject code, add unit tests Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

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

internal/configs/virtualserver.go

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

…to conf only if api key policy is used Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

…feat/api-key

internal/configs/version1/nginx-plus.tmpl

internal/k8s/secrets/validation.go

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

* always load njs module Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * accept api key policy yaml Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * [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 <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * [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 <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * [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 <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * [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 <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * 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 <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * add python tests for vs and vsr * fix dockerfile merge * add wait until pods are ready * update error message Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * test setting same namespace * custom objects * add crd print * add unit tests Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * 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 <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * remove logs, refactor, add tests Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * remove logs Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]> * add api key auth to telemetry --------- Signed-off-by: Haywood Shannon <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Jim Ryan <[email protected]>

haywoodsh added 2 commits May 20, 2024 09:25

always load njs module

ba8f0c2

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

accept api key policy yaml

d046e57

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

github-actions bot added enhancement Pull requests for new features/feature enhancements go Pull requests that update Go code labels May 20, 2024

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 Pull requests that update Docker code label May 20, 2024

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 <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

[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 May 24, 2024

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

2643320

use nginx.org/apikey secret type

c4b0bdf

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

[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 <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

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 Jun 6, 2024

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 <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

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 <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

add python tests for vs and vsr

3e53c4b

github-actions bot added python Pull requests that update Python code tests Pull requests that update tests labels Jun 12, 2024

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

21be26e

…feat/api-key

github-actions bot removed github_actions Pull requests that update Github_actions code chore Pull requests for routine tasks labels Jun 13, 2024

j1m-ryan added 2 commits June 13, 2024 16:34

further cleanup

9806d6b

clean up test

8956744

oseoin reviewed Jun 14, 2024

View reviewed changes

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

oseoin reviewed Jun 14, 2024

View reviewed changes

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

j1m-ryan mentioned this pull request Jun 14, 2024

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 <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

remove logs, refactor, add tests

b983616

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

remove logs

ec753ce

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

Merge branch 'main' into feat/api-key

ec84a05

add api key auth to telemetry

c6bd588

j1m-ryan mentioned this pull request Jun 14, 2024

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 Jun 14, 2024 that may be closed by this pull request

Support APIKey authentication - Implementation #5484

Closed

haywoodsh changed the title ~~Feat/api key~~ Support APIKey authentication Jun 14, 2024

oseoin approved these changes Jun 14, 2024

View reviewed changes

Merge branch 'main' into feat/api-key

fec5a3b

pdabelf5 approved these changes Jun 17, 2024

View reviewed changes

j1m-ryan merged commit dbba378 into main Jun 17, 2024
85 checks passed

j1m-ryan deleted the feat/api-key branch June 17, 2024 10:54

This was referenced Jul 1, 2024

[DO NOT MERGE] transport server template #5902

Closed

[DO NOT MERGE] transport server template #5903

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support APIKey authentication #5580

Support APIKey authentication #5580

haywoodsh commented May 20, 2024 •

edited

Loading

Support APIKey authentication #5580

Support APIKey authentication #5580

Conversation

haywoodsh commented May 20, 2024 • edited Loading

Proposed changes

Checklist

haywoodsh commented May 20, 2024 •

edited

Loading