nicinfo 1.3.0 → 1.4.0

data/lib/nicinfo/jcr/strict.jcr

@@ -0,0 +1,238 @@
+; all_parts strict_all.jcr
+;
+; Override rules for strict RDAP checking.
+;
+
+;
+; Object class response
+;
+
+; start_part strict_object_classes.jcr
+@{root} $entity_response = {
+    $response_mixin,
+    $entity_mixin,
+    @{not} $error_mixin,
+    @{not} $search_results
+}
+
+@{root} $nameserver_response = {
+    $response_mixin,
+    $nameserver_mixin,
+    @{not} $error_mixin,
+    @{not} $search_results
+}
+
+@{root} $domain_response = {
+    $response_mixin,
+    $domain_mixin,
+    @{not} $error_mixin,
+    @{not} $search_results
+}
+
+@{root} $network_response = {
+    $response_mixin,
+    $network_mixin,
+    @{not} $error_mixin,
+    @{not} $search_results
+}
+
+@{root} $autnum_response = {
+    $response_mixin,
+    $autnum_mixin,
+    @{not} $error_mixin,
+    @{not} $search_results
+}
+; end_part
+;
+; Help and error response
+;
+
+; start_part strict_help_and_error.jcr
+@{root} $error_response =  {
+    $response_mixin,
+    $error_mixin,
+    @{not} $object_class,
+    @{not} $search_results
+}
+
+@{root} $help_response = {
+    $response_mixin,
+    $lang ?,
+    @{not} $error_mixin,
+    @{not} $object_class,
+    @{not} $search_results
+}
+; end_part
+;
+; Search responses
+;
+
+; start_part strict_search_responses.jcr
+@{root} $domainSearch_response = {
+    $response_mixin,
+    $lang ?,
+    $domainSearchResult,
+    @{not} $error_mixin,
+    @{not} $object_class
+}
+
+@{root} $nameserverSearch_response = {
+    $response_mixin,
+    $lang ?,
+    $nameserverSearchResult,
+    @{not} $error_mixin,
+    @{not} $object_class
+}
+
+@{root} $entitySearch_response = {
+    $response_mixin,
+    $lang ?,
+    $entitySearchResult,
+    @{not} $error_mixin,
+    @{not} $object_class
+}
+; end_part
+;
+; Object class mixins
+;
+
+; start_part strict_object_class_mixins.jcr
+$object_class = (
+    $entity_mixin |
+    $nameserver_mixin |
+    $domain_mixin |
+    $network_mixin |
+    $autnum_mixin
+)
+; end_part
+;
+; All search results
+;
+
+; start_part strict_searches.jcr
+$search_results = (
+    $domainSearchResult |
+    $nameserverSearchResult |
+    $entitySearchResult
+)
+; end_part
+;
+; IANA Status Values
+;
+
+; start_part strict_iana_status_values.jcr
+$status = "status" : [ $status_values * ]
+
+$status_values = (
+    "validated" |
+    "renew prohibited" |
+    "update prohibited" |
+    "transfer prohibited" |
+    "delete prohibited" |
+    "proxy" |
+    "private" |
+    "removed" |
+    "obscured" |
+    "associated" |
+    "active" |
+    "inactive" |
+    "locked" |
+    "pending create" |
+    "pending renew" |
+    "pending transfer" |
+    "pending update" |
+    "pending delete" |
+    "add period" |
+    "auto renew period" |
+    "client delete prohibited" |
+    "client hold" |
+    "client renew prohibited" |
+    "client transfer prohibited" |
+    "client update prohibited" |
+    "pending restore" |
+    "redemption period" |
+    "renew period" |
+    "server delete prohibited" |
+    "server renew prohibited" |
+    "server transfer prohibited" |
+    "server update prohibited" |
+    "server hold" |
+    "transfer period"
+)
+; end_part
+;
+; IANA Notice and Remark Types
+;
+
+; start_part strict_iana_notice_remark_types.jcr
+$noticeRemarkType = "type" : $noticeRemarkType_values
+
+$noticeRemarkType_values = (
+    "result set truncated due to authorization" |
+    "result set truncated due to excessive load" |
+    "result set truncated due to unexplainable reasons" |
+    "object truncated due to authorization" |
+    "object truncated due to excessive load" |
+    "object truncated due to unexplainable reasons"
+)
+; end_part
+;
+; IANA Roles
+;
+
+; start_part strict_iana_roles.jcr
+$roles = "roles" : [ $role_values * ]
+
+$role_values = (
+    "registrant" |
+    "technical" |
+    "administrative" |
+    "abuse" |
+    "billing" |
+    "registrar" |
+    "reseller" |
+    "sponsor" |
+    "proxy" |
+    "notifications" |
+    "noc"
+)
+
+; end_part
+;
+; IANA Domain Variant Relations
+;
+
+; start_part strict_iana_domain_variant_relations.jcr
+$variantRelation = "relation" : [ $variantRelation_values * ]
+
+$variantRelation_values = (
+    "registered" |
+    "unregistered" |
+    "registration restricted" |
+    "open registration" |
+    "conjoined"
+)
+; end_part
+;
+; IANA Event Actions
+;
+
+; start_part strict_iana_event_actions.jcr
+$eventAction = "eventAction" : $eventAction_values
+
+$eventAction_values = (
+    "registration" |
+    "reregistration" |
+    "last changed" |
+    "expiration" |
+    "deletion" |
+    "reinstantiation" |
+    "transfer" |
+    "locked" |
+    "unlocked" |
+    "last update of RDAP database" |
+    "registrar expiration" |
+    "enum validation expiration"
+)
+; end_part
+

