SecureBuilder Class

class QKnxNetIpSessionAuthenticateProxy::SecureBuilder

The QKnxNetIpSessionAuthenticateProxy::SecureBuilder class provides the means to create a KNXnet/IP session authentication frame. More...

Public Functions

SecureBuilder(const SecureBuilder &other)
SecureBuilder &operator=(const SecureBuilder &other)
QKnxNetIpFrame create(const QByteArray &sessionPassword, const QKnxByteArray &clientPublicKey, const QKnxByteArray &serverPublicKey) const
SecureBuilder &setUserId(QKnxNetIp::SecureUserId userId)

Detailed Description

This class is part of the Qt KNX module and currently available as a Technology Preview, and therefore the API and functionality provided by the class may be subject to change at any time without prior notice.

Note: To use this class OpenSSL must be supported on your target system.

This frame will be sent by the KNXnet/IP secure client to the control endpoint of the KNXnet/IP secure server after the Diffie-Hellman handshake to authenticate the user against the server device. The maximum time a KNXnet/IP secure client will wait for an authentication status response of the KNXnet/IP secure server is 10 seconds.

The common way to create a session authentication frame is:

auto netIpFrame = QKnxNetIpSessionAuthenticateProxy::secureBuilder()
    .create(passwordHash, clientKey, serverKey);

See also QKnxCryptographicEngine.

Member Function Documentation

SecureBuilder::SecureBuilder(const SecureBuilder &other)

Constructs a copy of other.


Creates a new empty session authentication frame builder.

SecureBuilder &SecureBuilder::operator=(const SecureBuilder &other)

Assigns the specified other to this object.


Destroys the object and frees any allocated resources.

QKnxNetIpFrame SecureBuilder::create(const QByteArray &sessionPassword, const QKnxByteArray &clientPublicKey, const QKnxByteArray &serverPublicKey) const

Creates and returns a KNXnet/IP session authentication frame.

The function computes the AES128 CCM message authentication code (MAC) with the given user session password sessionPassword, the Curve25519 client public key clientPublicKey, the Curve25519 server public key serverPublicKey and appends it to the newly created frame.

Note: The returned frame may be invalid depending on the values used during setup.

See also isValid().

SecureBuilder &SecureBuilder::setUserId(QKnxNetIp::SecureUserId userId)

Sets the user ID of the KNXnet/IP session authentication frame to userId and returns a reference to the builder.

Note: A userId() with the value QKnxNetIp::SecureUserId::Reserved or equal to or more than QKnxNetIp::SecureUserId::Invalid is considered invalid according to the KNX application note AN159.

© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.