PySide6.QtNetwork.QSslCertificate¶

class QSslCertificate¶

The QSslCertificate class provides a convenient API for an X509 certificate.

Details

QSslCertificate stores an X509 certificate, and is commonly used to verify the identity and store information about the local host, a remotely connected peer, or a trusted third party Certificate Authority.

There are many ways to construct a QSslCertificate . The most common way is to call peerCertificate() , which returns a QSslCertificate object, or peerCertificateChain() , which returns a list of them. You can also load certificates from a DER (binary) or PEM (Base64) encoded bundle, typically stored as one or more local files, or in a Qt Resource.

You can call isNull() to check if your certificate is null. By default, QSslCertificate constructs a null certificate. A null certificate is invalid, but an invalid certificate is not necessarily null. If you want to reset all contents in a certificate, call clear() .

After loading a certificate, you can find information about the certificate, its subject, and its issuer, by calling one of the many accessor functions, including version() , serialNumber() , issuerInfo() and subjectInfo() . You can call effectiveDate() and expiryDate() to check when the certificate starts being effective and when it expires. The publicKey() function returns the certificate subject’s public key as a QSslKey . You can call issuerInfo() or subjectInfo() to get detailed information about the certificate issuer and its subject.

Internally, QSslCertificate is stored as an X509 structure. You can access this handle by calling handle() , but the results are likely to not be portable.

See also

QSslSocket QSslKey QSslCipher QSslError

Synopsis¶

Methods¶

def __init__()
def clear()
def digest()
def effectiveDate()
def expiryDate()
def extensions()
def handle()
def isBlacklisted()
def isNull()
def isSelfSigned()
def issuerDisplayName()
def issuerInfo()
def issuerInfoAttributes()
def __ne__()
def __eq__()
def publicKey()
def serialNumber()
def subjectAlternativeNames()
def subjectDisplayName()
def subjectInfo()
def subjectInfoAttributes()
def swap()
def toDer()
def toPem()
def toText()
def version()

Static functions¶

def fromData()
def fromDevice()
def fromFile()
def fromPath()
def importPkcs12()
def verify()

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

class SubjectInfo¶

Describes keys that you can pass to issuerInfo() or subjectInfo() to get information about the certificate issuer or subject.

Constant

Description

QSslCertificate.SubjectInfo.Organization

“O” The name of the organization.

QSslCertificate.SubjectInfo.CommonName

“CN” The common name; most often this is used to store the host name.

QSslCertificate.SubjectInfo.LocalityName

“L” The locality.

QSslCertificate.SubjectInfo.OrganizationalUnitName

“OU” The organizational unit name.

QSslCertificate.SubjectInfo.CountryName

“C” The country.

QSslCertificate.SubjectInfo.StateOrProvinceName

“ST” The state or province.

QSslCertificate.SubjectInfo.DistinguishedNameQualifier

The distinguished name qualifier

QSslCertificate.SubjectInfo.SerialNumber

The certificate’s serial number

QSslCertificate.SubjectInfo.EmailAddress

The email address associated with the certificate

Constant	Description
QSslCertificate.SubjectInfo.Organization	“O” The name of the organization.
QSslCertificate.SubjectInfo.CommonName	“CN” The common name; most often this is used to store the host name.
QSslCertificate.SubjectInfo.LocalityName	“L” The locality.
QSslCertificate.SubjectInfo.OrganizationalUnitName	“OU” The organizational unit name.
QSslCertificate.SubjectInfo.CountryName	“C” The country.
QSslCertificate.SubjectInfo.StateOrProvinceName	“ST” The state or province.
QSslCertificate.SubjectInfo.DistinguishedNameQualifier	The distinguished name qualifier
QSslCertificate.SubjectInfo.SerialNumber	The certificate’s serial number
QSslCertificate.SubjectInfo.EmailAddress	The email address associated with the certificate

class PatternSyntax¶

The syntax used to interpret the meaning of the pattern.

Constant

Description

QSslCertificate.PatternSyntax.PatternSyntax.RegularExpression

