acme_manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d9ddae0f05cc091f956174954b0b09ade18febb
+  data.tar.gz: 58ba851e02f8ca2c84c84db337a8e0594425f2ec
+SHA512:
+  metadata.gz: a59e3a3a7964018a394fa9049f7eeb32b66613af882f05f0ee541c8010b228f13308194c5196af7275e4304c97e73b34cfeb9e0d6f45c06f2486469b2a764be1
+  data.tar.gz: d39a859e35552e44f6a707f5821be91a59d0f302a9f8e235f008ee7a81143855e10a130d4eb805e0b446522dc4473fbeb8fe2dbe1b59c5d28e59eedf8fc41f86

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dan Wentworth
+
+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,101 @@
+# AcmeManager
+
+This is a client library for [acme-manager](https://github.com/atech/acme-manager), which is a tool to issue and manage letsencrypt certificates on a host.
+
+The library enables you to view the certificates currently managed by an instance of acme-manager, issue new certificates and provides an optional middleware to redirect letsencrypt domain verification requests to acme-manager.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acme_manager'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acme_manager
+
+## Configuration
+
+To configure the library you must configure the location of your acme-manager server and provide it's API key. You can do this with a configure block, or with the environment variables `ACME_MANAGER_HOST` and `ACME_MANAGER_API_KEY`.
+
+```ruby
+# config/initializers/acme_manager.rb
+AcmeManager.configure do |config|
+  config.host = 'https://acme-manager.example.com'
+  config.api_key = '1234567890'
+end
+```
+
+## Usage
+
+### Issuing a Certificate
+
+To issue a certificate call `AcmeManager.issue` this will return an object which indicates whether the request was successful, and what errors were received if it wasn't.
+
+```ruby
+issue_request = AcmeManager.issue('subdomain.example.com')
+issue_request.success?
+# => false
+issue_request.error
+# => "Error message raised by LE"
+```
+
+### Listing Certificates
+
+To get a list of existing certificates managed me acme-manager call `AcmeManager.list`. This will return an array of
+certificate objects.
+
+```ruby
+certificate = AcmeManager.list.first
+certificate.name
+# => "subdomain.example.com"
+certificate.not_after
+# => 2017-05-17 16:18:22 UTC
+certificate.expired?
+# => false
+```
+
+### Verification Request Proxying
+
+Acme-manager was designed to be run behind a load balancer, with any LetsEncrypt verification requests or requests to
+/~acmemanager being sent to it.
+
+If you're not lucky enough to have a load balancer that can siphon these requests for you, this library packs a
+middleware that you can use to proxy the verification requests. Instructions below are for Rails, if you need to
+include the middleware in another Rack app, you probably know what you're doing already.
+
+```ruby
+# config/application.rb
+# ...
+require 'acme_manager/middleware/forward_verification_challenge'
+
+module MyApp
+  class Application < Rails::Application
+    # ...
+    config.middleware.insert_before ActionDispatch::Static, AcmeManager::Middleware::ForwardVerificationChallenge
+    # ...
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/atech/acme-manager-client.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/acme_manager.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acme_manager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acme_manager"
+  spec.version       = AcmeManager::VERSION
+  spec.authors       = ["Dan Wentworth"]
+  spec.email         = ["dan@atechmedia.com"]
+
+  spec.summary       = "Client library for the acme-manager server"
+  spec.description   = "Provides a client library for interacting with the acme-manager server
+    (https://github.com/catphish/acme-manager) which assists with issuing lets-encrypt certificates"
+  spec.homepage      = "https://github.com/darkphnx/acme-manager-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "acme_manager"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/acme_manager.rb

@@ -0,0 +1,55 @@
+require "acme_manager/version"
+require "acme_manager/configuration"
+require "acme_manager/request"
+require "acme_manager/certificate"
+require "acme_manager/issue_request"
+
+module AcmeManager
+  class Error < StandardError; end;
+
+  # @return [Configuration] The current configuration (or new if uninitialized)
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  # Pass a block to configure the AcmeManager client
+  #
+  # @yieldparam [Configuration] Current configuration (see #config)
+  #
+  # @return [Configuration] Configuration after block has been called
+  def self.configure
+    yield config
+    config
+  end
+
+  # Get a list of certificates currently managed by the acme-manager
+  #
+  # @return [Array<Certificate>] List of certificates
+  def self.list
+    Certificate.all
+  end
+
+  # Instruct the acme-manager to issue a new certificate
+  #
+  # @param [String] name Domain name to issue a new certificate for
+  #
+  # @return [IssueRequest] Object containing result of the issue request
+  def self.issue(name)
+    IssueRequest.make(name)
+  end
+
+  def self.logger
+    @logger ||= begin
+      logger = Logger.new(config.log_path)
+      logger.level = config.log_level
+      logger
+    end
+  end
+
+  # Allow a custom logger to be set instead of configuring our own
+  #
+  # @param [Logger] new_logger Custom logger to set
+  def self.logger=(new_logger)
+    @logger = new_logger
+  end
+end

data/lib/acme_manager/certificate.rb

@@ -0,0 +1,28 @@
+module AcmeManager
+  # Represents a certificaate managed by acme-manager
+  class Certificate
+    attr_accessor :name, :not_after
+
+    # @param [String] name Domain name the certificate relates to
+    # @param [Time] not_after Timestamp representing the expiry time of the certificate
+    def initialize(name, not_after)
+      self.name = name
+      self.not_after = not_after
+    end
+
+    # Certificate is expired when we're past it's expiry time
+    def expired?
+      Time.now.utc > not_after
+    end
+
+    # Fetch a list of all certificates that acme-manager is currently managing
+    #
+    # @return [Array<Certificate>] All currently managed certificates
+    def self.all
+      Request.make('list').map do |cert_info|
+        AcmeManager.logger.info "Requesting list of certificates"
+        new(cert_info['name'], Time.iso8601(cert_info['not_after']))
+      end
+    end
+  end
+end

data/lib/acme_manager/configuration.rb

@@ -0,0 +1,34 @@
+module AcmeManager
+  # All global configuration for AcmeManager client
+  class Configuration
+    attr_writer :host, :api_key, :log_path, :log_level
+
+    # @return [String] The hostname where acme-manager is running. Set via accessor or by reading environment variable
+    #   ACME_MANAGER_HOST
+    #
+    # @raise [AcmeManager::Error] Raised when unconfigured
+    def host
+      @host || ENV['ACME_MANAGER_HOST'] || raise(Error, "`host` has not been configured. Set it using the " \
+        "`AcmeManager.configure` block or use the `ACME_MANAGER_HOST` environment variable")
+    end
+
+    # @return [String] The API key used to authenticate with acme-manager is running. Set via accessor or by reading
+    #   environment variable ACME_MANAGER_API_KEY
+    #
+    # @raise [AcmeManager::Error] Raised when unconfigured
+    def api_key
+      @api_key || ENV['ACME_MANAGER_API_KEY'] || raise(Error, "`api_key` has not been configured. Set it using the " \
+        "`AcmeManager.configure` block or use the `ACME_MANAGER_API_KEY` environment variable")
+    end
+
+    # @return [IO] Where log output should be written to. STDOUT by default.
+    def log_path
+      @log_path || STDOUT
+    end
+
+    # @return [Integer] Severity level to write logs at. Logger::WARNING by default.
+    def log_level
+      @log_level || Logger::WARNING
+    end
+  end
+end

data/lib/acme_manager/issue_request.rb

@@ -0,0 +1,48 @@
+module AcmeManager
+  # Handles the request and response associated with issuing a new certificate through acme-manager
+  class IssueRequest
+    SUCCESSFUL_RESULTS = %w(issued not_due).freeze
+
+    attr_reader :name, :success, :error_type, :error
+
+    # @param [String] name Domain name to issue a cert for
+    def initialize(name)
+      @name = name
+    end
+
+    # Convenience method for issuing a new certificate
+    #
+    # @param [String] name Domain name to issue a cert for
+    #
+    # @return [IssueRequest] A new instance after the request has been made
+    def self.make(name)
+      request = new(name)
+      request.make
+      request
+    end
+
+    # Send a request to acme-manager to issue a new certificate. If the request is a failure error_type and error will
+    # be set containing the failure details.
+    #
+    # @return [Boolean] true if the request was successful.
+    def make
+      AcmeManager.logger.info "Requesting certificate issue for '#{name}'"
+      response = Request.make("issue/#{name}")
+
+      if SUCCESSFUL_RESULTS.include?(response['result'])
+        AcmeManager.logger.info "Issue for '#{name}' successful"
+        @success = true
+      else
+        @error_type = response['reason']['type']
+        @error = response['reason']['detail']
+        AcmeManager.logger.warn "Issue for '#{name}' failed - #{error_type}, #{error}"
+        @success = false
+      end
+    end
+
+    # Was the request sucessful? This will return false if the request hasn't been made yet
+    def success?
+      !!@success
+    end
+  end
+end

data/lib/acme_manager/middleware/forward_verification_challenge.rb

@@ -0,0 +1,22 @@
+module AcmeManager
+  module Middleware
+    # If your setup is such that you cannot use a load-balancer to automatically syphon off LE requests to
+    # /.well-known/acme-challenge and direct them to acme-manager, you can use this middleware instead to act as a
+    # proxy between LE and acme-manager
+    class ForwardVerificationChallenge
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if env['PATH_INFO'] =~ %r{\A/.well-known/acme-challenge/}
+          AcmeManager.logger.info "Fowarding request to #{env['PATH_INFO']} to #{AcmeManager.config.host}"
+          result = Net::HTTP.get_response(URI("#{AcmeManager.config.host}#{env['PATH_INFO']}"))
+          [result.code.to_i, result.to_hash, [result.body]]
+        else
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/acme_manager/request.rb

@@ -0,0 +1,74 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module AcmeManager
+  # Simplify the process of making an API request to acme-manager
+  class Request
+    PATH_PREFIX = '~acmemanager/'.freeze
+
+    # @param [String] path The API call you wish to make. This will have PATH_PREFIX prepended to it when
+    #   making a request
+    def initialize(path)
+      @path = path
+    end
+
+    # Convenicence method to make a new instance and return the result of the request
+    #
+    # @param [String] path The API call you wish to make. See #new for more details.
+    def self.make(path)
+      new(path).make
+    end
+
+    # Make a request to the acme-manager API. Requests will be sent to the host defined in AcmeManager.config, and
+    # sent with the API key from the same configuration.
+    #
+    # Successfull responses are assumed to be in JSON format and are automatically parsed
+    #
+    # @return [Array, Hash] Parsed JSON data returned from the API
+    #
+    # @raise [Net::HTTPError] Raised when a non-2xx result is returned
+    def make
+      AcmeManager.logger.debug "Requesting #{request_uri}"
+
+      http = new_http_connection
+
+      request = Net::HTTP::Get.new(request_uri.path)
+      request['X-API-KEY'] = AcmeManager.config.api_key
+
+      result = http.request(request)
+
+      AcmeManager.logger.debug "Response Status: #{result.code}"
+      AcmeManager.logger.debug "Response Body:\n#{result.body}"
+
+      if result.is_a?(Net::HTTPSuccess)
+        JSON.parse(result.body)
+      else
+        AcmeManager.logger.warn "Request to #{request_uri} failed"
+        result.value
+      end
+    end
+
+    private
+
+    # Build a new connection object to the configured acme-manager host.
+    #
+    # @return [Net::HTTP] Connection object
+    def new_http_connection
+      http = Net::HTTP.start(request_uri.host, request_uri.port)
+      if request_uri.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+
+      http
+    end
+
+    # Build a complete URL for the request and parse it with URI
+    #
+    # @return [URI::HTTP] Parsed request URI
+    def request_uri
+      @request_uri ||= URI("#{AcmeManager.config.host}/#{PATH_PREFIX}#{@path}")
+    end
+  end
+end

data/lib/acme_manager/version.rb

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

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: acme_manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Wentworth
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  Provides a client library for interacting with the acme-manager server
+      (https://github.com/catphish/acme-manager) which assists with issuing lets-encrypt certificates
+email:
+- dan@atechmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acme_manager.gemspec
+- bin/console
+- bin/setup
+- lib/acme_manager.rb
+- lib/acme_manager/certificate.rb
+- lib/acme_manager/configuration.rb
+- lib/acme_manager/issue_request.rb
+- lib/acme_manager/middleware/forward_verification_challenge.rb
+- lib/acme_manager/request.rb
+- lib/acme_manager/version.rb
+homepage: https://github.com/darkphnx/acme-manager-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Client library for the acme-manager server
+test_files: []