Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

1-step to create user with SSH keys

Project Description
sshadduser
==========

Problem
-------

This simple script Imagine that you have SSH access to a server and you need to
grant access to a coworker. You must remember to perform multiple steps, such
as creating a home directory, setting a password, making sure the user is
included in the correct groups, etc. If the server requires public key
authentication (the default for Amazon EC2), then you must also put the keys in
the right place, with the right ownership and permissions. Screw up any tiny
part and OpenSSH will stubbornly and unhelpfully block the new user without any
explanation why.

Yo dawg, I heard you like `-vvv` flags so I put some `LogLevel VERBOSE` in your `sshd_config`.

-Xzibit's endorsement of `sshadduser` (paraphrased)

Solution
--------

The ``sshadduser`` script does the following things:

* Create account and home directory.
* Prompt for password or generate random password.
* Append keys to user's ``authorized_keys``, creating if necessary and setting
correct ownership/permissions. (optional)
* Add user to supplemental groups. (optional)

You could do these things yourself, but if you're like me, you tend to miss a
step every now and then. Or you could write a bash script to do it, but then
you'd have to copy that bash script everywhere you ever wanted to use it. And
if you wanted somebody else to grant SSH access *to you*, then you'd have to
explain to them how to use your script first.

On the other hand, `sshadduser` has super simple syntax. It runs interactively,
so you don't need to memorize a bunch of command line flags to use it. It's
easy to install on any reasonably modern \*nix. And if you want somebody else
to use it, just point them at this README.

Installation
------------

``python3`` and ``pip3`` are prerequisites. Once you have those, run:

.. code:: bash

$ sudo pip3 install sshadduser

Usage
-----

Specify the name of the user to create followed by supplemental groups (if
any). You will be prompted for a password and optional OpenSSH keys. For
example to create a user `jane` and add her to `sudo` and `rockstar` groups:

.. code:: bash

$ sudo sshadduser jane sudo rockstar
Enter a password (or leave blank to generate random password):

Enter SSH keys one per line. A blank line terminates.
ssh-rsa AAAAB3NzaC1yc2EAAAAblahblahblah jane@laptop
ssh-rsa AAAAB3NzaC1yc2EAAAAdoowopdoowop jane@desktop

Created an account named jane with password e0UkMmvPW6mT and 2 SSH keys.
Added supplemental groups: sudo and rockstar.

That's it! If something goes wrong, remove the user and try again:

.. code:: bash

$ sudo userdel -r jane

If you want to file a bug report, run the command with verbose logging enabled
and attach the complete output:

.. code:: bash

$ sudo sshadduser -v debug jane

Compatibility
-------------

Designed for POSIX environments, this is still a beta-quality project and it
has not been tested on many platforms. It has been tested on Ubuntu 14.04 and
16.04, and it should work on other systems, too. If you find that it does not
run somewhere that you need it, file an issue or — better yet — submit a pull
request.
Release History

Release History

History Node

0.5

History Node

0.4

History Node

0.3

This version
History Node

0.2

History Node

0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sshadduser-0.2.tar.gz (2.6 kB) Copy SHA256 Checksum SHA256 Source May 24, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting