File: README — Documentation for quantipay-ssl

SSL Requirement

SSL requirement adds a declarative way of specifying that certain actions should only be allowed to run under SSL, and if they’re accessed without it, they should be redirected.

Example:

class ApplicationController < ActionController::Base
  include SslRequirement
end

class AccountController < ApplicationController
  ssl_required :signup, :payment 
  ssl_allowed :index

  def signup
    # Non-SSL access will be redirected to SSL
  end

  def payment
    # Non-SSL access will be redirected to SSL
  end

  def index
    # This action will work either with or without SSL
  end

  def other
    # SSL access will be redirected to non-SSL
  end
end

If a majority (or all) of your actions require SSL, then use ssl_exceptions instead of ssl_required. You can list out the actions that you do NOT want to be SSL protected. Calling ssl_exceptions without any actions listed will make ALL actions SSL protected.

You can overwrite the protected method ssl_required? to rely on other things than just the declarative specification. Say, only premium accounts get SSL.

For SSL domains that differ from the domain of the redirecting site, add the following code to development.rb / test.rb / production.rb:

# Redirects to secure.example.com instead of the default # www.example.com. config.after_initialize do

SslRequirement.ssl_host = 'secure.example.com'

end

You are able to turn disable ssl redirects by adding the following environment configuration file:

SslRequirement.disable_ssl_check = true

P.S.: Beware when you include the SslRequirement module. At the time of inclusion, it’ll add the before_filter that validates the declarations. Some times you’ll want to run other before_filters before that. They should then be declared ahead of including this module.

SSL URL Helper

This plugin also adds a helper a :secure option to url_for and named_routes. This property allows you to set a url as secure or not secure. It uses the disable_ssl_check to determine if the option should be ignored or not so you can develop as normal.

Here is an example of creating a secure url:

<%= url_for(:controller => “c”, :action => “a”, :secure => true) %>

If disable_ssl_check returns false url_for will return the following:

yoursite.com/c/a

Furthermore, you can use the secure option in a named route to create a secure form as follows:

<% form_tag session_path(:secure => true), :class => ‘home_login’ do -%>

<p>
  <label for="name">Email</label>
  <%= text_field_tag 'email', '', :class => 'text', :tabindex => 1 %>
</p>
<p>
  <label for="password">Password</label>
  <%= password_field_tag 'password', '', :class => 'text', :tabindex => 2 %>
</p>
<p>
  <%= submit_tag "Login", :id => 'login_submit', :value => "", :alt => "Login" %>
</p>

<% end -%>