mailshield 0.1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75a143d6ea43f54fb93d97111b110549b11af8e4095d8633a0983d29bc24d48a
-  data.tar.gz: 7a7f03578febe47f990afc419a87af3b0c2eb3100adf9738c8f8188511bc779d
+  metadata.gz: 47694cab766631dd24097db7e130aeac98bbc12f2ad4aef7a5f065811796ea71
+  data.tar.gz: 52d6019eb905e12d7d4e5d6eee0cae2c36fba7e301a5e897c3350fa26aeb632f
 SHA512:
-  metadata.gz: dcbab4e23187ea34d25a7f6a8a63083ed006d5456a40ac089b1e1dad4cab5c2dbc3d31833da47b03a6a49357d95cf0a7655805528ea1b9b14fa84748014f991b
-  data.tar.gz: 27ce04f2c1422ee26667c891d037c55bffc55aa1865dd66d62449469dbcdd90577c60b8eb4aa8c48dfde299b1445fb3c1f86002de9c034a3074a721db196b853
+  metadata.gz: 41ec5aa1ae5db31d9e0e437eac3dc85da10561cecc9c1b57fe793fccda7990f7a707695c4f794c0518ed2fb23c99767daa18a7cca8488e7792b939e5a71d432e
+  data.tar.gz: 887fe66ea4b30711689cea1346c9466d326cb13c927b6e957c6d6d035ef908f0a5739751f27e6af17c4dbdb3d6df9d5bca4bf89087064fbc3d2427f8ce4a717b

