rails-letsencrypt 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f2c887b3a1d6aa85e7e816b9e38825f3731b7f6
-  data.tar.gz: 4e8c531be29e92c9bde71803ccca868a6ac649a3
+  metadata.gz: d6408387e993ede69529209f7e73797ba2b5d99a
+  data.tar.gz: 65192f2f42d4de422b3a2e17001e588512353397
 SHA512:
-  metadata.gz: 5149e9b89f63bf63933f2e68a1f31029ef2b9b393a02dd232d91d4a1dce95ac1b4dd10ee9155b287a4628de5868b2abddcfde408ddfd8150ba3bc69e3e843dd4
-  data.tar.gz: cde51125e065b0042cbf8c4b5c80f494309f574ee696adedfe53a47eb89c45d5633c3950106708c55eb43ef21bbc07f6ecaae2b94092f00098f712787150b1fb
+  metadata.gz: '09a814690b7c1d5f5dedd65a873ad9f5db9141f3d37f778fbed0498cee7652538231d337f8cb1158d40804149fac0abd0eec508fb074488327760656a7148012'
+  data.tar.gz: e051f1c768b3eb6b7a1baa3eb1bbfa24c0ba1cd8fa20ce10f65637f38e8b550586c5df9eaace83c589f3cba35526a7e92324da61741ec37e19af89526eb0cb8e

data/README.md

@@ -11,11 +11,19 @@ gem 'rails-letsencrypt'
 ```
 
 Run install migrations
+
 ```bash
-rake letsencrypt:install:migrations
+rails generate lets_encrypt:install
 rake db:migrate
 ```
 
+Setup private key for Let's Encrypt API
+
+```bash
+rails generate lets_encrypt:register
+```
+
+
 Add `acme-challenge` mounts in `config/routes.rb`
 ```ruby
 mount LetsEncrypt::Engine => '/.well-known'
@@ -25,6 +33,22 @@ mount LetsEncrypt::Engine => '/.well-known'
 
 The SSL certificate setup is depend on web server, this gem can work with `ngx_mruby` or `kong`.
 
