wlvalidate 0.1.6 → 0.3.2

data/lib/wlvalidate.rb

@@ -3,7 +3,7 @@
    Results of the below calls will be returned in the following format
    (TYPE, RESULT, DATA and EXT_DATA are return values in each hash line)
    +=======+===========+===================+===========++========+=================+======================+
-   [ TYPE  | RESULT    | DATA              | EXT_DATA  ][ Status | Return Type     | Return on all paths? ]
+   [ CALL  | RESULT    | DATA              | EXT_DATA  ][ Status | Return Type     | Return on all paths? ]
    +=======+===========+===================+===========++========+=================+======================+
    | A     | PASS/FAIL | (none)            | (none)    || Done   | Array of hashes | Yes                  |
    | SPF   | PASS/FAIL | SPF record        | Fail type || Done   | Hash            | Yes                  |
@@ -15,10 +15,6 @@
    | ALL   | (multi)   | (multi)           | (multi)   || Done   | Array of hashes | (n/a)                |
    +-------+-----------+-------------------+-----------++--------+-----------------+----------------------+
 
-   TO DO:
-      - Add master/slave DNS option
-      - Validate hashes for Ruby
-
 =end
 
 # Must have dnsruby gem installed for this to work
@@ -27,15 +23,84 @@ include Dnsruby
 
 module WLValidate
    class Validate
-      def initialize(attributes=nil)
-         @intDNSTimeout = 5
-         @intDNSIPLoops = 5
+      @@dns_updated = 0
+      @@dns_server = "8.8.8.8"
+      @@default_dns_server = "8.8.4.4"
+      @@dns_type = 1
+
+      def initialize( dns_server="8.8.4.4", dns_type=1 )
+         # PURPOSE: Executes code before anything else runs (hence Initialize)
+         # RETURNS: Not a darn thing...
+         # NOTES:   We want to soak in parameters for DNS servers (array), DNS type (integer) and DNS timeouts (integer):
+         #          Resulting global variables: @dns_servers, @dns_type, @dns_timeout
+         #          If these values are not set during instancing, we want to put in some default values
+         #
+         # VARS:    @dns_server:   single string, non-array of IP address
+         #          @dns_type:     integer where 1 = local config, 2 = authorative server, 3 = Specific server
+         
+         @dns_updated = 0
+         @dns_server = dns_server.to_s
+         @default_dns_server = "8.8.4.4"
+         @dns_type = dns_type.to_i
+
+         if (dns_type.to_i == 3)
+            if (dns_server)
+               @dns_server = dns_server
+            else
+               @dns_server = @default_dns_server
+            end
+         end
+      end
+
+      def get_info()
+         hashReturn = Hash.new
+         hashReturn = { "dns_server" => @dns_server, "dns_type" => @dns_type, "dns_timeout" => @dns_timeout, "dns_updated" => @dns_updated }      
+         return hashReturn
       end
 
-      def self.ALL(strWL, strDomain)
+      def set_auth_ns(strDomain)
+         # Since we can't get strDomain during __init__, we will check to see if @dns_type = 2 (auth) and if
+         # @dns_server is empty. If so, then we want to get the authorative NS and set it globally.
+         if ((@dns_updated == 0) && (@dns_type == 2))
+            iplist = []
+            begin
+               res = Dnsruby::Resolver.new
+     
+               res.retry_times=(1)
+               ns_req = nil
+               ns_req = res.query(strDomain, 'NS')
+     
+               res.recurse=(0)
+     
+               (ns_req.answer.select {|r| r.type == 'NS'}).each do |nsrr|
+                  ns = nsrr.domainname
+      
+                  local_res = Dnsruby::Resolver.new
+                  a_req=nil
+                  a_req = local_res.query(ns, 'A')
+       
+                     (a_req.answer.select {|r| r.type == 'A'}).each do |r|
+                        ip = r.address
+                        res.nameserver=(ip.to_s)
+                        soa_req=nil
+                        soa_req = res.query(strDomain, 'SOA', 'IN')
+                        iplist.push(ip.to_s)
+                     end
+                  end
+               iplist.shuffle!
+               @dns_server = iplist.first
+               @dns_updated = 1
+            rescue
+               @dns_server = @default_dns_server
+               @dns_updated = 1
+            end
+         end
+      end
+
+      def ALL(strWL, strDomain)
          # PURPOSE: Execute all of the below methods as a single call
          # RETURNS: Returns the combined array of hashes as returned by each function
