]> git.ipfire.org Git - thirdparty/glibc.git/blobdiff - pwd/pwd.h
Prefer https to http for gnu.org and fsf.org URLs
[thirdparty/glibc.git] / pwd / pwd.h
index 68792d8a4be8f86c1b4c8aa1b3428a592108e4b8..791c6d9044931e374a2a5e0b7c176174725fca75 100644 (file)
--- a/pwd/pwd.h
+++ b/pwd/pwd.h
@@ -1,42 +1,56 @@
-/* Copyright (C) 1991, 1992, 1995, 1996, 1997 Free Software Foundation, Inc.
+/* Copyright (C) 1991-2019 Free Software Foundation, Inc.
    This file is part of the GNU C Library.
 
    The GNU C Library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Library General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
 
    The GNU C Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   Library General Public License for more details.
+   Lesser General Public License for more details.
 
-   You should have received a copy of the GNU Library General Public
-   License along with the GNU C Library; see the file COPYING.LIB.  If not,
-   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, see
+   <https://www.gnu.org/licenses/>.  */
 
 /*
  *     POSIX Standard: 9.2.2 User Database Access      <pwd.h>
  */
 
 #ifndef        _PWD_H
-
 #define        _PWD_H  1
+
 #include <features.h>
 
 __BEGIN_DECLS
 
-#include <gnu/types.h>
+#include <bits/types.h>
 
 #define __need_size_t
 #include <stddef.h>
 
-/* The passwd structure.  */
+#if defined __USE_XOPEN || defined __USE_XOPEN2K
+/* The Single Unix specification says that some more types are
+   available here.  */
+# ifndef __gid_t_defined
+typedef __gid_t gid_t;
+#  define __gid_t_defined
+# endif
+
+# ifndef __uid_t_defined
+typedef __uid_t uid_t;
+#  define __uid_t_defined
+# endif
+#endif
+
+/* A record in the user database.  */
 struct passwd
 {
   char *pw_name;               /* Username.  */
-  char *pw_passwd;             /* Password.  */
+  char *pw_passwd;             /* Hashed passphrase, if shadow database
+                                   not in use (see shadow.h).  */
   __uid_t pw_uid;              /* User ID.  */
   __gid_t pw_gid;              /* Group ID.  */
   char *pw_gecos;              /* Real name.  */
@@ -45,59 +59,69 @@ struct passwd
 };
 
 
-#if defined(__USE_SVID) || defined(__USE_GNU)
-#define        __need_FILE
-#include <stdio.h>
+#ifdef __USE_MISC
+# include <bits/types/FILE.h>
 #endif
 
-#ifdef __USE_GNU
-/* Return a new stream open on the password file.  */
-extern FILE *__pwdopen __P ((void));
 
-/* Read a password entry from STREAM, filling in P.
-   Return the `struct passwd' of P if successful, NULL on failure.  */
-extern struct passwd *__pwdread __P ((FILE *__stream, __ptr_t __p));
+#if defined __USE_MISC || defined __USE_XOPEN_EXTENDED
+/* Rewind the user database stream.
+
+   This function is a possible cancellation point and therefore not
+   marked with __THROW.  */
+extern void setpwent (void);
+
+/* Close the user database stream.
+
+   This function is a possible cancellation point and therefore not
+   marked with __THROW.  */
+extern void endpwent (void);
 
-/* Return a chunk of memory containing pre-initialized data for __pwdread.  */
-extern __ptr_t __pwdalloc __P ((void));
+/* Read an entry from the user database stream, opening it if necessary.
 
-/* Scan the password file, filling in P, until SELECTOR returns nonzero for
-   an entry.  Return the `struct passwd' of P if successful, NULL on
-   failure.  */
-extern struct passwd *__pwdscan __P ((__ptr_t *__p,
-                                     int (*__selector) (struct passwd *)));
+   This function is a possible cancellation point and therefore not
+   marked with __THROW.  */
+extern struct passwd *getpwent (void);
 #endif
 
+#ifdef __USE_MISC
+/* Read a user database entry from STREAM.
 
-#if defined(__USE_SVID) || defined(__USE_MISC) || defined(__USE_XOPEN_EXTENDED)
-/* Rewind the password-file stream.  */
-extern void setpwent __P ((void));
+   This function is not part of POSIX and therefore no official
+   cancellation point.  But due to similarity with an POSIX interface
+   or due to the implementation it is a cancellation point and
+   therefore not marked with __THROW.  */
+extern struct passwd *fgetpwent (FILE *__stream) __nonnull ((1));
 
-/* Close the password-file stream.  */
-extern void endpwent __P ((void));
+/* Write a given user database entry onto the given stream.
 
-/* Read an entry from the password-file stream, opening it if necessary.  */
-extern struct passwd *getpwent __P ((void));
+   This function is not part of POSIX and therefore no official
+   cancellation point.  But due to similarity with an POSIX interface
+   or due to the implementation it is a cancellation point and
+   therefore not marked with __THROW.  */
+extern int putpwent (const struct passwd *__restrict __p,
+                    FILE *__restrict __f);
 #endif
 
