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