QCryptographicHash#

The QCryptographicHash class provides a way to generate cryptographic hashes. More…

Synopsis#

Functions#

def addData (data)
def addData (device)
def addData (data)
def algorithm ()
def reset ()
def result ()
def resultView ()
def swap (other)

Static functions#

def hash (data, method)
def hashLength (method)
def supportsAlgorithm (method)

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#

QCryptographicHash can be used to generate cryptographic hashes of binary or text data.

Refer to the documentation of the Algorithm enum for a list of the supported algorithms.

class PySide6.QtCore.QCryptographicHash(method)#

Parameters:: method – Algorithm

Constructs an object that can be used to create a cryptographic hash from data using method.

PySide6.QtCore.QCryptographicHash.Algorithm#

Note

In Qt versions before 5.9, when asked to generate a SHA3 hash sum, QCryptographicHash actually calculated Keccak. If you need compatibility with SHA-3 hashes produced by those versions of Qt, use the Keccak_ enumerators. Alternatively, if source compatibility is required, define the macro QT_SHA3_KECCAK_COMPAT.

Constant	Description
QCryptographicHash.Md4	Generate an MD4 hash sum
QCryptographicHash.Md5	Generate an MD5 hash sum
QCryptographicHash.Sha1	Generate an SHA-1 hash sum
QCryptographicHash.Sha224	Generate an SHA-224 hash sum (SHA-2). Introduced in Qt 5.0
QCryptographicHash.Sha256	Generate an SHA-256 hash sum (SHA-2). Introduced in Qt 5.0
QCryptographicHash.Sha384	Generate an SHA-384 hash sum (SHA-2). Introduced in Qt 5.0
QCryptographicHash.Sha512	Generate an SHA-512 hash sum (SHA-2). Introduced in Qt 5.0
QCryptographicHash.Sha3_224	Generate an SHA3-224 hash sum. Introduced in Qt 5.1
QCryptographicHash.Sha3_256	Generate an SHA3-256 hash sum. Introduced in Qt 5.1
QCryptographicHash.Sha3_384	Generate an SHA3-384 hash sum. Introduced in Qt 5.1
QCryptographicHash.Sha3_512	Generate an SHA3-512 hash sum. Introduced in Qt 5.1
QCryptographicHash.Keccak_224	Generate a Keccak-224 hash sum. Introduced in Qt 5.9.2
QCryptographicHash.Keccak_256	Generate a Keccak-256 hash sum. Introduced in Qt 5.9.2
QCryptographicHash.Keccak_384	Generate a Keccak-384 hash sum. Introduced in Qt 5.9.2
QCryptographicHash.Keccak_512	Generate a Keccak-512 hash sum. Introduced in Qt 5.9.2
QCryptographicHash.Blake2b_160	Generate a BLAKE2b-160 hash sum. Introduced in Qt 6.0
QCryptographicHash.Blake2b_256	Generate a BLAKE2b-256 hash sum. Introduced in Qt 6.0
QCryptographicHash.Blake2b_384	Generate a BLAKE2b-384 hash sum. Introduced in Qt 6.0
QCryptographicHash.Blake2b_512	Generate a BLAKE2b-512 hash sum. Introduced in Qt 6.0
QCryptographicHash.Blake2s_128	Generate a BLAKE2s-128 hash sum. Introduced in Qt 6.0
QCryptographicHash.Blake2s_160	Generate a BLAKE2s-160 hash sum. Introduced in Qt 6.0
QCryptographicHash.Blake2s_224	Generate a BLAKE2s-224 hash sum. Introduced in Qt 6.0
QCryptographicHash.Blake2s_256	Generate a BLAKE2s-256 hash sum. Introduced in Qt 6.0

PySide6.QtCore.QCryptographicHash.addData(data)#

Parameters:: data – QByteArrayView

Adds the characters in bytes to the cryptographic hash.

Note

In Qt versions prior to 6.3, this function took QByteArray , not QByteArrayView .

PySide6.QtCore.QCryptographicHash.addData(device)

Parameters:: device – PySide6.QtCore.QIODevice
Return type:: bool

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

PySide6.QtCore.QCryptographicHash.addData(data)

Parameters:: data – str

Note

This function is deprecated.

Adds the first length chars of data to the cryptographic hash.

Use the QByteArrayView overload instead.

PySide6.QtCore.QCryptographicHash.algorithm()#

Return type:: Algorithm

Returns the algorithm used to generate the cryptographic hash.

static PySide6.QtCore.QCryptographicHash.hash(data, method)#

Parameters:

data – QByteArrayView
method – Algorithm

Return type:

PySide6.QtCore.QByteArray

Returns the hash of data using method.

Note

In Qt versions prior to 6.3, this function took QByteArray , not QByteArrayView .

static PySide6.QtCore.QCryptographicHash.hashLength(method)#

Parameters:: method – Algorithm
Return type:: int

Returns the size of the output of the selected hash method in bytes.

PySide6.QtCore.QCryptographicHash.reset()#

Resets the object.

PySide6.QtCore.QCryptographicHash.result()#

Return type:: PySide6.QtCore.QByteArray

Returns the final hash value.

See also

resultView() toHex()

PySide6.QtCore.QCryptographicHash.resultView()#

Return type:: QByteArrayView

Returns the final hash value.

Note that the returned view remains valid only as long as the QCryptographicHash object is not modified by other means.

See also

result()

static PySide6.QtCore.QCryptographicHash.supportsAlgorithm(method)#

Parameters:: method – Algorithm
Return type:: bool

Returns whether the selected algorithm method is supported and if result() will return a value when the method is used.

Note

OpenSSL will be responsible for providing this information when used as a provider, otherwise true will be returned as the non-OpenSSL implementation doesn’t have any restrictions. We return false if we fail to query OpenSSL.

PySide6.QtCore.QCryptographicHash.swap(other)#

Parameters:: other – PySide6.QtCore.QCryptographicHash

Swaps cryptographic hash other with this cryptographic hash. This operation is very fast and never fails.