SKILL·52AC44

crypto-protocol-diagram

trailofbits
更新于 14 days ago
9 次查看
7,515
642
7,515
在 GitHub 上查看
元aidesign

关于

This skill extracts cryptographic protocol message flows from source code, RFCs, academic papers, or formal models and automatically generates Mermaid sequence diagrams with cryptographic annotations. It is ideal for visualizing handshakes, key exchanges, or diagramming protocols like TLS, Signal, or FROST from specifications. Developers should use it to quickly create clear, standardized diagrams from technical documentation or code.

快速安装

Claude Code

推荐
主要方式
npx skills add trailofbits/skills -a claude-code
插件命令备选方式
/plugin add https://github.com/trailofbits/skills
Git 克隆备选方式
git clone https://github.com/trailofbits/skills.git ~/.claude/skills/crypto-protocol-diagram

在 Claude Code 中复制并粘贴此命令以安装该技能

技能文档

Crypto Protocol Diagram

Produces a Mermaid sequenceDiagram (written to file) and an ASCII sequence diagram (printed inline) from either:

  • Source code implementing a cryptographic protocol, or
  • A specification — RFC, academic paper, pseudocode, informal prose, ProVerif (.pv), or Tamarin (.spthy) model.

Tools used: Read, Write, Grep, Glob, Bash, WebFetch (for URL specs).

Unlike the diagramming-code skill (which visualizes code structure), this skill extracts protocol semantics: who sends what to whom, what cryptographic transformations occur at each step, and what protocol phases exist.

For call graphs, class hierarchies, or module dependency maps, use the diagramming-code skill instead.

When to Use

  • User asks to diagram, visualize, or extract a cryptographic protocol
  • Input is source code implementing a handshake, key exchange, or multi-party protocol
  • Input is an RFC, academic paper, pseudocode, or formal model (ProVerif/Tamarin)
  • User names a specific protocol (TLS, Noise, Signal, X3DH, FROST)

When NOT to Use

  • User wants a call graph, class hierarchy, or module dependency map — use diagramming-code
  • User wants to formally verify a protocol — use mermaid-to-proverif (after generating the diagram)
  • Input has no cryptographic protocol semantics (no parties, no message exchange)

Rationalizations to Reject

RationalizationWhy It's WrongRequired Action
"The protocol is simple, I can diagram from memory"Memory-based diagrams miss steps and invert arrowsRead the source or spec systematically
"I'll skip the spec path since code exists"Code may diverge from the spec — both paths catch different bugsWhen both exist, run spec workflow first, then annotate code divergences
"Crypto annotations are optional decoration"Without crypto annotations, the diagram is just a message flow — useless for security reviewAnnotate every cryptographic operation
"The abort path is obvious, no need for alt blocks"Implicit abort handling hides missing error checksShow every abort/error path with alt blocks
"I don't need to check the examples first"The examples define the expected output quality barStudy the relevant example before working on unfamiliar input
"ProVerif/Tamarin models are code, not specs"Formal models are specifications — they describe intended behavior, not implementationUse the spec workflow (S1–S5) for .pv and .spthy files

Workflow

Protocol Diagram Progress:
- [ ] Step 0: Determine input type (code / spec / both)
- [ ] Step 1 (code) or S1–S5 (spec): Extract protocol structure
- [ ] Step 6: Generate sequenceDiagram
- [ ] Step 7: Verify and deliver

Step 0: Determine Input Type

Before doing anything else, classify the input:

SignalInput type
Source file extensions (.py, .rs, .go, .ts, .js, .cpp, .c)Code
Function/class definitions, import statementsCode
RFC-style section headers (§, Section X.Y, MUST/SHALL keywords)Spec
Algorithm/Protocol/Figure labels, mathematical notationSpec
ProVerif file (.pv) with process, let, in/outSpec
Tamarin file (.spthy) with rule, --[...]->Spec
Plain prose or numbered steps describing a protocolSpec
Both source files and a spec documentBoth (annotate divergences with ⚠️)
  • Code only → skip to Step 1 below
  • Spec only → skip to Spec Workflow (S1–S5) below
  • Both → run Spec Workflow first, then use the code-reading steps to verify the implementation against the spec diagram and annotate any divergences with ⚠️
  • Ambiguous → ask the user: "Is this a source code file, a specification document, or both?"

Step 1: Locate Protocol Entry Points

Grep for function names, type names, and comments that reveal the protocol:

# Find handshake, session, round, phase entry points
rg -l "handshake|session_init|round[_0-9]|setup|keygen|send_msg|recv_msg" {targetDir}

# Find crypto primitives in use
rg "sign|verify|encrypt|decrypt|dh|ecdh|kdf|hkdf|hmac|hash|commit|reveal|share" \
    {targetDir} --type-add 'src:*.{py,rs,go,ts,js,cpp,c}' -t src -l

