package guardian

  1. Overview
  2. Docs

Source file sqlite3_backend.ml

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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
exception Exception of string

let get_or_exn m = m |> CCResult.get_or_failwith |> Lwt.return

(** TODO: optional [ctx] arguments are ignored by sqlite backend *)
module Make (A : Guardian.RoleSig) (T : Guardian.RoleSig) = struct
  module Guardian = Guardian.Make (A) (T)
  module Uuid = Guardian.Uuid

  (** TODO: generalize this. right now it's fine because this backend should
      really only be used for testing purposes, but in the future it would be
      nice to have actual sqlite3 support. *)
  module ActorSet = Guardian.ActorRoleSet

  module TargetSet = Guardian.TargetRoleSet

  let db = Sqlite3.db_open "test_db.sqlite3"

  module Backend = struct
    type 'a authorizable = 'a Guardian.Authorizable.t
    type 'b authorizable_target = 'b Guardian.AuthorizableTarget.t
    type role = A.t
    type auth_rule = Guardian.Authorizer.auth_rule
    type actor_role_set = Guardian.ActorRoleSet.t
    type actor_spec = Guardian.Authorizer.Actor.spec
    type target_role_set = Guardian.TargetRoleSet.t
    type target_spec = Guardian.Authorizer.Target.spec
    type ('rv, 'err) monad = ('rv, 'err) Lwt_result.t

    let lwt_return_rc = function
      | Sqlite3.Rc.OK | DONE | ROW -> Lwt.return_ok ()
      | rc -> Lwt.return_error (Sqlite3.Rc.to_string rc)
    ;;

    module Actor = struct
      module Authorizable = struct
        let create ?ctx ?(owner : Uuid.Actor.t option) roles id
          : (unit, string) Lwt_result.t
          =
          let open Lwt_result.Syntax in
          let open Sqlite3 in
          let (_ : (string * string) list option) = ctx in
          let stmt =
            prepare
              db
              {sql|INSERT INTO guardian_actors (id, roles, parent) VALUES (?, ?, ?)|sql}
          in
          let roles' = roles |> ActorSet.to_yojson |> Yojson.Safe.to_string in
          let* () =
            bind_values
              stmt
              [ Data.TEXT (Uuid.Actor.to_string id)
              ; Data.TEXT roles'
              ; Data.opt_text (CCOption.map Uuid.Actor.to_string owner)
              ]
            |> lwt_return_rc
          in
          lwt_return_rc (step stmt)
        ;;

        let mem ?ctx id =
          let open Sqlite3 in
          let (_ : (string * string) list option) = ctx in
          let stmt =
            prepare db {sql|SELECT * FROM guardian_actors WHERE id = ?|sql}
          in
          let (_ : Rc.t) =
            bind_values stmt [ Data.TEXT (Uuid.Actor.to_string id) ]
          in
          let (_ : Rc.t), rv =
            fold stmt ~f:(fun _acc _row -> Some true) ~init:None
          in
          rv |> CCOption.get_or ~default:false |> Lwt.return_ok
        ;;
      end

      let find ?ctx typ id =
        let open Lwt_result.Syntax in
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let id' = Uuid.Actor.to_string id in
        let stmt =
          prepare
            db
            {sql|SELECT roles, parent FROM guardian_actors WHERE id = ?|sql}
        in
        let (_ : Rc.t) = bind_values stmt [ Data.TEXT id' ] in
        let* () = lwt_return_rc (step stmt) in
        let roles =
          column_text stmt 0
          |> Yojson.Safe.from_string
          |> ActorSet.of_yojson
          |> CCResult.get_or_failwith
        in
        let owner = column_text stmt 1 |> Uuid.Actor.of_string in
        Guardian.Authorizable.make ?owner roles typ id |> Lwt.return_ok
      ;;

      let find_roles ?ctx id =
        let open Lwt_result.Syntax in
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let id' = Uuid.Actor.to_string id in
        let stmt =
          prepare db {sql|SELECT roles FROM guardian_actors WHERE id = ?|sql}
        in
        let (_ : Rc.t) = bind_values stmt [ Data.TEXT id' ] in
        let* () = lwt_return_rc (step stmt) in
        match CCString.trim (column_text stmt 0) with
        | "" -> Lwt.return_ok ActorSet.empty
        | coltext ->
          Yojson.Safe.from_string coltext |> ActorSet.of_yojson |> Lwt.return
      ;;

      let find_owner ?ctx id =
        let open Lwt_result.Syntax in
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let id' = Uuid.Actor.to_string id in
        let stmt =
          prepare db {sql|SELECT parent FROM guardian_actors WHERE id = ?|sql}
        in
        let* () =
          let (_ : Rc.t) = bind_values stmt [ Data.TEXT id' ] in
          lwt_return_rc (step stmt)
        in
        let raw = column_text stmt 0 in
        match Uuid.Actor.of_string raw with
        | Some uuid -> Lwt.return_ok (Some uuid)
        | None -> Lwt.return_ok None
      ;;

      let save_rule ?ctx ((actor, action, target) : auth_rule) =
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let action' = Guardian.Action.to_string action in
        let stmt =
          match actor, target with
          | `Actor aid, `Target tid ->
            let stmt =
              {sql|
                INSERT INTO guardian_rules (actor_id, act, target_id)
                VALUES (?, ?, ?)
              |sql}
              |> prepare db
            in
            let _ =
              bind_values
                stmt
                Data.
                  [ TEXT (Uuid.Actor.to_string aid)
                  ; TEXT action'
                  ; TEXT (Uuid.Target.to_string tid)
                  ]
            in
            stmt
          | `Actor aid, `TargetEntity trole ->
            let stmt =
              {sql|
                INSERT INTO guardian_rules (actor_id, act, target_role)
                VALUES (?, ?, ?)
              |sql}
              |> prepare db
            in
            let _ =
              bind_values
                stmt
                Data.
                  [ TEXT (Uuid.Actor.to_string aid)
                  ; TEXT action'
                  ; TEXT (T.show trole)
                  ]
            in
            stmt
          | `ActorEntity arole, `Target tid ->
            let stmt =
              {sql|
                INSERT INTO guardian_rules (actor_role, act, target_id)
                VALUES (?, ?, ?)
              |sql}
              |> prepare db
            in
            let _ =
              bind_values
                stmt
                Data.
                  [ TEXT (A.show arole)
                  ; TEXT action'
                  ; TEXT (Uuid.Target.to_string tid)
                  ]
            in
            stmt
          | `ActorEntity arole, `TargetEntity trole ->
            let stmt =
              {sql|
                INSERT INTO guardian_rules (actor_role, act, target_role)
                VALUES (?, ?, ?)
              |sql}
              |> prepare db
            in
            let _ =
              bind_values
                stmt
                Data.[ TEXT (A.show arole); TEXT action'; TEXT (T.show trole) ]
            in
            stmt
        in
        lwt_return_rc (step stmt)
      ;;

      let delete_rule
        ?ctx
        ((actor, action, target) : Guardian.Authorizer.auth_rule)
        =
        let open Lwt_result.Syntax in
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        match actor, target with
        | `Actor aid, `Target tid ->
          let stmt =
            {sql|
              DELETE FROM guardian_rules WHERE actor_id = ? AND act = ? AND target_id = ?
            |sql}
          in
          let stmt = prepare db stmt in
          let* () =
            lwt_return_rc
              (bind_values
                 stmt
                 Data.
                   [ TEXT (Uuid.Actor.to_string aid)
                   ; TEXT (Guardian.Action.to_string action)
                   ; TEXT (Uuid.Target.to_string tid)
                   ])
          in
          lwt_return_rc (step stmt)
        | `Actor aid, `TargetEntity trole ->
          let stmt =
            {sql|
              DELETE FROM guardian_rules WHERE actor_id = ? AND act = ? AND target_role = ?
            |sql}
          in
          let stmt = prepare db stmt in
          let* () =
            lwt_return_rc
              (bind_values
                 stmt
                 Data.
                   [ TEXT (Uuid.Actor.to_string aid)
                   ; TEXT (Guardian.Action.to_string action)
                   ; TEXT (T.show trole)
                   ])
          in
          lwt_return_rc (step stmt)
        | `ActorEntity arole, `Target tid ->
          let stmt =
            {sql|
              DELETE FROM guardian_rules WHERE actor_role = ? AND act = ? AND target_id = ?
            |sql}
          in
          let stmt = prepare db stmt in
          let* () =
            lwt_return_rc
              (bind_values
                 stmt
                 Data.
                   [ TEXT (A.show arole)
                   ; TEXT (Guardian.Action.to_string action)
                   ; TEXT (Uuid.Target.to_string tid)
                   ])
          in
          lwt_return_rc (step stmt)
        | `ActorEntity arole, `TargetEntity trole ->
          let stmt =
            {sql|
              DELETE FROM guardian_rules WHERE actor_role = ? AND act = ? AND target_role = ?
            |sql}
          in
          let stmt = prepare db stmt in
          let* () =
            lwt_return_rc
              (bind_values
                 stmt
                 Data.
                   [ TEXT (A.show arole)
                   ; TEXT (Guardian.Action.to_string action)
                   ; TEXT (T.show trole)
                   ])
          in
          lwt_return_rc (step stmt)
      ;;

      let find_rules ?ctx (spec : target_spec) =
        let open Lwt_result.Syntax in
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let* stmt =
          match spec with
          | `Target tid ->
            let stmt =
              {sql|
                SELECT act, actor_id, actor_role FROM guardian_rules WHERE target_id = ?
              |sql}
              |> prepare db
            in
            let* () =
              lwt_return_rc
                (bind_values stmt [ Data.TEXT (Uuid.Target.to_string tid) ])
            in
            Lwt.return_ok stmt
          | `TargetEntity role ->
            let stmt =
              {sql|
                SELECT act, actor_id, actor_role FROM guardian_rules WHERE target_role = ?
              |sql}
              |> prepare db
            in
            let () = Printf.printf "Searching for role: %s\n" (T.show role) in
            let* () =
              lwt_return_rc (bind_values stmt [ Data.TEXT (T.show role) ])
            in
            Lwt.return_ok stmt
        in
        let rc, rv =
          fold
            stmt
            ~f:(fun acc row ->
              let action =
                row.(0) |> Data.to_string_exn |> Guardian.Action.of_string
              in
              let (actor : Guardian.Authorizer.Actor.spec) =
                match Data.(to_string row.(1), to_string row.(2)) with
                | Some actor_id, None ->
                  `Actor
                    (Uuid.Actor.of_string actor_id
                    |> CCOption.get_exn_or "Malformatted UUID!")
                | None, Some actor_role -> `ActorEntity (A.of_string actor_role)
                | _ -> raise (Invalid_argument "Invalid actor spec")
              in
              let x : Guardian.Authorizer.auth_rule = actor, action, spec in
              x :: acc)
            ~init:[]
        in
        let* () = lwt_return_rc rc in
        Lwt.return_ok rv
      ;;

      let grant_roles ?ctx id roles =
        let open Lwt_result.Syntax in
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let id' = Uuid.Actor.to_string id in
        let* roles' =
          let* pre_roles = find_roles id in
          ActorSet.union pre_roles roles
          |> ActorSet.to_yojson
          |> Yojson.Safe.to_string
          |> Lwt.return_ok
        in
        let* stmt =
          let* mem = Authorizable.mem ?ctx id in
          if mem
          then
            Lwt.return_ok
              (prepare
                 db
                 {sql|UPDATE guardian_actors SET roles = ? WHERE id = ?|sql})
          else
            Lwt.return_error
              "Cannot grant a role to an authorizable which doesn't exist."
        in
        let () = ignore (bind_values stmt Data.[ TEXT roles'; TEXT id' ]) in
        lwt_return_rc (step stmt)
      ;;

      let revoke_roles ?ctx id roles =
        let open Lwt_result.Syntax in
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let id' = Uuid.Actor.to_string id in
        let* roles' =
          let* pre_roles = find_roles id in
          ActorSet.diff pre_roles roles
          |> ActorSet.to_yojson
          |> Yojson.Safe.to_string
          |> Lwt.return_ok
        in
        let* stmt =
          let* mem = Authorizable.mem ?ctx id in
          if mem
          then
            Lwt.return_ok
              (prepare
                 db
                 {sql|UPDATE guardian_actors SET roles = ? WHERE id = ?|sql})
          else
            Lwt.return_error
              "Cannot grant a role to an authorizable which doesn't exist."
        in
        let () = ignore (bind_values stmt Data.[ TEXT roles'; TEXT id' ]) in
        lwt_return_rc (step stmt)
      ;;

      let save_owner ?ctx ?owner id =
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let id' = Uuid.Actor.to_string id in
        let owner' = owner |> CCOption.map Uuid.Actor.to_string in
        let stmt =
          prepare
            db
            {sql|UPDATE guardian_actors SET parent = ? WHERE id = ?|sql}
        in
        let () = ignore (bind_values stmt Data.[ opt_text owner'; TEXT id' ]) in
        lwt_return_rc (step stmt)
      ;;
    end

    module Target = struct
      module Authorizable = struct
        let create ?ctx ?owner roles id =
          let open Lwt_result.Syntax in
          let open Sqlite3 in
          let (_ : (string * string) list option) = ctx in
          let stmt =
            prepare
              db
              {sql|INSERT INTO guardian_targets (id, roles, parent) VALUES (?, ?, ?)|sql}
          in
          let roles' =
            Guardian.TargetRoleSet.to_yojson roles |> Yojson.Safe.to_string
          in
          let* () =
            bind_values
              stmt
              [ Data.TEXT (Uuid.Target.to_string id)
              ; Data.TEXT roles'
              ; Data.opt_text (owner |> CCOption.map Uuid.Actor.to_string)
              ]
            |> lwt_return_rc
          in
          lwt_return_rc (step stmt)
        ;;

        let mem ?ctx id =
          let open Sqlite3 in
          let (_ : (string * string) list option) = ctx in
          let stmt =
            prepare db {sql|SELECT * FROM guardian_targets WHERE id = ?|sql}
          in
          let (_ : Rc.t) =
            bind_values stmt [ Data.TEXT (Uuid.Target.to_string id) ]
          in
          let (_ : Rc.t), rv =
            fold stmt ~f:(fun _acc _row -> Some true) ~init:None
          in
          rv |> CCOption.get_or ~default:false |> Lwt.return_ok
        ;;
      end

      let find ?ctx typ id =
        let open Lwt_result.Syntax in
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let id' = Uuid.Target.to_string id in
        let stmt =
          prepare
            db
            {sql|SELECT roles, parent FROM guardian_targets WHERE id = ?|sql}
        in
        let (_ : Rc.t) = bind_values stmt [ Data.TEXT id' ] in
        let* () = lwt_return_rc (step stmt) in
        let entity =
          column_text stmt 0
          |> Yojson.Safe.from_string
          |> TargetSet.of_yojson
          |> CCResult.get_or_failwith
        in
        let owner = column_text stmt 1 |> Uuid.Actor.of_string in
        Guardian.AuthorizableTarget.make ?owner entity typ id |> Lwt.return_ok
      ;;

      let find_roles ?ctx (id : Uuid.Target.t) =
        let open Lwt_result.Syntax in
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let id' = Uuid.Target.to_string id in
        let stmt =
          prepare db {sql|SELECT roles FROM guardian_targets WHERE id = ?|sql}
        in
        let (_ : Rc.t) = bind_values stmt [ Data.TEXT id' ] in
        let* () = lwt_return_rc (step stmt) in
        match CCString.trim (column_text stmt 0) with
        | "" -> Lwt.return_ok Guardian.TargetRoleSet.empty
        | coltext ->
          Yojson.Safe.from_string coltext
          |> Guardian.TargetRoleSet.of_yojson
          |> Lwt.return
      ;;

      let find_owner ?ctx id =
        let open Lwt_result.Syntax in
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let id' = Uuid.Target.to_string id in
        let stmt =
          prepare db {sql|SELECT parent FROM guardian_targets WHERE id = ?|sql}
        in
        let* () =
          let (_ : Rc.t) = bind_values stmt [ Data.TEXT id' ] in
          lwt_return_rc (step stmt)
        in
        let raw = column_text stmt 0 in
        match Uuid.Actor.of_string raw with
        | Some uuid -> Lwt.return_ok (Some uuid)
        | None -> Lwt.return_ok None
      ;;

      let save_owner ?ctx ?owner id =
        let open Sqlite3 in
        let (_ : (string * string) list option) = ctx in
        let id' = Uuid.Target.to_string id in
        let owner' = owner |> CCOption.map Uuid.Actor.to_string in
        let stmt =
          prepare
            db
            {sql|UPDATE guardian_targets SET parent = ? WHERE id = ?|sql}
        in
        let () = ignore (bind_values stmt Data.[ opt_text owner'; TEXT id' ]) in
        lwt_return_rc (step stmt)
      ;;
    end

    (** [find_migrations ()] returns a list of all migrations as a tuple with
        key, datetime and sql query **)
    let find_migrations () = Migrations.all

    (** [find_clean ()] returns a list of all migrations as a tuple with key and
        sql query **)
    let find_clean () =
      Migrations.all_tables
      |> CCList.map (fun m -> m, Format.asprintf "DELETE FROM %s" m)
    ;;

    (** [migrate ()] runs all migration on a specified context [?ctx] **)
    let migrate ?ctx () =
      let (_ : (string * string) list option) = ctx in
      ()
      |> find_migrations
      |> Lwt_list.iter_s (fun (key, date, sql) ->
           let open Sqlite3 in
           let open Lwt.Infix in
           Logs.debug (fun m -> m "Migration: Run '%s' from '%s'" key date);
           sql |> prepare db |> step |> lwt_return_rc >>= get_or_exn)
    ;;

    (** [clean ()] runs clean on a specified context [?ctx] **)
    let clean ?ctx () =
      let (_ : (string * string) list option) = ctx in
      ()
      |> find_clean
      |> Lwt_list.iter_s (fun (key, sql) ->
           let open Sqlite3 in
           let open Lwt.Infix in
           Logs.debug (fun m -> m "Clean: Run '%s'" key);
           sql |> prepare db |> step |> lwt_return_rc >>= get_or_exn)
    ;;
  end

  include Guardian.Make_persistence (Backend)
end
OCaml

Innovation. Community. Security.