Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
68d94a4967 | ||
| 27aa29f9c8 | |||
| 39cf447ee0 | |||
| fe5b9c8b75 | |||
| 871188ec12 | |||
| 9482403a23 |
@@ -6,3 +6,4 @@ rules:
|
||||
require_ci_to_merge: false # CI runner dead (issue #915)
|
||||
block_force_pushes: true
|
||||
block_deletions: true
|
||||
block_on_outdated_branch: true
|
||||
|
||||
1
.github/BRANCH_PROTECTION.md
vendored
1
.github/BRANCH_PROTECTION.md
vendored
@@ -12,6 +12,7 @@ All repositories must enforce these rules on the `main` branch:
|
||||
| Require CI to pass | ⚠ Conditional | Only where CI exists |
|
||||
| Block force push | ✅ Enabled | Protect commit history |
|
||||
| Block branch deletion | ✅ Enabled | Prevent accidental deletion |
|
||||
| Require branch up-to-date before merge | ✅ Enabled | Surface conflicts before merge and force contributors to rebase |
|
||||
|
||||
## Default Reviewer Assignments
|
||||
|
||||
|
||||
162
SECURITY.md
Normal file
162
SECURITY.md
Normal file
@@ -0,0 +1,162 @@
|
||||
# Security Policy
|
||||
|
||||
## Overview
|
||||
|
||||
The Nexus is a sovereign AI agent system that prioritizes security, privacy, and local-first operation. This document outlines our security practices and how to report vulnerabilities.
|
||||
|
||||
## Security Principles
|
||||
|
||||
1. **Local-first**: All data and processing stays on the user's machine by default
|
||||
2. **Minimal attack surface**: Expose only what's necessary
|
||||
3. **Defense in depth**: Multiple layers of security controls
|
||||
4. **Transparency**: Open source, auditable code
|
||||
5. **User sovereignty**: Users control their data and connections
|
||||
|
||||
## Recent Security Improvements
|
||||
|
||||
### WebSocket Gateway Security (Issue #1504, #1514)
|
||||
|
||||
**Problem**: WebSocket gateway was exposed on `0.0.0.0` without authentication.
|
||||
|
||||
**Solution**:
|
||||
- **Localhost binding by default**: Gateway now binds to `127.0.0.1` by default
|
||||
- **Token authentication**: Optional token-based authentication via `NEXUS_WS_TOKEN`
|
||||
- **Rate limiting**: Connection and message rate limiting
|
||||
- **Configuration via environment variables**:
|
||||
- `NEXUS_WS_HOST`: Host to bind to (default: `127.0.0.1`)
|
||||
- `NEXUS_WS_PORT`: Port to listen on (default: `8765`)
|
||||
- `NEXUS_WS_TOKEN`: Authentication token (empty = no auth)
|
||||
|
||||
### Branch Protection
|
||||
|
||||
**Policy**: All repositories enforce branch protection rules on `main`:
|
||||
- Require pull requests for all changes
|
||||
- Require 1 approval before merge
|
||||
- Dismiss stale approvals on new commits
|
||||
- Block force pushes
|
||||
- Block branch deletion
|
||||
|
||||
### Command Injection Prevention
|
||||
|
||||
**Problem**: Shell injection vulnerabilities in commit messages and Electron IPC.
|
||||
|
||||
**Solution**:
|
||||
- Input validation and sanitization
|
||||
- Use of parameterized commands
|
||||
- Avoid shell execution where possible
|
||||
- Use of safe APIs (e.g., `child_process.execFile` instead of `child_process.exec`)
|
||||
|
||||
### ChromaDB Telemetry Disabled
|
||||
|
||||
**Problem**: ChromaDB enables anonymous telemetry by default, leaking usage patterns.
|
||||
|
||||
**Solution**:
|
||||
- Disabled telemetry in all client creation paths
|
||||
- Added `anonymized_telemetry=False` to all ChromaDB client instances
|
||||
|
||||
## Security Configuration
|
||||
|
||||
### Environment Variables
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `NEXUS_WS_HOST` | `127.0.0.1` | WebSocket gateway host |
|
||||
| `NEXUS_WS_PORT` | `8765` | WebSocket gateway port |
|
||||
| `NEXUS_WS_TOKEN` | (empty) | Authentication token |
|
||||
| `GITEA_TOKEN` | (required) | Gitea API token |
|
||||
| `GITEA_URL` | `https://forge.alexanderwhitestone.com` | Gitea instance URL |
|
||||
|
||||
### Secure Deployment
|
||||
|
||||
For production deployments:
|
||||
|
||||
1. **Use authentication**:
|
||||
```bash
|
||||
export NEXUS_WS_TOKEN=$(openssl rand -hex 32)
|
||||
```
|
||||
|
||||
2. **Bind to localhost** (default):
|
||||
```bash
|
||||
export NEXUS_WS_HOST=127.0.0.1
|
||||
```
|
||||
|
||||
3. **Use reverse proxy** for external access:
|
||||
```nginx
|
||||
# nginx example
|
||||
location /ws {
|
||||
proxy_pass http://127.0.0.1:8765;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "upgrade";
|
||||
proxy_set_header Host $host;
|
||||
}
|
||||
```
|
||||
|
||||
4. **Enable HTTPS** for external access
|
||||
|
||||
## Reporting Vulnerabilities
|
||||
|
||||
### Responsible Disclosure
|
||||
|
||||
If you discover a security vulnerability, please follow responsible disclosure:
|
||||
|
||||
1. **Do NOT** create a public issue
|
||||
2. **Email**: security@timmy.foundation (or contact Alexander directly)
|
||||
3. **Include**:
|
||||
- Description of the vulnerability
|
||||
- Steps to reproduce
|
||||
- Potential impact
|
||||
- Suggested fix (if any)
|
||||
|
||||
### Response Timeline
|
||||
|
||||
- **Acknowledgment**: Within 24 hours
|
||||
- **Assessment**: Within 72 hours
|
||||
- **Fix**: Within 7 days for critical issues
|
||||
- **Disclosure**: After fix is deployed
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
### For Users
|
||||
|
||||
1. **Keep software updated**: Regularly update The Nexus and dependencies
|
||||
2. **Use strong tokens**: Generate random, long tokens for authentication
|
||||
3. **Limit exposure**: Only expose services that need external access
|
||||
4. **Monitor logs**: Check logs for suspicious activity
|
||||
5. **Backup regularly**: Keep backups of important data
|
||||
|
||||
### For Developers
|
||||
|
||||
1. **Input validation**: Always validate and sanitize user input
|
||||
2. **Parameterized queries**: Use parameterized queries for database access
|
||||
3. **Least privilege**: Run with minimal required permissions
|
||||
4. **Secure defaults**: Default to secure configurations
|
||||
5. **Code review**: All changes require code review
|
||||
|
||||
### For Deployment
|
||||
|
||||
1. **Network segmentation**: Isolate services in network segments
|
||||
2. **Firewall rules**: Restrict access to necessary ports only
|
||||
3. **Regular updates**: Keep OS and dependencies updated
|
||||
4. **Monitoring**: Implement logging and monitoring
|
||||
5. **Backup strategy**: Regular, tested backups
|
||||
|
||||
## Security Audit Log
|
||||
|
||||
| Date | Issue | Description | Status |
|
||||
|------|-------|-------------|--------|
|
||||
| 2026-04-15 | #1504 | WebSocket gateway exposed on 0.0.0.0 | ✅ Fixed |
|
||||
| 2026-04-15 | #1514 | WebSocket security improvements | ✅ Fixed |
|
||||
| 2026-04-15 | #1423 | Command injection in Electron IPC | ✅ Fixed |
|
||||
| 2026-04-15 | #1430 | Shell injection in commit messages | ✅ Fixed |
|
||||
| 2026-04-15 | #1427 | ChromaDB telemetry enabled | ✅ Fixed |
|
||||
|
||||
## Contact
|
||||
|
||||
- **Security Issues**: security@timmy.foundation
|
||||
- **General Issues**: Create an issue on Gitea
|
||||
- **Emergency**: Contact Alexander directly
|
||||
|
||||
## License
|
||||
|
||||
This security policy is part of The Nexus project and is subject to the same license.
|
||||
@@ -4,48 +4,61 @@ Sync branch protection rules from .gitea/branch-protection/*.yml to Gitea.
|
||||
Correctly uses the Gitea 1.25+ API (not GitHub-style).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
import json
|
||||
import urllib.request
|
||||
from pathlib import Path
|
||||
|
||||
import yaml
|
||||
|
||||
GITEA_URL = os.getenv("GITEA_URL", "https://forge.alexanderwhitestone.com")
|
||||
GITEA_TOKEN = os.getenv("GITEA_TOKEN", "")
|
||||
ORG = "Timmy_Foundation"
|
||||
CONFIG_DIR = ".gitea/branch-protection"
|
||||
PROJECT_ROOT = Path(__file__).resolve().parent.parent
|
||||
CONFIG_DIR = PROJECT_ROOT / ".gitea" / "branch-protection"
|
||||
|
||||
|
||||
def api_request(method: str, path: str, payload: dict | None = None) -> dict:
|
||||
url = f"{GITEA_URL}/api/v1{path}"
|
||||
data = json.dumps(payload).encode() if payload else None
|
||||
req = urllib.request.Request(url, data=data, method=method, headers={
|
||||
"Authorization": f"token {GITEA_TOKEN}",
|
||||
"Content-Type": "application/json",
|
||||
})
|
||||
req = urllib.request.Request(
|
||||
url,
|
||||
data=data,
|
||||
method=method,
|
||||
headers={
|
||||
"Authorization": f"token {GITEA_TOKEN}",
|
||||
"Content-Type": "application/json",
|
||||
},
|
||||
)
|
||||
with urllib.request.urlopen(req, timeout=30) as resp:
|
||||
return json.loads(resp.read().decode())
|
||||
|
||||
|
||||
def apply_protection(repo: str, rules: dict) -> bool:
|
||||
branch = rules.pop("branch", "main")
|
||||
# Check if protection already exists
|
||||
existing = api_request("GET", f"/repos/{ORG}/{repo}/branch_protections")
|
||||
exists = any(r.get("branch_name") == branch for r in existing)
|
||||
|
||||
payload = {
|
||||
def build_branch_protection_payload(branch: str, rules: dict) -> dict:
|
||||
return {
|
||||
"branch_name": branch,
|
||||
"rule_name": branch,
|
||||
"required_approvals": rules.get("required_approvals", 1),
|
||||
"block_on_rejected_reviews": rules.get("block_on_rejected_reviews", True),
|
||||
"dismiss_stale_approvals": rules.get("dismiss_stale_approvals", True),
|
||||
"block_deletions": rules.get("block_deletions", True),
|
||||
"block_force_push": rules.get("block_force_push", True),
|
||||
"block_force_push": rules.get("block_force_push", rules.get("block_force_pushes", True)),
|
||||
"block_admin_merge_override": rules.get("block_admin_merge_override", True),
|
||||
"enable_status_check": rules.get("require_ci_to_merge", False),
|
||||
"status_check_contexts": rules.get("status_check_contexts", []),
|
||||
"block_on_outdated_branch": rules.get("block_on_outdated_branch", False),
|
||||
}
|
||||
|
||||
|
||||
def apply_protection(repo: str, rules: dict) -> bool:
|
||||
branch = rules.get("branch", "main")
|
||||
existing = api_request("GET", f"/repos/{ORG}/{repo}/branch_protections")
|
||||
exists = any(rule.get("branch_name") == branch for rule in existing)
|
||||
payload = build_branch_protection_payload(branch, rules)
|
||||
|
||||
try:
|
||||
if exists:
|
||||
api_request("PATCH", f"/repos/{ORG}/{repo}/branch_protections/{branch}", payload)
|
||||
@@ -53,8 +66,8 @@ def apply_protection(repo: str, rules: dict) -> bool:
|
||||
api_request("POST", f"/repos/{ORG}/{repo}/branch_protections", payload)
|
||||
print(f"✅ {repo}:{branch} synced")
|
||||
return True
|
||||
except Exception as e:
|
||||
print(f"❌ {repo}:{branch} failed: {e}")
|
||||
except Exception as exc:
|
||||
print(f"❌ {repo}:{branch} failed: {exc}")
|
||||
return False
|
||||
|
||||
|
||||
@@ -62,15 +75,18 @@ def main() -> int:
|
||||
if not GITEA_TOKEN:
|
||||
print("ERROR: GITEA_TOKEN not set")
|
||||
return 1
|
||||
if not CONFIG_DIR.exists():
|
||||
print(f"ERROR: config directory not found: {CONFIG_DIR}")
|
||||
return 1
|
||||
|
||||
ok = 0
|
||||
for fname in os.listdir(CONFIG_DIR):
|
||||
if not fname.endswith(".yml"):
|
||||
continue
|
||||
repo = fname[:-4]
|
||||
with open(os.path.join(CONFIG_DIR, fname)) as f:
|
||||
cfg = yaml.safe_load(f)
|
||||
if apply_protection(repo, cfg.get("rules", {})):
|
||||
for cfg_path in sorted(CONFIG_DIR.glob("*.yml")):
|
||||
repo = cfg_path.stem
|
||||
with cfg_path.open() as fh:
|
||||
cfg = yaml.safe_load(fh) or {}
|
||||
rules = cfg.get("rules", {})
|
||||
rules.setdefault("branch", cfg.get("branch", "main"))
|
||||
if apply_protection(repo, rules):
|
||||
ok += 1
|
||||
|
||||
print(f"\nSynced {ok} repo(s)")
|
||||
|
||||
45
tests/test_sync_branch_protection.py
Normal file
45
tests/test_sync_branch_protection.py
Normal file
@@ -0,0 +1,45 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import importlib.util
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
import yaml
|
||||
|
||||
PROJECT_ROOT = Path(__file__).parent.parent
|
||||
|
||||
_spec = importlib.util.spec_from_file_location(
|
||||
"sync_branch_protection_test",
|
||||
PROJECT_ROOT / "scripts" / "sync_branch_protection.py",
|
||||
)
|
||||
_mod = importlib.util.module_from_spec(_spec)
|
||||
sys.modules["sync_branch_protection_test"] = _mod
|
||||
_spec.loader.exec_module(_mod)
|
||||
|
||||
build_branch_protection_payload = _mod.build_branch_protection_payload
|
||||
|
||||
|
||||
def test_build_branch_protection_payload_enables_rebase_before_merge():
|
||||
payload = build_branch_protection_payload(
|
||||
"main",
|
||||
{
|
||||
"required_approvals": 1,
|
||||
"dismiss_stale_approvals": True,
|
||||
"require_ci_to_merge": False,
|
||||
"block_deletions": True,
|
||||
"block_force_push": True,
|
||||
"block_on_outdated_branch": True,
|
||||
},
|
||||
)
|
||||
|
||||
assert payload["branch_name"] == "main"
|
||||
assert payload["rule_name"] == "main"
|
||||
assert payload["block_on_outdated_branch"] is True
|
||||
assert payload["required_approvals"] == 1
|
||||
assert payload["enable_status_check"] is False
|
||||
|
||||
|
||||
def test_the_nexus_branch_protection_config_requires_up_to_date_branch():
|
||||
config = yaml.safe_load((PROJECT_ROOT / ".gitea" / "branch-protection" / "the-nexus.yml").read_text())
|
||||
rules = config["rules"]
|
||||
assert rules["block_on_outdated_branch"] is True
|
||||
Reference in New Issue
Block a user