mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2026-02-04 22:20:27 +01:00
keyfile: move keyfile utilities from src/ to libnm-core/
These utilities are concerned with valid file names (as NetworkManager daemon requires it). This is relevant for everybody who wants to write keyfile files directly. Hence, move it to libnm-core. Still as internal API.
This commit is contained in:
Thomas Haller
parent
61717cc575
commit
410664967b
5 changed files with 135 additions and 134 deletions
|
|
@ -168,4 +168,14 @@ gboolean _nm_keyfile_a_contains_all_in_b (GKeyFile *kf_a, GKeyFile *kf_b);
|
|||
gboolean _nm_keyfile_equals (GKeyFile *kf_a, GKeyFile *kf_b, gboolean consider_order);
|
||||
gboolean _nm_keyfile_has_values (GKeyFile *keyfile);
|
||||
|
||||
/*****************************************************************************/
|
||||
|
||||
#define NM_CONFIG_KEYFILE_PATH_IN_MEMORY NMRUNDIR "/system-connections"
|
||||
|
||||
#define NMS_KEYFILE_PATH_SUFFIX_NMCONNECTION ".nmconnection"
|
||||
|
||||
gboolean nms_keyfile_utils_should_ignore_file (const char *filename, gboolean require_extension);
|
||||
|
||||
char *nms_keyfile_utils_escape_filename (const char *filename, gboolean with_extension);
|
||||
|
||||
#endif /* __NM_KEYFILE_INTERNAL_H__ */
|
||||
|
|
|
|||
|
|
@ -3153,3 +3153,127 @@ nm_keyfile_write (NMConnection *connection,
|
|||
|
||||
return info.keyfile;
|
||||
}
|
||||
|
||||
/*****************************************************************************/
|
||||
|
||||
static const char temp_letters[] =
|
||||
"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
|
||||
|
||||
/*
|
||||
* Check '.[a-zA-Z0-9]{6}' file suffix used for temporary files by g_file_set_contents() (mkstemp()).
|
||||
*/
|
||||
static gboolean
|
||||
check_mkstemp_suffix (const char *path)
|
||||
{
|
||||
const char *ptr;
|
||||
|
||||
g_return_val_if_fail (path != NULL, FALSE);
|
||||
|
||||
/* Matches *.[a-zA-Z0-9]{6} suffix of mkstemp()'s temporary files */
|
||||
ptr = strrchr (path, '.');
|
||||
if (ptr && (strspn (ptr + 1, temp_letters) == 6) && (! ptr[7]))
|
||||
return TRUE;
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
static gboolean
|
||||
check_prefix_dot (const char *base)
|
||||
{
|
||||
nm_assert (base && base[0]);
|
||||
|
||||
return base[0] == '.';
|
||||
}
|
||||
|
||||
static gboolean
|
||||
check_suffix (const char *base, const char *tag)
|
||||
{
|
||||
int len, tag_len;
|
||||
|
||||
g_return_val_if_fail (base != NULL, TRUE);
|
||||
g_return_val_if_fail (tag != NULL, TRUE);
|
||||
|
||||
len = strlen (base);
|
||||
tag_len = strlen (tag);
|
||||
if ((len > tag_len) && !g_ascii_strcasecmp (base + len - tag_len, tag))
|
||||
return TRUE;
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
#define SWP_TAG ".swp"
|
||||
#define SWPX_TAG ".swpx"
|
||||
#define PEM_TAG ".pem"
|
||||
#define DER_TAG ".der"
|
||||
|
||||
gboolean
|
||||
nms_keyfile_utils_should_ignore_file (const char *filename, gboolean require_extension)
|
||||
{
|
||||
gs_free char *base = NULL;
|
||||
|
||||
g_return_val_if_fail (filename != NULL, TRUE);
|
||||
|
||||
base = g_path_get_basename (filename);
|
||||
g_return_val_if_fail (base != NULL, TRUE);
|
||||
|
||||
/* Ignore hidden and backup files */
|
||||
/* should_ignore_file() must mirror escape_filename() */
|
||||
if (check_prefix_dot (base) || check_suffix (base, "~"))
|
||||
return TRUE;
|
||||
/* Ignore temporary files */
|
||||
if (check_mkstemp_suffix (base))
|
||||
return TRUE;
|
||||
/* Ignore 802.1x certificates and keys */
|
||||
if (check_suffix (base, PEM_TAG) || check_suffix (base, DER_TAG))
|
||||
return TRUE;
|
||||
|
||||
if (require_extension) {
|
||||
gsize l = strlen (base);
|
||||
|
||||
if ( l <= NM_STRLEN (NMS_KEYFILE_PATH_SUFFIX_NMCONNECTION)
|
||||
|| !g_str_has_suffix (base, NMS_KEYFILE_PATH_SUFFIX_NMCONNECTION))
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
char *
|
||||
nms_keyfile_utils_escape_filename (const char *filename,
|
||||
gboolean with_extension)
|
||||
{
|
||||
GString *str;
|
||||
const char *f = filename;
|
||||
/* keyfile used to escape with '*', do not change that behavior.
|
||||
*
|
||||
* But for newly added escapings, use '_' instead.
|
||||
* Also, @with_extension is new-style. */
|
||||
const char ESCAPE_CHAR = with_extension ? '_' : '*';
|
||||
const char ESCAPE_CHAR2 = '_';
|
||||
|
||||
g_return_val_if_fail (filename && filename[0], NULL);
|
||||
|
||||
str = g_string_sized_new (60);
|
||||
|
||||
/* Convert '/' to ESCAPE_CHAR */
|
||||
for (f = filename; f[0]; f++) {
|
||||
if (f[0] == '/')
|
||||
g_string_append_c (str, ESCAPE_CHAR);
|
||||
else
|
||||
g_string_append_c (str, f[0]);
|
||||
}
|
||||
|
||||
/* escape_filename() must avoid anything that should_ignore_file() would reject.
|
||||
* We can escape here more aggressivly then what we would read back. */
|
||||
if (check_prefix_dot (str->str))
|
||||
str->str[0] = ESCAPE_CHAR2;
|
||||
if (check_suffix (str->str, "~"))
|
||||
str->str[str->len - 1] = ESCAPE_CHAR2;
|
||||
if ( check_mkstemp_suffix (str->str)
|
||||
|| check_suffix (str->str, PEM_TAG)
|
||||
|| check_suffix (str->str, DER_TAG))
|
||||
g_string_append_c (str, ESCAPE_CHAR2);
|
||||
|
||||
if (with_extension)
|
||||
g_string_append (str, NMS_KEYFILE_PATH_SUFFIX_NMCONNECTION);
|
||||
|
||||
return g_string_free (str, FALSE);;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -36,6 +36,7 @@
|
|||
#include "nm-utils.h"
|
||||
#include "nm-config.h"
|
||||
#include "nm-core-internal.h"
|
||||
#include "nm-keyfile-internal.h"
|
||||
|
||||
#include "settings/nm-settings-plugin.h"
|
||||
|
||||
|
|
|
|||
|
|
@ -35,88 +35,6 @@
|
|||
|
||||
/*****************************************************************************/
|
||||
|
||||
static const char temp_letters[] =
|
||||
"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
|
||||
|
||||
/*
|
||||
* Check '.[a-zA-Z0-9]{6}' file suffix used for temporary files by g_file_set_contents() (mkstemp()).
|
||||
*/
|
||||
static gboolean
|
||||
check_mkstemp_suffix (const char *path)
|
||||
{
|
||||
const char *ptr;
|
||||
|
||||
g_return_val_if_fail (path != NULL, FALSE);
|
||||
|
||||
/* Matches *.[a-zA-Z0-9]{6} suffix of mkstemp()'s temporary files */
|
||||
ptr = strrchr (path, '.');
|
||||
if (ptr && (strspn (ptr + 1, temp_letters) == 6) && (! ptr[7]))
|
||||
return TRUE;
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
static gboolean
|
||||
check_prefix_dot (const char *base)
|
||||
{
|
||||
nm_assert (base && base[0]);
|
||||
|
||||
return base[0] == '.';
|
||||
}
|
||||
|
||||
static gboolean
|
||||
check_suffix (const char *base, const char *tag)
|
||||
{
|
||||
int len, tag_len;
|
||||
|
||||
g_return_val_if_fail (base != NULL, TRUE);
|
||||
g_return_val_if_fail (tag != NULL, TRUE);
|
||||
|
||||
len = strlen (base);
|
||||
tag_len = strlen (tag);
|
||||
if ((len > tag_len) && !g_ascii_strcasecmp (base + len - tag_len, tag))
|
||||
return TRUE;
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
#define SWP_TAG ".swp"
|
||||
#define SWPX_TAG ".swpx"
|
||||
#define PEM_TAG ".pem"
|
||||
#define DER_TAG ".der"
|
||||
|
||||
gboolean
|
||||
nms_keyfile_utils_should_ignore_file (const char *filename, gboolean require_extension)
|
||||
{
|
||||
gs_free char *base = NULL;
|
||||
|
||||
g_return_val_if_fail (filename != NULL, TRUE);
|
||||
|
||||
base = g_path_get_basename (filename);
|
||||
g_return_val_if_fail (base != NULL, TRUE);
|
||||
|
||||
/* Ignore hidden and backup files */
|
||||
/* should_ignore_file() must mirror escape_filename() */
|
||||
if (check_prefix_dot (base) || check_suffix (base, "~"))
|
||||
return TRUE;
|
||||
/* Ignore temporary files */
|
||||
if (check_mkstemp_suffix (base))
|
||||
return TRUE;
|
||||
/* Ignore 802.1x certificates and keys */
|
||||
if (check_suffix (base, PEM_TAG) || check_suffix (base, DER_TAG))
|
||||
return TRUE;
|
||||
|
||||
if (require_extension) {
|
||||
gsize l = strlen (base);
|
||||
|
||||
if ( l <= NM_STRLEN (NMS_KEYFILE_PATH_SUFFIX_NMCONNECTION)
|
||||
|| !g_str_has_suffix (base, NMS_KEYFILE_PATH_SUFFIX_NMCONNECTION))
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
/*****************************************************************************/
|
||||
|
||||
gboolean
|
||||
nms_keyfile_utils_check_file_permissions_stat (const struct stat *st,
|
||||
GError **error)
|
||||
|
|
@ -174,50 +92,6 @@ nms_keyfile_utils_check_file_permissions (const char *filename,
|
|||
|
||||
/*****************************************************************************/
|
||||
|
||||
char *
|
||||
nms_keyfile_utils_escape_filename (const char *filename,
|
||||
gboolean with_extension)
|
||||
{
|
||||
GString *str;
|
||||
const char *f = filename;
|
||||
/* keyfile used to escape with '*', do not change that behavior.
|
||||
*
|
||||
* But for newly added escapings, use '_' instead.
|
||||
* Also, @with_extension is new-style. */
|
||||
const char ESCAPE_CHAR = with_extension ? '_' : '*';
|
||||
const char ESCAPE_CHAR2 = '_';
|
||||
|
||||
g_return_val_if_fail (filename && filename[0], NULL);
|
||||
|
||||
str = g_string_sized_new (60);
|
||||
|
||||
/* Convert '/' to ESCAPE_CHAR */
|
||||
for (f = filename; f[0]; f++) {
|
||||
if (f[0] == '/')
|
||||
g_string_append_c (str, ESCAPE_CHAR);
|
||||
else
|
||||
g_string_append_c (str, f[0]);
|
||||
}
|
||||
|
||||
/* escape_filename() must avoid anything that should_ignore_file() would reject.
|
||||
* We can escape here more aggressivly then what we would read back. */
|
||||
if (check_prefix_dot (str->str))
|
||||
str->str[0] = ESCAPE_CHAR2;
|
||||
if (check_suffix (str->str, "~"))
|
||||
str->str[str->len - 1] = ESCAPE_CHAR2;
|
||||
if ( check_mkstemp_suffix (str->str)
|
||||
|| check_suffix (str->str, PEM_TAG)
|
||||
|| check_suffix (str->str, DER_TAG))
|
||||
g_string_append_c (str, ESCAPE_CHAR2);
|
||||
|
||||
if (with_extension)
|
||||
g_string_append (str, NMS_KEYFILE_PATH_SUFFIX_NMCONNECTION);
|
||||
|
||||
return g_string_free (str, FALSE);;
|
||||
}
|
||||
|
||||
/*****************************************************************************/
|
||||
|
||||
const char *
|
||||
nms_keyfile_utils_get_path (void)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -23,20 +23,12 @@
|
|||
|
||||
#include "NetworkManagerUtils.h"
|
||||
|
||||
#define NM_CONFIG_KEYFILE_PATH_IN_MEMORY NMRUNDIR "/system-connections"
|
||||
|
||||
#define NMS_KEYFILE_PATH_SUFFIX_NMCONNECTION ".nmconnection"
|
||||
|
||||
#define NMS_KEYFILE_CONNECTION_LOG_PATH(path) ((path) ?: "in-memory")
|
||||
#define NMS_KEYFILE_CONNECTION_LOG_FMT "%s (%s,\"%s\")"
|
||||
#define NMS_KEYFILE_CONNECTION_LOG_ARG(con) NMS_KEYFILE_CONNECTION_LOG_PATH (nm_settings_connection_get_filename ((NMSettingsConnection *) (con))), nm_settings_connection_get_uuid ((NMSettingsConnection *) (con)), nm_settings_connection_get_id ((NMSettingsConnection *) (con))
|
||||
#define NMS_KEYFILE_CONNECTION_LOG_FMTD "%s (%s,\"%s\",%p)"
|
||||
#define NMS_KEYFILE_CONNECTION_LOG_ARGD(con) NMS_KEYFILE_CONNECTION_LOG_PATH (nm_settings_connection_get_filename ((NMSettingsConnection *) (con))), nm_settings_connection_get_uuid ((NMSettingsConnection *) (con)), nm_settings_connection_get_id ((NMSettingsConnection *) (con)), (con)
|
||||
|
||||
gboolean nms_keyfile_utils_should_ignore_file (const char *filename, gboolean require_extension);
|
||||
|
||||
char *nms_keyfile_utils_escape_filename (const char *filename, gboolean with_extension);
|
||||
|
||||
const char *nms_keyfile_utils_get_path (void);
|
||||
|
||||
struct stat;
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue