sshkey 1.0.0 → 1.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 James Miller
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,44 @@
+= sshkey
+
+Generate private/public SSH keys using Ruby without the `ssh-keygen` system command.
+
+  gem install sshkey
+
+Currently requires Ruby 1.9.
+  
+== Usage
+
+Generate an SSH Keypair with foo@bar.com as the comment - providing a comment is optional
+
+  k = SSHKey.generate(:comment => "foo@bar.com")
+  
+Return an SSHKey object from an existing RSA Private Key (provided as a string)
+
+  k = SSHKey.new(File.read("~/.ssh/id_rsa"), :comment => "foo@bar.com")
+
+Both of these will return an SSHKey object with the following methods:
+
+  # Returns an OpenSSL::PKey::RSA key object
+  # See http://www.ruby-doc.org/stdlib/libdoc/openssl/rdoc/classes/OpenSSL/PKey/RSA.html
+  k.key_object
+  # => -----BEGIN RSA PRIVATE KEY-----\nMIIEowI
+  
+  # Returns the RSA Private Key as a string
+  k.rsa_private_key
+  # => "-----BEGIN RSA PRIVATE KEY-----\nMIIEowI"
+  
+  # Returns the RSA Public Key as a string
+  k.rsa_public_key
+  # => "-----BEGIN RSA PUBLIC KEY-----\nMIIBCg"
+  
+  # Returns the SSH Public Key as a string
+  k.ssh_public_key
+  # => "ssh-rsa AAAAB3NzaC1yc2EA...."
+  
+  # Returns the comment as a string
+  k.comment
+  # => "foo@bar.com"
+
+== Copyright
+
+Copyright (c) 2011 James Miller

data/lib/sshkey.rb

@@ -3,18 +3,18 @@ require 'base64'
 
 class SSHKey
 
-  def self.generate(comment)
-    SSHKey.new(OpenSSL::PKey::RSA.generate(2048), comment)
+  def self.generate(options = {})
+    SSHKey.new(OpenSSL::PKey::RSA.generate(2048).to_pem, options)
   end
 
   attr_reader :key_object, :comment, :rsa_private_key, :rsa_public_key, :ssh_public_key
 
-  def initialize(key_object, comment)
-    @key_object = key_object
-    @comment = comment
-    @rsa_private_key = key_object.to_pem
-    @rsa_public_key = key_object.public_key.to_pem
-    @ssh_public_key = ["ssh-rsa", Base64.strict_encode64(ssh_public_key_conversion), @comment].join(" ")
+  def initialize(private_key, options = {})
+    @key_object = OpenSSL::PKey::RSA.new(private_key)
+    @comment = options[:comment] || ""
+    @rsa_private_key = @key_object.to_pem
+    @rsa_public_key = @key_object.public_key.to_pem
+    @ssh_public_key = ["ssh-rsa", Base64.strict_encode64(ssh_public_key_conversion), @comment].join(" ").strip
   end
 
   private

data/lib/sshkey/version.rb

@@ -1,3 +1,3 @@
 class SSHKey
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/sshkey_test.rb

@@ -67,14 +67,15 @@ EOF
   FINGERPRINT = "2a:89:84:c9:29:05:d1:f8:49:79:1c:ba:73:99:eb:af"
 
   def setup
-    @key1 = SSHKey.new(OpenSSL::PKey::RSA.new(SSH_PRIVATE_KEY1), "me@example.com")
-    @key2 = SSHKey.new(OpenSSL::PKey::RSA.new(SSH_PRIVATE_KEY2), "me@example.com")
+    @key1 = SSHKey.new(SSH_PRIVATE_KEY1, :comment => "me@example.com")
+    @key2 = SSHKey.new(SSH_PRIVATE_KEY2, :comment => "me@example.com")
+    @key_without_comment = SSHKey.new(SSH_PRIVATE_KEY1)
   end
 
   def test_private_key1
     assert_equal SSH_PRIVATE_KEY1, @key1.rsa_private_key
   end
-  
+
   def test_private_key2
     assert_equal SSH_PRIVATE_KEY2, @key2.rsa_private_key
   end
