README
¶
go-aws-auth
Go-AWS-Auth is a comprehensive, lightweight library for signing requests to Amazon Web Services.
It's easy to use: simply build your HTTP request, then call awsauth.Sign(req) before sending your request over the wire.
Supported signing mechanisms
- Signed Signature Version 2
- Signed Signature Version 3
- Signed Signature Version 4
- Custom S3 Authentication Scheme
- Security Token Service
- S3 Query String Authentication
- Coming soon: IAM Role Authentication
For more info about AWS authentication, see the comprehensive docs at AWS.
Install
Go get it:
$ go get github.com/smartystreets/go-aws-auth
Then import it:
import "github.com/smartystreets/awsauth"
Using your AWS Credentials
You can do it two ways.
-
Recommended: Set the
AWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEYenvironment variables with your credentials. The library will automatically detect and use them. Optionally, you may also set theAWS_SECURITY_TOKENenvironment variable if you are using temporary credentials from STS. -
You can set
awsauth.Keyswith hard-coded credentials (for testing or spike code):
awsauth.Keys = &awsauth.Credentials{
AccessKeyID: "Access Key ID",
SecretAccessKey: "Secret Access Key",
SecurityToken: "Security Token", // STS (optional)
}
Setting the credentials manually will override environment variables.
Signing requests
Once your credentials are set up, just make the request, have it signed, and perform the request as usual.
url := "https://iam.amazonaws.com/?Action=ListRoles&Version=2010-05-08"
client := &http.Client{}
req, err := http.NewRequest("GET", url, nil)
awsauth.Sign(req) // Automatically chooses the best signing mechanism for the service
resp, err := client.Do(req)
Contributing
This library isn't quite complete (yet) but should work well for most common AWS interactions. Please feel free to contribute by forking, opening issues, submitting pull requests, etc. Thanks to all contributors!
Documentation
¶
Overview ¶
Package awsauth implements AWS request signing using Signed Signature Version 2, Signed Signature Version 4, and the S3 Custom HTTP Authentication Scheme.
Index ¶
- func Sign(req *http.Request) *http.Request
- func Sign2(req *http.Request) *http.Request
- func Sign3(req *http.Request) *http.Request
- func Sign4(req *http.Request) *http.Request
- func SignS3(req *http.Request) *http.Request
- func SignS3Url(req *http.Request, expire time.Time) *http.Request
- type Credentials
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Sign ¶
Sign signs a request bound for AWS. It automatically chooses the best authentication scheme based on the service the request is going to.
func Sign2 ¶
Sign2 signs a request with Signed Signature Version 2. If the service you're accessing supports Version 4, use that instead.
func Sign3 ¶
Sign3 signs a request with Signed Signature Version 3. If the service you're accessing supports Version 4, use that instead.
func SignS3 ¶
SignS3 signs a request bound for Amazon S3 using their custom HTTP authentication scheme.
Types ¶
type Credentials ¶
var Keys *Credentials
Keys stores the authentication credentials to be used when signing requests. You can set them manually or leave it to awsauth to use environment variables.
Source Files