-#ifdef __USE_SVID
-/* Read an entry from STREAM.  */
-extern struct passwd *fgetpwent __P ((FILE *__stream));
+/* Retrieve the user database entry for the given user ID.
 
-/* Write the given entry onto the given stream.  */
-extern int putpwent __P ((__const struct passwd *__p, FILE *__f));
-#endif
+   This function is a possible cancellation point and therefore not
+   marked with __THROW.  */
+extern struct passwd *getpwuid (__uid_t __uid);
+
+/* Retrieve the user database entry for the given username.
 
-/* Search for an entry with a matching user ID.  */
-extern struct passwd *getpwuid __P ((__uid_t __uid));
+   This function is a possible cancellation point and therefore not
+   marked with __THROW.  */
+extern struct passwd *getpwnam (const char *__name) __nonnull ((1));
 
-/* Search for an entry with a matching username.  */
-extern struct passwd *getpwnam __P ((__const char *__name));
+#ifdef __USE_POSIX
 
-#if defined __USE_POSIX || defined __USE_REENTRANT
+# ifdef __USE_MISC
 /* Reasonable value for the buffer sized used in the reentrant
    functions below.  But better use `sysconf'.  */
-#define        NSS_BUFLEN_PASSWD       1024
+#  define NSS_BUFLEN_PASSWD    1024
+# endif
 
 /* Reentrant versions of some of the functions above.
 
@@ -107,41 +131,58 @@ extern struct passwd *getpwnam __P ((__const char *__name));
    other reentrant functions so the chances are good this is what the
    POSIX people would choose.  */
 
-#if defined(__USE_SVID) || defined(__USE_MISC) || defined(__USE_XOPEN_EXTENDED)
-extern int __getpwent_r __P ((struct passwd *__resultbuf, char *__buffer,
-                             size_t __buflen, struct passwd **__result));
-extern int getpwent_r __P ((struct passwd *__resultbuf, char *__buffer,
-                           size_t __buflen, struct passwd **__result));
-#endif
-
-extern int __getpwuid_r __P ((__uid_t __uid, struct passwd *__resultbuf,
-                             char *__buffer, size_t __buflen,
-                             struct passwd **__result));
-extern int getpwuid_r __P ((__uid_t __uid, struct passwd *__resultbuf,
-                           char *__buffer, size_t __buflen,
-                           struct passwd **__result));
-
-extern int __getpwnam_r __P ((__const char *__name, struct passwd *__resultbuf,
-                             char *__buffer, size_t __buflen,
-                             struct passwd **__result));
-extern int getpwnam_r __P ((__const char *__name, struct passwd *__resultbuf,
-                           char *__buffer, size_t __buflen,
-                           struct passwd **__result));
-
-
-#ifdef __USE_SVID
-/* Read an entry from STREAM.  This function is not standardized and
-   probably never will.  */
-extern int __fgetpwent_r __P ((FILE * __stream, struct passwd *__resultbuf,
-                              char *__buffer, size_t __buflen,
-                              struct passwd **__result));
-extern int fgetpwent_r __P ((FILE * __stream, struct passwd *__resultbuf,
-                            char *__buffer, size_t __buflen,
-                            struct passwd **__result));
-#endif
+# ifdef __USE_MISC
+/* This function is not part of POSIX and therefore no official
+   cancellation point.  But due to similarity with an POSIX interface
+   or due to the implementation it is a cancellation point and
+   therefore not marked with __THROW.  */
+extern int getpwent_r (struct passwd *__restrict __resultbuf,
+                      char *__restrict __buffer, size_t __buflen,
+                      struct passwd **__restrict __result)
+                      __nonnull ((1, 2, 4));
+# endif
+
+extern int getpwuid_r (__uid_t __uid,
+                      struct passwd *__restrict __resultbuf,
+                      char *__restrict __buffer, size_t __buflen,
+                      struct passwd **__restrict __result)
+                      __nonnull ((2, 3, 5));
+
+extern int getpwnam_r (const char *__restrict __name,
+                      struct passwd *__restrict __resultbuf,
+                      char *__restrict __buffer, size_t __buflen,
+                      struct passwd **__restrict __result)
+                      __nonnull ((1, 2, 3, 5));
+
+
+# ifdef        __USE_MISC
+/* Read a user database entry from STREAM.  This function is not
+   standardized and probably never will.
+
+   This function is not part of POSIX and therefore no official
+   cancellation point.  But due to similarity with an POSIX interface
+   or due to the implementation it is a cancellation point and
+   therefore not marked with __THROW.  */
+extern int fgetpwent_r (FILE *__restrict __stream,
+                       struct passwd *__restrict __resultbuf,
+                       char *__restrict __buffer, size_t __buflen,
+                       struct passwd **__restrict __result)
+                       __nonnull ((1, 2, 3, 5));
+# endif
 
 #endif /* POSIX or reentrant */
 
+#ifdef __USE_GNU
+/* Write a traditional /etc/passwd line, based on the user database
+   entry for the given UID, to BUFFER; space for BUFFER must be
+   allocated by the caller.
+
+   This function is not part of POSIX and therefore no official
+   cancellation point.  But due to similarity with an POSIX interface
+   or due to the implementation it is a cancellation point and
+   therefore not marked with __THROW.  */
+extern int getpw (__uid_t __uid, char *__buffer);
+#endif
 
 __END_DECLS