]>
Dogcows Code - chaz/p5-CGI-Ex/blob - lib/CGI/Ex/Auth.pm
5 CGI::Ex::Auth - Handle logins nicely.
9 ###----------------------------------------------------------------###
10 # Copyright 2006 - Paul Seamons #
11 # Distributed under the Perl Artistic License without warranty #
12 ###----------------------------------------------------------------###
15 use vars
qw($VERSION);
17 use MIME
::Base64
qw(encode_base64 decode_base64);
18 use Digest
::MD5
qw(md5_hex);
23 ###----------------------------------------------------------------###
26 my $class = shift || __PACKAGE__
;
27 my $args = shift || {};
28 return bless {%$args}, $class;
33 $self = $self->new(@_) if ! ref $self;
35 ### shortcut that will print a js file as needed (such as the md5.js)
36 if ($self->script_name . $self->path_info eq $self->js_uri_path . "/CGI/Ex/md5.js") {
37 $self->cgix->print_js('CGI/Ex/md5.js');
38 eval { die "Printed Javascript" };
42 my $form = $self->form;
43 my $cookies = $self->cookies;
44 my $key_l = $self->key_logout;
45 my $key_c = $self->key_cookie;
46 my $has_cookies = scalar %$cookies;
49 if ($form->{$key_l}) {
50 $self->delete_cookie({key
=> $key_c});;
51 $self->location_bounce($self->logout_redirect);
52 eval { die "Logging out" };
57 foreach ([$form, $self->key_user, 1],
58 [$cookies, $key_c, 0],
60 my ($hash, $key, $is_form) = @$_;
61 next if ! defined $hash->{$key};
62 $had_form_info ++ if $is_form;
64 ### if it looks like a bare username (as in they didn't have javascript)- add in other items
67 && $hash->{$key} !~ m
|^[^/]+/|
68 && defined $hash->{ $self->key_pass }) {
69 $data = $self->verify_token({
71 user
=> delete $hash->{$key},
72 test_pass
=> delete $hash->{ $self->key_pass },
73 expires_min
=> delete($hash->{ $self->key_save }) ? -1 : delete($hash->{ $self->key_expires_min }) || $self->expires_min,
74 payload
=> delete $hash->{ $self->key_payload } || '',
80 $data = $self->verify_token({token
=> $hash->{$key}, from
=> ($is_form ? 'form' : 'cookie')}) || next;
81 delete $hash->{$key} if $is_form;
84 ### generate a fresh cookie if they submitted info on plaintext types
85 if ($self->use_plaintext || ($data->{'type'} && $data->{'type'} eq 'crypt')) {
88 val
=> $self->generate_token($data),
89 no_expires
=> ($data->{ $self->key_save } ? 0 : 1), # make it a session cookie unless they ask for saving
90 }) if $is_form; # only set the cookie if we found info in the form - the cookie will be a session cookie after that
92 ### always generate a cookie on types that have expiration
96 val
=> $self->generate_token($data),
103 ### bounce to redirect
104 if (my $redirect = $form->{ $self->key_redirect }) {
105 $self->location_bounce($redirect);
106 eval { die "Success login - bouncing to redirect" };
109 ### if they have cookies we are done
110 } elsif ($has_cookies || $self->no_cookie_verify) {
113 ### need to verify cookies are set-able
115 $form->{$self->key_verify} = $self->server_time;
116 my $query = $self->cgix->make_form($form);
117 my $url = $self->script_name . $self->path_info . ($query ? "?$query" : "");
119 $self->location_bounce($url);
120 eval { die "Success login - bouncing to test cookie" };
125 ### make sure the cookie is gone
126 $self->delete_cookie({key
=> $key_c}) if $cookies->{$key_c};
128 ### nothing found - see if they have cookies
129 if (my $value = delete $form->{$self->key_verify}) {
130 if (abs(time() - $value) < 15) {
131 $self->no_cookies_print;
136 ### oh - you're still here - well then - ask for login credentials
137 my $key_r = $self->key_redirect;
138 if (! $form->{$key_r}) {
139 my $query = $self->cgix->make_form($form);
140 $form->{$key_r} = $self->script_name . $self->path_info . ($query ? "?$query" : "");
143 $form->{'had_form_data'} = $had_form_info;
145 my $data = $self->last_auth_data;
146 eval { die defined($data) ? $data : "Requesting credentials" };
148 ### allow for a sleep to help prevent brute force
149 sleep($self->failed_sleep) if defined($data) && $data->error ne 'Login expired' && $self->failed_sleep;
154 ###----------------------------------------------------------------###
156 sub script_name
{ shift-
>{'script_name'} || $ENV{'SCRIPT_NAME'} || die "Missing SCRIPT_NAME" }
158 sub path_info
{ shift-
>{'path_info'} || $ENV{'PATH_INFO'} || '' }
160 sub server_time
{ time }
164 $self->{'cgix'} = shift if $#_ != -1;
165 return $self->{'cgix'} ||= CGI
::Ex-
>new;
170 $self->{'form'} = shift if $#_ != -1;
171 return $self->{'form'} ||= $self->cgix->get_form;
176 $self->{'cookies'} = shift if $#_ != -1;
177 return $self->{'cookies'} ||= $self->cgix->get_cookies;
183 my $key = $args->{'key'};
184 $self->cgix->set_cookie({
190 delete $self->cookies->{$key};
196 my $key = $args->{'key'};
197 my $val = $args->{'val'};
198 $self->cgix->set_cookie({
201 ($args->{'no_expires'} ? () : (-expires
=> '+20y')), # let the expires time take care of things for types that self expire
204 $self->cookies->{$key} = $val;
207 sub location_bounce
{
210 return $self->cgix->location_bounce($url);
213 ###----------------------------------------------------------------###
215 sub key_logout
{ shift-
>{'key_logout'} ||= 'cea_logout' }
216 sub key_cookie
{ shift-
>{'key_cookie'} ||= 'cea_user' }
217 sub key_user
{ shift-
>{'key_user'} ||= 'cea_user' }
218 sub key_pass
{ shift-
>{'key_pass'} ||= 'cea_pass' }
219 sub key_time
{ shift-
>{'key_time'} ||= 'cea_time' }
220 sub key_save
{ shift-
>{'key_save'} ||= 'cea_save' }
221 sub key_expires_min
{ shift-
>{'key_expires_min'} ||= 'cea_expires_min' }
222 sub form_name
{ shift-
>{'form_name'} ||= 'cea_form' }
223 sub key_verify
{ shift-
>{'key_verify'} ||= 'cea_verify' }
224 sub key_redirect
{ shift-
>{'key_redirect'} ||= 'cea_redirect' }
225 sub key_payload
{ shift-
>{'key_payload'} ||= 'cea_payload' }
226 sub secure_hash_keys
{ shift-
>{'secure_hash_keys'} ||= [] }
227 sub no_cookie_verify
{ shift-
>{'no_cookie_verify'} ||= 0 }
228 sub use_crypt
{ shift-
>{'use_crypt'} ||= 0 }
229 sub use_blowfish
{ shift-
>{'use_blowfish'} ||= '' }
230 sub use_plaintext
{ my $s = shift; $s->use_crypt || ($s->{'use_plaintext'} ||= 0) }
231 sub use_base64
{ my $s = shift; $s->{'use_base64'} = 1 if ! defined $s->{'use_base64'}; $s->{'use_base64'} }
232 sub expires_min
{ my $s = shift; $s->{'expires_min'} = 6 * 60 if ! defined $s->{'expires_min'}; $s->{'expires_min'} }
233 sub failed_sleep
{ shift-
>{'failed_sleep'} ||= 0 }
235 sub logout_redirect
{
237 return $self->{'logout_redirect'} || $self->script_name ."?loggedout=1";
242 return $self->{'js_uri_path'} ||= $self->script_name ."/js";
245 ###----------------------------------------------------------------###
247 sub no_cookies_print
{
249 $self->cgix->print_content_type;
250 print qq{<div style="border: 2px solid black;background:red;color:white">You do not appear to have cookies enabled.</div>};
256 my $hash = $self->login_hash_common;
257 my $template = $self->login_template;
259 ### allow for a hooked override
260 if (my $meth = $self->{'login_print'}) {
261 $meth->($self, $template, $hash);
265 ### process the document
266 require CGI
::Ex
::Template
;
267 my $cet = CGI
::Ex
::Template-
>new($self->template_args);
269 $cet->process_simple($template, $hash, \
$out) || die $cet->error;
271 ### fill in form fields
272 require CGI
::Ex
::Fill
;
273 CGI
::Ex
::Fill
::fill
({text
=> \
$out, form
=> $hash});
276 $self->cgix->print_content_type;
284 return $self->{'template_args'} ||= {
285 INCLUDE_PATH
=> $self->template_include_path,
289 sub template_include_path
{ shift-
>{'template_include_path'} || '' }
291 sub login_hash_common
{
293 my $form = $self->form;
294 my $data = $self->last_auth_data;
295 $data = {} if ! defined $data;
299 error
=> ($form->{'had_form_data'}) ? "Login Failed" : "",
301 key_user
=> $self->key_user,
302 key_pass
=> $self->key_pass,
303 key_time
=> $self->key_time,
304 key_save
=> $self->key_save,
305 key_expires_min
=> $self->key_expires_min,
306 key_payload
=> $self->key_payload,
307 key_redirect
=> $self->key_redirect,
308 form_name
=> $self->form_name,
309 script_name
=> $self->script_name,
310 path_info
=> $self->path_info,
311 md5_js_path
=> $self->js_uri_path ."/CGI/Ex/md5.js",
312 use_plaintext
=> $self->use_plaintext,
313 $self->key_user => $data->{'user'} || '',
314 $self->key_pass => '', # don't allow for this to get filled into the form
315 $self->key_time => $self->server_time,
316 $self->key_payload => $self->generate_payload({%$data, login_form
=> 1}),
317 $self->key_expires_min => $self->expires_min,
318 text_user
=> $self->text_user,
319 text_pass
=> $self->text_pass,
320 text_save
=> $self->text_save,
324 ###----------------------------------------------------------------###
329 my $token = delete $args->{'token'} || die "Missing token";
330 my $data = $self->{'_last_auth_data'} = $self->new_auth_data({token
=> $token, %$args});
332 ### token already parsed
334 $data->add_data({%$token, armor
=> 'none'});
336 ### parse token for info
340 for my $armor ('none', 'base64', 'blowfish') { # try with and without base64 encoding
341 my $copy = ($armor eq 'none') ? $token
342 : ($armor eq 'base64') ? eval { local $^W; decode_base64
($token) }
343 : ($key = $self->use_blowfish) ? decrypt_blowfish
($token, $key)
345 if ($copy =~ m
|^ ([^/]+) / (\d
+) / (-?\d+) / (.*) / ([a-fA-F0-9]{32}) (?: / (sh\
.\d
+\
.\d
+))? $|x
) {
352 secure_hash
=> $6 || '',
357 } elsif ($copy =~ m
|^ ([^/]+) / (.*) $|x
) {
368 $data->error('Invalid token');
374 ### verify the user and get the pass
376 if (! defined($data->{'user'})) {
377 $data->error('Missing user');
379 } elsif (! defined $data->{'test_pass'}) {
380 $data->error('Missing test_pass');
382 } elsif (! $self->verify_user($data->{'user'} = $self->cleanup_user($data->{'user'}))) {
383 $data->error('Invalid user');
385 } elsif (! defined($pass = eval { $self->get_pass_by_user($data->{'user'}) })) {
386 $data->add_data({details
=> $@});
387 $data->error('Could not get pass');
388 } elsif (ref $pass eq 'HASH') {
390 $pass = exists($extra->{'real_pass'}) ? delete($extra->{'real_pass'})
391 : exists($extra->{'password'}) ? delete($extra->{'password'})
392 : do { $data->error('Data returned by get_pass_by_user did not contain real_pass or password'); undef };
393 $data->error('Invalid login') if ! defined $pass && ! $data->error;
394 $data->add_data($extra);
396 return $data if $data->error;
399 ### store - to allow generate_token to not need to relookup the pass
400 $data->add_data({real_pass
=> $pass});
403 ### looks like a secure_hash cram
404 if ($data->{'secure_hash'}) {
405 $data->add_data(type
=> 'secure_hash_cram');
406 my $array = eval {$self->secure_hash_keys };
408 $data->error('secure_hash_keys not found');
409 } elsif (! @$array) {
410 $data->error('secure_hash_keys empty');
411 } elsif ($data->{'secure_hash'} !~ /^sh\.(\d+)\.(\d+)$/ || $1 > $#$array) {
412 $data->error('Invalid secure hash');
416 my $real = $data->{'real_pass'} =~ /^[a-f0-9]{32}$/ ? lc($data->{'real_pass'}) : md5_hex
($data->{'real_pass'});
417 my $str = join("/", @{$data}{qw(user cram_time expires_min payload)});
418 my $sum = md5_hex
($str .'/'. $real .('/sh.'.$array->[$rand1].'.'.$rand2));
419 if ($data->{'expires_min'} > 0
420 && ($self->server_time - $data->{'cram_time'}) > $data->{'expires_min'} * 60) {
421 $data->error('Login expired');
422 } elsif (lc($data->{'test_pass'}) ne $sum) {
423 $data->error('Invalid login');
427 ### looks like a normal cram
428 } elsif ($data->{'cram_time'}) {
429 $data->add_data(type
=> 'cram');
430 my $real = $data->{'real_pass'} =~ /^[a-f0-9]{32}$/ ? lc($data->{'real_pass'}) : md5_hex
($data->{'real_pass'});
431 my $str = join("/", @{$data}{qw(user cram_time expires_min payload)});
432 my $sum = md5_hex
($str .'/'. $real);
433 if ($data->{'expires_min'} > 0
434 && ($self->server_time - $data->{'cram_time'}) > $data->{'expires_min'} * 60) {
435 $data->error('Login expired');
436 } elsif (lc($data->{'test_pass'}) ne $sum) {
437 $data->error('Invalid login');
441 } elsif ($data->{'real_pass'} =~ m
|^([./0-9A-Za-z]{2})([./0-9A-Za-z
]{11})$|
442 && crypt($data->{'test_pass'}, $1) eq $data->{'real_pass'}) {
443 $data->add_data(type
=> 'crypt', was_plaintext
=> 1);
445 ### failed plaintext crypt
446 } elsif ($self->use_crypt) {
447 $data->error('Invalid login');
448 $data->add_data(type
=> 'crypt', was_plaintext
=> ($data->{'test_pass'} =~ /^[a-f0-9]{32}$/ ? 0 : 1));
450 ### plaintext and md5
452 my $is_md5_t = $data->{'test_pass'} =~ /^[a-f0-9]{32}$/;
453 my $is_md5_r = $data->{'real_pass'} =~ /^[a-f0-9]{32}$/;
454 my $test = $is_md5_t ? lc($data->{'test_pass'}) : md5_hex
($data->{'test_pass'});
455 my $real = $is_md5_r ? lc($data->{'real_pass'}) : md5_hex
($data->{'real_pass'});
456 $data->add_data(type
=> ($is_md5_r ? 'md5' : 'plaintext'), was_plaintext
=> ($is_md5_t ? 0 : 1));
457 $data->error('Invalid login')
461 ### check the payload
462 if (! $data->error && ! $self->verify_payload($data->{'payload'})) {
463 $data->error('Invalid payload');
471 return CGI
::Ex
::Auth
::Data-
>new(@_);
474 sub last_auth_data
{ shift-
>{'_last_auth_data'} }
478 my $data = shift || $self->last_auth_data;
479 die "Can't generate a token off of a failed auth" if ! $data;
483 ### do kinds that require staying plaintext
484 if ( (defined($data->{'use_plaintext'}) ? $data->{'use_plaintext'} : $self->use_plaintext) # ->use_plaintext is true if ->use_crypt is
485 || (defined($data->{'use_crypt'}) && $data->{'use_crypt'})
486 || (defined($data->{'type'}) && $data->{'type'} eq 'crypt')) {
487 $token = $data->{'user'} .'/'. $data->{'real_pass'};
489 ### all other types go to cram - secure_hash_cram, cram, plaintext and md5
491 my $user = $data->{'user'} || die "Missing user";
492 my $real = defined($data->{'real_pass'}) ? ($data->{'real_pass'} =~ /^[a-f0-9]{32}$/ ? lc($data->{'real_pass'}) : md5_hex
($data->{'real_pass'}))
493 : die "Missing real_pass";
494 my $exp = defined($data->{'expires_min'}) ? $data->{'expires_min'} : $self->expires_min;
495 my $load = $self->generate_payload($data);
496 die "Payload can not contain a \"/\. Please escape it in generate_payload." if $load =~ m
|/|;
497 die "User can not contain a \"/\." if $user =~ m
|/|;
500 if (! $data->{'prefer_cram'}
501 && ($array = eval { $self->secure_hash_keys })
503 my $rand1 = int(rand @$array);
504 my $rand2 = int(rand 100000);
505 my $str = join("/", $user, $self->server_time, $exp, $load);
506 my $sum = md5_hex
($str .'/'. $real .('/sh.'.$array->[$rand1].'.'.$rand2));
507 $token = $str .'/'. $sum . '/sh.'.$rand1.'.'.$rand2;
509 my $str = join("/", $user, $self->server_time, $exp, $load);
510 my $sum = md5_hex
($str .'/'. $real);
511 $token = $str .'/'. $sum;
515 if (my $key = $data->{'use_blowfish'} || $self->use_blowfish) {
516 $token = encrypt_blowfish
($token, $key);
518 } elsif (defined($data->{'use_base64'}) ? $data->{'use_base64'} : $self->use_base64) {
519 $token = encode_base64
($token, '');
525 sub generate_payload
{
528 return defined($args->{'payload'}) ? $args->{'payload'} : '';
534 if (my $meth = $self->{'verify_user'}) {
535 return $meth->($self, $user);
543 if (my $meth = $self->{'cleanup_user'}) {
544 return $meth->($self, $user);
549 sub get_pass_by_user
{
552 if (my $meth = $self->{'get_pass_by_user'}) {
553 return $meth->($self, $user);
556 die "Please override get_pass_by_user";
562 if (my $meth = $self->{'verify_payload'}) {
563 return $meth->($self, $payload);
568 ###----------------------------------------------------------------###
570 sub encrypt_blowfish
{
571 my ($str, $key) = @_;
573 require Crypt
::Blowfish
;
574 my $cb = Crypt
::Blowfish-
>new($key);
576 $str .= (chr 0) x
(8 - length($str) % 8); # pad to multiples of 8
579 $enc .= unpack "H16", $cb->encrypt($1) while $str =~ /\G(.{8})/g; # 8 bytes at a time
584 sub decrypt_blowfish
{
585 my ($enc, $key) = @_;
587 require Crypt
::Blowfish
;
588 my $cb = Crypt
::Blowfish-
>new($key);
591 $str .= $cb->decrypt(pack "H16", $1) while $enc =~ /\G([A-Fa-f0-9]{16})/g;
597 ###----------------------------------------------------------------###
601 return $self->{'login_template'} if $self->{'login_template'};
604 . $self->login_header
606 . $self->login_script
607 . $self->login_footer;
612 return shift-
>{'login_header'} || q
{
613 [%~ TRY
; PROCESS
'login_header.tt' ; CATCH %]<!-- [% error
%] -->[% END ~%]
618 return shift-
>{'login_footer'} || q
{
619 [%~ TRY
; PROCESS
'login_footer.tt' ; CATCH %]<!-- [% error
%] -->[% END ~%]
624 return shift-
>{'login_form'} || q
{
625 <div
class="login_chunk">
626 <span
class="login_error">[% error
%]</span
>
627 <form
class="login_form" name
="[% form_name %]" method="post" action
="[% script_name %][% path_info %]">
628 <input type
="hidden" name
="[% key_redirect %]" value
="">
629 <input type
="hidden" name
="[% key_payload %]" value
="">
630 <input type
="hidden" name
="[% key_time %]" value
="">
631 <input type
="hidden" name
="[% key_expires_min %]" value
="">
632 <table
class="login_table">
633 <tr
class="login_username">
634 <td
>[% text_user
%]</td
>
635 <td
><input name
="[% key_user %]" type
="text" size
="30" value
=""></td
>
637 <tr
class="login_password">
638 <td
>[% text_pass
%]</td
>
639 <td
><input name
="[% key_pass %]" type
="password" size
="30" value
=""></td
>
641 <tr
class="login_save">
643 <input type
="checkbox" name
="[% key_save %]" value
="1"> [% text_save
%]
646 <tr
class="login_submit">
647 <td colspan
="2" align
="right">
648 <input type
="submit" value
="Submit">
657 sub text_user
{ my $self = shift; return defined($self->{'text_user'}) ? $self->{'text_user'} : 'Username:' }
658 sub text_pass
{ my $self = shift; return defined($self->{'text_pass'}) ? $self->{'text_pass'} : 'Password:' }
659 sub text_save
{ my $self = shift; return defined($self->{'text_save'}) ? $self->{'text_save'} : 'Save Password ?' }
663 [%~ IF
! use_plaintext
%]
664 <script src
="[% md5_js_path %]"></script
>
666 if (document
.md5_hex
) document
.[% form_name
%].onsubmit
= function
() {
667 var f
= document
.[% form_name
%];
668 var u
= f
.[% key_user
%].value
;
669 var p
= f
.[% key_pass
%].value
;
670 var t
= f
.[% key_time
%].value
;
671 var s
= f
.[% key_save
%] && f
.[% key_save
%].checked
? -1 : f
.[% key_expires_min
%].value
;
672 var l
= f
.[% key_payload
%].value
;
673 var r
= f
.[% key_redirect
%].value
;
675 var str
= u
+'/'+t
+'/'+s
+'/'+l
;
676 var sum
= document
.md5_hex
(str
+'/' + document
.md5_hex
(p
));
677 var loc
= f
.action
+ '?[% key_user %]='+escape
(str
+'/'+ sum
)+'&[% key_redirect %]='+escape
(r
);
687 ###----------------------------------------------------------------###
689 package CGI
::Ex
::Auth
::Data
;
693 'bool' => sub { ! shift-
>error },
695 '""' => sub { shift-
>as_string },
699 my ($class, $args) = @_;
700 return bless {%{ $args || {} }}, $class;
705 my $args = @_ == 1 ? shift : {@_};
706 @{ $self }{keys %$args} = values %$args;
712 $self->{'error'} = shift;
713 $self->{'error_caller'} = [caller];
715 return $self->{'error'};
720 return $self->error || ($self->{'user'} && $self->{'type'}) ? "Valid auth data" : "Unverified auth data";
723 ###----------------------------------------------------------------###
733 ### authorize the user
734 my $auth = CGI::Ex::Auth->get_valid_auth({
735 get_pass_by_user => \&get_pass_by_user,
739 sub get_pass_by_user {
742 my $pass = some_way_of_getting_password($user);
746 ### OR - if you are using a OO based CGI or Application
748 sub require_authentication {
751 return $self->{'auth'} = CGI::Ex::Auth->get_valid_auth({
752 get_pass_by_user => sub {
753 my ($auth, $user) = @_;
754 return $self->get_pass($user);
760 my ($self, $user) = @_;
761 return $self->loopup_and_cache_pass($user);
766 CGI::Ex::Auth allows for auto-expiring, safe and easy web based logins. Auth uses
767 javascript modules that perform MD5 hashing to cram the password on
768 the client side before passing them through the internet.
770 For the stored cookie you can choose to use cram mechanisms,
771 secure hash cram tokens, auto expiring logins (not cookie based),
772 and Crypt::Blowfish protection. You can also choose to keep
773 passwords plaintext and to use perl's crypt for testing
776 A downside to this module is that it does not use a session to
777 preserve state so get_pass_by_user has to happen on every request (any
778 authenticated area has to verify authentication each time). A plus is
779 that you don't need to use a session if you don't want to. It is up
780 to the interested reader to add caching to the get_pass_by_user
789 Constructor. Takes a hashref of properties as arguments.
791 Many of the methods which may be overridden in a subclass,
792 or may be passed as properties to the new constuctor such as in the following:
795 get_pass_by_user => \&my_pass_sub,
796 key_user => 'my_user',
797 key_pass => 'my_pass',
798 login_template => \"<form><input name=my_user ... </form>",
801 The following methods will look for properties of the same name. Each of these will be
832 template_include_path
843 =item C<generate_token>
845 Takes either an auth_data object from a auth_data returned by verify_token,
846 or a hashref of arguments.
848 Possible arguments are:
850 user - the username we are generating the token for
851 real_pass - the password of the user (if use_plaintext is false
852 and use_crypt is false, the password can be an md5sum
853 of the user's password)
854 use_blowfish - indicates that we should use Crypt::Blowfish to protect
855 the generated token. The value of this argument is used
856 as the key. Default is false.
857 use_base64 - indicates that we should use Base64 encoding to protect
858 the generated token. Default is true. Will not be
859 used if use_blowfish is true.
860 use_plaintext - indicates that we should keep the password in plaintext
861 use_crypt - also indicates that we should keep the password in plaintext
862 expires_min - says how many minutes until the generated token expires.
863 Values <= 0 indicate to not ever expire. Used only on cram
865 payload - a payload that will be passed to generate_payload and then
866 will be added to cram type tokens. It cannot contain a /.
867 prefer_cram - If the secure_hash_keys method returns keys, and it is a non-plaintext
868 token, generate_token will create a secure_hash_cram. Set
869 this value to true to tell it to use a normal cram. This
870 is generally only useful in testing.
872 The following are types of tokens that can be generated by generate_token. Each type includes
873 pseudocode and a sample of a generated that token.
877 real_pass := "123qwe"
878 token := join("/", user, real_pass);
881 token == "paul/123qwe"
884 token == "cGF1bC8xMjNxd2U="
886 use_blowfish := "foobarbaz"
887 token == "6da702975190f0fe98a746f0d6514683"
889 Notes: This token will be used if either use_plaintext or use_crypt is set.
890 The real_pass can also be the md5_sum of the password. If real_pass is an md5_sum
891 of the password but the get_pass_by_user hook returns the crypt'ed password, the
892 token will not be able to be verified.
896 real_pass := "123qwe"
897 server_time := 1148512991 # a time in seconds since epoch
898 expires_min := 6 * 60
899 payload := "something"
901 md5_pass := md5_sum(real_pass) # if it isn't already a 32 digit md5 sum
902 str := join("/", user, server_time, expires_min, payload, md5_pass)
903 md5_str := md5(sum_str)
904 token := join("/", user, server_time, expires_min, payload, md5_str)
907 token == "paul/1148512991/360/something/16d0ba369a4c9781b5981eb89224ce30"
910 token == "cGF1bC8xMTQ4NTEyOTkxLzM2MC9zb21ldGhpbmcvMTZkMGJhMzY5YTRjOTc4MWI1OTgxZWI4OTIyNGNlMzA="
912 Notes: use_blowfish is available as well
916 real_pass := "123qwe"
917 server_time := 1148514034 # a time in seconds since epoch
918 expires_min := 6 * 60
919 payload := "something"
920 secure_hash := ["aaaa", "bbbb", "cccc", "dddd"]
921 rand1 := 3 # int(rand(length(secure_hash)))
922 rand2 := 39163 # int(rand(100000))
924 md5_pass := md5_sum(real_pass) # if it isn't already a 32 digit md5 sum
926 sh_str1 := join(".", "sh", secure_hash[rand1], rand2)
927 sh_str2 := join(".", "sh", rand1, rand2)
928 str := join("/", user, server_time, expires_min, payload, md5_pass, sh_str1)
929 md5_str := md5(sum_str)
930 token := join("/", user, server_time, expires_min, payload, md5_str, sh_str2)
933 token == "paul/1148514034/360/something/06db2914c9fd4e11499e0652bcf67dae/sh.3.39163"
935 Notes: use_blowfish is available as well. The secure_hash keys need to be set in the
936 "secure_hash_keys" property of the CGI::Ex::Auth object.
938 =item C<get_valid_auth>
940 Performs the core logic. Returns an auth object on successful login.
941 Returns false on errored login (with the details of the error stored in
942 $@). If a false value is returned, execution of the CGI should be halted.
943 get_valid_auth WILL NOT automatically stop execution.
945 $auth->get_valid_auth || exit;
947 Optionally, the class and a list of arguments may be passed. This will create a
948 new object using the passed arguments, and then run get_valid_auth.
950 CGI::Ex::Auth->get_valid_auth({key_user => 'my_user'}) || exit;
954 Called if login errored. Defaults to printing a very basic (but
955 adequate) page loaded from login_template..
957 You will want to override it with a template from your own system.
958 The hook that is called will be passed the step to print (currently
959 only "get_login_info" and "no_cookies"), and a hash containing the
960 form variables as well as the following:
962 =item C<login_hash_common>
964 Passed to the template swapped during login_print.
966 %$form, # any keys passed to the login script
967 error # The text "Login Failed" if a login occurred
968 login_data # A login data object if they failed authentication.
969 key_user # $self->key_user, # the username fieldname
970 key_pass # $self->key_pass, # the password fieldname
971 key_time # $self->key_time, # the server time field name
972 key_save # $self->key_save, # the save password checkbox field name
973 key_payload # $self->key_payload, # the payload fieldname
974 key_redirect # $self->key_redirect, # the redirect fieldname
975 form_name # $self->form_name, # the name of the form
976 script_name # $self->script_name, # where the server will post back to
977 path_info # $self->path_info, # $ENV{PATH_INFO} if any
978 md5_js_path # $self->js_uri_path ."/CGI/Ex/md5.js", # script for cramming
979 use_plaintext # $self->use_plaintext, # used to avoid cramming
980 $self->key_user # $data->{'user'}, # the username (if any)
981 $self->key_pass # '', # intentional blankout
982 $self->key_time # $self->server_time, # the server's time
983 $self->key_payload # $data->{'payload'} # the payload (if any)
984 $self->key_expires_min # $self->expires_min # how many minutes crams are valid
985 text_user # $self->text_user # template text Username:
986 text_pass # $self->text_pass # template text Password:
987 text_save # $self->text_save # template text Save Password ?
991 If the form hash contains a true value in this field name, the current user will
992 be logged out. Default is "cea_logout".
996 The name of the auth cookie. Default is "cea_user".
1000 A field name used during a bounce to see if cookies exist. Default is "cea_verify".
1004 The form field name used to pass the username. Default is "cea_user".
1008 The form field name used to pass the password. Default is "cea_pass".
1012 Works in conjunction with key_expires_min. If key_save is true, then
1013 the cookie will be set to be saved for longer than the current session
1014 (If it is a plaintext variety it will be given a 20 year life rather
1015 than being a session cookie. If it is a cram variety, the expires_min
1016 portion of the cram will be set to -1). If it is set to false, the cookie
1017 will be available only for the session (If it is a plaintext variety, the cookie
1018 will be session based and will be removed on the next loggout. If it is
1019 a cram variety then the cookie will only be good for expires_min minutes.
1021 Default is "cea_save".
1023 =item C<key_expires_min>
1025 The name of the form field that contains how long cram type cookies will be valid
1026 if key_save contains a false value.
1028 Default key name is "cea_expires_min". Default field value is 6 * 60 (six hours).
1030 This value will have no effect when use_plaintext or use_crypt is set.
1032 A value of -1 means no expiration.
1034 =item C<failed_sleep>
1036 Number of seconds to sleep if the passed tokens are invalid. Does not apply
1037 if validation failed because of expired tokens. Default value is 0.
1038 Setting to 0 disables any sleeping.
1042 The name of the html login form to attach the javascript to. Default is "cea_form".
1044 =item C<verify_token>
1046 This method verifies the token that was passed either via the form or via cookies.
1047 It will accept plaintext or crammed tokens (A listing of the available algorithms
1048 for creating tokes is listed below). It also allows for armoring the token with
1049 base64 encoding, or using blowfish encryption. A listing of creating these tokens
1050 can be found under generate_token.
1052 =item C<cleanup_user>
1054 Called by verify_token. Default is to do no modification. Allows for usernames to
1055 be lowercased, or canonized in some other way. Should return the cleaned username.
1057 =item C<verify_user>
1059 Called by verify_token. Single argument is the username. May or may not be an
1060 initial check to see if the username is ok. The username will already be cleaned at
1061 this point. Default return is true.
1063 =item C<get_pass_by_user>
1065 Called by verify_token. Given the cleaned, verified username, should return a
1066 valid password for the user. It can always return plaintext. If use_crypt is
1067 enabled, it should return the crypted password. If use_plaintext and use_crypt
1068 are not enabled, it may return the md5 sum of the password.
1070 get_pass_by_user => sub {
1071 my ($auth_obj, $user) = @_;
1072 my $pass = $some_obj->get_pass({user => $user});
1076 Alternately, get_pass_by_user may return a hashref of data items that
1077 will be added to the data object if the token is valid. The hashref
1078 must also contain a key named real_pass or password that contains the
1079 password. Note that keys passed back in the hashref that are already
1080 in the data object will override those in the data object.
1082 get_pass_by_user => sub {
1083 my ($auth_obj, $user) = @_;
1084 my ($pass, $user_id) = $some_obj->get_pass({user => $user});
1087 user_id => $user_id,
1093 Returns a CGI::Ex object.
1097 A hash of passed form info. Defaults to CGI::Ex::get_form.
1101 The current cookies. Defaults to CGI::Ex::get_cookies.
1103 =item C<login_template>
1105 Should return either a template filename to use for the login template, or it
1106 should return a reference to a string that contains the template. The contents
1107 will be used in login_print and passed to the template engine.
1109 Default login_template is the values of login_header, login_form, login_script, and
1110 login_script concatenated together.
1112 Values from login_hash_common will be passed to the template engine, and will
1113 also be used to fill in the form.
1115 The basic values are capable of handling most needs so long as appropriate
1116 headers and css styles are used.
1118 =item C<login_header>
1120 Should return a header to use in the default login_template. The default
1121 value will try to PROCESS a file called login_header.tt that should be
1122 located in directory specified by the template_include_path method.
1124 It should ideally supply css styles that format the login_form as desired.
1126 =item C<login_footer>
1128 Same as login_header - but for the footer. Will look for login_footer.tt by
1133 An html chunk that contains the necessary form fields to login the user. The
1134 basic chunk has a username text entry, password text entry, save password checkbox,
1135 and submit button, and any hidden fields necessary for logging in the user.
1137 =item C<login_script>
1139 Contains javascript that will attach to the form from login_form. This script
1140 is capable of taking the login_fields and creating an md5 cram which prevents
1141 the password from being passed plaintext.
1143 =item C<text_user, text_pass, text_save>
1145 The text items shown in the default login template. The default values are:
1147 text_user "Username:"
1148 text_pass "Password:"
1149 text_save "Save Password ?"
1155 Paul Seamons <paul at seamons dot com>
This page took 0.129177 seconds and 5 git commands to generate.