tsutsu / github-auth3

Use Github for your SSH AuthorizedKeysCommand

github-auth3

github-auth3 is a plugin for OpenBSD SSHD (specifically, an AuthorizedKeysCommand) which allows users to authenticate themselves to machines configured with it by supplying the usernames of their GitHub accounts, and then doing SSH pubkey auth against any public key attached to those GitHub accounts. Access is controlled by membership to a specified GitHub organization, and optionally specified teams within the organization.

Installation

1. Create a GitHub organization, or choose one you already have. Any member of the configured organization will be able to log into the server.

2. Generate a GitHub access token, with minimal grants, against a user (usually yourself, but this could be an isolated "machine user") who can "see into" the membership of the organization. (For most organizations, all members are publicly visible, so you can do this as any user, even one who is not a member of the organization. The token is still necessary in such scenarios to raise API request limits.)

3. Create an sshauthcmd user:

#!/bin/sh
sudo adduser --system sshauthcmd

4. Add the following to your /etc/ssh/sshd_config:

AuthorizedKeysCommand /usr/local/bin/github-auth3 -a YOUR_GITHUB_ACCESS_TOKEN -o YOUR_ORG_NAME -u %u
AuthorizedKeysCommandUser sshauthcmd

5. Restart the sshd service (sudo systemctl restart sshd or equivalent.)

Restricting to specific Github teams within your organization

Just add the -t flag, passing a comma-separated list of acceptable team slug-names:

AuthorizedKeysCommand /usr/local/bin/github-auth3 -a YOUR_GITHUB_ACCESS_TOKEN -o YOUR_ORG_NAME -t TEAM1,TEAM2 -u %u

Enabling caching

github-auth3 can optionally make use of a persistent HTTP cache, respecting the caching headers in GitHub's API responses. This doesn't matter much normally, but can avoid some pain if your instance is public-visible and gets DoS-attacked with SSH login attempts.

1. Create a credential-cache directory for github-auth3 to use:

#!/bin/sh
sudo mkdir -p '/var/cache/github-auth3'
sudo chown sshauthcmd:root '/var/cache/github-auth3'
sudo chmod 0700 '/var/cache/github-auth3'

2. Add the -cpath flag to your AuthorizedKeysCommand in /etc/ssh/sshd_config:

AuthorizedKeysCommand /usr/local/bin/github-auth3 -a YOUR_GITHUB_ACCESS_TOKEN -cpath /var/cache/github-auth3 -o YOUR_ORG_NAME -u %u

3. Restart the sshd service (sudo systemctl restart sshd or equivalent.)

Hardening

If you're worried about having an access token embedded in /etc/ssh/sshd_config (despite this token not really being able to do anything much), you can provide a path to a file containing your token instead.

You'll probably want to lock down access to the token file itself, but remember that it's the AuthorizedKeysCommandUser, not OpenSSH itself, that will need to access this file.

1. Create the token file, and secure it:

#!/bin/sh
sudo vi /etc/ssh/github_access_token # or what-have-you
sudo chown sshauthcmd:root /etc/ssh/github_access_token
sudo chmod 0400 /etc/ssh/github_access_token

2. In /etc/ssh/sshd_config, replace your AuthorizedKeysCommand's -a flag with -apath:

AuthorizedKeysCommand /usr/local/bin/github-auth3 -apath /etc/ssh/github_access_token -o YOUR_ORG_NAME -u %u

3. Restart the sshd service (sudo systemctl restart sshd or equivalent.)

github-auth3's Issues

Access token visible in process command.

Enterprising individuals can grab the access token using something like ps.