acmesmith-http-path 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51783feaaae9246c7f6782902620415a1d390370
+  data.tar.gz: 7ddb0bb95c259ccb5cebd3609aa4d048e6a12672
+SHA512:
+  metadata.gz: 56d56fa58db5ef6a630bd84dc0f6432600bcdfdb168486682851e25c8952edfac948fbe216b676e8f5e26f090eec058297347fbe76ab88c57f7e8f57f3cbc152
+  data.tar.gz: 8a7a57930790b6501e8a2c986130f58f18e2fc254634684896b45f8c0722d5dfd33f9ecaf0a1e3521ef5b50ea85bdece0c09911fe11c6170e45dbf34e5e3a5c9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.13.6
+addons:
+  code_climate:
+    repo_token: 2b4761915a80ac4ebbb6d2536ecd174eb5aa3d78e4301d9a331a7551401e2802
+# regular test configuration
+after_success:
+  - bundle exec codeclimate-test-reporter

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pim@lingewoud.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acmesmith-http-path.gemspec
+gemspec
+
+gem "simplecov"
+gem "codeclimate-test-reporter", "~> 1.0.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pim Snel
+
+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,71 @@
+# acmesmith-http-path
+
+[![Build Status](https://travis-ci.org/mipmip/acmesmith-http-path.svg?branch=master)](https://travis-ci.org/mipmip/acmesmith-http-path)
+[![Code Climate](https://codeclimate.com/github/mipmip/acmesmith-http-path/badges/gpa.svg)](https://codeclimate.com/github/mipmip/acmesmith-http-path)
+[![Test Coverage](https://codeclimate.com/github/mipmip/acmesmith-http-path/badges/coverage.svg)](https://codeclimate.com/github/mipmip/acmesmith-http-path/coverage)
+
+This gem is a plugin for [Acmesmith](https://github.com/sorah/acmesmith)
+and implements an automated `http-01` challenge responder.
+
+## Usage
+
+### Prerequisites
+- You need to have write access to the docroot of your webserver vhost
+
+### Installation Install `acmesith-http-path` gem along with
+`acmesmith`. You can just do `gem install acmesith-http-path` or use
+Bundler if you want.
+
+### Configuration Use `http_path` challenge responder in your
+`acmesmith.yml`. General instructions about `acmesmith.yml` is available
+in the manual of Acmesmith.
+
+In the configuration you need to configure every domain seperately. The
+`htdocs_path` key should point to the root path of your domain website.
+
+```yaml
+endpoint: https://acme-v01.api.letsencrypt.org/
+
+storage:
+  type: filesystem
+  path: /path/to/key/storage
+
+challenge_responders:
+  - http_path:
+      "domain-one.com":
+        htdocs_path: /var/www/domain-one.com/public_html
+      "second-domain.com":
+        htdocs_path: /var/www/second-domain.com/public_html
+```
+
+you may want to use the post_issueing_hooks configuration to copy
+the certificates to the correct location and perhaps reload the webserver
+configuration.
+
+### Domain authorization and certificate requests
+
+You are instructed how to use Acmesmith in its documentaion. Here are
+just example command lines to authorize `domain-one.com` and request a
+certificate for it.
+
+```sh
+vi acmesmith.yml
+acmesmith register mailto:your.mail.address@example.net
+acmesmith authorize domain-one.com
+acmesmith request domain-one.com
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/acmesmith-http-path. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/acmesmith-http-path.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acmesmith-http-path/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acmesmith-http-path"
+  spec.version       = AcmesmithHttpPath::VERSION
+  spec.authors       = ["Pim Snel"]
+  spec.email         = ["pim@lingewoud.nl"]
+
+  spec.summary       = %q{AcmeSmith ChallengeResponders plugin for validating by http-01}
+  spec.description   = %q{AcmeSmith ChallengeResponders plugin for validating with letsencrypt by http-01 on a local machine}
+  spec.homepage      = "https://github.com/mipmip/acmesmith-http-path"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "acmesmith"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov", "~> 0.12"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "acmesmith/http/path"
+
+# 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

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/acmesmith-http-path/version.rb

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

data/lib/acmesmith/challenge_responders/http_path.rb

@@ -0,0 +1,38 @@
+require 'acmesmith/challenge_responders/base'
+
+module Acmesmith
+  module ChallengeResponders
+    class HttpPath < Base
+
+      def support?(type)
+        type == 'http-01'
+      end
+
+      def initialize(config)
+        @config = config
+      end
+
+      def respond(domain, challenge)
+        puts "=> Responding challenge http-01 for #{domain} in #{self.class.name}"
+        FileUtils.mkdir_p( File.join( htdocs_path(domain), File.dirname( challenge.filename ) ) )
+        File.write( File.join( htdocs_path(domain), challenge.filename), challenge.file_content )
+      end
+
+      def cleanup(domain, challenge)
+        puts "=> Cleanup challenge http-01 for #{domain} in #{self.class.name}"
+        FileUtils.rm_r( File.join( htdocs_path(domain), File.dirname( challenge.filename ) ) )
+      end
+
+      def htdocs_path(domain)
+        begin
+          htdocs_path = @config[domain.to_sym]['htdocs_path']
+        rescue
+          raise "cannot read configuration for http_path"
+        end
+
+        htdocs_path
+      end
+
+    end
+  end
+end

data/lib/http_path.rb

@@ -0,0 +1 @@
+require 'acmesmith/challenge_responders/http_path'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: acmesmith-http-path
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pim Snel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: acmesmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: AcmeSmith ChallengeResponders plugin for validating with letsencrypt
+  by http-01 on a local machine
+email:
+- pim@lingewoud.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acmesmith-http-path.gemspec
+- bin/console
+- bin/setup
+- lib/acmesmith-http-path/version.rb
+- lib/acmesmith/challenge_responders/http_path.rb
+- lib/http_path.rb
+homepage: https://github.com/mipmip/acmesmith-http-path
+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.4.8
+signing_key: 
+specification_version: 4
+summary: AcmeSmith ChallengeResponders plugin for validating by http-01
+test_files: []