Switch from 'sub base :Path :Args(0)' to 'sub index : Private' for
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Manual / Tutorial / Authentication.pod
CommitLineData
4d583dd8 1=head1 NAME
2
64ccd8a8 3Catalyst::Manual::Tutorial::Authentication - Catalyst Tutorial - Part 4: Authentication
4d583dd8 4
5
4d583dd8 6=head1 OVERVIEW
7
8This is B<Part 4 of 9> for the Catalyst tutorial.
9
64ccd8a8 10L<Tutorial Overview|Catalyst::Manual::Tutorial>
4d583dd8 11
12=over 4
13
14=item 1
15
16L<Introduction|Catalyst::Manual::Tutorial::Intro>
17
18=item 2
19
20L<Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics>
21
22=item 3
23
64ccd8a8 24L<Basic CRUD|Catalyst::Manual::Tutorial_BasicCRUD>
4d583dd8 25
26=item 4
27
28B<Authentication>
29
30=item 5
31
32L<Authorization|Catalyst::Manual::Tutorial::Authorization>
33
34=item 6
35
36L<Debugging|Catalyst::Manual::Tutorial::Debugging>
37
38=item 7
39
40L<Testing|Catalyst::Manual::Tutorial::Testing>
41
42=item 8
43
44L<AdvancedCRUD|Catalyst::Manual::Tutorial::AdvancedCRUD>
45
46=item 9
47
71dedf57 48L<Appendices|Catalyst::Manual::Tutorial::Appendicies>
4d583dd8 49
50=back
51
52
4d583dd8 53=head1 DESCRIPTION
54
64ccd8a8 55Now that we finally have a simple yet functional application, we can
71dedf57 56focus on providing authentication (with authorization coming next in
57Part 5).
4d583dd8 58
64ccd8a8 59This part of the tutorial is divided into two main sections: 1) basic,
60cleartext authentication and 2) hash-based authentication.
4d583dd8 61
64ccd8a8 62B<TIP>: Note that all of the code for this part of the tutorial can be
63pulled from the Catalyst Subversion repository in one step with the
64following command:
4d583dd8 65
66 svn checkout http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial@###
67 IMPORTANT: Does not work yet. Will be completed for final version.
68
69
4d583dd8 70=head1 BASIC AUTHENTICATION
71
71dedf57 72This section explores how to add authentication logic to a Catalyst
73application.
4d583dd8 74
a63e6e67 75
4d583dd8 76=head2 Add Users and Roles to the Database
77
71dedf57 78First, we add both user and role information to the database (we will
79add the role information here although it will not be used until the
64ccd8a8 80authorization section, Part 5). Create a new SQL script file by opening
81C<myapp02.sql> in your editor and insert:
4d583dd8 82
83 --
84 -- Add users and roles tables, along with a many-to-many join table
85 --
86 CREATE TABLE users (
87 id INTEGER PRIMARY KEY,
88 username TEXT,
89 password TEXT,
90 email_address TEXT,
91 first_name TEXT,
92 last_name TEXT,
93 active INTEGER
94 );
95 CREATE TABLE roles (
96 id INTEGER PRIMARY KEY,
97 role TEXT
98 );
99 CREATE TABLE user_roles (
100 user_id INTEGER,
101 role_id INTEGER,
102 PRIMARY KEY (user_id, role_id)
103 );
104 --
105 -- Load up some initial test data
106 --
107 INSERT INTO users VALUES (1, 'test01', 'mypass', 't01@na.com', 'Joe', 'Blow', 1);
108 INSERT INTO users VALUES (2, 'test02', 'mypass', 't02@na.com', 'Jane', 'Doe', 1);
109 INSERT INTO users VALUES (3, 'test03', 'mypass', 't03@na.com', 'No', 'Go', 0);
110 INSERT INTO roles VALUES (1, 'user');
111 INSERT INTO roles VALUES (2, 'admin');
112 INSERT INTO user_roles VALUES (1, 1);
113 INSERT INTO user_roles VALUES (1, 2);
114 INSERT INTO user_roles VALUES (2, 1);
115 INSERT INTO user_roles VALUES (3, 1);
116
117Then load this into the C<myapp.db> database with the following command:
118
119 $ sqlite3 myapp.db < myapp02.sql
120
121
71dedf57 122=head2 Add User and Role Information to DBIC Schema
4d583dd8 123
64ccd8a8 124This step adds DBIC-based classes for the user-related database tables
71dedf57 125(the role information will not be used until Part 5):
4d583dd8 126
64ccd8a8 127Edit C<lib/MyAppDB.pm> and update the contents to match (only the
128C<MyAppDB =E<gt> [qw/Book BookAuthor Author User UserRole Role/]> line
129has changed):
4d583dd8 130
131 package MyAppDB;
132
133 =head1 NAME
134
135 MyAppDB -- DBIC Schema Class
136
137 =cut
138
139 # Our schema needs to inherit from 'DBIx::Class::Schema'
140 use base qw/DBIx::Class::Schema/;
141
142 # Need to load the DB Model classes here.
143 # You can use this syntax if you want:
144 # __PACKAGE__->load_classes(qw/Book BookAuthor Author User UserRole Role/);
145 # Also, if you simply want to load all of the classes in a directory
146 # of the same name as your schema class (as we do here) you can use:
147 # __PACKAGE__->load_classes(qw//);
148 # But the variation below is more flexible in that it can be used to
149 # load from multiple namespaces.
150 __PACKAGE__->load_classes({
151 MyAppDB => [qw/Book BookAuthor Author User UserRole Role/]
152 });
153
154 1;
155
156
157=head2 Create New "Result Source Objects"
158
159Create the following three files with the content shown below.
160
161C<lib/MyAppDB/User.pm>:
162
163 package MyAppDB::User;
164
165 use base qw/DBIx::Class/;
166
167 # Load required DBIC stuff
168 __PACKAGE__->load_components(qw/PK::Auto Core/);
169 # Set the table name
170 __PACKAGE__->table('users');
171 # Set columns in table
172 __PACKAGE__->add_columns(qw/id username password email_address first_name last_name/);
173 # Set the primary key for the table
174 __PACKAGE__->set_primary_key('id');
175
176 #
177 # Set relationships:
178 #
179
180 # has_many():
181 # args:
182 # 1) Name of relationship, DBIC will create accessor with this name
183 # 2) Name of the model class referenced by this relationship
184 # 3) Column name in *foreign* table
185 __PACKAGE__->has_many(map_user_role => 'MyAppDB::UserRole', 'user_id');
186
187
188 =head1 NAME
189
190 MyAppDB::User - A model object representing a person with access to the system.
191
192 =head1 DESCRIPTION
193
194 This is an object that represents a row in the 'users' table of your application
195 database. It uses DBIx::Class (aka, DBIC) to do ORM.
196
197 For Catalyst, this is designed to be used through MyApp::Model::MyAppDB.
198 Offline utilities may wish to use this class directly.
199
200 =cut
201
202 1;
203
204
205C<lib/MyAppDB/Role.pm>:
206
207 package MyAppDB::Role;
208
209 use base qw/DBIx::Class/;
210
211 # Load required DBIC stuff
212 __PACKAGE__->load_components(qw/PK::Auto Core/);
213 # Set the table name
214 __PACKAGE__->table('roles');
215 # Set columns in table
216 __PACKAGE__->add_columns(qw/id role/);
217 # Set the primary key for the table
218 __PACKAGE__->set_primary_key('id');
219
220 #
221 # Set relationships:
222 #
223
224 # has_many():
225 # args:
226 # 1) Name of relationship, DBIC will create accessor with this name
227 # 2) Name of the model class referenced by this relationship
228 # 3) Column name in *foreign* table
229 __PACKAGE__->has_many(map_user_role => 'MyAppDB::UserRole', 'role_id');
230
231
232 =head1 NAME
233
234 MyAppDB::Role - A model object representing a class of access permissions to
235 the system.
236
237 =head1 DESCRIPTION
238
239 This is an object that represents a row in the 'roles' table of your
240 application database. It uses DBIx::Class (aka, DBIC) to do ORM.
241
242 For Catalyst, this is designed to be used through MyApp::Model::MyAppDB.
243 "Offline" utilities may wish to use this class directly.
244
245 =cut
246
247 1;
248
249
250C<lib/MyAppDB/UserRole.pm>:
251
252 package MyAppDB::UserRole;
253
254 use base qw/DBIx::Class/;
255
256 # Load required DBIC stuff
257 __PACKAGE__->load_components(qw/PK::Auto Core/);
258 # Set the table name
259 __PACKAGE__->table('user_roles');
260 # Set columns in table
261 __PACKAGE__->add_columns(qw/user_id role_id/);
262 # Set the primary key for the table
263 __PACKAGE__->set_primary_key(qw/user_id role_id/);
264
265 #
266 # Set relationships:
267 #
268
269 # belongs_to():
270 # args:
271 # 1) Name of relationship, DBIC will create accessor with this name
272 # 2) Name of the model class referenced by this relationship
273 # 3) Column name in *this* table
274 __PACKAGE__->belongs_to(user => 'MyAppDB::User', 'user_id');
275
276 # belongs_to():
277 # args:
278 # 1) Name of relationship, DBIC will create accessor with this name
279 # 2) Name of the model class referenced by this relationship
280 # 3) Column name in *this* table
281 __PACKAGE__->belongs_to(role => 'MyAppDB::Role', 'role_id');
282
283
284 =head1 NAME
285
286 MyAppDB::UserRole - A model object representing the JOIN between Users and Roles.
287
288 =head1 DESCRIPTION
289
290 This is an object that represents a row in the 'user_roles' table of your application
291 database. It uses DBIx::Class (aka, DBIC) to do ORM.
292
293 You probably won't need to use this class directly -- it will be automatically
294 used by DBIC where joins are needed.
295
296 For Catalyst, this is designed to be used through MyApp::Model::MyAppDB.
297 Offline utilities may wish to use this class directly.
298
299 =cut
300
301 1;
302
303The code for these three result source classes is obviously very familiar to the C<Book>, C<Author>, and C<BookAuthor> classes created in Part 2.
304
305
306=head2 Sanity-Check Reload of Development Server
307
308We aren't ready to try out the authentication just yet; we only want to do a quick check to be sure our model loads correctly. Press C<Ctrl-C> to kill the previous server instance (if it's still running) and restart it:
309
310 $ script/myapp_server.pl
311
312Look for the three new model objects in the startup debug output:
313
314 ...
315 .-------------------------------------------------------------------+----------.
316 | Class | Type |
317 +-------------------------------------------------------------------+----------+
318 | MyApp::Controller::Books | instance |
319 | MyApp::Controller::Root | instance |
320 | MyApp::Model::MyAppDB | instance |
321 | MyApp::Model::MyAppDB::Author | class |
322 | MyApp::Model::MyAppDB::Book | class |
323 | MyApp::Model::MyAppDB::BookAuthor | class |
324 | MyApp::Model::MyAppDB::Role | class |
325 | MyApp::Model::MyAppDB::User | class |
326 | MyApp::Model::MyAppDB::UserRole | class |
327 | MyApp::View::TT | instance |
328 '-------------------------------------------------------------------+----------'
329 ...
330
331Again, notice that your "result source" classes have been "re-loaded" by Catalyst under C<MyApp::Model>.
332
333
334=head2 Include Authentication and Session Plugins
335
33aee7ed 336Edit C<lib/MyApp.pm> and update it as follows (everything below C<StackTrace> is new):
4d583dd8 337
338 use Catalyst qw/
339 -Debug
340 ConfigLoader
341 Static::Simple
342
4d583dd8 343 StackTrace
4d583dd8 344
345 Authentication
346 Authentication::Store::DBIC
347 Authentication::Credential::Password
348
349 Session
350 Session::Store::FastMmap
351 Session::State::Cookie
352 /;
353
64ccd8a8 354The three C<Authentication> plugins work together to support
355Authentication while the C<Session> plugins are required to maintain
356state across multiple HTTP requests. Note that there are several
a63e6e67 357options for L<Session::Store|Catalyst::Plugin::Session::Store>
358(L<Session::Store::FastMmap|Catalyst::Plugin::Session::Store::FastMmap>
64ccd8a8 359is generally a good choice if you are on Unix; try
360L<Cache::FileCache|Catalyst::Plugin::Cache::FileCache> if you are on
361Win32) -- consult L<Session::Store|Catalyst::Plugin::Session::Store> and
362its subclasses for additional information.
4d583dd8 363
a63e6e67 364
4d583dd8 365=head2 Configure Authentication
366
64ccd8a8 367Although C<__PACKAGE__-E<gt>config(name =E<gt> 'value');> is still
368supported, newer Catalyst applications tend to place all configuration
369information in C<myapp.yml> and automatically load this information into
a63e6e67 370C<MyApp-E<gt>config> using the
371L<ConfigLoader|Catalyst::Plugin::ConfigLoader> plugin. Here, we need
372to load several parameters that tell
373L<Catalyst::Plugin::Authentication|Catalyst::Plugin::Authentication>
374where to locate information in your database. To do this, edit the
375C<myapp.yml> YAML and update it to match:
4d583dd8 376
377 ---
378 name: MyApp
379 authentication:
380 dbic:
381 # Note this first definition would be the same as setting
382 # __PACKAGE__->config->{authentication}->{dbic}->{user_class} = 'MyAppDB::User'
383 # in lib/MyApp.pm (IOW, each hash key becomes a "name:" in the YAML file).
384 #
385 # This is the model object created by Catalyst::Model::DBIC from your
386 # schema (you created 'MyAppDB::User' but as the Catalyst startup
387 # debug messages show, it was loaded as 'MyApp::Model::MyAppDB::User').
a63e6e67 388 # NOTE: Omit 'MyApp::Model' to avoid a component lookup issue in Catalyst 5.66
4d583dd8 389 user_class: MyAppDB::User
390 # This is the name of the field in your 'users' table that contains the user's name
391 user_field: username
392 # This is the name of the field in your 'users' table that contains the password
393 password_field: password
394 # Other options can go here for hashed passwords
395
396Inline comments in the code above explain how each field is being used.
397
64ccd8a8 398B<TIP>: Although YAML uses a very simple and easy-to-ready format, it
399does require the use of a consistent level of indenting. Be sure you
400line up everything on a given 'level' with the same number of indents.
401Also, be sure not to use C<tab> characters (YAML does not support them
402because they are handled inconsistently across editors).
4d583dd8 403
a63e6e67 404
4d583dd8 405=head2 Add Login and Logout Controllers
406
407Use the Catalyst create script to create two stub controller files:
408
409 $ script/myapp_create.pl controller Login
410 $ script/myapp_create.pl controller Logout
411
64ccd8a8 412B<NOTE>: You could easily use a single controller here. For example,
413you could have a C<User> controller with both C<login> and C<logout>
414actions. Remember, Catalyst is designed to be very flexible, and leaves
415such matters up to you, the designer and programmer.
4d583dd8 416
be16bacd 417Then open C<lib/MyApp/Controller/Login.pm>, locate the C<sub index :
418Private> method (this was automatically inserted by the helpers when we
419created the Login controller above), and delete this line:
420
421 $c->response->body('Matched MyApp::Controller::Login in Login.');
422
423Then update it to match:
4d583dd8 424
7e5eb02c 425 =head2 base
4d583dd8 426
427 Login logic
428
429 =cut
430
be16bacd 431 sub index : Private {
4d583dd8 432 my ($self, $c) = @_;
433
434 # Get the username and password from form
435 my $username = $c->request->params->{username} || "";
436 my $password = $c->request->params->{password} || "";
437
438 # If the username and password values were found in form
439 if ($username && $password) {
440 # Attempt to log the user in
441 if ($c->login($username, $password)) {
442 # If successful, then let them use the application
443 $c->response->redirect($c->uri_for('/books/list'));
444 return;
445 } else {
446 # Set an error message
447 $c->stash->{error_msg} = "Bad username or password.";
448 }
449 }
450
451 # If either of above don't work out, send to the login page
452 $c->stash->{template} = 'login.tt2';
453 }
454
64ccd8a8 455This controller fetches the C<username> and C<password> values from the
456login form and attempts to perform a login. If successful, it redirects
457the user to the book list page. If the login fails, the user will stay
458at the login page but receive an error message. If the C<username> and
459C<password> values are not present in the form, the user will be taken
460to the empty login form.
4d583dd8 461
7e5eb02c 462Note that we could have used something like C<sub default :Private>;
463however, the use of C<default> actions is discouraged because it does
464not receive path args as with other actions. The recommended practice
465is to only use C<default> in C<MyApp::Controller::Root>.
466
be16bacd 467Another options would be to use something like
468C<sub base :Path :Args(0) {...}> (where the C<...> refers to the login
469code shown in C<sub index : Private> above). We are using C<sub base
470:Path :Args(0) {...}> here to specifically match the URL C</login>.
471C<Path> actions (aka, "literal actions") create URI matches relative to
472the namespace of the controller where they are defined. Although
473C<Path> supports arguments that allow relative and absolute paths to be
474defined, here we use an empty C<Path> definition to match on just the
475name of the controller itself. The method name, C<base>, is arbitrary.
476We make the match even more specific with the C<:Args(0)> action
477modifier -- this forces the match on I<only> C</login>, not
478C</login/somethingelse>.
479
4d583dd8 480Next, create a corresponding method in C<lib/MyApp/Controller/Logout.pm>:
481
7e5eb02c 482 =head2 base
4d583dd8 483
484 Logout logic
485
486 =cut
487
be16bacd 488 sub index : Private {
4d583dd8 489 my ($self, $c) = @_;
490
491 # Clear the user's state
492 $c->logout;
493
71dedf57 494 # Send the user to the starting point
4d583dd8 495 $c->response->redirect($c->uri_for('/'));
496 }
497
be16bacd 498As with the login controller, be sure to delete the
499C<$c->response->body('Matched MyApp::Controller::Logout in Logout.');>
500line of the C<sub index>.
7e5eb02c 501
4d583dd8 502
503=head2 Add a Login Form TT Template Page
504
505Create a login form by opening C<root/src/login.tt2> and inserting:
506
507 [% META title = 'Login' %]
508
509 <!-- Login form -->
510 <form method="post" action=" [% Catalyst.uri_for('/login') %] ">
511 <table>
512 <tr>
513 <td>Username:</td>
514 <td><input type="text" name="username" size="40" /></td>
515 </tr>
516 <tr>
517 <td>Password:</td>
518 <td><input type="password" name="password" size="40" /></td>
519 </tr>
520 <tr>
521 <td colspan="2"><input type="submit" name="submit" value="Submit" /></td>
522 </tr>
523 </table>
524 </form>
525
526
527=head2 Add Valid User Check
528
64ccd8a8 529We need something that provides enforcement for the authentication
530mechanism -- a I<global> mechanism that prevents users who have not
531passed authentication from reaching any pages except the login page.
532This is generally done via an C<auto> action/method (prior to Catalyst
533v5.66, this sort of thing would go in C<MyApp.pm>, but starting in
534v5.66, the preferred location is C<lib/MyApp/Controller/Root.pm>).
4d583dd8 535
71dedf57 536Edit the existing C<lib/MyApp/Controller/Root.pm> class file and insert
537the following method:
4d583dd8 538
539 =head2 auto
540
541 Check if there is a user and, if not, forward to login page
542
543 =cut
544
545 # Note that 'auto' runs after 'begin' but before your actions and that
546 # 'auto' "chain" (all from application path to most specific class are run)
547 sub auto : Private {
548 my ($self, $c) = @_;
549
550 # Allow unauthenticated users to reach the login page
551 if ($c->request->path =~ /login/) {
552 return 1;
553 }
554
555 # If a user doesn't exist, force login
556 if (!$c->user_exists) {
557 # Dump a log message to the development server debug output
558 $c->log->debug('***Root::auto User not found, forwarding to /login');
559 # Redirect the user to the login page
560 $c->response->redirect($c->uri_for('/login'));
561 # Return 0 to cancel 'post-auto' processing and prevent use of application
562 return 0;
563 }
564
565 # User found, so return 1 to continue with processing after this 'auto'
566 return 1;
567 }
568
64ccd8a8 569B<Note:> Catalyst provides a number of different types of actions, such
570as C<Local>, C<Regex>, and C<Private>. You should refer to
71dedf57 571L<Catalyst::Manual::Intro> for a more detailed explanation, but the
572following bullet points provide a quick introduction:
4d583dd8 573
574=over 4
575
576=item *
577
64ccd8a8 578The majority of application use C<Local> actions for items that respond
579to user requests and C<Private> actions for those that do not directly
580respond to user input.
4d583dd8 581
582=item *
583
64ccd8a8 584There are five types of C<Private> actions: C<begin>, C<end>,
585C<default>, C<index>, and C<auto>.
4d583dd8 586
587=item *
588
a63e6e67 589Unlike the other actions where only a single method is called for each
590request, I<every> auto action along the chain of namespaces will be
591called.
4d583dd8 592
593=back
594
64ccd8a8 595By placing the authentication enforcement code inside the C<auto> method
596of C<lib/MyApp/Controller/Root.pm> (or C<lib/MyApp.pm>), it will be
597called for I<every> request that is received by the entire application.
4d583dd8 598
a63e6e67 599
4d583dd8 600=head2 Displaying Content Only to Authenticated Users
601
64ccd8a8 602Let's say you want to provide some information on the login page that
603changes depending on whether the user has authenticated yet. To do
604this, open C<root/src/login.tt2> in your editor and add the following
605lines to the bottom of the file:
4d583dd8 606
607 <p>
608 [%
609 # This code illustrates how certain parts of the TT
610 # template will only be shown to users who have logged in
611 %]
612 [% IF Catalyst.user %]
613 Please Note: You are already logged in as '[% Catalyst.user.username %]'.
614 You can <a href="[% Catalyst.uri_for('/logout') %]">logout</a> here.
615 [% ELSE %]
616 You need to log in to use this application.
617 [% END %]
618 [%#
619 Note that this whole block is a comment because the "#" appears
620 immediate after the "[%" (with no spaces in between). Although it
621 can be a handy way to temporarily "comment out" a whole block of
622 TT code, it's probably a little too subtle for use in "normal"
623 comments.
624 %]
625
64ccd8a8 626Although most of the code is comments, the middle few lines provide a
627"you are already logged in" reminder if the user returns to the login
628page after they have already authenticated. For users who have not yet
629authenticated, a "You need to log in..." message is displayed (note the
630use of an IF-THEN-ELSE construct in TT).
4d583dd8 631
632
633=head2 Try Out Authentication
634
64ccd8a8 635Press C<Ctrl-C> to kill the previous server instance (if it's still
636running) and restart it:
4d583dd8 637
638 $ script/myapp_server.pl
639
64ccd8a8 640B<IMPORTANT NOTE>: If you happen to be using Internet Explorer, you may
641need to use the command C<script/myapp_server.pl -k> to enable the
642keepalive feature in the development server. Otherwise, the HTTP
643redirect on successful login may not work correctly with IE (it seems to
644work without -k if you are running the web browser and development
645server on the same machine). If you are using browser a browser other
646than IE, it should work either way. If you want to make keepalive the
647default, you can edit C<script/myapp_server.pl> and change the
648initialization value for C<$keepalive> to C<1>. (You will need to do
649this every time you create a new Catalyst application or rebuild the
650C<myapp_server.pl> script.)
651
652Now trying going to L<http://localhost:3000/books/list> and you should
653be redirected to the login page, hitting Shift+Reload if necessary (the
654"You are already logged in" message should I<not> appear -- if it does,
71dedf57 655click the C<logout> button and try again). Note the C<***Root::auto User
656not found...> debug message in the development server output. Enter
657username C<test01> and password C<mypass>, and you should be taken to
658the Book List page.
4d583dd8 659
71dedf57 660Open C<root/src/books/list.tt2> and add the following lines to the
661bottom:
4d583dd8 662
663 <p>
664 <a href="[% Catalyst.uri_for('/login') %]">Login</a>
665 <a href="[% Catalyst.uri_for('form_create') %]">Create</a>
666 </p>
667
be16bacd 668Reload your browser and you should now see a "Login" and "Create" links
669at the bottom of the page (as mentioned earlier, you can update template
670files without reloading the development server). Click the first link
671to return to the login page. This time you I<should> see the "You are
672already logged in" message.
4d583dd8 673
64ccd8a8 674Finally, click the C<You can logout here> link on the C</login> page.
675You should stay at the login page, but the message should change to "You
676need to log in to use this application."
4d583dd8 677
678
4d583dd8 679=head1 USING PASSWORD HASHES
680
64ccd8a8 681In this section we increase the security of our system by converting
682from cleartext passwords to SHA-1 password hashes.
4d583dd8 683
64ccd8a8 684B<Note:> This section is optional. You can skip it and the rest of the
685tutorial will function normally.
4d583dd8 686
64ccd8a8 687Note that even with the techniques shown in this section, the browser
688still transmits the passwords in cleartext to your application. We are
689just avoiding the I<storage> of cleartext passwords in the database by
71dedf57 690using a SHA-1 hash. If you are concerned about cleartext passwords
691between the browser and your application, consider using SSL/TLS, made
a63e6e67 692easy with the Catalyst plugin
693L<Catalyst::Plugin:RequireSSL|Catalyst::Plugin:RequireSSL>.
694
4d583dd8 695
696=head2 Get a SHA-1 Hash for the Password
697
64ccd8a8 698Catalyst uses the C<Digest> module to support a variety of hashing
699algorithms. Here we will use SHA-1 (SHA = Secure Hash Algorithm).
700First, we should compute the SHA-1 hash for the "mypass" password we are
701using. The following command-line Perl script provides a "quick and
702dirty" way to do this:
4d583dd8 703
704 $ perl -MDigest::SHA -e 'print Digest::SHA::sha1_hex("mypass"), "\n"'
705 e727d1464ae12436e899a726da5b2f11d8381b26
706 $
707
cc548726 708B<Note:> You should probably modify this code for production use to
709not read the password from the command line. By having the script
710prompt for the cleartext password, it avoids having the password linger
711in forms such as your C<.bash_history> files (assuming you are using
712BASH as your shell). An example of such a script can be found in
713Appendix 3.
714
a63e6e67 715
4d583dd8 716=head2 Switch to SHA-1 Password Hashes in the Database
717
64ccd8a8 718Next, we need to change the C<password> column of our C<users> table to
719store this hash value vs. the existing cleartext password. Open
720C<myapp03.sql> in your editor and enter:
4d583dd8 721
722 --
723 -- Convert passwords to SHA-1 hashes
724 --
725 UPDATE users SET password = 'e727d1464ae12436e899a726da5b2f11d8381b26' WHERE id = 1;
726 UPDATE users SET password = 'e727d1464ae12436e899a726da5b2f11d8381b26' WHERE id = 2;
727 UPDATE users SET password = 'e727d1464ae12436e899a726da5b2f11d8381b26' WHERE id = 3;
728
729Then use the following command to update the SQLite database:
730
731 $ sqlite3 myapp.db < myapp03.sql
732
64ccd8a8 733B<Note:> We are using SHA-1 hashes here, but many other hashing
734algorithms are supported. See C<Digest> for more information.
4d583dd8 735
a63e6e67 736
64ccd8a8 737=head2 Enable SHA-1 Hash Passwords in
738C<Catalyst::Plugin::Authentication::Store::DBIC>
4d583dd8 739
64ccd8a8 740Edit C<myapp.yml> and update it to match (the C<password_type> and
741C<password_hash_type> are new, everything else is the same):
4d583dd8 742
743 ---
744 name: MyApp
745 authentication:
746 dbic:
747 # Note this first definition would be the same as setting
748 # __PACKAGE__->config->{authentication}->{dbic}->{user_class} = 'MyAppDB::User'
749 # in lib/MyApp.pm (IOW, each hash key becomes a "name:" in the YAML file).
750 #
751 # This is the model object created by Catalyst::Model::DBIC from your
752 # schema (you created 'MyAppDB::User' but as the Catalyst startup
753 # debug messages show, it was loaded as 'MyApp::Model::MyAppDB::User').
a63e6e67 754 # NOTE: Omit 'MyApp::Model' to avoid a component lookup issue in Catalyst 5.66
4d583dd8 755 user_class: MyAppDB::User
756 # This is the name of the field in your 'users' table that contains the user's name
757 user_field: username
758 # This is the name of the field in your 'users' table that contains the password
759 password_field: password
760 # Other options can go here for hashed passwords
761 # Enabled hashed passwords
762 password_type: hashed
763 # Use the SHA-1 hashing algorithm
764 password_hash_type: SHA-1
765
766
767=head2 Try Out the Hashed Passwords
768
64ccd8a8 769Press C<Ctrl-C> to kill the previous server instance (if it's still
770running) and restart it:
4d583dd8 771
772 $ script/myapp_server.pl
773
64ccd8a8 774You should now be able to go to L<http://localhost:3000/books/list> and
775login as before. When done, click the "Logout" link on the login page
776(or point your browser at L<http://localhost:3000/logout>).
4d583dd8 777
be16bacd 778B<Note:> If you receive the debug screen in your browser with a
779C<Can't call method "stash" on an undefined value...> error message,
780make sure that you are using v0.07 of
781L<Catalyst::Plugin::Authorization::ACL|Catalyst::Plugin::Authorization::ACL>.
782The following command can be a useful way to quickly dump the version number
783of this module on your system:
784
785 perl -MCatalyst::Plugin::Authorization::ACL -e 'print $Catalyst::Plugin::Authorization::ACL::VERSION, "\n";'
786
a63e6e67 787
4d583dd8 788=head1 AUTHOR
789
790Kennedy Clark, C<hkclark@gmail.com>
791
eed93301 792Please report any errors, issues or suggestions to the author. The
793most recent version of the Catlayst Tutorial can be found at
794L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst-Runtime/lib/Catalyst/Manual/Tutorial/>.
4d583dd8 795
a63e6e67 796Copyright 2006, Kennedy Clark, under Creative Commons License
797(L<http://creativecommons.org/licenses/by-nc-sa/2.5/>).