Fork of oauth 2 to allow the exposing of token refresher
Go to file
Brad Fitzpatrick a835fc4358 oauth2: move global auth style cache to be per-Config
In 80673b4a4 (https://go.dev/cl/157820) I added a never-shrinking
package-global cache to remember which auto-detected auth style (HTTP
headers vs POST) was supported by a certain OAuth2 server, keyed by
its URL.

Unfortunately, some multi-tenant SaaS OIDC servers behave poorly and
have one global OpenID configuration document for all of their
customers which says ("we support all auth styles! you pick!") but
then give each customer control of which style they specifically
accept. This is bogus behavior on their part, but the oauth2 package's
global caching per URL isn't helping. (It's also bad to have a
package-global cache that can never be GC'ed)

So, this change moves the cache to hang off the oauth *Configs
instead. Unfortunately, it does so with some backwards compatiblity
compromises (an atomic.Value hack), lest people are using old versions
of Go still or copying a Config by value, both of which this package
previously accidentally supported, even though they weren't tested.

This change also means that anybody that's repeatedly making ephemeral
oauth.Configs without an explicit auth style will be losing &
reinitializing their cache on any auth style failures + fallbacks to
the other style. I think that should be pretty rare. People seem to
make an oauth2.Config once earlier and stash it away somewhere (often
deep in a token fetcher or HTTP client/transport).

Change-Id: I91f107368ab3c3d77bc425eeef65372a589feb7b
Signed-off-by: Brad Fitzpatrick <bradfitz@golang.org>
Reviewed-on: https://go-review.googlesource.com/c/oauth2/+/515675
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Roland Shoemaker <roland@golang.org>
Reviewed-by: Adrian Dewhurst <adrian@tailscale.com>
Reviewed-by: Michael Knyszek <mknyszek@google.com>
2023-08-09 17:53:10 +00:00
amazon amazon: add amazon endpoints 2017-04-12 23:27:59 +00:00
authhandler authhandler: Add support for PKCE 2022-06-22 18:31:10 +00:00
bitbucket bitbucket: add end points 2015-09-17 03:41:47 +00:00
cern cern: add CERN OAuth endpoint 2018-05-29 17:07:32 +00:00
clientcredentials oauth2: move global auth style cache to be per-Config 2023-08-09 17:53:10 +00:00
endpoints all: gofmt 2022-04-11 21:57:20 +00:00
facebook internal: remove fallback parsing for expires_in 2019-03-19 18:23:50 +00:00
fitbit fitbit: add Fitbit API endpoints 2016-03-23 03:46:10 +00:00
foursquare oauth2: add Foursquare's Endpoint 2016-10-25 20:08:26 +00:00
github all: change copyright to 'Go Authors' 2015-10-22 04:14:42 +00:00
gitlab gitlab: Use correct endpoint URLs 2018-05-21 19:08:22 +00:00
google all: update go version to 1.18 2023-07-05 21:55:59 +00:00
heroku heroku: Add Heroku's endpoints 2016-08-23 22:06:57 +00:00
hipchat hipchat: Generate Config for Connect integrations 2016-04-28 20:45:44 +00:00
instagram instagram: add Instagram endpoints 2018-07-24 15:53:51 +00:00
internal oauth2: move global auth style cache to be per-Config 2023-08-09 17:53:10 +00:00
jira all: remove redundant type conversion 2022-09-09 00:33:41 +00:00
jws all: remove redundant type conversion 2022-09-09 00:33:41 +00:00
jwt jwt: support PrivateClaims in Config 2019-05-17 18:12:55 +00:00
kakao kakao: Add new endpoint of Kakao 2018-05-28 19:57:36 +00:00
linkedin oauth2: auto-detect auth style by default, add Endpoint.AuthStyle 2019-02-11 18:49:51 +00:00
mailchimp mailchimp: add MailChimp provider 2018-02-28 17:30:56 +00:00
mailru mailru: add Mail.Ru OAuth2 endpoint 2017-12-15 22:01:12 +00:00
mediamath mediamath: add MediaMath endpoints 2016-08-17 16:31:01 +00:00
microsoft microsoft: improve azure active directory endpoint 2017-12-13 21:28:14 +00:00
nokiahealth nokiehealth: add endpoint for Nokia Health Mate 2018-08-21 21:23:33 +00:00
odnoklassniki all: change copyright to 'Go Authors' 2015-10-22 04:14:42 +00:00
paypal all: change copyright to 'Go Authors' 2015-10-22 04:14:42 +00:00
slack slack: new package with Slack's endpoints 2016-02-17 21:10:11 +00:00
spotify spotify: add Spotify endpoints 2018-01-04 23:00:36 +00:00
stackoverflow stackoverflow: add stackoverflow oauth2 endpoints. 2018-06-20 17:54:06 +00:00
twitch twitch: update to new endpoint 2018-05-21 19:16:39 +00:00
uber uber: Add Uber API endpoints 2016-08-10 17:35:16 +00:00
vk all: change copyright to 'Go Authors' 2015-10-22 04:14:42 +00:00
yahoo yahoo: add Yahoo OAuth2 endpoint 2017-12-15 00:49:36 +00:00
yandex oauth2: add Yandex endpoint 2017-02-27 16:23:13 +00:00
.travis.yml travis: always build against tip 2016-05-20 18:58:28 +00:00
CONTRIBUTING.md CONTRIBUTING.md: remove note about not accepting Pull Requests 2018-03-14 18:02:39 +00:00
LICENSE LICENSE: attribute to the Go authors 2017-08-02 15:54:48 +00:00
README.md README: encourage issues and proposals before changes 2023-03-10 21:26:16 +00:00
example_test.go oauth2: improve the custom HTTP client example 2017-09-01 19:30:52 +00:00
go.mod go.mod: update golang.org/x dependencies 2023-08-04 23:51:27 +00:00
go.sum go.mod: update golang.org/x dependencies 2023-08-04 23:51:27 +00:00
oauth2.go oauth2: move global auth style cache to be per-Config 2023-08-09 17:53:10 +00:00
oauth2_test.go oauth2: move global auth style cache to be per-Config 2023-08-09 17:53:10 +00:00
token.go oauth2: move global auth style cache to be per-Config 2023-08-09 17:53:10 +00:00
token_test.go oauth2: add ReuseTokenSourceWithExpiry 2023-03-28 18:36:12 +00:00
transport.go oauth2: turn Transport.CancelRequest into a no-op 2019-12-02 22:59:59 +00:00
transport_test.go oauth2: close request body if errors occur before base RoundTripper is invoked 2018-05-29 20:36:26 +00:00

README.md

OAuth2 for Go

Go Reference Build Status

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 endpoints

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

The main issue tracker for the oauth2 repository is located at https://github.com/golang/oauth2/issues.

This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html. In particular:

  • Excluding trivial changes, all contributions should be connected to an existing issue.
  • API changes must go through the change proposal process before they can be accepted.
  • The code owners are listed at dev.golang.org/owners.