Now that we finally have a simple yet functional application, we can
focus on providing authentication (with authorization coming next in
-Chapter 6).
+L<Chapter 6|Catalyst::Manual::Tutorial::06_Authorization>).
-This chapter of the tutorial is divided into two main sections: 1) basic,
-cleartext authentication and 2) hash-based authentication.
+This chapter of the tutorial is divided into two main sections: 1)
+basic, cleartext authentication and 2) hash-based authentication.
You can checkout the source code for this example from the catalyst
subversion repository as per the instructions in
First, we add both user and role information to the database (we will
add the role information here although it will not be used until the
-authorization section, Chapter 6). Create a new SQL script file by opening
-C<myapp02.sql> in your editor and insert:
+authorization section, Chapter 6). Create a new SQL script file by
+opening C<myapp02.sql> in your editor and insert:
--
-- Add users and role tables, along with a many-to-many join table
=head2 Add User and Role Information to DBIC Schema
Although we could manually edit the DBIC schema information to include
-the new tables added in the previous step, let's use the C<create=static>
-option on the DBIC model helper to do most of the work for us:
+the new tables added in the previous step, let's use the
+C<create=static> option on the DBIC model helper to do most of the work
+for us:
$ script/myapp_create.pl model DB DBIC::Schema MyApp::Schema \
create=static components=TimeStamp dbi:SQLite:myapp.db \
MODIFY THIS OR ANYTHING ABOVE!> comment and your hand-edited
enhancements would have been preserved.
-Speaking of "hand-editted enhancements," we should now add the
+Speaking of "hand-edited enhancements," we should now add the
C<many_to_many> relationship information to the User Result Source file.
-As with the Book, BookAuthor, and Author files in
-L<Chapter 3|Catalyst::Manual::Tutorial::03_MoreCatalystBasics>,
-L<DBIx::Class::Schema::Loader> has
-automatically created the C<has_many> and C<belongs_to> relationships
-for the new User, UserRole, and Role tables. However, as a convenience
-for mapping Users to their assigned roles (see
-L<Chapter 6|Catalyst::Manual::Tutorial::06_Authorization>), we will
-also manually add a C<many_to_many> relationship. Edit
+As with the Book, BookAuthor, and Author files in L<Chapter
+3|Catalyst::Manual::Tutorial::03_MoreCatalystBasics>,
+L<DBIx::Class::Schema::Loader> has automatically created the C<has_many>
+and C<belongs_to> relationships for the new User, UserRole, and Role
+tables. However, as a convenience for mapping Users to their assigned
+roles (see L<Chapter 6|Catalyst::Manual::Tutorial::06_Authorization>),
+we will also manually add a C<many_to_many> relationship. Edit
C<lib/MyApp/Schema/Result/User.pm> add the following information between
the C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!> comment and the closing
C<1;>:
C<many_to_many> in the Users to Roles direction.
Note that we do not need to make any change to the
-C<lib/MyApp/Schema.pm> schema file. It simply tells DBIC to load all
-of the Result Class and ResultSet Class files it finds in below the
-C<lib/MyApp/Schema> directory, so it will automatically pick up our
-new table information.
+C<lib/MyApp/Schema.pm> schema file. It simply tells DBIC to load all of
+the Result Class and ResultSet Class files it finds in below the
+C<lib/MyApp/Schema> directory, so it will automatically pick up our new
+table information.
=head2 Sanity-Check of the Development Server Reload
'-------------------------------------------------------------------+----------'
...
-Again, notice that your "Result Class" classes have been "re-loaded"
-by Catalyst under C<MyApp::Model>.
+Again, notice that your "Result Class" classes have been "re-loaded" by
+Catalyst under C<MyApp::Model>.
=head2 Include Authentication and Session Plugins
requests.
Note that the only required Authentication class is the main one. This
-is a change that occurred in version 0.09999_01 of the
-C<Authentication> plugin. You B<do not need> to specify a particular
-Authentication::Store or Authentication::Credential plugin. Instead,
-indicate the Store and Credential you want to use in your application
-configuration (see below).
+is a change that occurred in version 0.09999_01 of the C<Authentication>
+plugin. You B<do not need> to specify a particular Authentication::Store
+or Authentication::Credential plugin. Instead, indicate the Store and
+Credential you want to use in your application configuration (see
+below).
-Make sure you include the additional plugins as new dependencies in
-the Makefile.PL file something like this:
+Make sure you include the additional plugins as new dependencies in the
+Makefile.PL file something like this:
requires 'Catalyst::Plugin::Authentication';
requires 'Catalyst::Plugin::Session';
Note that there are several options for
L<Session::Store|Catalyst::Plugin::Session::Store>.
-L<Session::Store::Memcached|Catalyst::Plugin::Session::Store::Memcached> is
-generally a good choice if you are on Unix. If you are running on
-Windows
-L<Session::Store::File|Catalyst::Plugin::Session::Store::File> is fine. Consult
-L<Session::Store|Catalyst::Plugin::Session::Store> and its subclasses
-for additional information and options (for example to use a database-
-backed session store).
+L<Session::Store::Memcached|Catalyst::Plugin::Session::Store::Memcached>
+is generally a good choice if you are on Unix. If you are running on
+Windows L<Session::Store::File|Catalyst::Plugin::Session::Store::File>
+is fine. Consult L<Session::Store|Catalyst::Plugin::Session::Store> and
+its subclasses for additional information and options (for example to
+use a database- backed session store).
=head2 Configure Authentication
There are a variety of ways to provide configuration information to
-L<Catalyst::Plugin::Authentication>.
-Here we will use
-L<Catalyst::Authentication::Realm::SimpleDB>
-because it automatically sets a reasonable set of defaults for us. Open
-C<lib/MyApp.pm> and place the following text above the call to
-C<__PACKAGE__-E<gt>setup();>:
+L<Catalyst::Plugin::Authentication>. Here we will use
+L<Catalyst::Authentication::Realm::SimpleDB> because it automatically
+sets a reasonable set of defaults for us. Open C<lib/MyApp.pm> and place
+the following text above the call to C<__PACKAGE__-E<gt>setup();>:
# Configure SimpleDB Authentication
__PACKAGE__->config(
},
);
-We could have placed this configuration in C<myapp.conf>, but placing
-it in C<lib/MyApp.pm> is probably a better place since it's not likely
+We could have placed this configuration in C<myapp.conf>, but placing it
+in C<lib/MyApp.pm> is probably a better place since it's not likely
something that users of your application will want to change during
-deployment (or you could use a mixture: leave C<class> and
-C<user_model> defined in C<lib/MyApp.pm> as we show above, but place
-C<password_type> in C<myapp.conf> to allow the type of password to be
-easily modified during deployment). We will stick with putting
-all of the authentication-related configuration in C<lib/MyApp.pm>
-for the tutorial, but if you wish to use C<myapp.conf>, just convert
-to the following code:
+deployment (or you could use a mixture: leave C<class> and C<user_model>
+defined in C<lib/MyApp.pm> as we show above, but place C<password_type>
+in C<myapp.conf> to allow the type of password to be easily modified
+during deployment). We will stick with putting all of the
+authentication-related configuration in C<lib/MyApp.pm> for the
+tutorial, but if you wish to use C<myapp.conf>, just convert to the
+following code:
<Plugin::Authentication>
<default>
</Plugin::Authentication>
B<TIP:> Here is a short script that will dump the contents of
-C<MyApp->config> to L<Config::General> format in
-C<myapp.conf>:
+C<MyApp->config> to L<Config::General> format in C<myapp.conf>:
$ CATALYST_DEBUG=0 perl -Ilib -e 'use MyApp; use Config::General;
Config::General->new->save_file("myapp.conf", MyApp->config);'
"myapp.conf" command. Otherwise, you will wind up with duplicate
configurations.
-B<NOTE:> Because we are using SimpleDB along with a database layout
-that complies with its default assumptions: we don't need to specify
-the names of the columns where our username and password information
-is stored (hence, the "Simple" part of "SimpleDB"). That being said,
-SimpleDB lets you specify that type of information if you need to.
-Take a look at
+B<NOTE:> Because we are using SimpleDB along with a database layout that
+complies with its default assumptions: we don't need to specify the
+names of the columns where our username and password information is
+stored (hence, the "Simple" part of "SimpleDB"). That being said,
+SimpleDB lets you specify that type of information if you need to. Take
+a look at
C<Catalyst::Authentication::Realm::SimpleDB|Catalyst::Authentication::Realm::SimpleDB>
for details.
matters up to you, the designer and programmer.
Then open C<lib/MyApp/Controller/Login.pm>, locate the
-C<sub index :Path :Args(0)> method (or C<sub index : Private> if you
-are using an older version of Catalyst) that was automatically
-inserted by the helpers when we created the Login controller above,
-and update the definition of C<sub index> to match:
+C<sub index :Path :Args(0)> method (or C<sub index : Private> if you are
+using an older version of Catalyst) that was automatically inserted by
+the helpers when we created the Login controller above, and update the
+definition of C<sub index> to match:
=head2 index
login form and attempts to authenticate the user. If successful, it
redirects the user to the book list page. If the login fails, the user
will stay at the login page and receive an error message. If the
-C<username> and C<password> values are not present in the form, the
-user will be taken to the empty login form.
+C<username> and C<password> values are not present in the form, the user
+will be taken to the empty login form.
Note that we could have used something like "C<sub default :Path>",
-however, it is generally recommended (partly for historical reasons,
-and partly for code clarity) only to use C<default> in
+however, it is generally recommended (partly for historical reasons, and
+partly for code clarity) only to use C<default> in
C<MyApp::Controller::Root>, and then mainly to generate the 404 not
found page for the application.
Instead, we are using "C<sub somename :Path :Args(0) {...}>" here to
specifically match the URL C</login>. C<Path> actions (aka, "literal
-actions") create URI matches relative to the namespace of the
-controller where they are defined. Although C<Path> supports
-arguments that allow relative and absolute paths to be defined, here
-we use an empty C<Path> definition to match on just the name of the
-controller itself. The method name, C<index>, is arbitrary. We make
-the match even more specific with the C<:Args(0)> action modifier --
-this forces the match on I<only> C</login>, not
-C</login/somethingelse>.
+actions") create URI matches relative to the namespace of the controller
+where they are defined. Although C<Path> supports arguments that allow
+relative and absolute paths to be defined, here we use an empty C<Path>
+definition to match on just the name of the controller itself. The
+method name, C<index>, is arbitrary. We make the match even more
+specific with the C<:Args(0)> action modifier -- this forces the match
+on I<only> C</login>, not C</login/somethingelse>.
Next, update the corresponding method in
C<lib/MyApp/Controller/Logout.pm> to match:
As discussed in
L<Catalyst::Manual::Tutorial::03_MoreCatalystBasics/CREATE A CATALYST CONTROLLER>,
every C<auto> method from the application/root controller down to the
-most specific controller will be called. By placing the
-authentication enforcement code inside the C<auto> method of
-C<lib/MyApp/Controller/Root.pm> (or C<lib/MyApp.pm>), it will be
-called for I<every> request that is received by the entire
-application.
+most specific controller will be called. By placing the authentication
+enforcement code inside the C<auto> method of
+C<lib/MyApp/Controller/Root.pm> (or C<lib/MyApp.pm>), it will be called
+for I<every> request that is received by the entire application.
=head2 Displaying Content Only to Authenticated Users
Reload your browser and you should now see a "Login" and "Create" links
at the bottom of the page (as mentioned earlier, you can update template
-files without a development server reload). Click the first link
-to return to the login page. This time you I<should> see the "You are
+files without a development server reload). Click the first link to
+return to the login page. This time you I<should> see the "You are
already logged in" message.
Finally, click the C<You can logout here> link on the C</login> page.
=head1 USING PASSWORD HASHES
In this section we increase the security of our system by converting
-from cleartext passwords to SHA-1 password hashes that include a
-random "salt" value to make them extremely difficult to crack with
-dictionary and "rainbow table" attacks.
+from cleartext passwords to SHA-1 password hashes that include a random
+"salt" value to make them extremely difficult to crack with dictionary
+and "rainbow table" attacks.
B<Note:> This section is optional. You can skip it and the rest of the
tutorial will function normally.
-Be aware that even with the techniques shown in this section, the browser
-still transmits the passwords in cleartext to your application. We are
-just avoiding the I<storage> of cleartext passwords in the database by
-using a salted SHA-1 hash. If you are concerned about cleartext passwords
-between the browser and your application, consider using SSL/TLS, made
-easy with the Catalyst plugin Catalyst::Plugin:RequireSSL.
+Be aware that even with the techniques shown in this section, the
+browser still transmits the passwords in cleartext to your application.
+We are just avoiding the I<storage> of cleartext passwords in the
+database by using a salted SHA-1 hash. If you are concerned about
+cleartext passwords between the browser and your application, consider
+using SSL/TLS, made easy with the Catalyst plugin
+L<Catalyst::Plugin:RequireSSL>.
=head2 Re-Run the DBIC::Schema Model Helper to Include DBIx::Class::PassphraseColumn
Next, we can re-run the model helper to have it include
-L<DBIx::Class::PassphraseColumn> in all of the Result Classes it generates for
-us. Simply use the same command we saw in Chapters 3 and 4, but add
-C<,PassphraseColumn> to the C<components> argument:
+L<DBIx::Class::PassphraseColumn> in all of the Result Classes it
+generates for us. Simply use the same command we saw in Chapters 3 and
+4, but add C<,PassphraseColumn> to the C<components> argument:
$ script/myapp_create.pl model DB DBIC::Schema MyApp::Schema \
create=static components=TimeStamp,PassphraseColumn dbi:SQLite:myapp.db \
on_connect_do="PRAGMA foreign_keys = ON"
If you then open one of the Result Classes, you will see that it
-includes PassphraseColumn in the C<load_components> line. Take a look at
-C<lib/MyApp/Schema/Result/User.pm> since that's the main class where we
-want to use hashed and salted passwords:
+includes PassphraseColumn in the C<load_components> line. Take a look
+at C<lib/MyApp/Schema/Result/User.pm> since that's the main class where
+we want to use hashed and salted passwords:
__PACKAGE__->load_components("InflateColumn::DateTime", "TimeStamp", "PassphraseColumn");
},
);
-This redefines the automatically generated definition for the password fields at
-the top of the Result Class file to now use PassphraseColumn logic, storing
-passwords in RFC 2307 format (C<passphrase> is set to C<rfc2307>).
-C<passphrase_class> can be set to the name of any C<Authen::Passphrase::*>
-class, such as C<SaltedDigest> to use L<Authen::Passphrase::SaltedDigest>, or
-C<BlowfishCrypt> to use L<Authen::Passphrase::BlowfishCrypt>.
-C<passphrase_args> is then used to customize the passphrase class you
-selected. Here we specified the digest algorithm to use as C<SHA-1> and the size
-of the salt to use, but we could have also specified any other option the
-selected passphrase class supports.
+This redefines the automatically generated definition for the password
+fields at the top of the Result Class file to now use PassphraseColumn
+logic, storing passwords in RFC 2307 format (C<passphrase> is set to
+C<rfc2307>). C<passphrase_class> can be set to the name of any
+C<Authen::Passphrase::*> class, such as C<SaltedDigest> to use
+L<Authen::Passphrase::SaltedDigest>, or C<BlowfishCrypt> to use
+L<Authen::Passphrase::BlowfishCrypt>. C<passphrase_args> is then used
+to customize the passphrase class you selected. Here we specified the
+digest algorithm to use as C<SHA-1> and the size of the salt to use, but
+we could have also specified any other option the selected passphrase
+class supports.
+
=head2 Load Hashed Passwords in the Database
-Next, let's create a quick script to load some hashed and salted passwords
-into the C<password> column of our C<users> table. Open the file
-C<set_hashed_passwords.pl> in your editor and enter the following text:
+Next, let's create a quick script to load some hashed and salted
+passwords into the C<password> column of our C<users> table. Open the
+file C<set_hashed_passwords.pl> in your editor and enter the following
+text:
#!/usr/bin/perl
2|test02|{SSHA}FpGhpCJus+Ea9ne4ww8404HH+hJKW/fW+bAv1v6FuRUy2G7I2aoTRQ==|t02@na.com|Jane|Doe|1
3|test03|{SSHA}ZyGlpiHls8qFBSbHr3r5t/iqcZE602XLMbkSVRRNl6rF8imv1abQVg==|t03@na.com|No|Go|0
-As you can see, the passwords are much harder to steal from the
-database (not only are the hashes stored, but every hash is different
-even though the passwords are the same because of the added "salt"
-value). Also note that this demonstrates how to use a DBIx::Class
-model outside of your web application -- a very useful feature in many
-situations.
+As you can see, the passwords are much harder to steal from the database
+(not only are the hashes stored, but every hash is different even though
+the passwords are the same because of the added "salt" value). Also
+note that this demonstrates how to use a DBIx::Class model outside of
+your web application -- a very useful feature in many situations.
=head2 Enable Hashed and Salted Passwords
-Edit C<lib/MyApp.pm> and update it to match the following text (the
-only change is to the C<password_type> field):
+Edit C<lib/MyApp.pm> and update it to match the following text (the only
+change is to the C<password_type> field):
# Configure SimpleDB Authentication
__PACKAGE__->config(
As discussed in the previous chapter of the tutorial, C<flash> allows
you to set variables in a way that is very similar to C<stash>, but it
-will remain set across multiple requests. Once the value is read, it
-is cleared (unless reset). Although C<flash> has nothing to do with
+will remain set across multiple requests. Once the value is read, it is
+cleared (unless reset). Although C<flash> has nothing to do with
authentication, it does leverage the same session plugins. Now that
those plugins are enabled, let's go back and update the "delete and
-redirect with query parameters" code seen at the end of the L<Basic
-CRUD|Catalyst::Manual::Tutorial::04_BasicCRUD> chapter of the tutorial to
-take advantage of C<flash>.
+redirect with query parameters" code seen at the end of the
+L<Basic CRUD|Catalyst::Manual::Tutorial::04_BasicCRUD> chapter of the
+tutorial to take advantage of C<flash>.
-First, open C<lib/MyApp/Controller/Books.pm> and modify C<sub delete>
-to match the following (everything after the model search line of code
-has changed):
+First, open C<lib/MyApp/Controller/Books.pm> and modify C<sub delete> to
+match the following (everything after the model search line of code has
+changed):
=head2 delete
</div><!-- end content -->
...
-Although the sample above only shows the C<content> div, leave the
-rest of the file intact -- the only change we made to replace
-"|| c.request.params.status_msg" with "c.flash.status_msg" in the
-C<< <span class="message"> >> line.
+Although the sample above only shows the C<content> div, leave the rest
+of the file intact -- the only change we made to replace "||
+c.request.params.status_msg" with "c.flash.status_msg" in the
+C<E<lt>span class="message"E<gt>> line.
=head2 Try Out Flash
B<NOTE:> While C<flash> will save information across multiple requests,
I<it does get cleared the first time it is read>. In general, this is
-exactly what you want -- the C<flash> message will get displayed on
-the next screen where it's appropriate, but it won't "keep showing up"
-after that first time (unless you reset it). Please refer to
-L<Catalyst::Plugin::Session> for additional
-information.
+exactly what you want -- the C<flash> message will get displayed on the
+next screen where it's appropriate, but it won't "keep showing up" after
+that first time (unless you reset it). Please refer to
+L<Catalyst::Plugin::Session> for additional information.
=head2 Switch To Flash-To-Stash
-Although the a use of flash above works well, the
+Although the use of flash above works well, the
C<status_msg || c.flash.status_msg> statement is a little ugly. A nice
alternative is to use the C<flash_to_stash> feature that automatically
-copies the content of flash to stash. This makes your controller
-and template code work regardless of where it was directly access, a
-forward, or a redirect. To enable C<flash_to_stash>, you can either
-set the value in C<lib/MyApp.pm> by changing the default
+copies the content of flash to stash. This makes your controller and
+template code work regardless of where it was directly access, a
+forward, or a redirect. To enable C<flash_to_stash>, you can either set
+the value in C<lib/MyApp.pm> by changing the default
C<__PACKAGE__-E<gt>config> setting to something like:
__PACKAGE__->config(
flash_to_stash 1
</Plugin::Session>
-The C<__PACKAGE__-E<gt>config> option is probably preferable here
-since it's not something you will want to change at runtime without it
+The C<__PACKAGE__-E<gt>config> option is probably preferable here since
+it's not something you will want to change at runtime without it
possibly breaking some of your code.
-Then edit C<root/src/wrapper.tt2> and change the C<status_msg> line
-to match the following:
+Then edit C<root/src/wrapper.tt2> and change the C<status_msg> line to
+match the following:
<span class="message">[% status_msg %]</span>
projects / catagits/Catalyst-Manual.git / commitdiff