acmesmith 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 881527f31c9c553cd24f871fdf3096f69d9ae7ae
-  data.tar.gz: 5baeb24754042ddbfbe1cd64f15e7c617d293770
+  metadata.gz: acb392ec6aa3ec962ef269435f61e0eee59191bb
+  data.tar.gz: 54e3498de72de66e12af34fd7cdeafeb0aad6530
 SHA512:
-  metadata.gz: 2334b213b01c42a9a751bf7264b66b2c154363c3fd01ec6977b4c519609177cb6dfeb0aa971942553a4bc449b2a5fae39694db557853750884dce2620b6ed225
-  data.tar.gz: eef530c96908705825f82fed413f36fd86e59eb5449471ab1e088ca8854b4fa5b2c9bc8aa4383e39120cd6df5bd367d84c38758c3fbf3a2e64f2dcaaa8832f10
+  metadata.gz: 7c9d77926eb2cca01db936ac89cacdf6b71779f743c0af3dbeeeb43af781bb62f065e20e65b0e44fdfc93a2c0f4c84f9a597d112c1d482cf645d45495170d6b7
+  data.tar.gz: 2ca4345dc71166a781b58e869c4fb3dd086f29fb118c3d54d1329be2c28810ea1901d6ca1389ff0ca2476769a18f3abfb2b0040f032836a713505dbb2ae85822

data/README.md

