xref: /netbsd-src/lib/libutil/pw_getconf.3 (revision 481fca6e59249d8ffcf24fef7cfbe7b131bfb080)
1.\"	$NetBSD: pw_getconf.3,v 1.3 2000/07/10 11:21:32 ad 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 SYNOPSIS
40.Fd #include <util.h>
41.Ft void
42.Fn pw_getconf "char *data" "size_t len" "const char *key" "const char *option"
43.Sh DESCRIPTION
44The
45.Fn pw_getconf
46function reads
47.Pa /etc/passwd.conf
48and retrieves the value of the option specified
49by
50.Pa option
51from the section given by
52.Pa key .
53If no suitable entry is found
54for the
55.Pa key
56an empty string will be returned in data.
57.Pp
58To retrieve default values the key
59.Pa default
60can be used.  In this case, if
61.Pa /etc/passwd.conf
62does not exist or does not contain a
63.Pa default
64section, the built-in defaults will be returned.  They are as follows:
65.Bl -column localcipher data -offset indent
66.It Sy option	data
67.It ypcipher	old
68.It localcipher	old
69.El
70.Pp
71An empty string is returned for all errors.
72.Sh FILES
73.Bl -tag -width /etc/passwd.conf -compact
74.It Pa /etc/passwd.conf
75.El
76.Sh SEE ALSO
77.Xr passwd 5 ,
78.Xr passwd.conf 5
79.Sh HISTORY
80The
81.Fn pw_getconf
82function first appeared in
83.Nx 1.6 .
84