irrc 0.1.0

data/lib/irrc/connecting.rb

@@ -0,0 +1,39 @@
+module Irrc
+  module Connecting
+    private
+
+    def connection
+      @connection
+    end
+
+    def connection=(connection)
+      @connection = connection
+    end
+
+    def connect
+      @connection ||= logger.info("Connecting to #{@host}") &&
+        Net::Telnet.new('Host' => @host,
+        'Port' => 43,
+        'Telnetmode' => false,
+        'Prompt' => return_code)
+    end
+
+    def close
+      if established?
+        logger.info "Closing a connection to #{@host}"
+        @connection.close
+      end
+    end
+
+    def established?
+      @connection && !@connection.sock.closed?
+    end
+
+    def execute(command)
+      return if command.nil? || command == ''
+
+      logger.debug "Executing: #{command}"
+      @connection.cmd(command).tap {|result| logger.debug "Returned: #{result}" }
+    end
+  end
+end

data/lib/irrc/irr.rb

@@ -0,0 +1,123 @@
+module Irrc
+  module Irr
+    class << self
+      def host(name)
+        irr_list[irr_name(name)]
+      end
+
+      def irr?(name)
+        irr_list.keys.include?(irr_name(name))
+      end
+
+      def type(name)
+        type_list[irr_name(name)] || type_list[fqdn(name)]
+      end
+
+      # See RFC2622 / RFC4012 for details
+      def members_tag
+        /^(?:mp-)?members:\s*(.*)$/
+      end
+
+      # See RFC2622 / RFC4012 for details
+      def route_tag(protocol)
+        case protocol
+        when :ipv4, 'ipv4'
+          /^route:\s*(\S+)$/
+        when :ipv6, 'ipv6'
+          /^route6:\s*(\S+)$/
+        end
+      end
+
+      private
+
+      def irr_list
+        @_irr_list ||= Hash[LIST.map {|i| [i[0], i[1]] }]
+      end
+
+      def type_list
+        @_type_list ||= Hash[LIST.map {|i| [[i[0], i[2]], [i[1], i[2]]] }.flatten(1)]
+      end
+
+      def irr_name(name)
+        name.to_s.upcase
+      end
+
+      def fqdn(fqdn)
+        fqdn.to_s.downcase
+      end
+
+      # See http://www.irr.net/docs/list.html
+      LIST = [
+        ['ALTDB',        'whois.altdb.net',         'irrd'],
+        ['AOLTW',        'whois.aoltw.net',         'irrd'],
+        ['APNIC',        'whois.apnic.net',         'whoisd'],
+        ['ARIN',         'rr.arin.net',             'whoisd'],
+#        ['BCNET',        'whois.bc.net',            nil],
+        ['BELL',         'whois.in.bell.ca',        'irrd'],
+        ['BBOI',         'irr.bboi.net',            'irrd'],
+        ['CANARIE',      'whois.canarie.ca',        'whoisd'],
+        ['D',            'whois.depository.net',    'whoisd'],
+#        ['DERU',         'whois.deru.net',          nil],
+#        ['DIGITALREALM', 'rr.digitalrealm.net',     nil],
+        ['EASYNET',      'whois.noc.easynet.net',   'whoisd'],
+#        ['EBIT',         'whois.ebit.ca',           nil],
+        ['EPOCH',        'whois.epoch.net',         'irrd'],
+        ['GT',           'rr.gt.ca',                'irrd'],
+#        ['GW',           'whois.gw.net',            nil],
+        ['HOST',         'rr.host.net',             'irrd'],
+        ['JPIRR',        'jpirr.nic.ad.jp',         'irrd'],
+        ['LEVEL3',       'rr.level3.net',           'whoisd'],
+#        ['MTO',          'rr.mtotelecom.com',       nil],
+        ['NESTEGG',      'whois.nestegg.net',       'irrd'],
+        ['NTTCOM',       'rr.ntt.net',              'irrd'],
+        ['OPENFACE',     'whois.openface.ca',       'irrd'],
+        ['OTTIX',        'whois.ottix.net',         'irrd'],
+        ['PANIX',        'rrdb.access.net',         'irrd'],
+        ['RADB',         'whois.radb.net',          'irrd'],
+        ['REACH',        'rr.net.reach.com',        'irrd'],
+        ['RGNET',        'whois.rg.net',            'irrd'],
+        ['RIPE',         'whois.ripe.net',          'whoisd'],
+        ['RISQ',         'rr.risq.net',             'irrd'],
+        ['ROGERS',       'whois.rogerstelecom.net', 'irrd'],
+        ['SAVVIS',       'rr.savvis.net',           'whoisd'],
+        ['TC',           'bgp.net.br',              'irrd']
+      ]
+    end
+
+
+    def object
+      @_object
+    end
+
+    def object=(object)
+      @_object = object
+    end
+
+    # Public: Returns the object type to query.
+    # See RFC2622 for details.
+    #
+    # Returns: A String. ('as-set', 'route-set' or 'aut-num')
+    def object_type
+      case @_object
+      when /^AS-[\w-]+$|:AS-[\w-]+$/i
+        'as-set'
+      when /^RS-[\w-]+$|:RS-[\w-]+$/i
+        'route-set'
+      when /^AS\d+$|:AS\d+$/i
+        'aut-num'
+      end
+    end
+
+    def as_set?
+      object_type == 'as-set'
+    end
+
+    def route_set?
+      object_type == 'route-set'
+    end
+
+    def aut_num?
+      object_type == 'aut-num'
+    end
+  end
+end

