spf 0.0.49 → 0.0.53

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7d7611765c97ea142a4b2809fc4f75d61ea0ee3d
-  data.tar.gz: 7b714243e6934102d5e07486227f0db0aeb3c210
+SHA256:
+  metadata.gz: 9b5b96521a48a4f0b0a78397d6e21ff99d03b9d144df182bfd68b0369046d73e
+  data.tar.gz: 17025632b91737a607a5035b9dfd2405bb080eeaee3e8091cd5e71dc4729cd4d
 SHA512:
-  metadata.gz: ca52c3eaec492ee51afde4ad20fac2d78bd48402005f320e700774afe8fb36298ead25da53eb34d04c512d7e5af0661e802b462d1f0c5589606a2eaba5d85117
-  data.tar.gz: bc10bbbf14fa2bb9a26ac55cde3793a914f5249ff5ee7909347c2dfb9225ce28284d22c064c2cbe2edd54e1b1c2257d665b56a9728b942db6a782b53c8a64188
+  metadata.gz: aea5c665821e18e2724d0d0e92ca02a89347eabc53226135944b9de65b7b20d25f64401128606f49367a718e637b2d425fa6bb2fdb0999b3cbecae72c5698852
+  data.tar.gz: f4f74a840d9fbe744d5b2fbf52abb5011f5c75672b648e6d0512450d7261997ee4006a83f707ec50300639972a235b0d261e11ac976bddf5a2eea13db8944150

data/Gemfile

@@ -9,8 +9,8 @@ gem "ruby-ip", "~> 0.9.1"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rspec", "~> 2.9"
-  gem "rdoc", "~> 3"
+  gem "rdoc", "~> 4.3"
   gem "bundler", "~> 1.2"
-  gem "jeweler", "~> 1.8"
+  gem "jeweler", "~> 2.3", ">= 2.3.9"
   gem "simplecov", :require => false, :group => :test
 end

data/Gemfile.lock

