summaryrefslogtreecommitdiffstats
path: root/src/core/api/qwebengineclientcertificatestore.cpp
blob: 850dd16d751c21bd3dbe61483f9a3045a0fa2dfd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/****************************************************************************
**
** 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 "qwebengineclientcertificatestore.h"

#include "net/client_cert_store_data.h"

#include <QByteArray>
#include <QList>

QT_BEGIN_NAMESPACE

#if QT_CONFIG(ssl)

QWebEngineClientCertificateStore *QWebEngineClientCertificateStore::m_instance = nullptr;

/*!
    \class QWebEngineClientCertificateStore::Entry
    \inmodule QtWebEngineCore
    \since 5.13
    \brief This structure holds the certificate and the private key.
*/

/*!
    \class QWebEngineClientCertificateStore
    \inmodule QtWebEngineCore
    \since 5.13
    \brief The QWebEngineClientCertificateStore class provides an in-memory store for client certificates.

    The class allows to store client certificates in an in-memory store.
    When a web site requests an SSL client certificate, the QWebEnginePage::selectClientCertificate
    signal is emitted with matching certificates from the native certificate store or the in-memory store.
    The getInstance() method can be used to access the single instance of the class.
*/

QWebEngineClientCertificateStore::QWebEngineClientCertificateStore()
        : d_ptr(new QtWebEngineCore::ClientCertificateStoreData)
{
}

/*!
    Destroys this QWebEngineClientCertificateStore object.
*/

QWebEngineClientCertificateStore::~QWebEngineClientCertificateStore()
{
    // Just in case user has not deleted in-memory certificates
    clear();
}

/*!
    Returns an in-memory client certificate store.
*/

QWebEngineClientCertificateStore *QWebEngineClientCertificateStore::getInstance()
{
    if (!m_instance)
        m_instance = new QWebEngineClientCertificateStore;
    return m_instance;
}

/*!
    Adds a \a certificate with the \a privateKey to the in-memory client certificate store.
*/

void QWebEngineClientCertificateStore::add(const QSslCertificate &certificate, const QSslKey &privateKey)
{
    d_ptr->add(certificate, privateKey);
}

/*!
    Returns a list of private and public keys of client certificates in the in-memory store.
    Returns an empty list if the in-memory store does not contain certificates.
*/

QList<QWebEngineClientCertificateStore::Entry> QWebEngineClientCertificateStore::toList() const
{
    QList<Entry> certificateList;
    for (auto data : qAsConst(d_ptr->addedCerts)) {
        Entry entry;
        entry.certificate = data->certificate;
        entry.privateKey = data->key;
        certificateList.append(entry);
    }
    return certificateList;
}

/*!
    Deletes all the instances of the client certificate in the in-memory client certificate store
    that matches the certificate in the \a entry.
*/

void QWebEngineClientCertificateStore::remove(Entry entry)
{
    auto it = d_ptr->addedCerts.begin();
    while (it != d_ptr->addedCerts.end()) {
        auto *overrideData = *it;
        if (entry.certificate.toDer() == overrideData->certificate.toDer()) {
            d_ptr->deletedCerts.append(overrideData);
            it = d_ptr->addedCerts.erase(it);
            continue;
        }
        ++it;
    }
}

/*!
    Clears all the client certificates from the in-memory store.
*/

void QWebEngineClientCertificateStore::clear()
{
    d_ptr->deletedCerts.append(d_ptr->addedCerts);
    d_ptr->addedCerts.clear();
}

#endif // QT_CONFIG(ssl)

QT_END_NAMESPACE