WebEngineCertificateError QML Type | Qt WebEngine 5.10

Qt 5.10 | Qt WebEngine | QML Types | WebEngineCertificateError QML Type

Qt 5.10.1 Reference Documentation

# WebEngineCertificateError QML Type

A utility type for ignoring certificate errors or rejecting erroneous certificates. More...

Import Statement: | import QtWebEngine 1.5
Since: | QtWebEngine 1.1

- List of all members, including inherited members

## Properties

- description : string
- error : enumeration
- overridable : bool
- url : url

## Methods

- void defer()
- void ignoreCertificateError()
- void rejectCertificate()

## Detailed Description

This QML type contains information about a certificate error that occurred. The error property holds the reason that the error occurred and the description property holds a short localized description of the error. The url property holds the URL that triggered the error.

The certificate can be rejected by calling rejectCertificate, which will stop loading the web engine request. By default, an invalid certificate will be automatically rejected.

The certificate error can be ignored by calling ignoreCertificateError, which will resume loading the request.

It is possible to defer the decision of rejecting a certificate by calling defer, which is useful when waiting for user input.

See also WebEngineView::certificateError.

## Property Documentation

[read-only] description : string

A short localized human-readable description of the error.

[read-only] error : enumeration

The type of the error.

Constant | Description
--- | ---
`WebEngineCertificateError.SslPinnedKeyNotInCertificateChain` | The certificate did not match the built-in public keys pinned for the host name.
`WebEngineCertificateError.CertificateCommonNameInvalid` | The certificate's common name did not match the host name.
`WebEngineCertificateError.CertificateDateInvalid` | The certificate is not valid at the current date and time.
`WebEngineCertificateError.CertificateAuthorityInvalid` | The certificate is not signed by a trusted authority.
`WebEngineCertificateError.CertificateContainsErrors` | The certificate contains errors.
`WebEngineCertificateError.CertificateNoRevocationMechanism` | The certificate has no mechanism for determining if it has been revoked.
`WebEngineCertificateError.CertificateUnableToCheckRevocation` | Revocation information for the certificate is not available.
`WebEngineCertificateError.CertificateRevoked` | The certificate has been revoked.
`WebEngineCertificateError.CertificateInvalid` | The certificate is invalid.
`WebEngineCertificateError.CertificateWeakSignatureAlgorithm` | The certificate is signed using a weak signature algorithm.
`WebEngineCertificateError.CertificateNonUniqueName` | The host name specified in the certificate is not unique.
`WebEngineCertificateError.CertificateWeakKey` | The certificate contains a weak key.
`WebEngineCertificateError.CertificateNameConstraintViolation` | The certificate claimed DNS names that are in violation of name constraints.
`WebEngineCertificateError.CertificateValidityTooLong` | The certificate has a validity period that is too long. (Added in 5.7)
`WebEngineCertificateError.CertificateTransparencyRequired` | Certificate Transparency was required for this connection, but the server did not provide CT information that complied with the policy. (Added in 5.8)

[read-only] overridable : bool

A boolean that indicates whether the certificate error can be overridden and ignored.

[read-only] url : url

The URL that triggered the error.

## Method Documentation

void defer()

This function should be called when there is a need to postpone the decision whether to ignore a certificate error, for example, while waiting for user input. When called, the function pauses the URL request until WebEngineCertificateError::ignoreCertificateError() or WebEngineCertificateError::rejectCertificate() is called.

void ignoreCertificateError()

The certificate error is ignored, and the web engine view continues to load the requested URL.

void rejectCertificate()

The certificate is rejected, and the web engine view stops loading the requested URL.