caleb-restful-authentication 1.1.1

data/CHANGELOG

@@ -0,0 +1,68 @@
+h1. Internal Changes to code
+
+As always, this is just a copy-and-pasted version of the CHANGELOG file in the source code tree.
+
+h2. Changes for the May, 2008 version of restful-authentication
+
+h3. Changes to user model
+
+* recently_activated? belongs only if stateful
+* Gave migration a 40-char limit on remember_token & an index on users by login
+* **Much** stricter login and email validation
+* put length constraints in migration too
+* password in 6, 40
+* salt and remember_token now much less predictability
+
+h3. Changes to session_controller
+
+* use uniform logout function
+* use uniform remember_cookie functions
+* avoid calling logged_in? which will auto-log-you-in (safe in the face of
+  logout! call, but idiot-proof)
+* Moved reset_session into only the "now logged in" branch
+** wherever it goes, it has to be in front of the current_user= call
+** See more in README-Tradeoffs.txt
+* made a place to take action on failed login attempt
+* recycle login and remember_me setting on failed login
+* nil'ed out the password field in 'new' view
+
+h3. Changes to users_controller
+
+* use uniform logout function
+* use uniform remember_cookie functions
+* Moved reset_session into only the "now logged in" branch
+** wherever it goes, it has to be in front of the current_user= call
+** See more in README-Tradeoffs.txt
+* made the implicit login only happen for non-activationed sites
+* On a failed signup, kick you back to the signin screen (but strip out the password & confirmation)
+* more descriptive error messages in activate()
+
+h3. users_helper
+
+* link_to_user, link_to_current_user, link_to_signin_with_IP 
+* if_authorized(action, resource, &block) view function (with appropriate
+  warning)
+
+h3. authenticated_system
+
+* Made authorized? take optional arguments action=nil, resource=nil, *args
+  This makes its signature better match traditional approaches to access control
+  eg Reference Monitor in "Security Patterns":http://www.securitypatterns.org/patterns.html)
+* authorized? should be a helper too
+* added uniform logout! methods
+* format.any (as found in access_denied) doesn't work until
+  http://dev.rubyonrails.org/changeset/8987 lands.
+* cookies are now refreshed each time we cross the logged out/in barrier, as 
+  "best":http://palisade.plynt.com/issues/2004Jul/safe-auth-practices/
+  "practice":http://www.owasp.org/index.php/Session_Management#Regeneration_of_Session_Tokens
+
+h3. Other
+
+* Used escapes <%= %> in email templates (among other reasons, so courtenay's
+  "'dumbass' test":http://tinyurl.com/684g9t doesn't complain)
+* Added site key to generator, users.yml.
+* Made site key generation idempotent in the most crude and hackish way
+* 100% coverage apart from the stateful code. (needed some access_control
+  checks, and the http_auth stuff)
+* Stories!
+

data/README.textile

@@ -0,0 +1,240 @@
+h1. "Restful Authentication Generator":http://github.com/technoweenie/restful-authentication
+
+This widely-used plugin provides a foundation for securely managing user
+authentication:
+* Login / logout
+* Secure password handling
+* Account activation by validating email
+* Account approval / disabling by admin
+* Rudimentary hooks for authorization and access control.
+* Forgot my password functionality with emailed reset code and password change
+
+Several features were updated in May, 2008.  
+* "Stable newer version":http://github.com/technoweenie/restful-authentication/tree/master 
+* "'Classic' (backward-compatible) version":http://github.com/technoweenie/restful-authentication/tree/classic
+* "Experimental version":http://github.com/technoweenie/restful-authentication/tree/modular (Much more modular, needs testing & review)
+
+  !! important: if you upgrade your site, existing user account !!
+  !! passwords will stop working unless you use --old-passwords !!
+
+***************************************************************************
+
+h2. Issue Tracker
+
+Please submit any bugs or annoyances on the lighthouse tracker at
+* "http://rails_security.lighthouseapp.com/projects/15332-restful_authentication/overview":http://rails_security.lighthouseapp.com/projects/15332-restful_authentication/overview
+
+For anything simple enough, please github message both maintainers: Rick Olson
+("technoweenie":http://github.com/technoweenie) and Flip Kromer
+("mrflip":http://github.com/mrflip).
+
+***************************************************************************
+
+h2. Documentation
+
+This page has notes on
+* "Installation":#INSTALL
+* "New Features":#AWESOME
+* "After installing":#POST-INSTALL
+
+See the "wiki":http://github.com/technoweenie/restful-authentication/wikis/home
+(or the notes/ directory) if you want to learn more about:
+
+* "Extensions, Addons and Alternatives":addons such as HAML templates
+* "Security Design Patterns":security-patterns with "snazzy diagram":http://github.com/technoweenie/restful-authentication/tree/master/notes/SecurityFramework.png
+* [[Authentication]] -- Lets a visitor identify herself (and lay  claim to her corresponding Roles and measure of Trust)
+* "Trust Metrics":Trustification -- Confidence we can rely on the outcomes of this visitor's actions.
+* [[Authorization]] and Policy -- Based on trust and identity, what actions may this visitor perform?
+* [[Access Control]] -- How the Authorization policy is actually enforced in your code (A: hopefully without turning it into  a spaghetti of if thens)
+* [[Rails Plugins]] for Authentication, Trust,  Authorization and Access Control
+* [[Tradeoffs]] -- for the paranoid or the curious, a rundown of tradeoffs made in the code
+* [[CHANGELOG]] -- Summary of changes to internals
+* [[TODO]] -- Ideas for how you can help
+
+These best version of the release notes are in the notes/ directory in the
+"source code":http://github.com/technoweenie/restful-authentication/tree/master
+-- look there for the latest version.  The wiki versions are taken (manually)
+from there.
+  
+***************************************************************************
+
+<a id="AWESOME"/> </a>
+h2. Exciting new features
+
+h3. Stories
+
+There are now RSpec stories that allow expressive, enjoyable tests for the
+authentication code. The flexible code for resource testing in stories was
+extended from "Ben Mabey's.":http://www.benmabey.com/2008/02/04/rspec-plain-text-stories-webrat-chunky-bacon/
+
+h3. Modularize to match security design patterns:
+
+* Authentication (currently: password, browser cookie token, HTTP basic)
+* Trust metric (email validation) 
+* Authorization (stateful roles)
+* Leave a flexible framework that will play nicely with other access control / policy definition / trust metric plugins
+
+h3. Other
+
+* Added a few helper methods for linking to user pages
+* Uniform handling of logout, remember_token
+* Stricter email, login field validation
+* Minor security fixes -- see CHANGELOG
+
+***************************************************************************
+
+h2. Non-backwards compatible Changes
+
+Here are a few changes in the May 2008 release that increase "Defense in Depth"
+but may require changes to existing accounts
+
+* If you have an existing site, none of these changes are compelling enough to
+  warrant migrating your userbase.
+* If you are generating for a new site, all of these changes are low-impact.
+  You should apply them.
+
+h3. Passwords
+
+The new password encryption (using a site key salt and stretching) will break
+existing user accounts' passwords.  We recommend you use the --old-passwords
+option or write a migration tool and submit it as a patch.  See the
+[[Tradeoffs]] note for more information.
+
+h3. Validations
+
+By default, email and usernames are validated against a somewhat strict pattern; your users' values may be now illegal.  Adjust to suit.
+
+***************************************************************************
+
+<a id="INSTALL"/> </a>
+h2. Installation
+
+This is a basic restful authentication generator for rails, taken from
+acts as authenticated.  Currently it requires Rails 1.2.6 or above.
+
+**IMPORTANT FOR RAILS > 2.1 USERS** To avoid a @NameError@ exception ("lighthouse tracker ticket":http://rails_security.lighthouseapp.com/projects/15332-restful_authentication/tickets/2-not-a-valid-constant-name-errors#ticket-2-2), check out the code to have an _underscore_ and not _dash_ in its name: 
+* either use <code>git clone git://github.com/technoweenie/restful-authentication.git restful_authentication</code> 
+* or rename the plugin's directory to be <code>restful_authentication</code> after fetching it.
+
+To use the generator:
+
+  ./script/generate authenticated user sessions \
+    --include-activation \
+    --include-forgot-password \
+    --email-as-login \
+    --stateful \
+    --rspec \
+    --skip-migration \
+    --skip-routes \
+    --old-passwords
+
+* The first parameter specifies the model that gets created in signup (typically
+  a user or account model).  A model with migration is created, as well as a
+  basic controller with the create method. You probably want to say "User" here.
+
+* The second parameter specifies the session controller name.  This is the
+  controller that handles the actual login/logout function on the site.
+  (probably: "Session").
+
+* --include-activation: Generates the code for a ActionMailer and its respective
+  Activation Code through email.
+
+* --include-activation: Generates the code for "forgot my password" functionality. 
+  A user clicks on a link to a forgot my password page where he/she can enter his/her
+  email address. An email with a reset code (similar to an activation code) will be
+  sent to the user in a url. The url will bring the user to a page with a form asking
+  for an email address and a new password (with confirmation).
+
+* --email-as-login: Uses the "email" field rather than the "login" field to
+  authenticate users
+
+* --stateful: Builds in support for acts_as_state_machine and generates
+  activation code.  (@--stateful@ implies @--include-activation@). Based on the
+  idea at [[http://www.vaporbase.com/postings/stateful_authentication]]. Passing
+  @--skip-migration@ will skip the user migration, and @--skip-routes@ will skip
+  resource generation -- both useful if you've already run this generator. 
+  (Needs the "acts_as_state_machine plugin":http://elitists.textdriven.com/svn/plugins/acts_as_state_machine/,
+  but new installs should probably run with @--aasm@ instead.)
+
+* --aasm: Works the same as stateful but uses the "updated aasm gem":http://github.com/rubyist/aasm/tree/master
+  
+* --rspec: Generate RSpec tests and Stories in place of standard rails tests.
+  This requires the
+    "RSpec and Rspec-on-rails plugins":http://rspec.info/
+  (make sure you "./script/generate rspec" after installing RSpec.)  The rspec
+  and story suite are much more thorough than the rails tests, and changes are
+  unlikely to be backported.
+  
+* --old-passwords: Use the older password scheme (see [[#COMPATIBILITY]], above)
+
+* --skip-migration: Don't generate a migration file for this model
+
+* --skip-routes: Don't generate a resource line in @config/routes.rb@
+
+***************************************************************************
+<a id="POST-INSTALL"/> </a>
+h2. After installing
+
+The below assumes a Model named 'User' and a Controller named 'Session'; please
+alter to suit. There are additional security minutae in @notes/README-Tradeoffs@
+-- only the paranoid or the curious need bother, though.
+
+* Add these familiar login URLs to your @config/routes.rb@ if you like:
+
+    <pre><code> 
+    map.signup  '/signup', :controller => 'users',   :action => 'new' 
+    map.login  '/login',  :controller => 'session', :action => 'new'
+    map.logout '/logout', :controller => 'session', :action => 'destroy' 
+    </code></pre>
+
+* With @--include-activation@, also add to your @config/routes.rb@:
+
+    <pre><code> 
+    map.activate '/activate/:activation_code', :controller => 'users', :action => 'activate', :activation_code => nil 
+    </code></pre> 
+
+  and add an observer to @config/environment.rb@:
+
+    <pre><code> 
+    config.active_record.observers = :user_observer
+    </code></pre> 
+
+  Pay attention, may be this is not an issue for everybody, but if you should
+  have problems, that the sent activation_code does match with that in the
+  database stored, reload your user object before sending its data through email
+  something like:
+
+    <pre><code> 
+    class UserObserver < ActiveRecord::Observer
+      def after_create(user)
+        user.reload
+        UserMailer.deliver_signup_notification(user)
+      end
+      def after_save(user)
+        user.reload
+        UserMailer.deliver_activation(user) if user.recently_activated?
+      end
+    end
+    </code></pre>
+
+
+* With @--include-forgot-password@, needs the same observer in @config/environment.rb@:
+
+    config.active_record.observers = :users_observer
+
+* With @--stateful@, also needs an observer in config/environment.rb:
+  
+    <pre><code> 
+    config.active_record.observers = :user_observer
+    </code></pre>
+    
+  and modify the users resource line to read
+  
+    map.resources :users, :member => { :suspend   => :put,
+                                       :unsuspend => :put,
+                                       :purge     => :delete } 
+
+* If you use a public repository for your code (such as github, rubyforge,
+  gitorious, etc.) make sure to NOT post your site_keys.rb (add a line like
+  '/config/initializers/site_keys.rb' to your .gitignore or do the svn ignore
+  dance), but make sure you DO keep it backed up somewhere safe.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the restful_authentication plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the restful_authentication plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RestfulAuthentication'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+gemspec = eval(File.read("#{File.dirname(__FILE__)}/restful-authentication.gemspec"))
+PKG_NAME = gemspec.name
+PKG_VERSION = gemspec.version
+
+Rake::GemPackageTask.new(gemspec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/TODO

@@ -0,0 +1,15 @@
+
+h3. Authentication security projects for a later date
+
+
+* Track 'failed logins this hour' and demand a captcha after say 5 failed logins
+  ("RECAPTCHA plugin.":http://agilewebdevelopment.com/plugins/recaptcha)
+  "De-proxy-ficate IP address": http://wiki.codemongers.com/NginxHttpRealIpModule
+
+* Make cookie spoofing a little harder: we set the user's cookie to
+  (remember_token), but store digest(remember_token, request_IP). A CSRF cookie
+  spoofer has to then at least also spoof the user's originating IP
+  (see "Secure Programs HOWTO":http://www.dwheeler.com/secure-programs/Secure-Programs-HOWTO/web-authentication.html)
+
+* Log HTTP request on authentication / authorization failures
+  http://palisade.plynt.com/issues/2004Jul/safe-auth-practices  

data/generators/authenticated/USAGE

@@ -0,0 +1 @@
+./script/generate authenticated USERMODEL CONTROLLERNAME

data/generators/authenticated/authenticated_generator.rb

@@ -0,0 +1,508 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_routes.rb")
+require 'digest/sha1'
+class AuthenticatedGenerator < Rails::Generator::NamedBase
+  default_options :skip_migration          => false,
+                  :skip_routes             => false,
+                  :old_passwords           => false,
+                  :include_activation      => false,
+                  :include_forgot_password => false,
+                  :email_as_login          => false,
+                  :login_field_name        => "login"
+
+  attr_reader   :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_singular_name,
+                :controller_plural_name,
+                :controller_routing_name,                 # new_session_path
+                :controller_routing_path,                 # /session/new
+                :controller_controller_name,              # sessions
+                :controller_file_name
+  alias_method  :controller_table_name, :controller_plural_name
+  attr_reader   :model_controller_name,
+                :model_controller_class_path,
+                :model_controller_file_path,
+                :model_controller_class_nesting,
+                :model_controller_class_nesting_depth,
+                :model_controller_class_name,
+                :model_controller_singular_name,
+                :model_controller_plural_name,
+                :model_controller_routing_name,           # new_user_path
+                :model_controller_routing_path,           # /users/new
+                :model_controller_controller_name         # users
+  alias_method  :model_controller_file_name,  :model_controller_singular_name
+  alias_method  :model_controller_table_name, :model_controller_plural_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    @rspec = has_rspec?
+
+    @controller_name = (args.shift || 'sessions').pluralize
+    @model_controller_name = @name.pluralize
+
+    # sessions controller
+    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
+    @controller_class_name_without_nesting, @controller_file_name, @controller_plural_name = inflect_names(base_name)
+    @controller_singular_name = @controller_file_name.singularize
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+    else
+      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+    end
+    @controller_routing_name  = @controller_singular_name
+    @controller_routing_path  = @controller_file_path.singularize
+    @controller_controller_name = @controller_plural_name
+
+    # model controller
+    base_name, @model_controller_class_path, @model_controller_file_path, @model_controller_class_nesting, @model_controller_class_nesting_depth = extract_modules(@model_controller_name)
+    @model_controller_class_name_without_nesting, @model_controller_singular_name, @model_controller_plural_name = inflect_names(base_name)
+
+    if @model_controller_class_nesting.empty?
+      @model_controller_class_name = @model_controller_class_name_without_nesting
+    else
+      @model_controller_class_name = "#{@model_controller_class_nesting}::#{@model_controller_class_name_without_nesting}"
+    end
+    @model_controller_routing_name    = @table_name
+    @model_controller_routing_path    = @model_controller_file_path
+    @model_controller_controller_name = @model_controller_plural_name
+
+    load_or_initialize_site_keys()
+
+    if options[:dump_generator_attribute_names]
+      dump_generator_attribute_names
+    end
+  end
+
+  def manifest
+    recorded_session = record do |m|
+      # Check for class naming collisions.
+      m.class_collisions controller_class_path,       "#{controller_class_name}Controller", # Sessions Controller
+                                                      "#{controller_class_name}Helper"
+      m.class_collisions model_controller_class_path, "#{model_controller_class_name}Controller", # Model Controller
+                                                      "#{model_controller_class_name}Helper"
+      m.class_collisions class_path,                  "#{class_name}", "#{class_name}Mailer", "#{class_name}MailerTest", "#{class_name}Observer"
+      m.class_collisions [], 'AuthenticatedSystem', 'AuthenticatedTestHelper'
+
+      # Controller, helper, views, and test directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('app/controllers', controller_class_path)
+      m.directory File.join('app/controllers', model_controller_class_path)
+      m.directory File.join('app/helpers', controller_class_path)
+      m.directory File.join('app/views', controller_class_path, controller_file_name)
+      m.directory File.join('app/views', class_path, "#{file_name}_mailer") if options[:include_activation]
+
+      m.directory File.join('app/controllers', model_controller_class_path)
+      m.directory File.join('app/helpers', model_controller_class_path)
+      m.directory File.join('app/views', model_controller_class_path, model_controller_file_name)
+      m.directory File.join('config/initializers')
+
+      if @rspec
+        m.directory File.join('spec/controllers', controller_class_path)
+        m.directory File.join('spec/controllers', model_controller_class_path)
+        m.directory File.join('spec/models', class_path)
+        m.directory File.join('spec/helpers', model_controller_class_path)
+        m.directory File.join('spec/fixtures', class_path)
+        m.directory File.join('stories', model_controller_file_path)
+        m.directory File.join('stories', 'steps')
+      else
+        m.directory File.join('test/functional', controller_class_path)
+        m.directory File.join('test/functional', model_controller_class_path)
+        m.directory File.join('test/unit', class_path)
+        m.directory File.join('test/fixtures', class_path)
+      end
+
+      m.template 'model.rb',
+                  File.join('app/models',
+                            class_path,
+                            "#{file_name}.rb")
+
+      if options[:include_activation]
+        %w( mailer observer ).each do |model_type|
+          m.template "#{model_type}.rb", File.join('app/models',
+                                               class_path,
+                                               "#{file_name}_#{model_type}.rb")
+        end
+      end
+
+      m.template 'controller.rb',
+                  File.join('app/controllers',
+                            controller_class_path,
+                            "#{controller_file_name}_controller.rb")
+
+      m.template 'model_controller.rb',
+                  File.join('app/controllers',
+                            model_controller_class_path,
+                            "#{model_controller_file_name}_controller.rb")
+
+      m.template 'authenticated_system.rb',
+                  File.join('lib', 'authenticated_system.rb')
+
+      m.template 'authenticated_test_helper.rb',
+                  File.join('lib', 'authenticated_test_helper.rb')
+
+      m.template 'site_keys.rb', site_keys_file
+
+      if @rspec
+        # RSpec Specs
+        m.template  'spec/controllers/users_controller_spec.rb',
+                    File.join('spec/controllers',
+                              model_controller_class_path,
+                              "#{model_controller_file_name}_controller_spec.rb")
+        m.template  'spec/controllers/sessions_controller_spec.rb',
+                    File.join('spec/controllers',
+                              controller_class_path,
+                              "#{controller_file_name}_controller_spec.rb")
+        m.template  'spec/controllers/access_control_spec.rb',
+                    File.join('spec/controllers',
+                              controller_class_path,
+                              "access_control_spec.rb")
+        m.template  'spec/controllers/authenticated_system_spec.rb',
+                    File.join('spec/controllers',
+                              controller_class_path,
+                              "authenticated_system_spec.rb")
+        m.template  'spec/helpers/users_helper_spec.rb',
+                    File.join('spec/helpers',
+                              model_controller_class_path,
+                              "#{table_name}_helper_spec.rb")
+        m.template  'spec/models/user_spec.rb',
+                    File.join('spec/models',
+                              class_path,
+                              "#{file_name}_spec.rb")
+        m.template 'spec/fixtures/users.yml',
+                    File.join('spec/fixtures',
+                               class_path,
+                              "#{table_name}.yml")
+
+        # RSpec Stories
+        m.template  'stories/steps/ra_navigation_steps.rb',
+         File.join('stories/steps/ra_navigation_steps.rb')
+        m.template  'stories/steps/ra_response_steps.rb',
+         File.join('stories/steps/ra_response_steps.rb')
+        m.template  'stories/steps/ra_resource_steps.rb',
+         File.join('stories/steps/ra_resource_steps.rb')
+        m.template  'stories/steps/user_steps.rb',
+         File.join('stories/steps/', "#{file_name}_steps.rb")
+        m.template  'stories/users/accounts.story',
+         File.join('stories', model_controller_file_path, 'accounts.story')
+        m.template  'stories/users/sessions.story',
+         File.join('stories', model_controller_file_path, 'sessions.story')
+        m.template  'stories/rest_auth_stories_helper.rb',
+         File.join('stories', 'rest_auth_stories_helper.rb')
+        m.template  'stories/rest_auth_stories.rb',
+         File.join('stories', 'rest_auth_stories.rb')
+
+      else
+        m.template 'test/functional_test.rb',
+                    File.join('test/functional',
+                              controller_class_path,
+                              "#{controller_file_name}_controller_test.rb")
+        m.template 'test/model_functional_test.rb',
+                    File.join('test/functional',
+                              model_controller_class_path,
+                              "#{model_controller_file_name}_controller_test.rb")
+        m.template 'test/unit_test.rb',
+                    File.join('test/unit',
+                              class_path,
+                              "#{file_name}_test.rb")
+        if options[:include_activation]
+          m.template 'test/mailer_test.rb', File.join('test/unit', class_path, "#{file_name}_mailer_test.rb")
+        end
+        m.template 'spec/fixtures/users.yml',
+                    File.join('test/fixtures',
+                              class_path,
+                              "#{table_name}.yml")
+      end
+
+      m.template 'helper.rb',
+                  File.join('app/helpers',
+                            controller_class_path,
+                            "#{controller_file_name}_helper.rb")
+
+      m.template 'model_helper.rb',
+                  File.join('app/helpers',
+                            model_controller_class_path,
+                            "#{model_controller_file_name}_helper.rb")
+
+
+      # Controller templates
+      m.template 'login.html.erb',  File.join('app/views', controller_class_path, controller_file_name, "new.html.erb")
+      m.template 'signup.html.erb', File.join('app/views', model_controller_class_path, model_controller_file_name, "new.html.erb")
+      m.template '_model_partial.html.erb', File.join('app/views', model_controller_class_path, model_controller_file_name, "_#{file_name}_bar.html.erb")
+
+      if options[:include_activation]
+        # Mailer templates
+        %w( activation signup_notification ).each do |action|
+          m.template "#{action}.erb",
+                     File.join('app/views', "#{file_name}_mailer", "#{action}.erb")
+        end
+      end
+
+      if options[:include_forgot_password]
+        m.template 'forgot.html.erb',  File.join('app/views', model_controller_class_path, model_controller_file_name, "forgot.html.erb")
+        m.template 'reset.html.erb',  File.join('app/views', model_controller_class_path, model_controller_file_name, "reset.html.erb")
+        # Mailer templates
+        %w( reset_password ).each do |action|
+          m.template "#{action}.html.erb",
+                     File.join('app/views', "#{file_name}_mailer", "#{action}.html.erb")
+        end
+      end
+
+      unless options[:skip_migration]
+        m.migration_template 'migration.rb', 'db/migrate', :assigns => {
+          :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"
+        }, :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+      end
+      unless options[:skip_routes]
+        # Note that this fails for nested classes -- you're on your own with setting up the routes.
+        m.route_resource  controller_singular_name
+        m.route_resources model_controller_plural_name
+        m.route_name('signup',   '/signup',   {:controller => model_controller_plural_name, :action => 'new'})
+        m.route_name('register', '/register', {:controller => model_controller_plural_name, :action => 'create'})
+        m.route_name('login',    '/login',    {:controller => controller_controller_name, :action => 'new'})
+        m.route_name('logout',   '/logout',   {:controller => controller_controller_name, :action => 'destroy'})
+        if options[:include_activation]
+          m.route_name('activate', '/activate/:activation_code', {:controller => model_controller_plural_name, :action => 'activate', :activation_code => nil})
+        end
+        if options[:include_forgot_password]
+          m.route_name('reset', '/reset/:reset_code', {:controller => model_controller_plural_name, :action => 'reset', :reset_code => nil})
+          m.route_name('forgot', '/forgot', {:controller => model_controller_plural_name, :action => 'forgot'})
+        end
+      end
+    end
+
+    #
+    # Post-install notes
+    #
+    action = File.basename($0) # grok the action from './script/generate' or whatever
+    case action
+    when "generate"
+      puts "Ready to generate."
+      puts ("-" * 70)
+      puts "Once finished, don't forget to:"
+      puts
+      if options[:include_activation]
+        puts "- Add an observer to config/environment.rb"
+        puts "    config.active_record.observers = :#{file_name}_observer"
+      end
+      if options[:aasm]
+        puts "- Install the acts_as_state_machine gem:"
+        puts "    sudo gem sources -a http://gems.github.com (If you haven't already)"
+        puts "    sudo gem install rubyist-aasm"
+      elsif options[:stateful]
+        puts "- Install the acts_as_state_machine plugin:"
+        puts "    svn export http://elitists.textdriven.com/svn/plugins/acts_as_state_machine/trunk vendor/plugins/acts_as_state_machine"
+      end
+      if options[:skip_routes]
+        puts "- Add routes to these resources. In config/routes.rb, insert routes like:"
+        puts %(    map.signup '/signup', :controller => '#{model_controller_file_name}', :action => 'new')
+        puts %(    map.login  '/login',  :controller => '#{controller_file_name}', :action => 'new')
+        puts %(    map.logout '/logout', :controller => '#{controller_file_name}', :action => 'destroy')
+        if options[:include_activation]
+          puts %(    map.activate '/activate/:activation_code', :controller => '#{model_controller_file_name}', :action => 'activate', :activation_code => nil)
+        end
+        if options[:include_forgot_password]
+          puts %(    map.forgot '/forgot', :controller => 'users', :action => 'forgot')
+          puts %(    map.reset 'reset/:reset_code', :controller => 'users', :action => 'reset', :reset_code => nil)
+        end
+      end
+      if options[:stateful]
+        puts  "  and modify the map.resources :#{model_controller_file_name} line to include these actions:"
+        puts  "    map.resources :#{model_controller_file_name}, :member => { :suspend => :put, :unsuspend => :put, :purge => :delete }"
+      end
+      puts
+      puts ("-" * 70)
+      puts
+      if $rest_auth_site_key_from_generator.blank?
+        puts "You've set a nil site key. This preserves existing users' passwords,"
+        puts "but allows dictionary attacks in the unlikely event your database is"
+        puts "compromised and your site code is not.  See the README for more."
+      elsif $rest_auth_keys_are_new
+        puts "We've create a new site key in #{site_keys_file}.  If you have existing"
+        puts "user accounts their passwords will no longer work (see README). As always,"
+        puts "keep this file safe but don't post it in public."
+      else
+        puts "We've reused the existing site key in #{site_keys_file}.  As always,"
+        puts "keep this file safe but don't post it in public."
+      end
+      puts
+      puts ("-" * 70)
+    when "destroy"
+      puts
+      puts ("-" * 70)
+      puts
+      puts "Thanks for using restful_authentication"
+      puts
+      puts "Don't forget to comment out the observer line in environment.rb"
+      puts "  (This was optional so it may not even be there)"
+      puts "  # config.active_record.observers = :#{file_name}_observer"
+      puts
+      puts ("-" * 70)
+      puts
+    else
+      puts "Didn't understand the action '#{action}' -- you might have missed the 'after running me' instructions."
+    end
+
+    #
+    # Do the thing
+    #
+    recorded_session
+  end
+
+  def has_rspec?
+    spec_dir = File.join(RAILS_ROOT, 'spec')
+    options[:rspec] ||= (File.exist?(spec_dir) && File.directory?(spec_dir)) unless (options[:rspec] == false)
+  end
+
+  #
+  # !! These must match the corresponding routines in by_password.rb !!
+  #
+  def secure_digest(*args)
+    Digest::SHA1.hexdigest(args.flatten.join('--'))
+  end
+  def make_token
+    secure_digest(Time.now, (1..10).map{ rand.to_s })
+  end
+  def password_digest(password, salt)
+    digest = $rest_auth_site_key_from_generator
+    $rest_auth_digest_stretches_from_generator.times do
+      digest = secure_digest(digest, salt, password, $rest_auth_site_key_from_generator)
+    end
+    digest
+  end
+
+  #
+  # Try to be idempotent:
+  # pull in the existing site key if any,
+  # seed it with reasonable defaults otherwise
+  #
+  def load_or_initialize_site_keys
+    case
+    when defined? REST_AUTH_SITE_KEY
+      if (options[:old_passwords]) && ((! REST_AUTH_SITE_KEY.blank?) || (REST_AUTH_DIGEST_STRETCHES != 1))
+        raise "You have a site key, but --old-passwords will overwrite it.  If this is really what you want, move the file #{site_keys_file} and re-run."
+      end
+      $rest_auth_site_key_from_generator         = REST_AUTH_SITE_KEY
+      $rest_auth_digest_stretches_from_generator = REST_AUTH_DIGEST_STRETCHES
+    when options[:old_passwords]
+      $rest_auth_site_key_from_generator         = nil
+      $rest_auth_digest_stretches_from_generator = 1
+      $rest_auth_keys_are_new                    = true
+    else
+      $rest_auth_site_key_from_generator         = make_token
+      $rest_auth_digest_stretches_from_generator = 10
+      $rest_auth_keys_are_new                    = true
+    end
+  end
+  def site_keys_file
+    File.join("config", "initializers", "site_keys.rb")
+  end
+
+protected
+  # Override with your own usage banner.
+  def banner
+    "Usage: #{$0} authenticated ModelName [ControllerName]"
+  end
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--skip-migration",
+      "Don't generate a migration file for this model")           { |v| options[:skip_migration] = v }
+    opt.on("--include-activation",
+      "Generate signup 'activation code' confirmation via email") { |v| options[:include_activation] = true }
+    opt.on("--include-forgot-password",
+      "Generate forgot my password support")                     { |v| options[:include_forgot_password] = true }
+    opt.on("--email-as-login",
+      "Use email address as login")                               { |v| options[:email_as_login] = true; options[:login_field_name] = "email" }
+    opt.on("--stateful",
+      "Use acts_as_state_machine.  Assumes --include-activation and --include-forgot-password") { |v| options[:include_activation] = options[:stateful] = true }
+    opt.on("--aasm",
+      "Use (gem) aasm.  Assumes --include-activation")            { |v| options[:include_activation] = options[:stateful] = options[:aasm] = true }
+    opt.on("--rspec",
+      "Force rspec mode (checks for RAILS_ROOT/spec by default)") { |v| options[:rspec] = true }
+    opt.on("--no-rspec",
+      "Force test (not RSpec mode")                               { |v| options[:rspec] = false }
+    opt.on("--skip-routes",
+      "Don't generate a resource line in config/routes.rb")       { |v| options[:skip_routes] = v }
+    opt.on("--old-passwords",
+      "Use the older password encryption scheme (see README)")    { |v| options[:old_passwords] = v }
+    opt.on("--dump-generator-attrs",
+      "(generator debug helper)")                                 { |v| options[:dump_generator_attribute_names] = v }
+  end
+
+  def dump_generator_attribute_names
+    generator_attribute_names = [
+      :table_name,
+      :file_name,
+      :class_name,
+      :controller_name,
+      :controller_class_path,
+      :controller_file_path,
+      :controller_class_nesting,
+      :controller_class_nesting_depth,
+      :controller_class_name,
+      :controller_singular_name,
+      :controller_plural_name,
+      :controller_routing_name,                 # new_session_path
+      :controller_routing_path,                 # /session/new
+      :controller_controller_name,              # sessions
+      :controller_file_name,
+      :controller_table_name, :controller_plural_name,
+      :model_controller_name,
+      :model_controller_class_path,
+      :model_controller_file_path,
+      :model_controller_class_nesting,
+      :model_controller_class_nesting_depth,
+      :model_controller_class_name,
+      :model_controller_singular_name,
+      :model_controller_plural_name,
+      :model_controller_routing_name,           # new_user_path
+      :model_controller_routing_path,           # /users/new
+      :model_controller_controller_name,        # users
+      :model_controller_file_name,  :model_controller_singular_name,
+      :model_controller_table_name, :model_controller_plural_name,
+    ]
+    generator_attribute_names.each do |attr|
+      puts "%-40s %s" % ["#{attr}:", self.send(attr)]  # instance_variable_get("@#{attr.to_s}"
+    end
+
+  end
+end
+
+# ./script/generate authenticated FoonParent::Foon SporkParent::Spork -p --force --rspec --dump-generator-attrs
+# table_name:                              foon_parent_foons
+# file_name:                               foon
+# class_name:                              FoonParent::Foon
+# controller_name:                         SporkParent::Sporks
+# controller_class_path:                   spork_parent
+# controller_file_path:                    spork_parent/sporks
+# controller_class_nesting:                SporkParent
+# controller_class_nesting_depth:          1
+# controller_class_name:                   SporkParent::Sporks
+# controller_singular_name:                spork
+# controller_plural_name:                  sporks
+# controller_routing_name:                 spork
+# controller_routing_path:                 spork_parent/spork
+# controller_controller_name:              sporks
+# controller_file_name:                    sporks
+# controller_table_name:                   sporks
+# controller_plural_name:                  sporks
+# model_controller_name:                   FoonParent::Foons
+# model_controller_class_path:             foon_parent
+# model_controller_file_path:              foon_parent/foons
+# model_controller_class_nesting:          FoonParent
+# model_controller_class_nesting_depth:    1
+# model_controller_class_name:             FoonParent::Foons
+# model_controller_singular_name:          foons
+# model_controller_plural_name:            foons
+# model_controller_routing_name:           foon_parent_foons
+# model_controller_routing_path:           foon_parent/foons
+# model_controller_controller_name:        foons
+# model_controller_file_name:              foons
+# model_controller_singular_name:          foons
+# model_controller_table_name:             foons
+# model_controller_plural_name:            foons