logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Authen::Htpasswd::User - represents a user line in a .htpasswd file

Author

       David Kamholz "dkamholz@cpan.org"

       Yuval Kogman

Methods

new
           my $userobj = Authen::Htpasswd::User->new($username, $password[, @extra_info], \%options);

       Creates a user object. You may also specify the arguments and options together in a hash: "{ username =>
       $foo, password => $bar, extra_info => [$email, $name], ... }".

       encrypt_hash
       check_hashes
           See Authen::Htpasswd.

       hashed_password
           Explicitly sets the value of the hashed password, rather than generating it with "password".

   check_password
           $userobj->check_password($password,\@check_hashes);

       Returns whether the password matches. "check_hashes" is the same as for Authen::Htpasswd.

   usernamehashed_passwordextra_info(@fields)
       Get  and set the fields of the user line. These methods, as well as "password" and "set" below, write any
       changes immediately if the user was lookup up  from  an  Authen::Htpasswd  object.  If  the  username  is
       changed, the old entry is not preserved.

   password
           $userobj->password($newpass);

       Encrypts a new password. Dies if $newpass is not provided.

   set
           $userobj->set(item => $value, ...);

       Sets any of the four preceding values at once. Only writes the file once if it is going to be written.

   to_line
           $userobj->to_line;

       Returns a line for the user, suitable for printing to a ".htpasswd" file. There is no newline at the end.

Name

       Authen::Htpasswd::User - represents a user line in a .htpasswd file

Synopsis

           my $user = Authen::Htpasswd::User->new($username, $password[, @extra_info], \%options);
           my $user = $pwfile->lookup_user($username); # from Authen::Htpasswd object

           if ($user->check_password($password)) { ... }
           if ($user->hashed_password eq $foo) { ... }

           # these are written immediately if the user was looked up from an Authen::Htpasswd object
           $user->username('bill');
           $user->password('bar');
           $user->hashed_password('tIYAwma5mxexA');
           $user->extra_info('root', 'joe@site.com', 'Joe Sysadmin');
           $user->set(username => 'bill', password => 'foo'); # set several at once

           print $user->to_line, "\n";

See Also