qsslkeyingmaterial.h

Go to the documentation of this file.

// Copyright (C) 2026 Governikus GmbH & Co. KG.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#ifndef QSSLKEYINGMATERIAL_H
#define QSSLKEYINGMATERIAL_H
 
#include <QtNetwork/qtnetworkglobal.h>
 
#include <QtCore/qbytearray.h>
#include <QtCore/qcompare.h>
#include <QtCore/qswap.h>
#include <QtCore/qtclasshelpermacros.h>
#include <QtCore/qtypes.h>
 
QT_REQUIRE_CONFIG(ssl);
 
 
QT_BEGIN_NAMESPACE
 
namespace QTlsPrivate {
class TlsCryptographOpenSSL;
}
 
class QDebug;
 
class QSslKeyingMaterial
{
public:
    Q_NETWORK_EXPORT QSslKeyingMaterial();
    Q_NETWORK_EXPORT explicit QSslKeyingMaterial(const QByteArray &label, qsizetype size);
    Q_NETWORK_EXPORT explicit QSslKeyingMaterial(const QByteArray &label, qsizetype size,
                                                 const QByteArray &context);
    Q_NETWORK_EXPORT QSslKeyingMaterial(const QSslKeyingMaterial &other);
    Q_NETWORK_EXPORT QSslKeyingMaterial &operator=(const QSslKeyingMaterial &other);
    QSslKeyingMaterial(QSslKeyingMaterial &&other) noexcept
        : m_label(std::move(other.m_label)),
          m_context(std::move(other.m_context)),
          m_value(std::move(other.m_value)),
          m_requestedSize(other.m_requestedSize),
          m_reserved{std::exchange(other.m_reserved, nullptr)}
    {}
    QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QSslKeyingMaterial)
    Q_NETWORK_EXPORT ~QSslKeyingMaterial();
 
    Q_NETWORK_EXPORT bool isValid() const noexcept;
 
    QByteArray label() const
    {
        return m_label;
    }
 
    QByteArray context() const
    {
        return m_context;
    }
 
    QByteArray value() const
    {
        return m_value;
    }
 
    qsizetype requestedSize() const noexcept
    {
        return m_requestedSize;
    }
 
    void swap(QSslKeyingMaterial &other) noexcept
    {
        m_label.swap(other.m_label);
        m_context.swap(other.m_context);
        m_value.swap(other.m_value);
        std::swap(m_requestedSize, other.m_requestedSize);
        qt_ptr_swap(m_reserved, other.m_reserved);
    }
 
private:
    QByteArray m_label;
    QByteArray m_context;
    QByteArray m_value;
    qsizetype m_requestedSize = 0;
    Q_DECL_UNUSED_MEMBER void *m_reserved = nullptr;
 
    friend Q_NETWORK_EXPORT bool comparesEqual(const QSslKeyingMaterial &lhs,
                                               const QSslKeyingMaterial &rhs) noexcept;
    Q_DECLARE_EQUALITY_COMPARABLE(QSslKeyingMaterial)
 
    friend size_t qHash(const QSslKeyingMaterial &material) noexcept
    { return qHash(material, 0); }
    friend Q_NETWORK_EXPORT size_t qHash(const QSslKeyingMaterial &material, size_t seed) noexcept;
 
#ifndef QT_NO_DEBUG_STREAM
    friend Q_NETWORK_EXPORT QDebug operator<<(QDebug debug, const QSslKeyingMaterial &keying);
#endif // QT_NO_DEBUG_STREAM
 
    friend class QTlsPrivate::TlsCryptographOpenSSL;
};
 
Q_DECLARE_SHARED(QSslKeyingMaterial)
 
QT_END_NAMESPACE
 
#endif // QSSLKEYINGMATERIAL_H