Add support for client-certificate selection to QML

Task-number: QTBUG-69363
Change-Id: I54d1df17d82bf2297f43762b0ba86a080bafee23
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>

4 files changed, 389 insertions, 4 deletions

diff --git a/src/webengine/api/qquickwebengineclientcertificateselection.cpp b/src/webengine/api/qquickwebengineclientcertificateselection.cpp
new file mode 100644
index 000000000..56cf1ff64
--- /dev/null
+++ b/src/webengine/api/qquickwebengineclientcertificateselection.cpp
@@ -0,0 +1,239 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qquickwebengineclientcertificateselection_p.h"
+
+#if QT_VERSION >= QT_VERSION_CHECK(5, 12, 0)
+
+#include "client_cert_select_controller.h"
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \qmltype WebEngineClientCertificateOption
+    \instantiates QQuickWebEngineClientCertificateOption
+    \inqmlmodule QtWebEngine
+    \since QtWebEngine 1.9
+    \brief Represents a client certificate option.
+
+    \sa {WebEngineClientCertificateSelection::certificates} {WebEngineClientCertificateSelection.certificates}
+*/
+
+QQuickWebEngineClientCertificateOption::QQuickWebEngineClientCertificateOption() = default;
+
+QQuickWebEngineClientCertificateOption::QQuickWebEngineClientCertificateOption(QQuickWebEngineClientCertificateSelection *selection, int index)
+        : QObject(), m_selection(selection), m_index(index)
+{}
+
+QQuickWebEngineClientCertificateOption::QQuickWebEngineClientCertificateOption(const QQuickWebEngineClientCertificateOption &other)
+        : QObject(), m_selection(other.m_selection), m_index(other.m_index)
+{}
+
+QQuickWebEngineClientCertificateOption &QQuickWebEngineClientCertificateOption::operator=(const QQuickWebEngineClientCertificateOption &other)
+{
+    m_selection = other.m_selection;
+    m_index = other.m_index;
+    return *this;
+}
+
+/*!
+    \qmlproperty string WebEngineClientCertificateOption::issuer
+    \brief The issuer of the certificate.
+*/
+
+QString QQuickWebEngineClientCertificateOption::issuer() const
+{
+    return m_selection->d_ptr->certificates().at(m_index).issuerDisplayName();
+}
+
+/*!
+    \qmlproperty string WebEngineClientCertificateOption::subject
+    \brief The subject of the certificate.
+*/
+QString QQuickWebEngineClientCertificateOption::subject() const
+{
+    return m_selection->d_ptr->certificates().at(m_index).subjectDisplayName();
+}
+
+/*!
+    \qmlproperty datetime WebEngineClientCertificateOption::effectiveDate
+    \brief The date and time when the certificate becomes valid.
+*/
+QDateTime QQuickWebEngineClientCertificateOption::effectiveDate() const
+{
+    return m_selection->d_ptr->certificates().at(m_index).effectiveDate();
+}
+
+/*!
+    \qmlproperty datetime WebEngineClientCertificateOption::expiryDate
+    \brief The date and time when the certificate becomes invalid.
+*/
+QDateTime QQuickWebEngineClientCertificateOption::expiryDate() const
+{
+    return m_selection->d_ptr->certificates().at(m_index).expiryDate();
+}
+
+/*!
+    \qmlproperty bool WebEngineClientCertificateOption::isSelfSigned
+    \brief Whether the certificate is only self-signed.
+*/
+bool QQuickWebEngineClientCertificateOption::isSelfSigned() const
+{
+    return m_selection->d_ptr->certificates().at(m_index).isSelfSigned();
+}
+
+/*!
+    \qmlmethod void WebEngineClientCertificateOption::select()
+
+    Selects this client certificate option.
+*/
+void QQuickWebEngineClientCertificateOption::select()
+{
+    m_selection->select(m_index);
+}
+
+/*!
+    \qmltype WebEngineClientCertificateSelection
+    \instantiates QQuickWebEngineClientCertificateSelection
+    \inqmlmodule QtWebEngine
+    \since QtWebEngine 1.9
+    \brief Provides a selection of client certificates.
+
+    When a web site requests an SSL client certificate, and one or more certificates
+    are found in the system's client certificate store, this type provides access to
+    the certificates to choose from, as well as a method for selecting one.
+
+    The selection is asynchronous. If no certificate is selected and no copy of the
+    object is kept alive, loading will continue without a certificate.
+
+    \sa {WebEngineView::selectClientCertificate}{WebEngineView.selectClientCertificate}
+*/
+
+QQuickWebEngineClientCertificateSelection::QQuickWebEngineClientCertificateSelection(QSharedPointer<ClientCertSelectController> selectController)
+        : QObject(), d_ptr(selectController)
+{}
+
+int QQuickWebEngineClientCertificateSelection::certificates_count(
+        QQmlListProperty<QQuickWebEngineClientCertificateOption> *p)
+{
+    Q_ASSERT(p && p->object);
+    QQuickWebEngineClientCertificateSelection *d = static_cast<QQuickWebEngineClientCertificateSelection *>(p->object);
+    return d->m_certificates.size();
+}
+
+QQuickWebEngineClientCertificateOption *QQuickWebEngineClientCertificateSelection::certificates_at(
+        QQmlListProperty<QQuickWebEngineClientCertificateOption> *p, int idx)
+{
+    Q_ASSERT(p && p->object);
+    QQuickWebEngineClientCertificateSelection *d = static_cast<QQuickWebEngineClientCertificateSelection *>(p->object);
+    if (idx < 0 || idx >= d->m_certificates.size())
+        return nullptr;
+    return &d->m_certificates[idx];
+}
+
+/*!
+    \qmlproperty list<WebEngineClientCertificateOption> WebEngineClientCertificateSelection::certificates
+    \brief The client certificates available to choose from.
+*/
+
+QQmlListProperty<QQuickWebEngineClientCertificateOption> QQuickWebEngineClientCertificateSelection::certificates()
+{
+    if (m_certificates.empty()) {
+        QVector<QSslCertificate> certificates = d_ptr->certificates();
+        for (int i = 0; i < certificates.count(); ++i)
+            m_certificates.push_back(QQuickWebEngineClientCertificateOption(this, i));
+    }
+
+    return QQmlListProperty<QQuickWebEngineClientCertificateOption>(
+                this, nullptr,
+                certificates_count,
+                certificates_at);
+}
+
+/*!
+    \qmlmethod void WebEngineClientCertificateSelection::select(WebEngineClientCertificateOption certificate)
+
+    Selects the client certificate \a certificate. The certificate must be one
+    of the offered certificates.
+
+    \sa selectNone()
+*/
+void QQuickWebEngineClientCertificateSelection::select(const QQuickWebEngineClientCertificateOption *certificate)
+{
+    select(certificate->m_index);
+}
+
+/*!
+    \qmlmethod void WebEngineClientCertificateSelection::select(int index)
+
+    Selects the client certificate at the index \a index in the list of offered certificates.
+
+    \sa selectNone()
+*/
+void QQuickWebEngineClientCertificateSelection::select(int index)
+{
+    d_ptr->select(index);
+}
+
+/*!
+    \qmlmethod void WebEngineClientCertificateSelection::selectNone()
+
+    Continues without using any of the offered certificates. This is the same
+    action as taken when destroying the last copy of this object if no
+    selection has been made.
+
+    \sa select()
+*/
+void QQuickWebEngineClientCertificateSelection::selectNone()
+{
+    d_ptr->selectNone();
+}
+
+/*!
+    \qmlproperty url WebEngineClientCertificateSelection::host
+    \brief The host and port of the server requesting the client certificate.
+*/
+QUrl QQuickWebEngineClientCertificateSelection::host() const
+{
+    return d_ptr->hostAndPort();
+}
+
+QT_END_NAMESPACE
+
+#endif // QT_VERSION >= QT_VERSION_CHECK(5, 12, 0)
diff --git a/src/webengine/api/qquickwebengineclientcertificateselection_p.h b/src/webengine/api/qquickwebengineclientcertificateselection_p.h
new file mode 100644
index 000000000..7f5a26296
--- /dev/null
+++ b/src/webengine/api/qquickwebengineclientcertificateselection_p.h
@@ -0,0 +1,135 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QQUICKWEBENGINECERTSELECTION_P_H
+#define QQUICKWEBENGINECERTSELECTION_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include <QtWebEngine/private/qtwebengineglobal_p.h>
+
+#include <QtCore/QDateTime>
+#include <QtCore/QObject>
+#include <QtCore/QSharedPointer>
+#include <QtCore/QUrl>
+#include <QtCore/QVector>
+#include <QtQml/QQmlListProperty>
+
+#if QT_VERSION >= QT_VERSION_CHECK(5, 12, 0)
+
+QT_BEGIN_NAMESPACE
+
+class ClientCertSelectController;
+class QQuickWebEngineClientCertificateSelection;
+
+class Q_WEBENGINE_PRIVATE_EXPORT QQuickWebEngineClientCertificateOption : public QObject {
+    Q_OBJECT
+    Q_PROPERTY(QString issuer READ issuer CONSTANT FINAL)
+    Q_PROPERTY(QString subject READ subject CONSTANT FINAL)
+    Q_PROPERTY(QDateTime effectiveDate READ effectiveDate CONSTANT FINAL)
+    Q_PROPERTY(QDateTime expiryDate READ expiryDate CONSTANT FINAL)
+    Q_PROPERTY(bool isSelfSigned READ isSelfSigned CONSTANT FINAL)
+
+public:
+    QQuickWebEngineClientCertificateOption();
+    QQuickWebEngineClientCertificateOption(const QQuickWebEngineClientCertificateOption &);
+    QQuickWebEngineClientCertificateOption &operator=(const QQuickWebEngineClientCertificateOption &);
+
+    QString issuer() const;
+    QString subject() const;
+    QDateTime effectiveDate() const;
+    QDateTime expiryDate() const;
+    bool isSelfSigned() const;
+
+    Q_INVOKABLE void select();
+
+private:
+    friend class QQuickWebEngineClientCertificateSelection;
+    QQuickWebEngineClientCertificateOption(QQuickWebEngineClientCertificateSelection *selection, int index);
+
+    QQuickWebEngineClientCertificateSelection *m_selection;
+    int m_index;
+};
+
+class Q_WEBENGINE_PRIVATE_EXPORT QQuickWebEngineClientCertificateSelection : public QObject {
+    Q_OBJECT
+    Q_PROPERTY(QUrl host READ host CONSTANT FINAL)
+    Q_PROPERTY(QQmlListProperty<QQuickWebEngineClientCertificateOption> certificates READ certificates CONSTANT FINAL)
+
+public:
+    QQuickWebEngineClientCertificateSelection() = default;
+
+    QUrl host() const;
+
+    Q_INVOKABLE void select(int idx);
+    Q_INVOKABLE void select(const QQuickWebEngineClientCertificateOption *certificate);
+    Q_INVOKABLE void selectNone();
+    QQmlListProperty<QQuickWebEngineClientCertificateOption> certificates();
+
+private:
+    friend class QQuickWebEngineViewPrivate;
+    friend class QQuickWebEngineClientCertificateOption;
+
+    static int certificates_count(QQmlListProperty<QQuickWebEngineClientCertificateOption> *p);
+    static QQuickWebEngineClientCertificateOption *certificates_at(QQmlListProperty<QQuickWebEngineClientCertificateOption> *p, int idx);
+
+    explicit QQuickWebEngineClientCertificateSelection(QSharedPointer<ClientCertSelectController>);
+
+    mutable QVector<QQuickWebEngineClientCertificateOption> m_certificates;
+    QSharedPointer<ClientCertSelectController> d_ptr;
+};
+
+QT_END_NAMESPACE
+
+Q_DECLARE_METATYPE(QQuickWebEngineClientCertificateOption *)
+Q_DECLARE_METATYPE(QQmlListProperty<QQuickWebEngineClientCertificateOption>)
+Q_DECLARE_METATYPE(QQuickWebEngineClientCertificateSelection *)
+
+#endif
+
+#endif // QQUICKWEBENGINECERTSELECTION_P_H
diff --git a/src/webengine/api/qquickwebengineview.cpp b/src/webengine/api/qquickwebengineview.cpp
index 353f55974..a6913e2a7 100644
--- a/src/webengine/api/qquickwebengineview.cpp
+++ b/src/webengine/api/qquickwebengineview.cpp
@@ -49,6 +49,7 @@
 #include "qquickwebengineaction_p_p.h"
 #include "qquickwebenginehistory_p.h"
 #include "qquickwebenginecertificateerror_p.h"
