sshkey 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcab21406c740089ec26317a5499a2b757f03e7c
-  data.tar.gz: 212a9a19f541aea1aeaf577cb2e938f1eae9c4fd
+  metadata.gz: 5d776647717b5c6c632f8b567e5f24ce5453e9dc
+  data.tar.gz: 4a6a78036abf72069b7facea22e76210a8285e21
 SHA512:
-  metadata.gz: ba8bf9fcef2981609256d9765e855e49771992caa20d1b87ff52a20d627a8d2571318486687b2cf51c52d6f8a510281ad351069e94cb092e44a520f069af5ab6
-  data.tar.gz: f1f47cb1a2861aa2a8a741d8b511529c62701e943658c1dead0f6621ad639158874b4c13fc6a00f9bc6375e00ea46aab32612d5337c8e55002503f0aaac6dab9
+  metadata.gz: 618febbb798fe552b6304616112826bfc62a190217c4dda38821b6440986958f0f0f1d4d834d48698d9c58ccd285db2361d97175d38403df17f8059e8ccb26c6
+  data.tar.gz: 6b17d1441004cd505882b2d17099be24853a8a360979820d93ae324b309fa2658620f145cf8b75ed179813de10b6ddc3987ae3d8fb222202a5a869135c4bf682

data/.travis.yml

@@ -1,41 +1,20 @@
+language: ruby
+
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - 2.0.0
-  - ree
+  - 2.0
+  - 2.1
+  - 2.2
   - ruby-head
-  - jruby-18mode
-  - jruby-19mode
-  - jruby-20mode
+  - ree
+  - jruby
   - jruby-head
-  - rbx-2.1.1
 
 matrix:
   allow_failures:
     - rvm: ruby-head
-  include:
-    - rvm: jruby-18mode
-      jdk: openjdk6
-    - rvm: jruby-18mode
-      jdk: openjdk7
-    - rvm: jruby-18mode
-      jdk: oraclejdk7
-    - rvm: jruby-19mode
-      jdk: openjdk6
-    - rvm: jruby-19mode
-      jdk: openjdk7
-    - rvm: jruby-19mode
-      jdk: oraclejdk7
-    - rvm: jruby-20mode
-      jdk: openjdk6
-    - rvm: jruby-20mode
-      jdk: openjdk7
-    - rvm: jruby-20mode
-      jdk: oraclejdk7
     - rvm: jruby-head
-      jdk: openjdk6
-    - rvm: jruby-head
-      jdk: openjdk7
-    - rvm: jruby-head
-      jdk: oraclejdk7
+
+sudo: false

data/Gemfile

@@ -1,6 +1,7 @@
 source "https://rubygems.org"
 
 gem "jruby-openssl", ">= 0.8.2", :platforms => :jruby
-gem "rubysl", "~> 2.0.14", :platforms => :rbx
+gem "rubysl", "~> 2.0.15", :platforms => :rbx
+gem "rubysl-test-unit", "~> 2.0.3", :platforms => :rbx
 
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2013 James Miller
+Copyright (c) 2011-2014 James Miller
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -4,9 +4,9 @@ Generate private and public SSH keys (RSA and DSA supported) using pure Ruby.
 
 	gem install sshkey
 
-Tested on the following Rubies: MRI 1.8.7, 1.9.2, 1.9.3, 2.0.0, REE, JRuby (1.7.2 and newer), Rubinius (2.1.1 and newer). Ruby must be compiled with OpenSSL support.
+Tested on the following Rubies: MRI 1.8.7, 1.9.2, 1.9.3, 2.0.0, 2.1.x, 2.2.x, REE. Ruby must be compiled with OpenSSL support.
 
