KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QSslCertificate

Notation used in Ruby API documentation

Module: QtNetwork

Description: Binding of QSslCertificate

Sub-classes: SubjectInfo, QFlags_SubjectInfo

Public constructors

new QSslCertificatenew(QIODevice ptr device,
const QSsl_EncodingFormat format = QSsl::Pem)
Constructor QSslCertificate::QSslCertificate(QIODevice *device, QSsl::EncodingFormat format)
new QSslCertificatenew(bytes data = QByteArray(),
const QSsl_EncodingFormat format = QSsl::Pem)
Constructor QSslCertificate::QSslCertificate(const QByteArray &data, QSsl::EncodingFormat format)
new QSslCertificatenew(const QSslCertificate other)Constructor QSslCertificate::QSslCertificate(const QSslCertificate &other)

Public methods

[const]bool!=(const QSslCertificate other)Method bool QSslCertificate::operator!=(const QSslCertificate &other)
[const]bool==(const QSslCertificate other)Method bool QSslCertificate::operator==(const QSslCertificate &other)
void_assign(const QSslCertificate other)Assigns another object to self
[const]QSslCertificate ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
QSslCertificateassign(const QSslCertificate other)Method QSslCertificate &QSslCertificate::operator=(const QSslCertificate &other)
voidclearMethod void QSslCertificate::clear()
[const]bytesdigest(const QCryptographicHash_Algorithm algorithm = QCryptographicHash::Md5)Method QByteArray QSslCertificate::digest(QCryptographicHash::Algorithm algorithm)
[const]new QSslCertificate ptrdupCreates a copy of self
[const]QDateTimeeffectiveDateMethod QDateTime QSslCertificate::effectiveDate()
[const]QDateTimeexpiryDateMethod QDateTime QSslCertificate::expiryDate()
[const]QSslCertificateExtension[]extensionsMethod QList<QSslCertificateExtension> QSslCertificate::extensions()
[const]void *handleMethod Qt::HANDLE QSslCertificate::handle()
[const]boolisBlacklisted?Method bool QSslCertificate::isBlacklisted()
[const]boolisNull?Method bool QSslCertificate::isNull()
[const]boolisSelfSigned?Method bool QSslCertificate::isSelfSigned()
[const]stringissuerDisplayNameMethod QString QSslCertificate::issuerDisplayName()
[const]string[]issuerInfo(const QSslCertificate_SubjectInfo info)Method QStringList QSslCertificate::issuerInfo(QSslCertificate::SubjectInfo info)
[const]string[]issuerInfo(bytes attribute)Method QStringList QSslCertificate::issuerInfo(const QByteArray &attribute)
[const]bytes[]issuerInfoAttributesMethod QList<QByteArray> QSslCertificate::issuerInfoAttributes()
[const]QSslKeypublicKeyMethod QSslKey QSslCertificate::publicKey()
[const]bytesserialNumberMethod QByteArray QSslCertificate::serialNumber()
[const]stringsubjectDisplayNameMethod QString QSslCertificate::subjectDisplayName()
[const]string[]subjectInfo(const QSslCertificate_SubjectInfo info)Method QStringList QSslCertificate::subjectInfo(QSslCertificate::SubjectInfo info)
[const]string[]subjectInfo(bytes attribute)Method QStringList QSslCertificate::subjectInfo(const QByteArray &attribute)
[const]bytes[]subjectInfoAttributesMethod QList<QByteArray> QSslCertificate::subjectInfoAttributes()
voidswap(QSslCertificate other)Method void QSslCertificate::swap(QSslCertificate &other)
[const]bytestoDerMethod QByteArray QSslCertificate::toDer()
[const]bytestoPemMethod QByteArray QSslCertificate::toPem()
[const]stringtoTextMethod QString QSslCertificate::toText()
[const]bytesversionMethod QByteArray QSslCertificate::version()

Public static methods and constants

