Add QXmppStartTlsPacket to replace hard-coded XML in TLS code

5 files changed, 261 insertions, 0 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index db020e3b..c61d4d48 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -51,6 +51,7 @@ set(INSTALL_HEADER_FILES
     base/QXmppSessionIq.h
     base/QXmppSocks.h
     base/QXmppStanza.h
+    base/QXmppStartTlsPacket.h
     base/QXmppStream.h
     base/QXmppStreamFeatures.h
     base/QXmppStun.h
@@ -135,6 +136,7 @@ set(SOURCE_FILES
     base/QXmppSessionIq.cpp
     base/QXmppSocks.cpp
     base/QXmppStanza.cpp
+    base/QXmppStartTlsPacket.cpp
     base/QXmppStream.cpp
     base/QXmppStreamFeatures.cpp
     base/QXmppStreamInitiationIq.cpp
diff --git a/src/base/QXmppStartTlsPacket.cpp b/src/base/QXmppStartTlsPacket.cpp
new file mode 100644
index 00000000..46aafc7d
--- /dev/null
+++ b/src/base/QXmppStartTlsPacket.cpp
@@ -0,0 +1,103 @@
+/*
+ * Copyright (C) 2008-2019 The QXmpp developers
+ *
+ * Authors:
+ *  Linus Jahn
+ *
+ * Source:
+ *  https://github.com/qxmpp-project/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ */
+
+#include "QXmppStartTlsPacket.h"
+
+#include "QXmppConstants_p.h"
+
+#include <QDomElement>
+#include <QXmlStreamWriter>
+
+const static QStringList STARTTLS_TYPES = {
+    QStringLiteral("starttls"),
+    QStringLiteral("proceed"),
+    QStringLiteral("failure")
+};
+
+/// Constructs a new QXmppStartTlsPacket
+///
+/// \param type The type of the new QXmppStartTlsPacket.
+
+QXmppStartTlsPacket::QXmppStartTlsPacket(Type type)
+    : m_type(type)
+{
+}
+
+QXmppStartTlsPacket::~QXmppStartTlsPacket() = default;
+
+/// Returns the type of the STARTTLS packet
+
+QXmppStartTlsPacket::Type QXmppStartTlsPacket::type() const
+{
+    return m_type;
+}
+
+/// Sets the type of the STARTTLS packet
+
+void QXmppStartTlsPacket::setType(QXmppStartTlsPacket::Type type)
+{
+    m_type = type;
+}
+
+/// \cond
+void QXmppStartTlsPacket::parse(const QDomElement &element)
+{
+    if (!QXmppStartTlsPacket::isStartTlsPacket(element))
+        return;
+
+    m_type = Type(STARTTLS_TYPES.indexOf(element.tagName()));
+}
+
+void QXmppStartTlsPacket::toXml(QXmlStreamWriter *writer) const
+{
+    writer->writeStartElement(STARTTLS_TYPES.at(int(m_type)));
+    writer->writeAttribute(QStringLiteral("xmlns"), ns_tls);
+    writer->writeEndElement();
+}
+/// \endcond
+
+/// Checks whether the given \p element is a STARTTLS packet according to
+/// <a href="https://xmpp.org/rfcs/rfc6120.html#tls-process-initiate">RFC6120</a>.
+///
+/// \param element The element that should be checked for being a STARTTLS packet.
+///
+/// \returns True, if the element is a STARTTLS packet.
+
+bool QXmppStartTlsPacket::isStartTlsPacket(const QDomElement &element)
+{
+    return element.namespaceURI() == ns_tls && STARTTLS_TYPES.contains(element.tagName());
+}
+
+/// Checks whether the given \p element is a STARTTLS packet according to
+/// <a href="https://xmpp.org/rfcs/rfc6120.html#tls-process-initiate">RFC6120</a>
+/// and has the correct type.
+///
+/// \param element The element that should be checked for being a STARTTLS packet.
+/// \param type The type the element needs to have.
+///
+/// \returns True, if the element is a STARTTLS packet and has the correct type.
+
+bool QXmppStartTlsPacket::isStartTlsPacket(const QDomElement &element, Type type)
+{
+    return element.namespaceURI() == ns_tls && element.tagName() == STARTTLS_TYPES.at(int(type));
+}
diff --git a/src/base/QXmppStartTlsPacket.h b/src/base/QXmppStartTlsPacket.h
new file mode 100644
index 00000000..05be4ba8
--- /dev/null
+++ b/src/base/QXmppStartTlsPacket.h
@@ -0,0 +1,62 @@
+/*
+ * Copyright (C) 2008-2019 The QXmpp developers
+ *
+ * Authors:
+ *  Linus Jahn
+ *
+ * Source:
+ *  https://github.com/qxmpp-project/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ */
+
+#ifndef QXMPPSTARTTLSPACKET_H
+#define QXMPPSTARTTLSPACKET_H
+
+#include "QXmppStanza.h"
+
+/// \brief The QXmppStartTlsPacket represents packets used for initiating
+/// STARTTLS negotiation when connecting.
+
+class QXMPP_EXPORT QXmppStartTlsPacket : public QXmppStanza
+{
+public:
+    /// The type of the STARTTLS packet.
+    enum Type {
+        StartTls,  ///< Used by the client to initiate STARTTLS.
+        Proceed,   ///< Used by the server to accept STARTTLS.
+        Failure    ///< Used by the server to reject STARTTLS.
+    };
+
+    QXmppStartTlsPacket(Type type = StartTls);
+    ~QXmppStartTlsPacket() override;
+
+    Type type() const;
+    void setType(Type type);
+
+    /// \cond
+    void parse(const QDomElement &element) override;
+    void toXml(QXmlStreamWriter *writer) const override;
+    /// \endcond
+
+    static bool isStartTlsPacket(const QDomElement &element);
+    static bool isStartTlsPacket(const QDomElement &element, Type type);
+
+private:
+    Type m_type;
+};
+
+Q_DECLARE_METATYPE(QXmppStartTlsPacket::Type);
+
+#endif  // QXMPPSTARTTLSPACKET_H
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
index a9c3e87d..262a9474 100644
--- a/tests/CMakeLists.txt
+++ b/tests/CMakeLists.txt
@@ -46,6 +46,7 @@ add_simple_test(qxmppserver)
 add_simple_test(qxmppsessioniq)
 add_simple_test(qxmppsocks)
 add_simple_test(qxmppstanza)
+add_simple_test(qxmppstarttlspacket)
 add_simple_test(qxmppstreamfeatures)
 add_simple_test(qxmppstunmessage)
 add_simple_test(qxmppvcardiq)
diff --git a/tests/qxmppstarttlspacket/tst_qxmppstarttlspacket.cpp b/tests/qxmppstarttlspacket/tst_qxmppstarttlspacket.cpp
new file mode 100644
index 00000000..1b6119d8
--- /dev/null
+++ b/tests/qxmppstarttlspacket/tst_qxmppstarttlspacket.cpp
@@ -0,0 +1,93 @@
+/*
+ * Copyright (C) 2008-2019 The QXmpp developers
+ *
+ * Author:
+ *  Linus Jahn
+ *
+ * Source:
+ *  https://github.com/qxmpp-project/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ */
+
+#include <QObject>
+
+#include "QXmppStartTlsPacket.h"
+#include "util.h"
+
+class tst_QXmppStartTlsPacket : public QObject
+{
+    Q_OBJECT
+
+private slots:
+    void testBasic_data();
+    void testBasic();
+};
+
+void tst_QXmppStartTlsPacket::testBasic_data()
+{
+    QTest::addColumn<QByteArray>("xml");
+    QTest::addColumn<bool>("valid");
+    QTest::addColumn<QXmppStartTlsPacket::Type>("type");
+
+#define ROW(name, xml, valid, type) \
+    QTest::newRow(name) \
+        << QByteArrayLiteral(xml) \
+        << valid \
+        << type
+
+    ROW("starttls", R"(<starttls xmlns="urn:ietf:params:xml:ns:xmpp-tls"/>)", true, QXmppStartTlsPacket::StartTls);
+    ROW("proceed", R"(<proceed xmlns="urn:ietf:params:xml:ns:xmpp-tls"/>)", true, QXmppStartTlsPacket::Proceed);
+    ROW("failure", R"(<failure xmlns="urn:ietf:params:xml:ns:xmpp-tls"/>)", true, QXmppStartTlsPacket::Failure);
+
+    ROW("invalid-tag", R"(<invalid-tag-name xmlns="urn:ietf:params:xml:ns:xmpp-tls"/>)", false, QXmppStartTlsPacket::StartTls);
+
+#undef ROW
+}
+
+void tst_QXmppStartTlsPacket::testBasic()
+{
+    QFETCH(QByteArray, xml);
+    QFETCH(bool, valid);
+    QFETCH(QXmppStartTlsPacket::Type, type);
+
+    QDomDocument doc;
+    QCOMPARE(doc.setContent(xml, true), true);
+    QCOMPARE(QXmppStartTlsPacket::isStartTlsPacket(doc.documentElement()), valid);
+    QCOMPARE(QXmppStartTlsPacket::isStartTlsPacket(doc.documentElement(), type), valid);
+
+    // test other types return false
+    for (auto testValue : {QXmppStartTlsPacket::StartTls,
+                            QXmppStartTlsPacket::Proceed,
+                            QXmppStartTlsPacket::Failure}) {
+        QCOMPARE(QXmppStartTlsPacket::isStartTlsPacket(doc.documentElement(), testValue), testValue == type && valid);
+    }
+
+    if (valid) {
+        QXmppStartTlsPacket packet;
+        parsePacket(packet, xml);
+        QCOMPARE(packet.type(), type);
+        serializePacket(packet, xml);
+
+        QXmppStartTlsPacket packet2(type);
+        serializePacket(packet2, xml);
+
+        QXmppStartTlsPacket packet3;
+        packet3.setType(type);
+        serializePacket(packet2, xml);
+    }
+}
+
+QTEST_MAIN(tst_QXmppStartTlsPacket)
+#include "tst_qxmppstarttlspacket.moc"