escher

README

EscherGo - HTTP request signing lib

Go implementation of the AWS4 compatible Escher HTTP request signing and authentication library.

Prerequisite

In order to run the tests, some Go libraries should be installed. Use go get to install the dependencies.

Run the tests

To run all the tests, use the go test -cover command.

About Escher

More details are available at our Escher documentation site.

Documentation

Index

• type EscherConfig
  • func Escher(config EscherConfig) EscherConfig
  • func (config EscherConfig) CanonicalizeRequest(request EscherRequest, headersToSign []string) string
  • func (config EscherConfig) GenerateHeader(request EscherRequest, headersToSign []string) string
  • func (config EscherConfig) GetStringToSign(request EscherRequest, headersToSign []string) string
  • func (config EscherConfig) SignRequest(request EscherRequest, headersToSign []string) EscherRequest
• type EscherRequest
• type EscherRequestHeaders
• type EscherRequestQuery

Types

type EscherConfig

type EscherConfig struct {
	VendorKey       string
	AlgoPrefix      string
	HashAlgo        string
	CredentialScope string
	ApiSecret       string
	AccessKeyId     string
	AuthHeaderName  string
	DateHeaderName  string
	Date            string
}

func Escher

func Escher(config EscherConfig) EscherConfig

func (EscherConfig) CanonicalizeRequest

func (config EscherConfig) CanonicalizeRequest(request EscherRequest, headersToSign []string) string

func (EscherConfig) GenerateHeader

func (config EscherConfig) GenerateHeader(request EscherRequest, headersToSign []string) string

func (EscherConfig) GetStringToSign

func (config EscherConfig) GetStringToSign(request EscherRequest, headersToSign []string) string

func (EscherConfig) SignRequest

func (config EscherConfig) SignRequest(request EscherRequest, headersToSign []string) EscherRequest

type EscherRequest

type EscherRequest struct {
	Method  string
	Url     string
	Headers EscherRequestHeaders
	Body    string
}

type EscherRequestHeaders

type EscherRequestHeaders [][2]string

type EscherRequestQuery

type EscherRequestQuery [][2]string