original/man3/getpwnam.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's "POSIX Programmer's Guide" (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\"
  30 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  31 .\" Modified 1996-05-27 by Martin Schulze (joey@linux.de)
  32 .\" Modified 2003-11-15 by aeb
  33 .\" 2008-11-07, mtk, Added an example program for getpwnam_r().
  34 .\"
  35 .TH GETPWNAM 3  2012-04-23 "GNU" "Linux Programmer's Manual"
  36 .SH NAME
  37 getpwnam, getpwnam_r, getpwuid, getpwuid_r \- get password file entry
  38 .SH SYNOPSIS
  39 .nf
  40 .B #include <sys/types.h>
  41 .B #include <pwd.h>
  42 .sp
  43 .BI "struct passwd *getpwnam(const char *" name );
  44 .sp
  45 .BI "struct passwd *getpwuid(uid_t " uid );
  46 .sp
  47 .BI "int getpwnam_r(const char *" name ", struct passwd *" pwd ,
  48 .br
  49 .BI "            char *" buf ", size_t " buflen ", struct passwd **" result );
  50 .sp
  51 .BI "int getpwuid_r(uid_t " uid ", struct passwd *" pwd ,
  52 .br
  53 .BI "            char *" buf ", size_t " buflen ", struct passwd **" result );
  54 .fi
  55 .sp
  56 .in -4n
  57 Feature Test Macro Requirements for glibc (see
  58 .BR feature_test_macros (7)):
  59 .in
  60 .sp
  61 .ad l
  62 .BR getpwnam_r (),
  63 .BR getpwuid_r ():
  64 .RS 4
  65 _POSIX_C_SOURCE\ >=\ 1 || _XOPEN_SOURCE || _BSD_SOURCE ||
  66 _SVID_SOURCE || _POSIX_SOURCE
  67 .RE
  68 .ad b
  69 .SH DESCRIPTION
  70 The
  71 .BR getpwnam ()
  72 function returns a pointer to a structure containing
  73 the broken-out fields of the record in the password database
  74 (e.g., the local password file
  75 .IR /etc/passwd ,
  76 NIS, and LDAP)
  77 that matches the username
  78 .IR name .
  79 .PP
  80 The
  81 .BR getpwuid ()
  82 function returns a pointer to a structure containing
  83 the broken-out fields of the record in the password database
  84 that matches the user ID
  85 .IR uid .
  86 .PP
  87 The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows:
  88 .sp
  89 .in +4n
  90 .nf
  91 struct passwd {
  92     char   *pw_name;       /* username */
  93     char   *pw_passwd;     /* user password */
  94     uid_t   pw_uid;        /* user ID */
  95     gid_t   pw_gid;        /* group ID */
  96     char   *pw_gecos;      /* user information */
  97     char   *pw_dir;        /* home directory */
  98     char   *pw_shell;      /* shell program */
  99 };
 100 .fi
 101 .in
 102 .PP
 103 See
 104 .BR passwd (5)
 105 for more information about these fields.
 106 .PP
 107 The
 108 .BR getpwnam_r ()
 109 and
 110 .BR getpwuid_r ()
 111 functions obtain the same information as
 112 .BR getpwnam ()
 113 and
 114 .BR getpwuid (),
 115 but store the retrieved
 116 .I passwd
 117 structure in the space pointed to by
 118 .IR pwd .
 119 The string fields pointed to by the members of the
 120 .I passwd
 121 structure are stored in the buffer
 122 .I buf
 123 of size
 124 .IR buflen .
 125 A pointer to the result (in case of success) or NULL (in case no entry
 126 was found or an error occurred) is stored in
 127 .IR *result .
 128 .PP
 129 The call
 130
 131     sysconf(_SC_GETPW_R_SIZE_MAX)
 132
 133 returns either \-1, without changing
 134 .IR errno ,
 135 or an initial suggested size for
 136 .IR buf .
 137 (If this size is too small,
 138 the call fails with
 139 .BR ERANGE ,
 140 in which case the caller can retry with a larger buffer.)
 141 .SH "RETURN VALUE"
 142 The
 143 .BR getpwnam ()
 144 and
 145 .BR getpwuid ()
 146 functions return a pointer to a
 147 .I passwd
 148 structure, or NULL if the matching entry is not found or
 149 an error occurs.
 150 If an error occurs,
 151 .I errno
 152 is set appropriately.
 153 If one wants to check
 154 .I errno
 155 after the call, it should be set to zero before the call.
 156 .LP
 157 The return value may point to a static area, and may be overwritten
 158 by subsequent calls to
 159 .BR getpwent (3),
 160 .BR getpwnam (),
 161 or
 162 .BR getpwuid ().
 163 (Do not pass the returned pointer to
 164 .BR free (3).)
 165 .LP
 166 On success,
 167 .BR getpwnam_r ()
 168 and
 169 .BR getpwuid_r ()
 170 return zero, and set
 171 .IR *result
 172 to
 173 .IR pwd .
 174 If no matching password record was found,
 175 these functions return 0 and store NULL in
 176 .IR *result .
 177 In case of error, an error number is returned, and NULL is stored in
 178 .IR *result .
 179 .SH ERRORS
 180 .TP
 181 .BR 0 " or " ENOENT " or " ESRCH " or " EBADF " or " EPERM " or ... "
 182 The given
 183 .I name
 184 or
 185 .I uid
 186 was not found.
 187 .TP
 188 .B EINTR
 189 A signal was caught.
 190 .TP
 191 .B EIO
 192 I/O error.
 193 .TP
 194 .B EMFILE
 195 The maximum number
 196 .RB ( OPEN_MAX )
 197 of files was open already in the calling process.
 198 .TP
 199 .B ENFILE
 200 The maximum number of files was open already in the system.
 201 .TP
 202 .B ENOMEM
 203 .\" not in POSIX
 204 Insufficient memory to allocate
 205 .I passwd
 206 structure.
 207 .\" This structure is static, allocated 0 or 1 times. No memory leak. (libc45)
 208 .TP
 209 .B ERANGE
 210 Insufficient buffer space supplied.
 211 .SH FILES
 212 .TP
 213 .I /etc/passwd
 214 local password database file
 215 .SH "CONFORMING TO"
 216 SVr4, 4.3BSD, POSIX.1-2001.
 217 The
 218 .I pw_gecos
 219 field is not specified in POSIX, but is present on most implementations.
 220 .SH NOTES
 221 The formulation given above under "RETURN VALUE" is from POSIX.1-2001.
 222 It does not call "not found" an error, and hence does not specify what value
 223 .I errno
 224 might have in this situation.
 225 But that makes it impossible to recognize
 226 errors.
 227 One might argue that according to POSIX
 228 .I errno
 229 should be left unchanged if an entry is not found.
 230 Experiments on various
 231 UNIX-like systems show that lots of different values occur in this
 232 situation: 0, ENOENT, EBADF, ESRCH, EWOULDBLOCK, EPERM and probably others.
 233 .\" more precisely:
 234 .\" AIX 5.1 - gives ESRCH
 235 .\" OSF1 4.0g - gives EWOULDBLOCK
 236 .\" libc, glibc up to version 2.6, Irix 6.5 - give ENOENT
 237 .\" glibc since version 2.7 - give 0
 238 .\" FreeBSD 4.8, OpenBSD 3.2, NetBSD 1.6 - give EPERM
 239 .\" SunOS 5.8 - gives EBADF
 240 .\" Tru64 5.1b, HP-UX-11i, SunOS 5.7 - give 0
 241
 242 The
 243 .I pw_dir
 244 field contains the name of the initial working directory of the user.
 245 Login programs use the value of this field to initialize the
 246 .B HOME
 247 environment variable for the login shell.
 248 An application that wants to determine its user's home directory
 249 should inspect the value of
 250 .B HOME
 251 (rather than the value
 252 .IR getpwuid(getuid())\->pw_dir )
 253 since this allows the user to modify their notion of
 254 "the home directory" during a login session.
 255 To determine the (initial) home directory of another user,
 256 it is necessary to use
 257 .I getpwnam("username")\->pw_dir
 258 or similar.
 259 .SH EXAMPLE
 260 The program below demonstrates the use of
 261 .BR getpwnam_r ()
 262 to find the full username and user ID for the username
 263 supplied as a command-line argument.
 264
 265 .nf
 266 #include <pwd.h>
 267 #include <stdio.h>
 268 #include <stdlib.h>
 269 #include <unistd.h>
 270 #include <errno.h>
 271
 272 int
 273 main(int argc, char *argv[])
 274 {
 275     struct passwd pwd;
 276     struct passwd *result;
 277     char *buf;
 278     size_t bufsize;
 279     int s;
 280
 281     if (argc != 2) {
 282         fprintf(stderr, "Usage: %s username\\n", argv[0]);
 283         exit(EXIT_FAILURE);
 284     }
 285
 286     bufsize = sysconf(_SC_GETPW_R_SIZE_MAX);
 287     if (bufsize == \-1)          /* Value was indeterminate */
 288         bufsize = 16384;        /* Should be more than enough */
 289
 290     buf = malloc(bufsize);
 291     if (buf == NULL) {
 292         perror("malloc");
 293         exit(EXIT_FAILURE);
 294     }
 295
 296     s = getpwnam_r(argv[1], &pwd, buf, bufsize, &result);
 297     if (result == NULL) {
 298         if (s == 0)
 299             printf("Not found\\n");
 300         else {
 301             errno = s;
 302             perror("getpwnam_r");
 303         }
 304         exit(EXIT_FAILURE);
 305     }
 306
 307     printf("Name: %s; UID: %ld\\n", pwd.pw_gecos, (long) pwd.pw_uid);
 308     exit(EXIT_SUCCESS);
 309 }
 310 .fi
 311 .SH "SEE ALSO"
 312 .BR endpwent (3),
 313 .BR fgetpwent (3),
 314 .BR getgrnam (3),
 315 .BR getpw (3),
 316 .BR getpwent (3),
 317 .BR getspnam (3),
 318 .BR putpwent (3),
 319 .BR setpwent (3),
 320 .BR passwd (5)