package internal

Import Path
	golang.org/x/oauth2/internal (on go.dev)

Dependency Relation
	imports 18 packages, and imported by 3 packages

Involved Source Files

	   d➜ doc.go
		Package internal contains support packages for oauth2 package.

	      oauth2.go
	      token.go
	      transport.go
Package-Level Type Names (total 6, in which 4 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type AuthStyle int (basic type)
		AuthStyle is a copy of the golang.org/x/oauth2 package's AuthStyle type.

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func lookupAuthStyle(tokenURL string) (style AuthStyle, ok bool)
		As Inputs Of (at least 3, in which 1 are exported)
			func RetrieveToken(ctx context.Context, clientID, clientSecret, tokenURL string, v url.Values, authStyle AuthStyle) (*Token, error)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func newTokenRequest(tokenURL, clientID, clientSecret string, v url.Values, authStyle AuthStyle) (*http.Request, error)
			func setAuthStyle(tokenURL string, v AuthStyle)
		As Types Of (total 3, all are exported)
			const AuthStyleInHeader
			const AuthStyleInParams
			const AuthStyleUnknown

	 type ContextKey (struct)
		ContextKey is just an empty struct. It exists so HTTPClient can be
		an immutable public variable with a unique type. It's immutable
		because nobody else can create a ContextKey, being unexported.

		As Types Of (total 2, both are exported)
			  var HTTPClient
			  var golang.org/x/oauth2.HTTPClient

	 type RetrieveError (struct)

		Fields (total 2, both are exported)
			Body []byte
			Response *http.Response
		Methods (only one, which is exported)
			(*T) Error() string
		Implements (at least one exported)
			*T : error

	 type Token (struct)
		Token represents the credentials used to authorize
		the requests to access protected resources on the OAuth 2.0
		provider's backend.

		This type is a mirror of oauth2.Token and exists to break
		an otherwise-circular dependency. Other internal packages
		should convert this Token into an oauth2.Token before use.

		Fields (total 5, all are exported)
			AccessToken string
				AccessToken is the token that authorizes and authenticates
				the requests.

			Expiry time.Time
				Expiry is the optional expiration time of the access token.

				If zero, TokenSource implementations will reuse the same
				token forever and RefreshToken or equivalent
				mechanisms for that TokenSource will not be used.

			Raw interface{}
				Raw optionally contains extra metadata from the server
				when updating a token.

			RefreshToken string
				RefreshToken is a token that's used by the application
				(as opposed to the user) to refresh the access token
				if it expires.

			TokenType string
				TokenType is the type of token.
				The Type method returns either this or "Bearer", the default.

		As Outputs Of (at least 2, in which 1 are exported)
			func RetrieveToken(ctx context.Context, clientID, clientSecret, tokenURL string, v url.Values, authStyle AuthStyle) (*Token, error)
			/* at least one unexported ... *//* at least one unexported: */
			func doTokenRoundTrip(ctx context.Context, req *http.Request) (*Token, error)
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func golang.org/x/oauth2.tokenFromInternal(t *Token) *oauth2.Token

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type expirationTime int32 (basic type)

		Methods (only one, which is exported)
			(*T) UnmarshalJSON(b []byte) error
		Implements (at least one exported)
			*T : encoding/json.Unmarshaler

	 type tokenJSON (struct)
		tokenJSON is the struct representing the HTTP response from OAuth2
		providers returning a token in JSON form.

		Fields (total 4, all are exported)
			AccessToken string
			ExpiresIn expirationTime
				// at least PayPal returns string, while most return number

			RefreshToken string
			TokenType string
		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*T) expiry() (t time.Time)


Package-Level Functions (total 10, in which 5 are exported)

	 func ContextClient(ctx context.Context) *http.Client
	 func ParseKey(key []byte) (*rsa.PrivateKey, error)
		ParseKey converts the binary contents of a private key file
		to an *rsa.PrivateKey. It detects whether the private key is in a
		PEM container or not. If so, it extracts the the private key
		from PEM container before conversion. It only supports PEM
		containers with no passphrase.

	 func RegisterBrokenAuthHeaderProvider(tokenURL string)
		RegisterBrokenAuthHeaderProvider previously did something. It is now a no-op.

		Deprecated: this function no longer does anything. Caller code that
		wants to avoid potential extra HTTP requests made during
		auto-probing of the provider's auth style should set
		Endpoint.AuthStyle.

	 func ResetAuthCache()
		ResetAuthCache resets the global authentication style cache used
		for AuthStyleUnknown token requests.

	 func RetrieveToken(ctx context.Context, clientID, clientSecret, tokenURL string, v url.Values, authStyle AuthStyle) (*Token, error)
	/* 5 unexporteds ... *//* 5 unexporteds: */
	 func cloneURLValues(v url.Values) url.Values
	 func doTokenRoundTrip(ctx context.Context, req *http.Request) (*Token, error)
	 func lookupAuthStyle(tokenURL string) (style AuthStyle, ok bool)
		lookupAuthStyle reports which auth style we last used with tokenURL
		when calling RetrieveToken and whether we have ever done so.

	 func newTokenRequest(tokenURL, clientID, clientSecret string, v url.Values, authStyle AuthStyle) (*http.Request, error)
		newTokenRequest returns a new *http.Request to retrieve a new token
		from tokenURL using the provided clientID, clientSecret, and POST
		body parameters.

		inParams is whether the clientID & clientSecret should be encoded
		as the POST body. An 'inParams' value of true means to send it in
		the POST body (along with any values in v); false means to send it
		in the Authorization header.

	 func setAuthStyle(tokenURL string, v AuthStyle)
		setAuthStyle adds an entry to authStyleCache, documented above.


Package-Level Variables (total 3, in which 1 are exported)

	  var HTTPClient ContextKey
		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.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var appengineClientHook (context.Context) *http.Client
	  var authStyleCache struct{sync.Mutex; m map[string]AuthStyle}
		authStyleCache is the set of tokenURLs we've successfully used via
		RetrieveToken and which style auth we ended up using.
		It's called a cache, but it doesn't (yet?) shrink. It's expected that
		the set of OAuth2 servers a program contacts over time is fixed and
		small.


Package-Level Constants (total 3, all are exported)

	const AuthStyleInHeader AuthStyle = 2
	const AuthStyleInParams AuthStyle = 1
	const AuthStyleUnknown AuthStyle = 0

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.