diff options
author | Zack Weinberg <zackw@panix.com> | 2018-06-29 16:53:37 +0200 |
---|---|---|
committer | Florian Weimer <fweimer@redhat.com> | 2018-06-29 16:53:37 +0200 |
commit | 841785bad14dfad81a0af94900310141c59f26a4 (patch) | |
tree | 9fba8a7c16596dcb9652576f9322c810eb0cf682 /manual/terminal.texi | |
parent | 6ab902e4decd89c1a9206497d14ddba7680bfc37 (diff) | |
download | glibc-841785bad14dfad81a0af94900310141c59f26a4.tar.gz glibc-841785bad14dfad81a0af94900310141c59f26a4.tar.xz glibc-841785bad14dfad81a0af94900310141c59f26a4.zip |
manual: Revise crypt.texi.
This is a major rewrite of the description of 'crypt', 'getentropy', and 'getrandom'. A few highlights of the content changes: - Throughout the manual, public headers, and user-visible messages, I replaced the term "password" with "passphrase", the term "password database" with "user database", and the term "encrypt(ion)" with "(one-way) hashing" whenever it was applied to passphrases. I didn't bother making this change in internal code or tests. The use of the term "password" in ruserpass.c survives, because that refers to a keyword in netrc files, but it is adjusted to make this clearer. There is a note in crypt.texi explaining that they were traditionally called passwords but single words are not good enough anymore, and a note in users.texi explaining that actual passphrase hashes are found in a "shadow" database nowadays. - There is a new short introduction to the "Cryptographic Functions" section, explaining how we do not intend to be a general-purpose cryptography library, and cautioning that there _are_, or have been, legal restrictions on the use of cryptography in many countries, without getting into any kind of detail that we can't promise to keep up to date. - I added more detail about what a "one-way function" is, and why they are used to obscure passphrases for storage. I removed the paragraph saying that systems not connected to a network need no user authentication, because that's a pretty rare situation nowadays. (It still says "sometimes it is necessary" to authenticate the user, though.) - I added documentation for all of the hash functions that glibc actually supports, but not for the additional hash functions supported by libxcrypt. If we're going to keep this manual section around after the transition is more advanced, it would probably make sense to add them then. - There is much more detailed discussion of how to generate a salt, and the failure behavior for crypt is documented. (Returning an invalid hash on failure is what libxcrypt does; Solar Designer's notes say that this was done "for compatibility with old programs that assume crypt can never fail".) - As far as I can tell, the header 'crypt.h' is entirely a GNU invention, and never existed on any other Unix lineage. The function 'crypt', however, was in Issue 1 of the SVID and is now in the XSI component of POSIX. I tried to make all of the @standards annotations consistent with this, but I'm not sure I got them perfectly right. - The genpass.c example has been improved to use getentropy instead of the current time to generate the salt, and to use a SHA-256 hash instead of MD5. It uses more random bytes than is strictly necessary because I didn't want to complicate the code with proper base64 encoding. - The testpass.c example has three hardwired hashes now, to demonstrate that different one-way functions produce different hashes for the same input. It also demonstrates how DES hashing only pays attention to the first eight characters of the input. - There is new text explaining in more detail how a CSPRNG differs from a regular random number generator, and how getentropy/getrandom are not exactly a CSPRNG. I tried not to make specific falsifiable claims here. I also tried to make the blocking/cancellation/error behavior of both getentropy and getrandom clearer.
Diffstat (limited to 'manual/terminal.texi')
-rw-r--r-- | manual/terminal.texi | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/manual/terminal.texi b/manual/terminal.texi index 0b275fc002..d830baacd7 100644 --- a/manual/terminal.texi +++ b/manual/terminal.texi @@ -24,7 +24,7 @@ descriptor is and how to open a file descriptor for a terminal device. * Line Control:: Sending break sequences, clearing terminal buffers @dots{} * Noncanon Example:: How to read single characters without echo. -* getpass:: Prompting the user for a password. +* getpass:: Prompting the user for a passphrase. * Pseudo-Terminals:: How to open a pseudo-terminal. @end menu @@ -1873,9 +1873,9 @@ handlers for job control signals that reset terminal modes. The above example does so. @node getpass -@section Reading Passwords +@section Reading Passphrases -When reading in a password, it is desirable to avoid displaying it on +When reading in a passphrase, it is desirable to avoid displaying it on the screen, to help keep it secret. The following function handles this in a convenient way. @@ -1884,7 +1884,7 @@ in a convenient way. @safety{@prelim{}@mtunsafe{@mtasuterm{}}@asunsafe{@ascuheap{} @asulock{} @asucorrupt{}}@acunsafe{@acuterm{} @aculock{} @acucorrupt{}}} @c This function will attempt to create a stream for terminal I/O, but @c will fallback to stdio/stderr. It attempts to change the terminal -@c mode in a thread-unsafe way, write out the prompt, read the password, +@c mode in a thread-unsafe way, write out the prompt, read the passphrase, @c then restore the terminal mode. It has a cleanup to close the stream @c in case of (synchronous) cancellation, but not to restore the @c terminal mode. @@ -1892,14 +1892,14 @@ in a convenient way. @code{getpass} outputs @var{prompt}, then reads a string in from the terminal without echoing it. It tries to connect to the real terminal, @file{/dev/tty}, if possible, to encourage users not to put plaintext -passwords in files; otherwise, it uses @code{stdin} and @code{stderr}. +passphrases in files; otherwise, it uses @code{stdin} and @code{stderr}. @code{getpass} also disables the INTR, QUIT, and SUSP characters on the terminal using the @code{ISIG} terminal attribute (@pxref{Local Modes}). The terminal is flushed before and after @code{getpass}, so that -characters of a mistyped password are not accidentally visible. +characters of a mistyped passphrase are not accidentally visible. In other C libraries, @code{getpass} may only return the first -@code{PASS_MAX} bytes of a password. @Theglibc{} has no limit, so +@code{PASS_MAX} bytes of a passphrase. @Theglibc{} has no limit, so @code{PASS_MAX} is undefined. The prototype for this function is in @file{unistd.h}. @code{PASS_MAX} |