mail_auto_link_obfuscation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5f3bee94220bd89058f7d7d87d4f788a08d5e6d
+  data.tar.gz: 5752d9c9d1ac194e1f444fd5aeac4fd773b474dc
+SHA512:
+  metadata.gz: 3a6bb4b166403f21145a2b55d8490d45be38fa5f686efc73cb92a542aab56700c4299d9ee4d1d8e4daf64b6f5806d574cff85089490cc9eb615c343c6bfc1c06
+  data.tar.gz: d7aeb2e4d48caf00b4072c58c94edd72f32ed275d9cd84aeb74a7811bf332692100944365da4e26dba68e8d6aa4806e5b6c184d4626c7c37854a44be6ff3eb24

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,8 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 125

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mail_auto_link_obfuscation.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Oliver Jundt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# MailAutoLinkObfuscation
+
+This gem hooks up your Rails application and prevents email clients from automatically converting link-like text (e.g. `example.com`, `info@example.com`, `ftp://123.234.234.234`) to hyperlinks in your emails.
+
+Automatic links can be an undesired feature, especially when user generated content is part of your emails, e.g. a user's name. If your user is called `your.enemy.com` and you insert his name directly in your mail, you will find that most email clients will make this name clickable. This effect can brake your email layout/design and even worse, it can be considered a security issue.
+
+To prevent email clients from auto-linking any link-like text we have to outsmart their link parsers. Inserting `span` tags in HTML parts and spaces in text parts has shown to work for most email clients. For HTML parts this obfuscation should be invisible. For text parts, it's unfortunately not.
+
+HTML example: `Hello your.enemy.com!` becomes `Hello your<span>.</span>enemy<span>.</span>com`
+Plain text example: `Hello your.enemy.com!` becomes `Hello your .enemy .com`
+
+Note that this module will not touch any explicit links mentioned in anchors in the `href` attribute. Those links are considered desired and trusted. If you provide HTML and text parts with your email (which you should) this gem is also smart enough not to change links in the text part if those have been explicitly hyperlinked in the HTML part.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mail_auto_link_obfuscation'
+```
+
+## Usage
+Simply include `MailAutoLinkObfuscation::Automatic` in the mailers where you want obfuscate links.
+
+```ruby
+class MyMailer
+  include MailAutoLinkObfuscation::Automatic
+end
+```
+
+## Configuration
+The obfuscation process can be configured at two places:
+
+1. `Rails.application.config.mail_auto_link_obfuscation`
+2. `MyMailer#mail_auto_link_obfuscation_options`
+
+Options are passed as a hash. At this moment you can only add a `style` attribute to the inserted `span` tags using `{ span_style: "font:inherit" }`
+
+## Development
+
+Specs can be run with `rake spec`. Guard is also available.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/moneybird/mail_auto_link_obfuscation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/mail_auto_link_obfuscation.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require 'mail_auto_link_obfuscation/version'
+require 'mail_auto_link_obfuscation/automatic'
+require 'mail_auto_link_obfuscation/obfuscate_auto_links_on_delivery'
+require 'mail_auto_link_obfuscation/auto_link_obfuscator'
+require 'mail_auto_link_obfuscation/railtie'