data/lib/irrc/irrd.rb

@@ -0,0 +1 @@
+require 'irrc/irrd/client'

data/lib/irrc/irrd/api.rb

@@ -0,0 +1,69 @@
+require 'irrc/irr'
+
+module Irrc
+  module Irrd
+    module Api
+      private
+
+      def persist_command
+        '!!'
+      end
+
+      # Public: Returns a IRR command to specify authoritative IRR source.
+      #
+      # sources - Array object containing IRR source names.
+      def set_source_command(sources)
+        if sources && !sources.empty?
+          "!s#{sources.join(',')}"
+        else
+          '!s-*'
+        end
+      end
+
+      def expand_set_command(as_set)
+        "!i#{as_set},1" if as_set && as_set != ''
+      end
+
+      def parse_aut_nums_from_as_set(result)
+        case result
+        when success_code
+          result.gsub(/^#{$1}$/, '').strip.split.grep(/^AS/).uniq
+        when error_code
+          raise $1
+        end
+      end
+
+      def parse_prefixes_from_route_set(result)
+        case result
+        when success_code
+          result.gsub(/^#{$1}$/, '').strip.split.reject {|p| p =~ /^A\d+$/ }.uniq
+        when error_code
+          raise $1
+        end
+      end
+
+      def expand_aut_num_command(autnum)
+        "-K -r -i origin #{autnum}" if autnum && autnum != ''
+      end
+
+      def parse_prefixes_from_aut_num(result, protocol)
+        result.scan(Irrc::Irr.route_tag(protocol)).flatten.uniq
+      end
+
+      # See http://www.irrd.net/irrd-user.pdf for return codes
+      def success_code
+        /^(C.*)\n$/
+      end
+
+      def error_code
+        /^(D|E|F.*)\n$/
+      end
+
+      def return_code
+        # Query with ripe option commands like "-i origin AS2515" returns doubled blank lines.
+        # And we can't easily tell whether it succeeded or not.
+        Regexp.union(success_code, error_code, /^\n\n$/)
+      end
+    end
+  end
+end

data/lib/irrc/irrd/client.rb

@@ -0,0 +1,90 @@
+require 'net/telnet'
+
+require 'irrc/connecting'
+require 'irrc/logging'
+require 'irrc/parameter'
+require 'irrc/prefix'
+require 'irrc/runner'
+require 'irrc/socket'
+require 'irrc/irrd/api'
+
+module Irrc
+  module Irrd
+
+    # Public: IRRd client worker.
+    class Client
+      include Irrc::Connecting
+      include Irrc::Logging
+      include Irrc::Parameter
+      include Irrc::Prefix
+      include Irrc::Runner
+      include Irrc::Irrd::Api
+
+      attr_reader :host, :queue
+
+
+      private
+
+      def connect
+        super
+        connection.puts persist_command
+      end
+
+      def process(query)
+        set_source query
+
+        case query.object_type
+        when 'as-set'
+          resolve_aut_nums_from_as_set query
+          resolve_prefixes_from_aut_nums query
+        when 'route-set'
+          resolve_prefixes_from_route_set query
+        when 'aut-num'
+          query.add_aut_num_result query.object
+          resolve_prefixes_from_aut_nums query
+        end
+      end
+
+      def set_source(query)
+        command = set_source_command(query.sources)
+        if execute(command) =~ error_code
+          raise "'#{command}' failed on '#{host}' (#{$1})."
+        end
+      end
+
+      def resolve_aut_nums_from_as_set(query)
+        command = expand_set_command(query.object)
+        result = execute(command)
+        query.add_aut_num_result parse_aut_nums_from_as_set(result)
+      rescue
+        raise "'#{command}' failed on '#{host}' (#{$!.message})."
+      end
+
+      def resolve_prefixes_from_route_set(query)
+        command = expand_set_command(query.object)
+        result = execute(command)
+        prefixes = classify_by_protocol(parse_prefixes_from_route_set(result))
+
+        query.protocols.each do |protocol|
+          query.add_prefix_result prefixes[protocol], nil, protocol
+        end
+      rescue
+        raise "'#{command}' failed on '#{host}' (#{$!.message})."
+      end
+
+      def resolve_prefixes_from_aut_nums(query)
+        unless query.protocols.empty?
+          # ipv4 and ipv6 should have the same result so far
+          (query.result[:ipv4] || query.result[:ipv6]).keys.each do |autnum|
+            command = expand_aut_num_command(autnum)
+            result = execute(command)
+
+            query.protocols.each do |protocol|
+              query.add_prefix_result parse_prefixes_from_aut_num(result, protocol), autnum, protocol
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/irrc/logging.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+module Irrc
+  module Logging
+    def logger=(logger)
+      @logger = logger
+    end
+
+    def logger
+      @logger ||= Logger.new(STDERR).tap {|l| l.level = Logger::WARN }
+    end
+  end
+end

data/lib/irrc/parameter.rb

@@ -0,0 +1,37 @@
+module Irrc
+  module Parameter
+
+    # Public: Create a new IRRd / Whoisd client worker.
+    #         You can customize the logger by specifying a block.
+    #         The default logger is STDERR printer of more severe messages than INFO.
+    #
+    # host   - FQDN of IRR / Whois. IRR / Whois name is also accespted.
+    # queue  - Queue object having query jobs.
+    #          IRR / Whois name is also accespted.
+    # block  - An optional block that can be used to customize the logger.
+    #
+    # Examples
+    #
+    #   Irrc::Irrd::Client.new('jpirr.nic.ad.jp', queue) {|c|
+    #     c.logger = Logger.new('irrc.log')
+    #   }
+    def initialize(host, queue, &block)
+      self.host = host
+      self.queue = queue
+      instance_eval(&block) if block_given?
+    end
+
+
+    private
+
+    def host=(host)
+      raise ArgumentError, "Missing argument." unless host
+      @host = Irrc::Irr.host(host) || host
+    end
+
+    def queue=(queue)
+      queue.is_a?(Queue) or raise ArgumentError, "Missing argument."
+      @queue = queue
+    end
+  end
+end

data/lib/irrc/prefix.rb

@@ -0,0 +1,19 @@
+require 'ipaddr'
+
+module Irrc
+  module Prefix
+    private
+
+    def classify_by_protocol(prefixes)
+      prefixes.each_with_object(Struct.new(:ipv4, :ipv6).new([], [])) {|prefix, result|
+        addr = IPAddr.new(prefix)
+        if addr.ipv4?
+          result.ipv4 << prefix
+        elsif addr.ipv6?
+          result.ipv6 << prefix
+        end
+      }
+    end
+  end
+end
+

data/lib/irrc/query.rb

@@ -0,0 +1,78 @@
+require 'irrc/irr'
+require 'irrc/query_status'
+require 'irrc/subquery'
+
+module Irrc
+
+  # Public: IRR / Whois query and result container.
+  class Query
+    include Irrc::Irr
+    include Irrc::QueryStatus
+    include Irrc::Subquery
+
+    attr_reader :sources, :protocols
+
+    # Public: Create a new Query object.
+    #
+    # object  - IRR object to extract. (eg: as-set, route-set, aut-num object)
+    # options - The Hash options to pass to IRR. (default: {procotol: [:ipv4, :ipv6]})
+    #           :source   - Specify authoritative IRR source names.
+    #                       If not given, any source will be accepted. (optional)
+    #           :protocol - :ipv4, :ipv6 or [:ipv4, :ipv6]
+    #                       A String or Symbol of protcol name is acceptable. (optional)
+    #
+    # Examples
+    #
+    #   Irrc::Query.new('AS-JPNIC', source: :jpirr, protocol: :ipv4)
+    #   Irrc::Query.new('AS-JPNIC', source: [:jpirr, :radb])
+    def initialize(object, options={})
+      options = {protocol: [:ipv4, :ipv6]}.merge(options)
+      self.sources = options[:source]
+      self.protocols = options[:protocol]
+      self.object = object.to_s
+    end
+
+    def result
+      @result ||= Struct.new(:ipv4, :ipv6).new
+    end
+
+    # Public: Register aut-num object(s) as a result.
+    #
+    # autnums - aut-num object(s) in String. Array form is also acceptable for multiple objects.
+    def add_aut_num_result(autnums)
+      @protocols.each do |protocol|
+        result[protocol] ||= {}
+
+        Array(autnums).each do |autnum|
+          result[protocol][autnum] ||= []
+        end
+      end
+    end
+
+    # Public: Register route object(s) as a result.
+    #
+    # prefixes - route object(s) in String. Array form is also acceptable for multiple objects.
+    # autnum   - Which aut-num has the route object(s).
+    # protocol - Which protocol the route object(s) is for. :ipv4 or :ipv6.
+    #            A String or Symbol of protcol name is acceptable.
+    def add_prefix_result(prefixes, autnum, protocol)
+      result[protocol] ||= {}
+      result[protocol][autnum] ||= []
+      result[protocol][autnum] |= Array(prefixes)
+    end
+
+
+    private
+
+    def sources=(sources)
+      @sources = Array(sources).compact.map(&:to_s).flatten.uniq
+    end
+
+    def protocols=(protocols)
+      protocols = Array(protocols).compact.map(&:to_s).flatten.uniq
+      invalid = protocols - ['ipv4', 'ipv6']
+      raise ArgumentError, "Invalid protocol: #{invalid.join(', ')}" unless invalid.empty?
+      @protocols = protocols
+    end
+  end
+end