Skip to content

docs: add security best practices guide#171

Open
DrGalio wants to merge 1 commit intoANAVHEOBA:mainfrom
DrGalio:docs/security-best-practices
Open

docs: add security best practices guide#171
DrGalio wants to merge 1 commit intoANAVHEOBA:mainfrom
DrGalio:docs/security-best-practices

Conversation

@DrGalio
Copy link
Copy Markdown

@DrGalio DrGalio commented Mar 26, 2026

Summary

Adds a comprehensive Security Best Practices guide for PrivacyLayer users, addressing the bounty in #47.

What's Included

The guide covers all six required sections from the bounty:

  1. Note Management — Backup strategies (encrypted USB, password manager, paper, encrypted cloud), why notes must never be shared, and the hard truth that recovery is impossible.

  2. Privacy Practices — Recommended wait times between deposit/withdrawal based on pool size, address separation strategy, pattern avoidance, and network privacy tools (Tor, VPN, own node).

  3. Operational Security — Hardware wallet usage, transaction metadata awareness, browser fingerprinting mitigation, and smart contract interaction hygiene.

  4. Common Mistakes — Five documented anti-patterns with visual diagrams: address reuse, immediate withdrawals, small anonymity sets, address linking, and insufficient backups.

  5. Threat Model — Clear breakdown of what PrivacyLayer does and does NOT protect against, plus five known attack vectors (timing analysis, denomination fingerprinting, relayer centralization, frontend compromise, trusted setup compromise).

  6. Emergency Procedures — Practical steps for lost notes, compromised wallets, paused contracts, and suspected vulnerabilities.

Acceptance Criteria Met

  • Complete guide written (2,800+ words)
  • Clear examples and visual aids (ASCII diagrams, tables, flowcharts)
  • User-friendly language (glossary included, no assumed crypto knowledge)
  • Clean markdown, no broken links

Notes

  • All examples use PrivacyLayer's actual architecture (Poseidon commitments, BN254/Groth16 proofs, fixed denominations).
  • Threat model references the contract's actual pause() function and admin role.
  • Terminology matches the project's existing README and CONTRIBUTING.md.

Closes #47

Comprehensive user-facing guide covering:
- Note management (backup strategies, recovery impossibility)
- Privacy practices (timing, address separation, network privacy)
- Operational security (wallet, transaction privacy, browser fingerprinting)
- Common mistakes (address reuse, immediate withdrawals, small anonymity sets)
- Threat model (what is/isn't protected, known attack vectors)
- Emergency procedures (lost note, compromised wallet, contract paused)

Closes ANAVHEOBA#47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BOUNTY] Write Security Best Practices Guide

1 participant