Merge branch 'release/0.3.2'

Author: hugoduncan

README.md

@@ -54,18 +54,13 @@ time.
 
 SSH tunneling is also supported:
 
+```clj
     (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)))
+        (with-connection session
+          (with-local-port-forward [session 8080 80]
+            (comment do something with port 8080 here)))))
+```
 
 ## Documentation
 
@@ -87,17 +82,12 @@ 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.1"]
+    :dependencies [clj-ssh "0.3.2"]
 
 or your favourite maven repository aware tool.
 
 ## License
 
-Licensed under [EPL](http://www.eclipse.org/legal/epl-v10.html)
-
-## TODO
+Copyright © 2012 Hugo Duncan
 
-port forwarding
-environment setup
-sftp
-scp
+Licensed under [EPL](http://www.eclipse.org/legal/epl-v10.html)

ReleaseNotes.md

@@ -1,6 +1,16 @@
 # Release Notes
 
-Current release is 0.3.1
+Current release is 0.3.2
+
+## 0.3.2
+
+- Add remote port forwarding support
+
+- Fix documentation for with-local-port-forward
+
+- Allow specification of session options as strings
+  This should allow options like:
+   (default-session-options {"GSSAPIAuthentication" "no"})
 
 ## 0.3.1
 

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>clj-ssh</groupId>
   <artifactId>clj-ssh</artifactId>
-  <version>0.3.1</version>
+  <version>0.3.3-SNAPSHOT</version>
   <name>clj-ssh</name>
   <description>
     clj-ssh is a clojure wrapper for he jsch library, and can be used as an
@@ -22,42 +22,42 @@
     <testSourceDirectory>test</testSourceDirectory>
     <resources>
       <resource>
-	<directory>src</directory>
+        <directory>src</directory>
       </resource>
     </resources>
     <plugins>
       <plugin>
-	<groupId>com.theoryinpractise</groupId>
-	<artifactId>clojure-maven-plugin</artifactId>
-	<version>1.3.7</version>
-	<configuration>
-	  <sourceDirectories>
-	    <sourceDirectory>src</sourceDirectory>
-	  </sourceDirectories>
-	  <testSourceDirectories>
-	    <testSourceDirectory>test</testSourceDirectory>
-	  </testSourceDirectories>
-	  <clojureOptions>-Xmx512m -Djava.awt.headless=true -XX:MaxPermSize=256m</clojureOptions>
-	  <warnOnReflection>false</warnOnReflection>
+        <groupId>com.theoryinpractise</groupId>
+        <artifactId>clojure-maven-plugin</artifactId>
+        <version>1.3.7</version>
+        <configuration>
+          <sourceDirectories>
+            <sourceDirectory>src</sourceDirectory>
+          </sourceDirectories>
+          <testSourceDirectories>
+            <testSourceDirectory>test</testSourceDirectory>
+          </testSourceDirectories>
+          <clojureOptions>-Xmx512m -Djava.awt.headless=true -XX:MaxPermSize=256m</clojureOptions>
+          <warnOnReflection>false</warnOnReflection>
           <compileDeclaredNamespaceOnly>true</compileDeclaredNamespaceOnly>
           <temporaryOutputDirectory>true</temporaryOutputDirectory>
-	</configuration>
-	<executions>
-	  <execution>
-	    <id>compile-clojure</id>
-	    <phase>compile</phase>
-	    <goals>
-	      <goal>compile</goal>
-	    </goals>
-	  </execution>
-	  <execution>
-	    <id>test-clojure</id>
-	    <phase>test</phase>
-	    <goals>
-	      <goal>test</goal>
-	    </goals>
-	  </execution>
-	</executions>
+        </configuration>
+        <executions>
+          <execution>
+            <id>compile-clojure</id>
+            <phase>compile</phase>
+            <goals>
+              <goal>compile</goal>
+            </goals>
+          </execution>
+          <execution>
+            <id>test-clojure</id>
+            <phase>test</phase>
+            <goals>
+              <goal>test</goal>
+            </goals>
+          </execution>
+        </executions>
       </plugin>
       <plugin>
           <artifactId>maven-jar-plugin</artifactId>
@@ -69,22 +69,15 @@
           </configuration>
       </plugin>
       <plugin>
-	<artifactId>maven-release-plugin</artifactId>
-	<version>2.0</version>
+        <artifactId>maven-release-plugin</artifactId>
+        <version>2.0</version>
         <configuration>
           <pushChanges>false</pushChanges>
         </configuration>
       </plugin>
     </plugins>
   </build>
 
-  <repositories>
-    <repository>
-      <id>clojars</id>
-      <url>http://clojars.org/repo/</url>
-    </repository>
-  </repositories>
-
   <dependencies>
     <dependency>
       <groupId>org.clojure</groupId>
@@ -126,16 +119,16 @@
     <profile>
       <id>testuser</id>
       <build>
-	<plugins>
-	  <plugin>
-	    <groupId>com.theoryinpractise</groupId>
-	    <artifactId>clojure-maven-plugin</artifactId>
-	    <version>1.3.7</version>
-	    <configuration>
-	      <clojureOptions>-Xmx512m -Djava.awt.headless=true -XX:MaxPermSize=256m -Dssh.username=testuser</clojureOptions>
-	    </configuration>
-	  </plugin>
-	</plugins>
+        <plugins>
+          <plugin>
+            <groupId>com.theoryinpractise</groupId>
+            <artifactId>clojure-maven-plugin</artifactId>
+            <version>1.3.7</version>
+            <configuration>
+              <clojureOptions>-Xmx512m -Djava.awt.headless=true -XX:MaxPermSize=256m -Dssh.username=testuser</clojureOptions>
+            </configuration>
+          </plugin>
+        </plugins>
       </build>
     </profile>
     <profile>

project.clj

@@ -1,4 +1,4 @@
-(defproject clj-ssh "0.3.1"
+(defproject clj-ssh "0.3.2-SNAPSHOT"
   :description "Library for using SSH from clojure."
   :dependencies [[org.clojure/clojure "1.2.0"]
                  [org.clojure/tools.logging "0.1.2"]

src/clj_ssh/ssh.clj

@@ -237,11 +237,13 @@ be added.  An existing agent instance can alternatively be passed."
                  (or port 22))]
     (when password
       (.setPassword session password))
-    (doseq [option options]
+    (doseq [[k v :as option] options]
       (.setConfig
        session
-       (camelize (as-string (first option)))
-       (as-string (second option))))
+       (if (string? k)
+         k
+         (camelize (as-string k)))
+       (as-string v)))
     session))
 
 (defn session
@@ -397,6 +399,29 @@ keys.  All other option key pairs will be passed as SSH config options."
            (.toByteArray err-stream)
            (.toString err-stream out))]))))
 
