Blame login/utmp_file.c

Packit 6c4009
/* Copyright (C) 1996-2018 Free Software Foundation, Inc.
Packit 6c4009
   This file is part of the GNU C Library.
Packit 6c4009
   Contributed by Ulrich Drepper <drepper@cygnus.com>
Packit 6c4009
   and Paul Janzen <pcj@primenet.com>, 1996.
Packit 6c4009
Packit 6c4009
   The GNU C Library is free software; you can redistribute it and/or
Packit 6c4009
   modify it under the terms of the GNU Lesser General Public
Packit 6c4009
   License as published by the Free Software Foundation; either
Packit 6c4009
   version 2.1 of the License, or (at your option) any later version.
Packit 6c4009
Packit 6c4009
   The GNU C Library is distributed in the hope that it will be useful,
Packit 6c4009
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 6c4009
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 6c4009
   Lesser General Public License for more details.
Packit 6c4009
Packit 6c4009
   You should have received a copy of the GNU Lesser General Public
Packit 6c4009
   License along with the GNU C Library; if not, see
Packit 6c4009
   <http://www.gnu.org/licenses/>.  */
Packit 6c4009
Packit 6c4009
#include <assert.h>
Packit 6c4009
#include <errno.h>
Packit 6c4009
#include <fcntl.h>
Packit 6c4009
#include <signal.h>
Packit 6c4009
#include <stdbool.h>
Packit 6c4009
#include <stdio.h>
Packit 6c4009
#include <string.h>
Packit 6c4009
#include <unistd.h>
Packit 6c4009
#include <utmp.h>
Packit 6c4009
#include <not-cancel.h>
Packit 6c4009
#include <kernel-features.h>
Packit 6c4009
#include <sigsetops.h>
Packit 6c4009
#include <not-cancel.h>
Packit 6c4009
Packit 6c4009
#include "utmp-private.h"
Packit 6c4009
#include "utmp-equal.h"
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* Descriptor for the file and position.  */
Packit 6c4009
static int file_fd = -1;
Packit 6c4009
static bool file_writable;
Packit 6c4009
static off64_t file_offset;
Packit 6c4009
Packit 6c4009
/* Cache for the last read entry.  */
Packit 6c4009
static struct utmp last_entry;
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* Locking timeout.  */
Packit 6c4009
#ifndef TIMEOUT
Packit 6c4009
# define TIMEOUT 10
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
/* Do-nothing handler for locking timeout.  */
Packit 6c4009
static void timeout_handler (int signum) {};
Packit 6c4009
Packit Service 5f5648
Packit Service 5f5648
/* try_file_lock (LOCKING, FD, TYPE) returns true if the locking
Packit Service 5f5648
   operation failed and recovery needs to be performed.
Packit Service 5f5648
Packit Service 5f5648
   file_unlock (FD) removes the lock (which must have been
Packit Service d20430
   successfully acquired). */