data/lib/mailshield/disposable_domains.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+require 'set'
+
+module MailShield
+  KNOWN_DISPOSABLE_DOMAINS = Set.new(
+    [
+      '10mail.org', '10minut.com.pl', '10minut.xyz', '10minutemail.nl', '11163.com',
+      '1secmail.com', '1secmail.net', '1secmail.org', '20minutemail.com', '2chmail.net',
+      '30wave.com', '4warding.net', '55hosting.net', '5july.org', '5ymail.com',
+      '672643.net', '6ip.us', '99.com', 'acentri.com', 'afrobacon.com',
+      'ahk.jp', 'aiafhg.com', 'airsi.de', 'akgq701.com', 'aleeas.com',
+      'alienware13.com', 'ama-trans.de', 'amiri.net', 'ano-mail.net', 'anonaddy.com',
+      'anonmails.de', 'apkmd.com', 'armyspy.com', 'asorent.com', 'augmentationtechnology.com',
+      'aver.com', 'averdov.com', 'axsup.net', 'b2cmail.de', 'banit.club',
+      'bearsarefuzzy.com', 'belamail.org', 'bitwhites.top', 'bladesmail.net', 'bobmail.info',
+      'boxformail.in', 'ccmail.uk', 'ceed.se', 'chammy.info', 'cheaphub.net',
+      'choco.la', 'choicemail1.com', 'chong-mail.net', 'cocoro.uk', 'cocovpn.com',
+      'crazymailing.com', 'cream.pink', 'cutradition.com', 'cuvox.de', 'd1yun.com',
+      'd3p.dk', 'dab.ro', 'dandikmail.com', 'datum2.com', 'dayrep.com',
+      'desoz.com', 'devnullmail.com', 'digdig.org', 'digitalsanctuary.com', 'dispo.in',
+      'dispostable.com', 'dndent.com', 'domozmail.com', 'drdrb.com', 'drevo.si',
+      'dropmail.me', 'dukedish.com', 'durandinterstellar.com', 'e4ward.com', 'eay.jp',
+      'ee1.pl', 'efxs.ca', 'einmalmail.de', 'einrot.com', 'eintagsmail.de',
+      'email.com', 'email.it', 'email60.com', 'emailinfive.com', 'emailresort.com',
+      'emailxfer.com', 'emeraldwebmail.com', 'emlhub.com', 'emlpro.com', 'emltmp.com',
+      'envy17.com', 'esemay.com', 'ether123.net', 'ethereum1.top', 'ethersports.org',
+      'evyush.com', 'exdonuts.com', 'express.net.ua', 'eyepaste.com', 'fanclub.pm',
+      'fangoh.com', 'fantasymail.de', 'fastmail.com', 'fatflap.com', 'fightallspam.com',
+      'fiifke.de', 'findu.pl', 'fleckens.hu', 'foobarbot.net', 'fr33mail.info',
+      'freeinbox.email', 'freeml.net', 'fukurou.ch', 'fuwamofu.com', 'fuwari.be',
+      'gafy.net', 'gambling.com', 'gehensiemirnichtaufdensack.de', 'gelitik.in', 'geronra.com',
+      'getmails.eu', 'getover.de', 'givememail.club', 'gmatch.org', 'go2vpn.net',
+      'golemico.com', 'greenhousemail.com', 'guerillamail.biz', 'guerrillamail.com', 'gustr.com',
+      'haltospam.com', 'hamham.uk', 'harakirimail.com', 'haydoo.com', 'headstrong.de',
+      'heisei.be', 'herp.in', 'herpderp.nl', 'hidemyass.com', 'hidzz.com',
+      'hola.org', 'honeys.be', 'honor-8.com', 'hornyalwary.top', 'hostcalls.com',
+      'hotmai.com', 'hotsoup.be', 'ichigo.me', 'icx.ro', 'ieatspam.eu',
+      'ige.es', 'imails.info', 'imstations.com', 'in-ulm.de', 'inboxalias.com',
+      'inkomail.com', 'instaddr.ch', 'interstats.org', 'ip6.li', 'janproz.com',
+      'jobposts.net', 'jourrapide.com', 'kagi.be', 'katztube.com', 'kbox.li',
+      'kkmail.be', 'kksm.be', 'klipschx12.com', 'kmail.li', 'koszmail.pl',
+      'kpay.be', 'kpost.be', 'kulturbetrieb.info', 'labworld.org', 'lee.mx',
+      'lenovog4.com', 'lgxscreen.com', 'lifetotech.com', 'ligsb.com', 'lillemap.net',
+      'locanto1.club', 'locantofuck.top', 'lukop.dk', 'macr2.com', 'macromaid.com',
+      'magim.be', 'mail.darmajaya.ac.id', 'mail.ru', 'mail.tm', 'mail21.cc',
+      'mailcker.com', 'maildrop.cc', 'maildx.com', 'mailfs.com', 'mailguard.me',
+      'mailinater.com', 'mailinator.com', 'mailinator.net', 'mailinator.us', 'mailsac.com',
+      'mailscrap.com', 'mailshell.com', 'mailtechx.com', 'mailtothis.com', 'mama3.org',
+      'manybrain.com', 'mbox.re', 'meantinc.com', 'mepost.pw', 'merry.pink',
+      'metalunits.com', 'midiharmonica.com', 'mirai.re', 'mobilevpn.top', 'mofu.be',
+      'moimoi.re', 'monumentmail.com', 'morsin.com', 'mt2009.com', 'mt2014.com',
+      'mt2015.com', 'mybitti.de', 'mymail-in.net', 'mymailoasis.com', 'mypacks.net',
+      'myspamless.com', 'mystvpn.com', 'mytrashmail.com', 'na-cat.com', 'nada.email',
+      'nagi.be', 'nanonym.ch', 'neko2.net', 'nekochan.fr', 'nervmich.net',
+      'nextstopvalhalla.com', 'nezdiro.org', 'nezumi.be', 'niseko.be', 'nospamfor.us',
+      'notmailinator.com', 'ntlhelp.net', 'nurfuerspam.de', 'nutpa.net', 'nypato.com',
+      'okinawa.li', 'onemail.host', 'onetm.jp', 'online.ms', 'oopi.org',
+      'ovomail.co', 'owleyes.ch', 'oxopoha.com', 'p33.org', 'pancakemail.com',
+      'pavilionx2.com', 'payperex2.com', 'pecinan.net', 'pingir.com', 'placebomail10.com',
+      'plw.me', 'porsh.net', 'pratikmail.com', 'pratikmail.org', 'prin.be',
+      'privy-mail.de', 'pro-tag.org', 'projectcl.com', 'psh.me', 'put2.net',
+      'putthisinyourspamdatabase.com', 'qtum-ico.com', 'quickemail.info', 'quicksend.ch', 'rabin.ca',
+      'rapt.be', 'reallymymail.com', 'recode.me', 'redfeathercrow.com', 'reftoken.net',
+      'rhyta.com', 'rootfest.net', 'royal.net', 'ruru.be', 'safetymail.info',
+      'schrott-email.de', 'sendnow.win', 'sendspamhere.com', 'senseless-entertainment.com', 'sexyalwasmi.top',
+      'shalar.net', 'sharklasers.com', 'shieldedmail.com', 'shieldemail.com', 'shipfromto.com',
+      'shrib.com', 'sika3.com', 'simaenaga.com', 'simplelogin.co', 'sinaite.net',
+      'slaskpost.se', 'sofia.re', 'sogetthis.com', 'spamdecoy.net', 'spamhereplease.com',
+      'spamhole.com', 'stayhome.li', 'storiqax.top', 'storj99.com', 'storj99.top',
+      'stromox.com', 'superrito.com', 'supersave.net', 'suremail.info', 'svk.jp',
+      'tapi.re', 'teleworm.us', 'temp-mail.org', 'tempail.com', 'tempemail.net',
+      'tempmail.dev', 'tempmail2.com', 'tempmailer.com', 'tempmailo.com', 'tensi.org',
+      'testudine.com', 'thankyou2010.com', 'thisisnotmyrealemail.com', 'throwam.com', 'tilien.com',
+      'tmail.ws', 'tokem.co', 'topless-new-world.com', 'topmail.com', 'torba.cc',
+      'trickmail.net', 'trickmail.org', 'trixtrux1.com', 'truckeremail.net', 'tryalert.com',
+      'turual.com', 'twddos.com', 'unmail.ru', 'uploadnolimit.com', 'uw5t6ds54.com',
+      'ventolin.org', 'vintomaper.com', 'vmailcloud.com', 'vubby.com', 'vuiy.pw',
+      'warpmail.net', 'watch-harry-potter.com', 'watchfulli.com', 'wep68.com', 'wh4f.org',
+      'willhackforfood.biz', 'winbroadband.co.uk', 'workshop-liberal.com', 'wronghead.com', 'wwwmail.win',
+      'x24.com', 'xn--9kq967o.com', 'xn--cg7bx4b4x1b.com', 'xsynergy.top', 'xxhamsterxx.com',
+      'yepmail.net', 'yesspam.com', 'yo-site.com', 'yogotemail.com', 'yopmail.fr',
+      'yopmail.gq', 'yopmail.net', 'yopmail.org', 'yourinbox.email', 'yuurok.com',
+      'zainmax.net', 'ze.gy', 'zipmail.com', 'zoemail.net', 'zombie-hive.com',
+      'zsero.com', 'zumrot.com'
+    ]
+  )
+
+
+  class << self
+    def disposable_domain?(domain)
+      KNOWN_DISPOSABLE_DOMAINS.include?(domain)
+    end
+  end
+end

