capistrano-lets-encrypt 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90da1a49714e482b35e657c3224aec74936e259a
-  data.tar.gz: 328392b3bec296ed09b6a37444d04c378dbf760a
+  metadata.gz: de66e730ca0dcec1a728877a7f32043b749d5791
+  data.tar.gz: be723601fc953f0aa0598b01b323949f1519f59f
 SHA512:
-  metadata.gz: 9814cac7056f473ec0f840277ad14b8387a9156743a1ad8b87c26df2dad5cd691f8318666ac40fcf6278631887f15a337c95b6f768563e911f8a6484acd0e183
-  data.tar.gz: 2c9c2fdcba8fc3a44c0406841d3d95b220111e47f422cb69e18fd3856d6662366f42278d84a1a4bb2d2debad438dc3cc77455f60525e8bebabb05aa3a4a3e3f8
+  metadata.gz: bb1a2c4e7fb237c2d1bcabff6baa9946ce75f66dbfdae6262567c2bddf862b342e016e9923ccca18944ee72800e939cec0e36f820c16bd3fa480a598419fcf2d
+  data.tar.gz: ef87c42ba5ef686a4d86e7fd4eaaf61a3a45d38d41f642ad12eb0feefbc5f70da43d8de1a1730431871cc086c54b1795024b7f84d41ed9f9a0358eb76443333c

data/README.md