+(defn forward-remote-port
+  "Start remote port forwarding"
+  ([session remote-port local-port local-host]
+     (.setPortForwardingR session remote-port local-host local-port))
+  ([session remote-port local-port]
+     (forward-remote-port session remote-port local-port "localhost")))
+
+(defn unforward-remote-port
+  "Remove remote port forwarding"
+  [session remote-port]
+  (.delPortForwardingR session remote-port))
+
+(defmacro with-remote-port-forward
+  "Creates a context in which a remote SSH tunnel is established for the
+  session. (Use after the connection is opened.)"
+  [[session remote-port local-port & [local-host & _]] & body]
+  `(try
+     (forward-remote-port
+      ~session ~remote-port ~local-port ~(or local-host "localhost"))
+     ~@body
+     (finally
+      (unforward-remote-port ~session ~remote-port))))
+
 (defn forward-local-port
   "Start local port forwarding"
   ([session local-port remote-port remote-host]
@@ -411,7 +436,7 @@ keys.  All other option key pairs will be passed as SSH config options."
 
 (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.)"
+   (Use after the connection is opened.)"
   [[session local-port remote-port & [remote-host & _]] & body]
   `(try
      (forward-local-port

test/clj_ssh/ssh_test.clj

@@ -523,6 +523,23 @@ list, Alan Dipert and MeikelBrandmeyer."
     (let [[priv pub] (generate-keypair :rsa 1024 "hello")]
       (add-identity *ssh-agent* "name" priv pub (.getBytes "hello")))))
 
+(defn port-reachable?
+  ([ip port timeout]
+     (let [socket (doto (java.net.Socket.)
+                    (.setReuseAddress false)
+                    (.setSoLinger false 1)
+                    (.setSoTimeout timeout))]
+       (try
+         (.connect socket (java.net.InetSocketAddress. ip port))
+         true
+         (catch java.io.IOException _)
+         (finally
+           (try (.close socket) (catch java.io.IOException _))))))
+  ([ip port]
+     (port-reachable? ip port 2000))
+  ([port]
+     (port-reachable? "localhost" port)))
+
 (deftest forward-local-port-test
   (testing "minimal test"
     (with-ssh-agent [false]
@@ -531,13 +548,36 @@ list, Alan Dipert and MeikelBrandmeyer."
                              :strict-host-key-checking :no)]
         (is (instance? com.jcraft.jsch.Session session))
         (is (not (connected? session)))
+        (is (not (port-reachable? 2222)))
         (connect session)
         (is (connected? session))
         (forward-local-port session 2222 22)
+        (is (port-reachable? 2222))
         (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))
+          (is (port-reachable? 2222)))
         (with-local-port-forward [session 2222 22 "localhost"]
-          (is true))))))
+          (is (port-reachable? 2222)))))))
+
+(deftest forward-remote-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)))
+        (is (not (port-reachable? 2222)))
+        (connect session)
+        (is (connected? session))
+        (forward-remote-port session 2222 22)
+        (is (port-reachable? 2222))
+        (unforward-remote-port session 2222)
+        (forward-remote-port session 2222 22 "localhost")
+        (unforward-remote-port session 2222)
+        (with-remote-port-forward [session 2222 22]
+          (is (port-reachable? 2222)))
+        (with-remote-port-forward [session 2222 22 "localhost"]
+          (is (port-reachable? 2222)))))))