celatim 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.
Files changed (149) hide show
  1. celatim-0.1.0/LICENSE +202 -0
  2. celatim-0.1.0/PKG-INFO +265 -0
  3. celatim-0.1.0/README.md +229 -0
  4. celatim-0.1.0/pyproject.toml +131 -0
  5. celatim-0.1.0/src/celatim/__init__.py +693 -0
  6. celatim-0.1.0/src/celatim/adapter.py +889 -0
  7. celatim-0.1.0/src/celatim/analysis/__init__.py +41 -0
  8. celatim-0.1.0/src/celatim/analysis/crosshost_evidence.py +525 -0
  9. celatim-0.1.0/src/celatim/analysis/crosshost_metrics.py +235 -0
  10. celatim-0.1.0/src/celatim/analysis/dataset.py +182 -0
  11. celatim-0.1.0/src/celatim/analysis/subliminal_controls.py +218 -0
  12. celatim-0.1.0/src/celatim/api.py +1395 -0
  13. celatim-0.1.0/src/celatim/assurance/__init__.py +35 -0
  14. celatim-0.1.0/src/celatim/assurance/requirements.py +213 -0
  15. celatim-0.1.0/src/celatim/assurance/scorecard.py +342 -0
  16. celatim-0.1.0/src/celatim/catalog.py +92 -0
  17. celatim-0.1.0/src/celatim/channel/__init__.py +31 -0
  18. celatim-0.1.0/src/celatim/channel/bits.py +60 -0
  19. celatim-0.1.0/src/celatim/channel/codec.py +90 -0
  20. celatim-0.1.0/src/celatim/channel/driver.py +53 -0
  21. celatim-0.1.0/src/celatim/channel/framer.py +80 -0
  22. celatim-0.1.0/src/celatim/channel/registry.py +59 -0
  23. celatim-0.1.0/src/celatim/cli.py +2269 -0
  24. celatim-0.1.0/src/celatim/cli_endpoints.py +1535 -0
  25. celatim-0.1.0/src/celatim/crypto_transcript.py +1198 -0
  26. celatim-0.1.0/src/celatim/data/__init__.py +1 -0
  27. celatim-0.1.0/src/celatim/data/mechanisms.jsonl +165 -0
  28. celatim-0.1.0/src/celatim/data/protocol_rates.toml +57 -0
  29. celatim-0.1.0/src/celatim/detect/__init__.py +90 -0
  30. celatim-0.1.0/src/celatim/detect/replay.py +996 -0
  31. celatim-0.1.0/src/celatim/detect/rules.py +609 -0
  32. celatim-0.1.0/src/celatim/detect/scrub.py +309 -0
  33. celatim-0.1.0/src/celatim/detect/stateful.py +176 -0
  34. celatim-0.1.0/src/celatim/discovery.py +267 -0
  35. celatim-0.1.0/src/celatim/docs/__init__.py +1 -0
  36. celatim-0.1.0/src/celatim/docs/api-guide.md +558 -0
  37. celatim-0.1.0/src/celatim/docs/reviewer-quickstart.md +297 -0
  38. celatim-0.1.0/src/celatim/docs/scenario-authoring.md +119 -0
  39. celatim-0.1.0/src/celatim/docs/troubleshooting.md +117 -0
  40. celatim-0.1.0/src/celatim/doctor.py +714 -0
  41. celatim-0.1.0/src/celatim/envelope.py +155 -0
  42. celatim-0.1.0/src/celatim/errors.py +52 -0
  43. celatim-0.1.0/src/celatim/evidence.py +263 -0
  44. celatim-0.1.0/src/celatim/evidence_index.py +907 -0
  45. celatim-0.1.0/src/celatim/inspection.py +264 -0
  46. celatim-0.1.0/src/celatim/layout/__init__.py +5 -0
  47. celatim-0.1.0/src/celatim/layout/loader.py +30 -0
  48. celatim-0.1.0/src/celatim/metrics/__init__.py +46 -0
  49. celatim-0.1.0/src/celatim/metrics/storage.py +44 -0
  50. celatim-0.1.0/src/celatim/metrics/subliminal.py +132 -0
  51. celatim-0.1.0/src/celatim/metrics/timing.py +142 -0
  52. celatim-0.1.0/src/celatim/model.py +407 -0
  53. celatim-0.1.0/src/celatim/observer.py +638 -0
  54. celatim-0.1.0/src/celatim/pcap_decode.py +282 -0
  55. celatim-0.1.0/src/celatim/pdu/__init__.py +87 -0
  56. celatim-0.1.0/src/celatim/pdu/bgp_attr.py +54 -0
  57. celatim-0.1.0/src/celatim/pdu/bitfield.py +63 -0
  58. celatim-0.1.0/src/celatim/pdu/coap_msg.py +53 -0
  59. celatim-0.1.0/src/celatim/pdu/dns_txt.py +136 -0
  60. celatim-0.1.0/src/celatim/pdu/format_carriers.py +170 -0
  61. celatim-0.1.0/src/celatim/pdu/http2.py +84 -0
  62. celatim-0.1.0/src/celatim/pdu/http2_fields.py +120 -0
  63. celatim-0.1.0/src/celatim/pdu/minimal_pdu.py +151 -0
  64. celatim-0.1.0/src/celatim/pdu/quic.py +107 -0
  65. celatim-0.1.0/src/celatim/pdu/quic_fields.py +157 -0
  66. celatim-0.1.0/src/celatim/pdu/rtcp.py +91 -0
  67. celatim-0.1.0/src/celatim/pdu/scapy_field.py +92 -0
  68. celatim-0.1.0/src/celatim/pdu/scapy_pdu.py +440 -0
  69. celatim-0.1.0/src/celatim/pdu/ssh_kex.py +85 -0
  70. celatim-0.1.0/src/celatim/pdu/struct_fields.py +402 -0
  71. celatim-0.1.0/src/celatim/pdu/tcp.py +101 -0
  72. celatim-0.1.0/src/celatim/pdu/tls_fields.py +144 -0
  73. celatim-0.1.0/src/celatim/pdu/ws_frame.py +59 -0
  74. celatim-0.1.0/src/celatim/py.typed +0 -0
  75. celatim-0.1.0/src/celatim/report/__init__.py +117 -0
  76. celatim-0.1.0/src/celatim/report/detector_rules.py +448 -0
  77. celatim-0.1.0/src/celatim/report/figures.py +439 -0
  78. celatim-0.1.0/src/celatim/report/guidance.py +134 -0
  79. celatim-0.1.0/src/celatim/report/macros.py +234 -0
  80. celatim-0.1.0/src/celatim/report/protocol_rates.py +189 -0
  81. celatim-0.1.0/src/celatim/report/support_matrix.py +272 -0
  82. celatim-0.1.0/src/celatim/report/tables.py +85 -0
  83. celatim-0.1.0/src/celatim/report/windows_capture.py +92 -0
  84. celatim-0.1.0/src/celatim/resources.py +157 -0
  85. celatim-0.1.0/src/celatim/reviewer_bundle.py +1596 -0
  86. celatim-0.1.0/src/celatim/scenario.py +2301 -0
  87. celatim-0.1.0/src/celatim/scenarios/__init__.py +1 -0
  88. celatim-0.1.0/src/celatim/scenarios/http2-ping-opaque.toml +15 -0
  89. celatim-0.1.0/src/celatim/scenarios/quic-connection-id.toml +15 -0
  90. celatim-0.1.0/src/celatim/scenarios/rtp-rtcp-ext-app.toml +15 -0
  91. celatim-0.1.0/src/celatim/scenarios/subliminal-ctrl/zzz-ecdsa-nonce-128ctrl.toml +19 -0
  92. celatim-0.1.0/src/celatim/scenarios/subliminal-ctrl/zzz-rsa-pss-salt-128ctrl.toml +21 -0
  93. celatim-0.1.0/src/celatim/scenarios/tcp-reserved-bits.toml +15 -0
  94. celatim-0.1.0/src/celatim/scenarios/z-edns0-padding-dnsmasq-dig.toml +30 -0
  95. celatim-0.1.0/src/celatim/scenarios/z-http2-ping-opaque-hyper-h2.toml +20 -0
  96. celatim-0.1.0/src/celatim/scenarios/z-http3-reserved-settings-aioquic.toml +20 -0
  97. celatim-0.1.0/src/celatim/scenarios/z-quic-connection-id-aioquic.toml +20 -0
  98. celatim-0.1.0/src/celatim/scenarios/z-tcp-reserved-bits-afpacket.toml +34 -0
  99. celatim-0.1.0/src/celatim/scenarios/zz-ecdsa-nonce-local.toml +19 -0
  100. celatim-0.1.0/src/celatim/scenarios/zz-rsa-pss-salt-local.toml +21 -0
  101. celatim-0.1.0/src/celatim/scenarios/zzz-bgp-scapy.toml +14 -0
  102. celatim-0.1.0/src/celatim/scenarios/zzz-coap-aiocoap.toml +14 -0
  103. celatim-0.1.0/src/celatim/scenarios/zzz-dns-null-dnspython.toml +15 -0
  104. celatim-0.1.0/src/celatim/scenarios/zzz-dns-txt-dnspython.toml +15 -0
  105. celatim-0.1.0/src/celatim/scenarios/zzz-ssh-kexinit-paramiko.toml +14 -0
  106. celatim-0.1.0/src/celatim/scenarios/zzz-websocket-websockets.toml +14 -0
  107. celatim-0.1.0/src/celatim/schemas/__init__.py +1 -0
  108. celatim-0.1.0/src/celatim/schemas/detector-replay-corpus-v1.schema.json +154 -0
  109. celatim-0.1.0/src/celatim/schemas/detector-replay-v1.schema.json +194 -0
  110. celatim-0.1.0/src/celatim/schemas/detector-trace-manifest-v1.schema.json +48 -0
  111. celatim-0.1.0/src/celatim/schemas/doctor-v1.schema.json +40 -0
  112. celatim-0.1.0/src/celatim/schemas/evidence-index-v1.schema.json +301 -0
  113. celatim-0.1.0/src/celatim/schemas/evidence-run-v1.schema.json +947 -0
  114. celatim-0.1.0/src/celatim/schemas/pcap-decode-v1.schema.json +68 -0
  115. celatim-0.1.0/src/celatim/schemas/public-bundle-v1.schema.json +103 -0
  116. celatim-0.1.0/src/celatim/schemas/public-bundle-verify-v1.schema.json +99 -0
  117. celatim-0.1.0/src/celatim/schemas/public-evidence-index-v1.schema.json +256 -0
  118. celatim-0.1.0/src/celatim/schemas/qemu-tap-preflight-v1.schema.json +145 -0
  119. celatim-0.1.0/src/celatim/schemas/reviewer-bundle-v1.schema.json +89 -0
  120. celatim-0.1.0/src/celatim/schemas/reviewer-bundle-verify-v1.schema.json +99 -0
  121. celatim-0.1.0/src/celatim/schemas/scenario-execution-plan-v1.schema.json +120 -0
  122. celatim-0.1.0/src/celatim/schemas/scenario-inventory-v1.schema.json +83 -0
  123. celatim-0.1.0/src/celatim/schemas/scenario-v1.schema.json +146 -0
  124. celatim-0.1.0/src/celatim/schemas/scrub-report-v1.schema.json +56 -0
  125. celatim-0.1.0/src/celatim/schemas/support-matrix-v1.schema.json +216 -0
  126. celatim-0.1.0/src/celatim/schemas/testbed-requirements-v1.schema.json +108 -0
  127. celatim-0.1.0/src/celatim/schemas/timing-sweep-v1.schema.json +194 -0
  128. celatim-0.1.0/src/celatim/session.py +1408 -0
  129. celatim-0.1.0/src/celatim/testbed/__init__.py +215 -0
  130. celatim-0.1.0/src/celatim/testbed/afpacket.py +186 -0
  131. celatim-0.1.0/src/celatim/testbed/bgp_message.py +63 -0
  132. celatim-0.1.0/src/celatim/testbed/coap_message.py +63 -0
  133. celatim-0.1.0/src/celatim/testbed/commands.py +62 -0
  134. celatim-0.1.0/src/celatim/testbed/daemon.py +292 -0
  135. celatim-0.1.0/src/celatim/testbed/dns.py +659 -0
  136. celatim-0.1.0/src/celatim/testbed/dns_message.py +109 -0
  137. celatim-0.1.0/src/celatim/testbed/h3.py +346 -0
  138. celatim-0.1.0/src/celatim/testbed/http2.py +298 -0
  139. celatim-0.1.0/src/celatim/testbed/message_carrier.py +180 -0
  140. celatim-0.1.0/src/celatim/testbed/netns.py +193 -0
  141. celatim-0.1.0/src/celatim/testbed/packet_path.py +640 -0
  142. celatim-0.1.0/src/celatim/testbed/qemu.py +499 -0
  143. celatim-0.1.0/src/celatim/testbed/quic.py +318 -0
  144. celatim-0.1.0/src/celatim/testbed/requirements.py +215 -0
  145. celatim-0.1.0/src/celatim/testbed/ssh_message.py +69 -0
  146. celatim-0.1.0/src/celatim/testbed/tcpdump.py +143 -0
  147. celatim-0.1.0/src/celatim/testbed/ws_message.py +63 -0
  148. celatim-0.1.0/src/celatim/timing_sweep.py +494 -0
  149. celatim-0.1.0/src/celatim/transports.py +547 -0
