Differential D20930 Diff 57983 libs/editor/settings/wireguardpeerwidget.cpp

Changeset View

Standalone View

View Options

libs/editor/settings/wireguardpeerwidget.cpp

  • This file was added.
1​/*
2​ Copyright 2019 Bruce Anderson <banderson19com@san.rr.com>
3​
4​ This library is free software; you can redistribute it and/or
5​ modify it under the terms of the GNU Lesser General Public
6​ License as published by the Free Software Foundation; either
7​ version 2.1 of the License, or (at your option) version 3, or any
8​ later version accepted by the membership of KDE e.V. (or its
9​ successor approved by the membership of KDE e.V.), which shall
10​ act as a proxy defined in Section 6 of version 3 of the license.
11​
12​ This library is distributed in the hope that it will be useful,
13​ but WITHOUT ANY WARRANTY; without even the implied warranty of
14​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15​ Lesser General Public License for more details.
16​
17​ You should have received a copy of the GNU Lesser General Public
18​ License along with this library. If not, see <http://www.gnu.org/licenses/>.
19​*/
20​#include "debug.h"
21​#include "wireguardpeerwidget.h"
22​#include "wireguardtabwidget.h"
23​#include "ui_wireguardpeerwidget.h"
24​#include "uiutils.h"
25​#include "simpleipv4addressvalidator.h"
26​#include "simpleiplistvalidator.h"
27​#include "wireguardkeyvalidator.h"
28​
29​#include <QStandardItemModel>
30​
31​#include <NetworkManagerQt/Utils>
32​#include <NetworkManagerQt/WireguardSetting>
33​#include <NetworkManagerQt/Ipv4Setting>
34​#include <NetworkManagerQt/Ipv6Setting>
35​#include <KColorScheme>
36​#include <KConfig>
37​#include <KConfigGroup>
38​
39​// Keys for the NetworkManager configuration
40​#define PNM_SETTING_WIREGUARD_SETTING_NAME "wireguard"
41​
42​#define PNM_WG_KEY_PEERS "peers"
43​#define PNM_WG_KEY_MTU "mtu"
44​#define PNM_WG_KEY_PEER_ROUTES "peer-routes"
45​#define PNM_WG_PEER_KEY_ALLOWED_IPS "allowed-ips"
46​#define PNM_WG_PEER_KEY_ENDPOINT "endpoint"
47​#define PNM_WG_PEER_KEY_PERSISTENT_KEEPALIVE "persistent-keepalive"
48​#define PNM_WG_PEER_KEY_PRESHARED_KEY "preshared-key"
49​#define PNM_WG_PEER_KEY_PRESHARED_KEY_FLAGS "preshared-key-flags"
50​#define PNM_WG_PEER_KEY_PUBLIC_KEY "public-key"
51​
52​static WireGuardKeyValidator keyValidator(nullptr);
53​static SimpleIpListValidator allowedIPsValidator(nullptr, SimpleIpListValidator::WithCidr,
jgrulichUnsubmitted
Not Done

You can change all the validators to take all the necessary parameters as first and then have a default value for the parent object so you don't need to pass a nullptr.

E.g.

explicit SimpleIpV4AddressValidator(AddressStyle style = AddressStyle::Base, QObject *parent = nullptr);

I should have noticed this before. Can you change all the validators you use this way?

jgrulich: You can change all the validators to take all the necessary parameters as first and then have a…
andersonbruceAuthorUnsubmitted
Not Done

SimpleIpV4AddressValidator and SimpleIpV6AddressValidator were intentionally done this way because they were existing functions that I didn't want to break when I added new (defaulted) parameters for use in with WireGuard functionality.

Since changing these two will involve changes to non-WireGuard code and it makes sense to do them all at the same time, can we write this up as a separate Bug?

andersonbruce: SimpleIpV4AddressValidator and SimpleIpV6AddressValidator were intentionally done this way…
jgrulichUnsubmitted
Not Done

Ok, we can do that in a separate review.

jgrulich: Ok, we can do that in a separate review.
54​ SimpleIpListValidator::Both);
55​
56​class WireGuardPeerWidget::Private
57​{
58​public:
59​ Private();
60​ ~Private();
61​
62​ Ui_WireGuardPeersProp ui;
63​ NetworkManager::WireGuardSetting::Ptr setting;
64​ KSharedConfigPtr config;
65​ QPalette warningPalette;
66​ QPalette normalPalette;
67​ QVariantMap peerData;
68​ bool publicKeyValid;
69​ bool allowedIPsValid;
70​ bool endpointValid;
71​ bool presharedKeyValid;
72​};
73​
74​WireGuardPeerWidget::Private::Private(void)
75​ : publicKeyValid(false)
76​ , allowedIPsValid(false)
77​ , endpointValid(true)
78​ , presharedKeyValid(true)
79​{
80​}
81​
82​WireGuardPeerWidget::Private::~Private()
83​{
84​}
85​
86​WireGuardPeerWidget::WireGuardPeerWidget(const QVariantMap &peerData, QWidget *parent, Qt::WindowFlags f)
87​ : QDialog(parent, f)
jgrulichUnsubmitted
Done
WireGuardPeerWidget::WireGuardPeerWidget(const QVariantMap &peerData, QWidget *parent, Qt::WindowFlags f)
jgrulich: ``` WireGuardPeerWidget::WireGuardPeerWidget(const QVariantMap &peerData, QWidget *parent, Qt…
88​ , d(new Private)
89​{
90​ d->ui.setupUi(this);
91​ d->peerData = peerData;
92​
93​ d->config = KSharedConfig::openConfig();
94​ d->warningPalette = KColorScheme::createApplicationPalette(d->config);
95​ d->normalPalette = KColorScheme::createApplicationPalette(d->config);
96​ KColorScheme::adjustBackground(d->warningPalette, KColorScheme::NegativeBackground, QPalette::Base,
97​ KColorScheme::ColorSet::View, d->config);
98​
99​ KColorScheme::adjustBackground(d->normalPalette, KColorScheme::NormalBackground, QPalette::Base,
100​ KColorScheme::ColorSet::View, d->config);
101​
102​ setWindowTitle(i18nc("@title: window wireguard peers properties",
103​ "WireGuard peers properties"));
104​ connect(d->ui.publicKeyLineEdit, &QLineEdit::textChanged, this, &WireGuardPeerWidget::checkPublicKeyValid);
105​ connect(d->ui.allowedIPsLineEdit, &QLineEdit::textChanged, this, &WireGuardPeerWidget::checkAllowedIpsValid);
106​ connect(d->ui.endpointAddressLineEdit, &QLineEdit::textChanged, this, &WireGuardPeerWidget::checkEndpointValid);
107​ connect(d->ui.endpointPortLineEdit, &QLineEdit::textChanged, this, &WireGuardPeerWidget::checkEndpointValid);
108​ connect(d->ui.presharedKeyLineEdit, &PasswordField::textChanged, this, &WireGuardPeerWidget::checkPresharedKeyValid);
109​ connect(d->ui.presharedKeyLineEdit, &PasswordField::passwordOptionChanged, this, &WireGuardPeerWidget::saveKeyFlags);
110​ connect(d->ui.keepaliveLineEdit, &QLineEdit::textChanged, this, &WireGuardPeerWidget::saveKeepAlive);
111​
112​ d->ui.presharedKeyLineEdit->setPasswordModeEnabled(true);
113​ d->ui.presharedKeyLineEdit->setPasswordOptionsEnabled(true);
114​ d->ui.presharedKeyLineEdit->setPasswordNotRequiredEnabled(true);
115​ d->ui.presharedKeyLineEdit->setPasswordNotSavedEnabled(false);
116​
117​ // Create validator for endpoint port
118​ QIntValidator *portValidator = new QIntValidator(this);
119​ portValidator->setBottom(0);
120​ portValidator->setTop(65535);
121​ d->ui.endpointPortLineEdit->setValidator(portValidator);
122​
123​ // Reuse the port validator for the persistent keepalive.
124​ // It is not a "port" but has the same limits
125​ d->ui.keepaliveLineEdit->setValidator(portValidator);
126​
127​ KAcceleratorManager::manage(this);
128​ updatePeerWidgets();
129​
130​ // Set the initial backgrounds on all the widgets
131​ checkPublicKeyValid();
132​ checkAllowedIpsValid();
133​ checkEndpointValid();
134​}
135​
136​WireGuardPeerWidget::~WireGuardPeerWidget()
137​{
138​ delete d;
139​}
140​
141​QVariantMap WireGuardPeerWidget::setting() const
142​{
143​ return d->peerData;
144​}
145​
146​void WireGuardPeerWidget::checkPublicKeyValid()
147​{
148​ int pos = 0;
149​ QLineEdit *widget = d->ui.publicKeyLineEdit;
150​ QString value = widget->displayText();
151​ bool valid = QValidator::Acceptable == keyValidator.validate(value, pos);
152​ setBackground(widget, valid);
153​ d->peerData[PNM_WG_PEER_KEY_PUBLIC_KEY] = value;
154​ if (valid != d->publicKeyValid) {
155​ d->publicKeyValid = valid;
156​ slotWidgetChanged();
157​ }
158​}
159​
160​void WireGuardPeerWidget::checkPresharedKeyValid()
161​{
162​ int pos = 0;
163​ PasswordField *widget = d->ui.presharedKeyLineEdit;
164​ QString value = widget->text();
165​
166​ // The value in the preshared key field is ignored if the type
167​ // of password is set to "Ask every time" or "Not Required" so
168​ // it is valid if it is set to "Store for user only"
169​ // or "Store for all users" even if the password is bad
170​ PasswordField::PasswordOption option = d->ui.presharedKeyLineEdit->passwordOption();
171​ bool valid = (QValidator::Acceptable == keyValidator.validate(value, pos)
172​ || option == PasswordField::NotRequired);
173​ setBackground(widget, valid);
174​ if (value.isEmpty())
175​ d->peerData.remove(PNM_WG_PEER_KEY_PRESHARED_KEY);
176​ else
177​ d->peerData[PNM_WG_PEER_KEY_PRESHARED_KEY] = value;
178​ if (valid != d->presharedKeyValid) {
179​ d->presharedKeyValid = valid;
180​ slotWidgetChanged();
181​ }
182​}
183​
184​void WireGuardPeerWidget::checkAllowedIpsValid()
185​{
186​ int pos = 0;
187​ QLineEdit *widget = d->ui.allowedIPsLineEdit;
188​ QString ipString = widget->displayText();
189​ QStringList ipList = ipString.split(',');
190​
191​ bool valid = QValidator::Acceptable == allowedIPsValidator.validate(ipString, pos);
192​ setBackground(widget, valid);
193​ d->peerData[PNM_WG_PEER_KEY_ALLOWED_IPS] = ipList;
194​ if (valid != d->allowedIPsValid) {
195​ d->allowedIPsValid = valid;
196​ slotWidgetChanged();
197​ }
198​}
199​
200​WireGuardPeerWidget::EndPointValid WireGuardPeerWidget::isEndpointValid(QString &address, QString &port)
201​{
202​ // Create a Reg Expression validator to do simple check for a valid qualified domain name
203​ // which checks to see that there are between 2 and 63 strings of at least 2 characters each
204​ // separated by '.', so "ab.cc" is valid but "a.cc" is not. The full string must also be less
205​ // than 255 characters long.
206​ static QRegExpValidator fqdnValidator(QRegExp(QLatin1String("(?=.{5,254}$)([a-zA-Z0-9][a-zA-Z0-9-]{1,62}\\.){1,63}[a-zA-Z]{2,63}")), nullptr);
207​ static SimpleIpV4AddressValidator ipv4Validator(nullptr);
208​ static SimpleIpV6AddressValidator ipv6Validator(nullptr);
209​ int pos = 0;
210​
211​ bool addressValid = QValidator::Acceptable == fqdnValidator.validate(address, pos)
212​ || QValidator::Acceptable == ipv4Validator.validate(address, pos)
213​ || QValidator::Acceptable == ipv6Validator.validate(address, pos);
214​ bool bothEmpty = address.isEmpty() && port.isEmpty();
215​ // Because of the validator, if the port is non-empty, it is valid
216​ bool portValid = !port.isEmpty();
217​
218​ if ((portValid && addressValid) || bothEmpty)
219​ return WireGuardPeerWidget::BothValid;
220​ else if (portValid)
221​ return WireGuardPeerWidget::PortValid;
222​ else if (addressValid)
223​ return WireGuardPeerWidget::AddressValid;
224​ else
225​ return WireGuardPeerWidget::BothInvalid;
226​}
227​
228​void WireGuardPeerWidget::checkEndpointValid()
229​{
230​ QLineEdit *addressWidget = d->ui.endpointAddressLineEdit;
231​ QLineEdit *portWidget = d->ui.endpointPortLineEdit;
232​ QString addressString = addressWidget->displayText();
233​ QString portString = portWidget->displayText();
234​
235​ QUrl temp;
236​ WireGuardPeerWidget::EndPointValid valid = isEndpointValid(addressString, portString);
237​
238​ setBackground(addressWidget, WireGuardPeerWidget::BothValid == valid || WireGuardPeerWidget::AddressValid == valid);
239​ setBackground(portWidget, WireGuardPeerWidget::BothValid == valid || WireGuardPeerWidget::PortValid == valid);
240​
241​ // If there is a ':' in the address string then it is an IPv6 address and
242​ // the output needs to be formatted as '[1:2:3:4:5:6:7:8]:123' otherwhise
243​ // it is formatted as '1.2.3.4:123' or 'ab.com:123'
244​ QString stringToStore;
245​ if (addressString.contains(":"))
246​ stringToStore = "[" + addressString.trimmed() + "]:" + portString.trimmed();
247​ else
248​ stringToStore = addressString.trimmed() + ":" + portString.trimmed();
249​
250​ if (addressString.isEmpty() && portString.isEmpty())
251​ d->peerData.remove(PNM_WG_PEER_KEY_ENDPOINT);
252​ else
253​ d->peerData[PNM_WG_PEER_KEY_ENDPOINT] = stringToStore;
254​
255​ if ((valid == WireGuardPeerWidget::BothValid) != d->endpointValid) {
256​ d->endpointValid = (valid == WireGuardPeerWidget::BothValid);
257​ slotWidgetChanged();
258​ }
259​}
260​
261​bool WireGuardPeerWidget::isValid()
262​{
263​ return d->publicKeyValid
264​ && d->allowedIPsValid
265​ && d->endpointValid
266​ && d->presharedKeyValid;
267​}
268​
269​void WireGuardPeerWidget::saveKeepAlive()
270​{
271​ QLineEdit *widget = d->ui.keepaliveLineEdit;
272​ QString value = widget->displayText();
273​
274​ if (value.isEmpty())
275​ d->peerData.remove(PNM_WG_PEER_KEY_PERSISTENT_KEEPALIVE);
276​ else
277​ d->peerData[PNM_WG_PEER_KEY_PERSISTENT_KEEPALIVE] = value;
278​}
279​
280​void WireGuardPeerWidget::saveKeyFlags()
281​{
282​ PasswordField::PasswordOption option = d->ui.presharedKeyLineEdit->passwordOption();
283​ switch (option) {
284​ case PasswordField::StoreForUser:
285​ d->peerData[PNM_WG_PEER_KEY_PRESHARED_KEY_FLAGS] = NetworkManager::Setting::AgentOwned;
286​ break;
287​ case PasswordField::StoreForAllUsers:
288​ d->peerData[PNM_WG_PEER_KEY_PRESHARED_KEY_FLAGS] = NetworkManager::Setting::None;
289​ break;
290​ // Always Ask is not a valid option for the preshared key so set it to AgentOwned instead
291​ case PasswordField::AlwaysAsk:
292​ d->peerData[PNM_WG_PEER_KEY_PRESHARED_KEY_FLAGS] = NetworkManager::Setting::AgentOwned;
293​ break;
294​ case PasswordField::NotRequired:
295​ d->peerData[PNM_WG_PEER_KEY_PRESHARED_KEY_FLAGS] = NetworkManager::Setting::NotRequired;
296​ break;
297​ }
298​ checkPresharedKeyValid();
299​}
300​
301​void WireGuardPeerWidget::setBackground(QWidget *w, bool result) const
302​{
303​ if (result)
304​ w->setPalette(d->normalPalette);
305​ else
306​ w->setPalette(d->warningPalette);
307​}
308​
309​void WireGuardPeerWidget::updatePeerWidgets()
310​{
311​ d->ui.presharedKeyLineEdit->setPasswordModeEnabled(true);
312​
313​ if (d->peerData.contains(PNM_WG_PEER_KEY_PUBLIC_KEY))
314​ d->ui.publicKeyLineEdit->setText(d->peerData[PNM_WG_PEER_KEY_PUBLIC_KEY].toString());
315​ else
316​ d->ui.publicKeyLineEdit->clear();
317​
318​ if (d->peerData.contains(PNM_WG_PEER_KEY_ALLOWED_IPS)) {
319​ QStringList allowedIps = d->peerData[PNM_WG_PEER_KEY_ALLOWED_IPS].toStringList();
320​ d->ui.allowedIPsLineEdit->setText(allowedIps.join(","));
321​ } else {
322​ d->ui.allowedIPsLineEdit->clear();
323​ }
324​
325​ if (d->peerData.contains(PNM_WG_PEER_KEY_PERSISTENT_KEEPALIVE))
326​ d->ui.keepaliveLineEdit->setText(d->peerData[PNM_WG_PEER_KEY_PERSISTENT_KEEPALIVE].toString());
327​ else
328​ d->ui.keepaliveLineEdit->clear();
329​
330​ // An endpoint is stored as <ipv4 | [ipv6] | fqdn>:<port>
331​ if (d->peerData.contains(PNM_WG_PEER_KEY_ENDPOINT)) {
332​ QString storedEndpoint = d->peerData[PNM_WG_PEER_KEY_ENDPOINT].toString();
333​ QStringList endpointList = storedEndpoint.contains("]:") ?
334​ d->peerData[PNM_WG_PEER_KEY_ENDPOINT].toString().split("]:") :
335​ d->peerData[PNM_WG_PEER_KEY_ENDPOINT].toString().split(":");
336​
337​ d->ui.endpointAddressLineEdit->setText(endpointList[0].remove("["));
338​ d->ui.endpointPortLineEdit->setText(endpointList[1]);
339​ } else {
340​ d->ui.endpointAddressLineEdit->clear();
341​ d->ui.endpointPortLineEdit->clear();
342​ }
343​ if (d->peerData.contains(PNM_WG_PEER_KEY_PRESHARED_KEY))
344​ d->ui.presharedKeyLineEdit->setText(d->peerData[PNM_WG_PEER_KEY_PRESHARED_KEY].toString());
345​ else
346​ d->ui.presharedKeyLineEdit->setText("");
347​
348​ if (d->peerData.contains(PNM_WG_PEER_KEY_PRESHARED_KEY_FLAGS)) {
349​ NetworkManager::Setting::SecretFlags type = static_cast<NetworkManager::Setting::SecretFlags>(d->peerData[PNM_WG_PEER_KEY_PRESHARED_KEY_FLAGS].toUInt());
350​ switch (type) {
351​ case NetworkManager::Setting::AgentOwned:
352​ d->ui.presharedKeyLineEdit->setPasswordOption(PasswordField::StoreForUser);
353​ break;
354​ case NetworkManager::Setting::None:
355​ d->ui.presharedKeyLineEdit->setPasswordOption(PasswordField::StoreForAllUsers);
356​ break;
357​ // Not saved is not a valid option for the private key so set it to StoreForUser instead
358​ case NetworkManager::Setting::NotSaved:
359​ d->ui.presharedKeyLineEdit->setPasswordOption(PasswordField::StoreForUser);
360​ break;
361​ case NetworkManager::Setting::NotRequired:
362​ d->ui.presharedKeyLineEdit->setPasswordOption(PasswordField::NotRequired);
363​ break;
364​ }
365​ } else {
366​ d->ui.presharedKeyLineEdit->setPasswordOption(PasswordField::NotRequired);
367​ }
368​
369​ slotWidgetChanged();
370​}
371​
372​void WireGuardPeerWidget::slotWidgetChanged()
373​{
374​ Q_EMIT notifyValid();
375​}