sshkey 1.2.1 → 1.2.2

data/README.md

@@ -1,7 +1,7 @@
 sshkey
 ======
 
-Generate private/public SSH keys using Ruby without the `ssh-keygen` system command.
+Generate private and public SSH keys (RSA and DSA supported) using Ruby without the `ssh-keygen` system command.
 
 	gem install sshkey
 
@@ -10,19 +10,16 @@ Tested on the following Rubies: MRI 1.8.7 and 1.9.2, Rubinius, JRuby.  Ruby must
 Usage
 -----
 
-Generate an SSH RSA Keypair with foo@bar.com as the comment - providing a comment is optional
+When generating a new keypair the default key type is 2048-bit RSA, but you can supply the `type` (RSA or DSA) and `bits` in the options.
+You can also (optionally) supply a comment:
 
 ``` ruby
-k = SSHKey.generate(:comment => "foo@bar.com")
-```
-
-Generate an SSH DSA Keypair with foo@bar.com as the comment - providing a comment is optional
+k = SSHKey.generate
 
-``` ruby
-k = SSHKey.generate(:type => "dsa", :comment => "foo@bar.com")
+k = SSHKey.generate(:type => "DSA", :bits => 1024, :comment => "foo@bar.com")
 ```
 
-Return an SSHKey object from an existing RSA Private Key (provided as a string)
+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")
@@ -32,7 +29,8 @@ Both of these will return an SSHKey object with the following methods:
 
 ``` ruby
 # Returns an OpenSSL::PKey::RSA or OpenSSL::PKey::DSA key object
-# See http://www.ruby-doc.org/stdlib/libdoc/openssl/rdoc/classes/OpenSSL/PKey/RSA.html
+# http://www.ruby-doc.org/stdlib/libdoc/openssl/rdoc/classes/OpenSSL/PKey/RSA.html
+# http://www.ruby-doc.org/stdlib/libdoc/openssl/rdoc/classes/OpenSSL/PKey/DSA.html
 k.key_object
 # => -----BEGIN RSA PRIVATE KEY-----\nMIIEowI...
 

data/lib/sshkey.rb

@@ -10,9 +10,10 @@ class SSHKey
 
   def self.generate(options = {})
     type = options[:type] || "rsa"
+    bits = options[:bits] || 2048
     case type.downcase
-    when "rsa" then SSHKey.new(OpenSSL::PKey::RSA.generate(2048).to_pem, options)
-    when "dsa" then SSHKey.new(OpenSSL::PKey::DSA.generate(2048).to_pem, options)
+    when "rsa" then SSHKey.new(OpenSSL::PKey::RSA.generate(bits).to_pem, options)
+    when "dsa" then SSHKey.new(OpenSSL::PKey::DSA.generate(bits).to_pem, options)
     else
       raise "Unknown key type #{type}"
     end

data/lib/sshkey/version.rb

@@ -1,3 +1,3 @@
 class SSHKey
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

metadata

@@ -2,7 +2,7 @@
 name: sshkey
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors: 
 - James Miller
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-02 00:00:00 -07:00
+date: 2011-06-04 00:00:00 -07:00
 default_executable: 
 dependencies: []