celatim-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 [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.
celatim-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,265 @@
1
+ Metadata-Version: 2.4
2
+ Name: celatim
3
+ Version: 0.1.0
4
+ Summary: Typed covert-channel research, measurement, and endpoint tooling for IETF protocol fields.
5
+ Keywords: covert-channels,network-measurement,network-protocols,privacy,steganography
6
+ Author: Michael Bommarito
7
+ Author-email: Michael Bommarito <michael.bommarito@gmail.com>
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: Science/Research
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.14
14
+ Classifier: Typing :: Typed
15
+ Requires-Dist: cryptography>=46.0.3 ; extra == 'crypto'
16
+ Requires-Dist: aioquic>=1.3.0 ; extra == 'daemon'
17
+ Requires-Dist: h2>=4.3.0 ; extra == 'daemon'
18
+ Requires-Dist: dnspython>=2.8.0 ; extra == 'dns'
19
+ Requires-Dist: aiocoap>=0.4.12 ; extra == 'iot'
20
+ Requires-Dist: paho-mqtt>=2.1.0 ; extra == 'iot'
21
+ Requires-Dist: scapy>=2.6.1 ; extra == 'packet'
22
+ Requires-Dist: websockets>=13.0 ; extra == 'realtime'
23
+ Requires-Dist: paramiko>=3.5.0 ; extra == 'ssh'
24
+ Requires-Python: >=3.14
25
+ Project-URL: Homepage, https://github.com/mjbommar/celatim
26
+ Project-URL: Issues, https://github.com/mjbommar/celatim/issues
27
+ Project-URL: Repository, https://github.com/mjbommar/celatim.git
28
+ Provides-Extra: crypto
29
+ Provides-Extra: daemon
30
+ Provides-Extra: dns
31
+ Provides-Extra: iot
32
+ Provides-Extra: packet
33
+ Provides-Extra: realtime
34
+ Provides-Extra: ssh
35
+ Description-Content-Type: text/markdown
36
+
37
+ # Celatim
38
+
39
+ Celatim is a typed Python 3.14+ toolkit for reproducible research on covert channels
40
+ and steganographic carriers in IETF protocol fields. It provides channel codecs,
41
+ protocol data-unit implementations, controlled endpoint transports, structural capacity
42
+ models, detector and scrub guidance, scenario execution, and evidence artifacts from one
43
+ distribution and one import namespace.
44
+
45
+ The project accompanies a survey and measurement paper. Its channel and defensive
46
+ implementations are published together so researchers can reproduce the measurements,
47
+ inspect assumptions, and evaluate both communication and normalization behavior.
48
+
49
+ Use Celatim only in controlled environments and on systems and networks you are
50
+ authorized to test.
51
+
52
+ ## Requirements
53
+
54
+ - CPython 3.14 or newer.
55
+ - Linux for AF_PACKET, network-namespace, tcpdump, and QEMU/TAP workflows.
56
+ - No optional protocol stack is imported by the base package.
57
+
58
+ ## Installation
59
+
60
+ ```bash
61
+ python -m pip install celatim
62
+ celatim --help
63
+ ```
64
+
65
+ The wheel installs one primary command, `celatim`, plus four deterministic report
66
+ generators from the same codebase:
67
+
68
+ - `celatim-paper-figures`
69
+ - `celatim-paper-macros`
70
+ - `celatim-paper-tables`
71
+ - `celatim-support-matrix`
72
+
73
+ ## Install profiles
74
+
75
+ Optional dependencies are grouped by capability:
76
+
77
+ | Extra | Capability |
78
+ |---|---|
79
+ | `celatim[packet]` | Scapy packet construction, parsing, and pcap integration |
80
+ | `celatim[crypto]` | ECDSA and RSA-PSS transcript experiments |
81
+ | `celatim[daemon]` | hyper-h2 and aioquic production-stack paths |
82
+ | `celatim[dns]` | dnspython message paths |
83
+ | `celatim[ssh]` | Paramiko SSH message paths |
84
+ | `celatim[iot]` | aiocoap and paho-mqtt message paths |
85
+ | `celatim[realtime]` | WebSocket message paths |
86
+
87
+ For example:
88
+
89
+ ```bash
90
+ python -m pip install 'celatim[packet,crypto,daemon]'
91
+ ```
92
+
93
+ ## Python API
94
+
95
+ The top-level API covers common endpoint operations and typed results:
96
+
97
+ ```python
98
+ from celatim import PayloadSource, roundtrip_payload
99
+
100
+ result = roundtrip_payload(
101
+ "http2-ping-opaque",
102
+ PayloadSource.hex("00 ff 80 41"),
103
+ )
104
+ assert result.ok
105
+ assert result.payload == b"\x00\xff\x80A"
106
+ ```
107
+
108
+ Mechanism discovery exposes executable transport metadata without importing optional
109
+ stacks:
110
+
111
+ ```python
112
+ from celatim import MechanismProfile
113
+
114
+ profile = MechanismProfile.from_catalog("http2-ping-opaque")
115
+ print([path.kind.value for path in profile.adapter.paths])
116
+ ```
117
+
118
+ The public API also includes scenario discovery, evidence generation, pcap decode and
119
+ scrub helpers, timing sweeps, installation checks, testbed requirements, and packaged
120
+ document/schema inspection. Lower-level codecs, PDU implementations, detector rules,
121
+ and transport classes remain available through focused `celatim.*` submodules.
122
+
123
+ ## Command line
124
+
125
+ Inspect mechanisms and packaged contracts:
126
+
127
+ ```bash
128
+ celatim mechanism list
129
+ celatim mechanism show http2-ping-opaque
130
+ celatim scenario list
131
+ celatim docs list
132
+ celatim schema list
133
+ celatim testbed requirements
134
+ ```
135
+
136
+ Run an in-memory binary-payload round trip:
137
+
138
+ ```bash
139
+ celatim roundtrip \
140
+ --mechanism http2-ping-opaque \
141
+ --hex "00 ff 80 41"
142
+ ```
143
+
144
+ Run a packaged non-privileged pcap scenario and write evidence:
145
+
146
+ ```bash
147
+ celatim scenario run \
148
+ --scenario-id http2-ping-opaque-real-pdu-smoke \
149
+ --artifact-dir out/carriers \
150
+ --pcap-dir out/pcaps \
151
+ --log-dir out/logs \
152
+ --output out/evidence.json
153
+ ```
154
+
155
+ Generate defensive artifacts:
156
+
157
+ ```bash
158
+ celatim detector rules \
159
+ --output-dir out/detector-rules \
160
+ --output out/detector-rules.json
161
+ celatim guidance generate --output out/detector-scrub-guidance.md
162
+ celatim guidance windows-capture --output out/windows-capture-guidance.md
163
+ ```
164
+
165
+ ## Architecture
166
+
167
+ Celatim is one PEP 621 project with one `celatim` package:
168
+
169
+ - `celatim.channel`: bit packing, codecs, framing, and transport-agnostic drivers.
170
+ - `celatim.pdu`: parser-visible protocol data-unit implementations.
171
+ - `celatim.transports`: in-memory, file, pcap, timing, and production-path transports.
172
+ - `celatim.testbed`: netns/veth, AF_PACKET, daemon, tcpdump, and QEMU/TAP helpers.
173
+ - `celatim.detect`: detector predicates, executable replay, and offline scrub support.
174
+ - `celatim.metrics`: separate storage, timing, and subliminal capacity models.
175
+ - `celatim.report`: deterministic tables, figures, matrices, and defensive guidance.
176
+ - `celatim.scenario`: versioned scenario loading and controlled execution.
177
+
178
+ The wheel includes its default catalog, protocol-rate assumptions, JSON Schemas,
179
+ scenario definitions, and operator documentation. CLI defaults resolve those resources
180
+ with `importlib.resources`, so installed commands do not depend on a source checkout.
181
+
182
+ Optional integrations are imported only when their transport is selected. The installed
183
+ package smoke verifies that a base import does not load Scapy, cryptography, aioquic,
184
+ dnspython, Paramiko, aiocoap, paho-mqtt, or WebSockets.
185
+
186
+ ## Evidence boundaries
187
+
188
+ Celatim distinguishes structural capability from executed evidence:
189
+
190
+ - Storage carriers report field width and both header-relative and on-wire density.
191
+ - Timing/count carriers use a separate rate model.
192
+ - Subliminal cryptographic carriers use separate entropy bounds.
193
+ - Evidence records identify the transport, parser validation, controls, endpoint
194
+ topology, artifact hashes, and claim status.
195
+ - Public indexes contain hashes and classifications rather than sensitive payloads,
196
+ transcripts, host paths, or reviewer-only artifacts.
197
+
198
+ Privileged experiments live under `experiments/`. They require explicit operator action
199
+ and do not run during normal installation, import, or non-privileged CI.
200
+
201
+ The chosen-nonce ECDSA transcript path is likewise research-only. It creates a fresh
202
+ ephemeral key for each local transcript, uses `cryptography`/OpenSSL for curve operations
203
+ and verification, and must not be used with production or long-lived signing keys.
204
+
205
+ The companion
206
+ [`rfc-tunnel-survey`](https://github.com/mjbommar/rfc-tunnel-survey) repository vendors
207
+ a manifest-verified snapshot of this project alongside the paper, RFC corpus, generated
208
+ figures, and evidence indexes. This repository is the canonical package and PyPI release
209
+ source.
210
+
211
+ ## Development
212
+
213
+ Install the locked development environment and run every package gate:
214
+
215
+ ```bash
216
+ make ci
217
+ ```
218
+
219
+ That target runs:
220
+
221
+ 1. `uv sync --locked --all-groups`
222
+ 2. `uv lock --check`
223
+ 3. `uv run ruff format --check .`
224
+ 4. `uv run ruff check .`
225
+ 5. `uv run ty check`
226
+ 6. `uv run pytest`
227
+ 7. `scripts/installed_wheel_smoke.py`
228
+ 8. `pip-audit` against every locked development and optional dependency
229
+
230
+ The type gate covers the package, tests, release scripts, and production experiment
231
+ drivers. There are no directory-wide type-check exclusions; optional-stack boundaries
232
+ use their concrete library modules so they remain statically resolvable.
233
+ GitHub runs the same gate on pushes, pull requests, manual dispatches, and a weekly
234
+ schedule so newly published dependency advisories are detected without waiting for a
235
+ source change.
236
+
237
+ The installed-wheel smoke builds an sdist, builds the wheel from that sdist, installs it
238
+ without dependencies into a fresh virtual environment, changes to a directory outside
239
+ the checkout, and exercises all five console entry points plus representative public API
240
+ and binary-payload workflows. After proving the base import does not load optional
241
+ stacks, it installs every wheel-declared extra into the isolated environment, imports
242
+ each integration dependency, and records the resolved versions.
243
+
244
+ Build and validate release distributions with:
245
+
246
+ ```bash
247
+ uv build --out-dir dist
248
+ uvx twine check dist/*
249
+ uvx check-wheel-contents dist/*.whl
250
+ ```
251
+
252
+ ## Release workflow
253
+
254
+ GitHub releases trigger `.github/workflows/release.yml`. The workflow requires a tag
255
+ that exactly matches `v<project.version>`, reruns the full CI and installed-package gate,
256
+ validates wheel metadata and contents, and passes verified artifacts to a separate PyPI
257
+ publishing job.
258
+
259
+ Only that final job receives `id-token: write`, uses the protected `pypi` environment,
260
+ and exchanges GitHub's OIDC identity for a short-lived PyPI credential. No PyPI token is
261
+ stored in the repository. See [`RELEASING.md`](RELEASING.md) for the trusted-publisher
262
+ identity and release procedure.
263
+
264
+ Celatim is licensed under the [Apache License 2.0](LICENSE). Release validation requires
265
+ the exact SPDX expression and packaged license file in the wheel.
@@ -0,0 +1,229 @@
1
+ # Celatim
2
+
3
+ Celatim is a typed Python 3.14+ toolkit for reproducible research on covert channels
4
+ and steganographic carriers in IETF protocol fields. It provides channel codecs,
5
+ protocol data-unit implementations, controlled endpoint transports, structural capacity
6
+ models, detector and scrub guidance, scenario execution, and evidence artifacts from one
7
+ distribution and one import namespace.
8
+
9
+ The project accompanies a survey and measurement paper. Its channel and defensive
10
+ implementations are published together so researchers can reproduce the measurements,
11
+ inspect assumptions, and evaluate both communication and normalization behavior.
12
+
13
+ Use Celatim only in controlled environments and on systems and networks you are
14
+ authorized to test.
15
+
16
+ ## Requirements
17
+
18
+ - CPython 3.14 or newer.
19
+ - Linux for AF_PACKET, network-namespace, tcpdump, and QEMU/TAP workflows.
20
+ - No optional protocol stack is imported by the base package.
21
+
22
+ ## Installation
23
+
24
+ ```bash
25
+ python -m pip install celatim
26
+ celatim --help
27
+ ```
28
+
29
+ The wheel installs one primary command, `celatim`, plus four deterministic report
30
+ generators from the same codebase:
31
+
32
+ - `celatim-paper-figures`
33
+ - `celatim-paper-macros`
34
+ - `celatim-paper-tables`
35
+ - `celatim-support-matrix`
36
+
37
+ ## Install profiles
38
+
39
+ Optional dependencies are grouped by capability:
40
+
41
+ | Extra | Capability |
42
+ |---|---|
43
+ | `celatim[packet]` | Scapy packet construction, parsing, and pcap integration |
44
+ | `celatim[crypto]` | ECDSA and RSA-PSS transcript experiments |
45
+ | `celatim[daemon]` | hyper-h2 and aioquic production-stack paths |
46
+ | `celatim[dns]` | dnspython message paths |
47
+ | `celatim[ssh]` | Paramiko SSH message paths |
48
+ | `celatim[iot]` | aiocoap and paho-mqtt message paths |
49
+ | `celatim[realtime]` | WebSocket message paths |
50
+
51
+ For example:
52
+
53
+ ```bash
54
+ python -m pip install 'celatim[packet,crypto,daemon]'
55
+ ```
56
+
57
+ ## Python API
58
+
59
+ The top-level API covers common endpoint operations and typed results:
60
+
61
+ ```python
62
+ from celatim import PayloadSource, roundtrip_payload
63
+
64
+ result = roundtrip_payload(
65
+ "http2-ping-opaque",
66
+ PayloadSource.hex("00 ff 80 41"),
67
+ )
68
+ assert result.ok
69
+ assert result.payload == b"\x00\xff\x80A"
70
+ ```
71
+
72
+ Mechanism discovery exposes executable transport metadata without importing optional
73
+ stacks:
74
+
75
+ ```python
76
+ from celatim import MechanismProfile
77
+
78
+ profile = MechanismProfile.from_catalog("http2-ping-opaque")
79
+ print([path.kind.value for path in profile.adapter.paths])
80
+ ```
81
+
82
+ The public API also includes scenario discovery, evidence generation, pcap decode and
83
+ scrub helpers, timing sweeps, installation checks, testbed requirements, and packaged
84
+ document/schema inspection. Lower-level codecs, PDU implementations, detector rules,
85
+ and transport classes remain available through focused `celatim.*` submodules.
86
+
87
+ ## Command line
88
+
89
+ Inspect mechanisms and packaged contracts:
90
+
91
+ ```bash
92
+ celatim mechanism list
93
+ celatim mechanism show http2-ping-opaque
94
+ celatim scenario list
95
+ celatim docs list
96
+ celatim schema list
97
+ celatim testbed requirements
98
+ ```
99
+
100
+ Run an in-memory binary-payload round trip:
101
+
102
+ ```bash
103
+ celatim roundtrip \
104
+ --mechanism http2-ping-opaque \
105
+ --hex "00 ff 80 41"
106
+ ```
107
+
108
+ Run a packaged non-privileged pcap scenario and write evidence:
109
+
110
+ ```bash
111
+ celatim scenario run \
112
+ --scenario-id http2-ping-opaque-real-pdu-smoke \
113
+ --artifact-dir out/carriers \
114
+ --pcap-dir out/pcaps \
115
+ --log-dir out/logs \
116
+ --output out/evidence.json
117
+ ```
118
+
119
+ Generate defensive artifacts:
120
+
121
+ ```bash
122
+ celatim detector rules \
123
+ --output-dir out/detector-rules \
124
+ --output out/detector-rules.json
125
+ celatim guidance generate --output out/detector-scrub-guidance.md
126
+ celatim guidance windows-capture --output out/windows-capture-guidance.md
127
+ ```
128
+
129
+ ## Architecture
130
+
131
+ Celatim is one PEP 621 project with one `celatim` package:
132
+
133
+ - `celatim.channel`: bit packing, codecs, framing, and transport-agnostic drivers.
134
+ - `celatim.pdu`: parser-visible protocol data-unit implementations.
135
+ - `celatim.transports`: in-memory, file, pcap, timing, and production-path transports.
136
+ - `celatim.testbed`: netns/veth, AF_PACKET, daemon, tcpdump, and QEMU/TAP helpers.
137
+ - `celatim.detect`: detector predicates, executable replay, and offline scrub support.
138
+ - `celatim.metrics`: separate storage, timing, and subliminal capacity models.
139
+ - `celatim.report`: deterministic tables, figures, matrices, and defensive guidance.
140
+ - `celatim.scenario`: versioned scenario loading and controlled execution.
141
+
142
+ The wheel includes its default catalog, protocol-rate assumptions, JSON Schemas,
143
+ scenario definitions, and operator documentation. CLI defaults resolve those resources
144
+ with `importlib.resources`, so installed commands do not depend on a source checkout.
145
+
146
+ Optional integrations are imported only when their transport is selected. The installed
147
+ package smoke verifies that a base import does not load Scapy, cryptography, aioquic,
148
+ dnspython, Paramiko, aiocoap, paho-mqtt, or WebSockets.
149
+
150
+ ## Evidence boundaries
151
+
152
+ Celatim distinguishes structural capability from executed evidence:
153
+
154
+ - Storage carriers report field width and both header-relative and on-wire density.
155
+ - Timing/count carriers use a separate rate model.
156
+ - Subliminal cryptographic carriers use separate entropy bounds.
157
+ - Evidence records identify the transport, parser validation, controls, endpoint
158
+ topology, artifact hashes, and claim status.
159
+ - Public indexes contain hashes and classifications rather than sensitive payloads,
160
+ transcripts, host paths, or reviewer-only artifacts.
161
+
162
+ Privileged experiments live under `experiments/`. They require explicit operator action
163
+ and do not run during normal installation, import, or non-privileged CI.
164
+
165
+ The chosen-nonce ECDSA transcript path is likewise research-only. It creates a fresh
166
+ ephemeral key for each local transcript, uses `cryptography`/OpenSSL for curve operations
167
+ and verification, and must not be used with production or long-lived signing keys.
168
+
169
+ The companion
170
+ [`rfc-tunnel-survey`](https://github.com/mjbommar/rfc-tunnel-survey) repository vendors
171
+ a manifest-verified snapshot of this project alongside the paper, RFC corpus, generated
172
+ figures, and evidence indexes. This repository is the canonical package and PyPI release
173
+ source.
174
+
175
+ ## Development
176
+
177
+ Install the locked development environment and run every package gate:
178
+
179
+ ```bash
180
+ make ci
181
+ ```
182
+
183
+ That target runs:
184
+
185
+ 1. `uv sync --locked --all-groups`
186
+ 2. `uv lock --check`
187
+ 3. `uv run ruff format --check .`
188
+ 4. `uv run ruff check .`
189
+ 5. `uv run ty check`
190
+ 6. `uv run pytest`
191
+ 7. `scripts/installed_wheel_smoke.py`
192
+ 8. `pip-audit` against every locked development and optional dependency
193
+
194
+ The type gate covers the package, tests, release scripts, and production experiment
195
+ drivers. There are no directory-wide type-check exclusions; optional-stack boundaries
196
+ use their concrete library modules so they remain statically resolvable.
197
+ GitHub runs the same gate on pushes, pull requests, manual dispatches, and a weekly
198
+ schedule so newly published dependency advisories are detected without waiting for a
199
+ source change.
200
+
201
+ The installed-wheel smoke builds an sdist, builds the wheel from that sdist, installs it
202
+ without dependencies into a fresh virtual environment, changes to a directory outside
203
+ the checkout, and exercises all five console entry points plus representative public API
204
+ and binary-payload workflows. After proving the base import does not load optional
205
+ stacks, it installs every wheel-declared extra into the isolated environment, imports
206
+ each integration dependency, and records the resolved versions.
207
+
208
+ Build and validate release distributions with:
209
+
210
+ ```bash
211
+ uv build --out-dir dist
212
+ uvx twine check dist/*
213
+ uvx check-wheel-contents dist/*.whl
214
+ ```
215
+
216
+ ## Release workflow
217
+
218
+ GitHub releases trigger `.github/workflows/release.yml`. The workflow requires a tag
219
+ that exactly matches `v<project.version>`, reruns the full CI and installed-package gate,
220
+ validates wheel metadata and contents, and passes verified artifacts to a separate PyPI
221
+ publishing job.
222
+
223
+ Only that final job receives `id-token: write`, uses the protected `pypi` environment,
224
+ and exchanges GitHub's OIDC identity for a short-lived PyPI credential. No PyPI token is
225
+ stored in the repository. See [`RELEASING.md`](RELEASING.md) for the trusted-publisher
226
+ identity and release procedure.
227
+
228
+ Celatim is licensed under the [Apache License 2.0](LICENSE). Release validation requires
229
+ the exact SPDX expression and packaged license file in the wheel.