File: EnhancedSecuritySitesPersistence.cpp

package info (click to toggle)
webkit2gtk 2.51.3-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 477,912 kB
  • sloc: cpp: 3,898,343; javascript: 198,215; ansic: 165,229; python: 50,371; asm: 21,819; ruby: 18,095; perl: 16,953; xml: 4,623; sh: 2,398; yacc: 2,356; java: 2,019; lex: 1,358; pascal: 372; makefile: 197
file content (300 lines) | stat: -rw-r--r-- 11,470 bytes parent folder | download
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
/*
 * Copyright (C) 2025 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "config.h"
#include "EnhancedSecuritySitesPersistence.h"

#include "Logging.h"
#include <WebCore/RegistrableDomain.h>
#include <WebCore/SQLiteStatement.h>
#include <wtf/FileSystem.h>
#include <wtf/MainThread.h>
#include <wtf/Seconds.h>
#include <wtf/StdLibExtras.h>
#include <wtf/text/MakeString.h>

#define ENHANCEDSECURITY_RELEASE_LOG(fmt, ...) RELEASE_LOG(EnhancedSecurity, "EnhancedSecuritySitesPersistence::" fmt, ##__VA_ARGS__)

namespace WebKit {

static constexpr auto sitesTableName = "sites"_s;
static constexpr auto siteIndexName = "idx_sites_site"_s;
static constexpr auto enhancedSecurityStateIndexName = "idx_sites_enhanced_security_state"_s;

static constexpr auto createSitesTableSQL = "CREATE TABLE sites (site TEXT PRIMARY KEY NOT NULL, enhanced_security_state INT NOT NULL)"_s;
static constexpr auto createEnhancedSecurityStateIndexSQL = "CREATE INDEX idx_sites_enhanced_security_state ON sites(enhanced_security_state)"_s;

static constexpr auto selectAllSitesSQL = "SELECT site FROM sites"_s;

static_assert(!enumToUnderlyingType(EnhancedSecurity::Disabled), "EnhancedSecurity::Disabled is not 0 as expected");
static constexpr auto selectEnhancedSecurityOnlySitesSQL = "SELECT site FROM sites WHERE enhanced_security_state != 0"_s;

static constexpr auto selectSpecificSiteSQL = "SELECT enhanced_security_state FROM sites WHERE site = ?"_s;
static constexpr auto deleteAllSitesSQL = "DELETE FROM sites"_s;
static constexpr auto deleteSiteSQL = "DELETE FROM sites WHERE site = ?"_s;
static constexpr auto insertSiteSQL = "INSERT OR REPLACE INTO sites (site, enhanced_security_state) VALUES (?, ?)"_s;

EnhancedSecuritySitesPersistence::EnhancedSecuritySitesPersistence(const String& databaseDirectoryPath)
{
    ASSERT(!isMainRunLoop());
    openDatabase(databaseDirectoryPath);
}

EnhancedSecuritySitesPersistence::~EnhancedSecuritySitesPersistence()
{
    ASSERT(!isMainRunLoop());

    if (m_sqliteDB)
        closeDatabase();
}

void EnhancedSecuritySitesPersistence::reportSQLError(ASCIILiteral method, ASCIILiteral action)
{
    RELEASE_LOG_ERROR(EnhancedSecurity, "EnhancedSecuritySitesPersistence::%" PUBLIC_LOG_STRING ": Failed to %" PUBLIC_LOG_STRING " (%d) - %" PUBLIC_LOG_STRING, method.characters(), action.characters(), m_sqliteDB->lastError(), m_sqliteDB->lastErrorMsg());
}

static String databasePath(const String& directoryPath)
{
    ASSERT(!directoryPath.isEmpty());
    return FileSystem::pathByAppendingComponent(directoryPath, "EnhancedSecuritySites.db"_s);
}

CheckedPtr<WebCore::SQLiteDatabase> EnhancedSecuritySitesPersistence::checkedDatabase() const
{
    return m_sqliteDB.get();
}

WebCore::SQLiteStatementAutoResetScope EnhancedSecuritySitesPersistence::cachedStatement(StatementType type)
{
    ASSERT(m_sqliteDB);

    switch (type) {
    case StatementType::SelectSite:
        return WebCore::SQLiteStatementAutoResetScope { m_selectSpecificSiteSQLStatement.get() };
    case StatementType::InsertSite:
        return WebCore::SQLiteStatementAutoResetScope { m_insertSiteSQLStatement.get() };
    case StatementType::DeleteSite:
        return WebCore::SQLiteStatementAutoResetScope { m_deleteSQLStatement.get() };
    }

    RELEASE_ASSERT_NOT_REACHED();
}

bool EnhancedSecuritySitesPersistence::openDatabase(const String& directoryPath)
{
    ASSERT(!isMainRunLoop());
    ASSERT(!directoryPath.isEmpty());

    FileSystem::makeAllDirectories(directoryPath);

    m_sqliteDB = makeUnique<WebCore::SQLiteDatabase>();

    CheckedPtr checkedDB = m_sqliteDB.get();

    // This database is accessed from serial queue EnhancedSecuritySitesHolder::sharedWorkQueueSingleton().
    checkedDB->disableThreadingChecks();

    auto reportErrorAndCloseDatabase = [&](ASCIILiteral action) {
        reportSQLError(__FUNCTION__, action);
        checkedDB = nullptr;
        closeDatabase();
        return false;
    };

    const auto path = databasePath(directoryPath);

    if (!checkedDB->open(path, WebCore::SQLiteDatabase::OpenMode::ReadWriteCreate, WebCore::SQLiteDatabase::OpenOptions::CanSuspendWhileLocked))
        return reportErrorAndCloseDatabase("open database"_s);

    if (!checkedDB->tableExists(sitesTableName)) {
        if (!checkedDB->executeCommand(createSitesTableSQL))
            return reportErrorAndCloseDatabase("create `sites` table"_s);

        ENHANCEDSECURITY_RELEASE_LOG("%s: Table %" PUBLIC_LOG_STRING " created", __FUNCTION__, sitesTableName.characters());
    }

    if (!checkedDB->indexExists(enhancedSecurityStateIndexName)) {
        if (!checkedDB->executeCommand(createEnhancedSecurityStateIndexSQL))
            return reportErrorAndCloseDatabase("create `enhanced_security_state` index on `sites` table"_s);

        ENHANCEDSECURITY_RELEASE_LOG("%s: Index %" PUBLIC_LOG_STRING " created", __FUNCTION__, enhancedSecurityStateIndexName.characters());
    }

    m_insertSiteSQLStatement = checkedDB->prepareStatement(insertSiteSQL);
    if (!m_insertSiteSQLStatement)
        return reportErrorAndCloseDatabase("prepare insert statement"_s);

    m_selectSpecificSiteSQLStatement = checkedDB->prepareStatement(selectSpecificSiteSQL);
    if (!m_selectSpecificSiteSQLStatement)
        return reportErrorAndCloseDatabase("prepare select specific site statement"_s);

    m_deleteSQLStatement = checkedDB->prepareStatement(deleteSiteSQL);
    if (!m_deleteSQLStatement)
        return reportErrorAndCloseDatabase("prepare delete statement"_s);

    checkedDB->turnOnIncrementalAutoVacuum();

    return true;
}

void EnhancedSecuritySitesPersistence::deleteSite(const WebCore::RegistrableDomain& site)
{
    if (!isDatabaseOpen()) {
        RELEASE_LOG_ERROR(EnhancedSecurity, "%s: Attempted operation on closed database.", __FUNCTION__);
        return;
    }

    CheckedPtr deleteStatement = cachedStatement(StatementType::DeleteSite).get();

    if (!deleteStatement
        || deleteStatement->bindText(1, site.string()) != SQLITE_OK
        || !deleteStatement->executeCommand())
        reportSQLError(__FUNCTION__, "failed to delete site"_s);
}

void EnhancedSecuritySitesPersistence::deleteSites(const Vector<WebCore::RegistrableDomain>& sites)
{
    ASSERT(!isMainRunLoop());

    if (!isDatabaseOpen()) {
        RELEASE_LOG_ERROR(EnhancedSecurity, "%s: Attempted operation on closed database.", __FUNCTION__);
        return;
    }

    for (auto& site : sites)
        deleteSite(site);
}

void EnhancedSecuritySitesPersistence::deleteAllSites()
{
    ASSERT(!isMainRunLoop());

    if (!isDatabaseOpen()) {
        RELEASE_LOG_ERROR(EnhancedSecurity, "%s: Delete all attempted on closed database, trying file deletion instead.", __FUNCTION__);
        return;
    }

    auto deleteStatement = checkedDatabase()->prepareStatement(deleteAllSitesSQL);
    if (!deleteStatement || !deleteStatement->executeCommand())
        return reportSQLError(__FUNCTION__, "delete all sites"_s);
}

HashSet<WebCore::RegistrableDomain> EnhancedSecuritySitesPersistence::enhancedSecurityOnlyDomains()
{
    ASSERT(!isMainRunLoop());

    if (!isDatabaseOpen()) {
        RELEASE_LOG_ERROR(EnhancedSecurity, "%s: Attempted operation on closed database.", __FUNCTION__);
        return { };
    }

    auto selectStatement = checkedDatabase()->prepareStatement(selectEnhancedSecurityOnlySitesSQL);
    if (!selectStatement) {
        reportSQLError(__FUNCTION__, "fetch enhanced security only sites"_s);
        return { };
    }

    HashSet<WebCore::RegistrableDomain> sites;
    while (selectStatement->step() == SQLITE_ROW) {
        auto site = selectStatement->columnText(0);
        sites.add(WebCore::RegistrableDomain::fromRawString(String { site }));
    }

    return sites;
}

HashSet<WebCore::RegistrableDomain> EnhancedSecuritySitesPersistence::allEnhancedSecuritySites()
{
    ASSERT(!isMainRunLoop());

    if (!isDatabaseOpen()) {
        RELEASE_LOG_ERROR(EnhancedSecurity, "%s: Attempted operation on closed database.", __FUNCTION__);
        return { };
    }

    auto selectStatement = checkedDatabase()->prepareStatement(selectAllSitesSQL);
    if (!selectStatement) {
        reportSQLError(__FUNCTION__, "fetch all sites"_s);
        return { };
    }

    HashSet<WebCore::RegistrableDomain> sites;
    while (selectStatement->step() == SQLITE_ROW) {
        auto site = selectStatement->columnText(0);
        sites.add(WebCore::RegistrableDomain::fromRawString(String { site }));
    }

    return sites;
}

void EnhancedSecuritySitesPersistence::trackEnhancedSecurityForDomain(WebCore::RegistrableDomain&& site, EnhancedSecurity reason)
{
    ASSERT(!isMainRunLoop());

    if (!isDatabaseOpen()) {
        RELEASE_LOG_ERROR(EnhancedSecurity, "%s: Attempted operation on closed database.", __FUNCTION__);
        return;
    }

    CheckedPtr selectSiteStatement = cachedStatement(StatementType::SelectSite).get();

    if (!selectSiteStatement
        || selectSiteStatement->bindText(1, site.string()) != SQLITE_OK)
        reportSQLError(__FUNCTION__, "Failed to query specific site"_s);

    if (selectSiteStatement->step() == SQLITE_ROW) {
        if (static_cast<EnhancedSecurity>(selectSiteStatement->columnInt(0)) == EnhancedSecurity::Disabled)
            return;
    }

    CheckedPtr insertSiteStatement = cachedStatement(StatementType::InsertSite).get();

    auto enhancedSecurityReason = enumToUnderlyingType(reason);
    if (!insertSiteStatement
        || insertSiteStatement->bindText(1, site.string()) != SQLITE_OK
        || insertSiteStatement->bindInt(2, enhancedSecurityReason) != SQLITE_OK
        || !insertSiteStatement->executeCommand())
        reportSQLError(__FUNCTION__, "Failed to insert or replace site"_s);
}

void EnhancedSecuritySitesPersistence::closeDatabase()
{
    ASSERT(!isMainRunLoop());

    m_insertSiteSQLStatement = nullptr;
    m_selectSpecificSiteSQLStatement = nullptr;
    m_deleteSQLStatement = nullptr;

    if (isDatabaseOpen()) {
        ENHANCEDSECURITY_RELEASE_LOG("%s: Closing database", __FUNCTION__);
        checkedDatabase()->close();
    }

    m_sqliteDB = nullptr;
}

} // namespace WebKit

#undef ENHANCEDSECURITY_RELEASE_LOG