httpi-adapter-openssl_gost 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7246e71d3ac930e54148951c0f832c4e285fb70b
+  data.tar.gz: 0e1b4be04689555e7eeba4664beb366877713fe7
+SHA512:
+  metadata.gz: 7fd06b785759998e6ec5893f7c2d5292e452f3c9416241c66cbed363861db8da28ab61acd0ff57f122c691f01c844ffc7a713921a9ce8acacefc79f119175349
+  data.tar.gz: e1c2581189f1bb79158f416c565b2b74ea4a678484c30c0092fcdcc665aec3e86d80a50a2c986e0e05cc317a62c896a6562ac22fdf30c77b946f46d891075e63

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in httpi-adapter-openssl_gost.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrey Novikov
+
+MIT License
+
+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.md

@@ -0,0 +1,121 @@
+OpenSSL GOST adapter for [HTTPI]
+================================
+
+This gem allows to perform HTTP requests over secure connections, that requires russian GOST cryptoalgorithms to be used.
+It allows to use client certificate and private key for authentication.
+
+**WARNING!** This gem is kind of «last chance software». It uses `openssl s_client` command to perform requests.
+As it's command for debug and testing purposes only, it's slow and unreliable. Use at your own risk only if nothing else is working for you (as it for me).
+
+## Installation
+
+### OpenSSL installation and configuration
+
+You need to install OpenSSL 1.0.0 or newer (OpenSSL 1.0.1 or newer is better) with GOST engine installed (it's bundled starting from 1.0.0).
+
+Usually in modern Lunux distributions it's installed already (at least in Ubuntu 12.04).
+Mac OS X users should install it through Homebrew or MacPorts: `brew install openssl`
+
+In `/etc/ssl/openssl.cnf` (`/usr/local/etc/openssl/openssl.cnf` for Mac OS X) add next line to _the very beginning of file_:
+
+    openssl_conf = openssl_def
+
+Add next lines to _the very end of file_:
+
+    [openssl_def]
+    engines = engine_section
+    [engine_section]
+    gost = gost_section
+    [gost_section]
+    default_algorithms = ALL
+    dynamic_path = /usr/lib/x86_64-linux-gnu/openssl-1.0.0/engines/libgost.so
+    engine_id = gost
+    CRYPT_PARAMS = id-Gost28147-89-CryptoPro-A-ParamSet
+
+`dynamic_path` isn't required in Mac OS X. Linux users can get it's value executing `locate libgost.so`.
+
+After that, `openssl ciphers | tr ":" "\n" | grep GOST` should return following lines:
+
+    GOST2001-GOST89-GOST89
+    GOST94-GOST89-GOST89
+
+### Gem installation
+
+Add this line to your application's Gemfile:
+
+    gem 'httpi-adapter-openssl_gost'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install httpi-adapter-openssl_gost
+
+## Usage
+
+```ruby
+require 'httpi/adapter/openssl_gost'
+request = HTTPI::Request.new
+request.url = 'https://example.com/'
+HTTPI.get(request, :openssl_gost)
+```
+
+Or you can specify it as default adapter for all requests:
+
+```ruby
+require 'httpi/adapter/openssl_gost'
+HTTPI.adapter :openssl_gost
+```
+
+If you need to specify client credentials (certificate and private key),
+pass file paths to `cert_file=` and `cert_key_file=` methods of the `request.auth.ssl`:
+
+```ruby
+request.auth.ssl.cert_file     = '/full/path/to/client.crt'
+request.auth.ssl.cert_key_file = '/full/path/to/client.pem'
+```
+
+### Usage with savon
+
+You need to use custom branches of [savon] and [wasabi] until next pull requests are not merged in:
+ 1. [savonrb/wasabi#44](https://github.com/savonrb/wasabi/issues/44)
+ 2. [savonrb/savon#566](https://github.com/savonrb/savon/pull/566):
+
+Place in your Gemfile:
+
+```ruby
+gem 'wasabi', github: 'Envek/wasabi', branch: 'specify_adapter'
+gem 'savon',  github: 'Envek/savon',  branch: 'specify_adapter'
+```
+
+Specify `:adapter` in savon client global options:
+
+```ruby
+require 'httpi/adapter/openssl_gost'
+soap_client = Savon.client(
+  wsdl:              'https://service-requiring-gost.ru/service?wsdl',
+  ssl_cert_file:     '/full/path/to/client.crt',
+  ssl_cert_key_file: '/full/path/to/client.pem',
+  adapter:           :openssl_gost,
+)
+```
+
+And use it as usual:
+
+```ruby
+soap_client.call(:method, message: {foo: 1})
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/Envek/httpi-adapter-openssl_gost/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[HTTPI]:  https://github.com/savonrb/httpi
+[savon]:  https://github.com/savonrb/savon
+[wasabi]: https://github.com/savonrb/wasabi

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/httpi-adapter-openssl_gost.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'httpi/adapter/openssl_gost/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'httpi-adapter-openssl_gost'
+  spec.version       = HTTPI::Adapter::OpensslGost::VERSION
+  spec.authors       = ['Andrey Novikov']
+  spec.email         = ['envek@envek.name']
+  spec.summary       = 'HTTPI adapter for accessing HTTPS servers with GOST algorithms and certificates'
+  spec.description   = 'It uses OpenSSL `s_client` command to securely connect with server that requires usage of GOST algorithms and client certificates.'
+  spec.homepage      = 'https://github.com/Envek/httpi-adapter-openssl_gost'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.requirements << 'OpenSSL 1.0.0 and newer with GOST engine installed, enabled, and configured.'
+  spec.add_dependency 'httpi', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10'
+end

data/lib/httpi/adapter/openssl_gost.rb

@@ -0,0 +1,78 @@
+require 'httpi'
+require 'open3'
+require 'httpi/adapter/openssl_gost/version'
+
+module HTTPI
+  module Adapter
+    class OpensslGost < Base
+
+      register :openssl_gost
+
+      def initialize(request)
+        @request = request
+        @pubkey_path  = request.auth.ssl.cert_file
+        @privkey_path = request.auth.ssl.cert_key_file
+      end
+
+      attr_reader :client
+      attr_accessor :pubkey_path
+      attr_accessor :privkey_path
+
+      def request(method)
+        uri = @request.url
+        cmd = "openssl s_client -engine gost -connect '#{uri.host}:#{uri.port}' -quiet"
+        cmd += " -cert '#{pubkey_path}'"  if pubkey_path
+        cmd += " -key '#{privkey_path}'"  if privkey_path
+
+        # Prepare request
+        req = "#{method.upcase} #{uri.request_uri} HTTP/1.1\r\n"
+        headers = @request.headers.map{|k,v| "#{k}: #{v}\r\n" }.join
+        # Set up Content-Length header if body present (HTTPI doesn't it for us)
+        if @request.body and !@request.headers['Content-Length']
+          headers += "Content-Length: #{@request.body.bytesize}\r\n"
+        end
+        # Add hostname header and explicitly close connection (we need command to exit immediately)
+        headers += "Host: #{uri.host}\r\nConnection: close\r\n\r\n"
+        req += headers
+        req += "#{@request.body}\r\n\r\n"  if @request.body
+
+        # Send request, get answer
+        HTTPI.logger.debug "Connecting to server with command: #{cmd}"
+        HTTPI.logger.debug "Sending request:\r\n#{req}"
+        retries = 0
+        begin
+          raw_response, openssl_stderr, status = Open3.capture3(cmd, stdin_data: req, binmode: true)
+        rescue Errno::EPIPE # Sometimes fails with no reason
+          retry if retries+=1 < 3
+        end
+
+        # Check whether command finished correctly and prepare response
+        if status.success?
+          HTTPI.logger.debug "Received response:\r\n#{raw_response}"
+          status_string, headers_and_body = raw_response.split("\r\n", 2)
+          response_headers, response_body = headers_and_body.split("\r\n\r\n", 2)
+          response_code = status_string.scan(/\d{3}/).first
+          response_headers = Hash[response_headers.split("\r\n").map{|h| h.split(':', 2).map(&:strip) }]
+          HTTPI::Response.new(response_code, response_headers, response_body)
+        else
+          HTTPI.logger.fatal "While connecting to server #{uri.host} with command: #{cmd}"
+          HTTPI.logger.fatal "Command returned:\r\n#{status.inspect}"
+          HTTPI.logger.fatal "STDERR is:\n#{openssl_stderr}"
+          # OpenSSL's s_client always return 1 on fail, try to catch most common errors
+          case openssl_stderr
+            when /connect:errno=60/ then raise HTTPI::TimeoutError
+            when /connect:errno=61/ then raise (HTTPI::Error.new).extend(HTTPI::ConnectionError) # Connection refused
+            when /connect:errno=2/  then raise (HTTPI::Error.new).extend(HTTPI::ConnectionError) # No DNS name found
+            when /ssl handshake failure/          then raise HTTPI::SSLError, 'Seems like you trying to connect to HTTP, not HTTPS'
+            when /missing dsa signing cert/       then raise HTTPI::SSLError, 'Probably your OpenSSL lacks GOST configuration'
+            when /unable to load certificate/     then raise HTTPI::SSLError, 'Can not load client certificate, check file path and access rights'
+            when /unable to load .*? private key/ then raise HTTPI::SSLError, 'Can not load client certificate private key, check file path and access rights'
+            else raise HTTPI::Error
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/httpi/adapter/openssl_gost/version.rb

@@ -0,0 +1,9 @@
+require 'httpi'
+
+module HTTPI
+  module Adapter
+    class OpensslGost < Base
+      VERSION = '0.0.1'
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: httpi-adapter-openssl_gost
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrey Novikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+description: It uses OpenSSL `s_client` command to securely connect with server that
+  requires usage of GOST algorithms and client certificates.
+email:
+- envek@envek.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- httpi-adapter-openssl_gost.gemspec
+- lib/httpi/adapter/openssl_gost.rb
+- lib/httpi/adapter/openssl_gost/version.rb
+homepage: https://github.com/Envek/httpi-adapter-openssl_gost
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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:
+- OpenSSL 1.0.0 and newer with GOST engine installed, enabled, and configured.
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: HTTPI adapter for accessing HTTPS servers with GOST algorithms and certificates
+test_files: []