xref: /netbsd-src/include/nsswitch.h (revision 4b896b232495b7a9b8b94a1cf1e21873296d53b8)
1 /*	$NetBSD: nsswitch.h,v 1.12 2003/07/09 01:59:34 kristerw Exp $	*/
2 
3 /*-
4  * Copyright (c) 1997, 1998, 1999 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Luke Mewburn.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #ifndef _NSSWITCH_H
40 #define _NSSWITCH_H	1
41 
42 /*
43  * Don't use va_list in prototypes.   Va_list is typedef'd in two places
44  * (<machine/varargs.h> and <machine/stdarg.h>), so if we include one of
45  * them here we may collide with the utility's includes.  It's unreasonable
46  * for utilities to have to include one of them to include nsswitch.h, so
47  * we get _BSD_VA_LIST_ from <machine/ansi.h> and use it.
48  */
49 #include <machine/ansi.h>
50 #include <sys/types.h>
51 
52 #ifndef _PATH_NS_CONF
53 #define _PATH_NS_CONF	"/etc/nsswitch.conf"
54 #endif
55 
56 #define	NS_CONTINUE	0
57 #define	NS_RETURN	1
58 
59 #define	NS_SUCCESS	(1<<0)		/* entry was found */
60 #define	NS_UNAVAIL	(1<<1)		/* source not responding, or corrupt */
61 #define	NS_NOTFOUND	(1<<2)		/* source responded 'no such entry' */
62 #define	NS_TRYAGAIN	(1<<3)		/* source busy, may respond to retrys */
63 #define	NS_STATUSMASK	0x000000ff	/* bitmask to get the status flags */
64 
65 /*
66  * currently implemented sources
67  */
68 #define NSSRC_FILES	"files"		/* local files */
69 #define	NSSRC_DNS	"dns"		/* DNS; IN for hosts, HS for others */
70 #define	NSSRC_NIS	"nis"		/* YP/NIS */
71 #define	NSSRC_COMPAT	"compat"	/* passwd,group in YP compat mode */
72 
73 /*
74  * currently implemented databases
75  */
76 #define NSDB_HOSTS		"hosts"
77 #define NSDB_GROUP		"group"
78 #define NSDB_GROUP_COMPAT	"group_compat"
79 #define NSDB_NETGROUP		"netgroup"
80 #define NSDB_NETWORKS		"networks"
81 #define NSDB_PASSWD		"passwd"
82 #define NSDB_PASSWD_COMPAT	"passwd_compat"
83 #define NSDB_SHELLS		"shells"
84 
85 /*
86  * suggested databases to implement
87  */
88 #define NSDB_ALIASES		"aliases"
89 #define NSDB_AUTH		"auth"
90 #define NSDB_AUTOMOUNT		"automount"
91 #define NSDB_BOOTPARAMS		"bootparams"
92 #define NSDB_ETHERS		"ethers"
93 #define NSDB_EXPORTS		"exports"
94 #define NSDB_NETMASKS		"netmasks"
95 #define NSDB_PHONES		"phones"
96 #define NSDB_PRINTCAP		"printcap"
97 #define NSDB_PROTOCOLS		"protocols"
98 #define NSDB_REMOTE		"remote"
99 #define NSDB_RPC		"rpc"
100 #define NSDB_SENDMAILVARS	"sendmailvars"
101 #define NSDB_SERVICES		"services"
102 #define NSDB_TERMCAP		"termcap"
103 #define NSDB_TTYS		"ttys"
104 
105 /*
106  * ns_dtab - `nsswitch dispatch table'
107  * contains an entry for each source and the appropriate function to call
108  */
109 typedef struct {
110 	const char	 *src;
111 	int		(*callback) __P((void *, void *, _BSD_VA_LIST_));
112 	void		 *cb_data;
113 } ns_dtab;
114 
115 /*
116  * macros to help build an ns_dtab[]
117  */
118 #define NS_FILES_CB(F,C)	{ NSSRC_FILES,	F,	C },
119 #define NS_COMPAT_CB(F,C)	{ NSSRC_COMPAT,	F,	C },
120 
121 #ifdef HESIOD
122 #   define NS_DNS_CB(F,C)	{ NSSRC_DNS,	F,	C },
123 #else
124 #   define NS_DNS_CB(F,C)
125 #endif
126 
127 #ifdef YP
128 #   define NS_NIS_CB(F,C)	{ NSSRC_NIS,	F,	C },
129 #else
130 #   define NS_NIS_CB(F,C)
131 #endif
132 
133 /*
134  * ns_src - `nsswitch source'
135  * used by the nsparser routines to store a mapping between a source
136  * and its dispatch control flags for a given database.
137  */
138 typedef struct {
139 	const char	*name;
140 	u_int32_t	 flags;
141 } ns_src;
142 
143 
144 /*
145  * default sourcelist (if nsswitch.conf is missing, corrupt,
146  * or the requested database doesn't have an entry.
147  */
148 extern const ns_src __nsdefaultsrc[];
149 
150 
151 #ifdef _NS_PRIVATE
152 
153 /*
154  * private data structures for back-end nsswitch implementation
155  */
156 
157 /*
158  * ns_dbt - `nsswitch database thang'
159  * for each database in /etc/nsswitch.conf there is a ns_dbt, with its
160  * name and a list of ns_src's containing the source information.
161  */
162 typedef struct {
163 	const char	*name;		/* name of database */
164 	ns_src		*srclist;	/* list of sources */
165 	int		 srclistsize;	/* size of srclist */
166 } ns_dbt;
167 
168 #endif /* _NS_PRIVATE */
169 
170 
171 #include <sys/cdefs.h>
172 
173 __BEGIN_DECLS
174 int	nsdispatch	__P((void *, const ns_dtab [], const char *,
175 			    const char *, const ns_src [], ...));
176 
177 #ifdef _NS_PRIVATE
178 int		 _nsdbtaddsrc __P((ns_dbt *, const ns_src *));
179 void		 _nsdbtdump __P((const ns_dbt *));
180 const ns_dbt	*_nsdbtget __P((const char *));
181 int		 _nsdbtput __P((const ns_dbt *));
182 void		 _nsyyerror __P((const char *));
183 int		 _nsyylex __P((void));
184 #endif /* _NS_PRIVATE */
185 
186 __END_DECLS
187 
188 #endif /* !_NSSWITCH_H */
189