@@ -10,12 +10,10 @@ This tool is written in Ruby, but Acmesmith saves certificates in simple scheme,
 - ACME registration, domain authorization, certificate requests 
   - Tested against [Let's encrypt](https://letsencrypt.org)
 - Storing keys in several ways
-  - Currently AWS S3 is supported
 - Challenge response
-  - Currently `dns-01` with AWS Route 53 is supported
-- Pluggable modules, you can use 3rd party one or write:
-  - Storages for other than AWS S3
-  - Challenge reponses for other than AWS Route53 or dns-01 challenges, like for Openstack DNSaaS.
+- Many cloud services support
+  - AWS S3 storage and Route53 `dns-01` responder support out-of-the-box
+  - 3rd party plugins available for OpenStack designate, Google Cloud DNS, simple http-01, and Google Cloud Storage. See [Plugins](#3rd-party-plugins) below
 
 ### Planned
 
@@ -141,12 +139,34 @@ challenge_responders:
       #   "example.org.": "/hostedzone/DEADBEEF"
 ```
 
+### Post Issueing Hooks
+
+Post issueing hooks are configurable actions that are executed
+when a new certificate has been succesfully issued. The hooks are
+sequentially executed in the same order as they are configured, and they
+are configurable per certificate's common-name.
+
+Currently `shell` action is available out of the box. It sets `COMMON_NAME` environment variable for use in a script.
+
+```
+post_issueing_hooks:
+  "test.example.com":
+    - shell:
+        command: mail -s "New cert for ${COMMON_NAME} has been issued" user@example.com < /dev/null
+    - shell:
+        command: touch /tmp/certs-has-been-issued-${COMMON_NAME}
+  "admin.example.com":
+    - shell:
+        command: /usr/bin/dosomethingelse ${COMMON_NAME}
+```
+
 ## 3rd party Plugins
 
 ### Challenge responders
 
 - [hanazuki/acmesmith-designate](https://github.com/hanazuki/acmesmith-designate) `dns-01` challenge responder with OpenStack-based DNSaaS (Designate v1 API), e.g. for ConoHa.
 - [nagachika/acmesmith-google-cloud-dns](https://github.com/nagachika/acmesmith-google-cloud-dns) `dns-01` challenge responder with [Google Cloud DNS](https://cloud.google.com/dns/).
+- [mipmip/acmesmith-http-path](https://github.com/mipmip/acmesmith-http-path) - `http-01` challenge reponder if you have write access to the vhost server root.
 
 ### Storage
 

data/lib/acmesmith/command.rb

@@ -64,7 +64,15 @@ module Acmesmith
 
       puts cert.certificate.to_text
       puts cert.certificate.to_pem
+
+      execute_post_issue_hooks(common_name)
+    end
+
+    desc "post-issue-hooks COMMON_NAME", "Run all post-issueing hooks for common name. (for testing purpose)"
+    def post_issue_hooks(common_name)
+      execute_post_issue_hooks(common_name)
     end
+    map 'post-issue-hooks' => :post_issue_hooks
 
     desc "list [COMMON_NAME]", "list certificates or its versions"
     def list(common_name = nil)
@@ -156,7 +164,7 @@ module Acmesmith
     end
 
     desc "autorenew", "request renewal of certificates which expires soon"
-    method_option :days, aliases: %w(-d), default: 7, desc: 'specify threshold in days to select certificates to renew'
+    method_option :days, type: :numeric, aliases: %w(-d), default: 7, desc: 'specify threshold in days to select certificates to renew'
     def autorenew
       storage.list_certificates.each do |cn|
         puts "=> #{cn}"
@@ -214,5 +222,15 @@ module Acmesmith
         config['account_key_passphrase']
       end
     end
+
+    def execute_post_issue_hooks(common_name)
+      post_issues_hooks_for_common_name = config.post_issueing_hooks(common_name)
+      if post_issues_hooks_for_common_name
+        post_issues_hooks_for_common_name.each do |hook|
+          hook.execute
+        end
+      end
+    end
+
   end
 end

data/lib/acmesmith/config.rb

@@ -1,6 +1,7 @@
 require 'yaml'
 require 'acmesmith/storages'
 require 'acmesmith/challenge_responders'
+require 'acmesmith/post_issueing_hooks'
 
 module Acmesmith
   class Config
@@ -42,8 +43,22 @@ module Acmesmith
       end
     end
 
+    def post_issueing_hooks(common_name)
+      @post_issueing_hooks ||= begin
+        if @config.key?('post_issueing_hooks') && @config['post_issueing_hooks'].key?(common_name)
+          specs = @config['post_issueing_hooks'][common_name]
+          specs.flat_map do |specs_sub|
+            specs_sub[specs_sub.flatten[0]]['common_name'] = common_name
+            specs_sub.map do |k, v|
+              PostIssueingHooks.find(k).new(**v.map{ |k_,v_| [k_.to_sym, v_]}.to_h)
+            end
+          end
+        end
+      end
+    end
+
     def challenge_responders
-      @challange_responders ||= begin
+      @challenge_responders ||= begin
         specs = @config['challenge_responders'].kind_of?(Hash) ? @config['challenge_responders'].map { |k,v| [k => v] } : @config['challenge_responders']
         specs.flat_map do |specs_sub|
           specs_sub.map do |k, v|

data/lib/acmesmith/post_issueing_hooks/base.rb

@@ -0,0 +1,14 @@
+module Acmesmith
+  module PostIssueingHooks
+    class Base
+      def initialize
+      end
+
+      def execute(domain)
+        raise NotImplementedError
+      end
+
+    end
+  end
+end
+

data/lib/acmesmith/post_issueing_hooks/shell.rb

@@ -0,0 +1,33 @@
+require 'open3'
+require 'acmesmith/post_issueing_hooks/base'
+
+module Acmesmith
+  module PostIssueingHooks
+    class Shell < Base
+      class HostedZoneNotFound < StandardError; end
+      class AmbiguousHostedZones < StandardError; end
+
+      def initialize(common_name:, command:, ignore_failure:false)
+        @common_name = common_name
+        @command = command
+        @ignore_failure = ignore_failure
+      end
+
+      def execute
+        puts "=> Executing Post Issueing Hook for #{@common_name} in #{self.class.name}"
+        puts "=> ENV: COMMON_NAME=#{@common_name}"
+        puts "=> Running: #{@command}"
+
+        status = system({"COMMON_NAME" => @common_name}, "#{@command};")
+
+        unless status
+          if @ignore_failure
+            $stderr.puts "WARNING, command failed"
+          else
+            raise "FATAL, command failed"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/acmesmith/post_issueing_hooks.rb

@@ -0,0 +1,9 @@
+require 'acmesmith/utils/finder'
+
+module Acmesmith
+  module PostIssueingHooks
+    def self.find(name)
+      Utils::Finder.find(self, 'acmesmith/post_issueing_hooks', name)
+    end
+  end
+end

data/lib/acmesmith/version.rb

@@ -1,3 +1,3 @@
 module Acmesmith
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acmesmith
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - sorah (Shota Fukumori)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acme-client
@@ -126,6 +126,9 @@ files:
 - lib/acmesmith/challenge_responders/route53.rb
 - lib/acmesmith/command.rb
 - lib/acmesmith/config.rb
+- lib/acmesmith/post_issueing_hooks.rb
+- lib/acmesmith/post_issueing_hooks/base.rb
+- lib/acmesmith/post_issueing_hooks/shell.rb
 - lib/acmesmith/storages.rb
 - lib/acmesmith/storages/base.rb
 - lib/acmesmith/storages/filesystem.rb
@@ -154,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: ACME client (Let's encrypt client) to manage certificate in multi server