{"id":22138963,"url":"https://github.com/cwaldbieser/txsshadmin","last_synced_at":"2025-07-20T15:35:09.851Z","repository":{"id":33525662,"uuid":"37171718","full_name":"cwaldbieser/txsshadmin","owner":"cwaldbieser","description":"Twisted Python Administrative service over SSH","archived":false,"fork":false,"pushed_at":"2023-01-09T20:01:00.000Z","size":33,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-04T09:03:25.400Z","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":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cwaldbieser.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-06-10T02:48:27.000Z","updated_at":"2022-07-28T16:09:55.000Z","dependencies_parsed_at":"2023-01-15T01:17:28.430Z","dependency_job_id":null,"html_url":"https://github.com/cwaldbieser/txsshadmin","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/cwaldbieser/txsshadmin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cwaldbieser%2Ftxsshadmin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cwaldbieser%2Ftxsshadmin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cwaldbieser%2Ftxsshadmin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cwaldbieser%2Ftxsshadmin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cwaldbieser","download_url":"https://codeload.github.com/cwaldbieser/txsshadmin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cwaldbieser%2Ftxsshadmin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265076094,"owners_count":23707512,"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":[],"created_at":"2024-12-01T20:13:07.767Z","updated_at":"2025-07-20T15:35:09.827Z","avatar_url":"https://github.com/cwaldbieser.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"################################################################\nAdministrative Services Over SSH for Twisted Python Applications\n################################################################\n\n===============================================\nCreate SSH Server public key / private key pair\n===============================================\n\nExample::\n\n    $ mkdir keys\n    $ ckeygen -b 2048 -t rsa -f keys/id_rsa\n\n=========\nRun Demos\n=========\n\nCustom protocol over SSH::\n\n    $ twistd -ny ./txsshadmin/demo.tac\n\nManhole REPL over SSH::\n\n    $ ./txsshadmin/manhole_repl.py\n\n\n===========================\nCreate Your Own SSH Service\n===========================\n\n-------------------------\nCreate a Protocol Handler\n-------------------------\n\nSubclass `txsshadmin.proto_dispatcher.BaseHandler`.  Override handler methods\nyou wish to customize.  When the handler is created, the SSH avatar is assigned \nto its `avatar` attribute.  Each handler method is passed an instance of the dispatcher.\n\n-------------------------\nCreate a Protocol Factory\n-------------------------\n\nUse `txsshadmin.proto_dispatcher.makeSSHDispatcherProtocolFactory()` to create\na protocol factory from your handler.\n\n--------------------\nCreate an SSH Avatar\n--------------------\n\nSubclass `txsshadmin.cred_base.SSHBaseAvatar` to create an avatar for your\nssh service.  Assign the protocol factory you created to its `protocolFactory`\nattribute.  The avatar is where you can define the capabilities of authenticated\nusers.  A protocol handler for a service with users with various capabilities\nmay delegate its handlers to its avatar.\n\n--------------\nCreate a Realm\n--------------\n\nThe realm determines what avatar (if any) is returned when the authenticated \navatar ID and a list of interfaces is provided to the realm.  The resulting\navatar should support at least one of the provided interfaces.\n\nFor a simple realm that returns only a single type of avatar, you can subclass\n`txsshadmin.cred_base.SSHBaseRealm` and set the `avatarFactory` attribute to\nan avatar factory.  For more sophisticated realms, you can include logic that\nreturns different avatars based on capabilities keyed to the avatar ID.\n\n----------------------\nCreate the SSH Service\n----------------------\n\nSubclass `txsshadmin.service.SSHServiceBase`.  Set the `realm` attribute equal\nto an instance of your realm.  \n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcwaldbieser%2Ftxsshadmin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcwaldbieser%2Ftxsshadmin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcwaldbieser%2Ftxsshadmin/lists"}