feat(key-auth): support get key from querystring

apache · Jun 30, 2021 · ef1e038 · ef1e038
1 parent 0c70327
commit ef1e038
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 0 deletions.
diff --git a/apisix/plugins/key-auth.lua b/apisix/plugins/key-auth.lua
@@ -32,6 +32,10 @@ local schema = {
             type = "string",
             default = "apikey",
         },
+        query = {
+            type = "string",
+            default = "apikey",
+        },
     },
 }
 
@@ -84,6 +88,12 @@ end
 
 function _M.rewrite(conf, ctx)
     local key = core.request.header(ctx, conf.header)
+
+    if not key then
+        local uri_args = core.request.get_uri_args(ctx) or {}
+        key = uri_args[conf.query]
+    end
+
     if not key then
         return 401, {message = "Missing API key found in request"}
     end

diff --git a/docs/en/latest/plugins/key-auth.md b/docs/en/latest/plugins/key-auth.md
@@ -48,6 +48,7 @@ For route side:
 | Name | Type   | Requirement | Default | Valid | Description                                                                  |
 | ---- | ------ | ----------- | ------- | ----- | ---------------------------------------------------------------------------- |
 | header  | string | optional    | apikey        |       | the header we get the key from |
+| query   | string | optional    | apikey        |       | the querystring we get the key from, which priority is lower than header |
 
 ## How To Enable
 

diff --git a/docs/zh/latest/plugins/key-auth.md b/docs/zh/latest/plugins/key-auth.md
@@ -48,6 +48,7 @@ router 端配置：
 | 名称 | 类型   | 必选项 | 默认值 | 有效值 | 描述                                                                                                          |
 | ---- | ------ | ------ | ------ | ------ | ------------------------------------------------------------------------------------------------------------- |
 | header  | string | 可选| apikey |        | 设置我们从哪个 header 获取 key。 |
+| query  | string | 可选 | apikey |        | 设置我们从哪个 querystring 获取 key，优先级低于header |
 
 ## 如何启用
 

diff --git a/t/plugin/key-auth.t b/t/plugin/key-auth.t
@@ -309,3 +309,51 @@ Authorization: auth-one
 hello world
 --- no_error_log
 [error]
+
+
+
+=== TEST 12: customize query string
+--- config
+    location /t {
+        content_by_lua_block {
+            local t = require("lib.test_admin").test
+            local code, body = t('/apisix/admin/routes/1',
+                ngx.HTTP_PUT,
+                [[{
+                    "plugins": {
+                        "key-auth": {
+                            "query": "auth"
+                        }
+                    },
+                    "upstream": {
+                        "nodes": {
+                            "127.0.0.1:1980": 1
+                        },
+                        "type": "roundrobin"
+                    },
+                    "uri": "/hello"
+                }]]
+                )
+
+            if code >= 300 then
+                ngx.status = code
+            end
+            ngx.say(body)
+        }
+    }
+--- request
+GET /t
+--- response_body
+passed
+--- no_error_log
+[error]
+
+
+
+=== TEST13: valid consumer
+--- request
+GET /hello?auth=auth-one
+--- response_body
+hello world
+--- no_error_log
+[error]