rdap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a812f4f58d5435ffd4a7b6d85d0373b1d7eb7914fb87854f48f2142009ff0f3f
+  data.tar.gz: f039922723968ba123c0697e5254e07220bce7a85015f2783bcaca17f2c87e37
+SHA512:
+  metadata.gz: d3fdb2df158c5a13d0a479fba0760e766c12f707cb82bb4214f7e9e95629d84700ab788d7b2591233367862b3f79e2f8eb34fa44a13fb8bfecdecde83f6d164b
+  data.tar.gz: 3a2219bfb23a0fa4e3a3204db935024b6a2ec2f733f57e5541fec37b3e917c41cd54231f418d91f5bf30e12bbccd4ac2f5b68a5d8ac001ba12d07e03e3ae3c32

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.7
+  - 2.6.5
+  - 2.7.5
+  - 3.0.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rdap.gemspec
+gemspec
+
+gem "rake", ">= 12.0"
+gem "rspec", "~> 3.0"
+gem "vcr", "~> 6.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    rdap (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    vcr (6.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (>= 12.0)
+  rdap!
+  rspec (~> 3.0)
+  vcr (~> 6.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,104 @@
+# RDAP
+
+A minimal Ruby client to query RDAP APIs though a bootstrap server.
+No dependencies, no caching or bootstrap file (the query is routed through a bootstrap server first).
+
+[RDAP](https://en.wikipedia.org/wiki/Registration_Data_Access_Protocol) is a new protocol destined to replace WHOIS to query informations about domains, IPs, ASNs, etc.
+Not all TLDs support RDAP at the moment, but the deployment is going well: https://deployment.rdap.org
+
+This library is optimal for low volume queries (the [bootstrap server we used here](https://about.rdap.org/) enforces [some throttling](https://about.rdap.org/#rate-limits)).
+If you need to perform a lot of queries, you should either:
+- avoid bootstrap servers and use a caching client like [nicinfo](https://github.com/arineng/nicinfo)
+- or run [your own bootstrap server](https://github.com/arineng/rdap_bootstrap_server).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rdap'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rdap
+
+## Usage
+
+You can use `bin/console` from this repository for an interactive prompt.
+
+```ruby
+RDAP.domain("google.com")
+# => {"objectClassName"=>"domain",
+#  "handle"=>"2138514_DOMAIN_COM-VRSN",
+#  "ldhName"=>"GOOGLE.COM",
+#  "links"=>[...],
+#  "status"=>[...],
+#  "entities"=>[...],
+#  "events"=>
+#   [{"eventAction"=>"registration", "eventDate"=>"1997-09-15T04:00:00Z"},
+#    {"eventAction"=>"expiration", "eventDate"=>"2028-09-14T04:00:00Z"},
+#    {"eventAction"=>"last update of RDAP database", "eventDate"=>"2021-12-17T11:35:32Z"}],
+#  "secureDNS"=>{"delegationSigned"=>false},
+#  "nameservers"=>
+#   [{"objectClassName"=>"nameserver", "ldhName"=>"NS1.GOOGLE.COM"},
+#    {"objectClassName"=>"nameserver", "ldhName"=>"NS2.GOOGLE.COM"},
+#    {"objectClassName"=>"nameserver", "ldhName"=>"NS3.GOOGLE.COM"},
+#    {"objectClassName"=>"nameserver", "ldhName"=>"NS4.GOOGLE.COM"}],
+#  "rdapConformance"=>
+#   ["rdap_level_0", "icann_rdap_technical_implementation_guide_0", "icann_rdap_response_profile_0"],
+#  "notices"=>[...]}
+RDAP.ip("8.8.8.8") # IPv4
+RDAP.ip("2620:119:35::35") # or IPv6
+RDAP.as("16276") # AS Number ("autnum" in RDAP phraseology)
+
+# there is also a lower level method accepting a type (:domain, :ip, :autnum) if needed
+RDAP.query("16276", type: :autnum)
+
+# Options
+RDAP.domain("google.com", server: "https://rdap-bootstrap.arin.net/bootstrap") # Specify an alternative bootstrap server
+RDAP.domain("google.com", server: "https://rdap.verisign.com/com/v1") # Or directly the target RDAP server if you know it
+RDAP.domain("google.com", timeout: 20) # Customize open and read timeouts (default = 5 sec each)
+
+# Error handling
+RDAP.domain("test.fr") # TLD not supported yet
+# => RDAP::NotFound ([404] domain test.fr not found in IANA boostrap file)
+RDAP.domain("jsiqpmcurt.design") # Domain not found
+# => RDAP::NotFound ([404] Object not found)
+RDAP.domain("jsiqpmcurt.com") # The message is not always exactly the same
+# => RDAP::NotFound ([404] Not Found)
+RDAP.domain("u$&~(!*@&@^#}") # Invalid URI
+# => URI::InvalidURIError (bad URI(is not URI?): "https://rdap.org/domain/u$&~(!*@&@^#}")
+RDAP.domain("broken") # Other type of unexpected server response
+# => RDAP::ServerError ([500] Internal Server Error)
+```
+
+## How does it work
+
+The gem make a query to one of the publicly available RDAP bootstrap server (their responsibility is simply to check the [bootstrap files](https://data.iana.org/rdap/dns.json) and redirect you to the proper RDAP server), then it does the query to the target RDAP server and returns the JSON parsed. The gem currently use this public bootstrap server: https://rdap.org/ but it's possible to change for another one in case of problem or limitation. For example ARIN has it's own bootstrap server too: https://rdap-bootstrap.arin.net/bootstrap. It's also possible to host your own bootstrap server.
+
+## Changelog
+
+**0.1.0** (2021-12-17) - Initial version
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jarthod/rdap.
+
+After checking out the repo, run `bundle install` 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.
+
+Tests are using the `vcr` gem to record server responses so we don't hit them too quickly/often. This is nice and fast but if the server API even changes we may not notice it. So from time to time it can be intereting to re-record the responses: `rm -R spec/fixtures && rake spec`
+
+## Alternatives
+
+If you're looking for a command line tool, you can check the excellent [nicinfo](https://github.com/arineng/nicinfo) (also written in Ruby).
+Also if you're just looking for one-off debugging and scripts, you can query a bootstrap endpoint directly using `curl -L`, example:
+
+```
+> curl -L https://rdap-bootstrap.arin.net/bootstrap/domain/google.com
+{"objectClassName":"domain","handle":"2138514_DOMAIN_COM-VRSN","ldhName":"GOOGLE.COM","links":[{"value":"https:\/\/rdap.verisign.com\/com\/v1\/domain\/GOOGLE.COM","rel":"self","href":"https:\/\/rdap.verisign.com\/com\/v1\/domain\/GOOGLE.COM","type":"application\/rdap+json"},{"value":"https:\/\/rdap.markmonitor.com\/rdap\/domain\/GOOGLE.COM","rel":"related","href":"https:\/\/rdap.markmonitor.com\/rdap\/domain\/GOOGLE.COM","type":"application\/rdap+json"}],"status":["client delete prohibited","client transfer prohibited","client update prohibited","server delete prohibited","server transfer prohibited","server update prohibited"],"entities":[{"objectClassName":"entity","handle":"292","roles":["registrar"],"publicIds":[{"type":"IANA Registrar ID","identifier":"292"}],"vcardArray":["vcard",[["version",{},"text","4.0"],["fn",{},"text","MarkMonitor Inc."]]],"entities":[{"objectClassName":"entity","roles":["abuse"],"vcardArray":["vcard",[["version",{},"text","4.0"],["fn",{},"text",""],["tel",{"type":"voice"},"uri","tel:+1.2083895740"],["email",{},"text","abusecomplaints@markmonitor.com"]]]}]}],"events":[{"eventAction":"registration","eventDate":"1997-09-15T04:00:00Z"},{"eventAction":"expiration","eventDate":"2028-09-14T04:00:00Z"},{"eventAction":"last update of RDAP database","eventDate":"2021-12-17T11:35:32Z"}],"secureDNS":{"delegationSigned":false},"nameservers":[{"objectClassName":"nameserver","ldhName":"NS1.GOOGLE.COM"},{"objectClassName":"nameserver","ldhName":"NS2.GOOGLE.COM"},{"objectClassName":"nameserver","ldhName":"NS3.GOOGLE.COM"},{"objectClassName":"nameserver","ldhName":"NS4.GOOGLE.COM"}],"rdapConformance":["rdap_level_0","icann_rdap_technical_implementation_guide_0","icann_rdap_response_profile_0"],"notices":[{"title":"Terms of Use","description":["Service subject to Terms of Use."],"links":[{"href":"https:\/\/www.verisign.com\/domain-names\/registration-data-access-protocol\/terms-service\/index.xhtml","type":"text\/html"}]},{"title":"Status Codes","description":["For more information on domain status codes, please visit https:\/\/icann.org\/epp"],"links":[{"href":"https:\/\/icann.org\/epp","type":"text\/html"}]},{"title":"RDDS Inaccuracy Complaint Form","description":["URL of the ICANN RDDS Inaccuracy Complaint Form: https:\/\/icann.org\/wicf"],"links":[{"href":"https:\/\/icann.org\/wicf","type":"text\/html"}]}]}
+```

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 "rdap"
+
+# 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/lib/rdap.rb

@@ -0,0 +1,63 @@
+require 'json'
+require 'net/http'
+
+module RDAP
+  VERSION = "0.1.0"
+  BOOTSTRAP = "https://rdap.org/"
+  TYPES = [:domain, :ip, :autnum]
+
+  class Error < StandardError; end
+  class ServerError < Error; end
+  class NotFound < Error; end
+
+  def self.domain name, **opts
+    query name, type: :domain, **opts
+  end
+
+  def self.ip name, **opts
+    query name, type: :ip, **opts
+  end
+
+  def self.as name, **opts
+    query name, type: :autnum, **opts
+  end
+
+  def self.query name, type:, timeout: 5, server: BOOTSTRAP
+    TYPES.include?(type) or raise ArgumentError.new("RDAP: Invalid query type: #{type}, supported types: #{TYPES}")
+    uri = URI("#{server.chomp('/')}/#{type}/#{name}")
+    get_follow_redirects(uri, timeout: timeout)
+  end
+
+  private
+
+  def self.get_follow_redirects uri, timeout: 5, redirection_limit: 5
+    raise ServerError.new("Too many redirections (> #{redirection_limit}) at #{uri}") if redirection_limit == 0
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.open_timeout = timeout
+    http.read_timeout = timeout
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+    response = http.get(uri.path, "Accept" => "application/rdap+json")
+    case response
+    when Net::HTTPSuccess
+      document = JSON.parse(response.body)
+      if document["errorCode"]
+        raise ServerError.new("[#{document["errorCode"]}] #{document["title"]} (#{uri})")
+      end
+      document
+    when Net::HTTPNotFound
+      # 404 sometimes return details in the JSON body so we threat them later
+      if response.body.size > 0 and (document = JSON.parse(response.body) rescue nil)
+        raise NotFound.new("[#{document["errorCode"]}] #{document["title"]}")
+      else
+        raise NotFound.new("[#{response.code}] #{response.message}")
+      end
+    when Net::HTTPRedirection
+      get_follow_redirects(URI(response["location"]), timeout: timeout, redirection_limit: redirection_limit - 1)
+    else
+      raise ServerError.new("[#{response.code}] #{response.message}")
+    end
+  end
+end

data/rdap.gemspec

@@ -0,0 +1,19 @@
+require_relative 'lib/rdap'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rdap"
+  spec.version       = RDAP::VERSION
+  spec.authors       = ["Adrien Rey-Jarthon"]
+  spec.email         = ["jobs@adrienjarthon.com"]
+
+  spec.summary       = %q{A minimal Ruby client to query RDAP APIs though a bootstrap server}
+  spec.homepage      = "https://github.com/jarthod/rdap"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # 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.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: rdap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrien Rey-Jarthon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-17 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- jobs@adrienjarthon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- lib/rdap.rb
+- rdap.gemspec
+homepage: https://github.com/jarthod/rdap
+licenses: []
+metadata: {}
+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.2
+signing_key: 
+specification_version: 4
+summary: A minimal Ruby client to query RDAP APIs though a bootstrap server
+test_files: []