@@ -4,7 +4,7 @@ Let's encrypt support for Capistrano 3.x
 
 Thanks to @unixcharles and @zealot128 for their libraries,
 [acme-client](https://github.com/unixcharles/acme-client/) and
-[letsencrypt-cli](https://github.com/zealot128/ruby-letsencrypt-cli) to manage
+[letsencrypt-cli](https://github.com/zealot128/ruby-letsencrypt-cli) for managing
 part of the workflow to work with Let's encrypt. This library use both to create
 a series of capistrano tasks that should help you create certs on your projects
 deployed with capistrano
@@ -13,7 +13,7 @@ deployed with capistrano
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano-lets-encrypt', '~> 1.0'
+    gem 'capistrano-lets-encrypt'
     gem 'capistrano'
 
 And then execute:
@@ -44,32 +44,48 @@ cap lets_encrypt:cert                # Create certificates and private keys
 Configurable options (copy into deploy.rb), shown here with examples:
 
 ```ruby
+# Set the roles where the let's encrypt process should be started
+# Be sure at least one server has primary: true
 # default value: :web
 set :lets_encrypt_roles, :lets_encrypt
 
+# Optionally set the user to use when installing on the remote system
+# default value: nil
+set :lets_encrypt_user, nil
+
+# Set it to true to use let's encrypt staging servers
 # default value: false
 set :lets_encrypt_test, true
 
+# Set your let's encrypt account email (required)
+# The account will be created if no private key match
 # default value: nil
 set :lets_encrypt_email, nil
 
+# Set the path to your let's encrypt account private key
+# default value: "#{fetch(:lets_encrypt_email)}.account_key.pem"
+set :lets_encrypt_account_key, "#{fetch(:lets_encrypt_email)}.account_key.pem"
+
+# Set the domains you want to register (required)
+# This must be a string of one or more domains separated a space - e.g. "example.com example2.com"
 # default value: nil
 set :lets_encrypt_domains, nil
 
+# Set the path from where you are serving your static assets
 # default value: "#{release_path}/public"
 set :lets_encrypt_challenge_public_path, "#{release_path}/public"
 
+# Set the path where the new certs are going to be saved
 # default value: "#{shared_path}/ssl/certs"
 set :lets_encrypt_output_path, "#{shared_path}/ssl/certs"
 
-# default value: "#{fetch(:lets_encrypt_email)}.account_key.pem"
-set :lets_encrypt_account_key, "#{fetch(:lets_encrypt_email)}.account_key.pem"
-
-# default value: 30
-set :lets_encrypt_days_valid, 30
-
+# Set the local path where the certs will be saved
 # default value: "~/certs"
 set :lets_encrypt_local_output_path, "~/certs"
+
+# Set the minimum time that the cert should be valid
+# default value: 30
+set :lets_encrypt_days_valid, 15
 ```
 
 ## Requirements
@@ -86,7 +102,7 @@ This tool needs Ruby >= 2.1 (as the dependency acme-client needs that because of
 
 ## Credits
 
-Thank you [contributors](https://github.com/platanus/capistran-lets-encrypt/graphs/contributors)!
+Thank you [contributors](https://github.com/platanus/capistrano-lets-encrypt/graphs/contributors)!
 
 <img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
 

data/capistrano-lets-encrypt.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "capistrano-lets-encrypt"
-  spec.version       = "0.2.0"
+  spec.version       = "0.3.0"
   spec.authors       = ["Juan Ignacio Donoso"]
   spec.email         = ["juan.ignacio@platan.us"]
   spec.summary       = %q{Adds support for let's encrypt to Capistrano 3.x}

data/lib/capistrano/tasks/lets-encrypt.rake

@@ -1,5 +1,6 @@
 require 'openssl'
 require 'letsencrypt/cli/acme_wrapper'
+require 'colorize'
 
 namespace :lets_encrypt do
 
@@ -61,34 +62,36 @@ namespace :lets_encrypt do
   end
 
   def authorize(domain)
-    wrapper.log "Authorizing #{domain.blue}."
-    authorization = client.authorize(domain: domain)
+    as_encrypt_user do
+      wrapper.log "Authorizing #{domain.blue}."
+      authorization = client.authorize(domain: domain)
 
-    challenge = authorization.http01
-    challenge_public_path = fetch(:lets_encrypt_challenge_public_path)
-    challenge_path = File.join(challenge_public_path, File.dirname(challenge.filename))
-    challenge_file_path = File.join(challenge_public_path, challenge.filename)
-    execute :mkdir, '-pv', challenge_path
+      challenge = authorization.http01
+      challenge_public_path = fetch(:lets_encrypt_challenge_public_path)
+      challenge_path = File.join(challenge_public_path, File.dirname(challenge.filename))
+      challenge_file_path = File.join(challenge_public_path, challenge.filename)
+      execute :mkdir, '-pv', challenge_path
 
-    wrapper.log "Writing challenge to #{challenge_file_path}", :debug
+      wrapper.log "Writing challenge to #{challenge_file_path}", :debug
 
-    execute :echo, "\"#{challenge.file_content}\" > #{challenge_file_path}"
+      execute :echo, "\"#{challenge.file_content}\" > #{challenge_file_path}"
 
-    challenge.request_verification
+      challenge.request_verification
 
-    5.times do
-      wrapper.log "Checking verification...", :debug
-      sleep 1
-      break if challenge.verify_status != 'pending'
-    end
-    if challenge.verify_status == 'valid'
-      wrapper.log "Authorization successful for #{domain.green}"
-      execute :rm, '-f', challenge_file_path
-      true
-    else
-      wrapper.log "Authorization error for #{domain.red}", :error
-      wrapper.log challenge.error['detail']
-      false
+      5.times do
+        wrapper.log "Checking verification...", :debug
+        sleep 1
+        break if challenge.verify_status != 'pending'
+      end
+      if challenge.verify_status == 'valid'
+        wrapper.log "Authorization successful for #{domain.green}"
+        execute :rm, '-f', challenge_file_path
+        true
+      else
+        wrapper.log "Authorization error for #{domain.red}", :error
+        wrapper.log challenge.error['detail']
+        false
+      end
     end
   end
 
@@ -100,11 +103,29 @@ namespace :lets_encrypt do
   end
 
   def upload_certs(domain)
-    execute :mkdir, '-pv', "#{fetch(:lets_encrypt_output_path)}/#{domain}"
-    upload! local_private_key_path, private_key_path
-    upload! local_fullchain_path, fullchain_path
-    upload! local_certificate_path, certificate_path
-    upload! local_chain_path, chain_path
+    as_encrypt_user do
+      execute :mkdir, '-pv', "#{fetch(:lets_encrypt_output_path)}/#{domain}"
+      safe_upload! local_private_key_path, private_key_path
+      safe_upload! local_fullchain_path, fullchain_path
+      safe_upload! local_certificate_path, certificate_path
+      safe_upload! local_chain_path, chain_path
+    end
+  end
+
+  def as_encrypt_user(&block)
+    if fetch(:lets_encrypt_user)
+      as fetch(:lets_encrypt_user) do
+        yield
+      end
+    else
+      yield
+    end
+  end
+
+  def safe_upload!(from, to)
+    tempname = "/tmp/#{Time.now.to_f}"
+    upload! from, tempname
+    sudo :mv, tempname, to
   end
 
   # Helpers
@@ -158,7 +179,7 @@ namespace :lets_encrypt do
 
   def options
     @options ||= {
-      account_key: fetch(:lets_encrypt_account_key),
+      account_key: File.expand_path(fetch(:lets_encrypt_account_key)),
       test: fetch(:lets_encrypt_test),
       log_level: "info",
       color: true,

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-lets-encrypt
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Juan Ignacio Donoso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-28 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: letsencrypt-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 description: Adds support for let's encrypt to Capistrano 3.x
@@ -59,7 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -78,19 +78,18 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Adds support for let's encrypt to Capistrano 3.x
 test_files: []
-has_rdoc: