kiosk-kyc-prove 0.5.20

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c88c7b32838b0f0f52116ed8970c4421e5fbd8cbf09047c858590d020c1a669a
+  data.tar.gz: a994ce36f35115acfc23b2cb21faed79a2d8f308dc21c61a80905f97460fe439
+SHA512:
+  metadata.gz: 0c0c5579e18f68d1d0a7ca3f11c5d5252596cc009a4b98993ffb212ff2a573ddbcfdef1eb6215afa1889e15613c93105b0b38749e66b7db2d9ba8924dac27c59
+  data.tar.gz: 559b7600ea23b3c99b5a916a86e8c4a781042791949209f251519dc3ff6499c13bc77f1eeb6af17ee77e425fe0465e48fc64ae28011a7056cf2743376cdfd310

data/CHANGELOG.md

@@ -0,0 +1,82 @@
+# Changelog
+
+How to write an entry, and what a release section means: `CHANGELOG-RULE.md` at
+the root of this repository —
+<https://github.com/kiosk-hq/kiosk/blob/main/CHANGELOG-RULE.md>. In short: under
+200 characters, one or two sentences, the essence rather than the content; write it
+under `## [Unreleased]`; a cut renames that heading to
+`## [MAJOR.MINOR.PATCH] — <date>` and opens a fresh empty one above it; nothing
+already written is edited.
+
+## [Unreleased]
+
+## [0.5.20] — 2026-10-20
+
+- 2026-10-20: Version 0.5.20, the tree cut that matches skill 0.5.20.
+
+## [0.5.19] — 2026-10-20
+
+- 2026-10-19: The adapter asks the broker for the attribute names in `kyc_claims` as they are. The broker names a licence by its category, such as `licence_a1` or `licence_a`.
+- 2026-10-19: The broker client connects to an intake URL that names an IPv6 literal, such as `http://[::1]:3004/`.
+
+## [0.5.18] — 2026-10-18
+
+- 2026-10-18: Version 0.5.18, the tree cut that matches skill 0.5.18.
+
+## [0.5.17] — 2026-10-18
+
+- 2026-10-18: A broker answer that is not HTTP raises `Unavailable`, so `request_kyc` answers `action_failed`, not 500.
+
+## [0.5.16] — 2026-10-18
+
+- 2026-10-18: Version 0.5.16, the tree cut that matches skill 0.5.16.
+
+## [0.5.15] — 2026-10-18
+
+- 2026-10-18: Version 0.5.15, the tree cut that matches skill 0.5.15.
+
+## [0.5.14] — 2026-10-18
+
+- 2026-10-18: Version 0.5.14, the tree cut that matches skill 0.5.14; this gem's surface is unchanged.
+
+## [0.5.13] — 2026-10-11
+
+- 2026-10-11: Version 0.5.13, the tree cut that matches skill 0.5.13.
+
+- 2026-10-09: **`Prove.issuer` and `Prove.broker_url` are removed**: the gem reads no ENV; pass `url:` and set `c.kyc_issuer` yourself.
+
+## [0.5.12] — 2026-10-08
+
+- 2026-10-08: Version 0.5.12, the tree cut that matches skill 0.5.12; this gem's surface is unchanged.
+
+## [0.5.11] — 2026-10-08
+
+- 2026-10-08: Version 0.5.11, the tree cut that matches skill 0.5.11; this gem's surface is unchanged.
+
+## [0.5.10] — 2026-10-08
+
+- 2026-10-08: Version 0.5.10, the tree cut that matches skill 0.5.10; this gem's surface is unchanged.
+
+## [0.5.9] — 2026-10-08
+
+- 2026-10-08: Version 0.5.9, the tree cut that matches skill 0.5.9; this gem's surface is unchanged.
+
+## [0.5.8] — 2026-10-07
+
+- 2026-10-07: Version 0.5.8, the tree cut that matches skill 0.5.8; this gem's surface is unchanged.
+
+## [0.5.7] — 2026-10-07
+
+- 2026-10-07: Version 0.5.7, the tree cut that matches skill 0.5.7; this gem's surface is unchanged.
+
+## [0.5.6] — 2026-10-07
+
+- 2026-10-07: Version 0.5.6, the tree cut that matches skill 0.5.6; this gem's surface is unchanged.
+
+## [0.5.5] — 2026-10-07
+
+- 2026-10-07: Version 0.5.5, the tree cut that matches skill 0.5.5; this gem's surface is unchanged.
+
+## [0.5.4] — 2026-10-07
+
+- 2026-10-07: **New gem: the Prove KYC broker behind `Kiosk::KycProviders::Base`**, moved out of the getgrocery and skooti demos (T-220).

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,44 @@
+# kiosk-kyc-prove
+
+Prove KYC broker adapter for [Kiosk](https://kiosk.tech). Implements
+`Kiosk::KycProviders::Base` against the Prove anonymizing broker.
+
+## Install
+
+> **Not on RubyGems yet** — so the `gem` line carries `github: "kiosk-hq/kiosk"`. Publication status and the canonical install are stated once, in the monorepo README's [Install](https://github.com/kiosk-hq/kiosk#install) section.
+
+```ruby
+gem "kiosk-kyc-prove", github: "kiosk-hq/kiosk"
+```
+
+## Configure
+
+Register with the broker first: it holds your operator id, your intake secret,
+the host your callback lives on and the audience it mints attestations for.
+
+```ruby
+require "kiosk/kyc_providers/prove"
+
+Kiosk.configure do |c|
+  c.kyc_provider   = Kiosk::KycProviders::Prove.new(operator_id: "acme", intake_secret: ENV.fetch("PROVE_SECRET"))
+  c.kyc_claims     = %w[age_over_18]
+  c.kyc_issuer     = Kiosk::KycProviders::Prove::HOSTED
+  c.kyc_public_key = ENV["PROVE_PUBLIC_KEY_PEM"]
+  c.kyc_audience   = "acme"
+end
+```
+
+kiosk-server then serves `request_kyc` and the broker's callback. The adapter:
+
+- opens a verification at `POST <broker>/verifications`, authenticated by the
+  intake secret, asking for the attribute names in `kyc_claims`;
+- raises `Kiosk::KycProviders::Unavailable` when the broker refuses, cannot be
+  reached, or answers without `request_id`, `verification_url` and `nonce`;
+- accepts only attestations whose `operator` claim is your operator id.
+
+`Prove.new` talks to the hosted broker at `Prove::HOSTED`
+(`https://kyc.demo.kiosk.tech`); pass `url:` for another one.
+
+## License
+
+Apache-2.0. See `LICENSE.txt`.

data/lib/kiosk/kyc_providers/prove/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Kiosk
+  module KycProviders
+    module ProveVersion
+      VERSION = '0.5.20'
+    end
+  end
+end

data/lib/kiosk/kyc_providers/prove.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'openssl'
+require 'uri'
+require 'kiosk'
+require 'kiosk/kyc_providers/prove/version'
+
+module Kiosk
+  module KycProviders
+    # The Prove anonymizing KYC broker. The operator registers with the broker
+    # once (an operator id, an intake secret and its callback host); the broker
+    # then signs only the booleans the human confirmed, with `operator` set to
+    # the operator the verification was opened for.
+    class Prove < Base
+      HOSTED = 'https://kyc.demo.kiosk.tech'
+
+      attr_reader :operator_id
+
+      def initialize(operator_id:, intake_secret:, url: HOSTED)
+        raise ArgumentError, "the broker's intake secret for #{operator_id} is required" if intake_secret.to_s.empty?
+
+        super()
+        @operator_id = operator_id.to_s
+        @secret      = intake_secret.to_s
+        @intake      = URI.join("#{url.to_s.chomp('/')}/", 'verifications')
+      end
+
+      def open_verification(subject:, claims:, audience:, callback_url:)
+        intake = post(operator_id: operator_id, callback_url: callback_url, requested_claims: claims,
+                      subject_handle: subject, audience: audience)
+        fields = intake.values_at('request_id', 'verification_url', 'nonce').map(&:to_s)
+        raise Unavailable, 'the KYC broker answered without request_id, verification_url and nonce' if fields.any?(&:empty?)
+
+        %i[request_id verification_url nonce].zip(fields).to_h
+      end
+
+      def accepts?(payload) = payload['operator'].to_s == operator_id
+
+      private
+
+      def post(body)
+        response = http_client.request(intake_request(body))
+        raise Unavailable, "the KYC broker answered #{response.code}" unless response.code.to_i == 201
+
+        parse(response.body)
+      rescue Timeout::Error, SocketError, SystemCallError, IOError, OpenSSL::SSL::SSLError, Net::HTTPBadResponse => e
+        raise Unavailable, "the KYC broker could not be reached (#{e.class})"
+      end
+
+      def intake_request(body)
+        request = Net::HTTP::Post.new(@intake, 'Content-Type' => 'application/json',
+                                               'Authorization' => "Bearer #{@secret}")
+        request.body = JSON.generate(body)
+        request
+      end
+
+      def http_client
+        http = Net::HTTP.new(@intake.hostname, @intake.port)
+        http.use_ssl = @intake.scheme == 'https'
+        http.open_timeout = http.read_timeout = 5
+        http
+      end
+
+      def parse(body)
+        parsed = JSON.parse(body)
+        raise Unavailable, 'the KYC broker answered a body that is not an object' unless parsed.is_a?(Hash)
+
+        parsed
+      rescue JSON::ParserError
+        raise Unavailable, 'the KYC broker answered a body that is not JSON'
+      end
+    end
+  end
+end

data/lib/kiosk-kyc-prove.rb

@@ -0,0 +1,5 @@
+# rubocop:disable Naming/FileName -- Bundler.require loads the file named after the gem.
+# frozen_string_literal: true
+
+require 'kiosk/kyc_providers/prove'
+# rubocop:enable Naming/FileName

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: kiosk-kyc-prove
+version: !ruby/object:Gem::Version
+  version: 0.5.20
+platform: ruby
+authors:
+- Phil Pirozhkov
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kiosk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: |
+  kiosk-kyc-prove implements Kiosk::KycProviders::Base against the Prove
+  anonymizing KYC broker: it opens a verification at the broker's intake,
+  and accepts only attestations the broker minted for this operator.
+  Assign an instance to Kiosk.configuration.kyc_provider and kiosk-server
+  serves request_kyc and the broker's callback.
+email:
+- hello@fili.pp.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/kiosk-kyc-prove.rb
+- lib/kiosk/kyc_providers/prove.rb
+- lib/kiosk/kyc_providers/prove/version.rb
+homepage: https://kiosk.tech
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://kiosk.tech
+  source_code_uri: https://github.com/kiosk-hq/kiosk
+  changelog_uri: https://github.com/kiosk-hq/kiosk/blob/main/kiosk-kyc-prove/CHANGELOG.md
+  bug_tracker_uri: https://github.com/kiosk-hq/kiosk/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '4.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Prove KYC broker adapter for the Kiosk framework
+test_files: []