QMessageAuthenticationCode¶

PyQt5.QtCore.QMessageAuthenticationCode

Description¶

The QMessageAuthenticationCode class provides a way to generate hash-based message authentication codes.

QMessageAuthenticationCode supports all cryptographic hashes which are supported by QCryptographicHash.

To generate message authentication code, pass hash algorithm Algorithm to constructor, then set key and message by setKey() and addData() functions. Result can be acquired by result() function.

#     QByteArray key = "key";
#     QByteArray message = "The quick brown fox jumps over the lazy dog";

#     QMessageAuthenticationCode code(QCryptographicHash::Sha1);
#     code.setKey(key);
#     code.addData(message);
#     code.result().toHex();      // returns "de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9"

Alternatively, this effect can be achieved by providing message, key and method to hash() method.

#     QMessageAuthenticationCode::hash(message, key, QCryptographicHash::Sha1).toHex();

Methods¶

__init__(Algorithm, key: Union[QByteArray, bytes, bytearray] = QByteArray()): Constructs an object that can be used to create a cryptographic hash from data using method method and key key.

addData(Union[QByteArray, bytes, bytearray]): This function overloads addData().

addData(QIODevice) → bool

Reads the data from the open QIODevice device until it ends and adds it to message. Returns true if reading was successful.

Note: device must be already opened.

addData(str, int): Adds the first length chars of data to the message.

@staticmethod hash(Union[QByteArray, bytes, bytearray], Union[QByteArray, bytes, bytearray], Algorithm) → QByteArray: Returns the authentication code for the message message using the key key and the method method.

reset(): Resets message data. Calling this method doesn’t affect the key.

result() → QByteArray: Returns the final authentication code.

See also

toHex().

setKey(Union[QByteArray, bytes, bytearray]): Sets secret key. Calling this method automatically resets the object state.