gitweb.dragonflybsd.org Git - dragonfly.git/blame_incremental

... / ...

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