mirror of
https://github.com/bolucat/Archive.git
synced 2026-04-23 00:17:16 +08:00
github-action[bot]
213 lines
16 KiB
Markdown
213 lines
16 KiB
Markdown
# 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][bugs]
|
|
|
|
## Releases
|
|
|
|
[](https://github.com/Chilledheart/yass/releases)
|
|
[](https://github.com/Chilledheart/yass/search?l=cpp)
|
|
[](https://github.com/Chilledheart/yass/releases/latest)
|
|
|
|
Because we are reusing chromium's network stack directly,
|
|
we are following [chromium's release schedule](https://chromiumdash.appspot.com/schedule) and delivering new versions based on its beta branch.
|
|
|
|
- [Latest M132's Release (1.16.x)](https://github.com/Chilledheart/yass/releases/tag/1.16.2) will become Stable Release since _Jan 14, 2025_ (Extended Support).
|
|
- [Latest M131's Release (1.15.x)](https://github.com/Chilledheart/yass/releases/tag/1.15.4) has become Stable Release since _Nov 12, 2024_.
|
|
- [Latest M130's Release (1.14.x)](https://github.com/Chilledheart/yass/releases/tag/1.14.5) has become Stable Release since _Oct 15, 2024_ (Extended Support).
|
|
- [Latest M129's Release (1.13.x)](https://github.com/Chilledheart/yass/releases/tag/1.13.3) has become Stable Release since _Sep 17, 2024_.
|
|
- [Latest M128's Release (1.12.x)](https://github.com/Chilledheart/yass/releases/tag/1.12.5) has become Stable Release since _Aug 20, 2024_ (Extended Support).
|
|
- [Latest M127's Release (1.11.x)](https://github.com/Chilledheart/yass/releases/tag/1.11.5) has become Stable Release since _Jul 23, 2024_.
|
|
- [Latest M126's Release (1.10.x)](https://github.com/Chilledheart/yass/releases/tag/1.10.7) has become Stable Release since _Jun 11, 2024_ (Extended Support).
|
|
- [Latest M125's Release (1.9.x)](https://github.com/Chilledheart/yass/releases/tag/1.9.7) has become Stable Release since _May 14, 2024_.
|
|
- [Latest M124's Release (1.8.x)](https://github.com/Chilledheart/yass/releases/tag/1.8.7) has become Stable Release since _Apr 16, 2024_ (Extended Support).
|
|
- [Latest M123's Release (1.7.x)](https://github.com/Chilledheart/yass/releases/tag/1.7.7) has become Stable Release since _Mar 19, 2024_.
|
|
- [Latest M122's Release (1.6.x)](https://github.com/Chilledheart/yass/releases/tag/1.6.5) has become Stable Release since _Feb 20, 2024_ (Extended Support).
|
|
- [Latest M121's Release (1.5.x)](https://github.com/Chilledheart/yass/releases/tag/1.5.24) has become Stable Release since _Jan 23, 2024_.
|
|
|
|
[Report here if you find new network protocol/modification here and there, likely outside Chromium and curl][frs]
|
|
|
|
### Prebuilt binaries (Supported platforms)
|
|
- GTK3 [download rpm][gtk3_rpm_url] or [download deb][gtk3_deb_url] (minimum requirement: _CentOS 8_ or _Ubuntu 16.04_)
|
|
- Qt5 [download rpm][qt5_rpm_url] or [download deb][qt5_deb_url] (minimum requirement: _CentOS 8_ or _Ubuntu 16.04_)
|
|
- GTK4 [download rpm][gtk4_rpm_url] or [download deb][gtk4_deb_url] (minimum requirement: _openSUSE Leap 15.5_, _CentOS 9_ or _Ubuntu 22.04_)
|
|
- Qt6 [download rpm][qt6_rpm_url] or [download deb][qt6_deb_url] (minimum requirement: _openSUSE Leap 15.5_, _CentOS 9_ with epel or _Ubuntu 22.04_)
|
|
|
|
[](https://aur.archlinux.org/packages/yass-proxy-gtk3)
|
|
[](https://aur.archlinux.org/packages/yass-proxy-qt5)
|
|
[](https://aur.archlinux.org/packages/yass-proxy)
|
|
[](https://aur.archlinux.org/packages/yass-proxy-qt6)
|
|
|
|
See [Status of Package Store](https://github.com/Chilledheart/yass/wiki/Status-of-Package-Store) for more.
|
|
|
|
- CLI [download tgz for amd64][cli_tgz_amd64_url] or [download tgz for i386][cli_tgz_i386_url] or [download tgz for arm64][cli_tgz_arm64_url] (require glibc >= 2.25)
|
|
- CLI [download tgz for loongarch64][cli_tgz_loongarch64_url] (require glibc >= 2.38, _new world_)
|
|
- CLI [download tgz for riscv64][cli_tgz_riscv64_url] or [download tgz for riscv32][cli_tgz_riscv32_url] (require glibc >= 2.36)
|
|
- CLI(openwrt) [download tgz for amd64][cli_openwrt_amd64_url] or [download tgz for i486][cli_openwrt_i486_url] or [download tgz for aarch64 generic][cli_openwrt_aarch64_url] (static build, no madvise support required)
|
|
- CLI(musl) [download tgz for amd64][cli_musl_amd64_url] or [download tgz for i386][cli_musl_i386_url] or [download tgz for aarch64][cli_musl_aarch64_url] or [download tgz for armhf][cli_musl_armhf_url] (static build, no madvise support required)
|
|
|
|
[](https://aur.archlinux.org/packages/yass-proxy-cli)
|
|
|
|
- Flatpak for Linux (Qt6) [download flatpak][qt6_flatpak_x86_64_url] for _x86_64_ only.
|
|
|
|
[Flathub][flathub_url]: available at latest version (Qt5, [report if you need Qt6 version][frs]), require [Flatpak][flatpak_setup_url] installed).
|
|
|
|
[][flathub_url]
|
|
[][flathub_url]
|
|
|
|
[Report here if you need new features][frs]
|
|
|
|
### Prebuilt binaries (Supported legacy platforms)
|
|
|
|
- Legacy Android [download 64-bit apk][android_64_apk_url] or [download 32-bit apk][android_32_apk_url] (require _Android 7.0_ or above)
|
|
- Legacy iOS [Continue to accept TestFlight invitation][ios_testflight_invitation] (require [TestFlight][ios_testflight_appstore_url] from _AppStore_, and _iOS 13.0_ or above)
|
|
- Legacy Windows [download 64-bit installer][windows_64_installer_url] (require [KB2999226] on _windows 7/8/8.1_) or [download 32-bit installer][windows_32_installer_url] (require [vc 2010 runtime][vs2010_x86] on _windows xp sp3_) or [download arm64 installer][windows_arm64_installer_url] (require _windows 10/11_)
|
|
- Legacy macOS [download intel dmg][macos_intel_dmg_url] or [download apple silicon dmg][macos_arm_dmg_url] (require _macOS 10.14_ or above)
|
|
|
|
See [Supporteded Operating System](https://github.com/Chilledheart/yass/wiki/Supported-Operating-System) for more.
|
|
|
|
[Report here if you need to run outside the OS in the table][frs]
|
|
|
|
Special Note: for legacy supported platforms, [bugs][bugs] will be fixed ASAP while [feature request][frs] 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][transifex]
|
|
|
|
Steps:
|
|
|
|
1. Create a free account on [Transifex][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][frs]
|
|
|
|
### Build from Source
|
|
Take a look at [build instructions](BUILDING.md) and [packaging instructions](PACKAGING.md).
|
|
|
|
[Report here if you want to build or package in a new distribution/platform][frs]
|
|
|
|
## 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][frs].
|
|
|
|
### Post Quantum key-agreements for TLS 1.3
|
|
[ML-KEM Post Quantum key-agreements][mlkem] (not enabled by default) for TLS 1.3 is supported on all platforms
|
|
in place of obsolete [Kyber768 hybrid key-agreements][kyber].
|
|
|
|
See [Protecting Chrome Traffic with Hybrid Kyber KEM](https://blog.chromium.org/2023/08/protecting-chrome-traffic-with-hybrid.html) 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](https://github.com/klzgrad/naiveproxy)'s project homepage for support.
|
|
|
|
## Usages
|
|
|
|
### Standard Usages
|
|
Visit wiki's [Usages](https://github.com/Chilledheart/yass/wiki/Usage).
|
|
|
|
[Report here if you want to add new client-side optimization/usage][frs]
|
|
|
|
### Server side support (mostly outside this project)
|
|
|
|
See [Setup forwardproxy caddy service](https://github.com/Chilledheart/yass/wiki/Usage:-server-setup#setup-forwardproxy-caddy-service) for more.
|
|
|
|
See [Window sizes for large bandwidth](https://github.com/Chilledheart/yass/wiki/Usage:-server-setup#window-sizes-for-large-bandwidth) for more.
|
|
|
|
See [Use BBR Congestion Control](https://github.com/Chilledheart/yass/wiki/Usage:-server-setup#use-bbr-congestion-control) for more.
|
|
|
|
See [ChatGPT capable caddy Server](https://github.com/Chilledheart/yass/wiki/Usage:-server-setup#chatgpt-capable-caddy-server) for more.
|
|
|
|
[Report here if you want to add new server-side optimization/cooperation][frs]
|
|
|
|
### Debug Guide
|
|
Start from wiki's [Guide](https://github.com/Chilledheart/yass/wiki/Debug-Guide)
|
|
|
|
## Build Status
|
|
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/compiler.yml)
|
|
[](https://circleci.com/gh/Chilledheart/yass/?branch=develop)
|
|
[](https://cirrus-ci.com/github/Chilledheart/yass/develop)
|
|
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-mingw-new.yml)
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-linux-binary.yml)
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-macos.yml)
|
|
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-android-binary.yml)
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-ios.yml)
|
|
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-openwrt-binary.yml)
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-freebsd-binary.yml)
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-rpm.yml)
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-deb.yml)
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-flatpak.yml)
|
|
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-windows.yml)
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/releases-mingw.yml)
|
|
[](https://github.com/Chilledheart/yass/actions/workflows/clang-tidy.yml)
|
|
|
|
[Report here if you want to connect to new CI infrastructure][frs]
|
|
|
|
[flathub_url]: https://flathub.org/apps/io.github.chilledheart.yass
|
|
[flatpak_setup_url]: https://flatpak.org/setup/
|
|
[ios_testflight_invitation]: https://testflight.apple.com/join/6AkiEq09
|
|
[ios_testflight_appstore_url]: https://apps.apple.com/us/app/testflight/id899247664
|
|
[KB2999226]: https://support.microsoft.com/en-us/topic/update-for-universal-c-runtime-in-windows-c0514201-7fe6-95a3-b0a5-287930f3560c
|
|
[vs2010_x86]: https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x86.exe
|
|
[transifex]: https://app.transifex.com/yetanothershadowsocket/yetanothershadowsocket
|
|
|
|
[bugs]: https://github.com/Chilledheart/yass/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=
|
|
[frs]: https://github.com/Chilledheart/yass/issues/new?assignees=&labels=feature&projects=&template=feature_request.md&title=
|
|
|
|
[mlkem]: https://datatracker.ietf.org/doc/draft-connolly-tls-mlkem-key-agreement/
|
|
[kyber]: https://datatracker.ietf.org/doc/draft-tls-westerbaan-xyber768d00/
|
|
|
|
[gtk3_rpm_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-gtk3.el8.x86_64.1.16.2.rpm
|
|
[gtk3_deb_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-gtk3-ubuntu-16.04-xenial_amd64.1.16.2.deb
|
|
[qt5_rpm_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-qt5.el8.x86_64.1.16.2.rpm
|
|
[qt5_deb_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-qt5-ubuntu-16.04-xenial_amd64.1.16.2.deb
|
|
[gtk4_rpm_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-gtk4.lp155.x86_64.1.16.2.rpm
|
|
[gtk4_deb_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-gtk4-ubuntu-22.04-jammy_amd64.1.16.2.deb
|
|
[qt6_rpm_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-qt6.lp155.x86_64.1.16.2.rpm
|
|
[qt6_deb_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-qt6-ubuntu-22.04-jammy_amd64.1.16.2.deb
|
|
|
|
[qt6_flatpak_x86_64_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-x86_64-1.16.2.flatpak
|
|
|
|
[cli_tgz_amd64_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-release-amd64-1.16.2.tgz
|
|
[cli_tgz_i386_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-release-amd64-1.16.2.tgz
|
|
[cli_tgz_arm64_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-release-arm64-1.16.2.tgz
|
|
[cli_tgz_loongarch64_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-release-loongarch64-1.16.2.tgz
|
|
[cli_tgz_riscv64_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-release-riscv64-1.16.2.tgz
|
|
[cli_tgz_riscv32_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-release-riscv32-1.16.2.tgz
|
|
|
|
[cli_openwrt_amd64_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-openwrt-release-x86_64-1.16.2.tgz
|
|
[cli_openwrt_i486_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-openwrt-release-i486-1.16.2.tgz
|
|
[cli_openwrt_aarch64_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-openwrt-release-aarch64-1.16.2.tgz
|
|
|
|
[cli_musl_amd64_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-musl-release-amd64-1.16.2.tgz
|
|
[cli_musl_i386_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-musl-release-i386-1.16.2.tgz
|
|
[cli_musl_aarch64_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-musl-release-aarch64-1.16.2.tgz
|
|
[cli_musl_armhf_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass_cli-linux-musl-release-armhf-1.16.2.tgz
|
|
|
|
[android_64_apk_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-android-release-arm64-1.16.2.apk
|
|
[android_32_apk_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-android-release-arm-1.16.2.apk
|
|
|
|
[windows_64_installer_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-mingw-win7-release-x86_64-1.16.2-system-installer.exe
|
|
[windows_32_installer_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-mingw-winxp-release-i686-1.16.2-system-installer.exe
|
|
|
|
[windows_arm64_installer_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-mingw-release-aarch64-1.16.2-system-installer.exe
|
|
[macos_intel_dmg_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-macos-release-x64-1.16.2.dmg
|
|
[macos_arm_dmg_url]: https://github.com/Chilledheart/yass/releases/download/1.16.2/yass-macos-release-arm64-1.16.2.dmg
|