safe_anchor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abbd0519adeac00ed37f941f780aa8fab35027c3877bdbfe052f367c4497f18e
+  data.tar.gz: cfe6b68db3a6ae0a9588c74343baa75af2896523858551e913d89b9cc2f9ab4e
+SHA512:
+  metadata.gz: 2118060daf8f1b1b6686f878130163ca87e046c6e28ff41c78b2aa2cbf26423520f14a24f9bad7a8c83850a58f9588c8f46a3e47e9370d990ad525bf61d91c64
+  data.tar.gz: 54c197d5c7a07282963bd04b947617b462d31f46d3bb16170790ae5bc880b10722f61c1512f6afab778b85660da173bedc21a031152c15bd6c4ba662a94dcfc0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.1.2

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in safe_anchor.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 woodydark
+
+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,45 @@
+# SafeAnchor
+
+SafeAnchor wraps around Rails's default link_to helper and sanitize method to output always output a sanitized anchor tag.
+
+This follows a secure-by-default principle and can be turned off by passing an optional argument `keep_dirty: true` when using the `link_to` helper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safe_anchor'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install safe_anchor
+
+## Usage
+
+SafeAnchor is secure-by-default.
+```
+<%= link_to "Dangerous Anchor", "javascript: alert('Boo!')" %>
+# <a>Dangerous Anchor</a>
+```
+
+Turning off sanitization.
+```
+<%= link_to "Dangerous Anchor", "javascript: alert('Boo!')", keep_dirty: true %>
+# <a keep_dirty="true" href="javascript: alert('Boo!')">Dangerous Anchor</a>
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/woodydark/safe_anchor.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "safe_anchor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/safe_anchor.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'safe_anchor/version'
+require 'safe_anchor/url_helper'
+
+module SafeAnchor
+end

data/lib/safe_anchor/url_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module UrlHelper
+  include ActionView::Helpers::UrlHelper
+  alias rails_default_link_to link_to
+
+  def link_to(*args, **kwargs)
+    anchor_tag = rails_default_link_to(*args, **kwargs)
+    return anchor_tag if kwargs[:keep_dirty]
+
+    sanitize anchor_tag
+  end
+end

data/lib/safe_anchor/version.rb

@@ -0,0 +1,3 @@
+module SafeAnchor
+  VERSION = "0.1.0"
+end

data/safe_anchor.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'lib/safe_anchor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'safe_anchor'
+  spec.version       = SafeAnchor::VERSION
+  spec.authors       = ['Jeffrey Soong']
+  spec.email         = ['darkwoodpresents@gmail.com']
+
+  spec.summary       = 'SafeAnchor ensures all link_to helper in Rails are sanitized by default'
+  spec.description   = 'SafeAnchor follows a secure-by-default principle and sanitizes all link_to helper output by default. This gem wraps around the default link_to and sanitize method provided by Rails.'
+  spec.homepage      = 'https://github.com/WoodyDark/SafeAnchor'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: safe_anchor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeffrey Soong
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-18 00:00:00.000000000 Z
+dependencies: []
+description: SafeAnchor follows a secure-by-default principle and sanitizes all link_to
+  helper output by default. This gem wraps around the default link_to and sanitize
+  method provided by Rails.
+email:
+- darkwoodpresents@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/safe_anchor.rb
+- lib/safe_anchor/url_helper.rb
+- lib/safe_anchor/version.rb
+- safe_anchor.gemspec
+homepage: https://github.com/WoodyDark/SafeAnchor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: SafeAnchor ensures all link_to helper in Rails are sanitized by default
+test_files: []