nsswitch.h revision 158115
1/* $NetBSD: nsswitch.h,v 1.6 1999/01/26 01:04:07 lukem Exp $ */ 2/* $FreeBSD: head/include/nsswitch.h 158115 2006-04-28 12:03:38Z ume $ */ 3 4/*- 5 * Copyright (c) 1997, 1998, 1999 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Luke Mewburn. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40#ifndef _NSSWITCH_H 41#define _NSSWITCH_H 1 42 43#include <sys/types.h> 44#include <stdarg.h> 45 46#define NSS_MODULE_INTERFACE_VERSION 1 47 48#ifndef _PATH_NS_CONF 49#define _PATH_NS_CONF "/etc/nsswitch.conf" 50#endif 51 52/* NSS source actions */ 53#define NS_ACTION_CONTINUE 0 /* try the next source */ 54#define NS_ACTION_RETURN 1 /* look no further */ 55 56#define NS_SUCCESS (1<<0) /* entry was found */ 57#define NS_UNAVAIL (1<<1) /* source not responding, or corrupt */ 58#define NS_NOTFOUND (1<<2) /* source responded 'no such entry' */ 59#define NS_TRYAGAIN (1<<3) /* source busy, may respond to retry */ 60#define NS_RETURN (1<<4) /* stop search, e.g. for ERANGE */ 61#define NS_TERMINATE (NS_SUCCESS|NS_RETURN) /* flags that end search */ 62#define NS_STATUSMASK 0x000000ff /* bitmask to get the status flags */ 63 64/* 65 * currently implemented sources 66 */ 67#define NSSRC_FILES "files" /* local files */ 68#define NSSRC_DNS "dns" /* DNS; IN for hosts, HS for others */ 69#define NSSRC_NIS "nis" /* YP/NIS */ 70#define NSSRC_COMPAT "compat" /* passwd,group in YP compat mode */ 71#define NSSRC_CACHE "cache" /* cache daemon */ 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#define NSDB_SERVICES "services" 85#define NSDB_SERVICES_COMPAT "services_compat" 86#define NSDB_SSH_HOSTKEYS "ssh_hostkeys" 87#define NSDB_PROTOCOLS "protocols" 88#define NSDB_RPC "rpc" 89 90/* 91 * suggested databases to implement 92 */ 93#define NSDB_ALIASES "aliases" 94#define NSDB_AUTH "auth" 95#define NSDB_AUTOMOUNT "automount" 96#define NSDB_BOOTPARAMS "bootparams" 97#define NSDB_ETHERS "ethers" 98#define NSDB_EXPORTS "exports" 99#define NSDB_NETMASKS "netmasks" 100#define NSDB_PHONES "phones" 101#define NSDB_PRINTCAP "printcap" 102#define NSDB_REMOTE "remote" 103#define NSDB_SENDMAILVARS "sendmailvars" 104#define NSDB_TERMCAP "termcap" 105#define NSDB_TTYS "ttys" 106 107/* 108 * ns_dtab `method' function signature. 109 */ 110typedef int (*nss_method)(void *_retval, void *_mdata, va_list _ap); 111 112/* 113 * Macro for generating method prototypes. 114 */ 115#define NSS_METHOD_PROTOTYPE(method) \ 116 int method(void *, void *, va_list) 117 118/* 119 * ns_dtab - `nsswitch dispatch table' 120 * Contains an entry for each source and the appropriate function to 121 * call. ns_dtabs are used in the nsdispatch() API in order to allow 122 * the application to override built-in actions. 123 */ 124typedef struct _ns_dtab { 125 const char *src; /* Source this entry implements */ 126 nss_method method; /* Method to be called */ 127 void *mdata; /* Data passed to method */ 128} ns_dtab; 129 130/* 131 * macros to help build an ns_dtab[] 132 */ 133#define NS_FILES_CB(F,C) { NSSRC_FILES, F, C }, 134#define NS_COMPAT_CB(F,C) { NSSRC_COMPAT, F, C }, 135 136#ifdef HESIOD 137# define NS_DNS_CB(F,C) { NSSRC_DNS, F, C }, 138#else 139# define NS_DNS_CB(F,C) 140#endif 141 142#ifdef YP 143# define NS_NIS_CB(F,C) { NSSRC_NIS, F, C }, 144#else 145# define NS_NIS_CB(F,C) 146#endif 147 148/* 149 * ns_src - `nsswitch source' 150 * used by the nsparser routines to store a mapping between a source 151 * and its dispatch control flags for a given database. 152 */ 153typedef struct _ns_src { 154 const char *name; 155 u_int32_t flags; 156} ns_src; 157 158 159/* 160 * default sourcelist (if nsswitch.conf is missing, corrupt, 161 * or the requested database doesn't have an entry. 162 */ 163extern const ns_src __nsdefaultsrc[]; 164 165/* 166 * ns_mtab - NSS method table 167 * An NSS module provides a mapping from (database name, method name) 168 * tuples to the nss_method and associated data. 169 */ 170typedef struct _ns_mtab { 171 const char *database; 172 const char *name; 173 nss_method method; 174 void *mdata; 175} ns_mtab; 176 177/* 178 * NSS module de-registration, called at module unload. 179 */ 180typedef void (*nss_module_unregister_fn)(ns_mtab *, unsigned int); 181 182/* 183 * NSS module registration, called at module load. 184 */ 185typedef ns_mtab *(*nss_module_register_fn)(const char *, unsigned int *, 186 nss_module_unregister_fn *); 187 188/* 189 * Many NSS interfaces follow the getXXnam, getXXid, getXXent pattern. 190 * Developers are encouraged to use nss_lookup_type where approriate. 191 */ 192enum nss_lookup_type { 193 nss_lt_name = 1, 194 nss_lt_id = 2, 195 nss_lt_all = 3 196}; 197 198#ifdef _NS_PRIVATE 199/* 200 * private data structures for back-end nsswitch implementation 201 */ 202 203/* 204 * ns_dbt - `nsswitch database thang' 205 * for each database in /etc/nsswitch.conf there is a ns_dbt, with its 206 * name and a list of ns_src's containing the source information. 207 */ 208typedef struct _ns_dbt { 209 const char *name; /* name of database */ 210 ns_src *srclist; /* list of sources */ 211 int srclistsize; /* size of srclist */ 212} ns_dbt; 213 214/* 215 * ns_mod - NSS module 216 */ 217typedef struct _ns_mod { 218 char *name; /* module name */ 219 void *handle; /* handle from dlopen */ 220 ns_mtab *mtab; /* method table */ 221 unsigned int mtabsize; /* count of entries in method table */ 222 nss_module_unregister_fn unregister; /* called to unload module */ 223} ns_mod; 224 225#endif /* _NS_PRIVATE */ 226 227 228#include <sys/cdefs.h> 229 230__BEGIN_DECLS 231extern int nsdispatch(void *, const ns_dtab [], const char *, 232 const char *, const ns_src [], ...); 233 234#ifdef _NS_PRIVATE 235extern void _nsdbtaddsrc(ns_dbt *, const ns_src *); 236extern void _nsdbtput(const ns_dbt *); 237extern void _nsyyerror(const char *); 238extern int _nsyylex(void); 239extern int _nsyyparse(void); 240extern int _nsyylineno; 241#ifdef _NSS_DEBUG 242extern void _nsdbtdump(const ns_dbt *); 243#endif 244#endif /* _NS_PRIVATE */ 245 246__END_DECLS 247 248#endif /* !_NSSWITCH_H */ 249