@@ -1,47 +1,55 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.7)
-    builder (3.2.2)
+    addressable (2.4.0)
+    builder (3.2.4)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    faraday (0.8.9)
-      multipart-post (~> 1.2.0)
-    git (1.2.9.1)
-    github_api (0.10.1)
-      addressable
-      faraday (~> 0.8.1)
-      hashie (>= 1.2)
-      multi_json (~> 1.4)
-      nokogiri (~> 1.5.2)
-      oauth2
-    hashie (3.4.0)
-    highline (1.7.1)
-    jeweler (1.8.8)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.7.0)
+      rchardet (~> 1.8)
+    github_api (0.16.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashie (4.1.0)
+    highline (2.0.3)
+    jeweler (2.3.9)
       builder
-      bundler (~> 1.0)
+      bundler
       git (>= 1.2.5)
-      github_api (= 0.10.1)
+      github_api (~> 0.16.0)
       highline (>= 1.6.15)
-      nokogiri (= 1.5.10)
+      nokogiri (>= 1.5.10)
+      psych
       rake
       rdoc
-    json (1.8.2)
-    jwt (1.3.0)
-    multi_json (1.10.1)
-    multi_xml (0.5.5)
-    multipart-post (1.2.0)
-    nokogiri (1.5.10)
-    oauth2 (1.0.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
+      semver2
+    jwt (2.2.2)
+    mime-types (2.99.3)
+    mini_portile2 (2.4.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    oauth2 (1.4.4)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.6.0)
-    rake (10.4.2)
-    rdoc (3.12.2)
-      json (~> 1.4)
+      rack (>= 1.2, < 3)
+    psych (3.2.0)
+    rack (2.2.3)
+    rake (13.0.1)
+    rchardet (1.8.0)
+    rdoc (4.3.0)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
       rspec-expectations (~> 2.99.0)
@@ -51,19 +59,24 @@ GEM
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.3)
     ruby-ip (0.9.3)
+    semver2 (3.4.2)
     simplecov (0.9.2)
       docile (~> 1.1.0)
       multi_json (~> 1.0)
       simplecov-html (~> 0.9.0)
     simplecov-html (0.9.0)
+    thread_safe (0.3.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.2)
-  jeweler (~> 1.8)
-  rdoc (~> 3)
+  jeweler (~> 2.3, >= 2.3.9)
+  rdoc (~> 4.3)
   rspec (~> 2.9)
   ruby-ip (~> 0.9.1)
   simplecov
+
+BUNDLED WITH
+   1.17.3

data/lib/spf/error.rb

@@ -50,15 +50,15 @@ module SPF
       class InvalidModError                 < SyntaxError;          end  # Invalid modifier
       class InvalidTermError                < SyntaxError;          end  # Invalid term
       class JunkInTermError                 < SyntaxError;          end  # Junk encountered in term
-      class DuplicateGlobalMod                < InvalidModError;    end  # Duplicate global modifier
+      class DuplicateGlobalModError           < InvalidModError;    end  # Duplicate global modifier
       class InvalidMechError                  < InvalidTermError;   end  # Invalid mechanism
       class InvalidMechQualifierError         < InvalidMechError;   end  # Invalid mechanism qualifier
       class InvalidMechCIDRError              < InvalidMechError;   end  # Invalid CIDR netblock in mech
       class TermDomainSpecExpectedError     < SyntaxError;          end  # Missing required <domain-spec> in term
       class TermIPv4AddressExpectedError    < SyntaxError;          end  # Missing required <ip4-network> in term
-      class TermIPv4PrefixLengthExpected    < SyntaxError;          end  # Missing required <ip4-cidr-length> in term
-      class TermIPv6AddressExpected         < SyntaxError;          end  # Missing required <ip6-network> in term
-      class TermIPv6PrefixLengthExpected    < SyntaxError;          end  # Missing required <ip6-cidr-length> in term
+      class TermIPv4PrefixLengthExpectedError < SyntaxError;        end  # Missing required <ip4-cidr-length> in term
+      class TermIPv6AddressExpectedError    < SyntaxError;          end  # Missing required <ip6-network> in term
+      class TermIPv6PrefixLengthExpectedError < SyntaxError;        end  # Missing required <ip6-cidr-length> in term
       class InvalidMacroStringError         < SyntaxError;          end  # Invalid macro string
       class InvalidMacroError                 < InvalidMacroStringError
                                                                     end  # Invalid macro

data/lib/spf/eval.rb

@@ -275,7 +275,13 @@ class SPF::Server
       versions.each do |version|
         klass = RECORD_CLASSES_BY_VERSION[version]
         begin
-          record = klass.new_from_string(text, {:raise_exceptions => @raise_exceptions})
+          options = {:raise_exceptions => @raise_exceptions}
+          # A MacroString object for domain indicates this is a nested record.
+          # Storing the domain.text maintains an association to the include domain.
+          if domain.class == SPF::MacroString
+            options[:record_domain] = domain.text
+          end
+          record = klass.new_from_string(text, options)
         rescue SPF::InvalidRecordVersionError => error
           if text =~ /#{LOOSE_SPF_MATCH_PATTERN}/
             possible_matches << text

data/lib/spf/macro_string.rb

@@ -1,5 +1,8 @@
 # encoding: ASCII-8BIT
 require 'spf/util'
+require 'spf/error'
+require 'uri'
+
 
 module SPF
   class MacroString
@@ -22,8 +25,8 @@ module SPF
         or raise ArgumentError, "Missing required 'text' option"
       @server   = options[:server]
       @request  = options[:request]
+      @is_explanation = options[:is_explanation]
       @expanded = nil
-      self.expand
     end
 
     attr_reader :text, :server, :request
@@ -43,9 +46,124 @@ module SPF
       return (@expanded = @text) unless @text =~ /%/
         # Short-circuit expansion if text has no '%' characters.
 
+      server, request = context ? context : [@server, @request]
+
+      valid_context(true, server, request)
+
       expanded = ''
-      # TODO
-      return (@expanded = @text)
+
+      text = @text
+
+      while m = text.match(/ (.*?) %(.) /x) do
+        expanded += m[1]
+        key = m[2]
+
+        if (key == '{')
+          if m2 = m.post_match.match(/ (\w|_\p{Alpha}+) ([0-9]+)? (r)? ([.\-+,\/_=])? } /x)
+            char, rh_parts, reverse, delimiter = m2.captures
+
+            # Upper-case macro chars trigger URL-escaping AKA percent-encoding
+            # (RFC 4408, 8.1/26):
+            do_percent_encode = char =~ /\p{Upper}/
+            char.downcase!
+
+            if char == 's' # RFC 4408, 8.1/19
+              value = request.identity
+            elsif char == 'l' # RFC 4408, 8.1/19
+              value = request.localpart
+            elsif char == 'o' # RFC 4408, 8.1/19
+              value = request.domain
+            elsif char == 'd' # RFC 4408, 8.1/6/4
+              value = request.authority_domain
+            elsif char == 'i' # RFC 4408, 8.1/20, 8.1/21
+              ip_address = request.ip_address
+              ip_address = SPF::Util.ipv6_address_to_ipv4(ip_address) if SPF::Util.ipv6_address_is_ipv4_mapped(ip_address)
+              if IP::V4 === ip_address
+                value = ip_address.to_addr
+              elsif IP::V6 === ip_address
+                value = ip_address.to_hex.upcase.split('').join('.')
+              else
+                server.throw_result(:permerror, request, "Unexpected IP address version in request")
+              end
+            elsif char == 'p' # RFC 4408, 8.1/22
+              # According to RFC 7208 the "p" macro letter should not be used (or even published).
+              # Here it is left unexpanded and transformers and delimiters are not applied.
+              value = '%{' + m2.to_s
+              rh_parts = nil
+              reverse = nil
+            elsif char == 'v' # RFC 4408, 8.1/6/7
+              if IP::V4 === request.ip_address
+                value = 'in-addr'
+              elsif IP::V6 === request.ip_address
+                value = 'ip6'
+              else
+                # Unexpected IP address version.
+                server.throw_result(:permerror, request, "Unexpected IP address version in request")
+              end
+            elsif char == 'h' # RFC 4408, 8.1/6/8
+              value = request.helo_identity || 'unknown'
+            elsif char == 'c' # RFC 4408, 8.1/20, 8.1/21
+              raise SPF::InvalidMacroStringError.new("Illegal 'c' macro in non-explanation macro string '#{@text}'") unless @is_explanation
+              ip_address = request.ip_address
+              value = SPF::Util::ip_address_to_string(ip_address)
+            elsif char == 'r' # RFC 4408, 8.1/23
+              value = server.hostname || 'unknown'
+            elsif char == 't'
+              raise SPF::InvalidMacroStringError.new("Illegal 't' macro in non-explanation macro string '#{@text}'") unless @is_explanation
+              value = Time.now.to_i.to_s
+            elsif char == '_scope'
+              # Scope pseudo macro for internal use only!
+              value = request.scope.to_s
+            else
+              # Unknown macro character.
+              raise SPF::InvalidMacroStringError.new("Invalid macro character #{char} in macro string '#{@text}'")
+            end
+
+            if rh_parts || reverse
+              delimiter ||= self.class.default_split_delimiters
+              list = value.split(delimiter)
+              list.reverse! if reverse
+              # Extract desired parts:
+              if rh_parts && rh_parts.to_i > 0
+                list = list.last(rh_parts.to_i)
+              end
+              if rh_parts && rh_parts.to_i == 0
+                raise SPF::InvalidMacroStringError.new("Illegal selection of 0 (zero) right-hand parts in macro string '#{@text}'")
+              end
+              value = list.join(self.class.default_join_delimiter)
+            end
+
+            if do_percent_encode
+              unsafe = Regexp.new('^' + self.class.uri_unreserved_chars)
+              value = URI.escape(value, unsafe)
+            end
+
+            expanded += value
+
+            text = m2.post_match
+          else
+            # Invalid macro expression.
+            raise SPF::InvalidMacroStringError.new("Invalid macro expression in macro string '#{@text}'")
+          end
+        elsif key == '-'
+          expanded += '-'
+          text = m.post_match
+        elsif key == '_'
+          expanded += ' '
+          text = m.post_match
+        elsif key == '%'
+          expanded += '%'
+          text = m.post_match
+        else
+          # Invalid macro expression.
+          pos = m.offset(2).first
+          raise SPF::InvalidMacroStringError.new("Invalid macro expression at pos #{pos} in macro string '#{@text}'")
+        end
+      end
+
+      expanded += text # Append remaining unmatched characters.
+
+      context ? expanded : @expanded = expanded
     end
 
     def to_s