data/lib/mailshield/secure_email_validator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module MailShield
+  class SecureEmailValidator < ActiveModel::Validator
+    def validate(record)
+      email = record.email
+      return if email.blank?
+
+      result = MailShield.validate_email(email)
+
+      return if result[:valid]
+
+      record.errors.add(:email, result[:issue])
+    end
+  end
+end

data/lib/mailshield/version.rb

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

data/lib/mailshield.rb

@@ -1,133 +1,89 @@
 # frozen_string_literal: true
 
-require_relative "mailshield/version"
+require_relative 'mailshield/version'
+require_relative 'mailshield/disposable_domains'
 require 'resolv'
 require 'csv'
+require 'net/smtp'
 
 module MailShield
+  EMAIL_REGEX = /\A[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}\z/.freeze
 
-  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 ValidationError < StandardError; end
+  class InvalidFormatError < ValidationError; end
+  class DomainNotFoundError < ValidationError; end
+  class SPFError < ValidationError; end
+  class DMARCError < ValidationError; end
+  class SMTPError < ValidationError; end
 
   class << self
-    TEMP_DOMAINS = %w[mailinator.com tempmail.com guerrillamail.com].freeze # Known temporary domains
-
+    attr_accessor :dns_cache, :smtp_cache
 
-    # 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
+    def validate_email(email, verify_by_send: false)
+      reset_caches
 
       domain = extract_domain(email)
 
-      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)
-      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
-
-      unless spf_record?(domain)
-        result[:valid] = false
-        result[:issues] << "The email domain is missing important records that help confirm its authenticity."
-        return result
+      begin
+        validate_format!(email)
+        validate_domain!(domain)
+        validate_spf!(domain)
+        validate_dmarc!(domain)
+        validate_smtp!(email) if verify_by_send
+      rescue ValidationError => e
+        return { valid: false, issues: [e.message] }
       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