Start reading from the highest-level orchestration function — the one that calls into handshake phases or the main protocol loop.

Step 2: Identify Parties and Roles

Extract participant names from:

  • Struct/class names: Client, Server, Initiator, Responder, Prover, Verifier, Dealer, Party, Coordinator
  • Function parameter names that carry state for a role
  • Comments declaring the protocol role
  • Test fixtures that set up two-party or N-party scenarios

Map these to Mermaid participant declarations. Use short, readable aliases:

participant I as Initiator
participant R as Responder

Step 3: Trace Message Flow

Follow state transitions and network sends/receives. Look for patterns like:

PatternMeaning
send(msg) / recv()Direct message exchange
serialize + transmitStructured message sent
Return value passed to other party's functionLogical message (in-process)
round1_output → round2_inputRound-based MPC step
Struct fields named ephemeral_key, ciphertext, mac, tagMessage contents

For in-process protocol implementations (where both parties run in the same process), treat function call boundaries as logical message sends when they represent what would be a network boundary in deployment.

Step 4: Annotate Cryptographic Operations

At each protocol step, identify and label:

OperationDiagram annotation
Key generationNote over A: keygen(params) → pk, sk
DH / ECDHNote over A,B: DH(sk_A, pk_B)
KDF / HKDFNote over A: HKDF(ikm, salt, info)
SigningNote over A: Sign(sk, msg) → σ
VerificationNote over B: Verify(pk, msg, σ)
EncryptionNote over A: Enc(key, plaintext) → ct
DecryptionNote over B: Dec(key, ct) → plaintext
CommitmentNote over A: Commit(value, rand) → C
HashNote over A: H(data) → digest
Secret sharingNote over D: Share(secret, t, n) → {s_i}
Threshold combineNote over C: Combine({s_i}) → secret

Keep annotations concise — use mathematical shorthand, not code.

Step 5: Identify Protocol Phases

Group message steps into named phases using rect or Note blocks:

Common phases to detect:

  • Setup / Key Generation: party key creation, trusted setup, parameter gen
  • Handshake / Init: ephemeral key exchange, nonce exchange, version negotiation
  • Authentication: identity proof, certificate exchange, signature verification
  • Key Derivation: session key derivation from shared secrets
  • Data Transfer / Main Protocol: encrypted application data exchange
  • Finalization / Teardown: session close, MAC verification, abort handling

Detect abort/error paths and show them with alt blocks.


Spec Workflow (S1–S5)

Use this path when the input is a specification document rather than source code. After completing S1–S5, continue with Step 6 (Generate sequenceDiagram) and Step 7 (Verify and deliver) from the code workflow above.

Step S1: Ingest the Spec

Obtain the full spec text:

  • File path provided → read with the Read tool
  • URL provided → fetch with WebFetch
  • Pasted inline → work directly from conversation context

Then identify the spec format and read references/spec-parsing-patterns.md for format-specific extraction guidance:

FormatSignals
RFCRFC XXXX, MUST/SHALL/SHOULD, ABNF grammars, section-numbered prose
Academic paper / pseudocodeAlgorithm X, Protocol X, Figure X, numbered steps, ←/→ in math mode
Informal proseNumbered lists, "A sends B ...", plain English descriptions
ProVerif (.pv)process, let, in(ch, x), out(ch, msg), ! (replication)
Tamarin (.spthy)rule, --[ ]->, Fr(~x), !Pk(A, pk), In(m), Out(m)

If the spec references a known named protocol (TLS, Noise, Signal, X3DH, Double Ratchet, FROST), also read references/protocol-patterns.md to use its canonical flow as a skeleton and fill in spec-specific details.

Step S2: Extract Parties and Roles

Identify all protocol participants. Look for:

  • Named roles in prose or pseudocode: Alice, Bob, Client, Server, Initiator, Responder, Prover, Verifier, Dealer, Party_i, Coordinator, Signer
  • Section headers: "Parties", "Roles", "Participants", "Setup", "Notation"
  • ProVerif: process names at top level (let ClientProc(...), let ServerProc(...))
  • Tamarin: rule names and fact arguments (e.g. !Pk($A, pk) — $A is a party)

Map each role to a Mermaid participant declaration. Use short IDs with descriptive aliases (see naming conventions in references/mermaid-sequence-syntax.md).

Step S3: Extract Message Flow

Trace what each party sends to whom and in what order. Extraction patterns by format:

RFC / informal prose:

  • Arrow notation: A → B: msg, A -> B
  • Sentence patterns: "A sends B ...", "B responds with ...", "A transmits ...", "upon receiving X, B sends Y"
  • Numbered steps: extract in order, inferring sender/receiver from context

