[GTK] Improve documentation of webkit_web_view_get_tls_info()
authorcommit-queue@webkit.org <commit-queue@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Sat, 18 Oct 2014 15:54:59 +0000 (15:54 +0000)
committercommit-queue@webkit.org <commit-queue@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Sat, 18 Oct 2014 15:54:59 +0000 (15:54 +0000)
https://bugs.webkit.org/show_bug.cgi?id=137852

Patch by Michael Catanzaro <mcatanzaro@igalia.com> on 2014-10-18
Reviewed by Martin Robinson.

* UIProcess/API/gtk/WebKitWebView.cpp:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@174861 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/WebKit2/ChangeLog
Source/WebKit2/UIProcess/API/gtk/WebKitWebView.cpp

index 24583f3..710d96d 100644 (file)
@@ -1,3 +1,12 @@
+2014-10-18  Michael Catanzaro  <mcatanzaro@igalia.com>
+
+        [GTK] Improve documentation of webkit_web_view_get_tls_info()
+        https://bugs.webkit.org/show_bug.cgi?id=137852
+
+        Reviewed by Martin Robinson.
+
+        * UIProcess/API/gtk/WebKitWebView.cpp:
+
 2014-10-17  Chris Dumez  <cdumez@apple.com>
 
         Use is<>() / downcast<>() for RenderBox
index b8786d9..ebfb865 100644 (file)
@@ -3185,7 +3185,7 @@ WebKitDownload* webkit_web_view_download_uri(WebKitWebView* webView, const char*
  * @certificate: (out) (transfer none): return location for a #GTlsCertificate
  * @errors: (out): return location for a #GTlsCertificateFlags the verification status of @certificate
  *
- * Retrieves the #GTlsCertificate associated with the @web_view connection,
+ * Retrieves the #GTlsCertificate associated with the main resource of @web_view,
  * and the #GTlsCertificateFlags showing what problems, if any, have been found
  * with that certificate.
  * If the connection is not HTTPS, this function returns %FALSE.
@@ -3193,6 +3193,13 @@ WebKitDownload* webkit_web_view_download_uri(WebKitWebView* webView, const char*
  * server, so you can connect to #WebKitWebView::load-changed and call this function
  * when it's emitted with %WEBKIT_LOAD_COMMITTED event.
  *
+ * Note that this function provides no information about the security of the web
+ * page if the current #WebKitTLSErrorsPolicy is @WEBKIT_TLS_ERRORS_POLICY_IGNORE,
+ * as subresources of the page may be controlled by an attacker. This function
+ * may safely be used to determine the security status of the current page only
+ * if the current #WebKitTLSErrorsPolicy is @WEBKIT_TLS_ERRORS_POLICY_FAIL, in
+ * which case subresources that fail certificate verification will be blocked.
+ *
  * Returns: %TRUE if the @web_view connection uses HTTPS and a response has been received
  *    from the server, or %FALSE otherwise.
  */