xrdp/sesman/sesexec/sessionrecord.c

/**
 * xrdp: A Remote Desktop Protocol server.
 *
 * Copyright (C) Emmanuel Blindauer 2017
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * str2memcpy() is taken from util-linux/include/strutils.h v2.39 which
 * has the following header:-
 *
 *     No copyright is claimed.  This code is in the public domain; do with
 *     it what you wish.
 */

/**
 *
 * @file sessionrecord.c
 * @brief utmp handling code
 *
 * wtmp/lastlog/btmp is handled by PAM or (on FreeBSD) UTX
 *
 * Idea: Only implement actual utmp, i.e. utmpx for 99%.
 *       See http://80386.nl/unix/utmpx/
 */

#if defined(HAVE_CONFIG_H)
#include <config_ac.h>
#endif

#include <ctype.h>

#include "sessionrecord.h"
#include "login_info.h"
#include "log.h"

// Operational mode of add_xtmp_entry()
//
// We can't use USER_PROCESS/DEAD_PROCESS directly, as they
// won't be available for platforms without USE_UTMP
enum add_xtmp_mode
{
    MODE_LOGIN,
    MODE_LOGOUT
};

#ifdef USE_UTMP

#include <sys/time.h>
#include <string.h>
#include <unistd.h>

#ifdef HAVE_UTMPX_H
#include <utmpx.h>
typedef struct utmpx _utmp;
#else
#include <utmp.h>
typedef struct utmp _utmp;
#endif

#include "os_calls.h"
#include "string_calls.h"

#define XRDP_LINE_FORMAT "xrdp:%s"
// ut_id is a very small field on some platforms, so use the display
// number in hex
#define XRDP_ID_FORMAT ":%x"

/******************************************************************************/
/**
 * utmp-specific strncpy() replacement
 *
 * @param dest Destination pointer
 * @param src Source pointer
 * @param n bytes to copy
 *
 * This is like strncpy(), but based on memcpy(), so compilers and static
 * analyzers do not complain when sizeof(destination) is the same as 'n' and
 * result is not terminated by zero.
 *
 *  ONLY use this function to copy string to logs with fixed sizes
 *  (wtmp/utmp. ...)  where string terminator is optional.
 */
static inline void *__attribute__((nonnull (1)))
str2memcpy(void *dest, const char *src, size_t n)
{
    size_t bytes = strlen(src) + 1;

    if (bytes > n)
    {
        bytes = n;
    }

    memcpy(dest, src, bytes);
    return dest;
}

/******************************************************************************/
/**
 * Get a display number from the display string
 *
 * Converts the display string to some sort of number to write to the
 * extremely short ut_id field
 * @param display string
 * @return display number
 */
static unsigned int
get_display_num(const char *display)
{
    unsigned int result = 0;
    /* Look for the first digit in the string */
    while (*display != '\0' && !isdigit(*display))
    {
        ++display;
    }
    /* convert consecutive digits to a number */
    while (*display != '\0' && isdigit(*display))
    {
        result = (result * 10) + (*display - '0');
        ++display;
    }

    return result;
}

/******************************************************************************/
/**
 * Prepare the utmp struct and write it.
 *
 * @param pid PID of session manager
 * @param display Display number of session
 * @param login_info Login info (NULL for MODE_LOGOUT)
 * @param mode see enum add_xtmp_mode
 * @param e Exit status (NULL unless MODE_LOGOUT)
 */

static void
add_xtmp_entry(int pid, const char *display,
               const struct login_info *login_info,
               enum add_xtmp_mode mode, const struct proc_exit_status *e)
{
    _utmp ut;
    /* For some string fields, use a formatting buffer one character larger
     * than the eventual destination. This lets us use normal string
     * functions to create the strings, and the terminator can then
     * be omitted (if necessary) when filling in 'ut' */
    char idbuff[sizeof(ut.ut_id) + 1];
    char linebuff[sizeof(ut.ut_line) + 1];

    struct timeval tv;

    /* Convert the display string to a number */
    unsigned int display_num = get_display_num(display);

    g_memset(&ut, 0, sizeof(ut));
    g_snprintf(idbuff, sizeof(idbuff), XRDP_ID_FORMAT, display_num);
    g_snprintf(linebuff, sizeof(linebuff), XRDP_LINE_FORMAT, display);
    gettimeofday(&tv, NULL);

    ut.ut_type = (mode == MODE_LOGIN) ? USER_PROCESS : DEAD_PROCESS;
    ut.ut_pid = pid;
    str2memcpy(ut.ut_id, idbuff, sizeof(ut.ut_id));

    // Linux utmp(5) suggests ut_line, ut_time, ut_user, and ut_host
    // are not set for a DEAD_PROCESS
    if (ut.ut_type != DEAD_PROCESS)
    {
        ut.ut_tv.tv_sec = tv.tv_sec;
        ut.ut_tv.tv_usec = tv.tv_usec;
        str2memcpy(ut.ut_line, linebuff, sizeof(ut.ut_line));
        if (login_info != NULL)
        {
            str2memcpy(ut.ut_user, login_info->username, sizeof(ut.ut_user));
#ifdef HAVE_UTMPX_UT_HOST
            str2memcpy(ut.ut_host, login_info->ip_addr, sizeof(ut.ut_host));
#endif
        }
    }

#ifdef HAVE_UTMPX_UT_EXIT
    if (e != NULL && e->reason == E_PXR_STATUS_CODE)
    {
        ut.ut_exit.e_exit = e->val;
    }
    else if (e != NULL && e->reason == E_PXR_SIGNAL)
    {
        ut.ut_exit.e_termination = e->val;
    }
#endif

    /* update the utmp file */
    /* open utmp */
    setutxent();
    /* add the computed entry */
    pututxline(&ut);
    /* closes utmp */
    endutxent();

}
#else // USE_UTMP
static void
add_xtmp_entry(int pid, const char *display,
               const struct login_info *login_info,
               short state, const struct proc_exit_status *e)
{
}
#endif


/******************************************************************************/
void
utmp_login(int pid, const char *display,
           const struct login_info *login_info)
{
    log_message(LOG_LEVEL_DEBUG,
                "adding login info for utmp: %d - %s - %s - %s",
                pid, display, login_info->username, login_info->ip_addr);

    add_xtmp_entry(pid, display, login_info, MODE_LOGIN, NULL);
}

/******************************************************************************/
void
utmp_logout(int pid, const char *display,
            const struct proc_exit_status *exit_status)
{

    log_message(LOG_LEVEL_DEBUG, "adding logout info for utmp: %d - %s",
                pid, display);

    add_xtmp_entry(pid, display, NULL, MODE_LOGOUT, exit_status);
}