data/lib/nicinfo/nicinfo_main.rb

@@ -17,6 +17,7 @@ require 'optparse'
 require 'net/http'
 require 'net/https'
 require 'uri'
+require 'jcr'
 require 'nicinfo/config'
 require 'nicinfo/constants'
 require 'nicinfo/cache'
@@ -68,9 +69,17 @@ module NicInfo
 
   end
 
+  class JcrMode < NicInfo::Enum
+    JcrMode.add_item :NO_VALIDATION, "NONE"
+    JcrMode.add_item :STANDARD_VALIDATION, "STANDARD"
+    JcrMode.add_item :STRICT_VALIDATION, "STRICT"
+  end
+
   # The main class for the nicinfo command.
   class Main
 
+    attr_accessor :config, :cache, :jcr_context, :jcr_strict_context
+
     def initialize args, config = nil
 
       if config
@@ -80,6 +89,7 @@ module NicInfo
       end
 
       @config.options.require_query = true
+      @config.options.jcr = JcrMode::NO_VALIDATION
 
       @opts = OptionParser.new do |opts|
 
@@ -265,6 +275,15 @@ module NicInfo
           @config.options.require_query = false
         end
 
+        opts.on( "--jcr STANDARD|STRICT",
+                 "Validate RDAP response with JCR") do |mode|
+          upmode = mode.upcase
+          raise OptionParser::InvalidArgument, type.to_s unless JcrMode.has_value?(upmode)
+          @config.options.jcr = upmode
+          get_jcr_context if upmode == JcrMode::STANDARD_VALIDATION
+          get_jcr_strict_context if upmode == JcrMode::STRICT_VALIDATION
+        end
+
       end
 
       begin
@@ -435,7 +454,7 @@ module NicInfo
 
       if @config.options.argv == nil || @config.options.argv == [] && !@config.options.query_type
         unless @config.options.require_query
-          exit
+          return
         else
           help
         end
@@ -449,7 +468,7 @@ module NicInfo
         if json_data["data"] == nil || json_data["data"]["ip"] == nil
           @config.logger.mesg("Server repsonded with unknown JSON")
           @config.logger.mesg("Unable to determine your IP Address. You must specify it.")
-          exit
+          return
         elsif
           @config.logger.mesg("Your IP address is " + json_data["data"]["ip"], NicInfo::AttentionType::SUCCESS )
           @config.options.argv[0] = json_data["data"]["ip"]
@@ -481,7 +500,7 @@ module NicInfo
             end
           else
             @config.logger.mesg( "#{@config.options.argv[0]} is not retrievable.")
-            exit
+            return
           end
         elsif @config.options.query_type == QueryType::BY_URL
           @config.options.url = @config.options.argv[0]
@@ -491,7 +510,7 @@ module NicInfo
         end
         if @config.options.query_type == nil
           @config.logger.mesg("Unable to guess type of query. You must specify it.")
