util-systemd.c

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT-0 */
 
/* Implement the systemd notify protocol without external dependencies.
 * Supports both readiness notification on startup and on reloading,
 * according to the protocol defined at:
 * https://www.freedesktop.org/software/systemd/man/latest/sd_notify.html
 * This protocol is guaranteed to be stable as per:
 * https://systemd.io/PORTABILITY_AND_STABILITY/ */
 
/* this file is copied from:
 * https://github.com/systemd/systemd/blob/main/man/notify-selfcontained-example.c
 * written by Luca Boccassi */
 
#include "suricata-common.h"
 
#if (defined SYSTEMD_NOTIFY) && (defined HAVE_SYS_UN_H) && (defined HAVE_SYS_STAT_H) &&            \
        (defined HAVE_SYS_TYPES_H)
#include <sys/un.h>
#include <sys/stat.h>
#include <sys/types.h>
 
#include "util-systemd.h"
 
#define _cleanup_(f) __attribute__((cleanup(f)))
 
static void closep(int *fd)
{
    if (!fd || *fd < 0)
        return;
 
    close(*fd);
    *fd = -1;
}
 
static int Notify(const char *message)
{
    union sockaddr_union {
        struct sockaddr sa;
        struct sockaddr_un sun;
    } socket_addr = {
        .sun.sun_family = AF_UNIX,
    };
    size_t path_length, message_length;
    _cleanup_(closep) int fd = -1;
    const char *socket_path;
 
    socket_path = getenv("NOTIFY_SOCKET");
    if (!socket_path)
        return 0; /* Not running under systemd? Nothing to do */
 
    if (!message)
        return -EINVAL;
 
    message_length = strlen(message);
    if (message_length == 0)
        return -EINVAL;
 
    /* Only AF_UNIX is supported, with path or abstract sockets */
    if (socket_path[0] != '/' && socket_path[0] != '@')
        return -EAFNOSUPPORT;
 
    path_length = strlen(socket_path);
    /* Ensure there is room for NUL byte */
    if (path_length >= sizeof(socket_addr.sun.sun_path))
        return -E2BIG;
 
    memcpy(socket_addr.sun.sun_path, socket_path, path_length);
 
    /* Support for abstract socket */
    if (socket_addr.sun.sun_path[0] == '@')
        socket_addr.sun.sun_path[0] = 0;
 
    fd = socket(AF_UNIX, SOCK_DGRAM | SOCK_CLOEXEC, 0);
    if (fd < 0)
        return -errno;
 
    if (connect(fd, &socket_addr.sa, offsetof(struct sockaddr_un, sun_path) + path_length) != 0)
        return -errno;
 
    ssize_t written = write(fd, message, message_length);
    if (written != (ssize_t)message_length)
        return written < 0 ? -errno : -EPROTO;
 
    return 1; /* Notified! */
}
 
int SystemDNotifyReady(void)
{
    return Notify("READY=1");
}
#endif