swarmauri_mre_crypto_pgp 0.3.0.dev3__py3-none-any.whl
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.
- swarmauri_mre_crypto_pgp/PGPSealMreCrypto.py +223 -0
- swarmauri_mre_crypto_pgp/__init__.py +11 -0
- swarmauri_mre_crypto_pgp/pgp_mre.py +457 -0
- swarmauri_mre_crypto_pgp/pgp_sealed_cek_mre.py +347 -0
- swarmauri_mre_crypto_pgp-0.3.0.dev3.dist-info/LICENSE +201 -0
- swarmauri_mre_crypto_pgp-0.3.0.dev3.dist-info/METADATA +114 -0
- swarmauri_mre_crypto_pgp-0.3.0.dev3.dist-info/RECORD +9 -0
- swarmauri_mre_crypto_pgp-0.3.0.dev3.dist-info/WHEEL +4 -0
- swarmauri_mre_crypto_pgp-0.3.0.dev3.dist-info/entry_points.txt +10 -0
@@ -0,0 +1,347 @@
|
|
1
|
+
"""PGPSealedCekMreCrypto
|
2
|
+
|
3
|
+
Multi-recipient encryption provider using a shared AEAD payload and OpenPGP
|
4
|
+
sealing of the content-encryption key (CEK).
|
5
|
+
"""
|
6
|
+
|
7
|
+
from __future__ import annotations
|
8
|
+
|
9
|
+
from typing import Any, Dict, Iterable, List, Mapping, Optional, Sequence, Tuple
|
10
|
+
|
11
|
+
import os
|
12
|
+
|
13
|
+
from swarmauri_core.mre_crypto.IMreCrypto import IMreCrypto
|
14
|
+
from swarmauri_core.crypto.types import Alg, KeyRef
|
15
|
+
|
16
|
+
try: # type-checking only
|
17
|
+
from swarmauri_core.mre_crypto.types import MultiRecipientEnvelope, RecipientId
|
18
|
+
except Exception: # pragma: no cover - typing fallback
|
19
|
+
MultiRecipientEnvelope = Dict[str, Any] # type: ignore
|
20
|
+
RecipientId = str # type: ignore
|
21
|
+
|
22
|
+
try: # pragma: no cover - optional runtime dep
|
23
|
+
from cryptography.hazmat.primitives.ciphers.aead import AESGCM
|
24
|
+
|
25
|
+
_CRYPTOGRAPHY_OK = True
|
26
|
+
except Exception: # pragma: no cover
|
27
|
+
_CRYPTOGRAPHY_OK = False
|
28
|
+
|
29
|
+
try: # pragma: no cover - optional runtime dep
|
30
|
+
import pgpy
|
31
|
+
|
32
|
+
_PGP_OK = True
|
33
|
+
except Exception: # pragma: no cover
|
34
|
+
_PGP_OK = False
|
35
|
+
|
36
|
+
|
37
|
+
def _ensure_crypto() -> None:
|
38
|
+
if not _CRYPTOGRAPHY_OK:
|
39
|
+
raise RuntimeError(
|
40
|
+
"PGPSealedCekMreCrypto requires 'cryptography'. Install with: pip install cryptography"
|
41
|
+
)
|
42
|
+
|
43
|
+
|
44
|
+
def _ensure_pgpy() -> None:
|
45
|
+
if not _PGP_OK:
|
46
|
+
raise RuntimeError(
|
47
|
+
"PGPSealedCekMreCrypto requires 'PGPy'. Install with: pip install pgpy"
|
48
|
+
)
|
49
|
+
|
50
|
+
|
51
|
+
# ---------------------------------------------------------------------------
|
52
|
+
# PGP helpers
|
53
|
+
# ---------------------------------------------------------------------------
|
54
|
+
|
55
|
+
|
56
|
+
def _load_pgpy_pubkey(rec: KeyRef) -> Tuple[str, "pgpy.PGPKey"]:
|
57
|
+
_ensure_pgpy()
|
58
|
+
if isinstance(rec, dict):
|
59
|
+
kind = rec.get("kind")
|
60
|
+
if kind == "pgpy_pub" and isinstance(rec.get("pub"), pgpy.PGPKey):
|
61
|
+
pk = rec["pub"]
|
62
|
+
elif kind == "pgpy_key" and isinstance(rec.get("key"), pgpy.PGPKey):
|
63
|
+
k = rec["key"]
|
64
|
+
pk = k.pubkey if hasattr(k, "pubkey") else k
|
65
|
+
elif kind == "pgpy_pub_armored" and isinstance(rec.get("pub"), str):
|
66
|
+
pk, _ = pgpy.PGPKey.from_blob(rec["pub"])
|
67
|
+
else:
|
68
|
+
raise TypeError("Unsupported KeyRef for PGP public key encryption.")
|
69
|
+
else:
|
70
|
+
raise TypeError("Unsupported KeyRef type for PGP public key encryption.")
|
71
|
+
|
72
|
+
if getattr(pk, "is_public", True) is False and hasattr(pk, "pubkey"):
|
73
|
+
pk = pk.pubkey # type: ignore[arg-type]
|
74
|
+
|
75
|
+
rid = str(pk.fingerprint)
|
76
|
+
return rid, pk
|
77
|
+
|
78
|
+
|
79
|
+
def _load_pgpy_privkey(
|
80
|
+
my: KeyRef, *, passphrase: Optional[bytes | str]
|
81
|
+
) -> "pgpy.PGPKey":
|
82
|
+
_ensure_pgpy()
|
83
|
+
if isinstance(my, dict):
|
84
|
+
kind = my.get("kind")
|
85
|
+
if kind == "pgpy_key" and isinstance(my.get("key"), pgpy.PGPKey):
|
86
|
+
k = my["key"]
|
87
|
+
elif kind == "pgpy_key_armored" and isinstance(my.get("key"), str):
|
88
|
+
k, _ = pgpy.PGPKey.from_blob(my["key"])
|
89
|
+
else:
|
90
|
+
raise TypeError("Unsupported KeyRef for PGP private key.")
|
91
|
+
else:
|
92
|
+
raise TypeError("Unsupported KeyRef for PGP private key.")
|
93
|
+
|
94
|
+
if getattr(k, "is_unlocked", True) is False:
|
95
|
+
if passphrase is None:
|
96
|
+
raise RuntimeError("PGP private key is locked. Provide opts['passphrase'].")
|
97
|
+
k.unlock(passphrase)
|
98
|
+
return k
|
99
|
+
|
100
|
+
|
101
|
+
# ---------------------------------------------------------------------------
|
102
|
+
# AEAD helpers
|
103
|
+
# ---------------------------------------------------------------------------
|
104
|
+
|
105
|
+
|
106
|
+
def _aead_encrypt(
|
107
|
+
cek: bytes, pt: bytes, *, aad: Optional[bytes]
|
108
|
+
) -> Tuple[bytes, bytes, bytes]:
|
109
|
+
_ensure_crypto()
|
110
|
+
if len(cek) not in (16, 24, 32):
|
111
|
+
raise ValueError("AES-GCM key must be 16/24/32 bytes.")
|
112
|
+
nonce = os.urandom(12)
|
113
|
+
aead = AESGCM(cek)
|
114
|
+
ct_plus_tag = aead.encrypt(nonce, pt, aad)
|
115
|
+
tag = ct_plus_tag[-16:]
|
116
|
+
ct = ct_plus_tag[:-16]
|
117
|
+
return nonce, ct, tag
|
118
|
+
|
119
|
+
|
120
|
+
def _aead_decrypt(
|
121
|
+
cek: bytes, nonce: bytes, ct: bytes, tag: bytes, *, aad: Optional[bytes]
|
122
|
+
) -> bytes:
|
123
|
+
_ensure_crypto()
|
124
|
+
aead = AESGCM(cek)
|
125
|
+
return aead.decrypt(nonce, ct + tag, aad)
|
126
|
+
|
127
|
+
|
128
|
+
class PGPSealedCekMreCrypto(IMreCrypto):
|
129
|
+
"""IMreCrypto provider for the ``sealed_cek+aead`` mode using OpenPGP."""
|
130
|
+
|
131
|
+
def supports(self) -> Dict[str, Iterable[str]]: # pragma: no cover - trivial
|
132
|
+
return {
|
133
|
+
"payload": ("AES-256-GCM",),
|
134
|
+
"recipient": ("OpenPGP-SEAL",),
|
135
|
+
"modes": ("sealed_cek+aead",),
|
136
|
+
"features": ("aad", "rewrap_without_reencrypt"),
|
137
|
+
}
|
138
|
+
|
139
|
+
async def encrypt_for_many(
|
140
|
+
self,
|
141
|
+
recipients: Sequence[KeyRef],
|
142
|
+
pt: bytes,
|
143
|
+
*,
|
144
|
+
payload_alg: Optional[Alg] = None,
|
145
|
+
recipient_alg: Optional[Alg] = None,
|
146
|
+
mode: Optional[str] = None,
|
147
|
+
aad: Optional[bytes] = None,
|
148
|
+
shared: Optional[Mapping[str, bytes]] = None,
|
149
|
+
opts: Optional[Mapping[str, object]] = None,
|
150
|
+
) -> MultiRecipientEnvelope:
|
151
|
+
mode = mode or "sealed_cek+aead"
|
152
|
+
if mode != "sealed_cek+aead":
|
153
|
+
raise ValueError(
|
154
|
+
"PGPSealedCekMreCrypto only supports mode='sealed_cek+aead'."
|
155
|
+
)
|
156
|
+
payload_alg = payload_alg or "AES-256-GCM"
|
157
|
+
if payload_alg != "AES-256-GCM":
|
158
|
+
raise ValueError("Unsupported payload_alg for PGPSealedCekMreCrypto.")
|
159
|
+
recipient_alg = recipient_alg or "OpenPGP-SEAL"
|
160
|
+
if recipient_alg != "OpenPGP-SEAL":
|
161
|
+
raise ValueError(
|
162
|
+
"Unsupported recipient_alg for PGPSealedCekMreCrypto (expected 'OpenPGP-SEAL')."
|
163
|
+
)
|
164
|
+
if not recipients:
|
165
|
+
raise ValueError("At least one recipient is required.")
|
166
|
+
|
167
|
+
cek = os.urandom(32)
|
168
|
+
nonce, ct, tag = _aead_encrypt(cek, pt, aad=aad)
|
169
|
+
|
170
|
+
_ensure_pgpy()
|
171
|
+
rec_headers: List[Dict[str, Any]] = []
|
172
|
+
for rec in recipients:
|
173
|
+
rid, pub = _load_pgpy_pubkey(rec)
|
174
|
+
literal = pgpy.PGPMessage.new(cek, file=False)
|
175
|
+
enc = pub.encrypt(literal)
|
176
|
+
header_bytes = bytes(enc.__bytes__())
|
177
|
+
rec_headers.append({"id": rid, "header": header_bytes})
|
178
|
+
|
179
|
+
env: MultiRecipientEnvelope = {
|
180
|
+
"mode": "sealed_cek+aead",
|
181
|
+
"payload": {
|
182
|
+
"kind": "aead",
|
183
|
+
"alg": payload_alg,
|
184
|
+
"nonce": nonce,
|
185
|
+
"ct": ct,
|
186
|
+
"tag": tag,
|
187
|
+
"aad": aad,
|
188
|
+
},
|
189
|
+
"recipient_alg": recipient_alg,
|
190
|
+
"recipients": rec_headers,
|
191
|
+
"shared": dict(shared) if shared else None,
|
192
|
+
"version": 1,
|
193
|
+
}
|
194
|
+
return env
|
195
|
+
|
196
|
+
async def open_for(
|
197
|
+
self,
|
198
|
+
my_identity: KeyRef,
|
199
|
+
env: MultiRecipientEnvelope,
|
200
|
+
*,
|
201
|
+
aad: Optional[bytes] = None,
|
202
|
+
opts: Optional[Mapping[str, object]] = None,
|
203
|
+
) -> bytes:
|
204
|
+
if env.get("mode") != "sealed_cek+aead":
|
205
|
+
raise ValueError("Unsupported envelope mode.")
|
206
|
+
payload = env.get("payload") or {}
|
207
|
+
if not isinstance(payload, dict) or payload.get("kind") != "aead":
|
208
|
+
raise ValueError("Malformed envelope payload for sealed_cek+aead.")
|
209
|
+
nonce: bytes = payload["nonce"]
|
210
|
+
ct: bytes = payload["ct"]
|
211
|
+
tag: bytes = payload["tag"]
|
212
|
+
bound_aad = payload.get("aad", None)
|
213
|
+
if (
|
214
|
+
(aad is not None)
|
215
|
+
and (bound_aad is not None)
|
216
|
+
and (bytes(aad) != bytes(bound_aad))
|
217
|
+
):
|
218
|
+
raise ValueError("AAD mismatch.")
|
219
|
+
|
220
|
+
passphrase = None
|
221
|
+
if opts and "passphrase" in opts:
|
222
|
+
passphrase = opts["passphrase"]
|
223
|
+
priv = _load_pgpy_privkey(my_identity, passphrase=passphrase)
|
224
|
+
my_rid = str((priv.pubkey if hasattr(priv, "pubkey") else priv).fingerprint)
|
225
|
+
|
226
|
+
header = None
|
227
|
+
for ent in env.get("recipients") or []:
|
228
|
+
if ent.get("id") == my_rid:
|
229
|
+
header = ent.get("header")
|
230
|
+
break
|
231
|
+
if not isinstance(header, (bytes, bytearray)):
|
232
|
+
raise ValueError("Recipient not found in envelope.")
|
233
|
+
|
234
|
+
sealed = pgpy.PGPMessage.from_blob(bytes(header))
|
235
|
+
lit = priv.decrypt(sealed)
|
236
|
+
cek = bytes(lit.message)
|
237
|
+
return _aead_decrypt(cek, nonce, ct, tag, aad=bound_aad)
|
238
|
+
|
239
|
+
async def open_for_many(
|
240
|
+
self,
|
241
|
+
my_identities: Sequence[KeyRef],
|
242
|
+
env: MultiRecipientEnvelope,
|
243
|
+
*,
|
244
|
+
aad: Optional[bytes] = None,
|
245
|
+
opts: Optional[Mapping[str, object]] = None,
|
246
|
+
) -> bytes:
|
247
|
+
last_err: Optional[Exception] = None
|
248
|
+
for kid in my_identities:
|
249
|
+
try:
|
250
|
+
return await self.open_for(kid, env, aad=aad, opts=opts)
|
251
|
+
except Exception as e: # pragma: no cover - best effort
|
252
|
+
last_err = e
|
253
|
+
continue
|
254
|
+
raise (
|
255
|
+
last_err
|
256
|
+
if last_err
|
257
|
+
else RuntimeError("Failed to open envelope with provided identities.")
|
258
|
+
)
|
259
|
+
|
260
|
+
async def rewrap(
|
261
|
+
self,
|
262
|
+
env: MultiRecipientEnvelope,
|
263
|
+
*,
|
264
|
+
add: Optional[Sequence[KeyRef]] = None,
|
265
|
+
remove: Optional[Sequence[RecipientId]] = None,
|
266
|
+
recipient_alg: Optional[Alg] = None,
|
267
|
+
opts: Optional[Mapping[str, object]] = None,
|
268
|
+
) -> MultiRecipientEnvelope:
|
269
|
+
if env.get("mode") != "sealed_cek+aead":
|
270
|
+
raise ValueError("Unsupported envelope mode for rewrap.")
|
271
|
+
if recipient_alg and recipient_alg != "OpenPGP-SEAL":
|
272
|
+
raise ValueError(
|
273
|
+
"PGPSealedCekMreCrypto only supports recipient_alg='OpenPGP-SEAL' in rewrap."
|
274
|
+
)
|
275
|
+
|
276
|
+
add = add or []
|
277
|
+
remove_ids = set(remove or [])
|
278
|
+
recipients = list(env.get("recipients") or [])
|
279
|
+
payload = env.get("payload") or {}
|
280
|
+
rotate_flag = bool((opts or {}).get("rotate_payload_on_revoke")) and bool(
|
281
|
+
remove_ids
|
282
|
+
)
|
283
|
+
|
284
|
+
cek: Optional[bytes] = None
|
285
|
+
need_cek = add or rotate_flag
|
286
|
+
if need_cek:
|
287
|
+
if opts and isinstance(opts.get("cek"), (bytes, bytearray)):
|
288
|
+
cek = bytes(opts["cek"])
|
289
|
+
else:
|
290
|
+
opener_list = (opts or {}).get("opener_identities")
|
291
|
+
if not opener_list:
|
292
|
+
raise RuntimeError(
|
293
|
+
"Rewrap(add=... or rotate) requires opts['cek'] or opts['opener_identities']."
|
294
|
+
)
|
295
|
+
if not isinstance(opener_list, (list, tuple)):
|
296
|
+
opener_list = [opener_list]
|
297
|
+
passphrase = (opts or {}).get("passphrase")
|
298
|
+
for ident in opener_list:
|
299
|
+
try:
|
300
|
+
priv = _load_pgpy_privkey(ident, passphrase=passphrase)
|
301
|
+
for ent in recipients:
|
302
|
+
try:
|
303
|
+
sealed = pgpy.PGPMessage.from_blob(bytes(ent["header"]))
|
304
|
+
with priv:
|
305
|
+
lit = priv.decrypt(sealed)
|
306
|
+
cek = bytes(lit.message)
|
307
|
+
break
|
308
|
+
except Exception:
|
309
|
+
continue
|
310
|
+
if cek:
|
311
|
+
break
|
312
|
+
except Exception:
|
313
|
+
continue
|
314
|
+
if cek is None:
|
315
|
+
raise RuntimeError("Unable to recover CEK for rewrap.")
|
316
|
+
|
317
|
+
if remove_ids:
|
318
|
+
recipients = [r for r in recipients if r.get("id") not in remove_ids]
|
319
|
+
|
320
|
+
if rotate_flag and cek is not None:
|
321
|
+
new_cek = os.urandom(32)
|
322
|
+
bound_aad = payload.get("aad")
|
323
|
+
pt = _aead_decrypt(
|
324
|
+
cek, payload["nonce"], payload["ct"], payload["tag"], aad=bound_aad
|
325
|
+
)
|
326
|
+
nonce, ct, tag = _aead_encrypt(new_cek, pt, aad=bound_aad)
|
327
|
+
env["payload"] = {
|
328
|
+
"kind": "aead",
|
329
|
+
"alg": payload.get("alg", "AES-256-GCM"),
|
330
|
+
"nonce": nonce,
|
331
|
+
"ct": ct,
|
332
|
+
"tag": tag,
|
333
|
+
"aad": bound_aad,
|
334
|
+
}
|
335
|
+
cek = new_cek
|
336
|
+
recipients = []
|
337
|
+
|
338
|
+
for rec in add:
|
339
|
+
rid, pub = _load_pgpy_pubkey(rec)
|
340
|
+
literal = pgpy.PGPMessage.new(cek, file=False)
|
341
|
+
enc = pub.encrypt(literal)
|
342
|
+
header_bytes = bytes(enc.__bytes__())
|
343
|
+
recipients = [r for r in recipients if r.get("id") != rid]
|
344
|
+
recipients.append({"id": rid, "header": header_bytes})
|
345
|
+
|
346
|
+
env["recipients"] = recipients
|
347
|
+
return env
|
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [2025] [Jacob Stewart @ Swarmauri]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
@@ -0,0 +1,114 @@
|
|
1
|
+
Metadata-Version: 2.3
|
2
|
+
Name: swarmauri_mre_crypto_pgp
|
3
|
+
Version: 0.3.0.dev3
|
4
|
+
Summary: OpenPGP sealed-per-recipient MRE provider for Swarmauri
|
5
|
+
License: Apache-2.0
|
6
|
+
Author: Swarmauri
|
7
|
+
Author-email: opensource@swarmauri.com
|
8
|
+
Requires-Python: >=3.10,<3.13
|
9
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
10
|
+
Classifier: Natural Language :: English
|
11
|
+
Classifier: Programming Language :: Python :: 3.10
|
12
|
+
Classifier: Programming Language :: Python :: 3.11
|
13
|
+
Classifier: Programming Language :: Python :: 3.12
|
14
|
+
Classifier: Programming Language :: Python :: 3.13
|
15
|
+
Classifier: Development Status :: 3 - Alpha
|
16
|
+
Classifier: Topic :: Security :: Cryptography
|
17
|
+
Classifier: Intended Audience :: Developers
|
18
|
+
Provides-Extra: cbor
|
19
|
+
Provides-Extra: cryptography
|
20
|
+
Provides-Extra: pgpy
|
21
|
+
Requires-Dist: cbor2 (>=5.4.6) ; extra == "cbor"
|
22
|
+
Requires-Dist: cryptography (>=41.0.0) ; extra == "cryptography"
|
23
|
+
Requires-Dist: pgpy (>=0.6.0)
|
24
|
+
Requires-Dist: pgpy (>=0.6.0) ; extra == "pgpy"
|
25
|
+
Requires-Dist: swarmauri_base
|
26
|
+
Requires-Dist: swarmauri_core
|
27
|
+
Description-Content-Type: text/markdown
|
28
|
+
|
29
|
+

