Skip to content

Commit 7856ba5

Browse files
committed
Update README with new implementation details
1 parent 7e6d1e1 commit 7856ba5

1 file changed

Lines changed: 42 additions & 21 deletions

File tree

โ€ŽREADME.mdโ€Ž

Lines changed: 42 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Open Integrity Project
22
> - _did: `did:repo:69c8659959f1a6aa281bdc1b8653b381e741b3f6/blob/main/README.md`_
33
> - _github: `https://github.com/OpenIntegrityProject/core/blob/main/README.md`_
4-
> - _updated: 2025-03-04 by Christopher Allen <ChristopherA@LifeWithAlacrity.com>_
4+
> - _updated: 2025-03-05 by Christopher Allen <ChristopherA@LifeWithAlacrity.com>_
55
66
## ๐Ÿ“– Introduction
77

@@ -10,6 +10,7 @@ _**Cryptographic Roots of Trust for Open Source Development**_
1010
[![License](https://img.shields.io/badge/License-BSD_2--Clause--Patent-blue.svg)](https://spdx.org/licenses/BSD-2-Clause-Patent.html)
1111
[![Project Status: Active](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
1212
[![Version](https://img.shields.io/badge/version-0.1.0-blue.svg)](CHANGELOG.md)
13+
[![Verify Signatures](https://github.com/OpenIntegrityProject/core/actions/workflows/verify-signatures.yml/badge.svg)](https://github.com/OpenIntegrityProject/core/actions/workflows/verify-signatures.yml)
1314

1415
**Open Integrity** is an initiative by [Blockchain Commons](https://www.blockchaincommons.com) to integrate cryptographic trust mechanisms into Git repositories. By leveraging Git's native SSH signing capabilities and structured verification processes, we ensure transparency, provenance, and immutability for software projects.
1516

@@ -50,6 +51,8 @@ This repository contains the core implementation and documentation for the Open
5051
- ๐Ÿ“œ [Problem Statement](docs/Open_Integrity_Problem_Statement.md) โ€“ Challenges & solutions for cryptographic roots of trust using Git repositories
5152
- ๐Ÿ“Ÿ [CLI One-Liners](docs/Open_Integrity-CLI_One_Liners.md) โ€“ Practical command-line shortcuts for Open Integrity
5253
- ๐Ÿ“‚ [Repository Structure](docs/Open_Integrity_Repo_Directory_Structure.md) โ€“ Open Integrity repository structure reference
54+
- ๐Ÿ”ง [Repository Structure Implementation](docs/Repository_Structure_Implementation.md) โ€“ Guide to implementing the `.repo` directory structure
55+
- ๐Ÿ“‹ [Implementation Strategy](docs/Implementation_Strategy.md) โ€“ Roadmap for evolving from proof-of-concept to production
5356
- ๐Ÿ›ฃ๏ธ [Project Roadmap](ROADMAP.md) โ€“ Development milestones and plans
5457
- ๐Ÿค [Contributing Guidelines](CONTRIBUTING.md) โ€“ How to contribute
5558
- ๐Ÿ”’ [Security Policy](SECURITY.md) โ€“ Reporting vulnerabilities
@@ -60,11 +63,6 @@ This repository contains the core implementation and documentation for the Open
6063
- ๐Ÿ’ฌ [Community Discussions](https://github.com/orgs/OpenIntegrityProject/discussions)
6164
- โ— [Initial Issue Tracker](https://github.com/OpenIntegrityProject/community/issues)
6265

63-
### ๐Ÿ“ Planned Resources
64-
65-
- ๐Ÿš€ [Getting Started Guide] โ€“ Step-by-step guide to set up your first Open Integrity repository
66-
- ๐Ÿ› [Architecture Documentation] โ€“ System design & implementation details
67-
6866
### ๐Ÿ›  Core Implementation
6967

7068
- โš™๏ธ [Source Code](src/) โ€“ Essential Open Integrity Project tools & automation scripts
@@ -75,39 +73,62 @@ This repository contains the core implementation and documentation for the Open
7573
- ๐Ÿ” [`audit_inception_commit-POC.sh`](src/audit_inception_commit-POC.sh) - Audit repositories for compliance
7674
- ๐Ÿ—๏ธ [`create_inception_commit.sh`](src/create_inception_commit.sh) - Create repositories with inception commits
7775
- ๐Ÿชช [`get_repo_did.sh`](src/get_repo_did.sh) - Retrieve repository DIDs
76+
- ๐Ÿ“‚ [`create_repo_structure.sh`](src/create_repo_structure.sh) - Create standard `.repo` directory structure
77+
- ๐Ÿ” [`manage_allowed_signers.sh`](src/manage_allowed_signers.sh) - Manage authorized signing keys
78+
- ๐Ÿ›Ÿ [Git Hooks](src/hooks/) - Enforce signing and integrity requirements
7879

7980
## ๐Ÿš€ Quick Start
8081

8182
Get started with Open Integrity by:
82-
1. Set up your development environment for signing
83-
2. Create a repository with an inception commit establishing your root of trust
84-
3. Choose your trust model:
85-
- Direct verification using the inception key
86-
- OR delegated verification through authorized signers
87-
4. Run Open Integrity audits on your repositories
83+
84+
### 1. Set up your environment
85+
86+
```bash
87+
# Configure Git for SSH signing
88+
git config --global gpg.format ssh
89+
git config --global user.signingkey ~/.ssh/your_key
90+
git config --global commit.gpgsign true
91+
```
92+
93+
### 2. Create Repository Structure
8894

8995
```bash
90-
# Example: Create a repository with a signed inception commit
96+
# Create the standard .repo directory structure
97+
./src/create_repo_structure.sh --repo my_project
98+
99+
# Add yourself as an authorized signer
100+
./src/manage_allowed_signers.sh add --key ~/.ssh/id_ed25519.pub --name "Your Name"
101+
```
102+
103+
### 3. Create a Repository with an Inception Commit
104+
105+
```bash
106+
# Create a new repository with a signed inception commit
91107
./src/create_inception_commit.sh -r my_new_repo
108+
```
109+
110+
### 4. Verify Repository Integrity
92111

93-
# Example: Audit a repository's inception commit
112+
```bash
113+
# Audit a repository's inception commit
94114
./src/audit_inception_commit-POC.sh -C /path/to/repo
95115

96-
# Example: Get a repository's DID
116+
# Get a repository's DID
97117
./src/get_repo_did.sh -C /path/to/repo
98118
```
99119

100-
For a deeper dive, check out our [Problem Statement](docs/Open_Integrity_Problem_Statement.md) and documentation.
120+
For a deeper dive, check out our [Repository Structure Implementation](docs/Repository_Structure_Implementation.md) guide.
101121

102122
## ๐Ÿšฆ Project Status & Roadmap
103123

104124
### **Current Phase: Early Research & Proof-of-Concept (v0.1.0)**
105125
๐Ÿ”น Core concepts & initial implementation complete
106-
๐Ÿ”น Seeking community feedback for improvements
107-
๐Ÿ”น Developing integration with CI/CD & key management solutions
126+
๐Ÿ”น Standard repository structure implemented with `.repo` directory
127+
๐Ÿ”น Tools for managing authorized signers and verifying integrity
128+
๐Ÿ”น GitHub Actions workflow for automated integrity verification
108129
๐Ÿ”น **Not yet production-ready**
109130

110-
๐Ÿ“ See our [ROADMAP.md](ROADMAP.md) for detailed development plans and our [Development Phases](https://github.com/BlockchainCommons/Community/blob/master/release-path.md) for general approach.
131+
๐Ÿ“ See our [Implementation Strategy](docs/Implementation_Strategy.md) and [ROADMAP.md](ROADMAP.md) for detailed development plans.
111132

112133
## โ— Issue Management
113134

@@ -137,8 +158,8 @@ We welcome contributions from developers, researchers, and security experts!
137158
1. Read our **[Contributing Guide](CONTRIBUTING.md)**
138159
2. Fork the repository & create a feature branch
139160
3. Implement your feature or fix
140-
4. Digitally sign all your commits with an SSH signing key (`gitc commit -S`) and attribute authorship (`git commit --signoff`).
141-
4. Submit a **Pull Request** for review
161+
4. Digitally sign all your commits with an SSH signing key (`git commit -S`) and attribute authorship (`git commit --signoff`).
162+
5. Submit a **Pull Request** for review
142163

143164
All contributors must adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).
144165

0 commit comments

Comments
ย (0)