summary refs log tree commit diff
path: root/src/libnm-core-impl/nm-setting-bluetooth.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/libnm-core-impl/nm-setting-bluetooth.c')
-rw-r--r--src/libnm-core-impl/nm-setting-bluetooth.c348
1 files changed, 348 insertions, 0 deletions
diff --git a/src/libnm-core-impl/nm-setting-bluetooth.c b/src/libnm-core-impl/nm-setting-bluetooth.c
new file mode 100644
index 00000000..4bd91a69
--- /dev/null
+++ b/src/libnm-core-impl/nm-setting-bluetooth.c
@@ -0,0 +1,348 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later */
+/*
+ * Copyright (C) 2007 - 2013 Red Hat, Inc.
+ * Copyright (C) 2007 - 2008 Novell, Inc.
+ */
+
+#include "libnm-core-impl/nm-default-libnm-core.h"
+
+#include "nm-setting-bluetooth.h"
+
+#include <net/ethernet.h>
+
+#include "nm-connection-private.h"
+#include "nm-setting-cdma.h"
+#include "nm-setting-gsm.h"
+#include "nm-setting-private.h"
+#include "nm-utils.h"
+#include "nm-utils-private.h"
+
+/**
+ * SECTION:nm-setting-bluetooth
+ * @short_description: Describes Bluetooth connection properties
+ *
+ * The #NMSettingBluetooth object is a #NMSetting subclass that describes
+ * properties necessary for connection to devices that provide network
+ * connections via the Bluetooth Dial-Up Networking (DUN) and Network Access
+ * Point (NAP) profiles.
+ **/
+
+/*****************************************************************************/
+
+NM_GOBJECT_PROPERTIES_DEFINE_BASE(PROP_BDADDR, PROP_TYPE, );
+
+typedef struct {
+    char *bdaddr;
+    char *type;
+} NMSettingBluetoothPrivate;
+
+/**
+ * NMSettingBluetooth:
+ *
+ * Bluetooth Settings
+ */
+struct _NMSettingBluetooth {
+    NMSetting parent;
+    /* In the past, this struct was public API. Preserve ABI! */
+};
+
+struct _NMSettingBluetoothClass {
+    NMSettingClass parent;
+    /* In the past, this struct was public API. Preserve ABI! */
+    gpointer padding[4];
+};
+
+G_DEFINE_TYPE(NMSettingBluetooth, nm_setting_bluetooth, NM_TYPE_SETTING)
+
+#define NM_SETTING_BLUETOOTH_GET_PRIVATE(o) \
+    (G_TYPE_INSTANCE_GET_PRIVATE((o), NM_TYPE_SETTING_BLUETOOTH, NMSettingBluetoothPrivate))
+
+/*****************************************************************************/
+
+/**
+ * nm_setting_bluetooth_get_connection_type:
+ * @setting: the #NMSettingBluetooth
+ *
+ * Returns the connection method for communicating with the remote device (i.e.
+ * either DUN to a DUN-capable device or PANU to a NAP-capable device).
+ *
+ * Returns: the type, either %NM_SETTING_BLUETOOTH_TYPE_PANU,
+ * %NM_SETTING_BLUETOOTH_TYPE_NAP or %NM_SETTING_BLUETOOTH_TYPE_DUN
+ **/
+const char *
+nm_setting_bluetooth_get_connection_type(NMSettingBluetooth *setting)
+{
+    g_return_val_if_fail(NM_IS_SETTING_BLUETOOTH(setting), NULL);
+
+    return NM_SETTING_BLUETOOTH_GET_PRIVATE(setting)->type;
+}
+
+/**
+ * nm_setting_bluetooth_get_bdaddr:
+ * @setting: the #NMSettingBluetooth
+ *
+ * Gets the Bluetooth address of the remote device which this setting
+ * describes a connection to.
+ *
+ * Returns: the Bluetooth address
+ **/
+const char *
+nm_setting_bluetooth_get_bdaddr(NMSettingBluetooth *setting)
+{
+    g_return_val_if_fail(NM_IS_SETTING_BLUETOOTH(setting), NULL);
+
+    return NM_SETTING_BLUETOOTH_GET_PRIVATE(setting)->bdaddr;
+}
+
+static gboolean
+verify(NMSetting *setting, NMConnection *connection, GError **error)
+{
+    NMSettingBluetoothPrivate *priv = NM_SETTING_BLUETOOTH_GET_PRIVATE(setting);
+    const char *               type;
+    gboolean                   missing_nap_bridge = FALSE;
+
+    if (priv->bdaddr && !nm_utils_hwaddr_valid(priv->bdaddr, ETH_ALEN)) {
+        g_set_error_literal(error,
+                            NM_CONNECTION_ERROR,
+                            NM_CONNECTION_ERROR_INVALID_PROPERTY,
+                            _("property is invalid"));
+        g_prefix_error(error,
+                       "%s.%s: ",
+                       NM_SETTING_BLUETOOTH_SETTING_NAME,
+                       NM_SETTING_BLUETOOTH_BDADDR);
+        return FALSE;
+    }
+
+    type = priv->type;
+    if (!type) {
+        if (connection) {
+            /* We may infer the type from the (non-)existence of gsm/cdma/bridge settings. */
+            type = _nm_connection_detect_bluetooth_type(connection);
+        }
+        if (!type) {
+            g_set_error_literal(error,
+                                NM_CONNECTION_ERROR,
+                                NM_CONNECTION_ERROR_MISSING_PROPERTY,
+                                _("property is missing"));
+            g_prefix_error(error,
+                           "%s.%s: ",
+                           NM_SETTING_BLUETOOTH_SETTING_NAME,
+                           NM_SETTING_BLUETOOTH_TYPE);
+            return FALSE;
+        }
+    }
+
+    if (!NM_IN_STRSET(type,
+                      NM_SETTING_BLUETOOTH_TYPE_DUN,
+                      NM_SETTING_BLUETOOTH_TYPE_NAP,
+                      NM_SETTING_BLUETOOTH_TYPE_PANU)) {
+        nm_assert(priv->type == type);
+        g_set_error(error,
+                    NM_CONNECTION_ERROR,
+                    NM_CONNECTION_ERROR_INVALID_PROPERTY,
+                    _("'%s' is not a valid value for the property"),
+                    type);
+        g_prefix_error(error,
+                       "%s.%s: ",
+                       NM_SETTING_BLUETOOTH_SETTING_NAME,
+                       NM_SETTING_BLUETOOTH_TYPE);
+        return FALSE;
+    }
+
+    /* Make sure the corresponding 'type' setting is present */
+    if (connection && nm_streq(type, NM_SETTING_BLUETOOTH_TYPE_DUN)) {
+        gboolean gsm = FALSE, cdma = FALSE;
+
+        gsm  = !!nm_connection_get_setting_gsm(connection);
+        cdma = !!nm_connection_get_setting_cdma(connection);
+
+        if (!gsm && !cdma) {
+            /* We can't return MISSING_SETTING here, because we don't know
+             * whether to prefix the message with NM_SETTING_GSM_SETTING_NAME or
+             * NM_SETTING_CDMA_SETTING_NAME.
+             */
+            g_set_error(error,
+                        NM_CONNECTION_ERROR,
+                        NM_CONNECTION_ERROR_INVALID_SETTING,
+                        _("'%s' connection requires '%s' or '%s' setting"),
+                        NM_SETTING_BLUETOOTH_TYPE_DUN,
+                        NM_SETTING_GSM_SETTING_NAME,
+                        NM_SETTING_CDMA_SETTING_NAME);
+            g_prefix_error(error, "%s: ", NM_SETTING_BLUETOOTH_SETTING_NAME);
+            return FALSE;
+        }
+    }
+    /* PANU doesn't need a 'type' setting since no further configuration
+     * is required at the interface level.
+     */
+
+    /* NAP mode needs a bridge setting, and a bridge needs a name. */
+    if (nm_streq(type, NM_SETTING_BLUETOOTH_TYPE_NAP)) {
+        if (!_nm_connection_verify_required_interface_name(connection, error))
+            return FALSE;
+        if (connection && !nm_connection_get_setting_bridge(connection))
+            missing_nap_bridge = TRUE;
+    } else {
+        if (!priv->bdaddr) {
+            g_set_error_literal(error,
+                                NM_CONNECTION_ERROR,
+                                NM_CONNECTION_ERROR_MISSING_PROPERTY,
+                                _("property is missing"));
+            g_prefix_error(error,
+                           "%s.%s: ",
+                           NM_SETTING_BLUETOOTH_SETTING_NAME,
+                           NM_SETTING_BLUETOOTH_BDADDR);
+            return FALSE;
+        }
+    }
+
+    /* errors form here are normalizable. */
+
+    if (!priv->type) {
+        /* as determined above, we can detect the bluetooth type. */
+        nm_assert(!missing_nap_bridge);
+        g_set_error_literal(error,
+                            NM_CONNECTION_ERROR,
+                            NM_CONNECTION_ERROR_MISSING_PROPERTY,
+                            _("property is missing"));
+        g_prefix_error(error,
+                       "%s.%s: ",
+                       NM_SETTING_BLUETOOTH_SETTING_NAME,
+                       NM_SETTING_BLUETOOTH_TYPE);
+        return NM_SETTING_VERIFY_NORMALIZABLE;
+    }
+
+    if (missing_nap_bridge) {
+        g_set_error(error,
+                    NM_CONNECTION_ERROR,
+                    NM_CONNECTION_ERROR_INVALID_SETTING,
+                    _("'%s' connection requires '%s' setting"),
+                    NM_SETTING_BLUETOOTH_TYPE_NAP,
+                    NM_SETTING_BRIDGE_SETTING_NAME);
+        g_prefix_error(error, "%s: ", NM_SETTING_BLUETOOTH_SETTING_NAME);
+        return NM_SETTING_VERIFY_NORMALIZABLE_ERROR;
+    }
+
+    return TRUE;
+}
+
+/*****************************************************************************/
+
+static void
+get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
+{
+    NMSettingBluetooth *setting = NM_SETTING_BLUETOOTH(object);
+
+    switch (prop_id) {
+    case PROP_BDADDR:
+        g_value_set_string(value, nm_setting_bluetooth_get_bdaddr(setting));
+        break;
+    case PROP_TYPE:
+        g_value_set_string(value, nm_setting_bluetooth_get_connection_type(setting));
+        break;
+    default:
+        G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
+        break;
+    }
+}
+
+static void
+set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
+{
+    NMSettingBluetoothPrivate *priv = NM_SETTING_BLUETOOTH_GET_PRIVATE(object);
+
+    switch (prop_id) {
+    case PROP_BDADDR:
+        g_free(priv->bdaddr);
+        priv->bdaddr = g_value_dup_string(value);
+        break;
+    case PROP_TYPE:
+        g_free(priv->type);
+        priv->type = g_value_dup_string(value);
+        break;
+    default:
+        G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
+        break;
+    }
+}
+
+/*****************************************************************************/
+
+static void
+nm_setting_bluetooth_init(NMSettingBluetooth *setting)
+{}
+
+/**
+ * nm_setting_bluetooth_new:
+ *
+ * Creates a new #NMSettingBluetooth object with default values.
+ *
+ * Returns: (transfer full): the new empty #NMSettingBluetooth object
+ **/
+NMSetting *
+nm_setting_bluetooth_new(void)
+{
+    return g_object_new(NM_TYPE_SETTING_BLUETOOTH, NULL);
+}
+
+static void
+finalize(GObject *object)
+{
+    NMSettingBluetoothPrivate *priv = NM_SETTING_BLUETOOTH_GET_PRIVATE(object);
+
+    g_free(priv->bdaddr);
+    g_free(priv->type);
+
+    G_OBJECT_CLASS(nm_setting_bluetooth_parent_class)->finalize(object);
+}
+
+static void
+nm_setting_bluetooth_class_init(NMSettingBluetoothClass *klass)
+{
+    GObjectClass *  object_class        = G_OBJECT_CLASS(klass);
+    NMSettingClass *setting_class       = NM_SETTING_CLASS(klass);
+    GArray *        properties_override = _nm_sett_info_property_override_create_array();
+
+    g_type_class_add_private(klass, sizeof(NMSettingBluetoothPrivate));
+
+    object_class->get_property = get_property;
+    object_class->set_property = set_property;
+    object_class->finalize     = finalize;
+
+    setting_class->verify = verify;
+
+    /**
+     * NMSettingBluetooth:bdaddr:
+     *
+     * The Bluetooth address of the device.
+     **/
+    obj_properties[PROP_BDADDR] = g_param_spec_string(
+        NM_SETTING_BLUETOOTH_BDADDR,
+        "",
+        "",
+        NULL,
+        G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | G_PARAM_STATIC_STRINGS);
+    _nm_properties_override_gobj(properties_override,
+                                 obj_properties[PROP_BDADDR],
+                                 &nm_sett_info_propert_type_mac_address);
+
+    /**
+     * NMSettingBluetooth:type:
+     *
+     * Either "dun" for Dial-Up Networking connections or "panu" for Personal
+     * Area Networking connections to devices supporting the NAP profile.
+     **/
+    obj_properties[PROP_TYPE] = g_param_spec_string(NM_SETTING_BLUETOOTH_TYPE,
+                                                    "",
+                                                    "",
+                                                    NULL,
+                                                    G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE
+                                                        | G_PARAM_STATIC_STRINGS);
+
+    g_object_class_install_properties(object_class, _PROPERTY_ENUMS_LAST, obj_properties);
+
+    _nm_setting_class_commit_full(setting_class,
+                                  NM_META_SETTING_TYPE_BLUETOOTH,
+                                  NULL,
+                                  properties_override);
+}