package jws

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

Dependency Relation
	imports 11 packages, and imported by 2 packages

Involved Source Files

	   d➜ jws.go
		Package jws provides a partial implementation
		of JSON Web Signature encoding and decoding.
		It exists to support the golang.org/x/oauth2 package.

		See RFC 7515.

		Deprecated: this package is not intended for public use and might be
		removed in the future. It exists for internal use only.
		Please switch to another JWS package or copy this package into your own
		source tree.
Package-Level Type Names (total 3, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type ClaimSet (struct)
		ClaimSet contains information about the JWT signature including the
		permissions being requested (scopes), the target of the token, the issuer,
		the time the token was issued, and the lifetime of the token.

		Fields (total 9, all are exported)
			Aud string
				// descriptor of the intended target of the assertion (Optional).

			Exp int64
				// the expiration time of the assertion (seconds since Unix epoch)

			Iat int64
				// the time the assertion was issued (seconds since Unix epoch)

			Iss string
				// email address of the client_id of the application making the access token request

			PrivateClaims map[string]interface{}
				See http://tools.ietf.org/html/draft-jones-json-web-token-10#section-4.3
				This array is marshalled using custom code (see (c *ClaimSet) encode()).

			Prn string
				The old name of Sub. Client keeps setting Prn to be
				complaint with legacy OAuth 2.0 providers. (Optional)

			Scope string
				// space-delimited list of the permissions the application requests

			Sub string
				Email for which the application is requesting delegated access (Optional).

			Typ string
				// token type (Optional).

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*T) encode() (string, error)
		As Outputs Of (at least one exported)
			func Decode(payload string) (*ClaimSet, error)
		As Inputs Of (at least 2, both are exported)
			func Encode(header *Header, c *ClaimSet, key *rsa.PrivateKey) (string, error)
			func EncodeWithSigner(header *Header, c *ClaimSet, sg Signer) (string, error)

	 type Header (struct)
		Header represents the header for the signed JWS payloads.

		Fields (total 3, all are exported)
			Algorithm string
				The algorithm used for signature.

			KeyID string
				The optional hint of which key is being used.

			Typ string
				Represents the token type.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*T) encode() (string, error)
		As Inputs Of (at least 2, both are exported)
			func Encode(header *Header, c *ClaimSet, key *rsa.PrivateKey) (string, error)
			func EncodeWithSigner(header *Header, c *ClaimSet, sg Signer) (string, error)
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var golang.org/x/oauth2/jwt.defaultHeader *Header

	 type Signer (func)
		Signer returns a signature for the given data.

		As Inputs Of (at least one exported)
			func EncodeWithSigner(header *Header, c *ClaimSet, sg Signer) (string, error)


Package-Level Functions (total 4, all are exported)

	 func Decode(payload string) (*ClaimSet, error)
		Decode decodes a claim set from a JWS payload.

	 func Encode(header *Header, c *ClaimSet, key *rsa.PrivateKey) (string, error)
		Encode encodes a signed JWS with provided header and claim set.
		This invokes EncodeWithSigner using crypto/rsa.SignPKCS1v15 with the given RSA private key.

	 func EncodeWithSigner(header *Header, c *ClaimSet, sg Signer) (string, error)
		EncodeWithSigner encodes a header and claim set with the provided signer.

	 func Verify(token string, key *rsa.PublicKey) error
		Verify tests whether the provided JWT token's signature was produced by the private key
		associated with the supplied public key.

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.