active_storage_svg_sanitizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2fe3665fa7b4bdfe831a8c1e84167eacfc92edf82d3a0f70e4b26ab776880a4d
+  data.tar.gz: 8b38e96d5c423146d69a3c37fe607577019292c1bebf5d0730ae44771f17e68c
+SHA512:
+  metadata.gz: 17bb4d3d8f96a4ba91fdcd52dbd8026eb62a819311d2062a13c4f8ee397877eb50aa1005bcf750b856b48bc20deccfacdf99c79dcb27a8b13518481b613ade83
+  data.tar.gz: 2bde5ecab52134656464b75d6b0f274725c8e49e7406298d6fbb761e87680bf3177c239b0d177a866848773a403f7d1b6dce1019c5c0240b82d925a17c877cfc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Nathan Hopkins
+
+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,26 @@
+# ActiveStorageSvgSanitizer
+
+A small library that sanitizes ActiveStorage SVG uploads by stripping any embedded `script` tags.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_storage_svg_sanitizer'
+```
+
+## Usage
+
+This libary uses ActiveJob to perform sanization tasks in the background.
+
+Simply including this gem will ensure your svg uploads are sanitized.
+
+If you'd like to render uploaded svg images in your application, add an initializer that unregisters `svg` as a binary file type.
+
+```ruby
+ActiveStorage::Engine.config.active_storage.content_types_to_serve_as_binary.delete "image/svg+xml"
+```
+
+## 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,34 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "ActiveStorageSvgSanitizer"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/active_storage_svg_sanitizer_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/active_storage_svg_sanitizer .css

data/app/assets/stylesheets/active_storage_svg_sanitizer/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/active_storage_svg_sanitizer/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveStorageSvgSanitizer
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/active_storage_svg_sanitizer/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ActiveStorageSvgSanitizer
+  module ApplicationHelper
+  end
+end

data/app/jobs/active_storage_svg_sanitizer/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ActiveStorageSvgSanitizer
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/active_storage_svg_sanitizer/sanitize_svg_job.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ActiveStorageSvgSanitizer
+  class SanitizeSvgJob < ApplicationJob
+    def perform(blob)
+      return unless blob.svg?
+      return if blob.metadata[:sanitized]
+
+      sanitized = sanitize(blob.download)
+      Tempfile.open([blob.filename.base, blob.filename.extension]) do |file|
+        file.print sanitized
+        file.rewind
+        blob.upload file
+      end
+
+      blob.metadata[:sanitized] = true
+      blob.save
+    end
+
+    private
+
+    def sanitize(unsafe_xml)
+      unsafe_xml = unsafe_xml.to_s
+      unsafe_xml.force_encoding "UTF-8"
+      return Loofah.xml_document(unsafe_xml).scrub!(scrubber).to_s if document?(unsafe_xml)
+      Loofah.xml_fragment(unsafe_xml).scrub!(scrubber).to_s
+    end
+
+    def scrubber
+      Loofah::Scrubber.new do |node|
+        node.remove if node.name == "script"
+      end
+    end
+
+    def document?(unsafe)
+      unsafe.include?("<?xml") || unsafe.include?("<!DOCTYPE")
+    end
+  end
+end

data/app/mailers/active_storage_svg_sanitizer/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActiveStorageSvgSanitizer
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/active_storage_svg_sanitizer/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveStorageSvgSanitizer
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/active_storage_svg_sanitizer/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Active storage svg sanitizer</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "active_storage_svg_sanitizer/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/active_storage_svg_sanitizer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "active_storage_svg_sanitizer/svg_sanitizer"
+
+# ActiveStorage::Engine.config.active_storage.content_types_to_serve_as_binary.delete "image/svg+xml"
+
+Rails.application.config.to_prepare do
+  ActiveStorage::Blob.send :include, ActiveStorageSvgSanitizer::SvgSanitizer
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+ActiveStorageSvgSanitizer::Engine.routes.draw do
+end

data/lib/active_storage_svg_sanitizer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "active_storage_svg_sanitizer/engine"
+
+module ActiveStorageSvgSanitizer
+  # Your code goes here...
+end

data/lib/active_storage_svg_sanitizer/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveStorageSvgSanitizer
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveStorageSvgSanitizer
+  end
+end

data/lib/active_storage_svg_sanitizer/svg_sanitizer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActiveStorageSvgSanitizer
+  module SvgSanitizer
+    extend ActiveSupport::Concern
+
+    included do
+      after_create_commit :sanitize_svg, if: :svg?
+    end
+
+    def svg?
+      filename.extension == "svg"
+    end
+
+    def sanitize_svg
+      ActiveStorageSvgSanitizer::SanitizeSvgJob.set(wait: 10.seconds).perform_later self
+    end
+  end
+end

data/lib/active_storage_svg_sanitizer/version.rb

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

data/lib/tasks/active_storage_svg_sanitizer_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :active_storage_svg_sanitizer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: active_storage_svg_sanitizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Hopkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sanitize SVG images after ActiveStorage upload
+email:
+- natehop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/active_storage_svg_sanitizer_manifest.js
+- app/assets/stylesheets/active_storage_svg_sanitizer/application.css
+- app/controllers/active_storage_svg_sanitizer/application_controller.rb
+- app/helpers/active_storage_svg_sanitizer/application_helper.rb
+- app/jobs/active_storage_svg_sanitizer/application_job.rb
+- app/jobs/active_storage_svg_sanitizer/sanitize_svg_job.rb
+- app/mailers/active_storage_svg_sanitizer/application_mailer.rb
+- app/models/active_storage_svg_sanitizer/application_record.rb
+- app/views/layouts/active_storage_svg_sanitizer/application.html.erb
+- config/initializers/active_storage_svg_sanitizer.rb
+- config/routes.rb
+- lib/active_storage_svg_sanitizer.rb
+- lib/active_storage_svg_sanitizer/engine.rb
+- lib/active_storage_svg_sanitizer/svg_sanitizer.rb
+- lib/active_storage_svg_sanitizer/version.rb
+- lib/tasks/active_storage_svg_sanitizer_tasks.rake
+homepage: https://github.com/hopsoft/active_storage_svg_sanitizer
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Sanitize SVG images after ActiveStorage upload
+test_files: []