{"id":31921390,"url":"https://github.com/genshen/wssocks","last_synced_at":"2025-10-13T22:47:06.984Z","repository":{"id":34591079,"uuid":"164198550","full_name":"genshen/wssocks","owner":"genshen","description":"socks5 over websocket","archived":false,"fork":false,"pushed_at":"2023-10-20T08:12:44.000Z","size":1320,"stargazers_count":146,"open_issues_count":27,"forks_count":27,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-06-18T20:23:34.064Z","etag":null,"topics":["firewalls","https-proxy","proxy","socks5","socks5-proxy","tunnel","websocket","websockets"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/genshen.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-05T08:59:41.000Z","updated_at":"2024-06-12T03:13:54.000Z","dependencies_parsed_at":"2024-06-18T20:07:49.646Z","dependency_job_id":null,"html_url":"https://github.com/genshen/wssocks","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/genshen/wssocks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/genshen%2Fwssocks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/genshen%2Fwssocks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/genshen%2Fwssocks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/genshen%2Fwssocks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/genshen","download_url":"https://codeload.github.com/genshen/wssocks/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/genshen%2Fwssocks/sbom","scorecard":{"id":422649,"data":{"date":"2025-08-11","repo":{"name":"github.com/genshen/wssocks","commit":"0794f544ced44878d94ff115b11631e2534f0aa1"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/21 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/go.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/go.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/genshen/wssocks/go.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/go.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/genshen/wssocks/go.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/go.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/genshen/wssocks/go.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/go.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/genshen/wssocks/go.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/go.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/genshen/wssocks/go.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/go.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/genshen/wssocks/go.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:4","Warn: containerImage not pinned by hash: Dockerfile:13","Warn: containerImage not pinned by hash: Dockerfile:34: pin your Docker image by updating alpine:3.13.0 to alpine:3.13.0@sha256:d9a7354e3845ea8466bb00b22224d9116b183e594527fb5b6c3d30bc01a20378","Warn: goCommand not pinned by hash: Dockerfile:20-21","Warn: goCommand not pinned by hash: .github/workflows/go.yml:29","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   3 containerImage dependencies pinned","Info:   0 out of   2 goCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.6.1 not signed: https://api.github.com/repos/genshen/wssocks/releases/114542067","Warn: release artifact v0.5.0 not signed: https://api.github.com/repos/genshen/wssocks/releases/29373978","Warn: release artifact v0.5.0-beta.3 not signed: https://api.github.com/repos/genshen/wssocks/releases/32125171","Warn: release artifact v0.5.0-beta.2 not signed: https://api.github.com/repos/genshen/wssocks/releases/30024352","Warn: release artifact v0.6.1 does not have provenance: https://api.github.com/repos/genshen/wssocks/releases/114542067","Warn: release artifact v0.5.0 does not have provenance: https://api.github.com/repos/genshen/wssocks/releases/29373978","Warn: release artifact v0.5.0-beta.3 does not have provenance: https://api.github.com/repos/genshen/wssocks/releases/32125171","Warn: release artifact v0.5.0-beta.2 does not have provenance: https://api.github.com/repos/genshen/wssocks/releases/30024352"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 15 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"51 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2023-2402 / GHSA-45x7-px36-x8w8","Warn: Project is vulnerable to: GO-2024-3321 / GHSA-v778-237x-gjrc","Warn: Project is vulnerable to: GO-2025-3487 / GHSA-hcg3-q754-cr77","Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27","Warn: Project is vulnerable to: GHSA-4www-5p9h-95mh","Warn: Project is vulnerable to: GHSA-9gqv-wp59-fq42","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3","Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986","Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6","Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v","Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T01:36:06.608Z","repository_id":34591079,"created_at":"2025-08-19T01:36:06.608Z","updated_at":"2025-08-19T01:36:06.608Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017138,"owners_count":26085984,"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","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["firewalls","https-proxy","proxy","socks5","socks5-proxy","tunnel","websocket","websockets"],"created_at":"2025-10-13T22:46:57.532Z","updated_at":"2025-10-13T22:47:06.979Z","avatar_url":"https://github.com/genshen.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# wssocks\n\n![build](https://github.com/genshen/wssocks/workflows/Go/badge.svg)\n[![Go Report Card](https://goreportcard.com/badge/github.com/genshen/wssocks)](https://goreportcard.com/report/github.com/genshen/wssocks)\n![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/genshen/wssocks?logo=docker\u0026sort=date)\n![Docker Image Version (latest semver)](https://img.shields.io/docker/v/genshen/wssocks?sort=semver\u0026logo=docker)\n![Docker Pulls](https://img.shields.io/docker/pulls/genshen/wssocks?logo=docker)\n\n\u003e socks5 over websocket.\n\nwssocks can proxy TCP and UDP(not implemented currently) connections via socks5. But the socks5 data is wrapped in websockets and then sent to server.\n\n## Features\n- **Transfer data through firewalls**  \nIn some network environment, due to the restricts of firewalls, only http(s)/websocket is allowed. wssocks is mainly useful for passing through firewalls. We can access the inner netwrok (such as ssh) behind the firewalls via socks protocol wrapped in websockets.  \n- **High performance**  \nwssocks only create one TCP connection (websocket) per client to handle multiple socks5 connections, which achieves much higher performance.\n- **Easy to use**  \nNo configures, no dependences, just a single executable including client and server.\n\n## Build and install\n```bash\ncd status-web; yarn install; yarn build; cd ../\ngo get -u github.com/rakyll/statik\ncd cmd/server; statik --src=../../status-web/build/; cd ../../\ngo build\ngo install\n```\nYou can also download it from [release](https://github.com/genshen/wssocks/releases) page.\n\n## Quick start\n\n### server side\n```bash\nwssocks server --addr :1088\n```\n### client side\n```bash\nwssocks client --addr :1080 --remote ws://example.com:1088\n# using ssh to connect to example.com which may be behind firewalls.\nssh -o ProxyCommand='nc -x 127.0.0.1:1080 %h %p' user@example.com \n```\n\nAnd set your socks5 server address as `:1080` in your socks5 client (such as [proxifier](https://www.proxifier.com/) or proxy setting in mac's network preferences) if you need to use socks5 proxy in more situations, not only `ssh` in terminal.  \n\n## Advanced usage\n### enable http and https proxy\nYou can also enable http and https proxy by `--http` option(in client side)\nif http(s) proxy in server side is enabled:\n\n```bash\n# client siede\nwssocks client --addr :1080 --remote ws://example.com:1088 --http\n```\nThe http proxy listen address is specified by `--http-addr` in client side (default value is `:1086`),\nand https proxy listen address is the same as socks5 proxy listen address(specified by `--addr` option).\n\nThen you can set server address of http and https proxy as `:1080` \nin your http(s) proxy client (e.g. mac's network preferences).\n\nnote: http(s) proxy is enabled by default in server side, you can disable it in server side \nby `wssocks server --addr :1088 --http=false` .\n\n### Connection key\nIn some cases, you don't want anyone to connect to your wssocks server.\nYou can use connection key to prevent the clients who don't have correct connection authentication.  \nAt server side, just enable flag `--auth`, e.g.:\n```bash\nwssocks server --addr :1088 --auth\n```\nThen it will generate a random connection key.\nYou can also specific a customized connection key via flag `--auth_key`.  \nAt client side, connect to wssocks server via the connection key:\n```bash\nwssocks client --remote ws://example.com:1088 --key YOUR_CONNECTION_KEY\n```\n\n### TSL/SSL support\nMethod 1: \nIn version 0.5.0, transfering data between wssocks client and wssocks server under TSL/SSL protocol is supported.\n\nAt server side, use `--tsl` flag to enable TSL/SSL support, \nand specific path of certificate via `--tls-cert-file` and `--tls-key-file`.\ne.g.\n```bash\nwssocks server --addr :1088 --tsl --tls-cert-file /path/of/certificate-file --tls-key-file /path/of/certificate-key-file\n```\nAt client side, we can then use `wss://example.com:1088` as remote address, for instance.\n\nMethod 2:\nUse nginx reverse proxy, enable ssl and specific certificate file and certificate key file in nginx config.\nFor more information, see issue [#11](https://github.com/genshen/wssocks/issues/11#issuecomment-669324542)).\n\n### Server status\nIn version 0.5.0, we can enable statue page of server by passing `--status` flag at server side (status page is disabled by default).  \nThen, you can get server status in your browser of client side, by visiting http://example.com:1088/status (where example.com:1088 is the address of wssocks server).\n\n### Help\n```\nwssocks --help\nwssocks client --help\nwssocks server --help\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenshen%2Fwssocks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenshen%2Fwssocks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenshen%2Fwssocks/lists"}