More use of getpwuid_r() directly

Remove src/port/user.c, call getpwuid_r() directly.  This reduces some
complexity and allows better control of the error behavior.  For
example, the old code would in some circumstances silently truncate
the result string, or produce error message strings that the caller
wouldn't use.

src/port/user.c used to be called src/port/thread.c and contained
various portability complications to support thread-safety.  These are
all obsolete, and all but the user-lookup functions have already been
removed.  This patch completes this by also removing the user-lookup
functions.

Also convert src/backend/libpq/auth.c to use getpwuid_r() for
thread-safety.

Originally, I tried to be overly correct by using
sysconf(_SC_GETPW_R_SIZE_MAX) to get the buffer size for getpwuid_r(),
but that doesn't work on FreeBSD.  All the OS where I could find the
source code internally use 1024 as the suggested buffer size, so I
just ended up hardcoding that.  The previous code used BUFSIZ, which
is an unrelated constant from stdio.h, so its use seemed
inappropriate.

Reviewed-by: Heikki Linnakangas <hlinnaka@iki.fi>
Discussion: https://www.postgresql.org/message-id/flat/5f293da9-ceb4-4937-8e52-82c25db8e4d3%40eisentraut.org
This commit is contained in:
Peter Eisentraut 2024-09-02 08:16:25 +02:00
parent 23138284cd
commit 4d5111b3f1
10 changed files with 72 additions and 123 deletions

View File

@ -1857,7 +1857,10 @@ auth_peer(hbaPort *port)
uid_t uid;
gid_t gid;
#ifndef WIN32
struct passwd pwbuf;
struct passwd *pw;
char buf[1024];
int rc;
int ret;
#endif
@ -1876,16 +1879,18 @@ auth_peer(hbaPort *port)
}
#ifndef WIN32
errno = 0; /* clear errno before call */
pw = getpwuid(uid);
if (!pw)
rc = getpwuid_r(uid, &pwbuf, buf, sizeof buf, &pw);
if (rc != 0)
{
int save_errno = errno;
errno = rc;
ereport(LOG,
(errmsg("could not look up local user ID %ld: %s",
(long) uid,
save_errno ? strerror(save_errno) : _("user does not exist"))));
errmsg("could not look up local user ID %ld: %m", (long) uid));
return STATUS_ERROR;
}
else if (!pw)
{
ereport(LOG,
errmsg("local user with ID %ld does not exist", (long) uid));
return STATUS_ERROR;
}

View File

@ -23,8 +23,7 @@ GETTEXT_FILES = $(FRONTEND_COMMON_GETTEXT_FILES) \
../../common/exec.c \
../../common/fe_memutils.c \
../../common/username.c \
../../common/wait_error.c \
../../port/user.c
../../common/wait_error.c
GETTEXT_TRIGGERS = $(FRONTEND_COMMON_GETTEXT_TRIGGERS) \
HELP0 HELPN N_ simple_prompt simple_prompt_extended
GETTEXT_FLAGS = $(FRONTEND_COMMON_GETTEXT_FLAGS) \

View File

@ -436,12 +436,6 @@ extern size_t strnlen(const char *str, size_t maxlen);
extern char *strsep(char **stringp, const char *delim);
#endif
/* port/user.c */
#ifndef WIN32
extern bool pg_get_user_name(uid_t user_id, char *buffer, size_t buflen);
extern bool pg_get_user_home_dir(uid_t user_id, char *buffer, size_t buflen);
#endif
/*
* Callers should use the qsort() macro defined below instead of calling
* pg_qsort() directly.

View File

@ -28,6 +28,7 @@
#include <unistd.h>
#include <fcntl.h>
#include <limits.h>
#include <pwd.h>
#include <sys/param.h> /* for MAXHOSTNAMELEN on most */
#include <sys/socket.h>
#ifdef HAVE_SYS_UCRED_H
@ -1203,7 +1204,10 @@ pg_fe_getusername(uid_t user_id, PQExpBuffer errorMessage)
char username[256 + 1];
DWORD namesize = sizeof(username);
#else
char pwdbuf[BUFSIZ];
struct passwd pwbuf;
struct passwd *pw;
char buf[1024];
int rc;
#endif
#ifdef WIN32
@ -1214,10 +1218,19 @@ pg_fe_getusername(uid_t user_id, PQExpBuffer errorMessage)
"user name lookup failure: error code %lu",
GetLastError());
#else
if (pg_get_user_name(user_id, pwdbuf, sizeof(pwdbuf)))
name = pwdbuf;
else if (errorMessage)
appendPQExpBuffer(errorMessage, "%s\n", pwdbuf);
rc = getpwuid_r(user_id, &pwbuf, buf, sizeof buf, &pw);
if (rc != 0)
{
errno = rc;
if (errorMessage)
libpq_append_error(errorMessage, "could not look up local user ID %ld: %m", (long) user_id);
}
else if (!pw)
{
if (errorMessage)
libpq_append_error(errorMessage, "local user with ID %ld does not exist", (long) user_id);
}
name = pw->pw_name;
#endif
if (name)

View File

