bzp2010 commented on code in PR #11417: URL: https://github.com/apache/apisix/pull/11417#discussion_r1714764673
########## apisix/secret/aws.lua: ########## @@ -0,0 +1,157 @@ +-- +-- 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. +-- + +--- AWS Tools. +local core = require("apisix.core") +local http = require("resty.http") +local aws = require("resty.aws") + +local sub = core.string.sub +local find = core.string.find +local env = core.env +local type = type +local unpack = unpack + +local schema = { + type = "object", + properties = { + access_key_id = { + type = "string", + }, + secret_access_key = { + type = "string", + }, + session_token = { + type = "string", + }, + region = { + type = "string", + default = "us-east-1", + }, + endpoint_url = core.schema.uri_def, + }, + required = {"access_key_id", "secret_access_key"}, +} + +local _M = { + schema = schema +} + +local function make_request_to_aws(conf, key) + local aws_instance = aws() + + local region = conf.region + + local access_key_id = env.fetch_by_uri(conf.access_key_id) or conf.access_key_id + + local secret_access_key = env.fetch_by_uri(conf.secret_access_key) or conf.secret_access_key + + local session_token = env.fetch_by_uri(conf.session_token) or conf.session_token + + local credentials = aws_instance:Credentials({ + accessKeyId = access_key_id, + secretAccessKey = secret_access_key, + sessionToken = session_token, + }) + + local default_endpoint = "https://secretsmanager."; .. region .. ".amazonaws.com" + local pre, host, port, _, _ = unpack(http:parse_uri(conf.endpoint_url or default_endpoint)) + local endpoint = pre .. "://" .. host + + local sm = aws_instance:SecretsManager({ + credentials = credentials, + endpoint = endpoint, + region = region, + port = port, + }) + + local res, err = sm:getSecretValue({ + SecretId = key, + VersionStage = "AWSCURRENT", + }) + + if type(res) ~= "table" then + if err then + return nil, err + end + + return nil, "invalid response" + end + + if res.status ~= 200 then + local body = res.body + if type(body) == "table" then + local data = core.json.encode(body) + if data then + return nil, "invalid status code " .. res.status .. ", " .. data + end + end + + return nil, "invalid status code " .. res.status + end Review Comment: According `https://github.com/api7/lua-resty-aws/blob/main/src/resty/aws/init.lua#L392-L397`, this needs to be modified. From the lib code, there are two possibilities for the return value of a call to the service API (like getSecretValue): - res ~= nil, err == nil - res == nil, err ~= nil So the first thing you should do is to check if res is empty, and if it is, it means that err must have a value of type string. ```Lua if not res then return nil, "invalid response: " .. err end ``` Next, check the `res.status` value. `res` must not be null and must be of type table. record the status code and response as a log. ```Lua if res.status ~= 200 then return nil, "invalid status code " .. res.status .. ", " .. data end ``` Now `res` is not null and the response is as expected, so `res.body` is the data we need. Parsing it. This simplifies your code. ########## apisix/secret/aws.lua: ########## @@ -0,0 +1,193 @@ +-- +-- 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. +-- + +--- AWS Tools. +local core = require("apisix.core") +local http = require("resty.http") +local aws = require("resty.aws") + +local sub = core.string.sub +local rfind_char = core.string.rfind_char +local env = core.env +local type = type +local unpack = unpack + +--- AWS Environment Configuration +local AWS +local AWS_ACCESS_KEY_ID +local AWS_SECRET_ACCESS_KEY +local AWS_SESSION_TOKEN +local AWS_REGION + +local schema = { + type = "object", + properties = { + access_key_id = { + type = "string", + }, + secret_access_key = { + type = "string", + }, + session_token = { + type = "string", + }, + region = { + type = "string", + }, + endpoint_url = core.schema.uri_def, + }, +} + +local _M = { + schema = schema +} + +local function initialize_aws() + AWS_ACCESS_KEY_ID = env.fetch_by_uri("$ENV://AWS_ACCESS_KEY_ID") + AWS_SECRET_ACCESS_KEY = env.fetch_by_uri("$ENV://AWS_SECRET_ACCESS_KEY") + AWS_SESSION_TOKEN = env.fetch_by_uri("$ENV://AWS_SESSION_TOKEN") + AWS_REGION = env.fetch_by_uri("$ENV://AWS_REGION") + AWS = aws() + initialize_aws= nil +end + +local function make_request_to_aws(conf,key) + if initialize_aws then + initialize_aws() + end + + local region = conf.region or AWS_REGION + if not region then + return nil, "aws secret manager requires region" + end + + local access_key_id = env.fetch_by_uri(conf.access_key_id) + if not access_key_id then + access_key_id = conf.access_key_id or AWS_ACCESS_KEY_ID + end + + local secret_access_key = env.fetch_by_uri(conf.secret_access_key) + if not secret_access_key then + secret_access_key = conf.secret_access_key or AWS_SECRET_ACCESS_KEY + end + + local session_token = env.fetch_by_uri(conf.session_token) + if not session_token then + session_token = conf.session_token or AWS_SESSION_TOKEN + end + + local my_creds = nil + if access_key_id and secret_access_key then + my_creds = AWS:Credentials { + accessKeyId = access_key_id, + secretAccessKey = secret_access_key, + sessionToken = session_token, + } + end + + if not my_creds then + return nil, "(invalid credentials)" + end + + AWS.config.credentials = my_creds + + local default_endpoint = "https://secretsmanager."; .. region .. ".amazonaws.com" + local pre, host, port, _, _ = unpack(http:parse_uri(conf.endpoint_url or default_endpoint)) + local endpoint = pre .. "://" .. host + + local sm = AWS:SecretsManager { + endpoint = endpoint, + region = region, + port = port, + } + + local res, err = sm:getSecretValue { + SecretId = key, + VersionStage = "AWSCURRENT", + } + + if type(res) ~= "table" then + if err then + return nil, err + end + return nil, "(invalid response)" + end + + if res.status ~= 200 then + local body = res.body + if type(body) == "table" then + err = core.json.decode(body) + end + + if err then + return nil, err + end + + return nil, "(invalid status)" + end + + local body = res.body + if type(body) ~= "table" then + return nil, "(invalid response)" + end + + local secret = res.body.SecretString + if type(secret) ~= "string" then + return nil, "(invalid secret)" + end + + return secret +end + +-- key is the aws secretId +local function get(conf,key) + core.log.info("fetching data from aws for key: ", key) + + local idx = rfind_char(key, '/') + if not idx then + return nil, "error key format, key: " .. key + end + + local main_key = sub(key, 1, idx - 1) + if main_key == "" then + return nil, "can't find main key, key: " .. key + end + + local sub_key = sub(key, idx + 1) + if sub_key == "" then + return nil, "can't find sub key, key: " .. key + end + + core.log.info("main: ", main_key, " sub: ", sub_key) + + local res,err = make_request_to_aws(conf,main_key) + if not res then + return nil, "failed to retrtive data from aws secret manager: " .. err + end + + local ret = core.json.decode(res) Review Comment: @HuanXin-Chen -- 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. To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
