Add Brave-specific options to policy templates #16351
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| diff --git a/components/policy/resources/policy_templates.json b/components/policy/resources/policy_templates.json | ||
| index 5238b76ba5466b3015157bc33e4efe13a2213418..382aeede0591a604f48d85cac70389ce38cf619d 100644 | ||
| --- a/components/policy/resources/policy_templates.json | ||
| +++ b/components/policy/resources/policy_templates.json | ||
| @@ -1,4 +1,4 @@ | ||
| -{ | ||
| +__import__('policy_source_helper').BravePolicies() + { | ||
| # policy_templates.json - Metafile for policy templates | ||
| # | ||
| # The content of this file is evaluated as a Python expression. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,12 @@ | ||
| diff --git a/components/policy/tools/generate_policy_source.py b/components/policy/tools/generate_policy_source.py | ||
| index feb36d536f184b8d9f8e7284a26ba68d8b2205ea..021536491dc2dcca662f64ea11a657a53a33dd75 100755 | ||
| --- a/components/policy/tools/generate_policy_source.py | ||
| +++ b/components/policy/tools/generate_policy_source.py | ||
| @@ -55,6 +55,7 @@ PLATFORM_STRINGS = { | ||
| 'chrome.win7': ['win'], | ||
| } | ||
|
|
||
| +from policy_source_helper import CHROMIUM_POLICY_KEY | ||
|
|
||
| class PolicyDetails: | ||
| """Parses a policy template and caches all its details.""" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,3 @@ | ||
| # Copyright (c) 2019 The Brave Authors. All rights reserved. | ||
| # This Source Code Form is subject to the terms of the Mozilla Public | ||
| # License, v. 2.0. If a copy of the MPL was not distributed with this file, | ||
|
|
@@ -9,33 +7,71 @@ | |
| CHROMIUM_POLICY_KEY = 'SOFTWARE\\\\Policies\\\\BraveSoftware\\\\Brave' | ||
|
|
||
|
|
||
| class BravePolicies: # pylint: disable=too-few-public-methods | ||
| """ | ||
| We want to add Brave-specific values to policy_templates.json. Doing so in | ||
| policy_templates.json would produce a very large diff. This class implements | ||
| a trick that allows us to do it with a single-line change. | ||
|
|
||
| policy_templates.json is Python code that evaluates to a dictionary. It has | ||
| the form: | ||
|
|
||
| { | ||
| ... | ||
| } | ||
|
|
||
| We change it to: | ||
|
|
||
| BravePolicies() + { | ||
| ... | ||
| } | ||
|
|
||
| This invokes __add__(...) below. There, we can add our own values and return | ||
| the new dicitonary. | ||
| """ | ||
|
|
||
| def __add__(self, policy_templates_dict): | ||
| _add_brave_policies(policy_templates_dict) | ||
| return policy_templates_dict | ||
|
|
||
|
|
||
| def _add_brave_policies(template_file_contents): | ||
| highest_id = template_file_contents['highest_id_currently_used'] | ||
| policies = [ | ||
| { | ||
| 'name': | ||
| 'TorDisabled', | ||
|
There was a problem hiding this comment. let's merge a workaround for yapf and fix this bad formatting afterwards. |
||
| 'type': | ||
| 'main', | ||
| 'schema': { | ||
| 'type': 'boolean' | ||
| }, | ||
| 'supported_on': | ||
| ['chrome.win:78-', 'chrome.mac:93-', 'chrome.linux:93-'], | ||
| 'features': { | ||
| 'dynamic_refresh': False, | ||
| 'per_profile': False, | ||
| 'can_be_recommended': False, | ||
| 'can_be_mandatory': True | ||
| }, | ||
| 'example_value': | ||
| True, | ||
| 'id': | ||
| 0, | ||
| 'caption': | ||
| '''Disables the tor feature.''', | ||
| 'tags': [], | ||
| 'desc': ('''This policy allows an admin to specify that tor ''' | ||
| '''must be disabled at startup.'''), | ||
| }, | ||
| { | ||
| 'name': | ||
| 'IPFSEnabled', | ||
|
There was a problem hiding this comment. We're in the process of removing IPFS so this can go away. |
||
| 'type': | ||
| 'main', | ||
| 'schema': { | ||
| 'type': 'boolean' | ||
| }, | ||
| 'supported_on': ['chrome.*:87-'], | ||
| 'future_on': ['android'], | ||
| 'features': { | ||
|
|
@@ -44,55 +80,76 @@ def AddBravePolicies(template_file_contents): | |
| 'can_be_recommended': False, | ||
| 'can_be_mandatory': True | ||
| }, | ||
| 'example_value': | ||
| True, | ||
| 'id': | ||
| 1, | ||
| 'caption': | ||
| '''Enable IPFS feature''', | ||
| 'tags': [], | ||
| 'desc': ('''This policy allows an admin to specify whether IPFS ''' | ||
| '''feature can be enabled.'''), | ||
| }, | ||
| { | ||
| 'name': | ||
| 'BraveRewardsDisabled', | ||
| 'type': | ||
| 'main', | ||
| 'schema': { | ||
| 'type': 'boolean' | ||
| }, | ||
| 'supported_on': ['chrome.*:105-'], | ||
| 'features': { | ||
| 'dynamic_refresh': False, | ||
| 'per_profile': True, | ||
| 'can_be_recommended': False, | ||
| 'can_be_mandatory': True | ||
| }, | ||
| 'example_value': | ||
| True, | ||
| 'id': | ||
| 2, | ||
| 'caption': | ||
| '''Disable Brave Rewards feature.''', | ||
| 'tags': [], | ||
| 'desc': ('''This policy allows an admin to specify that Brave ''' | ||
| '''Rewards feature will be disabled.'''), | ||
| }, | ||
| { | ||
| 'name': | ||
| 'BraveWalletDisabled', | ||
| 'type': | ||
| 'main', | ||
| 'schema': { | ||
| 'type': 'boolean' | ||
| }, | ||
| 'supported_on': ['chrome.*:106-'], | ||
| 'features': { | ||
| 'dynamic_refresh': False, | ||
| 'per_profile': True, | ||
| 'can_be_recommended': False, | ||
| 'can_be_mandatory': True | ||
| }, | ||
| 'example_value': | ||
| True, | ||
| 'id': | ||
| 3, | ||
| 'caption': | ||
| '''Disable Brave Wallet feature.''', | ||
| 'tags': [], | ||
| 'desc': ('''This policy allows an admin to specify that Brave ''' | ||
| '''Wallet feature will be disabled.'''), | ||
| }, | ||
| { | ||
| 'name': | ||
| 'BraveShieldsDisabledForUrls', | ||
| 'type': | ||
| 'list', | ||
| 'schema': { | ||
| 'type': 'array', | ||
| 'items': { | ||
| 'type': 'string' | ||
| }, | ||
| }, | ||
| 'supported_on': ['chrome.*:107-'], | ||
| 'features': { | ||
|
|
@@ -102,18 +159,24 @@ def AddBravePolicies(template_file_contents): | |
| 'can_be_mandatory': True | ||
| }, | ||
| 'example_value': ['https://brave.com'], | ||
| 'id': | ||
| 4, | ||
| 'caption': | ||
| '''Disables Brave Shields for urls.''', | ||
| 'tags': [], | ||
| 'desc': ('''This policy allows an admin to specify that Brave ''' | ||
| '''Shields disabled.'''), | ||
| }, | ||
| { | ||
| 'name': | ||
| 'BraveShieldsEnabledForUrls', | ||
| 'type': | ||
| 'list', | ||
| 'schema': { | ||
| 'type': 'array', | ||
| 'items': { | ||
| 'type': 'string' | ||
| }, | ||
| }, | ||
| 'supported_on': ['chrome.*:107-'], | ||
| 'features': { | ||
|
|
@@ -123,8 +186,10 @@ def AddBravePolicies(template_file_contents): | |
| 'can_be_mandatory': True | ||
| }, | ||
| 'example_value': ['https://brave.com'], | ||
| 'id': | ||
| 5, | ||
| 'caption': | ||
| '''Enables Brave Shields for urls.''', | ||
| 'tags': [], | ||
| 'desc': ('''This policy allows an admin to specify that Brave ''' | ||
| '''Shields enabled.'''), | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will it work like this?
or
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR will likely have to be re-done in its entirety because upstream just completely changed their implementation. Settings used to be defined in a single .json file. Now it's a set of directories and .yaml files.