Go to file
saltzmanjoelh 2e205327f8
Make sure urls have trailing slashes (#6)
* Make sure urls have trailing slashes
* Cleaned up code

Co-authored-by: Joel Saltzman <>
2020-08-11 15:48:44 +01:00
.github/workflows SwiftCrypto (#3) 2020-08-03 11:28:49 +01:00
Sources Make sure urls have trailing slashes (#6) 2020-08-11 15:48:44 +01:00
Tests Make sure urls have trailing slashes (#6) 2020-08-11 15:48:44 +01:00
.gitignore async-http-client version 1.0.0 2019-11-06 10:20:25 +00:00
.travis.yml Update travis yml to include zlib 2019-11-06 10:28:49 +00:00
Dockerfile Update Dockerfile to cache packages, remove docker-compose setup 2020-08-03 11:51:23 +01:00
LICENSE Create LICENSE 2019-08-30 15:31:20 +01:00
Package.swift Remove HTTPClientAWSSigner target (#4) 2020-08-03 11:53:00 +01:00
README.md Update README badges 2020-08-03 14:12:58 +01:00

README.md

AWS Signer

Swift 5.1

Generate a signed URL or Request headers for submitting to Amazon Web Services. Supply the library with your URL, HTTP method, headers and body and get back a signed URL or signed headers to use in your HTTP Request.

Usage Guide

Create an AWSSigner object. Initialise it with security credentials for accessing Amazon Web Services, the signing name of the service you are using and the AWS region you are working in. You can create a credentials object directly and enter your credentials or get them from the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY using the EnvironmentCredential struct. There are other ways of accessing AWS security credentials but that isn't the purpose of this library. The signing name in general is the same as the service name eg s3, sns, iam but this is not always the case.

The following example code creates a signed URL to access a file in S3.

let credentials = StaticCredential(accessKeyId: "MYACCESSKEY", secretAccessKey: "MYSECRETACCESSKEY")
let signer = AWSSigner(credentials: credentials, name: "s3", region: "us-east-1")
let signedURL = signer.signURL(
                    url: URL(string:"mybucket.s3.us-east-1.amazonaws.com/myfile")!,
                    method: .GET)

Alternatively you can store the authentication details in the request headers. The following returns the headers required to sign a request plus the original headers. The signature is stored in the 'Authorization' header. This request will return a response containing a list of SNS Topics from AWS region us-east-1.

let credentials = StaticCredential(accessKeyId: "MYACCESSKEY", secretAccessKey: "MYSECRETACCESSKEY")
let signer = AWSSigner(credentials: credentials, name: "sns", region: "us-east-1")
let body = "Action=ListTopics&Version=2010-03-31"
let signedHeaders = signer.signHeaders(
                  url: URL(string:"sns.us-east-1.amazonaws.com/")!,
                  method: .GET,
                  headers: ["Content-Type": "application/x-www-form-urlencoded; charset=utf-8"],
                  body: .string(body))