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