Skip to main content

A tool which has been written to make SSH key distribution easier for sysop teams.

Project description

[![CC BY](http://mirrors.creativecommons.org/presskit/buttons/80x15/svg/by.svg)](http://creativecommons.org/licenses/by/4.0/)
[![Build Status](https://travis-ci.org/thomai/SSHKeyDistribut0r.svg?branch=master)](https://travis-ci.org/thomai/SSHKeyDistribut0r)

SSHKeyDistribut0r has been written to make SSH key distribution easier
for sysop teams.

![Screenshot](http://i.imgur.com/qoKm9dl.png)

# How to use
## Install
```
pip install SSHKeyDistribut0r
```

## Create configuration files
First, copy the YAML sample files to your users config directory and customize them.

The sample files should be in
`$HOME/.local/share/SSHKeyDistribut0r/config_sample`,
`/usr/local/share/SSHKeyDistribut0r/config_sample` or
`/usr/share/SSHKeyDistribut0r/config_sample`

The config files need to be copied to `$USER_CONFIG_DIR/SSHKeyDistribut0r/`
(`$HOME/.config/...` on most Linux systems, check `SSHKeyDistribut0r -h` for
the location on your system)

The keys.yml file has to contain all users which are used in the
servers.yml file. Every entry in the YML structure requires the
following attributes:
The `fullname` is a string value to mention the full name of a person.
`keys` is a list of SSH keys in the format `ssh-rsa <KEY> <comment>`.

The servers.yml file contains all servers with the specified user
permissions. It consists of a list of dictionaries with the following
attributes:
* `ip`: String value in the format `XXX.XXX.XXX.XXX`
* `port`: Integer value which specifies the SSH port
* `user`: String value which specifies the system user to log in.
* `comment`: String value to describe the system
* `authorized_users`: List of strings which specify a user. Every user
has to be declared in the keys.yml file as a key.

## Usage
Run `SSHKeyDistribut0r` to distribute your SSH keys :)

### Options
* `--dry-run`/`-n`: To verify your configuration whithout actually applying those changes.
* `--keys`/`-k`: Custom path to keys file
* `--server`/`-s`: Custom path to server file

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

SSHKeyDistribut0r-0.2.1.tar.gz (7.3 kB view details)

Uploaded Source

File details

Details for the file SSHKeyDistribut0r-0.2.1.tar.gz.

File metadata

  • Download URL: SSHKeyDistribut0r-0.2.1.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/3.6.3

File hashes

Hashes for SSHKeyDistribut0r-0.2.1.tar.gz
Algorithm Hash digest
SHA256 dfdbcd7eb7d3187ed93f2cad132f253fb2db0edce51369329e4633edcacd2256
MD5 fea0c5bd2cac46f79c002899a399eaed
BLAKE2b-256 e84fb93ebbcc441aae4ce20e8b47774d3cbe08a5081a8589215bb88a717fa165

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page