{"id":13456814,"url":"https://github.com/huashengdun/webssh","last_synced_at":"2026-10-18T23:50:04.923Z","repository":{"id":39229263,"uuid":"109987486","full_name":"huashengdun/webssh","owner":"huashengdun","description":":seedling: Web based ssh client","archived":false,"fork":false,"pushed_at":"2025-07-27T13:48:13.000Z","size":1053,"stargazers_count":5147,"open_issues_count":157,"forks_count":1607,"subscribers_count":83,"default_branch":"master","last_synced_at":"2026-10-04T04:32:32.869Z","etag":null,"topics":["asynchronous","paramiko","python","tornado","websockets","xtermjs"],"latest_commit_sha":null,"homepage":"https://webssh.huashengdun.org/","language":"Python","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/huashengdun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"ko_fi":"huashengdun","custom":"https://bit.ly/2XmXXIP"}},"created_at":"2017-11-08T14:37:03.000Z","updated_at":"2026-10-03T07:50:56.000Z","dependencies_parsed_at":"2024-01-11T17:47:27.673Z","dependency_job_id":"260666bc-1a79-4135-b550-04ac59a0de18","html_url":"https://github.com/huashengdun/webssh","commit_stats":{"total_commits":463,"total_committers":17,"mean_commits":"27.235294117647058","dds":0.06263498920086397,"last_synced_commit":"04a9bd5efff535ab5d80b2dbbedfe146dea4f86c"},"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"purl":"pkg:github/huashengdun/webssh","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huashengdun%2Fwebssh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huashengdun%2Fwebssh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huashengdun%2Fwebssh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huashengdun%2Fwebssh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/huashengdun","download_url":"https://codeload.github.com/huashengdun/webssh/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huashengdun%2Fwebssh/sbom","scorecard":{"id":471772,"data":{"date":"2025-08-11","repo":{"name":"github.com/huashengdun/webssh","commit":"aaac2afe2a0d0c2fb8a8fd0813462d354682888a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.1,"checks":[{"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":"Maintained","score":5,"reason":"5 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":2,"reason":"Found 5/20 approved changesets -- score normalized to 2","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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/python.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/python.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/huashengdun/webssh/python.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/huashengdun/webssh/python.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/huashengdun/webssh/python.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/huashengdun/webssh/python.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/huashengdun/webssh/python.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating python:3-alpine to python:3-alpine@sha256:af1fd7a973d8adc761ee6b9d362b99329b39eb096ea3c53b8838f99bd187011e","Warn: pipCommand not pinned by hash: Dockerfile:8-14","Warn: pipCommand not pinned by hash: .github/workflows/python.yml:14","Warn: pipCommand not pinned by hash: .github/workflows/python.yml:26","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   3 pipCommand 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":-1,"reason":"no releases found","details":null,"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":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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"}}]},"last_synced_at":"2025-08-19T14:05:10.968Z","repository_id":39229263,"created_at":"2025-08-19T14:05:10.968Z","updated_at":"2025-08-19T14:05:10.968Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38343425,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-18T02:00:06.448Z","response_time":63,"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":["asynchronous","paramiko","python","tornado","websockets","xtermjs"],"created_at":"2024-07-31T08:01:28.237Z","updated_at":"2026-10-18T23:50:04.911Z","avatar_url":"https://github.com/huashengdun.png","language":"Python","funding_links":["https://ko-fi.com/huashengdun","https://bit.ly/2XmXXIP"],"categories":["Python","User Interface","Other","Python (1887)","python","Projects"],"sub_categories":["Applications and End User Tools","Open Source Projects"],"readme":"## WebSSH\n\n[![python](https://github.com/huashengdun/webssh/actions/workflows/python.yml/badge.svg)](https://github.com/huashengdun/webssh/actions/workflows/python.yml)\n[![codecov](https://raw.githubusercontent.com/huashengdun/webssh/coverage-badge/coverage.svg)](https://raw.githubusercontent.com/huashengdun/webssh/coverage-badge/coverage.svg)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/webssh.svg)\n![PyPI](https://img.shields.io/pypi/v/webssh.svg)\n\n\n### Introduction\n\nA simple web application to be used as an ssh client to connect to your ssh servers. It is written in Python, base on tornado, paramiko and xterm.js.\n\n### Features\n\n* SSH password authentication supported, including empty password.\n* SSH public-key authentication supported, including DSA RSA ECDSA Ed25519 keys.\n* Encrypted keys supported.\n* Two-Factor Authentication (time-based one-time password) supported.\n* Fullscreen terminal supported.\n* Terminal window resizable.\n* Auto detect the ssh server's default encoding.\n* Modern browsers including Chrome, Firefox, Safari, Edge, Opera supported.\n\n\n### Preview\n\n![Login](preview/login.png)\n![Terminal](preview/terminal.png)\n\n\n### How it works\n```\n+---------+     http     +--------+    ssh    +-----------+\n| browser | \u003c==========\u003e | webssh | \u003c=======\u003e | ssh server|\n+---------+   websocket  +--------+    ssh    +-----------+\n```\n\n### Requirements\n\n* Python 3.10+\n\n\n### Quickstart\n\n1. Install this app, run command `pip install webssh`\n2. Start a webserver, run command `wssh`\n3. Open your browser, navigate to `127.0.0.1:8888`\n4. Input your data, submit the form.\n\n\n### Server options\n\n```bash\n# start a http server with specified listen address and listen port\nwssh --address='2.2.2.2' --port=8000\n\n# start a https server, certfile and keyfile must be passed\nwssh --certfile='/path/to/cert.crt' --keyfile='/path/to/cert.key'\n\n# missing host key policy\nwssh --policy=reject\n\n# logging level\nwssh --logging=debug\n\n# log to file\nwssh --log-file-prefix=main.log\n\n# more options\nwssh --help\n```\n\n### Browser console\n\n```javascript\n// connect to your ssh server\nwssh.connect(hostname, port, username, password, privatekey, passphrase, totp);\n\n// pass an object to wssh.connect\nvar opts = {\n  hostname: 'hostname',\n  port: 'port',\n  username: 'username',\n  password: 'password',\n  privatekey: 'the private key text',\n  passphrase: 'passphrase',\n  totp: 'totp'\n};\nwssh.connect(opts);\n\n// without an argument, wssh will use the form data to connect\nwssh.connect();\n\n// set a new encoding for client to use\nwssh.set_encoding(encoding);\n\n// reset encoding to use the default one\nwssh.reset_encoding();\n\n// send a command to the server\nwssh.send('ls -l');\n```\n\n### Custom Font\n\nTo use custom font, put your font file in the directory `webssh/static/css/fonts/` and restart the server.\n\n### URL Arguments\n\nSupport passing arguments by url (query or fragment) like following examples:\n\nPassing form data (password must be encoded in base64, privatekey not supported)\n```bash\nhttp://localhost:8888/?hostname=xx\u0026username=yy\u0026password=str_base64_encoded\n```\n\nPassing a terminal background color\n```bash\nhttp://localhost:8888/#bgcolor=green\n```\n\nPassing a terminal font color\n```bash\nhttp://localhost:8888/#fontcolor=red\n```\n\nPassing a user defined title\n```bash\nhttp://localhost:8888/?title=my-ssh-server\n```\n\nPassing an encoding\n```bash\nhttp://localhost:8888/#encoding=gbk\n```\n\nPassing a font size\n```bash\nhttp://localhost:8888/#fontsize=24\n```\n\nPassing a command executed right after login\n```bash\nhttp://localhost:8888/?command=pwd\n```\n\nPassing a terminal type\n```bash\nhttp://localhost:8888/?term=xterm-256color\n```\n\n### Use Docker\n\nStart up the app\n```\ndocker-compose up\n```\n\nTear down the app\n```\ndocker-compose down\n```\n\n### Tests\n\nRequirements\n```\npip install pytest pytest-cov codecov flake8 mock\n```\n\nUse unittest to run all tests\n```\npython -m unittest discover tests\n```\n\nUse pytest to run all tests\n```\npython -m pytest tests\n```\n\n### Deployment\n\nRunning behind an Nginx server\n\n```bash\nwssh --address='127.0.0.1' --port=8888 --policy=reject\n```\n```nginx\n# Nginx config example\nlocation / {\n    proxy_pass http://127.0.0.1:8888;\n    proxy_http_version 1.1;\n    proxy_read_timeout 300;\n    proxy_set_header Upgrade $http_upgrade;\n    proxy_set_header Connection \"upgrade\";\n    proxy_set_header Host $http_host;\n    proxy_set_header X-Real-IP $remote_addr;\n    proxy_set_header X-Real-PORT $remote_port;\n}\n```\n\nRunning as a standalone server\n```bash\nwssh --port=8080 --sslport=4433 --certfile='cert.crt' --keyfile='cert.key' --xheaders=False --policy=reject\n```\n\n\n### Tips\n\n* For whatever deployment choice you choose, don't forget to enable SSL.\n* By default plain http requests from a public network will be either redirected or blocked and being redirected takes precedence over being blocked.\n* Try to use reject policy as the missing host key policy along with your verified known_hosts, this will prevent man-in-the-middle attacks. The idea is that it checks the system host keys file(\"~/.ssh/known_hosts\") and the application host keys file(\"./known_hosts\") in order, if the ssh server's hostname is not found or the key is not matched, the connection will be aborted.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuashengdun%2Fwebssh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhuashengdun%2Fwebssh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuashengdun%2Fwebssh/lists"}