jws

Documentation

Overview

Package jws provides encoding and decoding utilities for signed JWS messages.

Index

• func Encode(header *Header, c *ClaimSet, signature *rsa.PrivateKey) (payload string, err error)
• type ClaimSet
  • func Decode(payload string) (c *ClaimSet, err error)
• type Header

Functions

func Encode

func Encode(header *Header, c *ClaimSet, signature *rsa.PrivateKey) (payload string, err error)

Encode encodes a signed JWS with provided header and claim set.

Types

type ClaimSet

type ClaimSet struct {
	Iss   string `json:"iss"`             // email address of the client_id of the application making the access token request
	Scope string `json:"scope,omitempty"` // space-delimited list of the permissions the application requests
	Aud   string `json:"aud"`             // descriptor of the intended target of the assertion (Optional).
	Exp   int64  `json:"exp"`             // the expiration time of the assertion
	Iat   int64  `json:"iat"`             // the time the assertion was issued.
	Typ   string `json:"typ,omitempty"`   // token type (Optional).

	// Email for which the application is requesting delegated access (Optional).
	Sub string `json:"sub,omitempty"`

	// The old name of Sub. Client keeps setting Prn to be
	// complaint with legacy OAuth 2.0 providers. (Optional)
	Prn string `json:"prn,omitempty"`

	// 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()).
	PrivateClaims map[string]interface{} `json:"-"`
	// contains filtered or unexported fields
}

The JWT claim set contains information about the JWT 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.

func Decode

func Decode(payload string) (c *ClaimSet, err error)

Decode decodes a claim set from a JWS payload.

type Header

type Header struct {
	// The algorithm used for signature.
	Algorithm string `json:"alg"`

	// Represents the token type.
	Typ string `json:"typ"`
}

Header represents the header for the signed JWS payloads.