CatalystX::Usul::Users::Unix - User data store for the Unix OS
Describes v0.17.$Rev: 1 $
use CatalystX::Usul::Users::Unix; my $class = CatalystX::Usul::Users::Unix; my $user_obj = $class->new( $attr );
User storage model for the Unix operating system
Defines the following attributes
A hash ref which maps the field names used by the user model onto the field names used by the OS
A hash ref which details the features supported by the OS user data store
A path to a file coerced from an array ref which defaults to /etc/passwd
An instance of File::UnixAuth
The name of the hashing algorithm to use when creating new accounts. Defaults to SHA-512
SHA-512
Overrides the attribute in the parent class. This is the name of the class that manages roles (groups). It defaults to CatalystX::Usul::Roles::Unix
A path to a file coerced from an array ref which defaults to /etc/shadow
Returns a domain model user object for the specified user or throws an exception if the user does not exist
Calls the suid wrapper to change the users password
Calls the suid wrapper to check the users password
Calls the suid wrapper to create a new user account, populate the home directory and create a mail alias for the users email address to the new account
Calls the suid wrapper to delete the users mail alias and then delete the account
Sets the password to *DISABLED* disabling the account
*DISABLED*
Returns a hashref of features supported by this store. Can be checked using supports
Returns the users primary role (group) id from the /etc/passwd file
Returns a hashref containing the data fields for the requested user. Maps the field name specific to the store to those used by the identity model
Returns the list of users the share the given primary role (group) id
Returns true if the user exists, false otherwise
Returns the list of usernames matching the given pattern
Calls the suid wrapper to set the users password to a given value
Calls the suid wrapper to update the user account information
Calls the suid wrapper to create a report about the user accounts in this store
Called by check_password in the parent class. This method execute the external setuid root wrapper to validate the password provided
None
There are no known incompatibilities in this module
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Peter Flanigan, <Support at RoxSoft.co.uk>
<Support at RoxSoft.co.uk>
Copyright (c) 2014 Peter Flanigan. All rights reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic
This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
To install CatalystX::Usul, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CatalystX::Usul
CPAN shell
perl -MCPAN -e shell install CatalystX::Usul
For more information on module installation, please visit the detailed CPAN module installation guide.