presence-audit 0.1.0__tar.gz

presence_audit-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/
+*.py[cod]
+.pytest_cache/
+build/
+dist/
+*.egg-info/

presence_audit-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.

presence_audit-0.1.0/NOTICE

@@ -0,0 +1,46 @@
+bmc-sensor-audit
+Copyright 2026 James Sheen
+
+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.
+
+This project reads OpenBMC `entity-manager` configuration files and walks the
+DMTF Redfish API. It is not affiliated with, endorsed by, or part of the OpenBMC
+project or DMTF.
+
+REDISTRIBUTED THIRD-PARTY CONTENT
+
+`tests/fixtures/upstream/` contains twelve configuration files copied verbatim from
+the OpenBMC `entity-manager` project:
+
+    Copyright 2018 Intel Corporation
+    Licensed under the Apache License, Version 2.0
+    https://github.com/openbmc/entity-manager
+
+Their licence is reproduced unmodified at `tests/fixtures/upstream/LICENCE`,
+spelled as upstream spells it. The twelve files are unmodified and byte-identical
+to their sources. `tests/fixtures/upstream/README.md` records which documented
+finding each one reproduces, why these twelve were chosen, and what they do not
+cover.
+
+Pinned to upstream commit:
+
+    0ada048303bb007c9d7ec3a6a90433169f05dd99
+
+Pinning was not the original state, and the reason it is now is worth recording:
+the first snapshot came from a local checkout with no version control metadata,
+so no revision could be named — and by the time anyone looked, two of the nine
+files had been renamed upstream and every corpus count had moved. An unpinned
+snapshot of third-party content does not stay a snapshot; it becomes a claim
+about a revision nobody can identify.
+
+At Stage 2 this project depends on `arbiter-engine`, which is separately
+licensed under the same terms. It is a consumer of that package and not a part
+of it.

presence_audit-0.1.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.5
+Name: presence-audit
+Version: 0.1.0
+Summary: Given a declaration and a capture, say which declared points are reading, present but not reading, or absent.
+Project-URL: Homepage, https://github.com/james-sheen/presence-audit
+Project-URL: Source, https://github.com/james-sheen/presence-audit
+Project-URL: Issues, https://github.com/james-sheen/presence-audit/issues
+Author: James Sheen
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: attestation,audit,declaration,presence,regression
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# presence-audit
+
+Given a **declaration** of what should exist and a **capture** of what was
+observed, say which declared points are **reading**, **present but not reading**,
+or **absent**.
+
+Those three states are the whole product. *We did not look* and *it is not there*
+are different findings, and a presence audit exists to keep them apart.
+
+## What it does not know
+
+Anything about your domain. What a declared point IS, which kinds are worth
+auditing, when two of them are redundant readings of one thing, what changed
+about one between two captures — all of that arrives through a **vocabulary**
+supplied by a vertical you register. This package ships none.
+
+The protocol in `protocols.py` is the whole contract a vertical is written
+against. If something here needs a member the protocol does not declare, the
+protocol is wrong — not your vertical.
+
+## Registering a vertical
+
+Three ways in, resolved before anything is read:
+
+- an entry point in the group `presence_audit.plugins`
+- `PRESENCE_AUDIT_PLUGINS`, an `os.pathsep`-separated list of specs
+- whatever your own command line passes to `plugins.load_spec`
+
+Two installed verticals are **refused rather than ranked**: both would register,
+the later would silently win, and every verdict would come from a domain you were
+not auditing.
+
+## What a vertical supplies
+
+A **sketch, not a runnable block** — the complete member list is
+`vocabulary.Vocabulary`, which documents each one and what an empty answer
+means. Thirteen members; most domains answer several of them with *nothing*.
+
+```
+class MyVocabulary:
+    kinds       = ("tag", "label")      # every class a declared point falls into
+    count_keys  = {"label": "not_a_tag"}  # the ones worth reporting, under YOUR name
+    def classify(self, declared_type): ...        # must return a member of `kinds`
+    def is_auditable(self, kind): ...             # which kinds the audit is about
+    def is_expected_live(self, declared_type): ...
+    # ... and eight more, including the three that let a domain say
+    #     something about its own capture that the pairing cannot see
+
+def register():
+    from presence_audit import vocabulary
+    vocabulary.register(MyVocabulary())
+```
+
+Name `register` on the `presence_audit.plugins` entry point and a plain
+`pip install` finds it. Then `diff.compare(declaration, capture)` answers in
+three states, counting your kinds under your own keys.
+
+**Two installed verticals are refused, not ranked** — both would register, the
+later would win, and every verdict would come from a domain you were not
+auditing. Choose one with the environment variable or your own command line.
+
+## Status
+
+Extracted from `bmc-sensor-audit`, which keeps its Redfish capture layer, its
+sensor vocabulary and its command line and now depends on this. The extraction
+was by import graph: every module here reaches nothing domain-specific, and that
+is asserted by a test rather than by this sentence.
+
+Apache-2.0.

