lib/libc/net/nsdispatch.3

   1 .\"     $NetBSD: nsdispatch.3,v 1.8 1999/03/22 19:44:53 garbled Exp $
   2 .\"
   3 .\" Copyright (c) 1997, 1998, 1999 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Luke Mewburn.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  18 .\"    contributors may be used to endorse or promote products derived
  19 .\"    from this software without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  22 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  23 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  24 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  25 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31 .\" POSSIBILITY OF SUCH DAMAGE.
  32 .\"
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd April 4, 2010
  36 .Dt NSDISPATCH 3
  37 .Os
  38 .Sh NAME
  39 .Nm nsdispatch
  40 .Nd name-service switch dispatcher routine
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/types.h
  45 .In stdarg.h
  46 .In nsswitch.h
  47 .Ft int
  48 .Fo nsdispatch
  49 .Fa "void *retval"
  50 .Fa "const ns_dtab dtab[]"
  51 .Fa "const char *database"
  52 .Fa "const char *method_name"
  53 .Fa "const ns_src defaults[]"
  54 .Fa "..."
  55 .Fc
  56 .Sh DESCRIPTION
  57 The
  58 .Fn nsdispatch
  59 function invokes the methods specified in
  60 .Va dtab
  61 in the order given by
  62 .Xr nsswitch.conf 5
  63 for the database
  64 .Va database
  65 until a successful entry is found.
  66 .Pp
  67 .Va retval
  68 is passed to each method to modify as necessary, to pass back results to
  69 the caller of
  70 .Fn nsdispatch .
  71 .Pp
  72 Each method has the function signature described by the typedef:
  73 .Pp
  74 .Ft typedef int
  75 .Fn \*(lp*nss_method\*(rp "void *retval" "void *mdata" "va_list *ap" ;
  76 .Pp
  77 .Va dtab
  78 is an array of
  79 .Va ns_dtab
  80 structures, which have the following format:
  81 .Bd -literal -offset indent
  82 typedef struct _ns_dtab {
  83         const char      *src;
  84         nss_method       method;
  85         void            *mdata;
  86 } ns_dtab;
  87 .Ed
  88 .Pp
  89 The
  90 .Fa dtab
  91 array should consist of one entry for each source type that is
  92 implemented, with
  93 .Va src
  94 as the name of the source,
  95 .Va method
  96 as a function which handles that source, and
  97 .Va mdata
  98 as a handle on arbitrary data to be passed to the method.
  99 The last entry in
 100 .Va dtab
 101 should contain
 102 .Dv NULL
 103 values for
 104 .Va src ,
 105 .Va method ,
 106 and
 107 .Va mdata .
 108 .Pp
 109 Additionally, methods may be implemented in NSS modules, in
 110 which case they are selected using the
 111 .Fa database
 112 and
 113 .Fa method_name
 114 arguments along with the configured source.
 115 (The methods supplied via
 116 .Fa dtab
 117 take priority over those implemented in NSS modules in the event
 118 of a conflict.)
 119 .Pp
 120 .Va defaults
 121 contains a list of default sources to try if
 122 .Xr nsswitch.conf 5
 123 is missing or corrupted, or if there is no relevant entry for
 124 .Va database .
 125 It is an array of
 126 .Va ns_src
 127 structures, which have the following format:
 128 .Bd -literal -offset indent
 129 typedef struct _ns_src {
 130         const char      *src;
 131         uint32_t         flags;
 132 } ns_src;
 133 .Ed
 134 .Pp
 135 The
 136 .Fa defaults
 137 array should consist of one entry for each source to be configured by
 138 default indicated by
 139 .Va src ,
 140 and
 141 .Va flags
 142 set to the criterion desired
 143 (usually
 144 .Dv NS_SUCCESS ;
 145 refer to
 146 .Sx Method return values
 147 for more information).
 148 The last entry in
 149 .Va defaults
 150 should have
 151 .Va src
 152 set to
 153 .Dv NULL
 154 and
 155 .Va flags
 156 set to 0.
 157 .Pp
 158 For convenience, a global variable defined as:
 159 .Pp
 160 .Dl extern const ns_src __nsdefaultsrc[];
 161 .Pp
 162 exists which contains a single default entry for the source
 163 .Sq files
 164 that may be used by callers which do not require complicated default
 165 rules.
 166 .Pp
 167 .Sq Va ...
 168 are optional extra arguments, which are passed to the appropriate method
 169 as a variable argument list of the type
 170 .Vt va_list .
 171 .Ss Valid source types
 172 While there is support for arbitrary sources, the following
 173 #defines for commonly implemented sources are available:
 174 .Bl -column NSSRC_COMPAT compat -offset indent
 175 .It Sy "#define value"
 176 .It Dv NSSRC_FILES Ta  \&"files\&"
 177 .It Dv NSSRC_DB Ta \&"db\&"
 178 .It Dv NSSRC_DNS Ta \&"dns\&"
 179 .It Dv NSSRC_NIS Ta \&"nis\&"
 180 .It Dv NSSRC_COMPAT Ta \&"compat\&"
 181 .El
 182 .Pp
 183 Refer to
 184 .Xr nsswitch.conf 5
 185 for a complete description of what each source type is.
 186 .Ss Method return values
 187 The
 188 .Vt nss_method
 189 functions must return one of the following values depending upon status
 190 of the lookup:
 191 .Bl -column "Return value" "Status code"
 192 .It Sy "Return value    Status code"
 193 .It Dv NS_SUCCESS Ta success
 194 .It Dv NS_NOTFOUND Ta notfound
 195 .It Dv NS_UNAVAIL Ta unavail
 196 .It Dv NS_TRYAGAIN Ta tryagain
 197 .It Dv NS_RETURN Ta -none-
 198 .El
 199 .Pp
 200 Refer to
 201 .Xr nsswitch.conf 5
 202 for a complete description of each status code.
 203 .Pp
 204 The
 205 .Fn nsdispatch
 206 function returns the value of the method that caused the dispatcher to
 207 terminate, or
 208 .Dv NS_NOTFOUND
 209 otherwise.
 210 .Sh NOTES
 211 .Fx Ns 's
 212 .Lb libc
 213 provides stubs for compatibility with NSS modules
 214 written for the
 215 .Tn GNU
 216 C Library
 217 .Nm nsswitch
 218 interface.
 219 However, these stubs only support the use of the
 220 .Dq Li passwd
 221 and
 222 .Dq Li group
 223 databases.
 224 .Sh SEE ALSO
 225 .Xr hesiod 3 ,
 226 .Xr stdarg 3 ,
 227 .Xr nsswitch.conf 5 ,
 228 .Xr yp 8
 229 .Sh HISTORY
 230 The
 231 .Fn nsdispatch
 232 function first appeared in
 233 .Fx 5.0 .
 234 It was imported from the
 235 .Nx
 236 Project,
 237 where it appeared first in
 238 .Nx 1.4 .
 239 Support for NSS modules first appeared in
 240 .Fx 5.1 .
 241 .Sh AUTHORS
 242 Luke Mewburn
 243 .Aq lukem@netbsd.org
 244 wrote this freely-distributable name-service switch implementation,
 245 using ideas from the
 246 .Tn ULTRIX
 247 svc.conf(5)
 248 and
 249 .Tn Solaris
 250 nsswitch.conf(4)
 251 manual pages.
 252 The
 253 .Fx
 254 Project
 255 added the support for threads and NSS modules, and normalized the uses
 256 of
 257 .Fn nsdispatch
 258 within the standard C library.