Add push script; improve docs

* Add random-route option to manifest

* Add push script

* Add script to clean up temporary stuff

* Start client after push

* Split tunnel stuff into a separate script

* Emphasize need to have modified .ssh/config

* Add sanity check for URL

* Fix for changed version of cf

* Allow configuration of port numbers

Author: JimNasbyGE

.default.sh

@@ -0,0 +1,2 @@
+CHISEL_LOCAL_PORT=${CHISEL_LOCAL_PORT:-5022}
+CHISEL_REMOTE_PORT=${CHISEL_REMOTE_PORT:-2022}

.gitignore

@@ -0,0 +1,7 @@
+# Ignore client
+chisel
+
+# Ignore things that are done on a per-instance basis
+id_rsa.pub
+ssh_host_rsa_key
+ssh_host_rsa_key.pub

README.md

@@ -54,7 +54,24 @@
 	(2022 in this case) is fixed. You can run multiple chisel clients simultaneously
 	by choosing a different local port (5022 in this case).
 
-7. Use SSH to login in the container
+7. Add entry to ~/.ssh/config (optional)
+    
+    You can add an entry to your ssh config to make ssh'ing to chisel easier.
+    NOTE: the config file is position sensitive, so if you have a `Host *`
+    entry in your file you need to add this before the `Host *` entry.
+
+    ```
+    Host chisel
+        ForwardAgent yes
+        HostName localhost
+        Port 5022
+        User vcap
+        Compression yes
+    ```
+
+    This entry will allow you to simply `ssh chisel` to connect.
+
+8. Use SSH to login in the container
 
 	Use standard SSH applications to connect to the SSH daemon in the container.
 	The user name to connect as is `vcap`. The SSH utiliites will use your private
@@ -64,18 +81,34 @@
 	`-i` switch. You must have uploaded the corresponding public key in step 3
 	above, for this to work.
 
+    If you added an entry to ~/.ssh/config:
+
+    ```
+    ssh chisel
+    ```
+
+    otherwise:
+
 	```
 	ssh vcap@localhost -p 5022
 	```
 
-8. Perform local port forwarding
+9. Perform local port forwarding
 
 	You can also use SSH to perform local port forwarding.
 
 	For example, you can use this command to create a local port 6632 that
 	forwards all TCP traffic to your Postgres database (port 5432) instance
 	that is only accessible from Cloud Foundry applications.
 
+    If you added an entry to ~/.ssh/config:
+
+    ```
+	ssh -L 6632:myapp-db.example.com:5432 chisel
+    ```
+
+    otherwise:
+
 	```
 	ssh -L 6632:myapp-db.example.com:5432 vcap@localhost -p 5022
 	```

clean.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+set -e
+
+cd `dirname $0`
+
+for f in `egrep -v '^#' .gitignore`; do
+    if echo $f | egrep -q '^/|\.\.'; then
+        echo "Ignoring dangerous .gitignore entry $f"
+    else
+        echo Removing $f
+        rm -f $f
+    fi
+done

push.sh

@@ -0,0 +1,46 @@
+#!/bin/sh
+
+set -e # exit on error
+
+cd `dirname $0`
+source .default.sh
+
+appname="cf-ssh-chisel-$USER"
+
+# Generate a key to identify the server (if one doesn't already exist)
+# TODO: put all generated files (this and id_rsa.pub) into a single directory
+if [ ! -r ssh_host_rsa_key ]; then
+  ssh-keygen -t rsa -f ssh_host_rsa_key -N '' -C "chisel-ssh identity for $appname"
+  echo '[localhost]:$CHISEL_LOCAL_PORT' `cat ssh_host_rsa_key.pub` >> ~/.ssh/known_hosts
+fi
+
+if [ ! -r id_rsa.pub ]; then
+  cp ~/.ssh/id_rsa.pub .
+fi
+
+if ! grep -q 'Host chisel' ~/.ssh/config; then
+cat <<_EOF_
+
+You might want to add this entry to ~/.ssh/config. Note that the config file is
+position-sensitive, so this needs to be added before the 'Host *' entry if you
+have one.
+
+Host chisel
+    ForwardAgent yes
+    HostName localhost
+    Port $CHISEL_LOCAL_PORT
+    User vcap
+    Compression yes
+_EOF_
+fi
+
+cf push -t 180 $appname & # -t: maximum number of seconds to wait for app to start
+
+export GOPATH=$(echo ${PWD%src/github.com/jpillora/chisel})
+go build
+
+wait
+
+./tunnel
+
+# vi: expandtab sw=2 ts=2

tunnel

@@ -0,0 +1,47 @@
+#!/bin/sh
+
+set -e # exit on error
+
+cd `dirname $0`
+
+appname="cf-ssh-chisel-$USER"
+echo "Starting $appname forwarding local port ${CHISEL_LOCAL_PORT:=5022} to remote port ${CHISEL_REMOTE_PORT:=2022}"
+
+echo "Checking if $appname is running"
+cf app $appname > /dev/null # Make sure app is there
+
+if ! cf app $appname | grep -q running; then
+  echo "ERROR: $appname is not running"
+  exit 1
+fi
+
+echo "Obtaining url for $appname"
+url=`cf app $appname | egrep 'routes|urls' | awk '{print $2}'`
+
+# Sanity-check the URL. This is kinda important because the chisel client
+# doesn't complain if it can't connect. :(
+echo "$url" | grep "$appname" | grep -q predix.io || { echo "URL doesn't look sane: $url"; exit 2; }
+
+# If there's an existing client running, kill it
+client_pids=`ps auxww | grep ./chisel | grep ${CHISEL_LOCAL_PORT}:${CHISEL_REMOTE_PORT} | grep -v grep | awk '{print $2}'`
+if [ -n "$client_pids" ]; then
+  kill $client_pids
+fi
+
+echo "Starting client, connecting to $url"
+cmd="./chisel client --keepalive 10s https://$url ${CHISEL_LOCAL_PORT}:${CHISEL_REMOTE_PORT}"
+echo "Running in background: $cmd"
+$cmd > /dev/null &
+
+cat <<_EOF_
+You can now connect via
+
+ssh vcap@localhost -p ${CHISEL_LOCAL_PORT}
+
+or **IF** you added an entry to ~/.ssh/config:
+
+ssh chisel
+
+_EOF_
+
+# vi: expandtab sw=2 ts=2