.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "String::MkPasswd 3pm" .TH String::MkPasswd 3pm "2013-10-20" "perl v5.18.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" String::MkPasswd \- random password generator .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use String::MkPasswd qw(mkpasswd); \& \& print mkpasswd(); \& \& # for the masochisticly paranoid... \& print mkpasswd( \& \-length => 27, \& \-minnum => 5, \& \-minlower => 1, # minlower is increased if necessary \& \-minupper => 5, \& \-minspecial => 5, \& \-distribute => 1, \& ); .Ve .SH "ABSTRACT" .IX Header "ABSTRACT" This Perl library defines a single function, \f(CW\*(C`mkpasswd()\*(C'\fR, to generate random passwords. The function is meant to be a simple way for developers and system administrators to easily generate a relatively secure password. .SH "DESCRIPTION" .IX Header "DESCRIPTION" The exportable \f(CW\*(C`mkpasswd()\*(C'\fR function returns a single scalar: a random password. By default, this password is nine characters long with a random distribution of four lower-case characters, two upper-case characters, two digits, and one non-alphanumeric character. These parameters can be tuned by the user, as described in the \*(L"\s-1ARGUMENTS\*(R"\s0 section. .SS "\s-1ARGUMENTS\s0" .IX Subsection "ARGUMENTS" The \f(CW\*(C`mkpasswd()\*(C'\fR function takes an optional hash of arguments. .IP "\-length" 4 .IX Item "-length" The total length of the password. The default is 9. .IP "\-minnum" 4 .IX Item "-minnum" The minimum number of digits that will appear in the final password. The default is 2. .IP "\-minlower" 4 .IX Item "-minlower" The minimum number of lower-case characters that will appear in the final password. The default is 2. .IP "\-minupper" 4 .IX Item "-minupper" The minimum number of upper-case characters that will appear in the final password. The default is 2. .IP "\-minspecial" 4 .IX Item "-minspecial" The minimum number of non-alphanumeric characters that will appear in the final password. The default is 1. .IP "\-distribute" 4 .IX Item "-distribute" If set to a true value, password characters will be distributed between the left\- and right-hand sides of the keyboard. This makes it more difficult for an onlooker to see the password as it is typed. The default is false. .IP "\-noambiguous" 4 .IX Item "-noambiguous" If set to a true value, password characters will not include any that might be mistaken for others. This is particularly helpful if you're distributing a printed list of passwords to a group of people. The default is false. .IP "\-fatal" 4 .IX Item "-fatal" If set to a true value, \f(CW\*(C`mkpasswd()\*(C'\fR will \fICarp::croak()\fR rather than return \f(CW\*(C`undef\*(C'\fR on error. The default is false. .PP If \fB\-minnum\fR, \fB\-minlower\fR, \fB\-minupper\fR, and \fB\-minspecial\fR do not add up to \fB\-length\fR, \fB\-minlower\fR will be increased to compensate. However, if \fB\-minnum\fR, \fB\-minlower\fR, \fB\-minupper\fR, and \fB\-minspecial\fR add up to more than \fB\-length\fR, then \f(CW\*(C`mkpasswd()\*(C'\fR will return \f(CW\*(C`undef\*(C'\fR. See the section entitled \*(L"\s-1EXCEPTION HANDLING\*(R"\s0 for how to change this behavior. .SS "\s-1EXCEPTION HANDLING\s0" .IX Subsection "EXCEPTION HANDLING" By default, \f(CW\*(C`mkpasswd()\*(C'\fR will return \f(CW\*(C`undef\*(C'\fR if it cannot generate a password. Some people are inclined to exception handling, so \&\fBString::MkPasswd\fR does its best to accommodate them. If the variable \&\f(CW$String::MkPasswd::FATAL\fR is set to a true value, \f(CW\*(C`mkpasswd()\*(C'\fR will \&\fICarp::croak()\fR with an error instead of returning \f(CW\*(C`undef\*(C'\fR. .SS "\s-1EXPORT\s0" .IX Subsection "EXPORT" None by default. The \f(CW\*(C`mkpasswd()\*(C'\fR method is exportable. .SH "SEE ALSO" .IX Header "SEE ALSO" , \fImkpasswd\fR\|(1) .SH "AKNOWLEDGEMENTS" .IX Header "AKNOWLEDGEMENTS" Don Libes of the National Institute of Standards and Technology, who wrote the Expect example, \fImkpasswd\fR\|(1). .SH "AUTHOR" .IX Header "AUTHOR" Chris Grau .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (C) 2003\-2012 by Chris Grau .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.1 or, at your option, any later version of Perl 5 you may have available.