File: README — Documentation for merb-ssl-requirement (0.0.2)

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 Application < Merb::Controller
  include SslRequirement
end

class Accounts < 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

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

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.

Update Sat Feb 20, 2010: Added the ability to set a configuration parameter where you can specify which environments you want to exclude merb-ssl-requirement from enforcing ssl. This might be useful for testing and development environments where you don’t have ssl certs in place. If you don’t provide the configuration parameter or its value, merb-ssl-requirement still continues to function as expected.

Example:

If you want to work in the development environment and you don’t want ssl enforced then you can do the following in your-merb-app-base-dir/config/init.rb:

Merb::Config.use do |c|

c[:ssl_requirement_excluded_environments] = ["development"]

end

Other environments, will continue to enforce ssl without being effected.