[BACK]Return to getpass.3 CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / lib / libc / gen

Annotation of src/lib/libc/gen/getpass.3, Revision 1.13

1.13    ! jruoho      1: .\"    $NetBSD: getpass.3,v 1.12 2010/04/30 05:50:46 jruoho Exp $
1.4       cgd         2: .\"
                      3: .\" Copyright (c) 1989, 1991, 1993
                      4: .\"    The Regents of the University of California.  All rights reserved.
1.1       cgd         5: .\"
                      6: .\" Redistribution and use in source and binary forms, with or without
                      7: .\" modification, are permitted provided that the following conditions
                      8: .\" are met:
                      9: .\" 1. Redistributions of source code must retain the above copyright
                     10: .\"    notice, this list of conditions and the following disclaimer.
                     11: .\" 2. Redistributions in binary form must reproduce the above copyright
                     12: .\"    notice, this list of conditions and the following disclaimer in the
                     13: .\"    documentation and/or other materials provided with the distribution.
1.11      agc        14: .\" 3. Neither the name of the University nor the names of its contributors
1.1       cgd        15: .\"    may be used to endorse or promote products derived from this software
                     16: .\"    without specific prior written permission.
                     17: .\"
                     18: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     19: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     20: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     21: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     22: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     23: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     24: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     25: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     26: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     27: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     28: .\" SUCH DAMAGE.
                     29: .\"
1.4       cgd        30: .\"     @(#)getpass.3  8.1 (Berkeley) 6/4/93
1.1       cgd        31: .\"
1.13    ! jruoho     32: .Dd May 6, 2010
1.1       cgd        33: .Dt GETPASS 3
                     34: .Os
                     35: .Sh NAME
                     36: .Nm getpass
                     37: .Nd get a password
1.5       perry      38: .Sh LIBRARY
                     39: .Lb libc
1.1       cgd        40: .Sh SYNOPSIS
1.10      wiz        41: .In pwd.h
                     42: .In unistd.h
1.1       cgd        43: .Ft char *
                     44: .Fn getpass "const char *prompt"
                     45: .Sh DESCRIPTION
                     46: The
                     47: .Fn getpass
                     48: function displays a prompt to, and reads in a password from,
                     49: .Pa /dev/tty .
                     50: If this file is not accessible,
1.13    ! jruoho     51: .Fn getpass
1.1       cgd        52: displays the prompt on the standard error output and reads from the standard
                     53: input.
                     54: .Pp
                     55: The password may be up to _PASSWORD_LEN (currently 128)
                     56: characters in length.
                     57: Any additional
                     58: characters and the terminating newline character are discarded.
                     59: .Pp
1.13    ! jruoho     60: .Fn getpass
1.1       cgd        61: turns off character echoing while reading the password.
                     62: .Sh RETURN VALUES
1.13    ! jruoho     63: .Fn getpass
1.1       cgd        64: returns a pointer to the null terminated password.
                     65: .Sh FILES
1.3       jtc        66: .Bl -tag -width /dev/tty -compact
1.1       cgd        67: .It Pa /dev/tty
                     68: .El
                     69: .Sh SEE ALSO
                     70: .Xr crypt 3
1.12      jruoho     71: .Sh STANDARDS
                     72: The
                     73: .Fn getpass
                     74: function appeared in
                     75: .St -susv2 ,
                     76: but it was already marked as legacy.
                     77: The function was removed in the
                     78: .St -p1003.1-2001
                     79: standard.
1.1       cgd        80: .Sh HISTORY
                     81: A
1.13    ! jruoho     82: .Fn getpass
1.1       cgd        83: function appeared in
                     84: .At v7 .
                     85: .Sh BUGS
                     86: The
1.13    ! jruoho     87: .Fn getpass
1.1       cgd        88: function leaves its result in an internal static object and returns
                     89: a pointer to that object.
                     90: Subsequent calls to
1.13    ! jruoho     91: .Fn getpass
1.1       cgd        92: will modify the same object.
1.6       lukem      93: .Sh SECURITY CONSIDERATIONS
1.1       cgd        94: The calling process should zero the password as soon as possible to
                     95: avoid leaving the cleartext password visible in the process's address
                     96: space.

CVSweb <webmaster@jp.NetBSD.org>