Pseudocode:

  • Function signatures with explicit sender/receiver parameters
  • send(party, msg) / receive(party) calls
  • Return values passed as inputs to the other party's function in the next step

ProVerif (.pv):

  • out(ch, msg) — send on channel ch
  • in(ch, x) — receive on channel ch, bind to x
  • Match out/in pairs on the same channel to identify message flows
  • ! (replication) signals a role that handles multiple sessions

Tamarin (.spthy):

  • In(m) premise — receive message m
  • Out(m) conclusion — send message m
  • Rule name and ordering of rules reveal protocol rounds
  • Fr(~x) — fresh random value generated by a party
  • --[ Label ]-> facts — security annotations, not messages

Preserve the ordering and round structure. Group concurrent sends (broadcast) using par blocks in the final diagram.

Step S4: Extract Cryptographic Operations

For each protocol step, identify the cryptographic operations performed and which party performs them:

Spec notationOperationDiagram annotation
keygen(), Gen(1^λ)Key generationNote over A: keygen() → pk, sk
DH(a, B), g^abDH / ECDHNote over A,B: DH(sk_A, pk_B)
KDF(ikm), HKDF(...)Key derivationNote over A: HKDF(ikm, salt, info) → k
Sign(sk, m), σ ← SignSigningNote over A: Sign(sk, msg) → σ
Verify(pk, m, σ)VerificationNote over B: Verify(pk, msg, σ)
Enc(k, m), {m}_kEncryptionNote over A: Enc(k, plaintext) → ct
Dec(k, c)DecryptionNote over B: Dec(k, ct) → plaintext
H(m), hash(m)HashNote over A: H(data) → digest
Commit(v, r), comCommitmentNote over A: Commit(value, rand) → C
ProVerif senc(m, k)Symmetric encryptionNote over A: Enc(k, m) → ct
ProVerif pk(sk)Public key derivationNote over A: pk = pk(sk)
ProVerif sign(m, sk)SigningNote over A: Sign(sk, m) → σ

Identify security conditions and abort paths:

  • Prose: "if verification fails, abort", "only if ...", "reject if ..."
  • Pseudocode: assert, require, if ... abort
  • ProVerif: if m = expected then ... else 0
  • Tamarin: contradicting facts or restriction lemmas

These become alt blocks in the final diagram.

Step S5: Flag Spec Ambiguities

Before moving to Step 6, check for gaps:

  • Unclear message ordering: infer from round structure or section order; annotate with ⚠️ ordering inferred from spec structure
  • Implied parties: if a party's role is implied but unnamed, give it a descriptive name and note the inference
  • Missing steps: if the spec omits a step that the canonical pattern for this protocol requires, annotate: ⚠️ spec omits [step] — canonical protocol requires it
  • Underspecified crypto: if the spec says "encrypt" without specifying the scheme, annotate: ⚠️ encryption scheme not specified
  • ProVerif/Tamarin: private channels (c declared with new c or as a private free name) represent out-of-band channels — note them

<!-- Both code path (Steps 1–5) and spec path (Steps S1–S5) continue here -->

Step 6: Generate sequenceDiagram

Produce Mermaid syntax following the rules in references/mermaid-sequence-syntax.md.

Completeness over brevity. Show every distinct message type. Omit repeated loop iterations (use loop blocks instead), but never omit a distinct protocol step.

Correctness over aesthetics. The diagram must match what the code actually does. If the code diverges from a known spec, annotate the divergence:

Note over A,B: ⚠️ spec requires MAC here — implementation omits it

Step 7: Verify and Deliver

Before delivering:

  • Every participant declared actually sends or receives at least one message
  • Arrows point in the correct direction (sender → receiver)
  • Cryptographic operations are on the correct party (the one computing them)
  • If protocol phases are used, no arrows appear outside a phase block
  • alt blocks cover known abort/error paths
  • Diagram renders without syntax errors (check references/mermaid-sequence-syntax.md for common pitfalls)
  • If spec divergence found, annotated with ⚠️

Write the diagram to a file. Choose a filename derived from the protocol name, e.g. noise-xx-handshake.md or x3dh-key-agreement.md. Write a Markdown file with this structure:

# <Protocol Name> Sequence Diagram