[static,const]QSslCertificate_SubjectInfoCommonNameEnum constant QSslCertificate::CommonName
[static,const]QSslCertificate_SubjectInfoCountryNameEnum constant QSslCertificate::CountryName
[static,const]QSslCertificate_SubjectInfoDistinguishedNameQualifierEnum constant QSslCertificate::DistinguishedNameQualifier
[static,const]QSslCertificate_SubjectInfoEmailAddressEnum constant QSslCertificate::EmailAddress
[static,const]QSslCertificate_SubjectInfoLocalityNameEnum constant QSslCertificate::LocalityName
[static,const]QSslCertificate_SubjectInfoOrganizationEnum constant QSslCertificate::Organization
[static,const]QSslCertificate_SubjectInfoOrganizationalUnitNameEnum constant QSslCertificate::OrganizationalUnitName
[static,const]QSslCertificate_SubjectInfoSerialNumberEnum constant QSslCertificate::SerialNumber
[static,const]QSslCertificate_SubjectInfoStateOrProvinceNameEnum constant QSslCertificate::StateOrProvinceName
QSslCertificate[]fromData(bytes data,
const QSsl_EncodingFormat format = QSsl::Pem)
Static method QList<QSslCertificate> QSslCertificate::fromData(const QByteArray &data, QSsl::EncodingFormat format)
QSslCertificate[]fromDevice(QIODevice ptr device,
const QSsl_EncodingFormat format = QSsl::Pem)
Static method QList<QSslCertificate> QSslCertificate::fromDevice(QIODevice *device, QSsl::EncodingFormat format)
QSslCertificate[]fromPath(string path,
const QSsl_EncodingFormat format = QSsl::Pem,
const QRegExp_PatternSyntax syntax = QRegExp::FixedString)
Static method QList<QSslCertificate> QSslCertificate::fromPath(const QString &path, QSsl::EncodingFormat format, QRegExp::PatternSyntax syntax)
boolimportPkcs12(QIODevice ptr device,
QSslKey ptr key,
QSslCertificate ptr cert,
QSslCertificate[] ptr caCertificates = nullptr,
bytes passPhrase = QByteArray())
Static method bool QSslCertificate::importPkcs12(QIODevice *device, QSslKey *key, QSslCertificate *cert, QList<QSslCertificate> *caCertificates, const QByteArray &passPhrase)
QSslError[]verify(QSslCertificate[] certificateChain,
string hostName = QString())
Static method QList<QSslError> QSslCertificate::verify(QList<QSslCertificate> certificateChain, const QString &hostName)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QSslCertificate other)

Description: Method bool QSslCertificate::operator!=(const QSslCertificate &other)

==

Signature: [const] bool == (const QSslCertificate other)

Description: Method bool QSslCertificate::operator==(const QSslCertificate &other)

CommonName

Signature: [static,const] QSslCertificate_SubjectInfo CommonName

Description: Enum constant QSslCertificate::CommonName

Python specific notes:
The object exposes a readable attribute 'CommonName'. This is the getter.

CountryName

Signature: [static,const] QSslCertificate_SubjectInfo CountryName

Description: Enum constant QSslCertificate::CountryName

Python specific notes:
The object exposes a readable attribute 'CountryName'. This is the getter.

DistinguishedNameQualifier

Signature: [static,const] QSslCertificate_SubjectInfo DistinguishedNameQualifier

Description: Enum constant QSslCertificate::DistinguishedNameQualifier

Python specific notes:
The object exposes a readable attribute 'DistinguishedNameQualifier'. This is the getter.

EmailAddress

Signature: [static,const] QSslCertificate_SubjectInfo EmailAddress

Description: Enum constant QSslCertificate::EmailAddress

Python specific notes:
The object exposes a readable attribute 'EmailAddress'. This is the getter.

LocalityName

Signature: [static,const] QSslCertificate_SubjectInfo LocalityName

Description: Enum constant QSslCertificate::LocalityName

Python specific notes:
The object exposes a readable attribute 'LocalityName'. This is the getter.

Organization

Signature: [static,const] QSslCertificate_SubjectInfo Organization

Description: Enum constant QSslCertificate::Organization

Python specific notes:
The object exposes a readable attribute 'Organization'. This is the getter.

OrganizationalUnitName

Signature: [static,const] QSslCertificate_SubjectInfo OrganizationalUnitName

Description: Enum constant QSslCertificate::OrganizationalUnitName

Python specific notes:
The object exposes a readable attribute 'OrganizationalUnitName'. This is the getter.

SerialNumber

Signature: [static,const] QSslCertificate_SubjectInfo SerialNumber

Description: Enum constant QSslCertificate::SerialNumber

Python specific notes:
The object exposes a readable attribute 'SerialNumber'. This is the getter.

StateOrProvinceName

Signature: [static,const] QSslCertificate_SubjectInfo StateOrProvinceName

Description: Enum constant QSslCertificate::StateOrProvinceName

Python specific notes:
The object exposes a readable attribute 'StateOrProvinceName'. This is the getter.

_assign

Signature: void _assign (const QSslCertificate other)

Description: Assigns another object to self

_const_cast

Signature: [const] QSslCertificate ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: QSslCertificate assign (const QSslCertificate other)

Description: Method QSslCertificate &QSslCertificate::operator=(const QSslCertificate &other)

clear

Signature: void clear

Description: Method void QSslCertificate::clear()

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

digest

Signature: [const] bytes digest (const QCryptographicHash_Algorithm algorithm = QCryptographicHash::Md5)

Description: Method QByteArray QSslCertificate::digest(QCryptographicHash::Algorithm algorithm)

dup

Signature: [const] new QSslCertificate ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

effectiveDate

Signature: [const] QDateTime effectiveDate

Description: Method QDateTime QSslCertificate::effectiveDate()

expiryDate

Signature: [const] QDateTime expiryDate

Description: Method QDateTime QSslCertificate::expiryDate()

extensions

Signature: [const] QSslCertificateExtension[] extensions

Description: Method QList<QSslCertificateExtension> QSslCertificate::extensions()

fromData

Signature: [static] QSslCertificate[] fromData (bytes data, const QSsl_EncodingFormat format = QSsl::Pem)

