Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paragasu/lua-resty-aws-auth
Lua resty module to calculate AWS signature v4 authorization header
https://github.com/paragasu/lua-resty-aws-auth
Last synced: 3 months ago
JSON representation
Lua resty module to calculate AWS signature v4 authorization header
- Host: GitHub
- URL: https://github.com/paragasu/lua-resty-aws-auth
- Owner: paragasu
- License: mit
- Created: 2016-08-05T03:43:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T20:01:55.000Z (6 months ago)
- Last Synced: 2024-05-29T11:01:07.155Z (6 months ago)
- Language: Lua
- Homepage:
- Size: 49.8 KB
- Stars: 26
- Watchers: 2
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-resty - lua-resty-aws-auth
README
# lua-resty-aws-auth
Simple lua resty utilities to generate amazon v4 authorization and signature headers.
# Installation
Openresty installation should be compiled with *--with-luajit* directive otherwise you will get an error,
module 'ffi' not found
Install the package using luarocks
```lua
#luarocks install lua-resty-aws-auth
```
# Usage
```lua
local aws_auth = require "resty.aws-auth"
local config = {
aws_host = "email.us-east-1.amazonaws.com",
aws_key = "AKIDEXAMPLE",
aws_secret = "xxxsecret",
aws_region = "us-east-1",
aws_service = "ses",
content_type = "application/x-www-form-urlencoded",
request_method = "POST",
request_path = "/",
request_body = { hello="world" } -- table of all request params
}
local aws = aws_auth:new(config)
-- get the generated authorization header
-- eg: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20150830/us-east-1/iam/aws4_request,
--- SignedHeaders=content-type;host;x-amz-date, Signature=xxx
local auth = aws:get_authorization_header()
-- get the x-amz-date header
local amz_date = aws:get_amz_date_header()
```
Add _Authorization_ and _x-amz-date_ header to ngx.req.headers
```lua
aws:set_ngx_auth_headers()
```
For out-of-box experience, use the following docker image:
```bash
cd lua-resty-aws-auth
docker build -t lua-resty-aws-auth .
docker run -d --name nginx -p 8080:8080 -e AWS_ACCESS_KEY_ID=yourkey -e AWS_ACCESS_KEY_SECRET=yoursecret -e AWS_HOST=yourhost:port -e AWS_REGION=us-east-1 -e AWS_SERVICE=s3 lua-resty-aws-auth
```
the Dockerfile works both with arm64 and amd64 architectures.
then you can test the aws service by accessing localhost:8080. Remember to replace the environment variables with your own aws credentials.
actually the backend service can be any s3 compatible service, not only from aws, minio, ceph etc.
Reference
[Signing AWS With Signature V4](https://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html)
[AWS service namespaces list](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
[AWS region and endpoints](http://docs.aws.amazon.com/general/latest/gr/rande.html)