-[![Build Status](https://secure.travis-ci.org/bensie/sshkey.png)](http://travis-ci.org/bensie/sshkey)
+[![Build Status](https://secure.travis-ci.org/bensie/sshkey.svg?branch=master)](http://travis-ci.org/bensie/sshkey)
 
 ## Usage
 
@@ -18,7 +18,12 @@ You can also (optionally) supply a `comment` or `passphrase`.
 ```ruby
 k = SSHKey.generate
 
-k = SSHKey.generate(:type => "DSA", :bits => 1024, :comment => "foo@bar.com", :passphrase => "foobar")
+k = SSHKey.generate(
+  type:       "DSA",
+  bits:       1024,
+  comment:    "foo@bar.com",
+  passphrase: "foobar"
+)
 ```
 
 ### Use your existing key
@@ -26,7 +31,7 @@ k = SSHKey.generate(:type => "DSA", :bits => 1024, :comment => "foo@bar.com", :p
 Return an SSHKey object from an existing RSA or DSA private key (provided as a string).
 
 ```ruby
-k = SSHKey.new(File.read("~/.ssh/id_rsa"), :comment => "foo@bar.com")
+k = SSHKey.new(File.read("~/.ssh/id_rsa"), comment: "foo@bar.com")
 ```
 
 ### The SSHKey object
@@ -77,8 +82,10 @@ k.comment = "me@me.com"
 
 k.ssh_public_key
 # => "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC9HuXvYJPtQE/o/7TYi63yAopsrJ6TP+lDGdyQ+nVVp+5ojAIy9h8/h99UlNxjkiFT2YhI3Fl/pgNDRO4PVo6tlgb3CwiAZjSdeE5RnF79Dkj5XsM4j+FLMoXtbRw0K9ok9RKjz6ygIs1JDmaOdXexFnq4nAYU3fSLUa6WoccqTHe8bFuJoAv1gbnx09Js8YcVMD96mpTJ3V/MK5YfIv10dbtrDhGug3IS1V2J+0BB9orbQja554N+4S0I9rFBgVCpvPmQqddDHd/AdGkLv/zjEfGytjnvp68bEfDinkQkPfuxw01yd5MbcvLv39VVICWtKbqW263HT5LvSxwKorR7 me@me.com"
-```
 
+k.ssh2_public_key
+# => "---- BEGIN SSH2 PUBLIC KEY ----\nComment: me@me.com\nAAAAB3NzaC1yc2EAAAADAQABAAABAQC9HuXvYJPtQE/o/7TYi63yAopsrJ6TP+lDGdyQ+n\nVVp+5ojAIy9h8/h99UlNxjkiFT2YhI3Fl/pgNDRO4PVo6tlgb3CwiAZjSdeE5RnF79Dkj5\nXsM4j+FLMoXtbRw0K9ok9RKjz6ygIs1JDmaOdXexFnq4nAYU3fSLUa6WoccqTHe8bFuJoA\nv1gbnx09Js8YcVMD96mpTJ3V/MK5YfIv10dbtrDhGug3IS1V2J+0BB9orbQja554N+4S0I\n9rFBgVCpvPmQqddDHd/AdGkLv/zjEfGytjnvp68bEfDinkQkPfuxw01yd5MbcvLv39VVIC\nWtKbqW263HT5LvSxwKorR7\n---- END SSH2 PUBLIC KEY ----"
+```
 #### Bit length
 
 Determine the strength of the key in bits as an integer.
@@ -126,7 +133,7 @@ k.ssh_public_key
 
 #### Randomart
 
-Generate [OpenSSH compatible](http://www.opensource.apple.com/source/OpenSSH/OpenSSH-175/openssh/key.c) ASCII art fingerprints
+Generate [OpenSSH compatible](http://www.opensource.apple.com/source/OpenSSH/OpenSSH-175/openssh/key.c) ASCII art fingerprints.
 
 ```ruby
 puts k.randomart
@@ -184,6 +191,15 @@ SSHKey.sha1_fingerprint "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC9HuXvYJPtQE/o/7T
 # => "e5:c2:43:9e:e4:0c:0c:47:82:7a:3b:e9:61:13:bd:9c:43:eb:4c:b7"
 ```
 
+#### Convert to SSH2 Public Key
+
+Convert an existing SSH Public Key into an SSH2 Public key.  Returns `SSHKey::PublicKeyError` if a valid key cannot be generated.
+
+```ruby
+SSHKey.ssh_public_key_to_ssh2_public_key "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC9HuXvYJPtQE/o/7TYi63yAopsrJ6TP+lDGdyQ+nVVp+5ojAIy9h8/h99UlNxjkiFT2YhI3Fl/pgNDRO4PVo6tlgb3CwiAZjSdeE5RnF79Dkj5XsM4j+FLMoXtbRw0K9ok9RKjz6ygIs1JDmaOdXexFnq4nAYU3fSLUa6WoccqTHe8bFuJoAv1gbnx09Js8YcVMD96mpTJ3V/MK5YfIv10dbtrDhGug3IS1V2J+0BB9orbQja554N+4S0I9rFBgVCpvPmQqddDHd/AdGkLv/zjEfGytjnvp68bEfDinkQkPfuxw01yd5MbcvLv39VVICWtKbqW263HT5LvSxwKorR7 me@me.com"
+# => "---- BEGIN SSH2 PUBLIC KEY ----\nComment: me@me.com\nAAAAB3NzaC1yc2EAAAADAQABAAABAQC9HuXvYJPtQE/o/7TYi63yAopsrJ6TP+lDGdyQ+n\nVVp+5ojAIy9h8/h99UlNxjkiFT2YhI3Fl/pgNDRO4PVo6tlgb3CwiAZjSdeE5RnF79Dkj5\nXsM4j+FLMoXtbRw0K9ok9RKjz6ygIs1JDmaOdXexFnq4nAYU3fSLUa6WoccqTHe8bFuJoA\nv1gbnx09Js8YcVMD96mpTJ3V/MK5YfIv10dbtrDhGug3IS1V2J+0BB9orbQja554N+4S0I\n9rFBgVCpvPmQqddDHd/AdGkLv/zjEfGytjnvp68bEfDinkQkPfuxw01yd5MbcvLv39VVIC\nWtKbqW263HT5LvSxwKorR7\n---- END SSH2 PUBLIC KEY ----"
+```
+
 ## Copyright
 
-Copyright (c) 2011-2013 James Miller
+Copyright (c) 2011-2015 James Miller

data/lib/sshkey.rb

@@ -9,6 +9,7 @@ require 'sshkey/exception'
 class SSHKey
   SSH_TYPES      = {"rsa" => "ssh-rsa", "dsa" => "ssh-dss"}
   SSH_CONVERSION = {"rsa" => ["e", "n"], "dsa" => ["p", "q", "g", "pub_key"]}
+  SSH2_LINE_LENGTH = 70 # +1 (for line wrap '/' character) must be <= 72
 
   class << self
     # Generate a new keypair and return an SSHKey object
@@ -88,6 +89,29 @@ class SSHKey
       end
     end
 
+    # Convert an existing SSH public key to SSH2 (RFC4716) public key
+    #
+    # ==== Parameters
+    # * ssh_public_key<~String> - "ssh-rsa AAAAB3NzaC1yc2EA...."
+    # * headers<~Hash> - The Key will be used as the header-tag and the value as the header-value
+    #
+    def ssh_public_key_to_ssh2_public_key(ssh_public_key, headers = nil)
+      raise PublicKeyError, "invalid ssh public key" unless SSHKey.valid_ssh_public_key?(ssh_public_key)
+
+      source_format, source_key = parse_ssh_public_key(ssh_public_key)
+
+      # Add a 'Comment' Header Field unless others are explicitly passed in
+      if source_comment = ssh_public_key.split(source_key)[1]
+        headers = {'Comment' => source_comment.strip} if headers.nil? && !source_comment.empty?
+      end
+      header_fields = build_ssh2_headers(headers)
+
+      ssh2_key = "---- BEGIN SSH2 PUBLIC KEY ----\n"
+      ssh2_key << header_fields unless header_fields.nil?
+      ssh2_key << source_key.scan(/.{1,#{SSH2_LINE_LENGTH}}/).join("\n")
+      ssh2_key << "\n---- END SSH2 PUBLIC KEY ----"
+    end
+
     private
 
     def unpacked_byte_array(ssh_type, encoded_key)
@@ -121,12 +145,28 @@ class SSHKey
     end
 
     def parse_ssh_public_key(public_key)
+      raise PublicKeyError, "newlines are not permitted between key data" if public_key =~ /\n(?!$)/
+
       parsed = public_key.split(" ")
       parsed.each_with_index do |el, index|
         return parsed[index..(index+1)] if SSH_TYPES.invert[el]
       end
       raise PublicKeyError, "cannot determine key type"
     end
+
+    def build_ssh2_headers(headers = {})
+      return nil if headers.nil? || headers.empty?
+
+      headers.keys.sort.collect do |header_tag|
+        # header-tag must be us-ascii & <= 64 bytes and header-data must be UTF-8 & <= 1024 bytes
+        raise PublicKeyError, "SSH2 header-tag '#{header_tag}' must be US-ASCII" unless header_tag.each_byte.all? {|b| b < 128 }
+        raise PublicKeyError, "SSH2 header-tag '#{header_tag}' must be <= 64 bytes" unless header_tag.size <= 64
+        raise PublicKeyError, "SSH2 header-value for '#{header_tag}' must be <= 1024 bytes" unless headers[header_tag].size <= 1024
+
+        header_field = "#{header_tag}: #{headers[header_tag]}"
+        header_field.scan(/.{1,#{SSH2_LINE_LENGTH}}/).join("\\\n")
+      end.join("\n") << "\n"
+    end
   end
 
   attr_reader :key_object, :type
@@ -185,6 +225,19 @@ class SSHKey
     [directives.join(",").strip, SSH_TYPES[type], Base64.encode64(ssh_public_key_conversion).gsub("\n", ""), comment].join(" ").strip
   end
 
+  # SSH2 public key (RFC4716)
+  #
+  # ==== Parameters
+  # * headers<~Hash> - Keys will be used as header-tags and values as header-values.
+  #
+  # ==== Examples
+  # {'Comment' => '2048-bit RSA created by user@example'}
+  # {'x-private-use-tag' => 'Private Use Value'}
+  #
+  def ssh2_public_key(headers = nil)
+    self.class.ssh_public_key_to_ssh2_public_key(ssh_public_key, headers)
+  end
+
   # Fingerprints
   #
   # MD5 fingerprint for the given SSH public key

data/lib/sshkey/version.rb

@@ -1,3 +1,3 @@
 class SSHKey
-  VERSION = "1.6.1"
+  VERSION = "1.7.0"
 end

data/sshkey.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency("rake")
+  s.add_development_dependency("test-unit")
 end

data/test/sshkey_test.rb

@@ -127,6 +127,46 @@ EOF
 |                 |
 |                 |
 +-----------------+
+EOF
+
+  SSH2_PUBLIC_KEY1 = <<-EOF.rstrip
+---- BEGIN SSH2 PUBLIC KEY ----
+Comment: me@example.com
+AAAAB3NzaC1yc2EAAAABIwAAAQEArfTA/lKVR84IMc9ZzXOCHr8DVtR8hzWuEVHF6KElav
+RHlk14g0SZu3m908Ejm/XF3EfNHjX9wN+62IMA0QBxkBMFCuLF+U/oeUs0NoDdAEKxjj4n
+6lq6Ss8aLct+anMy7D1jwvOLbcwV54w1d5JDdlZVdZ6AvHm9otwJq6rNpDgdmXY4HgC2nM
+9csFpuy0cDpL6fdJx9lcNL2RnkRC4+RMsIB+PxDw0j3vDi04dYLBXMGYjyeGH+mIFpL3PT
+PXGXwL2XDYXZ2H4SQX6bOoKmazTXq6QXuEB665njh1GxXldoIMcSshoJL0hrk3WrTOG22N
+2CQA+IfHgrXJ+A+QUzKQ==
+---- END SSH2 PUBLIC KEY ----
+EOF
+
+  SSH2_PUBLIC_KEY2 = <<-EOF.rstrip
+---- BEGIN SSH2 PUBLIC KEY ----
+AAAAB3NzaC1yc2EAAAABIwAAAQEAxl6TpN7uFiY/JZ8qDnD7UrxDP+ABeh2PVg8Du1LEgX
+Nk0+YWCeP5S6oHklqaWeDlbmAs1oHsBwCMAVpMa5tgONOLvz4JgwgkiqQEbKR8ofWJ+LAD
+UElvqRVGmGiNEMLI6GJWeneL4sjmbb8d6U+M53c6iWG0si9XE5m7teBQSsCl0Tk3qMIkQG
+w5zpJeCXjZ8KpJhIJRYgexFkGgPlYRV+UYIhxpUW90t0Ra5i6JOFYwq98k5S/6SJIZQ/A9
+F4JNzwLw3eVxZj0yVHWxkGz1+TyELNY1kOyMxnZaqSfGzSQJTrnIXpdweVHuYh1LtOgedR
+QhCyiELeSMGwio1vRPKw==
+---- END SSH2 PUBLIC KEY ----
+EOF
+
+  SSH2_PUBLIC_KEY3 = <<-EOF.rstrip
+---- BEGIN SSH2 PUBLIC KEY ----
+Comment: 1024-bit DSA with provided comment
+x-private-use-header: some value that is long enough to go to wrap aro\\
+und to a new line.
+AAAAB3NzaC1kc3MAAACBALyVy5dwVwgL3CxXzsvo8DBh58qArQLBNIPW/f9pptmy7jD5QX
+zOw+12w0/z4lZ86ncoVutRMf44OABcX9ovhRl+luxB7jjpkVXy/p2ZaqPbeyTQUtdTmXa2
+y4n053Jd61VeMG+iLP7+viT+Ib96y9aVUYQfCrl5heBDUZ9cAFjdAAAAFQDFXnO7JJpFKw
+keoor4GWGHtz0D2QAAAIEAqel0RUBO0MY5b3DZ69J/mRzUifN1O6twk4er2ph0JpryuUwZ
+ohLpcVZwqoGWmPQy/ZHmV1b3RtT9GWUa+HUqKdMhFVOx/iq1khVfLi83whjMMvXj3ecqd0
+yzGxGHnSsjVKefa2ywCLHrh4nlUVIaXI5gQpgMyVbMcromDe1WZzoAAACBAIwTRPAEcroq
+OzaebiVspFcmsXxDQ4wXQZQdho1ExW6FKS8s7/6pItmZYXTvJDwLXgq2/iK1fRRcKk2PJE
+aSuJR7WeNGsJKfWmQ2UbOhqA3wWLDazIZtcMKjFzD0hM4E8qgjHjMvKDE6WgT6SFP+tqx3
+nnh7pJWwsbGjSMQexpyR
+---- END SSH2 PUBLIC KEY ----
 EOF
 
   def setup
@@ -202,6 +242,20 @@ EOF
     assert_equal expected4, @key_without_comment.ssh_public_key
   end
 
+  def test_ssh2_public_key_output
+    expected1 = SSH2_PUBLIC_KEY1
+    expected2 = SSH2_PUBLIC_KEY2
+    expected3 = SSH2_PUBLIC_KEY3
+    public_key1 = "ssh-rsa #{SSH_PUBLIC_KEY1} me@example.com"
+    public_key2 = "ssh-rsa #{SSH_PUBLIC_KEY2}"
+    public_key3 = "ssh-rsa #{SSH_PUBLIC_KEY3} 1024-bit DSA with provided comment"
+
+    assert_equal expected1, @key1.ssh2_public_key
+    assert_equal expected2, @key2.ssh2_public_key({})
+    assert_equal expected3, @key3.ssh2_public_key({'Comment' => '1024-bit DSA with provided comment', 
+      'x-private-use-header' => 'some value that is long enough to go to wrap around to a new line.'})
+  end
+
   def test_public_key_directives
     assert_equal [], SSHKey.generate.directives
 
@@ -253,6 +307,19 @@ EOF
     assert !SSHKey.valid_ssh_public_key?(invalid5)
   end
 
+  def test_ssh_public_key_validation_with_newlines
+    expected1 = "ssh-rsa #{SSH_PUBLIC_KEY1}\n"
+    invalid1  = "ssh-rsa #{SSH_PUBLIC_KEY1}\nme@example.com"
+    invalid2  = "ssh-rsa #{SSH_PUBLIC_KEY1}\n me@example.com"
+    invalid3  = "ssh-rsa #{SSH_PUBLIC_KEY1} \nme@example.com"
+
+    assert SSHKey.valid_ssh_public_key?(expected1)
+
+    assert !SSHKey.valid_ssh_public_key?(invalid1)
+    assert !SSHKey.valid_ssh_public_key?(invalid2)
+    assert !SSHKey.valid_ssh_public_key?(invalid3)
+  end
+
   def test_ssh_public_key_bits
     expected1 = "ssh-rsa #{SSH_PUBLIC_KEY1} me@example.com"
     expected2 = "ssh-rsa #{SSH_PUBLIC_KEY2} me@example.com"
@@ -276,6 +343,17 @@ EOF
     assert_equal( "byte array too short",      exception2.message )
     assert_equal( "cannot determine key type", exception3.message )
   end
+  
+  def test_ssh2_public_key_bits
+    public_key1 = "ssh-rsa #{SSH_PUBLIC_KEY1} me@example.com"
+    public_key2 = "ssh-rsa #{SSH_PUBLIC_KEY2}"
+    public_key3 = "ssh-dss #{SSH_PUBLIC_KEY3} 1024-bit DSA with provided comment"
+
+    assert_equal(SSH2_PUBLIC_KEY1, SSHKey.ssh_public_key_to_ssh2_public_key(public_key1))
+    assert_equal(SSH2_PUBLIC_KEY2, SSHKey.ssh_public_key_to_ssh2_public_key(public_key2))
+    assert_equal(SSH2_PUBLIC_KEY2, SSHKey.ssh_public_key_to_ssh2_public_key(public_key2, {}))
+    assert_equal(SSH2_PUBLIC_KEY3, SSHKey.ssh_public_key_to_ssh2_public_key(public_key3, {'Comment' => '1024-bit DSA with provided comment', 'x-private-use-header' => 'some value that is long enough to go to wrap around to a new line.'}))
+end
 
   def test_exponent
     assert_equal 35, @key1.key_object.e.to_i

metadata

@@ -1,27 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: sshkey
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - James Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Generate private/public SSH keypairs using pure Ruby
@@ -31,8 +45,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -52,17 +66,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: sshkey
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: SSH private/public key generator in Ruby