resolv-macos 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e831d7024ddf352eba750fea85e451304987d39667630f4201652c3f47d9e42
+  data.tar.gz: cea3f0850ba7ec3f87cf013341849c184aa0e6f9dc7ddb97375eefbfea114190
+SHA512:
+  metadata.gz: '022980eae5bfa0d5db5f01c03761c4c20063ade99384b83146af2f081bacd7349ca556ab2851c3a0f69907b4ddfc2552da6ff63bb22ee8eea6ad12236f5f8f57'
+  data.tar.gz: 193101f901f56699a166f398d0b0f4f044c7670b7dce64269ac15a2e27e8cea4be2294d840ab591d3b07f13f5de93c7832abbab69a610064fffcf60f247c2b83

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: test
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: build (${{ matrix.ruby }} / ${{ matrix.os }})
+    strategy:
+      matrix:
+        ruby: [ '3.0', '2.7', head ]
+        os: [ ubuntu-latest, macos-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run test
+      run: bundle exec rake spec

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in resolv-macos.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,48 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Max Fierke
+
+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.
+
+This software also contains some code from `resolv`, which is licensed under the
+2-clause BSD license. This license applies to portions of the `parse_resolv_conf`
+method in `lib/resolv/macos.rb`:
+
+Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1,58 @@
+# `resolv-macos`
+
+On macOS/darwin, `libresolv` supports multiple resolvers. This allows users, VPN
+clients, etc. to delegate queries for certain domains to other resolvers, in
+addition to the "Super Resolver" specified by `/etc/resolv.conf`. An example of
+this would be using something like `dnsmasq` or `launchdns` to resolve a
+[Special Use Domain (described by RFC 6761)](https://datatracker.ietf.org/doc/html/rfc6761)
+for local development like `*.localhost` or `*.test`
+
+This is supported transparently via the `gethostbyname` and `getaddrinfo` C
+calls, but when replacing use of those APIs w/ `Resolv`, these resolutions no
+longer happen automatically.
+
+This Gem patches the default behavior of the `Resolv` gem to include these
+additional resolvers in the default set, if they exist. (Using public APIs,
+there's no monkey-patching here.)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resolv-macos'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install resolv-macos
+
+## Usage
+
+No special usage instructions. The Gem will patch `Resolv` to automatically
+provide support for multiple resolvers on macOS, _a la_ the default behavior for
+`getaddrinfo`. On platforms other than macOS, this gem does nothing.
+
+## 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/IoraHealth/resolv-macos.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "resolv/macos"
+
+# 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/resolv/macos/version.rb

@@ -0,0 +1,5 @@
+class Resolv
+  module Macos
+    VERSION = "0.1.0"
+  end
+end

data/lib/resolv/macos.rb

@@ -0,0 +1,69 @@
+require "resolv"
+require "resolv/macos/version"
+
+class Resolv
+  module Macos
+    def self.default_resolvers(resolvers_path='/etc/resolver') # :nodoc:
+      resolvers = [Hosts.new, DNS.new]
+
+      # macOS supports multiple DNS resolvers via additional configs
+      # (e.g. local domain resolvers, VPNs, etc.)
+      # ref: `man 5 resolver` on macOS/darwin
+      Dir.each_child(resolvers_path) do |filename|
+        resolver = ::Resolv::Macos.parse_resolv_conf(
+          File.join(resolvers_path, filename)
+        )
+        resolver[:search] = [filename] unless resolver[:search]
+        resolvers << ::Resolv::DNS.new(resolver)
+      end
+
+      resolvers
+    end
+
+    # Most of this is directly cribbed from Resolv, but with `port` parsing
+    # added
+    def self.parse_resolv_conf(filename) # :nodoc:
+      nameserver = []
+        search = nil
+        ndots = 1
+        port = ::Resolv::DNS::Port
+        File.open(filename, 'rb') {|f|
+          f.each {|line|
+            line.sub!(/[#;].*/, '')
+            keyword, *args = line.split(/\s+/)
+            next unless keyword
+            case keyword
+            when 'nameserver'
+              nameserver += args
+            when 'domain'
+              next if args.empty?
+              search = [args[0]]
+            when 'search'
+              next if args.empty?
+              search = args
+            when 'options'
+              args.each {|arg|
+                case arg
+                when /\Andots:(\d+)\z/
+                  ndots = $1.to_i
+                end
+              }
+            when 'port'
+              next if args.empty?
+              port = args[0].to_i
+            end
+          }
+        }
+
+        return {
+          :nameserver_port => nameserver.to_enum(:each_with_index).map { |ns, i| [ns, port] },
+          :search => search,
+          :ndots => ndots
+        }
+    end
+  end
+end
+
+if /darwin/ =~ RUBY_PLATFORM && Dir.exist?('/etc/resolver')
+  Resolv::DefaultResolver.replace_resolvers(Resolv::Macos.default_resolvers)
+end

data/resolv-macos.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/resolv/macos/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resolv-macos"
+  spec.version       = Resolv::Macos::VERSION
+  spec.authors       = ["Max Fierke"]
+  spec.email         = ["max.fierke@iorahealth.com"]
+
+  spec.summary       = %q{macOS multiple resolver support for Resolv}
+  spec.description   = %q{Adds support for macOS's multiple resolver configs to Resolv's default set of resolvers.}
+  spec.homepage      = "https://github.com/IoraHealth/resolv-macos"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "resolv"
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: resolv-macos
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Max Fierke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resolv
+  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'
+description: Adds support for macOS's multiple resolver configs to Resolv's default
+  set of resolvers.
+email:
+- max.fierke@iorahealth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resolv/macos.rb
+- lib/resolv/macos/version.rb
+- resolv-macos.gemspec
+homepage: https://github.com/IoraHealth/resolv-macos
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/IoraHealth/resolv-macos
+  source_code_uri: https://github.com/IoraHealth/resolv-macos
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: macOS multiple resolver support for Resolv
+test_files: []