wlvalidate 0.1.5

data/lib/wlvalidate.rb

@@ -0,0 +1,316 @@
+=begin
+
+   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? ]
+   +=======+===========+===================+===========++========+=================+======================+
+   | A     | PASS/FAIL | (none)            | (none)    || Done   | Array of hashes | Yes                  |
+   | SPF   | PASS/FAIL | SPF record        | Fail type || Done   | Hash            | Yes                  |
+   | CNAME | PASS/FAIL | CNAME             | (none)    || Done   | Hash            | Yes                  |
+   | DKIM1 | PASS/FAIL | (none)            | CNAME/TXT || Done   | Hash            | Yes                  |
+   | DKIM2 | PASS/FAIL | (none)            | CNAME/TXT || Done   | Hash            | Yes                  |
+   | MX    | INFO      | MX Hostname       | Priority  || Done   | Array of hashes |                      |
+   +-------+-----------+-------------------+-----------++--------+-----------------+----------------------+
+   | 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
+require 'dnsruby'
+include Dnsruby
+
+module WLValidate
+   class Validate
+      def initialize(attributes=nil)
+         @intDNSTimeout = 5
+         @intDNSIPLoops = 5
+      end
+
+      def self.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
+
+         arrayReturns = Array.new
+
+         hashSPF = self.SPF(strWL, strDomain)
+         hashCNAME = self.CNAME(strWL, strDomain)
+         hashA = self.A(strWL, strDomain)
+         hashDKIM1 = self.DKIM1(strWL, strDomain)
+         hashDKIM2 = self.DKIM2(strWL, strDomain)
+         arrayMX = self.MX(strWL, strDomain)
+
+         # array.push hashes, and array.concat arrays
+         arrayReturns.push(hashSPF)
+         arrayReturns.push(hashCNAME)
+         arrayReturns.concat(hashA)
+         arrayReturns.push(hashDKIM1)
+         arrayReturns.push(hashDKIM2)
+         arrayReturns.concat(arrayMX)
+
+         return arrayReturns
+      end
+
+      def self.MX(strWL, strDomain)
+         # PURPOSE: Loop through all <domain> MX records
+         # RETURNS: Array of hashes 
+         hashTemp = Hash.new
+         arrayReturn = Array.new
+         arrayMX = Array.new
+
+         if ((strWL == "") || (strDomain == ""))
+            hashReturn = { "type" => "MX", "result" => "ERROR", "data" => "Missing parameters", "ext_data" => "One or more parameters are missing!" }
+         end
+
+         Dnsruby::DNS.open {|dns|
+            begin
+               arrayMX = dns.getresources(strDomain, Dnsruby::Types.MX)
+               if (arrayMX.count > 0)
+                  arrayMX.sort!
+                  arrayMX.each do |r|
+                     myExchange = r.exchange.to_s
+                     myPreference = r.preference.to_s
+                     hashTemp = { "type" => "MX", "result" => "INFO", "data" => myExchange, "ext_data" => myPreference }
+                     arrayReturn.push(hashTemp)
+                     hashTemp = {}
+                  end
+               else
+                  hashTemp = { "type" => "MX", "result" => "FAIL", "data" => "No records", "ext_data" => "No MX records exist for this domain" }
+                  arrayReturn.push(hashTemp)
+                  hashTemp = {}
+               end               
+            rescue
+               hashTemp = { "type" => "MX", "result" => "ERROR", "data" => "Unable to resolve", "ext_data" => "Unable to resolve MX records for domain " + strDomain }
+               arrayReturn.push(hashTemp)
+               hashTemp = {}
+            end
+         }
+         if arrayReturn.empty?
+            hashReturn = { "type" => "MX", "result" => "FAIL", "data" => "No data", "ext_data" => "No MX records in domain" }
+            arrayReturn.push(hashReturn)
+            hashReturn = {}
+         end
+         return arrayReturn
+      end
+
+      def self.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
+
+         hashReturn = Hash.new
+         arrayReturn = Array.new
+
+         if ((strWL == "") || (strDomain == ""))
+            hashReturn = { "type" => "A", "result" => "ERROR", "data" => "Missing parameters", "ext_data" => "One or more expected paramters are missing!" }
+         end
+
+         i = 1
+         intDNSIPLoops = 11
+         while i < intDNSIPLoops do
+            begin
+               tmpHost = "o" + i.to_s + "." + strWL + "." + strDomain
+               tmpIP = Dnsruby::Resolv.getaddress(tmpHost)
+               resolvedHost = Dnsruby::Resolv.getname(tmpIP)
+               if tmpHost == resolvedHost
+                  hashReturn = { "type" => "A", "result" => "PASS", "data" => tmpHost, "ext_data" => tmpIP }
+                  arrayReturn.push(hashReturn)
+                  hashReturn = {}
+               end
+            rescue Dnsruby::ResolvTimeout
+                  hashReturn = { "type" => "A", "result" => "ERROR", "data" => tmpHost, "ext_data" => "Timed out while attempting rDNS lookup" }
+                  arrayReturn.push(hashReturn)
+                  hashReturn = {}
+            rescue      
+                  #hashReturn = { "type" => "A", "result" => "ERROR", "data" => tmpHost, "ext_data" => "Unable to resolve rDNS for host" }
+                  #arrayReturn.push(hashReturn)
+                  #hashReturn = {}
+            end
+            i += 1
+         end
+         if arrayReturn.empty?
+            hashReturn = { "type" => "A", "result" => "FAIL", "data" => "No data", "ext_data" => "No SendGrid IPs" }
+            arrayReturn.push(hashReturn)
+            hashReturn = {}
+         end
+
+         return arrayReturn
+      end
+
+      def self.CNAME(strWL, strDomain)
+         # PURPOSE: Get CNAME record and make sure it's mapped to 'sendgrid.net'
+         # RETURNS: Hash - See above for definition
+
+         hashReturn = Hash.new
+         boolFoundMatch = false
+
+         if ((strWL == "") || (strDomain == ""))
+            hashReturn = { "type" => "CNAME", "result" => "ERROR", "data" => "Missing parameters", "ext_data" => "One or more expected paramters are missing!" }
+         end
+
+         Dnsruby::DNS.open {|dns|
+            begin
+               strHost = strWL + "." + strDomain
+               arrayCNAME = dns.getresources(strHost, Dnsruby::Types.CNAME)
+               arrayCNAME.each do |r|
+                  if boolFoundMatch == false
+                     tmpCNAME = r.domainname.to_s
+                     if tmpCNAME.match %r{sendgrid.net}
+                        hashReturn = { "type" => "CNAME", "result" => "PASS", "data" => strHost, "ext_data" => tmpCNAME }
+                        boolFoundMatch = true
+                     end
+                  end
+                  if hashReturn.empty?
+                     hashReturn = { "type" => "CNAME", "result" => "FAIL", "data" => "No data", "ext_data" => "No matching CNAME records found" }
+                  end
+               end
+            rescue Dnsruby::ResolvTimeout
+               hashReturn = { "type" => "CNAME", "result" => "ERROR", "data" => strHost, "ext_data" => "Timed out while attempting rDNS lookup" }
+            rescue
+               hashReturn = { "type" => "CNAME", "result" => "ERROR", "data" => strHost, "ext_data" => "Unable to resolve host, or query timed out" }
+            end
+         }
+         return hashReturn
+      end
+
+      def self.DKIM1(strWL, strDomain)
+         # PURPOSE: Get TXT/CNAME record for smtpapi._domainkey.<domain>.<tlds>
+         # RETURNS: Hash - See above for definition
+
+         hashReturn = Hash.new
+         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|
+            begin
+               arrayDKIM1 = dns.getresources(strHost, Dnsruby::Types.TXT)
+               arrayDKIM1.each do |r|
+                  if boolFoundMatch == false
+                     puts "DKIM data: #{r.data}"
+                     r.data.split(" ").each {|k|
+                       puts "#{k}"
+                     }
+                     puts "r.name.to_s => #{r.name.to_s}"
+                     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" }
+                        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" }
+               end
+            rescue
+               hashReturn = { "type" => "DKIM1", "result" => "ERROR", "data" => strHost, "ext_data" => "Unable to resolve host, or query timed out" }
+            end
+         }
+         return hashReturn
+      end
+
+      def self.DKIM2(strWL, strDomain)
+         # PURPOSE: Get TXT/CNAME record for smtpapi._domainkey.<wl>.<domain>.<tlds>
+         # RETURNS: Hash - See above for definition
+
+         hashReturn = Hash.new
+         boolFoundMatch = false
+         strHost = "smtpapi._domainkey." + strWL + "." + strDomain
+         strDKIM = "k=rsa; t=s; 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|
+            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 == strDKIM))
+                        hashReturn = { "type" => "DKIM2", "result" => "PASS", "data" => r.name.to_s, "ext_data" => "txt" }
+                        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?
+                  hashReturn = { "type" => "DKIM2", "result" => "FAIL", "data" => strHost, "ext_data" => "No matching DKIM/TXT records found" }
+               end
+            rescue
+               hashReturn = { "type" => "DKIM2", "result" => "ERROR", "data" => strHost, "ext_data" => "Unable to resolve host, or query timed out" }
+            end
+         }
+         return hashReturn
+      end
+
+      def self.SPF(strWL, strDomain)
+         # PURPOSE: Get TXT record and make sure it has include:sendgrid.net
+         # RETURNS: Hash - See above for definition
+
+         hashReturn = Hash.new
+         boolFoundMatch = false
+
+         if ((strWL == "") || (strDomain == ""))
+            hashReturn = { "type" => "SPF", "result" => "ERROR", "data" => "Missing parameters", "ext_data" => "One or more expected paramters are missing!" }
+         end
+
+         Dnsruby::DNS.open {|dns|
+            begin
+               arrayTXT = dns.getresources(strDomain, Dnsruby::Types.TXT)
+               if arrayTXT.to_s != "[]"
+                  arrayTXT.each do |r|
+                     if boolFoundMatch == false
+                        rTXT = r.strings.to_s
+                        if ((rTXT.match('v=spf1')) && (rTXT.match('include:sendgrid.net')))
+                           if rTXT.match %r{~al}
+                              hashReturn = { "type" => "SPF", "result" => "PASS", "data" => rTXT, "ext_data" => "softfail" }
+                           elsif rTXT.match %r{-al}
+                              hashReturn = { "type" => "SPF", "result" => "PASS", "data" => rTXT, "ext_data" => "fail" }
+                           elsif rTXT =~/^+al/
+                              hashReturn = { "type" => "SPF", "result" => "PASS", "data" => rTXT, "ext_data" => "pass" }
+                           elsif rTXT.match %r{\?al}
+                              hashReturn = { "type" => "SPF", "result" => "PASS", "data" => rTXT, "ext_data" => "neutral" }
+                           else
+                              hashReturn = { "type" => "SPF", "result" => "PASS", "data" => rTXT, "ext_data" => "" }
+                           end
+                           boolFoundMatch = true
+                        else
+                           hashReturn = { "type" => "SPF", "result" => "FAIL", "data" => "No record", "ext_data" => "The requested SPF record was not found" }
+                        end
+                     end
+                  end
+                  if hashReturn.empty?
+                     hashReturn = { "type" => "SPF", "result" => "FAIL", "data" => "No record", "ext_data" => "No matching DKIM/TXT records found" }
+                  end
+               else
+                  hashReturn = { "type" => "SPF", "result" => "FAIL", "data" => "No record", "ext_data" => "No TXT records found for domain" }
+               end
+            rescue
+               hashReturn = { "type" => "SPF", "result" => "ERROR", "data" => "No record", "ext_data" => "The requested SPF record was not found" }
+            end
+         }
+         return hashReturn
+      end
+   end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: wlvalidate
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+  prerelease: 
+platform: ruby
+authors:
+- Jayson M. Sperling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-08 00:00:00.000000000 Z
+dependencies: []
+description: SendGrid Rails Gem to validate White Label settings
+email: jayson.sperling@sendgrid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/wlvalidate.rb
+homepage: http://dev.tluw.net/sg/wlvalidate
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: SendGrid White Label Validator
+test_files: []