xref: /freebsd/lib/libc/gen/getnetgrent.3 (revision 952d112864d8008aa87278a30a539d888a8493cd)
1.\" Copyright (c) 1992, 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.\"     @(#)getnetgrent.3	8.1 (Berkeley) 6/4/93
33.\"
34.Dd June 4, 1993
35.Dt GETNETGRENT 3
36.Os
37.Sh NAME
38.Nm getnetgrent ,
39.Nm innetgr ,
40.Nm setnetgrent ,
41.Nm endnetgrent
42.Nd netgroup database operations
43.Sh SYNOPSIS
44.Ft int
45.Fn getnetgrent "char **host" "char **user" "char **domain"
46.Ft int
47.Fn innetgr "const char *netgroup" "const char *host" "const char *user" "const char *domain"
48.Ft void
49.Fn setnetgrent "const char *netgroup"
50.Ft void
51.Fn endnetgrent void
52.Sh DESCRIPTION
53These functions operate on the netgroup database file
54.Pa /etc/netgroup
55which is described
56in
57.Xr netgroup 5 .
58The database defines a set of netgroups, each made up of one or more triples:
59.Bd -literal -offset indent
60(host, user, domain)
61.Ed
62that defines a combination of host, user and domain.
63Any of the three fields may be specified as ``wildcards'' that match any
64string.
65.Pp
66The function
67.Fn getnetgrent
68sets the three pointer arguments to the strings of the next member of the
69current netgroup.
70If any of the string pointers are
71.Sy (char *)0
72that field is considered a wildcard.
73.Pp
74The functions
75.Fn setnetgrent
76and
77.Fn endnetgrent
78set the current netgroup and terminate the current netgroup respectively.
79If
80.Fn setnetgrent
81is called with a different netgroup than the previous call, an implicit
82.Fn endnetgrent
83is implied.
84.Fn Setnetgrent
85also sets the offset to the first member of the netgroup.
86.Pp
87The function
88.Fn innetgr
89searches for a match of all fields within the specified group.
90If any of the
91.Sy host ,
92.Sy user ,
93or
94.Sy domain
95arguments are
96.Sy (char *)0
97those fields will match any string value in the netgroup member.
98.Sh RETURN VALUES
99The function
100.Fn getnetgrent
101returns 0 for ``no more netgroup members'' and 1 otherwise.
102The function
103.Fn innetgr
104returns 1 for a successful match and 0 otherwise.
105The functions
106.Fn setnetgrent
107and
108.Fn endnetgrent
109have no return value.
110.Sh FILES
111.Bl -tag -width /etc/netgroup -compact
112.It Pa /etc/netgroup
113netgroup database file
114.El
115.Sh SEE ALSO
116.Xr netgroup 5
117.Sh COMPATIBILITY
118The netgroup members have three string fields to maintain compatibility
119with other vendor implementations, however it is not obvious what use the
120.Sy domain
121string has within BSD.
122.Sh BUGS
123The function
124.Fn getnetgrent
125returns pointers to dynamically allocated data areas that are freed when
126the function
127.Fn endnetgrent
128is called.
129