1 /*- 2 * Copyright (c) 2006 Michael Bushkov <bushman@freebsd.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 */ 27 28 #include <sys/cdefs.h> 29 __FBSDID("$FreeBSD$"); 30 31 #include <arpa/inet.h> 32 #include <errno.h> 33 #include <grp.h> 34 #include <stdio.h> 35 #include <stdlib.h> 36 #include <string.h> 37 #include <stringlist.h> 38 #include <unistd.h> 39 40 #include <atf-c.h> 41 42 #include "testutil.h" 43 44 enum test_methods { 45 TEST_GETGRENT = 1, 46 TEST_GETGRNAM = 2, 47 TEST_GETGRGID = 4, 48 TEST_GETGRENT_2PASS = 8, 49 TEST_BUILD_SNAPSHOT = 16, 50 }; 51 52 DECLARE_TEST_DATA(group) 53 DECLARE_TEST_FILE_SNAPSHOT(group) 54 DECLARE_1PASS_TEST(group) 55 DECLARE_2PASS_TEST(group) 56 57 static void clone_group(struct group *, struct group const *); 58 static int compare_group(struct group *, struct group *, void *); 59 static void dump_group(struct group *); 60 static void free_group(struct group *); 61 62 static void sdump_group(struct group *, char *, size_t); 63 static int group_read_snapshot_func(struct group *, char *); 64 65 static int group_check_ambiguity(struct group_test_data *, struct group *); 66 static int group_fill_test_data(struct group_test_data *); 67 static int group_test_correctness(struct group *, void *); 68 static int group_test_getgrnam(struct group *, void *); 69 static int group_test_getgrgid(struct group *, void *); 70 static int group_test_getgrent(struct group *, void *); 71 72 IMPLEMENT_TEST_DATA(group) 73 IMPLEMENT_TEST_FILE_SNAPSHOT(group) 74 IMPLEMENT_1PASS_TEST(group) 75 IMPLEMENT_2PASS_TEST(group) 76 77 static void 78 clone_group(struct group *dest, struct group const *src) 79 { 80 ATF_REQUIRE(dest != NULL); 81 ATF_REQUIRE(src != NULL); 82 83 char **cp; 84 int members_num; 85 86 memset(dest, 0, sizeof(struct group)); 87 88 if (src->gr_name != NULL) { 89 dest->gr_name = strdup(src->gr_name); 90 ATF_REQUIRE(dest->gr_name != NULL); 91 } 92 93 if (src->gr_passwd != NULL) { 94 dest->gr_passwd = strdup(src->gr_passwd); 95 ATF_REQUIRE(dest->gr_passwd != NULL); 96 } 97 dest->gr_gid = src->gr_gid; 98 99 if (src->gr_mem != NULL) { 100 members_num = 0; 101 for (cp = src->gr_mem; *cp; ++cp) 102 ++members_num; 103 104 dest->gr_mem = calloc(members_num + 1, sizeof(char *)); 105 ATF_REQUIRE(dest->gr_mem != NULL); 106 107 for (cp = src->gr_mem; *cp; ++cp) { 108 dest->gr_mem[cp - src->gr_mem] = strdup(*cp); 109 ATF_REQUIRE(dest->gr_mem[cp - src->gr_mem] != NULL); 110 } 111 } 112 } 113 114 static void 115 free_group(struct group *grp) 116 { 117 char **cp; 118 119 ATF_REQUIRE(grp != NULL); 120 121 free(grp->gr_name); 122 free(grp->gr_passwd); 123 124 for (cp = grp->gr_mem; *cp; ++cp) 125 free(*cp); 126 free(grp->gr_mem); 127 } 128 129 static int 130 compare_group(struct group *grp1, struct group *grp2, void *mdata) 131 { 132 char **c1, **c2; 133 134 if (grp1 == grp2) 135 return (0); 136 137 if (grp1 == NULL || grp2 == NULL) 138 goto errfin; 139 140 if (strcmp(grp1->gr_name, grp2->gr_name) != 0 || 141 strcmp(grp1->gr_passwd, grp2->gr_passwd) != 0 || 142 grp1->gr_gid != grp2->gr_gid) 143 goto errfin; 144 145 c1 = grp1->gr_mem; 146 c2 = grp2->gr_mem; 147 148 if (grp1->gr_mem == NULL || grp2->gr_mem == NULL) 149 goto errfin; 150 151 for (; *c1 && *c2; ++c1, ++c2) 152 if (strcmp(*c1, *c2) != 0) 153 goto errfin; 154 155 if (*c1 != NULL || *c2 != NULL) 156 goto errfin; 157 158 return 0; 159 160 errfin: 161 if (mdata == NULL) { 162 printf("following structures are not equal:\n"); 163 dump_group(grp1); 164 dump_group(grp2); 165 } 166 167 return (-1); 168 } 169 170 static void 171 sdump_group(struct group *grp, char *buffer, size_t buflen) 172 { 173 char **cp; 174 int written; 175 176 written = snprintf(buffer, buflen, "%s:%s:%d:", 177 grp->gr_name, grp->gr_passwd, grp->gr_gid); 178 buffer += written; 179 if (written > (int)buflen) 180 return; 181 buflen -= written; 182 183 if (grp->gr_mem != NULL) { 184 if (*(grp->gr_mem) != NULL) { 185 for (cp = grp->gr_mem; *cp; ++cp) { 186 written = snprintf(buffer, buflen, "%s%s", 187 cp == grp->gr_mem ? "" : ",", *cp); 188 buffer += written; 189 if (written > (int)buflen) 190 return; 191 buflen -= written; 192 193 if (buflen == 0) 194 return; 195 } 196 } else 197 snprintf(buffer, buflen, "nomem"); 198 } else 199 snprintf(buffer, buflen, "(null)"); 200 } 201 202 static int 203 group_read_snapshot_func(struct group *grp, char *line) 204 { 205 StringList *sl; 206 char *s, *ps, *ts; 207 const char *sep; 208 int i; 209 210 printf("1 line read from snapshot:\n%s\n", line); 211 212 i = 0; 213 sl = NULL; 214 ps = line; 215 sep = ":"; 216 memset(grp, 0, sizeof(struct group)); 217 while ((s = strsep(&ps, sep)) != NULL) { 218 switch (i) { 219 case 0: 220 grp->gr_name = strdup(s); 221 ATF_REQUIRE(grp->gr_name != NULL); 222 break; 223 224 case 1: 225 grp->gr_passwd = strdup(s); 226 ATF_REQUIRE(grp->gr_passwd != NULL); 227 break; 228 229 case 2: 230 grp->gr_gid = (gid_t)strtol(s, &ts, 10); 231 if (*ts != '\0') { 232 free(grp->gr_name); 233 free(grp->gr_passwd); 234 grp->gr_name = NULL; 235 grp->gr_passwd = NULL; 236 return (-1); 237 } 238 /* Change to parsing groups. */ 239 sep = ","; 240 break; 241 242 default: 243 if (sl == NULL) { 244 if (strcmp(s, "(null)") == 0) 245 return (0); 246 247 sl = sl_init(); 248 ATF_REQUIRE(sl != NULL); 249 250 if (strcmp(s, "nomem") != 0) { 251 ts = strdup(s); 252 ATF_REQUIRE(ts != NULL); 253 sl_add(sl, ts); 254 } 255 } else { 256 ts = strdup(s); 257 ATF_REQUIRE(ts != NULL); 258 sl_add(sl, ts); 259 } 260 break; 261 } 262 ++i; 263 } 264 265 if (i < 3) { 266 free(grp->gr_name); 267 free(grp->gr_passwd); 268 memset(grp, 0, sizeof(struct group)); 269 return (-1); 270 } 271 272 sl_add(sl, NULL); 273 grp->gr_mem = sl->sl_str; 274 275 /* NOTE: is it a dirty hack or not? */ 276 free(sl); 277 return (0); 278 } 279 280 static void 281 dump_group(struct group *result) 282 { 283 if (result != NULL) { 284 char buffer[1024]; 285 sdump_group(result, buffer, sizeof(buffer)); 286 printf("%s\n", buffer); 287 } else 288 printf("(null)\n"); 289 } 290 291 static int 292 group_fill_test_data(struct group_test_data *td) 293 { 294 struct group *grp; 295 296 setgroupent(1); 297 while ((grp = getgrent()) != NULL) { 298 if (group_test_correctness(grp, NULL) == 0) 299 TEST_DATA_APPEND(group, td, grp); 300 else 301 return (-1); 302 } 303 endgrent(); 304 305 return (0); 306 } 307 308 static int 309 group_test_correctness(struct group *grp, void *mdata __unused) 310 { 311 printf("testing correctness with the following data:\n"); 312 dump_group(grp); 313 314 if (grp == NULL) 315 goto errfin; 316 317 if (grp->gr_name == NULL) 318 goto errfin; 319 320 if (grp->gr_passwd == NULL) 321 goto errfin; 322 323 if (grp->gr_mem == NULL) 324 goto errfin; 325 326 printf("correct\n"); 327 328 return (0); 329 errfin: 330 printf("incorrect\n"); 331 332 return (-1); 333 } 334 335 /* group_check_ambiguity() is needed here because when doing the getgrent() 336 * calls sequence, records from different nsswitch sources can be different, 337 * though having the same pw_name/pw_uid */ 338 static int 339 group_check_ambiguity(struct group_test_data *td, struct group *pwd) 340 { 341 342 return (TEST_DATA_FIND(group, td, pwd, compare_group, NULL) != 343 NULL ? 0 : -1); 344 } 345 346 static int 347 group_test_getgrnam(struct group *grp_model, void *mdata) 348 { 349 struct group *grp; 350 351 printf("testing getgrnam() with the following data:\n"); 352 dump_group(grp_model); 353 354 grp = getgrnam(grp_model->gr_name); 355 if (group_test_correctness(grp, NULL) != 0) 356 goto errfin; 357 358 if (compare_group(grp, grp_model, NULL) != 0 && 359 group_check_ambiguity((struct group_test_data *)mdata, grp) != 0) 360 goto errfin; 361 362 return (0); 363 364 errfin: 365 return (-1); 366 } 367 368 static int 369 group_test_getgrgid(struct group *grp_model, void *mdata) 370 { 371 struct group *grp; 372 373 printf("testing getgrgid() with the following data...\n"); 374 dump_group(grp_model); 375 376 grp = getgrgid(grp_model->gr_gid); 377 if (group_test_correctness(grp, NULL) != 0 || 378 (compare_group(grp, grp_model, NULL) != 0 && 379 group_check_ambiguity((struct group_test_data *)mdata, grp) != 0)) 380 return (-1); 381 else 382 return (0); 383 } 384 385 static int 386 group_test_getgrent(struct group *grp, void *mdata __unused) 387 { 388 /* 389 * Only correctness can be checked when doing 1-pass test for 390 * getgrent(). 391 */ 392 return (group_test_correctness(grp, NULL)); 393 } 394 395 static int 396 run_tests(const char *snapshot_file, enum test_methods method) 397 { 398 struct group_test_data td, td_snap, td_2pass; 399 int rv; 400 401 TEST_DATA_INIT(group, &td, clone_group, free_group); 402 TEST_DATA_INIT(group, &td_snap, clone_group, free_group); 403 if (snapshot_file != NULL) { 404 if (access(snapshot_file, W_OK | R_OK) != 0) { 405 if (errno == ENOENT) 406 method = TEST_BUILD_SNAPSHOT; 407 else { 408 printf("can't access the file %s\n", 409 snapshot_file); 410 411 rv = -1; 412 goto fin; 413 } 414 } else { 415 if (method == TEST_BUILD_SNAPSHOT) { 416 rv = 0; 417 goto fin; 418 } 419 420 TEST_SNAPSHOT_FILE_READ(group, snapshot_file, 421 &td_snap, group_read_snapshot_func); 422 } 423 } 424 425 rv = group_fill_test_data(&td); 426 if (rv == -1) 427 return (-1); 428 switch (method) { 429 case TEST_GETGRNAM: 430 if (snapshot_file == NULL) 431 rv = DO_1PASS_TEST(group, &td, 432 group_test_getgrnam, (void *)&td); 433 else 434 rv = DO_1PASS_TEST(group, &td_snap, 435 group_test_getgrnam, (void *)&td_snap); 436 break; 437 case TEST_GETGRGID: 438 if (snapshot_file == NULL) 439 rv = DO_1PASS_TEST(group, &td, 440 group_test_getgrgid, (void *)&td); 441 else 442 rv = DO_1PASS_TEST(group, &td_snap, 443 group_test_getgrgid, (void *)&td_snap); 444 break; 445 case TEST_GETGRENT: 446 if (snapshot_file == NULL) 447 rv = DO_1PASS_TEST(group, &td, group_test_getgrent, 448 (void *)&td); 449 else 450 rv = DO_2PASS_TEST(group, &td, &td_snap, 451 compare_group, NULL); 452 break; 453 case TEST_GETGRENT_2PASS: 454 TEST_DATA_INIT(group, &td_2pass, clone_group, free_group); 455 rv = group_fill_test_data(&td_2pass); 456 if (rv != -1) 457 rv = DO_2PASS_TEST(group, &td, &td_2pass, 458 compare_group, NULL); 459 TEST_DATA_DESTROY(group, &td_2pass); 460 break; 461 case TEST_BUILD_SNAPSHOT: 462 if (snapshot_file != NULL) 463 rv = TEST_SNAPSHOT_FILE_WRITE(group, snapshot_file, &td, 464 sdump_group); 465 break; 466 default: 467 rv = 0; 468 break; 469 } 470 471 fin: 472 TEST_DATA_DESTROY(group, &td_snap); 473 TEST_DATA_DESTROY(group, &td); 474 475 return (rv); 476 } 477 478 #define SNAPSHOT_FILE "snapshot_grp" 479 480 ATF_TC_WITHOUT_HEAD(getgrent); 481 ATF_TC_BODY(getgrent, tc) 482 { 483 484 ATF_REQUIRE(run_tests(SNAPSHOT_FILE, TEST_GETGRENT) == 0); 485 } 486 487 ATF_TC_WITHOUT_HEAD(getgrent_with_snapshot); 488 ATF_TC_BODY(getgrent_with_snapshot, tc) 489 { 490 491 ATF_REQUIRE(run_tests(SNAPSHOT_FILE, TEST_BUILD_SNAPSHOT) == 0); 492 ATF_REQUIRE(run_tests(SNAPSHOT_FILE, TEST_GETGRENT) == 0); 493 } 494 495 ATF_TC_WITHOUT_HEAD(getgrent_with_two_pass); 496 ATF_TC_BODY(getgrent_with_two_pass, tc) 497 { 498 499 ATF_REQUIRE(run_tests(SNAPSHOT_FILE, TEST_GETGRENT_2PASS) == 0); 500 } 501 502 ATF_TC_WITHOUT_HEAD(getgrgid); 503 ATF_TC_BODY(getgrgid, tc) 504 { 505 506 ATF_REQUIRE(run_tests(SNAPSHOT_FILE, TEST_GETGRGID) == 0); 507 } 508 509 ATF_TC_WITHOUT_HEAD(getgrgid_with_snapshot); 510 ATF_TC_BODY(getgrgid_with_snapshot, tc) 511 { 512 513 ATF_REQUIRE(run_tests(SNAPSHOT_FILE, TEST_BUILD_SNAPSHOT) == 0); 514 ATF_REQUIRE(run_tests(SNAPSHOT_FILE, TEST_GETGRGID) == 0); 515 } 516 517 ATF_TC_WITHOUT_HEAD(getgrnam); 518 ATF_TC_BODY(getgrnam, tc) 519 { 520 521 ATF_REQUIRE(run_tests(SNAPSHOT_FILE, TEST_GETGRNAM) == 0); 522 } 523 524 ATF_TC_WITHOUT_HEAD(getgrnam_with_snapshot); 525 ATF_TC_BODY(getgrnam_with_snapshot, tc) 526 { 527 528 ATF_REQUIRE(run_tests(SNAPSHOT_FILE, TEST_BUILD_SNAPSHOT) == 0); 529 ATF_REQUIRE(run_tests(SNAPSHOT_FILE, TEST_GETGRNAM) == 0); 530 } 531 532 ATF_TP_ADD_TCS(tp) 533 { 534 535 ATF_TP_ADD_TC(tp, getgrent); 536 ATF_TP_ADD_TC(tp, getgrent_with_snapshot); 537 ATF_TP_ADD_TC(tp, getgrent_with_two_pass); 538 ATF_TP_ADD_TC(tp, getgrgid); 539 ATF_TP_ADD_TC(tp, getgrgid_with_snapshot); 540 ATF_TP_ADD_TC(tp, getgrnam); 541 ATF_TP_ADD_TC(tp, getgrnam_with_snapshot); 542 543 return (atf_no_error()); 544 } 545