signer

README

AWS Signer for Apex

A roundTripper implementation for Go to sign http requests to AWS services from AWS Lambda.

Requirements

This library is supposed to be used on AWS Lambda with the go-apex library / framework.

Background

The AWS SDK is a great tool to perform authenticated requests to AWS services. If you are trying to access a service directly with API calls, the SDK performs all the necessary bootstrap for you. However, when trying to access the applications hosted on those services, it becomes necessary to sign the request. A great upside of this method is that signed requests allows a resource to be authenticated by its IAM role. You can therefore assign and revoke IAM policies to the role keeping your infrastructure safe from the inside and the outside.

Use case: AWS Lambda to ElasticSearch with Go

This library was first built to access AWS ElasticSearch from a Lambda function. I have an S3 bucket that triggers a Lambda function when a new item is created or updated. The Lambda function pulls the object from the bucket performing some transformation and then ingests its content into an ElasticSearch index. The first part uses the S3 API and it's automagically managed by the SDK, but the last part (ingesting data ES) can be performed in different ways:

1. The YOLO / you are fired way: you open your ElasticSearch index to the world allowing access from 0.0.0.0.
2. The apprentice way: you can create a VPC with your Lambda function and the ElasticSearch service and restrict access to ES to the privateIP of the VPC
3. The master way: you can still create a VPC for security purposes but you can restrict even more the ES access leveraging policies to attach to an IAM role.

The second example can be good enough in most scenarios. However, one important downsize is that your ES instance will be still open to every resource inside the VPC, which is not great because a good security strategy protects both against external and internal threats.

Usage

Install the library as usual:

go get github.com/edoardo849/apex-aws-signer

If you want to run the tests, just in case... :

cd $GOPATH/src/github.com/edoardo849/apex-aws-signer
go test -cover

For example, if you're using ElasticSearch with @olivere's elastic library:

import (
    "github.com/edoardo849/apex-aws-signer"
    "github.com/apex/log"
    "github.com/aws/aws-sdk-go/service/elasticsearchservice"
    "gopkg.in/olivere/elastic.v3"
)

// Example For ElasticSearch
// ctx is the *apex.Context
ctxLogger := log.WithField("requestID", ctx.RequestID)
transport := signer.NewTransport(s, elasticsearchservice.ServiceName)

// This is optional
transport.Logger = ctxLogger

httpClient := &http.Client{
	Transport: transport,
}
// Use the client with Olivere's elastic client
client, err := elastic.NewClient(
    elastic.SetSniff(false),
    elastic.SetHealthcheckTimeout(time.Duration(2)*time.Second),
    elastic.SetURL("your-aws-es-endpoint"),
    elastic.SetScheme("https"),
    elastic.SetHttpClient(httpClient),
)

Credits

This library was partially inspired by go-loghttp.

Documentation

Index

• type AWSSigningTransport
  • func NewTransport(s *session.Session, serviceName string) *AWSSigningTransport
  • func (t *AWSSigningTransport) RoundTrip(req *http.Request) (*http.Response, error)

Types

type AWSSigningTransport

type AWSSigningTransport struct {
	Transport http.RoundTripper
	Logger    *log.Entry
	// contains filtered or unexported fields
}

AWSSigningTransport implements http.RoundTripper. When set as Transport of http.Client, it signs HTTP requests with the latest AWS v4 signer and logs the requests No field is mandatory, but you can provide your own Transport or contextLogger by setting the Transport or Logger property.

func NewTransport

func NewTransport(s *session.Session, serviceName string) *AWSSigningTransport

NewTransport creates a new instance of the AWSSigningTransport

func (*AWSSigningTransport) RoundTrip

func (t *AWSSigningTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip is the core part of this module and implements http.RoundTripper. Executes HTTP request with request/response logging. Signs the requests with AWS's v4 signer