nicinfo 1.3.0.pre.alpha1 → 1.5.0

data/lib/nicinfo/nicinfo_main.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2011,2012,2013,2014 American Registry for Internet Numbers
+# Copyright (C) 2011-2017 American Registry for Internet Numbers
 #
 # Permission to use, copy, modify, and/or distribute this software for any
 # purpose with or without fee is hereby granted, provided that the above
@@ -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|
 
@@ -199,6 +209,15 @@ module NicInfo
           raise OptionParser::InvalidArgument, pager.to_s unless pager =~ /yes|no|true|false/i
         end
 
+        opts.on( "--color-scheme DARK|LIGHT|NONE",
+                 "Determines color scheme to use:",
+                 "  dark  - for terminals with dark backgrounds",
+                 "  light - for terminals with light backgrounds",
+                 "  none  - turn off colors" ) do |cs|
+          @config.logger.color_scheme = cs.to_s.upcase
+          raise OptionParser::InvalidArgument, cs.to_s unless cs =~ /dark|light|none/i
+        end
+
         opts.on( "-V",
                  "Equivalent to --messages all and --data extra" ) do |v|
           @config.logger.data_amount = NicInfo::DataAmount::EXTRA_DATA
@@ -256,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
@@ -379,7 +407,7 @@ module NicInfo
     def run
 
       @config.logger.run_pager
-      @config.logger.mesg(NicInfo::VERSION_LABEL)
+      @config.logger.mesg(NicInfo::VERSION_LABEL, NicInfo::AttentionType::PRIMARY )
       @config.setup_workspace
       @config.check_config_version
       @cache = Cache.new(@config)
@@ -395,16 +423,16 @@ module NicInfo
         check_bsfiles_age = @config.check_bsfiles_age?
         update_bsfiles = @config.update_bsfiles?( check_bsfiles_age )
         if update_bsfiles
-          @config.logger.mesg( "IANA RDAP bootstrap files are old and need to be updated." )
+          @config.logger.mesg( "IANA RDAP bootstrap files are old and need to be updated.", NicInfo::AttentionType::ERROR )
           get_iana_files
         elsif check_bsfiles_age
-          @config.logger.mesg( "IANA RDAP bootstrap files are old. Update them with --iana option" )
+          @config.logger.mesg( "IANA RDAP bootstrap files are old. Update them with --iana option", NicInfo::AttentionType::ERROR )
         end
       end
 
       if @config.options.demo
-        @config.logger.mesg( "Populating cache with demonstration results" )
-        @config.logger.mesg( "Try the following demonstration queries:" )
+        @config.logger.mesg( "Populating cache with demonstration results", NicInfo::AttentionType::INFO )
+        @config.logger.mesg( "Try the following demonstration queries:", NicInfo::AttentionType::INFO )
         demo_dir = File.join( File.dirname( __FILE__ ), NicInfo::DEMO_DIR )
         demo_files = Dir::entries( demo_dir )
         demo_files.each do |file|
@@ -415,7 +443,7 @@ module NicInfo
             demo_url = json_data[ NicInfo::NICINFO_DEMO_URL ]
             demo_hint = json_data[ NicInfo::NICINFO_DEMO_HINT ]
             @cache.create( demo_url, demo_data )
-            @config.logger.mesg( "  " + demo_hint )
+            @config.logger.mesg( "  " + demo_hint, NicInfo::AttentionType::INFO )
           end
         end
       end
@@ -426,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
@@ -440,9 +468,9 @@ 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"])
+          @config.logger.mesg("Your IP address is " + json_data["data"]["ip"], NicInfo::AttentionType::SUCCESS )
           @config.options.argv[0] = json_data["data"]["ip"]
         end
       end
@@ -472,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]
@@ -482,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
@@ -506,7 +534,7 @@ module NicInfo
           end
         else
           json_data = do_rdap_query
-          display_rdap_query( json_data, true )
+          display_rdap_query( json_data, true ) if json_data
       end
 
 
@@ -521,6 +549,7 @@ module NicInfo
     end
 
     def do_rdap_query
+      retval = nil
       if @config.config[ NicInfo::BOOTSTRAP ][ NicInfo::BOOTSTRAP_URL ] == nil && !@config.options.url
         bootstrap = Bootstrap.new( @config )
         qtype = @config.options.query_type
@@ -578,56 +607,60 @@ module NicInfo
         end
         inspect_rdap_compliance json_data
         cache_self_references json_data
-        json_data
+        retval = json_data
       rescue JSON::ParserError => a
-        @config.logger.mesg( "Server returned invalid JSON!" )
+        @config.logger.mesg( "Server returned invalid JSON!", NicInfo::AttentionType::ERROR )
       rescue SocketError => a
-        @config.logger.mesg(a.message)
+        @config.logger.mesg(a.message, NicInfo::AttentionType::ERROR )
       rescue ArgumentError => a
