Home

Awesome

Yet Another Shadow Socket

yass is an efficient forward proxy client supporting http/socks4/socks4a/socks5/socks5h protocol running on PC and mobile devices.

Report if you find any bug in this product

Releases

GitHub release (latest SemVer) Language: C++ GitHub release (latest by SemVer)

Because we are reusing chromium's network stack directly, we are following chromium's release schedule and delivering new versions based on its beta branch.

Report here if you find new network protocol/modification here and there, likely outside Chromium and curl

Prebuilt binaries (Supported platforms)

aur yass-proxy-gtk3 aur yass-proxy-qt5 aur yass-proxy aur yass-proxy-qt6

See Status of Package Store for more.

aur yass-proxy-cli

Flathub: available at latest version (Qt5, report if you need Qt6 version), require Flatpak installed).

Flathub Version Flathub Downloads

Report here if you need new features

Prebuilt binaries (Supported legacy platforms)

See Supporteded Operating System for more.

Report here if you need to run outside the OS in the table

Special Note: for legacy supported platforms, bugs will be fixed ASAP while feature request is a time-consuming task and it is expected that it would be delayed in a proper and unlimited period.

Contribute your translation (i18n)

Please submit translations via Transifex

Steps:

  1. Create a free account on Transifex (https://www.transifex.com/).
  2. Send a request to join the language translation.
  3. After accepted by the project maintainer, then you can translate online.

Report here if you want to add new language outside current layout

Build from Source

Take a look at build instructions and packaging instructions.

Report here if you want to build or package in a new distribution/platform

Highlight Features

TLS-Compatible Protocol Support

Cipher http over TLS are compatible.

If you need custom Certificate Authority support in GUI or add other TLS-related features, report here.

Post Quantum key-agreements for TLS 1.3

ML-KEM Post Quantum key-agreements (not enabled by default) for TLS 1.3 is supported on all platforms in place of obsolete Kyber768 hybrid key-agreements.

See Protecting Chrome Traffic with Hybrid Kyber KEM for more.

Socks-Compatible Protocol Support

Cipher socks4 and socks5 are compatible.

Shadowsocket-Compatible Protocol Support

Ciphers released ahead of 2022 are compatible.

NaïveProxy-Compatible Protocol Support

Cipher http2 and https are compatible.

See NaïveProxy's project homepage for support.

Usages

Standard Usages

Visit wiki's Usages.

Report here if you want to add new client-side optimization/usage

Server side support (mostly outside this project)

See Setup forwardproxy caddy service for more.

See Window sizes for large bandwidth for more.

See Use BBR Congestion Control for more.

See ChatGPT capable caddy Server for more.

Report here if you want to add new server-side optimization/cooperation

Debug Guide

Start from wiki's Guide

Build Status

Compiler Compatibility CircleCI Cirrus CI

MinGW Build Linux Build macOS Build

Android Build iOS Build

OpenWRT Build FreeBSD Build RPM Build DEB Build Flatpak Build

MSVC Build Old MinGW Build Clang Tidy

Report here if you want to connect to new CI infrastructure