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