The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Data-Password-Simple-0.05
River stage one • 1 direct dependent • 1 total dependent
++
/ Data::Password::Simple

NAME

Data::Password::Simple provides a system of checking given strings against password complexity requirements.

Current features:

Case-insensitive dictionary word checking.
Minimum password length checking.

VERSION

Version 0.05

SYNOPSIS

    use Data::Password::Simple;

    my $checker = Data::Password::Simple->new(
        length => 6,
        dictionary => '/usr/share/dict/words'
    );

    $is_suitable = $checker->check($password) ? "yes" : "no";

CLASS METHODS

new

Input

length

Optional. The minimum password length required. Supply 0 to disable length checking.

Default is 6.

dictionary

Optional. Enables dictionary checking.

Accepts either a word list, or a file location. NOTE dictionary checking is case-insensitive.

Default is to disable dictionary checking

Output

    Returns a Data::Password::Simple object.

OBJECT METHODS

dictionary

Set or unset the dictionary used for word checking.

Input

    Expects a either a list, a file location scalar or undef

    Setting undef disables dictionary checking. Setting a dictionary enables it.

Output

    Returns true value if the dictionary is successfully updated, a false value otherwise.

required_length

Access the minimum required password length.

Input

    Optional. The new minimum password length required.

Output

    Returns new minimum length value or current value if no new value is suppplied.

check

Checks a given password against the specified criteria

Input

        Expects a scalar password

Output

        =item OK

    Returns a true value if the password is okay.

If called in a list context, also returns:

status
acceptable

Supplied with true value if the password meets requirements.

error

Only provided when the password fails to meet requirements.

Contains the following:

too_short

True value if the password is too short to meet the current length requirement.

in_dictionary

True value if the password matches a dictionary word.

AUTHOR

Ross Hayes, <ross at abablabab.co.uk>

BUGS

Please report any bugs or feature requests to bug-data-password-simple at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Data-Password-Simple. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Data::Password::Simple

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2013 Ross Hayes.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.