-        @config.logger.mesg(a.message)
+        @config.logger.mesg(a.message, NicInfo::AttentionType::ERROR )
       rescue Net::HTTPServerException => e
         case e.response.code
           when "200"
-            @config.logger.mesg( e.message )
+            @config.logger.mesg( e.message, NicInfo::AttentionType::SUCCESS )
           when "401"
-            @config.logger.mesg("Authorization is required.")
+            @config.logger.mesg("Authorization is required.", NicInfo::AttentionType::ERROR )
             handle_error_response e.response
           when "404"
-            @config.logger.mesg("Query yielded no results.")
+            @config.logger.mesg("Query yielded no results.", NicInfo::AttentionType::INFO )
             handle_error_response e.response
           else
-            @config.logger.mesg("Error #{e.response.code}.")
+            @config.logger.mesg("Error #{e.response.code}.", NicInfo::AttentionType::ERROR )
             handle_error_response e.response
         end
         @config.logger.trace("Server response code was " + e.response.code)
       rescue Net::HTTPFatalError => e
         case e.response.code
           when "500"
-            @config.logger.mesg("RDAP server is reporting an internal error.")
+            @config.logger.mesg("RDAP server is reporting an internal error.", NicInfo::AttentionType::ERROR )
             handle_error_response e.response
           when "501"
-            @config.logger.mesg("RDAP server does not implement the query.")
+            @config.logger.mesg("RDAP server does not implement the query.", NicInfo::AttentionType::ERROR )
             handle_error_response e.response
           when "503"
-            @config.logger.mesg("RDAP server is reporting that it is unavailable.")
+            @config.logger.mesg("RDAP server is reporting that it is unavailable.", NicInfo::AttentionType::ERROR )
             handle_error_response e.response
           else
-            @config.logger.mesg("Error #{e.response.code}.")
+            @config.logger.mesg("Error #{e.response.code}.", NicInfo::AttentionType::ERROR )
             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
 
     def display_rdap_query json_data, show_help = true
       if @config.options.output_json
-        @config.logger.raw( DataAmount::TERSE_DATA, json_data, false )
+        @config.logger.raw( DataAmount::TERSE_DATA, JSON.generate( json_data ), false )
       elsif @config.options.json_values
         @config.options.json_values.each do |value|
-          @config.logger.raw( DataAmount::TERSE_DATA, eval_json_value( value, json_data), false )
+          @config.logger.raw( DataAmount::TERSE_DATA, JSON.generate( eval_json_value( value, json_data) ), false )
         end
       else
-        Notices.new.display_notices json_data, @config, @config.options.query_type == QueryType::BY_SERVER_HELP
+        @config.factory.new_notices.display_notices json_data, @config.options.query_type == QueryType::BY_SERVER_HELP
         if @config.options.query_type != QueryType::BY_SERVER_HELP
           result_type = get_query_type_from_result( json_data )
           if result_type != nil
@@ -644,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
@@ -694,8 +744,8 @@ module NicInfo
     if res["content-type"] == NicInfo::RDAP_CONTENT_TYPE && res.body && res.body.to_s.size > 0
         json_data = JSON.load( res.body )
         inspect_rdap_compliance json_data
-        Notices.new.display_notices json_data, @config, true
-        ErrorCode.new.display_error_code json_data, @config
+        @config.factory.new_notices.display_notices json_data, true
+        @config.factory.new_error_code.display_error_code( json_data )
       end
     end
 
@@ -703,13 +753,60 @@ module NicInfo
       rdap_conformance = json[ "rdapConformance" ]
       if rdap_conformance
         rdap_conformance.each do |conformance|
-          @config.logger.trace( "Server conforms to #{conformance}" )
+          @config.logger.trace( "Server conforms to #{conformance}", NicInfo::AttentionType::SECONDARY )
         end
       else
         @config.conf_msgs << "Response has no RDAP Conformance level specified."
       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
@@ -965,10 +1062,11 @@ HELP_SUMMARY
 
     def show_conformance_messages
       return if @config.conf_msgs.size == 0
-      @config.logger.mesg( "** WARNING: There are problems in the response that might cause some data to discarded. **" )
+      @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}" )
+        @config.logger.trace( "#{i.to_s.rjust(pad," ")} : #{msg}", NicInfo::AttentionType::ERROR )
         i = i + 1
       end
     end
@@ -977,7 +1075,7 @@ HELP_SUMMARY
       truncated = json_data[ "searchResultsTruncated" ]
       if truncated.instance_of?(TrueClass) || truncated.instance_of?(FalseClass)
         if truncated
-          @config.logger.mesg( "Results have been truncated by the server." )
+          @config.logger.mesg( "Results have been truncated by the server.", NicInfo::AttentionType::INFO )
         end
       end
       if truncated != nil
@@ -1021,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.
@@ -1043,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
@@ -1068,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
@@ -1084,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