xref: /illumos-gate/usr/src/head/nss_dbdefs.h (revision 74e12c43fe52f2c30f36e65a4d0fb0e8dfd7068a)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2014 Garrett D'Amore <garrett@damore.org>
23  *
24  * Copyright 2012 Nexenta Systems, Inc.  All rights reserved.
25  *
26  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
27  * Use is subject to license terms.
28  *
29  * Database-specific definitions for the getXXXbyYYY routines
30  * (e.g getpwuid_r(), ether_ntohost()) that use the name-service switch.
31  * Database-independent definitions are in <nss_common.h>
32  *
33  * Ideally, this is the only switch header file one would add things
34  * to in order to support a new database.
35  *
36  * NOTE:  The interfaces documented in this file may change in a minor
37  *	  release.  It is intended that in the future a stronger committment
38  *	  will be made to these interface definitions which will guarantee
39  *	  them across minor releases.
40  */
41 
42 #ifndef _NSS_DBDEFS_H
43 #define	_NSS_DBDEFS_H
44 
45 #include <sys/types.h>
46 #include <unistd.h>
47 #include <errno.h>
48 #include <netdb.h>		/* MAXALIASES, MAXADDRS */
49 #include <limits.h>		/* LOGNAME_MAX */
50 #include <nss_common.h>
51 
52 #ifdef	__cplusplus
53 extern "C" {
54 #endif
55 
56 #ifndef	NSS_INCLUDE_UNSAFE
57 #define	NSS_INCLUDE_UNSAFE	1	/* Build old, MT-unsafe interfaces, */
58 #endif	/* NSS_INCLUDE_UNSAFE */	/*  e.g. getpwnam (c.f. getpwnam_r) */
59 
60 /*
61  * Names of the well-known databases.
62  */
63 
64 #define	NSS_DBNAM_ALIASES	"aliases"	/* E-mail aliases, that is */
65 #define	NSS_DBNAM_AUTOMOUNT	"automount"
66 #define	NSS_DBNAM_BOOTPARAMS	"bootparams"
67 #define	NSS_DBNAM_ETHERS	"ethers"
68 #define	NSS_DBNAM_GROUP		"group"
69 #define	NSS_DBNAM_HOSTS		"hosts"
70 #define	NSS_DBNAM_IPNODES	"ipnodes"
71 #define	NSS_DBNAM_NETGROUP	"netgroup"
72 #define	NSS_DBNAM_NETMASKS	"netmasks"
73 #define	NSS_DBNAM_NETWORKS	"networks"
74 #define	NSS_DBNAM_PASSWD	"passwd"
75 #define	NSS_DBNAM_PRINTERS	"printers"
76 #define	NSS_DBNAM_PROJECT	"project"
77 #define	NSS_DBNAM_PROTOCOLS	"protocols"
78 #define	NSS_DBNAM_PUBLICKEY	"publickey"
79 #define	NSS_DBNAM_RPC		"rpc"
80 #define	NSS_DBNAM_SERVICES	"services"
81 #define	NSS_DBNAM_AUDITUSER	"audit_user"
82 #define	NSS_DBNAM_AUTHATTR	"auth_attr"
83 #define	NSS_DBNAM_EXECATTR	"exec_attr"
84 #define	NSS_DBNAM_PROFATTR	"prof_attr"
85 #define	NSS_DBNAM_USERATTR	"user_attr"
86 
87 #define	NSS_DBNAM_TSOL_TP	"tnrhtp"
88 #define	NSS_DBNAM_TSOL_RH	"tnrhdb"
89 #define	NSS_DBNAM_TSOL_ZC	"tnzonecfg"
90 
91 /* getspnam() et al use the "passwd" config entry but the "shadow" backend */
92 #define	NSS_DBNAM_SHADOW	"shadow"
93 
94 /* The "compat" backend gets config entries for these pseudo-databases */
95 #define	NSS_DBNAM_PASSWD_COMPAT	"passwd_compat"
96 #define	NSS_DBNAM_GROUP_COMPAT	"group_compat"
97 
98 /*
99  * Default switch configuration, compiled into the front-ends.
100  *
101  * Absent good reasons to the contrary, this should be compatible with the
102  * default /etc/nsswitch.conf file.
103  */
104 #define	NSS_FILES_ONLY		"files"
105 #define	NSS_FILES_NS		"files nis"
106 #define	NSS_NS_FALLBACK		"nis [NOTFOUND=return] files"
107 #define	NSS_NS_ONLY		"nis"
108 #define	NSS_TSOL_FALLBACK	"files ldap"
109 
110 #define	NSS_DEFCONF_ALIASES	NSS_FILES_NS
111 #define	NSS_DEFCONF_AUTOMOUNT	NSS_FILES_NS
112 #define	NSS_DEFCONF_BOOTPARAMS	NSS_NS_FALLBACK
113 #define	NSS_DEFCONF_ETHERS	NSS_NS_FALLBACK
114 #define	NSS_DEFCONF_GROUP	NSS_FILES_NS
115 #define	NSS_DEFCONF_HOSTS	NSS_NS_FALLBACK
116 #define	NSS_DEFCONF_IPNODES	NSS_NS_FALLBACK
117 #define	NSS_DEFCONF_NETGROUP	NSS_NS_ONLY
118 #define	NSS_DEFCONF_NETMASKS	NSS_NS_FALLBACK
119 #define	NSS_DEFCONF_NETWORKS	NSS_NS_FALLBACK
120 #define	NSS_DEFCONF_PASSWD	NSS_FILES_NS
121 #define	NSS_DEFCONF_PRINTERS	"user files nis"
122 #define	NSS_DEFCONF_PROJECT	NSS_FILES_NS
123 #define	NSS_DEFCONF_PROTOCOLS	NSS_NS_FALLBACK
124 #define	NSS_DEFCONF_PUBLICKEY	NSS_FILES_NS
125 #define	NSS_DEFCONF_RPC		NSS_NS_FALLBACK
126 #define	NSS_DEFCONF_SERVICES	NSS_FILES_NS	/* speeds up byname() */
127 
128 #define	NSS_DEFCONF_GROUP_COMPAT	NSS_NS_ONLY
129 #define	NSS_DEFCONF_PASSWD_COMPAT	NSS_NS_ONLY
130 
131 #define	NSS_DEFCONF_ATTRDB	NSS_FILES_NS
132 
133 #define	NSS_DEFCONF_AUDITUSER	NSS_DEFCONF_PASSWD
134 #define	NSS_DEFCONF_USERATTR	NSS_DEFCONF_PASSWD
135 #define	NSS_DEFCONF_AUTHATTR	NSS_DEFCONF_ATTRDB
136 #define	NSS_DEFCONF_PROFATTR	NSS_DEFCONF_ATTRDB
137 #define	NSS_DEFCONF_EXECATTR	NSS_DEFCONF_PROFATTR
138 
139 #define	NSS_DEFCONF_TSOL_TP	NSS_TSOL_FALLBACK
140 #define	NSS_DEFCONF_TSOL_RH	NSS_TSOL_FALLBACK
141 #define	NSS_DEFCONF_TSOL_ZC	NSS_TSOL_FALLBACK
142 
143 /*
144  * Line-lengths that the "files" and "compat" backends will try to support.
145  * It may be reasonable (even advisable) to use smaller values than these.
146  */
147 
148 #define	NSS_BUFSIZ		1024
149 
150 #define	NSS_LINELEN_GROUP	((NSS_BUFSIZ) * 8)
151 #define	NSS_LINELEN_HOSTS	((NSS_BUFSIZ) * 8)
152 #define	NSS_LINELEN_IPNODES	((NSS_BUFSIZ) * 8)
153 #define	NSS_LINELEN_NETGROUP	((NSS_BUFSIZ) * 32)
154 #define	NSS_LINELEN_NETMASKS	NSS_BUFSIZ
155 #define	NSS_LINELEN_NETWORKS	NSS_BUFSIZ
156 #define	NSS_LINELEN_PASSWD	NSS_BUFSIZ
157 #define	NSS_LINELEN_PRINTERS	NSS_BUFSIZ
158 #define	NSS_LINELEN_PROJECT	((NSS_BUFSIZ) * 4)
159 #define	NSS_LINELEN_PROTOCOLS	NSS_BUFSIZ
160 #define	NSS_LINELEN_PUBLICKEY	NSS_BUFSIZ
161 #define	NSS_LINELEN_RPC		NSS_BUFSIZ
162 #define	NSS_LINELEN_SERVICES	NSS_BUFSIZ
163 #define	NSS_LINELEN_SHADOW	NSS_BUFSIZ
164 #define	NSS_LINELEN_ETHERS	NSS_BUFSIZ
165 #define	NSS_LINELEN_BOOTPARAMS	NSS_BUFSIZ
166 
167 #define	NSS_LINELEN_ATTRDB	NSS_BUFSIZ
168 
169 #define	NSS_LINELEN_AUDITUSER	NSS_LINELEN_ATTRDB
170 #define	NSS_LINELEN_AUTHATTR	NSS_LINELEN_ATTRDB
171 #define	NSS_LINELEN_EXECATTR	NSS_LINELEN_ATTRDB
172 #define	NSS_LINELEN_PROFATTR	NSS_LINELEN_ATTRDB
173 #define	NSS_LINELEN_USERATTR	NSS_LINELEN_ATTRDB
174 
175 #define	NSS_MMAPLEN_EXECATTR	NSS_LINELEN_EXECATTR * 8
176 
177 #define	NSS_LINELEN_TSOL	NSS_BUFSIZ
178 
179 #define	NSS_LINELEN_TSOL_TP	NSS_LINELEN_TSOL
180 #define	NSS_LINELEN_TSOL_RH	NSS_LINELEN_TSOL
181 #define	NSS_LINELEN_TSOL_ZC	NSS_LINELEN_TSOL
182 
183 /*
184  * Reasonable defaults for 'buflen' values passed to _r functions.  The BSD
185  * and SunOS 4.x implementations of the getXXXbyYYY() functions used hard-
186  * coded array sizes;  the values here are meant to handle anything that
187  * those implementations handled.
188  * === These might more reasonably go in <pwd.h>, <netdb.h> et al
189  */
190 
191 #define	NSS_BUFLEN_GROUP	NSS_LINELEN_GROUP
192 #define	NSS_BUFLEN_HOSTS	\
193 	(NSS_LINELEN_HOSTS + (MAXALIASES + MAXADDRS + 2) * sizeof (char *))
194 #define	NSS_BUFLEN_IPNODES	\
195 	(NSS_LINELEN_IPNODES + (MAXALIASES + MAXADDRS + 2) * sizeof (char *))
196 #define	NSS_BUFLEN_NETGROUP	(MAXHOSTNAMELEN * 2 + LOGNAME_MAX + 3)
197 #define	NSS_BUFLEN_NETWORKS	NSS_LINELEN_NETWORKS	/* === ?  + 35 * 4 */
198 #define	NSS_BUFLEN_PASSWD	NSS_LINELEN_PASSWD
199 #define	NSS_BUFLEN_PROJECT	(NSS_LINELEN_PROJECT + 800 * sizeof (char *))
200 #define	NSS_BUFLEN_PROTOCOLS	NSS_LINELEN_PROTOCOLS	/* === ?  + 35 * 4 */
201 #define	NSS_BUFLEN_PUBLICKEY	NSS_LINELEN_PUBLICKEY
202 #define	NSS_BUFLEN_RPC		NSS_LINELEN_RPC		/* === ?  + 35 * 4 */
203 #define	NSS_BUFLEN_SERVICES	NSS_LINELEN_SERVICES	/* === ?  + 35 * 4 */
204 #define	NSS_BUFLEN_SHADOW	NSS_LINELEN_SHADOW
205 #define	NSS_BUFLEN_ETHERS	NSS_LINELEN_ETHERS
206 #define	NSS_BUFLEN_BOOTPARAMS	NSS_LINELEN_BOOTPARAMS
207 
208 #define	NSS_BUFLEN_ATTRDB	NSS_LINELEN_ATTRDB
209 
210 #define	NSS_BUFLEN_AUDITUSER	NSS_BUFLEN_ATTRDB
211 #define	NSS_BUFLEN_AUTHATTR	NSS_BUFLEN_ATTRDB
212 #define	NSS_BUFLEN_EXECATTR	NSS_BUFLEN_ATTRDB
213 #define	NSS_BUFLEN_PROFATTR	NSS_BUFLEN_ATTRDB
214 #define	NSS_BUFLEN_USERATTR	((NSS_BUFLEN_ATTRDB) * 8)
215 
216 #define	NSS_BUFLEN_TSOL		NSS_LINELEN_TSOL
217 #define	NSS_BUFLEN_TSOL_TP	NSS_BUFLEN_TSOL
218 #define	NSS_BUFLEN_TSOL_RH	NSS_BUFLEN_TSOL
219 #define	NSS_BUFLEN_TSOL_ZC	NSS_BUFLEN_TSOL
220 
221 /*
222  * Default cache door buffer size (2x largest buffer)
223  */
224 
225 #define	NSS_BUFLEN_DOOR		((NSS_BUFSIZ) * 16)
226 
227 /*
228  * Arguments and results, passed between the frontends and backends for
229  * the well-known databases.  The getXbyY_r() and getXent_r() routines
230  * use a common format that is further described below;  other routines
231  * use their own formats.
232  */
233 
234 /*
235  * The nss_str2ent_t routine is the data marshaller for the nsswitch.
236  * it converts 'native files' format into 'entry' format as part of the
237  * return processing for a getXbyY interface.
238  *
239  * The nss_groupstr_t routine does the real work for any backend
240  * that can supply a netgroup entry as a string in /etc/group format
241  */
242 typedef int		(*nss_str2ent_t)(const char *in, int inlen,
243 				void *ent, char *buf, int buflen);
244 
245 struct nss_groupsbymem;		/* forward definition */
246 typedef nss_status_t	(*nss_groupstr_t)(const char *instr, int inlen,
247 				struct nss_groupsbymem *);
248 
249 /*
250  * The initgroups() function [see initgroups(3c)] needs to find all the
251  *   groups to which a given user belongs.  To do this it calls
252  *   _getgroupsbymember(), which is part of the frontend for the "group"
253  *   database.
254  * We want the same effect as if we used getgrent_r() to enumerate the
255  *   entire groups database (possibly from multiple sources), but getgrent_r()
256  *   is too inefficient.  Most backends can do better if they know they're
257  *   meant to scan all groups;  hence there's a separate backend operation,
258  *   NSS_DBOP_GROUP_BYMEMBER, which uses the nss_groupsbymem struct.
259  * Note that the normal return-value from such a backend, even when it
260  *   successfully finds matching group entries, is NSS_NOTFOUND, because
261  *   this tells the switch engine to keep searching in any more sources.
262  *   In fact, the backends only return NSS_SUCCESS if they find enough
263  *   matching entries that the gid_array is completely filled, in which
264  *   case the switch engine should stop searching.
265  * If the force_slow_way field is set, the backend should eschew any cached
266  *   information (e.g. the YP netid.byname map or the NIS+ cred.org_dir table)
267  *   and should instead grind its way through the group map/table/whatever.
268  */
269 
270 struct nss_groupsbymem {			/* For _getgroupsbymember() */
271 /* in: */
272 	const char	*username;
273 	gid_t		*gid_array;
274 	int		maxgids;
275 	int		force_slow_way;
276 	nss_str2ent_t	str2ent;
277 	nss_groupstr_t	process_cstr;
278 
279 /* in_out: */
280 	int		numgids;
281 };
282 
283 /*
284  * The netgroup routines are handled as follows:
285  *
286  *   Policy decision:
287  *	If netgroup A refers to netgroup B, both must occur in the same
288  *	source (other choices give very confusing semantics).  This
289  *	assumption is deeply embedded in the frontend and backends.
290  *
291  *    -	setnetgrent(), despite its name, is really a getXXXbyYYY operation:
292  *	it takes a name and finds a netgroup with that name (see the
293  *	nss_setnetgrent_args struct below).  The "result" that it returns
294  *	to the frontend is an nss_backend_t for a pseudo-backend that allows
295  *	one to enumerate the members of that netgroup.
296  *
297  *    -	getnetgrent() calls the 'getXXXent' function in the pseudo-backend;
298  *	it doesn't go through the switch engine at all.  It uses the
299  *	nss_getnetgrent_args struct below.
300  *
301  *    -	innetgr() is implemented on top of __multi_innetgr(), which replaces
302  *	each (char *) argument of innetgr() with a counted vector of (char *).
303  *	The semantics are the same as an OR of the results of innetgr()
304  *	operations on each possible 4-tuple picked from the arguments, but
305  *	it's possible to implement some cases more efficiently.  This is
306  *	important for mountd, which used to read YP netgroup.byhost directly
307  *	in order to determine efficiently whether a given host belonged to any
308  *	one of a long list of netgroups.  Wildcarded arguments are indicated
309  *	by a count of zero.
310  *
311  *    -	__multi_innetgr() uses the nss_innetgr_args struct.  A backend whose
312  *	source contains at least one of the groups listed in the 'groups'
313  *	vector will return NSS_SUCCESS and will set the 'status' field to
314  *	indicate whether any 4-tuple was satisfied.  A backend will only
315  *	return NSS_NOTFOUND if the source contained none of the groups
316  *	listed in the 'groups' vector.
317  */
318 
319 enum nss_netgr_argn {		/* We need (machine, user, domain) triples */
320 	NSS_NETGR_MACHINE = 0,
321 	NSS_NETGR_USER = 1,
322 	NSS_NETGR_DOMAIN = 2,
323 	NSS_NETGR_N = 3
324 };
325 
326 enum nss_netgr_status {		/* Status from setnetgrent, multi_innetgr */
327 	NSS_NETGR_FOUND = 0,
328 	NSS_NETGR_NO = 1,
329 	NSS_NETGR_NOMEM = 2
330 };
331 
332 struct nss_setnetgrent_args {
333 /* in: */
334 	const char		*netgroup;
335 /* out: */
336 	nss_backend_t		*iterator;	/* <==== Explain */
337 };
338 
339 struct nss_getnetgrent_args {
340 /* in: */
341 	char			*buffer;
342 	int			buflen;
343 /* out: */
344 	enum nss_netgr_status	status;
345 	char			*retp[NSS_NETGR_N];
346 };
347 
348 typedef unsigned	nss_innetgr_argc;    /* 0 means wildcard */
349 typedef char **		nss_innetgr_argv;    /* === Do we really need these? */
350 
351 struct nss_innetgr_1arg {
352 	nss_innetgr_argc	argc;
353 	nss_innetgr_argv	argv;
354 };
355 
356 struct nss_innetgr_args {
357 /* in: */
358 	struct nss_innetgr_1arg	arg[NSS_NETGR_N];
359 	struct nss_innetgr_1arg groups;
360 /* out: */
361 	enum nss_netgr_status	status;
362 };
363 
364 /* For NSS_DBOP_NETGROUP_BYNAME */
365 struct nss_netgrent {
366 	char	*netgr_name;
367 	char	*netgr_members;
368 };
369 
370 /*
371  * nss_XbyY_buf_t -- structure containing the generic arguments passwd to
372  *   getXXXbyYYY_r() and getXXXent_r() routines.  The (void *) value points to
373  *   a struct of the appropriate type, e.g. struct passwd or struct hostent.
374  *
375  * The functions that allocate and free these structures do no locking at
376  * all, since the routines that use them are inherently MT-unsafe anyway.
377  */
378 
379 typedef struct {
380 	void		*result;	/* "result" parameter to getXbyY_r() */
381 	char		*buffer;	/* "buffer"     "             "      */
382 	int		buflen;		/* "buflen"     "             "      */
383 } nss_XbyY_buf_t;
384 
385 extern nss_XbyY_buf_t	*_nss_XbyY_buf_alloc(int struct_size, int buffer_size);
386 extern void		 _nss_XbyY_buf_free(nss_XbyY_buf_t *);
387 
388 #define	NSS_XbyY_ALLOC(bufpp, str_size, buf_size)		(\
389 	(*bufpp) == 0						\
390 	? (*bufpp) = _nss_XbyY_buf_alloc(str_size, buf_size)	\
391 	: (*bufpp))
392 
393 #define	NSS_XbyY_FREE(bufpp)	(_nss_XbyY_buf_free(*bufpp), (*bufpp) = 0)
394 
395 /*
396  * The nss_XbyY_args_t struct contains all the information passed between
397  * frontends and backends for the getXbyY_r() and getXent() routines,
398  * including an nss_XbyY_buf_t and the lookup key (unused for getXXXent_r).
399  *
400  * The (*str2ent)() member converts a single XXXent from ASCII text to the
401  * appropriate struct, storing any pointer data (strings, in_addrs, arrays
402  * of these) in the buffer.  The ASCII text is a counted string (*not* a
403  * zero-terminated string) whose length is specified by the instr_len
404  * parameter.  The text is found at the address specified by instr and
405  * the string is treated as readonly. buffer and instr must be non-
406  * intersecting memory areas.
407  *
408  * With the exception of passwd, shadow and group, the text form for these
409  * databases allows trailing comments and arbitrary whitespace.  The
410  * corresponding str2ent routine assumes that comments, leading whitespace
411  * and trailing whitespace have been stripped (and thus assumes that entries
412  * consisting only of these have been discarded).
413  *
414  * The text entries for "rpc" and for the databases described in <netdb.h>
415  * follow a common format (a canonical name with a possibly empty list
416  * of aliases, and some other value), albeit with minor variations.
417  * The function _nss_netdb_aliases() does most of the generic work involved
418  * in parsing and marshalling these into the buffer.
419  */
420 
421 typedef union nss_XbyY_key {	/* No tag; backend should know what to expect */
422 	uid_t		uid;
423 	gid_t		gid;
424 	projid_t	projid;
425 	const char	*name;
426 	int		number;
427 	struct {
428 		int	net;
429 		int		type;
430 	}	netaddr;
431 	struct {
432 		const char	*addr;
433 		int		len;
434 		int		type;
435 	}	hostaddr;
436 	struct {
437 		union {
438 			const char	*name;
439 			int		port;
440 		}		serv;
441 		const char	*proto;
442 	}	serv;
443 	void *ether;
444 	struct {
445 		const char	*name;
446 		const char	*keytype;
447 	} pkey;
448 	struct {
449 		const char	*name;
450 		int		af_family;
451 		int		flags;
452 	}	ipnode;
453 	void *attrp;	/* for the new attr databases */
454 } nss_XbyY_key_t;
455 
456 
457 typedef int		(*nss_key2str_t)(void *buffer, size_t buflen,
458 				nss_XbyY_key_t *key, size_t *len);
459 
460 
461 typedef struct nss_XbyY_args {
462 
463 /* IN */
464 	nss_XbyY_buf_t	buf;
465 	int		stayopen;
466 			/*
467 			 * Support for setXXXent(stayopen)
468 			 * Used only in hosts, protocols,
469 			 * networks, rpc, and services.
470 			 */
471 	nss_str2ent_t	str2ent;
472 	union nss_XbyY_key key;
473 
474 /* OUT */
475 	void		*returnval;
476 	int		erange;
477 	int		h_errno;	/* For gethost*_r() */
478 	nss_status_t	status;		/* from the backend last called */
479 /* NSS2 */
480 	nss_key2str_t	key2str;	/* IN */
481 	size_t		returnlen;	/* OUT */
482 
483 /* NSCD/DOOR data */
484 
485 /* ... buffer arena follows... */
486 } nss_XbyY_args_t;
487 
488 
489 
490 /*
491  * nss/nscd v2 interface, packed buffer format
492  *
493  * A key component of the v2 name service switch is the redirection
494  * of all activity to nscd for actual processing.  In the original
495  * switch most activity took place in each application, and the nscd
496  * cache component was an add-on optional interface.
497  *
498  * The nscd v1 format was a completely private interface that
499  * implemented specific bufferiing formats on a per getXbyY API basis.
500  *
501  * The nss/nscd v2 interface uses a common header and commonalizes
502  * the buffering format as consistently as possible.  The general rule
503  * of thumb is that backends are required to assemble their results in
504  * "files based" format [IE the format used on a per result basis as
505  * returned by the files backend] and then call the standard str2ent
506  * interface.  This is the original intended design as used in the files
507  * and nis backends.
508  *
509  * The benefit of this is that the application side library can assemble
510  * a request and provide a header and a variable length result buffer via
511  * a doors API, and then the nscd side switch can assemble a a getXbyY
512  * request providing the result buffer and a str2ent function that copies
513  * but does not unpack the result.
514  *
515  * This results is returned back via the door, and unpacked using the
516  * native library side str2ent interface.
517  *
518  * Additionally, the common header allows extensibility to add new
519  * getXbyYs, putXbyYs or other maintenance APIs to/from nscd without
520  * changing the existing "old style" backend interfaces.
521  *
522  * Finally new style getXbyY, putXbyY and backend interfaces can be
523  * by adding new operation requests to the header, while old style
524  * backwards compatability.
525  */
526 
527 /*
528  * nss/nscd v2 callnumber definitions
529  */
530 
531 /*
532  * callnumbers are separated by categories, such as:
533  * application to nscd requests, nscd to nscd requests,
534  * smf to nscd requests, etc.
535  */
536 
537 #define	NSCDV2CATMASK	(0xFF000000)
538 #define	NSCDV2CALLMASK	(0x00FFFFFF)
539 
540 /*
541  * nss/nscd v2 categories
542  */
543 
544 #define	NSCD_CALLCAT_APP	('a'<<24)
545 #define	NSCD_CALLCAT_N2N	('n'<<24)
546 
547 /* nscd v2 app-> nscd callnumbers */
548 
549 #define	NSCD_SEARCH	(NSCD_CALLCAT_APP|0x01)
550 #define	NSCD_SETENT	(NSCD_CALLCAT_APP|0x02)
551 #define	NSCD_GETENT	(NSCD_CALLCAT_APP|0x03)
552 #define	NSCD_ENDENT	(NSCD_CALLCAT_APP|0x04)
553 #define	NSCD_PUT	(NSCD_CALLCAT_APP|0x05)
554 #define	NSCD_GETHINTS	(NSCD_CALLCAT_APP|0x06)
555 
556 /* nscd v2 SETENT cookie markers */
557 
558 #define	NSCD_NEW_COOKIE		0
559 #define	NSCD_LOCAL_COOKIE	1
560 
561 /* nscd v2 header revision */
562 /* treated as 0xMMMMmmmm MMMM - Major Rev, mmmm - Minor Rev */
563 
564 #define	NSCD_HEADER_REV		0x00020000
565 
566 /*
567  * ptr/uint data type used to calculate shared nscd buffer struct sizes
568  * sizes/offsets are arbitrarily limited to 32 bits for 32/64 compatibility
569  * datatype is 64 bits for possible pointer storage and future use
570  */
571 
572 typedef uint64_t	nssuint_t;
573 
574 /*
575  * nscd v2 buffer layout overview
576  *
577  * The key interface to nscd moving forward is the doors interface
578  * between applications and nscd (NSCD_CALLCAT_APP), and nscd and
579  * it's children (NSCD_CALLCAT_N2N).
580  *
581  * Regardless of the interface used, the buffer layout is consistent.
582  * The General Layout is:
583  *   [nss_pheader_t][IN key][OUT data results]{extend results}
584  *
585  *   The header (nss_pheader_t) remains constant.
586  *   Keys and key layouts vary between call numbers/requests
587  *	NSCD_CALLCAT_APP use key layouts mimics/defines in nss_dbdefs.h
588  *	NSCD_CALLCAT_NSN use layouts defined by nscd headers
589  *   Data and data results vary between results
590  *	NSCD_CALLCAT_APP return "file standard format" output buffers
591  *	NSCD_CALLCAT_NSN return data defined by nscd headers
592  *   extended results are optional and vary
593  *
594  */
595 
596 /*
597  * nss_pheader_t -- buffer header structure that contains switch data
598  * "packed" by the client into a buffer suitable for transport over
599  * nscd's door, and that can be unpacked into a native form within
600  * nscd's switch.  Capable of packing and unpacking data ans results.
601  *
602  * NSCD_HEADER_REV: 0x00020000		16 x uint64 = (128 byte header)
603  */
604 
605 typedef struct {
606 	uint32_t	nsc_callnumber;		/* packed buffer request */
607 	uint32_t	nss_dbop;		/* old nss dbop */
608 	uint32_t	p_ruid;			/* real uid */
609 	uint32_t	p_euid;			/* effective uid */
610 	uint32_t	p_version;		/* 0xMMMMmmmm Major/minor */
611 	uint32_t	p_status;		/* nss_status_t */
612 	uint32_t	p_errno;		/* errno */
613 	uint32_t	p_herrno;		/* h_errno */
614 	nssuint_t	libpriv;		/* reserved (for lib/client) */
615 	nssuint_t	pbufsiz;		/* buffer size */
616 	nssuint_t	dbd_off;		/* IN: db desc off */
617 	nssuint_t	dbd_len;		/* IN: db desc len */
618 	nssuint_t	key_off;		/* IN: key off */
619 	nssuint_t	key_len;		/* IN: key len */
620 	nssuint_t	data_off;		/* OUT: data off */
621 	nssuint_t	data_len;		/* OUT: data len */
622 	nssuint_t	ext_off;		/* OUT: extended results off */
623 	nssuint_t	ext_len;		/* OUT: extended results len */
624 	nssuint_t	nscdpriv;		/* reserved (for nscd) */
625 	nssuint_t	reserved1;		/* reserved (TBD) */
626 } nss_pheader_t;
627 
628 /*
629  * nss_pnetgr_t -- packed offset structure for holding keys used
630  * by innetgr (__multi_innetgr) key
631  * Key format is:
632  *    nss_pnetgr_t
633  *     (nssuint_t)[machine_argc] offsets to strings
634  *     (nssuint_t)[user_argc] offsets to strings
635  *     (nssuint_t)[domain_argc] offsets to strings
636  *     (nssuint_t)[groups_argc] offsets to strings
637  *     machine,user,domain,groups strings
638  */
639 
640 typedef struct {
641 	uint32_t	machine_argc;
642 	uint32_t	user_argc;
643 	uint32_t	domain_argc;
644 	uint32_t	groups_argc;
645 	nssuint_t	machine_offv;
646 	nssuint_t	user_offv;
647 	nssuint_t	domain_offv;
648 	nssuint_t	groups_offv;
649 } nss_pnetgr_t;
650 
651 
652 /* status returned by the str2ent parsing routines */
653 #define	NSS_STR_PARSE_SUCCESS 0
654 #define	NSS_STR_PARSE_PARSE 1
655 #define	NSS_STR_PARSE_ERANGE 2
656 
657 #define	NSS_XbyY_INIT(str, res, bufp, len, func)	(\
658 	(str)->buf.result = (res),			\
659 	(str)->buf.buffer = (bufp),			\
660 	(str)->buf.buflen = (len),			\
661 	(str)->stayopen  = 0,				\
662 	(str)->str2ent  = (func),			\
663 	(str)->key2str  = NULL,				\
664 	(str)->returnval = 0,				\
665 	(str)->returnlen = 0,				\
666 	(str)->h_errno    = 0,				\
667 	(str)->erange    = 0)
668 
669 #define	NSS_XbyY_INIT_EXT(str, res, bufp, len, func, kfunc)	(\
670 	(str)->buf.result = (res),			\
671 	(str)->buf.buffer = (bufp),			\
672 	(str)->buf.buflen = (len),			\
673 	(str)->stayopen  = 0,				\
674 	(str)->str2ent  = (func),			\
675 	(str)->key2str  = (kfunc),			\
676 	(str)->returnval = 0,				\
677 	(str)->returnlen = 0,				\
678 	(str)->h_errno    = 0,				\
679 	(str)->erange    = 0)
680 
681 #define	NSS_XbyY_FINI(str)	_nss_XbyY_fini(str)
682 
683 #define	NSS_PACKED_CRED_CHECK(buf, ruid, euid)		(\
684 	((nss_pheader_t *)(buf))->p_ruid == (ruid) && \
685 	((nss_pheader_t *)(buf))->p_euid == (euid))
686 
687 extern void		*_nss_XbyY_fini(nss_XbyY_args_t *);
688 extern char		**_nss_netdb_aliases(const char *, int, char *, int);
689 extern nss_status_t	nss_default_key2str(void *, size_t, nss_XbyY_args_t *,
690 					const char *, int, size_t *);
691 extern nss_status_t	nss_packed_arg_init(void *, size_t, nss_db_root_t *,
692 					nss_db_initf_t *, int *,
693 					nss_XbyY_args_t *);
694 extern nss_status_t	nss_packed_context_init(void *, size_t, nss_db_root_t *,
695 					nss_db_initf_t *, nss_getent_t **,
696 					nss_XbyY_args_t *);
697 extern void		nss_packed_set_status(void *, size_t, nss_status_t,
698 					nss_XbyY_args_t *);
699 extern nss_status_t	nss_packed_getkey(void *, size_t, char **, int *,
700 					nss_XbyY_args_t *);
701 
702 /*
703  * nss_dbop_t values for searches with various keys;  values for
704  * destructor/endent/setent/getent are defined in <nss_common.h>
705  */
706 
707 /*
708  * These are part of the "Over the wire" IE app->nscd getXbyY
709  * op for well known getXbyY's.  Cannot use NSS_DBOP_X_Y directly
710  * because NSS_DBOP_next_iter is NOT an incrementing counter value
711  * it's a starting offset into an array value.
712  */
713 
714 #define	NSS_DBOP_X(x)			((x)<<16)
715 #define	NSS_DBOP_XY(x, y)		((x)|(y))
716 
717 #define	NSS_DBOP_ALIASES	NSS_DBOP_X(1)
718 #define	NSS_DBOP_AUTOMOUNT	NSS_DBOP_X(2)
719 #define	NSS_DBOP_BOOTPARAMS	NSS_DBOP_X(3)
720 #define	NSS_DBOP_ETHERS		NSS_DBOP_X(4)
721 #define	NSS_DBOP_GROUP		NSS_DBOP_X(5)
722 #define	NSS_DBOP_HOSTS		NSS_DBOP_X(6)
723 #define	NSS_DBOP_IPNODES	NSS_DBOP_X(7)
724 #define	NSS_DBOP_NETGROUP	NSS_DBOP_X(8)
725 #define	NSS_DBOP_NETMASKS	NSS_DBOP_X(9)
726 #define	NSS_DBOP_NETWORKS	NSS_DBOP_X(10)
727 #define	NSS_DBOP_PASSWD		NSS_DBOP_X(11)
728 #define	NSS_DBOP_PRINTERS	NSS_DBOP_X(12)
729 #define	NSS_DBOP_PROJECT	NSS_DBOP_X(13)
730 #define	NSS_DBOP_PROTOCOLS	NSS_DBOP_X(14)
731 #define	NSS_DBOP_PUBLICKEY	NSS_DBOP_X(15)
732 #define	NSS_DBOP_RPC		NSS_DBOP_X(16)
733 #define	NSS_DBOP_SERVICES	NSS_DBOP_X(17)
734 #define	NSS_DBOP_AUDITUSER	NSS_DBOP_X(18)
735 #define	NSS_DBOP_AUTHATTR	NSS_DBOP_X(19)
736 #define	NSS_DBOP_EXECATTR	NSS_DBOP_X(20)
737 #define	NSS_DBOP_PROFATTR	NSS_DBOP_X(21)
738 #define	NSS_DBOP_USERATTR	NSS_DBOP_X(22)
739 
740 #define	NSS_DBOP_GROUP_BYNAME		(NSS_DBOP_next_iter)
741 #define	NSS_DBOP_GROUP_BYGID		(NSS_DBOP_GROUP_BYNAME + 1)
742 #define	NSS_DBOP_GROUP_BYMEMBER		(NSS_DBOP_GROUP_BYGID  + 1)
743 
744 #define	NSS_DBOP_PASSWD_BYNAME		(NSS_DBOP_next_iter)
745 #define	NSS_DBOP_PASSWD_BYUID		(NSS_DBOP_PASSWD_BYNAME + 1)
746 
747 /* The "compat" backend requires that PASSWD_BYNAME == SHADOW_BYNAME */
748 /*   (it also requires that both use key.name to pass the username). */
749 #define	NSS_DBOP_SHADOW_BYNAME		(NSS_DBOP_PASSWD_BYNAME)
750 
751 #define	NSS_DBOP_PROJECT_BYNAME		(NSS_DBOP_next_iter)
752 #define	NSS_DBOP_PROJECT_BYID		(NSS_DBOP_PROJECT_BYNAME + 1)
753 
754 #define	NSS_DBOP_HOSTS_BYNAME		(NSS_DBOP_next_iter)
755 #define	NSS_DBOP_HOSTS_BYADDR		(NSS_DBOP_HOSTS_BYNAME + 1)
756 
757 #define	NSS_DBOP_IPNODES_BYNAME		(NSS_DBOP_next_iter)
758 #define	NSS_DBOP_IPNODES_BYADDR		(NSS_DBOP_IPNODES_BYNAME + 1)
759 
760 /*
761  * NSS_DBOP_NAME_2ADDR
762  * NSS_DBOP_ADDR_2NAME
763  *                                : are defines for ipv6 api's
764  */
765 
766 #define	NSS_DBOP_NAME_2ADDR		(NSS_DBOP_next_ipv6_iter)
767 #define	NSS_DBOP_ADDR_2NAME		(NSS_DBOP_NAME_2ADDR + 1)
768 
769 #define	NSS_DBOP_RPC_BYNAME		(NSS_DBOP_next_iter)
770 #define	NSS_DBOP_RPC_BYNUMBER		(NSS_DBOP_RPC_BYNAME + 1)
771 
772 #define	NSS_DBOP_NETWORKS_BYNAME		(NSS_DBOP_next_iter)
773 #define	NSS_DBOP_NETWORKS_BYADDR		(NSS_DBOP_NETWORKS_BYNAME + 1)
774 
775 #define	NSS_DBOP_SERVICES_BYNAME	(NSS_DBOP_next_iter)
776 #define	NSS_DBOP_SERVICES_BYPORT	(NSS_DBOP_SERVICES_BYNAME + 1)
777 
778 #define	NSS_DBOP_PROTOCOLS_BYNAME	(NSS_DBOP_next_iter)
779 #define	NSS_DBOP_PROTOCOLS_BYNUMBER	(NSS_DBOP_PROTOCOLS_BYNAME + 1)
780 
781 #define	NSS_DBOP_ETHERS_HOSTTON	(NSS_DBOP_next_noiter)
782 #define	NSS_DBOP_ETHERS_NTOHOST	(NSS_DBOP_ETHERS_HOSTTON + 1)
783 
784 #define	NSS_DBOP_BOOTPARAMS_BYNAME	(NSS_DBOP_next_noiter)
785 #define	NSS_DBOP_NETMASKS_BYNET	(NSS_DBOP_next_noiter)
786 
787 #define	NSS_DBOP_PRINTERS_BYNAME	(NSS_DBOP_next_iter)
788 
789 /*
790  * The "real" backend for netgroup (__multi_innetgr, setnetgrent)
791  * Note: _BYNAME is implemented only in "files" (for now).
792  */
793 #define	NSS_DBOP_NETGROUP_IN		(NSS_DBOP_next_iter)
794 #define	NSS_DBOP_NETGROUP_SET		(NSS_DBOP_NETGROUP_IN  + 1)
795 #define	NSS_DBOP_NETGROUP_BYNAME	(NSS_DBOP_NETGROUP_SET + 1)
796 
797 /*
798  * The backend for getpublickey and getsecretkey (getkeys)
799  */
800 #define	NSS_DBOP_KEYS_BYNAME		(NSS_DBOP_next_iter)
801 
802 /*
803  * The pseudo-backend for netgroup (returned by setnetgrent) doesn't have
804  *   any getXXXbyYYY operations, just the usual destr/end/set/get ops,
805  *   so needs no definitions here.
806  */
807 
808 #define	NSS_DBOP_ATTRDB_BYNAME		(NSS_DBOP_next_iter)
809 
810 #define	NSS_DBOP_AUDITUSER_BYNAME	NSS_DBOP_ATTRDB_BYNAME
811 #define	NSS_DBOP_AUTHATTR_BYNAME	NSS_DBOP_ATTRDB_BYNAME
812 #define	NSS_DBOP_EXECATTR_BYNAME	NSS_DBOP_ATTRDB_BYNAME
813 #define	NSS_DBOP_EXECATTR_BYID		(NSS_DBOP_EXECATTR_BYNAME + 1)
814 #define	NSS_DBOP_EXECATTR_BYNAMEID	(NSS_DBOP_EXECATTR_BYID + 1)
815 #define	NSS_DBOP_PROFATTR_BYNAME	NSS_DBOP_ATTRDB_BYNAME
816 #define	NSS_DBOP_USERATTR_BYNAME	NSS_DBOP_ATTRDB_BYNAME
817 
818 #define	NSS_DBOP_TSOL_TP_BYNAME		(NSS_DBOP_next_iter)
819 #define	NSS_DBOP_TSOL_RH_BYADDR		(NSS_DBOP_next_iter)
820 #define	NSS_DBOP_TSOL_ZC_BYNAME		(NSS_DBOP_next_iter)
821 
822 /*
823  * Used all over in the switch code. The best home for it I can think of.
824  * Power-of-two alignments only.
825  */
826 #define	ROUND_DOWN(n, align)	(((uintptr_t)n) & ~((align) - 1l))
827 #define	ROUND_UP(n, align)	ROUND_DOWN(((uintptr_t)n) + (align) - 1l, \
828 				(align))
829 
830 #ifdef	__cplusplus
831 }
832 #endif
833 
834 #endif /* _NSS_DBDEFS_H */
835