-         # NOTES:   Need to encapsulate all functions in a begin/capture/end to catch anything odd
+         # NOTES:   All functions have values on all return paths, except for MX (see TODO above)
 
          arrayReturns = Array.new
 
@@ -45,6 +110,7 @@ module WLValidate
          hashDKIM1 = self.DKIM1(strWL, strDomain)
          hashDKIM2 = self.DKIM2(strWL, strDomain)
          arrayMX = self.MX(strWL, strDomain)
+         hashInfo = self.get_info()
 
          # array.push hashes, and array.concat arrays
          arrayReturns.push(hashSPF)
@@ -53,11 +119,12 @@ module WLValidate
          arrayReturns.push(hashDKIM1)
          arrayReturns.push(hashDKIM2)
          arrayReturns.concat(arrayMX)
+         arrayReturns.push(hashInfo)
 
          return arrayReturns
       end
 
-      def self.MX(strWL, strDomain)
+      def MX(strWL, strDomain)
          # PURPOSE: Loop through all <domain> MX records
          # RETURNS: Array of hashes 
          hashTemp = Hash.new
@@ -66,9 +133,16 @@ module WLValidate
 
          if ((strWL == "") || (strDomain == ""))
             hashReturn = { "type" => "MX", "result" => "ERROR", "data" => "Missing parameters", "ext_data" => "One or more parameters are missing!" }
+            arrayReturn.push(hashReturn)
+         end
+
+         set_auth_ns(strDomain)
+
+         if ((@dns_type == 2) || (@dns_type == 3))
+            dns_params = {:nameserver=>@dns_server}
          end
 
