nss/nsswitch.c

   1 /* Copyright (C) 1996, 1997 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1996.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Library General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Library General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public
  16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18    Boston, MA 02111-1307, USA.  */
  19
  20 #include <ctype.h>
  21 #include <dlfcn.h>
  22 #include <errno.h>
  23 #include <netdb.h>
  24 #include <libc-lock.h>
  25 #include <link.h>       /* We need some help from ld.so.  */
  26 #include <search.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <gnu/lib-names.h>
  31
  32 #include "nsswitch.h"
  33
  34 /* Prototypes for the local functions.  */
  35 static void *nss_lookup_function (service_user *ni, const char *fct_name);
  36 static name_database *nss_parse_file (const char *fname);
  37 static name_database_entry *nss_getline (char *line);
  38 static service_user *nss_parse_service_list (const char *line);
  39 static service_library *nss_new_service (name_database *database,
  40                                          const char *name);
  41
  42
  43 /* Declare external database variables.  */
  44 #define DEFINE_DATABASE(name)                                                 \
  45   extern service_user *__nss_##name##_database;                               \
  46   weak_extern (__nss_##name##_database)
  47 #include "databases.def"
  48 #undef DEFINE_DATABASE
  49
  50 /* Structure to map database name to variable.  */
  51 static struct
  52 {
  53   const char *name;
  54   service_user **dbp;
  55 } databases[] =
  56 {
  57 #define DEFINE_DATABASE(name)                                                 \
  58   { #name, &__nss_##name##_database },
  59 #include "databases.def"
  60 #undef DEFINE_DATABASE
  61 };
  62
  63
  64 __libc_lock_define_initialized (static, lock)
  65
  66
  67 /* String with revision number of the shared object files.  */
  68 static const char *const __nss_shlib_revision = LIBNSS_FILES_SO + 15;
  69
  70 /* The root of the whole data base.  */
  71 static name_database *service_table;
  72
  73
  74 /* -1 == database not found
  75     0 == database entry pointer stored */
  76 int
  77 __nss_database_lookup (const char *database, const char *alternate_name,
  78                        const char *defconfig, service_user **ni)
  79 {
  80   /* Prevent multiple threads to change the service table.  */
  81   __libc_lock_lock (lock);
  82
  83   /* Reconsider database variable in case some other thread called
  84      `__nss_configure_lookup' while we waited for the lock.  */
  85   if (*ni != NULL)
  86     {
  87       __libc_lock_unlock (lock);
  88       return 0;
  89     }
  90
  91   /* Are we initialized yet?  */
  92   if (service_table == NULL)
  93     /* Read config file.  */
  94     service_table = nss_parse_file (_PATH_NSSWITCH_CONF);
  95
  96   /* Test whether configuration data is available.  */
  97   if (service_table != NULL)
  98     {
  99       /* Return first `service_user' entry for DATABASE.  */
 100       name_database_entry *entry;
 101
 102       /* XXX Could use some faster mechanism here.  But each database is
 103          only requested once and so this might not be critical.  */
 104       for (entry = service_table->entry; entry != NULL; entry = entry->next)
 105         if (strcmp (database, entry->name) == 0)
 106           *ni = entry->service;
 107
 108       if (*ni == NULL && alternate_name != NULL)
 109         /* We haven't found an entry so far.  Try to find it with the
 110            alternative name.  */
 111         for (entry = service_table->entry; entry != NULL; entry = entry->next)
 112           if (strcmp (alternate_name, entry->name) == 0)
 113             *ni = entry->service;
 114     }
 115
 116   /* No configuration data is available, either because nsswitch.conf
 117      doesn't exist or because it doesn't has a line for this database.
 118
 119      DEFCONFIG specifies the default service list for this database,
 120      or null to use the most common default.  */
 121   if (*ni == NULL)
 122     *ni = nss_parse_service_list (defconfig
 123                                   ?: "nis [NOTFOUND=return] files");
 124
 125   __libc_lock_unlock (lock);
 126
 127   return 0;
 128 }
 129
 130
 131 /* -1 == not found
 132     0 == adjusted for next function */
 133 int
 134 __nss_lookup (service_user **ni, const char *fct_name, void **fctp)
 135 {
 136   *fctp = nss_lookup_function (*ni, fct_name);
 137
 138   while (*fctp == NULL
 139          && nss_next_action (*ni, NSS_STATUS_UNAVAIL) == NSS_ACTION_CONTINUE
 140          && (*ni)->next != NULL)
 141     {
 142       *ni = (*ni)->next;
 143
 144       *fctp = nss_lookup_function (*ni, fct_name);
 145     }
 146
 147   return *fctp != NULL ? 0 : -1;
 148 }
 149
 150
 151 /* -1 == not found
 152     0 == adjusted for next function
 153     1 == finished */
 154 int
 155 __nss_next (service_user **ni, const char *fct_name, void **fctp, int status,
 156             int all_values)
 157 {
 158   if (all_values)
 159     {
 160       if (nss_next_action (*ni, NSS_STATUS_TRYAGAIN) == NSS_ACTION_RETURN
 161           && nss_next_action (*ni, NSS_STATUS_UNAVAIL) == NSS_ACTION_RETURN
 162           && nss_next_action (*ni, NSS_STATUS_NOTFOUND) == NSS_ACTION_RETURN
 163           && nss_next_action (*ni, NSS_STATUS_SUCCESS) == NSS_ACTION_RETURN)
 164         return 1;
 165     }
 166   else
 167     {
 168       /* This is really only for debugging.  */
 169        if (NSS_STATUS_TRYAGAIN > status || status > NSS_STATUS_RETURN)
 170          __libc_fatal ("illegal status in " __FUNCTION__);
 171
 172        if (nss_next_action (*ni, status) == NSS_ACTION_RETURN)
 173          return 1;
 174     }
 175
 176   if ((*ni)->next == NULL)
 177     return -1;
 178
 179   do
 180     {
 181       *ni = (*ni)->next;
 182
 183       *fctp = nss_lookup_function (*ni, fct_name);
 184     }
 185   while (*fctp == NULL
 186          && nss_next_action (*ni, NSS_STATUS_UNAVAIL) == NSS_ACTION_CONTINUE
 187          && (*ni)->next != NULL);
 188
 189   return *fctp != NULL ? 0 : -1;
 190 }
 191
 192
 193 int
 194 __nss_configure_lookup (const char *dbname, const char *service_line)
 195 {
 196   service_user *new_db;
 197   size_t cnt;
 198
 199   for (cnt = 0; cnt < sizeof databases; ++cnt)
 200     {
 201       int cmp = strcmp (dbname, databases[cnt].name);
 202       if (cmp == 0)
 203         break;
 204       if (cmp < 0)
 205         {
 206           __set_errno (EINVAL);
 207           return -1;
 208         }
 209     }
 210
 211   if (cnt == sizeof databases)
 212     {
 213       __set_errno (EINVAL);
 214       return -1;
 215     }
 216
 217   /* Test whether it is really used.  */
 218   if (databases[cnt].dbp == NULL)
 219     /* Nothing to do, but we could do.  */
 220     return 0;
 221
 222   /* Try to generate new data.  */
 223   new_db = nss_parse_service_list (service_line);
 224   if (new_db == NULL)
 225     {
 226       /* Illegal service specification.  */
 227       __set_errno (EINVAL);
 228       return -1;
 229     }
 230
 231   /* Prevent multiple threads to change the service table.  */
 232   __libc_lock_lock (lock);
 233
 234   /* Install new rules.  */
 235   *databases[cnt].dbp = new_db;
 236
 237   __libc_lock_unlock (lock);
 238
 239   return 0;
 240 }
 241
 242
 243 static int
 244 nss_dlerror_run (void (*operate) (void))
 245 {
 246   char *last_errstring = NULL;
 247   const char *last_object_name = NULL;
 248   int result;
 249
 250   (void) _dl_catch_error (&last_errstring, &last_object_name, operate);
 251
 252   result = last_errstring != NULL;
 253   if (result)
 254     free (last_errstring);
 255
 256   return result;
 257 }
 258
 259
 260 /* Comparison function for searching NI->known tree.  */
 261 static int
 262 known_compare (const void *p1, const void *p2)
 263 {
 264   return p1 == p2 ? 0 : strcmp (*(const char *const *) p1,
 265                                 *(const char *const *) p2);
 266 }
 267
 268
 269 static void *
 270 nss_lookup_function (service_user *ni, const char *fct_name)
 271 {
 272   void **found, *result;
 273
 274   /* We now modify global data.  Protect it.  */
 275   __libc_lock_lock (lock);
 276
 277   /* Search the tree of functions previously requested.  Data in the
 278      tree are `known_function' structures, whose first member is a
 279      `const char *', the lookup key.  The search returns a pointer to
 280      the tree node structure; the first member of the is a pointer to
 281      our structure (i.e. what will be a `known_function'); since the
 282      first member of that is the lookup key string, &FCT_NAME is close
 283      enough to a pointer to our structure to use as a lookup key that
 284      will be passed to `known_compare' (above).  */
 285
 286   found = __tsearch (&fct_name, (void **) &ni->known, &known_compare);
 287   if (*found != &fct_name)
 288     /* The search found an existing structure in the tree.  */
 289     result = ((known_function *) *found)->fct_ptr;
 290   else
 291     {
 292       /* This name was not known before.  Now we have a node in the tree
 293          (in the proper sorted position for FCT_NAME) that points to
 294          &FCT_NAME instead of any real `known_function' structure.
 295          Allocate a new structure and fill it in.  */
 296
 297       known_function *known = malloc (sizeof *known);
 298       if (! known)
 299         {
 300         remove_from_tree:
 301           /* Oops.  We can't instantiate this node properly.
 302              Remove it from the tree.  */
 303           __tdelete (&fct_name, (void **) &ni->known, &known_compare);
 304           result = NULL;
 305         }
 306       else
 307         {
 308           /* Point the tree node at this new structure.  */
 309           *found = known;
 310           known->fct_name = fct_name;
 311
 312           if (ni->library == NULL)
 313             {
 314               /* This service has not yet been used.  Fetch the service
 315                  library for it, creating a new one if need be.  If there
 316                  is no service table from the file, this static variable
 317                  holds the head of the service_library list made from the
 318                  default configuration.  */
 319               static name_database default_table;
 320               ni->library = nss_new_service (service_table ?: &default_table,
 321                                              ni->name);
 322               if (ni->library == NULL)
 323                 {
 324                   /* This only happens when out of memory.  */
 325                   free (known);
 326                   goto remove_from_tree;
 327                 }
 328             }
 329
 330           if (ni->library->lib_handle == NULL)
 331             {
 332               /* Load the shared library.  */
 333               size_t shlen = (7 + strlen (ni->library->name) + 3
 334                               + strlen (__nss_shlib_revision) + 1);
 335               char shlib_name[shlen];
 336
 337               void do_open (void)
 338                 {
 339                   /* Open and relocate the shared object.  */
 340                   ni->library->lib_handle = _dl_open (shlib_name, RTLD_LAZY);
 341                 }
 342
 343               /* Construct shared object name.  */
 344               __stpcpy (__stpcpy (__stpcpy (__stpcpy (shlib_name, "libnss_"),
 345                                             ni->library->name),
 346                                   ".so"),
 347                         __nss_shlib_revision);
 348
 349               if (nss_dlerror_run (do_open) != 0)
 350                 /* Failed to load the library.  */
 351                 ni->library->lib_handle = (void *) -1l;
 352             }
 353
 354           if (ni->library->lib_handle == (void *) -1l)
 355             /* Library not found => function not found.  */
 356             result = NULL;
 357           else
 358             {
 359               /* Get the desired function.  Again,  GNU ld.so magic ahead.  */
 360               size_t namlen = (5 + strlen (ni->library->name) + 1
 361                                + strlen (fct_name) + 1);
 362               char name[namlen];
 363               struct link_map *map = ni->library->lib_handle;
 364               ElfW(Addr) loadbase;
 365               const ElfW(Sym) *ref = NULL;
 366               void get_sym (void)
 367                 {
 368                   struct link_map *scope[2] = { map, NULL };
 369                   loadbase = _dl_lookup_symbol (name, &ref,
 370                                                 scope, map->l_name, 0);
 371                 }
 372
 373               /* Construct the function name.  */
 374               __stpcpy (__stpcpy (__stpcpy (__stpcpy (name, "_nss_"),
 375                                             ni->library->name),
 376                                   "_"),
 377                         fct_name);
 378
 379               /* Look up the symbol.  */
 380               result = (nss_dlerror_run (get_sym)
 381                         ? NULL : (void *) (loadbase + ref->st_value));
 382             }
 383
 384           /* Remember function pointer for later calls.  Even if null, we
 385              record it so a second try needn't search the library again.  */
 386           known->fct_ptr = result;
 387         }
 388     }
 389
 390   /* Remove the lock.  */
 391   __libc_lock_unlock (lock);
 392
 393   return result;
 394 }
 395
 396
 397 static name_database *
 398 nss_parse_file (const char *fname)
 399 {
 400   FILE *fp;
 401   name_database *result;
 402   name_database_entry *last;
 403   char *line;
 404   size_t len;
 405
 406   /* Open the configuration file.  */
 407   fp = fopen (fname, "r");
 408   if (fp == NULL)
 409     return NULL;
 410
 411   result = (name_database *) malloc (sizeof (name_database));
 412   if (result == NULL)
 413     return NULL;
 414
 415   result->entry = NULL;
 416   result->library = NULL;
 417   last = NULL;
 418   line = NULL;
 419   len = 0;
 420   do
 421     {
 422       name_database_entry *this;
 423       ssize_t n;
 424       char *cp;
 425
 426       n = __getline (&line, &len, fp);
 427       if (n < 0)
 428         break;
 429       if (line[n - 1] == '\n')
 430         line[n - 1] = '\0';
 431
 432       /* Because the file format does not know any form of quoting we
 433          can search forward for the next '#' character and if found
 434          make it terminating the line.  */
 435       cp = strchr (line, '#');
 436       if (cp != NULL)
 437         *cp = '\0';
 438
 439       /* If the line is blank it is ignored.  */
 440       if (line[0] == '\0')
 441         continue;
 442
 443       /* Each line completely specifies the actions for a database.  */
 444       this = nss_getline (line);
 445       if (this != NULL)
 446         {
 447           if (last != NULL)
 448             last->next = this;
 449           else
 450             result->entry = this;
 451
 452           last = this;
 453         }
 454     }
 455   while (!feof (fp));
 456
 457   /* Free the buffer.  */
 458   free (line);
 459   /* Close configuration file.  */
 460   fclose (fp);
 461
 462   return result;
 463 }
 464
 465
 466 /* Read the source names:
 467         `( <source> ( "[" "!"? (<status> "=" <action> )+ "]" )? )*'
 468    */
 469 static service_user *
 470 nss_parse_service_list (const char *line)
 471 {
 472   service_user *result = NULL, **nextp = &result;
 473
 474   while (1)
 475     {
 476       service_user *new_service;
 477       const char *name;
 478
 479       while (isspace (line[0]))
 480         ++line;
 481       if (line[0] == '\0')
 482         /* No source specified.  */
 483         return result;
 484
 485       /* Read <source> identifier.  */
 486       name = line;
 487       while (line[0] != '\0' && !isspace (line[0]) && line[0] != '[')
 488         ++line;
 489       if (name == line)
 490         return result;
 491
 492
 493       new_service = (service_user *) malloc (sizeof (service_user));
 494       if (new_service == NULL)
 495         return result;
 496       else
 497         {
 498           char *source = (char *) malloc (line - name + 1);
 499           if (source == NULL)
 500             {
 501               free (new_service);
 502               return result;
 503             }
 504           memcpy (source, name, line - name);
 505           source[line - name] = '\0';
 506
 507           new_service->name = source;
 508         }
 509
 510       /* Set default actions.  */
 511       new_service->actions[2 + NSS_STATUS_TRYAGAIN] = NSS_ACTION_CONTINUE;
 512       new_service->actions[2 + NSS_STATUS_UNAVAIL] = NSS_ACTION_CONTINUE;
 513       new_service->actions[2 + NSS_STATUS_NOTFOUND] = NSS_ACTION_CONTINUE;
 514       new_service->actions[2 + NSS_STATUS_SUCCESS] = NSS_ACTION_RETURN;
 515       new_service->actions[2 + NSS_STATUS_RETURN] = NSS_ACTION_RETURN;
 516       new_service->library = NULL;
 517       new_service->known = NULL;
 518       new_service->next = NULL;
 519
 520       while (isspace (line[0]))
 521         ++line;
 522
 523       if (line[0] == '[')
 524         {
 525           /* Read criterions.  */
 526           do
 527             ++line;
 528           while (line[0] != '\0' && isspace (line[0]));
 529
 530           do
 531             {
 532               int not;
 533               enum nss_status status;
 534               lookup_actions action;
 535
 536               /* Grok ! before name to mean all statii but that one.  */
 537               if (not = line[0] == '!')
 538                 ++line;
 539
 540               /* Read status name.  */
 541               name = line;
 542               while (line[0] != '\0' && !isspace (line[0]) && line[0] != '='
 543                      && line[0] != ']')
 544                 ++line;
 545
 546               /* Compare with known statii.  */
 547               if (line - name == 7)
 548                 {
 549                   if (__strncasecmp (name, "SUCCESS", 7) == 0)
 550                     status = NSS_STATUS_SUCCESS;
 551                   else if (__strncasecmp (name, "UNAVAIL", 7) == 0)
 552                     status = NSS_STATUS_UNAVAIL;
 553                   else
 554                     return result;
 555                 }
 556               else if (line - name == 8)
 557                 {
 558                   if (__strncasecmp (name, "NOTFOUND", 8) == 0)
 559                     status = NSS_STATUS_NOTFOUND;
 560                   else if (__strncasecmp (name, "TRYAGAIN", 8) == 0)
 561                     status = NSS_STATUS_TRYAGAIN;
 562                   else
 563                     return result;
 564                 }
 565               else
 566                 return result;
 567
 568               while (isspace (line[0]))
 569                 ++line;
 570               if (line[0] != '=')
 571                 return result;
 572               do
 573                 ++line;
 574               while (isspace (line[0]));
 575
 576               name = line;
 577               while (line[0] != '\0' && !isspace (line[0]) && line[0] != '='
 578                      && line[0] != ']')
 579                 ++line;
 580
 581               if (line - name == 6 && __strncasecmp (name, "RETURN", 6) == 0)
 582                 action = NSS_ACTION_RETURN;
 583               else if (line - name == 8
 584                        && __strncasecmp (name, "CONTINUE", 8) == 0)
 585                 action = NSS_ACTION_CONTINUE;
 586               else
 587                 return result;
 588
 589               if (not)
 590                 {
 591                   /* Save the current action setting for this status,
 592                      set them all to the given action, and reset this one.  */
 593                   const lookup_actions save = new_service->actions[2 + status];
 594                   new_service->actions[2 + NSS_STATUS_TRYAGAIN] = action;
 595                   new_service->actions[2 + NSS_STATUS_UNAVAIL] = action;
 596                   new_service->actions[2 + NSS_STATUS_NOTFOUND] = action;
 597                   new_service->actions[2 + NSS_STATUS_SUCCESS] = action;
 598                   new_service->actions[2 + status] = save;
 599                 }
 600               else
 601                 new_service->actions[2 + status] = action;
 602
 603               /* Skip white spaces.  */
 604               while (isspace (line[0]))
 605                 ++line;
 606             }
 607           while (line[0] != ']');
 608
 609           /* Skip the ']'.  */
 610           ++line;
 611         }
 612
 613       *nextp = new_service;
 614       nextp = &new_service->next;
 615     }
 616 }
 617
 618 static name_database_entry *
 619 nss_getline (char *line)
 620 {
 621   const char *name;
 622   name_database_entry *result;
 623
 624   /* Ignore leading white spaces.  ATTENTION: this is different from
 625      what is implemented in Solaris.  The Solaris man page says a line
 626      beginning with a white space character is ignored.  We regard
 627      this as just another misfeature in Solaris.  */
 628   while (isspace (line[0]))
 629     ++line;
 630
 631   /* Recognize `<database> ":"'.  */
 632   name = line;
 633   while (line[0] != '\0' && !isspace (line[0]) && line[0] != ':')
 634     ++line;
 635   if (line[0] == '\0' || name == line)
 636     /* Syntax error.  */
 637     return NULL;
 638   *line++ = '\0';
 639
 640   result = (name_database_entry *) malloc (sizeof (name_database_entry));
 641   if (result == NULL)
 642     return NULL;
 643
 644   /* Save the database name.  */
 645   {
 646     const size_t len = strlen (name) + 1;
 647     char *new = malloc (len);
 648     if (new == NULL)
 649       {
 650         free (result);
 651         return NULL;
 652       }
 653     result->name = memcpy (new, name, len);
 654   }
 655
 656   /* Parse the list of services.  */
 657   result->service = nss_parse_service_list (line);
 658
 659   result->next = NULL;
 660   return result;
 661 }
 662
 663
 664 static service_library *
 665 nss_new_service (name_database *database, const char *name)
 666 {
 667   service_library **currentp = &database->library;
 668
 669   while (*currentp != NULL)
 670     {
 671       if (strcmp ((*currentp)->name, name) == 0)
 672         return *currentp;
 673       currentp = &(*currentp)->next;
 674     }
 675
 676   /* We have to add the new service.  */
 677   *currentp = (service_library *) malloc (sizeof (service_library));
 678   if (*currentp == NULL)
 679     return NULL;
 680
 681   (*currentp)->name = name;
 682   (*currentp)->lib_handle = NULL;
 683   (*currentp)->next = NULL;
 684
 685   return *currentp;
 686 }