@@ -58,16 +176,15 @@ module SPF
 
     def valid_context(required, server = self.server, request = self.request)
       if not SPF::Server === server
-        raise MacroExpansionCtxRequired, 'SPF server object required' if required
+        raise SPF::MacroExpansionCtxRequiredError.new('SPF server object required') if required
         return false
       end
       if not SPF::Request === request
-        raise MacroExpansionCtxRequired, 'SPF request object required' if required
+        raise SPF::MacroExpansionCtxRequiredError.new('SPF request object required') if required
         return false
       end
       return true
     end
-
   end
 end
 

data/lib/spf/model.rb

@@ -86,7 +86,7 @@ class SPF::Term
  ::
   "
 
-  attr_reader :errors, :ip_netblocks, :ip_address, :ip_network, :ipv4_prefix_length, :ipv6_prefix_length, :domain_spec, :raw_params
+  attr_reader :errors, :ip_netblocks, :ip_address, :ip_network, :ipv4_prefix_length, :ipv6_prefix_length, :domain_spec, :raw_params, :record_domain
 
   def initialize(options = {})
     @ip_address         = nil
@@ -97,6 +97,7 @@ class SPF::Term
     @errors             = []
     @ip_netblocks       = []
     @text               = options[:text]
+    @record_domain      = options[:record_domain]
     @raise_exceptions   = options.has_key?(:raise_exceptions) ? options[:raise_exceptions] : true
   end
 
@@ -117,6 +118,8 @@ class SPF::Term
       domain_spec = $1
       domain_spec.sub!(/^(.*?)\.?$/, $1)
       @domain_spec = SPF::MacroString.new({:text => domain_spec})