-          exit
+          return
         else
           @config.logger.trace("Assuming query value is " + @config.options.query_type)
         end
@@ -626,7 +645,10 @@ module NicInfo
             handle_error_response e.response
         end
         @config.logger.trace("Server response code was " + e.response.code)
+      rescue Net::HTTPRetriableError => e
+        @config.logger.mesg("Too many redirections, retries, or a redirect loop has been detected." )
       end
+
       return retval
     end
 
@@ -655,42 +677,59 @@ module NicInfo
           case @config.options.query_type
             when QueryType::BY_IP4_ADDR
               NicInfo::display_ip( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_NETWORK )
             when QueryType::BY_IP6_ADDR
               NicInfo::display_ip( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_NETWORK )
             when QueryType::BY_IP4_CIDR
               NicInfo::display_ip( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_NETWORK )
             when QueryType::BY_IP6_CIDR
               NicInfo::display_ip( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_NETWORK )
             when QueryType::BY_IP
               NicInfo::display_ip( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_NETWORK )
             when QueryType::BY_AS_NUMBER
               NicInfo::display_autnum( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_AUTNUM )
             when "NicInfo::DsData"
               NicInfo::display_ds_data( json_data, @config, data_tree )
             when "NicInfo::KeyData"
               NicInfo::display_key_data( json_data, @config, data_tree )
             when QueryType::BY_DOMAIN
               NicInfo::display_domain( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_DOMAIN )
             when QueryType::BY_NAMESERVER
               NicInfo::display_ns( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_NAMESERVER )
             when QueryType::BY_ENTITY_HANDLE
               NicInfo::display_entity( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_ENTITY )
             when QueryType::SRCH_DOMAINS
               NicInfo::display_domains( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_DOMAIN_SEARCH )
             when QueryType::SRCH_DOMAIN_BY_NAME
               NicInfo::display_domains( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_DOMAIN_SEARCH )
             when QueryType::SRCH_DOMAIN_BY_NSNAME
               NicInfo::display_domains( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_DOMAIN_SEARCH )
             when QueryType::SRCH_DOMAIN_BY_NSIP
               NicInfo::display_domains( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_DOMAIN_SEARCH )
             when QueryType::SRCH_ENTITY_BY_NAME
               NicInfo::display_entities( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_ENTITY_SEARCH )
             when QueryType::SRCH_NS
               NicInfo::display_nameservers( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_NAMESERVER_SEARCH )
             when QueryType::SRCH_NS_BY_NAME
               NicInfo::display_nameservers( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_NAMESERVER_SEARCH )
             when QueryType::SRCH_NS_BY_IP
               NicInfo::display_nameservers( json_data, @config, data_tree )
+              do_jcr( json_data, NicInfo::JCR_ROOT_NAMESERVER_SEARCH )
           end
           @config.save_as_yaml( NicInfo::LASTTREE_YAML, data_tree ) if !data_tree.empty?
           show_search_results_truncated json_data
@@ -721,6 +760,53 @@ module NicInfo
       end
     end
 
+    def get_jcr_context
+      if @jcr_context != nil
+        return @jcr_context
+      end
+      #else
+      ruleset_file = File.join( File.dirname( __FILE__ ), NicInfo::JCR_DIR, NicInfo::RDAP_JCR )
+      ruleset = File.open( ruleset_file ).read
+      @jcr_context = JCR::Context.new(ruleset, false )
+      return @jcr_context
+    end
+
+    def get_jcr_strict_context
+      if @jcr_strict_context != nil
+        return @jcr_strict_context
+      end
+      #else
+      strict_file = File.join( File.dirname( __FILE__ ), NicInfo::JCR_DIR, NicInfo::STRICT_RDAP_JCR )
+      strict = File.open( strict_file ).read
+      rdap_context = get_jcr_context()
+      @jcr_strict_context = rdap_context.override(strict )
+      return @jcr_strict_context
+    end
+
+    def do_jcr( json_data, root_name )
+
+      jcr_context = nil
+      if config.options.jcr == JcrMode::STANDARD_VALIDATION
+        config.logger.trace( "Standard JSON Content Rules validation mode enabled.")
+        jcr_context = get_jcr_context()
+      elsif config.options.jcr == JcrMode::STRICT_VALIDATION
+        config.logger.trace( "Strict JSON Content Rules validation mode enabled.")
+        jcr_context = get_jcr_strict_context()
+      else
+        return
+      end
+
+      e1 = jcr_context.evaluate( json_data, root_name )
+
+      unless e1.success
+        jcr_context.failure_report.each do |line|
+          config.conf_msgs << line
+        end
+      else
+        config.logger.trace( "JSON Content Rules validation was successful." )
+      end
+    end
+
     def help
 
       puts NicInfo::VERSION_LABEL
