Skip to content
/ csv-safe Public

Decorate the ruby CSV library to sanitize output CSV against CSV injection attacks.

License

Notifications You must be signed in to change notification settings

zvory/csv-safe

Repository files navigation

csv-safe

Gem Version

Also hosted on RubyGems.org.

This gem decorates the built in CSV library to prevent CSV injection attacks. Wherever you would use CSV in your code, use CSVSafe. The gem will encode your fields in UTF-8.

What this gem does specifically:

  • Override CSV#<< to sanitize incoming rows.
  • Override CSV#initialize to add a converter that will sanitize fields being read.

A description of CSV injection attacks on OWASP

Made while working at Influitive. We kept writing similar code to sanitize CSV output, and I couldn't find a gem to do this for us, so I wrote this.

Installation

Add this line to your application's Gemfile:

gem 'csv-safe'

And then execute:

$ bundle

Or install it yourself as:

$ gem install csv-safe

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 csv-safe.gemspec, 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.

License

The gem is available as open source under the terms of the MIT License.