+    elsif record_domain
+      @domain_spec = SPF::MacroString.new({:text => record_domain})
     elsif required
       error(SPF::TermDomainSpecExpectedError.new(
         "Missing required domain-spec in '#{@text}'"))
@@ -139,13 +142,13 @@ class SPF::Term
     if @parse_text.sub!(/^\/(\d+)/, '')
       bits = $1.to_i
       unless bits and bits >= 0 and bits <= 32 and $1 !~ /^0./
-        error(SPF::TermIPv4PrefixLengthExpected.new(
+        error(SPF::TermIPv4PrefixLengthExpectedError.new(
           "Invalid IPv4 prefix length encountered in '#{@text}'"))
         return
       end
       @ipv4_prefix_length = bits
     elsif required
-      error(SPF::TermIPv4PrefixLengthExpected.new(
+      error(SPF::TermIPv4PrefixLengthExpectedError.new(
         "Missing required IPv4 prefix length in '#{@text}"))
       return
     else
@@ -168,7 +171,7 @@ class SPF::Term
     if @parse_text.sub!(/(#{IPV6_ADDRESS_PATTERN})(?=\/|$)/x, '')
       @ip_address = $1
     elsif required
-      error(SPF::TermIPv6AddressExpected.new(
+      error(SPF::TermIPv6AddressExpectedError.new(
         "Missing or invalid required IPv6 address in '#{@text}'"))
     end
     @ip_address = @parse_text.dup unless @ip_address
@@ -184,7 +187,7 @@ class SPF::Term
       end
       @ipv6_prefix_length = bits
     elsif required
-      error(SPF::TermIPvPrefixLengthExpected.new(
+      error(SPF::TermIPv6PrefixLengthExpectedError.new(
         "Missing required IPv6 prefix length in '#{@text}'"))
       return
     else
@@ -214,7 +217,7 @@ class SPF::Term
 
   def domain(server, request)
     if self.instance_variable_defined?(:@domain_spec) and @domain_spec
-      return @domain_spec
+      return SPF::MacroString.new({:server => server, :request => request, :text => @domain_spec.text})
     end
     return request.authority_domain
   end
@@ -446,13 +449,13 @@ class SPF::Mech < SPF::Term
       server.count_dns_interactive_term(request)
 
       domain = self.domain(server, request)
-      packet = server.dns_lookup(domain, 'A')
-      rrs = (packet.exchange or server.count_void_dns_lookup(request))
-      rrs.each do |rr|
-        return true if rr.type == 'A'
+      begin
+        rrs = server.dns_lookup(domain, 'A')
+        return true if rrs.any?
+      rescue SPF::DNSNXDomainError => e
+        server.count_void_dns_lookup(request)
+        return false
       end
-
-      return false
     end
 
   end
@@ -844,6 +847,7 @@ class SPF::Record
     @global_mods    ||= {}
     @errors           = []
     @ip_netblocks     = []
+    @record_domain    = options[:record_domain]
     @raise_exceptions = options.has_key?(:raise_exceptions) ? options[:raise_exceptions] : true
   end
 
@@ -914,7 +918,11 @@ class SPF::Record
         error(exception)
         mech_class = SPF::Mech
       end
-      term = mech = mech_class.new_from_string(mech_text, {:raise_exceptions => @raise_exceptions})
+      options = {:raise_exceptions => @raise_exceptions}
+      if instance_variable_defined?("@record_domain")
+        options[:record_domain] = @record_domain
+      end
+      term = mech = mech_class.new_from_string(mech_text, options)
       term.errors << exception if exception
       @ip_netblocks << mech.ip_netblocks if mech.ip_netblocks
       @terms << mech
@@ -941,7 +949,7 @@ class SPF::Record
         if SPF::GlobalMod === mod
           # Global modifier.
           if @global_mods[mod_name]
-            raise SPF::DuplicateGlobalMod.new("Duplicate global modifier '#{mod_name}' encountered")
+            raise SPF::DuplicateGlobalModError.new("Duplicate global modifier '#{mod_name}' encountered")
           end
           @global_mods[mod_name] = mod
         elsif SPF::PositionalMod === mod

data/lib/spf/version.rb

@@ -1,6 +1,6 @@
 # encoding: ASCII-8BIT
 module SPF
-  VERSION = '0.0.49'
+  VERSION = '0.0.53'
 end
 
 # vim:sw=2 sts=2

data/spf.gemspec

@@ -6,7 +6,7 @@
 
 Gem::Specification.new do |s|
   s.name = "spf"
-  s.version = "0.0.49"
+  s.version = "0.0.53"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spf
 version: !ruby/object:Gem::Version
-  version: 0.0.49
+  version: 0.0.53
 platform: ruby
 authors:
 - Andrew Flury
@@ -133,8 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Implementation of the Sender Policy Framework