-
Notifications
You must be signed in to change notification settings - Fork 21
/
samples_test.go
257 lines (226 loc) · 6.62 KB
/
samples_test.go
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
package biscuittest
import (
"crypto/ed25519"
"crypto/rand"
"encoding/hex"
"encoding/json"
"fmt"
"os"
"sort"
"testing"
"github.com/biscuit-auth/biscuit-go/v2"
"github.com/biscuit-auth/biscuit-go/v2/parser"
"github.com/stretchr/testify/require"
)
type Samples struct {
RootPrivateKey string `json:"root_private_key"`
RootPublicKey string `json:"root_public_key"`
TestCases []TestCase `json:"testcases"`
}
type TestCase struct {
Title string `json:"title"`
Filename string `json:"filename"`
Token []Block `json:"token"`
Validations map[string]Validation `json:"validations"`
}
type Block struct {
Symbols []string `json:"symbols"`
PublicKeys []any `json:"public_keys"`
ExternalKey any `json:"external_key"`
Code string `json:"code"`
}
type Result struct {
Ok *int `json:"Ok"`
Err *BiscuitError `json:"Err"`
}
type BiscuitError struct {
FailedLogic *struct {
Unauthorized *struct {
Policy struct {
Allow int `json:"Allow"`
} `json:"policy"`
Checks []struct {
Block struct {
BlockID int `json:"block_id"`
CheckID int `json:"check_id"`
Rule string `json:"rule"`
} `json:"Block"`
} `json:"checks"`
} `json:"Unauthorized"`
InvalidBlockRule []any `json:"InvalidBlockRule"`
} `json:"FailedLogic"`
Format *struct {
Signature *struct {
InvalidSignature string `json:"InvalidSignature"`
} `json:"Signature"`
} `json:"Format"`
}
type World struct {
Facts []ScopedFact `json:"facts"`
Rules []ScopedRule `json:"rules"`
Checks []string `json:"checks"`
Policies []string `json:"policies"`
}
type ScopedFact struct {
Fact string
Scope [](*int32)
}
func (sf *ScopedFact) UnmarshalJSON(buf []byte) error {
tmp := []interface{}{&sf.Fact, &sf.Scope}
wantLen := len(tmp)
if err := json.Unmarshal(buf, &tmp); err != nil {
return err
}
if g, e := len(tmp), wantLen; g != e {
return fmt.Errorf("wrong number of fields in ScopedFact: %d != %d", g, e)
}
return nil
}
type ScopedRule struct {
Rule string
Scope *int32
}
func (sr *ScopedRule) UnmarshalJSON(buf []byte) error {
tmp := []interface{}{&sr.Rule, &sr.Scope}
wantLen := len(tmp)
if err := json.Unmarshal(buf, &tmp); err != nil {
return err
}
if g, e := len(tmp), wantLen; g != e {
return fmt.Errorf("wrong number of fields in ScopedRule: %d != %d", g, e)
}
return nil
}
func (w World) String() string {
facts := []string{}
for _, f := range w.Facts {
visible := true
for _, s := range f.Scope {
if s != nil && *s != 0 {
visible = false
break
}
}
if visible {
facts = append(facts, f.Fact)
}
}
sort.Strings(facts)
rules := []string{}
for _, r := range w.Rules {
if r.Scope == nil || *r.Scope == 0 {
rules = append(rules, r.Rule)
}
}
sort.Strings(rules)
return fmt.Sprintf("World {{\n\tfacts: %v\n\trules: %v\n}}", facts, rules)
}
type Validation struct {
World World `json:"world"`
Result Result `json:"result"`
AuthorizerCode string `json:"authorizer_code"`
RevocationIds []string `json:"revocation_ids"`
}
func CheckSample(root_key ed25519.PublicKey, c TestCase, t *testing.T) {
// all these contain v4 blocks, which are not supported yet
if c.Filename == "test024_third_party.bc" ||
c.Filename == "test025_check_all.bc" ||
c.Filename == "test026_public_keys_interning.bc" ||
c.Filename == "test027_integer_wraparound.bc" ||
c.Filename == "test028_expressions_v4.bc" {
t.SkipNow()
}
fmt.Printf("Checking sample %s\n", c.Filename)
b, err := os.ReadFile("./data/current/" + c.Filename)
require.NoError(t, err)
token, err := biscuit.Unmarshal(b)
if err == nil {
fmt.Printf(" Parsed file %s\n", c.Filename)
// this sample uses a tampered biscuit file on purpose
if c.Filename != "test006_reordered_blocks.bc" {
CompareBlocks(*token, c.Token, t)
}
for _, v := range c.Validations {
CompareResult(root_key, c.Filename, *token, v, t)
}
} else {
fmt.Println(err)
fmt.Println(" Parsing failed, all validations must be errors")
for _, v := range c.Validations {
require.Nil(t, v.Result.Ok)
}
}
}
func CompareBlocks(token biscuit.Biscuit, blocks []Block, t *testing.T) {
sample := token.Code()
p := parser.New()
rng := rand.Reader
_, privateRoot, _ := ed25519.GenerateKey(rng)
authority, err := p.Block(blocks[0].Code, nil)
require.NoError(t, err)
builder := biscuit.NewBuilder(privateRoot)
builder.AddBlock(authority)
r, err := builder.Build()
require.NoError(t, err)
rebuilt := *r
for _, b := range blocks[1:] {
parsed, err := p.Block(b.Code, nil)
require.NoError(t, err)
builder := rebuilt.CreateBlock()
builder.AddBlock(parsed)
r, err := rebuilt.Append(rng, builder.Build())
require.NoError(t, err)
rebuilt = *r
}
require.Equal(t, sample, rebuilt.Code())
}
func CompareResult(root_key ed25519.PublicKey, filename string, token biscuit.Biscuit, v Validation, t *testing.T) {
p := parser.New()
authorizer_code, err := p.Authorizer(v.AuthorizerCode, nil)
require.NoError(t, err)
authorizer, err := token.Authorizer(root_key)
if err != nil {
CompareError(err, v.Result.Err, t)
} else {
authorizer.AddAuthorizer(authorizer_code)
err = authorizer.Authorize()
if err != nil {
CompareError(err, v.Result.Err, t)
} else {
require.NotNil(t, v.Result.Ok)
}
require.Equal(t, v.World.String(), authorizer.PrintWorld())
}
}
func CompareError(authorization_error error, sample_error *BiscuitError, t *testing.T) {
error_string := authorization_error.Error()
if sample_error.Format != nil {
require.Equal(t, error_string, "biscuit: invalid signature")
} else if sample_error.FailedLogic != nil {
if sample_error.FailedLogic.Unauthorized != nil {
// todo check the block and check ids (if there is a single failed check, because the lib only reports one)
require.Regexp(t, "^biscuit: verification failed: failed to verify", error_string)
} else if sample_error.FailedLogic.InvalidBlockRule != nil {
// todo extract the block number
require.Regexp(t, "^biscuit: verification failed: failed to verify", error_string)
} else {
require.Fail(t, error_string)
}
} else {
fmt.Println(sample_error)
require.Fail(t, error_string)
}
}
func TestReadSamples(t *testing.T) {
b, err := os.ReadFile("./data/current/samples.json")
require.NoError(t, err)
var samples Samples
err = json.Unmarshal(b, &samples)
require.NoError(t, err)
root_key, err := hex.DecodeString(samples.RootPublicKey)
require.NoError(t, err)
fmt.Printf("Checking %d samples\n", len(samples.TestCases))
for _, v := range samples.TestCases {
t.Run(v.Filename, func(t *testing.T) { CheckSample(root_key, v, t) })
}
}