aboutsummaryrefslogtreecommitdiffstats
path: root/tests/auto/coapnetworksettings.h
blob: 7f425ff8734a32dd89b6eee9bee2c6a194a2d28f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/****************************************************************************
**
** Copyright (C) 2017 Witekio.
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCoap module.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include <QtTest>
#include <QtCore/qstring.h>
#include <QtNetwork/qhostinfo.h>
#include <QtCoap/qcoapclient.h>
#include <QtCoap/qcoapsecurityconfiguration.h>

/*!
    \internal

    This namespace provides URL and settings used in QtCoap tests.

    Tests require a Californium plugtest server, accessible with
    "coap-plugtest-server" host name. You create such server with Docker and
    the following command line:
    \code
        docker run -d --rm -p 5683:5683/udp aleravat/coap-test-server:latest
    \endcode

    For more details, see
    \l{https://github.com/Pixep/coap-testserver-docker}{https://github.com/Pixep/coap-testserver-docker}.
*/
namespace QtCoapNetworkSettings
{

#if defined(COAP_TEST_SERVER_IP) || defined(QT_TEST_SERVER)
#define CHECK_FOR_COAP_SERVER
#else
#define CHECK_FOR_COAP_SERVER \
    QSKIP("CoAP server is not setup, skipping the test..."); \
    return;
#endif

#if defined(QT_TEST_SERVER) && !defined(COAP_TEST_SERVER_IP)
static QString tryToResolveHostName(const QString &hostName)
{
    const auto hostInfo = QHostInfo::fromName(hostName);
    if (!hostInfo.addresses().empty())
        return hostInfo.addresses().first().toString();

    qWarning() << "Could not resolve the hostname"<< hostName;
    return hostName;
}
#endif

static QString getHostAddress(const QString &serverName)
{
#if defined(COAP_TEST_SERVER_IP)
    Q_UNUSED(serverName);
    return QStringLiteral(COAP_TEST_SERVER_IP);
#elif defined(QT_TEST_SERVER_NAME)
    QString hostname = serverName % "." % QString(QT_TEST_SERVER_DOMAIN);
    return tryToResolveHostName(hostname);
#elif defined(QT_TEST_SERVER)
    Q_UNUSED(serverName);
    QString hostname = "qt-test-server." % QString(QT_TEST_SERVER_DOMAIN);
    return tryToResolveHostName(hostname);
#else
    Q_UNUSED(serverName);
    qWarning("This test will fail, "
             "please set the COAP_TEST_SERVER_IP variable to specify the CoAP server.");
    return "";
#endif
}

QString testServerHost()
{
    static QString testServerHostAddress = getHostAddress("californium");
    return testServerHostAddress;
}

QString timeServerUrl()
{
    static QString timeServerHostAddress = getHostAddress("freecoap");
    return QStringLiteral("coaps://") + timeServerHostAddress + QStringLiteral(":5685/time");
}

QString testServerUrl()
{
    return QStringLiteral("coap://") + testServerHost() + QStringLiteral(":")
            + QString::number(QtCoap::DefaultPort);
}

QString testServerResource()
{
    return testServerHost() + QStringLiteral("/test");
}

QCoapSecurityConfiguration createConfiguration(QtCoap::SecurityMode securityMode)
{
    QCoapSecurityConfiguration configuration;

    if (securityMode == QtCoap::SecurityMode::PreSharedKey) {
        configuration.setPreSharedKeyIdentity("Client_identity");
        configuration.setPreSharedKey("secretPSK");
    } else if (securityMode == QtCoap::SecurityMode::Certificate) {
        const QString directory = QFINDTESTDATA("testdata");
        if (directory.isEmpty()) {
            qWarning() << "Found no testdata/, cannot load certificates.";
            return configuration;
        }

        const auto localCertPath = directory + QDir::separator() +"local_cert.pem";
        const auto localCerts = QSslCertificate::fromPath(localCertPath);
        if (localCerts.isEmpty()) {
            qWarning() << "Failed to load local certificates, the"
                       << localCertPath
                       << "file was not found or it is not valid.";
        } else {
            configuration.setLocalCertificateChain(localCerts.toVector());
        }

        const auto caCertPath = directory + QDir::separator() + "ca_cert.pem";
        const auto caCerts = QSslCertificate::fromPath(caCertPath);
        if (caCerts.isEmpty()) {
            qWarning() << "Failed to load CA certificates, the"
                       << caCertPath
                       << "file was not found or it is not valid.";
        } else {
            configuration.setCaCertificates(caCerts.toVector());
        }

        const auto privateKeyPath = directory + QDir::separator() + "privkey.pem";
        QFile privateKey(privateKeyPath);
        if (privateKey.open(QIODevice::ReadOnly)) {
            QCoapPrivateKey key(privateKey.readAll(), QSsl::Ec);
            if (key.isNull()) {
                qWarning() << "Failed to set a private key, the key" << privateKeyPath
                           << "is not valid.";
            } else {
                configuration.setPrivateKey(key);
            }
        } else {
            qWarning() << "Failed to read the private key" << privateKeyPath;
        }
    }

    return configuration;
}

bool waitForHost(const QUrl &url, QtCoap::SecurityMode security = QtCoap::SecurityMode::NoSecurity,
                 quint8 retries = 10)
{
    while (retries-- > 0) {
        QCoapClient client(security);
        if (security != QtCoap::SecurityMode::NoSecurity)
            client.setSecurityConfiguration(createConfiguration(security));

        QSignalSpy spyClientFinished(&client, SIGNAL(finished(QCoapReply *)));
        client.get(url);

        spyClientFinished.wait(1000);

        if (spyClientFinished.count() == 1)
            return true;
    }
    return false;
}

}