data/lib/mail_auto_link_obfuscation/auto_link_obfuscator.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+require 'nokogiri'
+
+module MailAutoLinkObfuscation
+  class AutoLinkObfuscator
+    AUTO_LINKED_EMAIL_PATTERN = /\S+@\w+(?:\.\w+)+/
+    AUTO_LINKED_URL_PATTERN = %r{(\w+://\w+(\.\w+)*|\w+(\.\w+)*\.\w{2,})\S*}
+    AUTO_LINKED_PATTERN = Regexp.new([AUTO_LINKED_EMAIL_PATTERN, AUTO_LINKED_URL_PATTERN].join('|'))
+    KEY_CHARS = /[@.:]/
+
+    def initialize(mail, options)
+      @mail = mail
+      @options = options || {}
+    end
+
+    def run
+      extract_link_whitelist_from_html
+      transform_html_body if @mail.content_type == 'text/html'
+      transform_text_body if @mail.content_type == 'text/plain'
+      transform_html_part if @mail.html_part
+      transform_text_part if @mail.text_part
+      @mail
+    end
+
+    def extract_link_whitelist_from_html
+      @link_whitelist =
+        extract_link_whitelist_from(html_body_doc) +
+        extract_link_whitelist_from(html_part_doc)
+    end
+
+    def extract_link_whitelist_from(doc)
+      return Set.new unless doc
+      doc.xpath('//@href').map(&:content).to_set
+    end
+
+    def html_body_doc
+      return unless @mail.content_type == 'text/html'
+      @html_body_doc ||= Nokogiri::HTML(@mail.body.decoded)
+    end
+
+    def html_part_doc
+      return unless @mail.html_part
+      @html_part_doc ||= Nokogiri::HTML(@mail.html_part.body.decoded)
+    end
+
+    def transform_html_body
+      @mail.body = transform_html(html_body_doc)
+    end
+
+    def transform_html_part
+      @mail.html_part.body = transform_html(html_part_doc)
+    end
+
+    def transform_html(doc)
+      doc.xpath('//body/descendant::text()').each do |node|
+        content = transform_auto_linked_pattern(node.content) do |match|
+          match.gsub(KEY_CHARS, span_template)
+        end
+
+        node.replace(content)
+      end
+
+      doc.to_s
+    end
+
+    def span_template
+      @span_template ||= '<span' + (@options[:span_style] ? " style=#{@options[:span_style]}" : '') + '>\0</span>'
+    end
+
+    def transform_text_body
+      @mail.body = transform_text(@mail.body.decoded)
+    end
+
+    def transform_text_part
+      @mail.text_part.body = transform_text(@mail.text_part.body.decoded)
+    end
+
+    def transform_text(text)
+      transform_auto_linked_pattern(text) do |match|
+        match.gsub(KEY_CHARS, ' \0')
+      end
+    end
+
+    def transform_auto_linked_pattern(text)
+      text.gsub(AUTO_LINKED_PATTERN) do |match|
+        @link_whitelist.include?(match) ? match : yield(match)
+      end
+    end
+  end
+end

data/lib/mail_auto_link_obfuscation/automatic.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module MailAutoLinkObfuscation
+  module Automatic
+    def mail(*args, &block)
+      super.tap do |email|
+        email.extend ObfuscateAutoLinksOnDelivery
+        email.mail_auto_link_obfuscation_options = mail_auto_link_obfuscation_options.try(:dup)
+      end
+    end
+
+    def mail_auto_link_obfuscation_options
+      ::Rails.application.config.mail_auto_link_obfuscation
+    end
+  end
+end

data/lib/mail_auto_link_obfuscation/obfuscate_auto_links_on_delivery.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module MailAutoLinkObfuscation
+  module ObfuscateAutoLinksOnDelivery
+    attr_accessor :mail_auto_link_obfuscation_options
+
+    def deliver
+      obfuscate_links
+      super
+    end
+
+    def deliver!
+      obfuscate_links
+      super
+    end
+
+    private
+
+    def obfuscate_links
+      AutoLinkObfuscator.new(self, mail_auto_link_obfuscation_options).run
+    end
+  end
+end

data/lib/mail_auto_link_obfuscation/railtie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'rails'
+
+module MailAutoLinkObfuscation
+  class Railtie < ::Rails::Railtie
+    config.mail_auto_link_obfuscation = {}
+  end
+end

data/lib/mail_auto_link_obfuscation/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module MailAutoLinkObfuscation
+  VERSION = '0.1.0'
+end

data/mail_auto_link_obfuscation.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mail_auto_link_obfuscation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mail_auto_link_obfuscation'
+  spec.version       = MailAutoLinkObfuscation::VERSION
+  spec.authors       = ['Oliver Jundt']
+  spec.email         = ['info@moneybird.com']
+
+  spec.summary       = 'Obfuscate link-like mail content on delivery to prevent auto hyperlinks in modern email clients.'
+  spec.description   = 'Obfuscate link-like mail content on delivery to prevent auto hyperlinks in modern email clients.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'railties', '>= 3.0', '< 5.1'
+  spec.add_dependency 'mail', '~> 2.5'
+  spec.add_dependency 'nokogiri', '~> 1.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rails', '>= 3.0', '< 5.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.42'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.7'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: mail_auto_link_obfuscation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oliver Jundt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+description: Obfuscate link-like mail content on delivery to prevent auto hyperlinks
+  in modern email clients.
+email:
+- info@moneybird.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mail_auto_link_obfuscation.rb
+- lib/mail_auto_link_obfuscation/auto_link_obfuscator.rb
+- lib/mail_auto_link_obfuscation/automatic.rb
+- lib/mail_auto_link_obfuscation/obfuscate_auto_links_on_delivery.rb
+- lib/mail_auto_link_obfuscation/railtie.rb
+- lib/mail_auto_link_obfuscation/version.rb
+- mail_auto_link_obfuscation.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Obfuscate link-like mail content on delivery to prevent auto hyperlinks in
+  modern email clients.
+test_files: []