ggoodale-restful-authentication 1.1.1

data/generators/authenticated/templates/model_controller.rb

@@ -0,0 +1,85 @@
+class <%= model_controller_class_name %>Controller < ApplicationController
+  # Be sure to include AuthenticationSystem in Application Controller instead
+  include AuthenticatedSystem
+  <% if options[:stateful] %>
+  # Protect these actions behind an admin login
+  # before_filter :admin_required, :only => [:suspend, :unsuspend, :destroy, :purge]
+  before_filter :find_<%= file_name %>, :only => [:suspend, :unsuspend, :destroy, :purge]
+  <% end %>
+
+  # render new.rhtml
+  def new
+    @<%= file_name %> = <%= class_name %>.new
+  end
+ 
+  def create
+    logout_keeping_session!
+    @<%= file_name %> = <%= class_name %>.new(params[:<%= file_name %>])
+<% if options[:stateful] -%>
+    @<%= file_name %>.register! if @<%= file_name %> && @<%= file_name %>.valid?
+    success = @<%= file_name %> && @<%= file_name %>.valid?
+<% else -%>
+    success = @<%= file_name %> && @<%= file_name %>.save
+<% end -%>
+    if success && @<%= file_name %>.errors.empty?
+      <% if !options[:include_activation] -%>
+      # Protects against session fixation attacks, causes request forgery
+      # protection if visitor resubmits an earlier form using back
+      # button. Uncomment if you understand the tradeoffs.
+      # reset session
+      self.current_<%= file_name %> = @<%= file_name %> # !! now logged in
+      <% end -%>redirect_back_or_default('/')
+      flash[:notice] = "Thanks for signing up!  We're sending you an email with your activation code."
+    else
+      flash[:error]  = "We couldn't set up that account, sorry.  Please try again, or contact an admin (link is above)."
+      render :action => 'new'
+    end
+  end
+<% if options[:include_activation] %>
+  def activate
+    logout_keeping_session!
+    <%= file_name %> = <%= class_name %>.find_by_activation_code(params[:activation_code]) unless params[:activation_code].blank?
+    case
+    when (!params[:activation_code].blank?) && <%= file_name %> && !<%= file_name %>.active?
+      <%= file_name %>.activate!
+      flash[:notice] = "Signup complete! Please sign in to continue."
+      redirect_to '/login'
+    when params[:activation_code].blank?
+      flash[:error] = "The activation code was missing.  Please follow the URL from your email."
+      redirect_back_or_default('/')
+    else 
+      flash[:error]  = "We couldn't find a <%= file_name %> with that activation code -- check your email? Or maybe you've already activated -- try signing in."
+      redirect_back_or_default('/')
+    end
+  end
+<% end %><% if options[:stateful] %>
+  def suspend
+    @<%= file_name %>.suspend! 
+    redirect_to <%= model_controller_routing_name %>_path
+  end
+
+  def unsuspend
+    @<%= file_name %>.unsuspend! 
+    redirect_to <%= model_controller_routing_name %>_path
+  end
+
+  def destroy
+    @<%= file_name %>.delete!
+    redirect_to <%= model_controller_routing_name %>_path
+  end
+
+  def purge
+    @<%= file_name %>.destroy
+    redirect_to <%= model_controller_routing_name %>_path
+  end
+  
+  # There's no page here to update or destroy a <%= file_name %>.  If you add those, be
+  # smart -- make sure you check that the visitor is authorized to do so, that they
+  # supply their old password along with a new one to update it, etc.
+
+protected
+  def find_<%= file_name %>
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+  end
+<% end -%>
+end

data/generators/authenticated/templates/model_helper.rb

