diff options
author | Your Name <you@example.com> | 2021-03-12 23:24:07 +0000 |
---|---|---|
committer | Your Name <you@example.com> | 2021-03-12 23:24:07 +0000 |
commit | c289083ad82333df5cec93786f2e3ccabe84f530 (patch) | |
tree | ddb1271b801e707be168585cc43f778c65c64f2d /src | |
parent | aa61faccdba3f6389d153610a6c7c8abce484693 (diff) | |
download | cracklib-c289083ad82333df5cec93786f2e3ccabe84f530.tar.gz |
Merge man pages from Debian
These are man pages from Debian added from archive
http://ftp.us.debian.org/debian/pool/main/c/cracklib2/cracklib2_2.9.6-3.4.debian.tar.xz
Diffstat (limited to 'src')
-rw-r--r-- | src/doc/FascistCheck.3 | 89 | ||||
-rw-r--r-- | src/doc/Makefile.am | 6 | ||||
-rw-r--r-- | src/doc/cracklib-check.8 | 25 | ||||
-rw-r--r-- | src/doc/cracklib-format.8 | 123 | ||||
-rw-r--r-- | src/doc/update-cracklib.8 | 43 |
5 files changed, 286 insertions, 0 deletions
diff --git a/src/doc/FascistCheck.3 b/src/doc/FascistCheck.3 new file mode 100644 index 0000000..08fa234 --- /dev/null +++ b/src/doc/FascistCheck.3 @@ -0,0 +1,89 @@ +.\" source: +.\" /var/cvs/projects/debian/cracklib/debian/dpkg.src/cracklib2-dev.FascistCheck.3.in,v +.\" +.\" revision: +.\" @(#) cracklib2-dev.FascistCheck.3.in,v 1.6 1999/03/29 15:30:21 jplejacq Exp +.\" +.\" copyright: +.\" Copyright (C) 1998, 1999 Jean Pierre LeJacq <jplejacq@quoininc.com> +.\" +.\" Distributed under the GNU GENERAL PUBLIC LICENSE. +.\" +.TH FascistCheck 3 "Wed, 3 Oct 2001 01:37:09 +0100" "2.7-8.5" "Debian GNU/Linux manual" +.SH NAME +FascistCheck \- a pro-active password checker library +.SH SYNOPSIS +.B #include <crack.h> +.sp +.B "static char const CRACKLIB_DICTPATH[] = \ .\|.\|.;" +.sp +.B "extern char const *" +.br +.B "FascistCheck(char const passwd[], char const dictpath[]);" +.SH DESCRIPTION +cracklib is a library containing the +.B FascistCheck +C function which may be used in a "passwd" like program. The idea is +simple: try to prevent users from choosing passwords that could be +guessed by "crack" by filtering them out, at source. cracklib is an +offshoot of the the version 5 of the "crack" software and contains a +considerable number of ideas nicked from the new software. + +The first formal argument +.B password +is the potential password. The second formal argument +.B dictpath +is the full path name + filename prefix of the cracklib +dictionary database. +.B FascistCheck +returns +the NULL pointer for a good password, or a pointer to a diagnostic +string if it is a weak password. + +The database is in a binary format generated by the utilities +.BR crack_mkdict (8) +and +.BR crack_packer (8). +On a Debian system the database is located in the directory defined by +the static constant +.B CRACKLIB_DICTPATH +and is set to /var/cache/cracklib/cracklib_dict. None of the subroutines in the +cracklib libraries have this location hard-coded into their +implementations. It is generated daily with the program +/etc/cron.daily/cracklib. +.SH FILES +.TP +.I /var/cache/cracklib/cracklib_dict.[hwm|pwd|pwi] +cracklib dictionary database files used by utilities. +.TP +.I /etc/cron.daily/cracklib +cracklib daily cron program to rebuild the cracklib dictionary database. +.TP +.I /etc/cracklib/cracklib.conf +cracklib configuration file used by the cracklib daily cron program to +rebuild the cracklib dictionary database. +.TP +.I /usr/sbin/crack_mkdict +cracklib shell script to create initial list of words for dictionary +database. +.TP +.I /usr/share/doc/cracklib2-dev/examples +Example +.BR cc (1) +source files that show how +.B FascistCheck +is used. +.SH SEE ALSO +.BR crack_teststr (8), +.BR crack_mkdict (8), +.BR update\-cracklib (8) +.br +/usr/share/doc/cracklib2-dev/examples +.br +/usr/share/doc/cracklib2/cracklib2.html +.br +/usr/share/doc/cracklib2-dev/cracklib2-dev.html +.SH AUTHOR +.B cracklib2 +is written by Alec Muffett <alecm@crypto.dircon.co.uk>. Manual added +by Jean Pierre LeJacq <jplejacq@quoininc.com>. diff --git a/src/doc/Makefile.am b/src/doc/Makefile.am index 30bf3eb..a4d7b31 100644 --- a/src/doc/Makefile.am +++ b/src/doc/Makefile.am @@ -1 +1,7 @@ dist_pkgdata_DATA = cracklib.magic + +man_MANS = \ + update-cracklib.8 \ + cracklib-format.8 \ + cracklib-check.8 \ + FascistCheck.3
\ No newline at end of file diff --git a/src/doc/cracklib-check.8 b/src/doc/cracklib-check.8 new file mode 100644 index 0000000..e953a3b --- /dev/null +++ b/src/doc/cracklib-check.8 @@ -0,0 +1,25 @@ +.TH cracklib\-check 8 "Sat Jun 21 22:44:33 CEST 2008" "Jan Dittberner" +.SH NAME +cracklib\-check \- Check passwords using libcrack2 +.SH SYNOPSIS +.B cracklib\-check +.br + +.SH DESCRIPTION +.B cracklib\-check +takes a list of passwords from stdin and checks them via libcrack2's +.BR FascistCheck (3) +sub routine. + +.SH RESULT +.B cracklib\-check +prints each checked password and the corresponding result of +.BR FascistCheck (3) +to stdout. The password and the result are separated by a colon. + +.SH SEE ALSO +.BR FascistCheck (3) + +.SH AUTHOR +This man page was written by Jan Dittberner <jandd@debian.org> for +the Debian GNU/Linux System (but may be used by others). diff --git a/src/doc/cracklib-format.8 b/src/doc/cracklib-format.8 new file mode 100644 index 0000000..4f38efb --- /dev/null +++ b/src/doc/cracklib-format.8 @@ -0,0 +1,123 @@ +.\" source: +.\" /var/cvs/projects/debian/cracklib/debian/dpkg.src/cracklib-runtime.crack_mkdict.8.in,v +.\" +.\" revision: +.\" @(#) cracklib-runtime.crack_mkdict.8.in,v 1.7 1999/04/02 14:50:43 jplejacq Exp +.\" +.\" copyright: +.\" Copyright (C) 1998, 1999 Jean Pierre LeJacq <jplejacq@quoininc.com> +.\" +.\" Distributed under the GNU GENERAL PUBLIC LICENSE. +.\" +.TH cracklib\-format 8 "Sat Jun 21 22:43:12 CEST 2008" "2.7-8.5" "Debian GNU/Linux manual" +.SH NAME +cracklib\-format, cracklib\-packer, cracklib\-unpacker \- cracklib dictionary utilities +.SH SYNOPSIS +.B cracklib\-format +.IR file +.IR ... + +.B cracklib\-packer +.IR cracklib_dictpath + +.B cracklib\-unpacker +.IR cracklib_dictpath +.SH DESCRIPTION +.B cracklib\-format +takes a list of text files each containing a list of words, one per line, It +lowercases all words, removes control characters, and sorts the lists. It +outputs the cleaned up list to standard output. The text files may be +optionally compressed with +.BR gzip (1). + +If you supply massive amounts of text to +.B cracklib\-format +you must have enough free space available for use by the +.BR sort (1) +command. If you do not have 20Mb free in /var/tmp (or whatever +temporary area your +.BR sort (1) +command uses), have a look at the +.B /usr/sbin/cracklib\-format +program which is a +.BR sh (1) +program. You can usually tweak the +.BR sort (1) +command to use any large area of disk you desire, by use of the +.B \-T +option. +.B cracklib\-format +has a hook for this. + +.B cracklib\-packer +reads from standard input a list of sorted and cleaned words and +creates a database in the directory and prefix given by the command +line argument +.B cracklib_dictpath. +Three files are created with the suffixes of .hwm, .pwd, and .pwi. +These three files are in the format that the +.BR FascistCheck (3) +subroutine, +.BR cracklib\-unpacker (8), +and +.BR cracklib\-check (8), +utilities understand. The number of words read and written are printed on +.BR stdout (3). + +.B cracklib\-unpacker +reads from the database in the directory and prefix given by the command +line argument +.B cracklib_dictpath +and outputs on standard output the list of words that make up the +database. + +The database is in a binary format generated by the utilities +.BR cracklib\-format (8) +and +.BR cracklib\-packer (8). +On a Debian system the database is located in the directory +/var/cache/cracklib/cracklib_dict and is generated daily with the program +/etc/cron.daily/cracklib. The location is also defined in the +header file +.B crack.h +using the constant +.B CRACKLIB_DICTPATH +though none of the subroutines in the cracklib libraries have this +location hardcoded into their implementations. + +.SH FILES +.TP +.I /var/cache/cracklib/cracklib_dict.[hwm|pwd|pwi] +cracklib dictionary database files used by utilities. +.TP +.I /etc/cron.daily/cracklib +cracklib daily cron program to rebuild the cracklib dictionary database. +.TP +.I /etc/cracklib/cracklib.conf +cracklib configuration file used by the cracklib daily cron program to +rebuild the cracklib dictionary database. +.TP +.I /usr/include/crack.h +cracklib header file defining the subroutine +.BR FascistCheck(3) +and the constant +.B CRACKLIB_DICTPATH +used to compile in the location of the cracklib dictionary database for +these utilities. +.TP +.I /usr/sbin/cracklib\-format +cracklib shell script to create initial list of words for dictionary +database. +.SH SEE ALSO +.BR FascistCheck (3), +.BR cracklib\-check (8), +.BR update\-cracklib (8), +.BR create\-cracklib\-dict (8) +.br +/usr/share/doc/libcrack2/libcrack2.html +.br +/usr/share/doc/cracklib-runtime/cracklib-runtime.html +.SH AUTHOR +.B cracklib2 +is written by Alec Muffett <alecm@crypto.dircon.co.uk>. Manual added +by Jean Pierre LeJacq <jplejacq@quoininc.com>. diff --git a/src/doc/update-cracklib.8 b/src/doc/update-cracklib.8 new file mode 100644 index 0000000..bad3c86 --- /dev/null +++ b/src/doc/update-cracklib.8 @@ -0,0 +1,43 @@ +.TH update\-cracklib 8 "June 09, 2003" "Martin Pitt" +.SH NAME +update\-cracklib \- Regenerate cracklib dictionary +.SH SYNOPSIS +.B update\-cracklib +.br + +.SH DESCRIPTION +.B update\-cracklib +builds a compressed and accumulated version of wordlists stored in the +directories given in cracklib's configuration file +/etc/cracklib/cracklib.conf. Programs using cracklib2 need this +database to be of any use. +.PP +By default this script is called by cron every day. + +.SH RESULT +.B +update\-cracklib +prints out two numbers: the number of words read from the ASCII +dictionaries and the number of words eventually written into the +cracklib database; if no error occurred, these should be equal. +.PP +0 is returned on success, otherwise an error message is printed to +standard error and \-1 is returned. + +.SH FILES +.TP +.B /etc/cracklib/cracklib.conf +shell script that sets +.B +cracklib_dictpath_src +which must be a space separated list of source dictionary files. + +.SH SEE ALSO +.BR cracklib (3), +.BR crack_mkdict (8) + +.SH AUTHOR +This program and manual page was written by Martin Pitt +<martin@piware.de> for the Debian GNU/Linux System (but may be used by +others). + |