modulepackage
0.0.0-20221105022016-c8d72c12d74c
Repository: https://github.com/shnplr/oauth2.git
Documentation: pkg.go.dev
# README
OAuth2 for Go
oauth2 package contains a client implementation for OAuth 2.0 spec.
Installation
go get golang.org/x/oauth2
Or you can manually git clone the repository to
$(go env GOPATH)/src/golang.org/x/oauth2
.
See pkg.go.dev for further documentation and examples.
Policy for new packages
We no longer accept new provider-specific packages in this repo if all they do is add a single endpoint variable. If you just want to add a single endpoint, add it to the pkg.go.dev/golang.org/x/oauth2/endpoints package.
Report Issues / Send Patches
This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.
The main issue tracker for the oauth2 repository is located at https://github.com/golang/oauth2/issues.
# Packages
Package authhandler implements a TokenSource to support "three-legged OAuth 2.0" via a custom AuthorizationHandler.
# Functions
NewClient creates an *http.Client from a Context and TokenSource.
RegisterBrokenAuthHeaderProvider previously did something.
ReuseTokenSource returns a TokenSource which repeatedly returns the same token as long as it's valid, starting with t.
SetAuthURLParam builds an AuthCodeOption which passes key/value parameters to a provider's authorization endpoint.
StaticTokenSource returns a TokenSource that always returns the same token.
# Constants
AuthStyleAutoDetect means to auto-detect which authentication style the provider wants by trying both ways and caching the successful way for the future.
AuthStyleInHeader sends the client_id and client_password using HTTP Basic Authorization.
AuthStyleInParams sends the "client_id" and "client_secret" in the POST body as application/x-www-form-urlencoded parameters.
# Variables
No description provided by the author
AccessTypeOnline and AccessTypeOffline are options passed to the Options.AuthCodeURL method.
ApprovalForce forces the users to view the consent dialog and confirm the permissions request at the URL returned from AuthCodeURL, even if they've already done so.
HTTPClient is the context key to use with golang.org/x/net/context's WithValue function to associate an *http.Client value with a context.
NoContext is the default context you should supply if not using your own context.Context (see https://golang.org/x/net/context).
# Structs
Config describes a typical 3-legged OAuth2 flow, with both the client application information and the server's endpoint URLs.
No description provided by the author
Endpoint represents an OAuth 2.0 provider's authorization and token endpoint URLs.
RetrieveError is the error returned when the token endpoint returns a non-2XX HTTP status code.
Token represents the credentials used to authorize the requests to access protected resources on the OAuth 2.0 provider's backend.
Transport is an http.RoundTripper that makes OAuth 2.0 HTTP requests, wrapping a base RoundTripper and adding an Authorization header with a token from the supplied Sources.
# Interfaces
An AuthCodeOption is passed to Config.AuthCodeURL.
A TokenSource is anything that can return a token.
# Type aliases
AuthStyle represents how requests for tokens are authenticated to the server.