QSslKey

The QSslKey class provides an interface for private and public keys. More…

Synopsis

Functions

• def __eq__ (key)

• def __ne__ (key)

• def algorithm ()

• def clear ()

• def handle ()

• def isNull ()

• def length ()

• def swap (other)

• def toDer ([passPhrase=QByteArray()])

• def toPem ([passPhrase=QByteArray()])

• def type ()

Detailed Description

QSslKey provides a simple API for managing keys.

See also

QSslSocket QSslCertificate QSslCipher

class PySide2.QtNetwork.QSslKey

PySide2.QtNetwork.QSslKey(device, algorithm[, format=QSsl.Pem[, type=QSsl.PrivateKey[, passPhrase=QByteArray()]]])

PySide2.QtNetwork.QSslKey(handle[, type=QSsl.PrivateKey])

PySide2.QtNetwork.QSslKey(encoded, algorithm[, format=QSsl.Pem[, type=QSsl.PrivateKey[, passPhrase=QByteArray()]]])

PySide2.QtNetwork.QSslKey(other)

param type:

KeyType

param format:

EncodingFormat

param passPhrase:

PySide2.QtCore.QByteArray

param device:

PySide2.QtCore.QIODevice

param algorithm:

KeyAlgorithm

param other:

PySide2.QtNetwork.QSslKey

param handle:

Qt::HANDLE

param encoded:

PySide2.QtCore.QByteArray

Constructs a null key.

See also

isNull()

Constructs a QSslKey from a valid native key handle . type specifies whether the key is public or private.

QSslKey will take ownership for this key and you must not free the key using the native library.

PySide2.QtNetwork.QSslKey.algorithm()

Return type:

KeyAlgorithm

Returns the key algorithm.

PySide2.QtNetwork.QSslKey.clear()

Clears the contents of this key, making it a null key.

See also

isNull()

PySide2.QtNetwork.QSslKey.handle()

Return type:

Qt::HANDLE

Returns a pointer to the native key handle, if there is one, else None .

You can use this handle together with the native API to access extended information about the key.

Warning

Use of this function has a high probability of being non-portable, and its return value may vary across platforms, and between minor Qt releases.

PySide2.QtNetwork.QSslKey.isNull()

Return type:

bool

Returns true if this is a null key; otherwise false.

See also

clear()

PySide2.QtNetwork.QSslKey.length()

Return type:

int

Returns the length of the key in bits, or -1 if the key is null.

PySide2.QtNetwork.QSslKey.__ne__(key)

Parameters:

key – PySide2.QtNetwork.QSslKey

Return type:

bool

Returns true if this key is not equal to key other ; otherwise returns false .

PySide2.QtNetwork.QSslKey.__eq__(key)

Parameters:

key – PySide2.QtNetwork.QSslKey

Return type:

bool

Returns true if this key is equal to other ; otherwise returns false .

PySide2.QtNetwork.QSslKey.swap(other)

Parameters:

other – PySide2.QtNetwork.QSslKey

Swaps this ssl key with other . This function is very fast and never fails.

PySide2.QtNetwork.QSslKey.toDer([passPhrase=QByteArray()])

Parameters:

passPhrase – PySide2.QtCore.QByteArray

Return type:

PySide2.QtCore.QByteArray

Returns the key in DER encoding.

The passPhrase argument should be omitted as DER cannot be encrypted. It will be removed in a future version of Qt.

PySide2.QtNetwork.QSslKey.toPem([passPhrase=QByteArray()])

Parameters:

passPhrase – PySide2.QtCore.QByteArray

Return type:

PySide2.QtCore.QByteArray

Returns the key in PEM encoding. The result is encrypted with passPhrase if the key is a private key and passPhrase is non-empty.

PySide2.QtNetwork.QSslKey.type()

Return type:

KeyType

Returns the type of the key (i.e., PublicKey or PrivateKey).