renaming and refactoring

Author: progrium

LICENSE

@@ -1,12 +1,21 @@
-Copyright (C) 2014 Jeff Lindsay
-Copyright (c) 2013-2014 Prime Directive, Inc. All rights reserved.
+The MIT License (MIT)
 
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+Copyright (c) 2015 Glider Labs
 
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -1,13 +1,15 @@
-NAME=execd
-OWNER=progrium
+NAME=sshfront
+OWNER=gliderlabs
 ARCH=$(shell uname -m)
-VERSION=0.1.0
+VERSION=0.2.0
 
 build:
 	mkdir -p build/Linux && GOOS=linux CGO_ENABLED=0 go build -a \
+		-ldflags "-X main.Version $(VERSION)" \
 		-installsuffix cgo \
 		-o build/Linux/$(NAME)
 	mkdir -p build/Darwin && GOOS=darwin CGO_ENABLED=0 go build -a \
+		-ldflags "-X main.Version $(VERSION)" \
 		-installsuffix cgo \
 		-o build/Darwin/$(NAME)
 
@@ -16,7 +18,7 @@ deps:
 	go get || true
 
 example: build
-	./execd -h localhost -p 2022 -k example/host_pk.pem example/authcheck example/helloworld
+	./build/Darwin/sshfront -d -p 2222 -k ~/.ssh/id_rsa example/helloworld
 
 
 release:

README.md

@@ -1,17 +1,17 @@
-# execd
+# sshfront
 
-A very lightweight SSH server frontend written in Go. The backend auth and execution logic is handled by commands you specify, letting you customize its behavior via your own scripts/executables.
+A lightweight SSH server frontend written in Go. Authentication and connections
+are controlled with command handlers / shell scripts.
 
-## Using execd
+## Using sshfront
 ```
-Usage: ./execd [options] <auth-handler> <exec-handler>
+Usage: ./sshfront [options] <handler>
 
   -d=false: debug mode displays handler output
   -e=false: pass environment to handlers
   -k="": pem file of private keys (read from SSH_PRIVATE_KEYS by default)
   -h="": host ip to listen on
   -p="22": port to listen on
-  -s=false: run exec handler via SHELL
 ```
 
 
@@ -39,15 +39,15 @@ exec-handler is the path to an executable that's used to execute the command pro
 Echo server (with accept-all auth):
 
 ```
-server$ execd $(which true) $(which echo)
+server$ sshfront $(which true) $(which echo)
 client$ ssh $SERVER "hello world"
 hello world
 ```
 
 Echo host's environment to clients (with accept-all auth):
 
 ```
-server$ execd -e $(which true) $(env)
+server$ sshfront -e $(which true) $(env)
 client$ ssh $SERVER
 USER=root
 HOME=/root
@@ -58,19 +58,13 @@ LANG=en_US.UTF-8
 Bash server (with accept-all auth):
 
 ```
-server$ execd $(which true) $(which bash)
+server$ sshfront $(which true) $(which bash)
 client$ ssh $SERVER
 bash-4.3$ echo "this is a bash instance running on the server"
 this is a bash instance running on the server
 ```
 
 
-## Credit / History
-
-It started with [gitreceive](https://github.com/progrium/gitreceive), which was then used in [Dokku](https://github.com/progrium/dokku). Then I made a more generalized version of gitreceive, more similar to execd, called [sshcommand](https://github.com/progrium/sshcommand), which eventually replaced gitreceive in Dokku. When I started work on Flynn, the first projects included [gitreceived](https://github.com/flynn/gitreceived) (a standalone daemon version of gitreceive). This was refined by the Flynn community, namely Jonathan Rudenberg. 
-
-Eventually I came to realize gitreceived could be generalized / simplified further in a way that could be used *with* the original gitreceive, *and* replace sshcommand, *and* be used in Dokku, *and* potentially replace gitreceived in Flynn. This project takes learnings from all those projects, though mostly gitreceived.
-
 ## Sponsors
 
 This project was made possible thanks to [DigitalOcean](http://digitalocean.com).

circle.yml

@@ -5,8 +5,8 @@ dependencies:
     - make deps
     - make build
   post:
-    - tar -czvf $CIRCLE_ARTIFACTS/execd-linux.tgz -C build/Linux execd
-    - tar -czvf $CIRCLE_ARTIFACTS/execd-darwin.tgz -C build/Darwin execd
+    - tar -czvf $CIRCLE_ARTIFACTS/sshfront-linux.tgz -C build/Linux sshfront
+    - tar -czvf $CIRCLE_ARTIFACTS/sshfront-darwin.tgz -C build/Darwin sshfront
     - tar -czvf $CIRCLE_ARTIFACTS/go-workspace.tgz -C ~/.go_workspace .
 
 test:

example/authcheck

@@ -1,13 +1,2 @@
 #!/bin/bash
-
-USER="$1"
-KEY="$2"
-
-generate_fingerprint() {
-  awk '{print $2}' | base64 -d | md5sum | awk '{print $1}' | sed -e 's/../:&/2g'
-}
-
-echo "USER=$USER"
-echo "FINGERPRINT=$(echo "$KEY" | generate_fingerprint)"
-
-grep "$KEY" "/home/$USER/.ssh/authorized_keys" > /dev/null 2>&1
+grep "$2" "/home/$1/.ssh/authorized_keys" > /dev/null 2>&1

example/helloworld

@@ -1,4 +1,6 @@
 #!/bin/bash
-echo "Hello world"
-read hello
-echo "OK: $hello"
+echo "Hello world: $@"
+env
+if [[ -t 1 ]]; then
+  exec bash
+fi