+      { valid: true }
+    end
 
-      result
+    def verify_address(email)
+      smtp_verify_email(email)
     end
 
-    def validate_emails_from_csv(input_file_path)
-      email_results = []
+    private
 
-      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
+    def reset_caches
+      @dns_cache = {}
+      @smtp_cache = {}
+    end
 
-      ValidationResult.new(email_results)
+    def validate_format!(email)
+      raise InvalidFormatError, 'The email address format is invalid.' unless valid_email_format?(email)
     end
 
-    def validate_email_for_csv(email)
-      return false unless valid_email_format?(email)
-      domain = extract_domain(email)
+    def validate_domain!(domain)
+      raise DomainNotFoundError, 'Email Not Found.' if fetch_mx_records(domain).empty?
+    end
 
-      return false if known_temp_domain?(domain)
-      return false unless spf_record?(domain)
-      return false unless dmarc_record?(domain)
+    def validate_spf!(domain)
+      raise SPFError, 'Temporary / Disposable Email' unless spf_record?(domain)
+    end
 
-      true
+    def validate_dmarc!(domain)
+      raise DMARCError, 'Temporary / Disposable Email' unless dmarc_record?(domain)
     end
 
-    private
+    def validate_smtp!(email)
+      raise SMTPError, 'Email Address Not Found' unless smtp_verify_email(email)
+    end
 
     def extract_domain(email)
       email.split('@').last.downcase
     end
 
     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)
+      EMAIL_REGEX.match?(email)
     end
 
     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)
+      dns_cache[domain] ||= begin
+        Resolv::DNS.open do |dns|
+          dns.getresources(domain, Resolv::DNS::Resource::IN::MX).map(&:exchange).map(&:to_s)
+        end
+      rescue Resolv::ResolvError
+        []
       end
-    rescue Resolv::ResolvError
-      []
-    end
-
-    def suspicious_mx_records?(mx_records)
-      suspicious_patterns = [/mailinator/, /tempmail/, /guerrillamail/]
-      mx_records.any? { |mx| suspicious_patterns.any? { |pattern| mx.match?(pattern) } }
     end
 
     def spf_record?(domain)
@@ -141,27 +97,36 @@ module MailShield
     end
 
     def fetch_txt_records(domain)
-      Resolv::DNS.open do |dns|
-        records = dns.getresources(domain, Resolv::DNS::Resource::IN::TXT)
-        records.map(&:data)
+      dns_cache[domain] ||= begin
+        Resolv::DNS.open do |dns|
+          dns.getresources(domain, Resolv::DNS::Resource::IN::TXT).map(&:data)
+        end
+      rescue Resolv::ResolvError
+        []
       end
-    rescue Resolv::ResolvError
-      []
     end
-  end
-end
 
+    def smtp_verify_email(email)
+      domain = extract_domain(email)
+      smtp_server = smtp_cache[domain] ||= get_smtp_server(domain)
+
+      return false unless smtp_server
+
+      begin
+        Net::SMTP.start(smtp_server, 25, 'localhost') do |smtp|
+          smtp.helo('localhost')
+          smtp.mailfrom('test@example.com')
+          response = smtp.rcptto(email)
+          response == '250 OK'
+        end
+      rescue Net::SMTPFatalError, Net::SMTPServerBusy, Net::SMTPSyntaxError, Errno::ECONNREFUSED
+        false
+      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/
+    def get_smtp_server(domain)
+      mx_records = fetch_mx_records(domain)
+      mx_records.first
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailshield
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '1.2'
 platform: ruby
 authors:
 - jana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-25 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies: []
 description: MailShield helps secure your application by identifying temporary or
   disposable email domains.
@@ -19,6 +19,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/mailshield.rb
+- lib/mailshield/disposable_domains.rb
+- lib/mailshield/docs/mailshield.png
+- lib/mailshield/secure_email_validator.rb
 - lib/mailshield/version.rb
 homepage: https://github.com/janarthanan-shanmugam/mailshield
 licenses:
@@ -43,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.18
 signing_key: 
 specification_version: 4
 summary: A gem to detect temporary or disposable email domains.