/usr/share/doc/glibc-doc/html/libc_29.html is in glibc-doc 2.15-0ubuntu10.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!-- This file documents the GNU C library.
This is Edition 0.13, last updated 2011-07-19,
of The GNU C Library Reference Manual, for version
2.14 (Ubuntu EGLIBC 2.15-0ubuntu10) .
Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2001, 2002,
2003, 2007, 2008, 2010, 2011 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being "Free Software Needs Free Documentation"
and "GNU Lesser General Public License", the Front-Cover texts being
"A GNU Manual", and with the Back-Cover Texts as in (a) below. A
copy of the license is included in the section entitled "GNU Free
Documentation License".
(a) The FSF's Back-Cover Text is: "You have the freedom to
copy and modify this GNU manual. Buying copies from the FSF
supports it in developing GNU and promoting software freedom."
-->
<!-- Created on April 20, 2012 by texi2html 1.82
texi2html was written by:
Lionel Cons <Lionel.Cons@cern.ch> (original author)
Karl Berry <karl@freefriends.org>
Olaf Bachmann <obachman@mathematik.uni-kl.de>
and many others.
Maintained by: Many creative people.
Send bugs and suggestions to <texi2html-bug@nongnu.org>
-->
<head>
<title>The GNU C Library: 29. Users and Groups</title>
<meta name="description" content="The GNU C Library: 29. Users and Groups">
<meta name="keywords" content="The GNU C Library: 29. Users and Groups">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.82">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
pre.display {font-family: serif}
pre.format {font-family: serif}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: serif; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: serif; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.roman {font-family:serif; font-weight:normal;}
span.sansserif {font-family:sans-serif; font-weight:normal;}
ul.toc {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Users-and-Groups"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="libc_28.html#NSS-Module-Function-Internals" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#User-and-Group-IDs" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc_28.html#Name-Service-Switch" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Users-and-Groups-1"></a>
<h1 class="chapter">29. Users and Groups</h1>
<p>Every user who can log in on the system is identified by a unique number
called the <em>user ID</em>. Each process has an effective user ID which
says which user’s access permissions it has.
</p>
<p>Users are classified into <em>groups</em> for access control purposes. Each
process has one or more <em>group ID values</em> which say which groups the
process can use for access to files.
</p>
<p>The effective user and group IDs of a process collectively form its
<em>persona</em>. This determines which files the process can access.
Normally, a process inherits its persona from the parent process, but
under special circumstances a process can change its persona and thus
change its access permissions.
</p>
<p>Each file in the system also has a user ID and a group ID. Access
control works by comparing the user and group IDs of the file with those
of the running process.
</p>
<p>The system keeps a database of all the registered users, and another
database of all the defined groups. There are library functions you
can use to examine these databases.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#User-and-Group-IDs">29.1 User and Group IDs</a></td><td> </td><td align="left" valign="top"> Each user has a unique numeric ID;
likewise for groups.
</td></tr>
<tr><td align="left" valign="top"><a href="#Process-Persona">29.2 The Persona of a Process</a></td><td> </td><td align="left" valign="top"> The user IDs and group IDs of a process.
</td></tr>
<tr><td align="left" valign="top"><a href="#Why-Change-Persona">29.3 Why Change the Persona of a Process?</a></td><td> </td><td align="left" valign="top"> Why a program might need to change
its user and/or group IDs.
</td></tr>
<tr><td align="left" valign="top"><a href="#How-Change-Persona">29.4 How an Application Can Change Persona</a></td><td> </td><td align="left" valign="top"> Changing the user and group IDs.
</td></tr>
<tr><td align="left" valign="top"><a href="#Reading-Persona">29.5 Reading the Persona of a Process</a></td><td> </td><td align="left" valign="top"> How to examine the user and group IDs.
</td></tr>
<tr><td align="left" valign="top"><a href="#Setting-User-ID">29.6 Setting the User ID</a></td><td> </td><td align="left" valign="top"> Functions for setting the user ID.
</td></tr>
<tr><td align="left" valign="top"><a href="#Setting-Groups">29.7 Setting the Group IDs</a></td><td> </td><td align="left" valign="top"> Functions for setting the group IDs.
</td></tr>
<tr><td align="left" valign="top"><a href="#Enable_002fDisable-Setuid">29.8 Enabling and Disabling Setuid Access</a></td><td> </td><td align="left" valign="top"> Turning setuid access on and off.
</td></tr>
<tr><td align="left" valign="top"><a href="#Setuid-Program-Example">29.9 Setuid Program Example</a></td><td> </td><td align="left" valign="top"> The pertinent parts of one sample program.
</td></tr>
<tr><td align="left" valign="top"><a href="#Tips-for-Setuid">29.10 Tips for Writing Setuid Programs</a></td><td> </td><td align="left" valign="top"> How to avoid granting unlimited access.
</td></tr>
<tr><td align="left" valign="top"><a href="#Who-Logged-In">29.11 Identifying Who Logged In</a></td><td> </td><td align="left" valign="top"> Getting the name of the user who logged in,
or of the real user ID of the current process.
</td></tr>
<tr><td align="left" valign="top"><a href="#User-Accounting-Database">29.12 The User Accounting Database</a></td><td> </td><td align="left" valign="top"> Keeping information about users and various
actions in databases.
</td></tr>
<tr><td align="left" valign="top"><a href="#User-Database">29.13 User Database</a></td><td> </td><td align="left" valign="top"> Functions and data structures for
accessing the user database.
</td></tr>
<tr><td align="left" valign="top"><a href="#Group-Database">29.14 Group Database</a></td><td> </td><td align="left" valign="top"> Functions and data structures for
accessing the group database.
</td></tr>
<tr><td align="left" valign="top"><a href="#Database-Example">29.15 User and Group Database Example</a></td><td> </td><td align="left" valign="top"> Example program showing the use of database
inquiry functions.
</td></tr>
<tr><td align="left" valign="top"><a href="#Netgroup-Database">29.16 Netgroup Database</a></td><td> </td><td align="left" valign="top"> Functions for accessing the netgroup database.
</td></tr>
</table>
<hr size="6">
<a name="User-and-Group-IDs"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Users-and-Groups" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Process-Persona" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="User-and-Group-IDs-1"></a>
<h2 class="section">29.1 User and Group IDs</h2>
<a name="index-login-name"></a>
<a name="index-user-name"></a>
<a name="index-user-ID"></a>
<p>Each user account on a computer system is identified by a <em>user
name</em> (or <em>login name</em>) and <em>user ID</em>. Normally, each user name
has a unique user ID, but it is possible for several login names to have
the same user ID. The user names and corresponding user IDs are stored
in a data base which you can access as described in <a href="#User-Database">User Database</a>.
</p>
<a name="index-group-name"></a>
<a name="index-group-ID"></a>
<p>Users are classified in <em>groups</em>. Each user name belongs to one
<em>default group</em> and may also belong to any number of
<em>supplementary groups</em>. Users who are members of the same group can
share resources (such as files) that are not accessible to users who are
not a member of that group. Each group has a <em>group name</em> and
<em>group ID</em>. See section <a href="#Group-Database">Group Database</a>, for how to find information
about a group ID or group name.
</p>
<hr size="6">
<a name="Process-Persona"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#User-and-Group-IDs" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Why-Change-Persona" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="The-Persona-of-a-Process"></a>
<h2 class="section">29.2 The Persona of a Process</h2>
<a name="index-persona"></a>
<a name="index-effective-user-ID"></a>
<a name="index-effective-group-ID"></a>
<a name="index-supplementary-group-IDs"></a>
<p>At any time, each process has an <em>effective user ID</em>, a <em>effective
group ID</em>, and a set of <em>supplementary group IDs</em>. These IDs
determine the privileges of the process. They are collectively
called the <em>persona</em> of the process, because they determine “who it
is” for purposes of access control.
</p>
<p>Your login shell starts out with a persona which consists of your user
ID, your default group ID, and your supplementary group IDs (if you are
in more than one group). In normal circumstances, all your other processes
inherit these values.
</p>
<a name="index-real-user-ID"></a>
<a name="index-real-group-ID"></a>
<p>A process also has a <em>real user ID</em> which identifies the user who
created the process, and a <em>real group ID</em> which identifies that
user’s default group. These values do not play a role in access
control, so we do not consider them part of the persona. But they are
also important.
</p>
<p>Both the real and effective user ID can be changed during the lifetime
of a process. See section <a href="#Why-Change-Persona">Why Change the Persona of a Process?</a>.
</p>
<p>For details on how a process’s effective user ID and group IDs affect
its permission to access files, see <a href="libc_14.html#Access-Permission">How Your Access to a File is Decided</a>.
</p>
<p>The effective user ID of a process also controls permissions for sending
signals using the <code>kill</code> function. See section <a href="libc_24.html#Signaling-Another-Process">Signaling Another Process</a>.
</p>
<p>Finally, there are many operations which can only be performed by a
process whose effective user ID is zero. A process with this user ID is
a <em>privileged process</em>. Commonly the user name <code>root</code> is
associated with user ID 0, but there may be other user names with this
ID.
</p>
<hr size="6">
<a name="Why-Change-Persona"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Process-Persona" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#How-Change-Persona" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Why-Change-the-Persona-of-a-Process_003f"></a>
<h2 class="section">29.3 Why Change the Persona of a Process?</h2>
<p>The most obvious situation where it is necessary for a process to change
its user and/or group IDs is the <code>login</code> program. When
<code>login</code> starts running, its user ID is <code>root</code>. Its job is to
start a shell whose user and group IDs are those of the user who is
logging in. (To accomplish this fully, <code>login</code> must set the real
user and group IDs as well as its persona. But this is a special case.)
</p>
<p>The more common case of changing persona is when an ordinary user
program needs access to a resource that wouldn’t ordinarily be
accessible to the user actually running it.
</p>
<p>For example, you may have a file that is controlled by your program but
that shouldn’t be read or modified directly by other users, either
because it implements some kind of locking protocol, or because you want
to preserve the integrity or privacy of the information it contains.
This kind of restricted access can be implemented by having the program
change its effective user or group ID to match that of the resource.
</p>
<p>Thus, imagine a game program that saves scores in a file. The game
program itself needs to be able to update this file no matter who is
running it, but if users can write the file without going through the
game, they can give themselves any scores they like. Some people
consider this undesirable, or even reprehensible. It can be prevented
by creating a new user ID and login name (say, <code>games</code>) to own the
scores file, and make the file writable only by this user. Then, when
the game program wants to update this file, it can change its effective
user ID to be that for <code>games</code>. In effect, the program must
adopt the persona of <code>games</code> so it can write the scores file.
</p>
<hr size="6">
<a name="How-Change-Persona"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Why-Change-Persona" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Reading-Persona" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="How-an-Application-Can-Change-Persona"></a>
<h2 class="section">29.4 How an Application Can Change Persona</h2>
<a name="index-setuid-programs"></a>
<a name="index-saved-set_002duser_002dID"></a>
<a name="index-saved-set_002dgroup_002dID"></a>
<a name="index-_005fPOSIX_005fSAVED_005fIDS"></a>
<p>The ability to change the persona of a process can be a source of
unintentional privacy violations, or even intentional abuse. Because of
the potential for problems, changing persona is restricted to special
circumstances.
</p>
<p>You can’t arbitrarily set your user ID or group ID to anything you want;
only privileged processes can do that. Instead, the normal way for a
program to change its persona is that it has been set up in advance to
change to a particular user or group. This is the function of the setuid
and setgid bits of a file’s access mode. See section <a href="libc_14.html#Permission-Bits">The Mode Bits for Access Permission</a>.
</p>
<p>When the setuid bit of an executable file is on, executing that file
gives the process a third user ID: the <em>file user ID</em>. This ID is
set to the owner ID of the file. The system then changes the effective
user ID to the file user ID. The real user ID remains as it was.
Likewise, if the setgid bit is on, the process is given a <em>file
group ID</em> equal to the group ID of the file, and its effective group ID
is changed to the file group ID.
</p>
<p>If a process has a file ID (user or group), then it can at any time
change its effective ID to its real ID and back to its file ID.
Programs use this feature to relinquish their special privileges except
when they actually need them. This makes it less likely that they can
be tricked into doing something inappropriate with their privileges.
</p>
<p><strong>Portability Note:</strong> Older systems do not have file IDs.
To determine if a system has this feature, you can test the compiler
define <code>_POSIX_SAVED_IDS</code>. (In the POSIX standard, file IDs are
known as saved IDs.)
</p>
<p>See section <a href="libc_14.html#File-Attributes">File Attributes</a>, for a more general discussion of file modes and
accessibility.
</p>
<hr size="6">
<a name="Reading-Persona"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#How-Change-Persona" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Setting-User-ID" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Reading-the-Persona-of-a-Process"></a>
<h2 class="section">29.5 Reading the Persona of a Process</h2>
<p>Here are detailed descriptions of the functions for reading the user and
group IDs of a process, both real and effective. To use these
facilities, you must include the header files ‘<tt>sys/types.h</tt>’ and
‘<tt>unistd.h</tt>’.
<a name="index-unistd_002eh-22"></a>
<a name="index-sys_002ftypes_002eh-4"></a>
</p>
<dl>
<dt><a name="index-uid_005ft"></a><u>Data Type:</u> <b>uid_t</b></dt>
<dd><p>This is an integer data type used to represent user IDs. In the GNU
library, this is an alias for <code>unsigned int</code>.
</p></dd></dl>
<dl>
<dt><a name="index-gid_005ft"></a><u>Data Type:</u> <b>gid_t</b></dt>
<dd><p>This is an integer data type used to represent group IDs. In the GNU
library, this is an alias for <code>unsigned int</code>.
</p></dd></dl>
<dl>
<dt><a name="index-getuid"></a><u>Function:</u> uid_t <b>getuid</b><i> (void)</i></dt>
<dd><p>The <code>getuid</code> function returns the real user ID of the process.
</p></dd></dl>
<dl>
<dt><a name="index-getgid"></a><u>Function:</u> gid_t <b>getgid</b><i> (void)</i></dt>
<dd><p>The <code>getgid</code> function returns the real group ID of the process.
</p></dd></dl>
<dl>
<dt><a name="index-geteuid"></a><u>Function:</u> uid_t <b>geteuid</b><i> (void)</i></dt>
<dd><p>The <code>geteuid</code> function returns the effective user ID of the process.
</p></dd></dl>
<dl>
<dt><a name="index-getegid"></a><u>Function:</u> gid_t <b>getegid</b><i> (void)</i></dt>
<dd><p>The <code>getegid</code> function returns the effective group ID of the process.
</p></dd></dl>
<dl>
<dt><a name="index-getgroups"></a><u>Function:</u> int <b>getgroups</b><i> (int <var>count</var>, gid_t *<var>groups</var>)</i></dt>
<dd><p>The <code>getgroups</code> function is used to inquire about the supplementary
group IDs of the process. Up to <var>count</var> of these group IDs are
stored in the array <var>groups</var>; the return value from the function is
the number of group IDs actually stored. If <var>count</var> is smaller than
the total number of supplementary group IDs, then <code>getgroups</code>
returns a value of <code>-1</code> and <code>errno</code> is set to <code>EINVAL</code>.
</p>
<p>If <var>count</var> is zero, then <code>getgroups</code> just returns the total
number of supplementary group IDs. On systems that do not support
supplementary groups, this will always be zero.
</p>
<p>Here’s how to use <code>getgroups</code> to read all the supplementary group
IDs:
</p>
<table><tr><td> </td><td><pre class="smallexample">gid_t *
read_all_groups (void)
{
int ngroups = getgroups (0, NULL);
gid_t *groups
= (gid_t *) xmalloc (ngroups * sizeof (gid_t));
int val = getgroups (ngroups, groups);
if (val < 0)
{
free (groups);
return NULL;
}
return groups;
}
</pre></td></tr></table>
</dd></dl>
<hr size="6">
<a name="Setting-User-ID"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Reading-Persona" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Setting-Groups" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Setting-the-User-ID"></a>
<h2 class="section">29.6 Setting the User ID</h2>
<p>This section describes the functions for altering the user ID (real
and/or effective) of a process. To use these facilities, you must
include the header files ‘<tt>sys/types.h</tt>’ and ‘<tt>unistd.h</tt>’.
<a name="index-unistd_002eh-23"></a>
<a name="index-sys_002ftypes_002eh-5"></a>
</p>
<dl>
<dt><a name="index-seteuid"></a><u>Function:</u> int <b>seteuid</b><i> (uid_t <var>neweuid</var>)</i></dt>
<dd><p>This function sets the effective user ID of a process to <var>newuid</var>,
provided that the process is allowed to change its effective user ID. A
privileged process (effective user ID zero) can change its effective
user ID to any legal value. An unprivileged process with a file user ID
can change its effective user ID to its real user ID or to its file user
ID. Otherwise, a process may not change its effective user ID at all.
</p>
<p>The <code>seteuid</code> function returns a value of <code>0</code> to indicate
successful completion, and a value of <code>-1</code> to indicate an error.
The following <code>errno</code> error conditions are defined for this
function:
</p>
<dl compact="compact">
<dt> <code>EINVAL</code></dt>
<dd><p>The value of the <var>newuid</var> argument is invalid.
</p>
</dd>
<dt> <code>EPERM</code></dt>
<dd><p>The process may not change to the specified ID.
</p></dd>
</dl>
<p>Older systems (those without the <code>_POSIX_SAVED_IDS</code> feature) do not
have this function.
</p></dd></dl>
<dl>
<dt><a name="index-setuid"></a><u>Function:</u> int <b>setuid</b><i> (uid_t <var>newuid</var>)</i></dt>
<dd><p>If the calling process is privileged, this function sets both the real
and effective user ID of the process to <var>newuid</var>. It also deletes
the file user ID of the process, if any. <var>newuid</var> may be any
legal value. (Once this has been done, there is no way to recover the
old effective user ID.)
</p>
<p>If the process is not privileged, and the system supports the
<code>_POSIX_SAVED_IDS</code> feature, then this function behaves like
<code>seteuid</code>.
</p>
<p>The return values and error conditions are the same as for <code>seteuid</code>.
</p></dd></dl>
<dl>
<dt><a name="index-setreuid"></a><u>Function:</u> int <b>setreuid</b><i> (uid_t <var>ruid</var>, uid_t <var>euid</var>)</i></dt>
<dd><p>This function sets the real user ID of the process to <var>ruid</var> and the
effective user ID to <var>euid</var>. If <var>ruid</var> is <code>-1</code>, it means
not to change the real user ID; likewise if <var>euid</var> is <code>-1</code>, it
means not to change the effective user ID.
</p>
<p>The <code>setreuid</code> function exists for compatibility with 4.3 BSD Unix,
which does not support file IDs. You can use this function to swap the
effective and real user IDs of the process. (Privileged processes are
not limited to this particular usage.) If file IDs are supported, you
should use that feature instead of this function. See section <a href="#Enable_002fDisable-Setuid">Enabling and Disabling Setuid Access</a>.
</p>
<p>The return value is <code>0</code> on success and <code>-1</code> on failure.
The following <code>errno</code> error conditions are defined for this
function:
</p>
<dl compact="compact">
<dt> <code>EPERM</code></dt>
<dd><p>The process does not have the appropriate privileges; you do not
have permission to change to the specified ID.
</p></dd>
</dl>
</dd></dl>
<hr size="6">
<a name="Setting-Groups"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Setting-User-ID" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Enable_002fDisable-Setuid" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Setting-the-Group-IDs"></a>
<h2 class="section">29.7 Setting the Group IDs</h2>
<p>This section describes the functions for altering the group IDs (real
and effective) of a process. To use these facilities, you must include
the header files ‘<tt>sys/types.h</tt>’ and ‘<tt>unistd.h</tt>’.
<a name="index-unistd_002eh-24"></a>
<a name="index-sys_002ftypes_002eh-6"></a>
</p>
<dl>
<dt><a name="index-setegid"></a><u>Function:</u> int <b>setegid</b><i> (gid_t <var>newgid</var>)</i></dt>
<dd><p>This function sets the effective group ID of the process to
<var>newgid</var>, provided that the process is allowed to change its group
ID. Just as with <code>seteuid</code>, if the process is privileged it may
change its effective group ID to any value; if it isn’t, but it has a
file group ID, then it may change to its real group ID or file group ID;
otherwise it may not change its effective group ID.
</p>
<p>Note that a process is only privileged if its effective <em>user</em> ID
is zero. The effective group ID only affects access permissions.
</p>
<p>The return values and error conditions for <code>setegid</code> are the same
as those for <code>seteuid</code>.
</p>
<p>This function is only present if <code>_POSIX_SAVED_IDS</code> is defined.
</p></dd></dl>
<dl>
<dt><a name="index-setgid"></a><u>Function:</u> int <b>setgid</b><i> (gid_t <var>newgid</var>)</i></dt>
<dd><p>This function sets both the real and effective group ID of the process
to <var>newgid</var>, provided that the process is privileged. It also
deletes the file group ID, if any.
</p>
<p>If the process is not privileged, then <code>setgid</code> behaves like
<code>setegid</code>.
</p>
<p>The return values and error conditions for <code>setgid</code> are the same
as those for <code>seteuid</code>.
</p></dd></dl>
<dl>
<dt><a name="index-setregid"></a><u>Function:</u> int <b>setregid</b><i> (gid_t <var>rgid</var>, gid_t <var>egid</var>)</i></dt>
<dd><p>This function sets the real group ID of the process to <var>rgid</var> and
the effective group ID to <var>egid</var>. If <var>rgid</var> is <code>-1</code>, it
means not to change the real group ID; likewise if <var>egid</var> is
<code>-1</code>, it means not to change the effective group ID.
</p>
<p>The <code>setregid</code> function is provided for compatibility with 4.3 BSD
Unix, which does not support file IDs. You can use this function to
swap the effective and real group IDs of the process. (Privileged
processes are not limited to this usage.) If file IDs are supported,
you should use that feature instead of using this function.
See section <a href="#Enable_002fDisable-Setuid">Enabling and Disabling Setuid Access</a>.
</p>
<p>The return values and error conditions for <code>setregid</code> are the same
as those for <code>setreuid</code>.
</p></dd></dl>
<p><code>setuid</code> and <code>setgid</code> behave differently depending on whether
the effective user ID at the time is zero. If it is not zero, they
behave like <code>seteuid</code> and <code>setegid</code>. If it is, they change
both effective and real IDs and delete the file ID. To avoid confusion,
we recommend you always use <code>seteuid</code> and <code>setegid</code> except
when you know the effective user ID is zero and your intent is to change
the persona permanently. This case is rare—most of the programs that
need it, such as <code>login</code> and <code>su</code>, have already been written.
</p>
<p>Note that if your program is setuid to some user other than <code>root</code>,
there is no way to drop privileges permanently.
</p>
<p>The system also lets privileged processes change their supplementary
group IDs. To use <code>setgroups</code> or <code>initgroups</code>, your programs
should include the header file ‘<tt>grp.h</tt>’.
<a name="index-grp_002eh-1"></a>
</p>
<dl>
<dt><a name="index-setgroups"></a><u>Function:</u> int <b>setgroups</b><i> (size_t <var>count</var>, gid_t *<var>groups</var>)</i></dt>
<dd><p>This function sets the process’s supplementary group IDs. It can only
be called from privileged processes. The <var>count</var> argument specifies
the number of group IDs in the array <var>groups</var>.
</p>
<p>This function returns <code>0</code> if successful and <code>-1</code> on error.
The following <code>errno</code> error conditions are defined for this
function:
</p>
<dl compact="compact">
<dt> <code>EPERM</code></dt>
<dd><p>The calling process is not privileged.
</p></dd>
</dl>
</dd></dl>
<dl>
<dt><a name="index-initgroups"></a><u>Function:</u> int <b>initgroups</b><i> (const char *<var>user</var>, gid_t <var>group</var>)</i></dt>
<dd><p>The <code>initgroups</code> function sets the process’s supplementary group
IDs to be the normal default for the user name <var>user</var>. The group
<var>group</var> is automatically included.
</p>
<p>This function works by scanning the group database for all the groups
<var>user</var> belongs to. It then calls <code>setgroups</code> with the list it
has constructed.
</p>
<p>The return values and error conditions are the same as for
<code>setgroups</code>.
</p></dd></dl>
<p>If you are interested in the groups a particular user belongs to, but do
not want to change the process’s supplementary group IDs, you can use
<code>getgrouplist</code>. To use <code>getgrouplist</code>, your programs should
include the header file ‘<tt>grp.h</tt>’.
<a name="index-grp_002eh-2"></a>
</p>
<dl>
<dt><a name="index-getgrouplist"></a><u>Function:</u> int <b>getgrouplist</b><i> (const char *<var>user</var>, gid_t <var>group</var>, gid_t *<var>groups</var>, int *<var>ngroups</var>)</i></dt>
<dd><p>The <code>getgrouplist</code> function scans the group database for all the
groups <var>user</var> belongs to. Up to *<var>ngroups</var> group IDs
corresponding to these groups are stored in the array <var>groups</var>; the
return value from the function is the number of group IDs actually
stored. If *<var>ngroups</var> is smaller than the total number of groups
found, then <code>getgrouplist</code> returns a value of <code>-1</code> and stores
the actual number of groups in *<var>ngroups</var>. The group <var>group</var> is
automatically included in the list of groups returned by
<code>getgrouplist</code>.
</p>
<p>Here’s how to use <code>getgrouplist</code> to read all supplementary groups
for <var>user</var>:
</p>
<table><tr><td> </td><td><pre class="smallexample">gid_t *
supplementary_groups (char *user)
{
int ngroups = 16;
gid_t *groups
= (gid_t *) xmalloc (ngroups * sizeof (gid_t));
struct passwd *pw = getpwnam (user);
if (pw == NULL)
return NULL;
if (getgrouplist (pw->pw_name, pw->pw_gid, groups, &ngroups) < 0)
{
groups = xrealloc (ngroups * sizeof (gid_t));
getgrouplist (pw->pw_name, pw->pw_gid, groups, &ngroups);
}
return groups;
}
</pre></td></tr></table>
</dd></dl>
<hr size="6">
<a name="Enable_002fDisable-Setuid"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Setting-Groups" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Setuid-Program-Example" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Enabling-and-Disabling-Setuid-Access"></a>
<h2 class="section">29.8 Enabling and Disabling Setuid Access</h2>
<p>A typical setuid program does not need its special access all of the
time. It’s a good idea to turn off this access when it isn’t needed,
so it can’t possibly give unintended access.
</p>
<p>If the system supports the <code>_POSIX_SAVED_IDS</code> feature, you can
accomplish this with <code>seteuid</code>. When the game program starts, its
real user ID is <code>jdoe</code>, its effective user ID is <code>games</code>, and
its saved user ID is also <code>games</code>. The program should record both
user ID values once at the beginning, like this:
</p>
<table><tr><td> </td><td><pre class="smallexample">user_user_id = getuid ();
game_user_id = geteuid ();
</pre></td></tr></table>
<p>Then it can turn off game file access with
</p>
<table><tr><td> </td><td><pre class="smallexample">seteuid (user_user_id);
</pre></td></tr></table>
<p>and turn it on with
</p>
<table><tr><td> </td><td><pre class="smallexample">seteuid (game_user_id);
</pre></td></tr></table>
<p>Throughout this process, the real user ID remains <code>jdoe</code> and the
file user ID remains <code>games</code>, so the program can always set its
effective user ID to either one.
</p>
<p>On other systems that don’t support file user IDs, you can
turn setuid access on and off by using <code>setreuid</code> to swap the real
and effective user IDs of the process, as follows:
</p>
<table><tr><td> </td><td><pre class="smallexample">setreuid (geteuid (), getuid ());
</pre></td></tr></table>
<p>This special case is always allowed—it cannot fail.
</p>
<p>Why does this have the effect of toggling the setuid access? Suppose a
game program has just started, and its real user ID is <code>jdoe</code> while
its effective user ID is <code>games</code>. In this state, the game can
write the scores file. If it swaps the two uids, the real becomes
<code>games</code> and the effective becomes <code>jdoe</code>; now the program has
only <code>jdoe</code> access. Another swap brings <code>games</code> back to
the effective user ID and restores access to the scores file.
</p>
<p>In order to handle both kinds of systems, test for the saved user ID
feature with a preprocessor conditional, like this:
</p>
<table><tr><td> </td><td><pre class="smallexample">#ifdef _POSIX_SAVED_IDS
seteuid (user_user_id);
#else
setreuid (geteuid (), getuid ());
#endif
</pre></td></tr></table>
<hr size="6">
<a name="Setuid-Program-Example"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Enable_002fDisable-Setuid" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Tips-for-Setuid" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Setuid-Program-Example-1"></a>
<h2 class="section">29.9 Setuid Program Example</h2>
<p>Here’s an example showing how to set up a program that changes its
effective user ID.
</p>
<p>This is part of a game program called <code>caber-toss</code> that manipulates
a file ‘<tt>scores</tt>’ that should be writable only by the game program
itself. The program assumes that its executable file will be installed
with the setuid bit set and owned by the same user as the ‘<tt>scores</tt>’
file. Typically, a system administrator will set up an account like
<code>games</code> for this purpose.
</p>
<p>The executable file is given mode <code>4755</code>, so that doing an
‘<samp>ls -l</samp>’ on it produces output like:
</p>
<table><tr><td> </td><td><pre class="smallexample">-rwsr-xr-x 1 games 184422 Jul 30 15:17 caber-toss
</pre></td></tr></table>
<p>The setuid bit shows up in the file modes as the ‘<samp>s</samp>’.
</p>
<p>The scores file is given mode <code>644</code>, and doing an ‘<samp>ls -l</samp>’ on
it shows:
</p>
<table><tr><td> </td><td><pre class="smallexample">-rw-r--r-- 1 games 0 Jul 31 15:33 scores
</pre></td></tr></table>
<p>Here are the parts of the program that show how to set up the changed
user ID. This program is conditionalized so that it makes use of the
file IDs feature if it is supported, and otherwise uses <code>setreuid</code>
to swap the effective and real user IDs.
</p>
<table><tr><td> </td><td><pre class="smallexample">#include <stdio.h>
#include <sys/types.h>
#include <unistd.h>
#include <stdlib.h>
/* <span class="roman">Remember the effective and real UIDs.</span> */
static uid_t euid, ruid;
/* <span class="roman">Restore the effective UID to its original value.</span> */
void
do_setuid (void)
{
int status;
#ifdef _POSIX_SAVED_IDS
status = seteuid (euid);
#else
status = setreuid (ruid, euid);
#endif
if (status < 0) {
fprintf (stderr, "Couldn't set uid.\n");
exit (status);
}
}
</pre><pre class="smallexample">/* <span class="roman">Set the effective UID to the real UID.</span> */
void
undo_setuid (void)
{
int status;
#ifdef _POSIX_SAVED_IDS
status = seteuid (ruid);
#else
status = setreuid (euid, ruid);
#endif
if (status < 0) {
fprintf (stderr, "Couldn't set uid.\n");
exit (status);
}
}
</pre><pre class="smallexample">
/* <span class="roman">Main program.</span> */
int
main (void)
{
/* <span class="roman">Remember the real and effective user IDs.</span> */
ruid = getuid ();
euid = geteuid ();
undo_setuid ();
/* <span class="roman">Do the game and record the score.</span> */
…
}
</pre></td></tr></table>
<p>Notice how the first thing the <code>main</code> function does is to set the
effective user ID back to the real user ID. This is so that any other
file accesses that are performed while the user is playing the game use
the real user ID for determining permissions. Only when the program
needs to open the scores file does it switch back to the file user ID,
like this:
</p>
<table><tr><td> </td><td><pre class="smallexample">/* <span class="roman">Record the score.</span> */
int
record_score (int score)
{
FILE *stream;
char *myname;
/* <span class="roman">Open the scores file.</span> */
do_setuid ();
stream = fopen (SCORES_FILE, "a");
undo_setuid ();
</pre><pre class="smallexample"> /* <span class="roman">Write the score to the file.</span> */
if (stream)
{
myname = cuserid (NULL);
if (score < 0)
fprintf (stream, "%10s: Couldn't lift the caber.\n", myname);
else
fprintf (stream, "%10s: %d feet.\n", myname, score);
fclose (stream);
return 0;
}
else
return -1;
}
</pre></td></tr></table>
<hr size="6">
<a name="Tips-for-Setuid"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Setuid-Program-Example" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Who-Logged-In" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Tips-for-Writing-Setuid-Programs"></a>
<h2 class="section">29.10 Tips for Writing Setuid Programs</h2>
<p>It is easy for setuid programs to give the user access that isn’t
intended—in fact, if you want to avoid this, you need to be careful.
Here are some guidelines for preventing unintended access and
minimizing its consequences when it does occur:
</p>
<ul>
<li>
Don’t have <code>setuid</code> programs with privileged user IDs such as
<code>root</code> unless it is absolutely necessary. If the resource is
specific to your particular program, it’s better to define a new,
nonprivileged user ID or group ID just to manage that resource.
It’s better if you can write your program to use a special group than a
special user.
</li><li>
Be cautious about using the <code>exec</code> functions in combination with
changing the effective user ID. Don’t let users of your program execute
arbitrary programs under a changed user ID. Executing a shell is
especially bad news. Less obviously, the <code>execlp</code> and <code>execvp</code>
functions are a potential risk (since the program they execute depends
on the user’s <code>PATH</code> environment variable).
<p>If you must <code>exec</code> another program under a changed ID, specify an
absolute file name (see section <a href="libc_11.html#File-Name-Resolution">File Name Resolution</a>) for the executable,
and make sure that the protections on that executable and <em>all</em>
containing directories are such that ordinary users cannot replace it
with some other program.
</p>
<p>You should also check the arguments passed to the program to make sure
they do not have unexpected effects. Likewise, you should examine the
environment variables. Decide which arguments and variables are safe,
and reject all others.
</p>
<p>You should never use <code>system</code> in a privileged program, because it
invokes a shell.
</p>
</li><li>
Only use the user ID controlling the resource in the part of the program
that actually uses that resource. When you’re finished with it, restore
the effective user ID back to the actual user’s user ID.
See section <a href="#Enable_002fDisable-Setuid">Enabling and Disabling Setuid Access</a>.
</li><li>
If the <code>setuid</code> part of your program needs to access other files
besides the controlled resource, it should verify that the real user
would ordinarily have permission to access those files. You can use the
<code>access</code> function (see section <a href="libc_14.html#Access-Permission">How Your Access to a File is Decided</a>) to check this; it
uses the real user and group IDs, rather than the effective IDs.
</li></ul>
<hr size="6">
<a name="Who-Logged-In"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Tips-for-Setuid" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#User-Accounting-Database" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Identifying-Who-Logged-In"></a>
<h2 class="section">29.11 Identifying Who Logged In</h2>
<a name="index-login-name_002c-determining"></a>
<a name="index-user-ID_002c-determining"></a>
<p>You can use the functions listed in this section to determine the login
name of the user who is running a process, and the name of the user who
logged in the current session. See also the function <code>getuid</code> and
friends (see section <a href="#Reading-Persona">Reading the Persona of a Process</a>). How this information is collected by
the system and how to control/add/remove information from the background
storage is described in <a href="#User-Accounting-Database">The User Accounting Database</a>.
</p>
<p>The <code>getlogin</code> function is declared in ‘<tt>unistd.h</tt>’, while
<code>cuserid</code> and <code>L_cuserid</code> are declared in ‘<tt>stdio.h</tt>’.
<a name="index-stdio_002eh-20"></a>
<a name="index-unistd_002eh-25"></a>
</p>
<dl>
<dt><a name="index-getlogin"></a><u>Function:</u> char * <b>getlogin</b><i> (void)</i></dt>
<dd><p>The <code>getlogin</code> function returns a pointer to a string containing the
name of the user logged in on the controlling terminal of the process,
or a null pointer if this information cannot be determined. The string
is statically allocated and might be overwritten on subsequent calls to
this function or to <code>cuserid</code>.
</p></dd></dl>
<dl>
<dt><a name="index-cuserid"></a><u>Function:</u> char * <b>cuserid</b><i> (char *<var>string</var>)</i></dt>
<dd><p>The <code>cuserid</code> function returns a pointer to a string containing a
user name associated with the effective ID of the process. If
<var>string</var> is not a null pointer, it should be an array that can hold
at least <code>L_cuserid</code> characters; the string is returned in this
array. Otherwise, a pointer to a string in a static area is returned.
This string is statically allocated and might be overwritten on
subsequent calls to this function or to <code>getlogin</code>.
</p>
<p>The use of this function is deprecated since it is marked to be
withdrawn in XPG4.2 and has already been removed from newer revisions of
POSIX.1.
</p></dd></dl>
<dl>
<dt><a name="index-L_005fcuserid"></a><u>Macro:</u> int <b>L_cuserid</b></dt>
<dd><p>An integer constant that indicates how long an array you might need to
store a user name.
</p></dd></dl>
<p>These functions let your program identify positively the user who is
running or the user who logged in this session. (These can differ when
setuid programs are involved; see <a href="#Process-Persona">The Persona of a Process</a>.) The user cannot
do anything to fool these functions.
</p>
<p>For most purposes, it is more useful to use the environment variable
<code>LOGNAME</code> to find out who the user is. This is more flexible
precisely because the user can set <code>LOGNAME</code> arbitrarily.
See section <a href="libc_25.html#Standard-Environment">Standard Environment Variables</a>.
</p>
<hr size="6">
<a name="User-Accounting-Database"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Who-Logged-In" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Manipulating-the-Database" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="The-User-Accounting-Database"></a>
<h2 class="section">29.12 The User Accounting Database</h2>
<a name="index-user-accounting-database"></a>
<p>Most Unix-like operating systems keep track of logged in users by
maintaining a user accounting database. This user accounting database
stores for each terminal, who has logged on, at what time, the process
ID of the user’s login shell, etc., etc., but also stores information
about the run level of the system, the time of the last system reboot,
and possibly more.
</p>
<p>The user accounting database typically lives in ‘<tt>/etc/utmp</tt>’,
‘<tt>/var/adm/utmp</tt>’ or ‘<tt>/var/run/utmp</tt>’. However, these files
should <strong>never</strong> be accessed directly. For reading information
from and writing information to the user accounting database, the
functions described in this section should be used.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#Manipulating-the-Database">29.12.1 Manipulating the User Accounting Database</a></td><td> </td><td align="left" valign="top"> Scanning and modifying the user
accounting database.
</td></tr>
<tr><td align="left" valign="top"><a href="#XPG-Functions">29.12.2 XPG User Accounting Database Functions</a></td><td> </td><td align="left" valign="top"> A standardized way for doing the same thing.
</td></tr>
<tr><td align="left" valign="top"><a href="#Logging-In-and-Out">29.12.3 Logging In and Out</a></td><td> </td><td align="left" valign="top"> Functions from BSD that modify the user
accounting database.
</td></tr>
</table>
<hr size="6">
<a name="Manipulating-the-Database"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#User-Accounting-Database" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#XPG-Functions" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#User-Accounting-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Manipulating-the-User-Accounting-Database"></a>
<h3 class="subsection">29.12.1 Manipulating the User Accounting Database</h3>
<p>These functions and the corresponding data structures are declared in
the header file ‘<tt>utmp.h</tt>’.
<a name="index-utmp_002eh"></a>
</p>
<dl>
<dt><a name="index-struct-exit_005fstatus"></a><u>Data Type:</u> <b>struct exit_status</b></dt>
<dd><p>The <code>exit_status</code> data structure is used to hold information about
the exit status of processes marked as <code>DEAD_PROCESS</code> in the user
accounting database.
</p>
<dl compact="compact">
<dt> <code>short int e_termination</code></dt>
<dd><p>The exit status of the process.
</p>
</dd>
<dt> <code>short int e_exit</code></dt>
<dd><p>The exit status of the process.
</p></dd>
</dl>
</dd></dl>
<dl>
<dt><a name="index-struct-utmp"></a><u>Data Type:</u> <b>struct utmp</b></dt>
<dd><p>The <code>utmp</code> data structure is used to hold information about entries
in the user accounting database. On the GNU system it has the following
members:
</p>
<dl compact="compact">
<dt> <code>short int ut_type</code></dt>
<dd><p>Specifies the type of login; one of <code>EMPTY</code>, <code>RUN_LVL</code>,
<code>BOOT_TIME</code>, <code>OLD_TIME</code>, <code>NEW_TIME</code>, <code>INIT_PROCESS</code>,
<code>LOGIN_PROCESS</code>, <code>USER_PROCESS</code>, <code>DEAD_PROCESS</code> or
<code>ACCOUNTING</code>.
</p>
</dd>
<dt> <code>pid_t ut_pid</code></dt>
<dd><p>The process ID number of the login process.
</p>
</dd>
<dt> <code>char ut_line[]</code></dt>
<dd><p>The device name of the tty (without ‘<tt>/dev/</tt>’).
</p>
</dd>
<dt> <code>char ut_id[]</code></dt>
<dd><p>The inittab ID of the process.
</p>
</dd>
<dt> <code>char ut_user[]</code></dt>
<dd><p>The user’s login name.
</p>
</dd>
<dt> <code>char ut_host[]</code></dt>
<dd><p>The name of the host from which the user logged in.
</p>
</dd>
<dt> <code>struct exit_status ut_exit</code></dt>
<dd><p>The exit status of a process marked as <code>DEAD_PROCESS</code>.
</p>
</dd>
<dt> <code>long ut_session</code></dt>
<dd><p>The Session ID, used for windowing.
</p>
</dd>
<dt> <code>struct timeval ut_tv</code></dt>
<dd><p>Time the entry was made. For entries of type <code>OLD_TIME</code> this is
the time when the system clock changed, and for entries of type
<code>NEW_TIME</code> this is the time the system clock was set to.
</p>
</dd>
<dt> <code>int32_t ut_addr_v6[4]</code></dt>
<dd><p>The Internet address of a remote host.
</p></dd>
</dl>
</dd></dl>
<p>The <code>ut_type</code>, <code>ut_pid</code>, <code>ut_id</code>, <code>ut_tv</code>, and
<code>ut_host</code> fields are not available on all systems. Portable
applications therefore should be prepared for these situations. To help
doing this the ‘<tt>utmp.h</tt>’ header provides macros
<code>_HAVE_UT_TYPE</code>, <code>_HAVE_UT_PID</code>, <code>_HAVE_UT_ID</code>,
<code>_HAVE_UT_TV</code>, and <code>_HAVE_UT_HOST</code> if the respective field is
available. The programmer can handle the situations by using
<code>#ifdef</code> in the program code.
</p>
<p>The following macros are defined for use as values for the
<code>ut_type</code> member of the <code>utmp</code> structure. The values are
integer constants.
</p>
<dl compact="compact">
<dd><a name="index-EMPTY"></a>
</dd>
<dt> <code>EMPTY</code></dt>
<dd><p>This macro is used to indicate that the entry contains no valid user
accounting information.
</p>
<a name="index-RUN_005fLVL"></a>
</dd>
<dt> <code>RUN_LVL</code></dt>
<dd><p>This macro is used to identify the systems runlevel.
</p>
<a name="index-BOOT_005fTIME"></a>
</dd>
<dt> <code>BOOT_TIME</code></dt>
<dd><p>This macro is used to identify the time of system boot.
</p>
<a name="index-OLD_005fTIME"></a>
</dd>
<dt> <code>OLD_TIME</code></dt>
<dd><p>This macro is used to identify the time when the system clock changed.
</p>
<a name="index-NEW_005fTIME"></a>
</dd>
<dt> <code>NEW_TIME</code></dt>
<dd><p>This macro is used to identify the time after the system changed.
</p>
<a name="index-INIT_005fPROCESS"></a>
</dd>
<dt> <code>INIT_PROCESS</code></dt>
<dd><p>This macro is used to identify a process spawned by the init process.
</p>
<a name="index-LOGIN_005fPROCESS"></a>
</dd>
<dt> <code>LOGIN_PROCESS</code></dt>
<dd><p>This macro is used to identify the session leader of a logged in user.
</p>
<a name="index-USER_005fPROCESS"></a>
</dd>
<dt> <code>USER_PROCESS</code></dt>
<dd><p>This macro is used to identify a user process.
</p>
<a name="index-DEAD_005fPROCESS"></a>
</dd>
<dt> <code>DEAD_PROCESS</code></dt>
<dd><p>This macro is used to identify a terminated process.
</p>
<a name="index-ACCOUNTING"></a>
</dd>
<dt> <code>ACCOUNTING</code></dt>
<dd><p>???
</p></dd>
</dl>
<p>The size of the <code>ut_line</code>, <code>ut_id</code>, <code>ut_user</code> and
<code>ut_host</code> arrays can be found using the <code>sizeof</code> operator.
</p>
<p>Many older systems have, instead of an <code>ut_tv</code> member, an
<code>ut_time</code> member, usually of type <code>time_t</code>, for representing
the time associated with the entry. Therefore, for backwards
compatibility only, ‘<tt>utmp.h</tt>’ defines <code>ut_time</code> as an alias for
<code>ut_tv.tv_sec</code>.
</p>
<dl>
<dt><a name="index-setutent"></a><u>Function:</u> void <b>setutent</b><i> (void)</i></dt>
<dd><p>This function opens the user accounting database to begin scanning it.
You can then call <code>getutent</code>, <code>getutid</code> or <code>getutline</code> to
read entries and <code>pututline</code> to write entries.
</p>
<p>If the database is already open, it resets the input to the beginning of
the database.
</p></dd></dl>
<dl>
<dt><a name="index-getutent"></a><u>Function:</u> struct utmp * <b>getutent</b><i> (void)</i></dt>
<dd><p>The <code>getutent</code> function reads the next entry from the user
accounting database. It returns a pointer to the entry, which is
statically allocated and may be overwritten by subsequent calls to
<code>getutent</code>. You must copy the contents of the structure if you
wish to save the information or you can use the <code>getutent_r</code>
function which stores the data in a user-provided buffer.
</p>
<p>A null pointer is returned in case no further entry is available.
</p></dd></dl>
<dl>
<dt><a name="index-endutent"></a><u>Function:</u> void <b>endutent</b><i> (void)</i></dt>
<dd><p>This function closes the user accounting database.
</p></dd></dl>
<dl>
<dt><a name="index-getutid"></a><u>Function:</u> struct utmp * <b>getutid</b><i> (const struct utmp *<var>id</var>)</i></dt>
<dd><p>This function searches forward from the current point in the database
for an entry that matches <var>id</var>. If the <code>ut_type</code> member of the
<var>id</var> structure is one of <code>RUN_LVL</code>, <code>BOOT_TIME</code>,
<code>OLD_TIME</code> or <code>NEW_TIME</code> the entries match if the
<code>ut_type</code> members are identical. If the <code>ut_type</code> member of
the <var>id</var> structure is <code>INIT_PROCESS</code>, <code>LOGIN_PROCESS</code>,
<code>USER_PROCESS</code> or <code>DEAD_PROCESS</code>, the entries match if the
<code>ut_type</code> member of the entry read from the database is one of
these four, and the <code>ut_id</code> members match. However if the
<code>ut_id</code> member of either the <var>id</var> structure or the entry read
from the database is empty it checks if the <code>ut_line</code> members match
instead. If a matching entry is found, <code>getutid</code> returns a pointer
to the entry, which is statically allocated, and may be overwritten by a
subsequent call to <code>getutent</code>, <code>getutid</code> or <code>getutline</code>.
You must copy the contents of the structure if you wish to save the
information.
</p>
<p>A null pointer is returned in case the end of the database is reached
without a match.
</p>
<p>The <code>getutid</code> function may cache the last read entry. Therefore,
if you are using <code>getutid</code> to search for multiple occurrences, it
is necessary to zero out the static data after each call. Otherwise
<code>getutid</code> could just return a pointer to the same entry over and
over again.
</p></dd></dl>
<dl>
<dt><a name="index-getutline"></a><u>Function:</u> struct utmp * <b>getutline</b><i> (const struct utmp *<var>line</var>)</i></dt>
<dd><p>This function searches forward from the current point in the database
until it finds an entry whose <code>ut_type</code> value is
<code>LOGIN_PROCESS</code> or <code>USER_PROCESS</code>, and whose <code>ut_line</code>
member matches the <code>ut_line</code> member of the <var>line</var> structure.
If it finds such an entry, it returns a pointer to the entry which is
statically allocated, and may be overwritten by a subsequent call to
<code>getutent</code>, <code>getutid</code> or <code>getutline</code>. You must copy the
contents of the structure if you wish to save the information.
</p>
<p>A null pointer is returned in case the end of the database is reached
without a match.
</p>
<p>The <code>getutline</code> function may cache the last read entry. Therefore
if you are using <code>getutline</code> to search for multiple occurrences, it
is necessary to zero out the static data after each call. Otherwise
<code>getutline</code> could just return a pointer to the same entry over and
over again.
</p></dd></dl>
<dl>
<dt><a name="index-pututline"></a><u>Function:</u> struct utmp * <b>pututline</b><i> (const struct utmp *<var>utmp</var>)</i></dt>
<dd><p>The <code>pututline</code> function inserts the entry <code>*<var>utmp</var></code> at
the appropriate place in the user accounting database. If it finds that
it is not already at the correct place in the database, it uses
<code>getutid</code> to search for the position to insert the entry, however
this will not modify the static structure returned by <code>getutent</code>,
<code>getutid</code> and <code>getutline</code>. If this search fails, the entry
is appended to the database.
</p>
<p>The <code>pututline</code> function returns a pointer to a copy of the entry
inserted in the user accounting database, or a null pointer if the entry
could not be added. The following <code>errno</code> error conditions are
defined for this function:
</p>
<dl compact="compact">
<dt> <code>EPERM</code></dt>
<dd><p>The process does not have the appropriate privileges; you cannot modify
the user accounting database.
</p></dd>
</dl>
</dd></dl>
<p>All the <code>get*</code> functions mentioned before store the information
they return in a static buffer. This can be a problem in multi-threaded
programs since the data returned for the request is overwritten by the
return value data in another thread. Therefore the GNU C Library
provides as extensions three more functions which return the data in a
user-provided buffer.
</p>
<dl>
<dt><a name="index-getutent_005fr"></a><u>Function:</u> int <b>getutent_r</b><i> (struct utmp *<var>buffer</var>, struct utmp **<var>result</var>)</i></dt>
<dd><p>The <code>getutent_r</code> is equivalent to the <code>getutent</code> function. It
returns the next entry from the database. But instead of storing the
information in a static buffer it stores it in the buffer pointed to by
the parameter <var>buffer</var>.
</p>
<p>If the call was successful, the function returns <code>0</code> and the
pointer variable pointed to by the parameter <var>result</var> contains a
pointer to the buffer which contains the result (this is most probably
the same value as <var>buffer</var>). If something went wrong during the
execution of <code>getutent_r</code> the function returns <code>-1</code>.
</p>
<p>This function is a GNU extension.
</p></dd></dl>
<dl>
<dt><a name="index-getutid_005fr"></a><u>Function:</u> int <b>getutid_r</b><i> (const struct utmp *<var>id</var>, struct utmp *<var>buffer</var>, struct utmp **<var>result</var>)</i></dt>
<dd><p>This function retrieves just like <code>getutid</code> the next entry matching
the information stored in <var>id</var>. But the result is stored in the
buffer pointed to by the parameter <var>buffer</var>.
</p>
<p>If successful the function returns <code>0</code> and the pointer variable
pointed to by the parameter <var>result</var> contains a pointer to the
buffer with the result (probably the same as <var>result</var>. If not
successful the function return <code>-1</code>.
</p>
<p>This function is a GNU extension.
</p></dd></dl>
<dl>
<dt><a name="index-getutline_005fr"></a><u>Function:</u> int <b>getutline_r</b><i> (const struct utmp *<var>line</var>, struct utmp *<var>buffer</var>, struct utmp **<var>result</var>)</i></dt>
<dd><p>This function retrieves just like <code>getutline</code> the next entry
matching the information stored in <var>line</var>. But the result is stored
in the buffer pointed to by the parameter <var>buffer</var>.
</p>
<p>If successful the function returns <code>0</code> and the pointer variable
pointed to by the parameter <var>result</var> contains a pointer to the
buffer with the result (probably the same as <var>result</var>. If not
successful the function return <code>-1</code>.
</p>
<p>This function is a GNU extension.
</p></dd></dl>
<p>In addition to the user accounting database, most systems keep a number
of similar databases. For example most systems keep a log file with all
previous logins (usually in ‘<tt>/etc/wtmp</tt>’ or ‘<tt>/var/log/wtmp</tt>’).
</p>
<p>For specifying which database to examine, the following function should
be used.
</p>
<dl>
<dt><a name="index-utmpname"></a><u>Function:</u> int <b>utmpname</b><i> (const char *<var>file</var>)</i></dt>
<dd><p>The <code>utmpname</code> function changes the name of the database to be
examined to <var>file</var>, and closes any previously opened database. By
default <code>getutent</code>, <code>getutid</code>, <code>getutline</code> and
<code>pututline</code> read from and write to the user accounting database.
</p>
<p>The following macros are defined for use as the <var>file</var> argument:
</p>
<dl>
<dt><a name="index-_005fPATH_005fUTMP"></a><u>Macro:</u> char * <b>_PATH_UTMP</b></dt>
<dd><p>This macro is used to specify the user accounting database.
</p></dd></dl>
<dl>
<dt><a name="index-_005fPATH_005fWTMP"></a><u>Macro:</u> char * <b>_PATH_WTMP</b></dt>
<dd><p>This macro is used to specify the user accounting log file.
</p></dd></dl>
<p>The <code>utmpname</code> function returns a value of <code>0</code> if the new name
was successfully stored, and a value of <code>-1</code> to indicate an error.
Note that <code>utmpname</code> does not try to open the database, and that
therefore the return value does not say anything about whether the
database can be successfully opened.
</p></dd></dl>
<p>Specially for maintaining log-like databases the GNU C Library provides
the following function:
</p>
<dl>
<dt><a name="index-updwtmp"></a><u>Function:</u> void <b>updwtmp</b><i> (const char *<var>wtmp_file</var>, const struct utmp *<var>utmp</var>)</i></dt>
<dd><p>The <code>updwtmp</code> function appends the entry *<var>utmp</var> to the
database specified by <var>wtmp_file</var>. For possible values for the
<var>wtmp_file</var> argument see the <code>utmpname</code> function.
</p></dd></dl>
<p><strong>Portability Note:</strong> Although many operating systems provide a
subset of these functions, they are not standardized. There are often
subtle differences in the return types, and there are considerable
differences between the various definitions of <code>struct utmp</code>. When
programming for the GNU system, it is probably best to stick
with the functions described in this section. If however, you want your
program to be portable, consider using the XPG functions described in
<a href="#XPG-Functions">XPG User Accounting Database Functions</a>, or take a look at the BSD compatible functions in
<a href="#Logging-In-and-Out">Logging In and Out</a>.
</p>
<hr size="6">
<a name="XPG-Functions"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Manipulating-the-Database" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Logging-In-and-Out" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#User-Accounting-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="XPG-User-Accounting-Database-Functions"></a>
<h3 class="subsection">29.12.2 XPG User Accounting Database Functions</h3>
<p>These functions, described in the X/Open Portability Guide, are declared
in the header file ‘<tt>utmpx.h</tt>’.
<a name="index-utmpx_002eh"></a>
</p>
<dl>
<dt><a name="index-struct-utmpx"></a><u>Data Type:</u> <b>struct utmpx</b></dt>
<dd><p>The <code>utmpx</code> data structure contains at least the following members:
</p>
<dl compact="compact">
<dt> <code>short int ut_type</code></dt>
<dd><p>Specifies the type of login; one of <code>EMPTY</code>, <code>RUN_LVL</code>,
<code>BOOT_TIME</code>, <code>OLD_TIME</code>, <code>NEW_TIME</code>, <code>INIT_PROCESS</code>,
<code>LOGIN_PROCESS</code>, <code>USER_PROCESS</code> or <code>DEAD_PROCESS</code>.
</p>
</dd>
<dt> <code>pid_t ut_pid</code></dt>
<dd><p>The process ID number of the login process.
</p>
</dd>
<dt> <code>char ut_line[]</code></dt>
<dd><p>The device name of the tty (without ‘<tt>/dev/</tt>’).
</p>
</dd>
<dt> <code>char ut_id[]</code></dt>
<dd><p>The inittab ID of the process.
</p>
</dd>
<dt> <code>char ut_user[]</code></dt>
<dd><p>The user’s login name.
</p>
</dd>
<dt> <code>struct timeval ut_tv</code></dt>
<dd><p>Time the entry was made. For entries of type <code>OLD_TIME</code> this is
the time when the system clock changed, and for entries of type
<code>NEW_TIME</code> this is the time the system clock was set to.
</p></dd>
</dl>
<p>On the GNU system, <code>struct utmpx</code> is identical to <code>struct
utmp</code> except for the fact that including ‘<tt>utmpx.h</tt>’ does not make
visible the declaration of <code>struct exit_status</code>.
</p></dd></dl>
<p>The following macros are defined for use as values for the
<code>ut_type</code> member of the <code>utmpx</code> structure. The values are
integer constants and are, on the GNU system, identical to the
definitions in ‘<tt>utmp.h</tt>’.
</p>
<dl compact="compact">
<dd><a name="index-EMPTY-1"></a>
</dd>
<dt> <code>EMPTY</code></dt>
<dd><p>This macro is used to indicate that the entry contains no valid user
accounting information.
</p>
<a name="index-RUN_005fLVL-1"></a>
</dd>
<dt> <code>RUN_LVL</code></dt>
<dd><p>This macro is used to identify the systems runlevel.
</p>
<a name="index-BOOT_005fTIME-1"></a>
</dd>
<dt> <code>BOOT_TIME</code></dt>
<dd><p>This macro is used to identify the time of system boot.
</p>
<a name="index-OLD_005fTIME-1"></a>
</dd>
<dt> <code>OLD_TIME</code></dt>
<dd><p>This macro is used to identify the time when the system clock changed.
</p>
<a name="index-NEW_005fTIME-1"></a>
</dd>
<dt> <code>NEW_TIME</code></dt>
<dd><p>This macro is used to identify the time after the system changed.
</p>
<a name="index-INIT_005fPROCESS-1"></a>
</dd>
<dt> <code>INIT_PROCESS</code></dt>
<dd><p>This macro is used to identify a process spawned by the init process.
</p>
<a name="index-LOGIN_005fPROCESS-1"></a>
</dd>
<dt> <code>LOGIN_PROCESS</code></dt>
<dd><p>This macro is used to identify the session leader of a logged in user.
</p>
<a name="index-USER_005fPROCESS-1"></a>
</dd>
<dt> <code>USER_PROCESS</code></dt>
<dd><p>This macro is used to identify a user process.
</p>
<a name="index-DEAD_005fPROCESS-1"></a>
</dd>
<dt> <code>DEAD_PROCESS</code></dt>
<dd><p>This macro is used to identify a terminated process.
</p></dd>
</dl>
<p>The size of the <code>ut_line</code>, <code>ut_id</code> and <code>ut_user</code> arrays
can be found using the <code>sizeof</code> operator.
</p>
<dl>
<dt><a name="index-setutxent"></a><u>Function:</u> void <b>setutxent</b><i> (void)</i></dt>
<dd><p>This function is similar to <code>setutent</code>. On the GNU system it is
simply an alias for <code>setutent</code>.
</p></dd></dl>
<dl>
<dt><a name="index-getutxent"></a><u>Function:</u> struct utmpx * <b>getutxent</b><i> (void)</i></dt>
<dd><p>The <code>getutxent</code> function is similar to <code>getutent</code>, but returns
a pointer to a <code>struct utmpx</code> instead of <code>struct utmp</code>. On
the GNU system it simply is an alias for <code>getutent</code>.
</p></dd></dl>
<dl>
<dt><a name="index-endutxent"></a><u>Function:</u> void <b>endutxent</b><i> (void)</i></dt>
<dd><p>This function is similar to <code>endutent</code>. On the GNU system it is
simply an alias for <code>endutent</code>.
</p></dd></dl>
<dl>
<dt><a name="index-getutxid"></a><u>Function:</u> struct utmpx * <b>getutxid</b><i> (const struct utmpx *<var>id</var>)</i></dt>
<dd><p>This function is similar to <code>getutid</code>, but uses <code>struct utmpx</code>
instead of <code>struct utmp</code>. On the GNU system it is simply an alias
for <code>getutid</code>.
</p></dd></dl>
<dl>
<dt><a name="index-getutxline"></a><u>Function:</u> struct utmpx * <b>getutxline</b><i> (const struct utmpx *<var>line</var>)</i></dt>
<dd><p>This function is similar to <code>getutid</code>, but uses <code>struct utmpx</code>
instead of <code>struct utmp</code>. On the GNU system it is simply an alias
for <code>getutline</code>.
</p></dd></dl>
<dl>
<dt><a name="index-pututxline"></a><u>Function:</u> struct utmpx * <b>pututxline</b><i> (const struct utmpx *<var>utmp</var>)</i></dt>
<dd><p>The <code>pututxline</code> function is functionally identical to
<code>pututline</code>, but uses <code>struct utmpx</code> instead of <code>struct
utmp</code>. On the GNU system, <code>pututxline</code> is simply an alias for
<code>pututline</code>.
</p></dd></dl>
<dl>
<dt><a name="index-utmpxname"></a><u>Function:</u> int <b>utmpxname</b><i> (const char *<var>file</var>)</i></dt>
<dd><p>The <code>utmpxname</code> function is functionally identical to
<code>utmpname</code>. On the GNU system, <code>utmpxname</code> is simply an
alias for <code>utmpname</code>.
</p></dd></dl>
<p>You can translate between a traditional <code>struct utmp</code> and an XPG
<code>struct utmpx</code> with the following functions. On the GNU system,
these functions are merely copies, since the two structures are
identical.
</p>
<dl>
<dt><a name="index-getutmp"></a><u>Function:</u> int <b>getutmp</b><i> (const struct utmpx *utmpx, struct utmp *utmp)</i></dt>
<dd><p><code>getutmp</code> copies the information, insofar as the structures are
compatible, from <var>utmpx</var> to <var>utmp</var>.
</p></dd></dl>
<dl>
<dt><a name="index-getutmpx"></a><u>Function:</u> int <b>getutmpx</b><i> (const struct utmp *utmp, struct utmpx *utmpx)</i></dt>
<dd><p><code>getutmpx</code> copies the information, insofar as the structures are
compatible, from <var>utmp</var> to <var>utmpx</var>.
</p></dd></dl>
<hr size="6">
<a name="Logging-In-and-Out"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#XPG-Functions" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#User-Database" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#User-Accounting-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Logging-In-and-Out-1"></a>
<h3 class="subsection">29.12.3 Logging In and Out</h3>
<p>These functions, derived from BSD, are available in the separate
‘<tt>libutil</tt>’ library, and declared in ‘<tt>utmp.h</tt>’.
<a name="index-utmp_002eh-1"></a>
</p>
<p>Note that the <code>ut_user</code> member of <code>struct utmp</code> is called
<code>ut_name</code> in BSD. Therefore, <code>ut_name</code> is defined as an alias
for <code>ut_user</code> in ‘<tt>utmp.h</tt>’.
</p>
<dl>
<dt><a name="index-login_005ftty"></a><u>Function:</u> int <b>login_tty</b><i> (int <var>filedes</var>)</i></dt>
<dd><p>This function makes <var>filedes</var> the controlling terminal of the
current process, redirects standard input, standard output and
standard error output to this terminal, and closes <var>filedes</var>.
</p>
<p>This function returns <code>0</code> on successful completion, and <code>-1</code>
on error.
</p></dd></dl>
<dl>
<dt><a name="index-login"></a><u>Function:</u> void <b>login</b><i> (const struct utmp *<var>entry</var>)</i></dt>
<dd><p>The <code>login</code> functions inserts an entry into the user accounting
database. The <code>ut_line</code> member is set to the name of the terminal
on standard input. If standard input is not a terminal <code>login</code>
uses standard output or standard error output to determine the name of
the terminal. If <code>struct utmp</code> has a <code>ut_type</code> member,
<code>login</code> sets it to <code>USER_PROCESS</code>, and if there is an
<code>ut_pid</code> member, it will be set to the process ID of the current
process. The remaining entries are copied from <var>entry</var>.
</p>
<p>A copy of the entry is written to the user accounting log file.
</p></dd></dl>
<dl>
<dt><a name="index-logout"></a><u>Function:</u> int <b>logout</b><i> (const char *<var>ut_line</var>)</i></dt>
<dd><p>This function modifies the user accounting database to indicate that the
user on <var>ut_line</var> has logged out.
</p>
<p>The <code>logout</code> function returns <code>1</code> if the entry was successfully
written to the database, or <code>0</code> on error.
</p></dd></dl>
<dl>
<dt><a name="index-logwtmp"></a><u>Function:</u> void <b>logwtmp</b><i> (const char *<var>ut_line</var>, const char *<var>ut_name</var>, const char *<var>ut_host</var>)</i></dt>
<dd><p>The <code>logwtmp</code> function appends an entry to the user accounting log
file, for the current time and the information provided in the
<var>ut_line</var>, <var>ut_name</var> and <var>ut_host</var> arguments.
</p></dd></dl>
<p><strong>Portability Note:</strong> The BSD <code>struct utmp</code> only has the
<code>ut_line</code>, <code>ut_name</code>, <code>ut_host</code> and <code>ut_time</code>
members. Older systems do not even have the <code>ut_host</code> member.
</p>
<hr size="6">
<a name="User-Database"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Logging-In-and-Out" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#User-Data-Structure" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="User-Database-1"></a>
<h2 class="section">29.13 User Database</h2>
<a name="index-user-database"></a>
<a name="index-password-database"></a>
<a name="index-_002fetc_002fpasswd"></a>
<p>This section describes how to search and scan the database of registered
users. The database itself is kept in the file ‘<tt>/etc/passwd</tt>’ on
most systems, but on some systems a special network server gives access
to it.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#User-Data-Structure">29.13.1 The Data Structure that Describes a User</a></td><td> </td><td align="left" valign="top"> What each user record contains.
</td></tr>
<tr><td align="left" valign="top"><a href="#Lookup-User">29.13.2 Looking Up One User</a></td><td> </td><td align="left" valign="top"> How to look for a particular user.
</td></tr>
<tr><td align="left" valign="top"><a href="#Scanning-All-Users">29.13.3 Scanning the List of All Users</a></td><td> </td><td align="left" valign="top"> Scanning the list of all users, one by one.
</td></tr>
<tr><td align="left" valign="top"><a href="#Writing-a-User-Entry">29.13.4 Writing a User Entry</a></td><td> </td><td align="left" valign="top"> How a program can rewrite a user’s record.
</td></tr>
</table>
<hr size="6">
<a name="User-Data-Structure"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#User-Database" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Lookup-User" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#User-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="The-Data-Structure-that-Describes-a-User"></a>
<h3 class="subsection">29.13.1 The Data Structure that Describes a User</h3>
<p>The functions and data structures for accessing the system user database
are declared in the header file ‘<tt>pwd.h</tt>’.
<a name="index-pwd_002eh-1"></a>
</p>
<dl>
<dt><a name="index-struct-passwd"></a><u>Data Type:</u> <b>struct passwd</b></dt>
<dd><p>The <code>passwd</code> data structure is used to hold information about
entries in the system user data base. It has at least the following members:
</p>
<dl compact="compact">
<dt> <code>char *pw_name</code></dt>
<dd><p>The user’s login name.
</p>
</dd>
<dt> <code>char *pw_passwd.</code></dt>
<dd><p>The encrypted password string.
</p>
</dd>
<dt> <code>uid_t pw_uid</code></dt>
<dd><p>The user ID number.
</p>
</dd>
<dt> <code>gid_t pw_gid</code></dt>
<dd><p>The user’s default group ID number.
</p>
</dd>
<dt> <code>char *pw_gecos</code></dt>
<dd><p>A string typically containing the user’s real name, and possibly other
information such as a phone number.
</p>
</dd>
<dt> <code>char *pw_dir</code></dt>
<dd><p>The user’s home directory, or initial working directory. This might be
a null pointer, in which case the interpretation is system-dependent.
</p>
</dd>
<dt> <code>char *pw_shell</code></dt>
<dd><p>The user’s default shell, or the initial program run when the user logs in.
This might be a null pointer, indicating that the system default should
be used.
</p></dd>
</dl>
</dd></dl>
<hr size="6">
<a name="Lookup-User"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#User-Data-Structure" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Scanning-All-Users" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#User-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Looking-Up-One-User"></a>
<h3 class="subsection">29.13.2 Looking Up One User</h3>
<a name="index-converting-user-ID-to-user-name"></a>
<a name="index-converting-user-name-to-user-ID"></a>
<p>You can search the system user database for information about a
specific user using <code>getpwuid</code> or <code>getpwnam</code>. These
functions are declared in ‘<tt>pwd.h</tt>’.
</p>
<dl>
<dt><a name="index-getpwuid"></a><u>Function:</u> struct passwd * <b>getpwuid</b><i> (uid_t <var>uid</var>)</i></dt>
<dd><p>This function returns a pointer to a statically-allocated structure
containing information about the user whose user ID is <var>uid</var>. This
structure may be overwritten on subsequent calls to <code>getpwuid</code>.
</p>
<p>A null pointer value indicates there is no user in the data base with
user ID <var>uid</var>.
</p></dd></dl>
<dl>
<dt><a name="index-getpwuid_005fr"></a><u>Function:</u> int <b>getpwuid_r</b><i> (uid_t <var>uid</var>, struct passwd *<var>result_buf</var>, char *<var>buffer</var>, size_t <var>buflen</var>, struct passwd **<var>result</var>)</i></dt>
<dd><p>This function is similar to <code>getpwuid</code> in that it returns
information about the user whose user ID is <var>uid</var>. However, it
fills the user supplied structure pointed to by <var>result_buf</var> with
the information instead of using a static buffer. The first
<var>buflen</var> bytes of the additional buffer pointed to by <var>buffer</var>
are used to contain additional information, normally strings which are
pointed to by the elements of the result structure.
</p>
<p>If a user with ID <var>uid</var> is found, the pointer returned in
<var>result</var> points to the record which contains the wanted data (i.e.,
<var>result</var> contains the value <var>result_buf</var>). If no user is found
or if an error occurred, the pointer returned in <var>result</var> is a null
pointer. The function returns zero or an error code. If the buffer
<var>buffer</var> is too small to contain all the needed information, the
error code <code>ERANGE</code> is returned and <var>errno</var> is set to
<code>ERANGE</code>.
</p></dd></dl>
<dl>
<dt><a name="index-getpwnam"></a><u>Function:</u> struct passwd * <b>getpwnam</b><i> (const char *<var>name</var>)</i></dt>
<dd><p>This function returns a pointer to a statically-allocated structure
containing information about the user whose user name is <var>name</var>.
This structure may be overwritten on subsequent calls to
<code>getpwnam</code>.
</p>
<p>A null pointer return indicates there is no user named <var>name</var>.
</p></dd></dl>
<dl>
<dt><a name="index-getpwnam_005fr"></a><u>Function:</u> int <b>getpwnam_r</b><i> (const char *<var>name</var>, struct passwd *<var>result_buf</var>, char *<var>buffer</var>, size_t <var>buflen</var>, struct passwd **<var>result</var>)</i></dt>
<dd><p>This function is similar to <code>getpwnam</code> in that is returns
information about the user whose user name is <var>name</var>. However, like
<code>getpwuid_r</code>, it fills the user supplied buffers in
<var>result_buf</var> and <var>buffer</var> with the information instead of using
a static buffer.
</p>
<p>The return values are the same as for <code>getpwuid_r</code>.
</p></dd></dl>
<hr size="6">
<a name="Scanning-All-Users"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Lookup-User" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Writing-a-User-Entry" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#User-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Scanning-the-List-of-All-Users"></a>
<h3 class="subsection">29.13.3 Scanning the List of All Users</h3>
<a name="index-scanning-the-user-list"></a>
<p>This section explains how a program can read the list of all users in
the system, one user at a time. The functions described here are
declared in ‘<tt>pwd.h</tt>’.
</p>
<p>You can use the <code>fgetpwent</code> function to read user entries from a
particular file.
</p>
<dl>
<dt><a name="index-fgetpwent"></a><u>Function:</u> struct passwd * <b>fgetpwent</b><i> (FILE *<var>stream</var>)</i></dt>
<dd><p>This function reads the next user entry from <var>stream</var> and returns a
pointer to the entry. The structure is statically allocated and is
rewritten on subsequent calls to <code>fgetpwent</code>. You must copy the
contents of the structure if you wish to save the information.
</p>
<p>The stream must correspond to a file in the same format as the standard
password database file.
</p></dd></dl>
<dl>
<dt><a name="index-fgetpwent_005fr"></a><u>Function:</u> int <b>fgetpwent_r</b><i> (FILE *<var>stream</var>, struct passwd *<var>result_buf</var>, char *<var>buffer</var>, size_t <var>buflen</var>, struct passwd **<var>result</var>)</i></dt>
<dd><p>This function is similar to <code>fgetpwent</code> in that it reads the next
user entry from <var>stream</var>. But the result is returned in the
structure pointed to by <var>result_buf</var>. The
first <var>buflen</var> bytes of the additional buffer pointed to by
<var>buffer</var> are used to contain additional information, normally
strings which are pointed to by the elements of the result structure.
</p>
<p>The stream must correspond to a file in the same format as the standard
password database file.
</p>
<p>If the function returns zero <var>result</var> points to the structure with
the wanted data (normally this is in <var>result_buf</var>). If errors
occurred the return value is nonzero and <var>result</var> contains a null
pointer.
</p></dd></dl>
<p>The way to scan all the entries in the user database is with
<code>setpwent</code>, <code>getpwent</code>, and <code>endpwent</code>.
</p>
<dl>
<dt><a name="index-setpwent"></a><u>Function:</u> void <b>setpwent</b><i> (void)</i></dt>
<dd><p>This function initializes a stream which <code>getpwent</code> and
<code>getpwent_r</code> use to read the user database.
</p></dd></dl>
<dl>
<dt><a name="index-getpwent"></a><u>Function:</u> struct passwd * <b>getpwent</b><i> (void)</i></dt>
<dd><p>The <code>getpwent</code> function reads the next entry from the stream
initialized by <code>setpwent</code>. It returns a pointer to the entry. The
structure is statically allocated and is rewritten on subsequent calls
to <code>getpwent</code>. You must copy the contents of the structure if you
wish to save the information.
</p>
<p>A null pointer is returned when no more entries are available.
</p></dd></dl>
<dl>
<dt><a name="index-getpwent_005fr"></a><u>Function:</u> int <b>getpwent_r</b><i> (struct passwd *<var>result_buf</var>, char *<var>buffer</var>, int <var>buflen</var>, struct passwd **<var>result</var>)</i></dt>
<dd><p>This function is similar to <code>getpwent</code> in that it returns the next
entry from the stream initialized by <code>setpwent</code>. Like
<code>fgetpwent_r</code>, it uses the user-supplied buffers in
<var>result_buf</var> and <var>buffer</var> to return the information requested.
</p>
<p>The return values are the same as for <code>fgetpwent_r</code>.
</p>
</dd></dl>
<dl>
<dt><a name="index-endpwent"></a><u>Function:</u> void <b>endpwent</b><i> (void)</i></dt>
<dd><p>This function closes the internal stream used by <code>getpwent</code> or
<code>getpwent_r</code>.
</p></dd></dl>
<hr size="6">
<a name="Writing-a-User-Entry"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Scanning-All-Users" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Group-Database" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#User-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Writing-a-User-Entry-1"></a>
<h3 class="subsection">29.13.4 Writing a User Entry</h3>
<dl>
<dt><a name="index-putpwent"></a><u>Function:</u> int <b>putpwent</b><i> (const struct passwd *<var>p</var>, FILE *<var>stream</var>)</i></dt>
<dd><p>This function writes the user entry <code>*<var>p</var></code> to the stream
<var>stream</var>, in the format used for the standard user database
file. The return value is zero on success and nonzero on failure.
</p>
<p>This function exists for compatibility with SVID. We recommend that you
avoid using it, because it makes sense only on the assumption that the
<code>struct passwd</code> structure has no members except the standard ones;
on a system which merges the traditional Unix data base with other
extended information about users, adding an entry using this function
would inevitably leave out much of the important information.
</p>
<p>The group and user ID fields are left empty if the group or user name
starts with a - or +.
</p>
<p>The function <code>putpwent</code> is declared in ‘<tt>pwd.h</tt>’.
</p></dd></dl>
<hr size="6">
<a name="Group-Database"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Writing-a-User-Entry" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Group-Data-Structure" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Group-Database-1"></a>
<h2 class="section">29.14 Group Database</h2>
<a name="index-group-database"></a>
<a name="index-_002fetc_002fgroup"></a>
<p>This section describes how to search and scan the database of
registered groups. The database itself is kept in the file
‘<tt>/etc/group</tt>’ on most systems, but on some systems a special network
service provides access to it.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#Group-Data-Structure">29.14.1 The Data Structure for a Group</a></td><td> </td><td align="left" valign="top"> What each group record contains.
</td></tr>
<tr><td align="left" valign="top"><a href="#Lookup-Group">29.14.2 Looking Up One Group</a></td><td> </td><td align="left" valign="top"> How to look for a particular group.
</td></tr>
<tr><td align="left" valign="top"><a href="#Scanning-All-Groups">29.14.3 Scanning the List of All Groups</a></td><td> </td><td align="left" valign="top"> Scanning the list of all groups.
</td></tr>
</table>
<hr size="6">
<a name="Group-Data-Structure"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Group-Database" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Lookup-Group" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Group-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="The-Data-Structure-for-a-Group"></a>
<h3 class="subsection">29.14.1 The Data Structure for a Group</h3>
<p>The functions and data structures for accessing the system group
database are declared in the header file ‘<tt>grp.h</tt>’.
<a name="index-grp_002eh-3"></a>
</p>
<dl>
<dt><a name="index-struct-group"></a><u>Data Type:</u> <b>struct group</b></dt>
<dd><p>The <code>group</code> structure is used to hold information about an entry in
the system group database. It has at least the following members:
</p>
<dl compact="compact">
<dt> <code>char *gr_name</code></dt>
<dd><p>The name of the group.
</p>
</dd>
<dt> <code>gid_t gr_gid</code></dt>
<dd><p>The group ID of the group.
</p>
</dd>
<dt> <code>char **gr_mem</code></dt>
<dd><p>A vector of pointers to the names of users in the group. Each user name
is a null-terminated string, and the vector itself is terminated by a
null pointer.
</p></dd>
</dl>
</dd></dl>
<hr size="6">
<a name="Lookup-Group"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Group-Data-Structure" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Scanning-All-Groups" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Group-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Looking-Up-One-Group"></a>
<h3 class="subsection">29.14.2 Looking Up One Group</h3>
<a name="index-converting-group-name-to-group-ID"></a>
<a name="index-converting-group-ID-to-group-name"></a>
<p>You can search the group database for information about a specific
group using <code>getgrgid</code> or <code>getgrnam</code>. These functions are
declared in ‘<tt>grp.h</tt>’.
</p>
<dl>
<dt><a name="index-getgrgid"></a><u>Function:</u> struct group * <b>getgrgid</b><i> (gid_t <var>gid</var>)</i></dt>
<dd><p>This function returns a pointer to a statically-allocated structure
containing information about the group whose group ID is <var>gid</var>.
This structure may be overwritten by subsequent calls to
<code>getgrgid</code>.
</p>
<p>A null pointer indicates there is no group with ID <var>gid</var>.
</p></dd></dl>
<dl>
<dt><a name="index-getgrgid_005fr"></a><u>Function:</u> int <b>getgrgid_r</b><i> (gid_t <var>gid</var>, struct group *<var>result_buf</var>, char *<var>buffer</var>, size_t <var>buflen</var>, struct group **<var>result</var>)</i></dt>
<dd><p>This function is similar to <code>getgrgid</code> in that it returns
information about the group whose group ID is <var>gid</var>. However, it
fills the user supplied structure pointed to by <var>result_buf</var> with
the information instead of using a static buffer. The first
<var>buflen</var> bytes of the additional buffer pointed to by <var>buffer</var>
are used to contain additional information, normally strings which are
pointed to by the elements of the result structure.
</p>
<p>If a group with ID <var>gid</var> is found, the pointer returned in
<var>result</var> points to the record which contains the wanted data (i.e.,
<var>result</var> contains the value <var>result_buf</var>). If no group is found
or if an error occurred, the pointer returned in <var>result</var> is a null
pointer. The function returns zero or an error code. If the buffer
<var>buffer</var> is too small to contain all the needed information, the
error code <code>ERANGE</code> is returned and <var>errno</var> is set to
<code>ERANGE</code>.
</p></dd></dl>
<dl>
<dt><a name="index-getgrnam"></a><u>Function:</u> struct group * <b>getgrnam</b><i> (const char *<var>name</var>)</i></dt>
<dd><p>This function returns a pointer to a statically-allocated structure
containing information about the group whose group name is <var>name</var>.
This structure may be overwritten by subsequent calls to
<code>getgrnam</code>.
</p>
<p>A null pointer indicates there is no group named <var>name</var>.
</p></dd></dl>
<dl>
<dt><a name="index-getgrnam_005fr"></a><u>Function:</u> int <b>getgrnam_r</b><i> (const char *<var>name</var>, struct group *<var>result_buf</var>, char *<var>buffer</var>, size_t <var>buflen</var>, struct group **<var>result</var>)</i></dt>
<dd><p>This function is similar to <code>getgrnam</code> in that is returns
information about the group whose group name is <var>name</var>. Like
<code>getgrgid_r</code>, it uses the user supplied buffers in
<var>result_buf</var> and <var>buffer</var>, not a static buffer.
</p>
<p>The return values are the same as for <code>getgrgid_r</code>
<code>ERANGE</code>.
</p></dd></dl>
<hr size="6">
<a name="Scanning-All-Groups"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Lookup-Group" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Database-Example" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Group-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Scanning-the-List-of-All-Groups"></a>
<h3 class="subsection">29.14.3 Scanning the List of All Groups</h3>
<a name="index-scanning-the-group-list"></a>
<p>This section explains how a program can read the list of all groups in
the system, one group at a time. The functions described here are
declared in ‘<tt>grp.h</tt>’.
</p>
<p>You can use the <code>fgetgrent</code> function to read group entries from a
particular file.
</p>
<dl>
<dt><a name="index-fgetgrent"></a><u>Function:</u> struct group * <b>fgetgrent</b><i> (FILE *<var>stream</var>)</i></dt>
<dd><p>The <code>fgetgrent</code> function reads the next entry from <var>stream</var>.
It returns a pointer to the entry. The structure is statically
allocated and is overwritten on subsequent calls to <code>fgetgrent</code>. You
must copy the contents of the structure if you wish to save the
information.
</p>
<p>The stream must correspond to a file in the same format as the standard
group database file.
</p></dd></dl>
<dl>
<dt><a name="index-fgetgrent_005fr"></a><u>Function:</u> int <b>fgetgrent_r</b><i> (FILE *<var>stream</var>, struct group *<var>result_buf</var>, char *<var>buffer</var>, size_t <var>buflen</var>, struct group **<var>result</var>)</i></dt>
<dd><p>This function is similar to <code>fgetgrent</code> in that it reads the next
user entry from <var>stream</var>. But the result is returned in the
structure pointed to by <var>result_buf</var>. The first <var>buflen</var> bytes
of the additional buffer pointed to by <var>buffer</var> are used to contain
additional information, normally strings which are pointed to by the
elements of the result structure.
</p>
<p>This stream must correspond to a file in the same format as the standard
group database file.
</p>
<p>If the function returns zero <var>result</var> points to the structure with
the wanted data (normally this is in <var>result_buf</var>). If errors
occurred the return value is non-zero and <var>result</var> contains a null
pointer.
</p></dd></dl>
<p>The way to scan all the entries in the group database is with
<code>setgrent</code>, <code>getgrent</code>, and <code>endgrent</code>.
</p>
<dl>
<dt><a name="index-setgrent"></a><u>Function:</u> void <b>setgrent</b><i> (void)</i></dt>
<dd><p>This function initializes a stream for reading from the group data base.
You use this stream by calling <code>getgrent</code> or <code>getgrent_r</code>.
</p></dd></dl>
<dl>
<dt><a name="index-getgrent"></a><u>Function:</u> struct group * <b>getgrent</b><i> (void)</i></dt>
<dd><p>The <code>getgrent</code> function reads the next entry from the stream
initialized by <code>setgrent</code>. It returns a pointer to the entry. The
structure is statically allocated and is overwritten on subsequent calls
to <code>getgrent</code>. You must copy the contents of the structure if you
wish to save the information.
</p></dd></dl>
<dl>
<dt><a name="index-getgrent_005fr"></a><u>Function:</u> int <b>getgrent_r</b><i> (struct group *<var>result_buf</var>, char *<var>buffer</var>, size_t <var>buflen</var>, struct group **<var>result</var>)</i></dt>
<dd><p>This function is similar to <code>getgrent</code> in that it returns the next
entry from the stream initialized by <code>setgrent</code>. Like
<code>fgetgrent_r</code>, it places the result in user-supplied buffers
pointed to <var>result_buf</var> and <var>buffer</var>.
</p>
<p>If the function returns zero <var>result</var> contains a pointer to the data
(normally equal to <var>result_buf</var>). If errors occurred the return
value is non-zero and <var>result</var> contains a null pointer.
</p></dd></dl>
<dl>
<dt><a name="index-endgrent"></a><u>Function:</u> void <b>endgrent</b><i> (void)</i></dt>
<dd><p>This function closes the internal stream used by <code>getgrent</code> or
<code>getgrent_r</code>.
</p></dd></dl>
<hr size="6">
<a name="Database-Example"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Scanning-All-Groups" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Netgroup-Database" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="User-and-Group-Database-Example"></a>
<h2 class="section">29.15 User and Group Database Example</h2>
<p>Here is an example program showing the use of the system database inquiry
functions. The program prints some information about the user running
the program.
</p>
<table><tr><td> </td><td><pre class="smallexample">#include <grp.h>
#include <pwd.h>
#include <sys/types.h>
#include <unistd.h>
#include <stdlib.h>
int
main (void)
{
uid_t me;
struct passwd *my_passwd;
struct group *my_group;
char **members;
/* <span class="roman">Get information about the user ID.</span> */
me = getuid ();
my_passwd = getpwuid (me);
if (!my_passwd)
{
printf ("Couldn't find out about user %d.\n", (int) me);
exit (EXIT_FAILURE);
}
/* <span class="roman">Print the information.</span> */
printf ("I am %s.\n", my_passwd->pw_gecos);
printf ("My login name is %s.\n", my_passwd->pw_name);
printf ("My uid is %d.\n", (int) (my_passwd->pw_uid));
printf ("My home directory is %s.\n", my_passwd->pw_dir);
printf ("My default shell is %s.\n", my_passwd->pw_shell);
/* <span class="roman">Get information about the default group ID.</span> */
my_group = getgrgid (my_passwd->pw_gid);
if (!my_group)
{
printf ("Couldn't find out about group %d.\n",
(int) my_passwd->pw_gid);
exit (EXIT_FAILURE);
}
/* <span class="roman">Print the information.</span> */
printf ("My default group is %s (%d).\n",
my_group->gr_name, (int) (my_passwd->pw_gid));
printf ("The members of this group are:\n");
members = my_group->gr_mem;
while (*members)
{
printf (" %s\n", *(members));
members++;
}
return EXIT_SUCCESS;
}
</pre></td></tr></table>
<p>Here is some output from this program:
</p>
<table><tr><td> </td><td><pre class="smallexample">I am Throckmorton Snurd.
My login name is snurd.
My uid is 31093.
My home directory is /home/fsg/snurd.
My default shell is /bin/sh.
My default group is guest (12).
The members of this group are:
friedman
tami
</pre></td></tr></table>
<hr size="6">
<a name="Netgroup-Database"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Database-Example" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Netgroup-Data" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Netgroup-Database-1"></a>
<h2 class="section">29.16 Netgroup Database</h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#Netgroup-Data">29.16.1 Netgroup Data</a></td><td> </td><td align="left" valign="top"> Data in the Netgroup database and where
it comes from.
</td></tr>
<tr><td align="left" valign="top"><a href="#Lookup-Netgroup">29.16.2 Looking up one Netgroup</a></td><td> </td><td align="left" valign="top"> How to look for a particular netgroup.
</td></tr>
<tr><td align="left" valign="top"><a href="#Netgroup-Membership">29.16.3 Testing for Netgroup Membership</a></td><td> </td><td align="left" valign="top"> How to test for netgroup membership.
</td></tr>
</table>
<hr size="6">
<a name="Netgroup-Data"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Netgroup-Database" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Lookup-Netgroup" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Netgroup-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Netgroup-Data-1"></a>
<h3 class="subsection">29.16.1 Netgroup Data</h3>
<a name="index-Netgroup"></a>
<p>Sometimes it is useful to group users according to other criteria
(see section <a href="#Group-Database">Group Database</a>). E.g., it is useful to associate a certain
group of users with a certain machine. On the other hand grouping of
host names is not supported so far.
</p>
<p>In Sun Microsystems SunOS appeared a new kind of database, the netgroup
database. It allows grouping hosts, users, and domains freely, giving
them individual names. To be more concrete, a netgroup is a list of triples
consisting of a host name, a user name, and a domain name where any of
the entries can be a wildcard entry matching all inputs. A last
possibility is that names of other netgroups can also be given in the
list specifying a netgroup. So one can construct arbitrary hierarchies
without loops.
</p>
<p>Sun’s implementation allows netgroups only for the <code>nis</code> or
<code>nisplus</code> service, see section <a href="libc_28.html#Services-in-the-NSS-configuration">Services in the NSS configuration File</a>. The
implementation in the GNU C library has no such restriction. An entry
in either of the input services must have the following form:
</p>
<table><tr><td> </td><td><pre class="smallexample"><var>groupname</var> ( <var>groupname</var> | <code>(</code><var>hostname</var><code>,</code><var>username</var><code>,</code><code>domainname</code><code>)</code> )+
</pre></td></tr></table>
<p>Any of the fields in the triple can be empty which means anything
matches. While describing the functions we will see that the opposite
case is useful as well. I.e., there may be entries which will not
match any input. For entries like this, a name consisting of the single
character <code>-</code> shall be used.
</p>
<hr size="6">
<a name="Lookup-Netgroup"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Netgroup-Data" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#Netgroup-Membership" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Netgroup-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Looking-up-one-Netgroup"></a>
<h3 class="subsection">29.16.2 Looking up one Netgroup</h3>
<p>The lookup functions for netgroups are a bit different to all other
system database handling functions. Since a single netgroup can contain
many entries a two-step process is needed. First a single netgroup is
selected and then one can iterate over all entries in this netgroup.
These functions are declared in ‘<tt>netdb.h</tt>’.
</p>
<dl>
<dt><a name="index-setnetgrent"></a><u>Function:</u> int <b>setnetgrent</b><i> (const char *<var>netgroup</var>)</i></dt>
<dd><p>A call to this function initializes the internal state of the library to
allow following calls of the <code>getnetgrent</code> to iterate over all entries
in the netgroup with name <var>netgroup</var>.
</p>
<p>When the call is successful (i.e., when a netgroup with this name exists)
the return value is <code>1</code>. When the return value is <code>0</code> no
netgroup of this name is known or some other error occurred.
</p></dd></dl>
<p>It is important to remember that there is only one single state for
iterating the netgroups. Even if the programmer uses the
<code>getnetgrent_r</code> function the result is not really reentrant since
always only one single netgroup at a time can be processed. If the
program needs to process more than one netgroup simultaneously she
must protect this by using external locking. This problem was
introduced in the original netgroups implementation in SunOS and since
we must stay compatible it is not possible to change this.
</p>
<p>Some other functions also use the netgroups state. Currently these are
the <code>innetgr</code> function and parts of the implementation of the
<code>compat</code> service part of the NSS implementation.
</p>
<dl>
<dt><a name="index-getnetgrent"></a><u>Function:</u> int <b>getnetgrent</b><i> (char **<var>hostp</var>, char **<var>userp</var>, char **<var>domainp</var>)</i></dt>
<dd><p>This function returns the next unprocessed entry of the currently
selected netgroup. The string pointers, in which addresses are passed in
the arguments <var>hostp</var>, <var>userp</var>, and <var>domainp</var>, will contain
after a successful call pointers to appropriate strings. If the string
in the next entry is empty the pointer has the value <code>NULL</code>.
The returned string pointers are only valid if none of the netgroup
related functions are called.
</p>
<p>The return value is <code>1</code> if the next entry was successfully read. A
value of <code>0</code> means no further entries exist or internal errors occurred.
</p></dd></dl>
<dl>
<dt><a name="index-getnetgrent_005fr"></a><u>Function:</u> int <b>getnetgrent_r</b><i> (char **<var>hostp</var>, char **<var>userp</var>, char **<var>domainp</var>, char *<var>buffer</var>, int <var>buflen</var>)</i></dt>
<dd><p>This function is similar to <code>getnetgrent</code> with only one exception:
the strings the three string pointers <var>hostp</var>, <var>userp</var>, and
<var>domainp</var> point to, are placed in the buffer of <var>buflen</var> bytes
starting at <var>buffer</var>. This means the returned values are valid
even after other netgroup related functions are called.
</p>
<p>The return value is <code>1</code> if the next entry was successfully read and
the buffer contains enough room to place the strings in it. <code>0</code> is
returned in case no more entries are found, the buffer is too small, or
internal errors occurred.
</p>
<p>This function is a GNU extension. The original implementation in the
SunOS libc does not provide this function.
</p></dd></dl>
<dl>
<dt><a name="index-endnetgrent"></a><u>Function:</u> void <b>endnetgrent</b><i> (void)</i></dt>
<dd><p>This function frees all buffers which were allocated to process the last
selected netgroup. As a result all string pointers returned by calls
to <code>getnetgrent</code> are invalid afterwards.
</p></dd></dl>
<hr size="6">
<a name="Netgroup-Membership"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Lookup-Netgroup" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Netgroup-Database" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Testing-for-Netgroup-Membership"></a>
<h3 class="subsection">29.16.3 Testing for Netgroup Membership</h3>
<p>It is often not necessary to scan the whole netgroup since often the
only interesting question is whether a given entry is part of the
selected netgroup.
</p>
<dl>
<dt><a name="index-innetgr"></a><u>Function:</u> int <b>innetgr</b><i> (const char *<var>netgroup</var>, const char *<var>host</var>, const char *<var>user</var>, const char *<var>domain</var>)</i></dt>
<dd><p>This function tests whether the triple specified by the parameters
<var>hostp</var>, <var>userp</var>, and <var>domainp</var> is part of the netgroup
<var>netgroup</var>. Using this function has the advantage that
</p>
<ol>
<li>
no other netgroup function can use the global netgroup state since
internal locking is used and
</li><li>
the function is implemented more efficiently than successive calls
to the other <code>set</code>/<code>get</code>/<code>endnetgrent</code> functions.
</li></ol>
<p>Any of the pointers <var>hostp</var>, <var>userp</var>, and <var>domainp</var> can be
<code>NULL</code> which means any value is accepted in this position. This is
also true for the name <code>-</code> which should not match any other string
otherwise.
</p>
<p>The return value is <code>1</code> if an entry matching the given triple is
found in the netgroup. The return value is <code>0</code> if the netgroup
itself is not found, the netgroup does not contain the triple or
internal errors occurred.
</p></dd></dl>
<hr size="6">
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#Users-and-Groups" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="libc_30.html#System-Management" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="libc.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="libc_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="libc_42.html#Concept-Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="libc_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<p>
<font size="-1">
This document was generated by <em>root</em> on <em>April 20, 2012</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html 1.82</em></a>.
</font>
<br>
</p>
</body>
</html>
|