@@ -0,0 +1,93 @@
+module <%= model_controller_class_name %>Helper
+  
+  #
+  # Use this to wrap view elements that the user can't access.
+  # !! Note: this is an *interface*, not *security* feature !!
+  # You need to do all access control at the controller level.
+  #
+  # Example:
+  # <%%= if_authorized?(:index,   User)  do link_to('List all users', users_path) end %> |
+  # <%%= if_authorized?(:edit,    @user) do link_to('Edit this user', edit_user_path) end %> |
+  # <%%= if_authorized?(:destroy, @user) do link_to 'Destroy', @user, :confirm => 'Are you sure?', :method => :delete end %> 
+  #
+  #
+  def if_authorized?(action, resource, &block)
+    if authorized?(action, resource)
+      yield action, resource
+    end
+  end
+
+  #
+  # Link to user's page ('<%= table_name %>/1')
+  #
+  # By default, their login is used as link text and link title (tooltip)
+  #
+  # Takes options
+  # * :content_text => 'Content text in place of <%= file_name %>.login', escaped with
+  #   the standard h() function.
+  # * :content_method => :<%= file_name %>_instance_method_to_call_for_content_text
+  # * :title_method => :<%= file_name %>_instance_method_to_call_for_title_attribute
+  # * as well as link_to()'s standard options
+  #
+  # Examples:
+  #   link_to_<%= file_name %> @<%= file_name %>
+  #   # => <a href="/<%= table_name %>/3" title="barmy">barmy</a>
+  #
+  #   # if you've added a .name attribute:
+  #  content_tag :span, :class => :vcard do
+  #    (link_to_<%= file_name %> <%= file_name %>, :class => 'fn n', :title_method => :login, :content_method => :name) +
+  #          ': ' + (content_tag :span, <%= file_name %>.email, :class => 'email')
+  #   end
+  #   # => <span class="vcard"><a href="/<%= table_name %>/3" title="barmy" class="fn n">Cyril Fotheringay-Phipps</a>: <span class="email">barmy@blandings.com</span></span>
+  #
+  #   link_to_<%= file_name %> @<%= file_name %>, :content_text => 'Your user page'
+  #   # => <a href="/<%= table_name %>/3" title="barmy" class="nickname">Your user page</a>
+  #
+  def link_to_<%= file_name %>(<%= file_name %>, options={})
+    raise "Invalid <%= file_name %>" unless <%= file_name %>
+    options.reverse_merge! :content_method => :login, :title_method => :login, :class => :nickname
+    content_text      = options.delete(:content_text)
+    content_text    ||= <%= file_name %>.send(options.delete(:content_method))
+    options[:title] ||= <%= file_name %>.send(options.delete(:title_method))
+    link_to h(content_text), <%= model_controller_routing_name.singularize %>_path(<%= file_name %>), options
+  end
+
+  #
+  # Link to login page using remote ip address as link content
+  #
+  # The :title (and thus, tooltip) is set to the IP address 
+  #
+  # Examples:
+  #   link_to_login_with_IP
+  #   # => <a href="/login" title="169.69.69.69">169.69.69.69</a>
+  #
+  #   link_to_login_with_IP :content_text => 'not signed in'
+  #   # => <a href="/login" title="169.69.69.69">not signed in</a>
+  #
+  def link_to_login_with_IP content_text=nil, options={}
+    ip_addr           = request.remote_ip
+    content_text    ||= ip_addr
+    options.reverse_merge! :title => ip_addr
+    if tag = options.delete(:tag)
+      content_tag tag, h(content_text), options
+    else
+      link_to h(content_text), login_path, options
+    end
+  end
+
+  #
+  # Link to the current user's page (using link_to_<%= file_name %>) or to the login page
+  # (using link_to_login_with_IP).
+  #
+  def link_to_current_<%= file_name %>(options={})
+    if current_<%= file_name %>
+      link_to_<%= file_name %> current_<%= file_name %>, options
+    else
+      content_text = options.delete(:content_text) || 'not signed in'
+      # kill ignored options from link_to_<%= file_name %>
+      [:content_method, :title_method].each{|opt| options.delete(opt)} 
+      link_to_login_with_IP content_text, options
+    end
+  end
+
+end

data/generators/authenticated/templates/model_helper_spec.rb