Packit Service 5f5648
Packit Service 5f5648
static bool
Packit Service d20430
try_file_lock (int fd, int type)
Packit Service 5f5648
{
Packit Service 5f5648
  /* Cancel any existing alarm.  */
Packit Service d20430
  int old_timeout = alarm (0);
Packit Service 5f5648
Packit Service 5f5648
  /* Establish signal handler.  */
Packit Service d20430
  struct sigaction old_action;
Packit Service 5f5648
  struct sigaction action;
Packit Service 5f5648
  action.sa_handler = timeout_handler;
Packit Service 5f5648
  __sigemptyset (&action.sa_mask);
Packit Service 5f5648
  action.sa_flags = 0;
Packit Service d20430
  __sigaction (SIGALRM, &action, &old_action);
Packit Service 5f5648
Packit Service 5f5648
  alarm (TIMEOUT);
Packit Service 5f5648
Packit Service 5f5648
  /* Try to get the lock.  */
Packit Service fbc33e
 struct flock64 fl =
Packit Service 5f5648
   {
Packit Service 5f5648
    .l_type = type,
Packit Service 5f5648
    fl.l_whence = SEEK_SET,
Packit Service 5f5648
   };
Packit Service d20430
Packit Service d20430
 bool status = __fcntl64_nocancel (fd, F_SETLKW, &fl) < 0;
Packit Service d20430
 int saved_errno = errno;
Packit Service d20430
Packit Service d20430
 /* Reset the signal handler and alarm.  We must reset the alarm
Packit Service d20430
    before resetting the handler so our alarm does not generate a
Packit Service d20430
    spurious SIGALRM seen by the user.  However, we cannot just set
Packit Service d20430
    the user's old alarm before restoring the handler, because then
Packit Service d20430
    it's possible our handler could catch the user alarm's SIGARLM and
Packit Service d20430
    then the user would never see the signal he expected.  */
Packit Service d20430
  alarm (0);
Packit Service d20430
  __sigaction (SIGALRM, &old_action, NULL);
Packit Service d20430
  if (old_timeout != 0)
Packit Service d20430
    alarm (old_timeout);
Packit Service d20430
Packit Service d20430
  __set_errno (saved_errno);
Packit Service d20430
  return status;
Packit Service 5f5648
}
Packit Service 5f5648
Packit Service 5f5648
static void
Packit Service 5f5648
file_unlock (int fd)
Packit Service 5f5648
{
Packit Service fbc33e
  struct flock64 fl =
Packit Service 5f5648
    {
Packit Service 5f5648
      .l_type = F_UNLCK,
Packit Service 5f5648
    };
Packit Service 5f5648
  __fcntl64_nocancel (fd, F_SETLKW, &fl);
Packit Service 5f5648
}
Packit Service 5f5648
Packit 6c4009
#ifndef TRANSFORM_UTMP_FILE_NAME
Packit 6c4009
# define TRANSFORM_UTMP_FILE_NAME(file_name) (file_name)
Packit 6c4009
#endif
Packit 6c4009
Packit Service 2f694a
int
Packit Service 2f694a
__libc_setutent (void)
Packit 6c4009
{
Packit 6c4009
  if (file_fd < 0)
Packit 6c4009
    {
Packit 6c4009
      const char *file_name;
Packit 6c4009
Packit 6c4009
      file_name = TRANSFORM_UTMP_FILE_NAME (__libc_utmp_file_name);
Packit 6c4009
Packit 6c4009
      file_writable = false;
Packit 6c4009
      file_fd = __open_nocancel
Packit 6c4009
	(file_name, O_RDONLY | O_LARGEFILE | O_CLOEXEC);
Packit 6c4009
      if (file_fd == -1)
Packit 6c4009
	return 0;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  __lseek64 (file_fd, 0, SEEK_SET);
Packit 6c4009
  file_offset = 0;
Packit 6c4009
Packit Service 6de65a
  /* Make sure the entry won't match.  */
Packit Service 6de65a
  last_entry.ut_type = -1;
Packit Service 6de65a
Packit 6c4009
  return 1;
Packit 6c4009
}
Packit 6c4009
Packit Service 2f694a
/* Preform initialization if necessary.  */
Packit Service 2f694a
static bool
Packit Service 2f694a
maybe_setutent (void)
Packit Service 2f694a
{
Packit Service 2f694a
  return file_fd >= 0 || __libc_setutent ();
Packit Service 2f694a
}
Packit 6c4009
Packit Service 2f694a
int
Packit Service 2f694a
__libc_getutent_r (struct utmp *buffer, struct utmp **result)
Packit Service 82ff93
{
Packit Service 6de65a
  ssize_t nbytes;
Packit Service 82ff93
Packit Service 2f694a
  if (!maybe_setutent () || file_offset == -1l)
Packit 6c4009
    {
Packit 6c4009
      /* Not available.  */
Packit 6c4009
      *result = NULL;
Packit 6c4009
      return -1;
Packit 6c4009
    }
Packit 6c4009
Packit Service d20430
  if (try_file_lock (file_fd, F_RDLCK))
Packit Service 5f5648
    nbytes = 0;
Packit Service 5f5648
  else
Packit Service 6de65a
    {
Packit Service 5f5648
      /* Read the next entry.  */
Packit Service 5f5648
      nbytes = __read_nocancel (file_fd, &last_entry, sizeof (struct utmp));
Packit Service 5f5648
      file_unlock (file_fd);
Packit Service 6de65a
    }
Packit Service 6de65a
Packit Service 6de65a
  if (nbytes != sizeof (struct utmp))
Packit 6c4009
    {
Packit Service 6de65a
      if (nbytes != 0)
Packit Service 6de65a
	file_offset = -1l;
Packit 6c4009
      *result = NULL;
Packit 6c4009
      return -1;
Packit 6c4009
    }
Packit 6c4009
Packit Service 6de65a
  /* Update position pointer.  */
Packit Service 6de65a
  file_offset += sizeof (struct utmp);
Packit Service 6de65a
Packit 6c4009
  memcpy (buffer, &last_entry, sizeof (struct utmp));
Packit 6c4009
  *result = buffer;
Packit 6c4009
Packit 6c4009
  return 0;
Packit 6c4009
}
Packit 6c4009
Packit 6c4009
Packit 6c4009
static int
Packit Service 6de65a
internal_getut_r (const struct utmp *id, struct utmp *buffer,
Packit Service 6de65a
		  bool *lock_failed)
Packit 6c4009
{
Packit Service 6de65a
  int result = -1;
Packit Service 6de65a
Packit Service d20430
  if (try_file_lock (file_fd, F_RDLCK))
Packit Service 6de65a
    {
Packit Service 6de65a
      *lock_failed = true;
Packit Service 5f5648
      return -1;
Packit Service 6de65a
    }
Packit Service 6de65a
Packit Service 6de65a
  if (id->ut_type == RUN_LVL || id->ut_type == BOOT_TIME
Packit Service 6de65a
      || id->ut_type == OLD_TIME || id->ut_type == NEW_TIME)
Packit 6c4009
    {
Packit Service 6de65a
      /* Search for next entry with type RUN_LVL, BOOT_TIME,
Packit Service 6de65a
	 OLD_TIME, or NEW_TIME.  */
Packit Service 6de65a
Packit Service 6de65a
      while (1)
Packit 6c4009
	{
Packit Service 6de65a
	  /* Read the next entry.  */
Packit Service 6de65a
	  if (__read_nocancel (file_fd, buffer, sizeof (struct utmp))
Packit Service 6de65a
	      != sizeof (struct utmp))
Packit Service 6de65a
	    {
Packit Service 6de65a
	      __set_errno (ESRCH);
Packit Service 6de65a
	      file_offset = -1l;
Packit Service 6de65a
	      goto unlock_return;
Packit Service 6de65a
	    }
Packit Service 6de65a
	  file_offset += sizeof (struct utmp);
Packit Service 6de65a
Packit Service 6de65a
	  if (id->ut_type == buffer->ut_type)
Packit Service 6de65a
	    break;
Packit 6c4009
	}
Packit Service 6de65a
    }
Packit Service 6de65a
  else
Packit Service 6de65a
    {
Packit Service 6de65a
      /* Search for the next entry with the specified ID and with type
Packit Service 6de65a
	 INIT_PROCESS, LOGIN_PROCESS, USER_PROCESS, or DEAD_PROCESS.  */
Packit Service 93dc7a
Packit Service 6de65a
      while (1)
Packit Service 6de65a
	{
Packit Service 6de65a
	  /* Read the next entry.  */
Packit Service 6de65a
	  if (__read_nocancel (file_fd, buffer, sizeof (struct utmp))
Packit Service 6de65a
	      != sizeof (struct utmp))
Packit Service 6de65a
	    {
Packit Service 6de65a
	      __set_errno (ESRCH);
Packit Service 6de65a
	      file_offset = -1l;
Packit Service 6de65a
	      goto unlock_return;
Packit Service 6de65a
	    }
Packit Service 6de65a
	  file_offset += sizeof (struct utmp);
Packit Service 6de65a
Packit Service 6de65a
	  if (__utmp_equal (buffer, id))
Packit Service 6de65a
	    break;
Packit Service 6de65a
	}
Packit 6c4009
    }
Packit 6c4009
Packit Service 6de65a
  result = 0;
Packit 6c4009
Packit Service 6de65a
unlock_return:
Packit Service 5f5648
  file_unlock (file_fd);
Packit 6c4009
Packit 6c4009
  return result;
Packit 6c4009
}
Packit 6c4009
Packit Service 6de65a
Packit 6c4009
/* For implementing this function we don't use the getutent_r function
Packit 6c4009
   because we can avoid the reposition on every new entry this way.  */
Packit Service 2f694a
int
Packit Service 2f694a
__libc_getutid_r (const struct utmp *id, struct utmp *buffer,
Packit Service 2f694a
		  struct utmp **result)
Packit 6c4009
{
Packit Service 2f694a
  if (!maybe_setutent () || file_offset == -1l)
Packit 6c4009
    {
Packit 6c4009
      *result = NULL;
Packit 6c4009
      return -1;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  /* We don't have to distinguish whether we can lock the file or
Packit 6c4009
     whether there is no entry.  */
Packit 6c4009
  bool lock_failed = false;
Packit Service 6de65a
  if (internal_getut_r (id, &last_entry, &lock_failed) < 0)
Packit 6c4009
    {
Packit 6c4009
      *result = NULL;
Packit 6c4009
      return -1;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  memcpy (buffer, &last_entry, sizeof (struct utmp));
Packit 6c4009
  *result = buffer;
Packit 6c4009
Packit 6c4009
  return 0;
Packit 6c4009
}
Packit 6c4009
Packit Service 6de65a
Packit 6c4009
/* For implementing this function we don't use the getutent_r function
Packit 6c4009
   because we can avoid the reposition on every new entry this way.  */
Packit Service 2f694a
int
Packit Service 2f694a
__libc_getutline_r (const struct utmp *line, struct utmp *buffer,
Packit Service 2f694a
		    struct utmp **result)
Packit 6c4009
{
Packit Service 2f694a
  if (!maybe_setutent () || file_offset == -1l)
Packit 6c4009
    {
Packit 6c4009
      *result = NULL;
Packit 6c4009
      return -1;
Packit 6c4009
    }
Packit 6c4009
Packit Service d20430
  if (try_file_lock (file_fd, F_RDLCK))
Packit 6c4009
    {
Packit 6c4009
      *result = NULL;
Packit Service 5f5648
      return -1;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  while (1)
Packit 6c4009
    {
Packit Service 6de65a
      /* Read the next entry.  */
Packit Service 6de65a
      if (__read_nocancel (file_fd, &last_entry, sizeof (struct utmp))
Packit Service 6de65a
	  != sizeof (struct utmp))
Packit 6c4009
	{
Packit 6c4009
	  __set_errno (ESRCH);
Packit Service 6de65a
	  file_offset = -1l;
Packit 6c4009
	  *result = NULL;
Packit Service 6de65a
	  goto unlock_return;
Packit 6c4009
	}
Packit Service 6de65a
      file_offset += sizeof (struct utmp);
Packit 6c4009
Packit 6c4009
      /* Stop if we found a user or login entry.  */
Packit Service c5ceb8
      if ((last_entry.ut_type == USER_PROCESS
Packit 6c4009
	   || last_entry.ut_type == LOGIN_PROCESS)
Packit Service c5ceb8
	  && (strncmp (line->ut_line, last_entry.ut_line, sizeof line->ut_line)
Packit Service c5ceb8
	      == 0))
Packit 6c4009
	break;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  memcpy (buffer, &last_entry, sizeof (struct utmp));
Packit 6c4009
  *result = buffer;
Packit 6c4009
Packit Service 6de65a
unlock_return:
Packit Service 5f5648
  file_unlock (file_fd);
Packit Service 6de65a
Packit Service 6de65a
  return ((*result == NULL) ? -1 : 0);
Packit 6c4009
}
Packit 6c4009
Packit 6c4009
Packit Service 2f694a
struct utmp *
Packit Service 2f694a
__libc_pututline (const struct utmp *data)
Packit 6c4009
{
Packit Service 2f694a
  if (!maybe_setutent ())
Packit Service 2f694a
    return NULL;
Packit Service 2f694a
Packit Service 6de65a
  struct utmp buffer;
Packit 6c4009
  struct utmp *pbuf;
Packit Service 6de65a
  int found;
Packit Service 6de65a
Packit 6c4009
  if (! file_writable)
Packit 6c4009
    {
Packit 6c4009
      /* We must make the file descriptor writable before going on.  */
Packit 6c4009
      const char *file_name = TRANSFORM_UTMP_FILE_NAME (__libc_utmp_file_name);
Packit 6c4009
Packit 6c4009
      int new_fd = __open_nocancel
Packit 6c4009
	(file_name, O_RDWR | O_LARGEFILE | O_CLOEXEC);
Packit 6c4009
      if (new_fd == -1)
Packit 6c4009
	return NULL;
Packit 6c4009
Packit Service 6de65a
      if (__lseek64 (new_fd, __lseek64 (file_fd, 0, SEEK_CUR), SEEK_SET) == -1
Packit Service 6de65a
	  || __dup2 (new_fd, file_fd) < 0)
Packit 6c4009
	{
Packit 6c4009
	  __close_nocancel_nostatus (new_fd);
Packit 6c4009
	  return NULL;
Packit 6c4009
	}
Packit 6c4009
      __close_nocancel_nostatus (new_fd);
Packit 6c4009
      file_writable = true;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  /* Find the correct place to insert the data.  */
Packit Service 6de65a
  if (file_offset > 0
Packit Service c5ceb8
      && ((last_entry.ut_type == data->ut_type
Packit Service 6de65a
	   && (last_entry.ut_type == RUN_LVL
Packit Service 6de65a
	       || last_entry.ut_type == BOOT_TIME
Packit Service 6de65a
	       || last_entry.ut_type == OLD_TIME
Packit Service 6de65a
	       || last_entry.ut_type == NEW_TIME))
Packit Service c5ceb8
	  || __utmp_equal (&last_entry, data)))
Packit Service 6de65a
    found = 1;
Packit Service 6de65a
  else
Packit 6c4009
    {
Packit Service 6de65a
      bool lock_failed = false;
Packit Service 6de65a
      found = internal_getut_r (data, &buffer, &lock_failed);
Packit Service 6de65a
Packit Service 6de65a
      if (__builtin_expect (lock_failed, false))
Packit 6c4009
	{
Packit Service 6de65a
	  __set_errno (EAGAIN);
Packit 6c4009
	  return NULL;
Packit 6c4009
	}
Packit 6c4009
    }
Packit 6c4009
Packit Service d20430
  if (try_file_lock (file_fd, F_WRLCK))
Packit Service d20430
    return NULL;
Packit 6c4009
Packit Service 6de65a
  if (found < 0)
Packit 6c4009
    {
Packit 6c4009
      /* We append the next entry.  */
Packit Service 6de65a
      file_offset = __lseek64 (file_fd, 0, SEEK_END);
Packit Service 6de65a
      if (file_offset % sizeof (struct utmp) != 0)
Packit Service 6de65a
	{
Packit Service 6de65a
	  file_offset -= file_offset % sizeof (struct utmp);
Packit Service 6de65a
	  __ftruncate64 (file_fd, file_offset);
Packit Service 6de65a
Packit Service 6de65a
	  if (__lseek64 (file_fd, 0, SEEK_END) < 0)
Packit Service 6de65a
	    {
Packit Service 6de65a
	      pbuf = NULL;
Packit Service 6de65a
	      goto unlock_return;
Packit Service 6de65a
	    }
Packit Service 6de65a
	}
Packit 6c4009
    }
Packit 6c4009
  else
Packit 6c4009
    {
Packit Service 6de65a
      /* We replace the just read entry.  */
Packit Service 6de65a
      file_offset -= sizeof (struct utmp);
Packit Service 6de65a
      __lseek64 (file_fd, file_offset, SEEK_SET);
Packit 6c4009
    }
Packit 6c4009
Packit Service 6de65a
  /* Write the new data.  */
Packit Service 6de65a
  if (__write_nocancel (file_fd, data, sizeof (struct utmp))
Packit Service 6de65a
      != sizeof (struct utmp))
Packit 6c4009
    {
Packit 6c4009
      /* If we appended a new record this is only partially written.
Packit 6c4009
	 Remove it.  */
Packit Service 6de65a
      if (found < 0)
Packit Service 6de65a
	(void) __ftruncate64 (file_fd, file_offset);
Packit Service 6de65a
      pbuf = NULL;
Packit Service 6de65a
    }
Packit Service 6de65a
  else
Packit Service 6de65a
    {
Packit Service 6de65a
      file_offset += sizeof (struct utmp);
Packit Service 6de65a
      pbuf = (struct utmp *) data;
Packit 6c4009
    }
Packit 6c4009
Packit Service 6de65a
 unlock_return:
Packit Service 5f5648
  file_unlock (file_fd);
Packit 6c4009
Packit 6c4009
  return pbuf;
Packit 6c4009
}
Packit 6c4009
Packit 6c4009
Packit Service 2f694a
void
Packit Service 2f694a
__libc_endutent (void)
Packit 6c4009
{
Packit Service 2f694a
  if (file_fd >= 0)
Packit Service 2f694a
    {
Packit Service 2f694a
      __close_nocancel_nostatus (file_fd);
Packit Service 2f694a
      file_fd = -1;
Packit Service 2f694a
    }
Packit 6c4009
}
Packit 6c4009
Packit 6c4009
Packit Service 2f694a
int
Packit Service 2f694a
__libc_updwtmp (const char *file, const struct utmp *utmp)
Packit 6c4009
{
Packit 6c4009
  int result = -1;
Packit 6c4009
  off64_t offset;
Packit 6c4009
  int fd;
Packit 6c4009
Packit 6c4009
  /* Open WTMP file.  */
Packit 6c4009
  fd = __open_nocancel (file, O_WRONLY | O_LARGEFILE);
Packit 6c4009
  if (fd < 0)
Packit 6c4009
    return -1;
Packit 6c4009
Packit Service d20430
  if (try_file_lock (fd, F_WRLCK))
Packit Service 5f5648
    {
Packit Service 5f5648
      __close_nocancel_nostatus (fd);
Packit Service 5f5648
      return -1;
Packit Service 5f5648
    }
Packit 6c4009
Packit 6c4009
  /* Remember original size of log file.  */
Packit 6c4009
  offset = __lseek64 (fd, 0, SEEK_END);
Packit 6c4009
  if (offset % sizeof (struct utmp) != 0)
Packit 6c4009
    {
Packit 6c4009
      offset -= offset % sizeof (struct utmp);
Packit 6c4009
      __ftruncate64 (fd, offset);
Packit 6c4009
Packit 6c4009
      if (__lseek64 (fd, 0, SEEK_END) < 0)
Packit 6c4009
	goto unlock_return;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  /* Write the entry.  If we can't write all the bytes, reset the file
Packit 6c4009
     size back to the original size.  That way, no partial entries
Packit 6c4009
     will remain.  */
Packit 6c4009
  if (__write_nocancel (fd, utmp, sizeof (struct utmp))
Packit 6c4009
      != sizeof (struct utmp))
Packit 6c4009
    {
Packit 6c4009
      __ftruncate64 (fd, offset);
Packit 6c4009
      goto unlock_return;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  result = 0;
Packit 6c4009
Packit 6c4009
unlock_return:
Packit Service 745861
  file_unlock (fd);
Packit 6c4009
Packit 6c4009
  /* Close WTMP file.  */
Packit 6c4009
  __close_nocancel_nostatus (fd);
Packit 6c4009
Packit 6c4009
  return result;
Packit 6c4009
}