+#include "qquickwebengineclientcertificateselection_p.h"
 #include "qquickwebenginecontextmenurequest_p.h"
 #include "qquickwebenginedialogrequests_p.h"
 #include "qquickwebenginefaviconprovider_p_p.h"
@@ -299,9 +300,17 @@ void QQuickWebEngineViewPrivate::allowCertificateError(const QSharedPointer<Cert
         m_certificateErrorControllers.append(errorController);
 }
 
-void QQuickWebEngineViewPrivate::selectClientCert(const QSharedPointer<ClientCertSelectController> &)
+void QQuickWebEngineViewPrivate::selectClientCert(const QSharedPointer<ClientCertSelectController> &controller)
 {
-    // Doing nothing will free the select-controller and perform default continue.
+#if QT_VERSION >= QT_VERSION_CHECK(5, 12, 0)
+    Q_Q(QQuickWebEngineView);
+    QQuickWebEngineClientCertificateSelection *certSelection = new QQuickWebEngineClientCertificateSelection(controller);
+    // mark the object for gc by creating temporary jsvalue
+    qmlEngine(q)->newQObject(certSelection);
+    Q_EMIT q->selectClientCertificate(certSelection);
+#else
+    Q_UNUSED(controller);
+#endif
 }
 
 void QQuickWebEngineViewPrivate::runGeolocationPermissionRequest(const QUrl &url)
