/usr/share/perl5/Catalyst/Plugin/Authorization/Roles.pm is in libcatalyst-plugin-authorization-roles-perl 0.09-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 | #!/usr/bin/perl
package Catalyst::Plugin::Authorization::Roles;
use strict;
use warnings;
use Set::Object ();
use Scalar::Util ();
use Catalyst::Exception ();
our $VERSION = '0.09';
sub check_user_roles {
my ( $c, @roles ) = @_;
local $@;
eval { $c->assert_user_roles(@roles) };
return $@ ? 0 : 1;
}
sub assert_user_roles {
my ( $c, @roles ) = @_;
my $user;
if ( Scalar::Util::blessed( $roles[0] )
&& $roles[0]->isa("Catalyst::Authentication::User") )
{
$user = shift @roles;
}
$user ||= $c->user;
unless ( $user ) {
Catalyst::Exception->throw(
"No logged in user, and none supplied as argument");
}
Catalyst::Exception->throw("User does not support roles")
unless $user->supports(qw/roles/);
local $" = ", ";
if ( $user->supports(qw/roles self_check/) ) {
if ( $user->check_roles(@roles) ) {
$c->log->debug("Role granted: @roles") if $c->debug;
return 1;
}
else {
$c->log->debug("Role denied: @roles") if $c->debug;
Catalyst::Exception->throw("Missing roles");
}
}
else {
my $have = Set::Object->new($user->roles);
my $need = Set::Object->new(@roles);
if ( $have->superset($need) ) {
$c->log->debug("Role granted: @roles") if $c->debug;
return 1;
}
else {
$c->log->debug("Role denied: @roles") if $c->debug;
my @missing = $need->difference($have)->members;
Catalyst::Exception->throw("Missing roles: @missing");
}
}
}
sub check_any_user_role {
my ( $c, @roles ) = @_;
local $@;
eval { $c->assert_any_user_role(@roles) };
return $@ ? 0 : 1;
}
sub assert_any_user_role {
my ( $c, @roles ) = @_;
my $user;
if ( Scalar::Util::blessed( $roles[0] )
&& $roles[0]->isa("Catalyst::Authentication::User") )
{
$user = shift @roles;
}
$user ||= $c->user;
unless ( $user ) {
Catalyst::Exception->throw(
"No logged in user, and none supplied as argument");
}
Catalyst::Exception->throw("User does not support roles")
unless $user->supports(qw/roles/);
if ( $user->supports(qw/roles self_check_any/) ) {
if ( $user->check_roles_any(@roles) ) {
$c->log->debug("At least one role granted: @roles") if $c->debug;
return 1;
}
else {
$c->log->debug("Roles denied: @roles") if $c->debug;
Catalyst::Exception->throw("Missing roles");
}
}
else {
my $have = Set::Object->new($user->roles);
my $need = Set::Object->new(@roles);
if ( $have->intersection($need)->size > 0 ) {
$c->log->debug("At least one role granted: @roles") if $c->debug;
return 1;
}
else {
$c->log->debug("Role denied: @roles") if $c->debug;
Catalyst::Exception->throw( "Missing roles" );
}
}
}
__PACKAGE__;
__END__
=pod
=head1 NAME
Catalyst::Plugin::Authorization::Roles - Role based authorization for Catalyst based on Catalyst::Plugin::Authentication
=head1 SYNOPSIS
use Catalyst qw/
Authentication
Authorization::Roles
/;
sub delete : Local {
my ( $self, $c ) = @_;
$c->assert_user_roles( qw/admin/ ); # only admins can delete
$c->model("Foo")->delete_it();
}
=head1 DESCRIPTION
Role based access control is very simple: every user has a list of roles,
which that user is allowed to assume, and every restricted part of the app
makes an assertion about the necessary roles.
With C<assert_user_roles>, if the user is a member in B<all> of the required
roles access is granted. Otherwise, access is denied. With
C<assert_any_user_role> it is enough that the user is a member in B<one>
role.
There are alternative approaches to do this on a per action basis, see
L<Catalyst::ActionRole::ACL>.
For example, if you have a CRUD application, for every mutating action you
probably want to check that the user is allowed to edit. To do this, create an
editor role, and add that role to every user who is allowed to edit.
sub edit : Local {
my ( $self, $c ) = @_;
$c->assert_user_roles( qw/editor/ );
$c->model("TheModel")->make_changes();
}
When this plugin checks the roles of a user it will first see if the user
supports the self check method.
When this is not supported the list of roles is extracted from the user using
the C<roles> method.
When this is supported, the C<check_roles> method will be used to delegate the
role check to the user class. Classes like the one provided with
L<iCatalyst::Authentication::Store::DBIx::Class> optimize the check this way.
=head1 METHODS
=over 4
=item assert_user_roles [ $user ], @roles
Checks that the user (as supplied by the first argument, or, if omitted,
C<< $c->user >>) has the specified roles.
If for any reason (C<< $c->user >> is not defined, the user is missing a role,
etc) the check fails, an error is thrown.
You can either catch these errors with an eval, or clean them up in your C<end>
action.
=item check_user_roles [ $user ], @roles
Takes the same args as C<assert_user_roles>, and performs the same check, but
instead of throwing errors returns a boolean value.
=item assert_any_user_role [ $user ], @roles
Checks that the user (as supplied by the first argument, or, if omitted,
C<< $c->user >>) has at least one of the specified roles.
Other than that, works like C<assert_user_roles>.
=item check_any_user_role [ $user ], @roles
Takes the same args as C<assert_any_user_role>, and performs the same check, but
instead of throwing errors returns a boolean value.
=back
=head1 SEE ALSO
=over
=item L<Catalyst::Plugin::Authentication>
=item L<Catalyst::ActionRole::ACL>
=item L<< Catalyst::Manual::Tutorial::06_Authorization >>
=back
=head1 AUTHOR
Yuval Kogman E<lt>nothingmuch@woobling.orgE<gt>
=head1 COPYRIGHT & LICENSE
Copyright (c) 2005-2011
the Catalyst::Plugin::Authorization::Roles L</AUTHOR>
as listed above.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|