@@ -978,8 +1064,9 @@ HELP_SUMMARY
       return if @config.conf_msgs.size == 0
       @config.logger.mesg( "** WARNING: There are problems in the response that might cause some data to discarded. **", NicInfo::AttentionType::ERROR )
       i = 1
+      pad = @config.conf_msgs.length.to_s.length
       @config.conf_msgs.each do |msg|
-        @config.logger.trace( "#{i} : #{msg}", NicInfo::AttentionType::ERROR )
+        @config.logger.trace( "#{i.to_s.rjust(pad," ")} : #{msg}", NicInfo::AttentionType::ERROR )
         i = i + 1
       end
     end
@@ -1032,7 +1119,7 @@ HELP_SUMMARY
 
 QUERIES
   For most query values, the query type is inferred. However, some types of queries
-  cannot be inferred and so the -t option must be used. The domain search by name
+  cannot be inferred and so the -t parameter must be used. The domain search by name
   (dsbyname) and entity search by name (esbyname) queries can take wildcards ('*'),
   but these must be quoted or escaped to avoid processing by the invoking OS shell
   on Unix-like operating systems.
@@ -1054,11 +1141,11 @@ CONFIGURATION
 
 CACHING
   This program will write query responses to a cache. By default, answers are pulled
-  from the cache if present. This can be turned on or off with the --cache option or
+  from the cache if present. This can be turned on or off with the --cache parameter or
   using the cache/use_cache value in the configuration file.
 
   Expiration of items in the cache and eviction of items from the cache can also be
-  controlled. The cache can be manually emptied using the --empty-cache option.
+  controlled. The cache can be manually emptied using the --empty-cache parameter.
 
 BOOTSTRAPPING
   Bootstrapping is the process of finding an appropriate RDAP server in which to send
@@ -1079,15 +1166,15 @@ BOOTSTRAPPING
   configuration file).
 
 USAGE FOR SCRIPTING
-  For usage with shell scripting, there are a couple of useful command line switches.
+  For usage with shell scripting, there are a couple of useful command line parameters.
 
-  The --json option suppresses the human-readable output and instead emits the JSON
+  The --json parameter suppresses the human-readable output and instead emits the JSON
   returned by the server. When not writing to an output file, this options should be
   used with the -Q option to suppress the pager and program runtime messages so that
   the JSON maybe run through a JSON parser.
 
-  The --jv option instructs this program to parse the JSON and emit specific JSON
-  values.  This option is also useful in combination with the -Q option to feed the
+  The --jv parameter instructs this program to parse the JSON and emit specific JSON
+  values.  This parameter is also useful in combination with the -Q option to feed the
   JSON values into other programs.  The syntax for specifying a JSON value is a
   list of JSON object member names or integers signifying JSON array indexes separated
   by a period, such as name1.name2.3.name4.5. For example, "entities.0.handle" would
@@ -1095,16 +1182,27 @@ USAGE FOR SCRIPTING
 
     { "entities" : [ { "handle": "foo" } ] }
 
-  Multiple --jv options may be specified.
+  Multiple --jv parameters may be specified.
 
 DEMONSTRATION QUERIES
   There are several built-in demonstration queries that may be exercised to show the
-  utility of RDAP. To use these queries, the --demo option must be used to populate
+  utility of RDAP. To use these queries, the --demo parameter must be used to populate
   the query answers into the cache. If the cache is already populated with items, it
-  may be necessary to clean the cache using the --empty-cache option.
+  may be necessary to clean the cache using the --empty-cache parameter.
 
-  When the --demo option is given, the list of demonstration queries will be printed
+  When the --demo parameter is given, the list of demonstration queries will be printed
   out.
