SecureBuilder Class

class QKnxNetIpSessionResponseProxy::SecureBuilder

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

Public Functions

SecureBuilder(const SecureBuilder &other)
SecureBuilder()
SecureBuilder &operator=(const SecureBuilder &other)
~SecureBuilder()
QKnxNetIpFrame create(const QByteArray &devicePassword, const QKnxByteArray &clientPublicKey) const
SecureBuilder &setPublicKey(const QKnxByteArray &serverPublicKey)
SecureBuilder &setSecureSessionId(quint16 sessionId)

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 server to the KNXnet/IP secure client control endpoint in response to a received secure session request frame.

The common way to create a session response frame is:

auto serverPublicKey = ... // create the public key
auto auth = ... // create the full 128 bit CCM-MAC

auto netIpFrame = QKnxNetIpSessionResponseProxy::secureBuilder()
    .setSecureSessionId(0x1976)
    .setPublicKey(serverPublicKey)
    .create();

See also QKnxCryptographicEngine.

Member Function Documentation

SecureBuilder::SecureBuilder(const SecureBuilder &other)

Constructs a copy of other.

SecureBuilder::SecureBuilder()

Creates a new empty session response builder object.

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

Assigns the specified other to this object.

SecureBuilder::~SecureBuilder()

Destroys the object and frees any allocated resources.

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

Creates and returns a KNXnet/IP session response frame.

The function computes the AES128 CCM message authentication code (MAC) with the given device password devicePassword and the Curve25519 client public key clientPublicKey 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::setPublicKey(const QKnxByteArray &serverPublicKey)

Sets the public key of the KNXnet/IP session response frame to serverPublicKey and returns a reference to the builder. The public key needs to be generated using the Curve25519 algorithm and has a fixed size of 32 bytes.

SecureBuilder &SecureBuilder::setSecureSessionId(quint16 sessionId)

Sets the secure session ID of the KNXnet/IP session response frame to sessionId and returns a reference to the builder.

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