Merge branch 'release/0.4.1'

Author: hugoduncan

README.md

@@ -50,47 +50,75 @@ the system's ssh-agent, or to clj-ssh's ssh-agent with the appropriate
 
 ### Non REPL
 
-The `clj-ssh.ssh` namespace should be using SSH from functional code.
+The `clj-ssh.ssh` namespace should be used for SSH from functional code.
 
 ```clj
-(let [agent (ssh-agent {:use-system-ssh-agent false})]
-  (add-identity agent "/user/name/.ssh/id_rsa")
+(let [agent (ssh-agent {})]
   (let [session (session agent "localhost" {:strict-host-key-checking :no})]
     (with-connection session
       (let [result (ssh session {:in "echo hello"})]
         (println (result :out)))
       (let [result (ssh session {:cmd "ls"}]
-        (println (second result))))))
+        (println (second result)))))))
 ```
 
 The above example shows using `:in` to pass commands to a shell, and using
 `:cmd` to exec a command without a shell. When using `:cmd` you can still pass
 a stream or a string to `:in` to be used as the process' standard input.
 
+By default, the system ssh-agent is used, which means the ssh keys you use at
+the command line level should automatically be picked up (this should also work
+with `pageant` on windows).
+
+You can forward the ssh-agent, which allows you to run ssh based commands on the
+remote host using the credentials in your local ssh-agent:
+
+```clj
+(let [agent (ssh-agent {})]
+  (let [session (session agent "localhost" {:strict-host-key-checking :no})]
+    (with-connection session
+      (let [result (ssh session {:in "ssh somehost ls" :agent-forwarding true})]
+        (println (result :out))))))
+```
+
+If you prefer not to use the system ssh-agent, or one is not running on your
+system, then a local, isolated ssh-agent can be used.
+
+```clj
+(let [agent (ssh-agent {:use-system-ssh-agent false})]
+  (add-identity agent "/user/name/.ssh/id_rsa")
+  (let [session (session agent "localhost" {:strict-host-key-checking :no})]
+    (with-connection session
+      (let [result (ssh session {:in "echo hello"})]
+        (println (result :out)))))
+```
+
+SFTP is supported:
+
 ```clj
 (let [agent (ssh-agent {})]
   (let [session (session agent "localhost" {:strict-host-key-checking :no})]
     (with-connection session
       (let [channel (ssh-sftp session)]
         (with-channel-connection channel
-          (sftp channel :cd "/remote/path")
-          (sftp channel :put "/some/file" "filename"))))))
+          (sftp channel {} :cd "/remote/path")
+          (sftp channel {} :put "/some/file" "filename"))))))
 ```
 
 SSH tunneling is also supported:
 
 ```clj
-    (let [agent (ssh-agent {:use-system-ssh-agent false})]
-      (let [session (session agent "localhost" :strict-host-key-checking :no)]
+    (let [agent (ssh-agent {})]
+      (let [session (session agent "localhost" {:strict-host-key-checking :no})]
         (with-connection session
           (with-local-port-forward [session 8080 80]
             (comment do something with port 8080 here)))))
 ```
 
 ## Documentation
 
-[Annotated source](http:/hugoduncan.github.com/clj-ssh/uberdoc.html).
-[API](http:/hugoduncan.github.com/clj-ssh/api/0.3/index.html).
+[Annotated source](http:/hugoduncan.github.com/clj-ssh/api/0.4/uberdoc.html).
+[API](http:/hugoduncan.github.com/clj-ssh/api/0.4/index.html).
 
 ## FAQ
 
@@ -105,7 +133,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.4.0"]
+    :dependencies [clj-ssh "0.4.1"]
 
 or your favourite maven repository aware tool.
 

ReleaseNotes.md

@@ -1,6 +1,12 @@
 # Release Notes
 
-Current release is 0.4.0
+Current release is 0.4.1
+
+## 0.4.1
+
+- add option to ssh-agent for :known-hosts-path. Fixes #16.
+
+- remap log levels to be less verbose by default. Fixes #17
 
 ## 0.4.0
 

brick.clj

@@ -0,0 +1,4 @@
+(defbrick clj-ssh
+  :images {:vmfest [{:image {:os-family :ubuntu :os-version-matches "12.04"
+                             :os-64-bit true}
+                     :selectors [:default]}]})

profiles.clj