+
+RDAP VALIDATION
+  This program has built-in checks for verifying the validity of RDAP responses.
+  Beyond these normal built-in checks, it can also JSON Content Rules to check
+  the validity of the responses using the --jcr parameter, which requires either
+  the standard (i.e. --jcr standard) or strict (i.e. --jcr strict) parameter
+  options.
+
+MORE INFORMATION
+  More information about this program may be found at 
+  https://github.com/arineng/nicinfo/wiki
 EXTENDED_HELP
 
 end

data/lib/nicinfo/notices.rb

@@ -15,6 +15,7 @@
 require 'nicinfo/config'
 require 'nicinfo/nicinfo_logger'
 require 'nicinfo/utils'
+require 'nicinfo/common_json'
 
 module NicInfo
 
@@ -25,6 +26,7 @@ module NicInfo
 
     def initialize( config )
       @config = config
+      @common = CommonJson.new( config )
     end
 
     def is_excessive_notice notices
@@ -92,22 +94,7 @@ module NicInfo
         @config.conf_msgs << "'description' in 'notice' is not an array."
       end
       links = notice[ "links" ]
-      if links
-        if links.instance_of?( Array )
-          alternate = NicInfo.get_alternate_link links
-          @config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "More", alternate, NicInfo::AttentionType::SECONDARY if alternate
-          about = NicInfo.get_about_link links
-          @config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "About", about, NicInfo::AttentionType::SECONDARY if about
-          tos = NicInfo.get_tos_link links
-          @config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "TOS", tos, NicInfo::AttentionType::SECONDARY if tos
-          copyright = NicInfo.get_copyright_link links
-          @config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "(C)", copyright, NicInfo::AttentionType::SECONDARY if copyright
-          license = NicInfo.get_license_link links
-          @config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "License", license, NicInfo::AttentionType::SECONDARY if license
-        else
-          @config.conf_msgs << "'links' is not an array."
-        end
-      end
+      @common.display_simple_links( links )
       @config.logger.end_data_item
     end
 

data/lib/nicinfo/ns.rb

@@ -66,7 +66,7 @@ module NicInfo
       @config.logger.start_data_item
       @config.logger.data_title "[ NAME SERVER ]"
       @config.logger.terse "Handle", NicInfo::get_handle( @objectclass ), NicInfo::AttentionType::SUCCESS
-      @config.logger.extra "Object Class Name", NicInfo::get_object_class_name( @objectclass )
+      @config.logger.extra "Object Class Name", NicInfo::get_object_class_name( @objectclass, "nameserver", @config )
       @config.logger.terse "Host Name", NicInfo::get_ldhName( @objectclass ), NicInfo::AttentionType::SUCCESS
       @config.logger.terse "IDN Host Name", NicInfo::get_unicodeName( @objectclass ), NicInfo::AttentionType::SUCCESS
       ipAddrs = @objectclass[ "ipAddresses" ]

data/lib/nicinfo/utils.rb

@@ -55,8 +55,14 @@ module NicInfo
     return json_data[ "handle" ]
   end
 
-  def NicInfo.get_object_class_name json_data
-    return json_data[ "objectClassName" ]
+  def NicInfo.get_object_class_name json_data, expected, config
+    objectClassName =  json_data[ "objectClassName" ]
+    if objectClassName == nil
+      config.conf_msgs << "Expected 'objectClassName' is not present."
+    elsif objectClassName != expected
+      config.conf_msgs << "Expected 'objectClassName' to be '#{expected}' but it is '#{objectClassName}'."
+    end
+    return objectClassName
   end
 
   def NicInfo.get_ldhName json_data

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nicinfo
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Andrew Newton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2018-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netaddr
@@ -30,6 +30,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: jcrvalidator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
 description: A command-line RDAP client.
 email: andy@arin.net
 executables:
@@ -77,6 +105,8 @@ files:
 - lib/nicinfo/factory.rb
 - lib/nicinfo/female-first-names.txt
 - lib/nicinfo/ip.rb
+- lib/nicinfo/jcr/rdap.jcr
+- lib/nicinfo/jcr/strict.jcr
 - lib/nicinfo/key_data.rb
 - lib/nicinfo/last-names.txt
 - lib/nicinfo/male-first-names.txt