libpwdgrp/pwd_grp.c

   1 /* vi: set sw=4 ts=4: */
   2 /* Copyright (C) 2014 Tito Ragusa <farmatito@tiscali.it>
   3  *
   4  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
   5  */
   6 /* This program is distributed in the hope that it will be useful,
   7  * but WITHOUT ANY WARRANTY!!
   8  *
   9  * Rewrite of some parts. Main differences are:
  10  *
  11  * 1) the buffer for getpwuid, getgrgid, getpwnam, getgrnam is dynamically
  12  *    allocated.
  13  *    If ENABLE_FEATURE_CLEAN_UP is set the buffers are freed at program
  14  *    exit using the atexit function to make valgrind happy.
  15  * 2) the passwd/group files:
  16  *      a) must contain the expected number of fields (as per count of field
  17  *         delimeters ":") or we will complain with a error message.
  18  *      b) leading and trailing whitespace in fields is stripped.
  19  *      c) some fields are not allowed to be empty (e.g. username, uid/gid,
  20  *         homedir, shell) and in this case NULL is returned and errno is
  21  *         set to EINVAL. This behaviour could be easily changed by
  22  *         modifying PW_DEF, GR_DEF, SP_DEF strings (uppercase
  23  *         makes a field mandatory).
  24  *      d) the string representing uid/gid must be convertible by strtoXX
  25  *         functions, or errno is set to EINVAL.
  26  *      e) leading and trailing whitespace in group member names is stripped.
  27  * 3) the internal function for getgrouplist uses dynamically allocated buffer.
  28  * 4) at the moment only the functions really used by busybox code are
  29  *    implemented, if you need a particular missing function it should be
  30  *    easy to write it by using the internal common code.
  31  */
  32
  33 #include "libbb.h"
  34
  35 struct const_passdb {
  36         const char *filename;
  37         char def[7 + 2*ENABLE_USE_BB_SHADOW];
  38         uint8_t off[7 + 2*ENABLE_USE_BB_SHADOW];
  39         uint8_t numfields;
  40         uint8_t size_of;
  41 };
  42 struct passdb {
  43         const char *filename;
  44         char def[7 + 2*ENABLE_USE_BB_SHADOW];
  45         uint8_t off[7 + 2*ENABLE_USE_BB_SHADOW];
  46         uint8_t numfields;
  47         uint8_t size_of;
  48         FILE *fp;
  49         char *malloced;
  50 };
  51 /* Note: for shadow db, def[] will not contain terminating NUL,
  52  * but convert_to_struct() logic detects def[] end by "less than SP?",
  53  * not by "is it NUL?" condition; and off[0] happens to be zero
  54  * for every db anyway, so there _is_ in fact a terminating NUL there.
  55  */
  56
  57 /* S = string not empty, s = string maybe empty,
  58  * I = uid,gid, l = long maybe empty, m = members,
  59  * r = reserved
  60  */
  61 #define PW_DEF "SsIIsss"
  62 #define GR_DEF "SsIm"
  63 #define SP_DEF "Ssllllllr"
  64
  65 static const struct const_passdb const_pw_db = {
  66         _PATH_PASSWD, PW_DEF,
  67         {
  68                 offsetof(struct passwd, pw_name),       /* 0 S */
  69                 offsetof(struct passwd, pw_passwd),     /* 1 s */
  70                 offsetof(struct passwd, pw_uid),        /* 2 I */
  71                 offsetof(struct passwd, pw_gid),        /* 3 I */
  72                 offsetof(struct passwd, pw_gecos),      /* 4 s */
  73                 offsetof(struct passwd, pw_dir),        /* 5 S */
  74                 offsetof(struct passwd, pw_shell)       /* 6 S */
  75         },
  76         sizeof(PW_DEF)-1, sizeof(struct passwd)
  77 };
  78 static const struct const_passdb const_gr_db = {
  79         _PATH_GROUP, GR_DEF,
  80         {
  81                 offsetof(struct group, gr_name),        /* 0 S */
  82                 offsetof(struct group, gr_passwd),      /* 1 s */
  83                 offsetof(struct group, gr_gid),         /* 2 I */
  84                 offsetof(struct group, gr_mem)          /* 3 m (char **) */
  85         },
  86         sizeof(GR_DEF)-1, sizeof(struct group)
  87 };
  88 #if ENABLE_USE_BB_SHADOW
  89 static const struct const_passdb const_sp_db = {
  90         _PATH_SHADOW, SP_DEF,
  91         {
  92                 offsetof(struct spwd, sp_namp),         /* 0 S Login name */
  93                 offsetof(struct spwd, sp_pwdp),         /* 1 s Encrypted password */
  94                 offsetof(struct spwd, sp_lstchg),       /* 2 l */
  95                 offsetof(struct spwd, sp_min),          /* 3 l */
  96                 offsetof(struct spwd, sp_max),          /* 4 l */
  97                 offsetof(struct spwd, sp_warn),         /* 5 l */
  98                 offsetof(struct spwd, sp_inact),        /* 6 l */
  99                 offsetof(struct spwd, sp_expire),       /* 7 l */
 100                 offsetof(struct spwd, sp_flag)          /* 8 r Reserved */
 101         },
 102         sizeof(SP_DEF)-1, sizeof(struct spwd)
 103 };
 104 #endif
 105
 106 /* We avoid having big global data. */
 107 struct statics {
 108         /* We use same buffer (db[0].malloced) for getpwuid and getpwnam.
 109          * Manpage says:
 110          * "The return value may point to a static area, and may be overwritten
 111          * by subsequent calls to getpwent(), getpwnam(), or getpwuid()."
 112          */
 113         struct passdb db[2 + ENABLE_USE_BB_SHADOW];
 114         char *tokenize_end;
 115         unsigned string_size;
 116 };
 117
 118 static struct statics *ptr_to_statics;
 119 #define S     (*ptr_to_statics)
 120 #define has_S (ptr_to_statics)
 121
 122 #if ENABLE_FEATURE_CLEAN_UP
 123 static void free_static(void)
 124 {
 125         free(S.db[0].malloced);
 126         free(S.db[1].malloced);
 127 # if ENABLE_USE_BB_SHADOW
 128         free(S.db[2].malloced);
 129 # endif
 130         free(ptr_to_statics);
 131 }
 132 #endif
 133
 134 static struct statics *get_S(void)
 135 {
 136         if (!ptr_to_statics) {
 137                 ptr_to_statics = xzalloc(sizeof(S));
 138                 memcpy(&S.db[0], &const_pw_db, sizeof(const_pw_db));
 139                 memcpy(&S.db[1], &const_gr_db, sizeof(const_gr_db));
 140 #if ENABLE_USE_BB_SHADOW
 141                 memcpy(&S.db[2], &const_sp_db, sizeof(const_sp_db));
 142 #endif
 143 #if ENABLE_FEATURE_CLEAN_UP
 144                 atexit(free_static);
 145 #endif
 146         }
 147         return ptr_to_statics;
 148 }
 149
 150 /* Internal functions */
 151
 152 /* Divide the passwd/group/shadow record in fields
 153  * by substituting the given delimeter
 154  * e.g. ':' or ',' with '\0'.
 155  * Returns the number of fields found.
 156  * Strips leading and trailing whitespace in fields.
 157  */
 158 static int tokenize(char *buffer, int ch)
 159 {
 160         char *p = buffer;
 161         char *s = p;
 162         int num_fields = 0;
 163
 164         for (;;) {
 165                 if (isblank(*s)) {
 166                         overlapping_strcpy(s, skip_whitespace(s));
 167                 }
 168                 if (*p == ch || *p == '\0') {
 169                         char *end = p;
 170                         while (p != s && isblank(p[-1]))
 171                                 p--;
 172                         if (p != end)
 173                                 overlapping_strcpy(p, end);
 174                         num_fields++;
 175                         if (*end == '\0') {
 176                                 S.tokenize_end = p + 1;
 177                                 return num_fields;
 178                         }
 179                         *p = '\0';
 180                         s = p + 1;
 181                 }
 182                 p++;
 183         }
 184 }
 185
 186 /* Returns !NULL on success and matching line broken up in fields by '\0' in buf.
 187  * We require the expected number of fields to be found.
 188  */
 189 static char *parse_common(FILE *fp, struct passdb *db,
 190                 const char *key, int field_pos)
 191 {
 192         char *buf;
 193
 194         while ((buf = xmalloc_fgetline(fp)) != NULL) {
 195                 /* Skip empty lines, comment lines */
 196                 if (buf[0] == '\0' || buf[0] == '#')
 197                         goto free_and_next;
 198                 if (tokenize(buf, ':') != db->numfields) {
 199                         /* number of fields is wrong */
 200                         bb_error_msg("%s: bad record", db->filename);
 201                         goto free_and_next;
 202                 }
 203
 204                 if (field_pos == -1) {
 205                         /* no key specified: sequential read, return a record */
 206                         break;
 207                 }
 208                 if (strcmp(key, nth_string(buf, field_pos)) == 0) {
 209                         /* record found */
 210                         break;
 211                 }
 212  free_and_next:
 213                 free(buf);
 214         }
 215
 216         S.string_size = S.tokenize_end - buf;
 217 /*
 218  * Ugly hack: group db requires additional buffer space
 219  * for members[] array. If there is only one group, we need space
 220  * for 3 pointers: alignment padding, group name, NULL.
 221  * +1 for every additional group.
 222  */
 223         if (buf && db->numfields == sizeof(GR_DEF)-1) { /* if we read group file... */
 224                 int cnt = 3;
 225                 char *p = buf;
 226                 while (p < S.tokenize_end)
 227                         if (*p++ == ',')
 228                                 cnt++;
 229                 S.string_size += cnt * sizeof(char*);
 230 //bb_error_msg("+%d words = %u key:%s buf:'%s'", cnt, S.string_size, key, buf);
 231                 buf = xrealloc(buf, S.string_size);
 232         }
 233
 234         return buf;
 235 }
 236
 237 static char *parse_file(struct passdb *db,
 238                 const char *key, int field_pos)
 239 {
 240         char *buf = NULL;
 241         FILE *fp = fopen_for_read(db->filename);
 242
 243         if (fp) {
 244                 buf = parse_common(fp, db, key, field_pos);
 245                 fclose(fp);
 246         }
 247         return buf;
 248 }
 249
 250 /* Convert passwd/group/shadow file record in buffer to a struct */
 251 static void *convert_to_struct(struct passdb *db,
 252                 char *buffer, void *result)
 253 {
 254         const char *def = db->def;
 255         const uint8_t *off = db->off;
 256
 257         /* For consistency, zero out all fields */
 258         memset(result, 0, db->size_of);
 259
 260         for (;;) {
 261                 void *member = (char*)result + (*off++);
 262
 263                 if ((*def | 0x20) == 's') { /* s or S */
 264                         *(char **)member = (char*)buffer;
 265                         if (!buffer[0] && (*def == 'S')) {
 266                                 errno = EINVAL;
 267                         }
 268                 }
 269                 if (*def == 'I') {
 270                         *(int *)member = bb_strtou(buffer, NULL, 10);
 271                 }
 272 #if ENABLE_USE_BB_SHADOW
 273                 if (*def == 'l') {
 274                         long n = -1;
 275                         if (buffer[0])
 276                                 n = bb_strtol(buffer, NULL, 10);
 277                         *(long *)member = n;
 278                 }
 279 #endif
 280                 if (*def == 'm') {
 281                         char **members;
 282                         int i = tokenize(buffer, ',');
 283
 284                         /* Store members[] after buffer's end.
 285                          * This is safe ONLY because there is a hack
 286                          * in parse_common() which allocates additional space
 287                          * at the end of malloced buffer!
 288                          */
 289                         members = (char **)
 290                                 ( ((intptr_t)S.tokenize_end + sizeof(members[0]))
 291                                 & -(intptr_t)sizeof(members[0])
 292                                 );
 293                         ((struct group *)result)->gr_mem = members;
 294                         while (--i >= 0) {
 295                                 if (buffer[0]) {
 296                                         *members++ = buffer;
 297                                         // bb_error_msg("member[]='%s'", buffer);
 298                                 }
 299                                 buffer += strlen(buffer) + 1;
 300                         }
 301                         *members = NULL;
 302                 }
 303                 /* def "r" does nothing */
 304
 305                 def++;
 306                 if ((unsigned char)*def <= (unsigned char)' ')
 307                         break;
 308                 buffer += strlen(buffer) + 1;
 309         }
 310
 311         if (errno)
 312                 result = NULL;
 313         return result;
 314 }
 315
 316 static int massage_data_for_r_func(struct passdb *db,
 317                 char *buffer, size_t buflen,
 318                 void **result,
 319                 char *buf)
 320 {
 321         void *result_buf = *result;
 322         *result = NULL;
 323         if (buf) {
 324                 if (S.string_size > buflen) {
 325                         errno = ERANGE;
 326                 } else {
 327                         memcpy(buffer, buf, S.string_size);
 328                         *result = convert_to_struct(db, buffer, result_buf);
 329                 }
 330                 free(buf);
 331         }
 332         /* "The reentrant functions return zero on success.
 333          * In case of error, an error number is returned."
 334          * NB: not finding the record is also a "success" here:
 335          */
 336         return errno;
 337 }
 338
 339 static void* massage_data_for_non_r_func(struct passdb *db, char *buf)
 340 {
 341         if (!buf)
 342                 return NULL;
 343
 344         free(db->malloced);
 345         /* We enlarge buf and move string data up, freeing space
 346          * for struct passwd/group/spwd at the beginning. This way,
 347          * entire result of getXXnam is in a single malloced block.
 348          * This enables easy creation of xmalloc_getpwnam() API.
 349          */
 350         db->malloced = buf = xrealloc(buf, db->size_of + S.string_size);
 351         memmove(buf + db->size_of, buf, S.string_size);
 352         return convert_to_struct(db, buf + db->size_of, buf);
 353 }
 354
 355 /****** getXXnam/id_r */
 356
 357 static int FAST_FUNC getXXnam_r(const char *name, uintptr_t db_and_field_pos,
 358                 char *buffer, size_t buflen,
 359                 void *result)
 360 {
 361         char *buf;
 362         struct passdb *db = &get_S()->db[db_and_field_pos >> 2];
 363
 364         buf = parse_file(db, name, 0 /*db_and_field_pos & 3*/);
 365         /* "db_and_field_pos & 3" is commented out since so far we don't implement
 366          * getXXXid_r() functions which would use that to pass 2 here */
 367
 368         return massage_data_for_r_func(db, buffer, buflen, result, buf);
 369 }
 370
 371 int FAST_FUNC getpwnam_r(const char *name, struct passwd *struct_buf,
 372                 char *buffer, size_t buflen,
 373                 struct passwd **result)
 374 {
 375         /* Why the "store buffer address in result" trick?
 376          * This way, getXXnam_r has the same ABI signature as getpwnam_r,
 377          * hopefully compiler can optimize tail call better in this case.
 378          */
 379         *result = struct_buf;
 380         return getXXnam_r(name, (0 << 2) + 0, buffer, buflen, result);
 381 }
 382 #if ENABLE_USE_BB_SHADOW
 383 int FAST_FUNC getspnam_r(const char *name, struct spwd *struct_buf, char *buffer, size_t buflen,
 384                 struct spwd **result)
 385 {
 386         *result = struct_buf;
 387         return getXXnam_r(name, (2 << 2) + 0, buffer, buflen, result);
 388 }
 389 #endif
 390
 391 #ifdef UNUSED
 392 /****** getXXent_r */
 393
 394 static int FAST_FUNC getXXent_r(uintptr_t db_idx, char *buffer, size_t buflen,
 395                 void *result)
 396 {
 397         char *buf;
 398         struct passdb *db = &get_S()->db[db_idx];
 399
 400         if (!db->fp) {
 401                 db->fp = fopen_for_read(db->filename);
 402                 if (!db->fp) {
 403                         return errno;
 404                 }
 405                 close_on_exec_on(fileno(db->fp));
 406         }
 407
 408         buf = parse_common(db->fp, db, /*no search key:*/ NULL, -1);
 409         if (!buf && !errno)
 410                 errno = ENOENT;
 411         return massage_data_for_r_func(db, buffer, buflen, result, buf);
 412 }
 413
 414 int FAST_FUNC getpwent_r(struct passwd *struct_buf, char *buffer, size_t buflen,
 415                 struct passwd **result)
 416 {
 417         *result = struct_buf;
 418         return getXXent_r(0, buffer, buflen, result);
 419 }
 420 #endif
 421
 422 /****** getXXent */
 423
 424 static void* FAST_FUNC getXXent(uintptr_t db_idx)
 425 {
 426         char *buf;
 427         struct passdb *db = &get_S()->db[db_idx];
 428
 429         if (!db->fp) {
 430                 db->fp = fopen_for_read(db->filename);
 431                 if (!db->fp) {
 432                         return NULL;
 433                 }
 434                 close_on_exec_on(fileno(db->fp));
 435         }
 436
 437         buf = parse_common(db->fp, db, /*no search key:*/ NULL, -1);
 438         return massage_data_for_non_r_func(db, buf);
 439 }
 440
 441 struct passwd* FAST_FUNC getpwent(void)
 442 {
 443         return getXXent(0);
 444 }
 445
 446 /****** getXXnam/id */
 447
 448 static void* FAST_FUNC getXXnam(const char *name, unsigned db_and_field_pos)
 449 {
 450         char *buf;
 451         struct passdb *db = &get_S()->db[db_and_field_pos >> 2];
 452
 453         buf = parse_file(db, name, db_and_field_pos & 3);
 454         return massage_data_for_non_r_func(db, buf);
 455 }
 456
 457 struct passwd* FAST_FUNC getpwnam(const char *name)
 458 {
 459         return getXXnam(name, (0 << 2) + 0);
 460 }
 461 struct group* FAST_FUNC getgrnam(const char *name)
 462 {
 463         return getXXnam(name, (1 << 2) + 0);
 464 }
 465 struct passwd* FAST_FUNC getpwuid(uid_t id)
 466 {
 467         return getXXnam(utoa(id), (0 << 2) + 2);
 468 }
 469 struct group* FAST_FUNC getgrgid(gid_t id)
 470 {
 471         return getXXnam(utoa(id), (1 << 2) + 2);
 472 }
 473
 474 /****** end/setXXend */
 475
 476 void FAST_FUNC endpwent(void)
 477 {
 478         if (has_S && S.db[0].fp) {
 479                 fclose(S.db[0].fp);
 480                 S.db[0].fp = NULL;
 481         }
 482 }
 483 void FAST_FUNC setpwent(void)
 484 {
 485         if (has_S && S.db[0].fp) {
 486                 rewind(S.db[0].fp);
 487         }
 488 }
 489 void FAST_FUNC endgrent(void)
 490 {
 491         if (has_S && S.db[1].fp) {
 492                 fclose(S.db[1].fp);
 493                 S.db[1].fp = NULL;
 494         }
 495 }
 496
 497 /****** initgroups and getgrouplist */
 498
 499 static gid_t* FAST_FUNC getgrouplist_internal(int *ngroups_ptr,
 500                 const char *user, gid_t gid)
 501 {
 502         FILE *fp;
 503         gid_t *group_list;
 504         int ngroups;
 505
 506         /* We alloc space for 8 gids at a time. */
 507         group_list = xzalloc(8 * sizeof(group_list[0]));
 508         group_list[0] = gid;
 509         ngroups = 1;
 510
 511         fp = fopen_for_read(_PATH_GROUP);
 512         if (fp) {
 513                 struct passdb *db = &get_S()->db[1];
 514                 char *buf;
 515                 while ((buf = parse_common(fp, db, NULL, -1)) != NULL) {
 516                         char **m;
 517                         struct group group;
 518                         if (!convert_to_struct(db, buf, &group))
 519                                 goto next;
 520                         if (group.gr_gid == gid)
 521                                 goto next;
 522                         for (m = group.gr_mem; *m; m++) {
 523                                 if (strcmp(*m, user) != 0)
 524                                         continue;
 525                                 group_list = xrealloc_vector(group_list, /*8=2^3:*/ 3, ngroups);
 526                                 group_list[ngroups++] = group.gr_gid;
 527                                 goto next;
 528                         }
 529  next:
 530                         free(buf);
 531                 }
 532                 fclose(fp);
 533         }
 534         *ngroups_ptr = ngroups;
 535         return group_list;
 536 }
 537
 538 int FAST_FUNC initgroups(const char *user, gid_t gid)
 539 {
 540         int ngroups;
 541         gid_t *group_list = getgrouplist_internal(&ngroups, user, gid);
 542
 543         ngroups = setgroups(ngroups, group_list);
 544         free(group_list);
 545         return ngroups;
 546 }
 547
 548 int FAST_FUNC getgrouplist(const char *user, gid_t gid, gid_t *groups, int *ngroups)
 549 {
 550         int ngroups_old = *ngroups;
 551         gid_t *group_list = getgrouplist_internal(ngroups, user, gid);
 552
 553         if (*ngroups <= ngroups_old) {
 554                 ngroups_old = *ngroups;
 555                 memcpy(groups, group_list, ngroups_old * sizeof(groups[0]));
 556         } else {
 557                 ngroups_old = -1;
 558         }
 559         free(group_list);
 560         return ngroups_old;
 561 }