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 aa7b8c
Packit aa7b8c
/* try_file_lock (LOCKING, FD, TYPE) returns true if the locking
Packit aa7b8c
   operation failed and recovery needs to be performed.
Packit aa7b8c
Packit aa7b8c
   file_unlock (FD) removes the lock (which must have been
Packit 25ee91
   successfully acquired). */
Packit aa7b8c
Packit aa7b8c
static bool
Packit 25ee91
try_file_lock (int fd, int type)
Packit aa7b8c
{
Packit aa7b8c
  /* Cancel any existing alarm.  */
Packit 25ee91
  int old_timeout = alarm (0);
Packit aa7b8c
Packit aa7b8c
  /* Establish signal handler.  */
Packit 25ee91
  struct sigaction old_action;
Packit aa7b8c
  struct sigaction action;
Packit aa7b8c
  action.sa_handler = timeout_handler;
Packit aa7b8c
  __sigemptyset (&action.sa_mask);
Packit aa7b8c
  action.sa_flags = 0;
Packit 25ee91
  __sigaction (SIGALRM, &action, &old_action);
Packit aa7b8c
Packit aa7b8c
  alarm (TIMEOUT);
Packit aa7b8c
Packit aa7b8c
  /* Try to get the lock.  */
Packit fb4551
 struct flock64 fl =
Packit aa7b8c
   {
Packit aa7b8c
    .l_type = type,
Packit aa7b8c
    fl.l_whence = SEEK_SET,
Packit aa7b8c
   };
Packit 25ee91
Packit 25ee91
 bool status = __fcntl64_nocancel (fd, F_SETLKW, &fl) < 0;
Packit 25ee91
 int saved_errno = errno;
Packit 25ee91
Packit 25ee91
 /* Reset the signal handler and alarm.  We must reset the alarm
Packit 25ee91
    before resetting the handler so our alarm does not generate a
Packit 25ee91
    spurious SIGALRM seen by the user.  However, we cannot just set
Packit 25ee91
    the user's old alarm before restoring the handler, because then
Packit 25ee91
    it's possible our handler could catch the user alarm's SIGARLM and
Packit 25ee91
    then the user would never see the signal he expected.  */
Packit 25ee91
  alarm (0);
Packit 25ee91
  __sigaction (SIGALRM, &old_action, NULL);
Packit 25ee91
  if (old_timeout != 0)
Packit 25ee91
    alarm (old_timeout);
Packit 25ee91
Packit 25ee91
  __set_errno (saved_errno);
Packit 25ee91
  return status;
Packit aa7b8c
}
Packit aa7b8c
Packit aa7b8c
static void
Packit aa7b8c
file_unlock (int fd)
Packit aa7b8c
{
Packit fb4551
  struct flock64 fl =
Packit aa7b8c
    {
Packit aa7b8c
      .l_type = F_UNLCK,
Packit aa7b8c
    };
Packit aa7b8c
  __fcntl64_nocancel (fd, F_SETLKW, &fl);
Packit aa7b8c
}
Packit aa7b8c
Packit 6c4009
#ifndef TRANSFORM_UTMP_FILE_NAME
Packit 6c4009
# define TRANSFORM_UTMP_FILE_NAME(file_name) (file_name)
Packit 6c4009
#endif
Packit 6c4009
Packit 078067
int
Packit 078067
__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 6c4009
  /* Make sure the entry won't match.  */
Packit 6c4009
  last_entry.ut_type = -1;
Packit 6c4009
Packit 6c4009
  return 1;
