jwt

README

7.1. Creating a JWT

To create a JWT, the following steps are performed. The order of the steps is not significant in cases where there are no dependencies between the inputs and outputs of the steps.

1. Create a JWT Claims Set containing the desired claims. Note that whitespace is explicitly allowed in the representation and no canonicalization need be performed before encoding.

2. Let the Message be the octets of the UTF-8 representation of the JWT Claims Set.

3. Create a JOSE Header containing the desired set of Header Parameters. The JWT MUST conform to either the [JWS] or [JWE] specification. Note that whitespace is explicitly allowed in the representation and no canonicalization need be performed before encoding.

4. Depending upon whether the JWT is a JWS or JWE, there are two cases:

   • If the JWT is a JWS, create a JWS using the Message as the JWS Payload; all steps specified in [JWS] for creating a JWS MUST be followed.

   • Else, if the JWT is a JWE, create a JWE using the Message as the plaintext for the JWE; all steps specified in [JWE] for creating a JWE MUST be followed.

5. If a nested signing or encryption operation will be performed, let the Message be the JWS or JWE, and return to Step 3, using a "cty" (content type) value of "JWT" in the new JOSE Header created in that step.

6. Otherwise, let the resulting JWT be the JWS or JWE.

Validating a JWT

When validating a JWT, the following steps are performed. The order of the steps is not significant in cases where there are no dependencies between the inputs and outputs of the steps. If any of the listed steps fail, then the JWT MUST be rejected -- that is, treated by the application as an invalid input.

1. Verify that the JWT contains at least one period ('.') character.

2. Let the Encoded JOSE Header be the portion of the JWT before the first period ('.') character.

3. Base64url decode the Encoded JOSE Header following the restriction that no line breaks, whitespace, or other additional characters have been used.

4. Verify that the resulting octet sequence is a UTF-8-encoded representation of a completely valid JSON object conforming to RFC 7159 [RFC7159]; let the JOSE Header be this JSON object.

5. Verify that the resulting JOSE Header includes only parameters and values whose syntax and semantics are both understood and supported or that are specified as being ignored when not understood.

6. Determine whether the JWT is a JWS or a JWE using any of the methods described in Section 9 of [JWE].

7. Depending upon whether the JWT is a JWS or JWE, there are two cases:

   • If the JWT is a JWS, follow the steps specified in [JWS] for validating a JWS. Let the Message be the result of base64url decoding the JWS Payload.

   • Else, if the JWT is a JWE, follow the steps specified in [JWE] for validating a JWE. Let the Message be the resulting plaintext.

8. If the JOSE Header contains a "cty" (content type) value of "JWT", then the Message is a JWT that was the subject of nested signing or encryption operations. In this case, return to Step 1, using the Message as the JWT.

9. Otherwise, base64url decode the Message following the restriction that no line breaks, whitespace, or other additional characters have been used.

10. Verify that the resulting octet sequence is a UTF-8-encoded representation of a completely valid JSON object conforming to RFC 7159 [RFC7159]; let the JWT Claims Set be this JSON object.

Finally, note that it is an application decision which algorithms may be used in a given context. Even if a JWT can be successfully validated, unless the algorithms used in the JWT are acceptable to the application, it SHOULD reject the JWT.

Documentation

Index

• type TokenBuilder
  • func DecodeToken(tokenString string, key []byte) (*TokenBuilder, error)
  • func NewJWEToken(suite common.AlgorithmSuite, key []byte) *TokenBuilder
  • func NewJWSToken(algorithmType common.AlgorithmType, key []byte) *TokenBuilder
  • func (b *TokenBuilder) AddClaims(claims common.ClaimSet) *TokenBuilder
  • func (b *TokenBuilder) GetClaims() common.ClaimSet
  • func (b *TokenBuilder) Serialize() (string, error)
  • func (b *TokenBuilder) Validate() (bool, error)

Types

type TokenBuilder

type TokenBuilder struct {
	// contains filtered or unexported fields
}

func DecodeToken

func DecodeToken(tokenString string, key []byte) (*TokenBuilder, error)

func NewJWEToken

func NewJWEToken(suite common.AlgorithmSuite, key []byte) *TokenBuilder

func NewJWSToken

func NewJWSToken(algorithmType common.AlgorithmType, key []byte) *TokenBuilder

func (*TokenBuilder) AddClaims

func (b *TokenBuilder) AddClaims(claims common.ClaimSet) *TokenBuilder

func (*TokenBuilder) GetClaims

func (b *TokenBuilder) GetClaims() common.ClaimSet

func (*TokenBuilder) Serialize

func (b *TokenBuilder) Serialize() (string, error)

func (*TokenBuilder) Validate

func (b *TokenBuilder) Validate() (bool, error)