@@ -0,0 +1,21 @@
+{:dev {:dependencies [[ch.qos.logback/logback-classic "1.0.0"]]}
+ :slingshot-0.10.1 {:dependencies [[slingshot "0.10.1"]
+                                   [org.clojure/clojure "1.2.1"]]}
+ :clojure-1.2.1 {:dependencies [[slingshot "0.10.1"]
+                                [org.clojure/clojure "1.2.1"]]}
+ :clojure-1.3.0 {:dependencies [[slingshot "0.10.1"]
+                                [org.clojure/clojure "1.3.0"]]}
+ :clojure-1.4.0 {:dependencies [[slingshot "0.10.1"]
+                                [org.clojure/clojure "1.4.0-beta1"]]}
+ :codox {:codox {:writer codox-md.writer/write-docs
+                 :version "0.4"
+                 :output-dir "doc/api/0.4"
+                 :exclude [clj-ssh.agent clj-ssh.reflect clj-ssh.keychain]}
+         :dependencies [[codox-md "0.1.0" :exclusions [org.clojure/clojure]]]}
+ :marginalia {:marginalia {:dir "doc/api/0.4"}}
+ :release
+ {:plugins [[lein-set-version "0.2.1"]]
+  :set-version
+  {:updates [{:path "README.md"
+              :no-snapshot true
+              :search-regex #"clj-ssh \"\d+\.\d+\.\d+\""}]}}}

project.clj

@@ -1,31 +1,14 @@
-(defproject clj-ssh "0.4.0"
+(defproject clj-ssh "0.4.1"
   :description "Library for using SSH from clojure."
   :url "https://github.com/hugoduncan/clj-ssh"
+  :license {:name "Eclipse Public License"
+            :url "http://www.eclipse.org/legal/epl-v10.html"}
   :dependencies [[org.clojure/clojure "1.2.1"]
-                 [org.clojure/tools.logging "0.1.2"]
+                 [org.clojure/tools.logging "0.1.2"
+                  :exclusions [org.clojure/clojure]]
                  [jsch-agent-proxy "0.0.4"]
                  [jsch-agent-proxy/jsch-agent-proxy-jna "0.0.4"
                   :exclusions [com.jcraft/jsch-agent-proxy]]
-                 [slingshot "0.10.2"]
-                 [com.jcraft/jsch "0.1.48"]]
-  :dev-dependencies [[org.slf4j/slf4j-api "1.6.1"]
-                     [ch.qos.logback/logback-core "1.0.0"]
-                     [ch.qos.logback/logback-classic "1.0.0"]]
-  :profiles {:dev {:dependencies [[org.slf4j/slf4j-api "1.6.1"]
-                                  [ch.qos.logback/logback-core "1.0.0"]
-                                  [ch.qos.logback/logback-classic "1.0.0"]
-                                  [codox-md "0.1.0"]]}}
-  :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.4"
-          :output-dir "doc/api/0.4"
-          :exclude [clj-ssh.agent clj-ssh.reflect clj-ssh.keychain]}
-  :license {:name "Eclipse Public License"
-            :url "http://www.eclipse.org/legal/epl-v10.html"})
+                 [slingshot "0.10.2"
+                  :exclusions [org.clojure/clojure]]
+                 [com.jcraft/jsch "0.1.48"]])

release.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+# start the release
+
+if [[ $# -lt 3 ]]; then
+  echo "usage: $(basename $0) previous-version new-version next-version" >&2
+  exit 1
+fi
+
+previous_version=$1
+version=$2
+next_version=$3
+
+echo ""
+echo "Start release of $version, previous version is $previous_version"
+echo ""
+echo ""
+
+lein do clean, test && \
+git flow release start $version || exit 1
+
+lein with-profile release set-version ${version} :previous-version ${previous_version} \
+  || { echo "set version failed" >&2 ; exit 1; }
+
+echo ""
+echo ""
+echo "Changes since $previous_version"
+git log --pretty=changelog $previous_version..
+echo ""
+echo ""
+echo "Now edit ReleaseNotes, README and project.clj"
+
+$EDITOR ReleaseNotes.md
+$EDITOR README.md
+$EDITOR project.clj
+
+echo -n "commiting release notes and readme.  enter to continue:" && read x \
+&& git add ReleaseNotes.md README.md project.clj \
+&& git commit -m "Updated version, release notes and readme for $version" \
+&& echo -n "Peform release.  enter to continue:" && read x \
+&& lein with-profile default:clojure-1.2.1:clojure-1.3.0:clojure-1.4.0 test \
+&& lein deploy clojars \
+&& git flow release finish $version \
+&& lein with-profile release set-version ${next_version} \
+&& git add project.clj \
+&& git commit -m "Updated version for next release cycle"

src/clj_ssh/ssh.clj

@@ -45,8 +45,8 @@
 (def ^{:dynamic true}
   ssh-log-levels
   (atom
-   {com.jcraft.jsch.Logger/DEBUG :debug
-    com.jcraft.jsch.Logger/INFO  :info
+   {com.jcraft.jsch.Logger/DEBUG :trace
+    com.jcraft.jsch.Logger/INFO  :debug
     com.jcraft.jsch.Logger/WARN  :warn
     com.jcraft.jsch.Logger/ERROR :error
     com.jcraft.jsch.Logger/FATAL :fatal}))
@@ -93,11 +93,15 @@
 ;;; Agent
 (defn ssh-agent
   "Create a ssh-agent. By default a system ssh-agent is preferred."
-  [{:keys [use-system-ssh-agent] :or {use-system-ssh-agent true}}]
-  (if use-system-ssh-agent
-    (doto (JSch.) (agent/connect))
-    (JSch.)))
-
+  [{:keys [use-system-ssh-agent known-hosts-path]
+    :or {use-system-ssh-agent true
+         known-hosts-path (str (. System getProperty "user.home") "/.ssh/known_hosts")}}]
+  (let [agent (JSch.)]
+    (when use-system-ssh-agent
+      (agent/connect agent))
+    (when known-hosts-path
+      (.setKnownHosts agent known-hosts-path))
+    agent))
 
 ;;; Identities
 (defn has-identity?
@@ -536,7 +540,7 @@ sh returns a map of
 (defn sftp
   "Execute SFTP commands.
 
-  sftp host-or-session cmd & options
+  sftp host-or-session options cmd & args
 
 cmd specifies a command to exec.  Valid commands are:
 :ls