{"id":37211842,"url":"https://github.com/treeder/sshttp","last_synced_at":"2026-01-15T00:12:18.317Z","repository":{"id":21583266,"uuid":"24903249","full_name":"treeder/sshttp","owner":"treeder","description":null,"archived":false,"fork":false,"pushed_at":"2016-01-28T09:15:29.000Z","size":11,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-06-20T00:33:17.808Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/treeder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-10-07T17:48:06.000Z","updated_at":"2017-01-04T21:25:36.000Z","dependencies_parsed_at":"2022-07-22T13:02:15.282Z","dependency_job_id":null,"html_url":"https://github.com/treeder/sshttp","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/treeder/sshttp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treeder%2Fsshttp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treeder%2Fsshttp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treeder%2Fsshttp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treeder%2Fsshttp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/treeder","download_url":"https://codeload.github.com/treeder/sshttp/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treeder%2Fsshttp/sbom","scorecard":{"id":897694,"data":{"date":"2025-08-11","repo":{"name":"github.com/treeder/sshttp","commit":"1fa60e62391122d322ebb00249f941cbc69a3832"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.1,"checks":[{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"Code-Review","score":0,"reason":"Found 0/6 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":"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":-1,"reason":"no workflows found","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":"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":"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":"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":"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":"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":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating iron/base to iron/base@sha256:81f97f851059d087c64de5b7921da38383681224ac701a25bd9b8271f34a4d81","Info:   0 out of   1 containerImage 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.0.1 not signed: https://api.github.com/repos/treeder/sshttp/releases/609784","Warn: release artifact v0.0.1 does not have provenance: https://api.github.com/repos/treeder/sshttp/releases/609784"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"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":"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"}}]},"last_synced_at":"2025-08-24T14:21:51.969Z","repository_id":21583266,"created_at":"2025-08-24T14:21:51.969Z","updated_at":"2025-08-24T14:21:51.969Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28439626,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T22:37:52.437Z","status":"ssl_error","status_checked_at":"2026-01-14T22:37:31.496Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2026-01-15T00:12:17.681Z","updated_at":"2026-01-15T00:12:18.305Z","avatar_url":"https://github.com/treeder.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"sshttp\n============\n\nsshttp provides a REST/HTTP API for interacting with a computer, sorta SSH over HTTP. sshttp is written in [the Go Programming Language](http://golang.org/).\n\n## Quick Start\n\n```sh\ndocker run --rm -p 8022:8022 treeder/sshttp -t SECRET_TOKEN\n```\n\nTODO: Change token input to an env var. \n\n## Authentication\n\nsshttp currently uses a very simple method for authenticating API requests. The daemon may be configured to require authentication at runtime using the `-t` switch. This token may be any arbitrary string at the time of this writing.\n\n**Example Query with Parameter**:\n\n`GET https://nodename.com:7780/v1/system?token=abc4c7c627376858`\n\n## Requests\n\nRequests to the API are simple HTTP requests against the API endpoints.\n\nAll request bodies should be in JSON, with Content-Type of `application/json`.\n\n### Base URL\n\nA few parameters may be set at runtime which will affect the bare URL that you will use as the prefix for the desired endpoint.\n\n* `-ssl`: Enforce encryption of communication with the API\n* `-p`: Specify the port for communication with the API (defaults to 8022)\n\nAll endpoints should be prefixed with something similar to the following:\n\n`{scheme}://{nodename}:{port}/v1`\n\n\n## Endpoints\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth\u003eURI\u003c/th\u003e\n    \u003cth\u003eHTTP Verb\u003c/th\u003e\n    \u003cth\u003ePurpose\u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e/system\u003c/td\u003e\n    \u003ctd\u003eGET\u003c/td\u003e\n    \u003ctd\u003eList all available resources\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e/system/host\u003c/td\u003e\n    \u003ctd\u003eGET\u003c/td\u003e\n    \u003ctd\u003eList node hostname\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e/system/disk\u003c/td\u003e\n    \u003ctd\u003eGET\u003c/td\u003e\n    \u003ctd\u003eList node disk usage\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e/system/processes\u003c/td\u003e\n    \u003ctd\u003eGET\u003c/td\u003e\n    \u003ctd\u003eList of processes\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e/system/load\u003c/td\u003e\n    \u003ctd\u003eGET\u003c/td\u003e\n    \u003ctd\u003eList node load averages\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e/system/ram\u003c/td\u003e\n    \u003ctd\u003eGET\u003c/td\u003e\n    \u003ctd\u003eList node RAM usage\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e/shell\u003c/td\u003e\n    \u003ctd\u003eGET\u003c/td\u003e\n    \u003ctd\u003eExecute arbitrary shell commands on the node\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e/files\u003c/td\u003e\n    \u003ctd\u003eGET\u003c/td\u003e\n    \u003ctd\u003eGet list of files/dirs or get content of file (if file specified)\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e/files\u003c/td\u003e\n    \u003ctd\u003ePOST\u003c/td\u003e\n    \u003ctd\u003eWrite file to specified dir or create dir if file not specified\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e/files\u003c/td\u003e\n    \u003ctd\u003eDELETE\u003c/td\u003e\n    \u003ctd\u003eDelete file or dir(recursive)\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\n## Responses\n\nAll responses are in JSON, with Content-Type of `application/json`. A response is structured as follows:\n\n`{ \"resource_name\": \"resource value\" }`\n\n---\n\n## System\n\nOverview of all available resources\n\n**Endpoint**\n\n`GET /system`\n\n**Optional URI Parameters**\n\n* `disk`: Specify a path or device for disk usage\n    *  If none is specified, \"/\" is assumed\n\n**Response**\n\n    {\n      \"host\": \"mario\",\n      \"disk\": {\n        \"all\": 117623562240,\n        \"used\": 8339341312,\n        \"free\": 109284220928\n      },\n      \"cpuinfo\": {\n        \"processors\": 4,\n        \"siblings\": 4,\n        \"cores\": 2\n      },\n      \"load\": {\n        \"avg1\": 0.26,\n        \"avg2\": 0.23,\n        \"avg3\": 0.23\n      },\n      \"ram\": {\n        \"free\": 565848,\n        \"total\": 7871876\n      },\n      \"time\": \"2014-03-24T12:24:26-07:00\"\n    }\n\n## Host\n\nSystem hostname\n\n**Endpoint**\n\n`GET /system/host`\n\n**Response**\n\n    \"nexus2\"\n\n## Disk\n\nUsed, free, and total disk space available for a given device or path. If no `disk` parameter is provided, the endpoint assumes the `/` path.\n\n**Endpoint**\n\n`GET /system/disk`\n\n**Optional URI Parameters**\n\n* `disk`: Specify a path or device for disk usage\n    *  If none is specified, \"/\" is assumed\n\n**Response**\n\n    {\n      \"all\": 35439468544,\n      \"used\": 20696563712,\n      \"free\": 14742904832\n    }\n\n## Processes\n\nProvide info about running processes (cpu,mem,user,pid,pname)\n\n**Endpoint**\n\n`GET /system/processes`\n\n**Response**\n\n    {\n      \"used_mem\": 74.10000000000001,\n      \"used_cpu\": 49.600000000000016,\n      \"processes\": [\n        {\n          \"user\": \"rkononov\",\n          \"name\": \"rhythmbox\\n\",\n          \"pid\": 7324,\n          \"cpu\": 8.7\n        },\n        {\n          \"user\": \"rkononov\",\n          \"name\": \"/opt/google/chrome/google-chrome\",\n          \"pid\": 2604,\n          \"cpu\": 4.4\n        }\n       ]\n    }\n\n## CpuInfo\n\nFrom `/etc/cpuinfo`\n\n**Endpoint**\n\n`GET /system/cpuinfo`\n\nResponse:\n\n    {\n      \"processors\": 4,\n      \"siblings\": 4,\n      \"cores\": 2\n    }\n\n## Load\n\nLoad averages for the node\n\n**Endpoint**\n\n`GET /system/load`\n\nResponse:\n\n    {\n      \"avg1\": 0.40,\n      \"avg2\": 0.40,\n      \"avg3\": 0.37\n    }\n\n## RAM\n\nRAM usage for the node\n\n**Endpoint**\n\n`GET /system/ram`\n\nResponse:\n\n    {\n      \"free\": 20608,\n      \"total\": 2060976\n    }\n\n## Shell\n\nExecute arbitrary shell commands on the node. This endpoint is only accessible if a token was specified at runtime(take in account that any command will timeout after 60 seconds)\n\n**Endpoint**\n\n`POST /shell`\n\n**URI Parameters**\n\n* `exec`: Specify the command to be executed on the node - EITHER this or the JSON body should be passed in.\n* `token`: Mandatory authentication token\n\n**Request**\n\nJSON body with list of commands, ex:\n\n```json\n{\n    \"commands\": [\n        \"chmod a+x /home/whatever\"\n    ]\n}\n```\n\n**Response**\n\n    \"command response\"\n\n## Files\n\n###Get list of files/dir in selected path\n\n**Endpoint**\n\n`GET /files`\n\n**URI Parameters**\n\n* `path`: Specify the path to dir\n* `token`: Mandatory authentication token\n\n**Response**\n\n    {\n      \"count\": 25,\n      \"entities\": [\n        {\n          \"name\": \"bin\",\n          \"size\": 4096,\n          \"updated_at\": \"Feb 11, 2014 at 11:45am (KGT)\",\n          \"is_dir\": true\n        }\n       ]\n\n    }\n\n###Write file to selected dir / Create dir\n\n**Endpoint**\n\n`POST /files`\n\n**URI Parameters**\n\n* `path`: Specify the path to dir\n* `token`: Mandatory authentication token\n* `file`: File content, sent as form/multipart\n\n**Response**\n\nEmpty response or error code/description`\n\n\n###Delete file or dir\n\n**Endpoint**\n\n`DELETE /files`\n\n**URI Parameters**\n\n* `path`: Specify the path to dir/file\n* `token`: Mandatory authentication token\n\n**Response**\n\nEmpty response or error code/description\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftreeder%2Fsshttp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftreeder%2Fsshttp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftreeder%2Fsshttp/lists"}