/edwh-sshkey-plugin

Plugin for `edwh` that generates ssh keys

Primary LanguagePythonMIT LicenseMIT

edwh-sshkey-plugin

PyPI - Version PyPI - Python Version

Table of Contents

Installation

To install all edwh related plugins

pipx install edwh[plugins,omgeving]

To only install edwh sshkey plugin

pipx install edwh[sshkey]

Guide

Generating new keys:

example for ubuntu@user.nl

edwh sshkey.generate --message={message} --owner=ubuntu --hostname=user --goal=nl

possible arguments for ew sshkey.generate:

  • message: REQUIRED, message to give with the generated key
  • owner: owner of the server you are generating a key for
  • hostname: hostname of the server you are generating the key for
  • goal: What is the goal to use this key for, for example: 'production' or 'testing'

note:

you atleast need to give this function 2-3 parameters and a message else it will not work.

Adding keys to remote

example for ubuntu@user.nl

edwh sshkey.add-to-remote -H ubuntu@user.nl --keys_to_remote=owner-hostname-goal

possible arguments for ew sshkey.add-to-remote:

  • keys_to_remote: all saved keys you want to add to the remote

Removing SSH keys from a remote machine:

The delete_remote function is used to remove specified SSH keys from a remote machine. The function takes in an iterable of keys to be removed and a Connection object.

usage:

edwh sshkey.delete-remote -H ubuntu@user.nl --keys_to_remote=owner-hostname-doel

possible arguments for ew delete_remote:

  • keys_to_remote: An iterable of keys to be removed from the remote machine. If a string is provided, it is converted into a list with one element.

note:

The function retrieves all key information from the keyholder and checks if the command line key is present in the key information. If it is, the function retrieves the SSH key and removes it from the authorized_keys file on the remote machine. After successfully removing the key, the function prints a success message indicating that the specified key has been removed.

List SSH keys from a remote or local machine:

edwh sshkey.list -H ubuntu@user.nl

Note:

this list all found known and unknown keys on the local or remote server.

License

edwh-sshkey-plugin is distributed under the terms of the MIT license.