QSslPreSharedKeyAuthenticator#
The QSslPreSharedKeyAuthenticator
class provides authentication data for pre shared keys (PSK) ciphersuites. More…
Synopsis#
Functions#
def
identity
()def
identityHint
()def
maximumIdentityLength
()def
maximumPreSharedKeyLength
()def
__ne__
(rhs)def
__eq__
(rhs)def
preSharedKey
()def
setIdentity
(identity)def
setPreSharedKey
(preSharedKey)def
swap
(other)
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description#
Warning
This section contains snippets that were automatically translated from C++ to Python and may contain errors.
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:
socket.preSharedKeyAuthenticationRequired.connect( self.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.
- 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:
Returns the PSK client identity.
See also
- PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.identityHint()#
- Return type:
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 maximumIdentityLength(); in this case, only the first maximumIdentityLength() bytes will be actually sent to the server.
See also
- 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 maximumPreSharedKeyLength(); in this case, only the first maximumPreSharedKeyLength() bytes will be actually sent to the server.
See also
- PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.__ne__(rhs)#
- Parameters:
- Return type:
bool
Returns true
if the authenticator object lhs
is not equal to rhs
; false
otherwise.
- PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.__eq__(rhs)#
- Parameters:
- Return type:
bool
Returns true
if the authenticator object lhs
is equal to rhs
; false
otherwise.
Two authenticator objects are equal if and only if they have the same identity hint, identity, pre shared key, maximum length for the identity and maximum length for the pre shared key.
- PySide6.QtNetwork.QSslPreSharedKeyAuthenticator.preSharedKey()#
- Return type:
Returns the pre shared key.
See also
- 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
- 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:
Swaps the QSslPreSharedKeyAuthenticator
object authenticator
with this object. This operation is very fast and never fails.