sign

README

Aliyun api gateway request signature algorithm implemented by go

English ∙ 简体中文

For signature methods, see: using digital signature authentication to call api

Installation

Download package by using:

$ go get github.com/sliveryou/aliyun-api-gateway-sign

Usage Example

package main

import (
	"io/ioutil"
	"log"
	"net/http"
	"net/http/httputil"
	"strings"

	sign "github.com/sliveryou/aliyun-api-gateway-sign"
)

func main() {
	var url string = "https://bankcard4c.shumaidata.com/bankcard4c"
	var body string
	var appKey, appKeySecret string

	// Prepare a HTTP request.
	req, err := http.NewRequest(sign.HTTPMethodPost, url, strings.NewReader(body))
	if err != nil {
		// Handle err.
		panic(err)
	}
	// Set the request with headers.
	req.Header.Set(sign.HTTPHeaderAccept, sign.HTTPContentTypeJson)
	req.Header.Set(sign.HTTPHeaderContentType, sign.HTTPContentTypeJson)

	// Sign the request.
	if err := sign.Sign(req, appKey, appKeySecret); err != nil {
		panic(err)
	}

	// Show the dump request.
	dumpReq, err := httputil.DumpRequestOut(req, true)
	if err != nil {
		panic(err)
	}
	log.Println("\n" + string(dumpReq))

	// Do the request.
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	// Handle response.
	content, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	log.Println("\n"+string(content), resp.StatusCode, resp.Header.Get("X-Ca-Error-Message"))
}

Documentation

Index

• Constants
• func CurrentGMTDate() string
• func CurrentTimeMillis() string
• func HmacSHA256(b, key []byte) string
• func MD5(b []byte) string
• func Sign(req *http.Request, appKey, appKeySecret string) error
• func UUID4() string

Constants

const (
	HTTPHeaderAccept      = "Accept"
	HTTPHeaderContentMD5  = "Content-MD5"
	HTTPHeaderContentType = "Content-Type"
	HTTPHeaderDate        = "Date"
	HTTPHeaderUserAgent   = "User-Agent"
)

HTTP header keys.

const (
	HTTPHeaderCAPrefix           = "X-Ca-"
	HTTPHeaderCAKey              = "X-Ca-Key"
	HTTPHeaderCANonce            = "X-Ca-Nonce"
	HTTPHeaderCASignature        = "X-Ca-Signature"
	HTTPHeaderCASignatureHeaders = "X-Ca-Signature-Headers"
	HTTPHeaderCASignatureMethod  = "X-Ca-Signature-Method"
	HTTPHeaderCATimestamp        = "X-Ca-Timestamp"
)

HTTP header keys used for Aliyun API gateway signature.

const (
	HTTPContentTypeForm                      = "application/x-www-form-urlencoded"
	HTTPContentTypeMultipartForm             = "multipart/form-data"
	HTTPContentTypeMultipartFormWithBoundary = "multipart/form-data; boundary="
	HTTPContentTypeStream                    = "application/octet-stream"
	HTTPContentTypeJson                      = "application/json"
	HTTPContentTypeXml                       = "application/xml"
	HTTPContentTypeText                      = "text/plain"
)

HTTP header content-type values.

const (
	HTTPMethodGet     = "GET"
	HTTPMethodPost    = "POST"
	HTTPMethodPut     = "PUT"
	HTTPMethodDelete  = "DELETE"
	HTTPMethodPatch   = "PATCH"
	HTTPMethodHead    = "HEAD"
	HTTPMethodOptions = "OPTIONS"
)

HTTP method values.

Functions

func CurrentGMTDate

func CurrentGMTDate() string

CurrentGMTDate returns the GMT date representation of the current time.

func CurrentTimeMillis

func CurrentTimeMillis() string

CurrentTimeMillis returns the millisecond representation of the current time.

func HmacSHA256

func HmacSHA256(b, key []byte) string

HmacSHA256 returns the string encrypted with HmacSHA256 method.

func MD5

func MD5(b []byte) string

MD5 returns the string hashed with MD5 method.

func Sign

func Sign(req *http.Request, appKey, appKeySecret string) error

Sign will sign the request with appKey and appKeySecret.

func UUID4

func UUID4() string

UUID4 returns random generated UUID string.