sshkg 0.1.0 → 0.2.0

data/README.rdoc

@@ -0,0 +1,41 @@
+= SSH Key Generator
+
+A little wrapper over secure shell private/public key generator utility
+
+
+== Installing
+    
+The latest stable version is published in gemcutter/rubygems.
+
+  gem install sshkg
+  
+
+== How to use
+
+  Help is your friend RTFM
+  
+  sshkg --help
+
+
+== License
+
+Copyright (c) 2010-2030 Javier Juarez Martinez
+
+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/bin/sshkg

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
 
-$:.unshift( File.join( File.dirname( __FILE__ ), "..", "lib" ) )
-require 'sshkg'
+$:.unshift( File.join( File.dirname( __FILE__ ), %w[.. lib] ) )
+
+require 'loader'
 
 ##
 # ::Main::
-if( Choice.choices[:config] && Choice.choices[:user] )
+ConfigContext.user = Choice.choices[:user]
 
-  SSHKeyGenerator::Config.load( Choice.choices[:user], Choice.choices[:config] )
-  SSHKeyGenerator::generate( )    
-end
+ConfigContext.load( File.expand_path( Choice.choices[:config] ) )
+SSHKeyGenerator.generate( ConfigContext.all )    

data/lib/loader.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+
+$:.unshift( File.join( File.dirname( __FILE__ ), 'sshkg' ) )
+
+begin
+  Dir.glob( File.join( File.dirname( __FILE__ ), "**", "*.rb" ) ).each do |library| 
+
+    require library    
+  end  
+rescue LoadError => le
+  MiniLogger.error( le.message )
+end

data/lib/sshkg/generator.rb

@@ -1,10 +1,24 @@
+require 'rubygems'
+require 'config_context'
+
+
 module SSHKeyGenerator
   extend self
   
-  SSH_KEYGEN = "/usr/bin/ssh-keygen"
+  DEFAULT_TYPE    = :dsa
+  DEFAULT_BITS    = 1024
+  DEFAULT_COMMENT = "example.com"
+  
+  def generate( atts = { } )
 
-  def self.generate( options=Config.to_h )
+    raise ArgumentError.new( "There is an argument problem" ) if atts.empty?
+    raise ArgumentError.new( "You need an user id" ) unless atts[:user]
     
