remoteoauth

Documentation

Index

• func NewAuthTransport(ts oauth2.TokenSource) http.RoundTripper
• func NewTokenSource(opts ...TokenSourceOption) (oauth2.TokenSource, error)
• func TokenAuthEditor(tokenSource oauth2.TokenSource) func(context.Context, *http.Request) error
• type RewriterFunc
• type TokenAuthTransport
  • func (t *TokenAuthTransport) RoundTrip(req *http.Request) (*http.Response, error)
• type TokenSourceOption
  • func WithAccessToken(token, tokenType string, expiry time.Time) TokenSourceOption
  • func WithDefaultContext(ctx context.Context) TokenSourceOption
  • func WithToken(token oauth2.Token) TokenSourceOption

Functions

func NewAuthTransport

func NewAuthTransport(ts oauth2.TokenSource) http.RoundTripper

NewAuthTransport creates a new TokenAuthTransport with the provided TokenSource

func NewTokenSource

func NewTokenSource(opts ...TokenSourceOption) (oauth2.TokenSource, error)

func TokenAuthEditor

func TokenAuthEditor(tokenSource oauth2.TokenSource) func(context.Context, *http.Request) error

TokenAuthEditor returns a custom RequestEditorFn to inject the OAuth2 token

Types

type RewriterFunc

type RewriterFunc func(*http.Request, oauth2.Token)

RewriterFunc is a function that can be used to rewrite the request before it is sent

type TokenAuthTransport

type TokenAuthTransport struct {
	TokenSource oauth2.TokenSource // required

	BaseTransport http.RoundTripper
	Rewriter      RewriterFunc
}

TokenAuthTransport is a custom http.RoundTripper to inject the OAuth2 token

func (*TokenAuthTransport) RoundTrip

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

RoundTrip executes a single HTTP transaction and injects the token into the request header

type TokenSourceOption

type TokenSourceOption func(source *tokenSource)

func WithAccessToken

func WithAccessToken(token, tokenType string, expiry time.Time) TokenSourceOption

WithAccessToken sets the access token, token type and expiry time for the token source. Deprecated: Use WithToken instead.

func WithDefaultContext

func WithDefaultContext(ctx context.Context) TokenSourceOption

WithDefaultContext sets the default context for the token source, used when creating a new token request.

func WithToken

func WithToken(token oauth2.Token) TokenSourceOption

WithToken sets the default token for the token source.