ekey 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tags
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dmitry Koprov
+
+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,69 @@
+# Ekey
+
+A ruby wrapper for API of the ekey.ru
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ekey'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ekey
+
+## Usage
+
+### api_key setup
+
+First of all, setup `api_key`. To do this, put a file `ekey.rb` into rails config/initializers directory.
+
+    Ekey::Config.api_key = <your_api_key>
+
+If you aren't using rails, just make shure, api_key fills in before any API methods calls.
+
+### Sending certificate request
+
+To send certificate request (csr) to the certificate authority CA, use the `CSR.issue` method
+
+    Ekey::Certificate.issue(csr)
+
+Where the `csr` parameter is the signed certificate request in the `pem` format.
+Here is shortened example of the csr in pem format:
+
+    -----BEGIN CERTIFICATE REQUEST-----\nMIICTzCCAfwCAQAwggFEMT0wOwYDVQQDHjQEEAQ7BDUEOgRBBDAEPQQ0BEAAIAQfBDAEMgQ7BD4EMgQ4BEcAIAQSBDAEMgQ4BDsEPgQyMRUwEwYYVQUHHgwGHPQ\n-----END CERTIFICATE REQUEST-----
+
+Result: a ruby Hash, in format: `{"created_request_id" => <number>}` or `{"error" => <message>}`.
+
+### Getting issued certificates by request ids
+
+In order to get issued certificates use
+
+    Ekey::Certificate.get_certificates(request_ids)
+
+Where request_ids is a collection of all request ids of the pending certificates in your application. It can be a String, Array or just one Fixnum.
+
+Response: a JSON in format `[{"id" => <request_id>, "certificate" => <certificate_body>}]`, or if the certificate is'n issued yet - `[{"id" => <request_id>, "error" => "certificate is not ready yet"}]`. Response can contain both of this as well.
+
+Note, that certificate is the only base64 string without BEGIN CERTIFICATE/END CERTIFICATE splitted by 64 characters.
+Here is the shortened sample of the certificate value:
+
+    MIIDZjCCAxOgAwIBAgIKXaz9BwAAAADF1jAKBgYqhQMCAgMFADCBkjEeMBwGCSqG\nSIb3DQEJARYPY29udGFjdEBla2V5LnJ1MQswCQYDVQQGEwJSVTEVMBMGA1UEBwwM\n0JzQvtGB0LrQstCwMTcwNQYDVQQKn8HsQFSfy9BDG+A==\n
+
+
+## Contributing
+
+1. Fork.
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+Copyright (c) 2012 by Dmitry Koprov (dkoprov), evrone.com
+
+This project uses MIT LICENSE

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/ekey.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ekey/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dmitry Koprov"]
+  gem.email         = ["dmitry.koprov@gmail.com"]
+  gem.description   = %q{A ruby wrapper for API of the ekey.ru}
+  gem.summary       = %q{A ruby wrapper for API of the ekey.ru}
+  gem.homepage      = "https://github.com/dkoprov/ekey"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "ekey"
+  gem.require_paths = ["lib"]
+  gem.version       = Ekey::VERSION
+
+  gem.add_dependency "json_pure"
+  gem.add_dependency "rest-client"
+
+end

data/lib/ekey/certificate.rb

@@ -0,0 +1,47 @@
+# Модуль Certificate отвечает за отправление запроса на сертификат (CSR) и получение готового сертификата.
+#
+# Комплекс взаимодействия с ekey.ru:
+#    - issue -- отправляет запрос на выпуск сертификата
+#       на вход: csr в формате pem
+#       ответ: ruby hash в формате {"created_request_id" => <number>} или {"error" => <message>}
+#    - get_certificates -- забирает с Удостоверяющего центра (УЦ, CA) готовые сертификаты
+#       на вход: id сертификатов в очереди на выпуск (request_ids)
+#       ответ: json в формате [{"id" => <request_id>, "certificate" => <certificate_body>},
+#              если серт. еще не выпущен - {"id" => <request_id>, "error" => "certificate is not ready yet"}]
+
+require 'rest_client'
+require 'json'
+
+module Ekey
+  class Certificate
+    CA_UPLOAD_PAGE_URL   = "http://cabinet.ekey.ru/api/1.0/request/put"
+    CA_DOWNLOAD_PAGE_URL = "http://cabinet.ekey.ru/api/1.0/certificates/get"
+
+    CERTIFICATE_LINE_LENGTH = 64
+
+    # Делит длинную строку base64 на строки по 64 символа.
+    # Это требование cabinet.ekey.ru к запросам на выпуск сертификата (CSR).
+    def self.add_container_to_csr(cert_req)
+      stripted_body = cert_req.gsub("-----BEGIN CERTIFICATE REQUEST-----", '').gsub("-----END CERTIFICATE REQUEST-----", '').gsub(/[\r\n\s]/, '')
+      parts = stripted_body.scan(/.{1,#{CERTIFICATE_LINE_LENGTH}}/)
+      csr_with_container = "-----BEGIN CERTIFICATE REQUEST-----\n#{parts.join("\n")}\n-----END CERTIFICATE REQUEST-----"
+    end
+
+    def self.issue(csr)
+      upload_responce = RestClient.post(CA_UPLOAD_PAGE_URL,
+                                        { :api_key => Ekey::Config.api_key,
+                                          :pkcs10 => add_container_to_csr(csr) },
+                                        :multipart => true)
+      JSON(upload_responce)
+    end
+
+    def self.get_certificates(ca_request_ids)
+      id_list = Array(ca_request_ids).join(', ')
+      ca_responce = RestClient.post(CA_DOWNLOAD_PAGE_URL, { :api_key => Ekey::Config.api_key,
+                                                            :id_list => id_list })
+      JSON(ca_responce)
+    end
+
+  end
+end
+

data/lib/ekey/version.rb

@@ -0,0 +1,3 @@
+module Ekey
+  VERSION = "0.1.0"
+end

data/lib/ekey.rb

@@ -0,0 +1,8 @@
+require "ekey/certificate"
+
+module Ekey
+  module Config
+    # API_KEY for cabinet.ekey.ru.
+    mattr_accessor :api_key
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: ekey
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dmitry Koprov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A ruby wrapper for API of the ekey.ru
+email: 
+- dmitry.koprov@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ekey.gemspec
+- lib/ekey.rb
+- lib/ekey/certificate.rb
+- lib/ekey/version.rb
+homepage: https://github.com/dkoprov/ekey
+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.10
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for API of the ekey.ru
+test_files: []
+