docs: add security model mapping branch scanning targets#737
Merged
Conversation
main is a landing-page branch with no TEE code, so a security scan must target the branches that contain code. Adds docs/security-model.md, a brief orientation that maps those scanning targets: experimental-web3 (the active vm/wallet-gateway TEE-backed wallet custody gateway, with its task-runner-tee vs. task-runner-normal trust split), the cleanroom SGX FaaS prototype, and the deprecated legacy FaaS framework (which already has its own threat-model docs). Points to the per-platform SDK security models (SGX, TrustZone, crates) as the authoritative trust-boundary references, and links the doc from SECURITY.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
docs/security-model.mdtomain, and links it fromSECURITY.md.Why
mainis the ecosystem landing-page branch and contains no TEE code (crates/,sgx/,trustzone/hold only README pointers). A security reviewer — human or automated/LLM agent — pointed atmainwould find nothing to audit and could mistakenly conclude there is no attack surface. The actual code lives on other branches. This doc is a brief map to scanning targets so a review is aimed at the right place, with the right trust model.It deliberately does not duplicate a full threat model — the per-platform trust models already live in the SDK repositories, and the
legacybranch already carries its owndocs/threat-model.md.Contents
docs/security-model.mdcovers:mainhas no TEE code — so don't auditmainitself for TEE issues.experimental-web3(active/latest) →vm/wallet-gateway/, a TEE-backed crypto-wallet custody gateway. The trust boundary is visible in the workspace:task-runner-tee(+credential-manager, signing/keys) is the TCB;api-server/webapi,net(external blockchain RPC and price feeds),db-service/db-manager(untrusted storage), andtask-runner-normalare untrusted. Lists the attacker-controlled inputs to focus on.cleanroom— an earlier SGX FaaS-style prototype.legacy— the deprecated original FaaS framework (already documented underdocs/).This is documentation only; no code or behavior changes.
🤖 Generated with Claude Code