NAME

genpw - (Gen)erate random password/strings, with (p)atterns and (w)ordlists

VERSION

This document describes version 0.014 of genpw (from Perl distribution App-genpw), released on 2024-08-06.

SYNOPSIS

genpw --help (or -h, -?)

genpw --version (or -v)

DESCRIPTION

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

Allow specifying pattern(s), e.g. '%8a%s' means 8 random alphanumeric characters followed by a symbol.
Use words from wordlists.
Use strong random source when available, otherwise fallback to Perl's builtin rand().

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 WordList::* modules. You need to install the genpw-wordlist CLI. By default, will use wordlist from WordList::EN::Enable:

% genpw -p '%(wordlist:EN::Enable)w%4d'

% 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 '%(u)8h-%(u)4h-%(u)4h-%(u)4h-%(u)12h'
CA333840-6132-33A1-9C31-F2FF20EDB3EA

% genpw -p '%()(Str::uc)8h-%()(Str::uc)4h-%()(Str::uc)4h-%()(Str::uc)4h-%()(Str::uc)12h'
CA333840-6132-33A1-9C31-F2FF20EDB3EA

% 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 ~/genpw.conf:

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

then:

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

Even more (real-world) examples:

# Generate a few random Tokopedia/Shopee voucher codes (5 alphanumeric characters)
% genpw -p '%()(Str::uppercase)5a' 4

Keywords: generate, pattern, wordlist

OPTIONS

* marks required options.

Main options

--action=s

Default value:

"gen"

Valid values:

["gen","list-patterns"]

--case=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.

--len=s, -l

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

--list-patterns

Shortcut for --action=list-patterns.

See --action.

--max-len=s

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

--min-len=s

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

--num=s, -n

Default value:

Can also be specified as the 1st command-line argument.

--pattern=s@, -p

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)(Str::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).

Filter names are modules in the Data::Sah::Filter::perl:: namespace (without the prefix). To list available filters, you can use pmlist or list-sah-filter-rule-modules:

% pmlist 'Data::Sah::Filter::perl::**'
% list-sah-filter-rule-modules --perl

Can be specified multiple times.

--patterns-json=s

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

See --pattern.

-L

Shortcut for --case=lower.

See --case.

-U

Shortcut for --case=upper.

See --case.

Configuration options

--config-path=s, -c

Set path to configuration file.

Can actually be specified multiple times to instruct application to read from multiple configuration files (and merge them).

--config-profile=s, -P

Set configuration profile to use.

A single configuration file can contain profiles, i.e. alternative sets of values that can be selected. For example:

[profile=dev]
username=foo
pass=beaver

[profile=production]
username=bar
pass=honey

When you specify --config-profile=dev, username will be set to foo and password to beaver. When you specify --config-profile=production, username will be set to bar and password to honey.

--no-config, -C

Do not use any configuration file.

If you specify --no-config, the application will not read any configuration file.

Environment options

--no-env

Do not read environment for default options.

If you specify --no-env, the application wil not read any environment variable.

Output options

--format=s

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

Default value:

undef

Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

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]

--page-result

Filter output through a pager.

This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.

--view-result

View output using a viewer.

This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.

Other options

--help, -h, -?: Display help message and exit.
--version, -v: Display program's version and exit.

COMPLETION

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

bash

To activate bash completion for this script, put:

complete -C genpw genpw

in your bash startup (e.g. ~/.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 cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

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

in your tcsh startup (e.g. ~/.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 shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

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

By default, these names are searched for configuration filenames (can be changed using --config-path): /home/u1/.config/genpw.conf, /home/u1/genpw.conf, or /etc/genpw.conf.

All found files will be read and merged.

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

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

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

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [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.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

[plugin=DumpArgs]
-event=before_validate_args
-prio=99

[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

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)

ENVIRONMENT

GENPW_OPT

String. Specify additional command-line options.

FILES

/home/u1/.config/genpw.conf

/home/u1/genpw.conf

/etc/genpw.conf

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-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 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

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.

To install App::genpw, copy and paste the appropriate command in to your terminal.

cpanm

cpanm App::genpw

CPAN shell

perl -MCPAN -e shell
install App::genpw

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

OPTIONS

Main options

Configuration options

Environment options

Output options

Other options

COMPLETION

bash

tcsh

other shells

CONFIGURATION FILE

ENVIRONMENT

GENPW_OPT

FILES

/home/u1/.config/genpw.conf

/home/u1/genpw.conf

/etc/genpw.conf

HOMEPAGE

SOURCE

SEE ALSO

AUTHOR

CONTRIBUTING

COPYRIGHT AND LICENSE

BUGS

Module Install Instructions