1// Copyright (C) 2021 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QNETWORKMANAGERSERVICE_H
6#define QNETWORKMANAGERSERVICE_H
7
8//
9// W A R N I N G
10// -------------
11//
12// This file is not part of the Qt API. It exists purely as an
13// implementation detail. This header file may change from version to
14// version without notice, or even be removed.
15//
16// We mean it.
17//
18
19#include <QtCore/qvariant.h>
20#include <QtCore/qmap.h>
21#include <QtDBus/qdbusabstractinterface.h>
22
23#include <optional>
24
25// Matches 'NMDeviceState' from https://developer.gnome.org/NetworkManager/stable/nm-dbus-types.html
26enum NMDeviceState {
27 NM_DEVICE_STATE_UNKNOWN = 0,
28 NM_DEVICE_STATE_UNMANAGED = 10,
29 NM_DEVICE_STATE_UNAVAILABLE = 20,
30 NM_DEVICE_STATE_DISCONNECTED = 30,
31 NM_DEVICE_STATE_PREPARE = 40,
32 NM_DEVICE_STATE_CONFIG = 50,
33 NM_DEVICE_STATE_NEED_AUTH = 60,
34 NM_DEVICE_STATE_IP_CONFIG = 70,
35 NM_DEVICE_STATE_ACTIVATED = 100,
36 NM_DEVICE_STATE_DEACTIVATING = 110,
37 NM_DEVICE_STATE_FAILED = 120
38};
39
40QT_BEGIN_NAMESPACE
41
42class QDBusObjectPath;
43class QNetworkManagerNetworkInformationBackend;
44
45// This tiny class exists for the purpose of seeing if NetworkManager is available without
46// initializing everything the derived/full class needs.
47class QNetworkManagerInterfaceBase : public QDBusAbstractInterface
48{
49 Q_OBJECT
50public:
51 explicit QNetworkManagerInterfaceBase(QObject *parent = nullptr);
52 ~QNetworkManagerInterfaceBase() = default;
53
54 static bool networkManagerAvailable();
55
56private:
57 Q_DISABLE_COPY_MOVE(QNetworkManagerInterfaceBase)
58};
59
60class QNetworkManagerInterface final : public QNetworkManagerInterfaceBase
61{
62 Q_OBJECT
63
64public:
65 // Matches 'NMState' from https://developer.gnome.org/NetworkManager/stable/nm-dbus-types.html
66 enum NMState {
67 NM_STATE_UNKNOWN = 0,
68 NM_STATE_ASLEEP = 10,
69 NM_STATE_DISCONNECTED = 20,
70 NM_STATE_DISCONNECTING = 30,
71 NM_STATE_CONNECTING = 40,
72 NM_STATE_CONNECTED_LOCAL = 50,
73 NM_STATE_CONNECTED_SITE = 60,
74 NM_STATE_CONNECTED_GLOBAL = 70
75 };
76 Q_ENUM(NMState)
77 // Matches 'NMConnectivityState' from
78 // https://developer.gnome.org/NetworkManager/stable/nm-dbus-types.html#NMConnectivityState
79 enum NMConnectivityState {
80 NM_CONNECTIVITY_UNKNOWN = 0,
81 NM_CONNECTIVITY_NONE = 1,
82 NM_CONNECTIVITY_PORTAL = 2,
83 NM_CONNECTIVITY_LIMITED = 3,
84 NM_CONNECTIVITY_FULL = 4,
85 };
86 Q_ENUM(NMConnectivityState)
87 // Matches 'NMDeviceType' from
88 // https://developer-old.gnome.org/NetworkManager/stable/nm-dbus-types.html#NMDeviceType
89 enum NMDeviceType {
90 NM_DEVICE_TYPE_UNKNOWN = 0,
91 NM_DEVICE_TYPE_GENERIC = 14,
92 NM_DEVICE_TYPE_ETHERNET = 1,
93 NM_DEVICE_TYPE_WIFI = 2,
94 NM_DEVICE_TYPE_UNUSED1 = 3,
95 NM_DEVICE_TYPE_UNUSED2 = 4,
96 NM_DEVICE_TYPE_BT = 5,
97 NM_DEVICE_TYPE_OLPC_MESH = 6,
98 NM_DEVICE_TYPE_WIMAX = 7,
99 NM_DEVICE_TYPE_MODEM = 8,
100 NM_DEVICE_TYPE_INFINIBAND = 9,
101 NM_DEVICE_TYPE_BOND = 10,
102 NM_DEVICE_TYPE_VLAN = 11,
103 NM_DEVICE_TYPE_ADSL = 12,
104 NM_DEVICE_TYPE_BRIDGE = 13,
105 NM_DEVICE_TYPE_TEAM = 15,
106 NM_DEVICE_TYPE_TUN = 16,
107 NM_DEVICE_TYPE_IP_TUNNEL = 17,
108 NM_DEVICE_TYPE_MACVLAN = 18,
109 NM_DEVICE_TYPE_VXLAN = 19,
110 NM_DEVICE_TYPE_VETH = 20,
111 NM_DEVICE_TYPE_MACSEC = 21,
112 NM_DEVICE_TYPE_DUMMY = 22,
113 NM_DEVICE_TYPE_PPP = 23,
114 NM_DEVICE_TYPE_OVS_INTERFACE = 24,
115 NM_DEVICE_TYPE_OVS_PORT = 25,
116 NM_DEVICE_TYPE_OVS_BRIDGE = 26,
117 NM_DEVICE_TYPE_WPAN = 27,
118 NM_DEVICE_TYPE_6LOWPAN = 28,
119 NM_DEVICE_TYPE_WIREGUARD = 29,
120 NM_DEVICE_TYPE_WIFI_P2P = 30,
121 NM_DEVICE_TYPE_VRF = 31,
122 };
123 // Matches 'NMMetered' from
124 // https://developer-old.gnome.org/NetworkManager/stable/nm-dbus-types.html#NMMetered
125 enum NMMetered {
126 NM_METERED_UNKNOWN,
127 NM_METERED_YES,
128 NM_METERED_NO,
129 NM_METERED_GUESS_YES,
130 NM_METERED_GUESS_NO,
131 };
132
133 explicit QNetworkManagerInterface(QObject *parent = nullptr);
134 ~QNetworkManagerInterface();
135
136 void setBackend(QNetworkManagerNetworkInformationBackend *ourBackend);
137
138 NMState state() const;
139 NMConnectivityState connectivityState() const;
140 NMDeviceType deviceType() const;
141 NMMetered meteredState() const;
142
143 bool isValid() const { return QDBusAbstractInterface::isValid() && validDBusConnection; }
144
145private Q_SLOTS:
146 void setProperties(const QString &interfaceName, const QMap<QString, QVariant> &map,
147 const QStringList &invalidatedProperties);
148
149private:
150 Q_DISABLE_COPY_MOVE(QNetworkManagerInterface)
151
152 NMDeviceType extractDeviceType(const QDBusObjectPath &devicePath) const;
153 NMMetered extractDeviceMetered(const QDBusObjectPath &devicePath) const;
154
155 std::optional<QDBusObjectPath> primaryConnectionDevicePath() const;
156
157 QVariantMap propertyMap;
158 QNetworkManagerNetworkInformationBackend *backend = nullptr;
159 bool validDBusConnection = true;
160};
161
162class PropertiesDBusInterface : public QDBusAbstractInterface
163{
164public:
165 PropertiesDBusInterface(const QString &service, const QString &path, const QString &interface,
166 const QDBusConnection &connection, QObject *parent = nullptr)
167 : QDBusAbstractInterface(service, path, interface.toLatin1().data(), connection, parent)
168 {
169 }
170};
171
172QT_END_NAMESPACE
173
174#endif
175

source code of qtbase/src/plugins/networkinformation/networkmanager/qnetworkmanagerservice.h