Merge branch 'release/0.3.1'

Conflicts:
	README.md
	ReleaseNotes.md
	pom.xml
	src/clj_ssh/reflect.clj

Author: hugoduncan

.gitignore

@@ -4,3 +4,4 @@ target
 lib
 classes
 autodoc/**
+doc/**

README.md

@@ -52,9 +52,25 @@ Note that any sftp commands that change the state of the sftp session (such as
 cd) do not work with the simplified interface, as a new session is created each
 time.
 
+SSH tunneling is also supported:
+
+    (with-ssh-agent []
+      (let [session (session "localhost" :strict-host-key-checking :no)]
+        (with-local-tunnel session 8080 80
+          (with-connection session
+            (while (connected? session)
+              (Thread/sleep 100))))))
+
+or more conveniently:
+
+    (with-ssh-agent []
+      (let [session (session "localhost" :strict-host-key-checking :no)]
+        (ssh-tunnel session 8080 80)))
+
 ## Documentation
 
 [Annotated source](http:/hugoduncan.github.com/clj-ssh/uberdoc.html).
+[API](http:/hugoduncan.github.com/clj-ssh/api/0.3/index.html).
 
 ## FAQ
 
@@ -71,7 +87,7 @@ A: Probably a disk full, or permission error.
 Via [clojars](http://clojars.org) and
 [Leiningen](http://github.com/technomancy/leiningen).
 
-    :dependencies [clj-ssh "0.3.0"]
+    :dependencies [clj-ssh "0.3.1"]
 
 or your favourite maven repository aware tool.
 

ReleaseNotes.md

@@ -1,6 +1,13 @@
 # Release Notes
 
-Current release is 0.3.0
+Current release is 0.3.1
+
+## 0.3.1
+
+- Allow clj-ssh to work with a wide range of slingshot versions
+  Tested with slingshot 0.2.0 and 0.10.1
+
+- Added SSH tunneling.
 
 ## 0.3.0
 

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>clj-ssh</groupId>
   <artifactId>clj-ssh</artifactId>
-  <version>0.3.0</version>
+  <version>0.3.1</version>
   <name>clj-ssh</name>
   <description>
     clj-ssh is a clojure wrapper for he jsch library, and can be used as an
@@ -94,7 +94,7 @@
     <dependency>
       <groupId>slingshot</groupId>
       <artifactId>slingshot</artifactId>
-      <version>0.2.0</version>
+      <version>${slingshot.version}</version>
     </dependency>
     <dependency>
       <groupId>org.clojure</groupId>
@@ -141,13 +141,20 @@
     <profile>
       <id>clojure-1.3</id>
       <properties>
-        <clojure.version>1.3.0-beta1</clojure.version>
+        <clojure.version>1.3.0</clojure.version>
+      </properties>
+    </profile>
+    <profile>
+      <id>clojure-1.4</id>
+      <properties>
+        <clojure.version>1.4.0-alpha3</clojure.version>
       </properties>
     </profile>
   </profiles>
 
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <clojure.version>1.2.0</clojure.version>
+    <slingshot.version>0.2.0</slingshot.version>
   </properties>
 </project>

project.clj

@@ -1,14 +1,18 @@
-(defproject clj-ssh "0.3.0"
-  :description "ssh from clojure"
+(defproject clj-ssh "0.3.1"
+  :description "Library for using SSH from clojure."
   :dependencies [[org.clojure/clojure "1.2.0"]
                  [org.clojure/tools.logging "0.1.2"]
                  [slingshot "0.2.0"]
                  [com.jcraft/jsch "0.1.44-1"]]
-  :dev-dependencies [[swank-clojure "1.2.1"]
-                     [autodoc "0.7.1"]
-                     [log4j/log4j "1.2.14"]]
-  :autodoc {:name "clj-ssh"
-            :description "Library for using SSH from clojure."
-            :copyright "Copyright Hugo Duncan 2010, 2011. All rights reserved."
-            :web-src-dir "http://github.com/hugoduncan/clj-ssh/blob/"
-            :web-home "http://hugoduncan.github.com/clj-ssh/" })
+  :dev-dependencies [[log4j/log4j "1.2.14"]]
+  :multi-deps {"slingshot-0.10.1" [[slingshot "0.10.1"]
+                                   [org.clojure/clojure "1.2.1"]]
+               "clojure-1.2.1" [[slingshot "0.10.1"]
+                                [org.clojure/clojure "1.2.1"]]
+               "clojure-1.3.0" [[slingshot "0.10.1"]
+                                [org.clojure/clojure "1.3.0"]]
+               "clojure-1.4.0" [[slingshot "0.10.1"]
+                                [org.clojure/clojure "1.4.0-beta1"]]}
+  :codox {:writer codox-md.writer/write-docs
+          :version "0.3"
+          :output-dir "doc/api/0.3"})

src/clj_ssh/reflect.clj

@@ -27,9 +27,11 @@
       (.invoke obj (into-array Object args))))
 
 (defn get-field
-  "Access to private or protected field.  field-name is a symbol or
-  keyword."
+  "Access to private or protected field. field-name is a symbol or
+   keyword."
   [klass field-name obj]
-  (-> klass (.getDeclaredField (name field-name))
-      (doto (.setAccessible true))
-      (.get obj)))
+  (->
+   klass
+   (.getDeclaredField (name field-name))
+   (doto (.setAccessible true))
+   (.get obj)))

src/clj_ssh/ssh.clj

@@ -42,12 +42,17 @@ Licensed under EPL (http://www.eclipse.org/legal/epl-v10.html)"
    [clj-ssh.reflect :as reflect]
    [clojure.java.io :as io]
    [clojure.string :as string]
-   [clojure.tools.logging :as logging]
-   [slingshot.core :as slingshot])
+   [clojure.tools.logging :as logging])
   (:import [com.jcraft.jsch
             JSch Session Channel ChannelShell ChannelExec ChannelSftp
             Identity IdentityFile Logger KeyPair]))
 
+;; slingshot version compatability
+(try
+  (use '[slingshot.slingshot :only [throw+]])
+  (catch Exception _
+    (use '[slingshot.core :only [throw+]])))
+
 (def ^{:doc "SSH agent used to manage identities." :dynamic true}
   *ssh-agent*)
 
@@ -392,6 +397,29 @@ keys.  All other option key pairs will be passed as SSH config options."
            (.toByteArray err-stream)
            (.toString err-stream out))]))))
 
+(defn forward-local-port
+  "Start local port forwarding"
+  ([session local-port remote-port remote-host]
+     (.setPortForwardingL session local-port remote-host remote-port))
+  ([session local-port remote-port]
+     (forward-local-port session local-port remote-port "localhost")))
+
+(defn unforward-local-port
+  "Remove local port forwarding"
+  [session local-port]
+  (.delPortForwardingL session local-port))
+
+(defmacro with-local-port-forward
+  "Creates a context in which a local SSH tunnel is established for the session.
+   (Use before the connection is opened.)"
+  [[session local-port remote-port & [remote-host & _]] & body]
+  `(try
+     (forward-local-port
+      ~session ~local-port ~remote-port ~(or remote-host "localhost"))
+     ~@body
+     (finally
+      (unforward-local-port ~session ~local-port))))
+
 (defn default-session [host username port password]
   (doto (session-impl
          (or (and (bound? #'*ssh-agent*) *ssh-agent*) (create-ssh-agent))
@@ -487,7 +515,7 @@ Options are
       5 (. target#
            (~name (first args#) (second args#) (nth args# 2) (nth args# 3)
                   (nth args# 4)))
-      (slingshot/throw+
+      (throw+
        (java.lang.IllegalArgumentException.
         (str "Too many arguments passed.  Limit 5, passed " (count args#)))))))
 
@@ -533,7 +561,7 @@ Options are
                       (conj args (sftp-modemap (options :mode)))
                       args)]
            ((memfn-varargs put) channel args))
-    (slingshot/throw+
+    (throw+
      (java.lang.IllegalArgumentException. (str "Unknown SFTP command " cmd)))))
 
 (defn sftp
@@ -605,7 +633,7 @@ Options are
   [in]
   (let [code (.read in)]
     (when-not (zero? code)
-      (slingshot/throw+
+      (throw+
        {:type :clj-ssh/scp-failure
         :message (format
                   "clj-ssh scp failure: %s"
@@ -685,7 +713,7 @@ Options are
             (fn [path]
               (let [file (java.io.File. path)]
                 (when (.isDirectory file)
-                  (slingshot/throw+
+                  (throw+
                    {:type :clj-ssh/scp-directory-copy-requested
                     :message (format
                               "Copy of dir %s requested without recursive flag"
@@ -838,7 +866,7 @@ Options are
         _ (when (and (.exists file)
                      (not (.isDirectory file))
                      (> (count remote-paths) 1))
-            (slingshot/throw+
+            (throw+
              {:type :clj-ssh/scp-copy-multiple-files-to-file-requested
               :message (format
                         "Copy of multiple files to file %s requested"

test/clj_ssh/ssh_test.clj

@@ -522,3 +522,22 @@ list, Alan Dipert and MeikelBrandmeyer."
   (with-ssh-agent []
     (let [[priv pub] (generate-keypair :rsa 1024 "hello")]
       (add-identity *ssh-agent* "name" priv pub (.getBytes "hello")))))
+
+(deftest forward-local-port-test
+  (testing "minimal test"
+    (with-ssh-agent [false]
+      (add-identity (private-key-path))
+      (let [session (session "localhost" :username (username)
+                             :strict-host-key-checking :no)]
+        (is (instance? com.jcraft.jsch.Session session))
+        (is (not (connected? session)))
+        (connect session)
+        (is (connected? session))
+        (forward-local-port session 2222 22)
+        (unforward-local-port session 2222)
+        (forward-local-port session 2222 22 "localhost")
+        (unforward-local-port session 2222)
+        (with-local-port-forward [session 2222 22]
+          (is true))
+        (with-local-port-forward [session 2222 22 "localhost"]
+          (is true))))))