https://github.com/rustonbsd/rustpatcher
A p2p patcher system written in rust using iroh and pkarr
https://github.com/rustonbsd/rustpatcher
Last synced: 5 months ago
JSON representation
A p2p patcher system written in rust using iroh and pkarr
- Host: GitHub
- URL: https://github.com/rustonbsd/rustpatcher
- Owner: rustonbsd
- License: mit
- Created: 2025-01-29T14:36:53.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-06-13T12:47:06.000Z (5 months ago)
- Last Synced: 2025-06-13T13:48:25.496Z (5 months ago)
- Language: Rust
- Homepage:
- Size: 65.4 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-iroh - Rust Patcher - Secure Decentralized Software updates. (File Sharing)
README
# Rust Patcher
*Secure Decentralized Software Updates* - Working work in progress
[](https://crates.io/crates/rustpatcher)
[](https://docs.rs/rustpatcher)
## Implementation Flow
### 1. Add Dependency (Crates.io)
```toml
# Cargo.toml
[dependencies]
rustpatcher = "0.1"
```
### 2. Initialize Patcher
```rust
// main.rs
use rustpatcher::Patcher;
#[rustpatcher::main]
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let patcher = Patcher::new()
.build()
.await?;
}
```
### 3. Initialize Cryptographic Identity
```bash
cargo run -- rustpatcher init
```
**Output:**
```text
New keys generated:
Trusted-Key = mw6iuq1iu7qd5gcz59qpjnu6tw9yn7pn4gxxkdbqwwwxfzyziuro
Shared-Secret = 8656fg8j6s43a4jndkzdysjuof588zezsn6s8sd6wwcpwf6b3r9y
```
### 4. Extend main with keys
```rust
// main.rs
use rustpatcher::Patcher;
#[rustpatcher::main]
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let patcher = Patcher::new()
.trusted_key_from_z32_str("mw6iuq1iu7qd5gcz59qpjnu6tw9yn7pn4gxxkdbqwwwxfzyziuro")
.shared_secret_key_from_z32_str("mw6iuq1iu7qd5gcz59qpjnu6tw9yn7pn4gxxkdbqwwwxfzyziuro"))
.build()
.await?;
}
```
### 5. Publish Updates (Master Node)
```bash
# Increment version in Cargo.toml first
cargo run -- rustpatcher publish
```
Creates signed package with:
- SHA-256 executable hash
- Version metadata (major.minor.patch)
- Ed25519 publisher signature
- PKARR DHT record
---
## Network Architecture
### Master Node Flow
```mermaid
sequenceDiagram
Master->>+PKARR: Publish signed package
Master->>+Iroh: Announce version topic
Master-->>Network: Propagate via DHT
```
### Client Node Flow
```mermaid
sequenceDiagram
Client->>+PKARR: Check version records
PKARR-->>-Client: Return latest signed package
Client->>+Iroh: Discover peers via topic
Iroh-->>-Client: Return node list
Client->>Peer: Establish P2P connection
Peer-->>Client: Stream verified update
Client->>Self: Safe replace via self_replace
```
## Key Processes
1. **Version Propagation**
- Master nodes sign packages with secret key
- PKARR DHT stores version records with TTL
- Iroh topic tracker maintains peer list per version
2. **Update Verification**
```rust
// Verification chain
if pub_key.verify(&data, &sig).is_ok()
&& compute_hash(data) == stored_hash
&& version > current_version {
apply_update()
}
```
3. **Self-Update Mechanism**
- Hash and Signature verification after data download
- Temp file write with atomic replacement
- Execv syscall for instant reload
## CLI Reference
| Command | Function |
|-----------------|--------------------------------------|
| `init` | Generate cryptographic identity |
| `publish` | Create/distribute signed package |
*Zero configuration needed for peer discovery - automatic via Iroh Topic Tracker*
## Old Architecture Diagram
