1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
package examples_test
import (
"encoding/json"
"fmt"
"os"
"github.com/lestrrat-go/jwx/v2/jwt"
)
func Example_jwt_flatten_audience() {
// Sometimes you need to "flatten" the "aud" claim because of
// parsers developed by people who apparently didn't read the RFC.
//
// In such cases, you can control the behavior of the JSON
// emitted when tokens are converted to JSON by tweaking the
// per-token options set.
{ // Case 1: the per-object way
tok, err := jwt.NewBuilder().
Audience([]string{`foo`}).
Build()
if err != nil {
fmt.Printf("failed to build token: %s\n", err)
return
}
// Only this particular instance of the token is affected
tok.Options().Enable(jwt.FlattenAudience)
json.NewEncoder(os.Stdout).Encode(tok)
}
{ // Case 2: globally enabling flattened audience
// NOTE: This example DOES NOT flatten the audience
// because the call to change this global settings has been
// commented out. Setting this has GLOBAL effects, and would
// alter the output of other examples.
//
// If you would like to try this, UNCOMMENT the line below
//
// // UNCOMMENT THIS LINE BELOW
// jwt.Settings(jwt.WithFlattenAudience(true))
//
// ...and if you are running from the examples directory, run
// this example in isolation by invoking
//
// go test -run=ExampleJWT_FlattenAudience
//
// You may see the example fail, but that's because the OUTPUT line
// expects the global settings to be DISABLED. In order to make
// the example pass, change the second line from OUTPUT below
//
// from: {"aud":["foo"]}
// to : {"aud":"foo"}
//
// Please note that it is recommended you ONLY set the jwt.Settings(jwt.WithFlattenedAudience(true))
// once at the beginning of your main program (probably in an `init()` function)
// so that you do not need to worry about causing issues depending
// on when tokens are created relative to the time when
// the global setting is changed.
tok, err := jwt.NewBuilder().
Audience([]string{`foo`}).
Build()
if err != nil {
fmt.Printf("failed to build token: %s\n", err)
return
}
// This would flatten the "aud" claim if the appropriate
// line above has been uncommented
json.NewEncoder(os.Stdout).Encode(tok)
// This would force this particular object not to flatten the
// "aud" claim. All other tokens would be constructed with the
// option enabled
tok.Options().Enable(jwt.FlattenAudience)
json.NewEncoder(os.Stdout).Encode(tok)
}
// OUTPUT:
// {"aud":"foo"}
// {"aud":["foo"]}
// {"aud":"foo"}
}
|
