#!perl

# Note: This script is a CLI for Riap function /App/genpw/genpw
# and generated automatically using Perinci::CmdLine::Gen version 0.496

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2020-05-22'; # DATE
our $DIST = 'App-genpw'; # DIST
our $VERSION = '0.011'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any;

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/genpw/genpw",
    program_name => "genpw",
    use_utf8 => 1,
);

$cmdline->run;

# ABSTRACT: Generate random password, with patterns and wordlists
# PODNAME: genpw

__END__

=pod

=encoding UTF-8

=head1 NAME

genpw - Generate random password, with patterns and wordlists

=head1 VERSION

This document describes version 0.011 of genpw (from Perl distribution App-genpw), released on 2020-05-22.

=head1 SYNOPSIS

Usage:

 % genpw [-L] [-U] [--action=s] [--case=s] [--config-path=path | -c]
     [--config-profile=profile | -P] [--format=name] [--json] [-l=s]
     [--len=s] [--list-patterns] [--max-len=s] [--min-len=s]
     [--(no)naked-res] [--no-config | -C] [--no-env] [-p=s+]
     [--page-result[=program]] [--pattern=s+] [--patterns-json=s] [num]

=head1 DESCRIPTION

This is yet another utility to generate random password. Features:

=over

=item * Allow specifying pattern(s), e.g. '%8a%s' means 8 random alphanumeric
characters followed by a symbol.

=item * Use words from wordlists.

=item * Use strong random source when available, otherwise fallback to Perl's builtin
C<rand()>.

=back

Examples:

By default generate base56 password 12-20 characters long (-p %12$20B):

 % genpw
 Uk7Zim6pZeMTZQUyaM

Generate 5 passwords instead of 1:

 % genpw 5
 igYiRhUb5t9d9f3J
 b7D44pnxZHJGQzDy2eg
 RXDtqjMvp2hNAdQ
 Xz3DmAL94akqtZ5xb
 7TfANv9yxAaMGXm

Generate random digits between 10 and 12 characters long:

 % genpw -p '%10$12d'
 55597085674

Generate password in the form of a random word + 4 random digits. Words will be
fed from STDIN:

 % genpw -p '%w%4d' < /usr/share/dict/words
 shafted0412

Like the above, but words will be fetched from C<WordList::*> modules. You need
to install the L<genpw-wordlist> CLI. By default, will use wordlist from
L<WordList::EN::Enable>:

 % genpw-wordlist -p '%w%4d'
 sedimentologists8542

Generate a random GUID:

 % genpw -p '%8h-%4h-%4h-%4h-%12h'
 ff26d142-37a8-ecdf-c7f6-8b6ae7b27695

Like the above, but in uppercase:

 % genpw -p '%8h-%4h-%4h-%4h-%12h' -U
 22E13D9E-1187-CD95-1D05-2B92A09E740D

Use configuration file to avoid typing the pattern every time, put this in
C<~/genpw.conf>:

 [profile=guid]
 patterns = "%8h-%4h-%4h-%4h-%12h"

then:

 % genpw -P guid
 008869fa-177e-3a46-24d6-0900a00e56d5

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--action>=I<s>

Default value:

 "gen"

Valid values:

 ["gen","list-patterns"]

=item B<--case>=I<s>

Force casing.

Default value:

 "default"

Valid values:

 ["default","random","lower","upper","title"]

`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.


=item B<--len>=I<s>, B<-l>

If no pattern is supplied, will generate random alphanum characters with this exact length.

=item B<--list-patterns>

Shortcut for --action=list-patterns.

See C<--action>.

=item B<--max-len>=I<s>

If no pattern is supplied, will generate random alphanum characters with this maximum length.

=item B<--min-len>=I<s>

If no pattern is supplied, will generate random alphanum characters with this minimum length.

=item B<--num>=I<s>, B<-n>

Default value:

 1

=item B<--pattern>=I<s@>, B<-p>

Pattern(s) to use.

A pattern is string that is similar to a printf pattern. %P (where P is certain
letter signifying a format) will be replaced with some other string. %Nw (where
N is a number) will be replaced by a word of length N, %N$MP (where N and M is a
number) will be replaced by a word of length between N and M. Anything else will
be used as-is. Available conversions:

    %l   Random Latin letter (A-Z, a-z)
    %d   Random digit (0-9)
    %h   Random hexdigit (0-9a-f)
    %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


Can be specified multiple times.

=item B<--patterns-json>=I<s>

Pattern(s) to use (JSON-encoded).

See C<--pattern>.

=item B<-L>

Shortcut for --case=lower.

See C<--case>.

=item B<-U>

Shortcut for --case=upper.

See C<--case>.

=back

=head2 Configuration options

=over

=item B<--config-path>=I<s>, B<-c>

Set path to configuration file.

=item B<--config-profile>=I<s>, B<-P>

Set configuration profile to use.

=item B<--no-config>, B<-C>

Do not use any configuration file.

=back

=head2 Environment options

=over

=item B<--no-env>

Do not read environment for default options.

=back

=head2 Output options

=over

=item B<--format>=I<s>

Choose output format, e.g. json, text.

Default value:

 undef

=item B<--json>

Set output format to json.

=item B<--naked-res>

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd
element) as well as result metadata/extra result (4th element) instead of just
the result (3rd element). However, sometimes you want just the result, e.g. when
you want to pipe the result for more post-processing. In this case you can use
`--naked-res` so you just get:

    [1,2,3]


=item B<--page-result>

Filter output through a pager.

=back

=head2 Other options

=over

=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--version>, B<-v>

Display program's version and exit.

=back

=head1 COMPLETION

This script has shell tab completion capability with support for several
shells.

=head2 bash

To activate bash completion for this script, put:

 complete -C genpw genpw

in your bash startup (e.g. F<~/.bashrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is recommended, however, that you install modules using L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete genpw 'p/*/`genpw`/'

in your tcsh startup (e.g. F<~/.tcshrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is also recommended to install L<shcompgen> (see above).

=head2 other shells

For fish and zsh, install L<shcompgen> as described above.

=head1 CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of L<IOD>, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F<~/.config/genpw.conf>, F<~/genpw.conf>, or F</etc/genpw.conf>.

All found files will be read and merged.

To disable searching for configuration files, pass C<--no-config>.

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.

You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable has value equals something: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal something: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when an environment variable contains something: C<[env=HOSTNAME*=server ...]> or C<[SOMESECTION env=HOSTNAME*=server ...]>. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

 action (see --action)
 case (see --case)
 format (see --format)
 len (see --len)
 max_len (see --max-len)
 min_len (see --min-len)
 naked_res (see --naked-res)
 num (see --num)
 patterns (see --pattern)

=head1 ENVIRONMENT

=head2 GENPW_OPT => str

Specify additional command-line options.

=head1 FILES

F<~/.config/genpw.conf>

F<~/genpw.conf>

F</etc/genpw.conf>

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-genpw>.

=head1 SOURCE

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

=head1 BUGS

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

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.

=head1 SEE ALSO

L<genpw-base56>.

L<genpw-base64>.

L<genpw-id>.

L<genpw-wordlist>.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2018 by 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.

=cut