1 /* $NetBSD: getnetconfig.c,v 1.20 2012/03/20 17:14:50 matt Exp $ */ 2 3 /* 4 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for 5 * unrestricted use provided that this legend is included on all tape 6 * media and as a part of the software program in whole or part. Users 7 * may copy or modify Sun RPC without charge, but are not authorized 8 * to license or distribute it to anyone else except as part of a product or 9 * program developed by the user or with the express written consent of 10 * Sun Microsystems, Inc. 11 * 12 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE 13 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR 14 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE. 15 * 16 * Sun RPC is provided with no support and without any obligation on the 17 * part of Sun Microsystems, Inc. to assist in its use, correction, 18 * modification or enhancement. 19 * 20 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE 21 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC 22 * OR ANY PART THEREOF. 23 * 24 * In no event will Sun Microsystems, Inc. be liable for any lost revenue 25 * or profits or other special, indirect and consequential damages, even if 26 * Sun has been advised of the possibility of such damages. 27 * 28 * Sun Microsystems, Inc. 29 * 2550 Garcia Avenue 30 * Mountain View, California 94043 31 */ 32 33 #include <sys/cdefs.h> 34 #if defined(LIBC_SCCS) && !defined(lint) 35 #if 0 36 static char sccsid[] = "@(#)getnetconfig.c 1.12 91/12/19 SMI"; 37 #else 38 __RCSID("$NetBSD: getnetconfig.c,v 1.20 2012/03/20 17:14:50 matt Exp $"); 39 #endif 40 #endif 41 42 /* 43 * Copyright (c) 1989 by Sun Microsystems, Inc. 44 */ 45 46 #include "namespace.h" 47 #include "reentrant.h" 48 #include <stdio.h> 49 #include <assert.h> 50 #include <errno.h> 51 #include <netconfig.h> 52 #include <stddef.h> 53 #include <stdlib.h> 54 #include <string.h> 55 #include <rpc/rpc.h> 56 #include "rpc_internal.h" 57 58 #ifdef __weak_alias 59 __weak_alias(getnetconfig,_getnetconfig) 60 __weak_alias(setnetconfig,_setnetconfig) 61 __weak_alias(endnetconfig,_endnetconfig) 62 __weak_alias(getnetconfigent,_getnetconfigent) 63 __weak_alias(freenetconfigent,_freenetconfigent) 64 __weak_alias(nc_perror,_nc_perror) 65 __weak_alias(nc_sperror,_nc_sperror) 66 #endif 67 68 /* 69 * The five library routines in this file provide application access to the 70 * system network configuration database, /etc/netconfig. In addition to the 71 * netconfig database and the routines for accessing it, the environment 72 * variable NETPATH and its corresponding routines in getnetpath.c may also be 73 * used to specify the network transport to be used. 74 */ 75 76 77 /* 78 * netconfig errors 79 */ 80 81 #define NC_NONETCONFIG ENOENT 82 #define NC_NOMEM ENOMEM 83 #define NC_NOTINIT EINVAL /* setnetconfig was not called first */ 84 #define NC_BADFILE EBADF /* format for netconfig file is bad */ 85 86 /* 87 * semantics as strings (should be in netconfig.h) 88 */ 89 #define NC_TPI_CLTS_S "tpi_clts" 90 #define NC_TPI_COTS_S "tpi_cots" 91 #define NC_TPI_COTS_ORD_S "tpi_cots_ord" 92 #define NC_TPI_RAW_S "tpi_raw" 93 94 /* 95 * flags as characters (also should be in netconfig.h) 96 */ 97 #define NC_NOFLAG_C '-' 98 #define NC_VISIBLE_C 'v' 99 #define NC_BROADCAST_C 'b' 100 101 /* 102 * Character used to indicate there is no name-to-address lookup library 103 */ 104 #define NC_NOLOOKUP "-" 105 106 static const char * const _nc_errors[] = { 107 "Netconfig database not found", 108 "Not enough memory", 109 "Not initialized", 110 "Netconfig database has invalid format" 111 }; 112 113 struct netconfig_info { 114 int eof; /* all entries has been read */ 115 int ref; /* # of times setnetconfig() has been called */ 116 struct netconfig_list *head; /* head of the list */ 117 struct netconfig_list *tail; /* last of the list */ 118 }; 119 120 struct netconfig_list { 121 char *linep; /* hold line read from netconfig */ 122 struct netconfig *ncp; 123 struct netconfig_list *next; 124 }; 125 126 struct netconfig_vars { 127 int valid; /* token that indicates valid netconfig_vars */ 128 int flag; /* first time flag */ 129 struct netconfig_list *nc_configs; 130 /* pointer to the current netconfig entry */ 131 }; 132 133 #define NC_VALID 0xfeed 134 #define NC_STORAGE 0xf00d 135 #define NC_INVALID 0 136 137 138 static int *__nc_error(void); 139 static int parse_ncp(char *, struct netconfig *); 140 static struct netconfig *dup_ncp(struct netconfig *); 141 142 143 static FILE *nc_file; /* for netconfig db */ 144 static struct netconfig_info ni = { 0, 0, NULL, NULL}; 145 146 #define MAXNETCONFIGLINE 1000 147 148 #ifdef _REENTRANT 149 static thread_key_t nc_key; 150 static once_t nc_once = ONCE_INITIALIZER; 151 152 static void 153 __nc_error_setup(void) 154 { 155 thr_keycreate(&nc_key, free); 156 } 157 #endif 158 159 static int * 160 __nc_error(void) 161 { 162 #ifdef _REENTRANT 163 int *nc_addr = NULL; 164 #endif 165 static int nc_error = 0; 166 167 #ifdef _REENTRANT 168 if (__isthreaded == 0) 169 return &nc_error; 170 thr_once(&nc_once, __nc_error_setup); 171 nc_addr = thr_getspecific(nc_key) ; 172 if (nc_addr == NULL) { 173 nc_addr = malloc(sizeof (int)); 174 if (nc_addr == NULL) 175 return &nc_error; 176 if (thr_setspecific(nc_key, (void *) nc_addr) != 0) { 177 if (nc_addr) 178 free(nc_addr); 179 return &nc_error; 180 } 181 *nc_addr = 0; 182 } 183 return nc_addr; 184 #else 185 return &nc_error; 186 #endif 187 } 188 189 #define nc_error (*(__nc_error())) 190 /* 191 * A call to setnetconfig() establishes a /etc/netconfig "session". A session 192 * "handle" is returned on a successful call. At the start of a session (after 193 * a call to setnetconfig()) searches through the /etc/netconfig database will 194 * proceed from the start of the file. The session handle must be passed to 195 * getnetconfig() to parse the file. Each call to getnetconfig() using the 196 * current handle will process one subsequent entry in /etc/netconfig. 197 * setnetconfig() must be called before the first call to getnetconfig(). 198 * (Handles are used to allow for nested calls to setnetpath()). 199 * 200 * A new session is established with each call to setnetconfig(), with a new 201 * handle being returned on each call. Previously established sessions remain 202 * active until endnetconfig() is called with that session's handle as an 203 * argument. 204 * 205 * setnetconfig() need *not* be called before a call to getnetconfigent(). 206 * setnetconfig() returns a NULL pointer on failure (for example, if 207 * the netconfig database is not present). 208 */ 209 void * 210 setnetconfig(void) 211 { 212 struct netconfig_vars *nc_vars; 213 214 if ((nc_vars = malloc(sizeof(*nc_vars))) == NULL) { 215 return(NULL); 216 } 217 218 /* 219 * For multiple calls, i.e. nc_file is not NULL, we just return the 220 * handle without reopening the netconfig db. 221 */ 222 ni.ref++; 223 if ((nc_file != NULL) || (nc_file = fopen(NETCONFIG, "re")) != NULL) { 224 nc_vars->valid = NC_VALID; 225 nc_vars->flag = 0; 226 nc_vars->nc_configs = ni.head; 227 return ((void *)nc_vars); 228 } 229 ni.ref--; 230 nc_error = NC_NONETCONFIG; 231 free(nc_vars); 232 return (NULL); 233 } 234 235 236 /* 237 * When first called, getnetconfig() returns a pointer to the first entry in 238 * the netconfig database, formatted as a struct netconfig. On each subsequent 239 * call, getnetconfig() returns a pointer to the next entry in the database. 240 * getnetconfig() can thus be used to search the entire netconfig file. 241 * getnetconfig() returns NULL at end of file. 242 */ 243 244 struct netconfig * 245 getnetconfig(void *handlep) 246 { 247 struct netconfig_vars *ncp = (struct netconfig_vars *)handlep; 248 char *stringp; /* tmp string pointer */ 249 struct netconfig_list *list; 250 struct netconfig *np; 251 252 /* 253 * Verify that handle is valid 254 */ 255 if (ncp == NULL || nc_file == NULL) { 256 nc_error = NC_NOTINIT; 257 return (NULL); 258 } 259 260 switch (ncp->valid) { 261 case NC_VALID: 262 /* 263 * If entry has already been read into the list, 264 * we return the entry in the linked list. 265 * If this is the first time call, check if there are any 266 * entries in linked list. If no entries, we need to read the 267 * netconfig db. 268 * If we have been here and the next entry is there, we just 269 * return it. 270 */ 271 if (ncp->flag == 0) { /* first time */ 272 ncp->flag = 1; 273 ncp->nc_configs = ni.head; 274 if (ncp->nc_configs != NULL) /* entry already exist */ 275 return(ncp->nc_configs->ncp); 276 } 277 else if (ncp->nc_configs != NULL && 278 ncp->nc_configs->next != NULL) { 279 ncp->nc_configs = ncp->nc_configs->next; 280 return(ncp->nc_configs->ncp); 281 } 282 283 /* 284 * If we cannot find the entry in the list and is end of file, 285 * we give up. 286 */ 287 if (ni.eof == 1) 288 return(NULL); 289 break; 290 default: 291 nc_error = NC_NOTINIT; 292 return (NULL); 293 } 294 295 stringp = malloc(MAXNETCONFIGLINE); 296 if (stringp == NULL) 297 return (NULL); 298 299 #ifdef MEM_CHK 300 if (malloc_verify() == 0) { 301 fprintf(stderr, "memory heap corrupted in getnetconfig\n"); 302 exit(1); 303 } 304 #endif 305 306 /* 307 * Read a line from netconfig file. 308 */ 309 do { 310 if (fgets(stringp, MAXNETCONFIGLINE, nc_file) == NULL) { 311 free(stringp); 312 ni.eof = 1; 313 return (NULL); 314 } 315 } while (*stringp == '#'); 316 317 list = malloc(sizeof(*list)); 318 if (list == NULL) { 319 free(stringp); 320 return(NULL); 321 } 322 np = malloc(sizeof(*np)); 323 if (np == NULL) { 324 free(stringp); 325 free(list); 326 return(NULL); 327 } 328 list->ncp = np; 329 list->next = NULL; 330 list->ncp->nc_lookups = NULL; 331 list->linep = stringp; 332 if (parse_ncp(stringp, list->ncp) == -1) { 333 free(stringp); 334 free(np); 335 free(list); 336 return (NULL); 337 } else { 338 /* 339 * If this is the first entry that's been read, it is the 340 * head of the list. If not, put the entry at the end of 341 * the list. Reposition the current pointer of the handle to 342 * the last entry in the list. 343 */ 344 if (ni.head == NULL) /* first entry */ 345 ni.head = ni.tail = list; 346 else { 347 ni.tail->next = list; 348 ni.tail = ni.tail->next; 349 } 350 ncp->nc_configs = ni.tail; 351 return(ni.tail->ncp); 352 } 353 } 354 355 /* 356 * endnetconfig() may be called to "unbind" or "close" the netconfig database 357 * when processing is complete, releasing resources for reuse. endnetconfig() 358 * may not be called before setnetconfig(). endnetconfig() returns 0 on 359 * success and -1 on failure (for example, if setnetconfig() was not called 360 * previously). 361 */ 362 int 363 endnetconfig(void *handlep) 364 { 365 struct netconfig_vars *nc_handlep = (struct netconfig_vars *)handlep; 366 367 struct netconfig_list *q, *p; 368 369 /* 370 * Verify that handle is valid 371 */ 372 if (nc_handlep == NULL || (nc_handlep->valid != NC_VALID && 373 nc_handlep->valid != NC_STORAGE)) { 374 nc_error = NC_NOTINIT; 375 return (-1); 376 } 377 378 /* 379 * Return 0 if anyone still needs it. 380 */ 381 nc_handlep->valid = NC_INVALID; 382 nc_handlep->flag = 0; 383 nc_handlep->nc_configs = NULL; 384 if (--ni.ref > 0) { 385 free(nc_handlep); 386 return(0); 387 } 388 389 /* 390 * Noone needs these entries anymore, then frees them. 391 * Make sure all info in netconfig_info structure has been 392 * reinitialized. 393 */ 394 q = p = ni.head; 395 ni.eof = ni.ref = 0; 396 ni.head = NULL; 397 ni.tail = NULL; 398 while (q) { 399 p = q->next; 400 if (q->ncp->nc_lookups != NULL) free(q->ncp->nc_lookups); 401 free(q->ncp); 402 free(q->linep); 403 free(q); 404 q = p; 405 } 406 free(nc_handlep); 407 408 fclose(nc_file); 409 nc_file = NULL; 410 return (0); 411 } 412 413 /* 414 * getnetconfigent(netid) returns a pointer to the struct netconfig structure 415 * corresponding to netid. It returns NULL if netid is invalid (that is, does 416 * not name an entry in the netconfig database). It returns NULL and sets 417 * errno in case of failure (for example, if the netconfig database cannot be 418 * opened). 419 */ 420 421 struct netconfig * 422 getnetconfigent(const char *netid) 423 { 424 FILE *file; /* NETCONFIG db's file pointer */ 425 char *linep; /* holds current netconfig line */ 426 char *stringp; /* temporary string pointer */ 427 struct netconfig *ncp = NULL; /* returned value */ 428 struct netconfig_list *list; /* pointer to cache list */ 429 430 if (netid == NULL || strlen(netid) == 0) 431 return (NULL); 432 433 /* 434 * Look up table if the entries have already been read and parsed in 435 * getnetconfig(), then copy this entry into a buffer and return it. 436 * If we cannot find the entry in the current list and there are more 437 * entries in the netconfig db that has not been read, we then read the 438 * db and try find the match netid. 439 * If all the netconfig db has been read and placed into the list and 440 * there is no match for the netid, return NULL. 441 */ 442 if (ni.head != NULL) { 443 for (list = ni.head; list; list = list->next) { 444 if (strcmp(list->ncp->nc_netid, netid) == 0) 445 return(dup_ncp(list->ncp)); 446 } 447 if (ni.eof == 1) /* that's all the entries */ 448 return(NULL); 449 } 450 451 if ((file = fopen(NETCONFIG, "r")) == NULL) 452 return (NULL); 453 454 if ((linep = malloc(MAXNETCONFIGLINE)) == NULL) { 455 fclose(file); 456 return (NULL); 457 } 458 do { 459 ptrdiff_t len; 460 char *tmpp; /* tmp string pointer */ 461 462 do { 463 if ((stringp = fgets(linep, MAXNETCONFIGLINE, file)) 464 == NULL) 465 break; 466 } while (*stringp == '#'); 467 if (stringp == NULL) /* eof */ 468 break; 469 if ((tmpp = strpbrk(stringp, "\t ")) == NULL) { 470 /* can't parse file */ 471 nc_error = NC_BADFILE; 472 break; 473 } 474 if (strlen(netid) == (size_t) (len = tmpp - stringp) && /* a match */ 475 strncmp(stringp, netid, (size_t)len) == 0) { 476 if ((ncp = malloc(sizeof(*ncp))) == NULL) 477 break; 478 ncp->nc_lookups = NULL; 479 if (parse_ncp(linep, ncp) == -1) { 480 free(ncp); 481 ncp = NULL; 482 } 483 break; 484 } 485 } while (stringp != NULL); 486 if (ncp == NULL) 487 free(linep); 488 fclose(file); 489 return(ncp); 490 } 491 492 /* 493 * freenetconfigent(netconfigp) frees the netconfig structure pointed to by 494 * netconfigp (previously returned by getnetconfigent()). 495 */ 496 497 void 498 freenetconfigent(struct netconfig *netconfigp) 499 { 500 if (netconfigp != NULL) { 501 /* holds all netconfigp's strings */ 502 free(netconfigp->nc_netid); 503 if (netconfigp->nc_lookups != NULL) 504 free(netconfigp->nc_lookups); 505 free(netconfigp); 506 } 507 } 508 509 /* 510 * Parse line and stuff it in a struct netconfig 511 * Typical line might look like: 512 * udp tpi_cots vb inet udp /dev/udp /usr/lib/ip.so,/usr/local/ip.so 513 * 514 * We return -1 if any of the tokens don't parse, or malloc fails. 515 * 516 * Note that we modify stringp (putting NULLs after tokens) and 517 * we set the ncp's string field pointers to point to these tokens within 518 * stringp. 519 */ 520 521 static int 522 parse_ncp( 523 char *stringp, /* string to parse */ 524 struct netconfig *ncp) /* where to put results */ 525 { 526 char *tokenp; /* for processing tokens */ 527 char *lasts; 528 529 _DIAGASSERT(stringp != NULL); 530 _DIAGASSERT(ncp != NULL); 531 532 nc_error = NC_BADFILE; 533 /* nearly anything that breaks is for this reason */ 534 stringp[strlen(stringp)-1] = '\0'; /* get rid of newline */ 535 /* netid */ 536 if ((ncp->nc_netid = strtok_r(stringp, "\t ", &lasts)) == NULL) 537 return (-1); 538 539 /* semantics */ 540 if ((tokenp = strtok_r(NULL, "\t ", &lasts)) == NULL) 541 return (-1); 542 if (strcmp(tokenp, NC_TPI_COTS_ORD_S) == 0) 543 ncp->nc_semantics = NC_TPI_COTS_ORD; 544 else if (strcmp(tokenp, NC_TPI_COTS_S) == 0) 545 ncp->nc_semantics = NC_TPI_COTS; 546 else if (strcmp(tokenp, NC_TPI_CLTS_S) == 0) 547 ncp->nc_semantics = NC_TPI_CLTS; 548 else if (strcmp(tokenp, NC_TPI_RAW_S) == 0) 549 ncp->nc_semantics = NC_TPI_RAW; 550 else 551 return (-1); 552 553 /* flags */ 554 if ((tokenp = strtok_r(NULL, "\t ", &lasts)) == NULL) 555 return (-1); 556 for (ncp->nc_flag = NC_NOFLAG; *tokenp != '\0'; tokenp++) { 557 switch (*tokenp) { 558 case NC_NOFLAG_C: 559 break; 560 case NC_VISIBLE_C: 561 ncp->nc_flag |= NC_VISIBLE; 562 break; 563 case NC_BROADCAST_C: 564 ncp->nc_flag |= NC_BROADCAST; 565 break; 566 default: 567 return (-1); 568 } 569 } 570 /* protocol family */ 571 if ((ncp->nc_protofmly = strtok_r(NULL, "\t ", &lasts)) == NULL) 572 return (-1); 573 /* protocol name */ 574 if ((ncp->nc_proto = strtok_r(NULL, "\t ", &lasts)) == NULL) 575 return (-1); 576 /* network device */ 577 if ((ncp->nc_device = strtok_r(NULL, "\t ", &lasts)) == NULL) 578 return (-1); 579 if ((tokenp = strtok_r(NULL, "\t ", &lasts)) == NULL) 580 return (-1); 581 if (strcmp(tokenp, NC_NOLOOKUP) == 0) { 582 ncp->nc_nlookups = 0; 583 ncp->nc_lookups = NULL; 584 } else { 585 char *cp; /* tmp string */ 586 587 if (ncp->nc_lookups != NULL) /* from last visit */ 588 free(ncp->nc_lookups); 589 /* preallocate one string pointer */ 590 ncp->nc_lookups = malloc(sizeof(*ncp->nc_lookups)); 591 ncp->nc_nlookups = 0; 592 while ((cp = tokenp) != NULL) { 593 tokenp = _get_next_token(cp, ','); 594 ncp->nc_lookups[(size_t)ncp->nc_nlookups++] = cp; 595 ncp->nc_lookups = (char **) 596 realloc(ncp->nc_lookups, 597 (size_t)(ncp->nc_nlookups+1) *sizeof(char *)); 598 /* for next loop */ 599 } 600 } 601 return (0); 602 } 603 604 /* 605 * Returns a string describing the reason for failure. 606 */ 607 char * 608 nc_sperror(void) 609 { 610 const char *message; 611 612 switch(nc_error) { 613 case NC_NONETCONFIG: 614 message = _nc_errors[0]; 615 break; 616 case NC_NOMEM: 617 message = _nc_errors[1]; 618 break; 619 case NC_NOTINIT: 620 message = _nc_errors[2]; 621 break; 622 case NC_BADFILE: 623 message = _nc_errors[3]; 624 break; 625 default: 626 message = "Unknown network selection error"; 627 } 628 return __UNCONST(message); 629 } 630 631 /* 632 * Prints a message onto standard error describing the reason for failure. 633 */ 634 void 635 nc_perror(const char *s) 636 { 637 638 _DIAGASSERT(s != NULL); 639 640 fprintf(stderr, "%s: %s", s, nc_sperror()); 641 } 642 643 /* 644 * Duplicates the matched netconfig buffer. 645 */ 646 static struct netconfig * 647 dup_ncp(struct netconfig *ncp) 648 { 649 struct netconfig *p; 650 char *tmp; 651 u_int i; 652 653 _DIAGASSERT(ncp != NULL); 654 655 if ((tmp = malloc(MAXNETCONFIGLINE)) == NULL) 656 return(NULL); 657 if ((p = malloc(sizeof(*p))) == NULL) { 658 free(tmp); 659 return(NULL); 660 } 661 /* 662 * First we dup all the data from matched netconfig buffer. Then we 663 * adjust some of the member pointer to a pre-allocated buffer where 664 * contains part of the data. 665 * To follow the convention used in parse_ncp(), we store all the 666 * necessary information in the pre-allocated buffer and let each 667 * of the netconfig char pointer member point to the right address 668 * in the buffer. 669 */ 670 *p = *ncp; 671 p->nc_netid = (char *)strcpy(tmp,ncp->nc_netid); 672 tmp = strchr(tmp, '\0') + 1; 673 p->nc_protofmly = (char *)strcpy(tmp,ncp->nc_protofmly); 674 tmp = strchr(tmp, '\0') + 1; 675 p->nc_proto = (char *)strcpy(tmp,ncp->nc_proto); 676 tmp = strchr(tmp, '\0') + 1; 677 p->nc_device = (char *)strcpy(tmp,ncp->nc_device); 678 p->nc_lookups = malloc((size_t)(p->nc_nlookups+1) * sizeof(char *)); 679 if (p->nc_lookups == NULL) { 680 free(p->nc_netid); 681 free(p); 682 return(NULL); 683 } 684 for (i=0; i < p->nc_nlookups; i++) { 685 tmp = strchr(tmp, '\0') + 1; 686 p->nc_lookups[i] = strcpy(tmp,ncp->nc_lookups[i]); 687 } 688 return(p); 689 } 690