Skip to main content

Authenticate SSH users using their GitHub keys

Project description

GitHub-SSH-Auth

CICD

PyPI Supported Python versions Code style: black Downloads

About

This project aims to provide a way for SSH daemon to authenticate your organization users on (standalone) shell boxes using their GitHub SSH keys.

How it works

SSH Authentication against GitHub API is done using a feature of OpenSSH, namely AuthorizedKeysCommand and AuthorizedKeysCommandUser.

These two options are used to specify the command to run and the user to run it as. If you are familiar with authorized_keys file, you can understand that each time you want to update keys, you have to first copy them using ssh-copy-id for example or any similar method.

But what happens if you fail to copy keys? Or you have lost your keys because of computer crash? Or you have lost your keys because of some other reason?

Then you have to update your keys again. And the process of updating keys on each of your running boxes is a nightmare.

Of course, some companies have their own systems for this purpose. A possible solution would be to use a deployment service like Ansible or Chef to update keys on each box.

Another possible solution would be to have some common infrastructure like sssd or LDAP to deport the authentication some place else, or to somewhat automagically update the keys upon valid logon credentials.

This is not a solution for everyone.

Therefore here is another technique that can help in such scenarios.

Everytime a user connects, the script will be called with the login as command line parameter.

In detail, the following happens :

  1. sshd deamon runs github-ssh-auth under the user defined by AuthorizedKeysCommandUser option.

  2. github-ssh-auth reads its configuration file (by default /etc/github-ssh/conf)

  3. according to the configuration file, it looks up the username given by sshd and checks if that user is granted permission to connect to this host

  4. if yes, it tries to read the cache file (recommended but can be disabled) to find user's keys. If no cache file found or if disabled, then it queries GitHub API to get the keys and creates the cache (if enabled).

  5. github-ssh-auth returns a list of eligible ssh public keys to standard output to be processed by sshd

The rest is handled by sshd itself, i.e. checking validity of that public key and the rest of the connection handling.

It does not interfere with the rest of the system, including anything PAM related.

Updating keys and cache use

To avoid flooding GitHub API and consequently being temporarily banned from using their API in case of massive connects, it is recommended to have cache enabled and update the keys only few times a day. The periodicity is yours and that is why there is a special update command line parameter for that.

Consider the following scenario:

  • cache is enabled
  • cache file already exists
  • a new user has joined the team OR an existing user replaced his/her keys

In such case, the cache file will NOT be updated when authentication happens, this is the behavior set by design to separate concerns and prevent connection to the outside world being in the critical path for authentication.

Instead, a locally defined cron should either:

  • call github-ssh-update to update cache
  • delete cache file (by default /etc/github-ssh/cache.json) which will force recreation when next auth happens

Both will have the same outcome but the former is cleaner than the latter.

All in all, choice is yours :wink:

Installation

Since this Python module deals with SSH authentication, it should be installed globally, hence:

$ sudo pip install github-ssh-auth

This will install the following program and its shortcuts in /usr/local/bin:

github-ssh

The real application, handling all options, but for convenience the shortcuts described after can be used.

Usage

