diff options
author | Michal Klocek <michal.klocek@qt.io> | 2020-08-06 17:08:25 +0200 |
---|---|---|
committer | Michal Klocek <michal.klocek@qt.io> | 2020-08-14 16:34:48 +0200 |
commit | c7a10dd8b0426a84205958a3f832a36fd35e24ca (patch) | |
tree | bb0dbdc2eecc767d1f12552289889c81dfa8d3cd /src | |
parent | 26bc12617efaae040dbd6166c2da27236104bf43 (diff) | |
download | qtwebengine-c7a10dd8b0426a84205958a3f832a36fd35e24ca.tar.gz |
Move WebEngineCertificateError docs to own file
Change-Id: I097666c7b55d1a49ec3f88662d73063f13ce44a2
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/webengine/doc/src/webengine_certificate_error.qdoc | 133 | ||||
-rw-r--r-- | src/webengine/doc/src/webengineview_lgpl.qdoc | 106 |
2 files changed, 133 insertions, 106 deletions
diff --git a/src/webengine/doc/src/webengine_certificate_error.qdoc b/src/webengine/doc/src/webengine_certificate_error.qdoc new file mode 100644 index 000000000..8c032dc8b --- /dev/null +++ b/src/webengine/doc/src/webengine_certificate_error.qdoc @@ -0,0 +1,133 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \qmltype WebEngineCertificateError + \instantiates QWebEngineCertificateError + \inqmlmodule QtWebEngine + \since QtWebEngine 1.1 + + \brief A utility type for ignoring certificate errors or rejecting erroneous certificates. + + This QML type contains information about a certificate error that occurred. The \l error + property holds the reason that the error occurred and the \l description property holds a + short localized description of the error. The \l url property holds the URL that triggered + the error. + + The certificate can be rejected by calling \l 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 \l ignoreCertificateError, which will + resume loading the request. + + It is possible to defer the decision of rejecting a certificate by calling \l defer, + which is useful when waiting for user input. + + \sa WebEngineView::certificateError +*/ +/*! + \qmlmethod void WebEngineCertificateError::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. + */ +/*! + \qmlmethod void WebEngineCertificateError::ignoreCertificateError() + + The certificate error is ignored, and the web engine view continues to load the requested URL. + */ +/*! + \qmlmethod void WebEngineCertificateError::rejectCertificate() + + The certificate is rejected, and the web engine view stops loading the requested URL. + */ +/*! + \qmlproperty url WebEngineCertificateError::url + \readonly + + The URL that triggered the error. + */ +/*! + \qmlproperty enumeration WebEngineCertificateError::error + \readonly + + The type of the error. + + \value WebEngineCertificateError.SslPinnedKeyNotInCertificateChain + The certificate did not match the built-in public keys pinned for + the host name. + \value WebEngineCertificateError.CertificateCommonNameInvalid + The certificate's common name did not match the host name. + \value WebEngineCertificateError.CertificateDateInvalid + The certificate is not valid at the current date and time. + \value WebEngineCertificateError.CertificateAuthorityInvalid + The certificate is not signed by a trusted authority. + \value WebEngineCertificateError.CertificateContainsErrors + The certificate contains errors. + \value WebEngineCertificateError.CertificateNoRevocationMechanism + The certificate has no mechanism for determining if it has been + revoked. + \value WebEngineCertificateError.CertificateUnableToCheckRevocation + Revocation information for the certificate is not available. + \value WebEngineCertificateError.CertificateRevoked + The certificate has been revoked. + \value WebEngineCertificateError.CertificateInvalid + The certificate is invalid. + \value WebEngineCertificateError.CertificateWeakSignatureAlgorithm + The certificate is signed using a weak signature algorithm. + \value WebEngineCertificateError.CertificateNonUniqueName + The host name specified in the certificate is not unique. + \value WebEngineCertificateError.CertificateWeakKey + The certificate contains a weak key. + \value WebEngineCertificateError.CertificateNameConstraintViolation + The certificate claimed DNS names that are in violation of name + constraints. + \value WebEngineCertificateError.CertificateValidityTooLong + The certificate has a validity period that is too long. + (Added in 5.7) + \value 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) + \value WebEngineCertificateError.CertificateKnownInterceptionBlocked + The certificate is known to be used for interception by an entity other + the device owner. (Added in 5.15) + +*/ +/*! + \qmlproperty string WebEngineCertificateError::description + \readonly + + A short localized human-readable description of the error. +*/ +/*! + \qmlproperty bool WebEngineCertificateError::overridable + \readonly + + A boolean that indicates whether the certificate error can be overridden and ignored. +*/ diff --git a/src/webengine/doc/src/webengineview_lgpl.qdoc b/src/webengine/doc/src/webengineview_lgpl.qdoc index fe31e74a9..2be475903 100644 --- a/src/webengine/doc/src/webengineview_lgpl.qdoc +++ b/src/webengine/doc/src/webengineview_lgpl.qdoc @@ -1496,109 +1496,3 @@ \sa renderProcessPid */ -/*! - \qmltype WebEngineCertificateError - \instantiates QWebEngineCertificateError - \inqmlmodule QtWebEngine - \since QtWebEngine 1.1 - - \brief A utility type for ignoring certificate errors or rejecting erroneous certificates. - - This QML type contains information about a certificate error that occurred. The \l error - property holds the reason that the error occurred and the \l description property holds a - short localized description of the error. The \l url property holds the URL that triggered - the error. - - The certificate can be rejected by calling \l 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 \l ignoreCertificateError, which will - resume loading the request. - - It is possible to defer the decision of rejecting a certificate by calling \l defer, - which is useful when waiting for user input. - - \sa WebEngineView::certificateError -*/ -/*! - \qmlmethod void WebEngineCertificateError::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. - */ -/*! - \qmlmethod void WebEngineCertificateError::ignoreCertificateError() - - The certificate error is ignored, and the web engine view continues to load the requested URL. - */ -/*! - \qmlmethod void WebEngineCertificateError::rejectCertificate() - - The certificate is rejected, and the web engine view stops loading the requested URL. - */ -/*! - \qmlproperty url WebEngineCertificateError::url - \readonly - - The URL that triggered the error. - */ -/*! - \qmlproperty enumeration WebEngineCertificateError::error - \readonly - - The type of the error. - - \value WebEngineCertificateError.SslPinnedKeyNotInCertificateChain - The certificate did not match the built-in public keys pinned for - the host name. - \value WebEngineCertificateError.CertificateCommonNameInvalid - The certificate's common name did not match the host name. - \value WebEngineCertificateError.CertificateDateInvalid - The certificate is not valid at the current date and time. - \value WebEngineCertificateError.CertificateAuthorityInvalid - The certificate is not signed by a trusted authority. - \value WebEngineCertificateError.CertificateContainsErrors - The certificate contains errors. - \value WebEngineCertificateError.CertificateNoRevocationMechanism - The certificate has no mechanism for determining if it has been - revoked. - \value WebEngineCertificateError.CertificateUnableToCheckRevocation - Revocation information for the certificate is not available. - \value WebEngineCertificateError.CertificateRevoked - The certificate has been revoked. - \value WebEngineCertificateError.CertificateInvalid - The certificate is invalid. - \value WebEngineCertificateError.CertificateWeakSignatureAlgorithm - The certificate is signed using a weak signature algorithm. - \value WebEngineCertificateError.CertificateNonUniqueName - The host name specified in the certificate is not unique. - \value WebEngineCertificateError.CertificateWeakKey - The certificate contains a weak key. - \value WebEngineCertificateError.CertificateNameConstraintViolation - The certificate claimed DNS names that are in violation of name - constraints. - \value WebEngineCertificateError.CertificateValidityTooLong - The certificate has a validity period that is too long. - (Added in 5.7) - \value 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) - \value WebEngineCertificateError.CertificateKnownInterceptionBlocked - The certificate is known to be used for interception by an entity other - the device owner. (Added in 5.15) - -*/ -/*! - \qmlproperty string WebEngineCertificateError::description - \readonly - - A short localized human-readable description of the error. -*/ -/*! - \qmlproperty bool WebEngineCertificateError::overridable - \readonly - - A boolean that indicates whether the certificate error can be overridden and ignored. -*/ |