No description, website, or topics provided.
Ruby
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.document
.gitignore
.rspec
.rvmrc
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
VERSION
subdomainbox.gemspec

README.md

subdomainbox

Subdomain boxing was inspired by Egor Homakov's post on pageboxing. Subdomain boxing limits the reach of any XSS attacks. If an attacker manages to insert javascript onto a page of your application, the javascript on that page will be unable to read data from or post data to any pages on different subdomains in your application. POST protection is achieved by creating a separate CSRF token for each subdomain. CSRF protection is also strengthened by changing the CSRF token based on session id (request.session_options[:id]).

Demo: http://app.subdomainbox.com

The subdomainbox gem is simple to add even to existing Rails applications:

class ApplicationController

  # set up a default subdomain box for all controllers that won't get an explicit subdomain box
  # this protects regular pages that don't get a dedicated subdomain box from being accessed
  # from a subdomain boxed page
  default_subdomainbox ''

  ...

end


class DocsController < ApplicationController

  subdomainbox 'posts', :except => [:edit, :update, :show]
  subdomainbox 'edit-%{id}', :only => [:edit, :update]
  subdomainbox 'preview-%{id}', :only => :show
  ...

end


class Admin::DocsController < ApplicationController

  subdomainbox 'admin', :only => :index
  subdomainbox 'admin-%{doc_id}', :except => :index

  ...

end


class AvatarIcon < ApplicationController

  # for controllers that need to be accessed from many places, that don't need boxing
  # protection, the default subdomain box can be removed (thereby allowing ajax calls
  # from any subdomain)
  remove_default_subdomainbox

  ...

end

There is no need to adjust your routes or your path / url helpers. Subdomainbox automatically redirects the browser as needed based on your subdomainbox directives.

Installation

  1. Add subdomainbox to your gemfile and bundle install

  2. Run the generator (for generating the CSRF token secret):

     $ rails generate subdomainbox
    
  3. Make sure the root domain of your application has a wildcard SSL certificate

  4. Set the domain of your session cookie to the root domain

     if Rails.env.development?
       cookie_domain = 'lvh.me'
     elsif Rails.env.production?
       cookie_domain = 'mydomain.com'
     end
     MyApp::Application.config.session_store :cookie_store, key: '_myapp_session', :domain => cookie_domain
    
  5. If you use Google Analytics, set up (cross subdomain tracking)[https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingSite#domainSubDomains]

Development

Use lvh.me:3000 instead of localhost:3000 since localhost doesn't support subdomains

Testing

In controller specs, we don't want to worry about subdomain-boxing, so stub it out:

controller.stub(:subdomainbox)

Request/feature/integration specs are vital when using subdomain boxing. Non-javascript Capybara + Rack should work out of the box, but Capybara + Selenium/Webkit javascript driver requires modification of the test machine in order for it to work with subdomains:

brew install dnsmasq
mkdir -pv $(brew --prefix)/etc/
echo 'address=/.dev/127.0.0.1' > $(brew --prefix)/etc/dnsmasq.conf
sudo cp -v $(brew --prefix dnsmasq)/homebrew.mxcl.dnsmasq.plist /Library/LaunchDaemons
sudo launchctl load -w /Library/LaunchDaemons/homebrew.mxcl.dnsmasq.plist
sudo mkdir -v /etc/resolver
sudo bash -c 'echo "nameserver 127.0.0.1" > /etc/resolver/dev'

-- source http://www.echoditto.com/blog/never-touch-your-local-etchosts-file-os-x-again

Contributing to subdomainbox

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Credits

Written by Daniel Nelson. Inspired by Egor Homakov's post on pageboxing.