qopanza 0.1.0__tar.gz
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.
- qopanza-0.1.0/LICENSE +202 -0
- qopanza-0.1.0/MANIFEST.in +9 -0
- qopanza-0.1.0/PKG-INFO +200 -0
- qopanza-0.1.0/README.md +162 -0
- qopanza-0.1.0/examples/quickstart.py +66 -0
- qopanza-0.1.0/pyproject.toml +78 -0
- qopanza-0.1.0/qopanza/__init__.py +23 -0
- qopanza-0.1.0/qopanza/cli.py +763 -0
- qopanza-0.1.0/qopanza/client.py +411 -0
- qopanza-0.1.0/qopanza/py.typed +0 -0
- qopanza-0.1.0/qopanza/zk.py +247 -0
- qopanza-0.1.0/qopanza.egg-info/PKG-INFO +200 -0
- qopanza-0.1.0/qopanza.egg-info/SOURCES.txt +19 -0
- qopanza-0.1.0/qopanza.egg-info/dependency_links.txt +1 -0
- qopanza-0.1.0/qopanza.egg-info/entry_points.txt +2 -0
- qopanza-0.1.0/qopanza.egg-info/requires.txt +10 -0
- qopanza-0.1.0/qopanza.egg-info/top_level.txt +1 -0
- qopanza-0.1.0/setup.cfg +4 -0
- qopanza-0.1.0/tests/test_cli.py +214 -0
- qopanza-0.1.0/tests/test_signup.py +124 -0
- qopanza-0.1.0/tests/test_zk.py +198 -0
qopanza-0.1.0/LICENSE
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 2026 Gsente LLC
|
|
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.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# The wheel is built from the package directory, but the sdist is built
|
|
2
|
+
# from this tree — and by default it would omit the licence and tests,
|
|
3
|
+
# which is exactly what people check when auditing a security package
|
|
4
|
+
# before installing it.
|
|
5
|
+
include LICENSE
|
|
6
|
+
include README.md
|
|
7
|
+
recursive-include tests *.py
|
|
8
|
+
recursive-include examples *.py
|
|
9
|
+
global-exclude __pycache__/* *.pyc *.pyo
|
qopanza-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: qopanza
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Post-quantum cryptography as an API — ML-KEM, ML-DSA and SLH-DSA for Python, plus the qopanza CLI
|
|
5
|
+
Author: Gsente LLC
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://qopanza.com
|
|
8
|
+
Project-URL: Repository, https://github.com/isingomajoel2023/qopanza-sdks
|
|
9
|
+
Project-URL: Issues, https://github.com/isingomajoel2023/qopanza-sdks/issues
|
|
10
|
+
Keywords: post-quantum,cryptography,pqc,ml-kem,ml-dsa,slh-dsa,kyber,dilithium,quantum-safe,encryption,security
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Intended Audience :: System Administrators
|
|
14
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
23
|
+
Classifier: Topic :: Security :: Cryptography
|
|
24
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
25
|
+
Classifier: Typing :: Typed
|
|
26
|
+
Requires-Python: >=3.9
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
License-File: LICENSE
|
|
29
|
+
Requires-Dist: httpx>=0.27.0
|
|
30
|
+
Provides-Extra: test
|
|
31
|
+
Requires-Dist: pytest>=8.0; extra == "test"
|
|
32
|
+
Requires-Dist: pytest-httpx>=0.30; extra == "test"
|
|
33
|
+
Requires-Dist: respx>=0.21; extra == "test"
|
|
34
|
+
Provides-Extra: zk
|
|
35
|
+
Requires-Dist: liboqs-python>=0.12; extra == "zk"
|
|
36
|
+
Requires-Dist: cryptography>=42.0; extra == "zk"
|
|
37
|
+
Dynamic: license-file
|
|
38
|
+
|
|
39
|
+
# qopanza (Python)
|
|
40
|
+
|
|
41
|
+
Python client for the Qopanza API — post-quantum encryption and
|
|
42
|
+
signing (ML-KEM, ML-DSA, SLH-DSA) behind one API call, plus the `qopanza`
|
|
43
|
+
CLI. Python 3.9+, one runtime dependency (`httpx`).
|
|
44
|
+
|
|
45
|
+
## Install
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
pip install qopanza
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Optional extras:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
pip install 'qopanza[zk]' # zero-knowledge: local PQC, needs liboqs
|
|
55
|
+
pip install 'qopanza[test]' # to run the test suite
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
From a checkout of this repo instead:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
cd sdks/python && pip install -e .
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Usage
|
|
65
|
+
|
|
66
|
+
### Start from nothing
|
|
67
|
+
|
|
68
|
+
`signup` is the one call that works without credentials, and it adopts
|
|
69
|
+
the returned key onto the client so the next call is authenticated.
|
|
70
|
+
|
|
71
|
+
```python
|
|
72
|
+
from qopanza import QopanzaClient
|
|
73
|
+
|
|
74
|
+
with QopanzaClient(base_url="https://api.example.com") as client:
|
|
75
|
+
account = client.signup("you@example.com", "a-real-password")
|
|
76
|
+
print(account["api_key"]) # shown once — store it now
|
|
77
|
+
|
|
78
|
+
enc = client.encrypt(plaintext=b"customer sensitive information")
|
|
79
|
+
assert client.decrypt(**enc) == b"customer sensitive information"
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
The API key is returned rather than hidden inside the client on purpose:
|
|
83
|
+
it is issued once and cannot be retrieved again, so a version of this
|
|
84
|
+
that quietly kept it would lose it when the process exited.
|
|
85
|
+
|
|
86
|
+
### One-line encryption (no cryptography knowledge required)
|
|
87
|
+
|
|
88
|
+
With a key you already have. Don't create or manage keys at all — the
|
|
89
|
+
platform provisions a managed key for your account on first use and
|
|
90
|
+
reuses it.
|
|
91
|
+
|
|
92
|
+
```python
|
|
93
|
+
from qopanza import QopanzaClient
|
|
94
|
+
|
|
95
|
+
with QopanzaClient(base_url="https://api.example.com", api_key=api_key) as client:
|
|
96
|
+
enc = client.encrypt(plaintext=b"customer sensitive information")
|
|
97
|
+
data = client.decrypt(**enc)
|
|
98
|
+
assert data == b"customer sensitive information"
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Zero-knowledge: keys that never leave your machine
|
|
102
|
+
|
|
103
|
+
Install with the `zk` extra (`pip install 'qopanza[zk]'`) and the
|
|
104
|
+
private key is generated locally and stays there. The platform holds the
|
|
105
|
+
public half, so it can inventory, version and police the key — and cannot
|
|
106
|
+
decrypt with it.
|
|
107
|
+
|
|
108
|
+
```python
|
|
109
|
+
from qopanza import QopanzaClient, zk
|
|
110
|
+
|
|
111
|
+
keypair = zk.generate_keypair() # local, never uploaded
|
|
112
|
+
envelope = zk.encrypt(keypair.public_key, b"secret") # local
|
|
113
|
+
assert zk.decrypt(keypair.secret_key, envelope) == b"secret"
|
|
114
|
+
|
|
115
|
+
with QopanzaClient(base_url="http://localhost:8000", api_key=api_key) as client:
|
|
116
|
+
client.register_key(
|
|
117
|
+
purpose="kem", algorithm=keypair.algorithm, public_key=keypair.public_key
|
|
118
|
+
)
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
**There is no escrow.** Lose the private key and the data is unrecoverable
|
|
122
|
+
— that is the guarantee, not a gap. `/encrypt`, `/decrypt` and `/sign`
|
|
123
|
+
return 409 for these keys rather than quietly routing your plaintext
|
|
124
|
+
through the server. See `docs/zero-knowledge.md`.
|
|
125
|
+
|
|
126
|
+
### Full control
|
|
127
|
+
|
|
128
|
+
```python
|
|
129
|
+
from qopanza import QopanzaClient
|
|
130
|
+
|
|
131
|
+
with QopanzaClient(base_url="http://localhost:8000", api_key=api_key) as client:
|
|
132
|
+
# Generate a KEM keypair
|
|
133
|
+
key = client.create_key(purpose="kem", label="order-service-kem")
|
|
134
|
+
|
|
135
|
+
# Encrypt / decrypt
|
|
136
|
+
enc = client.encrypt(key_id=key["id"], plaintext=b"hello quantum-safe world")
|
|
137
|
+
plaintext = client.decrypt(**enc)
|
|
138
|
+
assert plaintext == b"hello quantum-safe world"
|
|
139
|
+
|
|
140
|
+
# Signatures
|
|
141
|
+
sig_key = client.create_key(purpose="signature", label="order-service-sig")
|
|
142
|
+
signed = client.sign(key_id=sig_key["id"], message=b"order-42-confirmed")
|
|
143
|
+
assert client.verify(
|
|
144
|
+
key_id=sig_key["id"], message=b"order-42-confirmed", signature=signed["signature"]
|
|
145
|
+
)
|
|
146
|
+
|
|
147
|
+
# AI security analysis
|
|
148
|
+
report = client.analyze(
|
|
149
|
+
context={"algorithms_in_use": ["RSA-2048"], "key_reuse_count": 3}
|
|
150
|
+
)
|
|
151
|
+
for finding in report["findings"]:
|
|
152
|
+
print(finding["severity"], finding["title"])
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
See `examples/quickstart.py` for a runnable script.
|
|
156
|
+
|
|
157
|
+
## `qopanza` command line
|
|
158
|
+
|
|
159
|
+
Installing the SDK also installs the `qopanza` CLI.
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
qopanza login # store credentials (chmod 600)
|
|
163
|
+
qopanza scan . # scan a directory
|
|
164
|
+
qopanza scan --tls api.example.com # probe a live TLS endpoint
|
|
165
|
+
qopanza scan --repository https://github.com/org/repo
|
|
166
|
+
qopanza posture # quantum risk score + category breakdown
|
|
167
|
+
qopanza inventory # cryptographic inventory
|
|
168
|
+
qopanza key create --purpose hybrid_kem
|
|
169
|
+
qopanza key rotate <key-id> # old versions still decrypt
|
|
170
|
+
qopanza audit --verify # verify the audit hash chain
|
|
171
|
+
qopanza migrate --plan # generate a migration plan
|
|
172
|
+
qopanza compliance # control checks (not an audit result)
|
|
173
|
+
|
|
174
|
+
qopanza zk keygen --out key.json # generate locally; nothing is uploaded
|
|
175
|
+
qopanza zk register --key key.json # send the PUBLIC half only
|
|
176
|
+
qopanza zk encrypt --key key.json --in secrets.txt --out sealed.json
|
|
177
|
+
qopanza zk decrypt --key key.json --in sealed.json
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
`qopanza zk keygen/encrypt/decrypt` make no network calls and need no API
|
|
181
|
+
key at all.
|
|
182
|
+
|
|
183
|
+
Add `--json` to any command for machine-readable output.
|
|
184
|
+
|
|
185
|
+
Credentials come from `~/.config/qopanza/config.json` or, taking
|
|
186
|
+
precedence, `QOPANZA_API_KEY` / `QOPANZA_BASE_URL` — so CI can inject them
|
|
187
|
+
without writing anything to disk.
|
|
188
|
+
|
|
189
|
+
### Using it as a CI gate
|
|
190
|
+
|
|
191
|
+
```bash
|
|
192
|
+
qopanza scan . --fail-on high
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
Exit codes: `0` clean, `1` the scan could not run, `2` findings at or
|
|
196
|
+
above the threshold. `1` and `2` are deliberately distinct — a scan that
|
|
197
|
+
failed to run must never be read as a clean build. See
|
|
198
|
+
`integrations/README.md` for ready-made GitHub Actions and GitLab CI
|
|
199
|
+
configurations, and for advice on rolling the gate out without blocking
|
|
200
|
+
every PR on day one.
|
qopanza-0.1.0/README.md
ADDED
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
# qopanza (Python)
|
|
2
|
+
|
|
3
|
+
Python client for the Qopanza API — post-quantum encryption and
|
|
4
|
+
signing (ML-KEM, ML-DSA, SLH-DSA) behind one API call, plus the `qopanza`
|
|
5
|
+
CLI. Python 3.9+, one runtime dependency (`httpx`).
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pip install qopanza
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Optional extras:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
pip install 'qopanza[zk]' # zero-knowledge: local PQC, needs liboqs
|
|
17
|
+
pip install 'qopanza[test]' # to run the test suite
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
From a checkout of this repo instead:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
cd sdks/python && pip install -e .
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
### Start from nothing
|
|
29
|
+
|
|
30
|
+
`signup` is the one call that works without credentials, and it adopts
|
|
31
|
+
the returned key onto the client so the next call is authenticated.
|
|
32
|
+
|
|
33
|
+
```python
|
|
34
|
+
from qopanza import QopanzaClient
|
|
35
|
+
|
|
36
|
+
with QopanzaClient(base_url="https://api.example.com") as client:
|
|
37
|
+
account = client.signup("you@example.com", "a-real-password")
|
|
38
|
+
print(account["api_key"]) # shown once — store it now
|
|
39
|
+
|
|
40
|
+
enc = client.encrypt(plaintext=b"customer sensitive information")
|
|
41
|
+
assert client.decrypt(**enc) == b"customer sensitive information"
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
The API key is returned rather than hidden inside the client on purpose:
|
|
45
|
+
it is issued once and cannot be retrieved again, so a version of this
|
|
46
|
+
that quietly kept it would lose it when the process exited.
|
|
47
|
+
|
|
48
|
+
### One-line encryption (no cryptography knowledge required)
|
|
49
|
+
|
|
50
|
+
With a key you already have. Don't create or manage keys at all — the
|
|
51
|
+
platform provisions a managed key for your account on first use and
|
|
52
|
+
reuses it.
|
|
53
|
+
|
|
54
|
+
```python
|
|
55
|
+
from qopanza import QopanzaClient
|
|
56
|
+
|
|
57
|
+
with QopanzaClient(base_url="https://api.example.com", api_key=api_key) as client:
|
|
58
|
+
enc = client.encrypt(plaintext=b"customer sensitive information")
|
|
59
|
+
data = client.decrypt(**enc)
|
|
60
|
+
assert data == b"customer sensitive information"
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Zero-knowledge: keys that never leave your machine
|
|
64
|
+
|
|
65
|
+
Install with the `zk` extra (`pip install 'qopanza[zk]'`) and the
|
|
66
|
+
private key is generated locally and stays there. The platform holds the
|
|
67
|
+
public half, so it can inventory, version and police the key — and cannot
|
|
68
|
+
decrypt with it.
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
from qopanza import QopanzaClient, zk
|
|
72
|
+
|
|
73
|
+
keypair = zk.generate_keypair() # local, never uploaded
|
|
74
|
+
envelope = zk.encrypt(keypair.public_key, b"secret") # local
|
|
75
|
+
assert zk.decrypt(keypair.secret_key, envelope) == b"secret"
|
|
76
|
+
|
|
77
|
+
with QopanzaClient(base_url="http://localhost:8000", api_key=api_key) as client:
|
|
78
|
+
client.register_key(
|
|
79
|
+
purpose="kem", algorithm=keypair.algorithm, public_key=keypair.public_key
|
|
80
|
+
)
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
**There is no escrow.** Lose the private key and the data is unrecoverable
|
|
84
|
+
— that is the guarantee, not a gap. `/encrypt`, `/decrypt` and `/sign`
|
|
85
|
+
return 409 for these keys rather than quietly routing your plaintext
|
|
86
|
+
through the server. See `docs/zero-knowledge.md`.
|
|
87
|
+
|
|
88
|
+
### Full control
|
|
89
|
+
|
|
90
|
+
```python
|
|
91
|
+
from qopanza import QopanzaClient
|
|
92
|
+
|
|
93
|
+
with QopanzaClient(base_url="http://localhost:8000", api_key=api_key) as client:
|
|
94
|
+
# Generate a KEM keypair
|
|
95
|
+
key = client.create_key(purpose="kem", label="order-service-kem")
|
|
96
|
+
|
|
97
|
+
# Encrypt / decrypt
|
|
98
|
+
enc = client.encrypt(key_id=key["id"], plaintext=b"hello quantum-safe world")
|
|
99
|
+
plaintext = client.decrypt(**enc)
|
|
100
|
+
assert plaintext == b"hello quantum-safe world"
|
|
101
|
+
|
|
102
|
+
# Signatures
|
|
103
|
+
sig_key = client.create_key(purpose="signature", label="order-service-sig")
|
|
104
|
+
signed = client.sign(key_id=sig_key["id"], message=b"order-42-confirmed")
|
|
105
|
+
assert client.verify(
|
|
106
|
+
key_id=sig_key["id"], message=b"order-42-confirmed", signature=signed["signature"]
|
|
107
|
+
)
|
|
108
|
+
|
|
109
|
+
# AI security analysis
|
|
110
|
+
report = client.analyze(
|
|
111
|
+
context={"algorithms_in_use": ["RSA-2048"], "key_reuse_count": 3}
|
|
112
|
+
)
|
|
113
|
+
for finding in report["findings"]:
|
|
114
|
+
print(finding["severity"], finding["title"])
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
See `examples/quickstart.py` for a runnable script.
|
|
118
|
+
|
|
119
|
+
## `qopanza` command line
|
|
120
|
+
|
|
121
|
+
Installing the SDK also installs the `qopanza` CLI.
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
qopanza login # store credentials (chmod 600)
|
|
125
|
+
qopanza scan . # scan a directory
|
|
126
|
+
qopanza scan --tls api.example.com # probe a live TLS endpoint
|
|
127
|
+
qopanza scan --repository https://github.com/org/repo
|
|
128
|
+
qopanza posture # quantum risk score + category breakdown
|
|
129
|
+
qopanza inventory # cryptographic inventory
|
|
130
|
+
qopanza key create --purpose hybrid_kem
|
|
131
|
+
qopanza key rotate <key-id> # old versions still decrypt
|
|
132
|
+
qopanza audit --verify # verify the audit hash chain
|
|
133
|
+
qopanza migrate --plan # generate a migration plan
|
|
134
|
+
qopanza compliance # control checks (not an audit result)
|
|
135
|
+
|
|
136
|
+
qopanza zk keygen --out key.json # generate locally; nothing is uploaded
|
|
137
|
+
qopanza zk register --key key.json # send the PUBLIC half only
|
|
138
|
+
qopanza zk encrypt --key key.json --in secrets.txt --out sealed.json
|
|
139
|
+
qopanza zk decrypt --key key.json --in sealed.json
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
`qopanza zk keygen/encrypt/decrypt` make no network calls and need no API
|
|
143
|
+
key at all.
|
|
144
|
+
|
|
145
|
+
Add `--json` to any command for machine-readable output.
|
|
146
|
+
|
|
147
|
+
Credentials come from `~/.config/qopanza/config.json` or, taking
|
|
148
|
+
precedence, `QOPANZA_API_KEY` / `QOPANZA_BASE_URL` — so CI can inject them
|
|
149
|
+
without writing anything to disk.
|
|
150
|
+
|
|
151
|
+
### Using it as a CI gate
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
qopanza scan . --fail-on high
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Exit codes: `0` clean, `1` the scan could not run, `2` findings at or
|
|
158
|
+
above the threshold. `1` and `2` are deliberately distinct — a scan that
|
|
159
|
+
failed to run must never be read as a clean build. See
|
|
160
|
+
`integrations/README.md` for ready-made GitHub Actions and GitLab CI
|
|
161
|
+
configurations, and for advice on rolling the gate out without blocking
|
|
162
|
+
every PR on day one.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
"""Run against a local `docker compose up` stack:
|
|
2
|
+
|
|
3
|
+
python examples/quickstart.py
|
|
4
|
+
|
|
5
|
+
Signs up for a fresh account to get a real API key (this SDK covers the
|
|
6
|
+
crypto/analyze endpoints only — account signup isn't part of it yet, see
|
|
7
|
+
the client module docstring), then exercises encrypt/decrypt, sign/verify,
|
|
8
|
+
and the AI analysis endpoint.
|
|
9
|
+
"""
|
|
10
|
+
|
|
11
|
+
import httpx
|
|
12
|
+
|
|
13
|
+
from qopanza import QopanzaClient
|
|
14
|
+
|
|
15
|
+
BASE_URL = "http://localhost:8000"
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
def get_api_key() -> str:
|
|
19
|
+
resp = httpx.post(
|
|
20
|
+
f"{BASE_URL}/v1/accounts",
|
|
21
|
+
json={"email": "quickstart@example.com", "password": "quickstart-password-1"},
|
|
22
|
+
)
|
|
23
|
+
if resp.status_code == 409:
|
|
24
|
+
raise SystemExit(
|
|
25
|
+
"Account already exists — this quickstart signs up fresh each run. "
|
|
26
|
+
"Change the email above or delete the account first."
|
|
27
|
+
)
|
|
28
|
+
resp.raise_for_status()
|
|
29
|
+
return resp.json()["api_key"]
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
def main():
|
|
33
|
+
api_key = get_api_key()
|
|
34
|
+
|
|
35
|
+
with QopanzaClient(base_url=BASE_URL, api_key=api_key) as client:
|
|
36
|
+
print("== Key encapsulation (encrypt/decrypt) ==")
|
|
37
|
+
kem_key = client.create_key(purpose="kem", label="quickstart-kem")
|
|
38
|
+
print("Created KEM key:", kem_key["id"], kem_key["algorithm"], kem_key["backend"])
|
|
39
|
+
|
|
40
|
+
enc = client.encrypt(key_id=kem_key["id"], plaintext=b"hello quantum-safe world")
|
|
41
|
+
plaintext = client.decrypt(**enc)
|
|
42
|
+
print("Round-trip OK:", plaintext == b"hello quantum-safe world")
|
|
43
|
+
|
|
44
|
+
print("\n== Signatures ==")
|
|
45
|
+
sig_key = client.create_key(purpose="signature", label="quickstart-sig")
|
|
46
|
+
signed = client.sign(key_id=sig_key["id"], message=b"order-42-confirmed")
|
|
47
|
+
valid = client.verify(
|
|
48
|
+
key_id=sig_key["id"], message=b"order-42-confirmed", signature=signed["signature"]
|
|
49
|
+
)
|
|
50
|
+
print("Signature valid:", valid)
|
|
51
|
+
|
|
52
|
+
print("\n== AI security analysis ==")
|
|
53
|
+
report = client.analyze(
|
|
54
|
+
context={
|
|
55
|
+
"algorithms_in_use": ["RSA-2048"],
|
|
56
|
+
"key_ages_days": [400, 20],
|
|
57
|
+
"key_reuse_count": 3,
|
|
58
|
+
}
|
|
59
|
+
)
|
|
60
|
+
print("Summary:", report["summary"])
|
|
61
|
+
for finding in report["findings"]:
|
|
62
|
+
print(f" [{finding['severity']}] {finding['rule_id']}: {finding['title']}")
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
if __name__ == "__main__":
|
|
66
|
+
main()
|