/
acl.go
433 lines (371 loc) · 12.1 KB
/
acl.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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
package v0
import (
"context"
"errors"
"fmt"
v0 "github.com/authzed/authzed-go/proto/authzed/api/v0"
v1_api "github.com/authzed/authzed-go/proto/authzed/api/v1"
"github.com/authzed/grpcutil"
grpcmw "github.com/grpc-ecosystem/go-grpc-middleware"
"github.com/rs/zerolog/log"
"github.com/shopspring/decimal"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"github.com/authzed/spicedb/internal/datastore"
"github.com/authzed/spicedb/internal/dispatch"
"github.com/authzed/spicedb/internal/graph"
"github.com/authzed/spicedb/internal/namespace"
v1 "github.com/authzed/spicedb/internal/proto/dispatch/v1"
"github.com/authzed/spicedb/internal/services/serviceerrors"
"github.com/authzed/spicedb/internal/services/shared"
"github.com/authzed/spicedb/internal/sharederrors"
"github.com/authzed/spicedb/pkg/tuple"
"github.com/authzed/spicedb/pkg/zookie"
)
type aclServer struct {
v0.UnimplementedACLServiceServer
shared.WithUnaryServiceSpecificInterceptor
ds datastore.Datastore
nsm namespace.Manager
dispatch dispatch.Dispatcher
defaultDepth uint32
}
const (
maxUInt16 = int(^uint16(0))
lookupDefaultLimit = uint32(25)
lookupMaximumLimit = uint32(100)
)
var errInvalidZookie = errors.New("invalid revision requested")
// NewACLServer creates an instance of the ACL server.
func NewACLServer(ds datastore.Datastore, nsm namespace.Manager, dispatch dispatch.Dispatcher, defaultDepth uint32) v0.ACLServiceServer {
s := &aclServer{
ds: ds,
nsm: nsm,
dispatch: dispatch,
defaultDepth: defaultDepth,
WithUnaryServiceSpecificInterceptor: shared.WithUnaryServiceSpecificInterceptor{
Unary: grpcmw.ChainUnaryServer(grpcutil.DefaultUnaryMiddleware...),
},
}
return s
}
func (as *aclServer) Write(ctx context.Context, req *v0.WriteRequest) (*v0.WriteResponse, error) {
for _, mutation := range req.Updates {
err := validateTupleWrite(ctx, mutation.Tuple, as.nsm)
if err != nil {
return nil, rewriteACLError(err)
}
}
preconditions := make([]*v1_api.Precondition, 0, len(req.WriteConditions))
for _, cond := range req.WriteConditions {
preconditions = append(preconditions, &v1_api.Precondition{
Operation: v1_api.Precondition_OPERATION_MUST_MATCH,
Filter: tuple.ToFilter(cond),
})
}
mutations := make([]*v1_api.RelationshipUpdate, 0, len(req.Updates))
for _, mut := range req.Updates {
mutations = append(mutations, tuple.UpdateToRelationshipUpdate(mut))
}
revision, err := as.ds.WriteTuples(ctx, preconditions, mutations)
if err != nil {
return nil, rewriteACLError(err)
}
return &v0.WriteResponse{
Revision: zookie.NewFromRevision(revision),
}, nil
}
func (as *aclServer) Read(ctx context.Context, req *v0.ReadRequest) (*v0.ReadResponse, error) {
for _, tuplesetFilter := range req.Tuplesets {
checkedRelation := false
for _, filter := range tuplesetFilter.Filters {
switch filter {
case v0.RelationTupleFilter_OBJECT_ID:
if tuplesetFilter.ObjectId == "" {
return nil, status.Errorf(
codes.InvalidArgument,
"object ID filter specified but not object ID provided.",
)
}
case v0.RelationTupleFilter_RELATION:
if tuplesetFilter.Relation == "" {
return nil, status.Errorf(
codes.InvalidArgument,
"relation filter specified but not relation provided.",
)
}
if err := as.nsm.CheckNamespaceAndRelation(
ctx,
tuplesetFilter.Namespace,
tuplesetFilter.Relation,
false, // Disallow ellipsis
); err != nil {
return nil, rewriteACLError(err)
}
checkedRelation = true
case v0.RelationTupleFilter_USERSET:
if tuplesetFilter.Userset == nil {
return nil, status.Errorf(
codes.InvalidArgument,
"userset filter specified but not userset provided.",
)
}
default:
return nil, status.Errorf(
codes.InvalidArgument,
"unknown tupleset filter type: %s",
filter,
)
}
}
if !checkedRelation {
if err := as.nsm.CheckNamespaceAndRelation(
ctx,
tuplesetFilter.Namespace,
datastore.Ellipsis,
true, // Allow ellipsis
); err != nil {
return nil, rewriteACLError(err)
}
}
}
var atRevision decimal.Decimal
if req.AtRevision != nil {
// Read should attempt to use the exact revision requested
decoded, err := zookie.DecodeRevision(req.AtRevision)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "bad request revision: %s", err)
}
atRevision = decoded
} else {
// No revision provided, we'll pick one
var err error
atRevision, err = as.ds.Revision(ctx)
if err != nil {
return nil, status.Errorf(codes.Internal, "unable to pick request revision: %s", err)
}
}
err := as.ds.CheckRevision(ctx, atRevision)
if err != nil {
return nil, rewriteACLError(err)
}
var allTuplesetResults []*v0.ReadResponse_Tupleset
for _, tuplesetFilter := range req.Tuplesets {
queryFilter := datastore.TupleQueryResourceFilter{
ResourceType: tuplesetFilter.Namespace,
}
var filterUserset *v0.ObjectAndRelation
for _, filter := range tuplesetFilter.Filters {
switch filter {
case v0.RelationTupleFilter_OBJECT_ID:
queryFilter.OptionalResourceID = tuplesetFilter.ObjectId
case v0.RelationTupleFilter_RELATION:
queryFilter.OptionalResourceRelation = tuplesetFilter.Relation
case v0.RelationTupleFilter_USERSET:
filterUserset = tuplesetFilter.Userset
default:
return nil, status.Errorf(codes.InvalidArgument, "unknown tupleset filter type: %s", filter)
}
}
query := as.ds.QueryTuples(queryFilter, atRevision)
if filterUserset != nil {
query = query.WithUsersets([]*v0.ObjectAndRelation{filterUserset})
}
tupleIterator, err := query.Execute(ctx)
if err != nil {
return nil, rewriteACLError(err)
}
defer tupleIterator.Close()
tuplesetResult := &v0.ReadResponse_Tupleset{}
for tuple := tupleIterator.Next(); tuple != nil; tuple = tupleIterator.Next() {
tuplesetResult.Tuples = append(tuplesetResult.Tuples, tuple)
}
if tupleIterator.Err() != nil {
return nil, status.Errorf(codes.Internal, "error when reading tuples: %s", err)
}
allTuplesetResults = append(allTuplesetResults, tuplesetResult)
}
return &v0.ReadResponse{
Tuplesets: allTuplesetResults,
Revision: zookie.NewFromRevision(atRevision),
}, nil
}
func (as *aclServer) Check(ctx context.Context, req *v0.CheckRequest) (*v0.CheckResponse, error) {
atRevision, err := as.pickBestRevision(ctx, req.AtRevision)
if err != nil {
return nil, rewriteACLError(err)
}
return as.commonCheck(ctx, atRevision, req.TestUserset, req.User.GetUserset())
}
func (as *aclServer) ContentChangeCheck(ctx context.Context, req *v0.ContentChangeCheckRequest) (*v0.CheckResponse, error) {
atRevision, err := as.ds.SyncRevision(ctx)
if err != nil {
return nil, rewriteACLError(err)
}
return as.commonCheck(ctx, atRevision, req.TestUserset, req.User.GetUserset())
}
func (as *aclServer) commonCheck(
ctx context.Context,
atRevision decimal.Decimal,
start *v0.ObjectAndRelation,
goal *v0.ObjectAndRelation,
) (*v0.CheckResponse, error) {
err := as.nsm.CheckNamespaceAndRelation(ctx, start.Namespace, start.Relation, false)
if err != nil {
return nil, rewriteACLError(err)
}
err = as.nsm.CheckNamespaceAndRelation(ctx, goal.Namespace, goal.Relation, true)
if err != nil {
return nil, rewriteACLError(err)
}
cr, err := as.dispatch.DispatchCheck(ctx, &v1.DispatchCheckRequest{
Metadata: &v1.ResolverMeta{
AtRevision: atRevision.String(),
DepthRemaining: as.defaultDepth,
},
ObjectAndRelation: start,
Subject: goal,
})
if err != nil {
return nil, rewriteACLError(err)
}
var membership v0.CheckResponse_Membership
switch cr.Membership {
case v1.DispatchCheckResponse_MEMBER:
membership = v0.CheckResponse_MEMBER
case v1.DispatchCheckResponse_NOT_MEMBER:
membership = v0.CheckResponse_NOT_MEMBER
default:
membership = v0.CheckResponse_UNKNOWN
}
return &v0.CheckResponse{
IsMember: membership == v0.CheckResponse_MEMBER,
Revision: zookie.NewFromRevision(atRevision),
Membership: membership,
}, nil
}
func (as *aclServer) Expand(ctx context.Context, req *v0.ExpandRequest) (*v0.ExpandResponse, error) {
err := as.nsm.CheckNamespaceAndRelation(ctx, req.Userset.Namespace, req.Userset.Relation, false)
if err != nil {
return nil, rewriteACLError(err)
}
atRevision, err := as.pickBestRevision(ctx, req.AtRevision)
if err != nil {
return nil, rewriteACLError(err)
}
resp, err := as.dispatch.DispatchExpand(ctx, &v1.DispatchExpandRequest{
Metadata: &v1.ResolverMeta{
AtRevision: atRevision.String(),
DepthRemaining: as.defaultDepth,
},
ObjectAndRelation: req.Userset,
ExpansionMode: v1.DispatchExpandRequest_SHALLOW,
})
if err != nil {
return nil, rewriteACLError(err)
}
return &v0.ExpandResponse{
TreeNode: resp.TreeNode,
Revision: zookie.NewFromRevision(atRevision),
}, nil
}
func min(a, b int) int {
if a < b {
return a
}
return b
}
func (as *aclServer) Lookup(ctx context.Context, req *v0.LookupRequest) (*v0.LookupResponse, error) {
err := as.nsm.CheckNamespaceAndRelation(ctx, req.User.Namespace, req.User.Relation, true)
if err != nil {
return nil, rewriteACLError(err)
}
err = as.nsm.CheckNamespaceAndRelation(ctx, req.ObjectRelation.Namespace, req.ObjectRelation.Relation, false)
if err != nil {
return nil, rewriteACLError(err)
}
atRevision, err := as.pickBestRevision(ctx, req.AtRevision)
if err != nil {
return nil, rewriteACLError(err)
}
limit := req.Limit
if limit == 0 {
limit = lookupDefaultLimit
} else if limit > lookupMaximumLimit {
limit = lookupMaximumLimit
}
resp, err := as.dispatch.DispatchLookup(ctx, &v1.DispatchLookupRequest{
Metadata: &v1.ResolverMeta{
AtRevision: atRevision.String(),
DepthRemaining: as.defaultDepth,
},
ObjectRelation: req.ObjectRelation,
Subject: req.User,
Limit: limit,
DirectStack: nil,
TtuStack: nil,
})
if err != nil {
return nil, rewriteACLError(err)
}
resolvedObjectIDs := []string{}
for _, found := range resp.ResolvedOnrs {
if found.Namespace != req.ObjectRelation.Namespace {
return nil, rewriteACLError(fmt.Errorf("got invalid resolved object %v (expected %v)", found, req.ObjectRelation))
}
resolvedObjectIDs = append(resolvedObjectIDs, found.ObjectId)
}
return &v0.LookupResponse{
Revision: zookie.NewFromRevision(atRevision),
ResolvedObjectIds: resolvedObjectIDs,
}, nil
}
func (as *aclServer) pickBestRevision(ctx context.Context, requested *v0.Zookie) (decimal.Decimal, error) {
// Calculate a revision as we see fit
databaseRev, err := as.ds.Revision(ctx)
if err != nil {
return decimal.Zero, err
}
if requested != nil {
requestedRev, err := zookie.DecodeRevision(requested)
if err != nil {
return decimal.Zero, errInvalidZookie
}
if requestedRev.GreaterThan(databaseRev) {
return requestedRev, nil
}
return databaseRev, nil
}
return databaseRev, nil
}
func rewriteACLError(err error) error {
var nsNotFoundError sharederrors.UnknownNamespaceError = nil
var relNotFoundError sharederrors.UnknownRelationError = nil
switch {
case err == errInvalidZookie:
return status.Errorf(codes.InvalidArgument, "invalid argument: %s", err)
case errors.As(err, &nsNotFoundError):
fallthrough
case errors.As(err, &relNotFoundError):
fallthrough
case errors.As(err, &datastore.ErrPreconditionFailed{}):
return status.Errorf(codes.FailedPrecondition, "failed precondition: %s", err)
case errors.As(err, &graph.ErrRequestCanceled{}):
return status.Errorf(codes.Canceled, "request canceled: %s", err)
case errors.As(err, &datastore.ErrInvalidRevision{}):
return status.Errorf(codes.OutOfRange, "invalid zookie: %s", err)
case errors.As(err, &datastore.ErrReadOnly{}):
return serviceerrors.ErrServiceReadOnly
case errors.As(err, &graph.ErrRelationMissingTypeInfo{}):
return status.Errorf(codes.FailedPrecondition, "failed precondition: %s", err)
case errors.As(err, &graph.ErrAlwaysFail{}):
log.Err(err)
return status.Errorf(codes.Internal, "internal error: %s", err)
default:
if _, ok := err.(invalidRelationError); ok {
return status.Errorf(codes.InvalidArgument, "%s", err.Error())
}
log.Err(err)
return err
}
}