membphis commented on a change in pull request #2192: URL: https://github.com/apache/apisix/pull/2192#discussion_r487669728
########## File path: apisix/plugins/hmac-auth.lua ########## @@ -0,0 +1,286 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local ngx = ngx +local type = type +local select = select +local abs = math.abs +local ngx_time = ngx.time +local str_fmt = string.format +local ngx_re = require("ngx.re") +local ngx_req = ngx.req +local pairs = pairs +local ipairs = ipairs +local hmac_sha1 = ngx.hmac_sha1 +local escape_uri = ngx.escape_uri +local core = require("apisix.core") +local hmac = require("resty.hmac") +local consumer = require("apisix.consumer") +local ngx_decode_base64 = ngx.decode_base64 + +local SIGNATURE_KEY = "X-HMAC-SIGNATURE" +local ALGORITHM_KEY = "X-HMAC-ALGORITHM" +local TIMESTAMP_KEY = "X-HMAC-TIMESTAMP" +local ACCESS_KEY = "X-HMAC-ACCESS-KEY" +local plugin_name = "hmac-auth" + +local schema = { + type = "object", + properties = { + access_key = {type = "string", minLength = 1, maxLength = 256}, + secret_key = {type = "string", minLength = 1, maxLength = 256}, + algorithm = { + type = "string", + enum = {"hmac-sha1", "hmac-sha256", "hmac-sha512"}, + default = "hmac-sha256" + }, + clock_skew = { + type = "integer", + default = 300 + } + }, + dependencies = { + ["access_key"] = {"secret_key"}, + ["secret_key"] = {"access_key"}, + ["algorithm"] = {"secret_key", "access_key"} + } +} + +local _M = { + version = 0.1, + priority = 2530, + type = 'auth', + name = plugin_name, + schema = schema, +} + +local hmac_funcs = { + ["hmac-sha1"] = function(secret_key, message) + return hmac_sha1(secret_key, message) + end, + ["hmac-sha256"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA256):final(message) + end, + ["hmac-sha512"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA512):final(message) + end, +} + + +local function try_attr(t, ...) + local count = select('#', ...) + for i = 1, count do + local attr = select(i, ...) + t = t[attr] + if type(t) ~= "table" then + return false + end + end + + return true +end + + +local create_consumer_cache +do + local consumer_ids = {} + + function create_consumer_cache(consumers) + core.table.clear(consumer_ids) + + for _, consumer in ipairs(consumers.nodes) do + core.log.info("consumer node: ", core.json.delay_encode(consumer)) + consumer_ids[consumer.auth_conf.access_key] = consumer + end + + return consumer_ids + end + +end -- do + + +function _M.check_schema(conf) + core.log.info("input conf: ", core.json.delay_encode(conf)) + + return core.schema.check(schema, conf) +end + + +local function get_consumer(access_key) + if not access_key then + return nil, {message = "missing access key"} + end + + local consumer_conf = consumer.plugin(plugin_name) + if not consumer_conf then + return nil, {message = "Missing related consumer"} + end + + local consumers = core.lrucache.plugin(plugin_name, "consumers_key", + consumer_conf.conf_version, + create_consumer_cache, consumer_conf) + + local consumer = consumers[access_key] + if not consumer then + return nil, {message = "Invalid access key"} + end + core.log.info("consumer: ", core.json.delay_encode(consumer)) + + return consumer, nil +end + + +local function generate_signature(ctx, secret_key, params) + local canonical_uri = ctx.var.uri + local canonical_query_string = "" + local request_method = ngx_req.get_method() + local args = ngx_req.get_uri_args() + + if type(args) == "table" then + local keys = {} + local query_tab = {} + local query_tab_size = 1 + + for k,v in pairs(args) do Review comment: missing one space, should be `k, v` ########## File path: apisix/plugins/hmac-auth.lua ########## @@ -0,0 +1,286 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local ngx = ngx +local type = type +local select = select +local abs = math.abs +local ngx_time = ngx.time +local str_fmt = string.format +local ngx_re = require("ngx.re") +local ngx_req = ngx.req +local pairs = pairs +local ipairs = ipairs +local hmac_sha1 = ngx.hmac_sha1 +local escape_uri = ngx.escape_uri +local core = require("apisix.core") +local hmac = require("resty.hmac") +local consumer = require("apisix.consumer") +local ngx_decode_base64 = ngx.decode_base64 + +local SIGNATURE_KEY = "X-HMAC-SIGNATURE" +local ALGORITHM_KEY = "X-HMAC-ALGORITHM" +local TIMESTAMP_KEY = "X-HMAC-TIMESTAMP" +local ACCESS_KEY = "X-HMAC-ACCESS-KEY" +local plugin_name = "hmac-auth" + +local schema = { + type = "object", + properties = { + access_key = {type = "string", minLength = 1, maxLength = 256}, + secret_key = {type = "string", minLength = 1, maxLength = 256}, + algorithm = { + type = "string", + enum = {"hmac-sha1", "hmac-sha256", "hmac-sha512"}, + default = "hmac-sha256" + }, + clock_skew = { + type = "integer", + default = 300 + } + }, + dependencies = { + ["access_key"] = {"secret_key"}, + ["secret_key"] = {"access_key"}, + ["algorithm"] = {"secret_key", "access_key"} + } +} + +local _M = { + version = 0.1, + priority = 2530, + type = 'auth', + name = plugin_name, + schema = schema, +} + +local hmac_funcs = { + ["hmac-sha1"] = function(secret_key, message) + return hmac_sha1(secret_key, message) + end, + ["hmac-sha256"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA256):final(message) + end, + ["hmac-sha512"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA512):final(message) + end, +} + + +local function try_attr(t, ...) + local count = select('#', ...) + for i = 1, count do + local attr = select(i, ...) + t = t[attr] + if type(t) ~= "table" then + return false + end + end + + return true +end + + +local create_consumer_cache +do + local consumer_ids = {} + + function create_consumer_cache(consumers) + core.table.clear(consumer_ids) + + for _, consumer in ipairs(consumers.nodes) do + core.log.info("consumer node: ", core.json.delay_encode(consumer)) + consumer_ids[consumer.auth_conf.access_key] = consumer + end + + return consumer_ids + end + +end -- do + + +function _M.check_schema(conf) + core.log.info("input conf: ", core.json.delay_encode(conf)) + + return core.schema.check(schema, conf) +end + + +local function get_consumer(access_key) + if not access_key then + return nil, {message = "missing access key"} + end + + local consumer_conf = consumer.plugin(plugin_name) + if not consumer_conf then + return nil, {message = "Missing related consumer"} + end + + local consumers = core.lrucache.plugin(plugin_name, "consumers_key", + consumer_conf.conf_version, + create_consumer_cache, consumer_conf) + + local consumer = consumers[access_key] + if not consumer then + return nil, {message = "Invalid access key"} + end + core.log.info("consumer: ", core.json.delay_encode(consumer)) + + return consumer, nil +end + + +local function generate_signature(ctx, secret_key, params) + local canonical_uri = ctx.var.uri + local canonical_query_string = "" + local request_method = ngx_req.get_method() + local args = ngx_req.get_uri_args() + + if type(args) == "table" then + local keys = {} + local query_tab = {} + local query_tab_size = 1 + + for k,v in pairs(args) do + core.table.insert(keys, k) + end + core.table.sort(keys) + + for _, key in pairs(keys) do + local param = args[key] + if type(param) == "table" then + for _, vval in pairs(param) do + query_tab[query_tab_size] = escape_uri(key) .. "=" .. escape_uri(vval) Review comment: we can use `core.table.insert(query_tab , ...)` way, which is simpler and the `query_tab_size` is useless ########## File path: apisix/plugins/hmac-auth.lua ########## @@ -0,0 +1,286 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local ngx = ngx +local type = type +local select = select +local abs = math.abs +local ngx_time = ngx.time +local str_fmt = string.format +local ngx_re = require("ngx.re") +local ngx_req = ngx.req +local pairs = pairs +local ipairs = ipairs +local hmac_sha1 = ngx.hmac_sha1 +local escape_uri = ngx.escape_uri +local core = require("apisix.core") +local hmac = require("resty.hmac") +local consumer = require("apisix.consumer") +local ngx_decode_base64 = ngx.decode_base64 + +local SIGNATURE_KEY = "X-HMAC-SIGNATURE" +local ALGORITHM_KEY = "X-HMAC-ALGORITHM" +local TIMESTAMP_KEY = "X-HMAC-TIMESTAMP" +local ACCESS_KEY = "X-HMAC-ACCESS-KEY" +local plugin_name = "hmac-auth" + +local schema = { + type = "object", + properties = { + access_key = {type = "string", minLength = 1, maxLength = 256}, + secret_key = {type = "string", minLength = 1, maxLength = 256}, + algorithm = { + type = "string", + enum = {"hmac-sha1", "hmac-sha256", "hmac-sha512"}, + default = "hmac-sha256" + }, + clock_skew = { + type = "integer", + default = 300 + } + }, + dependencies = { + ["access_key"] = {"secret_key"}, + ["secret_key"] = {"access_key"}, + ["algorithm"] = {"secret_key", "access_key"} + } +} + +local _M = { + version = 0.1, + priority = 2530, + type = 'auth', + name = plugin_name, + schema = schema, +} + +local hmac_funcs = { + ["hmac-sha1"] = function(secret_key, message) + return hmac_sha1(secret_key, message) + end, + ["hmac-sha256"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA256):final(message) + end, + ["hmac-sha512"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA512):final(message) + end, +} + + +local function try_attr(t, ...) + local count = select('#', ...) + for i = 1, count do + local attr = select(i, ...) + t = t[attr] + if type(t) ~= "table" then + return false + end + end + + return true +end + + +local create_consumer_cache +do + local consumer_ids = {} + + function create_consumer_cache(consumers) + core.table.clear(consumer_ids) + + for _, consumer in ipairs(consumers.nodes) do + core.log.info("consumer node: ", core.json.delay_encode(consumer)) + consumer_ids[consumer.auth_conf.access_key] = consumer + end + + return consumer_ids + end + +end -- do + + +function _M.check_schema(conf) + core.log.info("input conf: ", core.json.delay_encode(conf)) + + return core.schema.check(schema, conf) +end + + +local function get_consumer(access_key) + if not access_key then + return nil, {message = "missing access key"} + end + + local consumer_conf = consumer.plugin(plugin_name) + if not consumer_conf then + return nil, {message = "Missing related consumer"} + end + + local consumers = core.lrucache.plugin(plugin_name, "consumers_key", + consumer_conf.conf_version, + create_consumer_cache, consumer_conf) + + local consumer = consumers[access_key] + if not consumer then + return nil, {message = "Invalid access key"} + end + core.log.info("consumer: ", core.json.delay_encode(consumer)) + + return consumer, nil +end + + +local function generate_signature(ctx, secret_key, params) + local canonical_uri = ctx.var.uri + local canonical_query_string = "" + local request_method = ngx_req.get_method() + local args = ngx_req.get_uri_args() + + if type(args) == "table" then + local keys = {} + local query_tab = {} + local query_tab_size = 1 + + for k,v in pairs(args) do + core.table.insert(keys, k) + end + core.table.sort(keys) + + for _, key in pairs(keys) do + local param = args[key] + if type(param) == "table" then + for _, vval in pairs(param) do + query_tab[query_tab_size] = escape_uri(key) .. "=" .. escape_uri(vval) + query_tab_size = query_tab_size + 1 + end + else + query_tab[query_tab_size] = escape_uri(key) .. "=" .. escape_uri(param) + query_tab_size = query_tab_size + 1 + end + end + canonical_query_string = core.table.concat(query_tab, "&") + end + + local req_body, _ = core.request.get_body() + req_body = req_body or "" + + local signing_string = request_method .. canonical_uri .. canonical_query_string .. + req_body .. params.access_key .. params.timestamp .. secret_key + + return hmac_funcs[params.algorithm](secret_key, signing_string) +end + + +local function validate(ctx, params) + if not params.access_key or not params.signature then + return false, nil, {message = "access key or signature missing"} + end + + local consumer, err = get_consumer(params.access_key) + if err then + return false, nil, err + end + + local conf = consumer.auth_conf + if conf.algorithm ~= params.algorithm then + return false, nil, {message = str_fmt("algorithm %s not supported", params.algorithm)} + end + + core.log.info("conf.clock_skew:", conf.clock_skew) + if conf.clock_skew and conf.clock_skew > 0 then + local diff = abs(ngx_time() - params.timestamp) + core.log.info("conf.diff:", diff) + if diff > conf.clock_skew then + return false, nil, {message = "Invalid timestamp"} + end + end + + local secret_key = conf and conf.secret_key + local request_signature = ngx_decode_base64(params.signature) + local generated_signature = generate_signature(ctx, secret_key, params) + + core.log.info("request_signature:", request_signature) + core.log.info("generated_signature:", generated_signature) + + return request_signature == generated_signature, consumer +end + +local function get_params(ctx) + local params = {} + local local_conf = core.config.local_conf() + local signature_key = SIGNATURE_KEY + local algorithm_key = ALGORITHM_KEY + local timestamp_key = TIMESTAMP_KEY + local access_key = ACCESS_KEY + + if try_attr(local_conf, "plugin_attr", "hmac-auth") then + local attr = local_conf.plugin_attr["hmac-auth"] + signature_key = attr.signature_key or signature_key Review comment: this should be a bug. we should not update the variable `signature_key`, it can be used in multiple requests. ########## File path: apisix/plugins/hmac-auth.lua ########## @@ -0,0 +1,286 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local ngx = ngx +local type = type +local select = select +local abs = math.abs +local ngx_time = ngx.time +local str_fmt = string.format +local ngx_re = require("ngx.re") +local ngx_req = ngx.req +local pairs = pairs +local ipairs = ipairs +local hmac_sha1 = ngx.hmac_sha1 +local escape_uri = ngx.escape_uri +local core = require("apisix.core") +local hmac = require("resty.hmac") +local consumer = require("apisix.consumer") +local ngx_decode_base64 = ngx.decode_base64 + +local SIGNATURE_KEY = "X-HMAC-SIGNATURE" +local ALGORITHM_KEY = "X-HMAC-ALGORITHM" +local TIMESTAMP_KEY = "X-HMAC-TIMESTAMP" +local ACCESS_KEY = "X-HMAC-ACCESS-KEY" +local plugin_name = "hmac-auth" + +local schema = { + type = "object", + properties = { + access_key = {type = "string", minLength = 1, maxLength = 256}, + secret_key = {type = "string", minLength = 1, maxLength = 256}, + algorithm = { + type = "string", + enum = {"hmac-sha1", "hmac-sha256", "hmac-sha512"}, + default = "hmac-sha256" + }, + clock_skew = { + type = "integer", + default = 300 + } + }, + dependencies = { + ["access_key"] = {"secret_key"}, + ["secret_key"] = {"access_key"}, + ["algorithm"] = {"secret_key", "access_key"} + } +} + +local _M = { + version = 0.1, + priority = 2530, + type = 'auth', + name = plugin_name, + schema = schema, +} + +local hmac_funcs = { + ["hmac-sha1"] = function(secret_key, message) + return hmac_sha1(secret_key, message) + end, + ["hmac-sha256"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA256):final(message) + end, + ["hmac-sha512"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA512):final(message) + end, +} + + +local function try_attr(t, ...) + local count = select('#', ...) + for i = 1, count do + local attr = select(i, ...) + t = t[attr] + if type(t) ~= "table" then + return false + end + end + + return true +end + + +local create_consumer_cache +do + local consumer_ids = {} + + function create_consumer_cache(consumers) + core.table.clear(consumer_ids) + + for _, consumer in ipairs(consumers.nodes) do + core.log.info("consumer node: ", core.json.delay_encode(consumer)) + consumer_ids[consumer.auth_conf.access_key] = consumer + end + + return consumer_ids + end + +end -- do + + +function _M.check_schema(conf) + core.log.info("input conf: ", core.json.delay_encode(conf)) + + return core.schema.check(schema, conf) +end + + +local function get_consumer(access_key) + if not access_key then + return nil, {message = "missing access key"} + end + + local consumer_conf = consumer.plugin(plugin_name) + if not consumer_conf then + return nil, {message = "Missing related consumer"} + end + + local consumers = core.lrucache.plugin(plugin_name, "consumers_key", + consumer_conf.conf_version, + create_consumer_cache, consumer_conf) + + local consumer = consumers[access_key] + if not consumer then + return nil, {message = "Invalid access key"} + end + core.log.info("consumer: ", core.json.delay_encode(consumer)) + + return consumer, nil +end + + +local function generate_signature(ctx, secret_key, params) + local canonical_uri = ctx.var.uri + local canonical_query_string = "" + local request_method = ngx_req.get_method() + local args = ngx_req.get_uri_args() + + if type(args) == "table" then + local keys = {} + local query_tab = {} + local query_tab_size = 1 + + for k,v in pairs(args) do + core.table.insert(keys, k) + end + core.table.sort(keys) + + for _, key in pairs(keys) do + local param = args[key] + if type(param) == "table" then + for _, vval in pairs(param) do + query_tab[query_tab_size] = escape_uri(key) .. "=" .. escape_uri(vval) + query_tab_size = query_tab_size + 1 + end + else + query_tab[query_tab_size] = escape_uri(key) .. "=" .. escape_uri(param) + query_tab_size = query_tab_size + 1 + end + end + canonical_query_string = core.table.concat(query_tab, "&") + end + + local req_body, _ = core.request.get_body() Review comment: `local req_body = core.request.get_body()` simpler code style ########## File path: apisix/plugins/hmac-auth.lua ########## @@ -0,0 +1,286 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local ngx = ngx +local type = type +local select = select +local abs = math.abs +local ngx_time = ngx.time +local str_fmt = string.format +local ngx_re = require("ngx.re") +local ngx_req = ngx.req +local pairs = pairs +local ipairs = ipairs +local hmac_sha1 = ngx.hmac_sha1 +local escape_uri = ngx.escape_uri +local core = require("apisix.core") +local hmac = require("resty.hmac") +local consumer = require("apisix.consumer") +local ngx_decode_base64 = ngx.decode_base64 + +local SIGNATURE_KEY = "X-HMAC-SIGNATURE" +local ALGORITHM_KEY = "X-HMAC-ALGORITHM" +local TIMESTAMP_KEY = "X-HMAC-TIMESTAMP" +local ACCESS_KEY = "X-HMAC-ACCESS-KEY" +local plugin_name = "hmac-auth" + +local schema = { + type = "object", + properties = { + access_key = {type = "string", minLength = 1, maxLength = 256}, + secret_key = {type = "string", minLength = 1, maxLength = 256}, + algorithm = { + type = "string", + enum = {"hmac-sha1", "hmac-sha256", "hmac-sha512"}, + default = "hmac-sha256" + }, + clock_skew = { + type = "integer", + default = 300 + } + }, + dependencies = { + ["access_key"] = {"secret_key"}, + ["secret_key"] = {"access_key"}, + ["algorithm"] = {"secret_key", "access_key"} + } +} + +local _M = { + version = 0.1, + priority = 2530, + type = 'auth', + name = plugin_name, + schema = schema, +} + +local hmac_funcs = { + ["hmac-sha1"] = function(secret_key, message) + return hmac_sha1(secret_key, message) + end, + ["hmac-sha256"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA256):final(message) + end, + ["hmac-sha512"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA512):final(message) + end, +} + + +local function try_attr(t, ...) + local count = select('#', ...) + for i = 1, count do + local attr = select(i, ...) + t = t[attr] + if type(t) ~= "table" then + return false + end + end + + return true +end + + +local create_consumer_cache +do + local consumer_ids = {} + + function create_consumer_cache(consumers) + core.table.clear(consumer_ids) + + for _, consumer in ipairs(consumers.nodes) do + core.log.info("consumer node: ", core.json.delay_encode(consumer)) + consumer_ids[consumer.auth_conf.access_key] = consumer + end + + return consumer_ids + end + +end -- do + + +function _M.check_schema(conf) + core.log.info("input conf: ", core.json.delay_encode(conf)) + + return core.schema.check(schema, conf) +end + + +local function get_consumer(access_key) + if not access_key then + return nil, {message = "missing access key"} + end + + local consumer_conf = consumer.plugin(plugin_name) + if not consumer_conf then + return nil, {message = "Missing related consumer"} + end + + local consumers = core.lrucache.plugin(plugin_name, "consumers_key", + consumer_conf.conf_version, + create_consumer_cache, consumer_conf) + + local consumer = consumers[access_key] + if not consumer then + return nil, {message = "Invalid access key"} + end + core.log.info("consumer: ", core.json.delay_encode(consumer)) + + return consumer, nil +end + + +local function generate_signature(ctx, secret_key, params) + local canonical_uri = ctx.var.uri + local canonical_query_string = "" + local request_method = ngx_req.get_method() + local args = ngx_req.get_uri_args() + + if type(args) == "table" then + local keys = {} + local query_tab = {} + local query_tab_size = 1 + + for k,v in pairs(args) do + core.table.insert(keys, k) + end + core.table.sort(keys) + + for _, key in pairs(keys) do + local param = args[key] + if type(param) == "table" then + for _, vval in pairs(param) do + query_tab[query_tab_size] = escape_uri(key) .. "=" .. escape_uri(vval) + query_tab_size = query_tab_size + 1 + end + else + query_tab[query_tab_size] = escape_uri(key) .. "=" .. escape_uri(param) + query_tab_size = query_tab_size + 1 + end + end + canonical_query_string = core.table.concat(query_tab, "&") + end + + local req_body, _ = core.request.get_body() + req_body = req_body or "" + + local signing_string = request_method .. canonical_uri .. canonical_query_string .. + req_body .. params.access_key .. params.timestamp .. secret_key Review comment: bad indentation ########## File path: apisix/plugins/hmac-auth.lua ########## @@ -0,0 +1,286 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local ngx = ngx +local type = type +local select = select +local abs = math.abs +local ngx_time = ngx.time +local str_fmt = string.format +local ngx_re = require("ngx.re") +local ngx_req = ngx.req +local pairs = pairs +local ipairs = ipairs +local hmac_sha1 = ngx.hmac_sha1 +local escape_uri = ngx.escape_uri +local core = require("apisix.core") +local hmac = require("resty.hmac") +local consumer = require("apisix.consumer") +local ngx_decode_base64 = ngx.decode_base64 + +local SIGNATURE_KEY = "X-HMAC-SIGNATURE" +local ALGORITHM_KEY = "X-HMAC-ALGORITHM" +local TIMESTAMP_KEY = "X-HMAC-TIMESTAMP" +local ACCESS_KEY = "X-HMAC-ACCESS-KEY" +local plugin_name = "hmac-auth" + +local schema = { + type = "object", + properties = { + access_key = {type = "string", minLength = 1, maxLength = 256}, + secret_key = {type = "string", minLength = 1, maxLength = 256}, + algorithm = { + type = "string", + enum = {"hmac-sha1", "hmac-sha256", "hmac-sha512"}, + default = "hmac-sha256" + }, + clock_skew = { + type = "integer", + default = 300 + } + }, + dependencies = { + ["access_key"] = {"secret_key"}, + ["secret_key"] = {"access_key"}, + ["algorithm"] = {"secret_key", "access_key"} + } +} + +local _M = { + version = 0.1, + priority = 2530, + type = 'auth', + name = plugin_name, + schema = schema, +} + +local hmac_funcs = { + ["hmac-sha1"] = function(secret_key, message) + return hmac_sha1(secret_key, message) + end, + ["hmac-sha256"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA256):final(message) + end, + ["hmac-sha512"] = function(secret_key, message) + return hmac:new(secret_key, hmac.ALGOS.SHA512):final(message) + end, +} + + +local function try_attr(t, ...) + local count = select('#', ...) + for i = 1, count do + local attr = select(i, ...) + t = t[attr] + if type(t) ~= "table" then + return false + end + end + + return true +end + + +local create_consumer_cache +do + local consumer_ids = {} + + function create_consumer_cache(consumers) + core.table.clear(consumer_ids) + + for _, consumer in ipairs(consumers.nodes) do + core.log.info("consumer node: ", core.json.delay_encode(consumer)) + consumer_ids[consumer.auth_conf.access_key] = consumer + end + + return consumer_ids + end + +end -- do + + +function _M.check_schema(conf) + core.log.info("input conf: ", core.json.delay_encode(conf)) + + return core.schema.check(schema, conf) +end + + +local function get_consumer(access_key) + if not access_key then + return nil, {message = "missing access key"} + end + + local consumer_conf = consumer.plugin(plugin_name) + if not consumer_conf then + return nil, {message = "Missing related consumer"} + end + + local consumers = core.lrucache.plugin(plugin_name, "consumers_key", + consumer_conf.conf_version, + create_consumer_cache, consumer_conf) + + local consumer = consumers[access_key] + if not consumer then + return nil, {message = "Invalid access key"} + end + core.log.info("consumer: ", core.json.delay_encode(consumer)) + + return consumer, nil +end + + +local function generate_signature(ctx, secret_key, params) + local canonical_uri = ctx.var.uri + local canonical_query_string = "" + local request_method = ngx_req.get_method() + local args = ngx_req.get_uri_args() + + if type(args) == "table" then + local keys = {} + local query_tab = {} + local query_tab_size = 1 + + for k,v in pairs(args) do + core.table.insert(keys, k) + end + core.table.sort(keys) + + for _, key in pairs(keys) do + local param = args[key] + if type(param) == "table" then + for _, vval in pairs(param) do + query_tab[query_tab_size] = escape_uri(key) .. "=" .. escape_uri(vval) + query_tab_size = query_tab_size + 1 + end + else + query_tab[query_tab_size] = escape_uri(key) .. "=" .. escape_uri(param) + query_tab_size = query_tab_size + 1 + end + end + canonical_query_string = core.table.concat(query_tab, "&") + end + + local req_body, _ = core.request.get_body() + req_body = req_body or "" + + local signing_string = request_method .. canonical_uri .. canonical_query_string .. + req_body .. params.access_key .. params.timestamp .. secret_key + + return hmac_funcs[params.algorithm](secret_key, signing_string) +end + + +local function validate(ctx, params) + if not params.access_key or not params.signature then + return false, nil, {message = "access key or signature missing"} + end + + local consumer, err = get_consumer(params.access_key) + if err then + return false, nil, err + end + + local conf = consumer.auth_conf + if conf.algorithm ~= params.algorithm then + return false, nil, {message = str_fmt("algorithm %s not supported", params.algorithm)} + end + + core.log.info("conf.clock_skew:", conf.clock_skew) + if conf.clock_skew and conf.clock_skew > 0 then + local diff = abs(ngx_time() - params.timestamp) + core.log.info("conf.diff:", diff) + if diff > conf.clock_skew then + return false, nil, {message = "Invalid timestamp"} + end + end + + local secret_key = conf and conf.secret_key + local request_signature = ngx_decode_base64(params.signature) + local generated_signature = generate_signature(ctx, secret_key, params) + + core.log.info("request_signature:", request_signature) + core.log.info("generated_signature:", generated_signature) + + return request_signature == generated_signature, consumer +end + +local function get_params(ctx) + local params = {} + local local_conf = core.config.local_conf() + local signature_key = SIGNATURE_KEY + local algorithm_key = ALGORITHM_KEY + local timestamp_key = TIMESTAMP_KEY + local access_key = ACCESS_KEY + + if try_attr(local_conf, "plugin_attr", "hmac-auth") then + local attr = local_conf.plugin_attr["hmac-auth"] + signature_key = attr.signature_key or signature_key + algorithm_key = attr.algorithm_key or algorithm_key + timestamp_key = attr.timestamp_key or timestamp_key + access_key = attr.access_key or access_key + end + + local ak = core.request.header(ctx, access_key) + local signature = core.request.header(ctx, signature_key) + local algorithm = core.request.header(ctx, algorithm_key) + local timestamp = core.request.header(ctx, timestamp_key) + + -- get params from header `Authorization` + if not ak then + local auth_string = core.request.header(ctx, "Authorization") + core.log.info("auth_string:", auth_string) + local auth_data = ngx_re.split(auth_string, "#") + core.log.info("#auth_data:", #auth_data) + core.log.info("auth_data:", core.json.delay_encode(auth_data)) + if #auth_data == 5 and auth_data[1] == "hmac-auth-v1" then + ak = auth_data[2] + signature = auth_data[3] + algorithm = auth_data[4] + timestamp = auth_data[5] + end + end + + + params.access_key = ak + params.algorithm = algorithm + params.signature = signature + params.timestamp = timestamp or 0 + + return params +end + + +function _M.rewrite(conf, ctx) + local params = get_params(ctx) + local ok, validated_consumer, err = validate(ctx, params) Review comment: I think `local validated_consumer, err = validate(ctx, params)` is enough ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