@@ -0,0 +1,158 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+include ApplicationHelper
+include <%= model_controller_class_name %>Helper
+
+describe "<%= model_controller_class_name %>Helper.link_to_<%= file_name %>" do
+  before do
+    @<%= file_name %> = <%= class_name %>.new({
+        :name  => '<%= class_name %> Name',
+        :login => '<%= file_name %>_name',
+      })
+    @<%= file_name %>.id = 1 # set non-attr_accessible specifically
+  end
+
+  it "should give an error on a nil <%= file_name %>" do
+    lambda { link_to_<%= file_name %>(nil) }.should raise_error('Invalid <%= file_name %>')
+  end
+
+  it "should link to the given <%= file_name %>" do
+    link_to_<%= file_name %>(@<%= file_name %>).should have_tag("a[href='/<%= table_name %>/1']")
+  end
+
+  it "should use given link text if :content_text is specified" do
+    link_to_<%= file_name %>(@<%= file_name %>, :content_text => 'Hello there!').should have_tag("a", 'Hello there!')
+  end
+
+  it "should use the login as link text with no :content_method specified" do
+    link_to_<%= file_name %>(@<%= file_name %>).should have_tag("a", '<%= file_name %>_name')
+  end
+
+  it "should use the name as link text with :content_method => :name" do
+    link_to_<%= file_name %>(@<%= file_name %>, :content_method => :name).should have_tag("a", '<%= class_name %> Name')
+  end
+
+  it "should use the login as title with no :title_method specified" do
+    link_to_<%= file_name %>(@<%= file_name %>).should have_tag("a[title='<%= file_name %>_name']")
+  end
+
+  it "should use the name as link title with :content_method => :name" do
+    link_to_<%= file_name %>(@<%= file_name %>, :title_method => :name).should have_tag("a[title='<%= class_name %> Name']")
+  end
+
+  it "should have nickname as a class by default" do
+    link_to_<%= file_name %>(@<%= file_name %>).should have_tag("a.nickname")
+  end
+
+  it "should take other classes and no longer have the nickname class" do
+    result = link_to_<%= file_name %>(@<%= file_name %>, :class => 'foo bar')
+    result.should have_tag("a.foo")
+    result.should have_tag("a.bar")
+  end
+end
+
+describe "<%= model_controller_class_name %>Helper.link_to_signin_with_IP" do
+  before do
+  end
+
+  it "should link to the signin_path" do
+    link_to_signin_with_IP().should have_tag("a[href='/signin']")
+  end
+
+  it "should use given link text if :content_text is specified" do
+    link_to_signin_with_IP(:content_text => 'Hello there!').should have_tag("a", 'Hello there!')
+  end
+
+  it "should use the login as link text with no :content_method specified" do
+    link_to_signin_with_IP().should have_tag("a", '0.0.0.0')
+  end
+
+  it "should use the ip address as title" do
+    link_to_signin_with_IP().should have_tag("a[title='0.0.0.0']")
+  end
+
+  it "should by default be like school in summer and have no class" do
+    link_to_signin_with_IP().should_not have_tag("a.nickname")
+  end
+  
+  it "should have some class if you tell it to" do
+    result = link_to_signin_with_IP(:class => 'foo bar')
+    result.should have_tag("a.foo")
+    result.should have_tag("a.bar")
+  end
+end
+
+describe "<%= model_controller_class_name %>Helper.link_to_current_<%= file_name %>, When logged in" do
+  fixtures :<%= table_name %>
+  include AuthenticatedTestHelper
+  before do
+    login_as(:quentin)
+  end
+
+  it "should link to the given <%= file_name %>" do
+    link_to_current_<%= file_name %>().should have_tag("a[href='/<%= table_name %>/1']")
+  end
+
+  it "should use given link text if :content_text is specified" do
+    link_to_current_user(:content_text => 'Hello there!').should have_tag("a", 'Hello there!')
+  end
+
+  it "should use the login as link text with no :content_method specified" do
+    link_to_current_user().should have_tag("a", 'quentin')
+  end
+
+  it "should use the name as link text with :content_method => :name" do
+    link_to_current_user(:content_method => :name).should have_tag("a", 'Quentin')
+  end
+
+  it "should use the login as title with no :title_method specified" do
+    link_to_current_user().should have_tag("a[title='quentin']")
+  end
+
+  it "should use the name as link title with :content_method => :name" do
+    link_to_current_user(:title_method => :name).should have_tag("a[title='Quentin']")
+  end
+
+  it "should have nickname as a class" do
+    link_to_current_user().should have_tag("a.nickname")
+  end
+
+  it "should take other classes and no longer have the nickname class" do
+    result = link_to_current_user(:class => 'foo bar')
+    result.should have_tag("a.foo")
+    result.should have_tag("a.bar")
+  end
+end
+
+
+
+describe "<%= model_controller_class_name %>Helper.link_to_current_user, When logged out" do
+  include AuthenticatedTestHelper
+  before do
+  end
+
+  it "should link to the signin_path" do
+    link_to_current_user().should have_tag("a[href='/signin']")
+  end
+
+  it "should use given link text if :content_text is specified" do
+    link_to_current_user(:content_text => 'Hello there!').should have_tag("a", 'Hello there!')
+  end
+
+  it "should use the IP address as link text with no :content_method specified" do
+    link_to_current_user().should have_tag("a", '0.0.0.0')
+  end
+
+  it "should use the ip address as title" do
+    link_to_current_user().should have_tag("a[title='0.0.0.0']")
+  end
+
+  it "should by default be like school in summer and have no class" do
+    link_to_current_user().should_not have_tag("a.nickname")
+  end
+
+  it "should have some class if you tell it to" do
+    result = link_to_current_user(:class => 'foo bar')
+    result.should have_tag("a.foo")
+    result.should have_tag("a.bar")
+  end
+end