@ -50,6 +50,7 @@
#include <netdb.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#include <pwd.h>
#endif
#ifdef WIN32
@ -7702,10 +7703,24 @@ pqGetHomeDirectory(char *buf, int bufsize)
const char *home;
home = getenv("HOME");
if (home == NULL || home[0] == '\0')
return pg_get_user_home_dir(geteuid(), buf, bufsize);
strlcpy(buf, home, bufsize);
return true;
if (home && home[0])
{
strlcpy(buf, home, bufsize);
return true;
}
else
{
struct passwd pwbuf;
struct passwd *pw;
char tmpbuf[1024];
int rc;
rc = getpwuid_r(geteuid(), &pwbuf, tmpbuf, sizeof tmpbuf, &pw);
if (rc != 0 || !pw)
return false;
strlcpy(buf, pw->pw_dir, bufsize);
return true;
}
#else
char tmppath[MAX_PATH];

View File

@ -13,8 +13,7 @@ GETTEXT_FILES = fe-auth.c \
fe-secure-common.c \
fe-secure-gssapi.c \
fe-secure-openssl.c \
win32.c \
../../port/user.c
win32.c
GETTEXT_TRIGGERS = libpq_append_conn_error:2 \
libpq_append_error:2 \
libpq_gettext \

View File

@ -57,8 +57,7 @@ OBJS = \
quotes.o \
snprintf.o \
strerror.o \
tar.o \
user.o
tar.o
# libpgport.a, libpgport_shlib.a, and libpgport_srv.a contain the same files
# foo.o, foo_shlib.o, and foo_srv.o are all built from foo.c

View File

@ -20,7 +20,6 @@ pgport_sources = [
'snprintf.c',
'strerror.c',
'tar.c',
'user.c',
]
if host_system == 'windows'

View File

@ -32,6 +32,7 @@
#define near
#include <shlobj.h>
#else
#include <pwd.h>
#include <unistd.h>
#endif
@ -934,10 +935,24 @@ get_home_path(char *ret_path)
const char *home;
home = getenv("HOME");
if (home == NULL || home[0] == '\0')
return pg_get_user_home_dir(geteuid(), ret_path, MAXPGPATH);
strlcpy(ret_path, home, MAXPGPATH);
return true;
if (home && home[0])
{
strlcpy(ret_path, home, MAXPGPATH);
return true;
}
else
{
struct passwd pwbuf;
struct passwd *pw;
char buf[1024];
int rc;
rc = getpwuid_r(geteuid(), &pwbuf, buf, sizeof buf, &pw);
if (rc != 0 || !pw)
return false;
strlcpy(ret_path, pw->pw_dir, MAXPGPATH);
return true;
}
#else
char *tmppath;

View File

@ -1,89 +0,0 @@
/*-------------------------------------------------------------------------
*
* user.c
*
* Wrapper functions for user and home directory lookup.
*
* Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
*
* src/port/user.c
*
*-------------------------------------------------------------------------
*/
#include "c.h"
#include <pwd.h>
#ifndef WIN32
/*
* pg_get_user_name - get the name of the user with the given ID
*
* On success, the user name is returned into the buffer (of size buflen),
* and "true" is returned. On failure, a localized error message is
* returned into the buffer, and "false" is returned.
*/
bool
pg_get_user_name(uid_t user_id, char *buffer, size_t buflen)
{
char pwdbuf[BUFSIZ];
struct passwd pwdstr;
struct passwd *pw = NULL;
int pwerr;
pwerr = getpwuid_r(user_id, &pwdstr, pwdbuf, sizeof(pwdbuf), &pw);
if (pw != NULL)
{
strlcpy(buffer, pw->pw_name, buflen);
return true;
}
if (pwerr != 0)
snprintf(buffer, buflen,
_("could not look up local user ID %d: %s"),
(int) user_id,
strerror_r(pwerr, pwdbuf, sizeof(pwdbuf)));
else
snprintf(buffer, buflen,
_("local user with ID %d does not exist"),
(int) user_id);
return false;
}
/*
* pg_get_user_home_dir - get the home directory of the user with the given ID
*
* On success, the directory path is returned into the buffer (of size buflen),
* and "true" is returned. On failure, a localized error message is
* returned into the buffer, and "false" is returned.
*
* Note that this does not incorporate the common behavior of checking
* $HOME first, since it's independent of which user_id is queried.
*/
bool
pg_get_user_home_dir(uid_t user_id, char *buffer, size_t buflen)
{
char pwdbuf[BUFSIZ];
struct passwd pwdstr;
struct passwd *pw = NULL;
int pwerr;
pwerr = getpwuid_r(user_id, &pwdstr, pwdbuf, sizeof(pwdbuf), &pw);
if (pw != NULL)
{
strlcpy(buffer, pw->pw_dir, buflen);
return true;
}
if (pwerr != 0)
snprintf(buffer, buflen,
_("could not look up local user ID %d: %s"),
(int) user_id,
strerror_r(pwerr, pwdbuf, sizeof(pwdbuf)));
else
snprintf(buffer, buflen,
_("local user with ID %d does not exist"),
(int) user_id);
return false;
}
#endif /* !WIN32 */