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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "net/extras/sqlite/sqlite_persistent_reporting_and_nel_store.h"
#include <list>
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/feature_list.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/json/json_reader.h"
#include "base/json/json_string_value_serializer.h"
#include "base/metrics/histogram_macros.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/task_traits.h"
#include "base/thread_annotations.h"
#include "net/base/features.h"
#include "net/base/network_anonymization_key.h"
#include "net/extras/sqlite/sqlite_persistent_store_backend_base.h"
#include "net/reporting/reporting_endpoint.h"
#include "net/reporting/reporting_target_type.h"
#include "sql/database.h"
#include "sql/meta_table.h"
#include "sql/statement.h"
#include "sql/transaction.h"
#include "url/origin.h"
namespace net {
namespace {
// Version 1 - 2019/03 - crrev.com/c/1504493, crrev.com/c/1560456
//
// Version 1 adds tables for NEL policies, Reporting endpoints, and Reporting
// endpoint groups.
//
// Version 2 - 2020/10 - https://crrev.com/c/2485253
//
// Version 2 adds NetworkAnonymizationKey fields to all entries. When migrating,
// existing entries get an empty NetworkAnonymizationKey value.
const int kCurrentVersionNumber = 2;
const int kCompatibleVersionNumber = 2;
// Histogram names
const char kNumberOfLoadedNelPoliciesHistogramName[] =
"ReportingAndNEL.NumberOfLoadedNELPolicies";
const char kNumberOfLoadedNelPolicies2HistogramName[] =
"ReportingAndNEL.NumberOfLoadedNELPolicies2";
const char kNumberOfLoadedReportingEndpoints2HistogramName[] =
"ReportingAndNEL.NumberOfLoadedReportingEndpoints2";
const char kNumberOfLoadedReportingEndpointGroups2HistogramName[] =
"ReportingAndNEL.NumberOfLoadedReportingEndpointGroups2";
} // namespace
base::TaskPriority GetReportingAndNelStoreBackgroundSequencePriority() {
return base::TaskPriority::USER_BLOCKING;
}
// Converts a NetworkAnonymizationKey to a string for serializing to disk.
// Returns false on failure, which happens for transient keys that should not be
// serialized to disk.
[[nodiscard]] bool NetworkAnonymizationKeyToString(
const NetworkAnonymizationKey& network_anonymization_key,
std::string* out_string) {
base::Value value;
if (!network_anonymization_key.ToValue(&value))
return false;
return JSONStringValueSerializer(out_string).Serialize(value);
}
// Attempts to convert a string returned by NetworkAnonymizationKeyToString() to
// a NetworkAnonymizationKey. Returns false on failure.
[[nodiscard]] bool NetworkAnonymizationKeyFromString(
std::string_view string,
NetworkAnonymizationKey* out_network_anonymization_key) {
std::optional<base::Value> value = base::JSONReader::Read(string);
if (!value)
return false;
if (!NetworkAnonymizationKey::FromValue(*value,
out_network_anonymization_key))
return false;
// If network state partitionining is disabled, but the
// NetworkAnonymizationKeys is non-empty, ignore the entry. The entry will
// still be in the on-disk database, in case NAKs are re-enabled, it just
// won't be loaded into memory. The entry could still be loaded with an empty
// NetworkAnonymizationKey, but that would require logic to resolve conflicts.
if (!out_network_anonymization_key->IsEmpty() &&
!NetworkAnonymizationKey::IsPartitioningEnabled()) {
*out_network_anonymization_key = NetworkAnonymizationKey();
return false;
}
return true;
}
class SQLitePersistentReportingAndNelStore::Backend
: public SQLitePersistentStoreBackendBase {
public:
Backend(
const base::FilePath& path,
const scoped_refptr<base::SequencedTaskRunner>& client_task_runner,
const scoped_refptr<base::SequencedTaskRunner>& background_task_runner)
: SQLitePersistentStoreBackendBase(
path,
/* histogram_tag = */ "ReportingAndNEL",
kCurrentVersionNumber,
kCompatibleVersionNumber,
background_task_runner,
client_task_runner,
/*enable_exclusive_access=*/false) {}
Backend(const Backend&) = delete;
Backend& operator=(const Backend&) = delete;
void LoadNelPolicies(NelPoliciesLoadedCallback loaded_callback);
void AddNelPolicy(const NetworkErrorLoggingService::NelPolicy& policy);
void UpdateNelPolicyAccessTime(
const NetworkErrorLoggingService::NelPolicy& policy);
void DeleteNelPolicy(const NetworkErrorLoggingService::NelPolicy& policy);
void LoadReportingClients(ReportingClientsLoadedCallback loaded_callback);
void AddReportingEndpoint(const ReportingEndpoint& endpoint);
void AddReportingEndpointGroup(const CachedReportingEndpointGroup& group);
void UpdateReportingEndpointGroupAccessTime(
const CachedReportingEndpointGroup& group);
void UpdateReportingEndpointDetails(const ReportingEndpoint& endpoint);
void UpdateReportingEndpointGroupDetails(
const CachedReportingEndpointGroup& group);
void DeleteReportingEndpoint(const ReportingEndpoint& endpoint);
void DeleteReportingEndpointGroup(const CachedReportingEndpointGroup& group);
// Gets the number of queued operations.
size_t GetQueueLengthForTesting() const;
private:
~Backend() override {
DCHECK(nel_policy_pending_ops_.empty());
DCHECK(reporting_endpoint_pending_ops_.empty());
DCHECK(reporting_endpoint_group_pending_ops_.empty());
DCHECK_EQ(0u, num_pending_);
}
// Represents a mutating operation to the database, specified by a type (add,
// update access time, update data, or delete) and data representing the entry
// in the database to be added/updated/deleted.
template <typename DataType>
class PendingOperation;
// Types of PendingOperation. Here to avoid templatizing the enum.
enum class PendingOperationType {
ADD,
UPDATE_ACCESS_TIME,
UPDATE_DETAILS,
DELETE
};
// List of pending operations for a particular entry in the database.
template <typename DataType>
using PendingOperationsVector =
std::vector<std::unique_ptr<PendingOperation<DataType>>>;
// A copy of the information relevant to a NEL policy.
struct NelPolicyInfo;
// A copy of the information relevant to a Reporting endpoint.
struct ReportingEndpointInfo;
// A copy of the information relevant to a Reporting endpoint group.
struct ReportingEndpointGroupInfo;
// TODO(chlily): add ReportingReportInfo.
// Uniquely identifies an endpoint in the store.
using ReportingEndpointKey = std::pair<ReportingEndpointGroupKey, GURL>;
// Map of pending operations for each entry in the database.
// Key types are: - url::Origin for NEL policies,
// - ReportingEndpointKey for Reporting endpoints,
// - ReportingEndpointGroupKey for Reporting endpoint groups
// (defined in //net/reporting/reporting_endpoint.h).
template <typename KeyType, typename DataType>
using QueueType = std::map<KeyType, PendingOperationsVector<DataType>>;
// SQLitePersistentStoreBackendBase implementation
bool CreateDatabaseSchema() override;
std::optional<int> DoMigrateDatabaseSchema() override;
void DoCommit() override;
// Commit a pending operation pertaining to a NEL policy.
// Returns true on success.
bool CommitNelPolicyOperation(PendingOperation<NelPolicyInfo>* op);
// Commit a pending operation pertaining to a Reporting endpoint.
// Returns true on success.
bool CommitReportingEndpointOperation(
PendingOperation<ReportingEndpointInfo>* op);
// Commit a pending operation pertaining to a Reporting endpoint group.
// Returns true on success.
bool CommitReportingEndpointGroupOperation(
PendingOperation<ReportingEndpointGroupInfo>* op);
// Add a pending operation to the appropriate queue.
template <typename KeyType, typename DataType>
void BatchOperation(KeyType key,
std::unique_ptr<PendingOperation<DataType>> po,
QueueType<KeyType, DataType>* queue);
// If there are existing pending operations for a given key, potentially
// remove some of the existing operations before adding |new_op|.
// In particular, if |new_op| is a deletion, then all the previous pending
// operations are made irrelevant and can be deleted. If |new_op| is an
// update-access-time, and the last operation in |ops_for_key| is also an
// update-access-time, then it can be discarded because |new_op| is about to
// overwrite the access time with a new value anyway. Similarly for
// update-details.
template <typename DataType>
void MaybeCoalesceOperations(PendingOperationsVector<DataType>* ops_for_key,
PendingOperation<DataType>* new_op)
EXCLUSIVE_LOCKS_REQUIRED(lock_);
// After adding a pending operation to one of the pending operations queues,
// this method posts a task to commit all pending operations if we reached the
// batch size, or starts a timer to commit after a time interval if we just
// started a new batch. |num_pending| is the total number of pending
// operations after the one we just added.
void OnOperationBatched(size_t num_pending);
// Loads NEL policies into a vector in the background, then posts a
// task to the client task runner to call |loaded_callback| with the loaded
// NEL policies.
void LoadNelPoliciesAndNotifyInBackground(
NelPoliciesLoadedCallback loaded_callback);
// Calls |loaded_callback| with the loaded NEL policies (which may be empty if
// loading was unsuccessful). If loading was successful, also report metrics.
void CompleteLoadNelPoliciesAndNotifyInForeground(
NelPoliciesLoadedCallback loaded_callback,
std::vector<NetworkErrorLoggingService::NelPolicy> loaded_policies,
bool load_success);
// Loads Reporting endpoints and endpoint groups into two vectors in the
// background, then posts a task to the client task runner to call
// |loaded_callback| with the loaded endpoints and endpoint groups.
void LoadReportingClientsAndNotifyInBackground(
ReportingClientsLoadedCallback loaded_callback);
// Calls |loaded_callback| with the loaded endpoints and endpoint groups
// (which may be empty if loading was unsuccessful). If loading was
// successful, also report metrics.
void CompleteLoadReportingClientsAndNotifyInForeground(
ReportingClientsLoadedCallback loaded_callback,
std::vector<ReportingEndpoint> loaded_endpoints,
std::vector<CachedReportingEndpointGroup> loaded_endpoint_groups,
bool load_success);
void RecordNumberOfLoadedNelPolicies(size_t count);
void RecordNumberOfLoadedReportingEndpoints(size_t count);
void RecordNumberOfLoadedReportingEndpointGroups(size_t count);
// Total number of pending operations (may not match the sum of the number of
// elements in the pending operations queues, due to operation coalescing).
size_t num_pending_ GUARDED_BY(lock_) = 0;
// Queue of pending operations pertaining to NEL policies, keyed on origin.
QueueType<NetworkErrorLoggingService::NelPolicyKey, NelPolicyInfo>
nel_policy_pending_ops_ GUARDED_BY(lock_);
// Queue of pending operations pertaining to Reporting endpoints, keyed on
// origin, group name, and url.
QueueType<ReportingEndpointKey, ReportingEndpointInfo>
reporting_endpoint_pending_ops_ GUARDED_BY(lock_);
// Queue of pending operations pertaining to Reporting endpoint groups, keyed
// on origin and group name.
QueueType<ReportingEndpointGroupKey, ReportingEndpointGroupInfo>
reporting_endpoint_group_pending_ops_ GUARDED_BY(lock_);
// TODO(chlily): add reporting_report_pending_ops_ for Reporting reports.
// Protects |num_pending_|, and all the pending operations queues.
mutable base::Lock lock_;
};
namespace {
bool CreateV2NelPoliciesSchema(sql::Database* db) {
DCHECK(!db->DoesTableExist("nel_policies"));
const char stmt[] =
"CREATE TABLE nel_policies ("
" nik TEXT NOT NULL,"
" origin_scheme TEXT NOT NULL,"
" origin_host TEXT NOT NULL,"
" origin_port INTEGER NOT NULL,"
" received_ip_address TEXT NOT NULL,"
" group_name TEXT NOT NULL,"
" expires_us_since_epoch INTEGER NOT NULL,"
" success_fraction REAL NOT NULL,"
" failure_fraction REAL NOT NULL,"
" is_include_subdomains INTEGER NOT NULL,"
" last_access_us_since_epoch INTEGER NOT NULL,"
// Each (origin, nik) specifies at most one NEL policy.
" UNIQUE (origin_scheme, origin_host, origin_port, nik)"
")";
return db->Execute(stmt);
}
bool CreateV2ReportingEndpointsSchema(sql::Database* db) {
DCHECK(!db->DoesTableExist("reporting_endpoints"));
const char stmt[] =
"CREATE TABLE reporting_endpoints ("
" nik TEXT NOT NULL,"
" origin_scheme TEXT NOT NULL,"
" origin_host TEXT NOT NULL,"
" origin_port INTEGER NOT NULL,"
" group_name TEXT NOT NULL,"
" url TEXT NOT NULL,"
" priority INTEGER NOT NULL,"
" weight INTEGER NOT NULL,"
// Each (origin, group, url, nik) tuple specifies at most one endpoint.
" UNIQUE (origin_scheme, origin_host, origin_port, group_name, url, nik)"
")";
return db->Execute(stmt);
}
bool CreateV2ReportingEndpointGroupsSchema(sql::Database* db) {
DCHECK(!db->DoesTableExist("reporting_endpoint_groups"));
const char stmt[] =
"CREATE TABLE reporting_endpoint_groups ("
" nik TEXT NOT NULL,"
" origin_scheme TEXT NOT NULL,"
" origin_host TEXT NOT NULL,"
" origin_port INTEGER NOT NULL,"
" group_name TEXT NOT NULL,"
" is_include_subdomains INTEGER NOT NULL,"
" expires_us_since_epoch INTEGER NOT NULL,"
" last_access_us_since_epoch INTEGER NOT NULL,"
// Each (origin, group, nik) tuple specifies at most one endpoint group.
" UNIQUE (origin_scheme, origin_host, origin_port, group_name, nik)"
")";
return db->Execute(stmt);
}
} // namespace
template <typename DataType>
class SQLitePersistentReportingAndNelStore::Backend::PendingOperation {
public:
PendingOperation(PendingOperationType type, DataType data)
: type_(type), data_(std::move(data)) {}
PendingOperationType type() const { return type_; }
const DataType& data() const { return data_; }
private:
const PendingOperationType type_;
const DataType data_;
};
// Makes a copy of the relevant information about a NelPolicy, stored in a
// form suitable for adding to the database.
// TODO(chlily): Add NIK.
struct SQLitePersistentReportingAndNelStore::Backend::NelPolicyInfo {
// This should only be invoked through CreatePendingOperation().
NelPolicyInfo(const NetworkErrorLoggingService::NelPolicy& nel_policy,
std::string network_anonymization_key_string)
: network_anonymization_key_string(
std::move(network_anonymization_key_string)),
origin_scheme(nel_policy.key.origin.scheme()),
origin_host(nel_policy.key.origin.host()),
origin_port(nel_policy.key.origin.port()),
received_ip_address(nel_policy.received_ip_address.ToString()),
report_to(nel_policy.report_to),
expires_us_since_epoch(
nel_policy.expires.ToDeltaSinceWindowsEpoch().InMicroseconds()),
success_fraction(nel_policy.success_fraction),
failure_fraction(nel_policy.failure_fraction),
is_include_subdomains(nel_policy.include_subdomains),
last_access_us_since_epoch(
nel_policy.last_used.ToDeltaSinceWindowsEpoch().InMicroseconds()) {}
// Creates the specified operation for the given policy. Returns nullptr for
// endpoints with transient NetworkAnonymizationKeys.
static std::unique_ptr<PendingOperation<NelPolicyInfo>>
CreatePendingOperation(
PendingOperationType type,
const NetworkErrorLoggingService::NelPolicy& nel_policy) {
std::string network_anonymization_key_string;
if (!NetworkAnonymizationKeyToString(
nel_policy.key.network_anonymization_key,
&network_anonymization_key_string)) {
return nullptr;
}
return std::make_unique<PendingOperation<NelPolicyInfo>>(
type,
NelPolicyInfo(nel_policy, std::move(network_anonymization_key_string)));
}
// NetworkAnonymizationKey associated with the request that received the
// policy, converted to a string via NetworkAnonymizationKeyToString().
std::string network_anonymization_key_string;
// Origin the policy was received from.
std::string origin_scheme;
std::string origin_host;
int origin_port = 0;
// IP address of the server that the policy was received from.
std::string received_ip_address;
// The Reporting group which the policy specifies.
std::string report_to;
// When the policy expires, in microseconds since the Windows epoch.
int64_t expires_us_since_epoch = 0;
// Sampling fractions.
double success_fraction = 0.0;
double failure_fraction = 1.0;
// Whether the policy applies to subdomains of the origin.
bool is_include_subdomains = false;
// Last time the policy was updated or used, in microseconds since the
// Windows epoch.
int64_t last_access_us_since_epoch = 0;
};
// Makes a copy of the relevant information about a ReportingEndpoint, stored in
// a form suitable for adding to the database.
struct SQLitePersistentReportingAndNelStore::Backend::ReportingEndpointInfo {
// This should only be invoked through CreatePendingOperation().
ReportingEndpointInfo(const ReportingEndpoint& endpoint,
std::string network_anonymization_key_string)
: network_anonymization_key_string(
std::move(network_anonymization_key_string)),
group_name(endpoint.group_key.group_name),
url(endpoint.info.url.spec()),
priority(endpoint.info.priority),
weight(endpoint.info.weight) {
// The group key should have an origin.
DCHECK(endpoint.group_key.origin.has_value());
origin_scheme = endpoint.group_key.origin.value().scheme();
origin_host = endpoint.group_key.origin.value().host();
origin_port = endpoint.group_key.origin.value().port();
}
// Creates the specified operation for the given endpoint. Returns nullptr for
// endpoints with transient NetworkAnonymizationKeys.
static std::unique_ptr<PendingOperation<ReportingEndpointInfo>>
CreatePendingOperation(PendingOperationType type,
const ReportingEndpoint& endpoint) {
std::string network_anonymization_key_string;
if (!NetworkAnonymizationKeyToString(
endpoint.group_key.network_anonymization_key,
&network_anonymization_key_string)) {
return nullptr;
}
return std::make_unique<PendingOperation<ReportingEndpointInfo>>(
type, ReportingEndpointInfo(
endpoint, std::move(network_anonymization_key_string)));
}
// NetworkAnonymizationKey associated with the endpoint, converted to a string
// via NetworkAnonymizationKeyString().
std::string network_anonymization_key_string;
// Origin the endpoint was received from.
std::string origin_scheme;
std::string origin_host;
int origin_port = 0;
// Name of the group the endpoint belongs to.
std::string group_name;
// URL of the endpoint.
std::string url;
// Priority of the endpoint.
int priority = ReportingEndpoint::EndpointInfo::kDefaultPriority;
// Weight of the endpoint.
int weight = ReportingEndpoint::EndpointInfo::kDefaultWeight;
};
struct SQLitePersistentReportingAndNelStore::Backend::
ReportingEndpointGroupInfo {
ReportingEndpointGroupInfo(const CachedReportingEndpointGroup& group,
std::string network_anonymization_key_string)
: network_anonymization_key_string(
std::move(network_anonymization_key_string)),
group_name(group.group_key.group_name),
is_include_subdomains(group.include_subdomains ==
OriginSubdomains::INCLUDE),
expires_us_since_epoch(
group.expires.ToDeltaSinceWindowsEpoch().InMicroseconds()),
last_access_us_since_epoch(
group.last_used.ToDeltaSinceWindowsEpoch().InMicroseconds()) {
// The group key should have an origin.
DCHECK(group.group_key.origin.has_value());
origin_scheme = group.group_key.origin.value().scheme();
origin_host = group.group_key.origin.value().host();
origin_port = group.group_key.origin.value().port();
}
// Creates the specified operation for the given endpoint reporting group.
// Returns nullptr for groups with transient NetworkAnonymizationKeys.
static std::unique_ptr<PendingOperation<ReportingEndpointGroupInfo>>
CreatePendingOperation(PendingOperationType type,
const CachedReportingEndpointGroup& group) {
std::string network_anonymization_key_string;
if (!NetworkAnonymizationKeyToString(
group.group_key.network_anonymization_key,
&network_anonymization_key_string)) {
return nullptr;
}
return std::make_unique<PendingOperation<ReportingEndpointGroupInfo>>(
type, ReportingEndpointGroupInfo(
group, std::move(network_anonymization_key_string)));
}
// NetworkAnonymizationKey associated with the endpoint group, converted to a
// string via NetworkAnonymizationKeyToString().
std::string network_anonymization_key_string;
// Origin the endpoint group was received from.
std::string origin_scheme;
std::string origin_host;
int origin_port = 0;
// Name of the group.
std::string group_name;
// Whether the group applies to subdomains of the origin.
bool is_include_subdomains = false;
// When the group expires, in microseconds since the Windows epoch.
int64_t expires_us_since_epoch = 0;
// Last time the group was updated or used, in microseconds since the Windows
// epoch.
int64_t last_access_us_since_epoch = 0;
};
void SQLitePersistentReportingAndNelStore::Backend::LoadNelPolicies(
NelPoliciesLoadedCallback loaded_callback) {
PostBackgroundTask(
FROM_HERE, base::BindOnce(&Backend::LoadNelPoliciesAndNotifyInBackground,
this, std::move(loaded_callback)));
}
void SQLitePersistentReportingAndNelStore::Backend::AddNelPolicy(
const NetworkErrorLoggingService::NelPolicy& policy) {
auto po =
NelPolicyInfo::CreatePendingOperation(PendingOperationType::ADD, policy);
if (!po)
return;
BatchOperation(policy.key, std::move(po), &nel_policy_pending_ops_);
}
void SQLitePersistentReportingAndNelStore::Backend::UpdateNelPolicyAccessTime(
const NetworkErrorLoggingService::NelPolicy& policy) {
auto po = NelPolicyInfo::CreatePendingOperation(
PendingOperationType::UPDATE_ACCESS_TIME, policy);
if (!po)
return;
BatchOperation(policy.key, std::move(po), &nel_policy_pending_ops_);
}
void SQLitePersistentReportingAndNelStore::Backend::DeleteNelPolicy(
const NetworkErrorLoggingService::NelPolicy& policy) {
auto po = NelPolicyInfo::CreatePendingOperation(PendingOperationType::DELETE,
policy);
if (!po)
return;
BatchOperation(policy.key, std::move(po), &nel_policy_pending_ops_);
}
void SQLitePersistentReportingAndNelStore::Backend::LoadReportingClients(
ReportingClientsLoadedCallback loaded_callback) {
PostBackgroundTask(
FROM_HERE,
base::BindOnce(&Backend::LoadReportingClientsAndNotifyInBackground, this,
std::move(loaded_callback)));
}
void SQLitePersistentReportingAndNelStore::Backend::AddReportingEndpoint(
const ReportingEndpoint& endpoint) {
auto po = ReportingEndpointInfo::CreatePendingOperation(
PendingOperationType::ADD, endpoint);
if (!po)
return;
ReportingEndpointKey key = std::pair(endpoint.group_key, endpoint.info.url);
BatchOperation(std::move(key), std::move(po),
&reporting_endpoint_pending_ops_);
}
void SQLitePersistentReportingAndNelStore::Backend::AddReportingEndpointGroup(
const CachedReportingEndpointGroup& group) {
auto po = ReportingEndpointGroupInfo::CreatePendingOperation(
PendingOperationType::ADD, group);
if (!po)
return;
BatchOperation(group.group_key, std::move(po),
&reporting_endpoint_group_pending_ops_);
}
void SQLitePersistentReportingAndNelStore::Backend::
UpdateReportingEndpointGroupAccessTime(
const CachedReportingEndpointGroup& group) {
auto po = ReportingEndpointGroupInfo::CreatePendingOperation(
PendingOperationType::UPDATE_ACCESS_TIME, group);
if (!po)
return;
BatchOperation(group.group_key, std::move(po),
&reporting_endpoint_group_pending_ops_);
}
void SQLitePersistentReportingAndNelStore::Backend::
UpdateReportingEndpointDetails(const ReportingEndpoint& endpoint) {
auto po = ReportingEndpointInfo::CreatePendingOperation(
PendingOperationType::UPDATE_DETAILS, endpoint);
if (!po)
return;
ReportingEndpointKey key = std::pair(endpoint.group_key, endpoint.info.url);
BatchOperation(std::move(key), std::move(po),
&reporting_endpoint_pending_ops_);
}
void SQLitePersistentReportingAndNelStore::Backend::
UpdateReportingEndpointGroupDetails(
const CachedReportingEndpointGroup& group) {
auto po = ReportingEndpointGroupInfo::CreatePendingOperation(
PendingOperationType::UPDATE_DETAILS, group);
if (!po)
return;
BatchOperation(group.group_key, std::move(po),
&reporting_endpoint_group_pending_ops_);
}
void SQLitePersistentReportingAndNelStore::Backend::DeleteReportingEndpoint(
const ReportingEndpoint& endpoint) {
auto po = ReportingEndpointInfo::CreatePendingOperation(
PendingOperationType::DELETE, endpoint);
if (!po)
return;
ReportingEndpointKey key = std::pair(endpoint.group_key, endpoint.info.url);
BatchOperation(std::move(key), std::move(po),
&reporting_endpoint_pending_ops_);
}
void SQLitePersistentReportingAndNelStore::Backend::
DeleteReportingEndpointGroup(const CachedReportingEndpointGroup& group) {
auto po = ReportingEndpointGroupInfo::CreatePendingOperation(
PendingOperationType::DELETE, group);
if (!po)
return;
BatchOperation(group.group_key, std::move(po),
&reporting_endpoint_group_pending_ops_);
}
size_t SQLitePersistentReportingAndNelStore::Backend::GetQueueLengthForTesting()
const {
size_t count = 0;
{
base::AutoLock locked(lock_);
for (auto& key_and_pending_ops : nel_policy_pending_ops_) {
count += key_and_pending_ops.second.size();
}
for (auto& key_and_pending_ops : reporting_endpoint_pending_ops_) {
count += key_and_pending_ops.second.size();
}
for (auto& key_and_pending_ops : reporting_endpoint_group_pending_ops_) {
count += key_and_pending_ops.second.size();
}
}
return count;
}
bool SQLitePersistentReportingAndNelStore::Backend::CreateDatabaseSchema() {
if (!db()->DoesTableExist("nel_policies") &&
!CreateV2NelPoliciesSchema(db())) {
return false;
}
if (!db()->DoesTableExist("reporting_endpoints") &&
!CreateV2ReportingEndpointsSchema(db())) {
return false;
}
if (!db()->DoesTableExist("reporting_endpoint_groups") &&
!CreateV2ReportingEndpointGroupsSchema(db())) {
return false;
}
// TODO(chlily): Initialize tables for Reporting reports.
return true;
}
std::optional<int>
SQLitePersistentReportingAndNelStore::Backend::DoMigrateDatabaseSchema() {
int cur_version = meta_table()->GetVersionNumber();
// Migrate from version 1 to version 2.
//
// For migration purposes, the NetworkAnonymizationKey field of the stored
// policies will be populated with an empty list, which corresponds to an
// empty NAK. This matches the behavior when NAKs are disabled. This will
// result in effectively clearing all policies once NAKs are enabled, at
// which point the the migration code should just be switched to deleting
// the old tables instead.
if (cur_version == 1) {
sql::Transaction transaction(db());
if (!transaction.Begin())
return std::nullopt;
// Migrate NEL policies table.
if (!db()->Execute("DROP TABLE IF EXISTS nel_policies_old") ||
!db()->Execute("ALTER TABLE nel_policies RENAME TO nel_policies_old")) {
return std::nullopt;
}
if (!CreateV2NelPoliciesSchema(db()))
return std::nullopt;
// clang-format off
// The "report_to" field is renamed to "group_name" for consistency with
// the other tables.
const char nel_policies_migrate_stmt[] =
"INSERT INTO nel_policies (nik, origin_scheme, origin_host, "
" origin_port, group_name, received_ip_address, expires_us_since_epoch, "
" success_fraction, failure_fraction, is_include_subdomains, "
" last_access_us_since_epoch) "
"SELECT '[]', origin_scheme, origin_host, origin_port, "
" report_to, received_ip_address, expires_us_since_epoch, "
" success_fraction, failure_fraction, is_include_subdomains, "
" last_access_us_since_epoch "
"FROM nel_policies_old" ;
// clang-format on
if (!db()->Execute(nel_policies_migrate_stmt)) {
return std::nullopt;
}
if (!db()->Execute("DROP TABLE nel_policies_old"))
return std::nullopt;
// Migrate Reporting endpoints table.
if (!db()->Execute("DROP TABLE IF EXISTS reporting_endpoints_old") ||
!db()->Execute("ALTER TABLE reporting_endpoints RENAME TO "
"reporting_endpoints_old")) {
return std::nullopt;
}
if (!CreateV2ReportingEndpointsSchema(db()))
return std::nullopt;
// clang-format off
const char reporting_endpoints_migrate_stmt[] =
"INSERT INTO reporting_endpoints (nik, origin_scheme, origin_host, "
" origin_port, group_name, url, priority, weight) "
"SELECT '[]', origin_scheme, origin_host, origin_port, group_name, "
" url, priority, weight "
"FROM reporting_endpoints_old" ;
// clang-format on
if (!db()->Execute(reporting_endpoints_migrate_stmt)) {
return std::nullopt;
}
if (!db()->Execute("DROP TABLE reporting_endpoints_old"))
return std::nullopt;
// Migrate Reporting endpoint groups table.
if (!db()->Execute("DROP TABLE IF EXISTS reporting_endpoint_groups_old") ||
!db()->Execute("ALTER TABLE reporting_endpoint_groups RENAME TO "
"reporting_endpoint_groups_old")) {
return std::nullopt;
}
if (!CreateV2ReportingEndpointGroupsSchema(db()))
return std::nullopt;
// clang-format off
const char reporting_endpoint_groups_migrate_stmt[] =
"INSERT INTO reporting_endpoint_groups (nik, origin_scheme, "
" origin_host, origin_port, group_name, is_include_subdomains, "
" expires_us_since_epoch, last_access_us_since_epoch) "
"SELECT '[]', origin_scheme, origin_host, origin_port, "
" group_name, is_include_subdomains, expires_us_since_epoch, "
" last_access_us_since_epoch "
"FROM reporting_endpoint_groups_old" ;
// clang-format on
if (!db()->Execute(reporting_endpoint_groups_migrate_stmt)) {
return std::nullopt;
}
if (!db()->Execute("DROP TABLE reporting_endpoint_groups_old"))
return std::nullopt;
++cur_version;
if (!meta_table()->SetVersionNumber(cur_version) ||
!meta_table()->SetCompatibleVersionNumber(
std::min(cur_version, kCompatibleVersionNumber)) ||
!transaction.Commit()) {
return std::nullopt;
}
}
// Future database upgrade statements go here.
return std::make_optional(cur_version);
}
void SQLitePersistentReportingAndNelStore::Backend::DoCommit() {
QueueType<NetworkErrorLoggingService::NelPolicyKey, NelPolicyInfo>
nel_policy_ops;
QueueType<ReportingEndpointKey, ReportingEndpointInfo> reporting_endpoint_ops;
QueueType<ReportingEndpointGroupKey, ReportingEndpointGroupInfo>
reporting_endpoint_group_ops;
size_t op_count = 0;
{
base::AutoLock locked(lock_);
nel_policy_pending_ops_.swap(nel_policy_ops);
reporting_endpoint_pending_ops_.swap(reporting_endpoint_ops);
reporting_endpoint_group_pending_ops_.swap(reporting_endpoint_group_ops);
// TODO(chlily): swap out pending operations queue for Reporting reports.
op_count = num_pending_;
num_pending_ = 0;
}
if (!db() || op_count == 0)
return;
sql::Transaction transaction(db());
if (!transaction.Begin())
return;
// Commit all the NEL policy operations.
for (const auto& origin_and_nel_policy_ops : nel_policy_ops) {
const PendingOperationsVector<NelPolicyInfo>& ops_for_origin =
origin_and_nel_policy_ops.second;
for (const std::unique_ptr<PendingOperation<NelPolicyInfo>>& nel_policy_op :
ops_for_origin) {
CommitNelPolicyOperation(nel_policy_op.get());
}
}
// Commit all the Reporting endpoint operations.
for (const auto& key_and_reporting_endpoint_ops : reporting_endpoint_ops) {
const PendingOperationsVector<ReportingEndpointInfo>& ops_for_key =
key_and_reporting_endpoint_ops.second;
for (const std::unique_ptr<PendingOperation<ReportingEndpointInfo>>&
reporting_endpoint_op : ops_for_key) {
CommitReportingEndpointOperation(reporting_endpoint_op.get());
}
}
// Commit all the Reporting endpoint group operations.
for (const auto& key_and_reporting_endpoint_group_ops :
reporting_endpoint_group_ops) {
const PendingOperationsVector<ReportingEndpointGroupInfo>& ops_for_key =
key_and_reporting_endpoint_group_ops.second;
for (const std::unique_ptr<PendingOperation<ReportingEndpointGroupInfo>>&
reporting_endpoint_group_op : ops_for_key) {
CommitReportingEndpointGroupOperation(reporting_endpoint_group_op.get());
}
}
// TODO(chlily): Commit operations pertaining to Reporting reports.
transaction.Commit();
}
bool SQLitePersistentReportingAndNelStore::Backend::CommitNelPolicyOperation(
PendingOperation<NelPolicyInfo>* op) {
DCHECK_EQ(1, db()->transaction_nesting());
sql::Statement add_statement(db()->GetCachedStatement(
SQL_FROM_HERE,
"INSERT INTO nel_policies (nik, origin_scheme, origin_host, origin_port, "
"received_ip_address, group_name, expires_us_since_epoch, "
"success_fraction, failure_fraction, is_include_subdomains, "
"last_access_us_since_epoch) VALUES (?,?,?,?,?,?,?,?,?,?,?)"));
if (!add_statement.is_valid())
return false;
sql::Statement update_access_statement(db()->GetCachedStatement(
SQL_FROM_HERE,
"UPDATE nel_policies SET last_access_us_since_epoch=? WHERE "
"nik=? AND origin_scheme=? AND origin_host=? AND origin_port=?"));
if (!update_access_statement.is_valid())
return false;
sql::Statement del_statement(db()->GetCachedStatement(
SQL_FROM_HERE,
"DELETE FROM nel_policies WHERE "
"nik=? AND origin_scheme=? AND origin_host=? AND origin_port=?"));
if (!del_statement.is_valid())
return false;
const NelPolicyInfo& nel_policy_info = op->data();
switch (op->type()) {
case PendingOperationType::ADD:
add_statement.Reset(true);
add_statement.BindString(
0, nel_policy_info.network_anonymization_key_string);
add_statement.BindString(1, nel_policy_info.origin_scheme);
add_statement.BindString(2, nel_policy_info.origin_host);
add_statement.BindInt(3, nel_policy_info.origin_port);
add_statement.BindString(4, nel_policy_info.received_ip_address);
add_statement.BindString(5, nel_policy_info.report_to);
add_statement.BindInt64(6, nel_policy_info.expires_us_since_epoch);
add_statement.BindDouble(7, nel_policy_info.success_fraction);
add_statement.BindDouble(8, nel_policy_info.failure_fraction);
add_statement.BindBool(9, nel_policy_info.is_include_subdomains);
add_statement.BindInt64(10, nel_policy_info.last_access_us_since_epoch);
if (!add_statement.Run()) {
DLOG(WARNING) << "Could not add a NEL policy to the DB.";
return false;
}
break;
case PendingOperationType::UPDATE_ACCESS_TIME:
update_access_statement.Reset(true);
update_access_statement.BindInt64(
0, nel_policy_info.last_access_us_since_epoch);
update_access_statement.BindString(
1, nel_policy_info.network_anonymization_key_string);
update_access_statement.BindString(2, nel_policy_info.origin_scheme);
update_access_statement.BindString(3, nel_policy_info.origin_host);
update_access_statement.BindInt(4, nel_policy_info.origin_port);
if (!update_access_statement.Run()) {
DLOG(WARNING)
<< "Could not update NEL policy last access time in the DB.";
return false;
}
break;
case PendingOperationType::DELETE:
del_statement.Reset(true);
del_statement.BindString(
0, nel_policy_info.network_anonymization_key_string);
del_statement.BindString(1, nel_policy_info.origin_scheme);
del_statement.BindString(2, nel_policy_info.origin_host);
del_statement.BindInt(3, nel_policy_info.origin_port);
if (!del_statement.Run()) {
DLOG(WARNING) << "Could not delete a NEL policy from the DB.";
return false;
}
break;
default:
// There are no UPDATE_DETAILS operations for NEL policies.
// TODO(chlily): Maybe add the ability to update details as opposed to
// removing and re-adding every time; it might be slightly more efficient.
NOTREACHED();
}
return true;
}
bool SQLitePersistentReportingAndNelStore::Backend::
CommitReportingEndpointOperation(
PendingOperation<ReportingEndpointInfo>* op) {
DCHECK_EQ(1, db()->transaction_nesting());
sql::Statement add_statement(db()->GetCachedStatement(
SQL_FROM_HERE,
"INSERT INTO reporting_endpoints (nik, origin_scheme, origin_host, "
"origin_port, group_name, url, priority, weight) "
"VALUES (?,?,?,?,?,?,?,?)"));
if (!add_statement.is_valid())
return false;
sql::Statement update_details_statement(db()->GetCachedStatement(
SQL_FROM_HERE,
"UPDATE reporting_endpoints SET priority=?, weight=? WHERE "
"nik=? AND origin_scheme=? AND origin_host=? AND origin_port=? "
"AND group_name=? AND url=?"));
if (!update_details_statement.is_valid())
return false;
sql::Statement del_statement(db()->GetCachedStatement(
SQL_FROM_HERE,
"DELETE FROM reporting_endpoints WHERE "
"nik=? AND origin_scheme=? AND origin_host=? AND origin_port=? "
"AND group_name=? AND url=?"));
if (!del_statement.is_valid())
return false;
const ReportingEndpointInfo& reporting_endpoint_info = op->data();
switch (op->type()) {
case PendingOperationType::ADD:
add_statement.Reset(true);
add_statement.BindString(
0, reporting_endpoint_info.network_anonymization_key_string);
add_statement.BindString(1, reporting_endpoint_info.origin_scheme);
add_statement.BindString(2, reporting_endpoint_info.origin_host);
add_statement.BindInt(3, reporting_endpoint_info.origin_port);
add_statement.BindString(4, reporting_endpoint_info.group_name);
add_statement.BindString(5, reporting_endpoint_info.url);
add_statement.BindInt(6, reporting_endpoint_info.priority);
add_statement.BindInt(7, reporting_endpoint_info.weight);
if (!add_statement.Run()) {
DLOG(WARNING) << "Could not add a Reporting endpoint to the DB.";
return false;
}
break;
case PendingOperationType::UPDATE_DETAILS:
update_details_statement.Reset(true);
update_details_statement.BindInt(0, reporting_endpoint_info.priority);
update_details_statement.BindInt(1, reporting_endpoint_info.weight);
update_details_statement.BindString(
2, reporting_endpoint_info.network_anonymization_key_string);
update_details_statement.BindString(
3, reporting_endpoint_info.origin_scheme);
update_details_statement.BindString(4,
reporting_endpoint_info.origin_host);
update_details_statement.BindInt(5, reporting_endpoint_info.origin_port);
update_details_statement.BindString(6,
reporting_endpoint_info.group_name);
update_details_statement.BindString(7, reporting_endpoint_info.url);
if (!update_details_statement.Run()) {
DLOG(WARNING)
<< "Could not update Reporting endpoint details in the DB.";
return false;
}
break;
case PendingOperationType::DELETE:
del_statement.Reset(true);
del_statement.BindString(
0, reporting_endpoint_info.network_anonymization_key_string);
del_statement.BindString(1, reporting_endpoint_info.origin_scheme);
del_statement.BindString(2, reporting_endpoint_info.origin_host);
del_statement.BindInt(3, reporting_endpoint_info.origin_port);
del_statement.BindString(4, reporting_endpoint_info.group_name);
del_statement.BindString(5, reporting_endpoint_info.url);
if (!del_statement.Run()) {
DLOG(WARNING) << "Could not delete a Reporting endpoint from the DB.";
return false;
}
break;
default:
// There are no UPDATE_ACCESS_TIME operations for Reporting endpoints
// because their access times are not tracked.
NOTREACHED();
}
return true;
}
bool SQLitePersistentReportingAndNelStore::Backend::
CommitReportingEndpointGroupOperation(
PendingOperation<ReportingEndpointGroupInfo>* op) {
DCHECK_EQ(1, db()->transaction_nesting());
sql::Statement add_statement(db()->GetCachedStatement(
SQL_FROM_HERE,
"INSERT INTO reporting_endpoint_groups (nik, origin_scheme, origin_host, "
"origin_port, group_name, is_include_subdomains, expires_us_since_epoch, "
"last_access_us_since_epoch) VALUES (?,?,?,?,?,?,?,?)"));
if (!add_statement.is_valid())
return false;
sql::Statement update_access_statement(db()->GetCachedStatement(
SQL_FROM_HERE,
"UPDATE reporting_endpoint_groups SET last_access_us_since_epoch=? WHERE "
"nik=? AND origin_scheme=? AND origin_host=? AND origin_port=? AND "
"group_name=?"));
if (!update_access_statement.is_valid())
return false;
sql::Statement update_details_statement(db()->GetCachedStatement(
SQL_FROM_HERE,
"UPDATE reporting_endpoint_groups SET is_include_subdomains=?, "
"expires_us_since_epoch=?, last_access_us_since_epoch=? WHERE "
"nik=? AND origin_scheme=? AND origin_host=? AND origin_port=? AND "
"group_name=?"));
if (!update_details_statement.is_valid())
return false;
sql::Statement del_statement(
db()->GetCachedStatement(SQL_FROM_HERE,
"DELETE FROM reporting_endpoint_groups WHERE "
"nik=? AND origin_scheme=? AND origin_host=? "
"AND origin_port=? AND group_name=?"));
if (!del_statement.is_valid())
return false;
const ReportingEndpointGroupInfo& reporting_endpoint_group_info = op->data();
switch (op->type()) {
case PendingOperationType::ADD:
add_statement.Reset(true);
add_statement.BindString(
0, reporting_endpoint_group_info.network_anonymization_key_string);
add_statement.BindString(1, reporting_endpoint_group_info.origin_scheme);
add_statement.BindString(2, reporting_endpoint_group_info.origin_host);
add_statement.BindInt(3, reporting_endpoint_group_info.origin_port);
add_statement.BindString(4, reporting_endpoint_group_info.group_name);
add_statement.BindBool(
5, reporting_endpoint_group_info.is_include_subdomains);
add_statement.BindInt64(
6, reporting_endpoint_group_info.expires_us_since_epoch);
add_statement.BindInt64(
7, reporting_endpoint_group_info.last_access_us_since_epoch);
if (!add_statement.Run()) {
DLOG(WARNING) << "Could not add a Reporting endpoint group to the DB.";
return false;
}
break;
case PendingOperationType::UPDATE_ACCESS_TIME:
update_access_statement.Reset(true);
update_access_statement.BindInt64(
0, reporting_endpoint_group_info.last_access_us_since_epoch);
update_access_statement.BindString(
1, reporting_endpoint_group_info.network_anonymization_key_string);
update_access_statement.BindString(
2, reporting_endpoint_group_info.origin_scheme);
update_access_statement.BindString(
3, reporting_endpoint_group_info.origin_host);
update_access_statement.BindInt(
4, reporting_endpoint_group_info.origin_port);
update_access_statement.BindString(
5, reporting_endpoint_group_info.group_name);
if (!update_access_statement.Run()) {
DLOG(WARNING)
<< "Could not update Reporting endpoint group last access "
"time in the DB.";
return false;
}
break;
case PendingOperationType::UPDATE_DETAILS:
update_details_statement.Reset(true);
update_details_statement.BindBool(
0, reporting_endpoint_group_info.is_include_subdomains);
update_details_statement.BindInt64(
1, reporting_endpoint_group_info.expires_us_since_epoch);
update_details_statement.BindInt64(
2, reporting_endpoint_group_info.last_access_us_since_epoch);
update_details_statement.BindString(
3, reporting_endpoint_group_info.network_anonymization_key_string);
update_details_statement.BindString(
4, reporting_endpoint_group_info.origin_scheme);
update_details_statement.BindString(
5, reporting_endpoint_group_info.origin_host);
update_details_statement.BindInt(
6, reporting_endpoint_group_info.origin_port);
update_details_statement.BindString(
7, reporting_endpoint_group_info.group_name);
if (!update_details_statement.Run()) {
DLOG(WARNING)
<< "Could not update Reporting endpoint group details in the DB.";
return false;
}
break;
case PendingOperationType::DELETE:
del_statement.Reset(true);
del_statement.BindString(
0, reporting_endpoint_group_info.network_anonymization_key_string);
del_statement.BindString(1, reporting_endpoint_group_info.origin_scheme);
del_statement.BindString(2, reporting_endpoint_group_info.origin_host);
del_statement.BindInt(3, reporting_endpoint_group_info.origin_port);
del_statement.BindString(4, reporting_endpoint_group_info.group_name);
if (!del_statement.Run()) {
DLOG(WARNING)
<< "Could not delete a Reporting endpoint group from the DB.";
return false;
}
break;
}
return true;
}
template <typename KeyType, typename DataType>
void SQLitePersistentReportingAndNelStore::Backend::BatchOperation(
KeyType key,
std::unique_ptr<PendingOperation<DataType>> po,
QueueType<KeyType, DataType>* queue) {
DCHECK(!background_task_runner()->RunsTasksInCurrentSequence());
size_t num_pending;
{
base::AutoLock locked(lock_);
std::pair<typename QueueType<KeyType, DataType>::iterator, bool>
iter_and_result =
queue->emplace(std::move(key), PendingOperationsVector<DataType>());
PendingOperationsVector<DataType>* ops_for_key =
&iter_and_result.first->second;
// If the insert failed, then we already have operations for this
// key, so we try to coalesce the new operation with the existing ones.
if (!iter_and_result.second)
MaybeCoalesceOperations(ops_for_key, po.get());
ops_for_key->push_back(std::move(po));
// Note that num_pending_ counts number of calls to Batch*Operation(), not
// the current length of the queue; this is intentional to guarantee
// progress, as the length of the queue may decrease in some cases.
num_pending = ++num_pending_;
}
OnOperationBatched(num_pending);
}
template <typename DataType>
void SQLitePersistentReportingAndNelStore::Backend::MaybeCoalesceOperations(
PendingOperationsVector<DataType>* ops_for_key,
PendingOperation<DataType>* new_op) {
DCHECK(!ops_for_key->empty());
switch (new_op->type()) {
case PendingOperationType::DELETE:
// A delete makes all previous operations irrelevant.
ops_for_key->clear();
break;
case PendingOperationType::UPDATE_ACCESS_TIME:
if (ops_for_key->back()->type() ==
PendingOperationType::UPDATE_ACCESS_TIME) {
// Updating the access time twice in a row is equivalent to just the
// latter update.
ops_for_key->pop_back();
}
break;
case PendingOperationType::UPDATE_DETAILS:
while (!ops_for_key->empty() &&
// Updating the details twice in a row is equivalent to just the
// latter update.
(ops_for_key->back()->type() ==
PendingOperationType::UPDATE_DETAILS ||
// UPDATE_DETAILS also updates the access time, so either type of
// update operation can be discarded.
ops_for_key->back()->type() ==
PendingOperationType::UPDATE_ACCESS_TIME)) {
ops_for_key->pop_back();
}
break;
case PendingOperationType::ADD:
// Nothing special is done for an add operation. If it is overwriting an
// existing entry, it will be preceded by at most one delete.
DCHECK_LE(ops_for_key->size(), 1u);
break;
}
}
void SQLitePersistentReportingAndNelStore::Backend::OnOperationBatched(
size_t num_pending) {
DCHECK(!background_task_runner()->RunsTasksInCurrentSequence());
// Commit every 30 seconds.
static const int kCommitIntervalMs = 30 * 1000;
// Commit right away if we have more than 512 outstanding operations.
static const size_t kCommitAfterBatchSize = 512;
if (num_pending == 1) {
// We've gotten our first entry for this batch, fire off the timer.
if (!background_task_runner()->PostDelayedTask(
FROM_HERE, base::BindOnce(&Backend::Commit, this),
base::Milliseconds(kCommitIntervalMs))) {
NOTREACHED() << "background_task_runner_ is not running.";
}
} else if (num_pending >= kCommitAfterBatchSize) {
// We've reached a big enough batch, fire off a commit now.
PostBackgroundTask(FROM_HERE, base::BindOnce(&Backend::Commit, this));
}
}
// TODO(chlily): Discard expired policies when loading, discard and record
// problem if loaded policy is malformed.
void SQLitePersistentReportingAndNelStore::Backend::
LoadNelPoliciesAndNotifyInBackground(
NelPoliciesLoadedCallback loaded_callback) {
DCHECK(background_task_runner()->RunsTasksInCurrentSequence());
std::vector<NetworkErrorLoggingService::NelPolicy> loaded_policies;
if (!InitializeDatabase()) {
PostClientTask(
FROM_HERE,
base::BindOnce(&Backend::CompleteLoadNelPoliciesAndNotifyInForeground,
this, std::move(loaded_callback),
std::move(loaded_policies), false /* load_success */));
return;
}
sql::Statement smt(db()->GetUniqueStatement(
"SELECT nik, origin_scheme, origin_host, origin_port, "
"received_ip_address, group_name, expires_us_since_epoch, "
"success_fraction, failure_fraction, is_include_subdomains, "
"last_access_us_since_epoch FROM nel_policies"));
if (!smt.is_valid()) {
Reset();
PostClientTask(
FROM_HERE,
base::BindOnce(&Backend::CompleteLoadNelPoliciesAndNotifyInForeground,
this, std::move(loaded_callback),
std::move(loaded_policies), false /* load_success */));
return;
}
while (smt.Step()) {
// Attempt to reconstitute a NEL policy from the fields stored in the
// database.
NetworkAnonymizationKey network_anonymization_key;
if (!NetworkAnonymizationKeyFromString(smt.ColumnStringView(0),
&network_anonymization_key)) {
continue;
}
NetworkErrorLoggingService::NelPolicy policy;
policy.key = NetworkErrorLoggingService::NelPolicyKey(
network_anonymization_key,
url::Origin::CreateFromNormalizedTuple(
/* origin_scheme = */ smt.ColumnString(1),
/* origin_host = */ smt.ColumnString(2),
/* origin_port = */ smt.ColumnInt(3)));
if (!policy.received_ip_address.AssignFromIPLiteral(
smt.ColumnStringView(4))) {
policy.received_ip_address = IPAddress();
}
policy.report_to = smt.ColumnString(5);
policy.expires = base::Time::FromDeltaSinceWindowsEpoch(
base::Microseconds(smt.ColumnInt64(6)));
policy.success_fraction = smt.ColumnDouble(7);
policy.failure_fraction = smt.ColumnDouble(8);
policy.include_subdomains = smt.ColumnBool(9);
policy.last_used = base::Time::FromDeltaSinceWindowsEpoch(
base::Microseconds(smt.ColumnInt64(10)));
loaded_policies.push_back(std::move(policy));
}
PostClientTask(
FROM_HERE,
base::BindOnce(&Backend::CompleteLoadNelPoliciesAndNotifyInForeground,
this, std::move(loaded_callback),
std::move(loaded_policies), true /* load_success */));
}
void SQLitePersistentReportingAndNelStore::Backend::
CompleteLoadNelPoliciesAndNotifyInForeground(
NelPoliciesLoadedCallback loaded_callback,
std::vector<NetworkErrorLoggingService::NelPolicy> loaded_policies,
bool load_success) {
DCHECK(client_task_runner()->RunsTasksInCurrentSequence());
if (load_success) {
RecordNumberOfLoadedNelPolicies(loaded_policies.size());
} else {
DCHECK(loaded_policies.empty());
}
std::move(loaded_callback).Run(std::move(loaded_policies));
}
void SQLitePersistentReportingAndNelStore::Backend::
LoadReportingClientsAndNotifyInBackground(
ReportingClientsLoadedCallback loaded_callback) {
DCHECK(background_task_runner()->RunsTasksInCurrentSequence());
std::vector<ReportingEndpoint> loaded_endpoints;
std::vector<CachedReportingEndpointGroup> loaded_endpoint_groups;
if (!InitializeDatabase()) {
PostClientTask(
FROM_HERE,
base::BindOnce(
&Backend::CompleteLoadReportingClientsAndNotifyInForeground, this,
std::move(loaded_callback), std::move(loaded_endpoints),
std::move(loaded_endpoint_groups), false /* load_success */));
return;
}
sql::Statement endpoints_statement(db()->GetUniqueStatement(
"SELECT nik, origin_scheme, origin_host, origin_port, group_name, "
"url, priority, weight FROM reporting_endpoints"));
sql::Statement endpoint_groups_statement(db()->GetUniqueStatement(
"SELECT nik, origin_scheme, origin_host, origin_port, group_name, "
"is_include_subdomains, expires_us_since_epoch, "
"last_access_us_since_epoch FROM reporting_endpoint_groups"));
if (!endpoints_statement.is_valid() ||
!endpoint_groups_statement.is_valid()) {
Reset();
PostClientTask(
FROM_HERE,
base::BindOnce(
&Backend::CompleteLoadReportingClientsAndNotifyInForeground, this,
std::move(loaded_callback), std::move(loaded_endpoints),
std::move(loaded_endpoint_groups), false /* load_success */));
return;
}
while (endpoints_statement.Step()) {
// Attempt to reconstitute a ReportingEndpoint from the fields stored in the
// database.
NetworkAnonymizationKey network_anonymization_key;
if (!NetworkAnonymizationKeyFromString(
endpoints_statement.ColumnStringView(0),
&network_anonymization_key)) {
continue;
}
// The target_type is set to kDeveloper because this function is used for
// V0 reporting, which only includes web developer entities.
ReportingEndpointGroupKey group_key(
network_anonymization_key,
/* origin = */
url::Origin::CreateFromNormalizedTuple(
/* origin_scheme = */ endpoints_statement.ColumnString(1),
/* origin_host = */ endpoints_statement.ColumnString(2),
/* origin_port = */ endpoints_statement.ColumnInt(3)),
/* group_name = */ endpoints_statement.ColumnString(4),
ReportingTargetType::kDeveloper);
ReportingEndpoint::EndpointInfo endpoint_info;
endpoint_info.url = GURL(endpoints_statement.ColumnStringView(5));
endpoint_info.priority = endpoints_statement.ColumnInt(6);
endpoint_info.weight = endpoints_statement.ColumnInt(7);
loaded_endpoints.emplace_back(std::move(group_key),
std::move(endpoint_info));
}
while (endpoint_groups_statement.Step()) {
// Attempt to reconstitute a CachedReportingEndpointGroup from the fields
// stored in the database.
NetworkAnonymizationKey network_anonymization_key;
if (!NetworkAnonymizationKeyFromString(
endpoint_groups_statement.ColumnStringView(0),
&network_anonymization_key)) {
continue;
}
// The target_type is set to kDeveloper because this function is used for
// V0 reporting, which only includes web developer entities.
ReportingEndpointGroupKey group_key(
network_anonymization_key,
/* origin = */
url::Origin::CreateFromNormalizedTuple(
/* origin_scheme = */ endpoint_groups_statement.ColumnString(1),
/* origin_host = */ endpoint_groups_statement.ColumnString(2),
/* origin_port = */ endpoint_groups_statement.ColumnInt(3)),
/* group_name = */ endpoint_groups_statement.ColumnString(4),
ReportingTargetType::kDeveloper);
OriginSubdomains include_subdomains =
endpoint_groups_statement.ColumnBool(5) ? OriginSubdomains::INCLUDE
: OriginSubdomains::EXCLUDE;
base::Time expires = base::Time::FromDeltaSinceWindowsEpoch(
base::Microseconds(endpoint_groups_statement.ColumnInt64(6)));
base::Time last_used = base::Time::FromDeltaSinceWindowsEpoch(
base::Microseconds(endpoint_groups_statement.ColumnInt64(7)));
loaded_endpoint_groups.emplace_back(std::move(group_key),
include_subdomains, expires, last_used);
}
PostClientTask(
FROM_HERE,
base::BindOnce(
&Backend::CompleteLoadReportingClientsAndNotifyInForeground, this,
std::move(loaded_callback), std::move(loaded_endpoints),
std::move(loaded_endpoint_groups), true /* load_success */));
}
void SQLitePersistentReportingAndNelStore::Backend::
CompleteLoadReportingClientsAndNotifyInForeground(
ReportingClientsLoadedCallback loaded_callback,
std::vector<ReportingEndpoint> loaded_endpoints,
std::vector<CachedReportingEndpointGroup> loaded_endpoint_groups,
bool load_success) {
DCHECK(client_task_runner()->RunsTasksInCurrentSequence());
if (load_success) {
RecordNumberOfLoadedReportingEndpoints(loaded_endpoints.size());
RecordNumberOfLoadedReportingEndpointGroups(loaded_endpoint_groups.size());
} else {
DCHECK(loaded_endpoints.empty());
DCHECK(loaded_endpoint_groups.empty());
}
std::move(loaded_callback)
.Run(std::move(loaded_endpoints), std::move(loaded_endpoint_groups));
}
void SQLitePersistentReportingAndNelStore::Backend::
RecordNumberOfLoadedNelPolicies(size_t count) {
// The NetworkErrorLoggingService stores up to 1000 policies.
UMA_HISTOGRAM_COUNTS_1000(kNumberOfLoadedNelPoliciesHistogramName, count);
// TODO(crbug.com/40054414): Remove this metric once the investigation is
// done.
UMA_HISTOGRAM_COUNTS_10000(kNumberOfLoadedNelPolicies2HistogramName, count);
}
void SQLitePersistentReportingAndNelStore::Backend::
RecordNumberOfLoadedReportingEndpoints(size_t count) {
// TODO(crbug.com/40054414): Remove this metric once the investigation is
// done.
UMA_HISTOGRAM_COUNTS_10000(kNumberOfLoadedReportingEndpoints2HistogramName,
count);
}
void SQLitePersistentReportingAndNelStore::Backend::
RecordNumberOfLoadedReportingEndpointGroups(size_t count) {
// TODO(crbug.com/40054414): Remove this metric once the investigation is
// done.
UMA_HISTOGRAM_COUNTS_10000(
kNumberOfLoadedReportingEndpointGroups2HistogramName, count);
}
SQLitePersistentReportingAndNelStore::SQLitePersistentReportingAndNelStore(
const base::FilePath& path,
const scoped_refptr<base::SequencedTaskRunner>& client_task_runner,
const scoped_refptr<base::SequencedTaskRunner>& background_task_runner)
: backend_(base::MakeRefCounted<Backend>(path,
client_task_runner,
background_task_runner)) {}
SQLitePersistentReportingAndNelStore::~SQLitePersistentReportingAndNelStore() {
backend_->Close();
}
void SQLitePersistentReportingAndNelStore::LoadNelPolicies(
NelPoliciesLoadedCallback loaded_callback) {
DCHECK(!loaded_callback.is_null());
backend_->LoadNelPolicies(base::BindOnce(
&SQLitePersistentReportingAndNelStore::CompleteLoadNelPolicies,
weak_factory_.GetWeakPtr(), std::move(loaded_callback)));
}
void SQLitePersistentReportingAndNelStore::AddNelPolicy(
const NetworkErrorLoggingService::NelPolicy& policy) {
backend_->AddNelPolicy(policy);
}
void SQLitePersistentReportingAndNelStore::UpdateNelPolicyAccessTime(
const NetworkErrorLoggingService::NelPolicy& policy) {
backend_->UpdateNelPolicyAccessTime(policy);
}
void SQLitePersistentReportingAndNelStore::DeleteNelPolicy(
const NetworkErrorLoggingService::NelPolicy& policy) {
backend_->DeleteNelPolicy(policy);
}
void SQLitePersistentReportingAndNelStore::LoadReportingClients(
ReportingClientsLoadedCallback loaded_callback) {
DCHECK(!loaded_callback.is_null());
backend_->LoadReportingClients(base::BindOnce(
&SQLitePersistentReportingAndNelStore::CompleteLoadReportingClients,
weak_factory_.GetWeakPtr(), std::move(loaded_callback)));
}
void SQLitePersistentReportingAndNelStore::AddReportingEndpoint(
const ReportingEndpoint& endpoint) {
backend_->AddReportingEndpoint(endpoint);
}
void SQLitePersistentReportingAndNelStore::AddReportingEndpointGroup(
const CachedReportingEndpointGroup& group) {
backend_->AddReportingEndpointGroup(group);
}
void SQLitePersistentReportingAndNelStore::
UpdateReportingEndpointGroupAccessTime(
const CachedReportingEndpointGroup& group) {
backend_->UpdateReportingEndpointGroupAccessTime(group);
}
void SQLitePersistentReportingAndNelStore::UpdateReportingEndpointDetails(
const ReportingEndpoint& endpoint) {
backend_->UpdateReportingEndpointDetails(endpoint);
}
void SQLitePersistentReportingAndNelStore::UpdateReportingEndpointGroupDetails(
const CachedReportingEndpointGroup& group) {
backend_->UpdateReportingEndpointGroupDetails(group);
}
void SQLitePersistentReportingAndNelStore::DeleteReportingEndpoint(
const ReportingEndpoint& endpoint) {
backend_->DeleteReportingEndpoint(endpoint);
}
void SQLitePersistentReportingAndNelStore::DeleteReportingEndpointGroup(
const CachedReportingEndpointGroup& group) {
backend_->DeleteReportingEndpointGroup(group);
}
void SQLitePersistentReportingAndNelStore::Flush() {
backend_->Flush(base::DoNothing());
}
size_t SQLitePersistentReportingAndNelStore::GetQueueLengthForTesting() const {
return backend_->GetQueueLengthForTesting();
}
void SQLitePersistentReportingAndNelStore::CompleteLoadNelPolicies(
NelPoliciesLoadedCallback callback,
std::vector<NetworkErrorLoggingService::NelPolicy> policies) {
std::move(callback).Run(std::move(policies));
}
void SQLitePersistentReportingAndNelStore::CompleteLoadReportingClients(
ReportingClientsLoadedCallback callback,
std::vector<ReportingEndpoint> endpoints,
std::vector<CachedReportingEndpointGroup> endpoint_groups) {
std::move(callback).Run(std::move(endpoints), std::move(endpoint_groups));
}
} // namespace net
|