You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/11/29 09:38:31 UTC
[GitHub] [apisix] spacewander commented on a change in pull request #5594: feat(plugins): aws lambda serverless
spacewander commented on a change in pull request #5594:
URL: https://github.com/apache/apisix/pull/5594#discussion_r758167136
##########
File path: t/admin/plugins.t
##########
@@ -40,7 +40,7 @@ __DATA__
--- request
GET /apisix/admin/plugins/list
--- response_body_like eval
-qr/\["real-ip","client-control","ext-plugin-pre-req","zipkin","request-id","fault-injection","serverless-pre-function","batch-requests","cors","ip-restriction","ua-restriction","referer-restriction","uri-blocker","request-validation","openid-connect","authz-casbin","wolf-rbac","ldap-auth","hmac-auth","basic-auth","jwt-auth","key-auth","consumer-restriction","authz-keycloak","proxy-mirror","proxy-cache","proxy-rewrite","api-breaker","limit-conn","limit-count","limit-req","gzip","server-info","traffic-split","redirect","response-rewrite","grpc-transcode","prometheus","datadog","echo","http-logger","skywalking-logger","google-cloud-logging","sls-logger","tcp-logger","kafka-logger","syslog","udp-logger","example-plugin","azure-functions","openwhisk","serverless-post-function","ext-plugin-post-req"\]/
+qr/\["real-ip","client-control","ext-plugin-pre-req","zipkin","request-id","fault-injection","serverless-pre-function","batch-requests","cors","ip-restriction","ua-restriction","referer-restriction","uri-blocker","request-validation","openid-connect","authz-casbin","wolf-rbac","ldap-auth","hmac-auth","basic-auth","jwt-auth","key-auth","consumer-restriction","authz-keycloak","proxy-mirror","proxy-cache","proxy-rewrite","api-breaker","limit-conn","limit-count","limit-req","gzip","server-info","traffic-split","redirect","response-rewrite","grpc-transcode","prometheus","datadog","echo","http-logger","skywalking-logger","google-cloud-logging","sls-logger","tcp-logger","kafka-logger","syslog","udp-logger","example-plugin","aws-lambda","azure-functions","openwhisk","serverless-post-function","ext-plugin-post-req"\]/
Review comment:
Can we split this into multiple lines? We can do it in the next PR.
##########
File path: apisix/plugins/aws-lambda.lua
##########
@@ -0,0 +1,185 @@
+--
+-- 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 pairs = pairs
+local tab_concat = table.concat
+local tab_sort = table.sort
+local os = os
+local hmac = require("resty.hmac")
+local hexencode = require("resty.string").to_hex
+local resty_sha256 = require("resty.sha256")
+
+
+local plugin_name = "aws-lambda"
+local plugin_version = 0.1
+local priority = -1899
+
+local ALGO = "AWS4-HMAC-SHA256"
+
+local function hmac256(key, msg)
+ return hmac:new(key, hmac.ALGOS.SHA256):final(msg)
+end
+
+local function sha256(msg)
+ local hash = resty_sha256:new()
+ hash:update(msg)
+ local digest = hash:final()
+ return hexencode(digest)
+end
+
+local function getSignatureKey(key, datestamp, region, service)
+ local kDate = hmac256("AWS4" .. key, datestamp)
+ local kRegion = hmac256(kDate, region)
+ local kService = hmac256(kRegion, service)
+ local kSigning = hmac256(kService, "aws4_request")
+ return kSigning
+end
+
+local aws_authz_schema = {
+ type = "object",
+ properties = {
+ -- API Key based authorization
+ apikey = {type = "string"},
+ -- IAM role based authorization, works via aws v4 request signing
+ -- more at https://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html
+ iam = {
+ type = "object",
+ properties = {
+ accesskey = {
+ type = "string",
+ description = "access key id from from aws iam console"
+ },
+ secretkey = {
+ type = "string",
+ description = "secret access key from from aws iam console"
+ },
+ aws_region = {
+ type = "string",
+ default = "us-east-1",
+ description = "the aws region that is receiving the request"
+ },
+ service = {
+ type = "string",
+ default = "execute-api",
+ description = "the service that is receiving the request"
+ }
+ },
+ required = {"accesskey", "secretkey"}
+ }
+ }
+}
+
+local function request_processor(conf, ctx, params)
+ local headers = params.headers
+ -- set authorization headers if not already set by the client
+ -- we are following not to overwrite the authz keys
+ if not headers["x-api-key"] then
+ if conf.authorization and conf.authorization.apikey then
+ headers["x-api-key"] = conf.authorization.apikey
+ return
+ end
+ end
+
+ -- performing aws v4 request signing for IAM authorization
+ -- visit https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html
+ -- to look at the pseudocode in python.
+ if headers["authorization"] or not conf.authorization or not conf.authorization.iam then
+ return
+ end
+
+ -- create a date for headers and the credential string
+ local t = ngx.time()
+ local amzdate = os.date("!%Y%m%dT%H%M%SZ", t)
+ local datestamp = os.date("!%Y%m%d", t) -- Date w/o time, used in credential scope
+ headers["X-Amz-Date"] = amzdate
+
+ -- computing canonical uri
+ local canonical_uri = params.path:gsub("//", "/")
+ if canonical_uri ~= "/" then
+ if canonical_uri:sub(-1, -1) == "/" then
+ canonical_uri = canonical_uri:sub(1, -2)
+ end
+ if canonical_uri:sub(1, 1) ~= "/" then
+ canonical_uri = "/" .. canonical_uri
+ end
+ end
+
+ -- computing canonical query string
+ local canonical_qs = {}
+ for k, v in pairs(params.query) do
+ canonical_qs[#canonical_qs+1] = ngx.unescape_uri(k) .. "=" .. ngx.unescape_uri(v)
+ end
+
+ tab_sort(canonical_qs)
+ canonical_qs = tab_concat(canonical_qs, "&")
+
+ -- computing canonical and signed headers
+
+ local canonical_headers, signed_headers = {}, {}
+ for k, v in pairs(headers) do
+ k = k:lower()
+ if k ~= "connection" then
+ signed_headers[#signed_headers+1] = k
+ -- strip starting and trailing spaces including strip multiple spaces into single space
+ canonical_headers[k] = v:gsub("^%s+", ""):gsub("%s+$", "")
Review comment:
We can use https://refined-github-html-preview.kidonng.workers.dev/lunarmodules/Penlight/raw/master/docs/libraries/pl.stringx.html#strip?
##########
File path: apisix/plugins/aws-lambda.lua
##########
@@ -0,0 +1,185 @@
+--
+-- 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 pairs = pairs
+local tab_concat = table.concat
+local tab_sort = table.sort
+local os = os
+local hmac = require("resty.hmac")
+local hexencode = require("resty.string").to_hex
+local resty_sha256 = require("resty.sha256")
+
+
+local plugin_name = "aws-lambda"
+local plugin_version = 0.1
+local priority = -1899
+
+local ALGO = "AWS4-HMAC-SHA256"
+
+local function hmac256(key, msg)
+ return hmac:new(key, hmac.ALGOS.SHA256):final(msg)
+end
+
+local function sha256(msg)
+ local hash = resty_sha256:new()
+ hash:update(msg)
+ local digest = hash:final()
+ return hexencode(digest)
+end
+
+local function getSignatureKey(key, datestamp, region, service)
+ local kDate = hmac256("AWS4" .. key, datestamp)
+ local kRegion = hmac256(kDate, region)
+ local kService = hmac256(kRegion, service)
+ local kSigning = hmac256(kService, "aws4_request")
+ return kSigning
+end
+
+local aws_authz_schema = {
+ type = "object",
+ properties = {
+ -- API Key based authorization
+ apikey = {type = "string"},
+ -- IAM role based authorization, works via aws v4 request signing
+ -- more at https://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html
+ iam = {
+ type = "object",
+ properties = {
+ accesskey = {
+ type = "string",
+ description = "access key id from from aws iam console"
+ },
+ secretkey = {
+ type = "string",
+ description = "secret access key from from aws iam console"
+ },
+ aws_region = {
+ type = "string",
+ default = "us-east-1",
+ description = "the aws region that is receiving the request"
+ },
+ service = {
+ type = "string",
+ default = "execute-api",
+ description = "the service that is receiving the request"
+ }
+ },
+ required = {"accesskey", "secretkey"}
+ }
+ }
+}
+
+local function request_processor(conf, ctx, params)
+ local headers = params.headers
+ -- set authorization headers if not already set by the client
+ -- we are following not to overwrite the authz keys
+ if not headers["x-api-key"] then
+ if conf.authorization and conf.authorization.apikey then
+ headers["x-api-key"] = conf.authorization.apikey
+ return
+ end
+ end
+
+ -- performing aws v4 request signing for IAM authorization
+ -- visit https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html
+ -- to look at the pseudocode in python.
+ if headers["authorization"] or not conf.authorization or not conf.authorization.iam then
+ return
+ end
+
+ -- create a date for headers and the credential string
+ local t = ngx.time()
+ local amzdate = os.date("!%Y%m%dT%H%M%SZ", t)
+ local datestamp = os.date("!%Y%m%d", t) -- Date w/o time, used in credential scope
+ headers["X-Amz-Date"] = amzdate
+
+ -- computing canonical uri
+ local canonical_uri = params.path:gsub("//", "/")
Review comment:
Can we use `pl.path` to do part of the normalized work?
https://refined-github-html-preview.kidonng.workers.dev/lunarmodules/Penlight/raw/master/docs/libraries/pl.path.html#normpath
##########
File path: docs/en/latest/plugins/aws-lambda.md
##########
@@ -0,0 +1,156 @@
+---
+title: aws-lambda
+---
+
+<!--
+#
+# 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.
+#
+-->
+
+## Summary
+
+- [Summary](#summary)
+- [Name](#name)
+- [Attributes](#attributes)
+ - [IAM Authorization Schema](#iam-authorization-schema)
+- [How To Enable](#how-to-enable)
+- [Disable Plugin](#disable-plugin)
+
+## Name
+
+`aws-lambda` is a serverless plugin built into Apache APISIX for seamless integration with [AWS Lambda](https://aws.amazon.com/lambda/), a widely used serverless solution, as a dynamic upstream to proxy all requests for a particular URI to the AWS cloud - one of the highly used public cloud platforms for production environment. If enabled, this plugin terminates the ongoing request to that particular URI and initiates a new request to the aws lambda gateway uri (the new upstream) on behalf of the client with the suitable authorization details set by the users, request headers, request body, params ( all these three components are passed from the original request ) and returns the response body, status code and the headers back to the original client that has invoked the request to the APISIX agent.
+At present, the plugin supports authorization via aws api key and aws IAM Secrets.
+
+## Attributes
+
+| Name | Type | Requirement | Default | Valid | Description |
+| ----------- | ------ | ----------- | ------- | ----- | ------------------------------------------------------------ |
+| function_uri | string | required | | | The aws api gateway endpoint which triggers the lambda serverless function code. |
+| authorization | object | optional | | | Authorization credentials to access the cloud function. |
+| authorization.apikey | string | optional | | | Field inside _authorization_. The generate API Key to authorize requests to that endpoint of the aws gateway. | |
+| authorization.iam | object | optional | | | Field inside _authorization_. AWS IAM role based authorization, performed via aws v4 request signing. See schema details below ([here](#iam-authorization-schema)). | |
+| timeout | integer | optional | 3000 | [100,...] | Proxy request timeout in milliseconds. |
+| ssl_verify | boolean | optional | true | true/false | If enabled performs SSL verification of the server. |
+| keepalive | boolean | optional | true | true/false | To reuse the same proxy connection in near future. Set to false to disable keepalives and immediately close the connection. |
+| keepalive_pool | integer | optional | 5 | [1,...] | The maximum number of connections in the pool. |
+| keepalive_timeout | integer | optional | 60000 | [1000,...] | The maximal idle timeout (ms). |
+
+### IAM Authorization Schema
+
+| Name | Type | Requirement | Default | Valid | Description |
+| ----------- | ------ | ----------- | ------- | ----- | ------------------------------------------------------------ |
+| accesskey | string | required | | | Genereated access key ID from aws IAM console. |
+| secret_key | string | required | | | Genereated access key secret from aws IAM console. |
+| aws_region | string | optional | "us-east-1" | | The aws region where the request is being sent. |
+| service | string | optional | "execute-api" | | The service that is receiving the request (In case of Http Trigger it is "execute-api"). |
+
+## How To Enable
+
+The following is an example of how to enable the aws-lambda faas plugin for a specific route URI. Calling the apisix route uri will make an invocation to the lambda function uri (the new upstream). We are assuming your cloud function is already up and running.
Review comment:
Please use APISIX route instead of `apisix route`. Need to fix other similar places.
##########
File path: docs/en/latest/plugins/aws-lambda.md
##########
@@ -0,0 +1,156 @@
+---
+title: aws-lambda
+---
+
+<!--
+#
+# 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.
+#
+-->
+
+## Summary
+
+- [Summary](#summary)
+- [Name](#name)
+- [Attributes](#attributes)
+ - [IAM Authorization Schema](#iam-authorization-schema)
+- [How To Enable](#how-to-enable)
+- [Disable Plugin](#disable-plugin)
+
+## Name
+
+`aws-lambda` is a serverless plugin built into Apache APISIX for seamless integration with [AWS Lambda](https://aws.amazon.com/lambda/), a widely used serverless solution, as a dynamic upstream to proxy all requests for a particular URI to the AWS cloud - one of the highly used public cloud platforms for production environment. If enabled, this plugin terminates the ongoing request to that particular URI and initiates a new request to the aws lambda gateway uri (the new upstream) on behalf of the client with the suitable authorization details set by the users, request headers, request body, params ( all these three components are passed from the original request ) and returns the response body, status code and the headers back to the original client that has invoked the request to the APISIX agent.
+At present, the plugin supports authorization via aws api key and aws IAM Secrets.
+
+## Attributes
+
+| Name | Type | Requirement | Default | Valid | Description |
+| ----------- | ------ | ----------- | ------- | ----- | ------------------------------------------------------------ |
+| function_uri | string | required | | | The aws api gateway endpoint which triggers the lambda serverless function code. |
+| authorization | object | optional | | | Authorization credentials to access the cloud function. |
+| authorization.apikey | string | optional | | | Field inside _authorization_. The generate API Key to authorize requests to that endpoint of the aws gateway. | |
+| authorization.iam | object | optional | | | Field inside _authorization_. AWS IAM role based authorization, performed via aws v4 request signing. See schema details below ([here](#iam-authorization-schema)). | |
+| timeout | integer | optional | 3000 | [100,...] | Proxy request timeout in milliseconds. |
+| ssl_verify | boolean | optional | true | true/false | If enabled performs SSL verification of the server. |
+| keepalive | boolean | optional | true | true/false | To reuse the same proxy connection in near future. Set to false to disable keepalives and immediately close the connection. |
+| keepalive_pool | integer | optional | 5 | [1,...] | The maximum number of connections in the pool. |
+| keepalive_timeout | integer | optional | 60000 | [1000,...] | The maximal idle timeout (ms). |
+
+### IAM Authorization Schema
+
+| Name | Type | Requirement | Default | Valid | Description |
+| ----------- | ------ | ----------- | ------- | ----- | ------------------------------------------------------------ |
+| accesskey | string | required | | | Genereated access key ID from aws IAM console. |
+| secret_key | string | required | | | Genereated access key secret from aws IAM console. |
+| aws_region | string | optional | "us-east-1" | | The aws region where the request is being sent. |
+| service | string | optional | "execute-api" | | The service that is receiving the request (In case of Http Trigger it is "execute-api"). |
+
+## How To Enable
+
+The following is an example of how to enable the aws-lambda faas plugin for a specific route URI. Calling the apisix route uri will make an invocation to the lambda function uri (the new upstream). We are assuming your cloud function is already up and running.
+
+```shell
+# enable aws lambda for a route via api key authorization
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "plugins": {
+ "aws-lambda": {
+ "function_uri": "https://x9w6z07gb9.execute-api.us-east-1.amazonaws.com/default/test-apisix",
+ "authorization": {
+ "apikey": "<Generated API Key from aws console>",
+ },
+ "ssl_verify":false
+ }
+ },
+ "uri": "/aws"
+}'
+```
+
+Now any requests (HTTP/1.1, HTTPS, HTTP2) to URI `/aws` will trigger an HTTP invocation to the aforesaid function URI and response body along with the response headers and response code will be proxied back to the client. For example ( here aws lambda function just take the `name` query param and returns `Hello $name` ) :
+
+```shell
+$ curl -i -XGET localhost:9080/aws\?name=apisix
+HTTP/1.1 200 OK
+Content-Type: application/json
+Connection: keep-alive
+Date: Sat, 27 Nov 2021 13:08:27 GMT
+x-amz-apigw-id: JdwXuEVxIAMFtKw=
+x-amzn-RequestId: 471289ab-d3b7-4819-9e1a-cb59cac611e0
+Content-Length: 16
+X-Amzn-Trace-Id: Root=1-61a22dca-600c552d1c05fec747fd6db0;Sampled=0
+Server: APISIX/2.10.2
+
+"Hello, apisix!"
+```
+
+For requests where the mode of communication between the client and the Apache APISIX gateway is HTTP/2, the example looks like ( make sure you are running APISIX agent with `enable_http2: true` for a port in conf.yaml or uncomment port 9081 of `node_listen` field inside [config-default.yaml](../../../../conf/config-default.yaml) ) :
Review comment:
Better to use `config-default.yaml` directly, since people may read the doc on the doc's website. Please fix the azure-functions' doc too.
##########
File path: apisix/plugins/aws-lambda.lua
##########
@@ -0,0 +1,185 @@
+--
+-- 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 pairs = pairs
+local tab_concat = table.concat
+local tab_sort = table.sort
+local os = os
+local hmac = require("resty.hmac")
+local hexencode = require("resty.string").to_hex
+local resty_sha256 = require("resty.sha256")
+
+
+local plugin_name = "aws-lambda"
+local plugin_version = 0.1
+local priority = -1899
+
+local ALGO = "AWS4-HMAC-SHA256"
+
+local function hmac256(key, msg)
+ return hmac:new(key, hmac.ALGOS.SHA256):final(msg)
+end
+
+local function sha256(msg)
+ local hash = resty_sha256:new()
+ hash:update(msg)
+ local digest = hash:final()
+ return hexencode(digest)
+end
+
+local function getSignatureKey(key, datestamp, region, service)
Review comment:
Ditto
##########
File path: apisix/plugins/aws-lambda.lua
##########
@@ -0,0 +1,185 @@
+--
+-- 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 pairs = pairs
+local tab_concat = table.concat
+local tab_sort = table.sort
+local os = os
+local hmac = require("resty.hmac")
+local hexencode = require("resty.string").to_hex
Review comment:
Can we use underscore style for function name?
##########
File path: apisix/plugins/aws-lambda.lua
##########
@@ -0,0 +1,185 @@
+--
+-- 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 pairs = pairs
+local tab_concat = table.concat
+local tab_sort = table.sort
+local os = os
+local hmac = require("resty.hmac")
+local hexencode = require("resty.string").to_hex
+local resty_sha256 = require("resty.sha256")
+
+
+local plugin_name = "aws-lambda"
+local plugin_version = 0.1
+local priority = -1899
+
+local ALGO = "AWS4-HMAC-SHA256"
+
+local function hmac256(key, msg)
+ return hmac:new(key, hmac.ALGOS.SHA256):final(msg)
+end
+
+local function sha256(msg)
+ local hash = resty_sha256:new()
+ hash:update(msg)
+ local digest = hash:final()
+ return hexencode(digest)
+end
+
+local function getSignatureKey(key, datestamp, region, service)
+ local kDate = hmac256("AWS4" .. key, datestamp)
+ local kRegion = hmac256(kDate, region)
+ local kService = hmac256(kRegion, service)
+ local kSigning = hmac256(kService, "aws4_request")
+ return kSigning
+end
+
+local aws_authz_schema = {
+ type = "object",
+ properties = {
+ -- API Key based authorization
+ apikey = {type = "string"},
+ -- IAM role based authorization, works via aws v4 request signing
+ -- more at https://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html
+ iam = {
+ type = "object",
+ properties = {
+ accesskey = {
+ type = "string",
+ description = "access key id from from aws iam console"
+ },
+ secretkey = {
+ type = "string",
+ description = "secret access key from from aws iam console"
+ },
+ aws_region = {
+ type = "string",
+ default = "us-east-1",
+ description = "the aws region that is receiving the request"
+ },
+ service = {
+ type = "string",
+ default = "execute-api",
+ description = "the service that is receiving the request"
+ }
+ },
+ required = {"accesskey", "secretkey"}
+ }
+ }
+}
+
+local function request_processor(conf, ctx, params)
+ local headers = params.headers
+ -- set authorization headers if not already set by the client
+ -- we are following not to overwrite the authz keys
+ if not headers["x-api-key"] then
+ if conf.authorization and conf.authorization.apikey then
+ headers["x-api-key"] = conf.authorization.apikey
+ return
+ end
+ end
+
+ -- performing aws v4 request signing for IAM authorization
+ -- visit https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html
+ -- to look at the pseudocode in python.
+ if headers["authorization"] or not conf.authorization or not conf.authorization.iam then
+ return
+ end
+
+ -- create a date for headers and the credential string
+ local t = ngx.time()
+ local amzdate = os.date("!%Y%m%dT%H%M%SZ", t)
+ local datestamp = os.date("!%Y%m%d", t) -- Date w/o time, used in credential scope
+ headers["X-Amz-Date"] = amzdate
+
+ -- computing canonical uri
+ local canonical_uri = params.path:gsub("//", "/")
+ if canonical_uri ~= "/" then
+ if canonical_uri:sub(-1, -1) == "/" then
+ canonical_uri = canonical_uri:sub(1, -2)
+ end
+ if canonical_uri:sub(1, 1) ~= "/" then
+ canonical_uri = "/" .. canonical_uri
+ end
+ end
+
+ -- computing canonical query string
+ local canonical_qs = {}
+ for k, v in pairs(params.query) do
+ canonical_qs[#canonical_qs+1] = ngx.unescape_uri(k) .. "=" .. ngx.unescape_uri(v)
+ end
+
+ tab_sort(canonical_qs)
+ canonical_qs = tab_concat(canonical_qs, "&")
+
+ -- computing canonical and signed headers
+
+ local canonical_headers, signed_headers = {}, {}
+ for k, v in pairs(headers) do
+ k = k:lower()
+ if k ~= "connection" then
+ signed_headers[#signed_headers+1] = k
+ -- strip starting and trailing spaces including strip multiple spaces into single space
+ canonical_headers[k] = v:gsub("^%s+", ""):gsub("%s+$", "")
+ end
+ end
+ tab_sort(signed_headers)
+
+ for i = 1, #signed_headers do
+ local k = signed_headers[i]
+ canonical_headers[i] = k .. ":" .. canonical_headers[k] .. "\n"
+ end
+ canonical_headers = tab_concat(canonical_headers, nil, 1, #signed_headers)
+ signed_headers = tab_concat(signed_headers, ";")
+
+ -- combining elements to form the canonical request (step-1)
+ local canonical_request = params.method:upper() .. "\n"
+ .. canonical_uri .. "\n"
+ .. (canonical_qs or "") .. "\n"
+ .. canonical_headers .. "\n"
+ .. signed_headers .. "\n"
+ .. sha256(params.body or "")
+
+ -- creating the string to sign for aws signature v4 (step-2)
+ local iam = conf.authorization.iam
+ local credential_scope = datestamp .. "/" .. iam.aws_region .. "/"
+ .. iam.service .. "/aws4_request"
+ local string_to_sign = ALGO .. "\n"
+ .. amzdate .. "\n"
+ .. credential_scope .. "\n"
+ .. sha256(canonical_request)
+
+ -- calculate the signature (step-3)
+ local signature_key = getSignatureKey(iam.secretkey, datestamp, iam.aws_region, iam.service)
+ local signature = hexencode(hmac256(signature_key, string_to_sign))
+
+ -- add info to the headers (step-4)
+ headers["authorization"] = ALGO .. " Credential=" .. iam.accesskey
+ .. "/" .. credential_scope
+ .. ", SignedHeaders=" .. signed_headers
+ .. ", Signature=" .. signature
+end
+
+
+local serverless_obj = require("apisix.plugins.serverless.generic-upstream")
+
+return serverless_obj(plugin_name,
+ plugin_version,
Review comment:
Bad indent
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org