feat(plugins) extended plugins API to query by specific relevant field

kong/plugins/basic-auth/api.lua

@@ -1,4 +1,5 @@
 local crud = require "kong.api.crud_helpers"
+local utils = require "kong.tools.utils"
 
 return {
   ["/consumers/:username_or_id/basic-auth/"] = {
@@ -19,15 +20,18 @@ return {
       crud.post(self.params, dao_factory.basicauth_credentials)
     end
   },
-  ["/consumers/:username_or_id/basic-auth/:id"] = {
+  ["/consumers/:username_or_id/basic-auth/:credential_username_or_id"] = {
     before = function(self, dao_factory, helpers)
       crud.find_consumer_by_username_or_id(self, dao_factory, helpers)
       self.params.consumer_id = self.consumer.id
 
-      local credentials, err = dao_factory.basicauth_credentials:find_all {
+      local filter_keys = {
+        [utils.is_valid_uuid(self.params.credential_username_or_id) and "id" or "username"] = self.params.credential_username_or_id,
         consumer_id = self.params.consumer_id,
-        id = self.params.id
       }
+      self.params.credential_username_or_id = nil
+
+      local credentials, err = dao_factory.basicauth_credentials:find_all(filter_keys)
       if err then
         return helpers.yield_error(err)
       elseif next(credentials) == nil then

kong/plugins/hmac-auth/api.lua

@@ -1,4 +1,5 @@
 local crud = require "kong.api.crud_helpers"
+local utils = require "kong.tools.utils"
 
 return{
   ["/consumers/:username_or_id/hmac-auth/"] = {
@@ -20,18 +21,26 @@ return{
     end
   },
 
-  ["/consumers/:username_or_id/hmac-auth/:id"]  = {
+  ["/consumers/:username_or_id/hmac-auth/:credential_username_or_id"]  = {
     before = function(self, dao_factory, helpers)
       crud.find_consumer_by_username_or_id(self, dao_factory, helpers)
       self.params.consumer_id = self.consumer.id
 
-      local err
-      self.hmacauth_credential, err = dao_factory.hmacauth_credentials:find(self.params)
+
+      local filter_keys = {
+        [utils.is_valid_uuid(self.params.credential_username_or_id) and "id" or "username"] = self.params.credential_username_or_id,
+        consumer_id = self.params.consumer_id,
+      }
+      self.params.credential_username_or_id = nil
+
+      local credentials, err = dao_factory.hmacauth_credentials:find_all(filter_keys)
       if err then
         return helpers.yield_error(err)
-      elseif self.hmacauth_credential == nil then
+      elseif next(credentials) == nil then
         return helpers.responses.send_HTTP_NOT_FOUND()
       end
+
+      self.hmacauth_credential = credentials[1]
     end,
 
     GET = function(self, dao_factory, helpers)

kong/plugins/jwt/api.lua

@@ -1,4 +1,5 @@
 local crud = require "kong.api.crud_helpers"
+local utils = require "kong.tools.utils"
 
 return {
   ["/consumers/:username_or_id/jwt/"] = {
@@ -20,18 +21,25 @@ return {
     end
   },
 
-  ["/consumers/:username_or_id/jwt/:id"] = {
+  ["/consumers/:username_or_id/jwt/:credential_key_or_id"] = {
     before = function(self, dao_factory, helpers)
       crud.find_consumer_by_username_or_id(self, dao_factory, helpers)
       self.params.consumer_id = self.consumer.id
 
-      local err
-      self.jwt_secret, err = dao_factory.jwt_secrets:find(self.params)
+      local filter_keys = {
+        [utils.is_valid_uuid(self.params.credential_key_or_id) and "id" or "key"] = self.params.credential_key_or_id,
+        consumer_id = self.params.consumer_id,
+      }
+      self.params.credential_key_or_id = nil
+
+      local credentials, err = dao_factory.jwt_secrets:find_all(filter_keys)
       if err then
         return helpers.yield_error(err)
-      elseif self.jwt_secret == nil then
+      elseif next(credentials) == nil then
         return helpers.responses.send_HTTP_NOT_FOUND()
       end
+
+      self.jwt_secret = credentials[1]
     end,
 
     GET = function(self, dao_factory, helpers)

kong/plugins/key-auth/api.lua

@@ -1,4 +1,5 @@
 local crud = require "kong.api.crud_helpers"
+local utils = require "kong.tools.utils"
 
 return {
   ["/consumers/:username_or_id/key-auth/"] = {
@@ -19,15 +20,18 @@ return {
       crud.post(self.params, dao_factory.keyauth_credentials)
     end
   },
-  ["/consumers/:username_or_id/key-auth/:id"] = {
+  ["/consumers/:username_or_id/key-auth/:credential_key_or_id"] = {
     before = function(self, dao_factory, helpers)
       crud.find_consumer_by_username_or_id(self, dao_factory, helpers)
       self.params.consumer_id = self.consumer.id
 
-      local credentials, err = dao_factory.keyauth_credentials:find_all {
+      local filter_keys = {
+        [utils.is_valid_uuid(self.params.credential_key_or_id) and "id" or "key"] = self.params.credential_key_or_id,
         consumer_id = self.params.consumer_id,
-        id = self.params.id
       }
+      self.params.credential_key_or_id = nil
+
+      local credentials, err = dao_factory.keyauth_credentials:find_all(filter_keys)
       if err then
         return helpers.yield_error(err)
       elseif next(credentials) == nil then

kong/plugins/oauth2/api.lua

@@ -1,4 +1,5 @@
 local crud = require "kong.api.crud_helpers"
+local utils = require "kong.tools.utils"
 
 return {
   ["/oauth2_tokens/"] = {
@@ -15,21 +16,34 @@ return {
     end
   },
 
-  ["/oauth2_tokens/:id"] = {
-    GET = function(self, dao_factory)
-      crud.get(self.params, dao_factory.oauth2_tokens)
+  ["/oauth2_tokens/:token_or_id"] = {
+    before = function(self, dao_factory, helpers)
+      local filter_keys = {
+        [utils.is_valid_uuid(self.params.token_or_id) and "id" or "access_token"] = self.params.token_or_id,
+        consumer_id = self.params.consumer_id,
+      }
+      self.params.token_or_id = nil
+
+      local credentials, err = dao_factory.oauth2_tokens:find_all(filter_keys)
+      if err then
+        return helpers.yield_error(err)
+      elseif next(credentials) == nil then
+        return helpers.responses.send_HTTP_NOT_FOUND()
+      end
+
+      self.oauth2_token = credentials[1]
     end,
 
-    PATCH = function(self, dao_factory)
-      crud.patch(self.params, dao_factory.oauth2_tokens, self.params)
+    GET = function(self, dao_factory, helpers)
+      return helpers.responses.send_HTTP_OK(self.oauth2_token)
     end,
 
-    PUT = function(self, dao_factory)
-      crud.put(self.params, dao_factory.oauth2_tokens)
+    PATCH = function(self, dao_factory)
+      crud.patch(self.params, dao_factory.oauth2_tokens, self.oauth2_token)
     end,
 
     DELETE = function(self, dao_factory)
-      crud.delete(self.params, dao_factory.oauth2_tokens)
+      crud.delete(self.oauth2_token, dao_factory.oauth2_tokens)
     end
   },
 
@@ -58,15 +72,18 @@ return {
     end
   },
 
-  ["/consumers/:username_or_id/oauth2/:id"] = {
+  ["/consumers/:username_or_id/oauth2/:clientid_or_id"] = {
     before = function(self, dao_factory, helpers)
       crud.find_consumer_by_username_or_id(self, dao_factory, helpers)
       self.params.consumer_id = self.consumer.id
 
-      local credentials, err = dao_factory.oauth2_credentials:find_all {
+      local filter_keys = {
+        [utils.is_valid_uuid(self.params.clientid_or_id) and "id" or "client_id"] = self.params.clientid_or_id,
         consumer_id = self.params.consumer_id,
-        id = self.params.id
       }
+      self.params.clientid_or_id = nil
+
+      local credentials, err = dao_factory.oauth2_credentials:find_all(filter_keys)
       if err then
         return helpers.yield_error(err)
       elseif next(credentials) == nil then
@@ -76,16 +93,16 @@ return {
       self.oauth2_credential = credentials[1]
     end,
 
-    GET = function(self, dao_factory)
-      crud.get(self.params, dao_factory.oauth2_credentials)
+    GET = function(self, dao_factory, helpers)
+      return helpers.responses.send_HTTP_OK(self.oauth2_credential)
     end,
 
     PATCH = function(self, dao_factory)
-      crud.patch(self.params, dao_factory.oauth2_credentials, self.params)
+      crud.patch(self.params, dao_factory.oauth2_credentials, self.oauth2_credential)
     end,
 
     DELETE = function(self, dao_factory)
-      crud.delete(self.params, dao_factory.oauth2_credentials)
+      crud.delete(self.oauth2_credential, dao_factory.oauth2_credentials)
     end
   }
 }

spec/03-plugins/01-basic-auth/02-api_spec.lua

@@ -161,6 +161,15 @@ describe("Plugin: basic-auth (API)", function()
         local json = cjson.decode(body)
         assert.equal(credential.id, json.id)
       end)
+      it("retrieves basic-auth credential by username", function()
+        local res = assert(admin_client:send {
+          method = "GET",
+          path = "/consumers/bob/basic-auth/"..credential.username
+        })
+        local body = assert.res_status(200, res)
+        local json = cjson.decode(body)
+        assert.equal(credential.id, json.id)
+      end)
       it("retrieves credential by id only if the credential belongs to the specified consumer", function()
         assert(helpers.dao.consumers:insert {
           username = "alice"
@@ -181,7 +190,7 @@ describe("Plugin: basic-auth (API)", function()
     end)
 
     describe("PATCH", function()
-      it("updates a credential", function()
+      it("updates a credential by id", function()
         local previous_hash = credential.password
 
         local res = assert(admin_client:send {
@@ -198,6 +207,23 @@ describe("Plugin: basic-auth (API)", function()
         local json = cjson.decode(body)
         assert.not_equal(previous_hash, json.password)
       end)
+      it("updates a credential by username", function()
+        local previous_hash = credential.password
+
+        local res = assert(admin_client:send {
+          method = "PATCH",
+          path = "/consumers/bob/basic-auth/"..credential.username,
+          body = {
+            password = "upd4321"
+          },
+          headers = {
+            ["Content-Type"] = "application/json"
+          }
+        })
+        local body = assert.res_status(200, res)
+        local json = cjson.decode(body)
+        assert.not_equal(previous_hash, json.password)
+      end)
       describe("errors", function()
         it("handles invalid input", function()
           local res = assert(admin_client:send {
@@ -225,12 +251,12 @@ describe("Plugin: basic-auth (API)", function()
         assert.res_status(204, res)
       end)
       describe("errors", function()
-        it("returns 400 on invalid input", function()
+        it("returns 404 on missing username", function()
           local res = assert(admin_client:send {
             method = "DELETE",
             path = "/consumers/bob/basic-auth/blah"
           })
-          assert.res_status(400, res)
+          assert.res_status(404, res)
         end)
         it("returns 404 if not found", function()
           local res = assert(admin_client:send {

spec/03-plugins/02-key-auth/01-api_spec.lua

@@ -151,6 +151,15 @@ describe("Plugin: key-auth (API)", function()
         local json = cjson.decode(body)
         assert.equal(credential.id, json.id)
       end)
+      it("retrieves key-auth credential by key", function()
+        local res = assert(admin_client:send {
+          method = "GET",
+          path = "/consumers/bob/key-auth/"..credential.key
+        })
+        local body = assert.res_status(200, res)
+        local json = cjson.decode(body)
+        assert.equal(credential.id, json.id)
+      end)
       it("retrieves credential by id only if the credential belongs to the specified consumer", function()
         assert(helpers.dao.consumers:insert {
           username = "alice"
@@ -171,7 +180,7 @@ describe("Plugin: key-auth (API)", function()
     end)
 
     describe("PATCH", function()
-      it("updates a credential", function()
+      it("updates a credential by id", function()
         local res = assert(admin_client:send {
           method = "PATCH",
           path = "/consumers/bob/key-auth/"..credential.id,
@@ -186,6 +195,21 @@ describe("Plugin: key-auth (API)", function()
         local json = cjson.decode(body)
         assert.equal("4321", json.key)
       end)
+      it("updates a credential by key", function()
+        local res = assert(admin_client:send {
+          method = "PATCH",
+          path = "/consumers/bob/key-auth/"..credential.key,
+          body = {
+            key = "4321UPD"
+          },
+          headers = {
+            ["Content-Type"] = "application/json"
+          }
+        })
+        local body = assert.res_status(200, res)
+        local json = cjson.decode(body)
+        assert.equal("4321UPD", json.key)
+      end)
       describe("errors", function()
         it("handles invalid input", function()
           local res = assert(admin_client:send {
@@ -218,7 +242,7 @@ describe("Plugin: key-auth (API)", function()
             method = "DELETE",
             path = "/consumers/bob/key-auth/blah"
           })
-          assert.res_status(400, res)
+          assert.res_status(404, res)
         end)
         it("returns 404 if not found", function()
           local res = assert(admin_client:send {

spec/03-plugins/06-jwt/02-api_spec.lua

@@ -194,10 +194,17 @@ describe("Plugin: jwt (API)", function()
         })
         assert.res_status(200, res)
       end)
+      it("retrieves by key", function()
+        local res = assert(admin_client:send {
+          method = "GET",
+          path = "/consumers/bob/jwt/"..jwt_secret.key,
+        })
+        assert.res_status(200, res)
+      end)
     end)
 
     describe("PATCH", function()
-      it("updates a credential", function()
+      it("updates a credential by id", function()
         local res = assert(admin_client:send {
           method = "PATCH",
           path = "/consumers/bob/jwt/"..jwt_secret.id,
@@ -213,6 +220,22 @@ describe("Plugin: jwt (API)", function()
         jwt_secret = cjson.decode(body)
         assert.equal("newsecret", jwt_secret.secret)
       end)
+      it("updates a credential by key", function()
+        local res = assert(admin_client:send {
+          method = "PATCH",
+          path = "/consumers/bob/jwt/"..jwt_secret.key,
+          body = {
+            key = "alice",
+            secret = "newsecret2"
+          },
+          headers = {
+            ["Content-Type"] = "application/json"
+          }
+        })
+        local body = assert.res_status(200, res)
+        jwt_secret = cjson.decode(body)
+        assert.equal("newsecret2", jwt_secret.secret)
+      end)
     end)
 
     describe("DELETE", function()
@@ -236,7 +259,7 @@ describe("Plugin: jwt (API)", function()
             ["Content-Type"] = "application/json"
           }
         })
-        assert.res_status(400, res)
+        assert.res_status(404, res)
 
        local res = assert(admin_client:send {
           method = "DELETE",