{"id":13775905,"url":"https://github.com/ehco1996/aioshadowsocks","last_synced_at":"2025-09-27T05:31:40.448Z","repository":{"id":38361584,"uuid":"142556060","full_name":"Ehco1996/aioshadowsocks","owner":"Ehco1996","description":"用 asyncio 重写 shadowsocks ~","archived":true,"fork":false,"pushed_at":"2022-11-23T04:10:47.000Z","size":2977,"stargazers_count":168,"open_issues_count":20,"forks_count":96,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-01-09T23:07:58.470Z","etag":null,"topics":["asyncio","shadowsocks"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ehco1996.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-27T09:20:00.000Z","updated_at":"2024-06-13T01:13:41.000Z","dependencies_parsed_at":"2022-08-25T04:50:40.191Z","dependency_job_id":null,"html_url":"https://github.com/Ehco1996/aioshadowsocks","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ehco1996%2Faioshadowsocks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ehco1996%2Faioshadowsocks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ehco1996%2Faioshadowsocks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ehco1996%2Faioshadowsocks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ehco1996","download_url":"https://codeload.github.com/Ehco1996/aioshadowsocks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234391382,"owners_count":18824810,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asyncio","shadowsocks"],"created_at":"2024-08-03T17:01:54.136Z","updated_at":"2025-09-27T05:31:40.084Z","avatar_url":"https://github.com/Ehco1996.png","language":"Python","funding_links":[],"categories":["\u003ca id=\"d03d494700077f6a65092985c06bf8e8\"\u003e\u003c/a\u003e工具"],"sub_categories":["\u003ca id=\"cb16466a31a167bb61f39e2a4a85f449\"\u003e\u003c/a\u003eShadowsocks"],"readme":"# aioshadowsocks\n\n用 asyncio 重写 shadowsocks\n\n![Publish Docker](https://github.com/Ehco1996/aioshadowsocks/workflows/Publish%20Docker/badge.svg?branch=master)\n\n## 视频安装教程\n\n* 面板视频安装教程: [地址](https://youtu.be/BRHcdGeufvY)\n\n* 后端对接视频教程: [地址](https://youtu.be/QNbnya1HHU0)\n\n* 隧道对接视频教程: [地址](https://youtu.be/R4U0NZaMUeY)\n\n## 使用\n\n* 安装\n\n``` sh\npip install aioshadowsocks\n```\n\n* 多用户配置\n\naioshadowsocks 将json作为配置文件, 会读取当前目录下 `userconfigs.json` 作为默认的配置文件\n\n``` json\n{\n    \"users\": [\n        {\n            \"user_id\": 1,\n            \"port\": 2345,\n            \"method\": \"none\",\n            \"password\": \"hellotheworld1\",\n            \"transfer\": 104857600,\n            \"speed_limit\": 0\n        },\n        {\n            \"user_id\": 2,\n            \"port\": 2346,\n            \"method\": \"chacha20-ietf-poly1305\",\n            \"password\": \"hellotheworld2\",\n            \"transfer\": 104857600,\n            \"speed_limit\": 384000\n        }\n    ]\n}\n```\n\n同时也支持从http服务器读取配置文件，这时需要注入环境变量 `SS_API_ENDPOINT` 作为读取配置的api地址\n\n* 注入环境变量\n\n `export SS_API_ENDPOINT=\"https://xxx/com\"`\n\n* 启动ss服务器\n\n``` bash\naioss run_ss_server\n```\n\n## Docker Version\n\n1. install docker\n\n``` sh\ncurl -sSL https://get.docker.com/ | sh\n```\n\n2. install docker-compose\n\n``` sh\nsudo curl -L \"https://github.com/docker/compose/releases/download/1.23.2/docker-compose-$(uname -s)-$(uname -m)\" -o /usr/local/bin/docker-compose\n```\n\n3. apply executable permissions\n\n``` sh\nsudo chmod +x /usr/local/bin/docker-compose\n```\n\n4. run server\n\n``` sh\ndocker-compose up\n```\n\n## 为什么要重写shadowsocks\n\n主要想通过这个项目的推进来深入了解 `asyncio`\n\n另外我的一个项目: [django-sspanel](https://github.com/Ehco1996/django-sspanel) 依赖 `shadowsocksr`\n\n但该项目已经停止开发了，所以决定重新造个轮子\n\n## 主要功能\n\n* tcp/udp 代理\n* 流量统计\n* 速率控制\n* 开放了grpc接口(类似ss-manager)\n* **单端口多用户（利用AEAD加密在不破坏协议的情况下实现）**\n* **prometheus/grafana metrics监控** （dashboard在项目的static/grafana/文件夹下）\n\n## 监控dashboard\n\n![](static/images/1.png)\n\n![](statoc/images/2.png)\n\n![](static/images/3.png)\n\n## 性能测试\n\n\u003e Shadowsocks本身是一个IO密集行的应用，但是由于加入了AEAD加密，使得SS本身变成了CPU密集行的应用\n\u003e 而Python本身是不太适合CPU密集的场景的，所以在AEAD模式中的表现不佳\n\u003e PS: 当然，其实是我代码写的烂，python不背锅\n\n* Steam-Cipher-None(不加密 高IO)\n\n![](static/images/stream-none.png)\n\n* AEAD-Cipher-CHACHA-20(加密 高CPU)\n\n![](static/images/aead-chacha-20-ietf-poly-1305.png)\n\n## rpc proto\n\n``` protobuf\nsyntax = \"proto3\";\n\npackage aioshadowsocks;\n\n// REQ\nmessage UserIdReq { int32 user_id = 1; }\nmessage PortReq { int32 port = 1; }\n\nmessage UserReq {\n  int32 user_id = 1;\n  int32 port = 2;\n  string method = 3;\n  string password = 4;\n  bool enable = 5;\n}\n\n// RES\nmessage Empty {}\n\nmessage User {\n  int32 user_id = 1;\n  int32 port = 2;\n  string method = 3;\n  string password = 4;\n  bool enable = 5;\n  int32 speed_limit = 6;\n  int32 access_order = 7;\n  bool need_sync = 8;\n  repeated string ip_list = 9;\n  int32 tcp_conn_num = 10;\n  int64 upload_traffic = 11;\n  int64 download_traffic = 12;\n}\n\n// service\nservice ss {\n  rpc CreateUser(UserReq) returns (User) {}\n  rpc UpdateUser(UserReq) returns (User) {}\n  rpc GetUser(UserIdReq) returns (User) {}\n  rpc DeleteUser(UserIdReq) returns (Empty) {}\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehco1996%2Faioshadowsocks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehco1996%2Faioshadowsocks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehco1996%2Faioshadowsocks/lists"}