mailshield 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b14ffd727fa0a54fbce427772f17317f28743bdcd87ec2f204bf89fc25530f3e
-  data.tar.gz: 6e593d1bac55e212d43d875692a2ae9d6ae10a451409e779f188531849bdac78
+  metadata.gz: 75a143d6ea43f54fb93d97111b110549b11af8e4095d8633a0983d29bc24d48a
+  data.tar.gz: 7a7f03578febe47f990afc419a87af3b0c2eb3100adf9738c8f8188511bc779d
 SHA512:
-  metadata.gz: 7bff616725f5ee9c1ea1d8cf49777ad6a0e83915bf1e48639e771785b84df7e0cd3db9f55aa7093477cee93fdaf93c241c3b475d3c159f1dd31cfb95afbf7ce4
-  data.tar.gz: acd38d78a78e94edf2df0e8f17b5debe32aca7ce17d2657df69323ff9909fa4c72f2f9d3023c3a937f535a12242525fc9ebf54209159fcacf5790b9ccb5e3fc7
+  metadata.gz: dcbab4e23187ea34d25a7f6a8a63083ed006d5456a40ac089b1e1dad4cab5c2dbc3d31833da47b03a6a49357d95cf0a7655805528ea1b9b14fa84748014f991b
+  data.tar.gz: 27ce04f2c1422ee26667c891d037c55bffc55aa1865dd66d62449469dbcdd90577c60b8eb4aa8c48dfde299b1445fb3c1f86002de9c034a3074a721db196b853

data/lib/mailshield/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mailshield
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/mailshield.rb

@@ -2,33 +2,121 @@
 
 require_relative "mailshield/version"
 require 'resolv'
+require 'csv'
 
 module MailShield
-  class DomainChecker
-    TEMP_DOMAINS = %w[mailinator.com tempmail.com guerrillamail.com].freeze # If any one want to contribute, please add the known more domains here.
 
-    def self.temporary_email?(email)
+  class ValidationResult
+    attr_reader :emails
+
+    def initialize(emails)
+      @emails = emails
+    end
+
+    def valid_emails
+      emails.select { |email| email[:valid] }.map { |email| email[:email] }
+    end
+
+    def invalid_emails
+      emails.reject { |email| email[:valid] }.map { |email| email[:email] }
+    end
+
+    def get_emails
+      emails.map { |email| { email: email[:email], valid: email[:valid] } }
+    end
+  end
+
+  class << self
+    TEMP_DOMAINS = %w[mailinator.com tempmail.com guerrillamail.com].freeze # Known temporary domains
+
+
+    # Main method to validate an email and return results in a hash
+    def validate_email(email)
+      result = {
+        email: email,
+        valid: true,
+        issues: []
+      }
+
+      unless valid_email_format?(email)
+        result[:valid] = false
+        result[:issues] << "The email address format is invalid."
+        return result
+      end
+
       domain = extract_domain(email)
-      return true if known_temp_domain?(domain)
+
+      if known_temp_domain?(domain)
+        result[:valid] = false
+        result[:issues] << "The email domain is known to be temporary or disposable."
+        return result
+      end
 
       mx_records = fetch_mx_records(domain)
-      return true if suspicious_mx_records?(mx_records)
+      if mx_records.empty?
+        result[:valid] = false
+        result[:issues] << "The email domain does not have valid mail exchange records."
+        return result
+      elsif suspicious_mx_records?(mx_records)
+        result[:valid] = false
+        result[:issues] << "The email domain's mail exchange records suggest it might be used for temporary or disposable email services."
+        return result
+      end
 
-      return true unless spf_record?(domain)
-      return true unless dmarc_record?(domain)
+      unless spf_record?(domain)
+        result[:valid] = false
+        result[:issues] << "The email domain is missing important records that help confirm its authenticity."
+        return result
+      end
+
+      unless dmarc_record?(domain)
+        result[:valid] = false
+        result[:issues] << "The email domain is missing records that help protect against email fraud."
+        return result
+      end
+
+      result
+    end
+
+    def validate_emails_from_csv(input_file_path)
+      email_results = []
+
+      CSV.foreach(input_file_path, headers: true) do |row|
+        email = row['email']
+        validation_result = validate_email_for_csv(email)
+        email_results << { email: email, valid: validation_result }
+      end
+
+      ValidationResult.new(email_results)
+    end
+
+    def validate_email_for_csv(email)
+      return false unless valid_email_format?(email)
+      domain = extract_domain(email)
 
-      false
+      return false if known_temp_domain?(domain)
+      return false unless spf_record?(domain)
+      return false unless dmarc_record?(domain)
+
+      true
     end
 
-    def self.extract_domain(email)
+    private
+
+    def extract_domain(email)
       email.split('@').last.downcase
     end
 
-    def self.known_temp_domain?(domain)
+    def valid_email_format?(email)
+      email_regex = /\A[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}\z/
+      !!(email =~ email_regex)
+    end
+
+    def known_temp_domain?(domain)
       TEMP_DOMAINS.include?(domain)
     end
 
-    def self.fetch_mx_records(domain)
+    def fetch_mx_records(domain)
       Resolv::DNS.open do |dns|
         mx_records = dns.getresources(domain, Resolv::DNS::Resource::IN::MX)
         mx_records.map(&:exchange).map(&:to_s)
@@ -37,22 +125,22 @@ module MailShield
       []
     end
 
-    def self.suspicious_mx_records?(mx_records)
+    def suspicious_mx_records?(mx_records)
       suspicious_patterns = [/mailinator/, /tempmail/, /guerrillamail/]
       mx_records.any? { |mx| suspicious_patterns.any? { |pattern| mx.match?(pattern) } }
     end
 
-    def self.spf_record?(domain)
+    def spf_record?(domain)
       spf_records = fetch_txt_records(domain)
       spf_records.any? { |record| record.include?('v=spf1') }
     end
 
-    def self.dmarc_record?(domain)
+    def dmarc_record?(domain)
       dmarc_records = fetch_txt_records("_dmarc.#{domain}")
       dmarc_records.any? { |record| record.include?('v=DMARC1') }
     end
 
-    def self.fetch_txt_records(domain)
+    def fetch_txt_records(domain)
       Resolv::DNS.open do |dns|
         records = dns.getresources(domain, Resolv::DNS::Resource::IN::TXT)
         records.map(&:data)
@@ -62,3 +150,18 @@ module MailShield
     end
   end
 end
+
+
+# SPF Record Explanation:
+#
+# SPF (Sender Policy Framework): A mechanism that helps email servers verify that an email claiming to come from a specific domain is actually sent by an authorized mail server. 
+# This prevents spammers from sending messages with forged "From" addresses.
+#
+# DMARC Record Explanation:
+#
+# DMARC (Domain-based Message Authentication, Reporting, and Conformance): A protocol that builds on SPF and DKIM (DomainKeys Identified Mail) to help email domain owners protect their domain from being used in email spoofing. 
+# It provides a way for domain owners to publish policies about their email authentication practices and how receiving mail servers should enforce them.
+#
+# References:
+# https://www.dkim.org/
+# https://www.cloudflare.com/en-gb/learning/dns/dns-records/dns-spf-record/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailshield
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - jana