acmesmith-cloudflare 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 696f366e01d4dc4201f12264d39af5e42b183b33224277aa2f0c3eb8002b262d
+  data.tar.gz: 97a3a228fc2c53d22443e66965de3ae2788aa52f7129fb58977e93cd484a1917
+SHA512:
+  metadata.gz: b8f8cccb781fedf2419ee5e7f613c10a9b28d6d826a940109ee94a8fd1977a059d0e9c2115a34f0f23a7f424052234d87ab53e344583df4b7287294acc17c0b2
+  data.tar.gz: 6ab49890092ed70f5a51df7aa979dee68a464e0d9667891f51775ed96b09398825759a7139edb56152684d4fba174ecf2be3f3326888d5636522732a5420db32

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Daisuke Aritomo
+
+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,35 @@
+# Acmesmith::Cloudflare
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/acmesmith/cloudflare`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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-cloudflare.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/acmesmith/challenge_responders/cloudflare.rb

@@ -0,0 +1,188 @@
+require 'acmesmith/challenge_responders/base'
+require 'acmesmith/cloudflare/client'
+
+module Acmesmith
+  module ChallengeResponders
+    class Cloudflare < Base
+      class ZoneNotFound < StandardError; end
+      class AmbiguousZones < StandardError; end
+
+      DEFAULT_COMMENT = 'Managed by acmesmith for ACME dns-01'.freeze
+
+      def support?(type)
+        type == 'dns-01'
+      end
+
+      def cap_respond_all?
+        true
+      end
+
+      def initialize(api_token:, zone_id_map: {}, substitution_map: {}, ttl: 60, wait_time_seconds: 30, api_base: nil, client: nil)
+        @client = client || ::Acmesmith::Cloudflare::Client.new(api_token: api_token, api_base: api_base)
+        @zone_id_map = normalize_keys(zone_id_map)
+        @substitution_map = normalize_keys(substitution_map)
+        @ttl = ttl
+        @wait_time_seconds = wait_time_seconds
+
+        @zones_by_name = {}
+        @created_record_ids = Hash.new { |hash, key| hash[key] = [] }
+      end
+
+      def respond_all(*domain_and_challenges)
+        domain_and_challenges = apply_substitution_for_domain_and_challenges(domain_and_challenges)
+
+        puts "=> Requesting DNS record changes on Cloudflare"
+        puts
+
+        domain_and_challenges.each do |domain, challenge|
+          zone_id = find_zone_id(domain)
+          record_name = record_name_for(domain, challenge)
+
+          print " * #{record_name} #{challenge.record_type} #{challenge.record_content} ..."
+          response = @client.create_dns_record(
+            zone_id: zone_id,
+            name: record_name,
+            type: challenge.record_type,
+            content: challenge.record_content,
+            ttl: @ttl,
+            comment: DEFAULT_COMMENT,
+          )
+          record_id = response.fetch('result').fetch('id')
+          @created_record_ids[record_identity(zone_id, record_name, challenge.record_type, challenge.record_content)] << record_id
+          puts " [ ok ] #{record_id}"
+        end
+
+        puts
+        wait_for_sync
+      end
+
+      def cleanup_all(*domain_and_challenges)
+        domain_and_challenges = apply_substitution_for_domain_and_challenges(domain_and_challenges)
+
+        puts "=> Removing DNS record changes from Cloudflare"
+        puts
+
+        domain_and_challenges.each do |domain, challenge|
+          zone_id = find_zone_id(domain)
+          record_name = record_name_for(domain, challenge)
+          record_ids = take_record_ids(zone_id, record_name, challenge.record_type, challenge.record_content)
+          record_ids = find_record_ids(zone_id, record_name, challenge.record_type, challenge.record_content) if record_ids.empty?
+
+          if record_ids.empty?
+            puts " * #{record_name} #{challenge.record_type} #{challenge.record_content} [ not found ]"
+            next
+          end
+
+          record_ids.each do |record_id|
+            print " * deleting #{record_name} #{challenge.record_type} #{challenge.record_content} ..."
+            @client.delete_dns_record(zone_id: zone_id, record_id: record_id)
+            puts " [ ok ] #{record_id}"
+          end
+        end
+
+        puts
+      end
+
+      private
+
+      def wait_for_sync
+        return unless @wait_time_seconds.to_i.positive?
+
+        puts "=> Waiting #{@wait_time_seconds} seconds for DNS changes to be seen"
+        sleep @wait_time_seconds
+        puts
+      end
+
+      def apply_substitution_for_domain_and_challenges(domain_and_challenges)
+        domain_and_challenges.map do |domain, challenge|
+          [@substitution_map.fetch(normalize_domain(domain), domain), challenge]
+        end
+      end
+
+      def record_name_for(domain, challenge)
+        "#{challenge.record_name}.#{normalize_domain(domain)}"
+      end
+
+      def find_zone_id(domain)
+        labels = normalize_domain(domain).split('.')
+
+        0.upto(labels.size - 1) do |i|
+          candidate = labels[i..-1].join('.')
+          mapped_zone_id = @zone_id_map[candidate]
+          return mapped_zone_id if mapped_zone_id
+        end
+
+        0.upto(labels.size - 1) do |i|
+          candidate = labels[i..-1].join('.')
+          zones = zones_for_name(candidate)
+          next if zones.empty?
+          raise AmbiguousZones, "multiple zones found for #{domain.inspect}: #{zones.map { |zone| zone['id'] }.inspect}, set zone_id_map to identify" if zones.size != 1
+
+          return zones.first.fetch('id')
+        end
+
+        raise ZoneNotFound, "zone not found for #{domain.inspect}"
+      end
+
+      def zones_for_name(name)
+        @zones_by_name[name] ||= begin
+          response = @client.list_zones(name: name)
+          Array(response['result']).select do |zone|
+            normalize_domain(zone.fetch('name')) == name
+          end
+        end
+      end
+
+      def record_identity(zone_id, record_name, record_type, record_content)
+        [zone_id, normalize_domain(record_name), record_type, record_content].join("\0")
+      end
+
+      def take_record_ids(zone_id, record_name, record_type, record_content)
+        @created_record_ids.delete(record_identity(zone_id, record_name, record_type, record_content)) || []
+      end
+
+      def find_record_ids(zone_id, record_name, record_type, record_content)
+        each_dns_record(zone_id, type: record_type).select do |record|
+          normalize_domain(record.fetch('name')) == normalize_domain(record_name) &&
+            record.fetch('type') == record_type &&
+            record.fetch('content') == record_content
+        end.map { |record| record.fetch('id') }
+      end
+
+      def each_dns_record(zone_id, type:)
+        page = 1
+        per_page = 100
+        records = []
+
+        loop do
+          response = @client.list_dns_records(
+            zone_id: zone_id,
+            page: page,
+            per_page: per_page,
+            type: type,
+          )
+          current_records = Array(response['result'])
+          records.concat(current_records)
+
+          result_info = response['result_info'] || {}
+          total_pages = result_info['total_pages'].to_i
+          break if current_records.empty?
+          break if total_pages.positive? && page >= total_pages
+          break if current_records.size < per_page
+
+          page += 1
+        end
+
+        records
+      end
+
+      def normalize_keys(hash)
+        hash.map { |key, value| [normalize_domain(key), value] }.to_h
+      end
+
+      def normalize_domain(domain)
+        domain.to_s.sub(/\.+$/, '').downcase
+      end
+    end
+  end
+end

data/lib/acmesmith/cloudflare/client.rb

@@ -0,0 +1,96 @@
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Acmesmith
+  module Cloudflare
+    class APIError < StandardError; end
+
+    DEFAULT_API_BASE = 'https://api.cloudflare.com/client/v4'.freeze
+
+    class Client
+      def initialize(api_token:, api_base: nil)
+        @api_token = api_token
+        @api_base = (api_base || DEFAULT_API_BASE).sub(%r{/*$}, '')
+      end
+
+      def list_zones(name:)
+        get('/zones', query: {
+          name: name,
+          status: 'active',
+          per_page: '50',
+        })
+      end
+
+      def list_dns_records(zone_id:, page: 1, per_page: 100, type: nil)
+        query = {
+          page: page.to_s,
+          per_page: per_page.to_s,
+        }
+        query[:type] = type if type
+
+        get("/zones/#{zone_id}/dns_records", query: query)
+      end
+
+      def create_dns_record(zone_id:, name:, type:, content:, ttl:, comment: nil)
+        payload = {
+          type: type,
+          name: name,
+          content: content,
+          ttl: ttl,
+          proxied: false,
+        }
+        payload[:comment] = comment if comment
+
+        post("/zones/#{zone_id}/dns_records", body: payload)
+      end
+
+      def delete_dns_record(zone_id:, record_id:)
+        delete("/zones/#{zone_id}/dns_records/#{record_id}")
+      end
+
+      private
+
+      def get(path, query: nil)
+        request(Net::HTTP::Get, path, query: query)
+      end
+
+      def post(path, body: nil)
+        request(Net::HTTP::Post, path, body: body)
+      end
+
+      def delete(path)
+        request(Net::HTTP::Delete, path)
+      end
+
+      def request(request_class, path, query: nil, body: nil)
+        uri = URI.parse("#{@api_base}#{path}")
+        uri.query = URI.encode_www_form(query) if query && !query.empty?
+
+        request = request_class.new(uri)
+        request['Authorization'] = "Bearer #{@api_token}"
+        request['Accept'] = 'application/json'
+        if body
+          request['Content-Type'] = 'application/json'
+          request.body = JSON.dump(body)
+        end
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+          http.request(request)
+        end
+
+        begin
+          payload = JSON.parse(response.body)
+        rescue JSON::ParserError
+          raise APIError, "Cloudflare API #{request.method} #{path} returned invalid JSON (HTTP #{response.code})"
+        end
+
+        return payload if response.is_a?(Net::HTTPSuccess) && payload['success']
+
+        details = Array(payload['errors']).map { |err| err['message'] || err.inspect }.join(', ')
+        details = response.body if details.empty?
+        raise APIError, "Cloudflare API #{request.method} #{path} failed (HTTP #{response.code}): #{details}"
+      end
+    end
+  end
+end

data/lib/acmesmith/cloudflare/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Acmesmith
+  module Cloudflare
+    VERSION = "0.1.0"
+  end
+end

data/lib/acmesmith/cloudflare.rb

@@ -0,0 +1,8 @@
+require_relative "cloudflare/client"
+require_relative "cloudflare/version"
+require_relative "challenge_responders/cloudflare"
+
+module Acmesmith
+  module Cloudflare
+  end
+end

data/sig/acmesmith/cloudflare.rbs

@@ -0,0 +1,6 @@
+module Acmesmith
+  module Cloudflare
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: acmesmith-cloudflare
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daisuke Aritomo
+bindir: exe
+cert_chain: []
+date: 1980-01-02 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'
+email:
+- osyoyu@osyoyu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/acmesmith/challenge_responders/cloudflare.rb
+- lib/acmesmith/cloudflare.rb
+- lib/acmesmith/cloudflare/client.rb
+- lib/acmesmith/cloudflare/version.rb
+- sig/acmesmith/cloudflare.rbs
+homepage: https://github.com/osyoyu/acmesmith-cloudflare
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/osyoyu/acmesmith-cloudflare
+  source_code_uri: https://github.com/osyoyu/acmesmith-cloudflare
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.1.0.dev
+specification_version: 4
+summary: An Acmesmith challenge-response plugin for Cloudflare DNS.
+test_files: []