Usage: github-ssh [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  auth    Authenticate user.
  init    Initialize GitHub SSH Authentication configuration file.
  update  Update GitHub SSH Auth cache file (users, teams, keys).

github-ssh-auth

Responsible for authentication itself, this one is to be called by sshd itself.

Usage

Usage: github-ssh-auth [OPTIONS] LOGIN

  Authenticate user.

Options:
  -c, --config FILE  Config file to use.  [default: /etc/github-ssh/conf]
  --help             Show this message and exit.

github-ssh-init

This command initializes the configuration file. It will also launch an editor of your choice (or the one specified in EDITOR environment variable) to edit the configuration file.

Note: if the configuration file already exists, it will NOT be overwritten.

Usage

Usage: github-ssh-init [OPTIONS]

  Initialize GitHub SSH Authentication configuration file.

Options:
  -c, --config FILE  Config file to use.  [default: /etc/github-ssh/conf]
  -e, --editor FILE  Editor to use.  [default: vim]
  --help             Show this message and exit.

github-ssh-update

Responsible for updating cache file, it can be scheduled to run periodicaly to ensure synchronization with updated keys from Github.

Usage

Usage: github-ssh-update [OPTIONS]

  Update GitHub SSH Auth cache file (users, teams, keys).

Options:
  -c, --config FILE  Config file to use.  [default: /etc/github-ssh/conf]
  --help             Show this message and exit.

Note: In some distros, /usr/local/bin is not eligible for sshd daemon because of some obscure group permissions reason. Moving the binaries (or create symlinks) from /usr/local/bin to /usr/bin make them work like a charm !

Configuration

SSH configuration in /etc/ssh/sshd_config

These lines should be somewhere in your sshd configuration file. Usually in /etc/ssh/sshd_config :

AuthorizedKeysCommand /usr/bin/github-ssh-auth %u
AuthorizedKeysCommandUser nobody

What do they mean?

The first line tells sshd to run github-ssh-auth with the username as command line parameter. As previously said, recent versions of sshd support AuthorizedKeysCommand option and only if command happens to live in /usr/bin not /usr/local/bin.

The second line tells sshd to run github-ssh-auth under nobody user. This is to prevent any possible privilege escalation.

GitHub token requirements

Since this application is dealing with some sensitive data (users and their team memberships) within an organization, we will need to create a so-called Personal access tokens.

To do that, fire up your GitHub organization dashboard, look for Settings then Developer settings.

Then click on Generate new token and set its permissions to:

read:org

This is the only requirement so that the API can be queried for users and teams memberships. All users keys are public by default and can be accessed from the outside world without authentication against GitHub API.

See for yourself, go to https://github.com/<yourhandle>.keys. :rocket:

GitHub SSH Auth configuration file

It resides by default in /etc/github-ssh/conf but of course you can change it using -c flag when calling (see above).

The format is a standard INI style.

Configuration file template

Below is the complete grammar with inline comments:

[global]
# Comments should start with a # and must be full lines
# The following two lines are mandatory
access_token = <token>
organization = <org>

# In case of connectivity lost and to prevent too many connections to GitHub API,
# it is strongly recommended to set it to an absolute filepath.
# Default (when not present) is set to /etc/github-ssh/cache.json and equivalent to:
# cache_file = /etc/github-ssh/cache.json

# If you want to disable, set it to 'false'
# cache_file = [/path/to/file | false]

# Unless overridden after, users (whether individual or teams) will have these configurations applied.
# By default, nothing is set so basically no one will be granted access
# The '<' case means that if a local exists with the same name as a GitHub user,
# it will be granted access. It is a shorthand to avoid a too
# complex, verbose yet common use case where every developer would
# like to have his/her own shell account.
teams_default = [ list,of,local,users,or,< ]
users_default = [ list,of,local,users,or,< ]

# Configuration below will override team defaults
[teams]
<team_name> = [ list,of,local,users,or,< ]
...

# And below to override default users setup
[users]
<user_name> = [ list,of,local,users,or,< ]
...

Special note on the '<'

Just a quick focus on that special caracter, designed to allow a GitHub user to connect provided that:

  • user is the Github handle, being part of the organization, and
  • user exists in the local user base (i.e. it is present when you do a getent passwd)

Real world example

Let's say Acme Corp. wants all its developers connect with their GitHub accounts. Let's say users jdoe bob alice are such handles. Also these user handles are also the respective handlers in GitHub.

Then with this simple configuration, we allow globally all these users to login with their handles:

[global]
...other config skipped for brevety...

users_default = <

Now if you only want bob to connect using login bob, the configuration file would look like this one:

[global]
...other config skipped for brevety...

users_default =

[users]
bob = <

Other real world examples

Some other ready-to-be-deployed-or-almost can be found in the example directory.

Testing

As this is my first Python module, and even my first Python program ever, I tried different methods to handle testing.

Have had a lot of shortcomings four years ago when I started this project, now I found a way to test it properly using tox and pytest. Of course code is coverage-driven, so you can use coverage to get an idea of what is covered and what is not.

An html report is also generated by coverage and can be found in .tox/htmlcov/index.html.

I therefore removed the previous stack of tests using Dockerfile and Makefile.

Contributions

Comments, issues, PR as :beer: will be warmly welcomed !

License

GPLv3+

Project details


Download files

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

Source Distribution

github_ssh_auth-1.0.1.tar.gz (28.6 kB view hashes)

Uploaded source

Built Distribution

github_ssh_auth-1.0.1-py2.py3-none-any.whl (25.4 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page