-         Dnsruby::DNS.open {|dns|
+         Dnsruby::DNS.open(dns_params) {|dns|
             begin
                arrayMX = dns.getresources(strDomain, Dnsruby::Types.MX)
                if (arrayMX.count > 0)
@@ -76,7 +150,11 @@ module WLValidate
                   arrayMX.each do |r|
                      myExchange = r.exchange.to_s
                      myPreference = r.preference.to_s
-                     hashTemp = { "type" => "MX", "result" => "INFO", "data" => myExchange, "ext_data" => myPreference }
+                     if myExchange.match %r{sendgrid.}
+                        hashTemp = { "type" => "MX", "result" => "ERROR", "data" => myExchange, "ext_data" => "SendGrid is listed as handling incoming email on the root domain - this is generally a bad idea unless you're using ParseAPI..." }
+                     else
+                        hashTemp = { "type" => "MX", "result" => "INFO", "data" => myExchange, "ext_data" => myPreference }
+                     end
                      arrayReturn.push(hashTemp)
                      hashTemp = {}
                   end
@@ -99,7 +177,7 @@ module WLValidate
          return arrayReturn
       end
 
-      def self.A(strWL, strDomain)
+      def A(strWL, strDomain)
          # PURPOSE: Loop through all oN.<wl>.<domain>.<tlds> to get IPs, then also do reverse DNS checks
          # RETURNS: Hash - see above for definition
 
@@ -108,8 +186,11 @@ module WLValidate
 
          if ((strWL == "") || (strDomain == ""))
             hashReturn = { "type" => "A", "result" => "ERROR", "data" => "Missing parameters", "ext_data" => "One or more expected paramters are missing!" }
+            arrayReturn.push(hashReturn)
          end
 
+         set_auth_ns(strDomain)
+
          i = 1
          intDNSIPLoops = 11
          while i < intDNSIPLoops do
@@ -142,7 +223,7 @@ module WLValidate
          return arrayReturn
       end
 
-      def self.CNAME(strWL, strDomain)
+      def CNAME(strWL, strDomain)
          # PURPOSE: Get CNAME record and make sure it's mapped to 'sendgrid.net'
          # RETURNS: Hash - See above for definition
 
@@ -153,7 +234,13 @@ module WLValidate
             hashReturn = { "type" => "CNAME", "result" => "ERROR", "data" => "Missing parameters", "ext_data" => "One or more expected paramters are missing!" }
          end
 
-         Dnsruby::DNS.open {|dns|
+         set_auth_ns(strDomain)
+
+         if ((@dns_type == 2) || (@dns_type == 3))
+            dns_params = {:nameserver=>@dns_server}
+         end
+
+         Dnsruby::DNS.open(dns_params) {|dns|
             begin
                strHost = strWL + "." + strDomain
                arrayCNAME = dns.getresources(strHost, Dnsruby::Types.CNAME)
@@ -166,9 +253,12 @@ module WLValidate
                      end
                   end
                   if hashReturn.empty?
-                     hashReturn = { "type" => "CNAME", "result" => "FAIL", "data" => "No data", "ext_data" => "No matching CNAME records found" }
+                     hashReturn = { "type" => "CNAME", "result" => "FAIL", "data" => strHost, "ext_data" => "No matching CNAME records found" }
                   end
                end
+               if boolFoundMatch == false
+                  hashReturn = { "type" => "CNAME", "result" => "FAIL", "data" => strHost, "ext_data" => "No matching CNAME records found" }
+               end
             rescue Dnsruby::ResolvTimeout
                hashReturn = { "type" => "CNAME", "result" => "ERROR", "data" => strHost, "ext_data" => "Timed out while attempting rDNS lookup" }
             rescue
@@ -178,7 +268,7 @@ module WLValidate
          return hashReturn
       end
 
-      def self.DKIM1(strWL, strDomain)
+      def DKIM1(strWL, strDomain)
          # PURPOSE: Get TXT/CNAME record for smtpapi._domainkey.<domain>.<tlds>
          # RETURNS: Hash - See above for definition
 
@@ -186,32 +276,41 @@ module WLValidate
          boolFoundMatch = false
          strHost = "smtpapi._domainkey." + strDomain
          strDKIM = "k=rsa; t=s; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDPtW5iwpXVPiH5FzJ7Nrl8USzuY9zqqzjE0D1r04xDN6qwziDnmgcFNNfMewVKN2D1O+2J9N14hRprzByFwfQW76yojh54Xu3uSbQ3JP0A7k8o8GutRF8zbFUA8n0ZH2y0cIEjMliXY4W4LwPA7m4q0ObmvSjhd63O9d8z1XkUBwIDAQAB"
-         strDKIM_k = "rsa"
-         strDKIM_t = "s"
-         strDKIM_p = "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDPtW5iwpXVPiH5FzJ7Nrl8USzuY9zqqzjE0D1r04xDN6qwziDnmgcFNNfMewVKN2D1O+2J9N14hRprzByFwfQW76yojh54Xu3uSbQ3JP0A7k8o8GutRF8zbFUA8n0ZH2y0cIEjMliXY4W4LwPA7m4q0ObmvSjhd63O9d8z1XkUBwIDAQAB"
 
          if ((strWL == "") || (strDomain == ""))
             hashReturn = { "type" => "DKIM1", "result" => "ERROR", "data" => "Missing parameters", "ext_data" => "One or more expected paramters are missing!" }
          end
 
-         Dnsruby::DNS.open {|dns|
+         set_auth_ns(strDomain)         
+
+         if ((@dns_type == 2) || (@dns_type == 3))
+            dns_params = {:nameserver=>@dns_server}
+         end
+
+         Dnsruby::DNS.open(dns_params) {|dns|
             begin
                arrayDKIM1 = dns.getresources(strHost, Dnsruby::Types.TXT)
                arrayDKIM1.each do |r|
-                  if boolFoundMatch == false
-                     if (r.name.to_s == "dkim.sendgrid.net") 
-                        hashReturn = { "type" => "DKIM1", "result" => "PASS", "data" => r.name.to_s, "ext_data" => "cname" }
-                        boolFoundMatch = true
-                     elsif ( (r.name.to_s == strHost) && (r.data.split(" ")[0].match %r{#{Regexp.escape(strDKIM_k)}}) && (r.data.split(" ")[1].match %r{#{Regexp.escape(strDKIM_t)}}) && (r.data.split(" ")[2].match %r{#{Regexp.escape(strDKIM_p)}}) )
-                        hashReturn = { "type" => "DKIM1", "result" => "PASS", "data" => r.name.to_s, "ext_data" => "txt" }
+                  if r.name.to_s.match %r{dkim.sendgrid.net}
+                     hashReturn = { "type" => "DKIM1", "result" => "PASS", "data" => r.name.to_s, "ext_data" => "CNAME" }
+                     boolFoundMatch = true
+                  end
+                  if ((r.name.to_s == strHost) && (r.data == strDKIM))
+                     hashReturn = { "type" => "DKIM1", "result" => "PASS", "data" => r.name.to_s, "ext_data" => "TXT" }
+                     boolFoundMatch = true
+                  end
+               end
+               if ((boolFoundMatch == false) || (hashReturn.empty?))
+                  arrayDKIM1CNAME = dns.getresources(strHost, Dnsruby::Types.CNAME)
+                  arrayDKIM1CNAME.each do |c|
+                     if c.rdata_to_string.match %r{dkim.sendgrid.net}
+                        hashReturn = { "type" => "DKIM1", "result" => "PASS", "data" => c.name.to_s, "ext_data" => "CNAME" }
                         boolFoundMatch = true
-                     else
-                        hashReturn = { "type" => "DKIM1", "result" => "FAIL", "data" => strHost, "ext_data" => "No DKIM record found as either CNAME or TXT" }
                      end
                   end
                end
-               if hashReturn.empty?
-                  hashReturn = { "type" => "DKIM2", "result" => "FAIL", "data" => strHost, "ext_data" => "No matching DKIM/TXT records found" }
+               if ((boolFoundMatch == false) || (hashReturn.empty?))
+                  hashReturn = { "type" => "DKIM1", "result" => "FAIL", "data" => strHost, "ext_data" => "No matching DKIM/TXT records found" }
                end
             rescue
                hashReturn = { "type" => "DKIM1", "result" => "ERROR", "data" => strHost, "ext_data" => "Unable to resolve host, or query timed out" }
@@ -220,7 +319,7 @@ module WLValidate
          return hashReturn
       end
 
-      def self.DKIM2(strWL, strDomain)
+      def DKIM2(strWL, strDomain)
          # PURPOSE: Get TXT/CNAME record for smtpapi._domainkey.<wl>.<domain>.<tlds>
          # RETURNS: Hash - See above for definition
 
@@ -228,31 +327,41 @@ module WLValidate
          boolFoundMatch = false
          strHost = "smtpapi._domainkey." + strWL + "." + strDomain
          strDKIM = "k=rsa; t=s; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDPtW5iwpXVPiH5FzJ7Nrl8USzuY9zqqzjE0D1r04xDN6qwziDnmgcFNNfMewVKN2D1O+2J9N14hRprzByFwfQW76yojh54Xu3uSbQ3JP0A7k8o8GutRF8zbFUA8n0ZH2y0cIEjMliXY4W4LwPA7m4q0ObmvSjhd63O9d8z1XkUBwIDAQAB"
-         strDKIM_k = "rsa"
-         strDKIM_t = "s"
-         strDKIM_p = "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDPtW5iwpXVPiH5FzJ7Nrl8USzuY9zqqzjE0D1r04xDN6qwziDnmgcFNNfMewVKN2D1O+2J9N14hRprzByFwfQW76yojh54Xu3uSbQ3JP0A7k8o8GutRF8zbFUA8n0ZH2y0cIEjMliXY4W4LwPA7m4q0ObmvSjhd63O9d8z1XkUBwIDAQAB"
 
          if ((strWL == "") || (strDomain == ""))
             hashReturn = { "type" => "DKIM2", "result" => "ERROR", "data" => "Missing parameters", "ext_data" => "One or more expected paramters are missing!" }
          end
 
-         Dnsruby::DNS.open {|dns|
+         set_auth_ns(strDomain)         
+
+         if ((@dns_type == 2) || (@dns_type == 3))
+            dns_params = {:nameserver=>@dns_server}
+         end
+
+         Dnsruby::DNS.open(dns_params) {|dns|
             begin
                arrayDKIM2 = dns.getresources(strHost, Dnsruby::Types.TXT)
                arrayDKIM2.each do |r|
-                  if boolFoundMatch == false
-                     if (r.name.to_s == "dkim.sendgrid.net")
-                        hashReturn = { "type" => "DKIM2", "result" => "PASS", "data" => r.name.to_s, "ext_data" => "cname" }
-                        boolFoundMatch = true
-                     elsif ( (r.name.to_s == strHost) && (r.data.split(" ")[0].match %r{#{Regexp.escape(strDKIM_k)}}) && (r.data.split(" ")[1].match %r{#{Regexp.escape(strDKIM_t)}}) && (r.data.split(" ")[2].match %r{#{Regexp.escape(strDKIM_p)}}) )
-                        hashReturn = { "type" => "DKIM2", "result" => "PASS", "data" => r.name.to_s, "ext_data" => "txt" }
+                  if r.name.to_s.match %r{dkim.sendgrid.net}
+                     hashReturn = { "type" => "DKIM2", "result" => "PASS", "data" => r.name.to_s, "ext_data" => "CNAME" }
+                     boolFoundMatch = true
+                  end
+                  if ((r.name.to_s == strHost) && (r.data == strDKIM))
+                     hashReturn = { "type" => "DKIM2", "result" => "PASS", "data" => r.name.to_s, "ext_data" => "TXT" }
+                     boolFoundMatch = true
+                  end
+               end
+
+               if ((boolFoundMatch == false) || (hashReturn.empty?))
+                  arrayDKIM2CNAME = dns.getresources(strHost, Dnsruby::Types.CNAME)
+                  arrayDKIM2CNAME.each do |c|
+                     if c.rdata_to_string.match %r{dkim.sendgrid.net}
+                        hashReturn = { "type" => "DKIM2", "result" => "PASS", "data" => c.name.to_s, "ext_data" => "CNAME" }
                         boolFoundMatch = true
-                     else
-                        hashReturn = { "type" => "DKIM2", "result" => "FAIL", "data" => strHost, "ext_data" => "No DKIM record found as either CNAME or TXT" }
                      end
                   end
                end
-               if hashReturn.empty?
+               if ((boolFoundMatch == false) || (hashReturn.empty?))
                   hashReturn = { "type" => "DKIM2", "result" => "FAIL", "data" => strHost, "ext_data" => "No matching DKIM/TXT records found" }
                end
             rescue
@@ -262,7 +371,7 @@ module WLValidate
          return hashReturn
       end
 
-      def self.SPF(strWL, strDomain)
+      def SPF(strWL, strDomain)
          # PURPOSE: Get TXT record and make sure it has include:sendgrid.net
          # RETURNS: Hash - See above for definition
 
@@ -273,7 +382,13 @@ module WLValidate
             hashReturn = { "type" => "SPF", "result" => "ERROR", "data" => "Missing parameters", "ext_data" => "One or more expected paramters are missing!" }
          end
 
-         Dnsruby::DNS.open {|dns|
+         set_auth_ns(strDomain)         
+
+         if ((@dns_type == 2) || (@dns_type == 3))
+            dns_params = {:nameserver=>@dns_server}
+         end
+
+         Dnsruby::DNS.open(dns_params) {|dns|
             begin
                arrayTXT = dns.getresources(strDomain, Dnsruby::Types.TXT)
                if arrayTXT.to_s != "[]"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wlvalidate
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
-dependencies: []
+date: 2013-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dnsruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: SendGrid Rails Gem to validate White Label settings
 email: jayson.sperling@sendgrid.com
 executables: []
@@ -38,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: SendGrid White Label Validator