feat: support hide credentials for jwt-auth plugin by pixeldin · Pull Request #8206 · apache/apisix

pixeldin · 2022-10-30T18:21:51Z

Description

Provides an optional feat for the jwt-auth plugin to hide authentication upstream as requested in #8122.
Setting hide_credentials to true in the plugin config will hide related auth parameters in upstream.

Fixes #8122

Checklist

I have explained the need for this PR and the problem it solves
I have explained the changes or the new features added to this PR
I have added tests corresponding to this change
I have updated the documentation to reflect this change
I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

…th-plugin-supporting-hide-credentials

update description Co-authored-by: Alex Zhang <[email protected]>

…th-plugin-supporting-hide-credentials

…rameters

…th-plugin-supporting-hide-credentials

Co-authored-by: 罗泽轩 <[email protected]>

spacewander

@pixeldin
Could you apply this patch in your code before we can merge it?
Thanks!

diff --git t/plugin/jwt-auth3.t t/plugin/jwt-auth3.t
index c0a1961d..fd53d56a 100755
--- t/plugin/jwt-auth3.t
+++ t/plugin/jwt-auth3.t
@@ -30,10 +30,10 @@ add_block_preprocessor(sub {

     if (!defined $block->request) {
         $block->set_value("request", "GET /t");
-    }

-    if (!$block->response_body) {
-        $block->set_value("response_body eval", "qr/^$/");
+        if (!$block->response_body) {
+            $block->set_value("response_body", "passed\n");
+        }
     }
 });

pixeldin · 2022-11-15T07:13:48Z

@pixeldin Could you apply this patch in your code before we can merge it? Thanks!

diff --git t/plugin/jwt-auth3.t t/plugin/jwt-auth3.t
index c0a1961d..fd53d56a 100755
--- t/plugin/jwt-auth3.t
+++ t/plugin/jwt-auth3.t
@@ -30,10 +30,10 @@ add_block_preprocessor(sub {

     if (!defined $block->request) {
         $block->set_value("request", "GET /t");
-    }

-    if (!$block->response_body) {
-        $block->set_value("response_body eval", "qr/^$/");
+        if (!$block->response_body) {
+            $block->set_value("response_body", "passed\n");
+        }
     }
 });

@spacewander Thanks, Done! Please review it when you have time.

root and others added 4 commits October 31, 2022 00:53

doc update: fix hide_credentials description

d1830f3

feat: support jwt-auth of hidding sensitive param

2c7d410

Merge branch 'master' of https://github.com/apache/apisix into jwt-au…

51eb733

…th-plugin-supporting-hide-credentials

doc: update plugin param description for EN-US

f0ffec8

pixeldin marked this pull request as ready for review October 30, 2022 18:23

doc: update plugin(jwt-auth) param description for EN-US

51dea0f

tokers reviewed Oct 31, 2022

View reviewed changes

Comment thread apisix/plugins/jwt-auth.lua Outdated

Comment thread t/plugin/jwt-auth3.t Outdated

Comment thread t/plugin/jwt-auth3.t Outdated

pixeldin and others added 5 commits October 31, 2022 09:26

lint: code reformat and reindex

7ee2cd4

Update t/plugin/jwt-auth3.t

06c2970

update description Co-authored-by: Alex Zhang <[email protected]>

Update t/plugin/jwt-auth3.t

3440bfe

update description Co-authored-by: Alex Zhang <[email protected]>

code reformat

e9519b8

format test file about trailing whitespace

8a24d82

starsz reviewed Oct 31, 2022

View reviewed changes

Comment thread apisix/plugins/jwt-auth.lua Outdated

Comment thread apisix/plugins/jwt-auth.lua Outdated

tzssangglass reviewed Oct 31, 2022

View reviewed changes

Comment thread apisix/plugins/jwt-auth.lua Outdated

tokers previously approved these changes Nov 1, 2022

View reviewed changes

spacewander reviewed Nov 1, 2022

View reviewed changes

Comment thread apisix/plugins/jwt-auth.lua Outdated

pixeldin added 2 commits November 1, 2022 21:42

adjust the hide credentials logic code and update cookie setting way

493b24c

Merge branch 'master' of https://github.com/apache/apisix into jwt-au…

