NAME
    App::genpw::wordlist - Generate password with words from WordList::*

VERSION
    This document describes version 0.010 of App::genpw::wordlist (from Perl
    distribution App-genpw-wordlist), released on 2024-01-23.

SYNOPSIS
    See the included script genpw-wordlist.

FUNCTIONS
  genpw
    Usage:

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

    Generate password with words from WordList::*.

    Examples:

    *   Generate some passwords from the default English (EN::Enable)
        wordlist:

         genpw(num => 8, wordlists => ["ID::KBBI"]);

    *   Generate some passwords from Indonesian words:

         genpw(num => 8, wordlists => ["ID::KBBI"]);

    *   Generate some passwords with specified pattern (see genpw
        documentation for details of pattern):

         genpw(
             num => 5,
           patterns => ["%w%8\$10d-%w%8\$10d-%8\$10d%w"],
           wordlists => ["ID::KBBI"]
         );

    Using password from dictionary words (in this case, from WordList::*)
    can be useful for humans when remembering the password. Note that using
    a string of random characters is generally better because of the larger
    space (combination). Using a password of two random words from a
    5000-word wordlist has a space of only ~25 million while an 8-character
    of random uppercase letters/lowercase letters/numbers has a space of
    62^8 = ~218 trillion. To increase the space you'll need to use more
    words (e.g. 3 to 5 instead of just 2). This is important if you are
    using the password for something that can be bruteforced quickly e.g.
    for protecting on-disk ZIP/GnuPG file and the attacker has access to
    your file. It is then recommended to use a high number of rounds for
    hashing to slow down password cracking (e.g. "--s2k-count 65011712" in
    GnuPG).

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   action => *str* (default: "gen")

        (No description)

    *   case => *str* (default: "default")

        Force casing.

        "default" means to not change case. "random" changes casing some
        letters randomly to lower-/uppercase. "lower" forces lower case.
        "upper" forces UPPER CASE. "title" forces Title case.

    *   num => *int* (default: 1)

        (No description)

    *   patterns => *array[str]*

        Pattern(s) to use.

        CONVERSION (%P). A pattern is string that is roughly similar to a
        printf pattern:

         %P

        where "P" is certain letter signifying a conversion. This will be
        replaced with some other string according to the conversion. An
        example is the %h conversion which will be replaced with hexdigit.

        LENGTH (%NP). A non-negative integer ("N") can be specified before
        the conversion to signify desired length, for example, %4w will
        return a random word of length 4.

        MINIMUM AND MAXIMUM LENGTH ("%M$NP"). If two non-negative integers
        separated by "$" is specified before the conversion, this specify
        desired minimum and maximum length. For example, "%4$10h" will be
        replaced with between 4 and 10 hexdigits.

        ARGUMENT AND FILTERS ("%(arg)P", "%(arg)(filter1)(...)P"). Finally,
        an argument followed by zero or more filters can be specified
        (before the lengths) and before the conversion. For example,
        "%(wordlist:ID::KBBI)w" will be replaced by a random word from the
        wordlist WordList::ID::KBBI. Another example, "%()(Str::uc)4$10h"
        will be replaced by between 4-10 uppercase hexdigits, and
        "%(arraydata:Sample::DeNiro)(Str::underscore_non_latin_alphanums)(St
        r::lc)(Str::ucfirst)w" will be replaced with a random movie title of
        Robert De Niro, where symbols are replaced with underscore then the
        string will be converted into lowercase and the first character
        uppercased, e.g. "Dear_america_letters_home_from_vietnam".

        Anything else will be left as-is.

        Available conversions:

         %l   Random Latin letter (A-Z, a-z)
         %d   Random digit (0-9)
         %h   Random hexdigit (0-9a-f in lowercase [default] or 0-9A-F in uppercase).
              Known arguments:
              - "u" (to use the uppercase instead of the default lowercase digits)
         %a   Random letter/digit (Alphanum) (A-Z, a-z, 0-9; combination of %l and %d)
         %s   Random ASCII symbol, e.g. "-" (dash), "_" (underscore), etc.
         %x   Random letter/digit/ASCII symbol (combination of %a and %s)
         %m   Base64 character (A-Z, a-z, 0-9, +, /)
         %b   Base58 character (A-Z, a-z, 0-9 minus IOl0)
         %B   Base56 character (A-Z, a-z, 0-9 minus IOol01)
         %%   A literal percent sign
         %w   Random word. Known arguments:
              - "stdin:" (for getting the words from stdin, the default)
              - "wordlist:NAME" (for getting the words from a L<WordList> module)
              - "arraydata:NAME" (for getting the words from an L<ArrayData> module, the
                Role::TinyCommons::Collection::PickItems::RandomPos will be applied).

        Filters are modules in the "Data::Sah::Filter::perl::" namespace.

    *   wordlists => *array[perl::wordlist::modname_with_optional_args]*

        (No description)

    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-genpw-wordlist>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-genpw-wordlist>.

SEE ALSO
    genpw (from App::genpw)

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) 2024, 2020, 2018 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-genpw-wordlist>

    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.

