The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Data::Password::Filter - Interface to the password filter.

VERSION

Version 0.14

DESCRIPTION

The module is a simple attempt to convert an article written by Christopher Frenz on the topic "The Development of a Perl-based Password Complexity Filter".However I took the liberty to add my flavour on top of it.

http://perl.sys-con.com/node/1911661

CONSTRUCTOR

Below is the list parameters that can be passed to the constructor. None of the parameters are mandatory. The format of user dictionary should be one word perl line. It only uses the word longer than 3 characters from the user dictionary, if supplied.

    +-----------------------+---------------------------------------------------+
    | Key                   | Description                                       |
    +-----------------------+---------------------------------------------------+
    | length                | Length of the password. Default is 8.             |
    |                       |                                                   |
    | min_lowercase_letter  | Minimum number of alphabets (a..z) in lowercase.  |
    |                       | Default is 1.                                     |
    |                       |                                                   |
    | min_uppercase_letter  | Minimum number of alphabets (A..Z) in uppercase.  |
    |                       | Default is 1.                                     |
    |                       |                                                   |
    | min_special_character | Minimum number of special characters.Default is 1.|
    |                       |                                                   |
    | min_digit             | Minimum number of digits (0..9). Default is 1.    |
    |                       |                                                   |
    | check_variation       | 1 or 0, depending whether checking variation.     |
    |                       | Default is 1.                                     |
    |                       |                                                   |
    | check_dictionary      | 1 or 0, depending whether checking dictionary.    |
    |                       | Default is 1.                                     |
    |                       |                                                   |
    | user_dictionary       | User supplied dictionary file location. Default   |
    |                       | use its own.                                      |
    +-----------------------+---------------------------------------------------+

The check_variation key, when set 1, looks for password that only vary by one character from a dictionary word.

SPECIAL CHARACTERS

Currently considers the following characters as special:

    !   "   #   $   %   &   '   (   \   |   )
    )   *   +   ,   -   .   /   :   ;   <   =
    >   ?   @   [   \   ]   ^   _   `   {   |
    }   ~

METHODS

strength($password)

Returns the strength of the given password and tt is case insensitive.

    +----------------+------------+
    | Score (s)      | Strength   |
    +----------------+------------+
    | s <= 50%       | Very weak. |
    | 50% < s <= 70% | Weak.      |
    | 70% < s <= 90% | Good.      |
    | s > 90%        | Very good. |
    +----------------+------------+

    use strict; use warnings;
    use Data::Password::Filter;

    my $password = Data::Password::Filter->new();
    print "Strength: " . $password->strength('Ab12345?') . "\n";

score($password)

Returns the score (percentage) of the given password or the previous password for which the strength has been calculated.

    use strict; use warnings;
    use Data::Password::Filter;

    my $password = Data::Password::Filter->new();
    print "Score   : " . $password->score('Ab12345?')    . "\n";

    $password = Data::Password::Filter->new();
    print "Strength: " . $password->strength('Ab54321?') . "\n";
    print "Score   : " . $password->score()              . "\n";

as_string()

Returns the filter detail.

    use strict; use warnings;
    use Data::Password::Filter;

    my $password = Data::Password::Filter->new();
    print "Strength: " . $password->strength('Ab12345?') . "\n";
    print "Score   : " . $password->score('Ab12345?')    . "\n";
    print $password->as_string() . "\n";

AUTHOR

Mohammad S Anwar, <mohammad.anwar at yahoo.com>

REPOSITORY

https://github.com/manwar/Data-Password-Filter

BUGS

Please report any bugs or feature requests to bug-data-password-filter at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Data-Password-Filter. 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::Filter

You can also look for information at:

ACKNOWLEDGEMENT

Christopher Frenz, author of "Visual Basic and Visual Basic .NET for Scientists and Engineers" (Apress) and "Pro Perl Parsing" (Apress).

LICENSE AND COPYRIGHT

Copyright (C) 2011 - 2015 Mohammad S Anwar.

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.