+### Tasks
+
+To renew certificate, you can can run `renew` task to renew coming expires certificates.
+
+```bash
+rake letsencrypt:renew
+```
+
+### Jobs
+
+If you are using Sidekiq or others, you can enqueue renew task daily.
+
+```
+LetsEncrypt::RenewCertificate.queue(:default)
+```
+
 ### ngx_mruby
 
 The setup is following this [Article](http://hb.matsumoto-r.jp/entry/2017/03/23/173236)

data/Rakefile

@@ -8,14 +8,10 @@ require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'LetsEncrypt'
+  rdoc.title    = 'rails-letsencrypt'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-# TODO: Add rails 5 support tasks => load 'rails/tasks/statistics.rake'
-
 require 'bundler/gem_tasks'
-
-task default: :install

data/app/controllers/lets_encrypt/application_controller.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module LetsEncrypt
+  # :nodoc:
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception
   end

data/app/controllers/lets_encrypt/verifications_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_dependency 'lets_encrypt/application_controller'
 
 module LetsEncrypt

data/app/jobs/lets_encrypt/renew_certificates_job.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LetsEncrypt
+  # :nodoc:
+  class RenewCertificatesJob < ApplicationJob
+    queue_as :default
+
+    def perform
+      LetsEncrypt::Certificate.renewable.each do |certificate|
+        next if certificate.renew
+        certificate.update(renew_after: 1.day.from_now)
+      end
+    end
+  end
+end

data/app/models/lets_encrypt/certificate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LetsEncrypt
   # :nodoc:
   class Certificate < ActiveRecord::Base
@@ -6,17 +8,39 @@ module LetsEncrypt
 
     validates :domain, presence: true, uniqueness: true
 
+    scope :active, -> { where('certificate IS NOT NULL AND expires_at > ?', Time.zone.now) }
+    scope :renewable, -> { where('renew_after IS NULL OR renew_after <= ?', Time.zone.now) }
+    scope :expired, -> { where('expires_at <= ?', Time.zone.now) }
+
     before_create -> { self.key = OpenSSL::PKey::RSA.new(4096).to_s }
     after_save -> { save_to_redis }, if: -> { LetsEncrypt.config.use_redis? }
 
+    def active?
+      certificate.present?
+    end
+
+    def expired?
+      Time.zone.now >= expires_at
+    end
+
     def get
       verify && issue
     end
 
+    alias renew get
+
     def bundle
       [intermediaries, certificate].join("\n")
     end
 
+    def certificate_object
+      @certificate_object ||= OpenSSL::X509::Certificate.new(certificate)
+    end
+
+    def key_object
+      @key_object ||= OpenSSL::PKey::RSA.new(key)
+    end
+
     def save_to_redis
       LetsEncrypt::Redis.save(self)
     end

data/lib/generators/lets_encrypt/install_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module LetsEncrypt
+  module Generators
+    # :nodoc:
+    class InstallGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
+      def copy_migrations
+        migration_template 'migration.rb',
+                           'db/migrate/create_letsencrypt_certificates.rb'
+      end
+
+      def rails5?
+        Rails::VERSION::MAJOR == 5
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if rails5?
+      end
+    end
+  end
+end

data/lib/generators/lets_encrypt/register_generator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module LetsEncrypt
+  module Generators
+    # :nodoc:
+    class RegisterGenerator < ::Rails::Generators::Base
+      def register
+        say 'Starting register Let\'s Encrypt account', :green
+
+        setup_environment
+        generate_key
+        register_email
+      rescue Acme::Client::Error => e
+        say(e.message, :red)
+      end
+
+      private
+
+      def setup_environment
+        production = yes?('Do you want to use in production environment? [y/N]:')
+        LetsEncrypt.config.use_staging = !production
+      end
+
+      def generate_key
+        # rubocop:disable Metric/LineLength
+        key_path = ask("Where you to save private key [#{LetsEncrypt.private_key_path}]:", path: true)
+        # rubocop:enable Metrics/LineLength
+        key_path = LetsEncrypt.private_key_path if key_path.blank?
+
+        return unless file_collision(key_path)
+        FileUtils.rm(key_path)
+        LetsEncrypt.config.use_env_key = false
+        LetsEncrypt.config.private_key_path = key_path
+
+        LetsEncrypt.load_private_key
+
+        # rubocop:disable Metrics/LineLength
+        say "Your privated key is saved in #{key_path}, make sure setup configure for your rails.", :yellow
+        # rubocop:enable Metrics/LineLength
+      end
+
+      def register_email
+        email = ask('What email you want to register:')
+        return say('Email is inavlid!', :red) if email.blank?
+        LetsEncrypt.register(email)
+        say 'Register successed, don\'t forget backup your private key', :green
+      end
+    end
+  end
+end

data/lib/generators/lets_encrypt/templates/migration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# :nodoc:
+class CreateLetsencryptCertificates < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :letsencrypt_certificates do |t|
+      t.string   :domain
+      t.text     :certificate, limit: 65535
+      t.text     :intermediaries, limit: 65535
+      t.text     :key, limit: 65535
+      t.datetime :expires_at
+      t.datetime :renew_after
+      t.string   :verification_path
+      t.string   :verification_string
+
+      t.index    :domain
+      t.index    :renew_after
+      t.timestamps
+    end
+  end
+end

data/lib/letsencrypt.rb

@@ -1,6 +1,7 @@
 require 'openssl'
 require 'acme-client'
 require 'redis'
+require 'letsEncrypt/railtie'
 require 'letsencrypt/engine'
 require 'letsencrypt/configuration'
 require 'letsencrypt/logger_proxy'
@@ -30,7 +31,7 @@ module LetsEncrypt
     end
 
     def endpoint
-      @endpoint ||= Rails.env.production? ? ENDPOINT : ENDPOINT_STAGING
+      @endpoint ||= config.use_staging? ? ENDPOINT_STAGING : ENDPOINT
     end
 
     def register(email)
@@ -42,7 +43,6 @@ module LetsEncrypt
     end
 
     def private_key_path
-      # TODO: Add options for specify path
       config.private_key_path || Rails.root.join('config', 'letsencrypt.key')
     end
 
@@ -57,8 +57,15 @@ module LetsEncrypt
       @logger ||= LoggerProxy.new(Rails.logger, tags: ['LetsEncrypt'])
     end
 
-    def config
+    def config(&block)
       @config ||= Configuration.new
+      instance_exec(@config, &block) if block_given?
+      @config
+    end
+
+    # @api private
+    def table_name_prefix
+      'letsencrypt_'
     end
   end
 end

data/lib/letsencrypt/configuration.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 module LetsEncrypt
   # :nodoc:
   class Configuration
     include ActiveSupport::Configurable
 
+    config_accessor :use_staging do
+      !Rails.env.production?
+    end
     config_accessor :private_key_path
     config_accessor :use_env_key do
       false
@@ -14,5 +19,9 @@ module LetsEncrypt
     def use_redis?
       save_to_redis == true
     end
+
+    def use_staging?
+      use_staging
+    end
   end
 end

data/lib/letsencrypt/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module LetsEncrypt
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/letsencrypt/version.rb

@@ -1,3 +1,3 @@
 module LetsEncrypt
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/tasks/letsencrypt_tasks.rake

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+namespace :letsencrypt do
+  desc 'Renew the certificates will epxired'
+  task renew: :environment do
+    count = 0
+    failed = 0
+    LetsEncrypt::Certificate.renewable do |certificate|
+      count += 1
+      next if certificate.renew
+      failed += 1
+      log "Could not renew domain: #{certificate.domain}"
+    end
+
+    puts "Total #{count} domains should renew, and #{failed} domains cannot be renewed."
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rails-letsencrypt
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - 蒼時弦也
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: acme-client
   requirement: !ruby/object:Gem::Requirement
@@ -79,20 +79,23 @@ files:
 - app/controllers/lets_encrypt/application_controller.rb
 - app/controllers/lets_encrypt/verifications_controller.rb
 - app/jobs/lets_encrypt/application_job.rb
+- app/jobs/lets_encrypt/renew_certificates_job.rb
 - app/models/concerns/lets_encrypt/certificate_issuable.rb
 - app/models/concerns/lets_encrypt/certificate_verifiable.rb
-- app/models/lets_encrypt/application_record.rb
 - app/models/lets_encrypt/certificate.rb
 - config/routes.rb
-- db/migrate/20170510075353_create_lets_encrypt_certificates.rb
+- lib/generators/lets_encrypt/install_generator.rb
+- lib/generators/lets_encrypt/register_generator.rb
+- lib/generators/lets_encrypt/templates/migration.rb
 - lib/letsencrypt.rb
 - lib/letsencrypt/configuration.rb
 - lib/letsencrypt/engine.rb
 - lib/letsencrypt/logger_proxy.rb
+- lib/letsencrypt/railtie.rb
 - lib/letsencrypt/redis.rb
 - lib/letsencrypt/version.rb
 - lib/rails-letsencrypt.rb
-- lib/tasks/lets_encrypt_tasks.rake
+- lib/tasks/letsencrypt_tasks.rake
 homepage: https://github.com/elct9620/rails-letsencrypt
 licenses:
 - MIT

data/app/models/lets_encrypt/application_record.rb

@@ -1,5 +0,0 @@
-module LetsEncrypt
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end

data/db/migrate/20170510075353_create_lets_encrypt_certificates.rb

@@ -1,17 +0,0 @@
-class CreateLetsEncryptCertificates < ActiveRecord::Migration
-  def change
-    create_table :lets_encrypt_certificates do |t|
-      t.string :domain
-      t.text :certificate, limit: 65535
-      t.text :intermediaries, limit: 65535
-      t.text :key, limit: 65535
-      t.datetime :expires_at
-      t.datetime :renew_after
-      t.string :verification_path
-      t.string :verification_string
-
-      t.index :domain
-      t.timestamps
-    end
-  end
-end

data/lib/tasks/lets_encrypt_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :lets_encrypt do
-#   # Task goes here
-# end