\`\`\`mermaid
sequenceDiagram
    ...
\`\`\`

## Protocol Summary

- **Parties:** ...
- **Round complexity:** ...
- **Key primitives:** ...
- **Authentication:** ...
- **Forward secrecy:** ...
- **Notable:** [spec deviations or security observations, or "none"]

After writing the file, print an ASCII sequence diagram inline in the response, followed by the Protocol Summary. State the output filename so the user knows where to find the Mermaid source.

Follow all drawing conventions in references/ascii-sequence-diagram.md, including the inline output format.


Decision Tree

── Input is a spec document (not code)?
│  └─ Step S1: identify format, read references/spec-parsing-patterns.md
│
── Input is source code (not a spec)?
│  └─ Step 1: grep for handshake/round/send/recv entry points
│
── Both spec and code provided?
│  └─ Run Spec Workflow (S1–S5) first to build canonical diagram,
│     then read code and annotate divergences with ⚠️
│
── Spec is a known protocol (TLS, Noise, Signal, X3DH, FROST)?
│  └─ Read references/protocol-patterns.md and use canonical flow as skeleton
│
── Spec is ProVerif (.pv) or Tamarin (.spthy)?
│  └─ Read references/spec-parsing-patterns.md → Formal Models section
│
── Spec message ordering is ambiguous?
│  └─ Infer from round/section structure, annotate with ⚠️
│
── Can't identify parties from spec?
│  └─ Check "Parties"/"Notation" sections; for ProVerif read process names;
│     for Tamarin read rule names and fact arguments
│
── Don't know which code files implement the protocol?
│  └─ Step 1: grep for handshake/round/send/recv entry points
│
── Can't identify parties from struct names?
│  └─ Read test files — test setup reveals roles
│
── Protocol runs in-process (no network calls)?
│  └─ Treat function argument passing at role boundaries as messages
│
── MPC / threshold protocol with N parties?
│  └─ Read references/protocol-patterns.md → MPC section
│
── Mermaid syntax error?
│  └─ Read references/mermaid-sequence-syntax.md → Common Pitfalls
│
└─ ASCII drawing conventions?
   └─ Read references/ascii-sequence-diagram.md

Examples

Code path — examples/simple-handshake/:

  • protocol.py — two-party authenticated key exchange (X25519 DH + Ed25519 signing + HKDF + ChaCha20-Poly1305)
  • expected-output.md — exact ASCII diagram and Mermaid file the skill should produce for that protocol

Spec path (ProVerif) — examples/simple-proverif/:

  • model.pv — HMAC challenge-response authentication modeled in ProVerif
  • expected-output.md — step-by-step extraction walkthrough (parties, message flow, crypto ops) and the exact ASCII diagram and Mermaid file the skill should produce

Study the relevant example before working on an unfamiliar input.


Supporting Documentation

GitHub 仓库

trailofbits/skills
路径: plugins/trailmark/skills/crypto-protocol-diagram
0
agent-skills
FAQ

常见问题

什么是 crypto-protocol-diagram Skill?

crypto-protocol-diagram 是一个 Claude Skill,作者为 trailofbits。Skill 将 Claude 按需加载的说明和资源打包,让 Claude 无需额外提示即可执行与 crypto-protocol-diagram 相关的任务。

如何安装 crypto-protocol-diagram?

使用本页的安装命令:将 crypto-protocol-diagram 作为插件添加到 Claude Code,或将其仓库克隆到 skills 目录,然后重启 Claude 以加载该 Skill。

crypto-protocol-diagram 属于哪个分类?

crypto-protocol-diagram 属于元分类。

crypto-protocol-diagram 可以免费使用吗?

可以。crypto-protocol-diagram 已收录在 AIMCP,可免费安装。

相关推荐技能

content-collections
元

Content Collections 是一个 TypeScript 优先的构建工具,可将本地 Markdown/MDX 文件转换为类型安全的数据集合。它专为构建博客、文档站和内容密集型 Vite+React 应用而设计,提供基于 Zod 的自动模式验证。该工具涵盖从 Vite 插件配置、MDX 编译到生产环境部署的完整工作流。

查看技能
polymarket
元

这个Claude Skill为开发者提供完整的Polymarket预测市场开发支持,涵盖API调用、交易执行和市场数据分析。关键特性包括实时WebSocket数据流,可监控实时交易、订单和市场动态。开发者可用它构建预测市场应用、实施交易策略并集成实时市场预测功能。

查看技能
creating-opencode-plugins
元

该Skill帮助开发者创建OpenCode插件,用于接入命令、文件、LSP等25+种事件。它提供了插件结构、事件API规范和JavaScript/TypeScript实现模式,适合需要拦截操作、扩展功能或自定义事件处理的场景。开发者可通过它快速构建响应式模块来增强OpenCode AI助手的能力。

查看技能
sglang
元

SGLang是一个专为LLM设计的高性能推理框架,特别适用于需要结构化输出的场景。它通过RadixAttention前缀缓存技术,在处理JSON、正则表达式、工具调用等具有重复前缀的复杂工作流时,能实现极速生成。如果你正在构建智能体或多轮对话系统,并追求远超vLLM的推理性能,SGLang是理想选择。

查看技能