-
Notifications
You must be signed in to change notification settings - Fork 66
/
rbac.go
414 lines (354 loc) · 12.6 KB
/
rbac.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
package service
import (
"context"
"errors"
"fmt"
"net/http"
"time"
"github.com/google/uuid"
"github.com/gorilla/mux"
"github.com/jackc/pgconn"
"github.com/jackc/pgx/v4"
"github.com/rs/zerolog"
"github.com/gilcrest/diy-go-api/datastore/authstore"
"github.com/gilcrest/diy-go-api/datastore/userstore"
"github.com/gilcrest/diy-go-api/domain/audit"
"github.com/gilcrest/diy-go-api/domain/auth"
"github.com/gilcrest/diy-go-api/domain/errs"
"github.com/gilcrest/diy-go-api/domain/secure"
"github.com/gilcrest/diy-go-api/domain/user"
)
// DBAuthorizer determines authorization for a user
// by running sql against tables in the database
type DBAuthorizer struct {
Datastorer Datastorer
}
// Authorize ensures that a subject (user.User) can perform a
// particular action on a resource, e.g. subject otto.maddox711@gmail.com
// can read (GET) the resource /api/v1/movies (path).
//
// The http.Request context is used to determine the route/path information
// and must be issued through the gorilla/mux library.
func (a DBAuthorizer) Authorize(lgr zerolog.Logger, r *http.Request, adt audit.Audit) error {
// current matched route for the request
route := mux.CurrentRoute(r)
// CurrentRoute can return a nil if route not setup properly or
// is being called outside the handler of the matched route
if route == nil {
return errs.E(errs.Unauthorized, "nil route returned from mux.CurrentRoute")
}
pathTemplate, err := route.GetPathTemplate()
if err != nil {
return errs.E(errs.Unauthorized, err)
}
arg := authstore.IsAuthorizedParams{
Resource: pathTemplate,
Operation: r.Method,
UserID: adt.User.ID,
}
// call IsAuthorized method to validate user has access to the resource and operation
var authorizedID uuid.UUID
authorizedID, err = authstore.New(a.Datastorer.Pool()).IsAuthorized(r.Context(), arg)
if err != nil || authorizedID == uuid.Nil {
lgr.Info().Str("user", adt.User.Username).Str("resource", pathTemplate).Str("operation", r.Method).
Msgf("Unauthorized (user: %s, resource: %s, operation: %s)", adt.User.Username, pathTemplate, r.Method)
// "In summary, a 401 Unauthorized response should be used for missing or
// bad authentication, and a 403 Forbidden response should be used afterwards,
// when the user is authenticated but isn’t authorized to perform the
// requested operation on the given resource."
// If the user has gotten here, they have gotten through authentication
// but do have the right access, this they are Unauthorized
return errs.E(errs.Unauthorized, fmt.Sprintf("user %s does not have %s permission for %s", adt.User.Username, r.Method, pathTemplate))
}
lgr.Debug().Str("user", adt.User.Username).Str("resource", pathTemplate).Str("operation", r.Method).
Msgf("Authorized (user: %s, resource: %s, operation: %s)", adt.User.Username, pathTemplate, r.Method)
return nil
}
// PermissionRequest is the request struct for creating a permission
type PermissionRequest struct {
// Unique External ID to be given to outside callers.
ExternalID string `json:"external_id"`
// A human-readable string which represents a resource (e.g. an HTTP route or document, etc.).
Resource string `json:"resource"`
// A string representing the action taken on the resource (e.g. POST, GET, edit, etc.)
Operation string `json:"operation"`
// A description of what the permission is granting, e.g. "grants ability to edit a billing document".
Description string `json:"description"`
// A boolean denoting whether the permission is active (true) or not (false).
Active bool `json:"active"`
}
// PermissionService is a service for creating, reading, updating and deleting a Permission
type PermissionService struct {
Datastorer Datastorer
}
// Create is used to create a Permission
func (s PermissionService) Create(ctx context.Context, r *PermissionRequest, adt audit.Audit) (p auth.Permission, err error) {
// start db txn using pgxpool
var tx pgx.Tx
tx, err = s.Datastorer.BeginTx(ctx)
if err != nil {
return auth.Permission{}, err
}
// defer transaction rollback and handle error, if any
defer func() {
err = s.Datastorer.RollbackTx(ctx, tx, err)
}()
p, err = createPermissionTx(ctx, tx, r, adt)
if err != nil {
return auth.Permission{}, err
}
// commit db txn using pgxpool
err = s.Datastorer.CommitTx(ctx, tx)
if err != nil {
return auth.Permission{}, err
}
return p, nil
}
// createPermissionTX separates the transaction logic as it needs to also be called during Genesis
func createPermissionTx(ctx context.Context, tx pgx.Tx, r *PermissionRequest, adt audit.Audit) (p auth.Permission, err error) {
p = auth.Permission{
ID: uuid.New(),
ExternalID: secure.NewID(),
Resource: r.Resource,
Operation: r.Operation,
Description: r.Description,
Active: r.Active,
}
err = p.IsValid()
if err != nil {
return auth.Permission{}, err
}
arg := authstore.CreatePermissionParams{
PermissionID: p.ID,
PermissionExtlID: p.ExternalID.String(),
Resource: p.Resource,
Operation: p.Operation,
PermissionDescription: p.Description,
Active: p.Active,
CreateAppID: adt.App.ID,
CreateUserID: adt.User.NullUUID(),
CreateTimestamp: time.Now(),
UpdateAppID: adt.App.ID,
UpdateUserID: adt.User.NullUUID(),
UpdateTimestamp: time.Now(),
}
var rowsAffected int64
rowsAffected, err = authstore.New(tx).CreatePermission(ctx, arg)
if err != nil {
var pgErr *pgconn.PgError
if errors.As(err, &pgErr) {
if pgErr.Code == "23505" {
return auth.Permission{}, errs.E(errs.Exist, errs.Exist.String())
}
return auth.Permission{}, errs.E(errs.Database, pgErr.Message)
}
return auth.Permission{}, errs.E(errs.Database, err)
}
// should only impact exactly one record
if rowsAffected != 1 {
return auth.Permission{}, errs.E(errs.Database, fmt.Sprintf("Create() should insert 1 row, actual: %d", rowsAffected))
}
return p, nil
}
// FindAll retrieves all permissions
func (s PermissionService) FindAll(ctx context.Context) ([]auth.Permission, error) {
rows, err := authstore.New(s.Datastorer.Pool()).FindAllPermissions(ctx)
if err != nil {
return nil, errs.E(errs.Database, err)
}
var sp []auth.Permission
for _, row := range rows {
p := auth.Permission{
ID: row.PermissionID,
ExternalID: secure.MustParseIdentifier(row.PermissionExtlID),
Resource: row.Resource,
Operation: row.Operation,
Description: row.PermissionDescription,
Active: row.Active,
}
sp = append(sp, p)
}
return sp, nil
}
// newPermission initializes an auth.Permission given an authstore.Permission
func newPermission(ap authstore.Permission) auth.Permission {
return auth.Permission{
ID: ap.PermissionID,
ExternalID: secure.MustParseIdentifier(ap.PermissionExtlID),
Resource: ap.Resource,
Operation: ap.Operation,
Description: ap.PermissionDescription,
Active: ap.Active,
}
}
// CreateRoleRequest is the request struct for creating a role
type CreateRoleRequest struct {
// A human-readable code which represents the role.
Code string `json:"role_cd"`
// A longer description of the role.
Description string `json:"role_description"`
// A boolean denoting whether the role is active (true) or not (false).
Active bool `json:"active"`
// The list of permissions to be given to the role
Permissions []PermissionRequest
UserExternals []string
}
// RoleService is a service for creating, reading, updating and deleting a Role
type RoleService struct {
Datastorer Datastorer
}
// Create is used to create a Role
func (s RoleService) Create(ctx context.Context, r *CreateRoleRequest, adt audit.Audit) (role auth.Role, err error) {
// start db txn using pgxpool
var tx pgx.Tx
tx, err = s.Datastorer.BeginTx(ctx)
if err != nil {
return auth.Role{}, err
}
// defer transaction rollback and handle error, if any
defer func() {
err = s.Datastorer.RollbackTx(ctx, tx, err)
}()
role, err = createRoleTx(ctx, tx, r, adt)
if err != nil {
return auth.Role{}, err
}
// commit db txn using pgxpool
err = s.Datastorer.CommitTx(ctx, tx)
if err != nil {
return auth.Role{}, err
}
return role, nil
}
// createRoleTx separates out the transaction logic for creating a role as it needs to be called in multiple places
func createRoleTx(ctx context.Context, tx pgx.Tx, r *CreateRoleRequest, adt audit.Audit) (role auth.Role, err error) {
var rolePermissions []auth.Permission
rolePermissions, err = findPermissionsForRole(ctx, tx, r.Permissions)
if err != nil {
return auth.Role{}, err
}
var roleUsers []user.User
roleUsers, err = findUsersForRole(ctx, tx, r.UserExternals)
if err != nil {
return auth.Role{}, err
}
role = auth.Role{
ID: uuid.New(),
ExternalID: secure.NewID(),
Code: r.Code,
Description: r.Description,
Active: r.Active,
Permissions: rolePermissions,
Users: roleUsers,
}
err = role.IsValid()
if err != nil {
return auth.Role{}, err
}
arg := authstore.CreateRoleParams{
RoleID: role.ID,
RoleExtlID: role.ExternalID.String(),
RoleCd: role.Code,
Active: role.Active,
CreateAppID: adt.App.ID,
CreateUserID: adt.User.NullUUID(),
CreateTimestamp: time.Now(),
UpdateAppID: adt.App.ID,
UpdateUserID: adt.User.NullUUID(),
UpdateTimestamp: time.Now(),
}
var rowsAffected int64
rowsAffected, err = authstore.New(tx).CreateRole(ctx, arg)
if err != nil {
return auth.Role{}, errs.E(errs.Database, err)
}
// should only impact exactly one record
if rowsAffected != 1 {
return auth.Role{}, errs.E(errs.Database, fmt.Sprintf("Create() should insert 1 row, actual: %d", rowsAffected))
}
for _, rp := range role.Permissions {
t := time.Now()
createRolePermissionParams := authstore.CreateRolePermissionParams{
RoleID: role.ID,
PermissionID: rp.ID,
CreateAppID: adt.App.ID,
CreateUserID: adt.User.NullUUID(),
CreateTimestamp: t,
UpdateAppID: adt.App.ID,
UpdateUserID: adt.User.NullUUID(),
UpdateTimestamp: t,
}
rowsAffected, err = authstore.New(tx).CreateRolePermission(ctx, createRolePermissionParams)
if err != nil {
return auth.Role{}, errs.E(errs.Database, err)
}
// should only impact exactly one record
if rowsAffected != 1 {
return auth.Role{}, errs.E(errs.Database, fmt.Sprintf("Create() should insert 1 row, actual: %d", rowsAffected))
}
}
for _, ru := range role.Users {
t := time.Now()
createRoleUserParams := authstore.CreateRoleUserParams{
RoleID: role.ID,
UserID: ru.ID,
CreateAppID: adt.App.ID,
CreateUserID: adt.User.NullUUID(),
CreateTimestamp: t,
UpdateAppID: adt.App.ID,
UpdateUserID: adt.User.NullUUID(),
UpdateTimestamp: t,
}
rowsAffected, err = authstore.New(tx).CreateRoleUser(ctx, createRoleUserParams)
if err != nil {
return auth.Role{}, errs.E(errs.Database, err)
}
// should only impact exactly one record
if rowsAffected != 1 {
return auth.Role{}, errs.E(errs.Database, fmt.Sprintf("Create() should insert 1 row, actual: %d", rowsAffected))
}
}
return role, nil
}
func findPermissionsForRole(ctx context.Context, tx pgx.Tx, prs []PermissionRequest) (aps []auth.Permission, err error) {
// it's fine for zero permissions to be added as part of a role
if len(prs) == 0 {
return nil, nil
}
// if permissions are set as part of role create, find them in the db depending on
// which key is sent (external id or resource/operation)
for _, pr := range prs {
var ap authstore.Permission
if pr.ExternalID != "" {
ap, err = authstore.New(tx).FindPermissionByExternalID(ctx, pr.ExternalID)
if err != nil {
return nil, errs.E(errs.Database, err)
}
aps = append(aps, newPermission(ap))
} else {
ap, err = authstore.New(tx).FindPermissionByResourceOperation(ctx, authstore.FindPermissionByResourceOperationParams{Resource: pr.Resource, Operation: pr.Operation})
if err != nil {
return nil, errs.E(errs.Database, err)
}
aps = append(aps, newPermission(ap))
}
}
return aps, nil
}
func findUsersForRole(ctx context.Context, tx pgx.Tx, extls []string) (users []user.User, err error) {
// it's fine for zero users to be added when creating a role
if len(extls) == 0 {
return nil, nil
}
// if users are set as part of role create, find them in the db depending on
// which key is sent (external id or resource/operation)
for _, s := range extls {
var row userstore.FindUserByExternalIDRow
row, err = userstore.New(tx).FindUserByExternalID(ctx, s)
if err != nil {
return nil, errs.E(errs.Database, err)
}
users = append(users, hydrateUserFromExternalIDRow(row))
}
return users, nil
}