Merge branch 'release/0.6.0'

Author: sirthias

CHANGELOG

@@ -0,0 +1,12 @@
+Version 0.6.0 (2012-05-30)
+--------------------------
+- Upgraded to
+  - sshj 0.8.0
+  - jzlib 1.1.1
+- Added option for loading the private key file from the classpath
+- Disabled cross-path publishing
+
+
+Version 0.5.0 (2012-02-06)
+--------------------------
+first public release

README.markdown

@@ -11,23 +11,23 @@ It builds on [sshj] to provide the following features:
 
 ## Installation
 
-The current release is *0.5.0*, it's available from <http://repo.spray.cc>.
+The current release is *0.6.0*, it's available from <http://repo.spray.cc>.
 If you use [SBT] you can pull in the _scala-ssh_ artifacts with:
 
     resolvers += "spray repo" at "http://repo.spray.cc"
 
-    libraryDependencies += "com.decodified" %% "scala-ssh" % "0.5.0"
+    libraryDependencies += "com.decodified" %% "scala-ssh" % "0.6.0"
 
 [sshj] uses [SLF4J] for logging, so you might want to also add [logback] to your dependencies:
 
-    libraryDependencies += "ch.qos.logback" % "logback-classic" % "1.0.0"
+    libraryDependencies += "ch.qos.logback" % "logback-classic" % "1.0.3"
 
 Additionally, in many cases you will need the following two artifacts, which provide additional cypher and compression
 support:
 
     libraryDependencies ++= Seq(
       "org.bouncycastle" % "bcprov-jdk16" % "1.46",
-      "com.jcraft" % "jzlib" % "1.0.7"
+      "com.jcraft" % "jzlib" % "1.1.1"
     )
 
 
@@ -90,7 +90,9 @@ These key are defined:
 * `password`: required for login-type `password`, ignored otherwise
 
 * `keyfile`: optionally specifies the location of the user keyfile to use with login-type `keyfile`,
-  if not given the default files `~/.ssh/id_rsa` and `~/.ssh/id_dsa` are tried, ignored for login-type `password`
+  if not given the default files `~/.ssh/id_rsa` and `~/.ssh/id_dsa` are tried, ignored for login-type `password`,
+  if the filename starts with a `+` the file is searched in addition to the default locations,
+  if the filename starts with `classpath:` it is interpreted as the name of a classpath resource holding the private key
 
 * `passphrase`: optionally specifies the passphrase for the keyfile, if not given the keyfile is assumed to be
   unencrypted, ignored for login-type `password`

build.sbt

@@ -1,6 +1,6 @@
 name := "scala-ssh"
 
-version := "0.6.0-SNAPSHOT"
+version := "0.6.0"
 
 organization := "com.decodified"
 
@@ -14,21 +14,17 @@ startYear := Some(2011)
 
 licenses := Seq("Apache 2" -> new URL("http://www.apache.org/licenses/LICENSE-2.0.txt"))
 
-scalaVersion := "2.9.1"
+scalaVersion := "2.9.2"
 
 scalacOptions := Seq("-deprecation", "-encoding", "utf8")
 
 libraryDependencies ++= Seq(
-	"net.schmizz" % "sshj" % "0.7.0",
+	"net.schmizz" % "sshj" % "0.8.0",
 	"org.slf4j" % "slf4j-api" % "1.6.4",
 	"org.bouncycastle" % "bcprov-jdk16" % "1.46" % "provided",
-	"com.jcraft" % "jzlib" % "1.0.7" % "provided",
-	"org.specs2" %% "specs2" % "1.7.1" % "test",
-	"ch.qos.logback" % "logback-classic" % "1.0.0" % "test"
-)
-
-resolvers ++= Seq(
-    "Akka repo" at "http://akka.io/repository/"
+	"com.jcraft" % "jzlib" % "1.1.1" % "provided",
+	"org.specs2" %% "specs2" % "1.10" % "test",
+	"ch.qos.logback" % "logback-classic" % "1.0.3" % "test"
 )
 
 
@@ -40,6 +36,8 @@ credentials += Credentials(Path.userHome / ".ivy2" / ".credentials")
 
 publishMavenStyle := true
 
