lib/libc/gen/getnetgrent.3

   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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd June 5, 2016
  29 .Dt GETNETGRENT 3
  30 .Os
  31 .Sh NAME
  32 .Nm getnetgrent ,
  33 .Nm innetgr ,
  34 .Nm setnetgrent ,
  35 .Nm endnetgrent
  36 .Nd netgroup database operations
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In netdb.h
  41 .Ft int
  42 .Fn getnetgrent "char **host" "char **user" "char **domain"
  43 .Ft int
  44 .Fn getnetgrent_r "char **host" "char **user" "char **domain" "char *buf" "size_t bufsize"
  45 .Ft int
  46 .Fn innetgr "const char *netgroup" "const char *host" "const char *user" "const char *domain"
  47 .Ft void
  48 .Fn setnetgrent "const char *netgroup"
  49 .Ft void
  50 .Fn endnetgrent void
  51 .Sh DESCRIPTION
  52 These functions operate on the netgroup database file
  53 .Pa /etc/netgroup
  54 which is described
  55 in
  56 .Xr netgroup 5 .
  57 The database defines a set of netgroups, each made up of one or more triples:
  58 .Bd -literal -offset indent
  59 (host, user, domain)
  60 .Ed
  61 that defines a combination of host, user and domain.
  62 Any of the three fields may be specified as ``wildcards'' that match any
  63 string.
  64 .Pp
  65 The function
  66 .Fn getnetgrent
  67 sets the three pointer arguments to the strings of the next member of the
  68 current netgroup.
  69 If any of the string pointers are
  70 .Dv NULL
  71 that field is considered a wildcard.
  72 .Pp
  73 The functions
  74 .Fn setnetgrent
  75 and
  76 .Fn endnetgrent
  77 set the current netgroup and terminate the current netgroup respectively.
  78 If
  79 .Fn setnetgrent
  80 is called with a different netgroup than the previous call, an implicit
  81 .Fn endnetgrent
  82 is implied.
  83 The
  84 .Fn setnetgrent
  85 function
  86 also sets the offset to the first member of the netgroup.
  87 .Pp
  88 The function
  89 .Fn innetgr
  90 searches for a match of all fields within the specified group.
  91 If any of the
  92 .Sy host ,
  93 .Sy user ,
  94 or
  95 .Sy domain
  96 arguments are
  97 .Dv NULL
  98 those fields will match any string value in the netgroup member.
  99 .Sh RETURN VALUES
 100 The function
 101 .Fn getnetgrent
 102 returns 0 for ``no more netgroup members'' and 1 otherwise.
 103 The function
 104 .Fn innetgr
 105 returns 1 for a successful match and 0 otherwise.
 106 The functions
 107 .Fn setnetgrent
 108 and
 109 .Fn endnetgrent
 110 have no return value.
 111 .Sh FILES
 112 .Bl -tag -width /etc/netgroup -compact
 113 .It Pa /etc/netgroup
 114 netgroup database file
 115 .El
 116 .Sh COMPATIBILITY
 117 The netgroup members have three string fields to maintain compatibility
 118 with other vendor implementations, however it is not obvious what use the
 119 .Sy domain
 120 string has within
 121 .Bx .
 122 .Sh SEE ALSO
 123 .Xr netgroup 5
 124 .Sh BUGS
 125 The function
 126 .Fn getnetgrent
 127 returns pointers to dynamically allocated data areas that are freed when
 128 the function
 129 .Fn endnetgrent
 130 is called.