Builder Class

class QKnxNetIpSessionAuthenticateProxy::Builder

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

List of all members, including inherited members

Public Functions

	Builder(const Builder &other)
	Builder()
Builder &	operator=(const Builder &other)
	~Builder()
QKnxNetIpFrame	create() const
Builder &	setMessageAuthenticationCode(const QKnxByteArray &data)
Builder &	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.

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 auth = ... // create the full 128 bit CCM-MAC

auto netIpFrame = QKnxNetIpSessionAuthenticateProxy::builder()
    .setUserId(QKnxNetIp::SecureUserId::Management)
    .setMessageAuthenticationCode(auth)
    .create();

See also QKnxCryptographicEngine.

Member Function Documentation

Builder::Builder(const Builder &other)

Constructs a copy of other.

Builder::Builder()

Creates a new empty session authentication frame builder.

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

Assigns the specified other to this object.

Builder::~Builder()

Destroys the object and frees any allocated resources.

QKnxNetIpFrame Builder::create() const

Creates and returns a KNXnet/IP session authentication frame.

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

See also isValid().

Builder &Builder::setMessageAuthenticationCode(const QKnxByteArray &data)

Sets the AES128 CCM message authentication code (MAC) of the generic KNXnet/IP session authentication frame to data and returns a reference to the builder. The MAC has a fixed size of 16 bytes.

Builder &Builder::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.

© 2024 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.