acmesmith-ns1 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a78e9feeca154a78c89dfbab1a2bdfbe44a6480d856d466d3412f0727bbb2b2
+  data.tar.gz: 624e8bf9b35f7d5066763f8a91b976ff270cb7675f1f7481e985597ffb11fe8b
+SHA512:
+  metadata.gz: 2581375c8e69540d1ac61af348d1d11e1690c634ab7179baa3ab33424a9381b65e2541934bb55819d8e5bee1a9594c1dc5c4b6e5e2ec2a361ef7c0fe4204056b
+  data.tar.gz: b143b0753e39a8d56f60a8ba48225c9d279ff4abc98f9b78468a53291a9fa4811edcfdf254843fb37ddc21f6f457fda2e5f787f5c03bd7d2f6672561b6e65bbd

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'rest-client'
+gem 'ns-1'
+gem 'json'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 benkap
+
+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,43 @@
+# acmesmith-ns1
+
+A plugin for [Acmesmith](https://github.com/sorah/acmesmith) and implements an automated `dns-01` challenge responder using NS1 API.
+
+With this plugin and Acmesmith, you can automate and authorize your domain hosted on [NS1 Portal](https://my.nsone.net) and request TLS certificates for the domains against [Let's Encrypt](https://letsencrypt.org/) and other CAs supporting the ACME protocol.
+
+For more infromation on NS1 API - [API Documentation](https://ns1.com/api)
+NS1 calls are managed by `ns-1` gem see [ns-1](https://rubygems.org/gems/ns-1)
+
+## Usage
+### Prerequisites
+- You need to issue an API token from your [NS1 Portal](https://my.nsone.net).
+- And attached the relevant permissions to the API token
+
+### Installation
+Install `acmesith-ns1` gem along with `acmesmith`. You can just do `gem install acmesith-ns1` or use Bundler if you want.
+
+### Configuration
+Use `ns1` challenge responder in your `acmesmith.yml`. General instructions about `acmesmith.yml` is available in the manual of [Acmesmith](https://github.com/sorah/acmesmith).
+
+The mandatory options for the `acmesmith.yml` (Or other file specified from command line) are:
+ - token: `NS1 API Token`
+
+ Optional option is:
+  - ttl: `Integer` -> Where default TTL is 3600 if this option is omitted.
+
+```yaml
+---
+directory: https://acme-v02.api.letsencrypt.org/directory
+
+storage:
+  type: filesystem
+  path: /path/to/key/storage
+
+challenge_responders:
+  - ns1:
+      token: "API_TOKEN" # (required)
+      ttl: 60 # (optional)
+```
+
+## 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-ns1.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acmesmith-ns1/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'acmesmith-ns1'
+  spec.version       = AcmesmithNS1::VERSION
+  spec.authors       = ['Ben Kaplan']
+
+  spec.summary       = %q{acmesmith plugin implementing dns-01 using NS1 REST API}
+  spec.description   = %q{This gem is a plugin for acmesmith and implements an automated dns-01 challenge responder using NS1 API.}
+  spec.homepage      = 'https://github.com/benkap/acmesmith-ns1'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split(?\0).reject { |f| f.match(%r{^(test|spec|features|tmp)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.1.0'
+  spec.add_runtime_dependency 'acmesmith', '~> 2'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/acmesmith-ns1/version.rb

@@ -0,0 +1,3 @@
+module AcmesmithNS1
+  VERSION = '0.1.0'
+end

data/lib/acmesmith/challenge_responders/ns1.rb

@@ -0,0 +1,173 @@
+require 'acmesmith/challenge_responders/base'
+require 'yaml'
+require 'rest-client'
+require 'resolv'
+require 'json'
+require 'nsone'
+
+module Acmesmith
+  module ChallengeResponders
+    class Ns1 < Base
+
+      def support?(type)
+        type == 'dns-01'
+      end
+
+      def initialize(config)
+        @config = config
+        @ttl = @config.has_key?(:ttl) ? @config[:ttl] : 3600
+        @timeout = 2
+        begin
+          token = @config.fetch(:token)
+        rescue
+          warn "ERROR :: Please verify that you add your NS1 account 'Token' config file."
+          exit 1
+        end
+        @ns1 = NSOne::Client.new(token)
+      end
+
+      def respond(domain, challenge)
+        @zone = find_zone(domain)
+        unless @zone
+          warn "ERROR :: Domain '#{domain}' is not configured in NS1."
+          exit 1
+        end
+        @fqdn = canonicalize(domain, challenge)
+
+        create_rr(challenge)
+        wait_for_sync_by_api(challenge)
+        wait_for_sync_by_dns(challenge)
+      end
+
+      def cleanup(domain, challenge)
+        @zone = find_zone(domain)
+        unless @zone
+          warn "ERROR :: Domain '#{domain}' is not configured in NS1."
+          exit 1
+        end
+        @fqdn = canonicalize(domain, challenge)
+
+        delete_rr(challenge)
+        wait_for_sync_by_api(challenge, false)
+      end
+
+      private
+
+      def get_rr(challenge)
+        begin
+          type = challenge.record_type
+
+          res = @ns1.record(@zone, @fqdn, type)
+
+          return res.has_key?("message") && res["message"] == "record not found" ? false : res
+
+        rescue => e
+          warn "ERROR :: Failed to get record: #{@fqdn}. error: #{e}"
+          exit 3
+        end
+      end
+
+      def create_rr(challenge)
+        begin
+          data = {
+            "zone" => @zone,
+            "domain" => @fqdn,
+            "type" => challenge.record_type,
+            "answers" => [{"answer" => [challenge.record_content]}],
+            "ttl" => @ttl,
+          }
+
+          res = @ns1.create_record(@zone, @fqdn, challenge.record_type, data)
+
+          raise "ERROR :: Failed to create record: #{@fqdn} zone: #{@zone}. msg: #{res["message"]}" if res.has_key?("message")
+
+          res
+
+        rescue => e
+          warn "ERROR :: error on create -> #{e}"
+          exit 3
+        end
+      end
+
+      def delete_rr(challenge)
+        begin
+          res = @ns1.delete_record(@zone, @fqdn, challenge.record_type)
+
+          raise "ERROR :: Failed to delete record: #{@fqdn} zone: #{@zone}." if res.has_key?("message")
+
+          res
+        rescue => e
+          warn "ERROR :: error on delete -> #{e}"
+          exit 3
+        end
+      end
+
+      def wait_for_sync_by_api(challenge, for_create = true)
+        puts " * API Check :: Checking if record found using NS1 API --> record: #{@fqdn} expected value: #{challenge.record_content}"
+
+        record = get_rr(challenge)
+
+        if for_create
+          while !record
+            puts " * Record creation still in process. waiting 3 seconds."
+            sleep 3
+            record = get_rr(challenge)
+          end
+
+          puts " * Confirm new record creation using API!"
+
+          return true
+        else
+          while record
+            puts " * Record deletion still in process. waiting 3 seconds"
+            sleep 3
+            record = get_rr(challenge)
+          end
+
+          puts " * Confirm record deletion using API!"
+
+          return true
+        end # if for_create
+      end # def
+
+      def wait_for_sync_by_dns(challenge)
+        value = challenge.record_content
+        puts " * DNS CHeck ::  Checking if record found using DNS query --> record: #{@fqdn} expected value: #{challenge.record_content}"
+
+        resolv = Resolv::DNS.new()
+        nameservers = resolv.getresources(@zone, Resolv::DNS::Resource::IN::NS).map {|ns| Resolv.getaddresses(ns.name.to_s).first}
+        Resolv::DNS.open(:nameserver => nameservers) do | dns |
+          dns.timeouts = @timeout
+
+          loop do
+
+            resolv_value = dns.getresources(@fqdn, Resolv::DNS::Resource::IN::TXT).map(&:data).first
+
+            if resolv_value == value
+              puts " * Success - Value found and it is as expected. value: #{resolv_value}"
+              sleep 1
+              break
+            else
+              puts " * Waiting - Value still does not match the expected result. current value: #{resolv_value}"
+              sleep 3
+            end
+
+          end # loop
+        end # Resolv::DNS
+      end # def
+
+      def canonicalize(domain, challenge)
+        "#{challenge.record_name}.#{domain}.".gsub(/\.{2,}/, '.')
+      end
+
+      def get_zones()
+        @zones ||= @ns1.zones.map {|z| z["zone"]}
+      end
+
+      def find_zone(domain)
+        get_zones.select {|z| domain[z] }.first
+      end
+
+    end # class
+  end # module
+end # module

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: acmesmith-ns1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Kaplan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: acmesmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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 NS1 API.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- acmesmith-ns1.gemspec
+- lib/acmesmith-ns1/version.rb
+- lib/acmesmith/challenge_responders/ns1.rb
+homepage: https://github.com/benkap/acmesmith-ns1
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: acmesmith plugin implementing dns-01 using NS1 REST API
+test_files: []