A simple application to manage and distribute SSH keys to our systems
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Max Mehl 18c201dbd8
bump ssh-data
1 month ago
.reuse fix REUSE and copyright 1 year ago
LICENSES made REUSE compliant 1 year ago
admin remove managed_ssh group and limit run to baseline group 10 months ago
inventory@50ead07987 bump inventory 3 months ago
ssh-data@837cedfaae bump ssh-data 1 month ago
tasks deal with non-existant files 10 months ago
.drone.yml fixed .drone.yml 12 months ago
.gitignore fix REUSE and copyright 1 year ago
.gitmodules fix REUSE and copyright 1 year ago
Pipfile Update dependency SQLAlchemy to <1.4.20,>=1.3.7 11 months ago
Pipfile.license made reuse compliant and added reuse to CI 12 months ago
Pipfile.lock Update dependency SQLAlchemy to <1.4.20,>=1.3.7 11 months ago
Pipfile.lock.license made reuse compliant and added reuse to CI 12 months ago
README.md remove managed_ssh group and limit run to baseline group 10 months ago
admin.py fix REUSE and copyright 1 year ago
ansible.cfg use inventory automatically, fix HTML syntax 1 year ago
playbook.yml remove managed_ssh group and limit run to baseline group 10 months ago
renovate.json Add renovate.json 1 year ago
renovate.json.license fix REUSE and copyright 1 year ago
utils.py fix REUSE and copyright 1 year ago

README.md

REUSEstatus Build Status

SSH Key Distributor

Goal

Providing a simple way to ensure the presence (or absence) of public SSH keys on a set of systems (user-host-combinations) according to profiles.

Usage

If you want to run this directly using Python or develop the tool further, first execute the following commands to get started with pipenv. Make sure you're using at least Python 3.9

pip install --user pipenv
pipenv install

then you should initialise the inventory and ssh-data submodules where all the FSFE-specific data is stored.

git submodule update --init --remote inventory
git submodule update --init --remote ssh-data

finally run to start the UI:

pipenv run python admin.py

and open http://localhost:5000/admin. There you'll find instructions on how to proceed. It boils down to the following:

  1. Configure keys and the systems to which they have access. This project uses the following concept to ease configuration:

    Systems are user-host-combinations, e.g. exampleuser@exampleserver.com. For each system the location of its authfile needs to be specified, e.g. /home/exampleuser/.ssh/authfile

    Profiles are simply a utility. They allow the user to specify which keys have access to which system in a more straightforward way than adding every key to every system individually. One can for example specify an admin group which has access to all root accounts on all hosts. Then adding a new key that is supposed to have this level of access can just be added to the admin profile.

    Keys are simply public SSH keys. They consist of a keytype (e.g. ed25519), the keystring, a comment and an option.

  2. Once everything is configured correctly, you can generate the variables that the Ansible playbook at the root of this project needs in order to carry out its function, i.e. updating all the ~/.ssh/authorized_keys files on all hosts. Generate the needed Ansible configuration files by clicking the button labelled Generate Ansible Config.

  3. At this point, All that is left to do is to deploy all the keys via a slim ansible playbook using the command below:

    pipenv run ansible-playbook playbook.yml
    

Architecture

UI

A simple CRUD interface based on Flask Admin based on data model managed in SQLAlchemy (a powerful ORM implementation)

Database

A simple data model with three tables (key, profile, system) and two association tables (at_key_profile, at_profile_system).

Deployment

A pre-deployment python script which creates and the correct variables for each host and the contents of the keystringfiles directory. This script is called from the homepage of the UI, i.e. /admin by clicking the aforementioned button.