Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ All notable changes to this project are documented here. The format follows

## [Unreleased]

## [0.1.2] - 2026-11-02

### Added

- Security and AI documentation in `docs/`: threat model, model card, data
Expand All @@ -31,9 +33,21 @@ All notable changes to this project are documented here. The format follows
- `examples/webhook.md`: alerting on privacy and model-integrity events.
- Fuzz harness also checks the access log's result count and the
`camera_health` privacy fields.
- `docs/SHARED_RESPONSIBILITY.md` with `docs/ssrm-ownership-ai-caiq-v1.1.0.csv`:
who owns each security control (CloudLab Works, you, the model provider),
per CSA AI-CAIQ v1.1.0 question.
- `docs/RISK_ASSESSMENT.md`: AI risk register and AI impact assessment.
- `docs/HARDENING.md` and `examples/hardening/`: run the camera runner as a
dedicated user under a sandboxed systemd unit and the MCP server read-only,
without network or devices; with a container test bed.

### Changed

- Threat model: mitigations mapped to threats and a guardrail review
procedure. Model card: verification steps, provenance, confidence
monitoring and spot-check, bias and fairness.
- SBOM regenerated for 0.1.2 (`docs/SBOM.md`); provenance re-checked.
- README: install from PyPI.
- CI and release workflows install their tools from hash-pinned lists in
`requirements/` (`pip install --require-hashes`), and install or build the
package without build isolation so no unpinned package is fetched.
Expand Down Expand Up @@ -61,7 +75,7 @@ All notable changes to this project are documented here. The format follows
- Repository moved to [cloudlabworks/oak-events](https://github.com/cloudlabworks/oak-events);
the MCP registry name is now `io.github.cloudlabworks/oak-events`. Old
`issaquahd/oak-events` links redirect.
- ~~First release published to PyPI (trusted publishing).~~ Correction 2026-11-02: both release runs on 2026-10-12 failed; the package is not on PyPI yet. Install from source until the next release.
- ~~First release published to PyPI (trusted publishing).~~ Correction 2026-11-02: both release runs on 2026-10-12 failed. 0.1.1 was published to PyPI on 2026-11-02, when its release run was repeated.

## [0.1.0] - 2026-10-11

Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@ Requires DepthAI v3 (`depthai>=3.9`) and Python 3.10+.
## Quickstart

```bash
# Not on PyPI yet: install the v0.1.0 release from GitHub
pip install 'oak-events[camera,mcp] @ git+https://github.com/cloudlabworks/oak-events@v0.1.0'
pip install 'oak-events[camera,mcp]'

# 1. Check the setup (works without a camera or depthai installed)
oak-events doctor
Expand Down Expand Up @@ -206,7 +205,7 @@ explaining why: `not_found`, `error`, `pipeline_stopped`.
- [Data flow, retention and privacy impact](docs/DATA_FLOW.md): what leaves
the camera, what is stored, retention and redaction.
- [Software bill of materials](docs/SBOM.md): CycloneDX SBOM and licence
summary for 0.1.1.
summary for 0.1.2.
- [Shared responsibility](docs/SHARED_RESPONSIBILITY.md): who owns which
security control (CloudLab Works, you, the model provider), per AI-CAIQ
question.
Expand Down
8 changes: 6 additions & 2 deletions docs/SBOM.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,21 @@
| | |
| --- | --- |
| Owner | Alex Alvord, CloudLab Works |
| Current SBOM | `sbom-oak-events-0.1.1-00d9053.cdx.json` (CycloneDX 1.6, JSON) |
| Current SBOM | `sbom-oak-events-0.1.2-c4fe71e.cdx.json`; licence summary `sbom-licenses-0.1.2-c4fe71e.md`. Previous: `sbom-oak-events-0.1.1-00d9053.cdx.json` (CycloneDX 1.6, JSON) |
| Regenerated | At every release (security baseline, section 7) and at least once a year |

## What the current SBOM covers

- oak-events 0.1.1 built from commit 00d9053, installed with both extras: `oak-events[camera,mcp]`.
- oak-events 0.1.2 built from commit c4fe71e with the version set to 0.1.2, installed with both extras: `oak-events[camera,mcp]`.
- oak-events as the root component, and 31 components: the 30 Python packages it pulls in plus `pip`
from the virtual environment, resolved on 2026-11-02 on macOS arm64 with Python 3.14, including
`depthai` 3.11.0, `mcp` 2.3.0 and `numpy` 2.5.4.
- Licences of the 30 dependencies are permissive or public-domain style (MIT, BSD-3-Clause, Apache-2.0,
MIT-0, PSF-2.0, 0BSD, Zlib, CC0-1.0); oak-events itself is MIT.
- Changes from the 0.1.1 SBOM: `pip` 26.2.1 to 26.3; every other component is unchanged.
- Provenance re-checked on 2026-11-02 for these 31 components with the PyPI integrity API (supply chain
policy section 4.1): 22 publish attestations for every file, 9 publish none (annotated-types, cffi,
depthai, h11, httpcore2, httpx2, opentelemetry-api, pycparser, pydantic_core). Same result as for 0.1.1.

**Not covered:**

Expand Down
33 changes: 33 additions & 0 deletions docs/sbom-licenses-0.1.2-c4fe71e.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
| Name | Version | License | URL |
|---------------------------|----------|----------------------------------------------------|------------------------------------------------------------------------------------|
| PyJWT | 2.15.1 | MIT | https://github.com/jpadilla/pyjwt |
| annotated-types | 0.8.0 | MIT | https://github.com/annotated-types/annotated-types |
| anyio | 4.16.0 | MIT | https://anyio.readthedocs.io/en/stable/versionhistory.html |
| attrs | 26.1.0 | MIT | https://www.attrs.org/en/stable/changelog.html |
| cffi | 2.1.1 | MIT-0 | https://cffi.readthedocs.io/en/latest/whatsnew.html |
| click | 8.5.0 | BSD-3-Clause | https://github.com/pallets/click/ |
| cryptography | 50.0.2 | Apache-2.0 OR BSD-3-Clause | https://github.com/pyca/cryptography |
| depthai | 3.11.0 | MIT License | https://github.com/luxonis/depthai-core/tree/main/bindings/python |
| h11 | 0.16.0 | MIT License | https://github.com/python-hyper/h11 |
| httpcore2 | 2.16.0 | BSD-3-Clause | https://github.com/pydantic/httpx2 |
| httpx2 | 2.16.0 | BSD-3-Clause | https://github.com/pydantic/httpx2 |
| idna | 3.20 | BSD-3-Clause | https://github.com/kjd/idna |
| jsonschema | 4.26.0 | MIT | https://github.com/python-jsonschema/jsonschema |
| jsonschema-specifications | 2025.9.1 | MIT | https://github.com/python-jsonschema/jsonschema-specifications |
| mcp | 2.3.0 | MIT License | https://modelcontextprotocol.io |
| mcp-types | 2.3.0 | MIT License | https://modelcontextprotocol.io |
| numpy | 2.5.4 | BSD-3-Clause AND 0BSD AND MIT AND Zlib AND CC0-1.0 | https://numpy.org |
| oak-events | 0.1.2 | MIT | UNKNOWN |
| opentelemetry-api | 1.45.2 | Apache-2.0 | https://github.com/open-telemetry/opentelemetry-python/tree/main/opentelemetry-api |
| pycparser | 3.12 | BSD-3-Clause | https://github.com/eliben/pycparser |
| pydantic | 2.14.2 | MIT | https://github.com/pydantic/pydantic |
| pydantic_core | 2.50.2 | MIT | https://github.com/pydantic |
| python-multipart | 0.0.33 | Apache-2.0 | https://github.com/Kludex/python-multipart |
| referencing | 0.37.0 | MIT | https://github.com/python-jsonschema/referencing |
| rpds-py | 2026.9.1 | MIT | https://github.com/crate-py/rpds |
| sse-starlette | 3.6.0 | BSD-3-Clause | https://github.com/sysid/sse-starlette |
| starlette | 1.10.0 | BSD-3-Clause | https://github.com/Kludex/starlette |
| truststore | 0.10.5 | MIT | https://github.com/sethmlarson/truststore |
| typing-inspection | 0.4.4 | MIT | https://github.com/pydantic/typing-inspection |
| typing_extensions | 4.16.0 | PSF-2.0 | https://github.com/python/typing_extensions |
| uvicorn | 0.54.0 | BSD-3-Clause | https://uvicorn.dev/ |
Loading
Loading