Skip to content

Commit bbe9498

Browse files
Dobbyclaude
andcommitted
docs: refresh README for launch — document info command + 5-check verify flow
README was stale: listed only 3 verify checks (actual is 5), missing the new `privateclaw info` subcommand, and pinned install URL to v1.0.0. Now points at /releases/latest/download/install.sh, lists all four commands with a table, and uses the "fully encrypted" framing that matches privateclaw.dev. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent f31ae56 commit bbe9498

1 file changed

Lines changed: 50 additions & 15 deletions

File tree

README.md

Lines changed: 50 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,48 +2,83 @@
22

33
TEE verification and management CLI for [PrivateClaw](https://privateclaw.dev) CVMs.
44

5+
PrivateClaw runs your inference workloads inside fully encrypted confidential VMs. This CLI lets you cryptographically confirm that a CVM really is a genuine TEE — and inspect its state.
6+
7+
For background on TEEs and remote attestation, see [confidential.ai/docs](https://confidential.ai/docs).
8+
59
## Install
610

711
```bash
8-
curl -fsSL https://github.com/lunal-dev/privateclaw-cli/releases/download/v1.0.0/install.sh | bash
12+
curl -fsSL https://github.com/lunal-dev/privateclaw-cli/releases/latest/download/install.sh | bash
913
```
1014

1115
This installs two binaries to `/usr/local/bin/`:
12-
- `privateclaw` — shell script CLI with `verify`, `attest`, and `assign` subcommands
13-
- `attestation-cli` — pre-built binary from [attestation-rs](https://github.com/lunal-dev/attestation-rs) for cryptographic TEE attestation
16+
17+
- `privateclaw` — the CLI shell script (this repo)
18+
- `attestation-cli` — pre-built binary from [lunal-dev/attestation-rs](https://github.com/lunal-dev/attestation-rs) that performs the cryptographic SEV-SNP and TPM attestation
1419

1520
## Commands
1621

22+
```
23+
privateclaw <command> [flags]
24+
```
25+
26+
| Command | Description |
27+
|---|---|
28+
| `verify [-v\|--verbose]` | Run the full 5-check TEE verification |
29+
| `info` | Print component versions, hostname, gateway IP, install date |
30+
| `attest` | Generate attestation evidence (boot-time; run by cloud-init) |
31+
| `assign` | Apply user configuration from IMDS (internal; run by systemd) |
32+
1733
### `privateclaw verify`
1834

19-
User-facing command. Cryptographically verifies your CVM is running in a genuine TEE:
35+
User-facing command. Runs five checks and prints a pass/fail summary:
2036

21-
1. **TEE Attestation** — validates AMD SEV-SNP attestation evidence via `attestation-cli`, confirms SSH host key is bound to the TEE
22-
2. **Inference Provider** — shows configured Lunal inference endpoint
23-
3. **External Access Lockout** — audits SSH authorized keys and firewall
37+
1. **SEV-SNP Hardware** — requests a fresh AMD SEV-SNP attestation report bound to the current SSH host key hash and validates the full cert chain via `attestation-cli`.
38+
2. **TPM Attestation** — validates the vTPM quote and AK cert chain.
39+
3. **Host Key Binding** — confirms the live SSH host key matches the key baked into the attestation evidence (so MITM is impossible).
40+
4. **Inference Provider** — shows the configured Lunal inference endpoint.
41+
5. **External Access Lockout** — audits `authorized_keys`, firewall rules, and cloud-provider access paths (waagent / VM extensions) to confirm no operator backdoor.
42+
43+
Add `-v` / `--verbose` for full cert-chain, VCEK, and endpoint diagnostics.
44+
45+
### `privateclaw info`
46+
47+
Prints a compact status block — useful for bug reports and quick sanity checks:
48+
49+
```
50+
privateclaw: v1.5.7
51+
attestation-cli: v0.4.1
52+
openclaw: <version>
53+
Hostname: <fqdn>
54+
Gateway IP: <gateway>
55+
Installed: <date>
56+
```
2457

2558
### `privateclaw attest`
2659

27-
Boot-time command (called by cloud-init). Generates attestation evidence binding the SSH host key to the TEE hardware.
60+
Boot-time command invoked by cloud-init. Generates SEV-SNP + TPM attestation evidence binding the SSH host key to the TEE hardware and writes it to `/etc/privateclaw/evidence.json`.
2861

2962
### `privateclaw assign`
3063

31-
Internal command (called by systemd timer). Polls Azure IMDS for user configuration and applies it.
64+
Internal command invoked by a systemd timer. Polls Azure IMDS for user configuration (SSH keys, inference endpoint) and applies it to the CVM.
3265

33-
## Independent Verification
66+
## Independent verification
3467

35-
You can verify a CVM's attestation evidence from any machine:
68+
You can verify a CVM's attestation evidence from any machine — you don't need to trust this CLI:
3669

3770
```bash
38-
# Copy evidence from CVM
71+
# Copy evidence off the CVM
3972
scp user@cvm:/etc/privateclaw/evidence.json .
4073

41-
# Verify locally (install attestation-cli first)
74+
# Verify locally with attestation-cli
4275
attestation-cli verify -e evidence.json --expected-report-data <host_key_hash_hex>
4376
```
4477

4578
## Auditing
4679

47-
This repo contains everything that runs on your CVM. The `privateclaw` script is a single shell file — read it directly to see exactly what it does.
80+
Everything that runs on your CVM lives in this repo. `privateclaw` is a single bash script — read it top to bottom to see exactly what it does. The only binary dependency is [`attestation-cli`](https://github.com/lunal-dev/attestation-rs), which is also open source.
81+
82+
## License
4883

49-
The only binary dependency is [`attestation-cli`](https://github.com/lunal-dev/attestation-rs), which is also open source.
84+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)