|
30
|
+
|
31
|
+
<p align="center">
|
32
|
+
<a href="https://pypi.org/project/swarmauri_mre_crypto_pgp/">
|
33
|
+
<img src="https://img.shields.io/pypi/dm/swarmauri_mre_crypto_pgp" alt="PyPI - Downloads"/></a>
|
34
|
+
<a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/standards/swarmauri_mre_crypto_pgp/">
|
35
|
+
<img alt="Hits" src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/standards/swarmauri_mre_crypto_pgp.svg"/></a>
|
36
|
+
<a href="https://pypi.org/project/swarmauri_mre_crypto_pgp/">
|
37
|
+
<img src="https://img.shields.io/pypi/pyversions/swarmauri_mre_crypto_pgp" alt="PyPI - Python Version"/></a>
|
38
|
+
<a href="https://pypi.org/project/swarmauri_mre_crypto_pgp/">
|
39
|
+
<img src="https://img.shields.io/pypi/l/swarmauri_mre_crypto_pgp" alt="PyPI - License"/></a>
|
40
|
+
<a href="https://pypi.org/project/swarmauri_mre_crypto_pgp/">
|
41
|
+
<img src="https://img.shields.io/pypi/v/swarmauri_mre_crypto_pgp?label=swarmauri_mre_crypto_pgp&color=green" alt="PyPI - swarmauri_mre_crypto_pgp"/></a>
|
42
|
+
</p>
|
43
|
+
|
44
|
+
---
|
45
|
+
|
46
|
+
## Swarmauri MRE Crypto PGP
|
47
|
+
|
48
|
+
OpenPGP-based multi-recipient encryption providers implementing the
|
49
|
+
`IMreCrypto` contract. This package exposes three providers:
|
50
|
+
|
51
|
+
* **PGPSealMreCrypto** – per-recipient sealed payloads
|
52
|
+
(`sealed_per_recipient` mode).
|
53
|
+
* **PGPSealedCekMreCrypto** – shared AEAD payload with per-recipient sealed
|
54
|
+
CEK (`sealed_cek+aead` mode).
|
55
|
+
* **PGPMreCrypto** – composite provider supporting both the
|
56
|
+
`enc_once+per_recipient_header` and `sealed_per_recipient` modes.
|
57
|
+
|
58
|
+
All providers use OpenPGP public key encryption via PGPy.
|
59
|
+
|
60
|
+
### Installation
|
61
|
+
|
62
|
+
```bash
|
63
|
+
pip install swarmauri_mre_crypto_pgp
|
64
|
+
```
|
65
|
+
|
66
|
+
### Usage
|
67
|
+
|
68
|
+
```python
|
69
|
+
import asyncio
|
70
|
+
from pgpy import PGPKey, PGPUID
|
71
|
+
from pgpy.constants import (
|
72
|
+
CompressionAlgorithm,
|
73
|
+
HashAlgorithm,
|
74
|
+
KeyFlags,
|
75
|
+
PubKeyAlgorithm,
|
76
|
+
SymmetricKeyAlgorithm,
|
77
|
+
)
|
78
|
+
from swarmauri_mre_crypto_pgp import PGPMreCrypto
|
79
|
+
|
80
|
+
|
81
|
+
async def main():
|
82
|
+
# Generate an OpenPGP key pair with pgpy
|
83
|
+
key = PGPKey.new(PubKeyAlgorithm.RSAEncryptOrSign, 2048)
|
84
|
+
uid = PGPUID.new("Test User", email="test@example.com")
|
85
|
+
key.add_uid(
|
86
|
+
uid,
|
87
|
+
usage={KeyFlags.EncryptCommunications},
|
88
|
+
hashes=[HashAlgorithm.SHA256],
|
89
|
+
ciphers=[SymmetricKeyAlgorithm.AES256],
|
90
|
+
compression=[CompressionAlgorithm.ZLIB],
|
91
|
+
)
|
92
|
+
|
93
|
+
# Create references understood by the provider
|
94
|
+
pub_ref = {"kind": "pgpy_pub", "pub": key.pubkey}
|
95
|
+
priv_ref = {"kind": "pgpy_priv", "priv": key}
|
96
|
+
|
97
|
+
# Encrypt for many and open with the private key
|
98
|
+
mre = PGPMreCrypto()
|
99
|
+
pt = b"hello"
|
100
|
+
env = await mre.encrypt_for_many([pub_ref], pt)
|
101
|
+
rt = await mre.open_for(priv_ref, env)
|
102
|
+
print(rt)
|
103
|
+
|
104
|
+
|
105
|
+
if __name__ == "__main__":
|
106
|
+
asyncio.run(main())
|
107
|
+
```
|
108
|
+
|
109
|
+
## Entry point
|
110
|
+
|
111
|
+
Providers are registered under the `swarmauri.mre_cryptos` entry-point as
|
112
|
+
`PGPSealMreCrypto`, `PGPSealedCekMreCrypto` and `PGPMreCrypto`.
|
113
|
+
|
114
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
swarmauri_mre_crypto_pgp/PGPSealMreCrypto.py,sha256=m-hU3q--YjujDrvdgkF29ElXWgtlxLYCjfB5ZmM8_cY,8187
|
2
|
+
swarmauri_mre_crypto_pgp/__init__.py,sha256=8jIWcVUOYwLAHjWx7NLd3WT-owus9Qb0nZjYJvqR64o,280
|
3
|
+
swarmauri_mre_crypto_pgp/pgp_mre.py,sha256=RTlq_kK7iyMMarmkR17x4G5fbQ-w2oQX8IKv2u1rX6U,16709
|
4
|
+
swarmauri_mre_crypto_pgp/pgp_sealed_cek_mre.py,sha256=tRrUrNdD1rCkFiY8aWBEgtTrV7g7YHHcTSSZThxQ97s,12408
|
5
|
+
swarmauri_mre_crypto_pgp-0.3.0.dev3.dist-info/LICENSE,sha256=djUXOlCxLVszShEpZXshZ7v33G-2qIC_j9KXpWKZSzQ,11359
|
6
|
+
swarmauri_mre_crypto_pgp-0.3.0.dev3.dist-info/METADATA,sha256=ofKOhFxFEI0s57tMk7b6uexTUrh9KB7M7qQd_HMHtfU,4067
|
7
|
+
swarmauri_mre_crypto_pgp-0.3.0.dev3.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
|
8
|
+
swarmauri_mre_crypto_pgp-0.3.0.dev3.dist-info/entry_points.txt,sha256=EYmzBKJYsYA7sUATQPlDs47BASiy5YOulGEoZOACRZQ,447
|
9
|
+
swarmauri_mre_crypto_pgp-0.3.0.dev3.dist-info/RECORD,,
|