letscert 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7794f56c134e1437cbb2d89cf9bcf3b2da6f5bc1
-  data.tar.gz: 735bb555113c95eb110500c3fcd43b435c7e41aa
+  metadata.gz: 13246f0cc94eb264f9dcc01fb55a2e55250d5e63
+  data.tar.gz: d543f27b0a2d55a1e0fc17950bb662bbfbb3a932
 SHA512:
-  metadata.gz: 8d1369f91acfe830d02461a442eeac66d14995944996dac69c1d6120c42077566701eb0aca6bdc34ec9a0a17e82d2765a315086ba5ad0d97b7c58772701e0102
-  data.tar.gz: 5cc07fe0b35bab4b652ac29a1807ae39b62cae562fcbb73dd8fc9320f2bbef3be338471094baca01bdc41c9309fb6c8b375080b01013c91538467ecaddbae05b
+  metadata.gz: ebbdc254cd7cfea90f1b23308673a839baeaa564450dc18fa5340ed30a8fa5e93e84180fdbe66360f70db449671bd276352c3a2081a5aa8b76b58604f341df7e
+  data.tar.gz: 4ae2cdc6a2fa18eb7e9606c909e6260cee6878000ab5c601ce0482352e15333e8bd048a8b33d2614459d0c9ba36dc7c72d753936e21489a584fafb9894457720

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/letscert.svg)](https://badge.fury.io/rb/letscert)
+
 # letscert
 A simple `Let's Encrypt` client in ruby.
 
@@ -7,12 +9,17 @@ in Ruby.
 
 # Usage
 
-Generate a key pair and get signed certificate
+Generate a key pair and get signed certificate:
+```bash
+letscert -d example.com:/var/www/example.com/html -f account_key.json -f key.pem -f cert.pem -f fullchain.pem
+```
+
+Generate a key pair and get a signed certificate for multi-domains:
 ```bash
-letscert -d example.com:/var/www/example.com/html -f key.pem -f cert.pem -f fullchain.pem
+letscert -d example.com -d www.example.com --default_root /var/www/html -f account_key.json -f key.pem -f cert.pem -f fullchain.pem
 ```
 
-The command is the same for certificate renewal.
+Commands are the sames for certificate renewal.
 
 # What `letscert` do
 
@@ -30,4 +37,4 @@ The command is the same for certificate renewal.
   * 2 in case of errors.
 
 # Todo
-Add support to revocation.
+Add support to revocation.

data/lib/letscert/certificate.rb

@@ -54,15 +54,17 @@ module LetsCert
         key = data[:key]
       else
         logger.info { 'Generate new private key' }
-        key = OpenSSL::PKey::RSA.generate(@options[:cert_key_size])
+        key = OpenSSL::PKey::RSA.generate(options[:cert_key_size])
       end
 
-      csr = Acme::Client::CertificateRequest.new(names: roots.keys, private_key: key)
+      csr = Acme::Client::CertificateRequest.new(names: roots.keys,
+                                                 private_key: key)
       cert = client.new_certificate(csr)
 
-      IOPlugin.registered.each do |name, plugin|
-        plugin.save( account_key: client.private_key, key: key, cert: cert.x509,
-                     chain: cert.x509_chain)
+      options[:files].each do |plugname|
+        IOPlugin.registered[plugname].save(account_key: client.private_key,
+                                           key: key, cert: cert.x509,
+                                           chain: cert.x509_chain)
       end
     end
 

data/lib/letscert/io_plugin.rb

@@ -19,8 +19,7 @@
 # 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.
-require 'json'
-require 'base64'
+require 'json/jwt'
 require_relative 'loggable'
 
 module LetsCert
@@ -145,43 +144,14 @@ module LetsCert
     def load_jwk(data)
       return nil if data.empty?
 
-      hsh = JSON.parse(data)
-
-      key = OpenSSL::PKey::RSA.new
-      key.n = OpenSSL::BN.new(Base64.strict_decode64(hsh['n']))
-      key.e = OpenSSL::BN.new(Base64.strict_decode64(hsh['e']))
-      key.d = OpenSSL::BN.new(Base64.strict_decode64(hsh['e']))
-      key.p = OpenSSL::BN.new(Base64.strict_decode64(hsh['p']))
-      key.q = OpenSSL::BN.new(Base64.strict_decode64(hsh['q']))
-      key.dmp1 = OpenSSL::BN.new(Base64.strict_decode64(hsh['dp']))
-      key.dmq1 = OpenSSL::BN.new(Base64.strict_decode64(hsh['dq']))
-      key.iqmp = OpenSSL::BN.new(Base64.strict_decode64(hsh['qi']))
-
-      key
+      JSON::JWK.new(JSON.parse(data)).to_key
     end
 
     # Dump crypto data (key) to a JSON-encoded string
-    # @param [OpenSSL::PKey] jwk
+    # @param [OpenSSL::PKey] key
     # @return [String]
-    def dump_jwk(jwk)
-      hsh = jwk.params
-
-      # Add and rename some fields to be compatible with simp_le
-      hsh['kty'] = 'RSA'
-      hsh['qi'] = hsh['iqmp'].dup
-      hsh['dp'] = hsh['dmp1'].dup
-      hsh['dq'] = hsh['dmq1'].dup
-      hsh.delete('iqmp')
-      hsh.delete('dmpl')
-      hsh.delete('dmql')
-      hsh.rehash
-
-      hsh.each_key do |key|
-        if hsh[key].is_a?(OpenSSL::BN)
-          hsh[key] = Base64.strict_encode64(hsh[key].to_s)
-        end
-      end
-      hsh.to_json
+    def dump_jwk(key)
+      key.to_jwk.to_json
     end
   end
 

data/lib/letscert.rb

@@ -24,7 +24,7 @@
 module LetsCert
 
   # Letscert version number
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 
 
   # Base error class

data/spec/account_key.json

@@ -0,0 +1 @@
+{"kty":"RSA","e":"AQAB","n":"ugv1o2Fg5N-RBScXrLpRRoPgDjFgHcM_BD2fHZYzXJ4k1AnspAgS-soaWuoN0WK4mwRsSGwF7cemLEA1zZiCpc6Q3WUxLDsM8oF8P_S0euAEhe8FQPON3vtNqYth2yPqAQ4-me43mZyXS94yzTrCVjowlnZsdaA54uUW0AxOD_0","d":"Qo-6zzwspVXTFYvZ7YMvRtIxnAJQR_Wtmv_M6JHvSEiQFoiCcGEvISijazlnvizarSNU9kgnit2t9xD17tuMidbqdPC0x0mkJ6BszB7lau6Nzfz6ACSqtH8eKmkGDBJTnRqzg45Z6-3-gQ9vlmvc3T029Gv7xfA-XOt_cNgFnGE","p":"7nhrSRbf6FZ6LA2FKzcdFOTSI7UlgEwWsrSC_7pyzYyXJC44crlWUDxxJJXNeC9OyOEJOXlgn-0hShAWkl9-CQ","q":"x7kFmj6GYbh0SaLeg9CFhnY-y_UMO9wFxu0NLi2JgL31gvIDrKGJYiSZ3xESi6FwpmHX_vbtFXpZXBbvMy0_VQ"}

data/spec/io_plugin_spec.rb

@@ -0,0 +1,104 @@
+require_relative 'spec_helper'
+require 'fileutils'
+
+module LetsCert
+
+  describe IOPlugin do
+
+    it '.empty_data always returns the same hash' do
+      hsh = IOPlugin.empty_data
+
+      expect(hsh.keys.size).to eq(4)
+      [:account_key, :key, :cert, :chain].each do |key|
+        expect(hsh.keys).to include(key)
+        expect(hsh[key]).to be_nil
+      end
+    end
+
+    it '.register registers known subclasses' do
+      names = %w(account_key.json key.pem key.der chain.pem fullchain.pem)
+      names += %w(cert.pem cert.der)
+
+      expect(IOPlugin.registered.size).to eq(names.size)
+
+      names.each do |name|
+        expect(IOPlugin.registered.keys).to include(name)
+      end
+    end
+
+    it '.register may register new classes' do
+      class NewIO < IOPlugin;end
+      IOPlugin.register(NewIO, 'newio')
+
+      expect(IOPlugin.registered.keys).to include('newio')
+      expect(IOPlugin.registered['newio']).to be_a(NewIO)
+    end
+
+  end
+
+  describe JWKIOPluginMixin do
+
+    class Test; include JWKIOPluginMixin; end
+
+    let(:test) { Test.new }
+
+    it "#load_jwk loads a RSA key from a JSON Web Key raw string" do
+      jwk = File.read(File.join(File.dirname(__FILE__), 'test.json'))
+      key = test.load_jwk(jwk)
+
+      expect(key).to be_a(OpenSSL::PKey::PKey)
+    end
+
+    it "#dump_jwk dumps a RSA key to a JSON Web Key raw string" do
+      jwk = File.read(File.join(File.dirname(__FILE__), 'test.json'))
+      key = test.load_jwk(jwk)
+
+      jwk2 = test.dump_jwk(key)
+      expect(jwk2).to eq(jwk)
+    end
+  end
+
+  describe AccountKey do
+
+    before(:all) { IOPlugin.logger = Logger.new('/dev/null') }
+
+    let(:ak) { IOPlugin.registered['account_key.json'] }
+
+    it 'persist account_key' do
+      persisted = ak.persisted
+      expect(persisted[:account_key]).to be(true)
+    end
+
+    it "#load account key from account_key.json file" do
+      expect(ak).to be_a(AccountKey)
+
+      pwd = FileUtils.pwd
+      FileUtils.cd File.dirname(__FILE__)
+
+      begin
+        content = ak.load
+        expect(content).to be_a(Hash)
+        expect(content.keys.size).to eq(1)
+        expect(content[:account_key]).to be_a(OpenSSL::PKey::PKey)
+      rescue Exception
+        raise
+      ensure
+        FileUtils.cd pwd
+      end
+    end
+
+    it "#save account key to account_key.json file" do
+      data = { account_key: OpenSSL::PKey::RSA.new(1024) }
+      ak.save(data)
+      begin
+        expect(File.exist?('account_key.json')).to be_truthy
+      rescue Exception
+        raise
+      ensure
+        File.unlink('account_key.json')
+      end
+    end
+
+  end
+
+end

data/spec/io_plugin_spec.rb~

@@ -0,0 +1,16 @@
+require_relative 'spec_helper'
+
+module LetsCert
+
+  describe IOPlugin do
+
+    it '.empty_data always returns the same hash' do
+      hsh = IOPlugin.empty_data
+
+      expect(hsh.keys.size).to eq(4)
+      expect(hsh.keys).to include(:account_key)
+    end
+
+  end
+
+end

data/spec/loggable_spec.rb

@@ -0,0 +1,32 @@
+require_relative 'spec_helper'
+
+module LetsCert
+
+  describe Loggable do
+
+    it 'extend a class to add loggability' do
+      class TestA; include Loggable; end
+
+      expect(TestA.methods).to include(:logger=)
+
+      my_logger = Logger.new(STDERR)
+      TestA.logger = my_logger
+      expect(TestA.new.logger).to eq(my_logger)
+    end
+
+    it 'extend a class and its subclasses to add loggability' do
+      class TestA; include Loggable; end
+      class TestB < TestA; end
+
+      expect(TestA.methods).to include(:logger=)
+      expect(TestB.methods).to include(:logger=)
+
+      my_logger = Logger.new(STDERR)
+      TestA.logger = my_logger
+      expect(TestA.new.logger).to eq(my_logger)
+      expect(TestB.new.logger).to eq(my_logger)
+    end
+
+  end
+
+end

data/spec/loggable_spec.rb~

@@ -0,0 +1 @@
+require_relative 'spec_helper'

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'letscert'

data/spec/spec_helper.rb~

@@ -0,0 +1 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')

data/spec/test.json

@@ -0,0 +1 @@
+{"kty":"RSA","e":"AQAB","n":"ugv1o2Fg5N-RBScXrLpRRoPgDjFgHcM_BD2fHZYzXJ4k1AnspAgS-soaWuoN0WK4mwRsSGwF7cemLEA1zZiCpc6Q3WUxLDsM8oF8P_S0euAEhe8FQPON3vtNqYth2yPqAQ4-me43mZyXS94yzTrCVjowlnZsdaA54uUW0AxOD_0","d":"Qo-6zzwspVXTFYvZ7YMvRtIxnAJQR_Wtmv_M6JHvSEiQFoiCcGEvISijazlnvizarSNU9kgnit2t9xD17tuMidbqdPC0x0mkJ6BszB7lau6Nzfz6ACSqtH8eKmkGDBJTnRqzg45Z6-3-gQ9vlmvc3T029Gv7xfA-XOt_cNgFnGE","p":"7nhrSRbf6FZ6LA2FKzcdFOTSI7UlgEwWsrSC_7pyzYyXJC44crlWUDxxJJXNeC9OyOEJOXlgn-0hShAWkl9-CQ","q":"x7kFmj6GYbh0SaLeg9CFhnY-y_UMO9wFxu0NLi2JgL31gvIDrKGJYiSZ3xESi6FwpmHX_vbtFXpZXBbvMy0_VQ"}

data/tasks/gem.rake

@@ -22,6 +22,7 @@ EOF
   s.executables = ['letscert']
 
   s.add_dependency 'acme-client', '~>0.3.0'
+  s.add_dependency 'json-jwt', '~>1.5'
   s.add_dependency 'yard', '~>0.8'
 
   #s.add_development_dependency 'rspec', '~>3.4'

data/tasks/spec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: letscert
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acme-client
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -55,13 +69,20 @@ files:
 - lib/letscert.rb
 - lib/letscert.rb~
 - lib/letscert/certificate.rb
-- lib/letscert/certificate.rb~
 - lib/letscert/io_plugin.rb
 - lib/letscert/loggable.rb
-- lib/letscert/loggable.rb~
 - lib/letscert/runner.rb
+- spec/account_key.json
+- spec/io_plugin_spec.rb
+- spec/io_plugin_spec.rb~
+- spec/loggable_spec.rb
+- spec/loggable_spec.rb~
+- spec/spec_helper.rb
+- spec/spec_helper.rb~
+- spec/test.json
 - tasks/gem.rake
 - tasks/gem.rake~
+- tasks/spec.rake
 - tasks/yard.rake
 homepage: https://github.com/sdaubert/letscert
 licenses:
@@ -83,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: letscert, a simple Let's Encrypt client

data/lib/letscert/certificate.rb~

@@ -1,8 +0,0 @@
-
-module LetsCert
-
-  # Class to handle ACME operations on certificates
-  class Certificate
-  end
-
-end

data/lib/letscert/loggable.rb~

@@ -1,24 +0,0 @@
-module LetsCert
-
-  module Loggable
-
-    module ClassMethods
-
-      # Set logger
-      # @param [Logger] logger
-      def self.logger=(logger)
-        @@logger = logger
-      end
-
-    end
-
-
-    # Get logger instance
-    # @return [Logger]
-    def logger
-      @logger ||= self.class.class_variable_get(:@@logger)
-    end
-
-  end
-
-end