rsolr-client-cert 0.5.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rsolr-client-cert.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# rsolr-client-cert [![Build Status](https://secure.travis-ci.org/mbklein/rsolr-client-cert.png)](http://travis-ci.org/mbklein/rsolr-client-cert)
+
+<b>rsolr-client-cert</b> provides client certificate authentication for [RSolr](https://github.com/mwmitchell/rsolr).
+
+## Installation
+
+    gem install rsolr-client-cert
+    
+## Usage
+
+    require 'rubygems'
+    require 'rsolr/client_cert'
+    
+    client = RSolr::ClientCert.connect :url => 'http://solrserver.com', :ssl_cert_file => '/path/to/certificate.crt', 
+      :ssl_key_file => '/path/to/keyfile.key', :ssl_key_pass => 'SuPeRseKrItPaSsWoRd!!11!'
+
+Or, to create the certificate/key objects manually:
+
+    @my_cert = OpenSSL::X509::Certificate.new(cert_pem)
+    @my_key = OpenSSL::PKey::RSA.new(key_pem, key_pass)
+    client = RSolr::ClientCert.connect :url => 'http://solrserver.com', :ssl_client_cert => @my_cert, 
+      :ssl_client_key => @my_key
+
+Any options that don't start with `:ssl_` will be passed through to `RSolr::Client`. See the 
+[RSolr README](https://github.com/mwmitchell/rsolr/blob/master/README.rdoc) for additional valid
+options.
+
+## Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit. Please do not mess with rakefile, version, or history. If you want to have your own version, 
+  that is fine but bump version in a commit by itself I can ignore when I pull.
+* Send me a pull request. Bonus points for topic branches.
+
+## Version History
+
+- <b>0.5.0</b> Initial release

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run spec tests"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ["-c", "-f doc"]
+end
+
+task :default => [:spec]

data/lib/rsolr/client-cert.rb

@@ -0,0 +1 @@
+require 'rsolr/client_cert'

data/lib/rsolr/client_cert.rb

@@ -0,0 +1,18 @@
+require 'rsolr'
+require "rsolr/client_cert/version"
+require 'rsolr/client_cert/connection'
+
+module RSolr
+  module ClientCert
+
+    def self.connect(opts)
+      grouped_opts = opts.group_by { |k,v| k.to_s =~ /^ssl_/ ? :ssl : :solr }
+      solr_opts = Hash[grouped_opts[:solr]]
+      ssl_opts = Hash[grouped_opts[:ssl]]
+      connection = Connection.new ssl_opts
+      client_class = opts.delete(:client_class) || RSolr::Client
+      client_class.new connection, solr_opts
+    end
+
+  end
+end

data/lib/rsolr/client_cert/connection.rb

@@ -0,0 +1,65 @@
+require 'openssl'
+
+module RSolr
+  module ClientCert
+    class Error < Exception; end
+      
+    class Connection
+      attr_reader :ssl_client_cert, :ssl_client_key
+      
+      def initialize opts = {}
+        @ssl_client_cert = extract_client_cert(opts)
+        @ssl_client_key = extract_client_key(opts)
+      end
+      
+      def execute client, request_context
+        resource = RestClient::Resource.new(
+          request_context[:uri].to_s,
+          :ssl_client_cert  =>  ssl_client_cert,
+          :ssl_client_key   =>  ssl_client_key
+        )
+        result = {}
+        resource.send(request_context[:method]) { |response, request, result, &block|
+          result = {
+            :status => response.net_http_res.code.to_i,
+            :headers => response.net_http_res.to_hash,
+            :body => response.net_http_res.body
+          }
+        }
+        result
+      end
+      
+      protected
+      
+      def extract_key_class(key_text)
+        if key_text =~ /BEGIN (.+) PRIVATE KEY/
+          OpenSSL::PKey.const_get($1.to_sym)
+        else
+          raise Error, "Cannot determine key type"
+        end
+      end
+    
+      def extract_client_key(opts)
+        if opts[:ssl_client_key]
+          opts[:ssl_client_key]
+        elsif opts[:ssl_key_file]
+          key_text = File.read(opts[:ssl_key_file])
+          key_class = extract_key_class(key_text)
+          key_class.new(key_text, opts[:ssl_key_pass].to_s)
+        else
+          raise Error, "No :ssl_client_key or :ssl_key_file provided"
+        end
+      end
+    
+      def extract_client_cert(opts)
+        if opts[:ssl_client_cert]
+          opts[:ssl_client_cert]
+        elsif opts[:ssl_cert_file]
+          OpenSSL::X509::Certificate.new(File.read(opts[:ssl_cert_file]))
+        else
+          raise Error, "No :ssl_client_key or :ssl_key_file provided"
+        end
+      end
+    end
+  end
+end

data/lib/rsolr/client_cert/version.rb

@@ -0,0 +1,5 @@
+module RSolr
+  module ClientCert
+    VERSION = "0.5.0"
+  end
+end

data/rsolr-client-cert.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rsolr/client_cert/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rsolr-client-cert"
+  s.version     = RSolr::ClientCert::VERSION
+  s.authors     = ["Michael Klein"]
+  s.email       = ["mbklein@gmail.com"]
+  s.homepage    = "https://github.com/mbklein/rsolr-client-cert"
+  s.summary     = %q{Client certificate authentication for RSolr}
+  s.description = %q{Client certificate authentication for RSolr}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+  s.add_runtime_dependency "jruby-openssl" if RUBY_PLATFORM == 'java'
+  s.add_runtime_dependency "rsolr"
+  s.add_runtime_dependency "rest-client"
+end

data/spec/fixtures/certificate.crt

@@ -0,0 +1,16 @@
+-----BEGIN CERTIFICATE-----
+MIICbTCCAhegAwIBAgIJAL901ib7qNHbMA0GCSqGSIb3DQEBBQUAMFoxCzAJBgNV
+BAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRIwEAYDVQQHEwlQYWxvIEFsdG8x
+IjAgBgNVBAoTGVJTb2xyIENsaWVudCBDZXJ0IFRlc3RpbmcwHhcNMTIwMjI4MjIw
+MzI5WhcNMTUwMjI3MjIwMzI5WjBaMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2Fs
+aWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRvMSIwIAYDVQQKExlSU29sciBDbGll
+bnQgQ2VydCBUZXN0aW5nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANK6Zv2M7H/4
+2RYJggi9NxeEFVswk2864VwOjevrzDQstds/vT2F9ljLVeetk7Zj/39cQzKDuPKG
+HXq+OH5q2IMCAwEAAaOBvzCBvDAdBgNVHQ4EFgQU1F08DR6zF1e3HE4bIPtQr1rr
+ao4wgYwGA1UdIwSBhDCBgYAU1F08DR6zF1e3HE4bIPtQr1rrao6hXqRcMFoxCzAJ
+BgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRIwEAYDVQQHEwlQYWxvIEFs
+dG8xIjAgBgNVBAoTGVJTb2xyIENsaWVudCBDZXJ0IFRlc3RpbmeCCQC/dNYm+6jR
+2zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA0EAEar8gmqHxbWoJ3w2p9F1
+l6idm8caVKKG6Y3Azv8xAKfwGeSUXOIJAWMHaN6LuU8p0tWgbt5sidlDe0dmWaxX
+Kg==
+-----END CERTIFICATE-----

data/spec/fixtures/dsa_key.key

@@ -0,0 +1,12 @@
+-----BEGIN DSA PRIVATE KEY-----
+MIIBugIBAAKBgQC36EQcSn4h/xg4YBPVMkjA6/AnA9kvS0T3dDUy62ey3r4zvbHM
+eirNIdYfCLT38zMEPfqWyTo4in0TfxQzso0MivVC8LUV0y8QayWpoi9DwPUuPcFj
+dGj2pAH+vTvm31glefLTY0Fc4YwSSGTlIk7Jz9XfM8ZYd/zHcjNx/GolPwIVAL8l
+DU7xcqQpUfvkteHJebLZk1SPAoGAFIhB3RN1hAh9z333CcHE2ZG0Iq4l9ctKPgMi
+NG7M8I+f2OaZG7pMZZFyuiKR1ELMaA/ByIp5Q5i4LmPVlWPvA4XjnGSKAVFKibwL
+iLnH13ocYVQhd3fr9eB+kay6OYQsp2kl26zLVFiwDY4YXTpc9eZS7FGe9TzXUWNJ
+9QwxQlECgYB4284c3vv96cJ0KtGRX2IDXBAsgRGIQ4RyBbREcgEEpatWCn7T0WZe
+zI2HRnEVSjn+O2YC0Ym2DWNUmoCtNd9NJucBAnCbBa9E3yS4lXAdBCF7ayyU38jL
+9R78O9OnB2caXSc4lauxof7Pp9vkJzL/RqvOroajCKZykpvWBeKR9gIUALtnzzgn
+mV4UIkYewkHsM/TUIkQ=
+-----END DSA PRIVATE KEY-----

data/spec/fixtures/rsa_key.key

@@ -0,0 +1,9 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIBPAIBAAJBANK6Zv2M7H/42RYJggi9NxeEFVswk2864VwOjevrzDQstds/vT2F
+9ljLVeetk7Zj/39cQzKDuPKGHXq+OH5q2IMCAwEAAQJBAIZtMKwITQop5dogAJqw
+kcdnk/QTHco0BnUiN7jLN/4DamPMI6DoGoqdkbVt5LuLatU5OT+hqPpC8m6SERVs
+M7kCIQD6j5lHGlTiEVCEsq8vvl8fZohFsIp8mHu1F7DRs0zK3wIhANdNcoCELOZ7
+9NeFLPbDCFUwvVGR/79OheZXc510LQrdAiBppIIL6J5BcutwB6a1ip6wrppmR7kc
+L255PDPhNqf6IQIhAMQ3KeYkD4OSboZIMb1F638wJymC5FAmMPPGuXBC45XlAiEA
+lYUA4Vrf9Hj5eKGddWTD//2xlwrrKjFLAXO1gOmJF7s=
+-----END RSA PRIVATE KEY-----

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'bundler/setup'
+require 'rspec'
+require 'simplecov'
+SimpleCov.start
+
+RSpec.configure do |config|
+
+end

data/spec/unit/client_cert_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'rsolr/client_cert'
+
+describe RSolr::ClientCert do
+  
+  before :all do
+    @fixture_dir = File.expand_path('../../fixtures',__FILE__)
+    @cert_file = File.join(@fixture_dir,'certificate.crt')
+    @key_pass = 'SuPeRseKrItPaSsWoRd!!11!'
+  end
+  
+  it "should provide an SSL certificate connection with an RSA keyfile" do
+    solr = RSolr::ClientCert.connect :url => 'https://example.edu/solr', :ssl_cert_file => @cert_file, 
+      :ssl_key_file => File.join(@fixture_dir, 'rsa_key.key'), :ssl_key_pass => @key_pass
+    solr.connection.ssl_client_cert.should be_a OpenSSL::X509::Certificate
+    solr.connection.ssl_client_key.should be_a OpenSSL::PKey::RSA
+  end
+  
+  it "should provide an SSL certificate connection with an RSA keyfile" do
+    solr = RSolr::ClientCert.connect :url => 'https://example.edu/solr', :ssl_cert_file => @cert_file, 
+      :ssl_key_file => File.join(@fixture_dir, 'dsa_key.key'), :ssl_key_pass => @key_pass
+    solr.connection.ssl_client_cert.should be_a OpenSSL::X509::Certificate
+    solr.connection.ssl_client_key.should be_a OpenSSL::PKey::DSA
+  end
+  
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: rsolr-client-cert
+version: !ruby/object:Gem::Version 
+  hash: 11
+  prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Michael Klein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rsolr
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+description: Client certificate authentication for RSolr
+email: 
+- mbklein@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/rsolr/client-cert.rb
+- lib/rsolr/client_cert.rb
+- lib/rsolr/client_cert/connection.rb
+- lib/rsolr/client_cert/version.rb
+- rsolr-client-cert.gemspec
+- spec/fixtures/certificate.crt
+- spec/fixtures/dsa_key.key
+- spec/fixtures/rsa_key.key
+- spec/spec_helper.rb
+- spec/unit/client_cert_spec.rb
+homepage: https://github.com/mbklein/rsolr-client-cert
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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.8.15
+signing_key: 
+specification_version: 3
+summary: Client certificate authentication for RSolr
+test_files: 
+- spec/fixtures/certificate.crt
+- spec/fixtures/dsa_key.key
+- spec/fixtures/rsa_key.key
+- spec/spec_helper.rb
+- spec/unit/client_cert_spec.rb