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 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/40285824): Remove this and convert code to safer constructs.
#pragma allow_unsafe_buffers
#endif
#include "components/policy/core/common/schema.h"
#include <limits.h>
#include <stddef.h>
#include <algorithm>
#include <climits>
#include <map>
#include <memory>
#include <ostream>
#include <set>
#include <sstream>
#include <string>
#include <utility>
#include <variant>
#include "base/check_op.h"
#include "base/compiler_specific.h"
#include "base/containers/contains.h"
#include "base/containers/flat_set.h"
#include "base/json/json_reader.h"
#include "base/memory/ptr_util.h"
#include "base/notreached.h"
#include "base/strings/strcat.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/stringprintf.h"
#include "base/types/expected.h"
#include "base/types/expected_macros.h"
#include "base/values.h"
#include "components/policy/core/common/json_schema_constants.h"
#include "components/policy/core/common/schema_internal.h"
#include "third_party/re2/src/re2/re2.h"
namespace schema = json_schema_constants;
namespace policy {
using internal::PropertiesNode;
using internal::PropertyNode;
using internal::RestrictionNode;
using internal::SchemaData;
using internal::SchemaNode;
std::string ErrorPathToString(const std::string& policy_name,
PolicyErrorPath error_path) {
if (error_path.empty())
return std::string();
std::stringstream error_path_string{policy_name};
error_path_string << policy_name;
for (auto& entry : error_path) {
if (std::holds_alternative<int>(entry)) {
error_path_string << "[" << std::get<int>(entry) << "]";
} else if (std::holds_alternative<std::string>(entry)) {
error_path_string << "." << std::get<std::string>(entry);
}
}
return error_path_string.str();
}
const char kSensitiveValueMask[] = "********";
namespace {
struct ReferencesAndIDs {
// Maps schema "id" attributes to the corresponding SchemaNode index.
std::map<std::string, int16_t> id_map;
// List of pairs of references to be assigned later. The string is the "id"
// whose corresponding index should be stored in the pointer, once all the IDs
// are available.
std::vector<std::pair<std::string, int16_t*>> reference_list;
};
// Sizes for the storage arrays. These are calculated in advance so that the
// arrays don't have to be resized during parsing, which would invalidate
// pointers into their contents (i.e. string's c_str() and address of indices
// for "$ref" attributes).
struct StorageSizes {
size_t strings = 0;
size_t schema_nodes = 0;
size_t property_nodes = 0;
size_t properties_nodes = 0;
size_t restriction_nodes = 0;
size_t required_properties = 0;
size_t int_enums = 0;
size_t string_enums = 0;
};
// An invalid index, indicating that a node is not present; similar to a NULL
// pointer.
const int16_t kInvalid = -1;
// Maps a schema key to the corresponding base::Value::Type
struct SchemaKeyToValueType {
const char* key;
base::Value::Type type;
};
// Allowed types and their base::Value::Type equivalent. These are ordered
// alphabetically to perform binary search.
const SchemaKeyToValueType kSchemaTypesToValueTypes[] = {
{schema::kArray, base::Value::Type::LIST},
{schema::kBoolean, base::Value::Type::BOOLEAN},
{schema::kInteger, base::Value::Type::INTEGER},
{schema::kNumber, base::Value::Type::DOUBLE},
{schema::kObject, base::Value::Type::DICT},
{schema::kString, base::Value::Type::STRING},
};
// Allowed attributes and types for type 'array'. These are ordered
// alphabetically to perform binary search.
const SchemaKeyToValueType kAttributesAndTypesForArray[] = {
{schema::kDescription, base::Value::Type::STRING},
{schema::kId, base::Value::Type::STRING},
{schema::kItems, base::Value::Type::DICT},
{schema::kSensitiveValue, base::Value::Type::BOOLEAN},
{schema::kTitle, base::Value::Type::STRING},
{schema::kType, base::Value::Type::STRING},
};
// Allowed attributes and types for type 'boolean'. These are ordered
// alphabetically to perform binary search.
const SchemaKeyToValueType kAttributesAndTypesForBoolean[] = {
{schema::kDescription, base::Value::Type::STRING},
{schema::kId, base::Value::Type::STRING},
{schema::kSensitiveValue, base::Value::Type::BOOLEAN},
{schema::kTitle, base::Value::Type::STRING},
{schema::kType, base::Value::Type::STRING},
};
// Allowed attributes and types for type 'integer'. These are ordered
// alphabetically to perform binary search.
const SchemaKeyToValueType kAttributesAndTypesForInteger[] = {
{schema::kDescription, base::Value::Type::STRING},
{schema::kEnum, base::Value::Type::LIST},
{schema::kId, base::Value::Type::STRING},
{schema::kMaximum, base::Value::Type::DOUBLE},
{schema::kMinimum, base::Value::Type::DOUBLE},
{schema::kSensitiveValue, base::Value::Type::BOOLEAN},
{schema::kTitle, base::Value::Type::STRING},
{schema::kType, base::Value::Type::STRING},
};
// Allowed attributes and types for type 'number'. These are ordered
// alphabetically to perform binary search.
const SchemaKeyToValueType kAttributesAndTypesForNumber[] = {
{schema::kDescription, base::Value::Type::STRING},
{schema::kId, base::Value::Type::STRING},
{schema::kSensitiveValue, base::Value::Type::BOOLEAN},
{schema::kTitle, base::Value::Type::STRING},
{schema::kType, base::Value::Type::STRING},
};
// Allowed attributes and types for type 'object'. These are ordered
// alphabetically to perform binary search.
const SchemaKeyToValueType kAttributesAndTypesForObject[] = {
{schema::kAdditionalProperties, base::Value::Type::DICT},
{schema::kDescription, base::Value::Type::STRING},
{schema::kId, base::Value::Type::STRING},
{schema::kPatternProperties, base::Value::Type::DICT},
{schema::kProperties, base::Value::Type::DICT},
{schema::kRequired, base::Value::Type::LIST},
{schema::kSensitiveValue, base::Value::Type::BOOLEAN},
{schema::kTitle, base::Value::Type::STRING},
{schema::kType, base::Value::Type::STRING},
};
// Allowed attributes and types for $ref. These are ordered alphabetically to
// perform binary search.
const SchemaKeyToValueType kAttributesAndTypesForRef[] = {
{schema::kDescription, base::Value::Type::STRING},
{schema::kRef, base::Value::Type::STRING},
{schema::kTitle, base::Value::Type::STRING},
};
// Allowed attributes and types for type 'string'. These are ordered
// alphabetically to perform binary search.
const SchemaKeyToValueType kAttributesAndTypesForString[] = {
{schema::kDescription, base::Value::Type::STRING},
{schema::kEnum, base::Value::Type::LIST},
{schema::kId, base::Value::Type::STRING},
{schema::kPattern, base::Value::Type::STRING},
{schema::kSensitiveValue, base::Value::Type::BOOLEAN},
{schema::kTitle, base::Value::Type::STRING},
{schema::kType, base::Value::Type::STRING},
};
// Helper for std::lower_bound.
bool CompareToString(const SchemaKeyToValueType& entry,
const std::string& key) {
return entry.key < key;
}
// Returns true if a SchemaKeyToValueType with key==|schema_key| can be found in
// the array represented by |begin| and |end|. If so, |value_type| will be set
// to the SchemaKeyToValueType value type.
bool MapSchemaKeyToValueType(const std::string& schema_key,
const SchemaKeyToValueType* begin,
const SchemaKeyToValueType* end,
base::Value::Type* value_type) {
const SchemaKeyToValueType* entry =
std::lower_bound(begin, end, schema_key, CompareToString);
if (entry == end || entry->key != schema_key)
return false;
if (value_type)
*value_type = entry->type;
return true;
}
// Shorthand method for |SchemaTypeToValueType()| with
// |kSchemaTypesToValueTypes|.
bool SchemaTypeToValueType(const std::string& schema_type,
base::Value::Type* value_type) {
return MapSchemaKeyToValueType(
schema_type, std::begin(kSchemaTypesToValueTypes),
std::end(kSchemaTypesToValueTypes), value_type);
}
bool StrategyAllowUnknown(SchemaOnErrorStrategy strategy) {
return strategy != SCHEMA_STRICT;
}
bool StrategyAllowInvalidListEntry(SchemaOnErrorStrategy strategy) {
return strategy == SCHEMA_ALLOW_UNKNOWN_AND_INVALID_LIST_ENTRY;
}
bool StrategyAllowUnknownWithoutWarning(SchemaOnErrorStrategy strategy) {
return strategy == SCHEMA_ALLOW_UNKNOWN_WITHOUT_WARNING;
}
void SchemaErrorFound(PolicyErrorPath* out_error_path,
std::string* out_error,
const std::string& msg) {
if (out_error_path)
*out_error_path = {};
if (out_error)
*out_error = msg;
}
void AddListIndexPrefixToPath(int index, PolicyErrorPath* path) {
if (path) {
path->emplace(path->begin(), index);
}
}
void AddDictKeyPrefixToPath(const std::string& key, PolicyErrorPath* path) {
if (path) {
path->emplace(path->begin(), key);
}
}
bool IgnoreUnknownAttributes(int options) {
return (options & kSchemaOptionsIgnoreUnknownAttributes);
}
// Check that the value's type and the expected type are equal. We also allow
// integers when expecting doubles.
bool CheckType(const base::Value* value, base::Value::Type expected_type) {
return value->type() == expected_type ||
(value->is_int() && expected_type == base::Value::Type::DOUBLE);
}
// Returns true if |type| is supported as schema's 'type' value.
bool IsValidType(const std::string& type) {
return MapSchemaKeyToValueType(type, std::begin(kSchemaTypesToValueTypes),
std::end(kSchemaTypesToValueTypes), nullptr);
}
// Validate that |dict| only contains attributes that are allowed for the
// corresponding value of 'type'. Also ensure that all of those attributes are
// of the expected type. |options| can be used to ignore unknown attributes.
base::expected<void, std::string> ValidateAttributesAndTypes(
const base::Value::Dict& dict,
const std::string& type,
int options) {
const SchemaKeyToValueType* begin = nullptr;
const SchemaKeyToValueType* end = nullptr;
if (type == schema::kArray) {
begin = std::begin(kAttributesAndTypesForArray);
end = std::end(kAttributesAndTypesForArray);
} else if (type == schema::kBoolean) {
begin = std::begin(kAttributesAndTypesForBoolean);
end = std::end(kAttributesAndTypesForBoolean);
} else if (type == schema::kInteger) {
begin = std::begin(kAttributesAndTypesForInteger);
end = std::end(kAttributesAndTypesForInteger);
} else if (type == schema::kNumber) {
begin = std::begin(kAttributesAndTypesForNumber);
end = std::end(kAttributesAndTypesForNumber);
} else if (type == schema::kObject) {
begin = std::begin(kAttributesAndTypesForObject);
end = std::end(kAttributesAndTypesForObject);
} else if (type == schema::kRef) {
begin = std::begin(kAttributesAndTypesForRef);
end = std::end(kAttributesAndTypesForRef);
} else if (type == schema::kString) {
begin = std::begin(kAttributesAndTypesForString);
end = std::end(kAttributesAndTypesForString);
} else {
NOTREACHED() << "Type should be a valid schema type or '$ref'.";
}
base::Value::Type expected_type = base::Value::Type::NONE;
for (auto it : dict) {
if (MapSchemaKeyToValueType(it.first, begin, end, &expected_type)) {
if (!CheckType(&it.second, expected_type)) {
return base::unexpected(base::StringPrintf(
"Invalid type for attribute '%s'", it.first.c_str()));
}
} else if (!IgnoreUnknownAttributes(options)) {
return base::unexpected(
base::StringPrintf("Unknown attribute '%s'", it.first.c_str()));
}
}
return base::ok();
}
// Validates that |enum_list| is a list and its items are all of type |type|.
base::expected<void, std::string> ValidateEnum(const base::Value* enum_list,
const std::string& type) {
if (!enum_list->is_list() || enum_list->GetList().empty()) {
return base::unexpected("Attribute 'enum' must be a non-empty list.");
}
base::Value::Type expected_item_type = base::Value::Type::NONE;
MapSchemaKeyToValueType(type, std::begin(kSchemaTypesToValueTypes),
std::end(kSchemaTypesToValueTypes),
&expected_item_type);
for (const base::Value& item : enum_list->GetList()) {
if (item.type() != expected_item_type) {
return base::unexpected(base::StringPrintf(
"Attribute 'enum' for type '%s' contains items with invalid types",
type.c_str()));
}
}
return base::ok();
}
// Forward declaration (used in ValidateProperties).
base::expected<void, std::string> IsValidSchema(const base::Value::Dict& dict,
int options);
// Validates that the values in the |properties| dict are valid schemas.
base::expected<void, std::string> ValidateProperties(
const base::Value::Dict& properties,
int options) {
for (auto dict_it : properties) {
if (!dict_it.second.is_dict()) {
return base::unexpected(base::StringPrintf(
"Schema for property '%s' must be a dict.", dict_it.first.c_str()));
}
RETURN_IF_ERROR(IsValidSchema(dict_it.second.GetDict(), options));
}
return base::ok();
}
base::expected<void, std::string> IsFieldTypeObject(
const base::Value& field,
const std::string& field_name) {
if (!field.is_dict()) {
return base::unexpected(base::StringPrintf("Field '%s' must be an object.",
field_name.c_str()));
}
return base::ok();
}
// Checks whether the passed dict is a valid schema. See
// |kAllowedAttributesAndTypes| for a list of supported types, supported
// attributes and their expected types. Values for 'minimum' and 'maximum' for
// type 'integer' can be of type int or double. Referenced IDs ($ref) are not
// checked for existence and IDs are not checked for duplicates. The 'pattern'
// attribute and keys for 'patternProperties' are not checked for valid regular
// expression syntax. Invalid regular expressions will cause a value validation
// error.
base::expected<void, std::string> IsValidSchema(const base::Value::Dict& dict,
int options) {
// Validate '$ref'.
if (dict.contains(schema::kRef)) {
return ValidateAttributesAndTypes(dict, schema::kRef, options);
}
// Validate 'type'.
if (!dict.contains(schema::kType)) {
return base::unexpected("Each schema must have a 'type' or '$ref'.");
}
const std::string* type = dict.FindString(schema::kType);
if (!type) {
return base::unexpected("Attribute 'type' must be a string.");
}
const std::string& type_string = *type;
if (!IsValidType(type_string)) {
return base::unexpected(
base::StringPrintf("Unknown type '%s'.", type_string.c_str()));
}
// Validate attributes and expected types.
RETURN_IF_ERROR(ValidateAttributesAndTypes(dict, type_string, options));
// Validate 'enum' attribute.
if (type_string == schema::kString || type_string == schema::kInteger) {
if (const base::Value* enum_list = dict.Find(schema::kEnum)) {
RETURN_IF_ERROR(ValidateEnum(enum_list, type_string));
}
}
// TODO(b/341873894): Refactor type validation to helper functions.
if (type_string == schema::kInteger) {
// Validate 'minimum' > 'maximum'.
const std::optional<double> minimum_value =
dict.FindDouble(schema::kMinimum);
const std::optional<double> maximum_value =
dict.FindDouble(schema::kMaximum);
if (minimum_value && maximum_value) {
if (minimum_value.value() > maximum_value.value()) {
return base::unexpected(
base::StringPrintf("Invalid range specified [%f;%f].",
minimum_value.value(), maximum_value.value()));
}
}
} else if (type_string == schema::kArray) {
// Validate type 'array'.
const base::Value* items = dict.Find(schema::kItems);
if (!items || !items->is_dict()) {
return base::unexpected(
"Schema of type 'array' must have a schema in 'items' of type "
"dictionary.");
}
RETURN_IF_ERROR(IsValidSchema(items->GetDict(), options));
} else if (type_string == schema::kObject) {
// Validate type 'object'.
const base::Value* properties = dict.Find(schema::kProperties);
if (properties) {
RETURN_IF_ERROR(IsFieldTypeObject(*properties, schema::kProperties));
RETURN_IF_ERROR(ValidateProperties(properties->GetDict(), options));
}
if (const base::Value* pattern_properties =
dict.Find(schema::kPatternProperties)) {
RETURN_IF_ERROR(
IsFieldTypeObject(*pattern_properties, schema::kPatternProperties));
RETURN_IF_ERROR(
ValidateProperties(pattern_properties->GetDict(), options));
}
if (const base::Value* additional_properties =
dict.Find(schema::kAdditionalProperties)) {
RETURN_IF_ERROR(IsFieldTypeObject(*additional_properties,
schema::kAdditionalProperties));
RETURN_IF_ERROR(IsValidSchema(additional_properties->GetDict(), options));
}
if (const base::Value::List* required = dict.FindList(schema::kRequired)) {
for (const base::Value& item : *required) {
if (!item.is_string()) {
return base::unexpected(
"Attribute 'required' may only contain strings.");
}
const std::string property_name = item.GetString();
if (!properties || !properties->GetDict().contains(property_name)) {
return base::unexpected(base::StringPrintf(
"Attribute 'required' contains unknown property '%s'.",
property_name.c_str()));
}
}
}
}
return base::ok();
}
} // namespace
// Contains the internal data representation of a Schema. This can either wrap
// a SchemaData owned elsewhere (currently used to wrap the Chrome schema, which
// is generated at compile time), or it can own its own SchemaData.
class Schema::InternalStorage
: public base::RefCountedThreadSafe<InternalStorage> {
public:
InternalStorage(const InternalStorage&) = delete;
InternalStorage& operator=(const InternalStorage&) = delete;
static scoped_refptr<const InternalStorage> Wrap(const SchemaData* data);
static base::expected<scoped_refptr<const InternalStorage>, std::string>
ParseSchema(const base::Value::Dict& schema);
const SchemaData* data() const { return &schema_data_; }
const SchemaNode* root_node() const { return schema(0); }
// Returns the validation_schema root node if one was generated, or nullptr.
const SchemaNode* validation_schema_root_node() const {
return schema_data_.validation_schema_root_index >= 0
? schema(schema_data_.validation_schema_root_index)
: nullptr;
}
const SchemaNode* schema(int index) const {
DCHECK_GE(index, 0);
return schema_data_.schema_nodes + index;
}
const PropertiesNode* properties(int index) const {
DCHECK_GE(index, 0);
return schema_data_.properties_nodes + index;
}
const PropertyNode* property(int index) const {
DCHECK_GE(index, 0);
return schema_data_.property_nodes + index;
}
const RestrictionNode* restriction(int index) const {
DCHECK_GE(index, 0);
return schema_data_.restriction_nodes + index;
}
const char* const* required_property(int index) const {
DCHECK_GE(index, 0);
return schema_data_.required_properties + index;
}
const int* int_enums(int index) const {
DCHECK_GE(index, 0);
return schema_data_.int_enums + index;
}
const char* const* string_enums(int index) const {
DCHECK_GE(index, 0);
return schema_data_.string_enums + index;
}
// Compiles regular expression |pattern|. The result is cached and will be
// returned directly next time.
re2::RE2* CompileRegex(const std::string& pattern) const;
private:
friend class base::RefCountedThreadSafe<InternalStorage>;
InternalStorage();
~InternalStorage();
// Determines the expected |sizes| of the storage for the representation
// of |schema|.
static void DetermineStorageSizes(const base::Value::Dict& schema,
StorageSizes* sizes);
// Parses the JSON schema in |schema|.
//
// If |schema| has a "$ref" attribute then a pending reference is appended
// to the |reference_list|, and nothing else is done.
//
// Otherwise, |index| gets assigned the index of the corresponding SchemaNode
// in |schema_nodes_|. If the |schema| contains an "id" then that ID is mapped
// to the |index| in the |id_map|.
//
// If |schema| is invalid, it returns an error reason.
base::expected<void, std::string> Parse(const base::Value::Dict& schema,
int16_t* index,
ReferencesAndIDs* references_and_ids);
// Helper for Parse() that gets an already assigned |schema_node| instead of
// an |index| pointer.
base::expected<void, std::string> ParseDictionary(
const base::Value::Dict& schema,
SchemaNode* schema_node,
ReferencesAndIDs* references_and_ids);
// Helper for Parse() that gets an already assigned |schema_node| instead of
// an |index| pointer.
base::expected<void, std::string> ParseList(
const base::Value::Dict& schema,
SchemaNode* schema_node,
ReferencesAndIDs* references_and_ids);
base::expected<void, std::string> ParseEnum(const base::Value::Dict& schema,
base::Value::Type type,
SchemaNode* schema_node);
base::expected<void, std::string> ParseRangedInt(
const base::Value::Dict& schema,
SchemaNode* schema_node);
base::expected<void, std::string> ParseStringPattern(
const base::Value::Dict& schema,
SchemaNode* schema_node);
// Assigns the IDs in |id_map| to the pending references in the
// |reference_list|. If an ID is missing then |error| is set and false is
// returned; otherwise returns true.
static bool ResolveReferences(const ReferencesAndIDs& references_and_ids,
std::string* error);
// Sets |has_sensitive_children| for all |SchemaNode|s in |schema_nodes_|.
void FindSensitiveChildren();
// Returns true iff the node at |index| has sensitive child elements or
// contains a sensitive value itself.
bool FindSensitiveChildrenRecursive(int index,
std::set<int>* handled_schema_nodes);
// Cache for CompileRegex(), will memorize return value of every call to
// CompileRegex() and return results directly next time.
mutable std::map<std::string, std::unique_ptr<re2::RE2>> regex_cache_;
SchemaData schema_data_;
std::vector<std::string> strings_;
std::vector<SchemaNode> schema_nodes_;
std::vector<PropertyNode> property_nodes_;
std::vector<PropertiesNode> properties_nodes_;
std::vector<RestrictionNode> restriction_nodes_;
std::vector<const char*> required_properties_;
std::vector<int> int_enums_;
std::vector<const char*> string_enums_;
};
Schema::InternalStorage::InternalStorage() = default;
Schema::InternalStorage::~InternalStorage() = default;
// static
scoped_refptr<const Schema::InternalStorage> Schema::InternalStorage::Wrap(
const SchemaData* data) {
InternalStorage* storage = new InternalStorage();
storage->schema_data_ = *data;
return storage;
}
// static
base::expected<scoped_refptr<const Schema::InternalStorage>, std::string>
Schema::InternalStorage::ParseSchema(const base::Value::Dict& schema) {
// Determine the sizes of the storage arrays and reserve the capacity before
// starting to append nodes and strings. This is important to prevent the
// arrays from being reallocated, which would invalidate the c_str() pointers
// and the addresses of indices to fix.
StorageSizes sizes;
DetermineStorageSizes(schema, &sizes);
scoped_refptr<InternalStorage> storage = new InternalStorage();
storage->strings_.reserve(sizes.strings);
storage->schema_nodes_.reserve(sizes.schema_nodes);
storage->property_nodes_.reserve(sizes.property_nodes);
storage->properties_nodes_.reserve(sizes.properties_nodes);
storage->restriction_nodes_.reserve(sizes.restriction_nodes);
storage->required_properties_.reserve(sizes.required_properties);
storage->int_enums_.reserve(sizes.int_enums);
storage->string_enums_.reserve(sizes.string_enums);
int16_t root_index = kInvalid;
ReferencesAndIDs references_and_ids;
RETURN_IF_ERROR(storage->Parse(schema, &root_index, &references_and_ids));
if (root_index == kInvalid) {
return base::unexpected("The main schema can't have a $ref");
}
// None of this should ever happen without having been already detected.
// But, if it does happen, then it will lead to corrupted memory; drop
// everything in that case.
if (root_index != 0 || sizes.strings != storage->strings_.size() ||
sizes.schema_nodes != storage->schema_nodes_.size() ||
sizes.property_nodes != storage->property_nodes_.size() ||
sizes.properties_nodes != storage->properties_nodes_.size() ||
sizes.restriction_nodes != storage->restriction_nodes_.size() ||
sizes.required_properties != storage->required_properties_.size() ||
sizes.int_enums != storage->int_enums_.size() ||
sizes.string_enums != storage->string_enums_.size()) {
return base::unexpected(
"Failed to parse the schema due to a Chrome bug. Please file a "
"new issue at http://crbug.com");
}
std::string error;
if (!ResolveReferences(references_and_ids, &error)) {
return base::unexpected(error);
}
storage->FindSensitiveChildren();
SchemaData* data = &storage->schema_data_;
data->schema_nodes = storage->schema_nodes_.data();
data->property_nodes = storage->property_nodes_.data();
data->properties_nodes = storage->properties_nodes_.data();
data->restriction_nodes = storage->restriction_nodes_.data();
data->required_properties = storage->required_properties_.data();
data->int_enums = storage->int_enums_.data();
data->string_enums = storage->string_enums_.data();
data->validation_schema_root_index = -1;
return base::ok(std::move(storage));
}
re2::RE2* Schema::InternalStorage::CompileRegex(
const std::string& pattern) const {
auto it = regex_cache_.find(pattern);
if (it == regex_cache_.end()) {
std::unique_ptr<re2::RE2> compiled(new re2::RE2(pattern));
re2::RE2* compiled_ptr = compiled.get();
regex_cache_.insert(std::make_pair(pattern, std::move(compiled)));
return compiled_ptr;
}
return it->second.get();
}
// static
void Schema::InternalStorage::DetermineStorageSizes(
const base::Value::Dict& schema,
StorageSizes* sizes) {
if (schema.FindString(schema::kRef)) {
// Schemas with a "$ref" attribute don't take additional storage.
return;
}
base::Value::Type type = base::Value::Type::NONE;
const std::string* type_string = schema.FindString(schema::kType);
if (!type_string || !SchemaTypeToValueType(*type_string, &type)) {
// This schema is invalid.
return;
}
sizes->schema_nodes++;
if (type == base::Value::Type::LIST) {
const base::Value* items = schema.Find(schema::kItems);
if (items && items->is_dict()) {
DetermineStorageSizes(items->GetDict(), sizes);
}
} else if (type == base::Value::Type::DICT) {
sizes->properties_nodes++;
const base::Value* additional_properties =
schema.Find(schema::kAdditionalProperties);
if (additional_properties && additional_properties->is_dict()) {
DetermineStorageSizes(additional_properties->GetDict(), sizes);
}
const base::Value::Dict* properties = schema.FindDict(schema::kProperties);
if (properties) {
for (auto property : *properties) {
if (property.second.is_dict()) {
DetermineStorageSizes(property.second.GetDict(), sizes);
}
sizes->strings++;
sizes->property_nodes++;
}
}
const base::Value::Dict* pattern_properties =
schema.FindDict(schema::kPatternProperties);
if (pattern_properties) {
for (auto pattern_property : *pattern_properties) {
if (pattern_property.second.is_dict()) {
DetermineStorageSizes(pattern_property.second.GetDict(), sizes);
}
sizes->strings++;
sizes->property_nodes++;
}
}
const base::Value::List* required_properties =
schema.FindList(schema::kRequired);
if (required_properties) {
sizes->strings += required_properties->size();
sizes->required_properties += required_properties->size();
}
} else if (schema.FindList(schema::kEnum)) {
const base::Value::List* possible_values = schema.FindList(schema::kEnum);
if (possible_values) {
size_t num_possible_values = possible_values->size();
if (type == base::Value::Type::INTEGER) {
sizes->int_enums += num_possible_values;
} else if (type == base::Value::Type::STRING) {
sizes->string_enums += num_possible_values;
sizes->strings += num_possible_values;
}
sizes->restriction_nodes++;
}
} else if (type == base::Value::Type::INTEGER) {
if (schema.contains(schema::kMinimum) ||
schema.contains(schema::kMaximum)) {
sizes->restriction_nodes++;
}
} else if (type == base::Value::Type::STRING) {
if (schema.contains(schema::kPattern)) {
sizes->strings++;
sizes->string_enums++;
sizes->restriction_nodes++;
}
}
}
base::expected<void, std::string> Schema::InternalStorage::Parse(
const base::Value::Dict& schema,
int16_t* index,
ReferencesAndIDs* references_and_ids) {
const std::string* ref = schema.FindString(schema::kRef);
if (ref) {
if (schema.FindString(schema::kId)) {
return base::unexpected("Schemas with a $ref can't have an id");
}
references_and_ids->reference_list.emplace_back(*ref, index);
return base::ok();
}
const std::string* type_string = schema.FindString(schema::kType);
if (!type_string) {
return base::unexpected("The schema type must be declared.");
}
base::Value::Type type = base::Value::Type::NONE;
if (!SchemaTypeToValueType(*type_string, &type)) {
return base::unexpected("Type not supported: " + *type_string);
}
if (schema_nodes_.size() > std::numeric_limits<int16_t>::max()) {
return base::unexpected(
"Can't have more than " +
base::NumberToString(std::numeric_limits<int16_t>::max()) +
" schema nodes.");
}
*index = static_cast<int16_t>(schema_nodes_.size());
schema_nodes_.push_back(
{.type = type,
.extra = kInvalid,
.is_sensitive_value =
schema.FindBool(schema::kSensitiveValue).value_or(false)});
SchemaNode* schema_node = &schema_nodes_.back();
if (type == base::Value::Type::DICT) {
RETURN_IF_ERROR(ParseDictionary(schema, schema_node, references_and_ids));
} else if (type == base::Value::Type::LIST) {
RETURN_IF_ERROR(ParseList(schema, schema_node, references_and_ids));
} else if (schema.contains(schema::kEnum)) {
RETURN_IF_ERROR(ParseEnum(schema, type, schema_node));
} else if (schema.contains(schema::kPattern)) {
RETURN_IF_ERROR(ParseStringPattern(schema, schema_node));
} else if (schema.contains(schema::kMinimum) ||
schema.contains(schema::kMaximum)) {
if (type != base::Value::Type::INTEGER) {
return base::unexpected("Only integers can have minimum and maximum");
}
RETURN_IF_ERROR(ParseRangedInt(schema, schema_node));
}
const std::string* id = schema.FindString(schema::kId);
if (id) {
auto& id_map = references_and_ids->id_map;
if (base::Contains(id_map, *id)) {
return base::unexpected("Duplicated id: " + *id);
}
id_map[*id] = *index;
}
return base::ok();
}
base::expected<void, std::string> Schema::InternalStorage::ParseDictionary(
const base::Value::Dict& schema,
SchemaNode* schema_node,
ReferencesAndIDs* references_and_ids) {
int extra = static_cast<int>(properties_nodes_.size());
properties_nodes_.push_back({.additional = kInvalid});
schema_node->extra = extra;
const base::Value::Dict* additional_properties =
schema.FindDict(schema::kAdditionalProperties);
if (additional_properties) {
RETURN_IF_ERROR(Parse(*additional_properties,
&properties_nodes_[extra].additional,
references_and_ids));
}
properties_nodes_[extra].begin = static_cast<int>(property_nodes_.size());
const base::Value::Dict* properties = schema.FindDict(schema::kProperties);
if (properties) {
// This and below reserves nodes for all of the |properties|, and makes sure
// they are contiguous. Recursive calls to Parse() will append after these
// elements.
property_nodes_.resize(property_nodes_.size() + properties->size());
}
properties_nodes_[extra].end = static_cast<int>(property_nodes_.size());
const base::Value::Dict* pattern_properties =
schema.FindDict(schema::kPatternProperties);
if (pattern_properties) {
property_nodes_.resize(property_nodes_.size() + pattern_properties->size());
}
properties_nodes_[extra].pattern_end =
static_cast<int>(property_nodes_.size());
if (properties != nullptr) {
int base_index = properties_nodes_[extra].begin;
int index = base_index;
for (auto property : *properties) {
strings_.push_back(property.first);
property_nodes_[index].key = strings_.back().c_str();
if (!property.second.is_dict()) {
return base::unexpected(std::string());
}
RETURN_IF_ERROR(Parse(property.second.GetDict(),
&property_nodes_[index].schema,
references_and_ids));
++index;
}
CHECK_EQ(static_cast<int>(properties->size()), index - base_index);
}
if (pattern_properties != nullptr) {
int base_index = properties_nodes_[extra].end;
int index = base_index;
for (auto pattern_property : *pattern_properties) {
re2::RE2* compiled_regex = CompileRegex(pattern_property.first);
if (!compiled_regex->ok()) {
return base::unexpected(
"/" + pattern_property.first +
"/ is a invalid regex: " + compiled_regex->error());
}
strings_.push_back(pattern_property.first);
property_nodes_[index].key = strings_.back().c_str();
if (!pattern_property.second.is_dict()) {
return base::unexpected(std::string());
}
RETURN_IF_ERROR(Parse(pattern_property.second.GetDict(),
&property_nodes_[index].schema,
references_and_ids));
++index;
}
CHECK_EQ(static_cast<int>(pattern_properties->size()), index - base_index);
}
properties_nodes_[extra].required_begin = required_properties_.size();
const base::Value::List* required_properties =
schema.FindList(schema::kRequired);
if (required_properties) {
for (const base::Value& val : *required_properties) {
strings_.push_back(val.GetString());
required_properties_.push_back(strings_.back().c_str());
}
}
properties_nodes_[extra].required_end = required_properties_.size();
if (properties_nodes_[extra].begin == properties_nodes_[extra].pattern_end) {
properties_nodes_[extra].begin = kInvalid;
properties_nodes_[extra].end = kInvalid;
properties_nodes_[extra].pattern_end = kInvalid;
properties_nodes_[extra].required_begin = kInvalid;
properties_nodes_[extra].required_end = kInvalid;
}
return base::ok();
}
base::expected<void, std::string> Schema::InternalStorage::ParseList(
const base::Value::Dict& schema,
SchemaNode* schema_node,
ReferencesAndIDs* references_and_ids) {
const base::Value::Dict* items = schema.FindDict(schema::kItems);
if (!items) {
return base::unexpected(
"Arrays must declare a single schema for their items.");
}
return Parse(*items, &schema_node->extra, references_and_ids);
}
base::expected<void, std::string> Schema::InternalStorage::ParseEnum(
const base::Value::Dict& schema,
base::Value::Type type,
SchemaNode* schema_node) {
const base::Value::List* possible_values = schema.FindList(schema::kEnum);
if (!possible_values) {
return base::unexpected("Enum attribute must be a list value");
}
if (possible_values->empty()) {
return base::unexpected("Enum attribute must be non-empty");
}
int offset_begin;
int offset_end;
if (type == base::Value::Type::INTEGER) {
offset_begin = static_cast<int>(int_enums_.size());
for (const auto& possible_value : *possible_values) {
if (!possible_value.is_int()) {
return base::unexpected("Invalid enumeration member type");
}
int_enums_.push_back(possible_value.GetInt());
}
offset_end = static_cast<int>(int_enums_.size());
} else if (type == base::Value::Type::STRING) {
offset_begin = static_cast<int>(string_enums_.size());
for (const auto& possible_value : *possible_values) {
if (!possible_value.is_string()) {
return base::unexpected("Invalid enumeration member type");
}
strings_.push_back(possible_value.GetString());
string_enums_.push_back(strings_.back().c_str());
}
offset_end = static_cast<int>(string_enums_.size());
} else {
return base::unexpected(
"Enumeration is only supported for integer and string.");
}
schema_node->extra = static_cast<int>(restriction_nodes_.size());
restriction_nodes_.push_back(RestrictionNode{
.enumeration_restriction = RestrictionNode::EnumerationRestriction{
.offset_begin = offset_begin, .offset_end = offset_end}});
return base::ok();
}
base::expected<void, std::string> Schema::InternalStorage::ParseRangedInt(
const base::Value::Dict& schema,
SchemaNode* schema_node) {
int min_value = schema.FindInt(schema::kMinimum).value_or(INT_MIN);
int max_value = schema.FindInt(schema::kMaximum).value_or(INT_MAX);
if (min_value > max_value) {
return base::unexpected("Invalid range restriction for int type.");
}
schema_node->extra = static_cast<int>(restriction_nodes_.size());
restriction_nodes_.push_back(
RestrictionNode{.ranged_restriction = RestrictionNode::RangedRestriction{
.max_value = max_value, .min_value = min_value}});
return base::ok();
}
base::expected<void, std::string> Schema::InternalStorage::ParseStringPattern(
const base::Value::Dict& schema,
SchemaNode* schema_node) {
const std::string* pattern = schema.FindString(schema::kPattern);
if (!pattern) {
return base::unexpected("Schema pattern must be a string.");
}
re2::RE2* compiled_regex = CompileRegex(*pattern);
if (!compiled_regex->ok()) {
return base::unexpected("/" + *pattern +
"/ is invalid regex: " + compiled_regex->error());
}
int index = static_cast<int>(string_enums_.size());
strings_.push_back(*pattern);
string_enums_.push_back(strings_.back().c_str());
schema_node->extra = static_cast<int>(restriction_nodes_.size());
restriction_nodes_.push_back(RestrictionNode{
.string_pattern_restriction = RestrictionNode::StringPatternRestriction{
.pattern_index = index, .pattern_index_backup = index}});
return base::ok();
}
// static
bool Schema::InternalStorage::ResolveReferences(
const ReferencesAndIDs& references_and_ids,
std::string* error) {
const auto& reference_list = references_and_ids.reference_list;
const auto& id_map = references_and_ids.id_map;
for (auto& ref : reference_list) {
auto id = id_map.find(ref.first);
if (id == id_map.end()) {
*error = "Invalid $ref: " + ref.first;
return false;
}
*ref.second = id->second;
}
return true;
}
void Schema::InternalStorage::FindSensitiveChildren() {
if (schema_nodes_.empty())
return;
std::set<int> handled_schema_nodes;
FindSensitiveChildrenRecursive(0, &handled_schema_nodes);
}
bool Schema::InternalStorage::FindSensitiveChildrenRecursive(
int index,
std::set<int>* handled_schema_nodes) {
DCHECK(static_cast<unsigned long>(index) < schema_nodes_.size());
SchemaNode& schema_node = schema_nodes_[index];
if (handled_schema_nodes->find(index) != handled_schema_nodes->end())
return schema_node.has_sensitive_children || schema_node.is_sensitive_value;
handled_schema_nodes->insert(index);
bool has_sensitive_children = false;
if (schema_node.type == base::Value::Type::DICT) {
const PropertiesNode& properties_node =
properties_nodes_[schema_node.extra];
// Iterate through properties and patternProperties.
for (int i = properties_node.begin; i < properties_node.pattern_end; ++i) {
int sub_index = property_nodes_[i].schema;
has_sensitive_children |=
FindSensitiveChildrenRecursive(sub_index, handled_schema_nodes);
}
if (properties_node.additional != kInvalid) {
has_sensitive_children |= FindSensitiveChildrenRecursive(
properties_node.additional, handled_schema_nodes);
}
} else if (schema_node.type == base::Value::Type::LIST) {
int sub_index = schema_node.extra;
has_sensitive_children |=
FindSensitiveChildrenRecursive(sub_index, handled_schema_nodes);
}
schema_node.has_sensitive_children = has_sensitive_children;
return schema_node.has_sensitive_children || schema_node.is_sensitive_value;
}
Schema::Iterator::Iterator(const scoped_refptr<const InternalStorage>& storage,
const PropertiesNode* node) {
if (node->begin == kInvalid || node->end == kInvalid) {
it_ = nullptr;
end_ = nullptr;
} else {
storage_ = storage;
it_ = storage->property(node->begin);
end_ = storage->property(node->end);
}
}
Schema::Iterator::Iterator(const Iterator& iterator)
: storage_(iterator.storage_), it_(iterator.it_), end_(iterator.end_) {}
Schema::Iterator::~Iterator() = default;
Schema::Iterator& Schema::Iterator::operator=(const Iterator& iterator) {
storage_ = iterator.storage_;
it_ = iterator.it_;
end_ = iterator.end_;
return *this;
}
bool Schema::Iterator::IsAtEnd() const {
return it_ == end_;
}
void Schema::Iterator::Advance() {
DCHECK(it_);
++it_;
}
const char* Schema::Iterator::key() const {
return it_->key;
}
Schema Schema::Iterator::schema() const {
return Schema(storage_, storage_->schema(it_->schema));
}
Schema::Schema() : node_(nullptr) {}
Schema::Schema(const scoped_refptr<const InternalStorage>& storage,
const SchemaNode* node)
: storage_(storage), node_(node) {}
Schema::Schema(const Schema& schema)
: storage_(schema.storage_), node_(schema.node_) {}
Schema::~Schema() = default;
Schema& Schema::operator=(const Schema& schema) {
storage_ = schema.storage_;
node_ = schema.node_;
return *this;
}
// static
Schema Schema::Wrap(const SchemaData* data) {
scoped_refptr<const InternalStorage> storage = InternalStorage::Wrap(data);
return Schema(storage, storage->root_node());
}
bool Schema::Validate(const base::Value& value,
SchemaOnErrorStrategy strategy,
PolicyErrorPath* out_error_path,
std::string* out_error) const {
if (!valid()) {
SchemaErrorFound(out_error_path, out_error, "The schema is invalid.");
return false;
}
if (value.type() != type()) {
// Allow the integer to double promotion. Note that range restriction on
// double is not supported now.
if (value.is_int() && type() == base::Value::Type::DOUBLE) {
return true;
}
SchemaErrorFound(
out_error_path, out_error,
base::StringPrintf(
"Policy type mismatch: expected: \"%s\", actual: \"%s\".",
base::Value::GetTypeName(type()),
base::Value::GetTypeName(value.type())));
return false;
}
if (value.is_dict()) {
base::flat_set<std::string> present_properties;
for (auto dict_item : value.GetDict()) {
SchemaList schema_list = GetMatchingProperties(dict_item.first);
if (schema_list.empty()) {
// Unknown property was detected.
if (!StrategyAllowUnknownWithoutWarning(strategy)) {
SchemaErrorFound(out_error_path, out_error,
"Unknown property: " + dict_item.first);
}
if (!StrategyAllowUnknown(strategy))
return false;
} else {
for (const auto& subschema : schema_list) {
std::string new_error;
const bool validation_result = subschema.Validate(
dict_item.second, strategy, out_error_path, &new_error);
if (!new_error.empty()) {
AddDictKeyPrefixToPath(dict_item.first, out_error_path);
if (out_error)
*out_error = std::move(new_error);
}
if (!validation_result) {
// Invalid property was detected.
return false;
}
}
present_properties.insert(dict_item.first);
}
}
for (const auto& required_property : GetRequiredProperties()) {
if (base::Contains(present_properties, required_property))
continue;
SchemaErrorFound(
out_error_path, out_error,
"Missing or invalid required property: " + required_property);
return false;
}
} else if (value.is_list()) {
for (size_t index = 0; index < value.GetList().size(); ++index) {
const base::Value& list_item = value.GetList()[index];
std::string new_error;
const bool validation_result =
GetItems().Validate(list_item, strategy, out_error_path, &new_error);
if (!new_error.empty()) {
AddListIndexPrefixToPath(index, out_error_path);
if (out_error)
*out_error = std::move(new_error);
}
if (!validation_result && !StrategyAllowInvalidListEntry(strategy))
return false; // Invalid list item was detected.
}
} else if (value.is_int()) {
if (node_->extra != kInvalid &&
!ValidateIntegerRestriction(node_->extra, value.GetInt())) {
SchemaErrorFound(out_error_path, out_error, "Invalid value for integer");
return false;
}
} else if (value.is_string()) {
if (node_->extra != kInvalid &&
!ValidateStringRestriction(node_->extra, value.GetString().c_str())) {
SchemaErrorFound(out_error_path, out_error, "Invalid value for string");
return false;
}
}
return true;
}
bool Schema::Normalize(base::Value* value,
SchemaOnErrorStrategy strategy,
PolicyErrorPath* out_error_path,
std::string* out_error,
bool* out_changed) const {
if (!valid()) {
SchemaErrorFound(out_error_path, out_error, "The schema is invalid.");
return false;
}
if (value->type() != type()) {
// Allow the integer to double promotion. Note that range restriction on
// double is not supported now.
if (value->is_int() && type() == base::Value::Type::DOUBLE) {
return true;
}
SchemaErrorFound(
out_error_path, out_error,
base::StringPrintf(
"Policy type mismatch: expected: \"%s\", actual: \"%s\".",
base::Value::GetTypeName(type()),
base::Value::GetTypeName(value->type())));
return false;
}
if (value->is_dict()) {
base::flat_set<std::string> present_properties;
std::vector<std::string> drop_list; // Contains the keys to drop.
for (auto dict_item : value->GetDict()) {
SchemaList schema_list = GetMatchingProperties(dict_item.first);
if (schema_list.empty()) {
// Unknown property was detected.
if (!StrategyAllowUnknownWithoutWarning(strategy)) {
SchemaErrorFound(out_error_path, out_error,
"Unknown property: " + dict_item.first);
}
if (!StrategyAllowUnknown(strategy))
return false;
if (!StrategyAllowUnknownWithoutWarning(strategy)) {
drop_list.push_back(dict_item.first);
}
} else {
for (const auto& subschema : schema_list) {
std::string new_error;
const bool normalization_result =
subschema.Normalize(&dict_item.second, strategy, out_error_path,
&new_error, out_changed);
if (!new_error.empty()) {
AddDictKeyPrefixToPath(dict_item.first, out_error_path);
if (out_error)
*out_error = std::move(new_error);
}
if (!normalization_result) {
// Invalid property was detected.
return false;
}
}
present_properties.insert(dict_item.first);
}
}
for (const auto& required_property : GetRequiredProperties()) {
if (base::Contains(present_properties, required_property))
continue;
SchemaErrorFound(
out_error_path, out_error,
"Missing or invalid required property: " + required_property);
return false;
}
if (out_changed && !drop_list.empty())
*out_changed = true;
for (const auto& drop_key : drop_list)
value->GetDict().Remove(drop_key);
return true;
} else if (value->is_list()) {
base::Value::List& list = value->GetList();
// Instead of removing invalid list items afterwards, we push valid items
// forward in the list by overriding invalid items. The next free position
// is indicated by |write_index|, which gets increased for every valid item.
// At the end |list| is resized to |write_index|'s size.
size_t write_index = 0;
for (size_t index = 0; index < list.size(); ++index) {
base::Value& list_item = list[index];
std::string new_error;
const bool normalization_result = GetItems().Normalize(
&list_item, strategy, out_error_path, &new_error, out_changed);
if (!new_error.empty()) {
AddListIndexPrefixToPath(index, out_error_path);
if (out_error)
*out_error = new_error;
}
if (!normalization_result) {
// Invalid list item was detected.
if (!StrategyAllowInvalidListEntry(strategy))
return false;
} else {
if (write_index != index)
list[write_index] = std::move(list_item);
++write_index;
}
}
if (out_changed && write_index < list.size())
*out_changed = true;
while (write_index < list.size()) {
list.erase(list.end() - 1);
}
return true;
}
return Validate(*value, strategy, out_error_path, out_error);
}
void Schema::MaskSensitiveValues(base::Value* value) const {
if (!valid())
return;
MaskSensitiveValuesRecursive(value);
}
// static
base::expected<Schema, std::string> Schema::Parse(const std::string& content) {
// Validate as a generic JSON schema, and ignore unknown attributes; they
// may become used in a future version of the schema format.
ASSIGN_OR_RETURN(auto dict,
Schema::ParseToDictAndValidate(
content, kSchemaOptionsIgnoreUnknownAttributes));
// Validate the main type.
const std::string* type = dict.FindString(schema::kType);
if (!type || *type != schema::kObject) {
return base::unexpected(
"The main schema must have a type attribute with \"object\" value.");
}
// Checks for invalid attributes at the top-level.
if (dict.contains(schema::kAdditionalProperties) ||
dict.contains(schema::kPatternProperties)) {
return base::unexpected(
"\"additionalProperties\" and \"patternProperties\" are not "
"supported at the main schema.");
}
ASSIGN_OR_RETURN(auto storage, InternalStorage::ParseSchema(dict));
return base::ok(Schema(storage, storage->root_node()));
}
// static
base::expected<base::Value::Dict, std::string> Schema::ParseToDictAndValidate(
const std::string& schema,
int validator_options) {
ASSIGN_OR_RETURN(
auto json,
base::JSONReader::ReadAndReturnValueWithError(
schema, base::JSONParserOptions::JSON_ALLOW_TRAILING_COMMAS |
base::JSONParserOptions::JSON_PARSE_CHROMIUM_EXTENSIONS),
[](auto e) { return std::move(e.ToString()); });
if (!json.is_dict()) {
return base::unexpected("Schema must be a JSON object");
}
RETURN_IF_ERROR(IsValidSchema(json.GetDict(), validator_options));
return base::ok(std::move(json).TakeDict());
}
base::Value::Type Schema::type() const {
CHECK(valid());
return node_->type;
}
Schema::Iterator Schema::GetPropertiesIterator() const {
CHECK(valid());
CHECK_EQ(base::Value::Type::DICT, type());
return Iterator(storage_, storage_->properties(node_->extra));
}
namespace {
bool CompareKeys(const PropertyNode& node, const std::string& key) {
return node.key < key;
}
} // namespace
Schema Schema::GetKnownProperty(const std::string& key) const {
CHECK(valid());
CHECK_EQ(base::Value::Type::DICT, type());
const PropertiesNode* node = storage_->properties(node_->extra);
if (node->begin == kInvalid || node->end == kInvalid)
return Schema();
const PropertyNode* begin = storage_->property(node->begin);
const PropertyNode* end = storage_->property(node->end);
const PropertyNode* it = std::lower_bound(begin, end, key, CompareKeys);
if (it != end && it->key == key)
return Schema(storage_, storage_->schema(it->schema));
return Schema();
}
Schema Schema::GetAdditionalProperties() const {
CHECK(valid());
CHECK_EQ(base::Value::Type::DICT, type());
const PropertiesNode* node = storage_->properties(node_->extra);
if (node->additional == kInvalid)
return Schema();
return Schema(storage_, storage_->schema(node->additional));
}
SchemaList Schema::GetPatternProperties(const std::string& key) const {
CHECK(valid());
CHECK_EQ(base::Value::Type::DICT, type());
const PropertiesNode* node = storage_->properties(node_->extra);
if (node->end == kInvalid || node->pattern_end == kInvalid)
return {};
const PropertyNode* begin = storage_->property(node->end);
const PropertyNode* end = storage_->property(node->pattern_end);
SchemaList matching_properties;
for (const PropertyNode* it = begin; it != end; ++it) {
if (re2::RE2::PartialMatch(key, *storage_->CompileRegex(it->key))) {
matching_properties.push_back(
Schema(storage_, storage_->schema(it->schema)));
}
}
return matching_properties;
}
std::vector<std::string> Schema::GetRequiredProperties() const {
CHECK(valid());
CHECK_EQ(base::Value::Type::DICT, type());
const PropertiesNode* node = storage_->properties(node_->extra);
if (node->required_begin == kInvalid || node->required_end == kInvalid)
return {};
const size_t begin = node->required_begin;
const size_t end = node->required_end;
return std::vector<std::string>(storage_->required_property(begin),
storage_->required_property(end));
}
Schema Schema::GetProperty(const std::string& key) const {
Schema schema = GetKnownProperty(key);
if (schema.valid())
return schema;
return GetAdditionalProperties();
}
SchemaList Schema::GetMatchingProperties(const std::string& key) const {
SchemaList schema_list;
Schema known_property = GetKnownProperty(key);
if (known_property.valid())
schema_list.push_back(known_property);
SchemaList pattern_properties = GetPatternProperties(key);
schema_list.insert(schema_list.end(), pattern_properties.begin(),
pattern_properties.end());
if (schema_list.empty()) {
Schema additional_property = GetAdditionalProperties();
if (additional_property.valid())
schema_list.push_back(additional_property);
}
return schema_list;
}
Schema Schema::GetItems() const {
CHECK(valid());
CHECK_EQ(base::Value::Type::LIST, type());
if (node_->extra == kInvalid)
return Schema();
return Schema(storage_, storage_->schema(node_->extra));
}
bool Schema::ValidateIntegerRestriction(int index, int value) const {
const RestrictionNode* rnode = storage_->restriction(index);
if (rnode->ranged_restriction.min_value <=
rnode->ranged_restriction.max_value) {
return rnode->ranged_restriction.min_value <= value &&
rnode->ranged_restriction.max_value >= value;
} else {
for (int i = rnode->enumeration_restriction.offset_begin;
i < rnode->enumeration_restriction.offset_end; ++i) {
if (*storage_->int_enums(i) == value)
return true;
}
return false;
}
}
bool Schema::ValidateStringRestriction(int index, const char* str) const {
const RestrictionNode* rnode = storage_->restriction(index);
if (rnode->enumeration_restriction.offset_begin <
rnode->enumeration_restriction.offset_end) {
for (int i = rnode->enumeration_restriction.offset_begin;
i < rnode->enumeration_restriction.offset_end; ++i) {
if (strcmp(*storage_->string_enums(i), str) == 0)
return true;
}
return false;
} else {
int pattern_index = rnode->string_pattern_restriction.pattern_index;
DCHECK(pattern_index ==
rnode->string_pattern_restriction.pattern_index_backup);
re2::RE2* regex =
storage_->CompileRegex(*storage_->string_enums(pattern_index));
return re2::RE2::PartialMatch(str, *regex);
}
}
void Schema::MaskSensitiveValuesRecursive(base::Value* value) const {
if (IsSensitiveValue()) {
*value = base::Value(kSensitiveValueMask);
return;
}
if (!HasSensitiveChildren())
return;
if (value->type() != type())
return;
if (value->is_dict()) {
for (auto [key, sub_value] : value->GetDict()) {
SchemaList schema_list = GetMatchingProperties(key);
for (const auto& schema_item : schema_list)
schema_item.MaskSensitiveValuesRecursive(&sub_value);
}
} else if (value->is_list()) {
for (auto& list_elem : value->GetList())
GetItems().MaskSensitiveValuesRecursive(&list_elem);
}
}
Schema Schema::GetValidationSchema() const {
CHECK(valid());
const SchemaNode* validation_schema_root_node =
storage_->validation_schema_root_node();
if (!validation_schema_root_node)
return Schema();
return Schema(storage_, validation_schema_root_node);
}
bool Schema::IsSensitiveValue() const {
CHECK(valid());
// This is safe because |node_| is guaranteed to have been returned from
// |storage_| and |storage_->root_node()| always returns to the |SchemaNode|
// with index 0.
int index = node_ - storage_->root_node();
const SchemaNode* schema_node = storage_->schema(index);
if (!schema_node)
return false;
return schema_node->is_sensitive_value;
}
bool Schema::HasSensitiveChildren() const {
CHECK(valid());
// This is safe because |node_| is guaranteed to have been returned from
// |storage_| and |storage_->root_node()| always returns to the |SchemaNode|
// with index 0.
int index = node_ - storage_->root_node();
const SchemaNode* schema_node = storage_->schema(index);
if (!schema_node)
return false;
return schema_node->has_sensitive_children;
}
} // namespace policy
|