rbl_mcafee 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fe5d6a370c1562c43a58901f5447ec61e5f5b04
-  data.tar.gz: 52a905ddb5c3152984669ee13cf3a49d95aaa258
+  metadata.gz: 4e020eef8e74971b1837a2c58f2897ea9b8bab9a
+  data.tar.gz: 795633fa1241d021c7dcfe73116d97e3f7c57fa8
 SHA512:
-  metadata.gz: 4aaaccad3566c5953089602333488cb755619f5a7e6af43b5117d6e9913656f8269341cbf4ab4905db2e9db52c6eb4840a31b9a090aa662fe7320df9c8e331c1
-  data.tar.gz: e3f4737e92750d0326e340d86bace22c1c856ced8eb2526870f25ab7094209f93eb7c1477a27979a00e290b75ba570bd556d5c300b348fd4b8e2c9b8b72f74ad
+  metadata.gz: 7699ffe783f39a5a5c38a67dc2e5206bb3c6e73d601b2c05391b54514a4ab77911d4112a133bda0a20a5797744c7542e2cf8aaf9d924dd978d8147058e15bc22
+  data.tar.gz: 0f2050bcce6d2ee3e449bcf6bdbad74b7aa72b1d542a5c9441428f0184f87362be1fb7bb0327a31d57be9851a08c38b7dedacea2d1102c45e4cf7d0e82c4f8ed

data/README.md

@@ -2,6 +2,8 @@
 
 Solution to test if an IP address is listed in the McAfee RBL.
 
