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  2009-03-30 "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
  88 .BR getpwnam_r ()
  89 and
  90 .BR getpwuid_r ()
  91 functions obtain the same information, but store the retrieved
  92 .I passwd
  93 structure in the space pointed to by
  94 .IR pwd .
  95 This
  96 .I passwd
  97 structure contains pointers to strings, and these strings
  98 are stored in the buffer
  99 .I buf
 100 of size
 101 .IR buflen .
 102 A pointer to the result (in case of success) or NULL (in case no entry
 103 was found or an error occurred) is stored in
 104 .IR *result .
 105 .PP
 106 The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows:
 107 .sp
 108 .in +4n
 109 .nf
 110 struct passwd {
 111     char   *pw_name;       /* username */
 112     char   *pw_passwd;     /* user password */
 113     uid_t   pw_uid;        /* user ID */
 114     gid_t   pw_gid;        /* group ID */
 115     char   *pw_gecos;      /* real name */
 116     char   *pw_dir;        /* home directory */
 117     char   *pw_shell;      /* shell program */
 118 };
 119 .fi
 120 .in
 121 .PP
 122 The maximum needed size for
 123 .I buf
 124 can be found using
 125 .BR sysconf (3)
 126 with the argument
 127 .BR _SC_GETPW_R_SIZE_MAX .
 128 .SH "RETURN VALUE"
 129 The
 130 .BR getpwnam ()
 131 and
 132 .BR getpwuid ()
 133 functions return a pointer to a
 134 .I passwd
 135 structure, or NULL if the matching entry is not found or
 136 an error occurs.
 137 If an error occurs,
 138 .I errno
 139 is set appropriately.
 140 If one wants to check
 141 .I errno
 142 after the call, it should be set to zero before the call.
 143 .LP
 144 The return value may point to a static area, and may be overwritten
 145 by subsequent calls to
 146 .BR getpwent (3),
 147 .BR getpwnam (),
 148 or
 149 .BR getpwuid ().
 150 (Do not pass the returned pointer to
 151 .BR free (3).)
 152 .LP
 153 On success,
 154 .BR getpwnam_r ()
 155 and
 156 .BR getpwuid_r ()
 157 return zero, and set
 158 .IR *result
 159 to
 160 .IR pwd .
 161 If no matching password record was found,
 162 these functions return 0 and store NULL in
 163 .IR *result .
 164 In case of error, an error number is returned, and NULL is stored in
 165 .IR *result .
 166 .SH ERRORS
 167 .TP
 168 .BR 0 " or " ENOENT " or " ESRCH " or " EBADF " or " EPERM " or ... "
 169 The given
 170 .I name
 171 or
 172 .I uid
 173 was not found.
 174 .TP
 175 .B EINTR
 176 A signal was caught.
 177 .TP
 178 .B EIO
 179 I/O error.
 180 .TP
 181 .B EMFILE
 182 The maximum number
 183 .RB ( OPEN_MAX )
 184 of files was open already in the calling process.
 185 .TP
 186 .B ENFILE
 187 The maximum number of files was open already in the system.
 188 .TP
 189 .B ENOMEM
 190 .\" not in POSIX
 191 Insufficient memory to allocate
 192 .I passwd
 193 structure.
 194 .\" This structure is static, allocated 0 or 1 times. No memory leak. (libc45)
 195 .TP
 196 .B ERANGE
 197 Insufficient buffer space supplied.
 198 .SH FILES
 199 .TP
 200 .I /etc/passwd
 201 local password database file
 202 .SH "CONFORMING TO"
 203 SVr4, 4.3BSD, POSIX.1-2001.
 204 .SH NOTES
 205 The formulation given above under "RETURN VALUE" is from POSIX.1-2001.
 206 It does not call "not found" an error, and hence does not specify what value
 207 .I errno
 208 might have in this situation.
 209 But that makes it impossible to recognize
 210 errors.
 211 One might argue that according to POSIX
 212 .I errno
 213 should be left unchanged if an entry is not found.
 214 Experiments on various
 215 UNIX-like systems show that lots of different values occur in this
 216 situation: 0, ENOENT, EBADF, ESRCH, EWOULDBLOCK, EPERM and probably others.
 217 .\" more precisely:
 218 .\" AIX 5.1 - gives ESRCH
 219 .\" OSF1 4.0g - gives EWOULDBLOCK
 220 .\" libc, glibc up to version 2.6, Irix 6.5 - give ENOENT
 221 .\" glibc since version 2.7 - give 0
 222 .\" FreeBSD 4.8, OpenBSD 3.2, NetBSD 1.6 - give EPERM
 223 .\" SunOS 5.8 - gives EBADF
 224 .\" Tru64 5.1b, HP-UX-11i, SunOS 5.7 - give 0
 225
 226 The
 227 .I pw_dir
 228 field contains the name of the initial working directory of the user.
 229 Login programs use the value of this field to initialize the
 230 .B HOME
 231 environment variable for the login shell.
 232 An application that wants to determine its user's home directory
 233 should inspect the value of
 234 .B HOME
 235 (rather than the value
 236 .IR getpwuid(getuid())\->pw_dir )
 237 since this allows the user to modify their notion of
 238 "the home directory" during a login session.
 239 To determine the (initial) home directory of another user,
 240 it is necessary to use
 241 .I getpwnam("username")\->pw_dir
 242 or similar.
 243 .SH EXAMPLE
 244 The program below demonstrates the use of
 245 .BR getpwnam_r ()
 246 to find the full username and user ID for the username
 247 supplied as a command-line argument.
 248
 249 .nf
 250 #include <pwd.h>
 251 #include <stdio.h>
 252 #include <stdlib.h>
 253 #include <unistd.h>
 254 #include <errno.h>
 255
 256 int
 257 main(int argc, char *argv[])
 258 {
 259     struct passwd pwd;
 260     struct passwd *result;
 261     char *buf;
 262     size_t bufsize;
 263     int s;
 264
 265     if (argc != 2) {
 266         fprintf(stderr, "Usage: %s username\\n", argv[0]);
 267         exit(EXIT_FAILURE);
 268     }
 269
 270     bufsize = sysconf(_SC_GETPW_R_SIZE_MAX);
 271     if (bufsize == \-1)          /* Value was indeterminate */
 272         bufsize = 16384;        /* Should be more than enough */
 273
 274     buf = malloc(bufsize);
 275     if (buf == NULL) {
 276         perror("malloc");
 277         exit(EXIT_FAILURE);
 278     }
 279
 280     s = getpwnam_r(argv[1], &pwd, buf, bufsize, &result);
 281     if (result == NULL) {
 282         if (s == 0)
 283             printf("Not found\\n");
 284         else {
 285             errno = s;
 286             perror("getpwnam_r");
 287         }
 288         exit(EXIT_FAILURE);
 289     }
 290
 291     printf("Name: %s; UID: %ld\\n", pwd.pw_gecos, (long) pwd.pw_uid);
 292     exit(EXIT_SUCCESS);
 293 }
 294 .fi
 295 .SH "SEE ALSO"
 296 .BR endpwent (3),
 297 .BR fgetpwent (3),
 298 .BR getgrnam (3),
 299 .BR getpw (3),
 300 .BR getpwent (3),
 301 .BR getspnam (3),
 302 .BR putpwent (3),
 303 .BR setpwent (3),
 304 .BR passwd (5)