diff --git a/src/webengine/api/qquickwebengineview_p.h b/src/webengine/api/qquickwebengineview_p.h
index 2528be3f8..3a40abf0a 100644
--- a/src/webengine/api/qquickwebengineview_p.h
+++ b/src/webengine/api/qquickwebengineview_p.h
@@ -52,10 +52,10 @@
 //
 
 #include <QtWebEngine/private/qtwebengineglobal_p.h>
-#include "qquickwebenginescript.h"
 #include <QQuickItem>
 #include <QtGui/qcolor.h>
 
+#include "qquickwebenginescript.h"
 
 QT_BEGIN_NAMESPACE
 
@@ -64,6 +64,7 @@ class QQuickContextMenuBuilder;
 class QQuickWebEngineAction;
 class QQuickWebEngineAuthenticationDialogRequest;
 class QQuickWebEngineCertificateError;
+class QQuickWebEngineClientCertificateSelection;
 class QQuickWebEngineColorDialogRequest;
 class QQuickWebEngineContextMenuRequest;
 class QQuickWebEngineFaviconProvider;
@@ -103,7 +104,7 @@ private:
     const bool m_toggleOn;
 };
 
-#define LATEST_WEBENGINEVIEW_REVISION 7
+#define LATEST_WEBENGINEVIEW_REVISION 9
 
 class Q_WEBENGINE_PRIVATE_EXPORT QQuickWebEngineView : public QQuickItem {
     Q_OBJECT
@@ -549,6 +550,7 @@ Q_SIGNALS:
     Q_REVISION(7) void devToolsViewChanged();
     Q_REVISION(7) void registerProtocolHandlerRequested(const QWebEngineRegisterProtocolHandlerRequest &request);
     Q_REVISION(8) void printRequested();
+    Q_REVISION(9) void selectClientCertificate(QQuickWebEngineClientCertificateSelection *clientCertSelection);
 
 #if QT_CONFIG(webengine_testsupport)
     void testSupportChanged();