-/* SPDX-License-Identifier: LGPL-2.1+ */
+/* SPDX-License-Identifier: LGPL-2.1-or-later */
#include <errno.h>
#include <stdbool.h>
#include "alloc-util.h"
#include "architecture.h"
+#include "chase-symlinks.h"
+#include "fd-util.h"
#include "format-util.h"
#include "fs-util.h"
#include "hostname-util.h"
+#include "id128-util.h"
#include "macro.h"
#include "os-util.h"
+#include "path-util.h"
#include "specifier.h"
#include "string-util.h"
#include "strv.h"
+#include "unit-file.h"
#include "user-util.h"
/*
* and "%" used for escaping. */
#define POSSIBLE_SPECIFIERS ALPHANUMERICAL "%"
-int specifier_printf(const char *text, const Specifier table[], const void *userdata, char **_ret) {
- size_t l, allocated = 0;
- _cleanup_free_ char *ret = NULL;
- char *t;
- const char *f;
+int specifier_printf(const char *text, size_t max_length, const Specifier table[], const char *root, const void *userdata, char **ret) {
+ _cleanup_free_ char *result = NULL;
bool percent = false;
+ size_t l;
+ char *t;
int r;
+ assert(ret);
assert(text);
assert(table);
l = strlen(text);
- if (!GREEDY_REALLOC(ret, allocated, l + 1))
+ if (!GREEDY_REALLOC(result, l + 1))
return -ENOMEM;
- t = ret;
+ t = result;
- for (f = text; *f; f++, l--)
+ for (const char *f = text; *f != '\0'; f++, l--) {
if (percent) {
+ percent = false;
+
if (*f == '%')
*(t++) = '%';
else {
_cleanup_free_ char *w = NULL;
size_t k, j;
- r = i->lookup(i->specifier, i->data, userdata, &w);
+ r = i->lookup(i->specifier, i->data, root, userdata, &w);
if (r < 0)
return r;
+ if (isempty(w))
+ continue;
- j = t - ret;
+ j = t - result;
k = strlen(w);
- if (!GREEDY_REALLOC(ret, allocated, j + k + l + 1))
+ if (!GREEDY_REALLOC(result, j + k + l + 1))
return -ENOMEM;
- memcpy(ret + j, w, k);
- t = ret + j + k;
+ memcpy(result + j, w, k);
+ t = result + j + k;
} else if (strchr(POSSIBLE_SPECIFIERS, *f))
/* Oops, an unknown specifier. */
return -EBADSLT;
*(t++) = *f;
}
}
-
- percent = false;
} else if (*f == '%')
percent = true;
else
*(t++) = *f;
+ if ((size_t) (t - result) > max_length)
+ return -ENAMETOOLONG;
+ }
+
/* If string ended with a stray %, also end with % */
- if (percent)
+ if (percent) {
*(t++) = '%';
- *(t++) = 0;
-
- /* Try to deallocate unused bytes, but don't sweat it too much */
- if ((size_t)(t - ret) < allocated) {
- t = realloc(ret, t - ret);
- if (t)
- ret = t;
+ if ((size_t) (t - result) > max_length)
+ return -ENAMETOOLONG;
}
+ *(t++) = 0;
- *_ret = TAKE_PTR(ret);
+ *ret = TAKE_PTR(result);
return 0;
}
/* Generic handler for simple string replacements */
-int specifier_string(char specifier, const void *data, const void *userdata, char **ret) {
- char *n;
+int specifier_string(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ char *n = NULL;
- n = strdup(strempty(data));
- if (!n)
- return -ENOMEM;
+ assert(ret);
+
+ if (!isempty(data)) {
+ n = strdup(data);
+ if (!n)
+ return -ENOMEM;
+ }
*ret = n;
return 0;
}
-int specifier_machine_id(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_real_path(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ const char *path = data;
+
+ assert(ret);
+
+ if (!path)
+ return -ENOENT;
+
+ return chase_symlinks(path, root, 0, ret, NULL);
+}
+
+int specifier_real_directory(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ _cleanup_free_ char *path = NULL;
+ int r;
+
+ assert(ret);
+
+ r = specifier_real_path(specifier, data, root, userdata, &path);
+ if (r < 0)
+ return r;
+
+ assert(path);
+ return path_extract_directory(path, ret);
+}
+
+int specifier_machine_id(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
sd_id128_t id;
char *n;
int r;
- r = sd_id128_get_machine(&id);
+ assert(ret);
+
+ if (root) {
+ _cleanup_close_ int fd = -1;
+
+ fd = chase_symlinks_and_open("/etc/machine-id", root, CHASE_PREFIX_ROOT, O_RDONLY|O_CLOEXEC|O_NOCTTY, NULL);
+ if (fd < 0)
+ /* Translate error for missing os-release file to EUNATCH. */
+ return fd == -ENOENT ? -EUNATCH : fd;
+
+ r = id128_read_fd(fd, ID128_PLAIN, &id);
+ } else
+ r = sd_id128_get_machine(&id);
if (r < 0)
return r;
- n = new(char, 33);
+ n = new(char, SD_ID128_STRING_MAX);
if (!n)
return -ENOMEM;
return 0;
}
-int specifier_boot_id(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_boot_id(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
sd_id128_t id;
char *n;
int r;
+ assert(ret);
+
r = sd_id128_get_boot(&id);
if (r < 0)
return r;
- n = new(char, 33);
+ n = new(char, SD_ID128_STRING_MAX);
if (!n)
return -ENOMEM;
return 0;
}
-int specifier_host_name(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_host_name(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
char *n;
+ assert(ret);
+
n = gethostname_malloc();
if (!n)
return -ENOMEM;
return 0;
}
-int specifier_short_host_name(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_short_host_name(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
char *n;
+ assert(ret);
+
n = gethostname_short_malloc();
if (!n)
return -ENOMEM;
return 0;
}
-int specifier_kernel_release(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_pretty_host_name(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ char *n = NULL;
+
+ assert(ret);
+
+ if (get_pretty_hostname(&n) < 0) {
+ n = gethostname_short_malloc();
+ if (!n)
+ return -ENOMEM;
+ }
+
+ *ret = n;
+ return 0;
+}
+
+int specifier_kernel_release(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
struct utsname uts;
char *n;
- int r;
- r = uname(&uts);
- if (r < 0)
+ assert(ret);
+
+ if (uname(&uts) < 0)
return -errno;
n = strdup(uts.release);
return 0;
}
-int specifier_architecture(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_architecture(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
char *t;
+ assert(ret);
+
t = strdup(architecture_to_string(uname_architecture()));
if (!t)
return -ENOMEM;
return 0;
}
-static int specifier_os_release_common(const char *field, char **ret) {
- char *t = NULL;
+/* Note: fields in /etc/os-release might quite possibly be missing, even if everything is entirely valid
+ * otherwise. We'll return an empty value or NULL in that case from the functions below. But if the
+ * os-release file is missing, we'll return -EUNATCH. This means that something is seriously wrong with the
+ * installation. */
+
+static int parse_os_release_specifier(const char *root, const char *id, char **ret) {
int r;
- r = parse_os_release(NULL, field, &t, NULL);
- if (r < 0)
- return r;
- if (!t) {
- /* fields in /etc/os-release might quite possibly be missing, even if everything is entirely
- * valid otherwise. Let's hence return "" in that case. */
- t = strdup("");
- if (!t)
- return -ENOMEM;
- }
+ assert(ret);
- *ret = t;
- return 0;
+ /* Translate error for missing os-release file to EUNATCH. */
+ r = parse_os_release(root, id, ret);
+ return r == -ENOENT ? -EUNATCH : r;
+}
+
+int specifier_os_id(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ return parse_os_release_specifier(root, "ID", ret);
+}
+
+int specifier_os_version_id(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ return parse_os_release_specifier(root, "VERSION_ID", ret);
}
-int specifier_os_id(char specifier, const void *data, const void *userdata, char **ret) {
- return specifier_os_release_common("ID", ret);
+int specifier_os_build_id(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ return parse_os_release_specifier(root, "BUILD_ID", ret);
}
-int specifier_os_version_id(char specifier, const void *data, const void *userdata, char **ret) {
- return specifier_os_release_common("VERSION_ID", ret);
+int specifier_os_variant_id(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ return parse_os_release_specifier(root, "VARIANT_ID", ret);
}
-int specifier_os_build_id(char specifier, const void *data, const void *userdata, char **ret) {
- return specifier_os_release_common("BUILD_ID", ret);
+int specifier_os_image_id(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ return parse_os_release_specifier(root, "IMAGE_ID", ret);
}
-int specifier_os_variant_id(char specifier, const void *data, const void *userdata, char **ret) {
- return specifier_os_release_common("VARIANT_ID", ret);
+int specifier_os_image_version(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ return parse_os_release_specifier(root, "IMAGE_VERSION", ret);
}
-int specifier_group_name(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_group_name(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ UnitFileScope scope = PTR_TO_INT(data);
char *t;
- t = gid_to_name(getgid());
+ assert(ret);
+
+ if (scope == UNIT_FILE_GLOBAL)
+ return -EINVAL;
+
+ t = gid_to_name(scope == UNIT_FILE_USER ? getgid() : 0);
if (!t)
return -ENOMEM;
return 0;
}
-int specifier_group_id(char specifier, const void *data, const void *userdata, char **ret) {
- if (asprintf(ret, UID_FMT, getgid()) < 0)
+int specifier_group_id(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ UnitFileScope scope = PTR_TO_INT(data);
+ gid_t gid;
+
+ assert(ret);
+
+ if (scope == UNIT_FILE_GLOBAL)
+ return -EINVAL;
+
+ gid = scope == UNIT_FILE_USER ? getgid() : 0;
+
+ if (asprintf(ret, UID_FMT, gid) < 0)
return -ENOMEM;
return 0;
}
-int specifier_user_name(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_user_name(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ UnitFileScope scope = PTR_TO_INT(data);
+ uid_t uid;
char *t;
- /* If we are UID 0 (root), this will not result in NSS, otherwise it might. This is good, as we want to be able
- * to run this in PID 1, where our user ID is 0, but where NSS lookups are not allowed.
+ assert(ret);
+
+ if (scope == UNIT_FILE_GLOBAL)
+ return -EINVAL;
+
+ uid = scope == UNIT_FILE_USER ? getuid() : 0;
+
+ /* If we are UID 0 (root), this will not result in NSS, otherwise it might. This is good, as we want
+ * to be able to run this in PID 1, where our user ID is 0, but where NSS lookups are not allowed.
- * We don't use getusername_malloc() here, because we don't want to look at $USER, to remain consistent with
- * specifer_user_id() below.
+ * We don't use getusername_malloc() here, because we don't want to look at $USER, to remain
+ * consistent with specifer_user_id() below.
*/
- t = uid_to_name(getuid());
+ t = uid_to_name(uid);
if (!t)
return -ENOMEM;
return 0;
}
-int specifier_user_id(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_user_id(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ UnitFileScope scope = PTR_TO_INT(data);
+ uid_t uid;
+
+ assert(ret);
+
+ if (scope == UNIT_FILE_GLOBAL)
+ return -EINVAL;
- if (asprintf(ret, UID_FMT, getuid()) < 0)
+ uid = scope == UNIT_FILE_USER ? getuid() : 0;
+
+ if (asprintf(ret, UID_FMT, uid) < 0)
return -ENOMEM;
return 0;
}
-int specifier_user_home(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_user_home(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ assert(ret);
/* On PID 1 (which runs as root) this will not result in NSS,
* which is good. See above */
return get_home_dir(ret);
}
-int specifier_user_shell(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_user_shell(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
+ assert(ret);
/* On PID 1 (which runs as root) this will not result in NSS,
* which is good. See above */
return get_shell(ret);
}
-int specifier_tmp_dir(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_tmp_dir(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
const char *p;
char *copy;
int r;
- r = tmp_dir(&p);
- if (r < 0)
- return r;
+ assert(ret);
+ if (root) /* If root dir is set, don't honour $TMP or similar */
+ p = "/tmp";
+ else {
+ r = tmp_dir(&p);
+ if (r < 0)
+ return r;
+ }
copy = strdup(p);
if (!copy)
return -ENOMEM;
return 0;
}
-int specifier_var_tmp_dir(char specifier, const void *data, const void *userdata, char **ret) {
+int specifier_var_tmp_dir(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
const char *p;
char *copy;
int r;
- r = var_tmp_dir(&p);
- if (r < 0)
- return r;
+ assert(ret);
+ if (root)
+ p = "/var/tmp";
+ else {
+ r = var_tmp_dir(&p);
+ if (r < 0)
+ return r;
+ }
copy = strdup(p);
if (!copy)
return -ENOMEM;
return 0;
}
+
+const Specifier system_and_tmp_specifier_table[] = {
+ COMMON_SYSTEM_SPECIFIERS,
+ COMMON_TMP_SPECIFIERS,
+ {}
+};