kiosk-pow 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 +7 -0
- data/CHANGELOG.md +110 -0
- data/LICENSE.txt +202 -0
- data/README.md +155 -0
- data/lib/kiosk/pow/blake2b.rb +100 -0
- data/lib/kiosk/pow/version.rb +7 -0
- data/lib/kiosk/pow.rb +15 -0
- metadata +59 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: d3cabd3fa9d6d117316774074bcd9fed4291c71069927111d92379a8cc0b7c77
|
|
4
|
+
data.tar.gz: 1d00f4aec418deb4541d2c826ae1f5013cfe1b64394d83fa3294bdb23c98fd26
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 8846210d90d2bab1ca8903a05f08f1f0a53a235f1a89b4919a645359efa38de7327e2ab5d2dbf2a1cbd449803fcdf3bb973caeb8a4979779ab0e4ad0f8309065
|
|
7
|
+
data.tar.gz: f0480b4230400a37a1092e48dfa6ec3688dae5e80f0386fa05b5d21e6d3490eba50312d5d97f8b7dd37f09ed8b7adaf6290793d4d7a4d110be9ba06278ebb1d3
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
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: kiosk-pow is the base of the PoW backends: `Kiosk::Pow::Blake2b`, `Kiosk::Pow.param` and a guide to add a backend. The Argon2id backend moves to kiosk-pow-argon2id.
|
|
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; this gem's surface is unchanged.
|
|
42
|
+
|
|
43
|
+
## [0.5.13] — 2026-10-11
|
|
44
|
+
|
|
45
|
+
- 2026-10-11: Version 0.5.13, the tree cut that matches skill 0.5.13; this gem's surface is unchanged.
|
|
46
|
+
|
|
47
|
+
## [0.5.12] — 2026-10-08
|
|
48
|
+
|
|
49
|
+
- 2026-10-08: Version 0.5.12, the tree cut that matches skill 0.5.12; this gem's surface is unchanged.
|
|
50
|
+
|
|
51
|
+
## [0.5.11] — 2026-10-08
|
|
52
|
+
|
|
53
|
+
- 2026-10-08: Version 0.5.11, the tree cut that matches skill 0.5.11; this gem's surface is unchanged.
|
|
54
|
+
|
|
55
|
+
## [0.5.10] — 2026-10-08
|
|
56
|
+
|
|
57
|
+
- 2026-10-08: Version 0.5.10, the tree cut that matches skill 0.5.10; this gem's surface is unchanged.
|
|
58
|
+
|
|
59
|
+
## [0.5.9] — 2026-10-08
|
|
60
|
+
|
|
61
|
+
- 2026-10-08: Version 0.5.9, the tree cut that matches skill 0.5.9; this gem's surface is unchanged.
|
|
62
|
+
|
|
63
|
+
## [0.5.8] — 2026-10-07
|
|
64
|
+
|
|
65
|
+
- 2026-10-07: Version 0.5.8, the tree cut that matches skill 0.5.8; this gem's surface is unchanged.
|
|
66
|
+
|
|
67
|
+
## [0.5.7] — 2026-10-07
|
|
68
|
+
|
|
69
|
+
- 2026-10-07: Version 0.5.7, the tree cut that matches skill 0.5.7; this gem's surface is unchanged.
|
|
70
|
+
|
|
71
|
+
## [0.5.6] — 2026-10-07
|
|
72
|
+
|
|
73
|
+
- 2026-10-07: Version 0.5.6, the tree cut that matches skill 0.5.6; this gem's surface is unchanged.
|
|
74
|
+
|
|
75
|
+
## [0.5.5] — 2026-10-07
|
|
76
|
+
|
|
77
|
+
- 2026-10-07: Version 0.5.5, the tree cut that matches skill 0.5.5; this gem's surface is unchanged.
|
|
78
|
+
|
|
79
|
+
## [0.5.4] — 2026-10-07
|
|
80
|
+
|
|
81
|
+
- 2026-10-07: Version 0.5.4, the tree cut that matches skill 0.5.4; this gem's surface is unchanged.
|
|
82
|
+
|
|
83
|
+
## [0.5.3] — 2026-10-06
|
|
84
|
+
|
|
85
|
+
- 2026-10-06: Version 0.5.3, the tree cut that matches skill 0.5.3; this gem's surface is unchanged.
|
|
86
|
+
|
|
87
|
+
## [0.5.2] — 2026-10-06
|
|
88
|
+
|
|
89
|
+
- 2026-10-06: Version 0.5.2, the tree cut that matches skill 0.5.2; this gem's surface is unchanged.
|
|
90
|
+
|
|
91
|
+
## [0.5.0] — 2026-09-26
|
|
92
|
+
|
|
93
|
+
### Changed
|
|
94
|
+
|
|
95
|
+
- CI now installs argon2-cffi, so the `:parity` examples run instead of pending; the gemspec says so rather than implying nothing checks the two implementations.
|
|
96
|
+
- The gemspec stops saying the `rake parity` check is «included» and «enforced»: the Rakefile is not packaged and nothing runs the task.
|
|
97
|
+
- The gemspec stops claiming kiosk-reputation uses this backend; a host must register it, and nothing here does outside kiosk-server's specs.
|
|
98
|
+
- 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.
|
|
99
|
+
|
|
100
|
+
### Added
|
|
101
|
+
|
|
102
|
+
- `Kiosk::Pow::NAME = "argon2id"` — algorithm name for challenge wire format.
|
|
103
|
+
- `Kiosk::Pow.params(d:, m: 65_536, t: 1, p: 1)` — build challenge params for a difficulty tier.
|
|
104
|
+
- `Kiosk::Pow.digest(salt:, params:, nonce:)` — one raw Argon2id eval (32 bytes). Calls `Argon2::Ext.argon2id_hash_raw` directly (bypasses the high-level `m_cost` exponent API) for exact KiB control and version-0x13 determinism.
|
|
105
|
+
- `Kiosk::Pow.verify(salt:, params:, nonce:)` — one eval + leading-zero-bits check; exactly one Argon2id evaluation, no loop.
|
|
106
|
+
- `Kiosk::Pow.leading_zero_bits(bytes)` — counts leading zero bits spanning bytes; a nonce is valid iff this count over its digest is >= `params[:d]`.
|
|
107
|
+
- `solve.py` — Python client solver (argon2-cffi); reads challenge JSON from arg/stdin, loops nonces, prints `{"nonce": "<n>"}`. Runnable in an assistant sandbox.
|
|
108
|
+
- `requirements.txt` — `argon2-cffi` (the only Python dependency).
|
|
109
|
+
- `Rakefile` `parity` task — cross-implementation parity proof: Ruby digest == Python digest (hex-equal) for fixed inputs; end-to-end: `solve.py` nonce accepted by Ruby `verify`.
|
|
110
|
+
- RSpec suite: `leading_zero_bits` on known byte patterns; `params` shape; `verify` true/false for found/wrong nonce; known-answer determinism vector; `parity`-tagged specs that shell out to Python.
|
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,155 @@
|
|
|
1
|
+
# kiosk-pow
|
|
2
|
+
|
|
3
|
+
The base of the proof-of-work backends of the [Kiosk](https://kiosk.tech) framework.
|
|
4
|
+
|
|
5
|
+
A backend verifies one proof of work for one algorithm. kiosk-pow holds the code
|
|
6
|
+
that the backends share:
|
|
7
|
+
|
|
8
|
+
- `Kiosk::Pow::Blake2b.digest256(input)` returns the BLAKE2b-256 digest of
|
|
9
|
+
`input` (RFC 7693, no key, 32 raw bytes). It is pure Ruby. Its spec compares it
|
|
10
|
+
with Python's `hashlib.blake2b(data, digest_size=32)`, on inputs at both sides
|
|
11
|
+
of the 128-byte block.
|
|
12
|
+
- `Kiosk::Pow.param(hash, key)` reads one key of a wire object. Parsed JSON has
|
|
13
|
+
String keys and Ruby callers use Symbols; it reads both.
|
|
14
|
+
|
|
15
|
+
kiosk-pow is pure Ruby. It has no runtime dependencies, and it does not need
|
|
16
|
+
`kiosk-core` or Rails.
|
|
17
|
+
|
|
18
|
+
## The backends
|
|
19
|
+
|
|
20
|
+
| Gem | `alg` | Status |
|
|
21
|
+
|-----|-------|--------|
|
|
22
|
+
| `kiosk-pow-equihash` | `equihash` | The shipped default. Registers itself in a Rails app. |
|
|
23
|
+
| `kiosk-pow-cuckoo` | `cuckatoo` | Opt-in. The host registers it. |
|
|
24
|
+
| `kiosk-pow-argon2id` | `argon2id` | Legacy. The host registers it. |
|
|
25
|
+
|
|
26
|
+
`kiosk-reputation` holds the registry. It mints and signs each challenge, and it
|
|
27
|
+
checks the signature and the expiry before it calls a backend.
|
|
28
|
+
|
|
29
|
+
## How to add a backend
|
|
30
|
+
|
|
31
|
+
A backend is a Ruby module. It verifies one proof against one challenge.
|
|
32
|
+
`kiosk-reputation` does all the other work.
|
|
33
|
+
|
|
34
|
+
### 1. Make the gem
|
|
35
|
+
|
|
36
|
+
Name the gem `kiosk-pow-<algorithm>`. Make it depend on `kiosk-pow`:
|
|
37
|
+
|
|
38
|
+
```ruby
|
|
39
|
+
spec.add_dependency 'kiosk-pow', '~> 0.5.0'
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### 2. Define the module
|
|
43
|
+
|
|
44
|
+
Require `kiosk/pow`. Define the module under `Kiosk::Pow`:
|
|
45
|
+
|
|
46
|
+
```ruby
|
|
47
|
+
require 'kiosk/pow'
|
|
48
|
+
|
|
49
|
+
module Kiosk
|
|
50
|
+
module Pow
|
|
51
|
+
module Example
|
|
52
|
+
NAME = 'example'
|
|
53
|
+
|
|
54
|
+
def self.params(bits: 20) = { bits: }
|
|
55
|
+
|
|
56
|
+
def self.verify(salt:, params:, nonce:)
|
|
57
|
+
bits = Integer(Pow.param(params, :bits))
|
|
58
|
+
value = Pow.param(nonce, :value)
|
|
59
|
+
return false unless value.is_a?(Integer) && value.between?(0, (1 << 64) - 1)
|
|
60
|
+
|
|
61
|
+
digest = Blake2b.digest256(salt + [value].pack('Q<'))
|
|
62
|
+
digest.unpack1('B*').start_with?('0' * bits)
|
|
63
|
+
rescue ArgumentError, TypeError
|
|
64
|
+
false
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### 3. Give the module these members
|
|
72
|
+
|
|
73
|
+
| Member | Required | What it does |
|
|
74
|
+
|--------|----------|--------------|
|
|
75
|
+
| `NAME` | Yes | The `alg` string of the wire challenge. |
|
|
76
|
+
| `.params(**)` | Yes | Returns the `params` Hash of a challenge. The host calls it when it writes its policy. |
|
|
77
|
+
| `.verify(salt:, params:, nonce:)` | Yes | Returns `true` when `nonce` is a valid proof for `salt` and `params`. Returns `false` for all other input. |
|
|
78
|
+
| `.valid_params?(params)` | No | Returns `false` when no proof can verify at `params`. `kiosk-server`'s PoW toll calls it through `Kiosk::Reputation::Backends.valid_params?` before it mints a challenge. A wrong configuration then fails at once. |
|
|
79
|
+
|
|
80
|
+
### 4. Read the inputs of `.verify` correctly
|
|
81
|
+
|
|
82
|
+
- `salt` is raw bytes. `kiosk-reputation` decodes the base64 of the wire.
|
|
83
|
+
- `params` is the signed `params` of the challenge, with Symbol keys.
|
|
84
|
+
- `nonce` is the `nonce` of the proof, as the `Kiosk-PoW` header carries it. It
|
|
85
|
+
is parsed JSON, so its keys are Strings. Read it with `Kiosk::Pow.param`.
|
|
86
|
+
- Each key and each value of `params` must not contain `|`, `,` or `=`. These
|
|
87
|
+
characters separate the fields of the signed string, and `kiosk-reputation`
|
|
88
|
+
refuses such a challenge.
|
|
89
|
+
|
|
90
|
+
### 5. Make a wrong proof cheap to refuse
|
|
91
|
+
|
|
92
|
+
`.verify` runs before authentication on `POST /kiosk/auth/register`. Anyone can
|
|
93
|
+
send it a proof. So:
|
|
94
|
+
|
|
95
|
+
- Check the shape and the bounds of the proof first. Compute hashes last.
|
|
96
|
+
- Return `false` at the first check that fails.
|
|
97
|
+
- Do not raise an exception for any input. Return `false`.
|
|
98
|
+
- Keep the memory and the time of one verify small.
|
|
99
|
+
|
|
100
|
+
### 6. Hash with the shared BLAKE2b
|
|
101
|
+
|
|
102
|
+
When the algorithm uses BLAKE2b-256, call `Kiosk::Pow::Blake2b.digest256`. Do not
|
|
103
|
+
add a second BLAKE2b implementation.
|
|
104
|
+
|
|
105
|
+
### 7. Register the backend
|
|
106
|
+
|
|
107
|
+
Register the module under its `NAME`:
|
|
108
|
+
|
|
109
|
+
```ruby
|
|
110
|
+
Kiosk::Reputation::Backends.register(Kiosk::Pow::Example::NAME, Kiosk::Pow::Example)
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
A Rails app can do this at boot. `kiosk-pow-equihash` does it with a Railtie:
|
|
114
|
+
|
|
115
|
+
```ruby
|
|
116
|
+
class Railtie < Rails::Railtie
|
|
117
|
+
initializer 'kiosk_pow_example.register_backend' do
|
|
118
|
+
require 'kiosk/reputation/backends'
|
|
119
|
+
Kiosk::Reputation::Backends.register(NAME, Example)
|
|
120
|
+
end
|
|
121
|
+
end
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
The policy then names the algorithm in each challenge:
|
|
125
|
+
`{ alg: 'example', params: Kiosk::Pow::Example.params }`.
|
|
126
|
+
|
|
127
|
+
### 8. Tell the assistants how to solve it
|
|
128
|
+
|
|
129
|
+
The specification lets an operator serve an `alg` that it does not define. The
|
|
130
|
+
backend brings its own `nonce` encoding. The Kiosk skill teaches assistants to
|
|
131
|
+
solve Equihash only. If you serve another `alg`, give the assistants a solver and
|
|
132
|
+
tell them the `nonce` encoding yourself.
|
|
133
|
+
|
|
134
|
+
### 9. Test the backend
|
|
135
|
+
|
|
136
|
+
- Write known-answer tests at the parameters that you ship. A test at small
|
|
137
|
+
parameters only does not prove the shipped parameters.
|
|
138
|
+
- Take one known answer from an independent implementation.
|
|
139
|
+
- When you ship a solver, run it in a test and verify its proof in Ruby.
|
|
140
|
+
- Test that each malformed proof returns `false` and does not raise.
|
|
141
|
+
|
|
142
|
+
## Installation
|
|
143
|
+
|
|
144
|
+
> **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.
|
|
145
|
+
|
|
146
|
+
A backend gem brings `kiosk-pow` with it. Add it yourself only when you write a
|
|
147
|
+
backend in your own app:
|
|
148
|
+
|
|
149
|
+
```ruby
|
|
150
|
+
gem "kiosk-pow", github: "kiosk-hq/kiosk"
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
## License
|
|
154
|
+
|
|
155
|
+
Apache-2.0. See [LICENSE.txt](LICENSE.txt).
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Kiosk
|
|
4
|
+
module Pow
|
|
5
|
+
# BLAKE2b-256 (RFC 7693): unkeyed, 32-byte digest. Pure Ruby, so the gem
|
|
6
|
+
# has no dependencies. Every backend that hashes with BLAKE2b calls this one.
|
|
7
|
+
module Blake2b
|
|
8
|
+
MASK64 = (1 << 64) - 1
|
|
9
|
+
BLOCK_BYTES = 128
|
|
10
|
+
|
|
11
|
+
# Parameter block word 0: outlen=32, keylen=0, fanout=1, depth=1.
|
|
12
|
+
PARAM_BLOCK = 0x0000_0000_0101_0020
|
|
13
|
+
|
|
14
|
+
IV = [
|
|
15
|
+
0x6a09e667f3bcc908, 0xbb67ae8584caa73b,
|
|
16
|
+
0x3c6ef372fe94f82b, 0xa54ff53a5f1d36f1,
|
|
17
|
+
0x510e527fade682d1, 0x9b05688c2b3e6c1f,
|
|
18
|
+
0x1f83d9abfb41bd6b, 0x5be0cd19137e2179
|
|
19
|
+
].freeze
|
|
20
|
+
|
|
21
|
+
SIGMA = [
|
|
22
|
+
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15],
|
|
23
|
+
[14, 10, 4, 8, 9, 15, 13, 6, 1, 12, 0, 2, 11, 7, 5, 3],
|
|
24
|
+
[11, 8, 12, 0, 5, 2, 15, 13, 10, 14, 3, 6, 7, 1, 9, 4],
|
|
25
|
+
[7, 9, 3, 1, 13, 12, 11, 14, 2, 6, 5, 10, 4, 0, 15, 8],
|
|
26
|
+
[9, 0, 5, 7, 2, 4, 10, 15, 14, 1, 11, 12, 6, 8, 3, 13],
|
|
27
|
+
[2, 12, 6, 10, 0, 11, 8, 3, 4, 13, 7, 5, 15, 14, 1, 9],
|
|
28
|
+
[12, 5, 1, 15, 14, 13, 4, 10, 0, 7, 6, 3, 9, 2, 8, 11],
|
|
29
|
+
[13, 11, 7, 14, 12, 1, 3, 9, 5, 0, 15, 4, 8, 6, 2, 10],
|
|
30
|
+
[6, 15, 14, 9, 11, 3, 0, 8, 12, 2, 13, 7, 1, 4, 10, 5],
|
|
31
|
+
[10, 2, 8, 4, 7, 6, 1, 5, 15, 11, 9, 14, 3, 12, 13, 0]
|
|
32
|
+
].freeze
|
|
33
|
+
|
|
34
|
+
# The lanes [a, b, c, d] of the eight G calls in one round: four columns, then four diagonals.
|
|
35
|
+
ROUND_LANES = [
|
|
36
|
+
[0, 4, 8, 12], [1, 5, 9, 13], [2, 6, 10, 14], [3, 7, 11, 15],
|
|
37
|
+
[0, 5, 10, 15], [1, 6, 11, 12], [2, 7, 8, 13], [3, 4, 9, 14]
|
|
38
|
+
].freeze
|
|
39
|
+
|
|
40
|
+
private_constant :MASK64, :BLOCK_BYTES, :PARAM_BLOCK, :IV, :SIGMA, :ROUND_LANES
|
|
41
|
+
|
|
42
|
+
def self.digest256(input)
|
|
43
|
+
data = input.b
|
|
44
|
+
chain = IV.dup
|
|
45
|
+
chain[0] ^= PARAM_BLOCK
|
|
46
|
+
blocks(data).each { |words, counter, last| compress(chain, words, counter, last) }
|
|
47
|
+
chain[0, 4].pack('Q<4')
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Each message block as [16 words, byte counter, last?]. An empty input is one zero block.
|
|
51
|
+
def self.blocks(data)
|
|
52
|
+
return [[[0] * 16, 0, true]] if data.empty?
|
|
53
|
+
|
|
54
|
+
count = (data.bytesize + BLOCK_BYTES - 1) / BLOCK_BYTES
|
|
55
|
+
Array.new(count) do |index|
|
|
56
|
+
last = index == count - 1
|
|
57
|
+
offset = index * BLOCK_BYTES
|
|
58
|
+
counter = last ? data.bytesize : offset + BLOCK_BYTES
|
|
59
|
+
[data.byteslice(offset, BLOCK_BYTES).ljust(BLOCK_BYTES, "\x00").unpack('Q<16'), counter, last]
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
def self.compress(chain, words, counter, last)
|
|
64
|
+
work = chain + IV
|
|
65
|
+
work[12] ^= counter & MASK64
|
|
66
|
+
work[14] ^= MASK64 if last
|
|
67
|
+
12.times { |round| mix_round(work, words, SIGMA[round % 10]) }
|
|
68
|
+
8.times { |i| chain[i] ^= work[i] ^ work[i + 8] }
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def self.mix_round(work, words, sigma)
|
|
72
|
+
ROUND_LANES.each_with_index do |lanes, i|
|
|
73
|
+
mix(work, lanes, words[sigma[2 * i]], 32, 24)
|
|
74
|
+
mix(work, lanes, words[sigma[(2 * i) + 1]], 16, 63)
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# One half of the G function: add a message word, then two add-xor-rotate steps.
|
|
79
|
+
def self.mix(work, lanes, word, rotate_d, rotate_b)
|
|
80
|
+
a, b, c, d = lanes
|
|
81
|
+
add(work, a, b, word)
|
|
82
|
+
xor_rotate(work, d, a, rotate_d)
|
|
83
|
+
add(work, c, d, 0)
|
|
84
|
+
xor_rotate(work, b, c, rotate_b)
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
def self.add(work, dst, src, word)
|
|
88
|
+
work[dst] = (work[dst] + work[src] + word) & MASK64
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
def self.xor_rotate(work, dst, src, bits)
|
|
92
|
+
work[dst] = rotr64(work[dst] ^ work[src], bits)
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
def self.rotr64(word, bits) = ((word >> bits) | (word << (64 - bits))) & MASK64
|
|
96
|
+
|
|
97
|
+
private_class_method :blocks, :compress, :mix_round, :mix, :add, :xor_rotate, :rotr64
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
end
|
data/lib/kiosk/pow.rb
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative 'pow/version'
|
|
4
|
+
require_relative 'pow/blake2b'
|
|
5
|
+
|
|
6
|
+
module Kiosk
|
|
7
|
+
# The base of every Kiosk proof-of-work backend. A backend is a module under
|
|
8
|
+
# Kiosk::Pow that defines NAME, .params and .verify(salt:, params:, nonce:),
|
|
9
|
+
# and can define .valid_params?. kiosk-reputation finds it by its NAME.
|
|
10
|
+
# README.md, "How to add a backend", gives the steps.
|
|
11
|
+
module Pow
|
|
12
|
+
# One key of a wire object. Parsed JSON has String keys; Ruby callers use Symbols.
|
|
13
|
+
def self.param(hash, key) = hash[key] || hash[key.to_s]
|
|
14
|
+
end
|
|
15
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: kiosk-pow
|
|
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
|
+
description: |
|
|
13
|
+
kiosk-pow is the base of every Kiosk proof-of-work backend:
|
|
14
|
+
kiosk-pow-equihash (the shipped default), kiosk-pow-cuckoo and
|
|
15
|
+
kiosk-pow-argon2id. It holds the one pure-Ruby BLAKE2b-256 that the
|
|
16
|
+
backends hash with, and the reader for wire parameters. Its README tells
|
|
17
|
+
how to add a backend.
|
|
18
|
+
|
|
19
|
+
Pure Ruby, no runtime dependencies. Does not depend on kiosk-core or Rails.
|
|
20
|
+
email:
|
|
21
|
+
- hello@fili.pp.ru
|
|
22
|
+
executables: []
|
|
23
|
+
extensions: []
|
|
24
|
+
extra_rdoc_files: []
|
|
25
|
+
files:
|
|
26
|
+
- CHANGELOG.md
|
|
27
|
+
- LICENSE.txt
|
|
28
|
+
- README.md
|
|
29
|
+
- lib/kiosk/pow.rb
|
|
30
|
+
- lib/kiosk/pow/blake2b.rb
|
|
31
|
+
- lib/kiosk/pow/version.rb
|
|
32
|
+
homepage: https://kiosk.tech
|
|
33
|
+
licenses:
|
|
34
|
+
- Apache-2.0
|
|
35
|
+
metadata:
|
|
36
|
+
homepage_uri: https://kiosk.tech
|
|
37
|
+
source_code_uri: https://github.com/kiosk-hq/kiosk
|
|
38
|
+
changelog_uri: https://github.com/kiosk-hq/kiosk/blob/main/kiosk-pow/CHANGELOG.md
|
|
39
|
+
bug_tracker_uri: https://github.com/kiosk-hq/kiosk/issues
|
|
40
|
+
rubygems_mfa_required: 'true'
|
|
41
|
+
rdoc_options: []
|
|
42
|
+
require_paths:
|
|
43
|
+
- lib
|
|
44
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
45
|
+
requirements:
|
|
46
|
+
- - ">="
|
|
47
|
+
- !ruby/object:Gem::Version
|
|
48
|
+
version: '4.0'
|
|
49
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - ">="
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '0'
|
|
54
|
+
requirements: []
|
|
55
|
+
rubygems_version: 4.0.3
|
|
56
|
+
specification_version: 4
|
|
57
|
+
summary: 'The base of the Kiosk proof-of-work backends: BLAKE2b-256 and the backend
|
|
58
|
+
contract'
|
|
59
|
+
test_files: []
|