Description: Static method QList<QSslCertificate> QSslCertificate::fromData(const QByteArray &data, QSsl::EncodingFormat format)

This method is static and can be called without an instance.

fromDevice

Signature: [static] QSslCertificate[] fromDevice (QIODevice ptr device, const QSsl_EncodingFormat format = QSsl::Pem)

Description: Static method QList<QSslCertificate> QSslCertificate::fromDevice(QIODevice *device, QSsl::EncodingFormat format)

This method is static and can be called without an instance.

fromPath

Signature: [static] QSslCertificate[] fromPath (string path, const QSsl_EncodingFormat format = QSsl::Pem, const QRegExp_PatternSyntax syntax = QRegExp::FixedString)

Description: Static method QList<QSslCertificate> QSslCertificate::fromPath(const QString &path, QSsl::EncodingFormat format, QRegExp::PatternSyntax syntax)

This method is static and can be called without an instance.

handle

Signature: [const] void * handle

Description: Method Qt::HANDLE QSslCertificate::handle()

importPkcs12

Signature: [static] bool importPkcs12 (QIODevice ptr device, QSslKey ptr key, QSslCertificate ptr cert, QSslCertificate[] ptr caCertificates = nullptr, bytes passPhrase = QByteArray())

Description: Static method bool QSslCertificate::importPkcs12(QIODevice *device, QSslKey *key, QSslCertificate *cert, QList<QSslCertificate> *caCertificates, const QByteArray &passPhrase)

This method is static and can be called without an instance.

isBlacklisted?

Signature: [const] bool isBlacklisted?

Description: Method bool QSslCertificate::isBlacklisted()

isNull?

Signature: [const] bool isNull?

Description: Method bool QSslCertificate::isNull()

isSelfSigned?

Signature: [const] bool isSelfSigned?

Description: Method bool QSslCertificate::isSelfSigned()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

issuerDisplayName

Signature: [const] string issuerDisplayName

Description: Method QString QSslCertificate::issuerDisplayName()

issuerInfo

(1) Signature: [const] string[] issuerInfo (const QSslCertificate_SubjectInfo info)

Description: Method QStringList QSslCertificate::issuerInfo(QSslCertificate::SubjectInfo info)

(2) Signature: [const] string[] issuerInfo (bytes attribute)

Description: Method QStringList QSslCertificate::issuerInfo(const QByteArray &attribute)

issuerInfoAttributes

Signature: [const] bytes[] issuerInfoAttributes

Description: Method QList<QByteArray> QSslCertificate::issuerInfoAttributes()

new

(1) Signature: [static] new QSslCertificate new (QIODevice ptr device, const QSsl_EncodingFormat format = QSsl::Pem)

Description: Constructor QSslCertificate::QSslCertificate(QIODevice *device, QSsl::EncodingFormat format)

This method creates an object of class QSslCertificate.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QSslCertificate new (bytes data = QByteArray(), const QSsl_EncodingFormat format = QSsl::Pem)

Description: Constructor QSslCertificate::QSslCertificate(const QByteArray &data, QSsl::EncodingFormat format)

This method creates an object of class QSslCertificate.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QSslCertificate new (const QSslCertificate other)

Description: Constructor QSslCertificate::QSslCertificate(const QSslCertificate &other)

This method creates an object of class QSslCertificate.

Python specific notes:
This method is the default initializer of the object.

publicKey

Signature: [const] QSslKey publicKey

Description: Method QSslKey QSslCertificate::publicKey()

serialNumber

Signature: [const] bytes serialNumber

Description: Method QByteArray QSslCertificate::serialNumber()

subjectDisplayName

Signature: [const] string subjectDisplayName

Description: Method QString QSslCertificate::subjectDisplayName()

subjectInfo

(1) Signature: [const] string[] subjectInfo (const QSslCertificate_SubjectInfo info)

Description: Method QStringList QSslCertificate::subjectInfo(QSslCertificate::SubjectInfo info)

(2) Signature: [const] string[] subjectInfo (bytes attribute)

Description: Method QStringList QSslCertificate::subjectInfo(const QByteArray &attribute)

subjectInfoAttributes

Signature: [const] bytes[] subjectInfoAttributes

Description: Method QList<QByteArray> QSslCertificate::subjectInfoAttributes()

swap

Signature: void swap (QSslCertificate other)

Description: Method void QSslCertificate::swap(QSslCertificate &other)

toDer

Signature: [const] bytes toDer

Description: Method QByteArray QSslCertificate::toDer()

toPem

Signature: [const] bytes toPem

Description: Method QByteArray QSslCertificate::toPem()

toText

Signature: [const] string toText

Description: Method QString QSslCertificate::toText()

verify

Signature: [static] QSslError[] verify (QSslCertificate[] certificateChain, string hostName = QString())

Description: Static method QList<QSslError> QSslCertificate::verify(QList<QSslCertificate> certificateChain, const QString &hostName)

This method is static and can be called without an instance.

version

Signature: [const] bytes version

Description: Method QByteArray QSslCertificate::version()