-
Notifications
You must be signed in to change notification settings - Fork 0
/
model.go
321 lines (261 loc) · 8.55 KB
/
model.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
package fgax
import (
"context"
"encoding/json"
"os"
openfga "github.com/openfga/go-sdk"
ofgaclient "github.com/openfga/go-sdk/client"
language "github.com/openfga/language/pkg/go/transformer"
typesystem "github.com/openfga/openfga/pkg/typesystem"
"github.com/pkg/errors"
"google.golang.org/protobuf/encoding/protojson"
)
// CreateModelFromFile creates a new fine grained authorization model and returns the model ID
func (c *Client) CreateModelFromFile(ctx context.Context, fn string, forceCreate bool) (string, error) {
options := ofgaclient.ClientReadAuthorizationModelsOptions{}
models, err := c.Ofga.ReadAuthorizationModels(context.Background()).Options(options).Execute()
if err != nil {
return "", err
}
// Only create a new test model if one does not exist and we aren't forcing a new model to be created
if !forceCreate {
if len(models.AuthorizationModels) > 0 {
modelID := models.GetAuthorizationModels()[0].Id
c.Logger.Infow("fga model exists", "model_id", modelID)
return modelID, nil
}
}
// Create new model
dsl, err := os.ReadFile(fn)
if err != nil {
return "", err
}
return c.CreateModelFromDSL(ctx, dsl)
}
// CreateModelFromDSL creates a new fine grained authorization model from the DSL and returns the model ID
func (c *Client) CreateModelFromDSL(ctx context.Context, dsl []byte) (string, error) {
// convert to json
dslJSON, err := dslToJSON(dsl)
if err != nil {
return "", err
}
var body ofgaclient.ClientWriteAuthorizationModelRequest
if err := json.Unmarshal(dslJSON, &body); err != nil {
return "", err
}
return c.CreateModel(ctx, body)
}
// CreateModel creates a new authorization model and returns the new model ID
func (c *Client) CreateModel(ctx context.Context, model ofgaclient.ClientWriteAuthorizationModelRequest) (string, error) {
resp, err := c.Ofga.WriteAuthorizationModel(ctx).Body(model).Execute()
if err != nil {
return "", err
}
modelID := resp.GetAuthorizationModelId()
c.Logger.Infow("fga model created", "model_id", modelID)
return modelID, nil
}
// dslToJSON converts fga model to JSON
func dslToJSON(dslString []byte) ([]byte, error) {
parsedAuthModel, err := language.TransformDSLToProto(string(dslString))
if err != nil {
return []byte{}, errors.Wrap(err, ErrFailedToTransformModel.Error())
}
return protojson.Marshal(parsedAuthModel)
}
// RoleRequest is the request to add a role to the model for an existing object
type RoleRequest struct {
// Role is the relation to add to the model
Role string
// Relation is the relation to the object
Relations []RelationSetting
// RelationCombination is the combination of the relation
RelationCombination RelationCombination
// ObjectType is the object type to add the role to
ObjectType string
}
// RelationCombination is the combination of the relation as an `and`, `or`, or `not`
type RelationCombination string
const (
// Union is an `or` relation
Union RelationCombination = "union"
// Intersection is an `and` relation
Intersection RelationCombination = "intersection"
// Difference is a `not` relation, currently not supported
// Difference RelationCombination = "difference"
)
// RelationSetting includes the name of the relation as well as flags to determine the type of relation
type RelationSetting struct {
// Relation is the relation to the object
Relation string
// IsDirect is the direct relation to another fga object type
IsDirect bool
// FromRelation is the relation from another relation, leave empty if not a from relation
FromRelation string
}
// AddOrReplaceRole adds (or replaces the existing) the role to the model and updates the config with the new model id
func (c *Client) AddOrReplaceRole(ctx context.Context, r RoleRequest) error {
// read the latest model
model, err := c.Ofga.ReadLatestAuthorizationModel(ctx).Execute()
if err != nil {
return err
}
// get the model
m := model.GetAuthorizationModel()
// get the type definitions from the existing model
td := m.TypeDefinitions
addedRole := false
for i, t := range td {
if t.Type == r.ObjectType {
// initialize the relation map
relations := t.GetRelations()
// add the role to the relation map
var metadata *openfga.Metadata
relations[r.Role], metadata = generateUserset(r)
// set the relation map and metadata
t.SetRelations(relations)
// t.SetMetadata(metadata)
metadataRelations := t.Metadata.GetRelations()
for k, v := range *metadata.Relations {
metadataRelations[k] = v
}
t.Metadata.SetRelations(metadataRelations)
// set the updated type definition
m.TypeDefinitions[i] = t
// track that we added the role
addedRole = true
}
}
// if we didn't add the role, create a new type definition
if !addedRole {
m.TypeDefinitions = append(m.TypeDefinitions,
createNewTypeDefinition(r))
}
// create the request to write the model
request := ofgaclient.ClientWriteAuthorizationModelRequest{
SchemaVersion: m.SchemaVersion,
Conditions: m.Conditions,
TypeDefinitions: m.TypeDefinitions,
}
// write the model back
resp, err := c.Ofga.WriteAuthorizationModel(ctx).Body(request).Execute()
if err != nil {
return err
}
// update to the new model ID in the config
c.Config.AuthorizationModelId = resp.GetAuthorizationModelId()
return nil
}
// createNewTypeDefinition creates a new type definition for the model
func createNewTypeDefinition(r RoleRequest) openfga.TypeDefinition {
relation := make(map[string]openfga.Userset)
td := openfga.TypeDefinition{
Type: r.ObjectType,
}
// get all the usersets
us, metadata := generateUserset(r)
relation[r.Role] = us
td.Relations = &relation
td.Metadata = metadata
return td
}
// generateUserset creates the userset and metadata for the role request
func generateUserset(r RoleRequest) (us openfga.Userset, metadata *openfga.Metadata) {
// create the default metadata
metadata = openfga.NewMetadataWithDefaults()
// create the usersets and determine if we have a direct relation
uses, directRelation := createUsersets(r)
// generate the metadata
md := createNewMetadata(r.Role, directRelation)
metadata.SetRelations(md)
// now combine the usersets
switch r.RelationCombination {
case Intersection:
us.Intersection = &openfga.Usersets{
Child: uses,
}
case Union:
us.Union = &openfga.Usersets{
Child: uses,
}
default:
// if we only have one userset, just return it
if len(uses) == 1 {
us = uses[0]
} else { // default to union
us.Union = &openfga.Usersets{
Child: uses,
}
}
}
return us, metadata
}
// createUsersets creates the usersets for the role request and determines if there is a direct relation
func createUsersets(r RoleRequest) (uses []openfga.Userset, directRelation string) {
for _, relation := range r.Relations {
rel := relation
switch {
case relation.IsDirect:
// create direct relation
relations := newDirectRelation(r.Role)
uses = append(uses, relations)
directRelation = relation.Relation
case relation.FromRelation != "":
// create tuple set for a from relation
uses = append(uses, newTupleUsersetRelation(rel.Relation, rel.FromRelation))
default:
// create computed userset, which is a relation to another relation
uses = append(uses, newComputedUsersetRelation(rel.Relation))
}
}
return
}
// createNewMetadata creates a new metadata for the relations
func createNewMetadata(r string, userType string) map[string]openfga.RelationMetadata {
rd := make(map[string]openfga.RelationMetadata)
rd[r] = openfga.RelationMetadata{
DirectlyRelatedUserTypes: &[]openfga.RelationReference{},
}
if userType != "" {
rd[r] = openfga.RelationMetadata{
DirectlyRelatedUserTypes: &[]openfga.RelationReference{
{
Type: userType,
},
},
}
}
return rd
}
// newDirectRelation creates a new relation to an existing object
func newDirectRelation(role string) openfga.Userset {
// create the user set
thisRelation := make(map[string]interface{})
thisRelation[role] = typesystem.This()
us := openfga.Userset{
This: &thisRelation,
}
return us
}
// newComputedUsersetRelation creates a new computed relation to another relation
func newComputedUsersetRelation(relation string) openfga.Userset {
return openfga.Userset{
ComputedUserset: &openfga.ObjectRelation{
Relation: &relation,
},
}
}
// newTupleUsersetRelation creates a new tuple relation to another relation
func newTupleUsersetRelation(relation, fromRelation string) openfga.Userset {
ts := openfga.TupleToUserset{
Tupleset: openfga.ObjectRelation{
Relation: &fromRelation,
},
ComputedUserset: openfga.ObjectRelation{
Relation: &relation,
},
}
return openfga.Userset{
TupleToUserset: &ts,
}
}