+McAfee uses the Spamhaus Project (https://www.spamhaus.org/).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,16 +20,19 @@ Or install it yourself as:
 
 ## Usage
 
-To verify if an IP address is listed in the McAfee RBL:
+To verify if an IP address is listed in one of the Spamhaus IP zones:
 
 ```ruby
-RblMcafee.blacklisted?('127.0.0.1')
+zone = RblMcafee::Zone.new('127.0.0.1')
+zone.pbl?
+zone.sbl?
+zone.xbl?
 ```
 
 Expected returned values are the following:
 
-* `true` when the IP address **is listed** in the McAfee RBL
-* `false` when the IP address **isn't listed** in the McAfee RBL
+* `true` when the IP address **is listed** in the zone
+* `false` when the IP address **isn't listed** in the zone
 
 When a **timeout** occurs, a `RblMcafee::Timeout` exception is raised.
 

data/lib/rbl_mcafee.rb

@@ -1,27 +1,9 @@
 require "rbl_mcafee/version"
-require 'resolv'
 
 module RblMcafee
   # Indicates a timeout checking an IP address
   class Timeout < TimeoutError; end
 
-  # @see https://kc.mcafee.com/corporate/index?page=content&id=KB53783
-  # If the reply is in the format 127.0.0.XXX, the host is listed in the McAfee
-  # RBL
-  MC_AFEE_RBL_LISTED_REGEX = /^127\.0\.0\.\d{1,3}$/
-
-  def self.blacklisted?(ip)
-    if !ip.match(Resolv::IPv6::Regex) && !ip.match(Resolv::IPv4::Regex)
-      raise ArgumentError, 'Invalid IP'
-    end
-
-    reversed_ip = ip.split('.').reverse.join('.')
-    resolved_ip = Resolv::getaddress("#{reversed_ip}.cidr.bl.mcafee.com")
-    return !!resolved_ip.match(MC_AFEE_RBL_LISTED_REGEX)
-
-    rescue Resolv::ResolvError
-      false
-    rescue Resolv::ResolvTimeout
-      raise RblMcafee::Timeout
-  end
+  # Indicates a failure to resolve an IP address
+  class Error < StandardError; end;
 end

data/lib/rbl_mcafee/ip.rb

@@ -0,0 +1,23 @@
+module RblMcafee
+  class Ip
+    attr_reader :ip
+
+    def initialize(ip)
+      @ip = ip
+    end
+
+    def valid?
+      ipv4? || ipv6?
+    end
+
+    private
+
+    def ipv4?
+      !!ip.match(Resolv::IPv4::Regex)
+    end
+
+    def ipv6?
+      !!ip.match(Resolv::IPv6::Regex)
+    end
+  end
+end

data/lib/rbl_mcafee/version.rb

@@ -1,3 +1,3 @@
 module RblMcafee
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/lib/rbl_mcafee/zone.rb

@@ -0,0 +1,81 @@
+require "rbl_mcafee/version"
+require "rbl_mcafee/ip"
+require 'resolv'
+
+module RblMcafee
+  class Zone
+    PBL = :pbl
+    SBL = :sbl
+    XBL = :xbl
+
+    attr_reader :ip
+
+    def initialize(ip)
+      raise ArgumentError, 'Invalid IP' unless RblMcafee::Ip.new(ip).valid?
+
+      @ip = ip
+    end
+
+    def pbl?
+      zone == PBL
+    end
+
+    def sbl?
+      zone == SBL
+    end
+
+    def xbl?
+      zone == XBL
+    end
+
+
+  private
+
+    def zone
+      return @zone if defined? @zone
+
+      @zone = extract_zone(resolved_ip)
+    end
+
+    # Lookup the IP address on "cidr.bl.mcafee.com"
+    def resolved_ip
+      return @resolved_ip if defined? @resolved_ip
+
+      reversed_ip = ip.split('.').reverse.join('.')
+      @resolved_ip = Resolv::getaddress("#{reversed_ip}.cidr.bl.mcafee.com")
+
+      rescue Resolv::ResolvError
+        @resolved_ip = nil
+      rescue Resolv::ResolvTimeout
+        raise RblMcafee::Timeout
+    end
+
+
+    # @see https://kc.mcafee.com/corporate/index?page=content&id=KB53783
+    # If the reply is in the format 127.0.0.XXX, the host is listed in the
+    # McAfee RBL (@see below)
+    MC_AFEE_RBL_LISTED_REGEX = /^127\.0\.0\.\d{1,3}$/
+
+    # @see https://www.spamhaus.org/faq/section/DNSBL%20Usage#202
+    #
+    # DNSBL | Returns       | Contains
+    # ------+---------------+---------------------------------------------------
+    # SBL	  | 127.0.0.2-3	  | Static UBE sources, verified spam services
+    #       |               | (hosting or support) and ROKSO spammers
+    # XBL	  | 127.0.0.4-7	  | Illegal 3rd party exploits, including proxies,
+    #       \               | worms and trojan exploits
+    # PBL	  | 127.0.0.10-11	| IP ranges which should not be delivering
+    #       |               | unauthenticated SMTP email.
+    def extract_zone(resolved_ip)
+      return nil if resolved_ip.nil?
+      return nil unless resolved_ip.match(MC_AFEE_RBL_LISTED_REGEX)
+
+      case resolved_ip.split('.').last.to_i
+      when 2..3   then SBL
+      when 4..7   then XBL
+      when 10..11 then PBL
+      else nil
+      end
+    end
+  end
+end

data/spec/rbl_mcafee/ip_spec.rb

@@ -0,0 +1,37 @@
+require 'rbl_mcafee/ip'
+
+describe RblMcafee::Ip do
+  subject { RblMcafee::Ip.new(ip_address) }
+
+  context 'with an IPv4 address' do
+    let(:ip_address) { '1.160.10.240' }
+
+    it 'detects the IP as IPv4' do
+      expect(subject.send(:ipv4?)).to be true
+    end
+
+    it 'does not detect the IP as IPv6' do
+      expect(subject.send(:ipv6?)).to be false
+    end
+
+    it 'detects the IP as valid' do
+      expect(subject.valid?).to be true
+    end
+  end
+
+  context 'with an IPv6 address' do
+    let(:ip_address) { '3ffe:1900:4545:3:200:f8ff:fe21:67cf' }
+
+    it 'does not detect the IP as IPv4' do
+      expect(subject.send(:ipv4?)).to be false
+    end
+
+    it 'detects the IP as IPv6' do
+      expect(subject.send(:ipv6?)).to be true
+    end
+
+    it 'detects the IP as valid' do
+      expect(subject.valid?).to be true
+    end
+  end
+end

data/spec/rbl_mcafee/zone_spec.rb

@@ -0,0 +1,120 @@
+require 'rbl_mcafee'
+require 'rbl_mcafee/zone'
+
+describe RblMcafee::Zone do
+  subject { RblMcafee::Zone.new('127.0.0.1') }
+
+  # Extract zone
+  # ----------------------------------------------------------------------------
+  it 'extracts the zones correctly' do
+    expect(subject.send(:extract_zone, nil)).to be(nil)
+    expect(subject.send(:extract_zone,'127.0.0.1')).to be(nil)
+    expect(subject.send(:extract_zone,'127.0.0.2')).to be(RblMcafee::Zone::SBL)
+    expect(subject.send(:extract_zone,'127.0.0.3')).to be(RblMcafee::Zone::SBL)
+    expect(subject.send(:extract_zone,'127.0.0.4')).to be(RblMcafee::Zone::XBL)
+    expect(subject.send(:extract_zone,'127.0.0.5')).to be(RblMcafee::Zone::XBL)
+    expect(subject.send(:extract_zone,'127.0.0.6')).to be(RblMcafee::Zone::XBL)
+    expect(subject.send(:extract_zone,'127.0.0.7')).to be(RblMcafee::Zone::XBL)
+    expect(subject.send(:extract_zone,'127.0.0.8')).to be(nil)
+    expect(subject.send(:extract_zone,'127.0.0.9')).to be(nil)
+    expect(subject.send(:extract_zone,'127.0.0.10')).to be(RblMcafee::Zone::PBL)
+    expect(subject.send(:extract_zone,'127.0.0.11')).to be(RblMcafee::Zone::PBL)
+    expect(subject.send(:extract_zone,'127.0.0.12')).to be(nil)
+  end
+
+  # PBL zone
+  # ----------------------------------------------------------------------------
+  context 'with an IP address listed in the PBL zone' do
+    before(:each) { Resolv.stub(:getaddress) { '127.0.0.10' } }
+
+    it 'is not detected as belonging to the SBL zone' do
+      expect(subject.sbl?).to be false
+    end
+
+    it 'is not detected as belonging to the XBL zone' do
+      expect(subject.xbl?).to be false
+    end
+
+    it 'is detected as belonging to the PBL zone' do
+      expect(subject.pbl?).to be true
+    end
+  end
+
+  # SBL zone
+  # ----------------------------------------------------------------------------
+  context 'with an IP address listed in the SBL zone' do
+    before(:each) { Resolv.stub(:getaddress) { '127.0.0.3' } }
+
+    it 'is detected as belonging to the SBL zone' do
+      expect(subject.sbl?).to be true
+    end
+
+    it 'is not detected as belonging to the XBL zone' do
+      expect(subject.xbl?).to be false
+    end
+
+    it 'is not detected as belonging to the PBL zone' do
+      expect(subject.pbl?).to be false
+    end
+  end
+
+  # XBL zone
+  # ----------------------------------------------------------------------------
+  context 'with an IP address listed in the XBL zone' do
+    before(:each) { Resolv.stub(:getaddress) { '127.0.0.4' } }
+
+    it 'is not detected as belonging to the SBL zone' do
+      expect(subject.sbl?).to be false
+    end
+
+    it 'is detected as belonging to the XBL zone' do
+      expect(subject.xbl?).to be true
+    end
+
+    it 'is not detected as belonging to the PBL zone' do
+      expect(subject.pbl?).to be false
+    end
+  end
+
+  # Without zone
+  # ----------------------------------------------------------------------------
+  context 'with an IP address not listed in any zone' do
+    before(:each) { Resolv.stub(:getaddress) { raise Resolv::ResolvError } }
+
+    it 'is not detected as belonging to the SBL zone' do
+      expect(subject.sbl?).to be false
+    end
+
+    it 'is not detected as belonging to the XBL zone' do
+      expect(subject.xbl?).to be false
+    end
+
+    it 'is not detected as belonging to the PBL zone' do
+      expect(subject.pbl?).to be false
+    end
+  end
+
+  # Exceptions
+  # ----------------------------------------------------------------------------
+  it 'raises an ArgumentError for invalid IP addresses' do
+    RblMcafee::Ip.any_instance.stub(:valid?) { false }
+
+    expect{subject}.to raise_error(ArgumentError)
+  end
+
+  it 'raises a RblMcafee::Timeout when a timeout error is raised by Resolv' do
+    Resolv.stub(:getaddress) { raise Resolv::ResolvTimeout }
+
+    expect{subject.sbl?}.to raise_error(RblMcafee::Timeout)
+    expect{subject.xbl?}.to raise_error(RblMcafee::Timeout)
+    expect{subject.pbl?}.to raise_error(RblMcafee::Timeout)
+  end
+
+  it 'raises unknown exceptions raised by Resolv' do
+    Resolv.stub(:getaddress) { raise 'oops' }
+
+    expect{subject.sbl?}.to raise_error('oops')
+    expect{subject.xbl?}.to raise_error('oops')
+    expect{subject.pbl?}.to raise_error('oops')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbl_mcafee
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Romain Salles
@@ -67,9 +67,12 @@ files:
 - README.md
 - Rakefile
 - lib/rbl_mcafee.rb
+- lib/rbl_mcafee/ip.rb
 - lib/rbl_mcafee/version.rb
+- lib/rbl_mcafee/zone.rb
 - rbl_mcafee.gemspec
-- spec/rbl_mcafee_spec.rb
+- spec/rbl_mcafee/ip_spec.rb
+- spec/rbl_mcafee/zone_spec.rb
 homepage: https://github.com/romainsalles/rbl_mcafee
 licenses:
 - MIT
@@ -95,4 +98,5 @@ signing_key:
 specification_version: 4
 summary: Solution to test if an IP address is listed in the McAfee RBL
 test_files:
-- spec/rbl_mcafee_spec.rb
+- spec/rbl_mcafee/ip_spec.rb
+- spec/rbl_mcafee/zone_spec.rb

data/spec/rbl_mcafee_spec.rb

@@ -1,54 +0,0 @@
-require 'rbl_mcafee'
-
-describe RblMcafee do
-  subject { RblMcafee.blacklisted?(ip_address) }
-  let(:ip_address) { '127.0.0.1' }
-
-  context 'with a non listed IP address' do
-    it 'returns false' do
-      Resolv.stub(:getaddress) { raise Resolv::ResolvError.new('whatever') }
-
-      expect(subject).to be false
-    end
-  end
-
-  context 'with a listed IP address' do
-    it 'returns true' do
-      Resolv.stub(:getaddress) { '127.0.0.11' }
-
-      expect(subject).to be true
-    end
-  end
-
-  context 'when a timeout error is raised by Resolv' do
-    it 'raises a RblMcafee::Timeout error' do
-      Resolv.stub(:getaddress) { raise Resolv::ResolvTimeout }
-
-      expect{subject}.to raise_error(RblMcafee::Timeout)
-    end
-  end
-
-  context 'when an unknown exception is raised by Resolv' do
-    it 'is re-raised by .blacklisted?' do
-      Resolv.stub(:getaddress) { raise 'oops' }
-
-      expect{subject}.to raise_error('oops')
-    end
-  end
-
-  context 'when an invalid IP address is passed as argument' do
-    let(:ip_address) { '001.8.9.10' }
-
-    it 'raises an ArgumentError' do
-      expect{subject}.to raise_error(ArgumentError)
-    end
-  end
-
-  context 'when a valid website address is passed as argument' do
-    let(:ip_address) { 'www.mcafee.com' }
-
-    it 'raises an ArgumentError' do
-      expect{subject}.to raise_error(ArgumentError)
-    end
-  end
-end