polkit 1.0.0

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: dc0c8cbaf48a016301ec845c59eeb601a59d814bfee1e1c8572a624bc4501453
4
+ data.tar.gz: 05d3db4ee6cfc5d62fa3464bdab3dc6f1d89b3611fa34918aee98122d744444f
5
+ SHA512:
6
+ metadata.gz: b9ffe1f307db6af6aa60837b6bd6ddf6548125a485846f436544f4d3be488ae650d75bac5e1c8937bd59bc348ca37e77b5ce8b3f3ed5861ba9acbb327dbee4bb
7
+ data.tar.gz: 89021feb7254cda535ca56e3c63d37e95c20b6f4c05830d8171d3c350301109283a1db959d631f883223a3ba15f96b0a88a399b98e9c6e0cfb1aa769a10039fc
data/CHANGELOG.md ADDED
@@ -0,0 +1,48 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project are documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ## [1.0.0] - 2026-11-03
11
+
12
+ ### Added
13
+
14
+ - `Polkit`, defined from the `Polkit-1.0` GObject Introspection typelib at
15
+ require time, giving asking whether an unprivileged process may do a privileged thing. `Polkit::Loader` is a
16
+ `GObjectIntrospection::Loader` subclass, so the binding is the whole
17
+ namespace rather than a hand-written subset, and it does not drift as the
18
+ library gains API.
19
+ - A dev shell (`flake.nix`) that pins the library and glib from one nixpkgs and
20
+ puts their typelibs on `GI_TYPELIB_PATH`, and CI that runs the suite inside
21
+ it, because the environment is the hard part of an introspection binding.
22
+
23
+ ### Changed
24
+
25
+ - The binding no longer goes through Rust. Earlier revisions wrapped a
26
+ gir-generated crate with magnus, which meant an `ext/` directory, a Cargo
27
+ workspace, system libraries at build time and a nine-platform cross-compile
28
+ matrix, to expose the handful of functions someone had written by hand. The
29
+ typelib loader replaces all of it with about twenty lines of Ruby.
30
+ - The gem is pure Ruby and declares no extensions. Installing it still
31
+ compiles C, because `glib2` and `gobject-introspection` are native
32
+ extensions built against glib — but this gem adds no build step of its own,
33
+ and those two are what every ruby-gnome application already has via `gtk4`.
34
+ - `bin/release-gem` releases one gem. It was built for the Rust model, where a
35
+ release meant a source gem plus one precompiled gem per platform downloaded
36
+ from the Cross Compile workflow; that workflow is gone and there are no
37
+ platform gems, so left alone it aborted before doing anything.
38
+
39
+ ### Removed
40
+
41
+ - `ext/`, `Cargo.toml`, `Cargo.lock`, the cross-compile workflow, and the
42
+ `rb_sys` and `rake-compiler` dependencies.
43
+ - `bin/release-gem`. It existed because releasing a Rust gem meant publishing a
44
+ source gem plus one precompiled gem per platform, downloaded from the Cross
45
+ Compile workflow's artifacts. There is nothing to compile here, so there is
46
+ one gem and one push, which is exactly what `gem kit release` does. The
47
+ script added only a check that the local version was ahead of RubyGems, and
48
+ `gem push` already refuses a version that has been pushed.
data/LICENSE ADDED
@@ -0,0 +1,200 @@
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 the 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 the 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 any 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. Please also get an
186
+ individualized contributor license agreement from each contributor.
187
+
188
+ Copyright 2026 General Intelligence Systems
189
+
190
+ Licensed under the Apache License, Version 2.0 (the "License");
191
+ you may not use this file except in compliance with the License.
192
+ You may obtain a copy of the License at
193
+
194
+ http://www.apache.org/licenses/LICENSE-2.0
195
+
196
+ Unless required by applicable law or agreed to in writing, software
197
+ distributed under the License is distributed on an "AS IS" BASIS,
198
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
199
+ See the License for the specific language governing permissions and
200
+ limitations under the License.
data/NOTICE ADDED
@@ -0,0 +1,48 @@
1
+ Polkit for Ruby
2
+ Copyright 2026 General Intelligence Systems
3
+
4
+ --------------------------------------------------------------------------------
5
+ polkit (the Rust crate)
6
+ --------------------------------------------------------------------------------
7
+
8
+ The native extension under ext/polkit links the polkit crate, Val Packett's
9
+ gir-generated binding over libpolkit-gobject-1. This gem is bindings for it and
10
+ nothing else: every module it defines speaks to a type of that crate.
11
+
12
+ https://codeberg.org/valpackett/polkit-rs
13
+ Copyright Val Packett
14
+ Licensed under 0BSD OR Unlicense, at the recipient's option
15
+
16
+ Both are permissive and neither carries a NOTICE requirement, so there is
17
+ nothing to propagate under section 4(d) of the Apache License this work is
18
+ distributed under.
19
+
20
+ --------------------------------------------------------------------------------
21
+ polkit (the C library)
22
+ --------------------------------------------------------------------------------
23
+
24
+ The crate above links libpolkit-gobject-1, part of polkit, the freedesktop.org
25
+ authorization framework. It is found by pkg-config at build time and is not
26
+ vendored here.
27
+
28
+ https://github.com/polkit-org/polkit
29
+ Copyright Red Hat, Inc. and contributors
30
+ Licensed under the GNU Lesser General Public License, version 2.0 or later
31
+
32
+ LGPL-2.0-or-later is a weak copyleft: it governs libpolkit-gobject-1 itself and
33
+ reaches this work only as a dynamically linked library, which section 6 of that
34
+ licence permits. Nothing in this gem is derived from polkit's source. A
35
+ distributor shipping a precompiled gem that links it satisfies section 6 in the
36
+ ordinary way, by leaving the library replaceable rather than statically
37
+ absorbed.
38
+
39
+ --------------------------------------------------------------------------------
40
+ glib and gio (the Rust crates)
41
+ --------------------------------------------------------------------------------
42
+
43
+ The extension depends on the gtk-rs glib and gio crates directly, for GObject
44
+ downcasting and for GIO's Cancellable.
45
+
46
+ https://github.com/gtk-rs/gtk-rs-core
47
+ Copyright The gtk-rs Project Developers
48
+ Licensed under the MIT License
data/README.md ADDED
@@ -0,0 +1,155 @@
1
+ # polkit
2
+
3
+ Ruby bindings for polkit, asking whether an unprivileged process may do a privileged thing.
4
+
5
+ ```ruby
6
+ require "polkit"
7
+
8
+ # Who is asking, and about what.
9
+ user = Polkit::UnixUser.new_for_name("root")
10
+ subject = Polkit::Subject.from_string("unix-process:#{Process.pid}:1")
11
+
12
+ # And the question itself, which needs polkitd on the system bus.
13
+ authority = Polkit::Authority.get_sync
14
+ result = authority.check_authorization_sync(
15
+ subject, "org.freedesktop.policykit.exec", nil,
16
+ Polkit::CheckAuthorizationFlags::ALLOW_USER_INTERACTION, nil,
17
+ )
18
+ result.authorized?
19
+ ```
20
+
21
+ ## How this works, and what it costs to install
22
+
23
+ polkit ships a GObject Introspection typelib — `Polkit-1.0.typelib` — describing
24
+ every class, method, property and signal it has. `Polkit::Loader`, about twenty
25
+ lines, hands that to ruby-gnome's `GObjectIntrospection::Loader`, which defines
26
+ the Ruby classes from it at `require` time.
27
+
28
+ So this gem is pure Ruby: no extension of its own, no Cargo workspace, no
29
+ per-platform binary. You get the whole library rather than the subset somebody
30
+ got round to wrapping by hand, and it does not drift when the library gains API.
31
+
32
+ Be precise about install, though: `gem install polkit` still compiles C, because
33
+ `gobject-introspection` and `glib2` are themselves native extensions built
34
+ against glib, so a compiler and glib's development headers are needed. What
35
+ this gem adds on top is nothing — those two are what every ruby-gnome
36
+ application already has, since `gtk4` depends on them.
37
+
38
+ ## Two namespaces, one gem
39
+
40
+ polkit is two libraries with two typelibs, and this gem has a loader for each:
41
+
42
+ | require | namespace | what it is for |
43
+ |---|---|---|
44
+ | `require "polkit"` | `Polkit` | the asking side: `Authority`, `Subject`, `Identity`, `AuthorizationResult` |
45
+ | `require "polkit/agent"` | `PolkitAgent` | the answering side: subclass `Listener` to *be* the process that shows the authentication prompt |
46
+
47
+ Most callers only ever ask, so `polkit/agent` is a separate require. Both
48
+ typelibs come from the same distribution package, so if one loads the other
49
+ does. If you are writing the GNOME authentication dialog in Ruby GTK,
50
+ `PolkitAgent::TextListener` is the implementation polkit ships and the one to
51
+ read first.
52
+
53
+ ## The one thing you must install
54
+
55
+ The typelib is a C-library artefact, so it belongs to your distribution and
56
+ this gem cannot install it:
57
+
58
+ | | |
59
+ |---|---|
60
+ | Debian / Ubuntu | `gir1.2-polkit-1.0` |
61
+ | Fedora | `polkit-libs` |
62
+ | Arch | `polkit` |
63
+ | nix | `pkgs.polkit` |
64
+
65
+ If it is not in the default search path, point `GI_TYPELIB_PATH` at the
66
+ directory holding `Polkit-1.0.typelib`. The dev shell in `flake.nix` does this.
67
+
68
+ Under nix there is one more wrinkle: `pkgs.polkit` resolves to its `bin`
69
+ output, which has no typelibs — they are in `polkit.out`, exactly as glib's
70
+ are. `flake.nix` builds the search path with
71
+ `map (drv: drv.out or drv)` for that reason.
72
+
73
+ **One trap worth knowing.** The typelib must come from the same glib build as
74
+ the `gobject-introspection` gem. Mixing two registers GIO twice in one process
75
+ and fails with `cannot register existing type 'GTlsCertificate'`. Under nix,
76
+ take both from one nixpkgs — and note that glib's typelibs live in its `out`
77
+ output, not the default one.
78
+
79
+ ## Using it from a flake
80
+
81
+ The gem needs `Polkit-1.0.typelib` and everything that typelib declares, resolved
82
+ transitively by the loader at `require` time. A missing one surfaces as
83
+ `Typelib file for namespace 'X' not found`, one at a time, so the whole chain
84
+ is listed here rather than discovered by repeated failure:
85
+
86
+ - `pkgs.polkit` — its typelib, which is where `Polkit-1.0.typelib` lives
87
+ - `pkgs.glib` — GLib-2.0, GObject-2.0 and Gio-2.0, which nearly every GNOME typelib declares
88
+
89
+ Note the `.out`: a package's default output is often `bin`, which carries no
90
+ typelibs. `makeSearchPath` takes the first output, so it has to be asked for
91
+ `out` explicitly — this is the single most common way to get a search path that
92
+ looks right and finds nothing.
93
+
94
+ ```nix
95
+ {
96
+ inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
97
+
98
+ outputs = { nixpkgs, ... }:
99
+ let
100
+ system = "x86_64-linux";
101
+ pkgs = nixpkgs.legacyPackages.${system};
102
+
103
+ typelibPath = pkgs.lib.makeSearchPath "lib/girepository-1.0"
104
+ (map (drv: drv.out or drv) [ pkgs.polkit pkgs.glib ]);
105
+ in
106
+ {
107
+ devShells.${system}.default = pkgs.mkShell {
108
+ packages = [ pkgs.ruby_3_4 pkgs.bundler ] ++ [ pkgs.polkit pkgs.glib ];
109
+
110
+ shellHook = ''
111
+ export GI_TYPELIB_PATH="${typelibPath}''${GI_TYPELIB_PATH:+:$GI_TYPELIB_PATH}"
112
+ '';
113
+ };
114
+ };
115
+ }
116
+ ```
117
+
118
+ Everything must come from **one** nixpkgs. A typelib built against a different
119
+ glib than the `gobject-introspection` gem registers GIO twice in the process
120
+ and fails with `cannot register existing type 'GTlsCertificate'`.
121
+
122
+ If you are packaging an application rather than entering a shell, the same
123
+ `typelibPath` goes on the wrapper:
124
+
125
+ ```nix
126
+ makeWrapper ${ruby}/bin/ruby $out/bin/my-app \
127
+ --set GI_TYPELIB_PATH "${typelibPath}"
128
+ ```
129
+
130
+ ## Development
131
+
132
+ ```sh
133
+ nix develop
134
+ bin/test
135
+ ```
136
+
137
+ ## Releasing
138
+
139
+ ```sh
140
+ gem kit release
141
+ ```
142
+
143
+ That is the whole thing. It gates on the changelog having an entry for this
144
+ version, on no deprecation deadline coming due, and on a clean working tree;
145
+ then builds, pushes and tags.
146
+
147
+ There is nothing to wait for in CI. This gem is pure Ruby, so `gem build`
148
+ produces one `polkit-X.Y.Z.gem` that is the same artefact wherever it is built —
149
+ no extension, no per-platform gems, nothing for a workflow to hand back.
150
+
151
+
152
+ ## Licence
153
+
154
+ Apache-2.0. The library itself keeps its own licence; this gem links nothing
155
+ and copies no code from it — it reads a description of it at runtime.
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Released under the Apache License, Version 2.0.
4
+ # Copyright, 2026, by General Intelligence Systems.
5
+
6
+ module PolkitAgent
7
+ # Defines everything in the PolkitAgent namespace from `PolkitAgent-1.0.typelib`.
8
+ #
9
+ # The same polkit package ships two typelibs: `Polkit-1.0` is the asking side
10
+ # (may this subject do this action?), and `PolkitAgent-1.0` is the answering
11
+ # side -- the API you implement to *be* the authentication agent that puts the
12
+ # password prompt on screen. They are separate GI namespaces, so they need
13
+ # separate loaders, but one library means one gem.
14
+ #
15
+ # Like Polkit, and unlike GtkSource, there is no init function to call: the
16
+ # typelib declares none, so there is no pre_load hook here.
17
+ class Loader < GObjectIntrospection::Loader
18
+ def load
19
+ self.version = "1.0"
20
+ super("PolkitAgent")
21
+ end
22
+
23
+ private
24
+
25
+ def post_load(repository, namespace)
26
+ require_libraries
27
+ end
28
+
29
+ def require_libraries
30
+ # Nothing yet. Hand-written Ruby that improves on the typelib goes in
31
+ # files required from here, which is the convention ruby-gnome uses.
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Released under the Apache License, Version 2.0.
4
+ # Copyright, 2026, by General Intelligence Systems.
5
+
6
+ require_relative "../polkit"
7
+ require_relative "agent/loader"
8
+
9
+ # The authentication-agent half of polkit.
10
+ #
11
+ # `require "polkit"` gives you the asking side: {Polkit::Authority} and the
12
+ # subjects and identities you ask it about. This gives you the answering side --
13
+ # {PolkitAgent::Listener}, which you subclass to become the process that shows
14
+ # the authentication prompt, and {PolkitAgent::Session}, which drives one
15
+ # attempt. `PolkitAgent::TextListener` is the terminal implementation polkit
16
+ # ships, and is the one to read first.
17
+ #
18
+ # It is a separate require because it is a separate GI namespace with its own
19
+ # typelib, and most callers only ever want to ask. Both typelibs come from the
20
+ # same polkit package, so if `require "polkit"` works this does too.
21
+ module PolkitAgent
22
+ loader = Loader.new(self)
23
+ loader.load
24
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Released under the Apache License, Version 2.0.
4
+ # Copyright, 2026, by General Intelligence Systems.
5
+
6
+ module Polkit
7
+ # Defines everything in the Polkit namespace from `Polkit-1.0.typelib`.
8
+ #
9
+ # Modelled on ruby-gnome's own loaders -- see
10
+ # gtksourceview5/lib/gtksourceview5/loader.rb for one that has to call the
11
+ # library's init function first, and libsecret/lib/libsecret/loader.rb for
12
+ # one that does not.
13
+ #
14
+ # The version string is the typelib's rather than the library's release
15
+ # number, and the two often differ: this one is "1.0", from
16
+ # `Polkit-1.0.typelib`.
17
+ class Loader < GObjectIntrospection::Loader
18
+ def load
19
+ self.version = "1.0"
20
+ super("Polkit")
21
+ end
22
+
23
+ private
24
+
25
+ def post_load(repository, namespace)
26
+ require_libraries
27
+ end
28
+
29
+ def require_libraries
30
+ # Nothing yet. Hand-written Ruby that improves on what the typelib gives
31
+ # -- an each that yields, a to_s, a keyword-argument constructor -- goes
32
+ # in files required from here, which is the convention ruby-gnome uses
33
+ # for exactly that purpose.
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Released under the Apache License, Version 2.0.
4
+ # Copyright, 2026, by General Intelligence Systems.
5
+
6
+ module Polkit
7
+ VERSION = "1.0.0"
8
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Released under the Apache License, Version 2.0.
4
+ # Copyright, 2026, by General Intelligence Systems.
5
+
6
+ module Polkit
7
+ VERSION = "<%= version %>"
8
+ end
data/lib/polkit.rb ADDED
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Released under the Apache License, Version 2.0.
4
+ # Copyright, 2026, by General Intelligence Systems.
5
+
6
+ require "gobject-introspection"
7
+
8
+ require_relative "polkit/version"
9
+ require_relative "polkit/loader"
10
+
11
+ # Ruby bindings for polkit, asking whether an unprivileged process may do a privileged thing.
12
+ #
13
+ # Nothing here wraps a C function by hand. The library ships a GObject
14
+ # Introspection typelib describing every class, method, property and signal it
15
+ # has, and ruby-gnome's GObjectIntrospection::Loader reads that at require time
16
+ # and defines the Ruby classes from it. {Polkit::Loader} is about twenty lines;
17
+ # what you get is the whole library, and it does not drift when the library
18
+ # gains API.
19
+ #
20
+ # This is how ruby-gnome itself ships gtksourceview5, libsecret and the rest.
21
+ #
22
+ # This is the asking side of polkit: an {Polkit::Authority} you put questions
23
+ # to, and the subjects and identities you ask about. The same polkit package
24
+ # also ships `PolkitAgent-1.0.typelib`, the answering side -- the API you
25
+ # implement to be the agent that shows the password prompt. That is a separate
26
+ # GI namespace, so it is a separate require: `require "polkit/agent"`.
27
+ #
28
+ # The typelib has to be findable at require time, which means the library's
29
+ # `girepository-1.0` directory on `GI_TYPELIB_PATH` or in the system default.
30
+ # This gem cannot install it -- it is a C library artefact and belongs to the
31
+ # distribution. See the README for the package name; `flake.nix` wires up a dev
32
+ # shell that has it.
33
+ #
34
+ # One trap, paid for already: the typelib must come from the same glib build as
35
+ # the `gobject-introspection` gem. Mix two and GIO is registered twice in one
36
+ # process, which fails as `cannot register existing type 'GTlsCertificate'`.
37
+ module Polkit
38
+ LOG_DOMAIN = "Polkit"
39
+ GLib::Log.set_log_domain(LOG_DOMAIN)
40
+
41
+ class Error < StandardError
42
+ end
43
+
44
+ loader = Loader.new(self)
45
+ loader.load
46
+ end
metadata ADDED
@@ -0,0 +1,98 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: polkit
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Nathan Kidd
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-01 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: gem_kit
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - "~>"
17
+ - !ruby/object:Gem::Version
18
+ version: '0.2'
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - "~>"
24
+ - !ruby/object:Gem::Version
25
+ version: '0.2'
26
+ - !ruby/object:Gem::Dependency
27
+ name: gobject-introspection
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - "~>"
31
+ - !ruby/object:Gem::Version
32
+ version: '4.3'
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '4.3'
40
+ - !ruby/object:Gem::Dependency
41
+ name: lefthook
42
+ requirement: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: '2.2'
47
+ type: :development
48
+ prerelease: false
49
+ version_requirements: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - "~>"
52
+ - !ruby/object:Gem::Version
53
+ version: '2.2'
54
+ description: Polkit, asking whether an unprivileged process may do a privileged thing,
55
+ for Ruby. Defined from its GObject Introspection typelib at require time rather
56
+ than wrapped by hand, so the binding is the whole library and does not drift as
57
+ it gains API.
58
+ email:
59
+ - nathankidd@hey.com
60
+ executables: []
61
+ extensions: []
62
+ extra_rdoc_files: []
63
+ files:
64
+ - CHANGELOG.md
65
+ - LICENSE
66
+ - NOTICE
67
+ - README.md
68
+ - lib/polkit.rb
69
+ - lib/polkit/agent.rb
70
+ - lib/polkit/agent/loader.rb
71
+ - lib/polkit/loader.rb
72
+ - lib/polkit/version.rb
73
+ - lib/polkit/version.rb.erb
74
+ homepage: https://github.com/n-at-han-k/polkit-rb
75
+ licenses:
76
+ - Apache-2.0
77
+ metadata:
78
+ source_code_uri: https://github.com/n-at-han-k/polkit-rb
79
+ documentation_uri: https://n-at-han-k.github.io/polkit-rb/
80
+ rdoc_options: []
81
+ require_paths:
82
+ - lib
83
+ required_ruby_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '3.3'
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - ">="
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ requirements: []
94
+ rubygems_version: 3.7.2
95
+ specification_version: 4
96
+ summary: Ruby bindings for polkit, asking whether an unprivileged process may do a
97
+ privileged thing.
98
+ test_files: []