41b52b2

…th-plugin-supporting-hide-credentials

pixeldin dismissed tokers’s stale review via 41b52b2 November 1, 2022 13:55

License Header Addition of test file

6006c52

spacewander reviewed Nov 2, 2022

View reviewed changes

Comment thread t/plugin/jwt-auth3.t Outdated

Comment thread apisix/plugins/jwt-auth.lua Outdated

pixeldin added 3 commits November 5, 2022 02:55

rewrite cookie updating way and import httpbin for testing related pa…

64b6dde

…rameters

Merge branch 'master' of https://github.com/apache/apisix into jwt-au…

dac50b5

…th-plugin-supporting-hide-credentials

fix expected final newline

da2f64b

spacewander reviewed Nov 6, 2022

View reviewed changes

Comment thread apisix/plugins/jwt-auth.lua Outdated

tzssangglass reviewed Nov 7, 2022

View reviewed changes

Comment thread t/plugin/jwt-auth3.t Outdated

pixeldin added 2 commits November 7, 2022 21:59

adjusting unit test and hiding credential in cookie with regex pattern

5179af6

Merge branch 'master' of https://github.com/apache/apisix into jwt-au…

fa9081c

…th-plugin-supporting-hide-credentials

tokers previously approved these changes Nov 8, 2022

View reviewed changes

spacewander reviewed Nov 8, 2022

View reviewed changes

Comment thread t/plugin/jwt-auth3.t Outdated

Comment thread docs/zh/latest/plugins/jwt-auth.md Outdated

Comment thread t/plugin/jwt-auth3.t

Comment thread apisix/plugins/jwt-auth.lua Outdated

pixeldin requested review from spacewander and tokers and removed request for spacewander and tokers November 9, 2022 03:32

spacewander reviewed Nov 9, 2022

View reviewed changes

Comment thread t/plugin/jwt-auth3.t Outdated

reformat test file about jwt-auth

b1c6fa0

pixeldin requested review from spacewander and removed request for tokers November 9, 2022 07:03

tzssangglass reviewed Nov 9, 2022

View reviewed changes

Comment thread apisix/plugins/jwt-auth.lua Outdated

tzssangglass reviewed Nov 9, 2022

View reviewed changes

Comment thread t/plugin/jwt-auth3.t Outdated

use ngx.re specification as cookie match way

cddc27f

pixeldin requested review from tzssangglass and removed request for spacewander November 9, 2022 08:46

spacewander reviewed Nov 10, 2022

View reviewed changes

Comment thread apisix/plugins/jwt-auth.lua Outdated

Comment thread t/plugin/jwt-auth3.t

pixeldin added 2 commits November 10, 2022 15:29

consider abnormal case and reformat test

3c8a9e1

fix trim trailing whitespace

a55846a

starsz previously approved these changes Nov 11, 2022

View reviewed changes

tzssangglass reviewed Nov 11, 2022

View reviewed changes

Comment thread t/plugin/jwt-auth3.t Outdated

spacewander reviewed Nov 11, 2022

View reviewed changes

Comment thread apisix/plugins/jwt-auth.lua Outdated

Comment thread t/plugin/jwt-auth3.t Outdated

pixeldin dismissed starsz’s stale review via 284c428 November 11, 2022 07:53

pixeldin and others added 2 commits November 11, 2022 15:53

Update apisix/plugins/jwt-auth.lua

284c428

Co-authored-by: 罗泽轩 <[email protected]>

adjust test file and print cover cookie case

b5bc8c7

spacewander previously approved these changes Nov 15, 2022

View reviewed changes

define default block for test file

b2a1e7d

pixeldin dismissed spacewander’s stale review via b2a1e7d November 15, 2022 07:09

pixeldin requested a review from spacewander November 15, 2022 07:14

spacewander approved these changes Nov 16, 2022

View reviewed changes

starsz approved these changes Nov 16, 2022

View reviewed changes

spacewander merged commit 2f4a4db into apache:master Nov 16, 2022

Uh oh!

Conversation

pixeldin commented Oct 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

spacewander left a comment

Choose a reason for hiding this comment

Uh oh!

pixeldin commented Nov 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

pixeldin commented Oct 30, 2022 •

edited

Loading