Commit | Line | Data |
d442cc9f |
1 | =head1 NAME |
2 | |
3533daff |
3 | Catalyst::Manual::Tutorial::Authentication - Catalyst Tutorial - Part 5: Authentication |
d442cc9f |
4 | |
5 | |
6 | =head1 OVERVIEW |
7 | |
3533daff |
8 | This is B<Part 5 of 10> for the Catalyst tutorial. |
d442cc9f |
9 | |
10 | L<Tutorial Overview|Catalyst::Manual::Tutorial> |
11 | |
12 | =over 4 |
13 | |
14 | =item 1 |
15 | |
16 | L<Introduction|Catalyst::Manual::Tutorial::Intro> |
17 | |
18 | =item 2 |
19 | |
20 | L<Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics> |
21 | |
22 | =item 3 |
23 | |
3533daff |
24 | L<More Catalyst Basics|Catalyst::Manual::Tutorial::MoreCatalystBasics> |
d442cc9f |
25 | |
26 | =item 4 |
27 | |
3533daff |
28 | L<Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD> |
d442cc9f |
29 | |
30 | =item 5 |
31 | |
3533daff |
32 | B<Authentication> |
d442cc9f |
33 | |
34 | =item 6 |
35 | |
3533daff |
36 | L<Authorization|Catalyst::Manual::Tutorial::Authorization> |
d442cc9f |
37 | |
38 | =item 7 |
39 | |
3533daff |
40 | L<Debugging|Catalyst::Manual::Tutorial::Debugging> |
d442cc9f |
41 | |
42 | =item 8 |
43 | |
3533daff |
44 | L<Testing|Catalyst::Manual::Tutorial::Testing> |
d442cc9f |
45 | |
46 | =item 9 |
47 | |
3533daff |
48 | L<Advanced CRUD|Catalyst::Manual::Tutorial::AdvancedCRUD> |
d442cc9f |
49 | |
3533daff |
50 | =item 10 |
d442cc9f |
51 | |
3533daff |
52 | L<Appendices|Catalyst::Manual::Tutorial::Appendices> |
d442cc9f |
53 | |
3533daff |
54 | =back |
2d0526d1 |
55 | |
2d0526d1 |
56 | |
d442cc9f |
57 | =head1 DESCRIPTION |
58 | |
905a3a26 |
59 | Now that we finally have a simple yet functional application, we can |
60 | focus on providing authentication (with authorization coming next in |
9ad715b3 |
61 | Part 6). |
d442cc9f |
62 | |
63 | This part of the tutorial is divided into two main sections: 1) basic, |
64 | cleartext authentication and 2) hash-based authentication. |
65 | |
66 | You can checkout the source code for this example from the catalyst |
67 | subversion repository as per the instructions in |
1390ef0e |
68 | L<Catalyst::Manual::Tutorial::Intro|Catalyst::Manual::Tutorial::Intro>. |
d442cc9f |
69 | |
fbbb9084 |
70 | |
d442cc9f |
71 | =head1 BASIC AUTHENTICATION |
72 | |
73 | This section explores how to add authentication logic to a Catalyst |
74 | application. |
75 | |
76 | |
77 | =head2 Add Users and Roles to the Database |
78 | |
79 | First, we add both user and role information to the database (we will |
80 | add the role information here although it will not be used until the |
9ad715b3 |
81 | authorization section, Part 6). Create a new SQL script file by opening |
d442cc9f |
82 | C<myapp02.sql> in your editor and insert: |
83 | |
84 | -- |
85 | -- Add users and roles tables, along with a many-to-many join table |
86 | -- |
87 | CREATE TABLE users ( |
88 | id INTEGER PRIMARY KEY, |
89 | username TEXT, |
90 | password TEXT, |
91 | email_address TEXT, |
92 | first_name TEXT, |
93 | last_name TEXT, |
94 | active INTEGER |
95 | ); |
96 | CREATE TABLE roles ( |
97 | id INTEGER PRIMARY KEY, |
98 | role TEXT |
99 | ); |
100 | CREATE TABLE user_roles ( |
101 | user_id INTEGER, |
102 | role_id INTEGER, |
103 | PRIMARY KEY (user_id, role_id) |
104 | ); |
105 | -- |
106 | -- Load up some initial test data |
107 | -- |
108 | INSERT INTO users VALUES (1, 'test01', 'mypass', 't01@na.com', 'Joe', 'Blow', 1); |
109 | INSERT INTO users VALUES (2, 'test02', 'mypass', 't02@na.com', 'Jane', 'Doe', 1); |
110 | INSERT INTO users VALUES (3, 'test03', 'mypass', 't03@na.com', 'No', 'Go', 0); |
111 | INSERT INTO roles VALUES (1, 'user'); |
112 | INSERT INTO roles VALUES (2, 'admin'); |
113 | INSERT INTO user_roles VALUES (1, 1); |
114 | INSERT INTO user_roles VALUES (1, 2); |
115 | INSERT INTO user_roles VALUES (2, 1); |
116 | INSERT INTO user_roles VALUES (3, 1); |
117 | |
118 | Then load this into the C<myapp.db> database with the following command: |
119 | |
120 | $ sqlite3 myapp.db < myapp02.sql |
121 | |
122 | |
123 | =head2 Add User and Role Information to DBIC Schema |
124 | |
3533daff |
125 | Although we could manually edit the DBIC schema information to include |
126 | the new tables added in the previous step, let's use the C<create=static> |
127 | option on the DBIC model helper to do most of the work for us: |
d442cc9f |
128 | |
acbd7bdd |
129 | $ script/myapp_create.pl model DB DBIC::Schema MyApp::Schema \ |
130 | create=static components=TimeStamp dbi:SQLite:myapp.db |
1390ef0e |
131 | exists "/root/dev/MyApp/script/../lib/MyApp/Model" |
132 | exists "/root/dev/MyApp/script/../t" |
133 | Dumping manual schema for MyApp::Schema to directory /root/dev/MyApp/script/../lib ... |
134 | Schema dump completed. |
135 | exists "/root/dev/MyApp/script/../lib/MyApp/Model/DB.pm" |
136 | $ |
acbd7bdd |
137 | $ ls lib/MyApp/Schema/Result |
3533daff |
138 | Authors.pm BookAuthors.pm Books.pm Roles.pm UserRoles.pm Users.pm |
d442cc9f |
139 | |
905a3a26 |
140 | Notice how the helper has added three new table-specific result source |
acbd7bdd |
141 | files to the C<lib/MyApp/Schema/Result> directory. And, more |
905a3a26 |
142 | importantly, even if there were changes to the existing result source |
143 | files, those changes would have only been written above the C<# DO NOT |
191dee29 |
144 | MODIFY THIS OR ANYTHING ABOVE!> comment and your hand-edited |
3533daff |
145 | enhancements would have been preserved. |
d442cc9f |
146 | |
191dee29 |
147 | Speaking of "hand-edit ted enhancements," we should now add |
905a3a26 |
148 | relationship information to the three new result source files. Edit |
149 | each of these files and add the following information between the C<# |
3533daff |
150 | DO NOT MODIFY THIS OR ANYTHING ABOVE!> comment and the closing C<1;>: |
d442cc9f |
151 | |
acbd7bdd |
152 | C<lib/MyApp/Schema/Result/Users.pm>: |
d442cc9f |
153 | |
d442cc9f |
154 | # |
155 | # Set relationships: |
156 | # |
1390ef0e |
157 | |
d442cc9f |
158 | # has_many(): |
159 | # args: |
160 | # 1) Name of relationship, DBIC will create accessor with this name |
161 | # 2) Name of the model class referenced by this relationship |
1435672d |
162 | # 3) Column name in *foreign* table (aka, foreign key in peer table) |
acbd7bdd |
163 | __PACKAGE__->has_many(map_user_role => 'MyApp::Schema::Result::UserRoles', 'user_id'); |
1390ef0e |
164 | |
3533daff |
165 | # many_to_many(): |
166 | # args: |
167 | # 1) Name of relationship, DBIC will create accessor with this name |
905a3a26 |
168 | # 2) Name of has_many() relationship this many_to_many() is shortcut for |
169 | # 3) Name of belongs_to() relationship in model class of has_many() above |
3533daff |
170 | # You must already have the has_many() defined to use a many_to_many(). |
171 | __PACKAGE__->many_to_many(roles => 'map_user_role', 'role'); |
d442cc9f |
172 | |
173 | |
acbd7bdd |
174 | C<lib/MyApp/Schema/Result/Roles.pm>: |
d442cc9f |
175 | |
d442cc9f |
176 | # |
177 | # Set relationships: |
178 | # |
1390ef0e |
179 | |
d442cc9f |
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 |
1435672d |
184 | # 3) Column name in *foreign* table (aka, foreign key in peer table) |
acbd7bdd |
185 | __PACKAGE__->has_many(map_user_role => 'MyApp::Schema::Result::UserRoles', 'role_id'); |
d442cc9f |
186 | |
187 | |
acbd7bdd |
188 | C<lib/MyApp/Schema/Result/UserRoles.pm>: |
d442cc9f |
189 | |
d442cc9f |
190 | # |
191 | # Set relationships: |
192 | # |
1390ef0e |
193 | |
d442cc9f |
194 | # belongs_to(): |
195 | # args: |
196 | # 1) Name of relationship, DBIC will create accessor with this name |
197 | # 2) Name of the model class referenced by this relationship |
198 | # 3) Column name in *this* table |
acbd7bdd |
199 | __PACKAGE__->belongs_to(user => 'MyApp::Schema::Result::Users', 'user_id'); |
1390ef0e |
200 | |
d442cc9f |
201 | # belongs_to(): |
202 | # args: |
203 | # 1) Name of relationship, DBIC will create accessor with this name |
204 | # 2) Name of the model class referenced by this relationship |
205 | # 3) Column name in *this* table |
acbd7bdd |
206 | __PACKAGE__->belongs_to(role => 'MyApp::Schema::Result::Roles', 'role_id'); |
d442cc9f |
207 | |
3533daff |
208 | |
905a3a26 |
209 | The code for these three sets of updates is obviously very similar to |
210 | the edits we made to the C<Books>, C<Authors>, and C<BookAuthors> |
3533daff |
211 | classes created in Part 3. |
212 | |
acbd7bdd |
213 | Note that we do not need to make any change to the |
214 | C<lib/MyApp/Schema.pm> schema file. It simply tells DBIC to load all |
215 | of the Result Class and ResultSet Class files it finds in below the |
216 | C<lib/MyApp/Schema> directory, so it will automatically pick up our |
217 | new table information. |
d442cc9f |
218 | |
219 | |
220 | =head2 Sanity-Check Reload of Development Server |
221 | |
905a3a26 |
222 | We aren't ready to try out the authentication just yet; we only want |
223 | to do a quick check to be sure our model loads correctly. Press |
224 | C<Ctrl-C> to kill the previous server instance (if it's still running) |
3533daff |
225 | and restart it: |
d442cc9f |
226 | |
227 | $ script/myapp_server.pl |
228 | |
229 | Look for the three new model objects in the startup debug output: |
230 | |
231 | ... |
232 | .-------------------------------------------------------------------+----------. |
233 | | Class | Type | |
234 | +-------------------------------------------------------------------+----------+ |
235 | | MyApp::Controller::Books | instance | |
236 | | MyApp::Controller::Root | instance | |
d0496197 |
237 | | MyApp::Model::DB | instance | |
238 | | MyApp::Model::DB::Author | class | |
239 | | MyApp::Model::DB::Books | class | |
240 | | MyApp::Model::DB::BookAuthors | class | |
241 | | MyApp::Model::DB::Roles | class | |
242 | | MyApp::Model::DB::Users | class | |
243 | | MyApp::Model::DB::UserRoles | class | |
d442cc9f |
244 | | MyApp::View::TT | instance | |
245 | '-------------------------------------------------------------------+----------' |
246 | ... |
247 | |
acbd7bdd |
248 | Again, notice that your "Result Class" classes have been "re-loaded" |
3533daff |
249 | by Catalyst under C<MyApp::Model>. |
d442cc9f |
250 | |
251 | |
252 | =head2 Include Authentication and Session Plugins |
253 | |
905a3a26 |
254 | Edit C<lib/MyApp.pm> and update it as follows (everything below |
3533daff |
255 | C<StackTrace> is new): |
d442cc9f |
256 | |
acbd7bdd |
257 | # Load plugins |
258 | use Catalyst qw/-Debug |
259 | ConfigLoader |
260 | Static::Simple |
261 | |
262 | StackTrace |
263 | |
264 | Authentication |
265 | |
266 | Session |
267 | Session::Store::FastMmap |
268 | Session::State::Cookie |
269 | /; |
d442cc9f |
270 | |
94d8da41 |
271 | B<Note:> As discussed in MoreCatalystBasics, different versions of |
272 | C<Catalyst::Devel> have used a variety of methods to load the plugins. |
533fee73 |
273 | You can put the plugins in the C<use Catalyst> statement if you prefer. |
94d8da41 |
274 | |
905a3a26 |
275 | The C<Authentication> plugin supports Authentication while the |
276 | C<Session> plugins are required to maintain state across multiple HTTP |
277 | requests. |
6d0971ad |
278 | |
905a3a26 |
279 | Note that the only required Authentication class is the main one. This |
280 | is a change that occurred in version 0.09999_01 of the |
281 | C<Authentication> plugin. You B<do not need> to specify a particular |
282 | Authentication::Store or Authentication::Credential plugin. Instead, |
283 | indicate the Store and Credential you want to use in your application |
6d0971ad |
284 | configuration (see below). |
285 | |
905a3a26 |
286 | Note that there are several options for |
287 | L<Session::Store|Catalyst::Plugin::Session::Store> |
288 | (L<Session::Store::FastMmap|Catalyst::Plugin::Session::Store::FastMmap> |
289 | is generally a good choice if you are on Unix; try |
290 | L<Session::Store::File|Catalyst::Plugin::Session::Store::File> if you |
291 | are on Win32) -- consult |
292 | L<Session::Store|Catalyst::Plugin::Session::Store> and its subclasses |
3533daff |
293 | for additional information and options (for example to use a database- |
294 | backed session store). |
d442cc9f |
295 | |
296 | |
297 | =head2 Configure Authentication |
298 | |
fbbb9084 |
299 | Although C<__PACKAGE__-E<gt>config(name =E<gt> 'value');> is still |
300 | supported, newer Catalyst applications tend to place all configuration |
301 | information in C<myapp.conf> and automatically load this information |
302 | into C<MyApp-E<gt>config> using the |
905a3a26 |
303 | L<ConfigLoader|Catalyst::Plugin::ConfigLoader> plugin. |
15e1d0b2 |
304 | |
fbbb9084 |
305 | As discussed in Part 3 of the tutorial, Catalyst has recently |
306 | switched from a default config file format of YAML to |
307 | L<Config::General|Config::General> (an apache-like format). In case |
308 | you are using a version of Catalyst earlier than v5.7014, delete the |
309 | C<myapp.yml>, or convert it to .conf format using the TIP in |
310 | L<Catalyst::Manual::MoreCatalystBasics/EDIT THE LIST OF CATALYST PLUGINS> |
311 | then simply follow the directions below to create a new C<myapp.conf> |
312 | file. Although we will use the C<Config::General> format here because |
313 | YAML files can be difficult to cut and paste in certain environments, |
314 | you are free to use any format supported by |
315 | L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader> and |
316 | L<Config::Any|Config::Any> -- Catalyst will transparently handle the |
317 | different formats. |
15e1d0b2 |
318 | |
905a3a26 |
319 | Here, we need to load several parameters that tell |
320 | L<Catalyst::Plugin::Authentication|Catalyst::Plugin::Authentication> |
321 | where to locate information in your database. To do this, edit the |
c010ae0d |
322 | C<myapp.conf> file and update it to match: |
323 | |
1390ef0e |
324 | # rename this file to MyApp.yml and put a : in front of "name" if |
325 | # you want to use yaml like in old versions of Catalyst |
c010ae0d |
326 | name MyApp |
327 | <authentication> |
328 | default_realm dbic |
329 | <realms> |
330 | <dbic> |
331 | <credential> |
905a3a26 |
332 | # Note: this first definition would be the same as setting |
3533daff |
333 | # __PACKAGE__->config->{authentication}->{realms}->{dbic} |
905a3a26 |
334 | # ->{credential} = 'Password' in lib/MyApp.pm |
3533daff |
335 | # |
336 | # Specify that we are going to do password-based auth |
c010ae0d |
337 | class Password |
3533daff |
338 | # This is the name of the field in the users table with the |
339 | # password stored in it |
c010ae0d |
340 | password_field password |
905a3a26 |
341 | # We are using an unencrypted password for now |
c010ae0d |
342 | password_type clear |
343 | </credential> |
344 | <store> |
3533daff |
345 | # Use DBIC to retrieve username, password & role information |
c010ae0d |
346 | class DBIx::Class |
905a3a26 |
347 | # This is the model object created by Catalyst::Model::DBIC |
acbd7bdd |
348 | # from your schema (you created 'MyApp::Schema::Result::User' |
349 | # but as the Catalyst startup debug messages show, it was |
350 | # loaded as 'MyApp::Model::DB::Users'). |
905a3a26 |
351 | # NOTE: Omit 'MyApp::Model' here just as you would when using |
d0496197 |
352 | # '$c->model("DB::Users)' |
353 | user_class DB::Users |
c010ae0d |
354 | </store> |
355 | </dbic> |
d0496197 |
356 | </realms> |
357 | </authentication> |
d442cc9f |
358 | |
359 | Inline comments in the code above explain how each field is being used. |
360 | |
1390ef0e |
361 | |
d442cc9f |
362 | =head2 Add Login and Logout Controllers |
363 | |
364 | Use the Catalyst create script to create two stub controller files: |
365 | |
366 | $ script/myapp_create.pl controller Login |
367 | $ script/myapp_create.pl controller Logout |
368 | |
fbbb9084 |
369 | You could easily use a single controller here. For example, you could |
370 | have a C<User> controller with both C<login> and C<logout> actions. |
371 | Remember, Catalyst is designed to be very flexible, and leaves such |
372 | matters up to you, the designer and programmer. |
d442cc9f |
373 | |
fbbb9084 |
374 | Then open C<lib/MyApp/Controller/Login.pm>, locate the |
375 | C<sub index :Path :Args(0)> method (or C<sub index : Private> if you |
376 | are using an older version of Catalyst) that was automatically |
377 | inserted by the helpers when we created the Login controller above, |
378 | and update the definition of C<sub index> to match: |
d442cc9f |
379 | |
380 | =head2 index |
1390ef0e |
381 | |
d442cc9f |
382 | Login logic |
1390ef0e |
383 | |
d442cc9f |
384 | =cut |
1390ef0e |
385 | |
ae492862 |
386 | sub index :Path :Args(0) { |
d442cc9f |
387 | my ($self, $c) = @_; |
1390ef0e |
388 | |
d442cc9f |
389 | # Get the username and password from form |
390 | my $username = $c->request->params->{username} || ""; |
391 | my $password = $c->request->params->{password} || ""; |
1390ef0e |
392 | |
d442cc9f |
393 | # If the username and password values were found in form |
394 | if ($username && $password) { |
395 | # Attempt to log the user in |
905a3a26 |
396 | if ($c->authenticate({ username => $username, |
5fefca35 |
397 | password => $password } )) { |
d442cc9f |
398 | # If successful, then let them use the application |
0416017e |
399 | $c->response->redirect($c->uri_for( |
400 | $c->controller('Books')->action_for('list'))); |
d442cc9f |
401 | return; |
402 | } else { |
403 | # Set an error message |
404 | $c->stash->{error_msg} = "Bad username or password."; |
405 | } |
406 | } |
1390ef0e |
407 | |
d442cc9f |
408 | # If either of above don't work out, send to the login page |
409 | $c->stash->{template} = 'login.tt2'; |
410 | } |
411 | |
412 | This controller fetches the C<username> and C<password> values from the |
905a3a26 |
413 | login form and attempts to authenticate the user. If successful, it |
414 | redirects the user to the book list page. If the login fails, the user |
415 | will stay at the login page and receive an error message. If the |
416 | C<username> and C<password> values are not present in the form, the |
f632e28b |
417 | user will be taken to the empty login form. |
d442cc9f |
418 | |
fbbb9084 |
419 | Note that we could have used something like "C<sub default :Path>", |
1390ef0e |
420 | however, it is generally recommended (partly for historical reasons, |
421 | and partly for code clarity) only to use C<default> in |
422 | C<MyApp::Controller::Root>, and then mainly to generate the 404 not |
85d49fb6 |
423 | found page for the application. |
ae492862 |
424 | |
fbbb9084 |
425 | Instead, we are using "C<sub somename :Path :Args(0) {...}>" here to |
905a3a26 |
426 | specifically match the URL C</login>. C<Path> actions (aka, "literal |
427 | actions") create URI matches relative to the namespace of the |
428 | controller where they are defined. Although C<Path> supports |
429 | arguments that allow relative and absolute paths to be defined, here |
430 | we use an empty C<Path> definition to match on just the name of the |
431 | controller itself. The method name, C<index>, is arbitrary. We make |
ae492862 |
432 | the match even more specific with the C<:Args(0)> action modifier -- |
905a3a26 |
433 | this forces the match on I<only> C</login>, not |
d442cc9f |
434 | C</login/somethingelse>. |
435 | |
905a3a26 |
436 | Next, update the corresponding method in |
3533daff |
437 | C<lib/MyApp/Controller/Logout.pm> to match: |
d442cc9f |
438 | |
439 | =head2 index |
1390ef0e |
440 | |
d442cc9f |
441 | Logout logic |
1390ef0e |
442 | |
d442cc9f |
443 | =cut |
1390ef0e |
444 | |
ae492862 |
445 | sub index :Path :Args(0) { |
d442cc9f |
446 | my ($self, $c) = @_; |
1390ef0e |
447 | |
d442cc9f |
448 | # Clear the user's state |
449 | $c->logout; |
1390ef0e |
450 | |
d442cc9f |
451 | # Send the user to the starting point |
452 | $c->response->redirect($c->uri_for('/')); |
453 | } |
454 | |
905a3a26 |
455 | As with the login controller, be sure to delete the |
14e5ed66 |
456 | C<$c-E<gt>response-E<gt>body('Matched MyApp::Controller::Logout in Logout.');> |
d442cc9f |
457 | line of the C<sub index>. |
458 | |
459 | |
460 | =head2 Add a Login Form TT Template Page |
461 | |
462 | Create a login form by opening C<root/src/login.tt2> and inserting: |
463 | |
464 | [% META title = 'Login' %] |
1390ef0e |
465 | |
d442cc9f |
466 | <!-- Login form --> |
8a7c5151 |
467 | <form method="post" action="[% c.uri_for('/login') %]"> |
d442cc9f |
468 | <table> |
469 | <tr> |
470 | <td>Username:</td> |
471 | <td><input type="text" name="username" size="40" /></td> |
472 | </tr> |
473 | <tr> |
474 | <td>Password:</td> |
475 | <td><input type="password" name="password" size="40" /></td> |
476 | </tr> |
477 | <tr> |
478 | <td colspan="2"><input type="submit" name="submit" value="Submit" /></td> |
479 | </tr> |
480 | </table> |
481 | </form> |
482 | |
483 | |
484 | =head2 Add Valid User Check |
485 | |
486 | We need something that provides enforcement for the authentication |
487 | mechanism -- a I<global> mechanism that prevents users who have not |
488 | passed authentication from reaching any pages except the login page. |
489 | This is generally done via an C<auto> action/method (prior to Catalyst |
490 | v5.66, this sort of thing would go in C<MyApp.pm>, but starting in |
491 | v5.66, the preferred location is C<lib/MyApp/Controller/Root.pm>). |
492 | |
493 | Edit the existing C<lib/MyApp/Controller/Root.pm> class file and insert |
494 | the following method: |
495 | |
496 | =head2 auto |
1390ef0e |
497 | |
d442cc9f |
498 | Check if there is a user and, if not, forward to login page |
1390ef0e |
499 | |
d442cc9f |
500 | =cut |
1390ef0e |
501 | |
d442cc9f |
502 | # Note that 'auto' runs after 'begin' but before your actions and that |
905a3a26 |
503 | # 'auto's "chain" (all from application path to most specific class are run) |
d442cc9f |
504 | # See the 'Actions' section of 'Catalyst::Manual::Intro' for more info. |
505 | sub auto : Private { |
506 | my ($self, $c) = @_; |
1390ef0e |
507 | |
d442cc9f |
508 | # Allow unauthenticated users to reach the login page. This |
191dee29 |
509 | # allows unauthenticated users to reach any action in the Login |
d442cc9f |
510 | # controller. To lock it down to a single action, we could use: |
511 | # if ($c->action eq $c->controller('Login')->action_for('index')) |
905a3a26 |
512 | # to only allow unauthenticated access to the 'index' action we |
d442cc9f |
513 | # added above. |
514 | if ($c->controller eq $c->controller('Login')) { |
515 | return 1; |
516 | } |
1390ef0e |
517 | |
d442cc9f |
518 | # If a user doesn't exist, force login |
519 | if (!$c->user_exists) { |
520 | # Dump a log message to the development server debug output |
521 | $c->log->debug('***Root::auto User not found, forwarding to /login'); |
522 | # Redirect the user to the login page |
523 | $c->response->redirect($c->uri_for('/login')); |
524 | # Return 0 to cancel 'post-auto' processing and prevent use of application |
525 | return 0; |
526 | } |
1390ef0e |
527 | |
d442cc9f |
528 | # User found, so return 1 to continue with processing after this 'auto' |
529 | return 1; |
530 | } |
531 | |
0416017e |
532 | As discussed in |
533 | L<Catalyst::Manual::Tutorial::MoreCatalystBasics/CREATE A CATALYST CONTROLLER>, |
534 | every C<auto> method from the application/root controller down to the |
535 | most specific controller will be called. By placing the |
536 | authentication enforcement code inside the C<auto> method of |
537 | C<lib/MyApp/Controller/Root.pm> (or C<lib/MyApp.pm>), it will be |
538 | called for I<every> request that is received by the entire |
539 | application. |
d442cc9f |
540 | |
541 | |
542 | =head2 Displaying Content Only to Authenticated Users |
543 | |
544 | Let's say you want to provide some information on the login page that |
545 | changes depending on whether the user has authenticated yet. To do |
546 | this, open C<root/src/login.tt2> in your editor and add the following |
547 | lines to the bottom of the file: |
548 | |
acbd7bdd |
549 | ... |
d442cc9f |
550 | <p> |
551 | [% |
905a3a26 |
552 | # This code illustrates how certain parts of the TT |
d442cc9f |
553 | # template will only be shown to users who have logged in |
554 | %] |
8a7c5151 |
555 | [% IF c.user_exists %] |
556 | Please Note: You are already logged in as '[% c.user.username %]'. |
557 | You can <a href="[% c.uri_for('/logout') %]">logout</a> here. |
d442cc9f |
558 | [% ELSE %] |
559 | You need to log in to use this application. |
560 | [% END %] |
561 | [%# |
562 | Note that this whole block is a comment because the "#" appears |
905a3a26 |
563 | immediate after the "[%" (with no spaces in between). Although it |
564 | can be a handy way to temporarily "comment out" a whole block of |
565 | TT code, it's probably a little too subtle for use in "normal" |
d442cc9f |
566 | comments. |
567 | %] |
3533daff |
568 | </p> |
d442cc9f |
569 | |
570 | Although most of the code is comments, the middle few lines provide a |
571 | "you are already logged in" reminder if the user returns to the login |
572 | page after they have already authenticated. For users who have not yet |
573 | authenticated, a "You need to log in..." message is displayed (note the |
574 | use of an IF-THEN-ELSE construct in TT). |
575 | |
576 | |
577 | =head2 Try Out Authentication |
578 | |
579 | Press C<Ctrl-C> to kill the previous server instance (if it's still |
580 | running) and restart it: |
581 | |
582 | $ script/myapp_server.pl |
583 | |
1390ef0e |
584 | B<IMPORTANT NOTE:> If you are having issues with authentication on |
585 | Internet Explorer, be sure to check the system clocks on both your |
586 | server and client machines. Internet Explorer is very picky about |
acbd7bdd |
587 | timestamps for cookies. You can quickly sync a Debian system by |
588 | installing the "ntpdate" package: |
589 | |
590 | sudo aptitude -y install ntpdate |
591 | |
592 | And then run the following command: |
25ed8f40 |
593 | |
acbd7bdd |
594 | sudo ntpdate-debian |
d442cc9f |
595 | |
acbd7bdd |
596 | Or, depending on your firewall configuration: |
597 | |
598 | sudo ntpdate-debian -u |
599 | |
600 | Note: NTP can be a little more finicky about firewalls because it uses |
601 | UDP vs. the more common TCP that you see with most Internet protocols. |
602 | Worse case, you might have to manually set the time on your development |
603 | box instead of using NTP. |
1390ef0e |
604 | |
605 | Now trying going to L<http://localhost:3000/books/list> and you should |
606 | be redirected to the login page, hitting Shift+Reload or Ctrl+Reload |
607 | if necessary (the "You are already logged in" message should I<not> |
608 | appear -- if it does, click the C<logout> button and try again). Note |
609 | the C<***Root::auto User not found...> debug message in the |
610 | development server output. Enter username C<test01> and password |
611 | C<mypass>, and you should be taken to the Book List page. |
d442cc9f |
612 | |
613 | Open C<root/src/books/list.tt2> and add the following lines to the |
3533daff |
614 | bottom (below the closing </table> tag): |
d442cc9f |
615 | |
616 | <p> |
8a7c5151 |
617 | <a href="[% c.uri_for('/login') %]">Login</a> |
0416017e |
618 | <a href="[% c.uri_for(c.controller.action_for('form_create')) %]">Create</a> |
d442cc9f |
619 | </p> |
620 | |
905a3a26 |
621 | Reload your browser and you should now see a "Login" and "Create" links |
622 | at the bottom of the page (as mentioned earlier, you can update template |
623 | files without reloading the development server). Click the first link |
624 | to return to the login page. This time you I<should> see the "You are |
d442cc9f |
625 | already logged in" message. |
626 | |
627 | Finally, click the C<You can logout here> link on the C</login> page. |
628 | You should stay at the login page, but the message should change to "You |
629 | need to log in to use this application." |
630 | |
631 | |
632 | =head1 USING PASSWORD HASHES |
633 | |
634 | In this section we increase the security of our system by converting |
635 | from cleartext passwords to SHA-1 password hashes. |
636 | |
637 | B<Note:> This section is optional. You can skip it and the rest of the |
638 | tutorial will function normally. |
639 | |
fbbb9084 |
640 | Be aware that even with the techniques shown in this section, the browser |
d442cc9f |
641 | still transmits the passwords in cleartext to your application. We are |
642 | just avoiding the I<storage> of cleartext passwords in the database by |
643 | using a SHA-1 hash. If you are concerned about cleartext passwords |
644 | between the browser and your application, consider using SSL/TLS, made |
fbbb9084 |
645 | easy with the Catalyst plugin Catalyst::Plugin:RequireSSL. You should |
646 | also consider adding a "salt" mechanism to your hashed passwords to |
b0eca006 |
647 | mitigate the risk of a "rainbow table" crack against your passwords (see |
648 | L<Catalyst::Authentication::Credential::Password|Catalyst::Authentication::Credential::Password> |
649 | for more information on using a salt value). |
d442cc9f |
650 | |
651 | |
652 | =head2 Get a SHA-1 Hash for the Password |
653 | |
654 | Catalyst uses the C<Digest> module to support a variety of hashing |
655 | algorithms. Here we will use SHA-1 (SHA = Secure Hash Algorithm). |
656 | First, we should compute the SHA-1 hash for the "mypass" password we are |
657 | using. The following command-line Perl script provides a "quick and |
658 | dirty" way to do this: |
659 | |
660 | $ perl -MDigest::SHA -e 'print Digest::SHA::sha1_hex("mypass"), "\n"' |
661 | e727d1464ae12436e899a726da5b2f11d8381b26 |
d0496197 |
662 | |
d442cc9f |
663 | B<Note:> You should probably modify this code for production use to |
664 | not read the password from the command line. By having the script |
665 | prompt for the cleartext password, it avoids having the password linger |
666 | in forms such as your C<.bash_history> files (assuming you are using |
667 | BASH as your shell). An example of such a script can be found in |
668 | Appendix 3. |
669 | |
670 | |
671 | =head2 Switch to SHA-1 Password Hashes in the Database |
672 | |
673 | Next, we need to change the C<password> column of our C<users> table to |
674 | store this hash value vs. the existing cleartext password. Open |
675 | C<myapp03.sql> in your editor and enter: |
676 | |
677 | -- |
678 | -- Convert passwords to SHA-1 hashes |
679 | -- |
680 | UPDATE users SET password = 'e727d1464ae12436e899a726da5b2f11d8381b26' WHERE id = 1; |
681 | UPDATE users SET password = 'e727d1464ae12436e899a726da5b2f11d8381b26' WHERE id = 2; |
682 | UPDATE users SET password = 'e727d1464ae12436e899a726da5b2f11d8381b26' WHERE id = 3; |
683 | |
684 | Then use the following command to update the SQLite database: |
685 | |
686 | $ sqlite3 myapp.db < myapp03.sql |
687 | |
1390ef0e |
688 | B<Note:> We are using SHA-1 hashes here, but many other hashing |
d442cc9f |
689 | algorithms are supported. See C<Digest> for more information. |
690 | |
691 | |
692 | =head2 Enable SHA-1 Hash Passwords in |
693 | C<Catalyst::Plugin::Authentication::Store::DBIC> |
694 | |
45d511e0 |
695 | Edit C<myapp.conf> and update it to match (the C<password_type> and |
d442cc9f |
696 | C<password_hash_type> are new, everything else is the same): |
697 | |
1390ef0e |
698 | # rename this file to MyApp.yml and put a : in front of "name" if |
699 | # you want to use yaml like in old versions of Catalyst |
c010ae0d |
700 | name MyApp |
701 | <authentication> |
702 | default_realm dbic |
703 | <realms> |
704 | <dbic> |
705 | <credential> |
3533daff |
706 | # Note this first definition would be the same as setting |
707 | # __PACKAGE__->config->{authentication}->{realms}->{dbic} |
905a3a26 |
708 | # ->{credential} = 'Password' in lib/MyApp.pm |
3533daff |
709 | # |
710 | # Specify that we are going to do password-based auth |
c010ae0d |
711 | class Password |
3533daff |
712 | # This is the name of the field in the users table with the |
713 | # password stored in it |
c010ae0d |
714 | password_field password |
3533daff |
715 | # Switch to more secure hashed passwords |
c010ae0d |
716 | password_type hashed |
3533daff |
717 | # Use the SHA-1 hashing algorithm |
c010ae0d |
718 | password_hash_type SHA-1 |
d0496197 |
719 | </credential> |
c010ae0d |
720 | <store> |
3533daff |
721 | # Use DBIC to retrieve username, password & role information |
c010ae0d |
722 | class DBIx::Class |
905a3a26 |
723 | # This is the model object created by Catalyst::Model::DBIC |
acbd7bdd |
724 | # from your schema (you created 'MyApp::Schema::Result::User' |
725 | # but as the Catalyst startup debug messages show, it was |
726 | # loaded as 'MyApp::Model::DB::Users'). |
905a3a26 |
727 | # NOTE: Omit 'MyApp::Model' here just as you would when using |
d0496197 |
728 | # '$c->model("DB::Users)' |
729 | user_class DB::Users |
d0496197 |
730 | </store> |
731 | </dbic> |
732 | </realms> |
733 | </authentication> |
d442cc9f |
734 | |
1390ef0e |
735 | |
d442cc9f |
736 | =head2 Try Out the Hashed Passwords |
737 | |
738 | Press C<Ctrl-C> to kill the previous server instance (if it's still |
739 | running) and restart it: |
740 | |
741 | $ script/myapp_server.pl |
742 | |
743 | You should now be able to go to L<http://localhost:3000/books/list> and |
fbbb9084 |
744 | login as before. When done, click the "logout" link on the login page |
d442cc9f |
745 | (or point your browser at L<http://localhost:3000/logout>). |
746 | |
d442cc9f |
747 | |
748 | =head1 USING THE SESSION FOR FLASH |
749 | |
750 | As discussed in Part 3 of the tutorial, C<flash> allows you to set |
905a3a26 |
751 | variables in a way that is very similar to C<stash>, but it will |
d442cc9f |
752 | remain set across multiple requests. Once the value is read, it |
753 | is cleared (unless reset). Although C<flash> has nothing to do with |
754 | authentication, it does leverage the same session plugins. Now that |
fbbb9084 |
755 | those plugins are enabled, let's go back and update the "delete |
d442cc9f |
756 | and redirect with query parameters" code seen at the end of the |
905a3a26 |
757 | L<Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD> part of the |
fbbb9084 |
758 | tutorial to take advantage of C<flash>. |
d442cc9f |
759 | |
760 | First, open C<lib/MyApp/Controller/Books.pm> and modify C<sub delete> |
3533daff |
761 | to match the following (everything after the model search line of code |
762 | has changed): |
d442cc9f |
763 | |
905a3a26 |
764 | =head2 delete |
1390ef0e |
765 | |
d442cc9f |
766 | Delete a book |
1390ef0e |
767 | |
d442cc9f |
768 | =cut |
1390ef0e |
769 | |
fbbb9084 |
770 | sub delete :Chained('object') :PathPart('delete') :Args(0) { |
771 | my ($self, $c) = @_; |
1390ef0e |
772 | |
fbbb9084 |
773 | # Use the book object saved by 'object' and delete it along |
774 | # with related 'book_authors' entries |
775 | $c->stash->{object}->delete; |
1390ef0e |
776 | |
d442cc9f |
777 | # Use 'flash' to save information across requests until it's read |
778 | $c->flash->{status_msg} = "Book deleted"; |
1390ef0e |
779 | |
3533daff |
780 | # Redirect the user back to the list page |
0416017e |
781 | $c->response->redirect($c->uri_for($self->action_for('list'))); |
d442cc9f |
782 | } |
783 | |
1390ef0e |
784 | Next, open C<root/src/wrapper.tt2> and update the TT code to pull from |
d442cc9f |
785 | flash vs. the C<status_msg> query parameter: |
786 | |
1390ef0e |
787 | ... |
d442cc9f |
788 | <div id="content"> |
1390ef0e |
789 | [%# Status and error messages %] |
790 | <span class="message">[% status_msg || c.flash.status_msg %]</span> |
791 | <span class="error">[% error_msg %]</span> |
792 | [%# This is where TT will stick all of your template's contents. -%] |
793 | [% content %] |
794 | </div><!-- end content --> |
795 | ... |
905a3a26 |
796 | |
1390ef0e |
797 | Although the sample above only shows the C<content> div, leave the |
798 | rest of the file intact -- the only change we made to the C<wrapper.tt2> |
799 | was to add "C<|| c.request.params.status_msg>" to the |
800 | C<E<lt>span class="message"E<gt>> line. |
d442cc9f |
801 | |
802 | |
803 | =head2 Try Out Flash |
804 | |
fbbb9084 |
805 | Restart the development server, log in, and then point your browser to |
806 | L<http://localhost:3000/books/url_create/Test/1/4> to create an extra |
807 | several books. Click the "Return to list" link and delete one of the |
808 | "Test" books you just added. The C<flash> mechanism should retain our |
3533daff |
809 | "Book deleted" status message across the redirect. |
d442cc9f |
810 | |
811 | B<NOTE:> While C<flash> will save information across multiple requests, |
812 | I<it does get cleared the first time it is read>. In general, this is |
813 | exactly what you want -- the C<flash> message will get displayed on |
814 | the next screen where it's appropriate, but it won't "keep showing up" |
815 | after that first time (unless you reset it). Please refer to |
816 | L<Catalyst::Plugin::Session|Catalyst::Plugin::Session> for additional |
817 | information. |
818 | |
1390ef0e |
819 | |
3533daff |
820 | =head2 Switch To Flash-To-Stash |
821 | |
fbbb9084 |
822 | Although the a use of flash above works well, the |
1390ef0e |
823 | C<status_msg || c.flash.status_msg> statement is a little ugly. A nice |
905a3a26 |
824 | alternative is to use the C<flash_to_stash> feature that automatically |
1390ef0e |
825 | copies the content of flash to stash. This makes your controller |
905a3a26 |
826 | and template code work regardless of where it was directly access, a |
fbbb9084 |
827 | forward, or a redirect. To enable C<flash_to_stash>, you can either |
905a3a26 |
828 | set the value in C<lib/MyApp.pm> by changing the default |
3533daff |
829 | C<__PACKAGE__-E<gt>config> setting to something like: |
830 | |
831 | __PACKAGE__->config( |
832 | name => 'MyApp', |
833 | session => {flash_to_stash => 1} |
834 | ); |
835 | |
45d511e0 |
836 | B<or> add the following to C<myapp.conf>: |
3533daff |
837 | |
45d511e0 |
838 | <session> |
839 | flash_to_stash 1 |
840 | </session> |
3533daff |
841 | |
905a3a26 |
842 | The C<__PACKAGE__-E<gt>config> option is probably preferable here |
843 | since it's not something you will want to change at runtime without it |
3533daff |
844 | possibly breaking some of your code. |
845 | |
1390ef0e |
846 | Then edit C<root/src/wrapper.tt2> and change the C<status_msg> line |
847 | to match the following: |
3533daff |
848 | |
849 | <span class="message">[% status_msg %]</span> |
850 | |
851 | Restart the development server and go to |
905a3a26 |
852 | L<http://localhost:3000/books/list> in your browser. Delete another |
3533daff |
853 | of the "Test" books you added in the previous step. Flash should still |
854 | maintain the status message across the redirect even though you are no |
8a7c5151 |
855 | longer explicitly accessing C<c.flash>. |
3533daff |
856 | |
d442cc9f |
857 | |
858 | =head1 AUTHOR |
859 | |
860 | Kennedy Clark, C<hkclark@gmail.com> |
861 | |
862 | Please report any errors, issues or suggestions to the author. The |
863 | most recent version of the Catalyst Tutorial can be found at |
82ab4bbf |
864 | L<http://dev.catalyst.perl.org/repos/Catalyst/Catalyst-Manual/5.70/trunk/lib/Catalyst/Manual/Tutorial/>. |
d442cc9f |
865 | |
45c7830f |
866 | Copyright 2006-2008, Kennedy Clark, under Creative Commons License |
95674086 |
867 | (L<http://creativecommons.org/licenses/by-sa/3.0/us/>). |