=head1 NAME Catalyst::Manual::Tutorial::Authentication - Catalyst Tutorial - Part 4: Authentication =head1 OVERVIEW This is B for the Catalyst tutorial. L =over 4 =item 1 L =item 2 L =item 3 L =item 4 B =item 5 L =item 6 L =item 7 L =item 8 L =item 9 L =back =head1 DESCRIPTION Now that we finally have a simple yet functional application, we can focus on providing authentication (with authorization coming next in Part 5). This part 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 L =head1 BASIC AUTHENTICATION This section explores how to add authentication logic to a Catalyst application. =head2 Add Users and Roles to the Database 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, Part 5). Create a new SQL script file by opening C in your editor and insert: -- -- Add users and roles tables, along with a many-to-many join table -- CREATE TABLE users ( id INTEGER PRIMARY KEY, username TEXT, password TEXT, email_address TEXT, first_name TEXT, last_name TEXT, active INTEGER ); CREATE TABLE roles ( id INTEGER PRIMARY KEY, role TEXT ); CREATE TABLE user_roles ( user_id INTEGER, role_id INTEGER, PRIMARY KEY (user_id, role_id) ); -- -- Load up some initial test data -- INSERT INTO users VALUES (1, 'test01', 'mypass', 't01@na.com', 'Joe', 'Blow', 1); INSERT INTO users VALUES (2, 'test02', 'mypass', 't02@na.com', 'Jane', 'Doe', 1); INSERT INTO users VALUES (3, 'test03', 'mypass', 't03@na.com', 'No', 'Go', 0); INSERT INTO roles VALUES (1, 'user'); INSERT INTO roles VALUES (2, 'admin'); INSERT INTO user_roles VALUES (1, 1); INSERT INTO user_roles VALUES (1, 2); INSERT INTO user_roles VALUES (2, 1); INSERT INTO user_roles VALUES (3, 1); Then load this into the C database with the following command: $ sqlite3 myapp.db < myapp02.sql =head2 Add User and Role Information to DBIC Schema This step adds DBIC-based classes for the user-related database tables (the role information will not be used until Part 5): Edit C and update the contents to match (only the C [qw/Book BookAuthor Author User UserRole Role/]> line has changed): package MyAppDB; =head1 NAME MyAppDB -- DBIC Schema Class =cut # Our schema needs to inherit from 'DBIx::Class::Schema' use base qw/DBIx::Class::Schema/; # Need to load the DB Model classes here. # You can use this syntax if you want: # __PACKAGE__->load_classes(qw/Book BookAuthor Author User UserRole Role/); # Also, if you simply want to load all of the classes in a directory # of the same name as your schema class (as we do here) you can use: # __PACKAGE__->load_classes(qw//); # But the variation below is more flexible in that it can be used to # load from multiple namespaces. __PACKAGE__->load_classes({ MyAppDB => [qw/Book BookAuthor Author User UserRole Role/] }); 1; =head2 Create New "Result Source Objects" Create the following three files with the content shown below. C: package MyAppDB::User; use base qw/DBIx::Class/; # Load required DBIC stuff __PACKAGE__->load_components(qw/PK::Auto Core/); # Set the table name __PACKAGE__->table('users'); # Set columns in table __PACKAGE__->add_columns(qw/id username password email_address first_name last_name/); # Set the primary key for the table __PACKAGE__->set_primary_key('id'); # # Set relationships: # # has_many(): # args: # 1) Name of relationship, DBIC will create accessor with this name # 2) Name of the model class referenced by this relationship # 3) Column name in *foreign* table __PACKAGE__->has_many(map_user_role => 'MyAppDB::UserRole', 'user_id'); =head1 NAME MyAppDB::User - A model object representing a person with access to the system. =head1 DESCRIPTION This is an object that represents a row in the 'users' table of your application database. It uses DBIx::Class (aka, DBIC) to do ORM. For Catalyst, this is designed to be used through MyApp::Model::MyAppDB. Offline utilities may wish to use this class directly. =cut 1; C: package MyAppDB::Role; use base qw/DBIx::Class/; # Load required DBIC stuff __PACKAGE__->load_components(qw/PK::Auto Core/); # Set the table name __PACKAGE__->table('roles'); # Set columns in table __PACKAGE__->add_columns(qw/id role/); # Set the primary key for the table __PACKAGE__->set_primary_key('id'); # # Set relationships: # # has_many(): # args: # 1) Name of relationship, DBIC will create accessor with this name # 2) Name of the model class referenced by this relationship # 3) Column name in *foreign* table __PACKAGE__->has_many(map_user_role => 'MyAppDB::UserRole', 'role_id'); =head1 NAME MyAppDB::Role - A model object representing a class of access permissions to the system. =head1 DESCRIPTION This is an object that represents a row in the 'roles' table of your application database. It uses DBIx::Class (aka, DBIC) to do ORM. For Catalyst, this is designed to be used through MyApp::Model::MyAppDB. "Offline" utilities may wish to use this class directly. =cut 1; C: package MyAppDB::UserRole; use base qw/DBIx::Class/; # Load required DBIC stuff __PACKAGE__->load_components(qw/PK::Auto Core/); # Set the table name __PACKAGE__->table('user_roles'); # Set columns in table __PACKAGE__->add_columns(qw/user_id role_id/); # Set the primary key for the table __PACKAGE__->set_primary_key(qw/user_id role_id/); # # Set relationships: # # belongs_to(): # args: # 1) Name of relationship, DBIC will create accessor with this name # 2) Name of the model class referenced by this relationship # 3) Column name in *this* table __PACKAGE__->belongs_to(user => 'MyAppDB::User', 'user_id'); # belongs_to(): # args: # 1) Name of relationship, DBIC will create accessor with this name # 2) Name of the model class referenced by this relationship # 3) Column name in *this* table __PACKAGE__->belongs_to(role => 'MyAppDB::Role', 'role_id'); =head1 NAME MyAppDB::UserRole - A model object representing the JOIN between Users and Roles. =head1 DESCRIPTION This is an object that represents a row in the 'user_roles' table of your application database. It uses DBIx::Class (aka, DBIC) to do ORM. You probably won't need to use this class directly -- it will be automatically used by DBIC where joins are needed. For Catalyst, this is designed to be used through MyApp::Model::MyAppDB. Offline utilities may wish to use this class directly. =cut 1; The code for these three result source classes is obviously very familiar to the C, C, and C classes created in Part 2. =head2 Sanity-Check Reload of Development Server We 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 to kill the previous server instance (if it's still running) and restart it: $ script/myapp_server.pl Look for the three new model objects in the startup debug output: ... .-------------------------------------------------------------------+----------. | Class | Type | +-------------------------------------------------------------------+----------+ | MyApp::Controller::Books | instance | | MyApp::Controller::Root | instance | | MyApp::Model::MyAppDB | instance | | MyApp::Model::MyAppDB::Author | class | | MyApp::Model::MyAppDB::Book | class | | MyApp::Model::MyAppDB::BookAuthor | class | | MyApp::Model::MyAppDB::Role | class | | MyApp::Model::MyAppDB::User | class | | MyApp::Model::MyAppDB::UserRole | class | | MyApp::View::TT | instance | '-------------------------------------------------------------------+----------' ... Again, notice that your "result source" classes have been "re-loaded" by Catalyst under C. =head2 Include Authentication and Session Plugins Edit C and update it as follows (everything below C is new): use Catalyst qw/ -Debug ConfigLoader Static::Simple StackTrace Authentication Authentication::Store::DBIC Authentication::Credential::Password Session Session::Store::FastMmap Session::State::Cookie /; The three C plugins work together to support Authentication while the C plugins are required to maintain state across multiple HTTP requests. Note that there are several options for L (L is generally a good choice if you are on Unix; try L if you are on Win32) -- consult L and its subclasses for additional information. =head2 Configure Authentication Although C<__PACKAGE__-Econfig(name =E 'value');> is still supported, newer Catalyst applications tend to place all configuration information in C and automatically load this information into Cconfig> using the L plugin. Here, we need to load several parameters that tell L where to locate information in your database. To do this, edit the C YAML and update it to match: --- name: MyApp authentication: dbic: # Note this first definition would be the same as setting # __PACKAGE__->config->{authentication}->{dbic}->{user_class} = 'MyAppDB::User' # in lib/MyApp.pm (IOW, each hash key becomes a "name:" in the YAML file). # # This is the model object created by Catalyst::Model::DBIC from your # schema (you created 'MyAppDB::User' but as the Catalyst startup # debug messages show, it was loaded as 'MyApp::Model::MyAppDB::User'). # NOTE: Omit 'MyApp::Model' to avoid a component lookup issue in Catalyst 5.66 user_class: MyAppDB::User # This is the name of the field in your 'users' table that contains the user's name user_field: username # This is the name of the field in your 'users' table that contains the password password_field: password # Other options can go here for hashed passwords Inline comments in the code above explain how each field is being used. B: Although YAML uses a very simple and easy-to-ready format, it does require the use of a consistent level of indenting. Be sure you line up everything on a given 'level' with the same number of indents. Also, be sure not to use C characters (YAML does not support them because they are handled inconsistently across editors). =head2 Add Login and Logout Controllers Use the Catalyst create script to create two stub controller files: $ script/myapp_create.pl controller Login $ script/myapp_create.pl controller Logout B: You could easily use a single controller here. For example, you could have a C controller with both C and C actions. Remember, Catalyst is designed to be very flexible, and leaves such matters up to you, the designer and programmer. Then open C, locate the C method (this was automatically inserted by the helpers when we created the Login controller above), and delete this line: $c->response->body('Matched MyApp::Controller::Login in Login.'); Then update it to match: =head2 index Login logic =cut sub index : Private { my ($self, $c) = @_; # Get the username and password from form my $username = $c->request->params->{username} || ""; my $password = $c->request->params->{password} || ""; # If the username and password values were found in form if ($username && $password) { # Attempt to log the user in if ($c->login($username, $password)) { # If successful, then let them use the application $c->response->redirect($c->uri_for('/books/list')); return; } else { # Set an error message $c->stash->{error_msg} = "Bad username or password."; } } # If either of above don't work out, send to the login page $c->stash->{template} = 'login.tt2'; } This controller fetches the C and C values from the login form and attempts to perform a login. If successful, it redirects the user to the book list page. If the login fails, the user will stay at the login page but receive an error message. If the C and C 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; however, the use of C actions is discouraged because it does not receive path args as with other actions. The recommended practice is to only use C in C. Another option would be to use something like C (where the C<...> refers to the login code shown in C above). We are using C here to specifically match the URL C. C actions (aka, "literal actions") create URI matches relative to the namespace of the controller where they are defined. Although C supports arguments that allow relative and absolute paths to be defined, here we use an empty C definition to match on just the name of the controller itself. The method name, C, is arbitrary. We make the match even more specific with the C<:Args(0)> action modifier -- this forces the match on I C, not C. Next, update the corresponding method in C to match: =head2 index Logout logic =cut sub index : Private { my ($self, $c) = @_; # Clear the user's state $c->logout; # Send the user to the starting point $c->response->redirect($c->uri_for('/')); } As with the login controller, be sure to delete the C<$c->response->body('Matched MyApp::Controller::Logout in Logout.');> line of the C. =head2 Add a Login Form TT Template Page Create a login form by opening C and inserting: [% META title = 'Login' %]
Username:
Password:
=head2 Add Valid User Check We need something that provides enforcement for the authentication mechanism -- a I mechanism that prevents users who have not passed authentication from reaching any pages except the login page. This is generally done via an C action/method (prior to Catalyst v5.66, this sort of thing would go in C, but starting in v5.66, the preferred location is C). Edit the existing C class file and insert the following method: =head2 auto Check if there is a user and, if not, forward to login page =cut # Note that 'auto' runs after 'begin' but before your actions and that # 'auto' "chain" (all from application path to most specific class are run) # See the 'Actions' section of 'Catalyst::Manual::Intro' for more info. sub auto : Private { my ($self, $c) = @_; # Allow unauthenticated users to reach the login page. This # allows anauthenticated users to reach any action in the Login # controller. To lock it down to a single action, we could use: # if ($c->action eq $c->controller('Login')->action_for('index')) # to only allow unauthenticated access to the C action we # added above. if ($c->controller eq $c->controller('Login')) { return 1; } # If a user doesn't exist, force login if (!$c->user_exists) { # Dump a log message to the development server debug output $c->log->debug('***Root::auto User not found, forwarding to /login'); # Redirect the user to the login page $c->response->redirect($c->uri_for('/login')); # Return 0 to cancel 'post-auto' processing and prevent use of application return 0; } # User found, so return 1 to continue with processing after this 'auto' return 1; } B Catalyst provides a number of different types of actions, such as C, C, and C. You should refer to L for a more detailed explanation, but the following bullet points provide a quick introduction: =over 4 =item * The majority of application use C actions for items that respond to user requests and C actions for those that do not directly respond to user input. =item * There are five types of C actions: C, C, C, C, and C. =item * With C, C, C, C private actions, only the most specific action of each type will be called. For example, if you define a C action in your controller it will I a C action in your application/root controller -- I the action in your controller will be called. =item * Unlike the other actions where only a single method is called for each request, I auto action along the chain of namespaces will be called. Each C action will be called I. =back By placing the authentication enforcement code inside the C method of C (or C), it will be called for I request that is received by the entire application. =head2 Displaying Content Only to Authenticated Users Let's say you want to provide some information on the login page that changes depending on whether the user has authenticated yet. To do this, open C in your editor and add the following lines to the bottom of the file:

[% # This code illustrates how certain parts of the TT # template will only be shown to users who have logged in %] [% IF Catalyst.user_exists %] Please Note: You are already logged in as '[% Catalyst.user.username %]'. You can logout here. [% ELSE %] You need to log in to use this application. [% END %] [%# Note that this whole block is a comment because the "#" appears immediate after the "[%" (with no spaces in between). Although it can be a handy way to temporarily "comment out" a whole block of TT code, it's probably a little too subtle for use in "normal" comments. %] Although most of the code is comments, the middle few lines provide a "you are already logged in" reminder if the user returns to the login page after they have already authenticated. For users who have not yet authenticated, a "You need to log in..." message is displayed (note the use of an IF-THEN-ELSE construct in TT). =head2 Try Out Authentication Press C to kill the previous server instance (if it's still running) and restart it: $ script/myapp_server.pl B: If you happen to be using Internet Explorer, you may need to use the command C