|
Packit Service |
dff8e4 |
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
Packit Service |
dff8e4 |
/*
|
|
Packit Service |
dff8e4 |
* Copyright (C) 2005 - 2017 Red Hat, Inc.
|
|
Packit Service |
dff8e4 |
*/
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
#ifndef __NM_UTILS_H__
|
|
Packit Service |
dff8e4 |
#define __NM_UTILS_H__
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
#if !defined(__NETWORKMANAGER_H_INSIDE__) && !defined(NETWORKMANAGER_COMPILATION)
|
|
Packit Service |
dff8e4 |
#error "Only <NetworkManager.h> can be included directly."
|
|
Packit Service |
dff8e4 |
#endif
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
#include <glib.h>
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
#include "nm-core-enum-types.h"
|
|
Packit Service |
dff8e4 |
#include "nm-setting-sriov.h"
|
|
Packit Service |
dff8e4 |
#include "nm-setting-tc-config.h"
|
|
Packit Service |
dff8e4 |
#include "nm-setting-wireless-security.h"
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
G_BEGIN_DECLS
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
/*****************************************************************************/
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
typedef struct _NMVariantAttributeSpec NMVariantAttributeSpec;
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
/* SSID helpers */
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_is_empty_ssid(const guint8 *ssid, gsize len);
|
|
Packit Service |
dff8e4 |
const char *nm_utils_escape_ssid(const guint8 *ssid, gsize len);
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_same_ssid(const guint8 *ssid1,
|
|
Packit Service |
dff8e4 |
gsize len1,
|
|
Packit Service |
dff8e4 |
const guint8 *ssid2,
|
|
Packit Service |
dff8e4 |
gsize len2,
|
|
Packit Service |
dff8e4 |
gboolean ignore_trailing_null);
|
|
Packit Service |
dff8e4 |
char * nm_utils_ssid_to_utf8(const guint8 *ssid, gsize len);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
/**
|
|
Packit Service |
dff8e4 |
* NMUtilsSecurityType:
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_INVALID: unknown or invalid security, placeholder and not used
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_NONE: unencrypted and open
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_STATIC_WEP: static WEP keys are used for encryption
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_LEAP: Cisco LEAP is used for authentication and for generating the
|
|
Packit Service |
dff8e4 |
* dynamic WEP keys automatically
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_DYNAMIC_WEP: standard 802.1x is used for authentication and
|
|
Packit Service |
dff8e4 |
* generating the dynamic WEP keys automatically
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_WPA_PSK: WPA1 is used with Pre-Shared Keys (PSK)
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_WPA_ENTERPRISE: WPA1 is used with 802.1x authentication
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_WPA2_PSK: WPA2/RSN is used with Pre-Shared Keys (PSK)
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_WPA2_ENTERPRISE: WPA2 is used with 802.1x authentication
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_SAE: is used with WPA3 Enterprise
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_OWE: is used with Enhanced Open
|
|
Packit Service |
dff8e4 |
* @NMU_SEC_WPA3_SUITE_B_192: is used with WPA3 Enterprise Suite-B 192 bit mode. Since: 1.30.
|
|
Packit Service |
dff8e4 |
*
|
|
Packit Service |
dff8e4 |
* Describes generic security mechanisms that 802.11 access points may offer.
|
|
Packit Service |
dff8e4 |
* Used with nm_utils_security_valid() for checking whether a given access
|
|
Packit Service |
dff8e4 |
* point is compatible with a network device.
|
|
Packit Service |
dff8e4 |
**/
|
|
Packit Service |
dff8e4 |
typedef enum {
|
|
Packit Service |
dff8e4 |
NMU_SEC_INVALID = 0,
|
|
Packit Service |
dff8e4 |
NMU_SEC_NONE,
|
|
Packit Service |
dff8e4 |
NMU_SEC_STATIC_WEP,
|
|
Packit Service |
dff8e4 |
NMU_SEC_LEAP,
|
|
Packit Service |
dff8e4 |
NMU_SEC_DYNAMIC_WEP,
|
|
Packit Service |
dff8e4 |
NMU_SEC_WPA_PSK,
|
|
Packit Service |
dff8e4 |
NMU_SEC_WPA_ENTERPRISE,
|
|
Packit Service |
dff8e4 |
NMU_SEC_WPA2_PSK,
|
|
Packit Service |
dff8e4 |
NMU_SEC_WPA2_ENTERPRISE,
|
|
Packit Service |
dff8e4 |
NMU_SEC_SAE,
|
|
Packit Service |
dff8e4 |
NMU_SEC_OWE,
|
|
Packit Service |
dff8e4 |
NMU_SEC_WPA3_SUITE_B_192,
|
|
Packit Service |
dff8e4 |
} NMUtilsSecurityType;
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_security_valid(NMUtilsSecurityType type,
|
|
Packit Service |
dff8e4 |
NMDeviceWifiCapabilities wifi_caps,
|
|
Packit Service |
dff8e4 |
gboolean have_ap,
|
|
Packit Service |
dff8e4 |
gboolean adhoc,
|
|
Packit Service |
dff8e4 |
NM80211ApFlags ap_flags,
|
|
Packit Service |
dff8e4 |
NM80211ApSecurityFlags ap_wpa,
|
|
Packit Service |
dff8e4 |
NM80211ApSecurityFlags ap_rsn);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_ap_mode_security_valid(NMUtilsSecurityType type,
|
|
Packit Service |
dff8e4 |
NMDeviceWifiCapabilities wifi_caps);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_wep_key_valid(const char *key, NMWepKeyType wep_type);
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_wpa_psk_valid(const char *psk);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_6
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_is_json_object(const char *str, GError **error);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
GVariant * nm_utils_ip4_dns_to_variant(char **dns);
|
|
Packit Service |
dff8e4 |
char ** nm_utils_ip4_dns_from_variant(GVariant *value);
|
|
Packit Service |
dff8e4 |
GVariant * nm_utils_ip4_addresses_to_variant(GPtrArray *addresses, const char *gateway);
|
|
Packit Service |
dff8e4 |
GPtrArray *nm_utils_ip4_addresses_from_variant(GVariant *value, char **out_gateway);
|
|
Packit Service |
dff8e4 |
GVariant * nm_utils_ip4_routes_to_variant(GPtrArray *routes);
|
|
Packit Service |
dff8e4 |
GPtrArray *nm_utils_ip4_routes_from_variant(GVariant *value);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
guint32 nm_utils_ip4_netmask_to_prefix(guint32 netmask);
|
|
Packit Service |
dff8e4 |
guint32 nm_utils_ip4_prefix_to_netmask(guint32 prefix);
|
|
Packit Service |
dff8e4 |
guint32 nm_utils_ip4_get_default_prefix(guint32 ip);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
GVariant * nm_utils_ip6_dns_to_variant(char **dns);
|
|
Packit Service |
dff8e4 |
char ** nm_utils_ip6_dns_from_variant(GVariant *value);
|
|
Packit Service |
dff8e4 |
GVariant * nm_utils_ip6_addresses_to_variant(GPtrArray *addresses, const char *gateway);
|
|
Packit Service |
dff8e4 |
GPtrArray *nm_utils_ip6_addresses_from_variant(GVariant *value, char **out_gateway);
|
|
Packit Service |
dff8e4 |
GVariant * nm_utils_ip6_routes_to_variant(GPtrArray *routes);
|
|
Packit Service |
dff8e4 |
GPtrArray *nm_utils_ip6_routes_from_variant(GVariant *value);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
GVariant * nm_utils_ip_addresses_to_variant(GPtrArray *addresses);
|
|
Packit Service |
dff8e4 |
GPtrArray *nm_utils_ip_addresses_from_variant(GVariant *value, int family);
|
|
Packit Service |
dff8e4 |
GVariant * nm_utils_ip_routes_to_variant(GPtrArray *routes);
|
|
Packit Service |
dff8e4 |
GPtrArray *nm_utils_ip_routes_from_variant(GVariant *value, int family);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
char *nm_utils_uuid_generate(void);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_file_is_certificate(const char *filename);
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_file_is_private_key(const char *filename, gboolean *out_encrypted);
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_file_is_pkcs12(const char *filename);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
typedef gboolean (*NMUtilsFileSearchInPathsPredicate)(const char *filename, gpointer user_data);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
struct stat;
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
typedef gboolean (*NMUtilsCheckFilePredicate)(const char * filename,
|
|
Packit Service |
dff8e4 |
const struct stat *stat,
|
|
Packit Service |
dff8e4 |
gpointer user_data,
|
|
Packit Service |
dff8e4 |
GError ** error);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
const char *nm_utils_file_search_in_paths(const char * progname,
|
|
Packit Service |
dff8e4 |
const char * try_first,
|
|
Packit Service |
dff8e4 |
const char *const * paths,
|
|
Packit Service |
dff8e4 |
GFileTest file_test_flags,
|
|
Packit Service |
dff8e4 |
NMUtilsFileSearchInPathsPredicate predicate,
|
|
Packit Service |
dff8e4 |
gpointer user_data,
|
|
Packit Service |
dff8e4 |
GError ** error);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
guint32 nm_utils_wifi_freq_to_channel(guint32 freq);
|
|
Packit Service |
dff8e4 |
guint32 nm_utils_wifi_channel_to_freq(guint32 channel, const char *band);
|
|
Packit Service |
dff8e4 |
guint32 nm_utils_wifi_find_next_channel(guint32 channel, int direction, char *band);
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_wifi_is_channel_valid(guint32 channel, const char *band);
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_2
|
|
Packit Service |
dff8e4 |
const guint *nm_utils_wifi_2ghz_freqs(void);
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_2
|
|
Packit Service |
dff8e4 |
const guint *nm_utils_wifi_5ghz_freqs(void);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
const char *nm_utils_wifi_strength_bars(guint8 strength);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
/**
|
|
Packit Service |
dff8e4 |
* NM_UTILS_HWADDR_LEN_MAX:
|
|
Packit Service |
dff8e4 |
*
|
|
Packit Service |
dff8e4 |
* The maximum length of hardware addresses handled by NetworkManager itself,
|
|
Packit Service |
dff8e4 |
* nm_utils_hwaddr_len(), and nm_utils_hwaddr_aton().
|
|
Packit Service |
dff8e4 |
*/
|
|
Packit Service |
dff8e4 |
#define NM_UTILS_HWADDR_LEN_MAX 20 /* INFINIBAND_ALEN */
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
gsize nm_utils_hwaddr_len(int type) G_GNUC_PURE;
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
char * nm_utils_hwaddr_ntoa(gconstpointer addr, gsize length);
|
|
Packit Service |
dff8e4 |
GByteArray *nm_utils_hwaddr_atoba(const char *asc, gsize length);
|
|
Packit Service |
dff8e4 |
guint8 * nm_utils_hwaddr_aton(const char *asc, gpointer buffer, gsize length);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_hwaddr_valid(const char *asc, gssize length);
|
|
Packit Service |
dff8e4 |
char * nm_utils_hwaddr_canonical(const char *asc, gssize length);
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_hwaddr_matches(gconstpointer hwaddr1,
|
|
Packit Service |
dff8e4 |
gssize hwaddr1_len,
|
|
Packit Service |
dff8e4 |
gconstpointer hwaddr2,
|
|
Packit Service |
dff8e4 |
gssize hwaddr2_len);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
char * nm_utils_bin2hexstr(gconstpointer src, gsize len, int final_len);
|
|
Packit Service |
dff8e4 |
GBytes *nm_utils_hexstr2bin(const char *hex);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_DEPRECATED_IN_1_6_FOR(nm_utils_is_valid_iface_name)
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_iface_valid_name(const char *name);
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_6
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_is_valid_iface_name(const char *name, GError **error);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_is_uuid(const char *str);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
/**
|
|
Packit Service |
dff8e4 |
* NM_UTILS_INET_ADDRSTRLEN:
|
|
Packit Service |
dff8e4 |
*
|
|
Packit Service |
dff8e4 |
* Defines the minimal length for a char buffer that is suitable as @dst argument
|
|
Packit Service |
dff8e4 |
* for both nm_utils_inet4_ntop() and nm_utils_inet6_ntop().
|
|
Packit Service |
dff8e4 |
**/
|
|
Packit Service |
dff8e4 |
#define NM_UTILS_INET_ADDRSTRLEN INET6_ADDRSTRLEN
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
const char *nm_utils_inet4_ntop(guint32 inaddr, char *dst);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
struct in6_addr;
|
|
Packit Service |
dff8e4 |
const char *nm_utils_inet6_ntop(const struct in6_addr *in6addr, char *dst);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_ipaddr_valid(int family, const char *ip);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_check_virtual_device_compatibility(GType virtual_type, GType other_type);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_2
|
|
Packit Service |
dff8e4 |
int nm_utils_bond_mode_string_to_int(const char *mode);
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_2
|
|
Packit Service |
dff8e4 |
const char *nm_utils_bond_mode_int_to_string(int mode);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_2
|
|
Packit Service |
dff8e4 |
char *nm_utils_enum_to_str(GType type, int value);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_2
|
|
Packit Service |
dff8e4 |
gboolean nm_utils_enum_from_str(GType type, const char *str, int *out_value, char **err_token);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_2
|
|
Packit Service |
dff8e4 |
const char **nm_utils_enum_get_values(GType type, int from, int to);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_6
|
|
Packit Service |
dff8e4 |
guint nm_utils_version(void);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_8
|
|
Packit Service |
dff8e4 |
GHashTable *nm_utils_parse_variant_attributes(const char *string,
|
|
Packit Service |
dff8e4 |
char attr_separator,
|
|
Packit Service |
dff8e4 |
char key_value_separator,
|
|
Packit Service |
dff8e4 |
gboolean ignore_unknown,
|
|
Packit Service |
dff8e4 |
const NMVariantAttributeSpec *const *spec,
|
|
Packit Service |
dff8e4 |
GError ** error);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_8
|
|
Packit Service |
dff8e4 |
char *nm_utils_format_variant_attributes(GHashTable *attributes,
|
|
Packit Service |
dff8e4 |
char attr_separator,
|
|
Packit Service |
dff8e4 |
char key_value_separator);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
/*****************************************************************************/
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_12
|
|
Packit Service |
dff8e4 |
NMTCQdisc *nm_utils_tc_qdisc_from_str(const char *str, GError **error);
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_12
|
|
Packit Service |
dff8e4 |
char *nm_utils_tc_qdisc_to_str(NMTCQdisc *qdisc, GError **error);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_12
|
|
Packit Service |
dff8e4 |
NMTCAction *nm_utils_tc_action_from_str(const char *str, GError **error);
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_12
|
|
Packit Service |
dff8e4 |
char *nm_utils_tc_action_to_str(NMTCAction *action, GError **error);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_12
|
|
Packit Service |
dff8e4 |
NMTCTfilter *nm_utils_tc_tfilter_from_str(const char *str, GError **error);
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_12
|
|
Packit Service |
dff8e4 |
char *nm_utils_tc_tfilter_to_str(NMTCTfilter *tfilter, GError **error);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
/*****************************************************************************/
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_14
|
|
Packit Service |
dff8e4 |
char *nm_utils_sriov_vf_to_str(const NMSriovVF *vf, gboolean omit_index, GError **error);
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_14
|
|
Packit Service |
dff8e4 |
NMSriovVF *nm_utils_sriov_vf_from_str(const char *str, GError **error);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
/*****************************************************************************/
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_12
|
|
Packit Service |
dff8e4 |
gint64 nm_utils_get_timestamp_msec(void);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
NM_AVAILABLE_IN_1_16
|
|
Packit Service |
dff8e4 |
gboolean
|
|
Packit Service |
dff8e4 |
nm_utils_base64secret_decode(const char *base64_key, gsize required_key_len, guint8 *out_key);
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
G_END_DECLS
|
|
Packit Service |
dff8e4 |
|
|
Packit Service |
dff8e4 |
#endif /* __NM_UTILS_H__ */
|