xref: /netbsd/lib/libutil/pw_getconf.3 (revision bf9ec67e)
1.\"	$NetBSD: pw_getconf.3,v 1.5 2002/02/07 07:00:52 ross Exp $
2.\"
3.\" Copyright 1997 Niels Provos <provos@physnet.uni-hamburg.de>
4.\" All rights reserved.
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.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"      This product includes software developed by Niels Provos.
17.\" 4. The name of the author may not be used to endorse or promote products
18.\"    derived from this software without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.\" from OpenBSD: pw_getconf.3,v 1.5 1999/09/21 04:52:46 csapuntz Exp
32.\"
33.Dd July 6, 2000
34.Dt PW_GETCONF 3
35.Os
36.Sh NAME
37.Nm pw_getconf
38.Nd password encryption configuration access function
39.Sh LIBRARY
40.Lb libutil
41.Sh SYNOPSIS
42.Fd #include \*[Lt]util.h\*[Gt]
43.Ft void
44.Fn pw_getconf "char *data" "size_t len" "const char *key" "const char *option"
45.Sh DESCRIPTION
46The
47.Fn pw_getconf
48function reads
49.Pa /etc/passwd.conf
50and retrieves the value of the option specified
51by
52.Pa option
53from the section given by
54.Pa key .
55If no suitable entry is found
56for the
57.Pa key
58an empty string will be returned in data.
59.Pp
60To retrieve default values the key
61.Pa default
62can be used.  In this case, if
63.Pa /etc/passwd.conf
64does not exist or does not contain a
65.Pa default
66section, the built-in defaults will be returned.  They are as follows:
67.Bl -column localcipher data -offset indent
68.It Sy option	data
69.It ypcipher	old
70.It localcipher	old
71.El
72.Pp
73An empty string is returned for all errors.
74.Sh FILES
75.Bl -tag -width /etc/passwd.conf -compact
76.It Pa /etc/passwd.conf
77.El
78.Sh SEE ALSO
79.Xr passwd 5 ,
80.Xr passwd.conf 5
81.Sh HISTORY
82The
83.Fn pw_getconf
84function first appeared in
85.Nx 1.6 .
86