spf 0.0.50 → 0.0.51

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 5b664a066cda59ad9e2ca7823802da8b0c9116ff
-  data.tar.gz: c9d87ca329cbe56ebbe98fa883c44be3297056b6
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODUyYWMzZjg2M2M5NjRkNjVjOWY1MDE2NDQ3ODE4OWJlYmZkZDk0YQ==
+  data.tar.gz: !binary |-
+    ZmZjZjhkNGU3NTNjNTUwNTdjZDFiOWRlNzEzM2I5Y2QzZTYwZjQ3Nw==
 SHA512:
-  metadata.gz: 66f66f59936df7c15e4b6c5d0a59eb9a4df275e661b8b7b0f8b937cfa73d106e4c27afb50e6524c6e4085ca43430b44276ac48e1c4f0f79ba206992a219ce6eb
-  data.tar.gz: 1ee62b089c30a43da72513f66facee595e212d1616f63ef0d685fd61f061c8c08f129ad7568738add15e4f17851687bee90502cd9ae16831a368e5a40cdbd823
+  metadata.gz: !binary |-
+    NGI0Yjg3ZTRlNzk0ZjA4MTUzMzEwMjE0YThmMzIyMTQ5ZWUyNTI3NjQwNDEy
+    NWE2ODc1ZDA2OTRlNzQ5YjYzZjUzNDY2MmJjMTZhMWNlMmQ5ODdjOWMzYTIx
+    N2YzYWFhMjAyZjQyMzBkZmUyMDc0YjUxMzIyM2ZkY2IwYzhhOGI=
+  data.tar.gz: !binary |-
+    YzBjYTc5ZDA5MzRlMjQ2N2RlNDQ4ZjlhZmU2YzQ1ODYwMWJhMjY4NGU0MDVk
+    Yjg0N2RiNDNiMmQ4NTBkNjExN2NjYjRiZTI1Zjk1M2M3NjBkZmMwOTNmNGE1
+    Y2M0M2MyNzJhMWNmZThmOTg2ZGNhNTBjMzNmY2M4MWFhNDc1Y2Y=

data/Gemfile.lock

@@ -38,7 +38,7 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    rack (1.6.0)
+    rack (1.6.2)
     rake (10.4.2)
     rdoc (3.12.2)
       json (~> 1.4)

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/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

@@ -139,13 +139,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 +168,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 +184,7 @@ class SPF::Term
       end
       @ipv6_prefix_length = bits
     elsif required
-      error(SPF::TermIPv6PrefixLengthExpected.new(
+      error(SPF::TermIPv6PrefixLengthExpectedError.new(
         "Missing required IPv6 prefix length in '#{@text}'"))
       return
     else
@@ -214,7 +214,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 +446,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
@@ -941,7 +941,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.50'
+  VERSION = '0.0.51'
 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.50"
+  s.version = "0.0.51"
 
   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.50
+  version: 0.0.51
 platform: ruby
 authors:
 - Andrew Flury
@@ -16,75 +16,74 @@ dependencies:
   name: ruby-ip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
-description: |2
-      An object-oriented Ruby implementation of the Sender Policy Framework (SPF)
-      e-mail sender authentication system, fully compliant with RFC 4408.
+description: ! "    An object-oriented Ruby implementation of the Sender Policy Framework
+  (SPF)\n    e-mail sender authentication system, fully compliant with RFC 4408.\n"
 email:
 - code@agari.com
 - aflury@agari.com
@@ -95,8 +94,8 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- ".document"
-- ".rspec"
+- .document
+- .rspec
 - Gemfile
 - Gemfile.lock
 - README.rdoc
@@ -124,17 +123,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Implementation of the Sender Policy Framework