kiosk-rls 0.5.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: f342f81e8a0c9d98ccf27406ee1e19cbf77c9d4ed685de2ac0b5cfc5869e82fa
4
+ data.tar.gz: e50975a44e63e8d6e407e8b717e01ff50c692e405399401fb75880d2eab82f32
5
+ SHA512:
6
+ metadata.gz: 7bb6b277c855a3cb1a802e3124604501b9bc08e7f22124c94c513c718222e4d42091932b1922fd56937eb12c8835a9bace04855d3ae108829c7470f008912521
7
+ data.tar.gz: dbbb5b6eab46dde59fa8f7c753d1c14793676ec36888fbc5c3ff80cf3bab35c5109540c45ce561133d464c2c406d93562a5b7efbe7ca603b7287a21822a01688
data/CHANGELOG.md ADDED
@@ -0,0 +1,129 @@
1
+ # Changelog
2
+
3
+ All notable changes follow [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and [Semantic Versioning](https://semver.org/).
4
+
5
+ How to write an entry, and what a release section means: `CHANGELOG-RULE.md` at
6
+ the root of this repository —
7
+ <https://github.com/kiosk-hq/kiosk/blob/main/CHANGELOG-RULE.md>. In short: under
8
+ 200 characters, one or two sentences, the essence rather than the content; write it
9
+ under `## [Unreleased]`; a cut renames that heading to
10
+ `## [MAJOR.MINOR.PATCH] — <date>` and opens a fresh empty one above it; nothing
11
+ already written is edited.
12
+
13
+ ## [Unreleased]
14
+
15
+ ## [0.5.20] — 2026-10-20
16
+
17
+ - 2026-10-20: Version 0.5.20, the tree cut that matches skill 0.5.20.
18
+
19
+ ## [0.5.19] — 2026-10-20
20
+
21
+ - 2026-10-20: Version 0.5.19, the tree cut that matches skill 0.5.19.
22
+
23
+ ## [0.5.18] — 2026-10-18
24
+
25
+ - 2026-10-18: Version 0.5.18, the tree cut that matches skill 0.5.18.
26
+
27
+ ## [0.5.17] — 2026-10-18
28
+
29
+ - 2026-10-18: Version 0.5.17, the tree cut that matches skill 0.5.17.
30
+
31
+ ## [0.5.16] — 2026-10-18
32
+
33
+ - 2026-10-18: Version 0.5.16, the tree cut that matches skill 0.5.16.
34
+
35
+ ## [0.5.15] — 2026-10-18
36
+
37
+ - 2026-10-18: Version 0.5.15, the tree cut that matches skill 0.5.15.
38
+
39
+ ## [0.5.14] — 2026-10-18
40
+
41
+ - 2026-10-18: Version 0.5.14, the tree cut that matches skill 0.5.14.
42
+
43
+ - 2026-10-17: The `system_role` setting is removed; nothing read it.
44
+
45
+ ## [0.5.13] — 2026-10-11
46
+
47
+ - 2026-10-11: Version 0.5.13, the tree cut that matches skill 0.5.13.
48
+
49
+ - 2026-10-09: The README says an app using RLS policies needs `schema_format = :sql`, since `schema.rb` cannot carry them.
50
+
51
+ ## [0.5.12] — 2026-10-08
52
+
53
+ - 2026-10-08: Version 0.5.12, the tree cut that matches skill 0.5.12; this gem's surface is unchanged.
54
+
55
+ ## [0.5.11] — 2026-10-08
56
+
57
+ - 2026-10-08: Version 0.5.11, the tree cut that matches skill 0.5.11; this gem's surface is unchanged.
58
+
59
+ ## [0.5.10] — 2026-10-08
60
+
61
+ - 2026-10-08: Version 0.5.10, the tree cut that matches skill 0.5.10; this gem's surface is unchanged.
62
+
63
+ ## [0.5.9] — 2026-10-08
64
+
65
+ - 2026-10-08: Version 0.5.9, the tree cut that matches skill 0.5.9; this gem's surface is unchanged.
66
+
67
+ ## [0.5.8] — 2026-10-07
68
+
69
+ - 2026-10-07: Version 0.5.8, the tree cut that matches skill 0.5.8; this gem's surface is unchanged.
70
+
71
+ ## [0.5.7] — 2026-10-07
72
+
73
+ - 2026-10-07: Version 0.5.7, the tree cut that matches skill 0.5.7; this gem's surface is unchanged.
74
+
75
+ ## [0.5.6] — 2026-10-07
76
+
77
+ - 2026-10-07: Version 0.5.6, the tree cut that matches skill 0.5.6; this gem's surface is unchanged.
78
+
79
+ ## [0.5.5] — 2026-10-07
80
+
81
+ - 2026-10-07: Version 0.5.5, the tree cut that matches skill 0.5.5; this gem's surface is unchanged.
82
+
83
+ ## [0.5.4] — 2026-10-07
84
+
85
+ - 2026-10-07: Version 0.5.4, the tree cut that matches skill 0.5.4; this gem's surface is unchanged.
86
+
87
+ ## [0.5.3] — 2026-10-06
88
+
89
+ - 2026-10-06: Version 0.5.3, the tree cut that matches skill 0.5.3; this gem's surface is unchanged.
90
+
91
+ ## [0.5.2] — 2026-10-06
92
+
93
+ - 2026-10-06: Version 0.5.2, the tree cut that matches skill 0.5.2; this gem's surface is unchanged.
94
+
95
+ ## [0.5.0] — 2026-09-26
96
+
97
+ ### Changed
98
+
99
+ - **The README stopped forecasting `rake kiosk:rls:{show,check}`, which nothing defines (K-1700).** It now points at `psql`, which answers both questions today.
100
+
101
+ - **The rubygems blurb listed the DDL this gem emits and left out FORCE ROW LEVEL SECURITY (K-1697).** Without it Postgres exempts the table owner and RLS is a no-op.
102
+ - **`system_role` stops pointing at an Action-DSL escalation that has not shipped (K-1695).** Its live caveat now carries the measurement behind it.
103
+
104
+ - README: every `gem` line in the install section now carries `github: "kiosk-hq/kiosk"`, so a copied line resolves before publication; the banner above them states what the block does rather than asking the reader to add it.
105
+ - Now truly opt-in: no longer a dependency of kiosk-server, kiosk-all, or
106
+ kiosk-test-support. `ConfigurationExtension` now contributes only
107
+ `system_role`; `schema` and `app_role` moved to kiosk-core,
108
+ `enforce_db_role` to kiosk-server.
109
+
110
+ ### Added
111
+
112
+ - `Kiosk::RLS::Railtie` — a Rails host gets the five migration verbs on
113
+ `ActiveRecord::Migration` from the gem itself. The README used to tell the
114
+ host to write `ActiveRecord::Migration.include(Kiosk::RLS::DSL)` in an
115
+ initializer; that is an application patching a framework class on a gem's
116
+ behalf, and it is gone. Non-Rails hosts still include `Kiosk::RLS::DSL`
117
+ wherever they answer `#execute(sql)`. (K-504)
118
+ - Initial skeleton.
119
+ - `Kiosk::RLS::Policy` value type (Data class): name, action, using, check; action ∈ {select, insert, update, delete, all}.
120
+ - `Kiosk::RLS::Table` mutable builder used inside `enable_rls_on` blocks.
121
+ - `Kiosk::RLS::Emitter` — pure SQL-DDL generation (ENABLE ROW LEVEL SECURITY, GRANT, CREATE POLICY, COMMENT ON TABLE, DROP POLICY, ALTER POLICY ... RENAME TO).
122
+ - `Kiosk::RLS::DSL` — `enable_rls_on`, `add_kiosk_policy_to`, `change_kiosk_policy_on`, `remove_kiosk_policy_from`, `rename_kiosk_policy_on`.
123
+ - `Kiosk::RLS::ConfigurationExtension` — adds the RLS-only `system_role` to `Kiosk::Configuration` with a lazy default.
124
+ - RSpec suite covering policy validation, builder semantics, SQL emission, DSL with fake executor, config extension.
125
+
126
+ ### Out of scope for first release
127
+
128
+ - `rake kiosk:rls:{show,check}` rake tasks (need PG connection — land later).
129
+ - Schema-separated view DSL (`bin/rails g kiosk:view` — deferred to v1.1).
data/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,121 @@
1
+ # kiosk-rls
2
+
3
+ Optional DB-layer defense-in-depth for [Kiosk](https://kiosk.tech) providers.
4
+
5
+ ## Security model overview
6
+
7
+ **RLS is not Kiosk's primary security model.** Kiosk's isolation comes from the sanctioned verb surface: agents never send raw SQL, named queries enforce app-layer authz, and `kiosk.current_user_id()` GUCs scope per-user reads in Ruby. That surface is sufficient.
8
+
9
+ `kiosk-rls` is an **optional** companion for providers who want an additional DB-level row enforcement layer — belt-and-suspenders hardening. Calling `enable_rls_on` is opt-in; not calling it is the default and fully correct.
10
+
11
+ Policies and the `kiosk.current_*()` functions they call are not representable in `db/schema.rb`; an app that uses this gem needs `config.active_record.schema_format = :sql`.
12
+
13
+ ## What it does
14
+
15
+ `kiosk-rls` provides the Ruby DSL providers use inside their ActiveRecord migrations to declare RLS policies — and compiles those declarations to standard PostgreSQL DDL.
16
+
17
+ When you opt in, `enable_rls_on` emits both `ENABLE ROW LEVEL SECURITY` **and** `FORCE ROW LEVEL SECURITY` so the policies actually enforce. Without `FORCE`, Postgres exempts the table owner from RLS — making it a no-op for the typical Rails setup where the app connects as the owner.
18
+
19
+ **Prerequisite for real enforcement:** the application must connect as a **non-superuser, non-owner role** (the `app_role`) with table GRANTs. `FORCE` makes RLS apply to the table owner too, but a Postgres superuser still bypasses all policies unconditionally. Never use a superuser as the runtime role when RLS enforcement matters.
20
+
21
+ ```ruby
22
+ # db/migrate/20260101000002_create_rentals.rb
23
+ class CreateRentals < ActiveRecord::Migration[8.1]
24
+ def change
25
+ create_table :rentals do |t|
26
+ t.references :user, null: false, foreign_key: true
27
+ t.references :scooter, null: false, foreign_key: true
28
+ t.timestamp :started_at, null: false
29
+ t.timestamp :ended_at
30
+ t.integer :total_cents
31
+ t.timestamps
32
+ end
33
+
34
+ enable_rls_on :rentals do
35
+ policy :select, using: "user_id = kiosk.current_user_id()"
36
+ policy :insert, check: "user_id = kiosk.current_user_id() AND kiosk.current_role() = 'customer'"
37
+ comment "Scooter rentals owned by the renting user. Mutations after creation go through Actions."
38
+ end
39
+ end
40
+ end
41
+ ```
42
+
43
+ Compiles to:
44
+
45
+ ```sql
46
+ ALTER TABLE "rentals" ENABLE ROW LEVEL SECURITY;
47
+ ALTER TABLE "rentals" FORCE ROW LEVEL SECURITY;
48
+ GRANT SELECT, INSERT, UPDATE, DELETE ON "rentals" TO "app_role";
49
+ CREATE POLICY "rentals_select" ON "rentals" FOR SELECT USING (user_id = kiosk.current_user_id());
50
+ CREATE POLICY "rentals_insert" ON "rentals" FOR INSERT WITH CHECK (user_id = kiosk.current_user_id() AND kiosk.current_role() = 'customer');
51
+ COMMENT ON TABLE "rentals" IS 'Scooter rentals owned by the renting user. ...';
52
+ ```
53
+
54
+ ## Evolving policies
55
+
56
+ ```ruby
57
+ add_kiosk_policy_to :rentals, :select, using: "..."
58
+ change_kiosk_policy_on :rentals, :update, using: "...", check: "..."
59
+ remove_kiosk_policy_from :rentals, :delete
60
+ rename_kiosk_policy_on :rentals, from: :select, to: "rentals_select_owner_or_admin"
61
+ ```
62
+
63
+ ## Install (opt-in)
64
+
65
+ > **Not on RubyGems yet** — so every `gem` line below carries `github: "kiosk-hq/kiosk"`, which is what makes it copy-pasteable today. Publication status and the canonical install are stated once, in the monorepo README's [Install](https://github.com/kiosk-hq/kiosk#install) section.
66
+
67
+ `kiosk-rls` is NOT pulled in by `kiosk-server` or `kiosk-all` — opting in
68
+ means adding the gem yourself:
69
+
70
+ ```ruby
71
+ gem "kiosk-rls", github: "kiosk-hq/kiosk"
72
+ ```
73
+
74
+ ## Rails integration
75
+
76
+ Nothing to wire. The gem ships a railtie (`Kiosk::RLS::Railtie`) that adds the
77
+ migration verbs used above to `ActiveRecord::Migration` on boot, so a
78
+ migration can call `enable_rls_on` the moment the gem is in your `Gemfile`. Do
79
+ **not** put `ActiveRecord::Migration.include(Kiosk::RLS::DSL)` in an
80
+ initializer — the gem does that itself, and an application patching a
81
+ framework class on a gem's behalf is a load-order bug waiting to happen.
82
+
83
+ What *is* yours to configure is the role posture, in
84
+ `config/initializers/kiosk.rb`:
85
+
86
+ ```ruby
87
+ Kiosk.configure do |c|
88
+ c.app_role = "app_role" # lives in kiosk-core config
89
+ c.enforce_db_role = true # kiosk-server: SET LOCAL ROLE per request
90
+ end
91
+ ```
92
+
93
+ ### Outside Rails
94
+
95
+ The DSL is a plain module and needs only a host that answers
96
+ `#execute(sql_string)` — a Sequel migration, a rake task, a bare script:
97
+
98
+ ```ruby
99
+ require "kiosk/rls"
100
+
101
+ class ApplyRLS
102
+ include Kiosk::RLS::DSL
103
+
104
+ def execute(sql) = DB.run(sql)
105
+ end
106
+ ```
107
+
108
+ ## Status
109
+
110
+ Pre-v1.0 alpha. The DSL surface is stable across pre-v1.0 minor bumps; SQL emission may evolve as we add corner cases (schema-qualified tables, partitioned tables, view-based column gating).
111
+
112
+ This gem emits DDL and ships no rake tasks. What a table's policies actually are on a live database is `psql`'s to answer, and it needs nothing from here: `\d+ TABLE` prints a `Policies (forced row security enabled)` block carrying every policy body, and `select * from pg_policies where tablename = 'TABLE'` returns the same as rows.
113
+
114
+ ## License
115
+
116
+ Apache-2.0 — see `LICENSE.txt`.
117
+
118
+ ## Links
119
+
120
+ - [kiosk.tech](https://kiosk.tech)
121
+ - [Issue tracker](https://github.com/kiosk-hq/kiosk/issues)
@@ -0,0 +1,70 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'kiosk/rls/policy'
4
+ require 'kiosk/rls/table'
5
+ require 'kiosk/rls/emitter'
6
+
7
+ module Kiosk
8
+ module RLS
9
+ # RLS migration verbs for any host that provides `#execute(sql)`;
10
+ # Rails migrations get them through {Kiosk::RLS::Railtie}.
11
+ module DSL
12
+ # @example
13
+ # enable_rls_on :rentals do
14
+ # policy :select, using: "user_id = kiosk.current_user_id()"
15
+ # policy :insert, check: "user_id = kiosk.current_user_id() AND kiosk.current_role() = 'customer'"
16
+ # comment "Scooter rentals owned by the renting user."
17
+ # end
18
+ def enable_rls_on(table_name, app_role: nil, sequences: [], &block)
19
+ table = Table.new(table_name, app_role: app_role, sequences: sequences)
20
+ table.instance_eval(&block) if block
21
+ table.validate!
22
+ emit_rls(Emitter.statements_for(table))
23
+ end
24
+
25
+ def add_kiosk_policy_to(table_name, action, name: nil, using: nil, check: nil)
26
+ policy = Policy.new(
27
+ name: name || default_policy_name(table_name, action),
28
+ action: action,
29
+ using: using,
30
+ check: check
31
+ )
32
+ emit_rls([Emitter.create_policy_sql(table_name.to_s, policy)])
33
+ end
34
+
35
+ # PG has no `CREATE OR REPLACE POLICY`.
36
+ def change_kiosk_policy_on(table_name, action, name: nil, using: nil, check: nil)
37
+ policy_name = name || default_policy_name(table_name, action)
38
+ emit_rls([
39
+ Emitter.drop_policy_sql(table_name.to_s, policy_name),
40
+ Emitter.create_policy_sql(
41
+ table_name.to_s,
42
+ Policy.new(name: policy_name, action: action, using: using, check: check)
43
+ )
44
+ ])
45
+ end
46
+
47
+ def remove_kiosk_policy_from(table_name, action, name: nil)
48
+ policy_name = name || default_policy_name(table_name, action)
49
+ emit_rls([Emitter.drop_policy_sql(table_name.to_s, policy_name)])
50
+ end
51
+
52
+ # A Symbol `from:` names the convention policy `<table>_<from>`.
53
+ def rename_kiosk_policy_on(table_name, from:, to:)
54
+ from_name = from.is_a?(Symbol) ? default_policy_name(table_name, from) : from.to_s
55
+ to_name = to.to_s
56
+ emit_rls([Emitter.rename_policy_sql(table_name.to_s, from_name, to_name)])
57
+ end
58
+
59
+ private
60
+
61
+ def default_policy_name(table_name, action)
62
+ "#{table_name}_#{action}"
63
+ end
64
+
65
+ def emit_rls(statements)
66
+ statements.each { |sql| execute(sql) }
67
+ end
68
+ end
69
+ end
70
+ end
@@ -0,0 +1,74 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Kiosk
4
+ module RLS
5
+ # Compiles {Table} and {Policy} into PostgreSQL DDL.
6
+ module Emitter
7
+ class << self
8
+ def statements_for(table)
9
+ name = table.name
10
+ [
11
+ enable_rls_sql(name),
12
+ force_rls_sql(name), # without FORCE the table owner bypasses RLS
13
+ grant_table_sql(name, table.app_role),
14
+ *table.sequences.map { |seq| grant_sequence_sql(seq, table.app_role) },
15
+ *table.policies.map { |policy| create_policy_sql(name, policy) },
16
+ *(comment_sql(name, table.comment_text) if table.comment_text)
17
+ ]
18
+ end
19
+
20
+ def enable_rls_sql(table_name)
21
+ %(ALTER TABLE #{quote_ident(table_name)} ENABLE ROW LEVEL SECURITY)
22
+ end
23
+
24
+ def force_rls_sql(table_name)
25
+ %(ALTER TABLE #{quote_ident(table_name)} FORCE ROW LEVEL SECURITY)
26
+ end
27
+
28
+ def grant_table_sql(table_name, role)
29
+ %(GRANT SELECT, INSERT, UPDATE, DELETE ON #{quote_ident(table_name)} TO #{quote_ident(role)})
30
+ end
31
+
32
+ def grant_sequence_sql(sequence_name, role)
33
+ %(GRANT USAGE, SELECT ON SEQUENCE #{quote_ident(sequence_name)} TO #{quote_ident(role)})
34
+ end
35
+
36
+ def create_policy_sql(table_name, policy)
37
+ parts = [
38
+ "CREATE POLICY #{quote_ident(policy.name)}",
39
+ "ON #{quote_ident(table_name)}",
40
+ "FOR #{policy.action.to_s.upcase}"
41
+ ]
42
+ parts << "USING (#{policy.using})" if policy.using
43
+ parts << "WITH CHECK (#{policy.check})" if policy.check
44
+ parts.join(' ')
45
+ end
46
+
47
+ def drop_policy_sql(table_name, policy_name)
48
+ %(DROP POLICY IF EXISTS #{quote_ident(policy_name)} ON #{quote_ident(table_name)})
49
+ end
50
+
51
+ def rename_policy_sql(table_name, from_name, to_name)
52
+ %(ALTER POLICY #{quote_ident(from_name)} ON #{quote_ident(table_name)} ) +
53
+ %(RENAME TO #{quote_ident(to_name)})
54
+ end
55
+
56
+ def comment_sql(table_name, text)
57
+ %(COMMENT ON TABLE #{quote_ident(table_name)} IS #{quote_literal(text)})
58
+ end
59
+
60
+ private
61
+
62
+ def quote_ident(name)
63
+ name.to_s.split('.').map do |part|
64
+ %("#{part.gsub('"', '""')}")
65
+ end.join('.')
66
+ end
67
+
68
+ def quote_literal(text)
69
+ %('#{text.to_s.gsub("'", "''")}')
70
+ end
71
+ end
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Kiosk
4
+ module RLS
5
+ # One PostgreSQL row-level-security policy: `using` filters reads, `check` writes.
6
+ Policy = Data.define(:name, :action, :using, :check)
7
+
8
+ class Policy
9
+ ACTIONS = %i[select insert update delete all].freeze
10
+
11
+ def initialize(name:, action:, using: nil, check: nil)
12
+ action = action.to_sym
13
+ raise ArgumentError, "action must be one of #{ACTIONS.inspect}, got #{action.inspect}" unless ACTIONS.include?(action)
14
+ raise ArgumentError, 'at least one of using:/check: required' if using.nil? && check.nil?
15
+
16
+ super(name: name.to_s, action: action, using: using&.to_s, check: check&.to_s)
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'kiosk/rls/dsl'
4
+
5
+ module Kiosk
6
+ module RLS
7
+ # Adds the RLS migration verbs to `ActiveRecord::Migration` with no host wiring.
8
+ class Railtie < ::Rails::Railtie
9
+ initializer 'kiosk_rls.migration_dsl' do
10
+ ActiveSupport.on_load(:active_record) do
11
+ ActiveRecord::Migration.include(Kiosk::RLS::DSL)
12
+ end
13
+ end
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'kiosk/rls/policy'
4
+
5
+ module Kiosk
6
+ module RLS
7
+ # The builder an `enable_rls_on TABLE do ... end` block runs in.
8
+ class Table
9
+ attr_reader :name, :policies, :comment_text, :app_role, :sequences
10
+
11
+ def initialize(name, app_role: nil, sequences: [])
12
+ @name = name.to_s
13
+ @policies = []
14
+ @comment_text = nil
15
+ @app_role = app_role || Kiosk.configuration.app_role
16
+ @sequences = Array(sequences).map(&:to_s)
17
+ end
18
+
19
+ def policy(action, name: nil, using: nil, check: nil)
20
+ @policies << Policy.new(
21
+ name: name || default_policy_name(action),
22
+ action: action,
23
+ using: using,
24
+ check: check
25
+ )
26
+ end
27
+
28
+ # Mandatory; emitted as COMMENT ON TABLE.
29
+ def comment(text)
30
+ @comment_text = text&.to_s
31
+ end
32
+
33
+ def validate!
34
+ if @comment_text.nil? || @comment_text.empty?
35
+ raise ArgumentError,
36
+ "enable_rls_on(:#{@name}) requires a `comment \"...\"` " \
37
+ 'inside the block'
38
+ end
39
+ self
40
+ end
41
+
42
+ private
43
+
44
+ def default_policy_name(action)
45
+ "#{@name}_#{action}"
46
+ end
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Kiosk
4
+ module RLS
5
+ VERSION = '0.5.20'
6
+ end
7
+ end
data/lib/kiosk/rls.rb ADDED
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ # kiosk-rls — the Kiosk RLS DSL and SQL emitter.
4
+
5
+ require 'kiosk'
6
+
7
+ require 'kiosk/rls/version'
8
+ require 'kiosk/rls/policy'
9
+ require 'kiosk/rls/table'
10
+ require 'kiosk/rls/emitter'
11
+ require 'kiosk/rls/dsl'
12
+
13
+ # Outside Rails the host includes {Kiosk::RLS::DSL} itself.
14
+ require 'kiosk/rls/railtie' if defined?(Rails::Railtie)
metadata ADDED
@@ -0,0 +1,82 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: kiosk-rls
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.5.20
5
+ platform: ruby
6
+ authors:
7
+ - Phil Pirozhkov
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: kiosk-core
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - "~>"
17
+ - !ruby/object:Gem::Version
18
+ version: 0.5.0
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - "~>"
24
+ - !ruby/object:Gem::Version
25
+ version: 0.5.0
26
+ description: |
27
+ kiosk-rls provides the row-level-security DSL Kiosk providers use inside
28
+ their ActiveRecord migrations: `enable_rls_on`, `policy`, plus the
29
+ add/change/remove/rename migration verbs.
30
+
31
+ The DSL compiles to standard PostgreSQL DDL (ALTER TABLE ENABLE ROW LEVEL
32
+ SECURITY, ALTER TABLE FORCE ROW LEVEL SECURITY, GRANT, CREATE POLICY,
33
+ COMMENT ON TABLE) and runs inside the migration's transaction via the
34
+ host's `#execute` method. FORCE is not optional: without it Postgres
35
+ exempts the table owner, and the typical Rails app connects as the owner,
36
+ so RLS would be a no-op.
37
+
38
+ No PostgreSQL runtime dependency — pure SQL generation. The host
39
+ provides the connection.
40
+ email:
41
+ - hello@fili.pp.ru
42
+ executables: []
43
+ extensions: []
44
+ extra_rdoc_files: []
45
+ files:
46
+ - CHANGELOG.md
47
+ - LICENSE.txt
48
+ - README.md
49
+ - lib/kiosk/rls.rb
50
+ - lib/kiosk/rls/dsl.rb
51
+ - lib/kiosk/rls/emitter.rb
52
+ - lib/kiosk/rls/policy.rb
53
+ - lib/kiosk/rls/railtie.rb
54
+ - lib/kiosk/rls/table.rb
55
+ - lib/kiosk/rls/version.rb
56
+ homepage: https://kiosk.tech
57
+ licenses:
58
+ - Apache-2.0
59
+ metadata:
60
+ homepage_uri: https://kiosk.tech
61
+ source_code_uri: https://github.com/kiosk-hq/kiosk
62
+ changelog_uri: https://github.com/kiosk-hq/kiosk/blob/main/kiosk-rls/CHANGELOG.md
63
+ bug_tracker_uri: https://github.com/kiosk-hq/kiosk/issues
64
+ rubygems_mfa_required: 'true'
65
+ rdoc_options: []
66
+ require_paths:
67
+ - lib
68
+ required_ruby_version: !ruby/object:Gem::Requirement
69
+ requirements:
70
+ - - ">="
71
+ - !ruby/object:Gem::Version
72
+ version: '4.0'
73
+ required_rubygems_version: !ruby/object:Gem::Requirement
74
+ requirements:
75
+ - - ">="
76
+ - !ruby/object:Gem::Version
77
+ version: '0'
78
+ requirements: []
79
+ rubygems_version: 4.0.3
80
+ specification_version: 4
81
+ summary: RLS DSL and PostgreSQL DDL emitter for the Kiosk framework
82
+ test_files: []