include/nsswitch.h

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