aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan DeMasi <jon.demasi@colorado.edu>2019-06-05 11:16:59 -0600
committerJonathan DeMasi <jon.demasi@colorado.edu>2019-06-05 11:16:59 -0600
commit6405fb9402a7b2b4401b43830efd36c76d3256d6 (patch)
tree0cd27b3cdaa6f1a6814507f28112fe13142dbfee
parentbbfc6effdca3f7d620ca706a80197e681b28f9c2 (diff)
downloadgh_authkey_checker-6405fb9402a7b2b4401b43830efd36c76d3256d6.tar
gh_authkey_checker-6405fb9402a7b2b4401b43830efd36c76d3256d6.tar.gz
gh_authkey_checker-6405fb9402a7b2b4401b43830efd36c76d3256d6.tar.bz2
gh_authkey_checker-6405fb9402a7b2b4401b43830efd36c76d3256d6.tar.lz
gh_authkey_checker-6405fb9402a7b2b4401b43830efd36c76d3256d6.tar.xz
gh_authkey_checker-6405fb9402a7b2b4401b43830efd36c76d3256d6.tar.zst
gh_authkey_checker-6405fb9402a7b2b4401b43830efd36c76d3256d6.zip
readme
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0cf989f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# gh_authkey_checker
+This is an sshd helper intended to be used in conjunction with the `AuthorizedKeysCommand` configuration option to check a user's presented key against their GitHub account. This is definitely *not* the most secure thing to do, but can be used for transient instances like Amazon and other cloud instances for temporary deployments so that you, as the admin, don't have to manage SSH keys :-) Just add users and go. *Note: Local usernames must match the user's GitHub account name*
+
+## Building
+Simply clone the repository and use `go build -o gh_authkey_checker main.go` to build a binary. This repository is also mirrored on [GitHub](https://github.com/jrdemasi/gh_authkey_checker), because, afterall, it's Go. If you trust me, the most up-to-date copy of the tool can also be found [here](https://jrdemasi.com/files/binaries/gh_authkey_checker "gh_authkey_checker binary download")