/usr/share/perl5/Catalyst/Manual/Tutorial/06_Authorization.pod is in libcatalyst-manual-perl 5.9009-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 | =head1 NAME
Catalyst::Manual::Tutorial::06_Authorization - Catalyst Tutorial - Chapter 6: Authorization
=head1 OVERVIEW
This is B<Chapter 6 of 10> for the Catalyst tutorial.
L<Tutorial Overview|Catalyst::Manual::Tutorial>
=over 4
=item 1
L<Introduction|Catalyst::Manual::Tutorial::01_Intro>
=item 2
L<Catalyst Basics|Catalyst::Manual::Tutorial::02_CatalystBasics>
=item 3
L<More Catalyst Basics|Catalyst::Manual::Tutorial::03_MoreCatalystBasics>
=item 4
L<Basic CRUD|Catalyst::Manual::Tutorial::04_BasicCRUD>
=item 5
L<Authentication|Catalyst::Manual::Tutorial::05_Authentication>
=item 6
B<06_Authorization>
=item 7
L<Debugging|Catalyst::Manual::Tutorial::07_Debugging>
=item 8
L<Testing|Catalyst::Manual::Tutorial::08_Testing>
=item 9
L<Advanced CRUD|Catalyst::Manual::Tutorial::09_AdvancedCRUD>
=item 10
L<Appendices|Catalyst::Manual::Tutorial::10_Appendices>
=back
=head1 DESCRIPTION
This chapter of the tutorial adds role-based authorization to the
existing authentication implemented in
L<Chapter 5|Catalyst::Manual::Tutorial::05_Authentication>. It provides
simple examples of how to use roles in both TT templates and controller
actions. The first half looks at basic authorization concepts. The
second half looks at how moving your authorization code to your model
can simplify your code and make things easier to maintain.
Source code for the tutorial in included in the F</home/catalyst/Final>
directory of the Tutorial Virtual machine (one subdirectory per
chapter). There are also instructions for downloading the code in
L<Catalyst::Manual::Tutorial::01_Intro>.
=head1 BASIC AUTHORIZATION
In this section you learn the basics of how authorization works under
Catalyst.
=head2 Update Plugins to Include Support for Authorization
Edit C<lib/MyApp.pm> and add C<Authorization::Roles> to the list:
# Load plugins
use Catalyst qw/
-Debug
ConfigLoader
Static::Simple
StackTrace
Authentication
Authorization::Roles
Session
Session::Store::File
Session::State::Cookie
StatusMessage
/;
Once again, include this additional plugin as a new dependency in the
Makefile.PL file like this:
requires 'Catalyst::Plugin::Authorization::Roles';
=head2 Add Role-Specific Logic to the "Book List" Template
Open C<root/src/books/list.tt2> in your editor and add the following
lines to the bottom of the file:
...
<p>Hello [% c.user.username %], you have the following roles:</p>
<ul>
[% # Dump list of roles -%]
[% FOR role = c.user.roles %]<li>[% role %]</li>[% END %]
</ul>
<p>
[% # Add some simple role-specific logic to template %]
[% # Use $c->check_user_roles() to check authz -%]
[% IF c.check_user_roles('user') %]
[% # Give normal users a link for 'logout' %]
<a href="[% c.uri_for('/logout') %]">User Logout</a>
[% END %]
[% # Can also use $c->user->check_roles() to check authz -%]
[% IF c.check_user_roles('admin') %]
[% # Give admin users a link for 'create' %]
<a href="[% c.uri_for(c.controller.action_for('form_create')) %]">Admin Create</a>
[% END %]
</p>
This code displays a different combination of links depending on the
roles assigned to the user.
=head2 Limit Books::add to 'admin' Users
C<IF> statements in TT templates simply control the output that is sent
to the user's browser; it provides no real enforcement (if users know or
guess the appropriate URLs, they are still perfectly free to hit any
action within your application). We need to enhance the controller
logic to wrap restricted actions with role-validation logic.
For example, we might want to restrict the "formless create" action to
admin-level users by editing C<lib/MyApp/Controller/Books.pm> and
updating C<url_create> to match the following code:
=head2 url_create
Create a book with the supplied title and rating,
with manual authorization
=cut
sub url_create :Chained('base') :PathPart('url_create') :Args(3) {
# In addition to self & context, get the title, rating & author_id args
# from the URL. Note that Catalyst automatically puts extra information
# after the "/<controller_name>/<action_name/" into @_
my ($self, $c, $title, $rating, $author_id) = @_;
# Check the user's roles
if ($c->check_user_roles('admin')) {
# Call create() on the book model object. Pass the table
# columns/field values we want to set as hash values
my $book = $c->model('DB::Book')->create({
title => $title,
rating => $rating
});
# Add a record to the join table for this book, mapping to
# appropriate author
$book->add_to_book_authors({author_id => $author_id});
# Note: Above is a shortcut for this:
# $book->create_related('book_authors', {author_id => $author_id});
# Assign the Book object to the stash and set template
$c->stash(book => $book,
template => 'books/create_done.tt2');
} else {
# Provide very simple feedback to the user.
$c->response->body('Unauthorized!');
}
}
To add authorization, we simply wrap the main code of this method in an
C<if> statement that calls C<check_user_roles>. If the user does not
have the appropriate permissions, they receive an "Unauthorized!"
message. Note that we intentionally chose to display the message this
way to demonstrate that TT templates will not be used if the response
body has already been set. In reality you would probably want to use a
technique that maintains the visual continuity of your template layout
(for example, using L<Catalyst::Plugin::StatusMessage> as shown in the
L<last chapter|Catalyst::Manual::Tutorial::05_Authentication> to
redirect to an "unauthorized" page).
B<TIP>: If you want to keep your existing C<url_create> method, you can
create a new copy and comment out the original by making it look like a
Pod comment. For example, put something like C<=begin> before
C<sub add : Local {> and C<=end> after the closing C<}>.
=head2 Try Out Authentication And Authorization
Make sure the development server is running:
$ script/myapp_server.pl -r
Now trying going to L<http://localhost:3000/books/list> and you should
be taken to the login page (you might have to C<Shift+Reload> or
C<Ctrl+Reload> your browser and/or click the "User Logout" link on the
book list page). Try logging in with both C<test01> and C<test02> (both
use a password of C<mypass>) and notice how the roles information
updates at the bottom of the "Book List" page. Also try the "User
Logout" link on the book list page.
Now the "url_create" URL will work if you are already logged in as user
C<test01>, but receive an authorization failure if you are logged in as
C<test02>. Try:
http://localhost:3000/books/url_create/test/1/6
while logged in as each user. Use one of the "logout" links (or go to
L<http://localhost:3000/logout> in your browser directly) when you are
done.
=head1 ENABLE MODEL-BASED AUTHORIZATION
Hopefully it's fairly obvious that adding detailed permission checking
logic to our controllers and view templates isn't a very clean or
scalable way to build role-based permissions into out application. As
with many other aspects of MVC web development, the goal is to have your
controllers and views be an "thin" as possible, with all of the "fancy
business logic" built into your model.
For example, let's add a method to our C<Books.pm> Result Class to check
if a user is allowed to delete a book. Open
C<lib/MyApp/Schema/Result/Book.pm> and add the following method (be sure
to add it below the "C<DO NOT MODIFY ...>" line):
=head2 delete_allowed_by
Can the specified user delete the current book?
=cut
sub delete_allowed_by {
my ($self, $user) = @_;
# Only allow delete if user has 'admin' role
return $user->has_role('admin');
}
Here we call a C<has_role> method on our user object, so we should add
this method to our Result Class. Open
C<lib/MyApp/Schema/Result/User.pm> and add the following method below
the "C<DO NOT MODIFY ...>" line:
=head2 has_role
Check if a user has the specified role
=cut
use Perl6::Junction qw/any/;
sub has_role {
my ($self, $role) = @_;
# Does this user posses the required role?
return any(map { $_->role } $self->roles) eq $role;
}
Let's also add C<Perl6::Junction> to the requirements listed in
Makefile.PL:
requires 'Perl6::Junction';
B<Note:> Feel free to use C<grep> in lieu of C<Perl6::Junction::any> if
you prefer. Also, please don't let the use of the C<Perl6::Junction>
module above lead you to believe that Catalyst is somehow dependent on
Perl 6... we are simply using that module for its
L<easy-to-read|http://blogs.perl.org/users/marc_sebastian_jakobs/2009/11/my-favorite-module-of-the-month-perl6junction.html>
C<any> function.
Now we need to add some enforcement inside our controller. Open
C<lib/MyApp/Controller/Books.pm> and update the C<delete> method to
match the following code:
=head2 delete
Delete a book
=cut
sub delete :Chained('object') :PathPart('delete') :Args(0) {
my ($self, $c) = @_;
# Check permissions
$c->detach('/error_noperms')
unless $c->stash->{object}->delete_allowed_by($c->user->get_object);
# Saved the PK id for status_msg below
my $id = $c->stash->{object}->id;
# Use the book object saved by 'object' and delete it along
# with related 'book_authors' entries
$c->stash->{object}->delete;
# Redirect the user back to the list page
$c->response->redirect($c->uri_for($self->action_for('list'),
{mid => $c->set_status_msg("Deleted book $id")}));
}
Here, we C<detach> to an error page if the user is lacking the
appropriate permissions. For this to work, we need to make arrangements
for the '/error_noperms' action to work. Open
C<lib/MyApp/Controller/Root.pm> and add this method:
=head2 error_noperms
Permissions error screen
=cut
sub error_noperms :Chained('/') :PathPart('error_noperms') :Args(0) {
my ($self, $c) = @_;
$c->stash(template => 'error_noperms.tt2');
}
And also add the template file by putting the following text into
C<root/src/error_noperms.tt2>:
<span class="error">Permission Denied</span>
Log in as C<test01> and create several new books using the C<url_create>
feature:
http://localhost:3000/books/url_create/Test/1/4
Then, while still logged in as C<test01>, click the "Delete" link next
to one of these books. The book should be removed and you should see
the usual green "Book deleted" message. Next, click the "User Logout"
link and log back in as C<test02>. Now try deleting one of the books.
You should be taken to the red "Permission Denied" message on our error
page.
Use one of the 'Logout' links (or go to the
L<http://localhost:3000/logout> URL directly) when you are done.
You can jump to the next chapter of the tutorial here:
L<Debugging|Catalyst::Manual::Tutorial::07_Debugging>
=head1 AUTHOR
Kennedy Clark, C<hkclark@gmail.com>
Feel free to contact the author for any errors or suggestions, but the
best way to report issues is via the CPAN RT Bug system at
L<https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Manual>.
Copyright 2006-2011, Kennedy Clark, under the
Creative Commons Attribution Share-Alike License Version 3.0
(L<http://creativecommons.org/licenses/by-sa/3.0/us/>).
|