acmesmith-google-cloud-dns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a46d6d5a3f556dcb149e5708306c1b111a9c5006
+  data.tar.gz: 4eb78bbe978413c07707404445ddf1fe9faabb11
+SHA512:
+  metadata.gz: baf9ce852a5e74ba05547593d76dfff9183f14104772ece7ed691701fcbaa79f57f7b9504a5f28e350523683e5eb2e367fc90cde0b5f041331276e853a531132
+  data.tar.gz: 30e8fa2c3bd938b1fe4da69ae9241963eeae8fcf87801e0d68ec4522a55d34c3f820c644dbbe0c5d350ee8f7ce6bc0d0d7c0436b741ec72361bab67d180be436

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle
+/acmesmith.yml
+/storage

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,41 @@
+# acmesmith-google-cloud-dns
+
+This gem is a plugin for [Acmesmith](https://github.com/sorah/acmesmith) and implements an automated `dns-01` challenge responder using Google Cloud DNS.
+
+With this plugin and Acmesmith, you can automate to authorize your domain hosted on [Google Cloud DNS](https://cloud.google.com/dns/) and request TLS certificates for the domains against [Let's Encrypt](https://letsencrypt.org/) and other CAs supporting the ACME protocol.
+
+## Usage
+### Prerequisites
+- You need to have control of your domain name to change its authoritative nameservers.
+- You need to have service account of Google Cloud Platform to operate Google Cloud DNS via API.
+
+### Preparation
+- Ask your DNSaaS provider to host a zone for your domain name. They will tell you the DNS content servers that host the zone.
+- Ask your domain registrar to set the authoritative nameservers of your domain to the content servers provided by the DNSaaS.
+
+### Installation
+Install `acmesith-google-cloud-dns` gem along with `acmesmith`. You can just do `gem install acmesith-google-cloud-dns` or use Bundler if you want.
+
+### Configuration
+Use `google-cloud-dns` challenge responder in your `acmesmith.yml`. General instructions about `acmesmith.yml` is available in the manual of Acmesmith.
+
+Write your `tenant_name`, `username`, `password` and `auth_url` in `acmesmith.yml`, or if you don't want to write them down into the file, export these values as the corresponding environment variables `OS_TENANT_NAME`, `OS_USERNAME`, `OS_PASSWORD` and `OS_AUTH_URL`.
+
+```yaml
+endpoint: https://acme-v01.api.letsencrypt.org/
+
+storage:
+  type: filesystem
+  path: /path/to/key/storage
+
+challenge_responders:
+  - google_cloud_dns:
+      project_id: my-project-id # GCP Project ID. Be careful it's different from Project Name.
+      compute_engine_service_account: true # (pick-one): You can use GCE VM instance scope
+      private_key_json_file: /path/to/credential.json # (pick-one) Only JSON key file is supported
+      ttl: 5  # (optional) long TTL hinders re-authorization, but a DNSaaS provider may restrict short TTL
+```
+
+## 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/acmesmith-google-cloud-dns.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-google-cloud-dns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acmesmith-google-cloud-dns"
+  spec.version       = AcmesmithGoogleCloudDns::VERSION
+  spec.authors       = ["Chikanaga Tomoyuki"]
+  spec.email         = ["nagachika@ruby-lang.org"]
+
+  spec.summary       = %q{acmesmith plugin implementing dns-01 using Google Cloud DNS}
+  spec.description   = %q{This gem is a plugin for acmesmith and implements an automated dns-01 challenge responder using Google Cloud DNS}
+  spec.homepage      = "https://github.com/nagachika/acmetmith-google-cloud-dns"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "acmesmith"
+  spec.add_dependency "google-api-client", "~> 0.9.1"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  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 "acmesmith/challenge_responders/google_cloud_dns"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/acmesmith-google-cloud-dns/version.rb

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

data/lib/acmesmith/challenge_responders/google_cloud_dns.rb

@@ -0,0 +1,122 @@
+require "acmesmith/challenge_responders/base"
+
+require "json"
+require "google/apis/dns_v1"
+require "resolv"
+
+module Acmesmith
+  module ChallengeResponders
+    class GoogleCloudDns < Base
+      def support?(type)
+        type == 'dns-01'
+      end
+
+      def initialize(config)
+        @config = config
+        @scope = "https://www.googleapis.com/auth/ndev.clouddns.readwrite"
+        @api = Google::Apis::DnsV1::DnsService.new
+        if @config[:compute_engine_service_account]
+          @api.authorization = Google::Auth.get_application_default(@scope)
+        elsif @config[:private_key_json_file]
+          credential = load_json_key(@config[:private_key_json_file])
+          @api.authorization = Signet::OAuth2::Client.new(
+            token_credential_uri: "https://accounts.google.com/o/oauth2/token",
+            audience: "https://accounts.google.com/o/oauth2/token",
+            scope: @scope,
+            issuer: credential[:email_address],
+            signing_key: credential[:private_key])
+        else
+          raise "You need to specify authentication options (compute_engine_service_account or private_key_json_file)"
+        end
+        @api.authorization.fetch_access_token!
+        @project_id = @config[:project_id]
+      end
+
+      def respond(domain, challenge)
+        puts "=> Responding challenge dns-01 for #{domain} in #{self.class.name}"
+
+        domain = canonicalize(domain)
+        zone_name = find_managed_zone(domain).name
+
+        puts " * create_change: #{challenge.record_type} #{[challenge.record_name, domain].join('.').inspect}, #{challenge.record_content.inspect}"
+        change = Google::Apis::DnsV1::Change.new
+        change.additions = [
+          resource_record_set(domain, challenge)
+        ]
+        resp = @api.create_change(@project_id, zone_name, change)
+
+        change_id = resp.id
+        puts " * requested change: #{change_id}"
+
+        while resp.status != 'done'
+          puts " * change #{change_id.inspect} is still #{resp.status.inspect}"
+          sleep 5
+          resp = @api.get_change(@project_id, zone_name, change_id)
+        end
+
+        puts " * synced!"
+
+        puts "=> Checking DNS resource record"
+        nameservers =  @api.get_managed_zone(@project_id, zone_name).name_servers
+        puts " * nameservers: #{nameservers.inspect}"
+        nameservers.each do |ns|
+          Resolv::DNS.open(:nameserver => Resolv.getaddresses(ns)) do |dns|
+            dns.timeouts = 5
+            begin
+              ret = dns.getresource([challenge.record_name, domain].join('.'), Resolv::DNS::Resource::IN::TXT)
+            rescue Resolv::ResolvError => e
+              puts " * [#{ns}] failed: #{e.to_s}"
+              sleep 5
+              retry
+            end
+            puts " * [#{ns}] success: ttl=#{ret.ttl.inspect}, data=#{ret.data.inspect}"
+            sleep 1
+          end
+        end
+      end
+
+      def cleanup(domain, challenge)
+        domain = canonicalize(domain)
+        zone_name = find_managed_zone(domain).name
+        change = Google::Apis::DnsV1::Change.new
+        change.deletions = [
+          resource_record_set(domain, challenge)
+        ]
+        @api.create_change(@project_id, zone_name, change)
+      end
+
+      private
+
+      def load_json_key(filepath)
+        obj = JSON.parse(File.read(filepath))
+        {
+          email_address: obj["client_email"],
+          private_key: OpenSSL::PKey.read(obj["private_key"]),
+        }
+      end
+
+      def canonicalize(domain)
+        "#{domain}.".gsub(/\.{2,}/, '.')
+      end
+
+      def find_managed_zone(domain)
+        managed_zone = @api.list_managed_zones(@project_id).managed_zones.select do |zone|
+          /(?:\A|\.)#{Regexp.escape(zone.dns_name)}\z/ =~ domain
+        end.max_by{|z| z.dns_name.size }
+        if managed_zone.nil?
+          raise "Domain #{domain} is not managed in Google Cloud DNS [project_id=#{@project_id}]"
+        end
+        managed_zone
+      end
+
+      def resource_record_set(domain, challenge)
+        Google::Apis::DnsV1::ResourceRecordSet.new(
+          name: [challenge.record_name, domain].join("."),
+          type: challenge.record_type,
+          rrdatas: [challenge.record_content],
+          ttl: @config[:ttl] || 5
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: acmesmith-google-cloud-dns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chikanaga Tomoyuki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-28 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: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: This gem is a plugin for acmesmith and implements an automated dns-01
+  challenge responder using Google Cloud DNS
+email:
+- nagachika@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- acmesmith-google-cloud-dns.gemspec
+- bin/console
+- bin/setup
+- lib/acmesmith-google-cloud-dns/version.rb
+- lib/acmesmith/challenge_responders/google_cloud_dns.rb
+homepage: https://github.com/nagachika/acmetmith-google-cloud-dns
+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.5.1
+signing_key: 
+specification_version: 4
+summary: acmesmith plugin implementing dns-01 using Google Cloud DNS
+test_files: []