@@ -82,7 +83,7 @@ EOF
   def test_ssh_public_key_decoded1
     assert_equal Base64.strict_decode64(SSH_PUBLIC_KEY1), @key1.send(:ssh_public_key_conversion)
   end
-  
+
   def test_ssh_public_key_decoded2
     assert_equal Base64.strict_decode64(SSH_PUBLIC_KEY2), @key2.send(:ssh_public_key_conversion)
   end
@@ -90,16 +91,18 @@ EOF
   def test_ssh_public_key_encoded1
     assert_equal SSH_PUBLIC_KEY1, Base64.strict_encode64(@key1.send(:ssh_public_key_conversion))
   end
-  
+
   def test_ssh_public_key_encoded2
     assert_equal SSH_PUBLIC_KEY2, Base64.strict_encode64(@key2.send(:ssh_public_key_conversion))
   end
-  
+
   def test_ssh_public_key_output
-    expected1 = "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArfTA/lKVR84IMc9ZzXOCHr8DVtR8hzWuEVHF6KElavRHlk14g0SZu3m908Ejm/XF3EfNHjX9wN+62IMA0QBxkBMFCuLF+U/oeUs0NoDdAEKxjj4n6lq6Ss8aLct+anMy7D1jwvOLbcwV54w1d5JDdlZVdZ6AvHm9otwJq6rNpDgdmXY4HgC2nM9csFpuy0cDpL6fdJx9lcNL2RnkRC4+RMsIB+PxDw0j3vDi04dYLBXMGYjyeGH+mIFpL3PTPXGXwL2XDYXZ2H4SQX6bOoKmazTXq6QXuEB665njh1GxXldoIMcSshoJL0hrk3WrTOG22N2CQA+IfHgrXJ+A+QUzKQ== me@example.com"
-    expected2 = "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAxl6TpN7uFiY/JZ8qDnD7UrxDP+ABeh2PVg8Du1LEgXNk0+YWCeP5S6oHklqaWeDlbmAs1oHsBwCMAVpMa5tgONOLvz4JgwgkiqQEbKR8ofWJ+LADUElvqRVGmGiNEMLI6GJWeneL4sjmbb8d6U+M53c6iWG0si9XE5m7teBQSsCl0Tk3qMIkQGw5zpJeCXjZ8KpJhIJRYgexFkGgPlYRV+UYIhxpUW90t0Ra5i6JOFYwq98k5S/6SJIZQ/A9F4JNzwLw3eVxZj0yVHWxkGz1+TyELNY1kOyMxnZaqSfGzSQJTrnIXpdweVHuYh1LtOgedRQhCyiELeSMGwio1vRPKw== me@example.com"
+    expected1 = "ssh-rsa #{SSH_PUBLIC_KEY1} me@example.com"
+    expected2 = "ssh-rsa #{SSH_PUBLIC_KEY2} me@example.com"
+    expected3 = "ssh-rsa #{SSH_PUBLIC_KEY1}"
     assert_equal expected1, @key1.ssh_public_key
     assert_equal expected2, @key2.ssh_public_key
+    assert_equal expected3, @key_without_comment.ssh_public_key
   end
 
   def test_exponent
@@ -115,7 +118,9 @@ EOF
   def test_to_byte_array
     ba1 = @key1.send(:to_byte_array, 35)
     ba2 = @key1.send(:to_byte_array, 65537)
+    ba3 = [0, 1, 255, 256, -1, -128, -256].map{|i| @key1.send(:to_byte_array, i)}
     assert_equal [35], ba1
     assert_equal [1, 0, 1], ba2
+    assert_equal [[0], [1], [0, 255], [1, 0], [255], [128], [255, 0]], ba3
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: sshkey
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - James Miller
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-12 00:00:00 -08:00
+date: 2011-03-12 23:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -26,6 +26,8 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- LICENSE
+- README.rdoc
 - Rakefile
 - lib/sshkey.rb
 - lib/sshkey/version.rb
@@ -55,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: sshkey
-rubygems_version: 1.5.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: SSH private/public key generator in Ruby