1951a39d68df598db08dfced8b4707755864a0492Ying Wang/* $NetBSD: nsswitch.h,v 1.18 2005/11/29 03:12:58 christos Exp $ */ 2951a39d68df598db08dfced8b4707755864a0492Ying Wang 3951a39d68df598db08dfced8b4707755864a0492Ying Wang/*- 4951a39d68df598db08dfced8b4707755864a0492Ying Wang * Copyright (c) 1997, 1998, 1999, 2004 The NetBSD Foundation, Inc. 5951a39d68df598db08dfced8b4707755864a0492Ying Wang * All rights reserved. 6951a39d68df598db08dfced8b4707755864a0492Ying Wang * 7951a39d68df598db08dfced8b4707755864a0492Ying Wang * This code is derived from software contributed to The NetBSD Foundation 8951a39d68df598db08dfced8b4707755864a0492Ying Wang * by Luke Mewburn. 9951a39d68df598db08dfced8b4707755864a0492Ying Wang * 10951a39d68df598db08dfced8b4707755864a0492Ying Wang * Redistribution and use in source and binary forms, with or without 11951a39d68df598db08dfced8b4707755864a0492Ying Wang * modification, are permitted provided that the following conditions 12951a39d68df598db08dfced8b4707755864a0492Ying Wang * are met: 13951a39d68df598db08dfced8b4707755864a0492Ying Wang * 1. Redistributions of source code must retain the above copyright 14951a39d68df598db08dfced8b4707755864a0492Ying Wang * notice, this list of conditions and the following disclaimer. 15951a39d68df598db08dfced8b4707755864a0492Ying Wang * 2. Redistributions in binary form must reproduce the above copyright 16951a39d68df598db08dfced8b4707755864a0492Ying Wang * notice, this list of conditions and the following disclaimer in the 17951a39d68df598db08dfced8b4707755864a0492Ying Wang * documentation and/or other materials provided with the distribution. 18951a39d68df598db08dfced8b4707755864a0492Ying Wang * 3. All advertising materials mentioning features or use of this software 19951a39d68df598db08dfced8b4707755864a0492Ying Wang * must display the following acknowledgement: 20951a39d68df598db08dfced8b4707755864a0492Ying Wang * This product includes software developed by the NetBSD 21951a39d68df598db08dfced8b4707755864a0492Ying Wang * Foundation, Inc. and its contributors. 22951a39d68df598db08dfced8b4707755864a0492Ying Wang * 4. Neither the name of The NetBSD Foundation nor the names of its 23951a39d68df598db08dfced8b4707755864a0492Ying Wang * contributors may be used to endorse or promote products derived 24951a39d68df598db08dfced8b4707755864a0492Ying Wang * from this software without specific prior written permission. 25951a39d68df598db08dfced8b4707755864a0492Ying Wang * 26951a39d68df598db08dfced8b4707755864a0492Ying Wang * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27951a39d68df598db08dfced8b4707755864a0492Ying Wang * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28951a39d68df598db08dfced8b4707755864a0492Ying Wang * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29951a39d68df598db08dfced8b4707755864a0492Ying Wang * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30951a39d68df598db08dfced8b4707755864a0492Ying Wang * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31951a39d68df598db08dfced8b4707755864a0492Ying Wang * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32951a39d68df598db08dfced8b4707755864a0492Ying Wang * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33951a39d68df598db08dfced8b4707755864a0492Ying Wang * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34951a39d68df598db08dfced8b4707755864a0492Ying Wang * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35951a39d68df598db08dfced8b4707755864a0492Ying Wang * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36951a39d68df598db08dfced8b4707755864a0492Ying Wang * POSSIBILITY OF SUCH DAMAGE. 37951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 38951a39d68df598db08dfced8b4707755864a0492Ying Wang 39951a39d68df598db08dfced8b4707755864a0492Ying Wang#ifndef _NSSWITCH_H 40951a39d68df598db08dfced8b4707755864a0492Ying Wang#define _NSSWITCH_H 1 41951a39d68df598db08dfced8b4707755864a0492Ying Wang 42951a39d68df598db08dfced8b4707755864a0492Ying Wang#include <sys/types.h> 43951a39d68df598db08dfced8b4707755864a0492Ying Wang#include <stdarg.h> 44951a39d68df598db08dfced8b4707755864a0492Ying Wang 45951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSS_MODULE_INTERFACE_VERSION 0 46951a39d68df598db08dfced8b4707755864a0492Ying Wang 47951a39d68df598db08dfced8b4707755864a0492Ying Wang#ifndef _PATH_NS_CONF 48951a39d68df598db08dfced8b4707755864a0492Ying Wang#define _PATH_NS_CONF "/etc/nsswitch.conf" 49951a39d68df598db08dfced8b4707755864a0492Ying Wang#endif 50951a39d68df598db08dfced8b4707755864a0492Ying Wang 51951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NS_CONTINUE 0 52951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NS_RETURN 1 53951a39d68df598db08dfced8b4707755864a0492Ying Wang 54951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 55951a39d68df598db08dfced8b4707755864a0492Ying Wang * Layout of: 56951a39d68df598db08dfced8b4707755864a0492Ying Wang * uint32_t ns_src.flags 57951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 58951a39d68df598db08dfced8b4707755864a0492Ying Wang /* nsswitch.conf status codes and nsdispatch(3) return values */ 59951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NS_SUCCESS (1<<0) /* entry was found */ 60951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NS_UNAVAIL (1<<1) /* source not responding, or corrupt */ 61951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NS_NOTFOUND (1<<2) /* source responded 'no such entry' */ 62951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NS_TRYAGAIN (1<<3) /* source busy, may respond to retrys */ 63951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NS_STATUSMASK 0x000000ff /* bitmask to get the status flags */ 64951a39d68df598db08dfced8b4707755864a0492Ying Wang 65951a39d68df598db08dfced8b4707755864a0492Ying Wang /* internal nsdispatch(3) flags; not settable in nsswitch.conf(5) */ 66951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NS_FORCEALL (1<<8) /* force all methods to be invoked; */ 67951a39d68df598db08dfced8b4707755864a0492Ying Wang 68951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 69951a39d68df598db08dfced8b4707755864a0492Ying Wang * Currently implemented sources. 70951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 71951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSSRC_FILES "files" /* local files */ 72951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSSRC_DNS "dns" /* DNS; IN for hosts, HS for others */ 73951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSSRC_NIS "nis" /* YP/NIS */ 74951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSSRC_COMPAT "compat" /* passwd,group in YP compat mode */ 75951a39d68df598db08dfced8b4707755864a0492Ying Wang 76951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 77951a39d68df598db08dfced8b4707755864a0492Ying Wang * Currently implemented databases. 78951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 79951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_HOSTS "hosts" 80951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_GROUP "group" 81951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_GROUP_COMPAT "group_compat" 82951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_NETGROUP "netgroup" 83951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_NETWORKS "networks" 84951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_PASSWD "passwd" 85951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_PASSWD_COMPAT "passwd_compat" 86951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_SHELLS "shells" 87951a39d68df598db08dfced8b4707755864a0492Ying Wang 88951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 89951a39d68df598db08dfced8b4707755864a0492Ying Wang * Suggested databases to implement. 90951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 91951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_ALIASES "aliases" 92951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_AUTH "auth" 93951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_AUTOMOUNT "automount" 94951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_BOOTPARAMS "bootparams" 95951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_ETHERS "ethers" 96951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_EXPORTS "exports" 97951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_NETMASKS "netmasks" 98951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_PHONES "phones" 99951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_PRINTCAP "printcap" 100951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_PROTOCOLS "protocols" 101951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_REMOTE "remote" 102951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_RPC "rpc" 103951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_SENDMAILVARS "sendmailvars" 104951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_SERVICES "services" 105951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_TERMCAP "termcap" 106951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NSDB_TTYS "ttys" 107951a39d68df598db08dfced8b4707755864a0492Ying Wang 108951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 109951a39d68df598db08dfced8b4707755864a0492Ying Wang * ns_dtab `callback' function signature. 110951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 111951a39d68df598db08dfced8b4707755864a0492Ying Wangtypedef int (*nss_method)(void *, void *, va_list); 112951a39d68df598db08dfced8b4707755864a0492Ying Wang 113951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 114951a39d68df598db08dfced8b4707755864a0492Ying Wang * ns_dtab - `nsswitch dispatch table' 115951a39d68df598db08dfced8b4707755864a0492Ying Wang * Contains an entry for each source and the appropriate function to call. 116951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 117951a39d68df598db08dfced8b4707755864a0492Ying Wangtypedef struct { 118951a39d68df598db08dfced8b4707755864a0492Ying Wang const char *src; 119951a39d68df598db08dfced8b4707755864a0492Ying Wang nss_method callback; 120951a39d68df598db08dfced8b4707755864a0492Ying Wang void *cb_data; 121951a39d68df598db08dfced8b4707755864a0492Ying Wang} ns_dtab; 122951a39d68df598db08dfced8b4707755864a0492Ying Wang 123951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 124951a39d68df598db08dfced8b4707755864a0492Ying Wang * Macros to help build an ns_dtab[] 125951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 126951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NS_FILES_CB(F,C) { NSSRC_FILES, F, __UNCONST(C) }, 127951a39d68df598db08dfced8b4707755864a0492Ying Wang#define NS_COMPAT_CB(F,C) { NSSRC_COMPAT, F, __UNCONST(C) }, 128951a39d68df598db08dfced8b4707755864a0492Ying Wang 129951a39d68df598db08dfced8b4707755864a0492Ying Wang#ifdef HESIOD 130951a39d68df598db08dfced8b4707755864a0492Ying Wang# define NS_DNS_CB(F,C) { NSSRC_DNS, F, __UNCONST(C) }, 131951a39d68df598db08dfced8b4707755864a0492Ying Wang#else 132951a39d68df598db08dfced8b4707755864a0492Ying Wang# define NS_DNS_CB(F,C) 133951a39d68df598db08dfced8b4707755864a0492Ying Wang#endif 134951a39d68df598db08dfced8b4707755864a0492Ying Wang 135951a39d68df598db08dfced8b4707755864a0492Ying Wang#ifdef YP 136951a39d68df598db08dfced8b4707755864a0492Ying Wang# define NS_NIS_CB(F,C) { NSSRC_NIS, F, __UNCONST(C) }, 137951a39d68df598db08dfced8b4707755864a0492Ying Wang#else 138951a39d68df598db08dfced8b4707755864a0492Ying Wang# define NS_NIS_CB(F,C) 139951a39d68df598db08dfced8b4707755864a0492Ying Wang#endif 140951a39d68df598db08dfced8b4707755864a0492Ying Wang 141951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 142951a39d68df598db08dfced8b4707755864a0492Ying Wang * ns_src - `nsswitch source' 143951a39d68df598db08dfced8b4707755864a0492Ying Wang * Used by the nsparser routines to store a mapping between a source 144951a39d68df598db08dfced8b4707755864a0492Ying Wang * and its dispatch control flags for a given database. 145951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 146951a39d68df598db08dfced8b4707755864a0492Ying Wangtypedef struct { 147951a39d68df598db08dfced8b4707755864a0492Ying Wang const char *name; 148951a39d68df598db08dfced8b4707755864a0492Ying Wang uint32_t flags; 149951a39d68df598db08dfced8b4707755864a0492Ying Wang} ns_src; 150951a39d68df598db08dfced8b4707755864a0492Ying Wang 151951a39d68df598db08dfced8b4707755864a0492Ying Wang 152951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 153951a39d68df598db08dfced8b4707755864a0492Ying Wang * Default sourcelists (if nsswitch.conf is missing, corrupt, 154951a39d68df598db08dfced8b4707755864a0492Ying Wang * or the requested database doesn't have an entry) 155951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 156951a39d68df598db08dfced8b4707755864a0492Ying Wang#if 0 /* MISSING FROM BIONIC */ 157951a39d68df598db08dfced8b4707755864a0492Ying Wangextern const ns_src __nsdefaultsrc[]; 158951a39d68df598db08dfced8b4707755864a0492Ying Wangextern const ns_src __nsdefaultcompat[]; 159951a39d68df598db08dfced8b4707755864a0492Ying Wangextern const ns_src __nsdefaultcompat_forceall[]; 160951a39d68df598db08dfced8b4707755864a0492Ying Wangextern const ns_src __nsdefaultfiles[]; 161951a39d68df598db08dfced8b4707755864a0492Ying Wangextern const ns_src __nsdefaultfiles_forceall[]; 162951a39d68df598db08dfced8b4707755864a0492Ying Wangextern const ns_src __nsdefaultnis[]; 163951a39d68df598db08dfced8b4707755864a0492Ying Wangextern const ns_src __nsdefaultnis_forceall[]; 164951a39d68df598db08dfced8b4707755864a0492Ying Wang#endif /* MISSING */ 165951a39d68df598db08dfced8b4707755864a0492Ying Wang 166951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 167951a39d68df598db08dfced8b4707755864a0492Ying Wang * ns_mtab - `nsswitch method table' 168951a39d68df598db08dfced8b4707755864a0492Ying Wang * An nsswitch module provides a mapping from (database name, method name) 169951a39d68df598db08dfced8b4707755864a0492Ying Wang * tuples to the nss_method and associated callback data. Effectively, 170951a39d68df598db08dfced8b4707755864a0492Ying Wang * ns_dtab, but used for dynamically loaded modules. 171951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 172951a39d68df598db08dfced8b4707755864a0492Ying Wangtypedef struct { 173951a39d68df598db08dfced8b4707755864a0492Ying Wang const char *database; 174951a39d68df598db08dfced8b4707755864a0492Ying Wang const char *name; 175951a39d68df598db08dfced8b4707755864a0492Ying Wang nss_method method; 176951a39d68df598db08dfced8b4707755864a0492Ying Wang void *mdata; 177951a39d68df598db08dfced8b4707755864a0492Ying Wang} ns_mtab; 178951a39d68df598db08dfced8b4707755864a0492Ying Wang 179951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 180951a39d68df598db08dfced8b4707755864a0492Ying Wang * nss_module_register_fn - module registration function 181951a39d68df598db08dfced8b4707755864a0492Ying Wang * called at module load 182951a39d68df598db08dfced8b4707755864a0492Ying Wang * nss_module_unregister_fn - module un-registration function 183951a39d68df598db08dfced8b4707755864a0492Ying Wang * called at module unload 184951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 185951a39d68df598db08dfced8b4707755864a0492Ying Wangtypedef void (*nss_module_unregister_fn)(ns_mtab *, u_int); 186951a39d68df598db08dfced8b4707755864a0492Ying Wangtypedef ns_mtab *(*nss_module_register_fn)(const char *, u_int *, 187951a39d68df598db08dfced8b4707755864a0492Ying Wang nss_module_unregister_fn *); 188951a39d68df598db08dfced8b4707755864a0492Ying Wang 189951a39d68df598db08dfced8b4707755864a0492Ying Wang#ifdef _NS_PRIVATE 190951a39d68df598db08dfced8b4707755864a0492Ying Wang 191951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 192951a39d68df598db08dfced8b4707755864a0492Ying Wang * Private data structures for back-end nsswitch implementation. 193951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 194951a39d68df598db08dfced8b4707755864a0492Ying Wang 195951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 196951a39d68df598db08dfced8b4707755864a0492Ying Wang * ns_dbt - `nsswitch database thang' 197951a39d68df598db08dfced8b4707755864a0492Ying Wang * For each database in /etc/nsswitch.conf there is a ns_dbt, with its 198951a39d68df598db08dfced8b4707755864a0492Ying Wang * name and a list of ns_src's containing the source information. 199951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 200951a39d68df598db08dfced8b4707755864a0492Ying Wangtypedef struct { 201951a39d68df598db08dfced8b4707755864a0492Ying Wang const char *name; /* name of database */ 202951a39d68df598db08dfced8b4707755864a0492Ying Wang ns_src *srclist; /* list of sources */ 203951a39d68df598db08dfced8b4707755864a0492Ying Wang u_int srclistsize; /* size of srclist */ 204951a39d68df598db08dfced8b4707755864a0492Ying Wang} ns_dbt; 205951a39d68df598db08dfced8b4707755864a0492Ying Wang 206951a39d68df598db08dfced8b4707755864a0492Ying Wang/* 207951a39d68df598db08dfced8b4707755864a0492Ying Wang * ns_mod - `nsswitch module' 208951a39d68df598db08dfced8b4707755864a0492Ying Wang */ 209951a39d68df598db08dfced8b4707755864a0492Ying Wangtypedef struct { 210951a39d68df598db08dfced8b4707755864a0492Ying Wang const char *name; /* module name */ 211951a39d68df598db08dfced8b4707755864a0492Ying Wang void *handle; /* handle from dlopen() */ 212951a39d68df598db08dfced8b4707755864a0492Ying Wang ns_mtab *mtab; /* method table */ 213951a39d68df598db08dfced8b4707755864a0492Ying Wang u_int mtabsize; /* size of mtab */ 214951a39d68df598db08dfced8b4707755864a0492Ying Wang /* called to unload module */ 215951a39d68df598db08dfced8b4707755864a0492Ying Wang nss_module_unregister_fn unregister; 216951a39d68df598db08dfced8b4707755864a0492Ying Wang} ns_mod; 217951a39d68df598db08dfced8b4707755864a0492Ying Wang 218951a39d68df598db08dfced8b4707755864a0492Ying Wang#endif /* _NS_PRIVATE */ 219951a39d68df598db08dfced8b4707755864a0492Ying Wang 220951a39d68df598db08dfced8b4707755864a0492Ying Wang 221951a39d68df598db08dfced8b4707755864a0492Ying Wang#include <sys/cdefs.h> 222951a39d68df598db08dfced8b4707755864a0492Ying Wang 223951a39d68df598db08dfced8b4707755864a0492Ying Wang__BEGIN_DECLS 224951a39d68df598db08dfced8b4707755864a0492Ying Wangint nsdispatch(void *, const ns_dtab [], const char *, 225951a39d68df598db08dfced8b4707755864a0492Ying Wang const char *, const ns_src [], ...); 226951a39d68df598db08dfced8b4707755864a0492Ying Wang 227951a39d68df598db08dfced8b4707755864a0492Ying Wang#ifdef _NS_PRIVATE 228951a39d68df598db08dfced8b4707755864a0492Ying Wangint _nsdbtaddsrc(ns_dbt *, const ns_src *); 229951a39d68df598db08dfced8b4707755864a0492Ying Wangvoid _nsdbtdump(const ns_dbt *); 230951a39d68df598db08dfced8b4707755864a0492Ying Wangint _nsdbtput(const ns_dbt *); 231951a39d68df598db08dfced8b4707755864a0492Ying Wangvoid _nsyyerror(const char *); 232951a39d68df598db08dfced8b4707755864a0492Ying Wangint _nsyylex(void); 233951a39d68df598db08dfced8b4707755864a0492Ying Wang#endif /* _NS_PRIVATE */ 234951a39d68df598db08dfced8b4707755864a0492Ying Wang 235951a39d68df598db08dfced8b4707755864a0492Ying Wang__END_DECLS 236951a39d68df598db08dfced8b4707755864a0492Ying Wang 237951a39d68df598db08dfced8b4707755864a0492Ying Wang#endif /* !_NSSWITCH_H */ 238