A rich Perl-like pattern matching syntax.

QSslCertificate.PatternSyntax.PatternSyntax.Wildcard

This provides a simple pattern matching syntax similar to that used by shells (command interpreters) for “file globbing”. See QRegularExpression::fromWildcard().

QSslCertificate.PatternSyntax.PatternSyntax.FixedString

The pattern is a fixed string. This is equivalent to using the RegularExpression pattern on a string in which all metacharacters are escaped using escape(). This is the default.

Constant	Description
QSslCertificate.PatternSyntax.PatternSyntax.RegularExpression	A rich Perl-like pattern matching syntax.
QSslCertificate.PatternSyntax.PatternSyntax.Wildcard	This provides a simple pattern matching syntax similar to that used by shells (command interpreters) for “file globbing”. See QRegularExpression::fromWildcard().
QSslCertificate.PatternSyntax.PatternSyntax.FixedString	The pattern is a fixed string. This is equivalent to using the RegularExpression pattern on a string in which all metacharacters are escaped using escape(). This is the default.

__init__(other)¶

Parameters:: other – QSslCertificate

Constructs an identical copy of other.

__init__(device[, format=QSsl.Pem])

Parameters:

device – QIODevice
format – EncodingFormat

Constructs a QSslCertificate by reading format encoded data from device and using the first certificate found. You can later call isNull() to see if device contained a certificate, and if this certificate was loaded successfully.

__init__([data=QByteArray()[, format=QSsl.Pem]])

Parameters:

data – QByteArray
format – EncodingFormat

Constructs a QSslCertificate by parsing the format encoded data and using the first available certificate found. You can later call isNull() to see if data contained a certificate, and if this certificate was loaded successfully.

clear()¶

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

See also

isNull()

digest([algorithm=QCryptographicHash.Md5])¶

Parameters:: algorithm – Algorithm
Return type:: QByteArray

Returns a cryptographic digest of this certificate. By default, an MD5 digest will be generated, but you can also specify a custom algorithm.

effectiveDate()¶

Return type:: QDateTime

Returns the date-time that the certificate becomes valid, or an empty QDateTime if this is a null certificate.

See also

expiryDate()

expiryDate()¶

Return type:: QDateTime

Returns the date-time that the certificate expires, or an empty QDateTime if this is a null certificate.

See also

effectiveDate()

extensions()¶

Return type:: .list of QSslCertificateExtension

Returns a list containing the X509 extensions of this certificate.

static fromData(data[, format=QSsl.Pem])¶

Parameters:

data – QByteArray
format – EncodingFormat

Return type:

.list of QSslCertificate

Searches for and parses all certificates in data that are encoded in the specified format and returns them in a list of certificates.

See also

fromDevice()

static fromDevice(device[, format=QSsl.Pem])¶

Parameters:

device – QIODevice
format – EncodingFormat

Return type:

.list of QSslCertificate

Searches for and parses all certificates in device that are encoded in the specified format and returns them in a list of certificates.

See also

fromData()

static fromFile(filePath[, format=QSsl.Pem])¶

Parameters:

filePath – str
format – EncodingFormat

Return type:

.list of QSslCertificate

Reads the data from the file filePath and parses all certificates that are encoded in the specified format and returns a list of QSslCertificate objects.

If filePath isn’t a regular file, this method will return an empty list.

See also

fromData() fromPath()

static fromPath(path[, format=QSsl.Pem[, syntax=QSslCertificate.PatternSyntax.FixedString]])¶

Parameters:

path – str
format – EncodingFormat
syntax – PatternSyntax

Return type:

.list of QSslCertificate

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Searches all files in the path for certificates encoded in the specified format and returns them in a list. path must be a file or a pattern matching one or more files, as specified by syntax.

Example:

certs = QSslCertificate.fromPath("C:/ssl/certificate.*.pem",()
                                             QSsl.Pem, QSslCertificate.Wildcard)
for cert in certs:
    print(cert.issuerInfo(QSslCertificate.Organization))