Repository navigation
Add repository metadata and governance documentation #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| cff-version: 1.2.0 | ||
| message: "If you use this software, please cite it as below." | ||
| authors: | ||
| - name: "Omni-Sentinel Contributors" | ||
| title: "Omni-Sentinel Cognitive Execution Environment" | ||
| version: 1.0.0 | ||
| date-released: 2026-06-01 | ||
| url: "https://github.com/omni-sentinel/omni-sentinel" | ||
| repository-code: "https://github.com/omni-sentinel/omni-sentinel" | ||
| license: MIT | ||
| type: software | ||
| keywords: | ||
| - post-quantum cryptography | ||
| - hardware attestation | ||
| - bayesian risk | ||
| - AI governance |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to creating a positive environment include: | ||
|
|
||
| * Using welcoming and inclusive language | ||
| * Being respectful of differing viewpoints and experiences | ||
| * Gracefully accepting constructive criticism | ||
| * Focusing on what is best for the community | ||
| * Showing empathy towards other community members | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| * The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
| * Trolling, insulting/derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
|
||
| ## Our Responsibilities | ||
|
|
||
| Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at security@omni-sentinel.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
|
Check notice on line 37 in CODE_OF_CONDUCT.md
|
||
|
|
||
| Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code-of-conduct.html][version] | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
| [version]: https://www.contributor-covenant.org/version/2/1/code-of-conduct.html | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Contributing to Omni-Sentinel | ||
|
|
||
| Thank you for your interest in contributing to Omni-Sentinel! We welcome contributions from the community to help make this project better. | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| 1. **Report Bugs**: If you find a bug, please open an issue on GitHub. Include a detailed description of the bug and steps to reproduce it. | ||
|
Check notice on line 7 in CONTRIBUTING.md
|
||
| 2. **Suggest Features**: If you have an idea for a new feature, please open an issue to discuss it. | ||
|
Check notice on line 8 in CONTRIBUTING.md
|
||
| 3. **Submit Pull Requests**: | ||
| - Fork the repository. | ||
| - Create a new branch for your changes (e.g., `feature/awesome-feature` or `bugfix/fix-issue`). | ||
| - Use DCO sign-off: `git commit -s -m "Commit message"`. | ||
| - Write tests for your changes. | ||
| - Ensure all tests pass. | ||
| - Submit a pull request with a clear description of your changes. | ||
|
|
||
| ## Security-Sensitive Modules | ||
|
|
||
| Changes to PQC (Post-Quantum Cryptography) or cryptographic modules require specialized security review. Please highlight any changes to files in `src/infrastructure/` that involve signing or attestation. | ||
|
|
||
| ## Coding Standards | ||
|
|
||
| - Follow PEP 8 for Python code. | ||
| - Ensure all functions and classes have descriptive docstrings. | ||
| - Keep security and integrity at the forefront of any infrastructure changes. | ||
|
|
||
| ## Testing | ||
|
|
||
| Always run the full test suite before submitting a pull request: | ||
|
|
||
| ```bash | ||
| PYTHONPATH=. python3 tests/test_governance.py | ||
| ``` | ||
|
|
||
| ## Community | ||
|
|
||
| Join our community discussions and help us build a safer environment for cognitive agents! | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2026 Omni-Sentinel Contributors | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,92 @@ | ||
| # Omni-Sentinel Cognitive Execution Environment | ||
|
|
||
| Omni-Sentinel is a high-assurance governance and execution framework designed for cognitive agents and AI systems. It provides a multi-layered defense-in-depth architecture anchored in hardware trust, Bayesian risk monitoring, and post-quantum cryptographic audit trails. | ||
|
|
||
| ## 🚀 Overview | ||
|
|
||
| The system is built to ensure that cognitive tasks are executed within safe, measurable, and immutable boundaries. It integrates advanced hardware attestation with real-time risk scoring to mitigate alignment drift and systemic risks. | ||
|
|
||
| ## 🏗️ Architecture (The G-Stack) | ||
|
|
||
| 1. **Hardware Root of Trust**: TEE/TPM with PCR_MATCH enforcement. Verifies the integrity of the execution environment. | ||
|
Check notice on line 11 in README.md
|
||
| 2. **Cognitive Control Plane**: Bayesian G-SRI (Global Systemic Risk Index) scoring engine regulating model execution based on real-time telemetry. | ||
|
Check notice on line 12 in README.md
|
||
| 3. **Immutable Evidence Store**: PQC-signed (ML-DSA) WORM (Write-Once-Read-Many) audit logs stored in an immutable bucket (e.g., AWS S3 Object Lock). | ||
|
Check notice on line 13 in README.md
|
||
|
|
||
| ## 📁 Project Structure | ||
|
|
||
| - `src/governance_engine/`: Contains the Bayesian scoring logic for risk assessment. | ||
| - `src/infrastructure/`: Hardware attestation and immutable logging implementations. | ||
| - `src/roadmap/`: Documentation regarding reference architecture and future master roadmap. | ||
| - `tests/`: Automated test suite for validating governance logic. | ||
| - `mock_s3_bucket/`: Simulated immutable storage for audit logs. | ||
|
|
||
| ## 🛠️ Getting Started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Python 3.10+ | ||
| - NumPy | ||
| - oqs-python (for ML-DSA signatures) | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Clone the repository: | ||
| ```bash | ||
| git clone https://github.com/omni-sentinel/omni-sentinel.git | ||
|
OneFineStarstuff marked this conversation as resolved.
OneFineStarstuff marked this conversation as resolved.
|
||
| cd omni-sentinel | ||
| ``` | ||
|
|
||
| 2. Install dependencies: | ||
| ```bash | ||
| pip install numpy oqs-python | ||
| ``` | ||
|
|
||
| ### Usage | ||
|
|
||
| #### G-SRI Scoring | ||
| ```python | ||
| from src.governance_engine.gsri_scoring_engine import GSRIScoringEngine | ||
|
|
||
| engine = GSRIScoringEngine() | ||
| telemetry = {"alignment_drift": 0.1, "compute_anomaly": 0.05} | ||
| gsri = engine.calculate_gsri(telemetry) | ||
| print(f"G-SRI: {gsri}") | ||
| ``` | ||
|
|
||
| #### PQC-WORM Logging | ||
| ```python | ||
| from src.infrastructure.pqc_worm_logger import PQCWormLogger | ||
|
|
||
| logger = PQCWormLogger() | ||
| logger.commit_batch("batch_001", [{"event": "GSRI_CHECK", "value": 15.5}]) | ||
| ``` | ||
|
|
||
| ## 🧪 Testing | ||
|
|
||
| Run the test suite: | ||
|
|
||
| ```bash | ||
| PYTHONPATH=. python3 tests/test_governance.py | ||
| ``` | ||
|
|
||
| ## 📜 License | ||
|
|
||
| This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. | ||
|
|
||
| ## 🤝 Contributing | ||
|
|
||
| Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute to this project. | ||
|
|
||
| ## 📝 Citation | ||
|
|
||
| If you use this software in your research, please cite it as follows: | ||
|
|
||
| ``` | ||
| @software{omni_sentinel_2026, | ||
| author = {{Omni-Sentinel Contributors}}, | ||
| title = {Omni-Sentinel Cognitive Execution Environment}, | ||
| version = {1.0.0}, | ||
| year = {2026}, | ||
| url = {https://github.com/omni-sentinel/omni-sentinel} | ||
|
OneFineStarstuff marked this conversation as resolved.
|
||
| } | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| { | ||
| "@context": "https://w3id.org/codemeta/3.0", | ||
| "@type": "SoftwareSourceCode", | ||
| "license": "https://spdx.org/licenses/MIT.html", | ||
| "codeRepository": "https://github.com/omni-sentinel/omni-sentinel", | ||
|
OneFineStarstuff marked this conversation as resolved.
|
||
| "datePublished": "2026-06-01", | ||
| "name": "Omni-Sentinel Cognitive Execution Environment", | ||
| "version": "1.0.0", | ||
| "description": "High-assurance governance and execution framework for cognitive agents and AI systems.", | ||
| "author": [ | ||
| { | ||
| "@type": "Organization", | ||
| "name": "Omni-Sentinel Contributors" | ||
| } | ||
| ], | ||
| "programmingLanguage": [ | ||
| "Python" | ||
| ], | ||
| "developmentStatus": "https://www.repostatus.org/#active", | ||
| "softwareRequirements": [ | ||
| "numpy", | ||
| "oqs-python" | ||
| ], | ||
| "keywords": [ | ||
| "PQC", | ||
| "TPM", | ||
| "Bayesian", | ||
| "AI safety" | ||
| ], | ||
| "runtimePlatform": "Linux" | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.