DisinfectUrl
This gem was heavily influenced by Braintree's sanitize-url
Installation
gem 'disinfect_url'
Usage
Requirements
This gem requires Ruby 2.4+
Basic Usage
Convert bad urls to "about:blank"
DisinfectUrl.sanitize("https://example.com")
# => https://example.com
DisinfectUrl.sanitize("http://example.com")
# => http://example.com
DisinfectUrl.sanitize("www.example.com")
# => www.example.com
DisinfectUrl.sanitize("mailto:hello@example.com")
# => mailto:hello@example.com
DisinfectUrl.sanitize("https://example.com")
# => https://example.com
DisinfectUrl.sanitize("javascript:alert(document.domain)")
DisinfectUrl.sanitize("jAvasCrIPT:alert(document.domain)")
DisinfectUrl.sanitize("JaVaScRiP%0at:alert(document.domain)")
# => about:blank
#HTML encoded javascript:alert('XSS')
DisinfectUrl.sanitize("javascript:alert('XSS')")
# => about:blank
# Works the same way for href attribute within <a> tags
DisinfectUrl.sanitize(%q(<a href="javascript:alert('attack')">Example</a>))
# => <a href="about:blank">Example</a>
ActiveRecord Callbacks
before_validation :disinfect_website_url
before_validation :disinfect_biography
private
def disinfect_website_url
self.website_url = DisinfectUrl.sanitize(self.website_url)
end
def disinfect_biography
self.biography = DisinfectUrl.sanitize(self.biography)
end
Validation Note
This gem doesn't perform any validation for differentiating HTML vs URL. You may need to perform additional validation.
def disinfect_website_url
self.website_url = DisinfectUrl.sanitize(%q(<a href="https://example.com">Example</a>))
end
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 the created tag, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/stevenjcumming/disinfect_url. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the DisinfectUrl project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.