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 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672
|
#!/usr/bin/env python3
# Copyright 2012 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
'''python3 %(prog)s [options]
Pass at least:
--chrome-version-major <chrome major version> or --all-chrome-versions
--target-platform <which platform the target code will be generated for and can
be one of (win, mac, linux, chromeos, ios, fuchsia)>
--policy-templates-file <path to the policy_templates.json input file>.'''
from argparse import ArgumentParser
from collections import defaultdict
from collections import namedtuple
from collections import OrderedDict
from functools import cmp_to_key
from functools import partial
import ast
import codecs
import json
import os
import re
import sys
import textwrap
from xml.sax.saxutils import escape as xml_escape
CHROME_POLICY_KEY = 'SOFTWARE\\\\Policies\\\\Google\\\\Chrome'
CHROME_FOR_TESTING_POLICY_KEY = CHROME_POLICY_KEY + ' for Testing'
CHROMIUM_POLICY_KEY = 'SOFTWARE\\\\Policies\\\\Chromium'
PLATFORM_STRINGS = {
'chrome_frame': ['win'],
'chrome_os': ['chrome_os'],
'android': ['android'],
'webview_android': ['android'],
'ios': ['ios'],
'fuchsia': ['fuchsia'],
'chrome.win': ['win'],
'chrome.linux': ['linux'],
'chrome.mac': ['mac'],
'chrome.*': ['win', 'mac', 'linux'],
'chrome.win7': ['win'],
}
class PolicyDetails:
"""Parses a policy template and caches all its details."""
# Maps policy types to a tuple with 4 other types:
# - the equivalent base::Value::Type or 'TYPE_EXTERNAL' if the policy
# references external data
# - the equivalent Protobuf field type
# - the name of one of the protobufs for shared policy types
# - the equivalent type in Android's App Restriction Schema
TYPE_MAP = {
'dict': ('Type::DICT', 'string', 'String', 'string'),
'external': ('TYPE_EXTERNAL', 'string', 'String', 'invalid'),
'int': ('Type::INTEGER', 'int64', 'Integer', 'integer'),
'int-enum': ('Type::INTEGER', 'int64', 'Integer', 'choice'),
'list': ('Type::LIST', 'StringList', 'StringList', 'string'),
'main': ('Type::BOOLEAN', 'bool', 'Boolean', 'bool'),
'string': ('Type::STRING', 'string', 'String', 'string'),
'string-enum': ('Type::STRING', 'string', 'String', 'choice'),
'string-enum-list':
('Type::LIST', 'StringList', 'StringList', 'multi-select'),
}
class EnumItem:
def __init__(self, item):
self.caption = PolicyDetails._RemovePlaceholders(item['caption'])
self.value = item['value']
def _ConvertPlatform(self, platform):
'''Converts product platform string in policy_templates.json to platform
string that is defined in build config.'''
if platform not in PLATFORM_STRINGS:
raise RuntimeError('Platform "%s" is not supported' % platform)
return PLATFORM_STRINGS[platform]
def __init__(self, policy, chrome_major_version, target_platform, valid_tags):
self.id = policy['id']
self.name = policy['name']
self.tags = policy.get('tags', None)
self._CheckTagsValidity(valid_tags)
features = policy.get('features', {})
self.can_be_recommended = features.get('can_be_recommended', False)
self.can_be_mandatory = features.get('can_be_mandatory', True)
self.internal_only = features.get('internal_only', False)
self.metapolicy_type = features.get('metapolicy_type', '')
self.is_deprecated = policy.get('deprecated', False)
self.is_device_only = policy.get('device_only', False)
self.per_profile = features.get('per_profile', False)
self.is_user_only = features.get('user_only', False)
self.schema = policy['schema']
self.validation_schema = policy.get('validation_schema')
self.has_enterprise_default = 'default_for_enterprise_users' in policy
if self.has_enterprise_default:
self.enterprise_default = policy['default_for_enterprise_users']
if self.has_enterprise_default:
self.default_policy_level = policy.get('default_policy_level', '')
if (self.default_policy_level == 'recommended'
and not self.can_be_recommended):
raise RuntimeError('Policy ' + self.name +
' has default_policy_level set to ' +
self.default_policy_level + ', '
'but can_be_recommended feature is not set to True')
self.cloud_only = features.get('cloud_only', False)
self.platforms = set()
self.future_on = set()
for platform, version_range in map(lambda s: s.split(':'),
policy.get('supported_on', [])):
split_result = version_range.split('-')
if len(split_result) != 2:
raise RuntimeError('supported_on must have exactly one dash: "%s"' %
self.name)
(version_min, version_max) = split_result
if version_min == '':
raise RuntimeError('supported_on must define a start version: "%s"' %
self.name)
# Skip if filtering by Chromium version and the current Chromium version
# does not support the policy.
if chrome_major_version:
if (int(version_min) > chrome_major_version
or version_max != '' and int(version_max) < chrome_major_version):
continue
self.platforms.update(self._ConvertPlatform(platform))
for platform in policy.get('future_on', []):
self.future_on.update(self._ConvertPlatform(platform))
if self.is_device_only and self.platforms.union(self.future_on) > set(
['chrome_os']):
raise RuntimeError('device_only is only allowed for Chrome OS: "%s"' %
self.name)
self.is_supported = (target_platform in self.platforms
or target_platform in self.future_on)
self.is_future = target_platform in self.future_on
if policy['type'] not in PolicyDetails.TYPE_MAP:
raise NotImplementedError(
'Unknown policy type for %s: %s' % (policy['name'], policy['type']))
self.policy_type, self.protobuf_type, self.policy_protobuf_type, \
self.restriction_type = PolicyDetails.TYPE_MAP[policy['type']]
self.desc = '\n'.join(
map(str.strip,
PolicyDetails._RemovePlaceholders(policy['desc']).splitlines()))
self.caption = PolicyDetails._RemovePlaceholders(policy['caption'])
self.max_size = policy.get('max_size', 0)
items = policy.get('items')
if items is None:
self.items = None
else:
self.items = [PolicyDetails.EnumItem(entry) for entry in items]
PH_PATTERN = re.compile('<ph[^>]*>([^<]*|[^<]*<ex>([^<]*)</ex>[^<]*)</ph>')
def _CheckTagsValidity(self, valid_tags):
if self.tags == None:
raise RuntimeError('Policy ' + self.name + ' has to contain a list of '
'tags!\n An empty list is also valid but means '
'setting this policy can never harm the user\'s '
'privacy or security.\n')
for tag in self.tags:
if not tag in valid_tags:
raise RuntimeError('Invalid Tag:' + tag + '!\n'
'Chose a valid tag from \'risk_tag_definitions\' (a '
'subproperty of root in policy_templates.json)!')
@property
def scope(self):
"""Get policy scope string based on per_profile and user_only feature.
The string is defined in policy_details.h.
"""
if self.is_device_only:
return 'kDevice'
if self.per_profile:
if self.is_user_only:
return 'kSingleProfile'
else:
return 'kProfile'
else:
return 'kBrowser'
# Simplistic grit placeholder stripper.
@staticmethod
def _RemovePlaceholders(text):
result = ''
pos = 0
for m in PolicyDetails.PH_PATTERN.finditer(text):
result += text[pos:m.start(0)]
result += m.group(2) or m.group(1)
pos = m.end(0)
result += text[pos:]
return result
class PolicyAtomicGroup:
"""Parses a policy atomic group and caches its name and policy names"""
def __init__(self, policy_group, available_policies,
policies_already_in_group):
self.id = policy_group['id']
self.name = policy_group['name']
self.policies = policy_group.get('policies', None)
self._CheckPoliciesValidity(available_policies, policies_already_in_group)
def _CheckPoliciesValidity(self, available_policies,
policies_already_in_group):
if self.policies == None or len(self.policies) <= 0:
raise RuntimeError('Atomic policy group ' + self.name +
' has to contain a list of '
'policies!\n')
for policy in self.policies:
if policy in policies_already_in_group:
raise RuntimeError('Policy: ' + policy +
' cannot be in more than one atomic group '
'in policy_templates.json)!')
policies_already_in_group.add(policy)
if not policy in available_policies:
raise RuntimeError('Invalid policy: ' + policy + ' in atomic group ' +
self.name + '.\n')
def main():
parser = ArgumentParser(usage=__doc__)
parser.add_argument(
'--pch',
'--policy-constants-header',
dest='header_path',
help='generate header file of policy constants',
metavar='FILE')
parser.add_argument(
'--pcc',
'--policy-constants-source',
dest='source_path',
help='generate source file of policy constants',
metavar='FILE')
parser.add_argument(
'--cpp',
'--cloud-policy-protobuf',
dest='cloud_policy_proto_path',
help='generate cloud policy protobuf file',
metavar='FILE')
parser.add_argument(
'--csp',
'--chrome-settings-protobuf',
dest='chrome_settings_proto_path',
help='generate chrome settings protobuf file',
metavar='FILE')
parser.add_argument(
'--ard',
'--app-restrictions-definition',
dest='app_restrictions_path',
help='generate an XML file as specified by '
'Android\'s App Restriction Schema',
metavar='FILE')
parser.add_argument(
'--rth',
'--risk-tag-header',
dest='risk_header_path',
help='generate header file for policy risk tags',
metavar='FILE')
parser.add_argument('--chrome-version-major',
dest='chrome_version_major',
help='Chrome major version',
type=int)
parser.add_argument(
'--all-chrome-versions',
action='store_true',
dest='all_chrome_versions',
default=False,
help='do not restrict generated policies by chrome version')
parser.add_argument(
'--target-platform',
dest='target_platform',
help='the platform the generated code should run on - can be one of'
'(win, mac, linux, chromeos, fuchsia)',
metavar='PLATFORM')
parser.add_argument(
'--policy-templates-file',
dest='policy_templates_file',
help='path to the policy_templates.json input file',
metavar='FILE')
parser.add_argument(
'--no-chunking',
action='store_false',
dest='chunking', # A variable called `no_chunking` would be confusing.
default=True,
help='do not split policies into subProto1, subProto2, etc.')
args = parser.parse_args()
has_arg_error = False
if not args.target_platform:
print('Error: Missing --target-platform=<platform>')
has_arg_error = True
if not args.policy_templates_file:
print('Error: Missing'
' --policy-templates-file=<path to policy_templates.json>')
has_arg_error = True
if not args.chrome_version_major and not args.all_chrome_versions:
print('Error: Missing'
' --chrome-version-major=<major version>\n'
' or --all-chrome-versions')
has_arg_error = True
if has_arg_error:
print('')
parser.print_help()
return 2
target_platform = args.target_platform
template_file_name = args.policy_templates_file
# --target-platform accepts "chromeos" as its input because that's what is
# used within GN. Within policy templates, "chrome_os" is used instead.
if target_platform == 'chromeos':
target_platform = 'chrome_os'
if args.all_chrome_versions:
chrome_major_version = None
else:
chrome_major_version = args.chrome_version_major
template_file_contents = _LoadJSONFile(template_file_name)
risk_tags = RiskTags(template_file_contents)
policy_details = [
PolicyDetails(policy, chrome_major_version, target_platform,
risk_tags.GetValidTags())
for policy in template_file_contents['policy_definitions']
if policy['type'] != 'group'
]
risk_tags.ComputeMaxTags(policy_details)
sorted_policy_details = sorted(policy_details, key=lambda policy: policy.name)
policy_details_set = list(map((lambda x: x.name), policy_details))
policies_already_in_group = set()
policy_atomic_groups = [
PolicyAtomicGroup(group, policy_details_set, policies_already_in_group)
for group in template_file_contents['policy_atomic_group_definitions']
]
sorted_policy_atomic_groups = sorted(
policy_atomic_groups, key=lambda group: group.name)
def GenerateFile(path, writer, sorted=False, xml=False):
if path:
with codecs.open(path, 'w', encoding='utf-8') as f:
_OutputGeneratedWarningHeader(f, template_file_name, xml)
writer(sorted and sorted_policy_details or policy_details,
sorted and sorted_policy_atomic_groups or policy_atomic_groups,
target_platform, f, risk_tags, args.chunking)
if args.header_path:
GenerateFile(args.header_path, _WritePolicyConstantHeader, sorted=True)
if args.source_path:
GenerateFile(args.source_path, _WritePolicyConstantSource, sorted=True)
if args.risk_header_path:
GenerateFile(args.risk_header_path, _WritePolicyRiskTagHeader)
if args.cloud_policy_proto_path:
GenerateFile(args.cloud_policy_proto_path, _WriteCloudPolicyProtobuf)
if args.chrome_settings_proto_path:
GenerateFile(args.chrome_settings_proto_path,
_WriteChromeSettingsProtobuf,
sorted=True)
if target_platform == 'android' and args.app_restrictions_path:
GenerateFile(args.app_restrictions_path, _WriteAppRestrictions, xml=True)
return 0
#------------------ shared helpers ---------------------------------#
def _OutputGeneratedWarningHeader(f, template_file_path, xml_style):
left_margin = '//'
if xml_style:
left_margin = ' '
f.write('<?xml version="1.0" encoding="utf-8"?>\n' '<!--\n')
else:
f.write('//\n')
f.write(left_margin + ' DO NOT MODIFY THIS FILE DIRECTLY!\n')
f.write(left_margin + ' IT IS GENERATED BY generate_policy_source.py\n')
f.write(left_margin + ' FROM ' + template_file_path + '\n')
if xml_style:
f.write('-->\n\n')
else:
f.write(left_margin + '\n\n')
COMMENT_WRAPPER = textwrap.TextWrapper()
COMMENT_WRAPPER.width = 80
COMMENT_WRAPPER.initial_indent = '// '
COMMENT_WRAPPER.subsequent_indent = '// '
COMMENT_WRAPPER.replace_whitespace = False
# Writes a comment, each line prefixed by // and wrapped to 80 spaces.
def _OutputComment(f, comment):
for line in comment.splitlines():
if len(line) == 0:
f.write('//')
else:
f.write(COMMENT_WRAPPER.fill(line))
f.write('\n')
def _LoadJSONFile(json_file):
with codecs.open(json_file, 'r', encoding='utf-8') as f:
return json.load(f)
def _GetSupportedChromeUserPolicies(policies, protobuf_type):
return [
p for p in policies if p.is_supported and not p.is_device_only
and p.policy_protobuf_type == protobuf_type
]
# Returns the policies supported by at least one platform.
# Ensure only windows supported policies are returned when building for windows.
# Eventually only supported policies on every platforms will be returned.
def _GetSupportedPolicies(policies, target_platform):
# TODO(crbug.com/40855589): Remove this special case once deprecated policies
# have been removed for fuchsia
if target_platform == 'fuchsia':
is_deprecated = lambda policy: len(policy.platforms) + len(
policy.future_on) > 0 and policy.is_deprecated
return [
policy for policy in policies
if (policy.is_supported or is_deprecated(policy))
]
return [policy for policy in policies if policy.is_supported]
#------------------ policy constants header ------------------------#
# Return a list of all policies of type |metapolicy_type|.
def _GetMetapoliciesOfType(policies, metapolicy_type):
return [
policy for policy in policies if policy.metapolicy_type == metapolicy_type
]
def _WritePolicyConstantHeader(all_policies, policy_atomic_groups,
target_platform, f, risk_tags, chunking):
policies = _GetSupportedPolicies(all_policies, target_platform)
f.write('''#ifndef COMPONENTS_POLICY_POLICY_CONSTANTS_H_
#define COMPONENTS_POLICY_POLICY_CONSTANTS_H_
#include <cstdint>
#include <string>
#include "components/policy/core/common/policy_details.h"
#include "components/policy/core/common/policy_map.h"
namespace enterprise_management {
class BooleanPolicyProto;
class CloudPolicySettings;
class IntegerPolicyProto;
class StringListPolicyProto;
class StringPolicyProto;
}
namespace em = enterprise_management;
namespace policy {
namespace internal {
struct SchemaData;
}
''')
if target_platform == 'win':
f.write('// The windows registry path where Chrome policy '
'configuration resides.\n'
'extern const wchar_t kRegistryChromePolicyKey[];\n')
f.write('''#if BUILDFLAG(IS_CHROMEOS)
// Sets default profile policies values for enterprise users.
void SetEnterpriseUsersProfileDefaults(PolicyMap* policy_map);
// Sets default system-wide policies values for enterprise users.
void SetEnterpriseUsersSystemWideDefaults(PolicyMap* policy_map);
// Sets all default values for enterprise users.
void SetEnterpriseUsersDefaults(PolicyMap* policy_map);
#endif
// Returns the PolicyDetails for |policy| if |policy| is a known
// Chrome policy, otherwise returns nullptr.
const PolicyDetails* GetChromePolicyDetails(
const std::string& policy);
// Returns the schema data of the Chrome policy schema.
const internal::SchemaData* GetChromeSchemaData();
''')
f.write('// Key names for the policy settings.\n' 'namespace key {\n\n')
for policy in policies:
f.write('extern const char k' + policy.name + '[];\n')
f.write('\n} // namespace key\n\n')
f.write('// Group names for the policy settings.\n' 'namespace group {\n\n')
for group in policy_atomic_groups:
f.write('extern const char k' + group.name + '[];\n')
f.write('\n} // namespace group\n\n')
f.write('struct AtomicGroup {\n'
' const short id;\n'
' const char* policy_group;\n'
' const char* const* policies;\n'
'};\n\n')
f.write('extern const AtomicGroup kPolicyAtomicGroupMappings[];\n\n')
f.write('extern const size_t kPolicyAtomicGroupMappingsLength;\n\n')
# Declare arrays of metapolicies.
f.write('// Arrays of metapolicies.\n' 'namespace metapolicy {\n\n')
f.write('extern const char* const kMerge[%s];\n' %
len(_GetMetapoliciesOfType(policies, METAPOLICY_TYPE['merge'])))
f.write('extern const char* const kPrecedence[%s];\n\n' %
len(_GetMetapoliciesOfType(policies, METAPOLICY_TYPE['precedence'])))
f.write('} // namespace metapolicy\n\n')
f.write('enum class StringPolicyType {\n'
' STRING,\n'
' JSON,\n'
' EXTERNAL,\n'
'};\n\n')
# User policy proto pointers, one struct for each protobuf type.
protobuf_types = _GetProtobufTypes()
for protobuf_type in protobuf_types:
_WriteChromePolicyAccessHeader(policies, f, protobuf_type)
f.write('constexpr int64_t kDevicePolicyExternalDataResourceCacheSize = %d;\n'
% _ComputeTotalDevicePolicyExternalDataMaxSize(policies))
f.write('\n} // namespace policy\n\n'
'#endif // COMPONENTS_POLICY_POLICY_CONSTANTS_H_\n')
def _WriteChromePolicyAccessHeader(policies, f, protobuf_type):
supported_user_policies = _GetSupportedChromeUserPolicies(
policies, protobuf_type)
f.write('// Read access to the protobufs of all supported %s user policies.\n'
% protobuf_type.lower())
f.write('struct %sPolicyAccess {\n' % protobuf_type)
f.write(' const char* policy_key;\n'
' bool per_profile;\n'
' bool (*has_proto)(const em::CloudPolicySettings& policy);\n'
' const em::%sPolicyProto& (*get_proto)(\n'
' const em::CloudPolicySettings& policy);\n' % protobuf_type)
if protobuf_type == 'String':
f.write(' const StringPolicyType type;\n')
f.write('};\n')
f.write('extern const std::array<%sPolicyAccess, %d> k%sPolicyAccess;\n\n' %
(protobuf_type, len(supported_user_policies), protobuf_type))
def _ComputeTotalDevicePolicyExternalDataMaxSize(policies):
total_device_policy_external_data_max_size = 0
for policy in policies:
if policy.is_device_only and policy.policy_type == 'TYPE_EXTERNAL':
total_device_policy_external_data_max_size += policy.max_size
return total_device_policy_external_data_max_size
#------------------ policy constants source ------------------------#
SchemaNodeKey = namedtuple('SchemaNodeKey',
'schema_type extra is_sensitive_value')
SchemaNode = namedtuple(
'SchemaNode',
'schema_type extra is_sensitive_value has_sensitive_children comments')
PropertyNode = namedtuple('PropertyNode', 'key schema')
PropertiesNode = namedtuple(
'PropertiesNode',
'begin end pattern_end required_begin required_end additional name')
RestrictionNode = namedtuple('RestrictionNode', 'first second')
# A mapping of the simple schema types to base::Value::Types.
SIMPLE_SCHEMA_NAME_MAP = {
'boolean': 'Type::BOOLEAN',
'integer': 'Type::INTEGER',
'null': 'Type::NONE',
'number': 'Type::DOUBLE',
'string': 'Type::STRING',
}
METAPOLICY_TYPE = {
'merge': 'merge',
'precedence': 'precedence',
}
INVALID_INDEX = -1
MIN_INDEX = -1
MAX_INDEX = (1 << 15) - 1 # signed short in c++
MIN_POLICY_ID = 0
MAX_POLICY_ID = (1 << 16) - 1 # unsigned short
MIN_EXTERNAL_DATA_SIZE = 0
MAX_EXTERNAL_DATA_SIZE = (1 << 32) - 1 # unsigned int32
class SchemaNodesGenerator:
"""Builds the internal structs to represent a JSON schema."""
def __init__(self, shared_strings):
"""Creates a new generator.
|shared_strings| is a map of strings to a C expression that evaluates to
that string at runtime. This mapping can be used to reuse existing string
constants."""
self.shared_strings = shared_strings
self.key_index_map = {} # |SchemaNodeKey| -> index in |schema_nodes|
self.schema_nodes = [] # List of |SchemaNode|s
self.property_nodes = [] # List of |PropertyNode|s
self.properties_nodes = [] # List of |PropertiesNode|s
self.restriction_nodes = [] # List of |RestrictionNode|s
self.required_properties = []
self.int_enums = []
self.string_enums = []
self.ranges = {}
self.id_map = {}
def GetString(self, s):
if s in self.shared_strings:
return self.shared_strings[s]
# Generate JSON escaped string, which is slightly different from desired
# C/C++ escaped string. Known differences includes unicode escaping format.
return json.dumps(s)
def AppendSchema(self, schema_type, extra, is_sensitive_value, comment=''):
# Find existing schema node with same structure.
key_node = SchemaNodeKey(schema_type, extra, is_sensitive_value)
if key_node in self.key_index_map:
index = self.key_index_map[key_node]
if comment:
self.schema_nodes[index].comments.add(comment)
return index
# Create new schema node.
index = len(self.schema_nodes)
comments = {comment} if comment else set()
schema_node = SchemaNode(schema_type, extra, is_sensitive_value, False,
comments)
self.schema_nodes.append(schema_node)
self.key_index_map[key_node] = index
return index
def AppendRestriction(self, first, second):
r = RestrictionNode(str(first), str(second))
if not r in self.ranges:
self.ranges[r] = len(self.restriction_nodes)
self.restriction_nodes.append(r)
return self.ranges[r]
def GetSimpleType(self, name, is_sensitive_value):
return self.AppendSchema(SIMPLE_SCHEMA_NAME_MAP[name], INVALID_INDEX,
is_sensitive_value, 'simple type: ' + name)
def SchemaHaveRestriction(self, schema):
return any(keyword in schema
for keyword in ['minimum', 'maximum', 'enum', 'pattern'])
def IsConsecutiveInterval(self, seq):
sortedSeq = sorted(seq)
return all(
sortedSeq[i] + 1 == sortedSeq[i + 1] for i in range(len(sortedSeq) - 1))
def GetEnumIntegerType(self, schema, is_sensitive_value, name):
assert all(type(x) == int for x in schema['enum'])
possible_values = schema['enum']
if self.IsConsecutiveInterval(possible_values):
index = self.AppendRestriction(max(possible_values), min(possible_values))
return self.AppendSchema(
'Type::INTEGER', index, is_sensitive_value,
'integer with enumeration restriction (use range instead): %s' % name)
offset_begin = len(self.int_enums)
self.int_enums += possible_values
offset_end = len(self.int_enums)
return self.AppendSchema('Type::INTEGER',
self.AppendRestriction(offset_begin, offset_end),
is_sensitive_value,
'integer with enumeration restriction: %s' % name)
def GetEnumStringType(self, schema, is_sensitive_value, name):
assert all(type(x) == str for x in schema['enum'])
offset_begin = len(self.string_enums)
self.string_enums += schema['enum']
offset_end = len(self.string_enums)
return self.AppendSchema('Type::STRING',
self.AppendRestriction(offset_begin, offset_end),
is_sensitive_value,
'string with enumeration restriction: %s' % name)
def GetEnumType(self, schema, is_sensitive_value, name):
if len(schema['enum']) == 0:
raise RuntimeError('Empty enumeration in %s' % name)
elif schema['type'] == 'integer':
return self.GetEnumIntegerType(schema, is_sensitive_value, name)
elif schema['type'] == 'string':
return self.GetEnumStringType(schema, is_sensitive_value, name)
else:
raise RuntimeError('Unknown enumeration type in %s' % name)
def GetPatternType(self, schema, is_sensitive_value, name):
if schema['type'] != 'string':
raise RuntimeError('Unknown pattern type in %s' % name)
pattern = schema['pattern']
# Try to compile the pattern to validate it, note that the syntax used
# here might be slightly different from re2.
# TODO(binjin): Add a python wrapper of re2 and use it here.
re.compile(pattern)
index = len(self.string_enums)
self.string_enums.append(pattern)
return self.AppendSchema('Type::STRING', self.AppendRestriction(
index, index), is_sensitive_value,
'string with pattern restriction: %s' % name)
def GetRangedType(self, schema, is_sensitive_value, name):
if schema['type'] != 'integer':
raise RuntimeError('Unknown ranged type in %s' % name)
min_value_set, max_value_set = False, False
if 'minimum' in schema:
min_value = int(schema['minimum'])
min_value_set = True
if 'maximum' in schema:
max_value = int(schema['maximum'])
max_value_set = True
if min_value_set and max_value_set and min_value > max_value:
raise RuntimeError('Invalid ranged type in %s' % name)
index = self.AppendRestriction(
str(max_value) if max_value_set else 'INT_MAX',
str(min_value) if min_value_set else 'INT_MIN')
return self.AppendSchema('Type::INTEGER', index, is_sensitive_value,
'integer with ranged restriction: %s' % name)
def Generate(self, schema, name):
"""Generates the structs for the given schema.
|schema|: a valid JSON schema in a dictionary.
|name|: the name of the current node, for the generated comments."""
if '$ref' in schema:
if 'id' in schema:
raise RuntimeError("Schemas with a $ref can't have an id")
if not isinstance(schema['$ref'], str):
raise RuntimeError("$ref attribute must be a string")
return schema['$ref']
is_sensitive_value = schema.get('sensitiveValue', False)
assert type(is_sensitive_value) is bool
if schema['type'] in SIMPLE_SCHEMA_NAME_MAP:
if not self.SchemaHaveRestriction(schema):
# Simple types use shared nodes.
return self.GetSimpleType(schema['type'], is_sensitive_value)
elif 'enum' in schema:
return self.GetEnumType(schema, is_sensitive_value, name)
elif 'pattern' in schema:
return self.GetPatternType(schema, is_sensitive_value, name)
else:
return self.GetRangedType(schema, is_sensitive_value, name)
if schema['type'] == 'array':
return self.AppendSchema(
'Type::LIST',
self.GenerateAndCollectID(schema['items'], 'items of ' + name),
is_sensitive_value)
elif schema['type'] == 'object':
# Reserve an index first, so that dictionaries come before their
# properties. This makes sure that the root node is the first in the
# SchemaNodes array.
# This however, prevents de-duplication for object schemas since we could
# only determine duplicates after all child schema nodes are generated as
# well and then we couldn't remove the newly created schema node without
# invalidating all child schema indices.
index = len(self.schema_nodes)
self.schema_nodes.append(
SchemaNode('Type::DICT', INVALID_INDEX, is_sensitive_value, False,
{name}))
if 'additionalProperties' in schema:
additionalProperties = self.GenerateAndCollectID(
schema['additionalProperties'], 'additionalProperties of ' + name)
else:
additionalProperties = INVALID_INDEX
# Properties must be sorted by name, for the binary search lookup.
# Note that |properties| must be evaluated immediately, so that all the
# recursive calls to Generate() append the necessary child nodes; if
# |properties| were a generator then this wouldn't work.
sorted_properties = sorted(schema.get('properties', {}).items())
properties = [
PropertyNode(
self.GetString(key), self.GenerateAndCollectID(subschema, key))
for key, subschema in sorted_properties
]
pattern_properties = []
for pattern, subschema in schema.get('patternProperties', {}).items():
pattern_properties.append(
PropertyNode(
self.GetString(pattern),
self.GenerateAndCollectID(subschema, pattern)))
begin = len(self.property_nodes)
self.property_nodes += properties
end = len(self.property_nodes)
self.property_nodes += pattern_properties
pattern_end = len(self.property_nodes)
if index == 0:
self.root_properties_begin = begin
self.root_properties_end = end
required_begin = len(self.required_properties)
required_properties = schema.get('required', [])
assert type(required_properties) is list
assert all(type(x) == str for x in required_properties)
self.required_properties += required_properties
required_end = len(self.required_properties)
# Check that each string in |required_properties| is in |properties|.
properties = schema.get('properties', {})
for name in required_properties:
assert name in properties
extra = len(self.properties_nodes)
self.properties_nodes.append(
PropertiesNode(begin, end, pattern_end, required_begin, required_end,
additionalProperties, name))
# Update index at |extra| now, since that was filled with a dummy value
# when the schema node was created.
self.schema_nodes[index] = self.schema_nodes[index]._replace(extra=extra)
return index
else:
assert False
def GenerateAndCollectID(self, schema, name):
"""A wrapper of Generate(), will take the return value, check and add 'id'
attribute to self.id_map. The wrapper needs to be used for every call to
Generate().
"""
index = self.Generate(schema, name)
if 'id' not in schema:
return index
id_str = schema['id']
if id_str in self.id_map:
raise RuntimeError('Duplicated id: ' + id_str)
self.id_map[id_str] = index
return index
def Write(self, f):
"""Writes the generated structs to the given file.
|f| an open file to write to."""
f.write('const internal::SchemaNode kSchemas[] = {\n'
'// Type' + ' ' * 27 +
'Extra IsSensitiveValue HasSensitiveChildren\n')
for schema_node in self.schema_nodes:
assert schema_node.extra >= MIN_INDEX and schema_node.extra <= MAX_INDEX
comment = ('\n' + ' ' * 69 + '// ').join(sorted(schema_node.comments))
f.write(' { base::Value::%-19s %4s %-16s %-5s }, // %s\n' %
(schema_node.schema_type + ',', str(schema_node.extra) + ',',
str(schema_node.is_sensitive_value).lower() + ',',
str(schema_node.has_sensitive_children).lower(), comment))
f.write('};\n\n')
if self.property_nodes:
f.write('const internal::PropertyNode kPropertyNodes[] = {\n'
'// Property' + ' ' * 61 + 'Schema\n')
for property_node in self.property_nodes:
f.write(' { %-64s %6d },\n' % (property_node.key + ',',
property_node.schema))
f.write('};\n\n')
if self.properties_nodes:
f.write('const internal::PropertiesNode kProperties[] = {\n'
'// Begin End PatternEnd RequiredBegin RequiredEnd'
' Additional Properties\n')
for properties_node in self.properties_nodes:
for i in range(0, len(properties_node) - 1):
assert (properties_node[i] >= MIN_INDEX and
properties_node[i] <= MAX_INDEX)
f.write(
' { %5d, %5d, %5d, %5d, %10d, %5d }, // %s\n' % properties_node)
f.write('};\n\n')
if self.restriction_nodes:
f.write('const internal::RestrictionNode kRestrictionNodes[] = {\n')
f.write('// FIRST, SECOND\n')
for restriction_node in self.restriction_nodes:
f.write(' {{ %-8s %4s}},\n' % (restriction_node.first + ',',
restriction_node.second))
f.write('};\n\n')
if self.required_properties:
f.write('const char* const kRequiredProperties[] = {\n')
for required_property in self.required_properties:
f.write(' %s,\n' % self.GetString(required_property))
f.write('};\n\n')
if self.int_enums:
f.write('const int kIntegerEnumerations[] = {\n')
for possible_values in self.int_enums:
f.write(' %d,\n' % possible_values)
f.write('};\n\n')
if self.string_enums:
f.write('const char* const kStringEnumerations[] = {\n')
for possible_values in self.string_enums:
f.write(' %s,\n' % self.GetString(possible_values))
f.write('};\n\n')
f.write('const internal::SchemaData* GetChromeSchemaData() {\n')
f.write(' static const internal::SchemaData kChromeSchemaData = {\n'
' kSchemas,\n')
f.write(' kPropertyNodes,\n' if self.property_nodes else ' nullptr,\n')
f.write(' kProperties,\n' if self.properties_nodes else ' nullptr,\n')
f.write(' kRestrictionNodes,\n' if self.
restriction_nodes else ' nullptr,\n')
f.write(' kRequiredProperties,\n' if self.
required_properties else ' nullptr,\n')
f.write(' kIntegerEnumerations,\n' if self.int_enums else ' nullptr,\n')
f.write(
' kStringEnumerations,\n' if self.string_enums else ' nullptr,\n')
f.write(' %d, // validation_schema root index\n' %
self.validation_schema_root_index)
f.write(' };\n\n')
f.write(' return &kChromeSchemaData;\n' '}\n\n')
def GetByID(self, id_str):
if not isinstance(id_str, str):
return id_str
if id_str not in self.id_map:
raise RuntimeError('Invalid $ref: ' + id_str)
return self.id_map[id_str]
def ResolveID(self, index, tuple_type, params):
simple_tuple = params[:index] + (self.GetByID(
params[index]),) + params[index + 1:]
return tuple_type(*simple_tuple)
def ResolveReferences(self):
"""Resolve reference mapping, required to be called after Generate()
After calling Generate(), the type of indices used in schema structures
might be either int or string. An int type suggests that it's a resolved
index, but for string type it's unresolved. Resolving a reference is as
simple as looking up for corresponding ID in self.id_map, and replace the
old index with the mapped index.
"""
self.schema_nodes = list(
map(partial(self.ResolveID, 1, SchemaNode), self.schema_nodes))
self.property_nodes = list(
map(partial(self.ResolveID, 1, PropertyNode), self.property_nodes))
self.properties_nodes = list(
map(partial(self.ResolveID, 3, PropertiesNode), self.properties_nodes))
def FindSensitiveChildren(self):
"""Wrapper function, which calls FindSensitiveChildrenRecursive().
"""
if self.schema_nodes:
self.FindSensitiveChildrenRecursive(0, set())
def FindSensitiveChildrenRecursive(self, index, handled_schema_nodes):
"""Recursively compute |has_sensitive_children| for the schema node at
|index| and all its child elements. A schema has sensitive children if any
of its children has |is_sensitive_value|==True or has sensitive children
itself.
"""
node = self.schema_nodes[index]
if index in handled_schema_nodes:
return node.has_sensitive_children or node.is_sensitive_value
handled_schema_nodes.add(index)
has_sensitive_children = False
if node.schema_type == 'Type::DICT':
properties_node = self.properties_nodes[node.extra]
# Iterate through properties and patternProperties.
for property_index in range(properties_node.begin,
properties_node.pattern_end - 1):
sub_index = self.property_nodes[property_index].schema
has_sensitive_children |= self.FindSensitiveChildrenRecursive(
sub_index, handled_schema_nodes)
# AdditionalProperties
if properties_node.additional != INVALID_INDEX:
sub_index = properties_node.additional
has_sensitive_children |= self.FindSensitiveChildrenRecursive(
sub_index, handled_schema_nodes)
elif node.schema_type == 'Type::LIST':
sub_index = node.extra
has_sensitive_children |= self.FindSensitiveChildrenRecursive(
sub_index, handled_schema_nodes)
if has_sensitive_children:
self.schema_nodes[index] = self.schema_nodes[index]._replace(
has_sensitive_children=True)
return has_sensitive_children or node.is_sensitive_value
def _GenerateDefaultValue(value):
"""Converts a JSON object into a base::Value entry. Returns a tuple, the first
entry being a list of declaration statements to define the variable, the
second entry being a way to access the variable.
If no definition is needed, the first return value will be an empty list. If
any error occurs, the second return value will be None (ie, no way to fetch
the value).
|value|: The deserialized value to convert to base::Value."""
if type(value) == bool or type(value) == int:
return [], 'base::Value(%s)' % json.dumps(value)
elif type(value) == str:
return [], 'base::Value("%s")' % value
elif type(value) == list:
setup = ['base::Value::List default_value;']
for entry in value:
decl, fetch = _GenerateDefaultValue(entry)
# Nested lists are not supported.
if decl:
return [], None
setup.append('default_value.Append(%s);' % fetch)
return setup, 'base::Value(std::move(default_value))'
return [], None
def _WritePolicyConstantSource(all_policies, policy_atomic_groups,
target_platform, f, risk_tags, chunking):
policies = _GetSupportedPolicies(all_policies, target_platform)
policy_names = [policy.name for policy in policies]
f.write('''#include "components/policy/policy_constants.h"
#include <algorithm>
#include <climits>
#include <iterator>
#include <memory>
#include "base/check_op.h"
#include "base/values.h"
#include "build/branding_buildflags.h"
#include "components/policy/core/common/policy_types.h"
#include "components/policy/core/common/schema_internal.h"
#include "components/policy/proto/cloud_policy.pb.h"
#include "components/policy/risk_tag.h"
namespace policy {
''')
# Generate the Chrome schema.
chrome_schema = {
'type': 'object',
'properties': {},
}
chrome_validation_schema = {
'type': 'object',
'properties': {},
}
shared_strings = {}
for policy in policies:
shared_strings[policy.name] = "key::k%s" % policy.name
if policy.is_supported:
chrome_schema['properties'][policy.name] = policy.schema
if policy.validation_schema is not None:
(chrome_validation_schema['properties'][policy.name]
) = policy.validation_schema
# Note: this list must be kept in sync with the known property list of the
# Chrome schema, so that binary searching in the PropertyNode array gets the
# right index on this array as well. See the implementation of
# GetChromePolicyDetails() below.
# TODO(crbug.com/40127969): kChromePolicyDetails shouldn't be declare if there
# is no policy.
f.write('''[[maybe_unused]] const PolicyDetails kChromePolicyDetails[] = {
// is_deprecated is_future scope id max_external_data_size, risk tags
''')
for policy in policies:
if policy.is_supported:
assert policy.id >= MIN_POLICY_ID and policy.id <= MAX_POLICY_ID
assert (policy.max_size >= MIN_EXTERNAL_DATA_SIZE and
policy.max_size <= MAX_EXTERNAL_DATA_SIZE)
f.write(' // %s\n' % policy.name)
f.write(' { %-14s%-10s%-17s%4s,%22s, %s },\n' %
('true,' if policy.is_deprecated else 'false,',
'true,' if policy.is_future else 'false, ', policy.scope + ",",
policy.id, policy.max_size, risk_tags.ToInitString(policy.tags)))
f.write('};\n\n')
schema_generator = SchemaNodesGenerator(shared_strings)
schema_generator.GenerateAndCollectID(chrome_schema, 'root node')
if chrome_validation_schema['properties']:
schema_generator.validation_schema_root_index = \
schema_generator.GenerateAndCollectID(chrome_validation_schema,
'validation_schema root node')
else:
schema_generator.validation_schema_root_index = INVALID_INDEX
schema_generator.ResolveReferences()
schema_generator.FindSensitiveChildren()
schema_generator.Write(f)
f.write('\n')
if schema_generator.property_nodes:
f.write('namespace {\n')
f.write('bool CompareKeys(const internal::PropertyNode& node,\n'
' const std::string& key) {\n'
' return node.key < key;\n'
'}\n\n')
f.write('} // namespace\n\n')
if target_platform == 'win':
f.write('#if BUILDFLAG(GOOGLE_CHROME_BRANDING)\n'
'const wchar_t kRegistryChromePolicyKey[] = '
'L"' + CHROME_POLICY_KEY + '";\n'
'#elif BUILDFLAG(GOOGLE_CHROME_FOR_TESTING_BRANDING)\n'
'const wchar_t kRegistryChromePolicyKey[] = '
'L"' + CHROME_FOR_TESTING_POLICY_KEY + '";\n'
'#else\n'
'const wchar_t kRegistryChromePolicyKey[] = '
'L"' + CHROMIUM_POLICY_KEY + '";\n'
'#endif\n\n')
# Setting enterprise defaults code generation.
profile_policy_enterprise_defaults = ""
system_wide_policy_enterprise_defaults = ""
for policy in policies:
if policy.has_enterprise_default and policy.is_supported:
declare_default_stmts, fetch_default = _GenerateDefaultValue(
policy.enterprise_default)
if not fetch_default:
raise RuntimeError('Type %s of policy %s is not supported at '
'enterprise defaults' %
(policy.policy_type, policy.name))
# Convert declare_default_stmts to a string with the correct indentation.
if declare_default_stmts:
declare_default = ' %s\n' % '\n '.join(declare_default_stmts)
else:
declare_default = ''
policy_level = "POLICY_LEVEL_MANDATORY"
if policy.default_policy_level == 'recommended':
policy_level = "POLICY_LEVEL_RECOMMENDED"
setting_enterprise_default = ''' if (!policy_map->Get(key::k%s)) {
%s
policy_map->Set(key::k%s,
%s,
POLICY_SCOPE_USER,
POLICY_SOURCE_ENTERPRISE_DEFAULT,
%s,
nullptr);
}
''' % (policy.name, declare_default, policy.name, policy_level, fetch_default)
if policy.per_profile:
profile_policy_enterprise_defaults += setting_enterprise_default
else:
system_wide_policy_enterprise_defaults += setting_enterprise_default
f.write('#if BUILDFLAG(IS_CHROMEOS)')
f.write('''
void SetEnterpriseUsersProfileDefaults(PolicyMap* policy_map) {
%s
}
''' % profile_policy_enterprise_defaults)
f.write('''
void SetEnterpriseUsersSystemWideDefaults(PolicyMap* policy_map) {
%s
}
''' % system_wide_policy_enterprise_defaults)
f.write('''
void SetEnterpriseUsersDefaults(PolicyMap* policy_map) {
SetEnterpriseUsersProfileDefaults(policy_map);
SetEnterpriseUsersSystemWideDefaults(policy_map);
}
''')
f.write('#endif\n\n')
f.write('const PolicyDetails* GetChromePolicyDetails('
'const std::string& policy) {\n')
if schema_generator.property_nodes:
f.write(' // First index in kPropertyNodes of the Chrome policies.\n'
' static constexpr int begin_index = %s;\n'
' // One-past-the-end of the Chrome policies in kPropertyNodes.\n'
' static constexpr int end_index = %s;\n' %
(schema_generator.root_properties_begin,
schema_generator.root_properties_end))
f.write(''' const internal::PropertyNode* begin =
kPropertyNodes + begin_index;
const internal::PropertyNode* end = kPropertyNodes + end_index;
const internal::PropertyNode* it =
std::lower_bound(begin, end, policy, CompareKeys);
if (it == end || it->key != policy)
return nullptr;
// This relies on kPropertyNodes from begin_index to end_index
// having exactly the same policies (and in the same order) as
// kChromePolicyDetails, so that binary searching on the first
// gets the same results as a binary search on the second would.
// However, kPropertyNodes has the policy names and
// kChromePolicyDetails doesn't, so we obtain the index into
// the second array by searching the first to avoid duplicating
// the policy name pointers.
// Offsetting |it| from |begin| here obtains the index we're
// looking for.
size_t index = it - begin;
CHECK_LT(index, std::size(kChromePolicyDetails));
return kChromePolicyDetails + index;
''')
else:
f.write('return nullptr;')
f.write('}\n\n')
f.write('namespace key {\n\n')
for policy in policies:
# TODO(joaodasilva): Include only supported policies in
# configuration_policy_handler.cc and configuration_policy_handler_list.cc
# so that these names can be conditional on 'policy.is_supported'.
# http://crbug.com/223616
f.write('const char k{name}[] = "{name}";\n'.format(name=policy.name))
f.write('\n} // namespace key\n\n')
f.write('namespace group {\n\n')
for group in policy_atomic_groups:
f.write('const char k{name}[] = "{name}";\n'.format(name=group.name))
f.write('\n')
f.write('namespace {\n\n')
for group in policy_atomic_groups:
f.write('const char* const %s[] = {' % (group.name))
for policy in group.policies:
if policy in policy_names:
f.write('key::k%s, ' % (policy))
f.write('nullptr};\n')
f.write('\n} // namespace\n')
f.write('\n} // namespace group\n\n')
atomic_groups_length = 0
f.write('const AtomicGroup kPolicyAtomicGroupMappings[] = {\n')
for group in policy_atomic_groups:
atomic_groups_length += 1
f.write(' {')
f.write(' {id}, group::k{name}, group::{name}'.format(
id=group.id, name=group.name))
f.write(' },\n')
f.write('};\n\n')
f.write('const size_t kPolicyAtomicGroupMappingsLength = %s;\n\n' %
(atomic_groups_length))
f.write('namespace metapolicy {\n\n')
# Populate merge metapolicy array.
merge_metapolicies = _GetMetapoliciesOfType(policies,
METAPOLICY_TYPE['merge'])
f.write('const char* const kMerge[%s] = {\n' % len(merge_metapolicies))
for metapolicy in merge_metapolicies:
f.write(' key::k%s,\n' % metapolicy.name)
f.write('};\n\n')
# Populate precedence metapolicy array.
precedence_metapolicies = _GetMetapoliciesOfType(
policies, METAPOLICY_TYPE['precedence'])
f.write('const char* const kPrecedence[%s] = {\n' %
len(precedence_metapolicies))
for metapolicy in precedence_metapolicies:
f.write(' key::k%s,\n' % metapolicy.name)
f.write('};\n\n')
f.write('} // namespace metapolicy\n\n')
protobuf_types = _GetProtobufTypes()
for protobuf_type in protobuf_types:
_WriteChromePolicyAccessSource(policies, f, protobuf_type, chunking)
f.write('\n} // namespace policy\n')
# Return the StringPolicyType enum value for a particular policy type.
def _GetStringPolicyType(policy_type):
if policy_type == 'Type::STRING':
return 'StringPolicyType::STRING'
elif policy_type == 'Type::DICT':
return 'StringPolicyType::JSON'
elif policy_type == 'TYPE_EXTERNAL':
return 'StringPolicyType::EXTERNAL'
raise RuntimeError('Invalid string type: ' + policy_type + '!\n')
# Writes an array that contains the pointers to the proto field for each policy
# in |policies| of the given |protobuf_type|.
def _WriteChromePolicyAccessSource(policies, f, protobuf_type, chunking):
supported_user_policies = _GetSupportedChromeUserPolicies(
policies, protobuf_type)
f.write('const std::array<%sPolicyAccess, %d> k%sPolicyAccess {{\n' %
(protobuf_type, len(supported_user_policies), protobuf_type))
for policy in supported_user_policies:
name = policy.name
lowercase_name = name.lower()
if protobuf_type == 'String':
extra_args = ',\n ' + _GetStringPolicyType(policy.policy_type)
else:
extra_args = ''
chunk_number = _ChunkNumber(policy.id, chunking)
if chunk_number == 0:
has_proto = 'policy.has_%s()' % lowercase_name
get_proto = 'policy.%s()' % lowercase_name
else:
has_subproto = 'policy.has_subproto%d() &&\n' % chunk_number
has_policy = ' policy.subproto%d().has_%s()' % (
chunk_number, lowercase_name)
has_proto = has_subproto + has_policy
get_proto = 'policy.subproto%d().%s()' % (chunk_number, lowercase_name)
f.write(' {key::k%s,\n'
' %s,\n'
' [](const em::CloudPolicySettings& policy) {\n'
' return %s;\n'
' },\n'
' [](const em::CloudPolicySettings& policy)\n'
' -> const em::%sPolicyProto& {\n'
' return %s;\n'
' }%s\n'
' },\n' % (name, str(policy.per_profile).lower(), has_proto,
protobuf_type, get_proto, extra_args))
f.write('}};\n\n')
#------------------ policy risk tag header -------------------------#
class RiskTags(object):
'''Generates files and strings to translate the parsed risk tags.'''
# TODO(tnagel): Add, Check & Generate translation descriptions.
def __init__(self, template_file_contents):
self.max_tags = None
self.enum_for_tag = OrderedDict() # Ordered by severity as stated in JSON.
self._ReadRiskTagMetaData(template_file_contents)
def GenerateEnum(self):
values = [' ' + self.enum_for_tag[tag] for tag in self.enum_for_tag]
values.append(' RISK_TAG_COUNT')
values.append(' RISK_TAG_NONE')
enum_text = 'enum RiskTag : uint8_t {\n'
enum_text += ',\n'.join(values) + '\n};\n'
return enum_text
def GetMaxTags(self):
return str(self.max_tags)
def GetValidTags(self):
return [tag for tag in self.enum_for_tag]
def ToInitString(self, tags):
all_tags = [self._ToEnum(tag) for tag in tags]
all_tags += ["RISK_TAG_NONE" for missing in range(len(tags), self.max_tags)]
str_tags = "{ " + ", ".join(all_tags) + " }"
return "\n ".join(textwrap.wrap(str_tags, 69))
def ComputeMaxTags(self, policies):
self.max_tags = 0
for policy in policies:
if not policy.is_supported or policy.tags == None:
continue
self.max_tags = max(len(policy.tags), self.max_tags)
def _ToEnum(self, tag):
if tag in self.enum_for_tag:
return self.enum_for_tag[tag]
raise RuntimeError('Invalid Tag:' + tag + '!\n'
'Chose a valid tag from \'risk_tag_definitions\' (a '
'subproperty of root in policy_templates.json)!')
def _ReadRiskTagMetaData(self, template_file_contents):
for tag in template_file_contents['risk_tag_definitions']:
if tag.get('name', None) == None:
raise RuntimeError('Tag in \'risk_tag_definitions\' without '
'description found!')
if tag.get('description', None) == None:
raise RuntimeError('Tag ' + tag['name'] + ' has no description!')
if tag.get('user-description', None) == None:
raise RuntimeError('Tag ' + tag['name'] + ' has no user-description!')
self.enum_for_tag[tag['name']] = "RISK_TAG_" + tag['name'].replace(
"-", "_").upper()
def _WritePolicyRiskTagHeader(policies, policy_atomic_groups, target_platform,
f, risk_tags, chunking):
f.write('''#ifndef CHROME_COMMON_POLICY_RISK_TAG_H_
#define CHROME_COMMON_POLICY_RISK_TAG_H_
#include <stddef.h>
namespace policy {
// The tag of a policy indicates which impact a policy can have on
// a user's privacy and/or security. Ordered descending by
// impact.
// The explanation of the single tags is stated in
// policy_templates.json within the 'risk_tag_definitions' tag.
''')
f.write(risk_tags.GenerateEnum() + '\n')
f.write('// This constant describes how many risk tags were used by the\n'
'// policy which uses the most risk tags.\n'
'const size_t kMaxRiskTagCount = ' + risk_tags.GetMaxTags() + ';\n'
'\n'
'} // namespace policy\n\n'
'\n'
'#endif // CHROME_COMMON_POLICY_RISK_TAG_H_')
#------------------ policy protobufs -------------------------------#
CHROME_SETTINGS_PROTO_HEAD = '''
syntax = "proto2";
option optimize_for = LITE_RUNTIME;
package enterprise_management;
option go_package="chromium/policy/enterprise_management_proto";
// For StringList and PolicyOptions.
import "policy_common_definitions.proto";
'''
CLOUD_POLICY_PROTO_HEAD = '''
syntax = "proto2";
option optimize_for = LITE_RUNTIME;
package enterprise_management;
option go_package="chromium/policy/enterprise_management_proto";
import "policy_common_definitions.proto";
'''
# Field IDs [1..RESERVED_IDS] will not be used in the wrapping protobuf.
RESERVED_IDS = 2
# All user policies with ID <= |_LAST_TOP_LEVEL_POLICY_ID| are added to the top
# level of ChromeSettingsProto and CloudPolicySettings, whereas all policies
# with ID > |_LAST_TOP_LEVEL_POLICY_ID| are nested into sub-protos. See
# https://crbug.com/1237044 for more details.
_LAST_TOP_LEVEL_POLICY_ID = 1040
# The approximate number of policies in one nested chunk for user policies with
# ID > |_LAST_TOP_LEVEL_POLICY_ID|. See https://crbug.com/1237044 for more
# details.
_CHUNK_SIZE = 800
def _WritePolicyProto(f, policy):
_OutputComment(f, policy.caption + '\n\n' + policy.desc)
if policy.items is not None:
_OutputComment(f, '\nValid values:')
for item in policy.items:
_OutputComment(f, ' %s: %s' % (str(item.value), item.caption))
if policy.policy_type == 'Type::DICT':
_OutputComment(
f, '\nValue schema:\n%s' % json.dumps(
policy.schema, sort_keys=True, indent=4, separators=(',', ': ')))
_OutputComment(
f, '\nSupported on: %s' %
', '.join(sorted(list(policy.platforms.union(policy.future_on)))))
if policy.can_be_recommended and not policy.can_be_mandatory:
_OutputComment(
f, '\nNote: this policy must have a RECOMMENDED ' +
'PolicyMode set in PolicyOptions.')
f.write('message %sProto {\n' % policy.name)
f.write(' optional PolicyOptions policy_options = 1;\n')
f.write(' optional %s %s = 2;\n' % (policy.protobuf_type, policy.name))
f.write('}\n\n')
def _ChunkNumber(policy_id, chunking):
# Compute which chunk the policy should go to. Chunk 0 contains the legacy
# policies, whereas subsequent chunks contain nested policies.
if not chunking or policy_id <= _LAST_TOP_LEVEL_POLICY_ID:
return 0
else:
return (policy_id - _LAST_TOP_LEVEL_POLICY_ID - 1) // _CHUNK_SIZE + 1
def _FieldNumber(policy_id, chunk_number):
if chunk_number == 0:
# For the top-level policies the field number in the proto file is the
# same as the id assigned to the policy in policy_templates.json,
# skipping the RESERVED_IDS.
return policy_id + RESERVED_IDS
else:
# For the nested policies, the field numbers should always be in the
# range [1, _CHUNK_SIZE], therefore we calculate them using this formula.
return (policy_id - _LAST_TOP_LEVEL_POLICY_ID - 1) % _CHUNK_SIZE + 1
def _WriteChromeSettingsProtobuf(policies, policy_atomic_groups,
target_platform, f, risk_tags, chunking):
f.write(CHROME_SETTINGS_PROTO_HEAD)
fields = defaultdict(list)
f.write('// PBs for individual settings.\n\n')
for policy in policies:
# Note: This protobuf also gets the unsupported policies, since it's an
# exhaustive list of all the supported user policies on any platform.
if not policy.is_device_only:
# Write the individual policy proto into the file
_WritePolicyProto(f, policy)
chunk_number = _ChunkNumber(policy.id, chunking)
field_number = _FieldNumber(policy.id, chunk_number)
# Add to |fields| in order to eventually add to ChromeSettingsProto.
fields[chunk_number].append(' optional %sProto %s = %s;\n' %
(policy.name, policy.name, field_number))
sorted_chunk_numbers = sorted(fields.keys())
if len(sorted_chunk_numbers) > 1:
f.write('// --------------------------------------------------\n'
'// PBs for policies with ID > %d.\n\n' % _LAST_TOP_LEVEL_POLICY_ID)
for sorted_chunk_number in sorted_chunk_numbers:
if sorted_chunk_number == 0:
continue
f.write('message ChromeSettingsSubProto%d {\n' % sorted_chunk_number)
f.write(''.join(fields[sorted_chunk_number]))
f.write('}\n\n')
f.write('// --------------------------------------------------\n'
'// Big wrapper PB containing the above groups.\n\n'
'message ChromeSettingsProto {\n')
for sorted_chunk_number in sorted_chunk_numbers:
if sorted_chunk_number == 0:
f.write(''.join(fields[sorted_chunk_number]))
else:
f.write(' optional ChromeSettingsSubProto%d subProto%d = %s;\n' %
(sorted_chunk_number, sorted_chunk_number,
_LAST_TOP_LEVEL_POLICY_ID + RESERVED_IDS + sorted_chunk_number))
f.write('}\n')
def _WriteCloudPolicyProtobuf(policies, policy_atomic_groups, target_platform,
f, risk_tags, chunking):
f.write(CLOUD_POLICY_PROTO_HEAD)
fields = defaultdict(list)
for policy in policies:
if not policy.is_supported or policy.is_device_only:
continue
chunk_number = _ChunkNumber(policy.id, chunking)
field_number = _FieldNumber(policy.id, chunk_number)
# Add to |fields| in order to eventually add to CloudPolicyProto.
fields[chunk_number].append(
' optional %sPolicyProto %s = %s;\n' %
(policy.policy_protobuf_type, policy.name, field_number))
sorted_chunk_numbers = sorted(fields.keys())
if len(sorted_chunk_numbers) > 1:
for sorted_chunk_number in sorted_chunk_numbers:
if sorted_chunk_number == 0:
continue
f.write('message CloudPolicySubProto%d {\n' % sorted_chunk_number)
f.write(''.join(fields[sorted_chunk_number]))
f.write('}\n\n')
f.write('message CloudPolicySettings {\n')
for sorted_chunk_number in sorted_chunk_numbers:
if sorted_chunk_number == 0:
f.write(''.join(fields[sorted_chunk_number]))
else:
f.write(' optional CloudPolicySubProto%d subProto%d = %s;\n' %
(sorted_chunk_number, sorted_chunk_number,
_LAST_TOP_LEVEL_POLICY_ID + RESERVED_IDS + sorted_chunk_number))
f.write('}\n')
# Returns the list of all policy.policy_protobuf_type strings from |policies|.
def _GetProtobufTypes():
return sorted(['Integer', 'Boolean', 'String', 'StringList'])
#------------------ app restrictions -------------------------------#
ENROLLMENT_TOKEN_POLICY_NAME = 'CloudManagementEnrollmentToken'
def _WriteAppRestrictions(policies, policy_atomic_groups, target_platform, f,
risk_tags, chunking):
def WriteRestrictionCommon(key):
f.write(' <restriction\n' ' android:key="%s"\n' % key)
f.write(' android:title="@string/%sTitle"\n' % key)
f.write(' android:description="@string/%sDesc"\n' % key)
def WriteItemsDefinition(key):
f.write(' android:entries="@array/%sEntries"\n' % key)
f.write(' android:entryValues="@array/%sValues"\n' % key)
def WriteAppRestriction(policy):
policy_name = policy.name
WriteRestrictionCommon(policy_name)
if policy.items is not None:
WriteItemsDefinition(policy_name)
f.write(' android:restrictionType="%s"/>' % policy.restriction_type)
f.write('\n\n')
def ShouldWriteAppRestriction(policy):
return (policy.is_supported and policy.restriction_type != 'invalid'
and not policy.is_deprecated and not policy.is_future
and not policy.internal_only and not policy.cloud_only)
# Compare policies by name, considering that `ENROLLMENT_TOKEN_POLICY_NAME`
# should come before all other policies in the generate app restrictions file.
def Compare(policy1, policy2):
if policy1.name == policy2.name:
return 0
if policy1.name == ENROLLMENT_TOKEN_POLICY_NAME:
return -1
if policy2.name == ENROLLMENT_TOKEN_POLICY_NAME:
return 1
if policy1.name < policy2.name:
return -1
return 1
# _WriteAppRestrictions body
f.write('<restrictions xmlns:android="'
'http://schemas.android.com/apk/res/android">\n\n')
for policy in sorted(policies, key=cmp_to_key(Compare)):
if ShouldWriteAppRestriction(policy):
WriteAppRestriction(policy)
f.write('</restrictions>')
if __name__ == '__main__':
sys.exit(main())
|