SystemConfig.php 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Daniel Kesselberg <mail@danielkesselberg.de>
  6. * @author Joas Schilling <coding@schilljs.com>
  7. * @author Johannes Schlichenmaier <johannes@schlichenmaier.info>
  8. * @author Lukas Reschke <lukas@statuscode.ch>
  9. * @author Morris Jobke <hey@morrisjobke.de>
  10. * @author Roeland Jago Douma <roeland@famdouma.nl>
  11. *
  12. * @license AGPL-3.0
  13. *
  14. * This code is free software: you can redistribute it and/or modify
  15. * it under the terms of the GNU Affero General Public License, version 3,
  16. * as published by the Free Software Foundation.
  17. *
  18. * This program is distributed in the hope that it will be useful,
  19. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21. * GNU Affero General Public License for more details.
  22. *
  23. * You should have received a copy of the GNU Affero General Public License, version 3,
  24. * along with this program. If not, see <http://www.gnu.org/licenses/>
  25. *
  26. */
  27. namespace OC;
  28. use OCP\IConfig;
  29. /**
  30. * Class which provides access to the system config values stored in config.php
  31. * Internal class for bootstrap only.
  32. * fixes cyclic DI: AllConfig needs AppConfig needs Database needs AllConfig
  33. */
  34. class SystemConfig {
  35. /** @var array */
  36. protected $sensitiveValues = [
  37. 'instanceid' => true,
  38. 'datadirectory' => true,
  39. 'dbname' => true,
  40. 'dbhost' => true,
  41. 'dbpassword' => true,
  42. 'dbuser' => true,
  43. 'activity_dbname' => true,
  44. 'activity_dbhost' => true,
  45. 'activity_dbpassword' => true,
  46. 'activity_dbuser' => true,
  47. 'mail_from_address' => true,
  48. 'mail_domain' => true,
  49. 'mail_smtphost' => true,
  50. 'mail_smtpname' => true,
  51. 'mail_smtppassword' => true,
  52. 'passwordsalt' => true,
  53. 'secret' => true,
  54. 'updater.secret' => true,
  55. 'trusted_proxies' => true,
  56. 'preview_imaginary_url' => true,
  57. 'proxyuserpwd' => true,
  58. 'sentry.dsn' => true,
  59. 'sentry.public-dsn' => true,
  60. 'zammad.download.secret' => true,
  61. 'zammad.portal.secret' => true,
  62. 'zammad.secret' => true,
  63. 'github.client_id' => true,
  64. 'github.client_secret' => true,
  65. 'log.condition' => [
  66. 'shared_secret' => true,
  67. ],
  68. 'license-key' => true,
  69. 'redis' => [
  70. 'host' => true,
  71. 'password' => true,
  72. ],
  73. 'redis.cluster' => [
  74. 'seeds' => true,
  75. 'password' => true,
  76. ],
  77. 'objectstore' => [
  78. 'arguments' => [
  79. // Legacy Swift (https://github.com/nextcloud/server/pull/17696#discussion_r341302207)
  80. 'options' => [
  81. 'credentials' => [
  82. 'key' => true,
  83. 'secret' => true,
  84. ]
  85. ],
  86. // S3
  87. 'key' => true,
  88. 'secret' => true,
  89. // Swift v2
  90. 'username' => true,
  91. 'password' => true,
  92. // Swift v3
  93. 'user' => [
  94. 'name' => true,
  95. 'password' => true,
  96. ],
  97. ],
  98. ],
  99. 'objectstore_multibucket' => [
  100. 'arguments' => [
  101. 'options' => [
  102. 'credentials' => [
  103. 'key' => true,
  104. 'secret' => true,
  105. ]
  106. ],
  107. // S3
  108. 'key' => true,
  109. 'secret' => true,
  110. // Swift v2
  111. 'username' => true,
  112. 'password' => true,
  113. // Swift v3
  114. 'user' => [
  115. 'name' => true,
  116. 'password' => true,
  117. ],
  118. ],
  119. ],
  120. 'onlyoffice' => [
  121. 'jwt_secret' => true,
  122. ],
  123. ];
  124. public function __construct(
  125. private Config $config,
  126. ) {
  127. }
  128. /**
  129. * Lists all available config keys
  130. * @return array an array of key names
  131. */
  132. public function getKeys() {
  133. return $this->config->getKeys();
  134. }
  135. /**
  136. * Sets a new system wide value
  137. *
  138. * @param string $key the key of the value, under which will be saved
  139. * @param mixed $value the value that should be stored
  140. */
  141. public function setValue($key, $value) {
  142. $this->config->setValue($key, $value);
  143. }
  144. /**
  145. * Sets and deletes values and writes the config.php
  146. *
  147. * @param array $configs Associative array with `key => value` pairs
  148. * If value is null, the config key will be deleted
  149. */
  150. public function setValues(array $configs) {
  151. $this->config->setValues($configs);
  152. }
  153. /**
  154. * Looks up a system wide defined value
  155. *
  156. * @param string $key the key of the value, under which it was saved
  157. * @param mixed $default the default value to be returned if the value isn't set
  158. * @return mixed the value or $default
  159. */
  160. public function getValue($key, $default = '') {
  161. return $this->config->getValue($key, $default);
  162. }
  163. /**
  164. * Looks up a system wide defined value and filters out sensitive data
  165. *
  166. * @param string $key the key of the value, under which it was saved
  167. * @param mixed $default the default value to be returned if the value isn't set
  168. * @return mixed the value or $default
  169. */
  170. public function getFilteredValue($key, $default = '') {
  171. $value = $this->getValue($key, $default);
  172. if (isset($this->sensitiveValues[$key])) {
  173. $value = $this->removeSensitiveValue($this->sensitiveValues[$key], $value);
  174. }
  175. return $value;
  176. }
  177. /**
  178. * Delete a system wide defined value
  179. *
  180. * @param string $key the key of the value, under which it was saved
  181. */
  182. public function deleteValue($key) {
  183. $this->config->deleteKey($key);
  184. }
  185. /**
  186. * @param bool|array $keysToRemove
  187. * @param mixed $value
  188. * @return mixed
  189. */
  190. protected function removeSensitiveValue($keysToRemove, $value) {
  191. if ($keysToRemove === true) {
  192. return IConfig::SENSITIVE_VALUE;
  193. }
  194. if (is_array($value)) {
  195. foreach ($keysToRemove as $keyToRemove => $valueToRemove) {
  196. if (isset($value[$keyToRemove])) {
  197. $value[$keyToRemove] = $this->removeSensitiveValue($valueToRemove, $value[$keyToRemove]);
  198. }
  199. }
  200. }
  201. return $value;
  202. }
  203. }