Metadata-Version: 2.1
Name: sshepherd
Version: 0.1
Summary: SSHepherd: Automated SSH User Management
Home-page: https://github.com/drpresq/sshepherd
Author: George
Author-email: drpresq@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE.md

# SSHepherd: Automated SSH Host Management

<p align="center">
<img alt="SSHepherd - Herd Your Flock!" src="docs/docs/media/sshepard.png">
</p>

## Description

SSHepherd eases integration of new user accounts for SSH hosts without centralized user management by:
* Creating the new user account on the target host
* Adding them to security groups as applicable
* Placing ssh public keys as applicable

## Features

SSHepherd is also capable of some other user management features:
* Take an inventory of users on each system
* Delete users from system groups
* A variety of functions across system groups:
    * delete, lock and unlock users
    * Update ssh keys
    * reset passwords
    * run arbitrary commands

## Install

```
git clone https://github.com/drpresq/sshepherd.git
pip3 install ./sshepherd
```

## Usage

```
usage: sshepherd [-h] [-a {list-users,add-users,run-command}]
                [-t TARGETS [TARGETS ...]] [-p PATH]
                [-c COMMAND [COMMAND ...]]

SSHepherd - herd your flock of ssh hosts

optional arguments:
  -h, --help            show this help message and exit
  -a {list-users,add-users,run-command}, --action {list-users,add-users,run-command}
                        
                        Action to be carried out on targets
                        
  -t TARGETS [TARGETS ...], --targets TARGETS [TARGETS ...]
                        
                        List of ip addresses/hostnames to perform action upon
                        
  -p PATH, --path PATH  
                        Path to New User SSH Public Keys. SSH Key names must conform to the following formats:
				<username>.pub or <username>_somethingelse.pub
                        
  -c COMMAND [COMMAND ...], --command COMMAND [COMMAND ...]
                        
                        Commands to be run on host separated by semicolons
                        

    Common Usage:
	sshepherd -a list-users -t 192.168.1.1 192.168.1.2				Returns a list of users by IP
	sshepherd -a add-users -t 192.168.1.1 -p /home/user/pub-keys			Add users to each target based on key name
	sshepherd -a run-command -t 192.168.1.1 -c sudo whoami; cat /etc/passwd		Runs the two commands on each target
```



