mobintel-probe-encryption 0.1.0__tar.gz

mobintel_probe_encryption-0.1.0/LICENSE

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

mobintel_probe_encryption-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+graft tests
+global-exclude __pycache__ *.py[cod]

mobintel_probe_encryption-0.1.0/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.4
+Name: mobintel-probe-encryption
+Version: 0.1.0
+Summary: Encrypted, unlinkable Wi-Fi probe-request beacons for MobIntel Guardian: decode them on a sensor, seal Bluetooth alerts back
+Author-email: Stepan Mazokha <smazokha2016@fau.edu>
+License-Expression: Apache-2.0
+Keywords: mobintel,probe,encryption
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: System :: Networking
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography>=3.3
+Provides-Extra: test
+Requires-Dist: pytest>=6; extra == "test"
+Requires-Dist: scapy; extra == "test"
+Dynamic: license-file
+
+# mobintel-probe-encryption
+
+Encrypted, unlinkable Wi-Fi beacons for the MobIntel Guardian pedestrian device, and the code a
+roadside sensor needs to read them.
+
+Once a second, a Guardian device broadcasts a Wi-Fi probe request carrying its id, its GPS position
+and the time, encrypted with a key that only the device and the enrolled sensors hold. Its source
+address and every other field change with each probe, so an outsider cannot tell that two probes
+came from the same device. This package is the one implementation of that format: the device runs
+`protocol.py` itself, and sensors use the rest of the package to
+
+- **read probes:** pick a Guardian device's probes out of everything a receiver captures, decrypt
+  them, and judge whether each one is current;
+- **send alerts:** seal a Bluetooth LE alert so that only the addressed device can open it.
+
+It does not capture frames or transmit advertisements (bring your own monitor interface and Bluetooth
+stack), and it does not make keys.
+
+## Install
+
+```bash
+pip install mobintel-probe-encryption
+```
+
+Python 3.9 or newer. The only dependency is `cryptography` (3.3 or newer).
+
+## Keys
+
+The decoder needs the enrolled devices' keys in a JSON file, `{"<device id>": "<64 hex characters>",
+...}`. Each is the same key the device holds (there is no public/private pair), so anyone with the
+file can read every listed device's position, pretend to be one of them, and send them alerts. Keep
+it out of version control and readable by its owner only; the library warns when other users can
+read it.
+
+## Reading probes
+
+```python
+from mobintel_probe_encryption import KeyStore, ProbeDecoder
+
+decoder = ProbeDecoder(KeyStore.from_file("/path/to/enrolled.json"))
+
+reading = decoder.decode_radiotap(frame)   # bytes: radiotap header + 802.11 frame (+ FCS)
+if reading is not None and reading.usable:
+    print(reading.device_id, reading.lat, reading.lon, reading.rssi_dbm)
+```
+
+`decode_radiotap` takes the bytes exactly as a monitor-mode capture delivers them: the radiotap
+header (signal strength, channel, and whether the frame's checksum is attached) followed by the
+802.11 frame. When decoding a recording, pass the capture time as `now` (unix seconds). Other
+inputs: `decode_80211(frame, has_fcs=...)` for a frame without radiotap, and
+`decode(source_mac, vendor_element)` when the frame is already taken apart. Each returns `None`
+unless the frame is a probe request from an enrolled device.
+
+A `Reading` has `device_id`, `lat`, `lon`, `timestamp` (the device's clock), `age_s` (receiver time
+minus that), `rssi_dbm`, `source_mac`, and `status`:
+
+| status | meaning | `usable` |
+|---|---|---|
+| `fresh` | a new message from the device | yes |
+| `duplicate` | another copy of a message received within the last 2 s, e.g. by a second receiver | yes |
+| `replay` | a message received before and sent again later, or older than one already accepted | no |
+| `stale` | its time is more than 120 s from the receiver's clock (a wrong clock, or an old recording) | no |
+
+The source address changes with every probe, so `device_id` is the only stable identity. A decoder
+is safe to share between threads. `decoder.stats` counts frames, probe requests, elements of a
+Guardian probe's length ("candidates") and recognised probes; candidates without recognised probes
+while a device is nearby mean its key is missing from the file.
+
+## Sending alerts
+
+```python
+from mobintel_probe_encryption import ALERT_COMPANY_ID, AlertSealer, advertising_data
+
+payload = AlertSealer(keys).seal(device_id=10, danger_level=7, message="CAR LEFT")
+# BlueZ: advertise ManufacturerData {ALERT_COMPANY_ID: payload}.
+# Raw HCI: advertising_data(payload) is the complete advertising data (up to 31 bytes).
+```
+
+`danger_level` is 1 to 10 (the device buzzes that many times) and the message at most 8 ASCII
+characters; anything else raises `ValueError` rather than being cut or changed.
+
+## Wire format (version 1)
+
+Every device has a 256-bit master key. HKDF-SHA256 derives one key per job from it: `guardian-aead-v1`
+(probe encryption), `guardian-mac-v1` (the source address) and `guardian-alert-v1` (alerts).
+
+**Probe.** Plaintext, 17 bytes, big-endian: version (1) · device id (uint32) · latitude and longitude
+(int32, microdegrees) · timestamp (uint32, unix seconds). It travels in a vendor-specific element
+(ID 221) of 48 bytes: a random 3-byte OUI · a random 12-byte nonce · the ChaCha20-Poly1305
+ciphertext and 16-byte tag (associated data `guardian-probe-v1`). The source address is the first 6
+bytes of HMAC-SHA256(address key, nonce), marked locally administered and unicast. A receiver
+recomputes that address for each enrolled key to recognise the device, then decrypts.
+
+**Alert.** Manufacturer-specific data, company id 0xFFFF: a 6-byte nonce · the ChaCha20 ciphertext
+of device id (uint32) · danger level (uint8) · message (0–8 ASCII) · the first 8 bytes of the
+Poly1305 tag (RFC 8439 construction, associated data `guardian-alert-v1`). It fits one 31-byte
+Bluetooth LE legacy advertisement.
+
+## Development
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+`tests/vectors.json` holds probes and alerts recorded from the code running on deployed devices.
+If a change to `protocol.py` alters those bytes, devices and sensors no longer understand each
+other: that is a new major version and a device update, not a fix.
+
+Releasing: raise `__version__` in `src/mobintel_probe_encryption/__init__.py`, then push a tag
+`v<version>`. The GitHub workflow runs the tests (Python 3.9 with cryptography 3.3.2, as on the
+device, up to Python 3.13), builds the package, and publishes it to PyPI through trusted publishing,
+so no upload token is stored anywhere.
+
+## Author
+
+Stepan Mazokha (smazokha2016@fau.edu), I-SENSE, Florida Atlantic University.
+
+## License
+
+Apache License 2.0; see [LICENSE](LICENSE).

mobintel_probe_encryption-0.1.0/README.md

@@ -0,0 +1,121 @@
+# mobintel-probe-encryption
+
+Encrypted, unlinkable Wi-Fi beacons for the MobIntel Guardian pedestrian device, and the code a
+roadside sensor needs to read them.
+
+Once a second, a Guardian device broadcasts a Wi-Fi probe request carrying its id, its GPS position
+and the time, encrypted with a key that only the device and the enrolled sensors hold. Its source
+address and every other field change with each probe, so an outsider cannot tell that two probes
+came from the same device. This package is the one implementation of that format: the device runs
+`protocol.py` itself, and sensors use the rest of the package to
+
+- **read probes:** pick a Guardian device's probes out of everything a receiver captures, decrypt
+  them, and judge whether each one is current;
+- **send alerts:** seal a Bluetooth LE alert so that only the addressed device can open it.
+
+It does not capture frames or transmit advertisements (bring your own monitor interface and Bluetooth
+stack), and it does not make keys.
+
+## Install
+
+```bash
+pip install mobintel-probe-encryption
+```
+
+Python 3.9 or newer. The only dependency is `cryptography` (3.3 or newer).
+
+## Keys
+
+The decoder needs the enrolled devices' keys in a JSON file, `{"<device id>": "<64 hex characters>",
+...}`. Each is the same key the device holds (there is no public/private pair), so anyone with the
+file can read every listed device's position, pretend to be one of them, and send them alerts. Keep
+it out of version control and readable by its owner only; the library warns when other users can
+read it.
+
+## Reading probes
+
+```python
+from mobintel_probe_encryption import KeyStore, ProbeDecoder
+
+decoder = ProbeDecoder(KeyStore.from_file("/path/to/enrolled.json"))
+
+reading = decoder.decode_radiotap(frame)   # bytes: radiotap header + 802.11 frame (+ FCS)
+if reading is not None and reading.usable:
+    print(reading.device_id, reading.lat, reading.lon, reading.rssi_dbm)
+```
+
+`decode_radiotap` takes the bytes exactly as a monitor-mode capture delivers them: the radiotap
+header (signal strength, channel, and whether the frame's checksum is attached) followed by the
+802.11 frame. When decoding a recording, pass the capture time as `now` (unix seconds). Other
+inputs: `decode_80211(frame, has_fcs=...)` for a frame without radiotap, and
+`decode(source_mac, vendor_element)` when the frame is already taken apart. Each returns `None`
+unless the frame is a probe request from an enrolled device.
+
+A `Reading` has `device_id`, `lat`, `lon`, `timestamp` (the device's clock), `age_s` (receiver time
+minus that), `rssi_dbm`, `source_mac`, and `status`:
+
+| status | meaning | `usable` |
+|---|---|---|
+| `fresh` | a new message from the device | yes |
+| `duplicate` | another copy of a message received within the last 2 s, e.g. by a second receiver | yes |
+| `replay` | a message received before and sent again later, or older than one already accepted | no |
+| `stale` | its time is more than 120 s from the receiver's clock (a wrong clock, or an old recording) | no |
+
+The source address changes with every probe, so `device_id` is the only stable identity. A decoder
+is safe to share between threads. `decoder.stats` counts frames, probe requests, elements of a
+Guardian probe's length ("candidates") and recognised probes; candidates without recognised probes
+while a device is nearby mean its key is missing from the file.
+
+## Sending alerts
+
+```python
+from mobintel_probe_encryption import ALERT_COMPANY_ID, AlertSealer, advertising_data
+
+payload = AlertSealer(keys).seal(device_id=10, danger_level=7, message="CAR LEFT")
+# BlueZ: advertise ManufacturerData {ALERT_COMPANY_ID: payload}.
+# Raw HCI: advertising_data(payload) is the complete advertising data (up to 31 bytes).
+```
+
+`danger_level` is 1 to 10 (the device buzzes that many times) and the message at most 8 ASCII
+characters; anything else raises `ValueError` rather than being cut or changed.
+
+## Wire format (version 1)
+
+Every device has a 256-bit master key. HKDF-SHA256 derives one key per job from it: `guardian-aead-v1`
+(probe encryption), `guardian-mac-v1` (the source address) and `guardian-alert-v1` (alerts).
+
+**Probe.** Plaintext, 17 bytes, big-endian: version (1) · device id (uint32) · latitude and longitude
+(int32, microdegrees) · timestamp (uint32, unix seconds). It travels in a vendor-specific element
+(ID 221) of 48 bytes: a random 3-byte OUI · a random 12-byte nonce · the ChaCha20-Poly1305
+ciphertext and 16-byte tag (associated data `guardian-probe-v1`). The source address is the first 6
+bytes of HMAC-SHA256(address key, nonce), marked locally administered and unicast. A receiver
+recomputes that address for each enrolled key to recognise the device, then decrypts.
+
+**Alert.** Manufacturer-specific data, company id 0xFFFF: a 6-byte nonce · the ChaCha20 ciphertext
+of device id (uint32) · danger level (uint8) · message (0–8 ASCII) · the first 8 bytes of the
+Poly1305 tag (RFC 8439 construction, associated data `guardian-alert-v1`). It fits one 31-byte
+Bluetooth LE legacy advertisement.
+
+## Development
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+`tests/vectors.json` holds probes and alerts recorded from the code running on deployed devices.
+If a change to `protocol.py` alters those bytes, devices and sensors no longer understand each
+other: that is a new major version and a device update, not a fix.
+
+Releasing: raise `__version__` in `src/mobintel_probe_encryption/__init__.py`, then push a tag
+`v<version>`. The GitHub workflow runs the tests (Python 3.9 with cryptography 3.3.2, as on the
+device, up to Python 3.13), builds the package, and publishes it to PyPI through trusted publishing,
+so no upload token is stored anywhere.
+
+## Author
+
+Stepan Mazokha (smazokha2016@fau.edu), I-SENSE, Florida Atlantic University.
+
+## License
+
+Apache License 2.0; see [LICENSE](LICENSE).

mobintel_probe_encryption-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=77.0.3"]   # 77.0.3: the license / license-files fields below
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mobintel-probe-encryption"
+dynamic = ["version"]
+description = "Encrypted, unlinkable Wi-Fi probe-request beacons for MobIntel Guardian: decode them on a sensor, seal Bluetooth alerts back"
+readme = "README.md"
+authors = [{ name = "Stepan Mazokha", email = "smazokha2016@fau.edu" }]
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+# 3.9 = the Guardian device (Raspberry Pi OS Bullseye), which runs protocol.py itself.
+requires-python = ">=3.9"
+# 3.3 = the oldest version on a deployed device (its Debian package).
+dependencies = ["cryptography>=3.3"]
+keywords = ["mobintel", "probe", "encryption"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Security :: Cryptography",
+    "Topic :: System :: Networking",
+    "Typing :: Typed",
+]
+
+[project.optional-dependencies]
+test = ["pytest>=6", "scapy"]
+
+[tool.setuptools.dynamic]
+version = { attr = "mobintel_probe_encryption.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+mobintel_probe_encryption = ["py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

mobintel_probe_encryption-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mobintel_probe_encryption-0.1.0/src/mobintel_probe_encryption/__init__.py

@@ -0,0 +1,26 @@
+"""mobintel_probe_encryption: the receiving side of the MobIntel Guardian beacon protocol, and the one
+copy of its wire format (``mobintel_probe_encryption.protocol``, which the device runs too).
+
+    from mobintel_probe_encryption import KeyStore, ProbeDecoder
+
+    decoder = ProbeDecoder(KeyStore.from_file("enrolled.json"))
+    reading = decoder.decode_radiotap(frame)        # radiotap + 802.11 bytes, as captured
+    if reading is not None and reading.usable:
+        print(reading.device_id, reading.lat, reading.lon)
+
+Alerts back to a device: ``AlertSealer(keys).seal(device_id, danger_level, message)``.
+"""
+from .alerts import AlertSealer, advertising_data
+from .decoder import DUPLICATE, FRESH, REPLAY, STALE, ProbeDecoder, Reading
+from .frames import FrameError, ProbeRequest, parse_80211_frame, parse_radiotap_frame
+from .keys import KeyFileWarning, KeyStore
+from .protocol import ALERT_COMPANY_ID, ALERT_MSG_MAX
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "KeyStore", "KeyFileWarning",
+    "ProbeDecoder", "Reading", "FRESH", "DUPLICATE", "REPLAY", "STALE",
+    "ProbeRequest", "FrameError", "parse_radiotap_frame", "parse_80211_frame",
+    "AlertSealer", "advertising_data", "ALERT_COMPANY_ID", "ALERT_MSG_MAX",
+]

mobintel_probe_encryption-0.1.0/src/mobintel_probe_encryption/alerts.py

@@ -0,0 +1,51 @@
+"""Seal Bluetooth alerts for enrolled devices (the sensor -> device direction).
+
+An alert travels as manufacturer-specific data in a Bluetooth LE legacy advertisement: company id
+ALERT_COMPANY_ID, then the sealed payload. Only the addressed device can open it, because it is
+sealed with that device's key. Sending the advertisement is the caller's job (BlueZ over D-Bus, raw
+HCI, ...).
+"""
+from __future__ import annotations
+
+import struct
+
+from . import protocol
+from .keys import KeyStore
+
+__all__ = ["AlertSealer", "advertising_data"]
+
+_LEGACY_ADVERT_MAX = 31   # bytes of advertising data in a Bluetooth LE legacy advertisement
+
+
+class AlertSealer:
+    def __init__(self, keys: KeyStore):
+        self.keys = keys
+
+    def seal(self, device_id: int, danger_level: int, message: str = "") -> bytes:
+        """The alert's manufacturer-specific data (what follows the company id).
+
+        danger_level 1..10 (the device buzzes that many times); message up to ALERT_MSG_MAX ASCII
+        characters. Raises ValueError rather than cut or alter a message, KeyError for a device
+        that is not enrolled. Every call uses a fresh nonce, so a re-sent alert counts again.
+        """
+        try:
+            encoded = message.encode("ascii")
+        except UnicodeEncodeError:
+            raise ValueError("message must be ASCII") from None
+        if len(encoded) > protocol.ALERT_MSG_MAX:
+            raise ValueError(f"message is {len(encoded)} characters; at most "
+                             f"{protocol.ALERT_MSG_MAX} fit in an advertisement")
+        return protocol.seal_alert(self.keys.master_key(device_id), device_id, danger_level, message)
+
+
+def advertising_data(payload: bytes) -> bytes:
+    """A sealed payload as one advertising data structure (length, type 0xFF, company id, payload),
+    for senders that build the advertisement themselves. It already uses all 31 bytes with an
+    8-character message, so a Flags structure does not fit beside it (none is needed for a
+    non-connectable broadcast)."""
+    body = struct.pack("<H", protocol.ALERT_COMPANY_ID) + payload
+    data = bytes([len(body) + 1, 0xFF]) + body
+    if len(data) > _LEGACY_ADVERT_MAX:
+        raise ValueError(f"{len(data)} bytes of advertising data; a legacy advertisement "
+                         f"holds {_LEGACY_ADVERT_MAX}")
+    return data