@@ -117,7 +117,7 @@ discard block |
||
| 117 | 117 | ['app' => 'encryption']); |
| 118 | 118 | |
| 119 | 119 | if (openssl_error_string()) { |
| 120 | - $log->error('Encryption library openssl_pkey_new() fails: ' . openssl_error_string(), |
|
| 120 | + $log->error('Encryption library openssl_pkey_new() fails: '.openssl_error_string(), |
|
| 121 | 121 | ['app' => 'encryption']); |
| 122 | 122 | } |
| 123 | 123 | } elseif (openssl_pkey_export($res, |
@@ -132,10 +132,10 @@ discard block |
||
| 132 | 132 | 'privateKey' => $privateKey |
| 133 | 133 | ]; |
| 134 | 134 | } |
| 135 | - $log->error('Encryption library couldn\'t export users private key, please check your servers OpenSSL configuration.' . $this->user, |
|
| 135 | + $log->error('Encryption library couldn\'t export users private key, please check your servers OpenSSL configuration.'.$this->user, |
|
| 136 | 136 | ['app' => 'encryption']); |
| 137 | 137 | if (openssl_error_string()) { |
| 138 | - $log->error('Encryption Library:' . openssl_error_string(), |
|
| 138 | + $log->error('Encryption Library:'.openssl_error_string(), |
|
| 139 | 139 | ['app' => 'encryption']); |
| 140 | 140 | } |
| 141 | 141 | |
@@ -210,15 +210,15 @@ discard block |
||
| 210 | 210 | public function generateHeader($keyFormat = 'hash') { |
| 211 | 211 | |
| 212 | 212 | if (in_array($keyFormat, $this->supportedKeyFormats, true) === false) { |
| 213 | - throw new \InvalidArgumentException('key format "' . $keyFormat . '" is not supported'); |
|
| 213 | + throw new \InvalidArgumentException('key format "'.$keyFormat.'" is not supported'); |
|
| 214 | 214 | } |
| 215 | 215 | |
| 216 | 216 | $cipher = $this->getCipher(); |
| 217 | 217 | |
| 218 | 218 | $header = self::HEADER_START |
| 219 | - . ':cipher:' . $cipher |
|
| 220 | - . ':keyFormat:' . $keyFormat |
|
| 221 | - . ':' . self::HEADER_END; |
|
| 219 | + . ':cipher:'.$cipher |
|
| 220 | + . ':keyFormat:'.$keyFormat |
|
| 221 | + . ':'.self::HEADER_END; |
|
| 222 | 222 | |
| 223 | 223 | return $header; |
| 224 | 224 | } |
@@ -240,7 +240,7 @@ discard block |
||
| 240 | 240 | |
| 241 | 241 | if (!$encryptedContent) { |
| 242 | 242 | $error = 'Encryption (symmetric) of content failed'; |
| 243 | - $this->logger->error($error . openssl_error_string(), |
|
| 243 | + $this->logger->error($error.openssl_error_string(), |
|
| 244 | 244 | ['app' => 'encryption']); |
| 245 | 245 | throw new EncryptionFailedException($error); |
| 246 | 246 | } |
@@ -268,8 +268,8 @@ discard block |
||
| 268 | 268 | } |
| 269 | 269 | |
| 270 | 270 | // Workaround for OpenSSL 0.9.8. Fallback to an old cipher that should work. |
| 271 | - if(OPENSSL_VERSION_NUMBER < 0x1000101f) { |
|
| 272 | - if($cipher === 'AES-256-CTR' || $cipher === 'AES-128-CTR') { |
|
| 271 | + if (OPENSSL_VERSION_NUMBER < 0x1000101f) { |
|
| 272 | + if ($cipher === 'AES-256-CTR' || $cipher === 'AES-128-CTR') { |
|
| 273 | 273 | $cipher = self::LEGACY_CIPHER; |
| 274 | 274 | } |
| 275 | 275 | } |
@@ -285,7 +285,7 @@ discard block |
||
| 285 | 285 | * @throws \InvalidArgumentException |
| 286 | 286 | */ |
| 287 | 287 | protected function getKeySize($cipher) { |
| 288 | - if(isset($this->supportedCiphersAndKeySize[$cipher])) { |
|
| 288 | + if (isset($this->supportedCiphersAndKeySize[$cipher])) { |
|
| 289 | 289 | return $this->supportedCiphersAndKeySize[$cipher]; |
| 290 | 290 | } |
| 291 | 291 | |
@@ -312,7 +312,7 @@ discard block |
||
| 312 | 312 | * @return string |
| 313 | 313 | */ |
| 314 | 314 | private function concatIV($encryptedContent, $iv) { |
| 315 | - return $encryptedContent . '00iv00' . $iv; |
|
| 315 | + return $encryptedContent.'00iv00'.$iv; |
|
| 316 | 316 | } |
| 317 | 317 | |
| 318 | 318 | /** |
@@ -321,7 +321,7 @@ discard block |
||
| 321 | 321 | * @return string |
| 322 | 322 | */ |
| 323 | 323 | private function concatSig($encryptedContent, $signature) { |
| 324 | - return $encryptedContent . '00sig00' . $signature; |
|
| 324 | + return $encryptedContent.'00sig00'.$signature; |
|
| 325 | 325 | } |
| 326 | 326 | |
| 327 | 327 | /** |
@@ -333,7 +333,7 @@ discard block |
||
| 333 | 333 | * @return string |
| 334 | 334 | */ |
| 335 | 335 | private function addPadding($data) { |
| 336 | - return $data . 'xxx'; |
|
| 336 | + return $data.'xxx'; |
|
| 337 | 337 | } |
| 338 | 338 | |
| 339 | 339 | /** |
@@ -347,7 +347,7 @@ discard block |
||
| 347 | 347 | protected function generatePasswordHash($password, $cipher, $uid = '') { |
| 348 | 348 | $instanceId = $this->config->getSystemValue('instanceid'); |
| 349 | 349 | $instanceSecret = $this->config->getSystemValue('secret'); |
| 350 | - $salt = hash('sha256', $uid . $instanceId . $instanceSecret, true); |
|
| 350 | + $salt = hash('sha256', $uid.$instanceId.$instanceSecret, true); |
|
| 351 | 351 | $keySize = $this->getKeySize($cipher); |
| 352 | 352 | |
| 353 | 353 | $hash = hash_pbkdf2( |
@@ -493,7 +493,7 @@ discard block |
||
| 493 | 493 | * @return string |
| 494 | 494 | */ |
| 495 | 495 | private function createSignature($data, $passPhrase) { |
| 496 | - $passPhrase = hash('sha512', $passPhrase . 'a', true); |
|
| 496 | + $passPhrase = hash('sha512', $passPhrase.'a', true); |
|
| 497 | 497 | $signature = hash_hmac('sha256', $data, $passPhrase); |
| 498 | 498 | return $signature; |
| 499 | 499 | } |
@@ -585,7 +585,7 @@ discard block |
||
| 585 | 585 | if ($plainContent) { |
| 586 | 586 | return $plainContent; |
| 587 | 587 | } else { |
| 588 | - throw new DecryptionFailedException('Encryption library: Decryption (symmetric) of content failed: ' . openssl_error_string()); |
|
| 588 | + throw new DecryptionFailedException('Encryption library: Decryption (symmetric) of content failed: '.openssl_error_string()); |
|
| 589 | 589 | } |
| 590 | 590 | } |
| 591 | 591 | |
@@ -651,7 +651,7 @@ discard block |
||
| 651 | 651 | if (openssl_open($encKeyFile, $plainContent, $shareKey, $privateKey)) { |
| 652 | 652 | return $plainContent; |
| 653 | 653 | } else { |
| 654 | - throw new MultiKeyDecryptException('multikeydecrypt with share key failed:' . openssl_error_string()); |
|
| 654 | + throw new MultiKeyDecryptException('multikeydecrypt with share key failed:'.openssl_error_string()); |
|
| 655 | 655 | } |
| 656 | 656 | } |
| 657 | 657 | |
@@ -687,7 +687,7 @@ discard block |
||
| 687 | 687 | 'data' => $sealed |
| 688 | 688 | ]; |
| 689 | 689 | } else { |
| 690 | - throw new MultiKeyEncryptException('multikeyencryption failed ' . openssl_error_string()); |
|
| 690 | + throw new MultiKeyEncryptException('multikeyencryption failed '.openssl_error_string()); |
|
| 691 | 691 | } |
| 692 | 692 | } |
| 693 | 693 | } |
@@ -53,641 +53,641 @@ |
||
| 53 | 53 | */ |
| 54 | 54 | class Crypt { |
| 55 | 55 | |
| 56 | - const DEFAULT_CIPHER = 'AES-256-CTR'; |
|
| 57 | - // default cipher from old Nextcloud versions |
|
| 58 | - const LEGACY_CIPHER = 'AES-128-CFB'; |
|
| 59 | - |
|
| 60 | - // default key format, old Nextcloud version encrypted the private key directly |
|
| 61 | - // with the user password |
|
| 62 | - const LEGACY_KEY_FORMAT = 'password'; |
|
| 63 | - |
|
| 64 | - const HEADER_START = 'HBEGIN'; |
|
| 65 | - const HEADER_END = 'HEND'; |
|
| 66 | - |
|
| 67 | - /** @var ILogger */ |
|
| 68 | - private $logger; |
|
| 69 | - |
|
| 70 | - /** @var string */ |
|
| 71 | - private $user; |
|
| 72 | - |
|
| 73 | - /** @var IConfig */ |
|
| 74 | - private $config; |
|
| 75 | - |
|
| 76 | - /** @var array */ |
|
| 77 | - private $supportedKeyFormats; |
|
| 78 | - |
|
| 79 | - /** @var IL10N */ |
|
| 80 | - private $l; |
|
| 81 | - |
|
| 82 | - /** @var array */ |
|
| 83 | - private $supportedCiphersAndKeySize = [ |
|
| 84 | - 'AES-256-CTR' => 32, |
|
| 85 | - 'AES-128-CTR' => 16, |
|
| 86 | - 'AES-256-CFB' => 32, |
|
| 87 | - 'AES-128-CFB' => 16, |
|
| 88 | - ]; |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * @param ILogger $logger |
|
| 92 | - * @param IUserSession $userSession |
|
| 93 | - * @param IConfig $config |
|
| 94 | - * @param IL10N $l |
|
| 95 | - */ |
|
| 96 | - public function __construct(ILogger $logger, IUserSession $userSession, IConfig $config, IL10N $l) { |
|
| 97 | - $this->logger = $logger; |
|
| 98 | - $this->user = $userSession && $userSession->isLoggedIn() ? $userSession->getUser()->getUID() : '"no user given"'; |
|
| 99 | - $this->config = $config; |
|
| 100 | - $this->l = $l; |
|
| 101 | - $this->supportedKeyFormats = ['hash', 'password']; |
|
| 102 | - } |
|
| 103 | - |
|
| 104 | - /** |
|
| 105 | - * create new private/public key-pair for user |
|
| 106 | - * |
|
| 107 | - * @return array|bool |
|
| 108 | - */ |
|
| 109 | - public function createKeyPair() { |
|
| 110 | - |
|
| 111 | - $log = $this->logger; |
|
| 112 | - $res = $this->getOpenSSLPKey(); |
|
| 113 | - |
|
| 114 | - if (!$res) { |
|
| 115 | - $log->error("Encryption Library couldn't generate users key-pair for {$this->user}", |
|
| 116 | - ['app' => 'encryption']); |
|
| 117 | - |
|
| 118 | - if (openssl_error_string()) { |
|
| 119 | - $log->error('Encryption library openssl_pkey_new() fails: ' . openssl_error_string(), |
|
| 120 | - ['app' => 'encryption']); |
|
| 121 | - } |
|
| 122 | - } elseif (openssl_pkey_export($res, |
|
| 123 | - $privateKey, |
|
| 124 | - null, |
|
| 125 | - $this->getOpenSSLConfig())) { |
|
| 126 | - $keyDetails = openssl_pkey_get_details($res); |
|
| 127 | - $publicKey = $keyDetails['key']; |
|
| 128 | - |
|
| 129 | - return [ |
|
| 130 | - 'publicKey' => $publicKey, |
|
| 131 | - 'privateKey' => $privateKey |
|
| 132 | - ]; |
|
| 133 | - } |
|
| 134 | - $log->error('Encryption library couldn\'t export users private key, please check your servers OpenSSL configuration.' . $this->user, |
|
| 135 | - ['app' => 'encryption']); |
|
| 136 | - if (openssl_error_string()) { |
|
| 137 | - $log->error('Encryption Library:' . openssl_error_string(), |
|
| 138 | - ['app' => 'encryption']); |
|
| 139 | - } |
|
| 140 | - |
|
| 141 | - return false; |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * Generates a new private key |
|
| 146 | - * |
|
| 147 | - * @return resource |
|
| 148 | - */ |
|
| 149 | - public function getOpenSSLPKey() { |
|
| 150 | - $config = $this->getOpenSSLConfig(); |
|
| 151 | - return openssl_pkey_new($config); |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * get openSSL Config |
|
| 156 | - * |
|
| 157 | - * @return array |
|
| 158 | - */ |
|
| 159 | - private function getOpenSSLConfig() { |
|
| 160 | - $config = ['private_key_bits' => 4096]; |
|
| 161 | - $config = array_merge( |
|
| 162 | - $config, |
|
| 163 | - $this->config->getSystemValue('openssl', []) |
|
| 164 | - ); |
|
| 165 | - return $config; |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - /** |
|
| 169 | - * @param string $plainContent |
|
| 170 | - * @param string $passPhrase |
|
| 171 | - * @param int $version |
|
| 172 | - * @param int $position |
|
| 173 | - * @return false|string |
|
| 174 | - * @throws EncryptionFailedException |
|
| 175 | - */ |
|
| 176 | - public function symmetricEncryptFileContent($plainContent, $passPhrase, $version, $position) { |
|
| 177 | - |
|
| 178 | - if (!$plainContent) { |
|
| 179 | - $this->logger->error('Encryption Library, symmetrical encryption failed no content given', |
|
| 180 | - ['app' => 'encryption']); |
|
| 181 | - return false; |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - $iv = $this->generateIv(); |
|
| 185 | - |
|
| 186 | - $encryptedContent = $this->encrypt($plainContent, |
|
| 187 | - $iv, |
|
| 188 | - $passPhrase, |
|
| 189 | - $this->getCipher()); |
|
| 190 | - |
|
| 191 | - // Create a signature based on the key as well as the current version |
|
| 192 | - $sig = $this->createSignature($encryptedContent, $passPhrase.$version.$position); |
|
| 193 | - |
|
| 194 | - // combine content to encrypt the IV identifier and actual IV |
|
| 195 | - $catFile = $this->concatIV($encryptedContent, $iv); |
|
| 196 | - $catFile = $this->concatSig($catFile, $sig); |
|
| 197 | - $padded = $this->addPadding($catFile); |
|
| 198 | - |
|
| 199 | - return $padded; |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * generate header for encrypted file |
|
| 204 | - * |
|
| 205 | - * @param string $keyFormat (can be 'hash' or 'password') |
|
| 206 | - * @return string |
|
| 207 | - * @throws \InvalidArgumentException |
|
| 208 | - */ |
|
| 209 | - public function generateHeader($keyFormat = 'hash') { |
|
| 210 | - |
|
| 211 | - if (in_array($keyFormat, $this->supportedKeyFormats, true) === false) { |
|
| 212 | - throw new \InvalidArgumentException('key format "' . $keyFormat . '" is not supported'); |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - $cipher = $this->getCipher(); |
|
| 216 | - |
|
| 217 | - $header = self::HEADER_START |
|
| 218 | - . ':cipher:' . $cipher |
|
| 219 | - . ':keyFormat:' . $keyFormat |
|
| 220 | - . ':' . self::HEADER_END; |
|
| 221 | - |
|
| 222 | - return $header; |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - /** |
|
| 226 | - * @param string $plainContent |
|
| 227 | - * @param string $iv |
|
| 228 | - * @param string $passPhrase |
|
| 229 | - * @param string $cipher |
|
| 230 | - * @return string |
|
| 231 | - * @throws EncryptionFailedException |
|
| 232 | - */ |
|
| 233 | - private function encrypt($plainContent, $iv, $passPhrase = '', $cipher = self::DEFAULT_CIPHER) { |
|
| 234 | - $encryptedContent = openssl_encrypt($plainContent, |
|
| 235 | - $cipher, |
|
| 236 | - $passPhrase, |
|
| 237 | - false, |
|
| 238 | - $iv); |
|
| 239 | - |
|
| 240 | - if (!$encryptedContent) { |
|
| 241 | - $error = 'Encryption (symmetric) of content failed'; |
|
| 242 | - $this->logger->error($error . openssl_error_string(), |
|
| 243 | - ['app' => 'encryption']); |
|
| 244 | - throw new EncryptionFailedException($error); |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - return $encryptedContent; |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - /** |
|
| 251 | - * return Cipher either from config.php or the default cipher defined in |
|
| 252 | - * this class |
|
| 253 | - * |
|
| 254 | - * @return string |
|
| 255 | - */ |
|
| 256 | - public function getCipher() { |
|
| 257 | - $cipher = $this->config->getSystemValue('cipher', self::DEFAULT_CIPHER); |
|
| 258 | - if (!isset($this->supportedCiphersAndKeySize[$cipher])) { |
|
| 259 | - $this->logger->warning( |
|
| 260 | - sprintf( |
|
| 261 | - 'Unsupported cipher (%s) defined in config.php supported. Falling back to %s', |
|
| 262 | - $cipher, |
|
| 263 | - self::DEFAULT_CIPHER |
|
| 264 | - ), |
|
| 265 | - ['app' => 'encryption']); |
|
| 266 | - $cipher = self::DEFAULT_CIPHER; |
|
| 267 | - } |
|
| 268 | - |
|
| 269 | - // Workaround for OpenSSL 0.9.8. Fallback to an old cipher that should work. |
|
| 270 | - if(OPENSSL_VERSION_NUMBER < 0x1000101f) { |
|
| 271 | - if($cipher === 'AES-256-CTR' || $cipher === 'AES-128-CTR') { |
|
| 272 | - $cipher = self::LEGACY_CIPHER; |
|
| 273 | - } |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - return $cipher; |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - /** |
|
| 280 | - * get key size depending on the cipher |
|
| 281 | - * |
|
| 282 | - * @param string $cipher |
|
| 283 | - * @return int |
|
| 284 | - * @throws \InvalidArgumentException |
|
| 285 | - */ |
|
| 286 | - protected function getKeySize($cipher) { |
|
| 287 | - if(isset($this->supportedCiphersAndKeySize[$cipher])) { |
|
| 288 | - return $this->supportedCiphersAndKeySize[$cipher]; |
|
| 289 | - } |
|
| 290 | - |
|
| 291 | - throw new \InvalidArgumentException( |
|
| 292 | - sprintf( |
|
| 293 | - 'Unsupported cipher (%s) defined.', |
|
| 294 | - $cipher |
|
| 295 | - ) |
|
| 296 | - ); |
|
| 297 | - } |
|
| 298 | - |
|
| 299 | - /** |
|
| 300 | - * get legacy cipher |
|
| 301 | - * |
|
| 302 | - * @return string |
|
| 303 | - */ |
|
| 304 | - public function getLegacyCipher() { |
|
| 305 | - return self::LEGACY_CIPHER; |
|
| 306 | - } |
|
| 307 | - |
|
| 308 | - /** |
|
| 309 | - * @param string $encryptedContent |
|
| 310 | - * @param string $iv |
|
| 311 | - * @return string |
|
| 312 | - */ |
|
| 313 | - private function concatIV($encryptedContent, $iv) { |
|
| 314 | - return $encryptedContent . '00iv00' . $iv; |
|
| 315 | - } |
|
| 316 | - |
|
| 317 | - /** |
|
| 318 | - * @param string $encryptedContent |
|
| 319 | - * @param string $signature |
|
| 320 | - * @return string |
|
| 321 | - */ |
|
| 322 | - private function concatSig($encryptedContent, $signature) { |
|
| 323 | - return $encryptedContent . '00sig00' . $signature; |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - /** |
|
| 327 | - * Note: This is _NOT_ a padding used for encryption purposes. It is solely |
|
| 328 | - * used to achieve the PHP stream size. It has _NOTHING_ to do with the |
|
| 329 | - * encrypted content and is not used in any crypto primitive. |
|
| 330 | - * |
|
| 331 | - * @param string $data |
|
| 332 | - * @return string |
|
| 333 | - */ |
|
| 334 | - private function addPadding($data) { |
|
| 335 | - return $data . 'xxx'; |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - /** |
|
| 339 | - * generate password hash used to encrypt the users private key |
|
| 340 | - * |
|
| 341 | - * @param string $password |
|
| 342 | - * @param string $cipher |
|
| 343 | - * @param string $uid only used for user keys |
|
| 344 | - * @return string |
|
| 345 | - */ |
|
| 346 | - protected function generatePasswordHash($password, $cipher, $uid = '') { |
|
| 347 | - $instanceId = $this->config->getSystemValue('instanceid'); |
|
| 348 | - $instanceSecret = $this->config->getSystemValue('secret'); |
|
| 349 | - $salt = hash('sha256', $uid . $instanceId . $instanceSecret, true); |
|
| 350 | - $keySize = $this->getKeySize($cipher); |
|
| 351 | - |
|
| 352 | - $hash = hash_pbkdf2( |
|
| 353 | - 'sha256', |
|
| 354 | - $password, |
|
| 355 | - $salt, |
|
| 356 | - 100000, |
|
| 357 | - $keySize, |
|
| 358 | - true |
|
| 359 | - ); |
|
| 360 | - |
|
| 361 | - return $hash; |
|
| 362 | - } |
|
| 363 | - |
|
| 364 | - /** |
|
| 365 | - * encrypt private key |
|
| 366 | - * |
|
| 367 | - * @param string $privateKey |
|
| 368 | - * @param string $password |
|
| 369 | - * @param string $uid for regular users, empty for system keys |
|
| 370 | - * @return false|string |
|
| 371 | - */ |
|
| 372 | - public function encryptPrivateKey($privateKey, $password, $uid = '') { |
|
| 373 | - $cipher = $this->getCipher(); |
|
| 374 | - $hash = $this->generatePasswordHash($password, $cipher, $uid); |
|
| 375 | - $encryptedKey = $this->symmetricEncryptFileContent( |
|
| 376 | - $privateKey, |
|
| 377 | - $hash, |
|
| 378 | - 0, |
|
| 379 | - 0 |
|
| 380 | - ); |
|
| 381 | - |
|
| 382 | - return $encryptedKey; |
|
| 383 | - } |
|
| 384 | - |
|
| 385 | - /** |
|
| 386 | - * @param string $privateKey |
|
| 387 | - * @param string $password |
|
| 388 | - * @param string $uid for regular users, empty for system keys |
|
| 389 | - * @return false|string |
|
| 390 | - */ |
|
| 391 | - public function decryptPrivateKey($privateKey, $password = '', $uid = '') { |
|
| 392 | - |
|
| 393 | - $header = $this->parseHeader($privateKey); |
|
| 394 | - |
|
| 395 | - if (isset($header['cipher'])) { |
|
| 396 | - $cipher = $header['cipher']; |
|
| 397 | - } else { |
|
| 398 | - $cipher = self::LEGACY_CIPHER; |
|
| 399 | - } |
|
| 400 | - |
|
| 401 | - if (isset($header['keyFormat'])) { |
|
| 402 | - $keyFormat = $header['keyFormat']; |
|
| 403 | - } else { |
|
| 404 | - $keyFormat = self::LEGACY_KEY_FORMAT; |
|
| 405 | - } |
|
| 406 | - |
|
| 407 | - if ($keyFormat === 'hash') { |
|
| 408 | - $password = $this->generatePasswordHash($password, $cipher, $uid); |
|
| 409 | - } |
|
| 410 | - |
|
| 411 | - // If we found a header we need to remove it from the key we want to decrypt |
|
| 412 | - if (!empty($header)) { |
|
| 413 | - $privateKey = substr($privateKey, |
|
| 414 | - strpos($privateKey, |
|
| 415 | - self::HEADER_END) + strlen(self::HEADER_END)); |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - $plainKey = $this->symmetricDecryptFileContent( |
|
| 419 | - $privateKey, |
|
| 420 | - $password, |
|
| 421 | - $cipher, |
|
| 422 | - 0 |
|
| 423 | - ); |
|
| 424 | - |
|
| 425 | - if ($this->isValidPrivateKey($plainKey) === false) { |
|
| 426 | - return false; |
|
| 427 | - } |
|
| 428 | - |
|
| 429 | - return $plainKey; |
|
| 430 | - } |
|
| 431 | - |
|
| 432 | - /** |
|
| 433 | - * check if it is a valid private key |
|
| 434 | - * |
|
| 435 | - * @param string $plainKey |
|
| 436 | - * @return bool |
|
| 437 | - */ |
|
| 438 | - protected function isValidPrivateKey($plainKey) { |
|
| 439 | - $res = openssl_get_privatekey($plainKey); |
|
| 440 | - if (is_resource($res)) { |
|
| 441 | - $sslInfo = openssl_pkey_get_details($res); |
|
| 442 | - if (isset($sslInfo['key'])) { |
|
| 443 | - return true; |
|
| 444 | - } |
|
| 445 | - } |
|
| 446 | - |
|
| 447 | - return false; |
|
| 448 | - } |
|
| 449 | - |
|
| 450 | - /** |
|
| 451 | - * @param string $keyFileContents |
|
| 452 | - * @param string $passPhrase |
|
| 453 | - * @param string $cipher |
|
| 454 | - * @param int $version |
|
| 455 | - * @param int $position |
|
| 456 | - * @return string |
|
| 457 | - * @throws DecryptionFailedException |
|
| 458 | - */ |
|
| 459 | - public function symmetricDecryptFileContent($keyFileContents, $passPhrase, $cipher = self::DEFAULT_CIPHER, $version = 0, $position = 0) { |
|
| 460 | - $catFile = $this->splitMetaData($keyFileContents, $cipher); |
|
| 461 | - |
|
| 462 | - if ($catFile['signature'] !== false) { |
|
| 463 | - $this->checkSignature($catFile['encrypted'], $passPhrase.$version.$position, $catFile['signature']); |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - return $this->decrypt($catFile['encrypted'], |
|
| 467 | - $catFile['iv'], |
|
| 468 | - $passPhrase, |
|
| 469 | - $cipher); |
|
| 470 | - } |
|
| 471 | - |
|
| 472 | - /** |
|
| 473 | - * check for valid signature |
|
| 474 | - * |
|
| 475 | - * @param string $data |
|
| 476 | - * @param string $passPhrase |
|
| 477 | - * @param string $expectedSignature |
|
| 478 | - * @throws GenericEncryptionException |
|
| 479 | - */ |
|
| 480 | - private function checkSignature($data, $passPhrase, $expectedSignature) { |
|
| 481 | - $signature = $this->createSignature($data, $passPhrase); |
|
| 482 | - if (!hash_equals($expectedSignature, $signature)) { |
|
| 483 | - throw new GenericEncryptionException('Bad Signature', $this->l->t('Bad Signature')); |
|
| 484 | - } |
|
| 485 | - } |
|
| 486 | - |
|
| 487 | - /** |
|
| 488 | - * create signature |
|
| 489 | - * |
|
| 490 | - * @param string $data |
|
| 491 | - * @param string $passPhrase |
|
| 492 | - * @return string |
|
| 493 | - */ |
|
| 494 | - private function createSignature($data, $passPhrase) { |
|
| 495 | - $passPhrase = hash('sha512', $passPhrase . 'a', true); |
|
| 496 | - $signature = hash_hmac('sha256', $data, $passPhrase); |
|
| 497 | - return $signature; |
|
| 498 | - } |
|
| 499 | - |
|
| 500 | - |
|
| 501 | - /** |
|
| 502 | - * remove padding |
|
| 503 | - * |
|
| 504 | - * @param string $padded |
|
| 505 | - * @param bool $hasSignature did the block contain a signature, in this case we use a different padding |
|
| 506 | - * @return string|false |
|
| 507 | - */ |
|
| 508 | - private function removePadding($padded, $hasSignature = false) { |
|
| 509 | - if ($hasSignature === false && substr($padded, -2) === 'xx') { |
|
| 510 | - return substr($padded, 0, -2); |
|
| 511 | - } elseif ($hasSignature === true && substr($padded, -3) === 'xxx') { |
|
| 512 | - return substr($padded, 0, -3); |
|
| 513 | - } |
|
| 514 | - return false; |
|
| 515 | - } |
|
| 516 | - |
|
| 517 | - /** |
|
| 518 | - * split meta data from encrypted file |
|
| 519 | - * Note: for now, we assume that the meta data always start with the iv |
|
| 520 | - * followed by the signature, if available |
|
| 521 | - * |
|
| 522 | - * @param string $catFile |
|
| 523 | - * @param string $cipher |
|
| 524 | - * @return array |
|
| 525 | - */ |
|
| 526 | - private function splitMetaData($catFile, $cipher) { |
|
| 527 | - if ($this->hasSignature($catFile, $cipher)) { |
|
| 528 | - $catFile = $this->removePadding($catFile, true); |
|
| 529 | - $meta = substr($catFile, -93); |
|
| 530 | - $iv = substr($meta, strlen('00iv00'), 16); |
|
| 531 | - $sig = substr($meta, 22 + strlen('00sig00')); |
|
| 532 | - $encrypted = substr($catFile, 0, -93); |
|
| 533 | - } else { |
|
| 534 | - $catFile = $this->removePadding($catFile); |
|
| 535 | - $meta = substr($catFile, -22); |
|
| 536 | - $iv = substr($meta, -16); |
|
| 537 | - $sig = false; |
|
| 538 | - $encrypted = substr($catFile, 0, -22); |
|
| 539 | - } |
|
| 540 | - |
|
| 541 | - return [ |
|
| 542 | - 'encrypted' => $encrypted, |
|
| 543 | - 'iv' => $iv, |
|
| 544 | - 'signature' => $sig |
|
| 545 | - ]; |
|
| 546 | - } |
|
| 547 | - |
|
| 548 | - /** |
|
| 549 | - * check if encrypted block is signed |
|
| 550 | - * |
|
| 551 | - * @param string $catFile |
|
| 552 | - * @param string $cipher |
|
| 553 | - * @return bool |
|
| 554 | - * @throws GenericEncryptionException |
|
| 555 | - */ |
|
| 556 | - private function hasSignature($catFile, $cipher) { |
|
| 557 | - $meta = substr($catFile, -93); |
|
| 558 | - $signaturePosition = strpos($meta, '00sig00'); |
|
| 559 | - |
|
| 560 | - // enforce signature for the new 'CTR' ciphers |
|
| 561 | - if ($signaturePosition === false && strpos(strtolower($cipher), 'ctr') !== false) { |
|
| 562 | - throw new GenericEncryptionException('Missing Signature', $this->l->t('Missing Signature')); |
|
| 563 | - } |
|
| 564 | - |
|
| 565 | - return ($signaturePosition !== false); |
|
| 566 | - } |
|
| 567 | - |
|
| 568 | - |
|
| 569 | - /** |
|
| 570 | - * @param string $encryptedContent |
|
| 571 | - * @param string $iv |
|
| 572 | - * @param string $passPhrase |
|
| 573 | - * @param string $cipher |
|
| 574 | - * @return string |
|
| 575 | - * @throws DecryptionFailedException |
|
| 576 | - */ |
|
| 577 | - private function decrypt($encryptedContent, $iv, $passPhrase = '', $cipher = self::DEFAULT_CIPHER) { |
|
| 578 | - $plainContent = openssl_decrypt($encryptedContent, |
|
| 579 | - $cipher, |
|
| 580 | - $passPhrase, |
|
| 581 | - false, |
|
| 582 | - $iv); |
|
| 583 | - |
|
| 584 | - if ($plainContent) { |
|
| 585 | - return $plainContent; |
|
| 586 | - } else { |
|
| 587 | - throw new DecryptionFailedException('Encryption library: Decryption (symmetric) of content failed: ' . openssl_error_string()); |
|
| 588 | - } |
|
| 589 | - } |
|
| 590 | - |
|
| 591 | - /** |
|
| 592 | - * @param string $data |
|
| 593 | - * @return array |
|
| 594 | - */ |
|
| 595 | - protected function parseHeader($data) { |
|
| 596 | - $result = []; |
|
| 597 | - |
|
| 598 | - if (substr($data, 0, strlen(self::HEADER_START)) === self::HEADER_START) { |
|
| 599 | - $endAt = strpos($data, self::HEADER_END); |
|
| 600 | - $header = substr($data, 0, $endAt + strlen(self::HEADER_END)); |
|
| 601 | - |
|
| 602 | - // +1 not to start with an ':' which would result in empty element at the beginning |
|
| 603 | - $exploded = explode(':', |
|
| 604 | - substr($header, strlen(self::HEADER_START) + 1)); |
|
| 605 | - |
|
| 606 | - $element = array_shift($exploded); |
|
| 607 | - |
|
| 608 | - while ($element != self::HEADER_END) { |
|
| 609 | - $result[$element] = array_shift($exploded); |
|
| 610 | - $element = array_shift($exploded); |
|
| 611 | - } |
|
| 612 | - } |
|
| 613 | - |
|
| 614 | - return $result; |
|
| 615 | - } |
|
| 616 | - |
|
| 617 | - /** |
|
| 618 | - * generate initialization vector |
|
| 619 | - * |
|
| 620 | - * @return string |
|
| 621 | - * @throws GenericEncryptionException |
|
| 622 | - */ |
|
| 623 | - private function generateIv() { |
|
| 624 | - return random_bytes(16); |
|
| 625 | - } |
|
| 626 | - |
|
| 627 | - /** |
|
| 628 | - * Generate a cryptographically secure pseudo-random 256-bit ASCII key, used |
|
| 629 | - * as file key |
|
| 630 | - * |
|
| 631 | - * @return string |
|
| 632 | - * @throws \Exception |
|
| 633 | - */ |
|
| 634 | - public function generateFileKey() { |
|
| 635 | - return random_bytes(32); |
|
| 636 | - } |
|
| 637 | - |
|
| 638 | - /** |
|
| 639 | - * @param $encKeyFile |
|
| 640 | - * @param $shareKey |
|
| 641 | - * @param $privateKey |
|
| 642 | - * @return string |
|
| 643 | - * @throws MultiKeyDecryptException |
|
| 644 | - */ |
|
| 645 | - public function multiKeyDecrypt($encKeyFile, $shareKey, $privateKey) { |
|
| 646 | - if (!$encKeyFile) { |
|
| 647 | - throw new MultiKeyDecryptException('Cannot multikey decrypt empty plain content'); |
|
| 648 | - } |
|
| 649 | - |
|
| 650 | - if (openssl_open($encKeyFile, $plainContent, $shareKey, $privateKey)) { |
|
| 651 | - return $plainContent; |
|
| 652 | - } else { |
|
| 653 | - throw new MultiKeyDecryptException('multikeydecrypt with share key failed:' . openssl_error_string()); |
|
| 654 | - } |
|
| 655 | - } |
|
| 656 | - |
|
| 657 | - /** |
|
| 658 | - * @param string $plainContent |
|
| 659 | - * @param array $keyFiles |
|
| 660 | - * @return array |
|
| 661 | - * @throws MultiKeyEncryptException |
|
| 662 | - */ |
|
| 663 | - public function multiKeyEncrypt($plainContent, array $keyFiles) { |
|
| 664 | - // openssl_seal returns false without errors if plaincontent is empty |
|
| 665 | - // so trigger our own error |
|
| 666 | - if (empty($plainContent)) { |
|
| 667 | - throw new MultiKeyEncryptException('Cannot multikeyencrypt empty plain content'); |
|
| 668 | - } |
|
| 669 | - |
|
| 670 | - // Set empty vars to be set by openssl by reference |
|
| 671 | - $sealed = ''; |
|
| 672 | - $shareKeys = []; |
|
| 673 | - $mappedShareKeys = []; |
|
| 674 | - |
|
| 675 | - if (openssl_seal($plainContent, $sealed, $shareKeys, $keyFiles)) { |
|
| 676 | - $i = 0; |
|
| 677 | - |
|
| 678 | - // Ensure each shareKey is labelled with its corresponding key id |
|
| 679 | - foreach ($keyFiles as $userId => $publicKey) { |
|
| 680 | - $mappedShareKeys[$userId] = $shareKeys[$i]; |
|
| 681 | - $i++; |
|
| 682 | - } |
|
| 683 | - |
|
| 684 | - return [ |
|
| 685 | - 'keys' => $mappedShareKeys, |
|
| 686 | - 'data' => $sealed |
|
| 687 | - ]; |
|
| 688 | - } else { |
|
| 689 | - throw new MultiKeyEncryptException('multikeyencryption failed ' . openssl_error_string()); |
|
| 690 | - } |
|
| 691 | - } |
|
| 56 | + const DEFAULT_CIPHER = 'AES-256-CTR'; |
|
| 57 | + // default cipher from old Nextcloud versions |
|
| 58 | + const LEGACY_CIPHER = 'AES-128-CFB'; |
|
| 59 | + |
|
| 60 | + // default key format, old Nextcloud version encrypted the private key directly |
|
| 61 | + // with the user password |
|
| 62 | + const LEGACY_KEY_FORMAT = 'password'; |
|
| 63 | + |
|
| 64 | + const HEADER_START = 'HBEGIN'; |
|
| 65 | + const HEADER_END = 'HEND'; |
|
| 66 | + |
|
| 67 | + /** @var ILogger */ |
|
| 68 | + private $logger; |
|
| 69 | + |
|
| 70 | + /** @var string */ |
|
| 71 | + private $user; |
|
| 72 | + |
|
| 73 | + /** @var IConfig */ |
|
| 74 | + private $config; |
|
| 75 | + |
|
| 76 | + /** @var array */ |
|
| 77 | + private $supportedKeyFormats; |
|
| 78 | + |
|
| 79 | + /** @var IL10N */ |
|
| 80 | + private $l; |
|
| 81 | + |
|
| 82 | + /** @var array */ |
|
| 83 | + private $supportedCiphersAndKeySize = [ |
|
| 84 | + 'AES-256-CTR' => 32, |
|
| 85 | + 'AES-128-CTR' => 16, |
|
| 86 | + 'AES-256-CFB' => 32, |
|
| 87 | + 'AES-128-CFB' => 16, |
|
| 88 | + ]; |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * @param ILogger $logger |
|
| 92 | + * @param IUserSession $userSession |
|
| 93 | + * @param IConfig $config |
|
| 94 | + * @param IL10N $l |
|
| 95 | + */ |
|
| 96 | + public function __construct(ILogger $logger, IUserSession $userSession, IConfig $config, IL10N $l) { |
|
| 97 | + $this->logger = $logger; |
|
| 98 | + $this->user = $userSession && $userSession->isLoggedIn() ? $userSession->getUser()->getUID() : '"no user given"'; |
|
| 99 | + $this->config = $config; |
|
| 100 | + $this->l = $l; |
|
| 101 | + $this->supportedKeyFormats = ['hash', 'password']; |
|
| 102 | + } |
|
| 103 | + |
|
| 104 | + /** |
|
| 105 | + * create new private/public key-pair for user |
|
| 106 | + * |
|
| 107 | + * @return array|bool |
|
| 108 | + */ |
|
| 109 | + public function createKeyPair() { |
|
| 110 | + |
|
| 111 | + $log = $this->logger; |
|
| 112 | + $res = $this->getOpenSSLPKey(); |
|
| 113 | + |
|
| 114 | + if (!$res) { |
|
| 115 | + $log->error("Encryption Library couldn't generate users key-pair for {$this->user}", |
|
| 116 | + ['app' => 'encryption']); |
|
| 117 | + |
|
| 118 | + if (openssl_error_string()) { |
|
| 119 | + $log->error('Encryption library openssl_pkey_new() fails: ' . openssl_error_string(), |
|
| 120 | + ['app' => 'encryption']); |
|
| 121 | + } |
|
| 122 | + } elseif (openssl_pkey_export($res, |
|
| 123 | + $privateKey, |
|
| 124 | + null, |
|
| 125 | + $this->getOpenSSLConfig())) { |
|
| 126 | + $keyDetails = openssl_pkey_get_details($res); |
|
| 127 | + $publicKey = $keyDetails['key']; |
|
| 128 | + |
|
| 129 | + return [ |
|
| 130 | + 'publicKey' => $publicKey, |
|
| 131 | + 'privateKey' => $privateKey |
|
| 132 | + ]; |
|
| 133 | + } |
|
| 134 | + $log->error('Encryption library couldn\'t export users private key, please check your servers OpenSSL configuration.' . $this->user, |
|
| 135 | + ['app' => 'encryption']); |
|
| 136 | + if (openssl_error_string()) { |
|
| 137 | + $log->error('Encryption Library:' . openssl_error_string(), |
|
| 138 | + ['app' => 'encryption']); |
|
| 139 | + } |
|
| 140 | + |
|
| 141 | + return false; |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * Generates a new private key |
|
| 146 | + * |
|
| 147 | + * @return resource |
|
| 148 | + */ |
|
| 149 | + public function getOpenSSLPKey() { |
|
| 150 | + $config = $this->getOpenSSLConfig(); |
|
| 151 | + return openssl_pkey_new($config); |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * get openSSL Config |
|
| 156 | + * |
|
| 157 | + * @return array |
|
| 158 | + */ |
|
| 159 | + private function getOpenSSLConfig() { |
|
| 160 | + $config = ['private_key_bits' => 4096]; |
|
| 161 | + $config = array_merge( |
|
| 162 | + $config, |
|
| 163 | + $this->config->getSystemValue('openssl', []) |
|
| 164 | + ); |
|
| 165 | + return $config; |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + /** |
|
| 169 | + * @param string $plainContent |
|
| 170 | + * @param string $passPhrase |
|
| 171 | + * @param int $version |
|
| 172 | + * @param int $position |
|
| 173 | + * @return false|string |
|
| 174 | + * @throws EncryptionFailedException |
|
| 175 | + */ |
|
| 176 | + public function symmetricEncryptFileContent($plainContent, $passPhrase, $version, $position) { |
|
| 177 | + |
|
| 178 | + if (!$plainContent) { |
|
| 179 | + $this->logger->error('Encryption Library, symmetrical encryption failed no content given', |
|
| 180 | + ['app' => 'encryption']); |
|
| 181 | + return false; |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + $iv = $this->generateIv(); |
|
| 185 | + |
|
| 186 | + $encryptedContent = $this->encrypt($plainContent, |
|
| 187 | + $iv, |
|
| 188 | + $passPhrase, |
|
| 189 | + $this->getCipher()); |
|
| 190 | + |
|
| 191 | + // Create a signature based on the key as well as the current version |
|
| 192 | + $sig = $this->createSignature($encryptedContent, $passPhrase.$version.$position); |
|
| 193 | + |
|
| 194 | + // combine content to encrypt the IV identifier and actual IV |
|
| 195 | + $catFile = $this->concatIV($encryptedContent, $iv); |
|
| 196 | + $catFile = $this->concatSig($catFile, $sig); |
|
| 197 | + $padded = $this->addPadding($catFile); |
|
| 198 | + |
|
| 199 | + return $padded; |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * generate header for encrypted file |
|
| 204 | + * |
|
| 205 | + * @param string $keyFormat (can be 'hash' or 'password') |
|
| 206 | + * @return string |
|
| 207 | + * @throws \InvalidArgumentException |
|
| 208 | + */ |
|
| 209 | + public function generateHeader($keyFormat = 'hash') { |
|
| 210 | + |
|
| 211 | + if (in_array($keyFormat, $this->supportedKeyFormats, true) === false) { |
|
| 212 | + throw new \InvalidArgumentException('key format "' . $keyFormat . '" is not supported'); |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + $cipher = $this->getCipher(); |
|
| 216 | + |
|
| 217 | + $header = self::HEADER_START |
|
| 218 | + . ':cipher:' . $cipher |
|
| 219 | + . ':keyFormat:' . $keyFormat |
|
| 220 | + . ':' . self::HEADER_END; |
|
| 221 | + |
|
| 222 | + return $header; |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + /** |
|
| 226 | + * @param string $plainContent |
|
| 227 | + * @param string $iv |
|
| 228 | + * @param string $passPhrase |
|
| 229 | + * @param string $cipher |
|
| 230 | + * @return string |
|
| 231 | + * @throws EncryptionFailedException |
|
| 232 | + */ |
|
| 233 | + private function encrypt($plainContent, $iv, $passPhrase = '', $cipher = self::DEFAULT_CIPHER) { |
|
| 234 | + $encryptedContent = openssl_encrypt($plainContent, |
|
| 235 | + $cipher, |
|
| 236 | + $passPhrase, |
|
| 237 | + false, |
|
| 238 | + $iv); |
|
| 239 | + |
|
| 240 | + if (!$encryptedContent) { |
|
| 241 | + $error = 'Encryption (symmetric) of content failed'; |
|
| 242 | + $this->logger->error($error . openssl_error_string(), |
|
| 243 | + ['app' => 'encryption']); |
|
| 244 | + throw new EncryptionFailedException($error); |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + return $encryptedContent; |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + /** |
|
| 251 | + * return Cipher either from config.php or the default cipher defined in |
|
| 252 | + * this class |
|
| 253 | + * |
|
| 254 | + * @return string |
|
| 255 | + */ |
|
| 256 | + public function getCipher() { |
|
| 257 | + $cipher = $this->config->getSystemValue('cipher', self::DEFAULT_CIPHER); |
|
| 258 | + if (!isset($this->supportedCiphersAndKeySize[$cipher])) { |
|
| 259 | + $this->logger->warning( |
|
| 260 | + sprintf( |
|
| 261 | + 'Unsupported cipher (%s) defined in config.php supported. Falling back to %s', |
|
| 262 | + $cipher, |
|
| 263 | + self::DEFAULT_CIPHER |
|
| 264 | + ), |
|
| 265 | + ['app' => 'encryption']); |
|
| 266 | + $cipher = self::DEFAULT_CIPHER; |
|
| 267 | + } |
|
| 268 | + |
|
| 269 | + // Workaround for OpenSSL 0.9.8. Fallback to an old cipher that should work. |
|
| 270 | + if(OPENSSL_VERSION_NUMBER < 0x1000101f) { |
|
| 271 | + if($cipher === 'AES-256-CTR' || $cipher === 'AES-128-CTR') { |
|
| 272 | + $cipher = self::LEGACY_CIPHER; |
|
| 273 | + } |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + return $cipher; |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + /** |
|
| 280 | + * get key size depending on the cipher |
|
| 281 | + * |
|
| 282 | + * @param string $cipher |
|
| 283 | + * @return int |
|
| 284 | + * @throws \InvalidArgumentException |
|
| 285 | + */ |
|
| 286 | + protected function getKeySize($cipher) { |
|
| 287 | + if(isset($this->supportedCiphersAndKeySize[$cipher])) { |
|
| 288 | + return $this->supportedCiphersAndKeySize[$cipher]; |
|
| 289 | + } |
|
| 290 | + |
|
| 291 | + throw new \InvalidArgumentException( |
|
| 292 | + sprintf( |
|
| 293 | + 'Unsupported cipher (%s) defined.', |
|
| 294 | + $cipher |
|
| 295 | + ) |
|
| 296 | + ); |
|
| 297 | + } |
|
| 298 | + |
|
| 299 | + /** |
|
| 300 | + * get legacy cipher |
|
| 301 | + * |
|
| 302 | + * @return string |
|
| 303 | + */ |
|
| 304 | + public function getLegacyCipher() { |
|
| 305 | + return self::LEGACY_CIPHER; |
|
| 306 | + } |
|
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * @param string $encryptedContent |
|
| 310 | + * @param string $iv |
|
| 311 | + * @return string |
|
| 312 | + */ |
|
| 313 | + private function concatIV($encryptedContent, $iv) { |
|
| 314 | + return $encryptedContent . '00iv00' . $iv; |
|
| 315 | + } |
|
| 316 | + |
|
| 317 | + /** |
|
| 318 | + * @param string $encryptedContent |
|
| 319 | + * @param string $signature |
|
| 320 | + * @return string |
|
| 321 | + */ |
|
| 322 | + private function concatSig($encryptedContent, $signature) { |
|
| 323 | + return $encryptedContent . '00sig00' . $signature; |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + /** |
|
| 327 | + * Note: This is _NOT_ a padding used for encryption purposes. It is solely |
|
| 328 | + * used to achieve the PHP stream size. It has _NOTHING_ to do with the |
|
| 329 | + * encrypted content and is not used in any crypto primitive. |
|
| 330 | + * |
|
| 331 | + * @param string $data |
|
| 332 | + * @return string |
|
| 333 | + */ |
|
| 334 | + private function addPadding($data) { |
|
| 335 | + return $data . 'xxx'; |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + /** |
|
| 339 | + * generate password hash used to encrypt the users private key |
|
| 340 | + * |
|
| 341 | + * @param string $password |
|
| 342 | + * @param string $cipher |
|
| 343 | + * @param string $uid only used for user keys |
|
| 344 | + * @return string |
|
| 345 | + */ |
|
| 346 | + protected function generatePasswordHash($password, $cipher, $uid = '') { |
|
| 347 | + $instanceId = $this->config->getSystemValue('instanceid'); |
|
| 348 | + $instanceSecret = $this->config->getSystemValue('secret'); |
|
| 349 | + $salt = hash('sha256', $uid . $instanceId . $instanceSecret, true); |
|
| 350 | + $keySize = $this->getKeySize($cipher); |
|
| 351 | + |
|
| 352 | + $hash = hash_pbkdf2( |
|
| 353 | + 'sha256', |
|
| 354 | + $password, |
|
| 355 | + $salt, |
|
| 356 | + 100000, |
|
| 357 | + $keySize, |
|
| 358 | + true |
|
| 359 | + ); |
|
| 360 | + |
|
| 361 | + return $hash; |
|
| 362 | + } |
|
| 363 | + |
|
| 364 | + /** |
|
| 365 | + * encrypt private key |
|
| 366 | + * |
|
| 367 | + * @param string $privateKey |
|
| 368 | + * @param string $password |
|
| 369 | + * @param string $uid for regular users, empty for system keys |
|
| 370 | + * @return false|string |
|
| 371 | + */ |
|
| 372 | + public function encryptPrivateKey($privateKey, $password, $uid = '') { |
|
| 373 | + $cipher = $this->getCipher(); |
|
| 374 | + $hash = $this->generatePasswordHash($password, $cipher, $uid); |
|
| 375 | + $encryptedKey = $this->symmetricEncryptFileContent( |
|
| 376 | + $privateKey, |
|
| 377 | + $hash, |
|
| 378 | + 0, |
|
| 379 | + 0 |
|
| 380 | + ); |
|
| 381 | + |
|
| 382 | + return $encryptedKey; |
|
| 383 | + } |
|
| 384 | + |
|
| 385 | + /** |
|
| 386 | + * @param string $privateKey |
|
| 387 | + * @param string $password |
|
| 388 | + * @param string $uid for regular users, empty for system keys |
|
| 389 | + * @return false|string |
|
| 390 | + */ |
|
| 391 | + public function decryptPrivateKey($privateKey, $password = '', $uid = '') { |
|
| 392 | + |
|
| 393 | + $header = $this->parseHeader($privateKey); |
|
| 394 | + |
|
| 395 | + if (isset($header['cipher'])) { |
|
| 396 | + $cipher = $header['cipher']; |
|
| 397 | + } else { |
|
| 398 | + $cipher = self::LEGACY_CIPHER; |
|
| 399 | + } |
|
| 400 | + |
|
| 401 | + if (isset($header['keyFormat'])) { |
|
| 402 | + $keyFormat = $header['keyFormat']; |
|
| 403 | + } else { |
|
| 404 | + $keyFormat = self::LEGACY_KEY_FORMAT; |
|
| 405 | + } |
|
| 406 | + |
|
| 407 | + if ($keyFormat === 'hash') { |
|
| 408 | + $password = $this->generatePasswordHash($password, $cipher, $uid); |
|
| 409 | + } |
|
| 410 | + |
|
| 411 | + // If we found a header we need to remove it from the key we want to decrypt |
|
| 412 | + if (!empty($header)) { |
|
| 413 | + $privateKey = substr($privateKey, |
|
| 414 | + strpos($privateKey, |
|
| 415 | + self::HEADER_END) + strlen(self::HEADER_END)); |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + $plainKey = $this->symmetricDecryptFileContent( |
|
| 419 | + $privateKey, |
|
| 420 | + $password, |
|
| 421 | + $cipher, |
|
| 422 | + 0 |
|
| 423 | + ); |
|
| 424 | + |
|
| 425 | + if ($this->isValidPrivateKey($plainKey) === false) { |
|
| 426 | + return false; |
|
| 427 | + } |
|
| 428 | + |
|
| 429 | + return $plainKey; |
|
| 430 | + } |
|
| 431 | + |
|
| 432 | + /** |
|
| 433 | + * check if it is a valid private key |
|
| 434 | + * |
|
| 435 | + * @param string $plainKey |
|
| 436 | + * @return bool |
|
| 437 | + */ |
|
| 438 | + protected function isValidPrivateKey($plainKey) { |
|
| 439 | + $res = openssl_get_privatekey($plainKey); |
|
| 440 | + if (is_resource($res)) { |
|
| 441 | + $sslInfo = openssl_pkey_get_details($res); |
|
| 442 | + if (isset($sslInfo['key'])) { |
|
| 443 | + return true; |
|
| 444 | + } |
|
| 445 | + } |
|
| 446 | + |
|
| 447 | + return false; |
|
| 448 | + } |
|
| 449 | + |
|
| 450 | + /** |
|
| 451 | + * @param string $keyFileContents |
|
| 452 | + * @param string $passPhrase |
|
| 453 | + * @param string $cipher |
|
| 454 | + * @param int $version |
|
| 455 | + * @param int $position |
|
| 456 | + * @return string |
|
| 457 | + * @throws DecryptionFailedException |
|
| 458 | + */ |
|
| 459 | + public function symmetricDecryptFileContent($keyFileContents, $passPhrase, $cipher = self::DEFAULT_CIPHER, $version = 0, $position = 0) { |
|
| 460 | + $catFile = $this->splitMetaData($keyFileContents, $cipher); |
|
| 461 | + |
|
| 462 | + if ($catFile['signature'] !== false) { |
|
| 463 | + $this->checkSignature($catFile['encrypted'], $passPhrase.$version.$position, $catFile['signature']); |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + return $this->decrypt($catFile['encrypted'], |
|
| 467 | + $catFile['iv'], |
|
| 468 | + $passPhrase, |
|
| 469 | + $cipher); |
|
| 470 | + } |
|
| 471 | + |
|
| 472 | + /** |
|
| 473 | + * check for valid signature |
|
| 474 | + * |
|
| 475 | + * @param string $data |
|
| 476 | + * @param string $passPhrase |
|
| 477 | + * @param string $expectedSignature |
|
| 478 | + * @throws GenericEncryptionException |
|
| 479 | + */ |
|
| 480 | + private function checkSignature($data, $passPhrase, $expectedSignature) { |
|
| 481 | + $signature = $this->createSignature($data, $passPhrase); |
|
| 482 | + if (!hash_equals($expectedSignature, $signature)) { |
|
| 483 | + throw new GenericEncryptionException('Bad Signature', $this->l->t('Bad Signature')); |
|
| 484 | + } |
|
| 485 | + } |
|
| 486 | + |
|
| 487 | + /** |
|
| 488 | + * create signature |
|
| 489 | + * |
|
| 490 | + * @param string $data |
|
| 491 | + * @param string $passPhrase |
|
| 492 | + * @return string |
|
| 493 | + */ |
|
| 494 | + private function createSignature($data, $passPhrase) { |
|
| 495 | + $passPhrase = hash('sha512', $passPhrase . 'a', true); |
|
| 496 | + $signature = hash_hmac('sha256', $data, $passPhrase); |
|
| 497 | + return $signature; |
|
| 498 | + } |
|
| 499 | + |
|
| 500 | + |
|
| 501 | + /** |
|
| 502 | + * remove padding |
|
| 503 | + * |
|
| 504 | + * @param string $padded |
|
| 505 | + * @param bool $hasSignature did the block contain a signature, in this case we use a different padding |
|
| 506 | + * @return string|false |
|
| 507 | + */ |
|
| 508 | + private function removePadding($padded, $hasSignature = false) { |
|
| 509 | + if ($hasSignature === false && substr($padded, -2) === 'xx') { |
|
| 510 | + return substr($padded, 0, -2); |
|
| 511 | + } elseif ($hasSignature === true && substr($padded, -3) === 'xxx') { |
|
| 512 | + return substr($padded, 0, -3); |
|
| 513 | + } |
|
| 514 | + return false; |
|
| 515 | + } |
|
| 516 | + |
|
| 517 | + /** |
|
| 518 | + * split meta data from encrypted file |
|
| 519 | + * Note: for now, we assume that the meta data always start with the iv |
|
| 520 | + * followed by the signature, if available |
|
| 521 | + * |
|
| 522 | + * @param string $catFile |
|
| 523 | + * @param string $cipher |
|
| 524 | + * @return array |
|
| 525 | + */ |
|
| 526 | + private function splitMetaData($catFile, $cipher) { |
|
| 527 | + if ($this->hasSignature($catFile, $cipher)) { |
|
| 528 | + $catFile = $this->removePadding($catFile, true); |
|
| 529 | + $meta = substr($catFile, -93); |
|
| 530 | + $iv = substr($meta, strlen('00iv00'), 16); |
|
| 531 | + $sig = substr($meta, 22 + strlen('00sig00')); |
|
| 532 | + $encrypted = substr($catFile, 0, -93); |
|
| 533 | + } else { |
|
| 534 | + $catFile = $this->removePadding($catFile); |
|
| 535 | + $meta = substr($catFile, -22); |
|
| 536 | + $iv = substr($meta, -16); |
|
| 537 | + $sig = false; |
|
| 538 | + $encrypted = substr($catFile, 0, -22); |
|
| 539 | + } |
|
| 540 | + |
|
| 541 | + return [ |
|
| 542 | + 'encrypted' => $encrypted, |
|
| 543 | + 'iv' => $iv, |
|
| 544 | + 'signature' => $sig |
|
| 545 | + ]; |
|
| 546 | + } |
|
| 547 | + |
|
| 548 | + /** |
|
| 549 | + * check if encrypted block is signed |
|
| 550 | + * |
|
| 551 | + * @param string $catFile |
|
| 552 | + * @param string $cipher |
|
| 553 | + * @return bool |
|
| 554 | + * @throws GenericEncryptionException |
|
| 555 | + */ |
|
| 556 | + private function hasSignature($catFile, $cipher) { |
|
| 557 | + $meta = substr($catFile, -93); |
|
| 558 | + $signaturePosition = strpos($meta, '00sig00'); |
|
| 559 | + |
|
| 560 | + // enforce signature for the new 'CTR' ciphers |
|
| 561 | + if ($signaturePosition === false && strpos(strtolower($cipher), 'ctr') !== false) { |
|
| 562 | + throw new GenericEncryptionException('Missing Signature', $this->l->t('Missing Signature')); |
|
| 563 | + } |
|
| 564 | + |
|
| 565 | + return ($signaturePosition !== false); |
|
| 566 | + } |
|
| 567 | + |
|
| 568 | + |
|
| 569 | + /** |
|
| 570 | + * @param string $encryptedContent |
|
| 571 | + * @param string $iv |
|
| 572 | + * @param string $passPhrase |
|
| 573 | + * @param string $cipher |
|
| 574 | + * @return string |
|
| 575 | + * @throws DecryptionFailedException |
|
| 576 | + */ |
|
| 577 | + private function decrypt($encryptedContent, $iv, $passPhrase = '', $cipher = self::DEFAULT_CIPHER) { |
|
| 578 | + $plainContent = openssl_decrypt($encryptedContent, |
|
| 579 | + $cipher, |
|
| 580 | + $passPhrase, |
|
| 581 | + false, |
|
| 582 | + $iv); |
|
| 583 | + |
|
| 584 | + if ($plainContent) { |
|
| 585 | + return $plainContent; |
|
| 586 | + } else { |
|
| 587 | + throw new DecryptionFailedException('Encryption library: Decryption (symmetric) of content failed: ' . openssl_error_string()); |
|
| 588 | + } |
|
| 589 | + } |
|
| 590 | + |
|
| 591 | + /** |
|
| 592 | + * @param string $data |
|
| 593 | + * @return array |
|
| 594 | + */ |
|
| 595 | + protected function parseHeader($data) { |
|
| 596 | + $result = []; |
|
| 597 | + |
|
| 598 | + if (substr($data, 0, strlen(self::HEADER_START)) === self::HEADER_START) { |
|
| 599 | + $endAt = strpos($data, self::HEADER_END); |
|
| 600 | + $header = substr($data, 0, $endAt + strlen(self::HEADER_END)); |
|
| 601 | + |
|
| 602 | + // +1 not to start with an ':' which would result in empty element at the beginning |
|
| 603 | + $exploded = explode(':', |
|
| 604 | + substr($header, strlen(self::HEADER_START) + 1)); |
|
| 605 | + |
|
| 606 | + $element = array_shift($exploded); |
|
| 607 | + |
|
| 608 | + while ($element != self::HEADER_END) { |
|
| 609 | + $result[$element] = array_shift($exploded); |
|
| 610 | + $element = array_shift($exploded); |
|
| 611 | + } |
|
| 612 | + } |
|
| 613 | + |
|
| 614 | + return $result; |
|
| 615 | + } |
|
| 616 | + |
|
| 617 | + /** |
|
| 618 | + * generate initialization vector |
|
| 619 | + * |
|
| 620 | + * @return string |
|
| 621 | + * @throws GenericEncryptionException |
|
| 622 | + */ |
|
| 623 | + private function generateIv() { |
|
| 624 | + return random_bytes(16); |
|
| 625 | + } |
|
| 626 | + |
|
| 627 | + /** |
|
| 628 | + * Generate a cryptographically secure pseudo-random 256-bit ASCII key, used |
|
| 629 | + * as file key |
|
| 630 | + * |
|
| 631 | + * @return string |
|
| 632 | + * @throws \Exception |
|
| 633 | + */ |
|
| 634 | + public function generateFileKey() { |
|
| 635 | + return random_bytes(32); |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + /** |
|
| 639 | + * @param $encKeyFile |
|
| 640 | + * @param $shareKey |
|
| 641 | + * @param $privateKey |
|
| 642 | + * @return string |
|
| 643 | + * @throws MultiKeyDecryptException |
|
| 644 | + */ |
|
| 645 | + public function multiKeyDecrypt($encKeyFile, $shareKey, $privateKey) { |
|
| 646 | + if (!$encKeyFile) { |
|
| 647 | + throw new MultiKeyDecryptException('Cannot multikey decrypt empty plain content'); |
|
| 648 | + } |
|
| 649 | + |
|
| 650 | + if (openssl_open($encKeyFile, $plainContent, $shareKey, $privateKey)) { |
|
| 651 | + return $plainContent; |
|
| 652 | + } else { |
|
| 653 | + throw new MultiKeyDecryptException('multikeydecrypt with share key failed:' . openssl_error_string()); |
|
| 654 | + } |
|
| 655 | + } |
|
| 656 | + |
|
| 657 | + /** |
|
| 658 | + * @param string $plainContent |
|
| 659 | + * @param array $keyFiles |
|
| 660 | + * @return array |
|
| 661 | + * @throws MultiKeyEncryptException |
|
| 662 | + */ |
|
| 663 | + public function multiKeyEncrypt($plainContent, array $keyFiles) { |
|
| 664 | + // openssl_seal returns false without errors if plaincontent is empty |
|
| 665 | + // so trigger our own error |
|
| 666 | + if (empty($plainContent)) { |
|
| 667 | + throw new MultiKeyEncryptException('Cannot multikeyencrypt empty plain content'); |
|
| 668 | + } |
|
| 669 | + |
|
| 670 | + // Set empty vars to be set by openssl by reference |
|
| 671 | + $sealed = ''; |
|
| 672 | + $shareKeys = []; |
|
| 673 | + $mappedShareKeys = []; |
|
| 674 | + |
|
| 675 | + if (openssl_seal($plainContent, $sealed, $shareKeys, $keyFiles)) { |
|
| 676 | + $i = 0; |
|
| 677 | + |
|
| 678 | + // Ensure each shareKey is labelled with its corresponding key id |
|
| 679 | + foreach ($keyFiles as $userId => $publicKey) { |
|
| 680 | + $mappedShareKeys[$userId] = $shareKeys[$i]; |
|
| 681 | + $i++; |
|
| 682 | + } |
|
| 683 | + |
|
| 684 | + return [ |
|
| 685 | + 'keys' => $mappedShareKeys, |
|
| 686 | + 'data' => $sealed |
|
| 687 | + ]; |
|
| 688 | + } else { |
|
| 689 | + throw new MultiKeyEncryptException('multikeyencryption failed ' . openssl_error_string()); |
|
| 690 | + } |
|
| 691 | + } |
|
| 692 | 692 | } |
| 693 | 693 | |
@@ -35,127 +35,127 @@ |
||
| 35 | 35 | |
| 36 | 36 | class DecryptAll { |
| 37 | 37 | |
| 38 | - /** @var Util */ |
|
| 39 | - protected $util; |
|
| 40 | - |
|
| 41 | - /** @var QuestionHelper */ |
|
| 42 | - protected $questionHelper; |
|
| 43 | - |
|
| 44 | - /** @var Crypt */ |
|
| 45 | - protected $crypt; |
|
| 46 | - |
|
| 47 | - /** @var KeyManager */ |
|
| 48 | - protected $keyManager; |
|
| 49 | - |
|
| 50 | - /** @var Session */ |
|
| 51 | - protected $session; |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * @param Util $util |
|
| 55 | - * @param KeyManager $keyManager |
|
| 56 | - * @param Crypt $crypt |
|
| 57 | - * @param Session $session |
|
| 58 | - * @param QuestionHelper $questionHelper |
|
| 59 | - */ |
|
| 60 | - public function __construct( |
|
| 61 | - Util $util, |
|
| 62 | - KeyManager $keyManager, |
|
| 63 | - Crypt $crypt, |
|
| 64 | - Session $session, |
|
| 65 | - QuestionHelper $questionHelper |
|
| 66 | - ) { |
|
| 67 | - $this->util = $util; |
|
| 68 | - $this->keyManager = $keyManager; |
|
| 69 | - $this->crypt = $crypt; |
|
| 70 | - $this->session = $session; |
|
| 71 | - $this->questionHelper = $questionHelper; |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * prepare encryption module to decrypt all files |
|
| 76 | - * |
|
| 77 | - * @param InputInterface $input |
|
| 78 | - * @param OutputInterface $output |
|
| 79 | - * @param $user |
|
| 80 | - * @return bool |
|
| 81 | - */ |
|
| 82 | - public function prepare(InputInterface $input, OutputInterface $output, $user) { |
|
| 83 | - |
|
| 84 | - $question = new Question('Please enter the recovery key password: '); |
|
| 85 | - |
|
| 86 | - if($this->util->isMasterKeyEnabled()) { |
|
| 87 | - $output->writeln('Use master key to decrypt all files'); |
|
| 88 | - $user = $this->keyManager->getMasterKeyId(); |
|
| 89 | - $password =$this->keyManager->getMasterKeyPassword(); |
|
| 90 | - } else { |
|
| 91 | - $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
| 92 | - if (!empty($user)) { |
|
| 93 | - $output->writeln('You can only decrypt the users files if you know'); |
|
| 94 | - $output->writeln('the users password or if he activated the recovery key.'); |
|
| 95 | - $output->writeln(''); |
|
| 96 | - $questionUseLoginPassword = new ConfirmationQuestion( |
|
| 97 | - 'Do you want to use the users login password to decrypt all files? (y/n) ', |
|
| 98 | - false |
|
| 99 | - ); |
|
| 100 | - $useLoginPassword = $this->questionHelper->ask($input, $output, $questionUseLoginPassword); |
|
| 101 | - if ($useLoginPassword) { |
|
| 102 | - $question = new Question('Please enter the user\'s login password: '); |
|
| 103 | - } else if ($this->util->isRecoveryEnabledForUser($user) === false) { |
|
| 104 | - $output->writeln('No recovery key available for user ' . $user); |
|
| 105 | - return false; |
|
| 106 | - } else { |
|
| 107 | - $user = $recoveryKeyId; |
|
| 108 | - } |
|
| 109 | - } else { |
|
| 110 | - $output->writeln('You can only decrypt the files of all users if the'); |
|
| 111 | - $output->writeln('recovery key is enabled by the admin and activated by the users.'); |
|
| 112 | - $output->writeln(''); |
|
| 113 | - $user = $recoveryKeyId; |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - $question->setHidden(true); |
|
| 117 | - $question->setHiddenFallback(false); |
|
| 118 | - $password = $this->questionHelper->ask($input, $output, $question); |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - $privateKey = $this->getPrivateKey($user, $password); |
|
| 122 | - if ($privateKey !== false) { |
|
| 123 | - $this->updateSession($user, $privateKey); |
|
| 124 | - return true; |
|
| 125 | - } else { |
|
| 126 | - $output->writeln('Could not decrypt private key, maybe you entered the wrong password?'); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - |
|
| 130 | - return false; |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * get the private key which will be used to decrypt all files |
|
| 135 | - * |
|
| 136 | - * @param string $user |
|
| 137 | - * @param string $password |
|
| 138 | - * @return bool|string |
|
| 139 | - * @throws \OCA\Encryption\Exceptions\PrivateKeyMissingException |
|
| 140 | - */ |
|
| 141 | - protected function getPrivateKey($user, $password) { |
|
| 142 | - $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
| 143 | - $masterKeyId = $this->keyManager->getMasterKeyId(); |
|
| 144 | - if ($user === $recoveryKeyId) { |
|
| 145 | - $recoveryKey = $this->keyManager->getSystemPrivateKey($recoveryKeyId); |
|
| 146 | - $privateKey = $this->crypt->decryptPrivateKey($recoveryKey, $password); |
|
| 147 | - } elseif ($user === $masterKeyId) { |
|
| 148 | - $masterKey = $this->keyManager->getSystemPrivateKey($masterKeyId); |
|
| 149 | - $privateKey = $this->crypt->decryptPrivateKey($masterKey, $password, $masterKeyId); |
|
| 150 | - } else { |
|
| 151 | - $userKey = $this->keyManager->getPrivateKey($user); |
|
| 152 | - $privateKey = $this->crypt->decryptPrivateKey($userKey, $password, $user); |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - return $privateKey; |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - protected function updateSession($user, $privateKey) { |
|
| 159 | - $this->session->prepareDecryptAll($user, $privateKey); |
|
| 160 | - } |
|
| 38 | + /** @var Util */ |
|
| 39 | + protected $util; |
|
| 40 | + |
|
| 41 | + /** @var QuestionHelper */ |
|
| 42 | + protected $questionHelper; |
|
| 43 | + |
|
| 44 | + /** @var Crypt */ |
|
| 45 | + protected $crypt; |
|
| 46 | + |
|
| 47 | + /** @var KeyManager */ |
|
| 48 | + protected $keyManager; |
|
| 49 | + |
|
| 50 | + /** @var Session */ |
|
| 51 | + protected $session; |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * @param Util $util |
|
| 55 | + * @param KeyManager $keyManager |
|
| 56 | + * @param Crypt $crypt |
|
| 57 | + * @param Session $session |
|
| 58 | + * @param QuestionHelper $questionHelper |
|
| 59 | + */ |
|
| 60 | + public function __construct( |
|
| 61 | + Util $util, |
|
| 62 | + KeyManager $keyManager, |
|
| 63 | + Crypt $crypt, |
|
| 64 | + Session $session, |
|
| 65 | + QuestionHelper $questionHelper |
|
| 66 | + ) { |
|
| 67 | + $this->util = $util; |
|
| 68 | + $this->keyManager = $keyManager; |
|
| 69 | + $this->crypt = $crypt; |
|
| 70 | + $this->session = $session; |
|
| 71 | + $this->questionHelper = $questionHelper; |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * prepare encryption module to decrypt all files |
|
| 76 | + * |
|
| 77 | + * @param InputInterface $input |
|
| 78 | + * @param OutputInterface $output |
|
| 79 | + * @param $user |
|
| 80 | + * @return bool |
|
| 81 | + */ |
|
| 82 | + public function prepare(InputInterface $input, OutputInterface $output, $user) { |
|
| 83 | + |
|
| 84 | + $question = new Question('Please enter the recovery key password: '); |
|
| 85 | + |
|
| 86 | + if($this->util->isMasterKeyEnabled()) { |
|
| 87 | + $output->writeln('Use master key to decrypt all files'); |
|
| 88 | + $user = $this->keyManager->getMasterKeyId(); |
|
| 89 | + $password =$this->keyManager->getMasterKeyPassword(); |
|
| 90 | + } else { |
|
| 91 | + $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
| 92 | + if (!empty($user)) { |
|
| 93 | + $output->writeln('You can only decrypt the users files if you know'); |
|
| 94 | + $output->writeln('the users password or if he activated the recovery key.'); |
|
| 95 | + $output->writeln(''); |
|
| 96 | + $questionUseLoginPassword = new ConfirmationQuestion( |
|
| 97 | + 'Do you want to use the users login password to decrypt all files? (y/n) ', |
|
| 98 | + false |
|
| 99 | + ); |
|
| 100 | + $useLoginPassword = $this->questionHelper->ask($input, $output, $questionUseLoginPassword); |
|
| 101 | + if ($useLoginPassword) { |
|
| 102 | + $question = new Question('Please enter the user\'s login password: '); |
|
| 103 | + } else if ($this->util->isRecoveryEnabledForUser($user) === false) { |
|
| 104 | + $output->writeln('No recovery key available for user ' . $user); |
|
| 105 | + return false; |
|
| 106 | + } else { |
|
| 107 | + $user = $recoveryKeyId; |
|
| 108 | + } |
|
| 109 | + } else { |
|
| 110 | + $output->writeln('You can only decrypt the files of all users if the'); |
|
| 111 | + $output->writeln('recovery key is enabled by the admin and activated by the users.'); |
|
| 112 | + $output->writeln(''); |
|
| 113 | + $user = $recoveryKeyId; |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + $question->setHidden(true); |
|
| 117 | + $question->setHiddenFallback(false); |
|
| 118 | + $password = $this->questionHelper->ask($input, $output, $question); |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + $privateKey = $this->getPrivateKey($user, $password); |
|
| 122 | + if ($privateKey !== false) { |
|
| 123 | + $this->updateSession($user, $privateKey); |
|
| 124 | + return true; |
|
| 125 | + } else { |
|
| 126 | + $output->writeln('Could not decrypt private key, maybe you entered the wrong password?'); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + |
|
| 130 | + return false; |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * get the private key which will be used to decrypt all files |
|
| 135 | + * |
|
| 136 | + * @param string $user |
|
| 137 | + * @param string $password |
|
| 138 | + * @return bool|string |
|
| 139 | + * @throws \OCA\Encryption\Exceptions\PrivateKeyMissingException |
|
| 140 | + */ |
|
| 141 | + protected function getPrivateKey($user, $password) { |
|
| 142 | + $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
| 143 | + $masterKeyId = $this->keyManager->getMasterKeyId(); |
|
| 144 | + if ($user === $recoveryKeyId) { |
|
| 145 | + $recoveryKey = $this->keyManager->getSystemPrivateKey($recoveryKeyId); |
|
| 146 | + $privateKey = $this->crypt->decryptPrivateKey($recoveryKey, $password); |
|
| 147 | + } elseif ($user === $masterKeyId) { |
|
| 148 | + $masterKey = $this->keyManager->getSystemPrivateKey($masterKeyId); |
|
| 149 | + $privateKey = $this->crypt->decryptPrivateKey($masterKey, $password, $masterKeyId); |
|
| 150 | + } else { |
|
| 151 | + $userKey = $this->keyManager->getPrivateKey($user); |
|
| 152 | + $privateKey = $this->crypt->decryptPrivateKey($userKey, $password, $user); |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + return $privateKey; |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + protected function updateSession($user, $privateKey) { |
|
| 159 | + $this->session->prepareDecryptAll($user, $privateKey); |
|
| 160 | + } |
|
| 161 | 161 | } |
@@ -83,10 +83,10 @@ discard block |
||
| 83 | 83 | |
| 84 | 84 | $question = new Question('Please enter the recovery key password: '); |
| 85 | 85 | |
| 86 | - if($this->util->isMasterKeyEnabled()) { |
|
| 86 | + if ($this->util->isMasterKeyEnabled()) { |
|
| 87 | 87 | $output->writeln('Use master key to decrypt all files'); |
| 88 | 88 | $user = $this->keyManager->getMasterKeyId(); |
| 89 | - $password =$this->keyManager->getMasterKeyPassword(); |
|
| 89 | + $password = $this->keyManager->getMasterKeyPassword(); |
|
| 90 | 90 | } else { |
| 91 | 91 | $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
| 92 | 92 | if (!empty($user)) { |
@@ -101,7 +101,7 @@ discard block |
||
| 101 | 101 | if ($useLoginPassword) { |
| 102 | 102 | $question = new Question('Please enter the user\'s login password: '); |
| 103 | 103 | } else if ($this->util->isRecoveryEnabledForUser($user) === false) { |
| 104 | - $output->writeln('No recovery key available for user ' . $user); |
|
| 104 | + $output->writeln('No recovery key available for user '.$user); |
|
| 105 | 105 | return false; |
| 106 | 106 | } else { |
| 107 | 107 | $user = $recoveryKeyId; |
@@ -28,38 +28,38 @@ |
||
| 28 | 28 | |
| 29 | 29 | class HookManager { |
| 30 | 30 | |
| 31 | - private $hookInstances = []; |
|
| 31 | + private $hookInstances = []; |
|
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @param array|IHook $instances |
|
| 35 | - * - This accepts either a single instance of IHook or an array of instances of IHook |
|
| 36 | - * @return bool |
|
| 37 | - */ |
|
| 38 | - public function registerHook($instances) { |
|
| 39 | - if (is_array($instances)) { |
|
| 40 | - foreach ($instances as $instance) { |
|
| 41 | - if (!$instance instanceof IHook) { |
|
| 42 | - return false; |
|
| 43 | - } |
|
| 44 | - $this->hookInstances[] = $instance; |
|
| 45 | - } |
|
| 33 | + /** |
|
| 34 | + * @param array|IHook $instances |
|
| 35 | + * - This accepts either a single instance of IHook or an array of instances of IHook |
|
| 36 | + * @return bool |
|
| 37 | + */ |
|
| 38 | + public function registerHook($instances) { |
|
| 39 | + if (is_array($instances)) { |
|
| 40 | + foreach ($instances as $instance) { |
|
| 41 | + if (!$instance instanceof IHook) { |
|
| 42 | + return false; |
|
| 43 | + } |
|
| 44 | + $this->hookInstances[] = $instance; |
|
| 45 | + } |
|
| 46 | 46 | |
| 47 | - } elseif ($instances instanceof IHook) { |
|
| 48 | - $this->hookInstances[] = $instances; |
|
| 49 | - } |
|
| 50 | - return true; |
|
| 51 | - } |
|
| 47 | + } elseif ($instances instanceof IHook) { |
|
| 48 | + $this->hookInstances[] = $instances; |
|
| 49 | + } |
|
| 50 | + return true; |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - public function fireHooks() { |
|
| 54 | - foreach ($this->hookInstances as $instance) { |
|
| 55 | - /** |
|
| 56 | - * Fire off the add hooks method of each instance stored in cache |
|
| 57 | - * |
|
| 58 | - * @var $instance IHook |
|
| 59 | - */ |
|
| 60 | - $instance->addHooks(); |
|
| 61 | - } |
|
| 53 | + public function fireHooks() { |
|
| 54 | + foreach ($this->hookInstances as $instance) { |
|
| 55 | + /** |
|
| 56 | + * Fire off the add hooks method of each instance stored in cache |
|
| 57 | + * |
|
| 58 | + * @var $instance IHook |
|
| 59 | + */ |
|
| 60 | + $instance->addHooks(); |
|
| 61 | + } |
|
| 62 | 62 | |
| 63 | - } |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | 65 | } |
@@ -26,36 +26,36 @@ |
||
| 26 | 26 | |
| 27 | 27 | (new Application())->registerRoutes($this, array('routes' => array( |
| 28 | 28 | |
| 29 | - [ |
|
| 30 | - 'name' => 'Recovery#adminRecovery', |
|
| 31 | - 'url' => '/ajax/adminRecovery', |
|
| 32 | - 'verb' => 'POST' |
|
| 33 | - ], |
|
| 34 | - [ |
|
| 35 | - 'name' => 'Settings#updatePrivateKeyPassword', |
|
| 36 | - 'url' => '/ajax/updatePrivateKeyPassword', |
|
| 37 | - 'verb' => 'POST' |
|
| 38 | - ], |
|
| 39 | - [ |
|
| 40 | - 'name' => 'Settings#setEncryptHomeStorage', |
|
| 41 | - 'url' => '/ajax/setEncryptHomeStorage', |
|
| 42 | - 'verb' => 'POST' |
|
| 43 | - ], |
|
| 44 | - [ |
|
| 45 | - 'name' => 'Recovery#changeRecoveryPassword', |
|
| 46 | - 'url' => '/ajax/changeRecoveryPassword', |
|
| 47 | - 'verb' => 'POST' |
|
| 48 | - ], |
|
| 49 | - [ |
|
| 50 | - 'name' => 'Recovery#userSetRecovery', |
|
| 51 | - 'url' => '/ajax/userSetRecovery', |
|
| 52 | - 'verb' => 'POST' |
|
| 53 | - ], |
|
| 54 | - [ |
|
| 55 | - 'name' => 'Status#getStatus', |
|
| 56 | - 'url' => '/ajax/getStatus', |
|
| 57 | - 'verb' => 'GET' |
|
| 58 | - ] |
|
| 29 | + [ |
|
| 30 | + 'name' => 'Recovery#adminRecovery', |
|
| 31 | + 'url' => '/ajax/adminRecovery', |
|
| 32 | + 'verb' => 'POST' |
|
| 33 | + ], |
|
| 34 | + [ |
|
| 35 | + 'name' => 'Settings#updatePrivateKeyPassword', |
|
| 36 | + 'url' => '/ajax/updatePrivateKeyPassword', |
|
| 37 | + 'verb' => 'POST' |
|
| 38 | + ], |
|
| 39 | + [ |
|
| 40 | + 'name' => 'Settings#setEncryptHomeStorage', |
|
| 41 | + 'url' => '/ajax/setEncryptHomeStorage', |
|
| 42 | + 'verb' => 'POST' |
|
| 43 | + ], |
|
| 44 | + [ |
|
| 45 | + 'name' => 'Recovery#changeRecoveryPassword', |
|
| 46 | + 'url' => '/ajax/changeRecoveryPassword', |
|
| 47 | + 'verb' => 'POST' |
|
| 48 | + ], |
|
| 49 | + [ |
|
| 50 | + 'name' => 'Recovery#userSetRecovery', |
|
| 51 | + 'url' => '/ajax/userSetRecovery', |
|
| 52 | + 'verb' => 'POST' |
|
| 53 | + ], |
|
| 54 | + [ |
|
| 55 | + 'name' => 'Status#getStatus', |
|
| 56 | + 'url' => '/ajax/getStatus', |
|
| 57 | + 'verb' => 'GET' |
|
| 58 | + ] |
|
| 59 | 59 | |
| 60 | 60 | |
| 61 | 61 | ))); |
@@ -34,209 +34,209 @@ |
||
| 34 | 34 | |
| 35 | 35 | class Provider implements IProvider { |
| 36 | 36 | |
| 37 | - /** @var IFactory */ |
|
| 38 | - protected $languageFactory; |
|
| 39 | - |
|
| 40 | - /** @var IL10N */ |
|
| 41 | - protected $l; |
|
| 42 | - |
|
| 43 | - /** @var IURLGenerator */ |
|
| 44 | - protected $url; |
|
| 45 | - |
|
| 46 | - /** @var ICommentsManager */ |
|
| 47 | - protected $commentsManager; |
|
| 48 | - |
|
| 49 | - /** @var IUserManager */ |
|
| 50 | - protected $userManager; |
|
| 51 | - |
|
| 52 | - /** @var IManager */ |
|
| 53 | - protected $activityManager; |
|
| 54 | - |
|
| 55 | - /** @var string[] */ |
|
| 56 | - protected $displayNames = []; |
|
| 57 | - |
|
| 58 | - /** |
|
| 59 | - * @param IFactory $languageFactory |
|
| 60 | - * @param IURLGenerator $url |
|
| 61 | - * @param ICommentsManager $commentsManager |
|
| 62 | - * @param IUserManager $userManager |
|
| 63 | - * @param IManager $activityManager |
|
| 64 | - */ |
|
| 65 | - public function __construct(IFactory $languageFactory, IURLGenerator $url, ICommentsManager $commentsManager, IUserManager $userManager, IManager $activityManager) { |
|
| 66 | - $this->languageFactory = $languageFactory; |
|
| 67 | - $this->url = $url; |
|
| 68 | - $this->commentsManager = $commentsManager; |
|
| 69 | - $this->userManager = $userManager; |
|
| 70 | - $this->activityManager = $activityManager; |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * @param string $language |
|
| 75 | - * @param IEvent $event |
|
| 76 | - * @param IEvent|null $previousEvent |
|
| 77 | - * @return IEvent |
|
| 78 | - * @throws \InvalidArgumentException |
|
| 79 | - * @since 11.0.0 |
|
| 80 | - */ |
|
| 81 | - public function parse($language, IEvent $event, IEvent $previousEvent = null) { |
|
| 82 | - if ($event->getApp() !== 'comments') { |
|
| 83 | - throw new \InvalidArgumentException(); |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - $this->l = $this->languageFactory->get('comments', $language); |
|
| 87 | - |
|
| 88 | - if ($event->getSubject() === 'add_comment_subject') { |
|
| 89 | - $this->parseMessage($event); |
|
| 90 | - $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg'))); |
|
| 91 | - |
|
| 92 | - if ($this->activityManager->isFormattingFilteredObject()) { |
|
| 93 | - try { |
|
| 94 | - return $this->parseShortVersion($event); |
|
| 95 | - } catch (\InvalidArgumentException $e) { |
|
| 96 | - // Ignore and simply use the long version... |
|
| 97 | - } |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - return $this->parseLongVersion($event); |
|
| 101 | - } else { |
|
| 102 | - throw new \InvalidArgumentException(); |
|
| 103 | - } |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * @param IEvent $event |
|
| 108 | - * @return IEvent |
|
| 109 | - * @throws \InvalidArgumentException |
|
| 110 | - */ |
|
| 111 | - protected function parseShortVersion(IEvent $event) { |
|
| 112 | - $subjectParameters = $event->getSubjectParameters(); |
|
| 113 | - |
|
| 114 | - if ($event->getSubject() === 'add_comment_subject') { |
|
| 115 | - if ($subjectParameters[0] === $this->activityManager->getCurrentUserId()) { |
|
| 116 | - $event->setParsedSubject($this->l->t('You commented')) |
|
| 117 | - ->setRichSubject($this->l->t('You commented'), []); |
|
| 118 | - } else { |
|
| 119 | - $author = $this->generateUserParameter($subjectParameters[0]); |
|
| 120 | - $event->setParsedSubject($this->l->t('%1$s commented', [$author['name']])) |
|
| 121 | - ->setRichSubject($this->l->t('{author} commented'), [ |
|
| 122 | - 'author' => $author, |
|
| 123 | - ]); |
|
| 124 | - } |
|
| 125 | - } else { |
|
| 126 | - throw new \InvalidArgumentException(); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - return $event; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * @param IEvent $event |
|
| 134 | - * @return IEvent |
|
| 135 | - * @throws \InvalidArgumentException |
|
| 136 | - */ |
|
| 137 | - protected function parseLongVersion(IEvent $event) { |
|
| 138 | - $subjectParameters = $event->getSubjectParameters(); |
|
| 139 | - |
|
| 140 | - if ($event->getSubject() === 'add_comment_subject') { |
|
| 141 | - if ($subjectParameters[0] === $this->activityManager->getCurrentUserId()) { |
|
| 142 | - $event->setParsedSubject($this->l->t('You commented on %1$s', [ |
|
| 143 | - trim($subjectParameters[1], '/'), |
|
| 144 | - ])) |
|
| 145 | - ->setRichSubject($this->l->t('You commented on {file}'), [ |
|
| 146 | - 'file' => $this->generateFileParameter($event->getObjectId(), $subjectParameters[1]), |
|
| 147 | - ]); |
|
| 148 | - } else { |
|
| 149 | - $author = $this->generateUserParameter($subjectParameters[0]); |
|
| 150 | - $event->setParsedSubject($this->l->t('%1$s commented on %2$s', [ |
|
| 151 | - $author['name'], |
|
| 152 | - trim($subjectParameters[1], '/'), |
|
| 153 | - ])) |
|
| 154 | - ->setRichSubject($this->l->t('{author} commented on {file}'), [ |
|
| 155 | - 'author' => $author, |
|
| 156 | - 'file' => $this->generateFileParameter($event->getObjectId(), $subjectParameters[1]), |
|
| 157 | - ]); |
|
| 158 | - } |
|
| 159 | - } else { |
|
| 160 | - throw new \InvalidArgumentException(); |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - return $event; |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * @param IEvent $event |
|
| 168 | - */ |
|
| 169 | - protected function parseMessage(IEvent $event) { |
|
| 170 | - $messageParameters = $event->getMessageParameters(); |
|
| 171 | - try { |
|
| 172 | - $comment = $this->commentsManager->get((int) $messageParameters[0]); |
|
| 173 | - $message = $comment->getMessage(); |
|
| 174 | - $message = str_replace("\n", '<br />', str_replace(['<', '>'], ['<', '>'], $message)); |
|
| 175 | - |
|
| 176 | - $mentionCount = 1; |
|
| 177 | - $mentions = []; |
|
| 178 | - foreach ($comment->getMentions() as $mention) { |
|
| 179 | - if ($mention['type'] !== 'user') { |
|
| 180 | - continue; |
|
| 181 | - } |
|
| 182 | - |
|
| 183 | - $message = preg_replace( |
|
| 184 | - '/(^|\s)(' . '@' . $mention['id'] . ')(\b)/', |
|
| 185 | - //'${1}' . $this->regexSafeUser($mention['id'], $displayName) . '${3}', |
|
| 186 | - '${1}' . '{mention' . $mentionCount . '}' . '${3}', |
|
| 187 | - $message |
|
| 188 | - ); |
|
| 189 | - $mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']); |
|
| 190 | - $mentionCount++; |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - $event->setParsedMessage($comment->getMessage()) |
|
| 194 | - ->setRichMessage($message, $mentions); |
|
| 195 | - } catch (NotFoundException $e) { |
|
| 196 | - } |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * @param int $id |
|
| 201 | - * @param string $path |
|
| 202 | - * @return array |
|
| 203 | - */ |
|
| 204 | - protected function generateFileParameter($id, $path) { |
|
| 205 | - return [ |
|
| 206 | - 'type' => 'file', |
|
| 207 | - 'id' => $id, |
|
| 208 | - 'name' => basename($path), |
|
| 209 | - 'path' => trim($path, '/'), |
|
| 210 | - 'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]), |
|
| 211 | - ]; |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * @param string $uid |
|
| 216 | - * @return array |
|
| 217 | - */ |
|
| 218 | - protected function generateUserParameter($uid) { |
|
| 219 | - if (!isset($this->displayNames[$uid])) { |
|
| 220 | - $this->displayNames[$uid] = $this->getDisplayName($uid); |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - return [ |
|
| 224 | - 'type' => 'user', |
|
| 225 | - 'id' => $uid, |
|
| 226 | - 'name' => $this->displayNames[$uid], |
|
| 227 | - ]; |
|
| 228 | - } |
|
| 229 | - |
|
| 230 | - /** |
|
| 231 | - * @param string $uid |
|
| 232 | - * @return string |
|
| 233 | - */ |
|
| 234 | - protected function getDisplayName($uid) { |
|
| 235 | - $user = $this->userManager->get($uid); |
|
| 236 | - if ($user instanceof IUser) { |
|
| 237 | - return $user->getDisplayName(); |
|
| 238 | - } else { |
|
| 239 | - return $uid; |
|
| 240 | - } |
|
| 241 | - } |
|
| 37 | + /** @var IFactory */ |
|
| 38 | + protected $languageFactory; |
|
| 39 | + |
|
| 40 | + /** @var IL10N */ |
|
| 41 | + protected $l; |
|
| 42 | + |
|
| 43 | + /** @var IURLGenerator */ |
|
| 44 | + protected $url; |
|
| 45 | + |
|
| 46 | + /** @var ICommentsManager */ |
|
| 47 | + protected $commentsManager; |
|
| 48 | + |
|
| 49 | + /** @var IUserManager */ |
|
| 50 | + protected $userManager; |
|
| 51 | + |
|
| 52 | + /** @var IManager */ |
|
| 53 | + protected $activityManager; |
|
| 54 | + |
|
| 55 | + /** @var string[] */ |
|
| 56 | + protected $displayNames = []; |
|
| 57 | + |
|
| 58 | + /** |
|
| 59 | + * @param IFactory $languageFactory |
|
| 60 | + * @param IURLGenerator $url |
|
| 61 | + * @param ICommentsManager $commentsManager |
|
| 62 | + * @param IUserManager $userManager |
|
| 63 | + * @param IManager $activityManager |
|
| 64 | + */ |
|
| 65 | + public function __construct(IFactory $languageFactory, IURLGenerator $url, ICommentsManager $commentsManager, IUserManager $userManager, IManager $activityManager) { |
|
| 66 | + $this->languageFactory = $languageFactory; |
|
| 67 | + $this->url = $url; |
|
| 68 | + $this->commentsManager = $commentsManager; |
|
| 69 | + $this->userManager = $userManager; |
|
| 70 | + $this->activityManager = $activityManager; |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * @param string $language |
|
| 75 | + * @param IEvent $event |
|
| 76 | + * @param IEvent|null $previousEvent |
|
| 77 | + * @return IEvent |
|
| 78 | + * @throws \InvalidArgumentException |
|
| 79 | + * @since 11.0.0 |
|
| 80 | + */ |
|
| 81 | + public function parse($language, IEvent $event, IEvent $previousEvent = null) { |
|
| 82 | + if ($event->getApp() !== 'comments') { |
|
| 83 | + throw new \InvalidArgumentException(); |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + $this->l = $this->languageFactory->get('comments', $language); |
|
| 87 | + |
|
| 88 | + if ($event->getSubject() === 'add_comment_subject') { |
|
| 89 | + $this->parseMessage($event); |
|
| 90 | + $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg'))); |
|
| 91 | + |
|
| 92 | + if ($this->activityManager->isFormattingFilteredObject()) { |
|
| 93 | + try { |
|
| 94 | + return $this->parseShortVersion($event); |
|
| 95 | + } catch (\InvalidArgumentException $e) { |
|
| 96 | + // Ignore and simply use the long version... |
|
| 97 | + } |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + return $this->parseLongVersion($event); |
|
| 101 | + } else { |
|
| 102 | + throw new \InvalidArgumentException(); |
|
| 103 | + } |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * @param IEvent $event |
|
| 108 | + * @return IEvent |
|
| 109 | + * @throws \InvalidArgumentException |
|
| 110 | + */ |
|
| 111 | + protected function parseShortVersion(IEvent $event) { |
|
| 112 | + $subjectParameters = $event->getSubjectParameters(); |
|
| 113 | + |
|
| 114 | + if ($event->getSubject() === 'add_comment_subject') { |
|
| 115 | + if ($subjectParameters[0] === $this->activityManager->getCurrentUserId()) { |
|
| 116 | + $event->setParsedSubject($this->l->t('You commented')) |
|
| 117 | + ->setRichSubject($this->l->t('You commented'), []); |
|
| 118 | + } else { |
|
| 119 | + $author = $this->generateUserParameter($subjectParameters[0]); |
|
| 120 | + $event->setParsedSubject($this->l->t('%1$s commented', [$author['name']])) |
|
| 121 | + ->setRichSubject($this->l->t('{author} commented'), [ |
|
| 122 | + 'author' => $author, |
|
| 123 | + ]); |
|
| 124 | + } |
|
| 125 | + } else { |
|
| 126 | + throw new \InvalidArgumentException(); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + return $event; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * @param IEvent $event |
|
| 134 | + * @return IEvent |
|
| 135 | + * @throws \InvalidArgumentException |
|
| 136 | + */ |
|
| 137 | + protected function parseLongVersion(IEvent $event) { |
|
| 138 | + $subjectParameters = $event->getSubjectParameters(); |
|
| 139 | + |
|
| 140 | + if ($event->getSubject() === 'add_comment_subject') { |
|
| 141 | + if ($subjectParameters[0] === $this->activityManager->getCurrentUserId()) { |
|
| 142 | + $event->setParsedSubject($this->l->t('You commented on %1$s', [ |
|
| 143 | + trim($subjectParameters[1], '/'), |
|
| 144 | + ])) |
|
| 145 | + ->setRichSubject($this->l->t('You commented on {file}'), [ |
|
| 146 | + 'file' => $this->generateFileParameter($event->getObjectId(), $subjectParameters[1]), |
|
| 147 | + ]); |
|
| 148 | + } else { |
|
| 149 | + $author = $this->generateUserParameter($subjectParameters[0]); |
|
| 150 | + $event->setParsedSubject($this->l->t('%1$s commented on %2$s', [ |
|
| 151 | + $author['name'], |
|
| 152 | + trim($subjectParameters[1], '/'), |
|
| 153 | + ])) |
|
| 154 | + ->setRichSubject($this->l->t('{author} commented on {file}'), [ |
|
| 155 | + 'author' => $author, |
|
| 156 | + 'file' => $this->generateFileParameter($event->getObjectId(), $subjectParameters[1]), |
|
| 157 | + ]); |
|
| 158 | + } |
|
| 159 | + } else { |
|
| 160 | + throw new \InvalidArgumentException(); |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + return $event; |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * @param IEvent $event |
|
| 168 | + */ |
|
| 169 | + protected function parseMessage(IEvent $event) { |
|
| 170 | + $messageParameters = $event->getMessageParameters(); |
|
| 171 | + try { |
|
| 172 | + $comment = $this->commentsManager->get((int) $messageParameters[0]); |
|
| 173 | + $message = $comment->getMessage(); |
|
| 174 | + $message = str_replace("\n", '<br />', str_replace(['<', '>'], ['<', '>'], $message)); |
|
| 175 | + |
|
| 176 | + $mentionCount = 1; |
|
| 177 | + $mentions = []; |
|
| 178 | + foreach ($comment->getMentions() as $mention) { |
|
| 179 | + if ($mention['type'] !== 'user') { |
|
| 180 | + continue; |
|
| 181 | + } |
|
| 182 | + |
|
| 183 | + $message = preg_replace( |
|
| 184 | + '/(^|\s)(' . '@' . $mention['id'] . ')(\b)/', |
|
| 185 | + //'${1}' . $this->regexSafeUser($mention['id'], $displayName) . '${3}', |
|
| 186 | + '${1}' . '{mention' . $mentionCount . '}' . '${3}', |
|
| 187 | + $message |
|
| 188 | + ); |
|
| 189 | + $mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']); |
|
| 190 | + $mentionCount++; |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + $event->setParsedMessage($comment->getMessage()) |
|
| 194 | + ->setRichMessage($message, $mentions); |
|
| 195 | + } catch (NotFoundException $e) { |
|
| 196 | + } |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * @param int $id |
|
| 201 | + * @param string $path |
|
| 202 | + * @return array |
|
| 203 | + */ |
|
| 204 | + protected function generateFileParameter($id, $path) { |
|
| 205 | + return [ |
|
| 206 | + 'type' => 'file', |
|
| 207 | + 'id' => $id, |
|
| 208 | + 'name' => basename($path), |
|
| 209 | + 'path' => trim($path, '/'), |
|
| 210 | + 'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]), |
|
| 211 | + ]; |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * @param string $uid |
|
| 216 | + * @return array |
|
| 217 | + */ |
|
| 218 | + protected function generateUserParameter($uid) { |
|
| 219 | + if (!isset($this->displayNames[$uid])) { |
|
| 220 | + $this->displayNames[$uid] = $this->getDisplayName($uid); |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + return [ |
|
| 224 | + 'type' => 'user', |
|
| 225 | + 'id' => $uid, |
|
| 226 | + 'name' => $this->displayNames[$uid], |
|
| 227 | + ]; |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + /** |
|
| 231 | + * @param string $uid |
|
| 232 | + * @return string |
|
| 233 | + */ |
|
| 234 | + protected function getDisplayName($uid) { |
|
| 235 | + $user = $this->userManager->get($uid); |
|
| 236 | + if ($user instanceof IUser) { |
|
| 237 | + return $user->getDisplayName(); |
|
| 238 | + } else { |
|
| 239 | + return $uid; |
|
| 240 | + } |
|
| 241 | + } |
|
| 242 | 242 | } |
@@ -181,12 +181,12 @@ |
||
| 181 | 181 | } |
| 182 | 182 | |
| 183 | 183 | $message = preg_replace( |
| 184 | - '/(^|\s)(' . '@' . $mention['id'] . ')(\b)/', |
|
| 184 | + '/(^|\s)('.'@'.$mention['id'].')(\b)/', |
|
| 185 | 185 | //'${1}' . $this->regexSafeUser($mention['id'], $displayName) . '${3}', |
| 186 | - '${1}' . '{mention' . $mentionCount . '}' . '${3}', |
|
| 186 | + '${1}'.'{mention'.$mentionCount.'}'.'${3}', |
|
| 187 | 187 | $message |
| 188 | 188 | ); |
| 189 | - $mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']); |
|
| 189 | + $mentions['mention'.$mentionCount] = $this->generateUserParameter($mention['id']); |
|
| 190 | 190 | $mentionCount++; |
| 191 | 191 | } |
| 192 | 192 | |
@@ -27,72 +27,72 @@ |
||
| 27 | 27 | |
| 28 | 28 | class Setting implements ISetting { |
| 29 | 29 | |
| 30 | - /** @var IL10N */ |
|
| 31 | - protected $l; |
|
| 30 | + /** @var IL10N */ |
|
| 31 | + protected $l; |
|
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @param IL10N $l |
|
| 35 | - */ |
|
| 36 | - public function __construct(IL10N $l) { |
|
| 37 | - $this->l = $l; |
|
| 38 | - } |
|
| 33 | + /** |
|
| 34 | + * @param IL10N $l |
|
| 35 | + */ |
|
| 36 | + public function __construct(IL10N $l) { |
|
| 37 | + $this->l = $l; |
|
| 38 | + } |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @return string Lowercase a-z and underscore only identifier |
|
| 42 | - * @since 11.0.0 |
|
| 43 | - */ |
|
| 44 | - public function getIdentifier() { |
|
| 45 | - return 'comments'; |
|
| 46 | - } |
|
| 40 | + /** |
|
| 41 | + * @return string Lowercase a-z and underscore only identifier |
|
| 42 | + * @since 11.0.0 |
|
| 43 | + */ |
|
| 44 | + public function getIdentifier() { |
|
| 45 | + return 'comments'; |
|
| 46 | + } |
|
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * @return string A translated string |
|
| 50 | - * @since 11.0.0 |
|
| 51 | - */ |
|
| 52 | - public function getName() { |
|
| 53 | - return $this->l->t('<strong>Comments</strong> for files'); |
|
| 54 | - } |
|
| 48 | + /** |
|
| 49 | + * @return string A translated string |
|
| 50 | + * @since 11.0.0 |
|
| 51 | + */ |
|
| 52 | + public function getName() { |
|
| 53 | + return $this->l->t('<strong>Comments</strong> for files'); |
|
| 54 | + } |
|
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * @return int whether the filter should be rather on the top or bottom of |
|
| 58 | - * the admin section. The filters are arranged in ascending order of the |
|
| 59 | - * priority values. It is required to return a value between 0 and 100. |
|
| 60 | - * @since 11.0.0 |
|
| 61 | - */ |
|
| 62 | - public function getPriority() { |
|
| 63 | - return 50; |
|
| 64 | - } |
|
| 56 | + /** |
|
| 57 | + * @return int whether the filter should be rather on the top or bottom of |
|
| 58 | + * the admin section. The filters are arranged in ascending order of the |
|
| 59 | + * priority values. It is required to return a value between 0 and 100. |
|
| 60 | + * @since 11.0.0 |
|
| 61 | + */ |
|
| 62 | + public function getPriority() { |
|
| 63 | + return 50; |
|
| 64 | + } |
|
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * @return bool True when the option can be changed for the stream |
|
| 68 | - * @since 11.0.0 |
|
| 69 | - */ |
|
| 70 | - public function canChangeStream() { |
|
| 71 | - return true; |
|
| 72 | - } |
|
| 66 | + /** |
|
| 67 | + * @return bool True when the option can be changed for the stream |
|
| 68 | + * @since 11.0.0 |
|
| 69 | + */ |
|
| 70 | + public function canChangeStream() { |
|
| 71 | + return true; |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * @return bool True when the option can be changed for the stream |
|
| 76 | - * @since 11.0.0 |
|
| 77 | - */ |
|
| 78 | - public function isDefaultEnabledStream() { |
|
| 79 | - return true; |
|
| 80 | - } |
|
| 74 | + /** |
|
| 75 | + * @return bool True when the option can be changed for the stream |
|
| 76 | + * @since 11.0.0 |
|
| 77 | + */ |
|
| 78 | + public function isDefaultEnabledStream() { |
|
| 79 | + return true; |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * @return bool True when the option can be changed for the mail |
|
| 84 | - * @since 11.0.0 |
|
| 85 | - */ |
|
| 86 | - public function canChangeMail() { |
|
| 87 | - return true; |
|
| 88 | - } |
|
| 82 | + /** |
|
| 83 | + * @return bool True when the option can be changed for the mail |
|
| 84 | + * @since 11.0.0 |
|
| 85 | + */ |
|
| 86 | + public function canChangeMail() { |
|
| 87 | + return true; |
|
| 88 | + } |
|
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * @return bool True when the option can be changed for the stream |
|
| 92 | - * @since 11.0.0 |
|
| 93 | - */ |
|
| 94 | - public function isDefaultEnabledMail() { |
|
| 95 | - return false; |
|
| 96 | - } |
|
| 90 | + /** |
|
| 91 | + * @return bool True when the option can be changed for the stream |
|
| 92 | + * @since 11.0.0 |
|
| 93 | + */ |
|
| 94 | + public function isDefaultEnabledMail() { |
|
| 95 | + return false; |
|
| 96 | + } |
|
| 97 | 97 | } |
| 98 | 98 | |
@@ -28,63 +28,63 @@ |
||
| 28 | 28 | |
| 29 | 29 | class Filter implements IFilter { |
| 30 | 30 | |
| 31 | - /** @var IL10N */ |
|
| 32 | - protected $l; |
|
| 31 | + /** @var IL10N */ |
|
| 32 | + protected $l; |
|
| 33 | 33 | |
| 34 | - /** @var IURLGenerator */ |
|
| 35 | - protected $url; |
|
| 34 | + /** @var IURLGenerator */ |
|
| 35 | + protected $url; |
|
| 36 | 36 | |
| 37 | - public function __construct(IL10N $l, IURLGenerator $url) { |
|
| 38 | - $this->l = $l; |
|
| 39 | - $this->url = $url; |
|
| 40 | - } |
|
| 37 | + public function __construct(IL10N $l, IURLGenerator $url) { |
|
| 38 | + $this->l = $l; |
|
| 39 | + $this->url = $url; |
|
| 40 | + } |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @return string Lowercase a-z only identifier |
|
| 44 | - * @since 11.0.0 |
|
| 45 | - */ |
|
| 46 | - public function getIdentifier() { |
|
| 47 | - return 'comments'; |
|
| 48 | - } |
|
| 42 | + /** |
|
| 43 | + * @return string Lowercase a-z only identifier |
|
| 44 | + * @since 11.0.0 |
|
| 45 | + */ |
|
| 46 | + public function getIdentifier() { |
|
| 47 | + return 'comments'; |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @return string A translated string |
|
| 52 | - * @since 11.0.0 |
|
| 53 | - */ |
|
| 54 | - public function getName() { |
|
| 55 | - return $this->l->t('Comments'); |
|
| 56 | - } |
|
| 50 | + /** |
|
| 51 | + * @return string A translated string |
|
| 52 | + * @since 11.0.0 |
|
| 53 | + */ |
|
| 54 | + public function getName() { |
|
| 55 | + return $this->l->t('Comments'); |
|
| 56 | + } |
|
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * @return int |
|
| 60 | - * @since 11.0.0 |
|
| 61 | - */ |
|
| 62 | - public function getPriority() { |
|
| 63 | - return 40; |
|
| 64 | - } |
|
| 58 | + /** |
|
| 59 | + * @return int |
|
| 60 | + * @since 11.0.0 |
|
| 61 | + */ |
|
| 62 | + public function getPriority() { |
|
| 63 | + return 40; |
|
| 64 | + } |
|
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * @return string Full URL to an icon, empty string when none is given |
|
| 68 | - * @since 11.0.0 |
|
| 69 | - */ |
|
| 70 | - public function getIcon() { |
|
| 71 | - return $this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')); |
|
| 72 | - } |
|
| 66 | + /** |
|
| 67 | + * @return string Full URL to an icon, empty string when none is given |
|
| 68 | + * @since 11.0.0 |
|
| 69 | + */ |
|
| 70 | + public function getIcon() { |
|
| 71 | + return $this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')); |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * @param string[] $types |
|
| 76 | - * @return string[] An array of allowed apps from which activities should be displayed |
|
| 77 | - * @since 11.0.0 |
|
| 78 | - */ |
|
| 79 | - public function filterTypes(array $types) { |
|
| 80 | - return $types; |
|
| 81 | - } |
|
| 74 | + /** |
|
| 75 | + * @param string[] $types |
|
| 76 | + * @return string[] An array of allowed apps from which activities should be displayed |
|
| 77 | + * @since 11.0.0 |
|
| 78 | + */ |
|
| 79 | + public function filterTypes(array $types) { |
|
| 80 | + return $types; |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * @return string[] An array of allowed apps from which activities should be displayed |
|
| 85 | - * @since 11.0.0 |
|
| 86 | - */ |
|
| 87 | - public function allowedApps() { |
|
| 88 | - return ['comments']; |
|
| 89 | - } |
|
| 83 | + /** |
|
| 84 | + * @return string[] An array of allowed apps from which activities should be displayed |
|
| 85 | + * @since 11.0.0 |
|
| 86 | + */ |
|
| 87 | + public function allowedApps() { |
|
| 88 | + return ['comments']; |
|
| 89 | + } |
|
| 90 | 90 | } |
@@ -27,93 +27,93 @@ |
||
| 27 | 27 | use OCP\Notification\IManager; |
| 28 | 28 | |
| 29 | 29 | class Listener { |
| 30 | - /** @var IManager */ |
|
| 31 | - protected $notificationManager; |
|
| 30 | + /** @var IManager */ |
|
| 31 | + protected $notificationManager; |
|
| 32 | 32 | |
| 33 | - /** @var IUserManager */ |
|
| 34 | - protected $userManager; |
|
| 33 | + /** @var IUserManager */ |
|
| 34 | + protected $userManager; |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Listener constructor. |
|
| 38 | - * |
|
| 39 | - * @param IManager $notificationManager |
|
| 40 | - * @param IUserManager $userManager |
|
| 41 | - */ |
|
| 42 | - public function __construct( |
|
| 43 | - IManager $notificationManager, |
|
| 44 | - IUserManager $userManager |
|
| 45 | - ) { |
|
| 36 | + /** |
|
| 37 | + * Listener constructor. |
|
| 38 | + * |
|
| 39 | + * @param IManager $notificationManager |
|
| 40 | + * @param IUserManager $userManager |
|
| 41 | + */ |
|
| 42 | + public function __construct( |
|
| 43 | + IManager $notificationManager, |
|
| 44 | + IUserManager $userManager |
|
| 45 | + ) { |
|
| 46 | 46 | |
| 47 | - $this->notificationManager = $notificationManager; |
|
| 48 | - $this->userManager = $userManager; |
|
| 49 | - } |
|
| 47 | + $this->notificationManager = $notificationManager; |
|
| 48 | + $this->userManager = $userManager; |
|
| 49 | + } |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @param CommentsEvent $event |
|
| 53 | - */ |
|
| 54 | - public function evaluate(CommentsEvent $event) { |
|
| 55 | - $comment = $event->getComment(); |
|
| 51 | + /** |
|
| 52 | + * @param CommentsEvent $event |
|
| 53 | + */ |
|
| 54 | + public function evaluate(CommentsEvent $event) { |
|
| 55 | + $comment = $event->getComment(); |
|
| 56 | 56 | |
| 57 | - $mentions = $this->extractMentions($comment->getMentions()); |
|
| 58 | - if(empty($mentions)) { |
|
| 59 | - // no one to notify |
|
| 60 | - return; |
|
| 61 | - } |
|
| 57 | + $mentions = $this->extractMentions($comment->getMentions()); |
|
| 58 | + if(empty($mentions)) { |
|
| 59 | + // no one to notify |
|
| 60 | + return; |
|
| 61 | + } |
|
| 62 | 62 | |
| 63 | - $notification = $this->instantiateNotification($comment); |
|
| 63 | + $notification = $this->instantiateNotification($comment); |
|
| 64 | 64 | |
| 65 | - foreach($mentions as $uid) { |
|
| 66 | - if( ($comment->getActorType() === 'users' && $uid === $comment->getActorId()) |
|
| 67 | - || !$this->userManager->userExists($uid) |
|
| 68 | - ) { |
|
| 69 | - // do not notify unknown users or yourself |
|
| 70 | - continue; |
|
| 71 | - } |
|
| 65 | + foreach($mentions as $uid) { |
|
| 66 | + if( ($comment->getActorType() === 'users' && $uid === $comment->getActorId()) |
|
| 67 | + || !$this->userManager->userExists($uid) |
|
| 68 | + ) { |
|
| 69 | + // do not notify unknown users or yourself |
|
| 70 | + continue; |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | - $notification->setUser($uid); |
|
| 74 | - if( $event->getEvent() === CommentsEvent::EVENT_DELETE |
|
| 75 | - || $event->getEvent() === CommentsEvent::EVENT_PRE_UPDATE) |
|
| 76 | - { |
|
| 77 | - $this->notificationManager->markProcessed($notification); |
|
| 78 | - } else { |
|
| 79 | - $this->notificationManager->notify($notification); |
|
| 80 | - } |
|
| 81 | - } |
|
| 82 | - } |
|
| 73 | + $notification->setUser($uid); |
|
| 74 | + if( $event->getEvent() === CommentsEvent::EVENT_DELETE |
|
| 75 | + || $event->getEvent() === CommentsEvent::EVENT_PRE_UPDATE) |
|
| 76 | + { |
|
| 77 | + $this->notificationManager->markProcessed($notification); |
|
| 78 | + } else { |
|
| 79 | + $this->notificationManager->notify($notification); |
|
| 80 | + } |
|
| 81 | + } |
|
| 82 | + } |
|
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * creates a notification instance and fills it with comment data |
|
| 86 | - * |
|
| 87 | - * @param IComment $comment |
|
| 88 | - * @return \OCP\Notification\INotification |
|
| 89 | - */ |
|
| 90 | - public function instantiateNotification(IComment $comment) { |
|
| 91 | - $notification = $this->notificationManager->createNotification(); |
|
| 92 | - $notification |
|
| 93 | - ->setApp('comments') |
|
| 94 | - ->setObject('comment', $comment->getId()) |
|
| 95 | - ->setSubject('mention', [ $comment->getObjectType(), $comment->getObjectId() ]) |
|
| 96 | - ->setDateTime($comment->getCreationDateTime()); |
|
| 84 | + /** |
|
| 85 | + * creates a notification instance and fills it with comment data |
|
| 86 | + * |
|
| 87 | + * @param IComment $comment |
|
| 88 | + * @return \OCP\Notification\INotification |
|
| 89 | + */ |
|
| 90 | + public function instantiateNotification(IComment $comment) { |
|
| 91 | + $notification = $this->notificationManager->createNotification(); |
|
| 92 | + $notification |
|
| 93 | + ->setApp('comments') |
|
| 94 | + ->setObject('comment', $comment->getId()) |
|
| 95 | + ->setSubject('mention', [ $comment->getObjectType(), $comment->getObjectId() ]) |
|
| 96 | + ->setDateTime($comment->getCreationDateTime()); |
|
| 97 | 97 | |
| 98 | - return $notification; |
|
| 99 | - } |
|
| 98 | + return $notification; |
|
| 99 | + } |
|
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * flattens the mention array returned from comments to a list of user ids. |
|
| 103 | - * |
|
| 104 | - * @param array $mentions |
|
| 105 | - * @return string[] containing the mentions, e.g. ['alice', 'bob'] |
|
| 106 | - */ |
|
| 107 | - public function extractMentions(array $mentions) { |
|
| 108 | - if(empty($mentions)) { |
|
| 109 | - return []; |
|
| 110 | - } |
|
| 111 | - $uids = []; |
|
| 112 | - foreach($mentions as $mention) { |
|
| 113 | - if($mention['type'] === 'user') { |
|
| 114 | - $uids[] = $mention['id']; |
|
| 115 | - } |
|
| 116 | - } |
|
| 117 | - return $uids; |
|
| 118 | - } |
|
| 101 | + /** |
|
| 102 | + * flattens the mention array returned from comments to a list of user ids. |
|
| 103 | + * |
|
| 104 | + * @param array $mentions |
|
| 105 | + * @return string[] containing the mentions, e.g. ['alice', 'bob'] |
|
| 106 | + */ |
|
| 107 | + public function extractMentions(array $mentions) { |
|
| 108 | + if(empty($mentions)) { |
|
| 109 | + return []; |
|
| 110 | + } |
|
| 111 | + $uids = []; |
|
| 112 | + foreach($mentions as $mention) { |
|
| 113 | + if($mention['type'] === 'user') { |
|
| 114 | + $uids[] = $mention['id']; |
|
| 115 | + } |
|
| 116 | + } |
|
| 117 | + return $uids; |
|
| 118 | + } |
|
| 119 | 119 | } |
@@ -55,15 +55,15 @@ discard block |
||
| 55 | 55 | $comment = $event->getComment(); |
| 56 | 56 | |
| 57 | 57 | $mentions = $this->extractMentions($comment->getMentions()); |
| 58 | - if(empty($mentions)) { |
|
| 58 | + if (empty($mentions)) { |
|
| 59 | 59 | // no one to notify |
| 60 | 60 | return; |
| 61 | 61 | } |
| 62 | 62 | |
| 63 | 63 | $notification = $this->instantiateNotification($comment); |
| 64 | 64 | |
| 65 | - foreach($mentions as $uid) { |
|
| 66 | - if( ($comment->getActorType() === 'users' && $uid === $comment->getActorId()) |
|
| 65 | + foreach ($mentions as $uid) { |
|
| 66 | + if (($comment->getActorType() === 'users' && $uid === $comment->getActorId()) |
|
| 67 | 67 | || !$this->userManager->userExists($uid) |
| 68 | 68 | ) { |
| 69 | 69 | // do not notify unknown users or yourself |
@@ -71,7 +71,7 @@ discard block |
||
| 71 | 71 | } |
| 72 | 72 | |
| 73 | 73 | $notification->setUser($uid); |
| 74 | - if( $event->getEvent() === CommentsEvent::EVENT_DELETE |
|
| 74 | + if ($event->getEvent() === CommentsEvent::EVENT_DELETE |
|
| 75 | 75 | || $event->getEvent() === CommentsEvent::EVENT_PRE_UPDATE) |
| 76 | 76 | { |
| 77 | 77 | $this->notificationManager->markProcessed($notification); |
@@ -92,7 +92,7 @@ discard block |
||
| 92 | 92 | $notification |
| 93 | 93 | ->setApp('comments') |
| 94 | 94 | ->setObject('comment', $comment->getId()) |
| 95 | - ->setSubject('mention', [ $comment->getObjectType(), $comment->getObjectId() ]) |
|
| 95 | + ->setSubject('mention', [$comment->getObjectType(), $comment->getObjectId()]) |
|
| 96 | 96 | ->setDateTime($comment->getCreationDateTime()); |
| 97 | 97 | |
| 98 | 98 | return $notification; |
@@ -105,12 +105,12 @@ discard block |
||
| 105 | 105 | * @return string[] containing the mentions, e.g. ['alice', 'bob'] |
| 106 | 106 | */ |
| 107 | 107 | public function extractMentions(array $mentions) { |
| 108 | - if(empty($mentions)) { |
|
| 108 | + if (empty($mentions)) { |
|
| 109 | 109 | return []; |
| 110 | 110 | } |
| 111 | 111 | $uids = []; |
| 112 | - foreach($mentions as $mention) { |
|
| 113 | - if($mention['type'] === 'user') { |
|
| 112 | + foreach ($mentions as $mention) { |
|
| 113 | + if ($mention['type'] === 'user') { |
|
| 114 | 114 | $uids[] = $mention['id']; |
| 115 | 115 | } |
| 116 | 116 | } |
@@ -40,95 +40,95 @@ |
||
| 40 | 40 | * @package OCA\Comments\Controller |
| 41 | 41 | */ |
| 42 | 42 | class Notifications extends Controller { |
| 43 | - /** @var Folder */ |
|
| 44 | - protected $folder; |
|
| 43 | + /** @var Folder */ |
|
| 44 | + protected $folder; |
|
| 45 | 45 | |
| 46 | - /** @var ICommentsManager */ |
|
| 47 | - protected $commentsManager; |
|
| 46 | + /** @var ICommentsManager */ |
|
| 47 | + protected $commentsManager; |
|
| 48 | 48 | |
| 49 | - /** @var IURLGenerator */ |
|
| 50 | - protected $urlGenerator; |
|
| 49 | + /** @var IURLGenerator */ |
|
| 50 | + protected $urlGenerator; |
|
| 51 | 51 | |
| 52 | - /** @var IManager */ |
|
| 53 | - protected $notificationManager; |
|
| 52 | + /** @var IManager */ |
|
| 53 | + protected $notificationManager; |
|
| 54 | 54 | |
| 55 | - /** @var IUserSession */ |
|
| 56 | - protected $userSession; |
|
| 55 | + /** @var IUserSession */ |
|
| 56 | + protected $userSession; |
|
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Notifications constructor. |
|
| 60 | - * |
|
| 61 | - * @param string $appName |
|
| 62 | - * @param IRequest $request |
|
| 63 | - * @param ICommentsManager $commentsManager |
|
| 64 | - * @param Folder $folder |
|
| 65 | - * @param IURLGenerator $urlGenerator |
|
| 66 | - * @param IManager $notificationManager |
|
| 67 | - * @param IUserSession $userSession |
|
| 68 | - */ |
|
| 69 | - public function __construct( |
|
| 70 | - $appName, |
|
| 71 | - IRequest $request, |
|
| 72 | - ICommentsManager $commentsManager, |
|
| 73 | - Folder $folder, |
|
| 74 | - IURLGenerator $urlGenerator, |
|
| 75 | - IManager $notificationManager, |
|
| 76 | - IUserSession $userSession |
|
| 77 | - ) { |
|
| 78 | - parent::__construct($appName, $request); |
|
| 79 | - $this->commentsManager = $commentsManager; |
|
| 80 | - $this->folder = $folder; |
|
| 81 | - $this->urlGenerator = $urlGenerator; |
|
| 82 | - $this->notificationManager = $notificationManager; |
|
| 83 | - $this->userSession = $userSession; |
|
| 84 | - } |
|
| 58 | + /** |
|
| 59 | + * Notifications constructor. |
|
| 60 | + * |
|
| 61 | + * @param string $appName |
|
| 62 | + * @param IRequest $request |
|
| 63 | + * @param ICommentsManager $commentsManager |
|
| 64 | + * @param Folder $folder |
|
| 65 | + * @param IURLGenerator $urlGenerator |
|
| 66 | + * @param IManager $notificationManager |
|
| 67 | + * @param IUserSession $userSession |
|
| 68 | + */ |
|
| 69 | + public function __construct( |
|
| 70 | + $appName, |
|
| 71 | + IRequest $request, |
|
| 72 | + ICommentsManager $commentsManager, |
|
| 73 | + Folder $folder, |
|
| 74 | + IURLGenerator $urlGenerator, |
|
| 75 | + IManager $notificationManager, |
|
| 76 | + IUserSession $userSession |
|
| 77 | + ) { |
|
| 78 | + parent::__construct($appName, $request); |
|
| 79 | + $this->commentsManager = $commentsManager; |
|
| 80 | + $this->folder = $folder; |
|
| 81 | + $this->urlGenerator = $urlGenerator; |
|
| 82 | + $this->notificationManager = $notificationManager; |
|
| 83 | + $this->userSession = $userSession; |
|
| 84 | + } |
|
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * @NoAdminRequired |
|
| 88 | - * @NoCSRFRequired |
|
| 89 | - * |
|
| 90 | - * @param string $id the comment ID |
|
| 91 | - * @return Response |
|
| 92 | - */ |
|
| 93 | - public function view($id) { |
|
| 94 | - try { |
|
| 95 | - $comment = $this->commentsManager->get($id); |
|
| 96 | - if($comment->getObjectType() !== 'files') { |
|
| 97 | - return new NotFoundResponse(); |
|
| 98 | - } |
|
| 99 | - $files = $this->folder->getById($comment->getObjectId()); |
|
| 100 | - if(count($files) === 0) { |
|
| 101 | - $this->markProcessed($comment); |
|
| 102 | - return new NotFoundResponse(); |
|
| 103 | - } |
|
| 86 | + /** |
|
| 87 | + * @NoAdminRequired |
|
| 88 | + * @NoCSRFRequired |
|
| 89 | + * |
|
| 90 | + * @param string $id the comment ID |
|
| 91 | + * @return Response |
|
| 92 | + */ |
|
| 93 | + public function view($id) { |
|
| 94 | + try { |
|
| 95 | + $comment = $this->commentsManager->get($id); |
|
| 96 | + if($comment->getObjectType() !== 'files') { |
|
| 97 | + return new NotFoundResponse(); |
|
| 98 | + } |
|
| 99 | + $files = $this->folder->getById($comment->getObjectId()); |
|
| 100 | + if(count($files) === 0) { |
|
| 101 | + $this->markProcessed($comment); |
|
| 102 | + return new NotFoundResponse(); |
|
| 103 | + } |
|
| 104 | 104 | |
| 105 | - $url = $this->urlGenerator->linkToRouteAbsolute( |
|
| 106 | - 'files.viewcontroller.showFile', |
|
| 107 | - [ 'fileid' => $comment->getObjectId() ] |
|
| 108 | - ); |
|
| 105 | + $url = $this->urlGenerator->linkToRouteAbsolute( |
|
| 106 | + 'files.viewcontroller.showFile', |
|
| 107 | + [ 'fileid' => $comment->getObjectId() ] |
|
| 108 | + ); |
|
| 109 | 109 | |
| 110 | - $this->markProcessed($comment); |
|
| 110 | + $this->markProcessed($comment); |
|
| 111 | 111 | |
| 112 | - return new RedirectResponse($url); |
|
| 113 | - } catch (\Exception $e) { |
|
| 114 | - return new NotFoundResponse(); |
|
| 115 | - } |
|
| 116 | - } |
|
| 112 | + return new RedirectResponse($url); |
|
| 113 | + } catch (\Exception $e) { |
|
| 114 | + return new NotFoundResponse(); |
|
| 115 | + } |
|
| 116 | + } |
|
| 117 | 117 | |
| 118 | - /** |
|
| 119 | - * Marks the notification about a comment as processed |
|
| 120 | - * @param IComment $comment |
|
| 121 | - */ |
|
| 122 | - protected function markProcessed(IComment $comment) { |
|
| 123 | - $user = $this->userSession->getUser(); |
|
| 124 | - if(is_null($user)) { |
|
| 125 | - return; |
|
| 126 | - } |
|
| 127 | - $notification = $this->notificationManager->createNotification(); |
|
| 128 | - $notification->setApp('comments') |
|
| 129 | - ->setObject('comment', $comment->getId()) |
|
| 130 | - ->setSubject('mention') |
|
| 131 | - ->setUser($user->getUID()); |
|
| 132 | - $this->notificationManager->markProcessed($notification); |
|
| 133 | - } |
|
| 118 | + /** |
|
| 119 | + * Marks the notification about a comment as processed |
|
| 120 | + * @param IComment $comment |
|
| 121 | + */ |
|
| 122 | + protected function markProcessed(IComment $comment) { |
|
| 123 | + $user = $this->userSession->getUser(); |
|
| 124 | + if(is_null($user)) { |
|
| 125 | + return; |
|
| 126 | + } |
|
| 127 | + $notification = $this->notificationManager->createNotification(); |
|
| 128 | + $notification->setApp('comments') |
|
| 129 | + ->setObject('comment', $comment->getId()) |
|
| 130 | + ->setSubject('mention') |
|
| 131 | + ->setUser($user->getUID()); |
|
| 132 | + $this->notificationManager->markProcessed($notification); |
|
| 133 | + } |
|
| 134 | 134 | } |
@@ -93,18 +93,18 @@ discard block |
||
| 93 | 93 | public function view($id) { |
| 94 | 94 | try { |
| 95 | 95 | $comment = $this->commentsManager->get($id); |
| 96 | - if($comment->getObjectType() !== 'files') { |
|
| 96 | + if ($comment->getObjectType() !== 'files') { |
|
| 97 | 97 | return new NotFoundResponse(); |
| 98 | 98 | } |
| 99 | 99 | $files = $this->folder->getById($comment->getObjectId()); |
| 100 | - if(count($files) === 0) { |
|
| 100 | + if (count($files) === 0) { |
|
| 101 | 101 | $this->markProcessed($comment); |
| 102 | 102 | return new NotFoundResponse(); |
| 103 | 103 | } |
| 104 | 104 | |
| 105 | 105 | $url = $this->urlGenerator->linkToRouteAbsolute( |
| 106 | 106 | 'files.viewcontroller.showFile', |
| 107 | - [ 'fileid' => $comment->getObjectId() ] |
|
| 107 | + ['fileid' => $comment->getObjectId()] |
|
| 108 | 108 | ); |
| 109 | 109 | |
| 110 | 110 | $this->markProcessed($comment); |
@@ -121,7 +121,7 @@ discard block |
||
| 121 | 121 | */ |
| 122 | 122 | protected function markProcessed(IComment $comment) { |
| 123 | 123 | $user = $this->userSession->getUser(); |
| 124 | - if(is_null($user)) { |
|
| 124 | + if (is_null($user)) { |
|
| 125 | 125 | return; |
| 126 | 126 | } |
| 127 | 127 | $notification = $this->notificationManager->createNotification(); |