NAME

OpenXPKI::Server::API2::Plugin::Crypto::password_quality::Validate

DESCRIPTION

Worker class that performs the password checks defined in several Moose roles:

OpenXPKI::Server::API2::Plugin::Crypto::password_quality::CheckStandardRole
OpenXPKI::Server::API2::Plugin::Crypto::password_quality::CheckEntropyRole
OpenXPKI::Server::API2::Plugin::Crypto::password_quality::CheckLegacyRole

For more information about the checks see OpenXPKI::Server::API2::Plugin::Crypto::password_quality.

ATTRIBUTES

log

Something that provides these methods: "trace", "debug", "info", "warn", "error", "fatal".

Default: no logging

checks

Checks to be performed.

Default: see the roles that implement checks

password

The password to be tested.

METHODS

is_valid

Returns 1 if the given password passes all enabled checks, 0 otherwise.

Parameters:

$password Str - password to be tested

first_error_messages

Returns the error messages of the checks with the lowest complexity or "undef" if password is valid.

I.e. for a password failing "letters", "digits" and "entropy" checks the result are the "letters" nad "digits" error messages.

error_messages

Returns a list of error messages from all checks.

error_codes

Return a list of error codes from all checks. The error codes match the options (e.g. "mixed", "sequence").

METHODS FOR ROLES

The following methods are meant to be used by roles implementing password checks.

hook_register_checks

Hook for roles to register their available checks and set default checks.

Example usage:

    after hook_register_checks => sub {
        my $self = shift;
        $self->register_check(
            'partsequence'  => 'check_partsequence',
            'partdict'      => 'check_partdict',
        );
        $self->add_default_check(qw( partsequence partdict ));
    };

register_check

Example usage: see "hook_register_checks".

add_default_check

Enable the given list of checks by default (unless overridden by constructor parameter "checks").

Example usage: see "hook_register_checks".

hook_enable_checks

Hook for roles to enable checks based on specific conditions.

Example usage:

    after hook_enable_checks => sub {
        my $self = shift;
        $self->enable('partdict') and $self->disable('dict') if $self->has_min_dict_len;
    };

enable

Enable the given list of checks.

disable

Disable the given list of checks.

add_error

Adds the given error to the list of errors.

Parameters:

$error ArrayRef - Error specified as "[ error_code => message ]".: "error_code" should be equal to the name of the check.