presence_audit-0.1.0/README.md

@@ -0,0 +1,69 @@
+# presence-audit
+
+Given a **declaration** of what should exist and a **capture** of what was
+observed, say which declared points are **reading**, **present but not reading**,
+or **absent**.
+
+Those three states are the whole product. *We did not look* and *it is not there*
+are different findings, and a presence audit exists to keep them apart.
+
+## What it does not know
+
+Anything about your domain. What a declared point IS, which kinds are worth
+auditing, when two of them are redundant readings of one thing, what changed
+about one between two captures — all of that arrives through a **vocabulary**
+supplied by a vertical you register. This package ships none.
+
+The protocol in `protocols.py` is the whole contract a vertical is written
+against. If something here needs a member the protocol does not declare, the
+protocol is wrong — not your vertical.
+
+## Registering a vertical
+
+Three ways in, resolved before anything is read:
+
+- an entry point in the group `presence_audit.plugins`
+- `PRESENCE_AUDIT_PLUGINS`, an `os.pathsep`-separated list of specs
+- whatever your own command line passes to `plugins.load_spec`
+
+Two installed verticals are **refused rather than ranked**: both would register,
+the later would silently win, and every verdict would come from a domain you were
+not auditing.
+
+## What a vertical supplies
+
+A **sketch, not a runnable block** — the complete member list is
+`vocabulary.Vocabulary`, which documents each one and what an empty answer
+means. Thirteen members; most domains answer several of them with *nothing*.
+
+```
+class MyVocabulary:
+    kinds       = ("tag", "label")      # every class a declared point falls into
+    count_keys  = {"label": "not_a_tag"}  # the ones worth reporting, under YOUR name
+    def classify(self, declared_type): ...        # must return a member of `kinds`
+    def is_auditable(self, kind): ...             # which kinds the audit is about
+    def is_expected_live(self, declared_type): ...
+    # ... and eight more, including the three that let a domain say
+    #     something about its own capture that the pairing cannot see
+
+def register():
+    from presence_audit import vocabulary
+    vocabulary.register(MyVocabulary())
+```
+
+Name `register` on the `presence_audit.plugins` entry point and a plain
+`pip install` finds it. Then `diff.compare(declaration, capture)` answers in
+three states, counting your kinds under your own keys.
+
+**Two installed verticals are refused, not ranked** — both would register, the
+later would win, and every verdict would come from a domain you were not
+auditing. Choose one with the environment variable or your own command line.
+
+## Status
+
+Extracted from `bmc-sensor-audit`, which keeps its Redfish capture layer, its
+sensor vocabulary and its command line and now depends on this. The extraction
+was by import graph: every module here reaches nothing domain-specific, and that
+is asserted by a test rather than by this sentence.
+
+Apache-2.0.

presence_audit-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "presence-audit"
+# Read from the package rather than duplicated here: a version written twice is
+# a version that will disagree with itself.
+dynamic = ["version"]
+description = "Given a declaration and a capture, say which declared points are reading, present but not reading, or absent."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [{name = "James Sheen"}]
+keywords = ["audit", "presence", "declaration", "attestation", "regression"]
+# NONE, and deliberately. Nothing here imports a third-party package at module
+# scope; a vertical supplies the domain and a judge is optional. Adding a
+# dependency to this list is a claim that the presence question cannot be
+# answered without it.
+dependencies = []
+
+[project.optional-dependencies]
+dev = ["pytest>=7"]
+
+[project.urls]
+Homepage = "https://github.com/james-sheen/presence-audit"
+Source = "https://github.com/james-sheen/presence-audit"
+Issues = "https://github.com/james-sheen/presence-audit/issues"
+
+[tool.hatch.version]
+path = "src/presence_audit/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/presence_audit"]

presence_audit-0.1.0/src/presence_audit/__init__.py

@@ -0,0 +1,20 @@
+"""Given a declaration and a capture, say what is present.
+
+A declaration is what should exist. A capture is what was observed. This
+package pairs them and puts every declared point in one of three states --
+reading, present but not reading, absent -- diffs two captures for regression,
+turns either into a report, feeds a judge, and attests to what it did.
+
+**It knows nothing about any domain, and it cannot.** What a declared point IS,
+which kinds are worth auditing, when two of them are redundant readings of one
+thing, what changed about one between two captures: those are domain questions,
+and they arrive through `vocabulary.Vocabulary` from a vertical that registers
+itself. This package ships no vertical. That is the property it exists to have,
+and `tests/` asserts it rather than this docstring promising it.
+
+The protocol in `protocols.py` is the WHOLE contract a vertical is written
+against. If something here needs a member the protocol does not declare, the
+protocol is wrong -- not the vertical.
+"""
+
+__version__ = "0.1.0"