PySide6.QtNetwork.QSslKey¶

class QSslKey¶

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

Synopsis¶

Methods¶

def __init__()
def algorithm()
def clear()
def handle()
def isNull()
def length()
def __ne__()
def __eq__()
def swap()
def toDer()
def toPem()
def type()

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¶

QSslKey provides a simple API for managing keys.

See also

QSslSocket QSslCertificate QSslCipher

__init__()¶

Constructs a null key.

See also

isNull()

__init__(other)

Parameters:: other – QSslKey

Constructs an identical copy of other.

__init__(handle[, type=QSsl.PrivateKey])

Parameters:

handle – Qt::HANDLE
type – KeyType

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.

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

Parameters:

device – QIODevice
algorithm – KeyAlgorithm
format – EncodingFormat
type – KeyType
passPhrase – QByteArray

Constructs a QSslKey by reading and decoding data from a device using a specified algorithm and encoding format. type specifies whether the key is public or private.

If the key is encrypted then passPhrase is used to decrypt it.

After construction, use isNull() to check if device provided a valid key.

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

Parameters:

encoded – QByteArray
algorithm – KeyAlgorithm
format – EncodingFormat
type – KeyType
passPhrase – QByteArray

Constructs a QSslKey by decoding the string in the byte array encoded using a specified algorithm and encoding format. type specifies whether the key is public or private.

If the key is encrypted then passPhrase is used to decrypt it.

After construction, use isNull() to check if encoded contained a valid key.

algorithm()¶

Return type:: KeyAlgorithm

Returns the key algorithm.

clear()¶

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

See also

isNull()

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.

isNull()¶

Return type:: bool

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

See also

clear()

length()¶

Return type:: int

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

__ne__(key)¶

Parameters:: key – QSslKey
Return type:: bool

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

__eq__(key)¶

Parameters:: key – QSslKey
Return type:: bool

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

swap(other)¶

Parameters:: other – QSslKey

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

toDer([passPhrase=QByteArray()])¶

Parameters:: passPhrase – QByteArray
Return type:: 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.

toPem([passPhrase=QByteArray()])¶

Parameters:: passPhrase – QByteArray
Return type:: 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.

type()¶

Return type:: KeyType

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