data/generators/authenticated/templates/observer.rb

@@ -0,0 +1,11 @@
+class <%= class_name %>Observer < ActiveRecord::Observer
+  def after_create(<%= file_name %>)
+    <%= class_name %>Mailer.deliver_signup_notification(<%= file_name %>)
+  end
+
+  def after_save(<%= file_name %>)
+  <% if options[:include_activation] %>
+    <%= class_name %>Mailer.deliver_activation(<%= file_name %>) if <%= file_name %>.recently_activated?
+  <% end %>
+  end
+end

data/generators/authenticated/templates/signup.html.erb

@@ -0,0 +1,19 @@
+<h1>Sign up as a new user</h1>
+<%% @<%= file_name %>.password = @<%= file_name %>.password_confirmation = nil %>
+
+<%%= error_messages_for :<%= file_name %> %>
+<%% form_for :<%= file_name %>, :url => <%= model_controller_routing_name %>_path do |f| -%>
+<p><%%= label_tag 'login' %><br/>
+<%%= f.text_field :login %></p>
+
+<p><%%= label_tag 'email' %><br/>
+<%%= f.text_field :email %></p>
+
+<p><%%= label_tag 'password' %><br/>
+<%%= f.password_field :password %></p>
+
+<p><%%= label_tag 'password_confirmation', 'Confirm Password' %><br/>
+<%%= f.password_field :password_confirmation %></p>
+
+<p><%%= submit_tag 'Sign up' %></p>
+<%% end -%>

data/generators/authenticated/templates/signup_notification.erb

@@ -0,0 +1,8 @@
+Your account has been created.
+
+  Username: <%%=h @<%= file_name %>.login %>
+  Password: <%%=h @<%= file_name %>.password %>
+
+Visit this url to activate your account:
+
+  <%%=h @url %>

data/generators/authenticated/templates/site_keys.rb

@@ -0,0 +1,38 @@
+
+# A Site key gives additional protection against a dictionary attack if your
+# DB is ever compromised.  With no site key, we store
+#   DB_password = hash(user_password, DB_user_salt)
+# If your database were to be compromised you'd be vulnerable to a dictionary
+# attack on all your stupid users' passwords.  With a site key, we store
+#   DB_password = hash(user_password, DB_user_salt, Code_site_key)
+# That means an attacker needs access to both your site's code *and* its
+# database to mount an "offline dictionary attack.":http://www.dwheeler.com/secure-programs/Secure-Programs-HOWTO/web-authentication.html
+# 
+# It's probably of minor importance, but recommended by best practices: 'defense
+# in depth'.  Needless to say, if you upload this to github or the youtubes or
+# otherwise place it in public view you'll kinda defeat the point.  Your users'
+# passwords are still secure, and the world won't end, but defense_in_depth -= 1.
+# 
+# Please note: if you change this, all the passwords will be invalidated, so DO
+# keep it someplace secure.  Use the random value given or type in the lyrics to
+# your favorite Jay-Z song or something; any moderately long, unpredictable text.
+REST_AUTH_SITE_KEY         = '<%= $rest_auth_site_key_from_generator %>'
+  
+# Repeated applications of the hash make brute force (even with a compromised
+# database and site key) harder, and scale with Moore's law.
+#
+#   bq. "To squeeze the most security out of a limited-entropy password or
+#   passphrase, we can use two techniques [salting and stretching]... that are
+#   so simple and obvious that they should be used in every password system.
+#   There is really no excuse not to use them." http://tinyurl.com/37lb73
+#   Practical Security (Ferguson & Scheier) p350
+# 
+# A modest 10 foldings (the default here) adds 3ms.  This makes brute forcing 10
+# times harder, while reducing an app that otherwise serves 100 reqs/s to 78 signin
+# reqs/s, an app that does 10reqs/s to 9.7 reqs/s
+# 
+# More:
+# * http://www.owasp.org/index.php/Hashing_Java
+# * "An Illustrated Guide to Cryptographic Hashes":http://www.unixwiz.net/techtips/iguide-crypto-hashes.html
+
+REST_AUTH_DIGEST_STRETCHES = <%= $rest_auth_digest_stretches_from_generator %>