+crossPaths := false
+
 publishTo <<= version { version =>
   Some {
     "spray nexus" at {

notes/0.6.0.markdown

@@ -0,0 +1,6 @@
+This is a maintenance release.
+Changes since 0.5.0:
+
+- Upgraded to sshj 0.8.0 and jzlib 1.1.1
+- Added option for loading the private key file from the classpath
+- Disabled cross-path publishing

notes/about.markdown

@@ -1 +1,9 @@
-_scala-ssh_ is a Scala library providing remote shell access via SSH.
+[scala-ssh](https://github.com/sirthias/scala-ssh) is a Scala library providing remote shell access via SSH.
+It builds on [sshj](https://github.com/shikhar/sshj) to provide the following features:
+
+* Remote execution of one or more shell commands
+* Access to `stdin`, `stdout`, `stderr` and exitcode of remote shell commands
+* Authentication via password or public key
+* Host key verification via `known_hosts` file or explicit fingerprint
+* Convenient configuration of remote host properties via config file, resource or directly in code
+* Scala-idiomatic API

project/build.properties

@@ -1 +1 @@
-sbt.version=0.11.2
+sbt.version=0.11.3

project/plugins.sbt

@@ -1,6 +1,8 @@
 addSbtPlugin("me.lessis" % "ls-sbt" % "0.1.1")
 
 resolvers ++= Seq(
-  "less is" at "http://repo.lessis.me",
+  Resolver.url("sbt-plugin-releases", new URL(
+    "http://scalasbt.artifactoryonline.com/scalasbt/sbt-plugin-releases/"))(
+      Resolver.ivyStylePatterns),
   "coda" at "http://repo.codahale.com"
 )

src/main/ls/0.6.0.json

@@ -0,0 +1,34 @@
+
+{
+ "organization":"com.decodified",
+ "name":"scala-ssh",
+ "version":"0.6.0",
+ "description":"A Scala library providing remote shell access via SSH",
+ "site":"https://github.com/sirthias/scala-ssh",
+ "tags":["ssh"],
+ "docs":"https://github.com/sirthias/scala-ssh/",
+ "licenses": [{
+   "name": "Apache 2",
+   "url": "http://www.apache.org/licenses/LICENSE-2.0.txt"
+  }],
+ "resolvers": ["http://repo.spray.cc"],
+ "dependencies": [{
+   "organization":"net.schmizz",
+   "name": "sshj",
+   "version": "0.8.0"
+  },{
+   "organization":"org.slf4j",
+   "name": "slf4j-api",
+   "version": "1.6.4"
+  },{
+   "organization":"org.bouncycastle",
+   "name": "bcprov-jdk16",
+   "version": "1.46"
+  },{
+   "organization":"com.jcraft",
+   "name": "jzlib",
+   "version": "1.1.1"
+  }],
+ "scalas": ["2.9.2"],
+ "sbt": false
+}

src/main/scala/com/decodified/scalassh/HostConfig.scala

@@ -100,8 +100,9 @@ abstract class FromStringsHostConfigProvider extends HostConfigProvider {
       PublicKeyLogin(
         user,
         passphrase.map(SimplePasswordProducer),
-        keyfile.map { kf =>
-          if (kf.startsWith("+")) kf.tail :: DefaultKeyLocations else kf :: Nil
+        keyfile.map {
+          case kf if kf.startsWith("+") => kf.tail :: DefaultKeyLocations
+          case kf => kf :: Nil
         }.getOrElse(DefaultKeyLocations)
       )
     }

src/main/scala/com/decodified/scalassh/SshClient.scala

@@ -18,8 +18,10 @@ package com.decodified.scalassh
 
 import java.util.concurrent.TimeUnit
 import net.schmizz.sshj.SSHClient
-import java.io.File
 import org.slf4j.LoggerFactory
+import net.schmizz.sshj.userauth.keyprovider.KeyProvider
+import io.Source
+import java.io.{InputStream, FileNotFoundException, FileInputStream, File}
 
 class SshClient(val config: HostConfig) {
   lazy val log = LoggerFactory.getLogger(getClass)
@@ -63,9 +65,26 @@ class SshClient(val config: HostConfig) {
   }
 
   protected def authenticate(client: SSHClient) = {
-    def existing(filenames: List[String]) = filenames.filter(new File(_).exists) match {
-      case Nil => sys.error("None of the configured keyfiles exists: " + filenames.mkString(", "))
-      case files => files
+    def keyProviders(locations: List[String], passProducer: PasswordProducer): List[KeyProvider] = {
+      def inputStream(location: String): Option[InputStream] = {
+        if (location.startsWith("classpath:")) {
+          val resource = location.substring("classpath:".length)
+          Option(getClass.getClassLoader.getResourceAsStream(resource))
+            .orElse(throw new RuntimeException("Classpath resource '" + resource + "' containing private key could not be found"))
+        } else {
+          try Some(new FileInputStream(location))
+          catch { case _: FileNotFoundException => None }
+        }
+      }
+      locations.flatMap { location =>
+        inputStream(location).map { stream =>
+          val privateKey = Source.fromInputStream(stream).getLines().mkString("\n")
+          client.loadKeys(privateKey, null, passProducer)
+        }
+      } match {
+        case Nil => sys.error("None of the configured keyfiles exists: " + locations.mkString(", "))
+        case x => x
+      }
     }
 
     require(client.isConnected && !client.isAuthenticated)
@@ -76,14 +95,9 @@ class SshClient(val config: HostConfig) {
           client.authPassword(user, passProducer)
           client
         }
-      case PublicKeyLogin(user, None, keyfileLocations) =>
+      case PublicKeyLogin(user, passProducer, keyfileLocations) =>
         protect("Could not authenticate (with keyfile) to") {
-          client.authPublickey(user, existing(keyfileLocations): _*)
-          client
-        }
-      case PublicKeyLogin(user, Some(passProducer), keyfileLocations) =>
-        protect("Could not authenticate (with encrypted keyfile) to") {
-          client.authPublickey(user, existing(keyfileLocations).map(client.loadKeys(_, passProducer)): _*)
+          client.authPublickey(user, keyProviders(keyfileLocations, passProducer.getOrElse(null)): _*)
           client
         }
     }