mirror of
https://we.phorge.it/source/phorge.git
synced 2024-12-23 05:50:55 +01:00
Add the "Security" config group options.
Summary: Added all the "Security" group options listed in T2255. Test Plan: - Looked at all the options. - Tested validation on `security.alternate-file-domain` Reviewers: epriestley, btrahan Reviewed By: epriestley CC: aran, Korvin Maniphest Tasks: T2255 Differential Revision: https://secure.phabricator.com/D4334
This commit is contained in:
Ricky Elrod
epriestley
parent
acadf51efe
commit
f84e0ca533
2 changed files with 184 additions and 0 deletions
|
|
@ -1142,6 +1142,7 @@ phutil_register_library_map(array(
|
|||
'PhabricatorSearchResultView' => 'applications/search/view/PhabricatorSearchResultView.php',
|
||||
'PhabricatorSearchScope' => 'applications/search/constants/PhabricatorSearchScope.php',
|
||||
'PhabricatorSearchSelectController' => 'applications/search/controller/PhabricatorSearchSelectController.php',
|
||||
'PhabricatorSecurityConfigOptions' => 'applications/config/option/PhabricatorSecurityConfigOptions.php',
|
||||
'PhabricatorSettingsAdjustController' => 'applications/settings/controller/PhabricatorSettingsAdjustController.php',
|
||||
'PhabricatorSettingsMainController' => 'applications/settings/controller/PhabricatorSettingsMainController.php',
|
||||
'PhabricatorSettingsPanel' => 'applications/settings/panel/PhabricatorSettingsPanel.php',
|
||||
|
|
@ -2451,6 +2452,7 @@ phutil_register_library_map(array(
|
|||
'PhabricatorSearchQuery' => 'PhabricatorSearchDAO',
|
||||
'PhabricatorSearchResultView' => 'AphrontView',
|
||||
'PhabricatorSearchSelectController' => 'PhabricatorSearchBaseController',
|
||||
'PhabricatorSecurityConfigOptions' => 'PhabricatorApplicationConfigOptions',
|
||||
'PhabricatorSettingsAdjustController' => 'PhabricatorController',
|
||||
'PhabricatorSettingsMainController' => 'PhabricatorController',
|
||||
'PhabricatorSettingsPanelAccount' => 'PhabricatorSettingsPanel',
|
||||
|
|
|
|||
|
|
@ -0,0 +1,182 @@
|
|||
<?php
|
||||
|
||||
final class PhabricatorSecurityConfigOptions
|
||||
extends PhabricatorApplicationConfigOptions {
|
||||
|
||||
public function getName() {
|
||||
return pht("Security");
|
||||
}
|
||||
|
||||
public function getDescription() {
|
||||
return pht("Security options.");
|
||||
}
|
||||
|
||||
public function getOptions() {
|
||||
return array(
|
||||
$this->newOption('security.alternate-file-domain', 'string', null)
|
||||
->setSummary(pht("Alternate domain to serve files from."))
|
||||
->setDescription(
|
||||
pht(
|
||||
"IMPORTANT: By default, Phabricator serves files from the same ".
|
||||
"domain the application lives on. This is convenient but not ".
|
||||
"secure: it creates a large class of vulnerabilities which can ".
|
||||
"not be generally mitigated.\n\n".
|
||||
|
||||
"To avoid this, you should configure a second domain in the same ".
|
||||
"way you have the primary domain configured (i.e., point it at ".
|
||||
"the same machine and set up the same vhost rules) and provide ".
|
||||
"it here. For instance, if your primary install is on ".
|
||||
"'http://www.phabricator-example.com/', you could configure ".
|
||||
"'http://www.phabricator-files.com/' and specify the entire ".
|
||||
"domain (with protocol) here. This will enforce that files are ".
|
||||
"served only from the alternate domain. Ideally, you should use ".
|
||||
"a completely separate domain name rather than just a different ".
|
||||
"subdomain.\n\n".
|
||||
|
||||
"It is **STRONGLY RECOMMENDED** that you configure this. Your ".
|
||||
"install is **NOT SECURE** unless you do so."))
|
||||
->addExample('http://www.phabricator-files.com/', pht('Valid Setting')),
|
||||
$this->newOption(
|
||||
'security.hmac-key',
|
||||
'string',
|
||||
'[D\t~Y7eNmnQGJ;rnH6aF;m2!vJ8@v8C=Cs:aQS\.Qw')
|
||||
->setSummary(
|
||||
pht("Key for HMAC digests."))
|
||||
->setDescription(
|
||||
pht(
|
||||
"Default key for HMAC digests where the key is not important ".
|
||||
"(i.e., the hash itself is secret). You can change this if you ".
|
||||
"want (to any other string), but doing so will break existing ".
|
||||
"sessions and CSRF tokens.")),
|
||||
$this->newOption('security.require-https', 'bool', false)
|
||||
->setSummary(
|
||||
pht("Force users to connect via https instead of http."))
|
||||
->setDescription(
|
||||
pht(
|
||||
"If the web server responds to both HTTP and HTTPS requests but ".
|
||||
"you want users to connect with only HTTPS, you can set this ".
|
||||
"to true to make Phabricator redirect HTTP requests to HTTPS.\n\n".
|
||||
|
||||
"Normally, you should just configure your server not to accept ".
|
||||
"HTTP traffic, but this setting may be useful if you originally ".
|
||||
"used HTTP and have now switched to HTTPS but don't want to ".
|
||||
"break old links, or if your webserver sits behind a load ".
|
||||
"balancer which terminates HTTPS connections and you can not ".
|
||||
"reasonably configure more granular behavior there.\n\n".
|
||||
|
||||
"NOTE: Phabricator determines if a request is HTTPS or not by ".
|
||||
"examining the PHP \$_SERVER['HTTPS'] variable. If you run ".
|
||||
"Apache/mod_php this will probably be set correctly for you ".
|
||||
"automatically, but if you run Phabricator as CGI/FCGI (e.g., ".
|
||||
"through nginx or lighttpd), you need to configure your web ".
|
||||
"server so that it passes the value correctly based on the ".
|
||||
"connection type. Alternatively, you can add a PHP snippet to ".
|
||||
"the top of this configuration file to directly set ".
|
||||
"\$_SERVER['HTTPS'] to the correct value."))
|
||||
->setOptions(
|
||||
array(
|
||||
pht('Allow HTTP'),
|
||||
pht('Force HTTPS'),
|
||||
)),
|
||||
$this->newOption(
|
||||
'phabricator.csrf-key',
|
||||
'string',
|
||||
'0b7ec0592e0a2829d8b71df2fa269b2c6172eca3')
|
||||
->setSummary(
|
||||
pht("Hashed with other inputs to generate CSRF tokens."))
|
||||
->setDescription(
|
||||
pht(
|
||||
"This is hashed with other inputs to generate CSRF tokens. If ".
|
||||
"you want, you can change it to some other string which is ".
|
||||
"unique to your install. This will make your install more secure ".
|
||||
"in a vague, mostly theoretical way. But it will take you like 3 ".
|
||||
"seconds of mashing on your keyboard to set it up so you might ".
|
||||
"as well.")),
|
||||
$this->newOption(
|
||||
'phabricator.mail-key',
|
||||
'string',
|
||||
'5ce3e7e8787f6e40dfae861da315a5cdf1018f12')
|
||||
->setSummary(
|
||||
pht("Hashed with other inputs to generate mail tokens."))
|
||||
->setDescription(
|
||||
pht(
|
||||
"This is hashed with other inputs to generate mail tokens. If ".
|
||||
"you want, you can change it to some other string which is ".
|
||||
"unique to your install. In particular, you will want to do ".
|
||||
"this if you accidentally send a bunch of mail somewhere you ".
|
||||
"shouldn't have, to invalidate all old reply-to addresses.")),
|
||||
// TODO: This should really be dict<string,bool> but that doesn't exist
|
||||
// yet.
|
||||
$this->newOption('uri.allowed-protocols', 'wild', null)
|
||||
->setSummary(
|
||||
pht("Determines which URI protocols are auto-linked."))
|
||||
->setDescription(
|
||||
pht(
|
||||
"When users write comments which have URIs, they'll be ".
|
||||
"automatically linked if the protocol appears in this set. This ".
|
||||
"whitelist is primarily to prevent security issues like ".
|
||||
"javascript:// URIs."))
|
||||
->addExample(
|
||||
'{"http": true, "https": true"}', pht('Valid Setting')),
|
||||
$this->newOption(
|
||||
'celerity.resource-hash',
|
||||
'string',
|
||||
'd9455ea150622ee044f7931dabfa52aa')
|
||||
->setSummary(
|
||||
pht("An input to the hash function when building resource hashes."))
|
||||
->setDescription(
|
||||
pht(
|
||||
"This value is an input to the hash function when building ".
|
||||
"resource hashes. It has no security value, but if you ".
|
||||
"accidentally poison user caches (by pushing a bad patch or ".
|
||||
"having something go wrong with a CDN, e.g.) you can change this ".
|
||||
"to something else and rebuild the Celerity map to break user ".
|
||||
"caches. Unless you are doing Celerity development, it is ".
|
||||
"exceptionally unlikely that you need to modify this.")),
|
||||
);
|
||||
}
|
||||
|
||||
protected function didValidateOption(
|
||||
PhabricatorConfigOption $option,
|
||||
$value) {
|
||||
|
||||
$key = $option->getKey();
|
||||
if ($key == 'security.alternate-file-domain') {
|
||||
|
||||
$uri = new PhutilURI($value);
|
||||
$protocol = $uri->getProtocol();
|
||||
if ($protocol !== 'http' && $protocol !== 'https') {
|
||||
throw new PhabricatorConfigValidationException(
|
||||
pht(
|
||||
"Config option '%s' is invalid. The URI must start with ".
|
||||
"'http://' or 'https://'.",
|
||||
$key));
|
||||
}
|
||||
|
||||
$domain = $uri->getDomain();
|
||||
if (strpos($domain, '.') === false) {
|
||||
throw new PhabricatorConfigValidationException(
|
||||
pht(
|
||||
"Config option '%s' is invalid. The URI must contain a dot ('.'), ".
|
||||
"like 'http://example.com/', not just a bare name like ".
|
||||
"'http://example/'. Some web browsers will not set cookies on ".
|
||||
"domains with no TLD.",
|
||||
$key));
|
||||
}
|
||||
|
||||
$path = $uri->getPath();
|
||||
if ($path !== '' && $path !== '/') {
|
||||
throw new PhabricatorConfigValidationException(
|
||||
pht(
|
||||
"Config option '%s' is invalid. The URI must NOT have a path, ".
|
||||
"e.g. 'http://phabricator.example.com/' is OK, but ".
|
||||
"'http://example.com/phabricator/' is not. Phabricator must be ".
|
||||
"installed on an entire domain; it can not be installed on a ".
|
||||
"path.",
|
||||
$key));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
Loading…
Reference in a new issue