-
Notifications
You must be signed in to change notification settings - Fork 245
/
debug.go
202 lines (175 loc) · 6.14 KB
/
debug.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
package v1
import (
"context"
"fmt"
"sort"
"strings"
v1 "github.com/authzed/authzed-go/proto/authzed/api/v1"
cexpr "github.com/authzed/spicedb/internal/caveats"
"github.com/authzed/spicedb/pkg/datastore"
dispatch "github.com/authzed/spicedb/pkg/proto/dispatch/v1"
"github.com/authzed/spicedb/pkg/schemadsl/compiler"
"github.com/authzed/spicedb/pkg/schemadsl/generator"
"github.com/authzed/spicedb/pkg/tuple"
)
// ConvertCheckDispatchDebugInformation converts dispatch debug information found in the response metadata
// into DebugInformation returnable to the API.
func ConvertCheckDispatchDebugInformation(
ctx context.Context,
caveatContext map[string]any,
metadata *dispatch.ResponseMeta,
reader datastore.Reader,
) (*v1.DebugInformation, error) {
debugInfo := metadata.DebugInfo
if debugInfo == nil {
return nil, nil
}
caveats, err := reader.ListAllCaveats(ctx)
if err != nil {
return nil, err
}
namespaces, err := reader.ListAllNamespaces(ctx)
if err != nil {
return nil, err
}
defs := make([]compiler.SchemaDefinition, 0, len(namespaces)+len(caveats))
for _, caveat := range caveats {
defs = append(defs, caveat.Definition)
}
for _, ns := range namespaces {
defs = append(defs, ns.Definition)
}
schema, _, err := generator.GenerateSchema(defs)
if err != nil {
return nil, err
}
converted, err := convertCheckTrace(ctx, caveatContext, debugInfo.Check, reader)
if err != nil {
return nil, err
}
return &v1.DebugInformation{
Check: converted,
SchemaUsed: strings.TrimSpace(schema),
}, nil
}
func convertCheckTrace(ctx context.Context, caveatContext map[string]any, ct *dispatch.CheckDebugTrace, reader datastore.Reader) (*v1.CheckDebugTrace, error) {
permissionType := v1.CheckDebugTrace_PERMISSION_TYPE_UNSPECIFIED
if ct.ResourceRelationType == dispatch.CheckDebugTrace_PERMISSION {
permissionType = v1.CheckDebugTrace_PERMISSION_TYPE_PERMISSION
} else if ct.ResourceRelationType == dispatch.CheckDebugTrace_RELATION {
permissionType = v1.CheckDebugTrace_PERMISSION_TYPE_RELATION
}
subRelation := ct.Request.Subject.Relation
if subRelation == tuple.Ellipsis {
subRelation = ""
}
permissionship := v1.CheckDebugTrace_PERMISSIONSHIP_NO_PERMISSION
var partialResults []*dispatch.ResourceCheckResult
for _, checkResult := range ct.Results {
if checkResult.Membership == dispatch.ResourceCheckResult_MEMBER {
permissionship = v1.CheckDebugTrace_PERMISSIONSHIP_HAS_PERMISSION
break
}
if checkResult.Membership == dispatch.ResourceCheckResult_CAVEATED_MEMBER && permissionship != v1.CheckDebugTrace_PERMISSIONSHIP_HAS_PERMISSION {
permissionship = v1.CheckDebugTrace_PERMISSIONSHIP_CONDITIONAL_PERMISSION
partialResults = append(partialResults, checkResult)
}
}
var caveatEvalInfo *v1.CaveatEvalInfo
if permissionship == v1.CheckDebugTrace_PERMISSIONSHIP_CONDITIONAL_PERMISSION && len(partialResults) == 1 {
partialCheckResult := partialResults[0]
computedResult, err := cexpr.RunCaveatExpression(ctx, partialCheckResult.Expression, caveatContext, reader, cexpr.RunCaveatExpressionWithDebugInformation)
if err != nil {
return nil, err
}
var partialCaveatInfo *v1.PartialCaveatInfo
caveatResult := v1.CaveatEvalInfo_RESULT_FALSE
if computedResult.Value() {
caveatResult = v1.CaveatEvalInfo_RESULT_TRUE
} else if computedResult.IsPartial() {
caveatResult = v1.CaveatEvalInfo_RESULT_MISSING_SOME_CONTEXT
missingNames, _ := computedResult.MissingVarNames()
partialCaveatInfo = &v1.PartialCaveatInfo{
MissingRequiredContext: missingNames,
}
}
contextStruct, err := computedResult.ContextStruct()
if err != nil {
return nil, fmt.Errorf("could not serialize context: %w. please report this error", err)
}
exprString, err := computedResult.ExpressionString()
if err != nil {
return nil, err
}
caveatName := ""
if partialCheckResult.Expression.GetCaveat() != nil {
caveatName = partialCheckResult.Expression.GetCaveat().CaveatName
}
caveatEvalInfo = &v1.CaveatEvalInfo{
Expression: exprString,
Result: caveatResult,
Context: contextStruct,
PartialCaveatInfo: partialCaveatInfo,
CaveatName: caveatName,
}
}
if len(ct.SubProblems) > 0 {
subProblems := make([]*v1.CheckDebugTrace, 0, len(ct.SubProblems))
for _, subProblem := range ct.SubProblems {
converted, err := convertCheckTrace(ctx, caveatContext, subProblem, reader)
if err != nil {
return nil, err
}
subProblems = append(subProblems, converted)
}
sort.Sort(sortByResource(subProblems))
return &v1.CheckDebugTrace{
Resource: &v1.ObjectReference{
ObjectType: ct.Request.ResourceRelation.Namespace,
ObjectId: strings.Join(ct.Request.ResourceIds, ","),
},
Permission: ct.Request.ResourceRelation.Relation,
PermissionType: permissionType,
Subject: &v1.SubjectReference{
Object: &v1.ObjectReference{
ObjectType: ct.Request.Subject.Namespace,
ObjectId: ct.Request.Subject.ObjectId,
},
OptionalRelation: subRelation,
},
CaveatEvaluationInfo: caveatEvalInfo,
Result: permissionship,
Resolution: &v1.CheckDebugTrace_SubProblems_{
SubProblems: &v1.CheckDebugTrace_SubProblems{
Traces: subProblems,
},
},
}, nil
}
return &v1.CheckDebugTrace{
Resource: &v1.ObjectReference{
ObjectType: ct.Request.ResourceRelation.Namespace,
ObjectId: strings.Join(ct.Request.ResourceIds, ","),
},
Permission: ct.Request.ResourceRelation.Relation,
PermissionType: permissionType,
Subject: &v1.SubjectReference{
Object: &v1.ObjectReference{
ObjectType: ct.Request.Subject.Namespace,
ObjectId: ct.Request.Subject.ObjectId,
},
OptionalRelation: subRelation,
},
CaveatEvaluationInfo: caveatEvalInfo,
Result: permissionship,
Resolution: &v1.CheckDebugTrace_WasCachedResult{
WasCachedResult: ct.IsCachedResult,
},
}, nil
}
type sortByResource []*v1.CheckDebugTrace
func (a sortByResource) Len() int { return len(a) }
func (a sortByResource) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
func (a sortByResource) Less(i, j int) bool {
return strings.Compare(tuple.StringObjectRef(a[i].Resource), tuple.StringObjectRef(a[j].Resource)) < 0
}