data/generators/authenticated/templates/spec/controllers/access_control_spec.rb

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + '<%= ('/..'*controller_class_nesting_depth) + '/../spec_helper' %>'
+  # Be sure to include AuthenticatedTestHelper in spec/spec_helper.rb instead
+# Then, you can remove it from this and the units test.
+include AuthenticatedTestHelper
+
+#
+# A test controller with and without access controls
+#
+class AccessControlTestController < ApplicationController
+  before_filter :login_required, :only => :login_is_required
+  def login_is_required
+    respond_to do |format|
+      @foo = { 'success' => params[:format]||'no fmt given'}
+      format.html do render :text => "success"             end
+      format.xml  do render :xml  => @foo, :status => :ok  end
+      format.json do render :json => @foo, :status => :ok  end
+    end
+  end
+  def login_not_required
+    respond_to do |format|
+      @foo = { 'success' => params[:format]||'no fmt given'}
+      format.html do render :text => "success"             end
+      format.xml  do render :xml  => @foo, :status => :ok  end
+      format.json do render :json => @foo, :status => :ok  end
+    end
+  end
+end
+
+#
+# Access Control
+#
+
+ACCESS_CONTROL_FORMATS = [
+  ['',     "success"],
+  ['xml',  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <success>xml</success>\n</hash>\n"],
+  ['json', "{\"success\": \"json\"}"],]
+ACCESS_CONTROL_AM_I_LOGGED_IN = [
+  [:i_am_logged_in,     :quentin],
+  [:i_am_not_logged_in, nil],]
+ACCESS_CONTROL_IS_LOGIN_REQD = [
+  :login_not_required,
+  :login_is_required,]
+
+describe AccessControlTestController do
+  fixtures        :<%= table_name %>
+  before do
+    # is there a better way to do this?
+    ActionController::Routing::Routes.add_route '/login_is_required',           :controller => 'access_control_test',   :action => 'login_is_required'
+    ActionController::Routing::Routes.add_route '/login_not_required',          :controller => 'access_control_test',   :action => 'login_not_required'
+  end
+
+  ACCESS_CONTROL_FORMATS.each do |format, success_text|
+    ACCESS_CONTROL_AM_I_LOGGED_IN.each do |logged_in_status, <%= file_name %>_login|
+      ACCESS_CONTROL_IS_LOGIN_REQD.each do |login_reqd_status|
+        describe "requesting #{format.blank? ? 'html' : format}; #{logged_in_status.to_s.humanize} and #{login_reqd_status.to_s.humanize}" do
+          before do
+            logout_keeping_session!
+            @<%= file_name %> = format.blank? ? login_as(<%= file_name %>_login) : authorize_as(<%= file_name %>_login)
+            get login_reqd_status.to_s, :format => format
+          end
+
+          if ((login_reqd_status == :login_not_required) ||
+              (login_reqd_status == :login_is_required && logged_in_status == :i_am_logged_in))
+            it "succeeds" do
+              response.should have_text(success_text)
+              response.code.to_s.should == '200'
+            end
+
+          elsif (login_reqd_status == :login_is_required && logged_in_status == :i_am_not_logged_in)
+            if ['html', ''].include? format
+              it "redirects me to the log in page" do
+                response.should redirect_to('/<%= controller_routing_path %>/new')
+              end
+            else
+              it "returns 'Access denied' and a 406 (Access Denied) status code" do
+                response.should have_text("HTTP Basic: Access denied.\n")
+                response.code.to_s.should == '401'
+              end
+            end
+
+          else
+            warn "Oops no case for #{format} and #{logged_in_status.to_s.humanize} and #{login_reqd_status.to_s.humanize}"
+          end
+        end # describe
+
+      end
+    end
+  end # cases
+
+end