Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: Add FAQ entries for single cipher support and censorship circumvention #14827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dguido merged 1 commit into master from docs/faq-cipher-censorship
Aug 22, 2025

Conversation

Copy link
Member

@dguido dguido commented Aug 22, 2025

Summary

Context

These FAQs address two long-standing documentation issues that help users understand Algo's security design philosophy:

  1. Single cipher suite: Explains that using only one modern cipher (AES256-GCM with SHA2 and ECP384) eliminates downgrade attacks, reduces complexity, ensures only modern clients connect, and simplifies security audits.

  2. Censorship circumvention: Clarifies that Algo focuses on privacy and security rather than censorship avoidance, explaining the different threat models, legal considerations, and why specialized tools like Tor or Shadowsocks are better suited for that purpose.

Test plan

  • Markdown renders correctly
  • Table of contents links work properly
  • Content is technically accurate based on project documentation

Closes #231
Closes #230

🤖 Generated with Claude Code

Hamled and Heliodex reacted with thumbs up emoji
...vention
- Add FAQ explaining why Algo supports only a single cipher suite (#231)
- Add FAQ clarifying why censorship avoidance is not a goal (#230)
- Update table of contents with new entries
These FAQs address common questions about Algo's security design decisions
and help users understand the project's focused approach to VPN security.
Closes #231
Closes #230
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
Copy link
Contributor

claude bot commented Aug 22, 2025
edited
Loading

Claude finished @dguido's task —— View job


Code Review Complete

I've reviewed the documentation changes in this PR. Overall, this is a well-written addition that addresses important user questions. Here's my detailed feedback:

✅ Strengths

Technical Accuracy: Both FAQ entries are technically sound and align well with Algo's security-first philosophy. The explanations are factually correct and well-researched.

Clear Communication: The content effectively explains complex security concepts in accessible language while maintaining technical precision.

Structure: Good use of numbered lists to break down complex reasoning, making the content scannable and easy to understand.

🔍 Issues Found

Minor Technical Inconsistency

Line 51 & 58: There's a discrepancy in the cipher suite specification:

  • Line 51: AES256-GCM with SHA2 and P-256
  • Line 58: AES256-GCM-SHA512 with ECP384

These appear to be different configurations. Based on the CLAUDE.md context mentioning "secp384r1" for elliptic curve cryptography, the second specification (ECP384/secp384r1) seems more accurate.

Formatting Enhancement Opportunity

Lines 51-57: Consider using a more consistent list format. The current numbered list uses periods, but other FAQ entries use dashes. For consistency with the rest of the document, consider:

- **Eliminating downgrade attacks** - With no weaker ciphers available...
- **Reducing complexity** - A single, well-tested configuration...
- **Ensuring modern clients only** - This approach naturally filters...
- **Simplifying audits** - Security researchers can focus...

Content Suggestion

Line 66: The phrase "break local laws" could be softened to "violate local regulations" for a more professional tone.

✅ What's Working Well

  • Table of contents integration: Both new entries are properly added and will link correctly
  • Cross-referencing: Good use of issue numbers in the PR description
  • Scope appropriateness: Content stays focused on Algo's specific design decisions
  • Educational value: Helps users understand the "why" behind architectural choices

🎯 Recommendations

  1. Clarify the cipher suite specification - Choose one consistent description and verify it matches the actual implementation
  2. Consider the formatting consistency mentioned above
  3. Otherwise, this is ready to merge - the content adds significant value to user documentation

Summary

This PR successfully addresses two long-standing documentation gaps with clear, technically accurate explanations. The minor issues identified don't affect the core value of the contribution. The additions will help users better understand Algo's security design philosophy and set appropriate expectations.

Recommendation: Approve with minor revisions to address the cipher suite inconsistency.


@dguido dguido merged commit 8dc21ce into master Aug 22, 2025
22 checks passed
@dguido dguido deleted the docs/faq-cipher-censorship branch August 22, 2025 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jackivanov jackivanov Awaiting requested review from jackivanov jackivanov is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add an FAQ about why we support only a single cipher Add FAQ entry regarding censorship avoidance

1 participant

AltStyle によって変換されたページ (->オリジナル) /