QSslKey#
The QSslKey
class provides an interface for private and public keys. More…
Synopsis#
Functions#
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
- class PySide6.QtNetwork.QSslKey#
PySide6.QtNetwork.QSslKey(device, algorithm[, format=QSsl.Pem[, type=QSsl.PrivateKey[, passPhrase=QByteArray()]]])
PySide6.QtNetwork.QSslKey(handle[, type=QSsl.PrivateKey])
PySide6.QtNetwork.QSslKey(encoded, algorithm[, format=QSsl.Pem[, type=QSsl.PrivateKey[, passPhrase=QByteArray()]]])
PySide6.QtNetwork.QSslKey(other)
- Parameters:
format –
EncodingFormat
handle –
Qt::HANDLE
passPhrase –
PySide6.QtCore.QByteArray
other –
PySide6.QtNetwork.QSslKey
encoded –
PySide6.QtCore.QByteArray
type –
KeyType
device –
PySide6.QtCore.QIODevice
algorithm –
KeyAlgorithm
Constructs a null key.
See also
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.
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.
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.
Constructs an identical copy of other
.
- PySide6.QtNetwork.QSslKey.algorithm()#
- Return type:
Returns the key algorithm.
- PySide6.QtNetwork.QSslKey.clear()#
Clears the contents of this key, making it a null key.
See also
- PySide6.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.
- PySide6.QtNetwork.QSslKey.isNull()#
- Return type:
bool
Returns true
if this is a null key; otherwise false.
See also
- PySide6.QtNetwork.QSslKey.length()#
- Return type:
int
Returns the length of the key in bits, or -1 if the key is null.
- PySide6.QtNetwork.QSslKey.__ne__(key)#
- Parameters:
- Return type:
bool
Returns true
if this key is not equal to key other
; otherwise returns false
.
- PySide6.QtNetwork.QSslKey.__eq__(key)#
- Parameters:
- Return type:
bool
Returns true
if this key is equal to other
; otherwise returns false
.
- PySide6.QtNetwork.QSslKey.swap(other)#
- Parameters:
other –
PySide6.QtNetwork.QSslKey
Swaps this ssl key with other
. This function is very fast and never fails.
- PySide6.QtNetwork.QSslKey.toDer([passPhrase=QByteArray()])#
- Parameters:
passPhrase –
PySide6.QtCore.QByteArray
- Return type:
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.
- PySide6.QtNetwork.QSslKey.toPem([passPhrase=QByteArray()])#
- Parameters:
passPhrase –
PySide6.QtCore.QByteArray
- Return type:
Returns the key in PEM encoding. The result is encrypted with passPhrase
if the key is a private key and passPhrase
is non-empty.
Returns the type of the key (i.e., PublicKey or PrivateKey).