-    `#{SSH_KEYGEN} -t #{options[:type]} -f #{options[:file]} -C "#{options[:comment]}" 2>/dev/null </dev/null` if options
+    user    = atts[:user]
+    type    = atts[:type] ? atts[:type] : DEFAULT_TYPE    
+    bits    = atts[:bits] ? atts[:bits] : DEFAULT_BITS
+    comment = atts[:comment] ? atts[:comment] : DEFAULT_COMMENT
+
+    %x{ssh-keygen -q -b #{bits} -t #{type} -f id_#{type}.#{user} -C #{user}@#{comment} 2>/dev/null </dev/null}
   end
 end

data/lib/{util/opt_parser.rb → sshkg/options_parser.rb}

@@ -1,18 +1,20 @@
+require 'rubygems'
 require 'choice'
 
+
 Choice.options do
   header ''
   header '  Specific options:'
 
-  option :config do
+  option :config, :required=>true do
     short '-c'
-    long '--config=DOMAIN'
+    long '--config'
     desc 'The yaml config file'
   end 
   
-  option :user do
+  option :user, :required=>true do
     short '-u'
-    long '--user=USER_ID'
+    long '--user'
     desc 'The user identificator'
   end
 

data/lib/sshkg/version.rb

@@ -1,12 +1,12 @@
-module SSHKeyGenerator  
+module SSHKeyGenerator
   module Version
-    MAJOR = 0
-    MINOR = 1
-    PATCH = 0
+    INFO = {
+      :major =>0,
+      :minor =>2,
+      :patch =>0
+    }
 
-    STRING = [MAJOR, MINOR, PATCH ].compact.join(".")
+    NAME    = 'sshkg'
+    VERSION = INFO.values.join( '.' )
   end
-
-  NAME    = "sshkg"
-  VERSION = Version::STRING
-end
+end

data/test/unit/tc_generator.rb

@@ -0,0 +1,78 @@
+$:.unshift( File.join( File.dirname( __FILE__ ), %w[.. .. lib sshkg] ) )
+
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'fileutils'
+require 'generator'
+
+
+class TestSSHKeyGenerator < Test::Unit::TestCase
+
+  context "A SSH key generator context" do
+
+    setup do
+      
+      @test_dsa_user                 = "dsauser"
+      @test_dsa_comment              = "dsacomment"
+      @test_dsa_key_file_name        = "id_dsa.#{@test_dsa_user}"
+      @test_dsa_public_key_file_name = "id_dsa.#{@test_dsa_user}.pub"
+
+      @test_rsa_user                 = "rsauser"
+      @test_rsa_comment              = "rsacomment"
+      @test_rsa_key_file_name        = "id_rsa.#{@test_rsa_user}"
+      @test_rsa_public_key_file_name = "id_rsa.#{@test_rsa_user}.pub"
+    end
+    
+    
+    teardown do
+      
+      FileUtils.rm_f( @test_dsa_key_file_name )
+      FileUtils.rm_f( @test_dsa_public_key_file_name )
+      
+      FileUtils.rm_f( @test_rsa_key_file_name )
+      FileUtils.rm_f( @test_rsa_public_key_file_name )
+    end
+    
+    
+    should "raise an ArgumentError" do
+            
+      assert_raises( ArgumentError ) { SSHKeyGenerator.generate( ) } 
+      assert_raises( ArgumentError ) { SSHKeyGenerator.generate( :type=>:dsa, :comment=>@test_dsa_comment ) } 
+      assert_raises( ArgumentError ) { SSHKeyGenerator.generate( :type=>:rsa, :comment=>@test_rsa_comment ) } 
+    end
+
+
+    should "generate a default key" do
+            
+      SSHKeyGenerator.generate( :user=>@test_dsa_user )
+      
+      assert( File.exist?( @test_dsa_key_file_name ) )      
+
+      assert( File.exist?( @test_dsa_public_key_file_name ) ) 
+      assert( File.read( @test_dsa_public_key_file_name ) =~ /^ssh-dss (.+) #{@test_dsa_user}\@example.com$/ )
+      
+      FileUtils.rm_f( @test_dsa_key_file_name )
+      FileUtils.rm_f( @test_dsa_public_key_file_name )
+    end
+
+
+    should "generate a pair of DSA keys" do
+      
+      SSHKeyGenerator.generate( :user=>@test_dsa_user, :type=>:dsa, :bits=>1024, :comment=>@test_dsa_comment )
+
+      assert( File.exist?( @test_dsa_public_key_file_name ) )
+      assert( File.read( @test_dsa_public_key_file_name ) =~ /^ssh-dss (.+) #{@test_dsa_user}\@#{@test_dsa_comment}$/ )
+    end
+
+    
+    should "generate a pair of RSA keys" do
+    
+      SSHKeyGenerator.generate( :user=>@test_rsa_user, :type=>:rsa, :bits=>2048, :comment=>@test_rsa_comment )  
+
+      assert( File.exist?( @test_rsa_public_key_file_name ) )
+      assert( File.read( @test_rsa_public_key_file_name ) =~ /ssh-rsa (.+) #{@test_rsa_user}\@#{@test_rsa_comment}$/ )
+    end
+  end
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: sshkg
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors: 
 - Javier Juarez
@@ -15,10 +10,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-04 00:00:00 +02:00
+date: 2011-03-31 00:00:00 +02:00
 default_executable: sshkg
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: choice
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: config_context
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: choice
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: config_context
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
 description: A wrapper over ssh-keygem for rubyists
 email: javier.juarez@gmail.com
 executables: 
@@ -26,22 +64,22 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README.textile
+- README.rdoc
 files: 
 - bin/sshkg
-- lib/sshkg.rb
-- lib/sshkg/config.rb
+- lib/loader.rb
 - lib/sshkg/generator.rb
+- lib/sshkg/options_parser.rb
 - lib/sshkg/version.rb
-- lib/util/opt_parser.rb
-- README.textile
+- test/unit/tc_generator.rb
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/jjuarez/sshkg
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -49,25 +87,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: http://github.com/jjuarez/sshkg
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A very simple gem that helps to automate the generation of SSH Keys
-test_files: []
-
+test_files: 
+- test/unit/tc_generator.rb

data/lib/sshkg/config.rb

@@ -1,24 +0,0 @@
-require 'yaml'
-
-module SSHKeyGenerator
-  
-  class Config    
-    class << self
-      
-      def load( user, file_name )
-        @config        = YAML.load_file( file_name )
-        @config[:user] = user 
-      end 
-
-      def [] key 
-        @config[key] ? @config[key] : @config[key.to_s] if @config
-      end
-      
-      def to_h()
-        { :type    =>Config[:type], 
-          :file    =>"id_#{Config[:type]}.#{Config[:user]}", 
-          :comment =>"#{Config[:user]}@#{Config[:comment]}" } if @config
-      end
-    end
-  end
-end

data/lib/sshkg.rb

@@ -1,5 +0,0 @@
-require 'rubygems'
-require 'util/opt_parser'
-require 'sshkg/version'
-require 'sshkg/config'
-require 'sshkg/generator'