nsswitch.h revision 1.5
1/*	$NetBSD: nsswitch.h,v 1.5 1999/01/19 07:55:14 lukem 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#include <sys/types.h>
43
44#if __STDC__
45#include <stdarg.h>
46#else
47#include <varargs.h>
48#endif
49
50#ifndef _PATH_NS_CONF
51#define _PATH_NS_CONF	"/etc/nsswitch.conf"
52#endif
53
54#define	NS_CONTINUE	0
55#define	NS_RETURN	1
56
57#define	NS_SUCCESS	(1<<0)		/* entry was found */
58#define	NS_UNAVAIL	(1<<1)		/* source not responding, or corrupt */
59#define	NS_NOTFOUND	(1<<2)		/* source responded 'no such entry' */
60#define	NS_TRYAGAIN	(1<<3)		/* source busy, may respond to retrys */
61#define	NS_STATUSMASK	0x000000ff	/* bitmask to get the status flags */
62
63/*
64 * currently implemented sources
65 */
66#define NSSRC_FILES	"files"		/* local files */
67#define	NSSRC_DNS	"dns"		/* DNS; IN for hosts, HS for others */
68#define	NSSRC_NIS	"nis"		/* YP/NIS */
69#define	NSSRC_COMPAT	"compat"	/* passwd,group in YP compat mode */
70
71/*
72 * currently implemented databases
73 */
74#define NSDB_HOSTS		"hosts"
75#define NSDB_GROUP		"group"
76#define NSDB_GROUP_COMPAT	"group_compat"
77#define NSDB_NETGROUP		"netgroup"
78#define NSDB_NETWORKS		"networks"
79#define NSDB_PASSWD		"passwd"
80#define NSDB_PASSWD_COMPAT	"passwd_compat"
81#define NSDB_SHELLS		"shells"
82
83/*
84 * suggested databases to implement
85 */
86#define NSDB_ALIASES		"aliases"
87#define NSDB_AUTH		"auth"
88#define NSDB_AUTOMOUNT		"automount"
89#define NSDB_BOOTPARAMS		"bootparams"
90#define NSDB_ETHERS		"ethers"
91#define NSDB_EXPORTS		"exports"
92#define NSDB_NETMASKS		"netmasks"
93#define NSDB_PHONES		"phones"
94#define NSDB_PRINTCAP		"printcap"
95#define NSDB_PROTOCOLS		"protocols"
96#define NSDB_REMOTE		"remote"
97#define NSDB_RPC		"rpc"
98#define NSDB_SENDMAILVARS	"sendmailvars"
99#define NSDB_SERVICES		"services"
100#define NSDB_TERMCAP		"termcap"
101#define NSDB_TTYS		"ttys"
102
103/*
104 * ns_dtab - `nsswitch dispatch table'
105 * contains an entry for each source and the appropriate function to call
106 */
107typedef struct {
108	const char	 *src;
109	int		(*callback)(void *retval, void *cb_data, va_list ap);
110	void		 *cb_data;
111} ns_dtab;
112
113/*
114 * macros to help build an ns_dtab[]
115 */
116#define NS_FILES_CB(F,C)	{ NSSRC_FILES,	F,	C },
117
118#ifdef HESIOD
119#   define NS_DNS_CB(F,C)	{ NSSRC_DNS,	F,	C },
120#else
121#   define NS_DNS_CB(F,C)
122#endif
123
124#ifdef YP
125#   define NS_NIS_CB(F,C)	{ NSSRC_NIS,	F,	C },
126#else
127#   define NS_NIS_CB(F,C)
128#endif
129
130#if defined(HESIOD) || defined(YP)
131#   define NS_COMPAT_CB(F,C)	{ NSSRC_COMPAT,	F,	C },
132#else
133#   define NS_COMPAT_CB(F,C)
134#endif
135
136/*
137 * ns_src - `nsswitch source'
138 * used by the nsparser routines to store a mapping between a source
139 * and its dispatch control flags for a given database.
140 */
141typedef struct {
142	const char	*name;
143	u_int32_t	 flags;
144} ns_src;
145
146
147/*
148 * default sourcelist (if nsswitch.conf is missing, corrupt,
149 * or the requested database doesn't have an entry.
150 */
151extern const ns_src __nsdefaultsrc[];
152
153
154#ifdef _NS_PRIVATE
155
156/*
157 * private data structures for back-end nsswitch implementation
158 */
159
160/*
161 * ns_dbt - `nsswitch database thang'
162 * for each database in /etc/nsswitch.conf there is a ns_dbt, with its
163 * name and a list of ns_src's containing the source information.
164 */
165typedef struct {
166	const char	*name;		/* name of database */
167	ns_src		*srclist;	/* list of sources */
168	int		 srclistsize;	/* size of srclist */
169} ns_dbt;
170
171#endif /* _NS_PRIVATE */
172
173
174#include <sys/cdefs.h>
175
176__BEGIN_DECLS
177extern	int	nsdispatch	__P((void *, const ns_dtab [], const char *,
178				    const char *, const ns_src [], ...));
179
180#ifdef _NS_PRIVATE
181extern	void		 _nsdbtaddsrc __P((ns_dbt *, const ns_src *));
182extern	void		 _nsdbtdump __P((const ns_dbt *));
183extern	const ns_dbt	*_nsdbtget __P((const char *));
184extern	void		 _nsdbtput __P((const ns_dbt *));
185extern	void		 _nsyyerror __P((const char *));
186extern	int		 _nsyylex __P((void));
187extern	int		 _nsyylineno;
188#endif /* _NS_PRIVATE */
189
190__END_DECLS
191
192#endif /* !_NSSWITCH_H */
193