QSslPreSharedKeyAuthenticator

The QSslPreSharedKeyAuthenticator class provides authentication data for pre shared keys (PSK) ciphersuites. More…

Synopsis

Functions

• def __eq__ (rhs)

• def __ne__ (rhs)

• def identity ()

• def identityHint ()

• def maximumIdentityLength ()

• def maximumPreSharedKeyLength ()

• def preSharedKey ()

• def setIdentity (identity)

• def setPreSharedKey (preSharedKey)

• def swap (other)

Detailed Description

The QSslPreSharedKeyAuthenticator class is used by an SSL socket to provide the required authentication data in a pre shared key (PSK) ciphersuite.

In a PSK handshake, the client must derive a key, which must match the key set on the server. The exact algorithm of deriving the key depends on the application; however, for this purpose, the server may send an identity hint to the client. This hint, combined with other information (for instance a passphrase), is then used by the client to construct the shared key.

The QSslPreSharedKeyAuthenticator provides means to client applications for completing the PSK handshake. The client application needs to connect a slot to the preSharedKeyAuthenticationRequired() signal:

connect(socket, QSslSocket.preSharedKeyAuthenticationRequired,
        self, AuthManager::handlePreSharedKeyAuthentication)

The signal carries a QSslPreSharedKeyAuthenticator object containing the identity hint the server sent to the client, and which must be filled with the corresponding client identity and the derived key:

def handlePreSharedKeyAuthentication(self, authenticator):

    authenticator.setIdentity("My Qt App")
    key = deriveKey(authenticator.identityHint(), passphrase)
    authenticator.setPreSharedKey(key)

Note

PSK ciphersuites are supported only when using OpenSSL 1.0.1 (or greater) as the SSL backend.

Note

PSK is currently only supported in OpenSSL.

See also

QSslSocket

class PySide6.QtNetwork.QSslPreSharedKeyAuthenticator

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator(authenticator)

Parameters

authenticator – PySide6.QtNetwork.QSslPreSharedKeyAuthenticator

Constructs a default QSslPreSharedKeyAuthenticator object.

The identity hint, the identity and the key will be initialized to empty byte arrays; the maximum length for both the identity and the key will be initialized to 0.

Constructs a QSslPreSharedKeyAuthenticator object as a copy of authenticator.

See also

operator=()

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.identity()

Return type

PySide6.QtCore.QByteArray

Returns the PSK client identity.

See also

setIdentity()

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.identityHint()

Return type

PySide6.QtCore.QByteArray

Returns the PSK identity hint as provided by the server. The interpretation of this hint is left to the application.

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.maximumIdentityLength()

Return type

int

Returns the maximum length, in bytes, of the PSK client identity.

Note

it is possible to set an identity whose length is greater than ; in this case, only the first bytes will be actually sent to the server.

See also

setIdentity()

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.maximumPreSharedKeyLength()

Return type

int

Returns the maximum length, in bytes, of the pre shared key.

Note

it is possible to set a key whose length is greater than the ; in this case, only the first bytes will be actually sent to the server.

See also

setPreSharedKey()

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.__ne__(rhs)

Parameters

rhs – PySide6.QtNetwork.QSslPreSharedKeyAuthenticator

Return type

bool

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.__eq__(rhs)

Parameters

rhs – PySide6.QtNetwork.QSslPreSharedKeyAuthenticator

Return type

bool

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.preSharedKey()

Return type

PySide6.QtCore.QByteArray

Returns the pre shared key.

See also

setPreSharedKey()

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.setIdentity(identity)

Parameters

identity – PySide6.QtCore.QByteArray

Sets the PSK client identity (to be advised to the server) to identity.

Note

it is possible to set an identity whose length is greater than maximumIdentityLength() ; in this case, only the first maximumIdentityLength() bytes will be actually sent to the server.

See also

identity() maximumIdentityLength()

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.setPreSharedKey(preSharedKey)

Parameters

preSharedKey – PySide6.QtCore.QByteArray

Sets the pre shared key to preSharedKey.

Note

it is possible to set a key whose length is greater than the maximumPreSharedKeyLength() ; in this case, only the first maximumPreSharedKeyLength() bytes will be actually sent to the server.

See also

preSharedKey() maximumPreSharedKeyLength() fromHex()

PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.swap(other)

Parameters

other – PySide6.QtNetwork.QSslPreSharedKeyAuthenticator

Swaps the QSslPreSharedKeyAuthenticator object authenticator with this object. This operation is very fast and never fails.