Packit 6c4009
}
Packit 6c4009
Packit 078067
/* Preform initialization if necessary.  */
Packit 078067
static bool
Packit 078067
maybe_setutent (void)
Packit 078067
{
Packit 078067
  return file_fd >= 0 || __libc_setutent ();
Packit 078067
}
Packit 6c4009
Packit 078067
int
Packit 078067
__libc_getutent_r (struct utmp *buffer, struct utmp **result)
Packit 6c4009
{
Packit 6c4009
  ssize_t nbytes;
Packit 6c4009
Packit 078067
  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 25ee91
  if (try_file_lock (file_fd, F_RDLCK))
Packit aa7b8c
    nbytes = 0;
Packit aa7b8c
  else
Packit 6c4009
    {
Packit aa7b8c
      /* Read the next entry.  */
Packit aa7b8c
      nbytes = __read_nocancel (file_fd, &last_entry, sizeof (struct utmp));
Packit aa7b8c
      file_unlock (file_fd);
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  if (nbytes != sizeof (struct utmp))
Packit 6c4009
    {
Packit 6c4009
      if (nbytes != 0)
Packit 6c4009
	file_offset = -1l;
Packit 6c4009
      *result = NULL;
Packit 6c4009
      return -1;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  /* Update position pointer.  */
Packit 6c4009
  file_offset += sizeof (struct utmp);
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 6c4009
Packit 95514d
/* Search for *ID, updating last_entry and file_offset.  Return 0 on
Packit 95514d
   success and -1 on failure.  If the locking operation failed, write
Packit 95514d
   true to *LOCK_FAILED.  */
Packit 6c4009
static int
Packit 95514d
internal_getut_r (const struct utmp *id, bool *lock_failed)
Packit 6c4009
{
Packit 6c4009
  int result = -1;
Packit 6c4009
Packit 25ee91
  if (try_file_lock (file_fd, F_RDLCK))
Packit 6c4009
    {
Packit 6c4009
      *lock_failed = true;
Packit aa7b8c
      return -1;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  if (id->ut_type == RUN_LVL || id->ut_type == BOOT_TIME
Packit 6c4009
      || id->ut_type == OLD_TIME || id->ut_type == NEW_TIME)
Packit 6c4009
    {
Packit 6c4009
      /* Search for next entry with type RUN_LVL, BOOT_TIME,
Packit 6c4009
	 OLD_TIME, or NEW_TIME.  */
Packit 6c4009
Packit 6c4009
      while (1)
Packit 6c4009
	{
Packit 6c4009
	  /* Read the next entry.  */
Packit 95514d
	  if (__read_nocancel (file_fd, &last_entry, sizeof (struct utmp))
Packit 6c4009
	      != sizeof (struct utmp))
Packit 6c4009
	    {
Packit 6c4009
	      __set_errno (ESRCH);
Packit 6c4009
	      file_offset = -1l;
Packit 6c4009
	      goto unlock_return;
Packit 6c4009
	    }
Packit 6c4009
	  file_offset += sizeof (struct utmp);
Packit 6c4009
Packit 95514d
	  if (id->ut_type == last_entry.ut_type)
Packit 6c4009
	    break;
Packit 6c4009
	}
Packit 6c4009
    }
Packit 6c4009
  else
Packit 6c4009
    {
Packit 6c4009
      /* Search for the next entry with the specified ID and with type
Packit 6c4009
	 INIT_PROCESS, LOGIN_PROCESS, USER_PROCESS, or DEAD_PROCESS.  */
Packit 6c4009
Packit 6c4009
      while (1)
Packit 6c4009
	{
Packit 6c4009
	  /* Read the next entry.  */
Packit 95514d
	  if (__read_nocancel (file_fd, &last_entry, sizeof (struct utmp))
Packit 6c4009
	      != sizeof (struct utmp))
Packit 6c4009
	    {
Packit 6c4009
	      __set_errno (ESRCH);
Packit 6c4009
	      file_offset = -1l;
Packit 6c4009
	      goto unlock_return;
Packit 6c4009
	    }
Packit 6c4009
	  file_offset += sizeof (struct utmp);
Packit 6c4009
Packit 95514d
	  if (__utmp_equal (&last_entry, id))
Packit 6c4009
	    break;
Packit 6c4009
	}
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  result = 0;
Packit 6c4009
Packit 6c4009
unlock_return:
Packit aa7b8c
  file_unlock (file_fd);
Packit 6c4009
Packit 6c4009
  return result;
Packit 6c4009
}
Packit 6c4009
Packit 6c4009
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 078067
int
Packit 078067
__libc_getutid_r (const struct utmp *id, struct utmp *buffer,
Packit 078067
		  struct utmp **result)
Packit 6c4009
{
Packit 078067
  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 95514d
  if (internal_getut_r (id, &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 6c4009
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 078067
int
Packit 078067
__libc_getutline_r (const struct utmp *line, struct utmp *buffer,
Packit 078067
		    struct utmp **result)
Packit 6c4009
{
Packit 078067
  if (!maybe_setutent () || file_offset == -1l)
Packit 6c4009
    {
Packit 6c4009
      *result = NULL;
Packit 6c4009
      return -1;
Packit 6c4009
    }
Packit 6c4009
Packit 25ee91
  if (try_file_lock (file_fd, F_RDLCK))
Packit 6c4009
    {
Packit 6c4009
      *result = NULL;
Packit aa7b8c
      return -1;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  while (1)
Packit 6c4009
    {
Packit 6c4009
      /* Read the next entry.  */
Packit 6c4009
      if (__read_nocancel (file_fd, &last_entry, sizeof (struct utmp))
Packit 6c4009
	  != sizeof (struct utmp))
Packit 6c4009
	{
Packit 6c4009
	  __set_errno (ESRCH);
Packit 6c4009
	  file_offset = -1l;
Packit 6c4009
	  *result = NULL;
Packit 6c4009
	  goto unlock_return;
Packit 6c4009
	}
Packit 6c4009
      file_offset += sizeof (struct utmp);
Packit 6c4009
Packit 6c4009
      /* Stop if we found a user or login entry.  */
Packit a3af96
      if ((last_entry.ut_type == USER_PROCESS
Packit 6c4009
	   || last_entry.ut_type == LOGIN_PROCESS)
Packit a3af96
	  && (strncmp (line->ut_line, last_entry.ut_line, sizeof line->ut_line)
Packit a3af96
	      == 0))
Packit 6c4009
	break;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  memcpy (buffer, &last_entry, sizeof (struct utmp));
Packit 6c4009
  *result = buffer;
Packit 6c4009
Packit 6c4009
unlock_return:
Packit aa7b8c
  file_unlock (file_fd);
Packit 6c4009
Packit 6c4009
  return ((*result == NULL) ? -1 : 0);
Packit 6c4009
}
Packit 6c4009
Packit 6c4009
Packit 078067
struct utmp *
Packit 078067
__libc_pututline (const struct utmp *data)
Packit 6c4009
{
Packit 95514d
  if (!maybe_setutent () || file_offset == -1l)
Packit 078067
    return NULL;
Packit 078067
Packit 6c4009
  struct utmp *pbuf;
Packit 6c4009
  int found;
Packit 6c4009
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 6c4009
      if (__lseek64 (new_fd, __lseek64 (file_fd, 0, SEEK_CUR), SEEK_SET) == -1
Packit 6c4009
	  || __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 6c4009
  if (file_offset > 0
Packit a3af96
      && ((last_entry.ut_type == data->ut_type
Packit 6c4009
	   && (last_entry.ut_type == RUN_LVL
Packit 6c4009
	       || last_entry.ut_type == BOOT_TIME
Packit 6c4009
	       || last_entry.ut_type == OLD_TIME
Packit 6c4009
	       || last_entry.ut_type == NEW_TIME))
Packit a3af96
	  || __utmp_equal (&last_entry, data)))
Packit 6c4009
    found = 1;
Packit 6c4009
  else
Packit 6c4009
    {
Packit 6c4009
      bool lock_failed = false;
Packit 95514d
      found = internal_getut_r (data, &lock_failed);
Packit 6c4009
Packit 6c4009
      if (__builtin_expect (lock_failed, false))
Packit 6c4009
	{
Packit 6c4009
	  __set_errno (EAGAIN);
Packit 6c4009
	  return NULL;
Packit 6c4009
	}
Packit 6c4009
    }
Packit 6c4009
Packit 25ee91
  if (try_file_lock (file_fd, F_WRLCK))
Packit 25ee91
    return NULL;
Packit 6c4009
Packit 6c4009
  if (found < 0)
Packit 6c4009
    {
Packit 6c4009
      /* We append the next entry.  */
Packit 6c4009
      file_offset = __lseek64 (file_fd, 0, SEEK_END);
Packit 6c4009
      if (file_offset % sizeof (struct utmp) != 0)
Packit 6c4009
	{
Packit 6c4009
	  file_offset -= file_offset % sizeof (struct utmp);
Packit 6c4009
	  __ftruncate64 (file_fd, file_offset);
Packit 6c4009
Packit 6c4009
	  if (__lseek64 (file_fd, 0, SEEK_END) < 0)
Packit 6c4009
	    {
Packit 6c4009
	      pbuf = NULL;
Packit 6c4009
	      goto unlock_return;
Packit 6c4009
	    }
Packit 6c4009
	}
Packit 6c4009
    }
Packit 6c4009
  else
Packit 6c4009
    {
Packit 6c4009
      /* We replace the just read entry.  */
Packit 6c4009
      file_offset -= sizeof (struct utmp);
Packit 6c4009
      __lseek64 (file_fd, file_offset, SEEK_SET);
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
  /* Write the new data.  */
Packit 6c4009
  if (__write_nocancel (file_fd, data, sizeof (struct utmp))
Packit 6c4009
      != sizeof (struct utmp))
Packit 6c4009
    {
Packit 6c4009
      /* If we appended a new record this is only partially written.
Packit 6c4009
	 Remove it.  */
Packit 6c4009
      if (found < 0)
Packit 6c4009
	(void) __ftruncate64 (file_fd, file_offset);
Packit 6c4009
      pbuf = NULL;
Packit 6c4009
    }
Packit 6c4009
  else
Packit 6c4009
    {
Packit 6c4009
      file_offset += sizeof (struct utmp);
Packit 6c4009
      pbuf = (struct utmp *) data;
Packit 6c4009
    }
Packit 6c4009
Packit 6c4009
 unlock_return:
Packit aa7b8c
  file_unlock (file_fd);
Packit 6c4009
Packit 6c4009
  return pbuf;
Packit 6c4009
}
Packit 6c4009
Packit 6c4009
Packit 078067
void
Packit 078067
__libc_endutent (void)
Packit 6c4009
{
Packit 078067
  if (file_fd >= 0)
Packit 078067
    {
Packit 078067
      __close_nocancel_nostatus (file_fd);
Packit 078067
      file_fd = -1;
Packit 078067
    }
Packit 6c4009
}
Packit 6c4009
Packit 6c4009
Packit 078067
int
Packit 078067
__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 25ee91
  if (try_file_lock (fd, F_WRLCK))
Packit aa7b8c
    {
Packit aa7b8c
      __close_nocancel_nostatus (fd);
Packit aa7b8c
      return -1;
Packit aa7b8c
    }
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 e44bc7
  file_unlock (fd);
Packit 6c4009
Packit 6c4009
  /* Close WTMP file.  */
Packit 6c4009
  __close_nocancel_nostatus (fd);
Packit 6c4009
Packit 6c4009
  return result;
Packit 6c4009
}