-
Notifications
You must be signed in to change notification settings - Fork 0
/
fga.go
277 lines (236 loc) · 8.69 KB
/
fga.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
package fgax
import (
"context"
openfga "github.com/openfga/go-sdk"
ofgaclient "github.com/openfga/go-sdk/client"
"github.com/openfga/go-sdk/credentials"
"go.uber.org/zap"
)
// Client is an ofga client with some configuration
type Client struct {
// Ofga is the openFGA client
Ofga ofgaclient.SdkClient
// Config is the client configuration
Config ofgaclient.ClientConfiguration
// Logger is the provided Logger
Logger *zap.SugaredLogger
}
// Config configures the openFGA setup
type Config struct {
// Enabled - checks this first before reading the config
Enabled bool `json:"enabled" koanf:"enabled" jsonschema:"description=enables authorization checks with openFGA" default:"true"`
// StoreName of the FGA Store
StoreName string `json:"storeName" koanf:"storeName" jsonschema:"description=name of openFGA store" default:"datum"`
// HostURL of the fga API, replaces Host and Scheme settings
HostURL string `json:"hostUrl" koanf:"hostUrl" jsonschema:"description=host url with scheme of the openFGA API,required" default:"https://authz.datum.net"`
// StoreID of the authorization store in FGA
StoreID string `json:"storeId" koanf:"storeId" jsonschema:"description=id of openFGA store"`
// ModelID that already exists in authorization store to be used
ModelID string `json:"modelId" koanf:"modelId" jsonschema:"description=id of openFGA model"`
// CreateNewModel force creates a new model, even if one already exists
CreateNewModel bool `json:"createNewModel" koanf:"createNewModel" jsonschema:"description=force create a new model, even if one already exists" default:"false"`
// ModelFile is the path to the model file
ModelFile string `json:"modelFile" koanf:"modelFile" jsonschema:"description=path to the fga model file" default:"fga/model/datum.fga"`
// Credentials for the client
Credentials Credentials `json:"credentials" koanf:"credentials" jsonschema:"description=credentials for the openFGA client"`
}
// Credentials for the openFGA client
type Credentials struct {
// APIToken is the token to use for the client, required if using API token authentication
APIToken string `json:"apiToken" koanf:"apiToken" jsonschema:"description=api token for the openFGA client, required if using pre-shared key authentication"`
// ClientID is the client ID to use for the client, required if using client credentials
ClientID string `json:"clientId" koanf:"clientId" jsonschema:"description=client id for the openFGA client, required if using client credentials authentication"`
// ClientSecret is the client secret to use for the client, required if using client credentials
ClientSecret string `json:"clientSecret" koanf:"clientSecret" jsonschema:"description=client secret for the openFGA client, required if using client credentials authentication"`
// Audience is the audience to use for the client, required if using client credentials
Audience string `json:"audience" koanf:"audience" jsonschema:"description=audience for the openFGA client"`
// Issuer is the issuer to use for the client, required if using client credentials
Issuer string `json:"issuer" koanf:"issuer" jsonschema:"description=issuer for the openFGA client"`
// Scopes is the scopes to use for the client, required if using client credentials
Scopes string `json:"scopes" koanf:"scopes" jsonschema:"description=scopes for the openFGA client"`
}
// Option is a functional configuration option for openFGA client
type Option func(c *Client)
// NewClient returns a wrapped OpenFGA API client ensuring all calls are made
// to the provided authorization model (id) and returns what is necessary.
func NewClient(host string, opts ...Option) (*Client, error) {
if host == "" {
return nil, ErrFGAMissingHost
}
// The api host is the only required field when setting up a new FGA client connection
client := Client{
Config: ofgaclient.ClientConfiguration{
ApiUrl: host,
},
}
for _, opt := range opts {
opt(&client)
}
fgaClient, err := ofgaclient.NewSdkClient(&client.Config)
if err != nil {
return nil, err
}
client.Ofga = fgaClient
return &client, err
}
func (c *Client) GetModelID() string {
return c.Config.AuthorizationModelId
}
// WithLogger sets logger
func WithLogger(l *zap.SugaredLogger) Option {
return func(c *Client) {
c.Logger = l
}
}
// WithStoreID sets the store IDs, not needed when calling `CreateStore` or `ListStores`
func WithStoreID(storeID string) Option {
return func(c *Client) {
c.Config.StoreId = storeID
}
}
// WithAuthorizationModelID sets the authorization model ID
func WithAuthorizationModelID(authModelID string) Option {
return func(c *Client) {
c.Config.AuthorizationModelId = authModelID
}
}
// WithAPITokenCredentials sets the credentials for the client with an API token
func WithAPITokenCredentials(token string) Option {
return func(c *Client) {
c.Config.Credentials = &credentials.Credentials{
Method: credentials.CredentialsMethodApiToken,
Config: &credentials.Config{
ApiToken: token,
},
}
}
}
// WithClientCredentials sets the client credentials for the client with a client ID and secret
func WithClientCredentials(clientID, clientSecret, aud, issuer, scopes string) Option {
return func(c *Client) {
c.Config.Credentials = &credentials.Credentials{
Method: credentials.CredentialsMethodClientCredentials,
Config: &credentials.Config{
ClientCredentialsClientId: clientID,
ClientCredentialsClientSecret: clientSecret,
ClientCredentialsApiAudience: aud,
ClientCredentialsApiTokenIssuer: issuer,
ClientCredentialsScopes: scopes,
},
}
}
}
// WithToken sets the client credentials
func WithToken(token string) Option {
return func(c *Client) {
c.Config.Credentials = &credentials.Credentials{
Method: credentials.CredentialsMethodApiToken,
Config: &credentials.Config{
ApiToken: token,
},
}
}
}
// CreateFGAClientWithStore returns a Client with a store and model configured
func CreateFGAClientWithStore(ctx context.Context, c Config, l *zap.SugaredLogger) (*Client, error) {
// initialize options with logger
opts := []Option{
WithLogger(l),
}
// set credentials if provided
if c.Credentials.APIToken != "" {
opts = append(opts, WithAPITokenCredentials(c.Credentials.APIToken))
} else if c.Credentials.ClientID != "" && c.Credentials.ClientSecret != "" {
opts = append(opts, WithClientCredentials(
c.Credentials.ClientID,
c.Credentials.ClientSecret,
c.Credentials.Audience,
c.Credentials.Issuer,
c.Credentials.Scopes,
))
}
// create store if an ID was not configured
if c.StoreID == "" {
// Create new store
fgaClient, err := NewClient(
c.HostURL,
opts...,
)
if err != nil {
return nil, err
}
c.StoreID, err = fgaClient.CreateStore(ctx, c.StoreName)
if err != nil {
return nil, err
}
}
// add store ID to the options
opts = append(opts, WithStoreID(c.StoreID))
// create model if ID was not configured
if c.ModelID == "" {
// create fga client with store ID
fgaClient, err := NewClient(
c.HostURL,
opts...,
)
if err != nil {
return nil, err
}
// Create model if one does not already exist
modelID, err := fgaClient.CreateModelFromFile(ctx, c.ModelFile, c.CreateNewModel)
if err != nil {
return nil, err
}
// Set ModelID in the config
c.ModelID = modelID
}
// add model ID to the options
opts = append(opts,
WithAuthorizationModelID(c.ModelID),
)
// create fga client with store ID
return NewClient(
c.HostURL,
opts...,
)
}
// CreateStore creates a new fine grained authorization store and returns the store ID
func (c *Client) CreateStore(ctx context.Context, storeName string) (string, error) {
options := ofgaclient.ClientListStoresOptions{
ContinuationToken: openfga.PtrString(""),
}
stores, err := c.Ofga.ListStores(context.Background()).Options(options).Execute()
if err != nil {
return "", err
}
// Only create a new test store if one does not exist
if len(stores.GetStores()) > 0 {
storeID := stores.GetStores()[0].Id
c.Logger.Infow("fga store exists", "store_id", storeID)
return storeID, nil
}
// Create new store
storeReq := c.Ofga.CreateStore(context.Background())
resp, err := storeReq.Body(ofgaclient.ClientCreateStoreRequest{
Name: storeName,
}).Execute()
if err != nil {
return "", err
}
storeID := resp.GetId()
c.Logger.Infow("fga store created", "store_id", storeID)
return storeID, nil
}
// Healthcheck reads the model to check if the connection is working
func Healthcheck(client Client) func(ctx context.Context) error {
return func(ctx context.Context) error {
opts := ofgaclient.ClientReadAuthorizationModelOptions{
AuthorizationModelId: &client.Config.AuthorizationModelId,
}
_, err := client.Ofga.ReadAuthorizationModel(ctx).Options(opts).Execute()
if err != nil {
return err
}
return nil
}
}