/ 
App-PasswordWordListUtils-0.002
River stage one • 1 direct dependent • 1 total dependent
/ App::PasswordWordListUtils

NAME

App::PasswordWordListUtils - Command-line utilities related to checking string against password wordlists

VERSION

This document describes version 0.002 of App::PasswordWordListUtils (from Perl distribution App-PasswordWordListUtils), released on 2022-08-20.

SYNOPSIS

This distribution provides the following command-line utilities:

DESCRIPTION

FUNCTIONS

exists_in_password_wordlist

Usage:

exists_in_password_wordlist(%args) -> [$status_code, $reason, $payload, \%result_meta]

Check that string(s) match(es) word in a password wordlist.

Password wordlist is one of WordList::* modules, without the prefix.

Since many password wordlist uses bloom filter, that means there's a possibility of false positive (e.g. 0.1% chance; see each password wordlist for more details).

This function is not exported.

Arguments ('*' denotes required arguments):

  • quiet => bool

  • strings* => array[str]

  • wordlist => perl::wordlist::modname (default: "Password::10Million::Top1000000")

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-PasswordWordListUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-PasswordWordListUtils.

SEE ALSO

WordList::Password::* modules, e.g. WordList::Password::10Million::Top1000000.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2020 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-PasswordWordListUtils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.