{"id":13936931,"url":"https://github.com/thomai/SSHKeyDistribut0r","last_synced_at":"2025-07-19T22:33:19.560Z","repository":{"id":53756070,"uuid":"53264791","full_name":"thomai/SSHKeyDistribut0r","owner":"thomai","description":"A tool to automate key distribution with user authorization","archived":false,"fork":false,"pushed_at":"2021-03-15T22:08:21.000Z","size":46,"stargazers_count":162,"open_issues_count":5,"forks_count":18,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-11-25T06:14:06.215Z","etag":null,"topics":["authorization","authorized-keys","python","ssh-key","sysop","system-administration","yml"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thomai.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-06T16:36:22.000Z","updated_at":"2024-07-27T14:49:44.000Z","dependencies_parsed_at":"2022-09-26T17:40:36.009Z","dependency_job_id":null,"html_url":"https://github.com/thomai/SSHKeyDistribut0r","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomai%2FSSHKeyDistribut0r","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomai%2FSSHKeyDistribut0r/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomai%2FSSHKeyDistribut0r/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomai%2FSSHKeyDistribut0r/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thomai","download_url":"https://codeload.github.com/thomai/SSHKeyDistribut0r/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226693903,"owners_count":17667757,"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":["authorization","authorized-keys","python","ssh-key","sysop","system-administration","yml"],"created_at":"2024-08-07T23:03:07.631Z","updated_at":"2024-11-27T05:30:41.914Z","avatar_url":"https://github.com/thomai.png","language":"Python","readme":"[![CC BY](http://mirrors.creativecommons.org/presskit/buttons/80x15/svg/by.svg)](http://creativecommons.org/licenses/by/4.0/)\n[![Build Status](https://travis-ci.org/thomai/SSHKeyDistribut0r.svg?branch=master)](https://travis-ci.org/thomai/SSHKeyDistribut0r)\n\nSSHKeyDistribut0r has been written to make SSH key distribution easier\nfor sysop teams.\n\n![Screenshot](http://i.imgur.com/qoKm9dl.png)\n\n# How to use\n## Install\n```\npip install SSHKeyDistribut0r\n```\n\n## Create configuration files\nFirst, copy the YAML sample files to your users config directory and customize them.\n\nThe sample files should be in\n`$HOME/.local/share/SSHKeyDistribut0r/config_sample`,\n`/usr/local/share/SSHKeyDistribut0r/config_sample` or\n`/usr/share/SSHKeyDistribut0r/config_sample`\n\nThe config files need to be copied to `$USER_CONFIG_DIR/SSHKeyDistribut0r/`\n(`$HOME/.config/...` on most Linux systems, check `SSHKeyDistribut0r -h` for\nthe location on your system)\n\nThe keys.yml file has to contain all users which are used in the\nservers.yml file. Every entry in the YML structure requires the\nfollowing attributes:\nThe `fullname` is a string value to mention the full name of a person.\n`keys` is a list of SSH keys in the format `ssh-rsa \u003cKEY\u003e \u003ccomment\u003e`.\n\nThe servers.yml file contains all servers with the specified user\npermissions. It consists of a list of dictionaries with the following\nattributes:\n* `ip`: String value in the format `XXX.XXX.XXX.XXX`\n* `port`: Integer value which specifies the SSH port\n* `user`: String value which specifies the system user to log in.\n* `comment`: String value to describe the system\n* `authorized_users`: List of strings which specify a user. Every user\n    has to be declared in the keys.yml file as a key.\n\n## Usage\nRun `SSHKeyDistribut0r` to distribute your SSH keys :)\n\nNote, that a pre-installed public key on the server side with a corresponding\nprivate key (without a passphrase or pre-loaded into a local key agent) is\nrequired for SSHKeyDistribut0r to work.\n\n### Options\n* `--dry-run`/`-n`: To verify your configuration whithout actually applying those changes.\n* `--keys`/`-k`: Custom path to keys file\n* `--server`/`-s`: Custom path to server file\n\n# New Release\n## Build Python Package\n* Update `CHANGELOG.md`\n* Update version in `setup.py`\n* Update `CONTRIBUTORS.md`\n* Install package builder: `pip install build`\n* Build package: `python -m build`\n* Installation: `pip install ./dist/SSHKeyDistribut0r-\u003cversion\u003e.tar.gz`\n* Do tests\n\n## Upload to PyPI\n* Install twine: `pip install twine`\n* Upload: `twine upload ./dist/SSHKeyDistribut0r-\u003cversion\u003e.tar.gz`\n\n## Git Stuff\n* `git add .`\n* Commit new version: `git commit -m \"Version x.x.x\"`\n* `git push`\n* `git checkout master`\n* Update master branch: `git merge develop`\n* `git push`\n* Set version tag: `git tag x.x.x`\n* `git push --tags`\n\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomai%2FSSHKeyDistribut0r","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthomai%2FSSHKeyDistribut0r","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomai%2FSSHKeyDistribut0r/lists"}