{"id":16394259,"url":"https://github.com/tryexceptpass/korv","last_synced_at":"2026-03-07T00:31:10.071Z","repository":{"id":57438448,"uuid":"129903118","full_name":"tryexceptpass/korv","owner":"tryexceptpass","description":"Python API framework using SSH sockets","archived":false,"fork":false,"pushed_at":"2019-01-17T05:31:36.000Z","size":15,"stargazers_count":99,"open_issues_count":3,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-09-25T10:54:29.841Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/tryexceptpass.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-04-17T12:44:28.000Z","updated_at":"2025-02-23T19:28:09.000Z","dependencies_parsed_at":"2022-08-29T08:40:58.057Z","dependency_job_id":null,"html_url":"https://github.com/tryexceptpass/korv","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/tryexceptpass/korv","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryexceptpass%2Fkorv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryexceptpass%2Fkorv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryexceptpass%2Fkorv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryexceptpass%2Fkorv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tryexceptpass","download_url":"https://codeload.github.com/tryexceptpass/korv/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tryexceptpass%2Fkorv/sbom","scorecard":{"id":900199,"data":{"date":"2025-08-11","repo":{"name":"github.com/tryexceptpass/korv","commit":"54169ceea7da537bd3c57816eacf2d6162f973fd"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"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":"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":-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":"Code-Review","score":0,"reason":"Found 0/13 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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"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":"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":"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":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2023-239 / GHSA-c35q-ffpf-5qpm","Warn: Project is vulnerable to: PYSEC-2023-237 / GHSA-cfc2-wr2v-gxm5","Warn: Project is vulnerable to: GHSA-hfmc-7525-mj55"],"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 8 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-24T15:17:59.505Z","repository_id":57438448,"created_at":"2025-08-24T15:17:59.506Z","updated_at":"2025-08-24T15:17:59.506Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30204154,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T19:07:06.838Z","status":"ssl_error","status_checked_at":"2026-03-06T18:57:34.882Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":"2024-10-11T04:55:15.480Z","updated_at":"2026-03-07T00:31:10.052Z","avatar_url":"https://github.com/tryexceptpass.png","language":"Python","readme":"Korv is an API framework that uses TCP sockets over SSH to exchange JSON data with a REST-like protocol. It's built on top of the `asyncssh` module, so it uses `asyncio` to manage the sockets and its callbacks. This allows you to build rich APIs with the session security of SSH and without the TCP overhead of HTTP.\n\nCommunications over this framework requires SSH keys like logging into a normal SSH server:\n* The server itself has a private key and a set of public keys for the authorized clients.\n* The client has a private key and a set of public keys for the servers it can connect to.\n\n\n## Verbs\nThere are 4 main verbs that indicate the intent of your request:\n* `GET` for retrieving information.\n* `STORE` for creating new objects.\n* `UPDATE` for changing existing objects.\n* `DELETE` for removing objects.\n\n\n## Keys\nAs discussed previously, you establish an SSH session with the server, so it's possible to reuse existing keys or generate them through any standard mechanism like the one below:\n\n```bash\nssh-keygen -t rsa -b 4096 -C \"your_email@example.com\"\n```\n\n## Server\nGetting a server up and running is very simple:\n\n```python\nfrom korv import KorvServer\n\n\ndef hello(request):\n    \"\"\"Callback for the /hello endpoint\"\"\"\n\n    return 200, {'msg': 'Hello World!'}\n\ndef echo(request):\n    \"\"\"Callback for the /echo endpoint\"\"\"\n\n    return 200, {'msg': f'{request}'}\n\n\n# Create a server\nk = KorvServer(host_keys=['PATH_TO_YOUR_SERVER_PRIVATE_KEY'], authorized_client_keys='PATH_TO_YOUR_AUTHORIZED_PUBLIC_KEYS')\n\n# Register the callbacks\nk.add_callback('GET', '/hello', hello)\nk.add_callback('GET', '/echo', echo)\n\n# Start listening for requests\nk.start()\n```\n\nThis will start a new SSH server with the specified private key that listens on port `8022` by default and will accept the clients listed in the authorized keys.\n\n## Client\nFollowing is an example on how to communicate with this server.\n\n```python\n\u003e\u003e\u003e from korv import KorvClient\n\u003e\u003e\u003e\n\u003e\u003e\u003e # Create the client\n\u003e\u003e\u003e k = KorvClient(client_keys=['PATH_TO_YOUR_CLIENTS_PRIVATE_KEY'])\n\u003e\u003e\u003e\n\u003e\u003e\u003e # Issue a GET request and print the output\n\u003e\u003e\u003e k.get('/hello', callback=lambda response: print(response['body']))\n\u003e\u003e\u003e {'msg': 'Hello World!'}\n```\n\n## Return Codes\nWe're using standard HTTP response codes:\n* `200` = Success.\n* `400` = Malformed request or missing parameters.\n* `404` = NotFound\n* `500` = Internal error.\n\nServer exceptions map to a `500` return code ans will include a traceback in the response.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftryexceptpass%2Fkorv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftryexceptpass%2Fkorv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftryexceptpass%2Fkorv/lists"}