Added 'description' class attribute to every command class (to help the
[python/dscho.git] / Doc / lib / libcrypt.tex
blobf9d161509d2d9d30dc0dd9182f633844b11ec721
1 \section{\module{crypt} ---
2 Function used to check \UNIX{} passwords}
4 \declaremodule{builtin}{crypt}
5 \platform{Unix}
6 \modulesynopsis{The \cfunction{crypt()} function used to check \UNIX{}
7 passwords.}
8 \moduleauthor{Steven D. Majewski}{sdm7g@virginia.edu}
9 \sectionauthor{Steven D. Majewski}{sdm7g@virginia.edu}
12 This module implements an interface to the \manpage{crypt}{3} routine,
13 which is a one-way hash function based upon a modified DES algorithm;
14 see the \UNIX{} man page for further details. Possible uses include
15 allowing Python scripts to accept typed passwords from the user, or
16 attempting to crack \UNIX{} passwords with a dictionary.
17 \index{crypt(3)}
19 \begin{funcdesc}{crypt}{word, salt}
20 \var{word} will usually be a user's password. \var{salt} is a
21 2-character string which will be used to select one of 4096 variations
22 of DES\indexii{cipher}{DES}. The characters in \var{salt} must be
23 either \character{.}, \character{/}, or an alphanumeric character.
24 Returns the hashed password as a string, which will be composed of
25 characters from the same alphabet as the salt.
26 \end{funcdesc}
28 The module and documentation were written by Steve Majewski.
29 \index{Majewski, Steve}