/ 
App-genpw-0.010
River stage one • 7 direct dependents • 8 total dependents
/ genpw

NAME

genpw - Generate random password, with patterns and wordlists

VERSION

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

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]

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

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

then:

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

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:

1
--pattern=s@, -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.

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

--config-profile=s, -P

Set configuration profile to use.

--no-config, -C

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

Output options

--format=s

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

Default value:

undef
--json

Set output format to json.

--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]
--page-result

Filter output through a pager.

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): ~/.config/genpw.conf, ~/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.

Finally, you can 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 has value equals something: [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 something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [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.

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 => str

Specify additional command-line options.

FILES

~/.config/genpw.conf

~/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.

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.

SEE ALSO

genpw-base56.

genpw-base64.

genpw-id.

genpw-wordlist.

AUTHOR

perlancar <perlancar@cpan.org>

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.