auth

Documentation

Overview

Package auth contains a non-exhaustive list of custom authentication round trippers to be used as authentication middleware with a gidari HTTP Service.

Index

• type RoundTrip
  • func NewBasicAuthRoundTrip(username, password string) RoundTrip
  • func NewCoinbaseRoundTrip(key, secret, passphrase string) RoundTrip

Types

type RoundTrip

type RoundTrip func(*http.Request) (*http.Response, error)

RoundTrip is an HTTP round tripper that acts as a middleware to add auth requirements to HTTP requests.

func NewBasicAuthRoundTrip

func NewBasicAuthRoundTrip(username, password string) RoundTrip

NewBasicAuthRoundTrip will return a "RoundTrip" function that can be used as a "RoundTrip" function in an "http.RoundTripper" interface to authenticate requests that require basic authentication.

func NewCoinbaseRoundTrip

func NewCoinbaseRoundTrip(key, secret, passphrase string) RoundTrip

NewCoinbaseRoundTrip will return a "RoundTrip" function that can be used as a "RoundTrip" function in an "http.RoundTripper" interface to authenticate requests to the Coinbase Cloud API.