nslookupot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0846a02a74eb40953b233d52b2b8f38f12414f8b3bf9c06c7eb2603129100428'
+  data.tar.gz: ab65aa27f3980d3bad019c6711258111da627298a3a07e63deb781550dda7ed3
+SHA512:
+  metadata.gz: 4ef75c8b9bd0b4acebec3255714f853a1b777f2e0132d9018dd094b5ff394e063439e68dc9f60621558964e5f73e4a0d2b332978b33078b54c29513f50ca94fd
+  data.tar.gz: aa3653f20ebd41e739f9d7aa7c24356ad037b6d333aed83da6f8d7c9b33d82f39c50a516229cb547222b3e309bc309543dc51ad21d7d6f05c9c41d84a9fad7b2

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+/vendor/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/
+
+.byebug_history
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 30
+
+Naming/UncommunicativeMethodParamName:
+  MinNameLength: 1

data/.travis.yml

@@ -0,0 +1,17 @@
+sudo: false
+
+language: ruby
+
+rvm:
+  - 2.6.3
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+before_install:
+  - gem install bundler
+  - bundle install
+
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'openssl'
+gem 'rake'
+
+group :test do
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'rspec', '3.8.0'
+  gem 'rubocop', '0.68.1'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tomoya Kuwayama
+
+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,80 @@
+# nslookupot
+
+[![Build Status](https://travis-ci.org/thekuwayama/nslookupot.svg?branch=master)](https://travis-ci.org/thekuwayama/nslookupot)
+[![Maintainability](https://api.codeclimate.com/v1/badges/5df9157757f5a0bf1623/maintainability)](https://codeclimate.com/github/thekuwayama/nslookupot/maintainability)
+
+nslookupot is CLI that is `nslookup` over TLS (version 1.2).
+
+
+## Installation
+
+The gem is available at [rubygems.org](https://rubygems.org/gems/nslookupot). You can install with:
+
+```bash
+$ gem install nslookupot
+```
+
+
+## Usage
+
+```bash
+$ nslookupot --help
+Usage: nslookupot [options] name
+    -s, --server VALUE               the name server IP address        (default 1.1.1.1)
+    -p, --port VALUE                 the name server port number       (default 853)
+    -h, --hostname VALUE             the name server hostname          (default cloudflare-dns.com)
+    -t, --type VALUE                 the type of the information query (default A)
+```
+
+You can run it the following:
+
+```bash
+$ nslookupot example.com
+Address:        1.1.1.1#853
+--
+Name:           example.com
+Address:        93.184.216.34
+Ttl:            2860
+
+```
+
+If you need to resolve other than A type, you can run it the following:
+
+```bash
+$ nslookupot --type=cname www.youtube.com
+Address:        1.1.1.1#853
+--
+Name:           www.youtube.com
+Name:           youtube-ui.l.google.com
+Ttl:            1358
+
+```
+
+If you need to query to `8.8.8.8`, you can run it the following:
+
+```bash
+$ nslookupot --server=8.8.8.8 --port=853 --hostname=dns.google www.google.com
+Address:        8.8.8.8#853
+--
+Name:           www.google.com
+Address:        172.217.24.132
+Ttl:            223
+
+```
+
+If you need to query to `9.9.9.9`, you can run it the following:
+
+```bash
+$ nslookupot --server=9.9.9.9 --port=853 --hostname=quad9.net www.quad9.net
+Address:        9.9.9.9#853
+--
+Name:           www.quad9.net
+Address:        216.21.3.77
+Ttl:            1200
+
+```
+
+
+## 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 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/exe/nslookupot

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << __dir__ + '/../lib'
+
+require 'nslookupot'
+
+Nslookupot::CLI.new.run

data/lib/nslookupot.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'resolv'
+require 'socket'
+require 'openssl'
+require 'optparse'
+
+require 'nslookupot/version'
+require 'nslookupot/resolver'
+require 'nslookupot/cli'

data/lib/nslookupot/cli.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module Nslookupot
+  class CLI
+    # rubocop: disable Metrics/MethodLength
+    def parse_options(argv = ARGV)
+      op = OptionParser.new
+
+      # default value
+      opts = {
+        server: '1.1.1.1',
+        port: 853,
+        hostname: 'cloudflare-dns.com'
+      }
+      type = 'A'
+
+      op.on(
+        '-s',
+        '--server VALUE',
+        "the name server IP address        (default #{opts[:server]})"
+      ) do |v|
+        opts[:server] = v
+      end
+
+      op.on(
+        '-p',
+        '--port VALUE',
+        "the name server port number       (default #{opts[:port]})"
+      ) do |v|
+        opts[:port] = v
+      end
+
+      op.on(
+        '-h',
+        '--hostname VALUE',
+        "the name server hostname          (default #{opts[:hostname]})"
+      ) do |v|
+        opts[:hostname] = v
+      end
+
+      op.on(
+        '-t',
+        '--type VALUE',
+        "the type of the information query (default #{type})"
+      ) do |v|
+        type = v
+      end
+
+      op.banner += ' name'
+      begin
+        args = op.parse(argv)
+      rescue OptionParser::InvalidOption => e
+        puts op.to_s
+        puts "error: #{e.message}"
+        exit 1
+      end
+
+      begin
+        type = s2typeclass(type)
+      rescue NameError
+        puts "error: unknown query type #{type}"
+        exit 1
+      end
+
+      if args.size != 1
+        puts op.to_s
+        puts 'error: number of arguments is not 1'
+        exit 1
+      end
+
+      [opts, args[0], type]
+    end
+    # rubocop: enable Metrics/MethodLength
+
+    def s2typeclass(s)
+      Resolv::DNS::Resource::IN.const_get(s.upcase)
+    end
+
+    def run
+      opts, name, type = parse_options
+
+      resolver = Nslookupot::Resolver.new(opts)
+      puts 'Address:'.ljust(16) + opts[:server] + '#' + opts[:port].to_s
+      puts '--'
+      resolver.resolve_resources(name, type).each do |rr|
+        puts 'Name:'.ljust(16) + name
+        rr.instance_variables.each do |v|
+          k = (v[1..].capitalize + ':').ljust(16)
+          v = rr.instance_variable_get(v).to_s
+          puts k + v
+        end
+        puts ''
+      end
+    end
+  end
+end

data/lib/nslookupot/resolver.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Nslookupot
+  class Resolver
+    # @param server [String]
+    # @param port [Integer]
+    # @param hostname [String]
+    def initialize(server: '1.1.1.1', port: 853,
+                   hostname: 'cloudflare-dns.com')
+      @server = server
+      @port = port
+      @hostname = hostname # for SNI
+    end
+
+    # @param name [String]
+    #
+    # @return [Resolv::IPv4 | Resolv::IPv6]
+    def resolve_address(name)
+      resolve_resources(name, Resolv::DNS::Resource::IN::A).first.address
+    end
+
+    # @param name [String]
+    #
+    # @return [Array of Resolv::IPv4 | Resolv::IPv6]
+    def resolve_addresses(name)
+      resolve_resources(name, Resolv::DNS::Resource::IN::A).map(&:address)
+    end
+
+    # @param name [String]
+    # @param typeclass [Resolv::DNS::Resource::IN constant]
+    #
+    # @return [Array of Resolv::DNS::Resource]
+    def resolve_resources(name, typeclass)
+      sock = gen_sock
+      send_msg(sock, name, typeclass)
+      msg = recv_msg(sock)
+      sock.close
+
+      msg.answer.map(&:last)
+    end
+
+    private
+
+    # @param sock [OpenSSL::SSL::SSLSocket]
+    #
+    # @return [Resolv::DNS::Message]
+    def recv_msg(sock)
+      # The message is prefixed with a two byte length field which gives the
+      # message length, excluding the two byte length field.
+      #
+      # https://tools.ietf.org/html/rfc1035#section-4.2.2
+      l = sock.read(2).unpack1('n')
+
+      Resolv::DNS::Message.decode(sock.read(l))
+    end
+
+    # @param sock [OpenSSL::SSL::SSLSocket]
+    # @param name [String]
+    # @param typeclass [Resolv::DNS::Resource::IN constant]
+    def send_msg(sock, name, typeclass)
+      q = Resolv::DNS::Message.new
+      q.rd = 1 # recursion desired
+      q.add_question(name, typeclass)
+      # The message is prefixed with a two byte length field
+      message = [q.encode.length].pack('n') + q.encode
+      sock.write(message)
+    end
+
+    # @return [OpenSSL::SSL::SSLSocket]
+    def gen_sock
+      ts = TCPSocket.new(@server, @port)
+      ctx = OpenSSL::SSL::SSLContext.new('TLSv1_2')
+      sock = OpenSSL::SSL::SSLSocket.new(ts, ctx)
+      sock.sync_close = true
+      sock.connect
+      sock.post_connection_check(@hostname)
+
+      sock
+    end
+  end
+end

data/lib/nslookupot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Nslookupot
+  VERSION = '0.0.1'
+end

data/nslookupot.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nslookupot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nslookupot'
+  spec.version       = Nslookupot::VERSION
+  spec.authors       = ['thekuwayama']
+  spec.email         = ['thekuwayama@gmail.com']
+  spec.summary       = 'nslookup over TLS'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/thekuwayama/nslookupot'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>=2.6.0'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.bindir        = 'exe'
+  spec.executables   = ['nslookupot']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_dependency             'openssl'
+end

data/spec/resolver_spec.rb

@@ -0,0 +1,30 @@
+# encoding: ascii-8bit
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+RSpec.describe Nslookupot::Resolver do
+  context '(DNS over TLS)' do
+    let(:resolver) do
+      Nslookupot::Resolver.new
+    end
+
+    let(:sock) do
+      sock = SimpleStream.new
+      bin = "\x00\x2d\x00\x00\x81\x80\x00\x01\x00\x01\x00\x00\x00\x00\x07\x65" \
+            "\x78\x61\x6d\x70\x6c\x65\x03\x63\x6f\x6d\x00\x00\x01\x00\x01\xc0" \
+            "\x0c\x00\x01\x00\x01\x00\x01\x18\xb3\x00\x04\x5d\xb8\xd8\x22"
+      sock.write(bin)
+
+      sock
+    end
+
+    it 'could resolve `example.com` with #getaddress' do
+      allow(resolver).to receive(:gen_sock).and_return(sock)
+      allow(resolver).to receive(:send_msg)
+
+      expect(resolver.resolve_address('example.com'))
+        .to eq Resolv::IPv4.create('93.184.216.34')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+RSpec.configure(&:disable_monkey_patching!)
+
+require 'nslookupot'
+
+class SimpleStream
+  def initialize(binary = '')
+    @buffer = binary
+  end
+
+  def write(binary)
+    @buffer += binary
+  end
+
+  def read(len = @buffer.length)
+    res = @buffer.slice(0, len)
+    @buffer = @buffer[len..]
+    res
+  end
+
+  def close
+    @buffer = nil
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: nslookupot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- thekuwayama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  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: nslookup over TLS
+email:
+- thekuwayama@gmail.com
+executables:
+- nslookupot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/nslookupot
+- lib/nslookupot.rb
+- lib/nslookupot/cli.rb
+- lib/nslookupot/resolver.rb
+- lib/nslookupot/version.rb
+- nslookupot.gemspec
+- spec/resolver_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/thekuwayama/nslookupot
+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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: nslookup over TLS
+test_files:
+- spec/resolver_spec.rb
+- spec/spec_helper.rb