nextcloud / server

apps/encryption/lib/Crypto/Crypt.php

Indentation +697 added lines, -697 removed lines

@@ -56,701 +56,701 @@
  * @package OCA\Encryption\Crypto
  */
 class Crypt {
-	public const SUPPORTED_CIPHERS_AND_KEY_SIZE = [
-		'AES-256-CTR' => 32,
-		'AES-128-CTR' => 16,
-		'AES-256-CFB' => 32,
-		'AES-128-CFB' => 16,
-	];
-	// one out of SUPPORTED_CIPHERS_AND_KEY_SIZE
-	public const DEFAULT_CIPHER = 'AES-256-CTR';
-	// default cipher from old Nextcloud versions
-	public const LEGACY_CIPHER = 'AES-128-CFB';
-
-	public const SUPPORTED_KEY_FORMATS = ['hash', 'password'];
-	// one out of SUPPORTED_KEY_FORMATS
-	public const DEFAULT_KEY_FORMAT = 'hash';
-	// default key format, old Nextcloud version encrypted the private key directly
-	// with the user password
-	public const LEGACY_KEY_FORMAT = 'password';
-
-	public const HEADER_START = 'HBEGIN';
-	public const HEADER_END = 'HEND';
-
-	// default encoding format, old Nextcloud versions used base64
-	public const BINARY_ENCODING_FORMAT = 'binary';
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var string */
-	private $user;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var IL10N */
-	private $l;
-
-	/** @var string|null */
-	private $currentCipher;
-
-	/** @var bool */
-	private $supportLegacy;
-
-	/**
-	 * Use the legacy base64 encoding instead of the more space-efficient binary encoding.
-	 */
-	private bool $useLegacyBase64Encoding;
-
-	/**
-	 * @param ILogger $logger
-	 * @param IUserSession $userSession
-	 * @param IConfig $config
-	 * @param IL10N $l
-	 */
-	public function __construct(ILogger $logger, IUserSession $userSession, IConfig $config, IL10N $l) {
-		$this->logger = $logger;
-		$this->user = $userSession && $userSession->isLoggedIn() ? $userSession->getUser()->getUID() : '"no user given"';
-		$this->config = $config;
-		$this->l = $l;
-		$this->supportLegacy = $this->config->getSystemValueBool('encryption.legacy_format_support', false);
-		$this->useLegacyBase64Encoding = $this->config->getSystemValueBool('encryption.use_legacy_base64_encoding', false);
-	}
-
-	/**
-	 * create new private/public key-pair for user
-	 *
-	 * @return array|bool
-	 */
-	public function createKeyPair() {
-		$log = $this->logger;
-		$res = $this->getOpenSSLPKey();
-
-		if (!$res) {
-			$log->error("Encryption Library couldn't generate users key-pair for {$this->user}",
-				['app' => 'encryption']);
-
-			if (openssl_error_string()) {
-				$log->error('Encryption library openssl_pkey_new() fails: ' . openssl_error_string(),
-					['app' => 'encryption']);
-			}
-		} elseif (openssl_pkey_export($res,
-			$privateKey,
-			null,
-			$this->getOpenSSLConfig())) {
-			$keyDetails = openssl_pkey_get_details($res);
-			$publicKey = $keyDetails['key'];
-
-			return [
-				'publicKey' => $publicKey,
-				'privateKey' => $privateKey
-			];
-		}
-		$log->error('Encryption library couldn\'t export users private key, please check your servers OpenSSL configuration.' . $this->user,
-			['app' => 'encryption']);
-		if (openssl_error_string()) {
-			$log->error('Encryption Library:' . openssl_error_string(),
-				['app' => 'encryption']);
-		}
-
-		return false;
-	}
-
-	/**
-	 * Generates a new private key
-	 *
-	 * @return resource
-	 */
-	public function getOpenSSLPKey() {
-		$config = $this->getOpenSSLConfig();
-		return openssl_pkey_new($config);
-	}
-
-	/**
-	 * get openSSL Config
-	 *
-	 * @return array
-	 */
-	private function getOpenSSLConfig() {
-		$config = ['private_key_bits' => 4096];
-		$config = array_merge(
-			$config,
-			$this->config->getSystemValue('openssl', [])
-		);
-		return $config;
-	}
-
-	/**
-	 * @param string $plainContent
-	 * @param string $passPhrase
-	 * @param int $version
-	 * @param int $position
-	 * @return false|string
-	 * @throws EncryptionFailedException
-	 */
-	public function symmetricEncryptFileContent($plainContent, $passPhrase, $version, $position) {
-		if (!$plainContent) {
-			$this->logger->error('Encryption Library, symmetrical encryption failed no content given',
-				['app' => 'encryption']);
-			return false;
-		}
-
-		$iv = $this->generateIv();
-
-		$encryptedContent = $this->encrypt($plainContent,
-			$iv,
-			$passPhrase,
-			$this->getCipher());
-
-		// Create a signature based on the key as well as the current version
-		$sig = $this->createSignature($encryptedContent, $passPhrase.'_'.$version.'_'.$position);
-
-		// combine content to encrypt the IV identifier and actual IV
-		$catFile = $this->concatIV($encryptedContent, $iv);
-		$catFile = $this->concatSig($catFile, $sig);
-		return $this->addPadding($catFile);
-	}
-
-	/**
-	 * generate header for encrypted file
-	 *
-	 * @param string $keyFormat see SUPPORTED_KEY_FORMATS
-	 * @return string
-	 * @throws \InvalidArgumentException
-	 */
-	public function generateHeader($keyFormat = self::DEFAULT_KEY_FORMAT) {
-		if (in_array($keyFormat, self::SUPPORTED_KEY_FORMATS, true) === false) {
-			throw new \InvalidArgumentException('key format "' . $keyFormat . '" is not supported');
-		}
-
-		$header = self::HEADER_START
-			. ':cipher:' . $this->getCipher()
-			. ':keyFormat:' . $keyFormat;
-
-		if ($this->useLegacyBase64Encoding !== true) {
-			$header .= ':encoding:' . self::BINARY_ENCODING_FORMAT;
-		}
-
-		$header .= ':' . self::HEADER_END;
-
-		return $header;
-	}
-
-	/**
-	 * @param string $plainContent
-	 * @param string $iv
-	 * @param string $passPhrase
-	 * @param string $cipher
-	 * @return string
-	 * @throws EncryptionFailedException
-	 */
-	private function encrypt($plainContent, $iv, $passPhrase = '', $cipher = self::DEFAULT_CIPHER) {
-		$options = $this->useLegacyBase64Encoding ? 0 : OPENSSL_RAW_DATA;
-		$encryptedContent = openssl_encrypt($plainContent,
-			$cipher,
-			$passPhrase,
-			$options,
-			$iv);
-
-		if (!$encryptedContent) {
-			$error = 'Encryption (symmetric) of content failed';
-			$this->logger->error($error . openssl_error_string(),
-				['app' => 'encryption']);
-			throw new EncryptionFailedException($error);
-		}
-
-		return $encryptedContent;
-	}
-
-	/**
-	 * return cipher either from config.php or the default cipher defined in
-	 * this class
-	 *
-	 * @return string
-	 */
-	private function getCachedCipher() {
-		if (isset($this->currentCipher)) {
-			return $this->currentCipher;
-		}
-
-		// Get cipher either from config.php or the default cipher defined in this class
-		$cipher = $this->config->getSystemValueString('cipher', self::DEFAULT_CIPHER);
-		if (!isset(self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher])) {
-			$this->logger->warning(
-				sprintf(
-					'Unsupported cipher (%s) defined in config.php supported. Falling back to %s',
-					$cipher,
-					self::DEFAULT_CIPHER
-				),
-				['app' => 'encryption']
-			);
-			$cipher = self::DEFAULT_CIPHER;
-		}
-
-		// Remember current cipher to avoid frequent lookups
-		$this->currentCipher = $cipher;
-		return $this->currentCipher;
-	}
-
-	/**
-	 * return current encryption cipher
-	 *
-	 * @return string
-	 */
-	public function getCipher() {
-		return $this->getCachedCipher();
-	}
-
-	/**
-	 * get key size depending on the cipher
-	 *
-	 * @param string $cipher
-	 * @return int
-	 * @throws \InvalidArgumentException
-	 */
-	protected function getKeySize($cipher) {
-		if (isset(self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher])) {
-			return self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher];
-		}
-
-		throw new \InvalidArgumentException(
-			sprintf(
-					'Unsupported cipher (%s) defined.',
-					$cipher
-			)
-		);
-	}
-
-	/**
-	 * get legacy cipher
-	 *
-	 * @return string
-	 */
-	public function getLegacyCipher() {
-		if (!$this->supportLegacy) {
-			throw new ServerNotAvailableException('Legacy cipher is no longer supported!');
-		}
-
-		return self::LEGACY_CIPHER;
-	}
-
-	/**
-	 * @param string $encryptedContent
-	 * @param string $iv
-	 * @return string
-	 */
-	private function concatIV($encryptedContent, $iv) {
-		return $encryptedContent . '00iv00' . $iv;
-	}
-
-	/**
-	 * @param string $encryptedContent
-	 * @param string $signature
-	 * @return string
-	 */
-	private function concatSig($encryptedContent, $signature) {
-		return $encryptedContent . '00sig00' . $signature;
-	}
-
-	/**
-	 * Note: This is _NOT_ a padding used for encryption purposes. It is solely
-	 * used to achieve the PHP stream size. It has _NOTHING_ to do with the
-	 * encrypted content and is not used in any crypto primitive.
-	 *
-	 * @param string $data
-	 * @return string
-	 */
-	private function addPadding($data) {
-		return $data . 'xxx';
-	}
-
-	/**
-	 * generate password hash used to encrypt the users private key
-	 *
-	 * @param string $password
-	 * @param string $cipher
-	 * @param string $uid only used for user keys
-	 * @return string
-	 */
-	protected function generatePasswordHash($password, $cipher, $uid = '') {
-		$instanceId = $this->config->getSystemValue('instanceid');
-		$instanceSecret = $this->config->getSystemValue('secret');
-		$salt = hash('sha256', $uid . $instanceId . $instanceSecret, true);
-		$keySize = $this->getKeySize($cipher);
-
-		$hash = hash_pbkdf2(
-			'sha256',
-			$password,
-			$salt,
-			100000,
-			$keySize,
-			true
-		);
-
-		return $hash;
-	}
-
-	/**
-	 * encrypt private key
-	 *
-	 * @param string $privateKey
-	 * @param string $password
-	 * @param string $uid for regular users, empty for system keys
-	 * @return false|string
-	 */
-	public function encryptPrivateKey($privateKey, $password, $uid = '') {
-		$cipher = $this->getCipher();
-		$hash = $this->generatePasswordHash($password, $cipher, $uid);
-		$encryptedKey = $this->symmetricEncryptFileContent(
-			$privateKey,
-			$hash,
-			0,
-			0
-		);
-
-		return $encryptedKey;
-	}
-
-	/**
-	 * @param string $privateKey
-	 * @param string $password
-	 * @param string $uid for regular users, empty for system keys
-	 * @return false|string
-	 */
-	public function decryptPrivateKey($privateKey, $password = '', $uid = '') {
-		$header = $this->parseHeader($privateKey);
-
-		if (isset($header['cipher'])) {
-			$cipher = $header['cipher'];
-		} else {
-			$cipher = $this->getLegacyCipher();
-		}
-
-		if (isset($header['keyFormat'])) {
-			$keyFormat = $header['keyFormat'];
-		} else {
-			$keyFormat = self::LEGACY_KEY_FORMAT;
-		}
-
-		if ($keyFormat === self::DEFAULT_KEY_FORMAT) {
-			$password = $this->generatePasswordHash($password, $cipher, $uid);
-		}
-
-		$binaryEncoding = isset($header['encoding']) && $header['encoding'] === self::BINARY_ENCODING_FORMAT;
-
-		// If we found a header we need to remove it from the key we want to decrypt
-		if (!empty($header)) {
-			$privateKey = substr($privateKey,
-				strpos($privateKey,
-					self::HEADER_END) + strlen(self::HEADER_END));
-		}
-
-		$plainKey = $this->symmetricDecryptFileContent(
-			$privateKey,
-			$password,
-			$cipher,
-			0,
-			0,
-			$binaryEncoding
-		);
-
-		if ($this->isValidPrivateKey($plainKey) === false) {
-			return false;
-		}
-
-		return $plainKey;
-	}
-
-	/**
-	 * check if it is a valid private key
-	 *
-	 * @param string $plainKey
-	 * @return bool
-	 */
-	protected function isValidPrivateKey($plainKey) {
-		$res = openssl_get_privatekey($plainKey);
-		// TODO: remove resource check one php7.4 is not longer supported
-		if (is_resource($res) || (is_object($res) && get_class($res) === 'OpenSSLAsymmetricKey')) {
-			$sslInfo = openssl_pkey_get_details($res);
-			if (isset($sslInfo['key'])) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * @param string $keyFileContents
-	 * @param string $passPhrase
-	 * @param string $cipher
-	 * @param int $version
-	 * @param int|string $position
-	 * @param boolean $binaryEncoding
-	 * @return string
-	 * @throws DecryptionFailedException
-	 */
-	public function symmetricDecryptFileContent($keyFileContents, $passPhrase, $cipher = self::DEFAULT_CIPHER, $version = 0, $position = 0, bool $binaryEncoding = false) {
-		if ($keyFileContents == '') {
-			return '';
-		}
-
-		$catFile = $this->splitMetaData($keyFileContents, $cipher);
-
-		if ($catFile['signature'] !== false) {
-			try {
-				// First try the new format
-				$this->checkSignature($catFile['encrypted'], $passPhrase . '_' . $version . '_' . $position, $catFile['signature']);
-			} catch (GenericEncryptionException $e) {
-				// For compatibility with old files check the version without _
-				$this->checkSignature($catFile['encrypted'], $passPhrase . $version . $position, $catFile['signature']);
-			}
-		}
-
-		return $this->decrypt($catFile['encrypted'],
-			$catFile['iv'],
-			$passPhrase,
-			$cipher,
-			$binaryEncoding);
-	}
-
-	/**
-	 * check for valid signature
-	 *
-	 * @param string $data
-	 * @param string $passPhrase
-	 * @param string $expectedSignature
-	 * @throws GenericEncryptionException
-	 */
-	private function checkSignature($data, $passPhrase, $expectedSignature) {
-		$enforceSignature = !$this->config->getSystemValueBool('encryption_skip_signature_check', false);
-
-		$signature = $this->createSignature($data, $passPhrase);
-		$isCorrectHash = hash_equals($expectedSignature, $signature);
-
-		if (!$isCorrectHash && $enforceSignature) {
-			throw new GenericEncryptionException('Bad Signature', $this->l->t('Bad Signature'));
-		} elseif (!$isCorrectHash && !$enforceSignature) {
-			$this->logger->info("Signature check skipped", ['app' => 'encryption']);
-		}
-	}
-
-	/**
-	 * create signature
-	 *
-	 * @param string $data
-	 * @param string $passPhrase
-	 * @return string
-	 */
-	private function createSignature($data, $passPhrase) {
-		$passPhrase = hash('sha512', $passPhrase . 'a', true);
-		return hash_hmac('sha256', $data, $passPhrase);
-	}
-
-
-	/**
-	 * remove padding
-	 *
-	 * @param string $padded
-	 * @param bool $hasSignature did the block contain a signature, in this case we use a different padding
-	 * @return string|false
-	 */
-	private function removePadding($padded, $hasSignature = false) {
-		if ($hasSignature === false && substr($padded, -2) === 'xx') {
-			return substr($padded, 0, -2);
-		} elseif ($hasSignature === true && substr($padded, -3) === 'xxx') {
-			return substr($padded, 0, -3);
-		}
-		return false;
-	}
-
-	/**
-	 * split meta data from encrypted file
-	 * Note: for now, we assume that the meta data always start with the iv
-	 *       followed by the signature, if available
-	 *
-	 * @param string $catFile
-	 * @param string $cipher
-	 * @return array
-	 */
-	private function splitMetaData($catFile, $cipher) {
-		if ($this->hasSignature($catFile, $cipher)) {
-			$catFile = $this->removePadding($catFile, true);
-			$meta = substr($catFile, -93);
-			$iv = substr($meta, strlen('00iv00'), 16);
-			$sig = substr($meta, 22 + strlen('00sig00'));
-			$encrypted = substr($catFile, 0, -93);
-		} else {
-			$catFile = $this->removePadding($catFile);
-			$meta = substr($catFile, -22);
-			$iv = substr($meta, -16);
-			$sig = false;
-			$encrypted = substr($catFile, 0, -22);
-		}
-
-		return [
-			'encrypted' => $encrypted,
-			'iv' => $iv,
-			'signature' => $sig
-		];
-	}
-
-	/**
-	 * check if encrypted block is signed
-	 *
-	 * @param string $catFile
-	 * @param string $cipher
-	 * @return bool
-	 * @throws GenericEncryptionException
-	 */
-	private function hasSignature($catFile, $cipher) {
-		$skipSignatureCheck = $this->config->getSystemValueBool('encryption_skip_signature_check', false);
-
-		$meta = substr($catFile, -93);
-		$signaturePosition = strpos($meta, '00sig00');
-
-		// If we no longer support the legacy format then everything needs a signature
-		if (!$skipSignatureCheck && !$this->supportLegacy && $signaturePosition === false) {
-			throw new GenericEncryptionException('Missing Signature', $this->l->t('Missing Signature'));
-		}
-
-		// Enforce signature for the new 'CTR' ciphers
-		if (!$skipSignatureCheck && $signaturePosition === false && stripos($cipher, 'ctr') !== false) {
-			throw new GenericEncryptionException('Missing Signature', $this->l->t('Missing Signature'));
-		}
-
-		return ($signaturePosition !== false);
-	}
-
-
-	/**
-	 * @param string $encryptedContent
-	 * @param string $iv
-	 * @param string $passPhrase
-	 * @param string $cipher
-	 * @param boolean $binaryEncoding
-	 * @return string
-	 * @throws DecryptionFailedException
-	 */
-	private function decrypt(string $encryptedContent, string $iv, string $passPhrase = '', string $cipher = self::DEFAULT_CIPHER, bool $binaryEncoding = false): string {
-		$options = $binaryEncoding === true ? OPENSSL_RAW_DATA : 0;
-		$plainContent = openssl_decrypt($encryptedContent,
-			$cipher,
-			$passPhrase,
-			$options,
-			$iv);
-
-		if ($plainContent) {
-			return $plainContent;
-		} else {
-			throw new DecryptionFailedException('Encryption library: Decryption (symmetric) of content failed: ' . openssl_error_string());
-		}
-	}
-
-	/**
-	 * @param string $data
-	 * @return array
-	 */
-	protected function parseHeader($data) {
-		$result = [];
-
-		if (substr($data, 0, strlen(self::HEADER_START)) === self::HEADER_START) {
-			$endAt = strpos($data, self::HEADER_END);
-			$header = substr($data, 0, $endAt + strlen(self::HEADER_END));
-
-			// +1 not to start with an ':' which would result in empty element at the beginning
-			$exploded = explode(':',
-				substr($header, strlen(self::HEADER_START) + 1));
-
-			$element = array_shift($exploded);
-
-			while ($element !== self::HEADER_END) {
-				$result[$element] = array_shift($exploded);
-				$element = array_shift($exploded);
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * generate initialization vector
-	 *
-	 * @return string
-	 * @throws GenericEncryptionException
-	 */
-	private function generateIv() {
-		return random_bytes(16);
-	}
-
-	/**
-	 * Generate a cryptographically secure pseudo-random 256-bit ASCII key, used
-	 * as file key
-	 *
-	 * @return string
-	 * @throws \Exception
-	 */
-	public function generateFileKey() {
-		return random_bytes(32);
-	}
-
-	/**
-	 * @param $encKeyFile
-	 * @param $shareKey
-	 * @param $privateKey
-	 * @return string
-	 * @throws MultiKeyDecryptException
-	 */
-	public function multiKeyDecrypt($encKeyFile, $shareKey, $privateKey) {
-		if (!$encKeyFile) {
-			throw new MultiKeyDecryptException('Cannot multikey decrypt empty plain content');
-		}
-
-		if (openssl_open($encKeyFile, $plainContent, $shareKey, $privateKey, 'RC4')) {
-			return $plainContent;
-		} else {
-			throw new MultiKeyDecryptException('multikeydecrypt with share key failed:' . openssl_error_string());
-		}
-	}
-
-	/**
-	 * @param string $plainContent
-	 * @param array $keyFiles
-	 * @return array
-	 * @throws MultiKeyEncryptException
-	 */
-	public function multiKeyEncrypt($plainContent, array $keyFiles) {
-		// openssl_seal returns false without errors if plaincontent is empty
-		// so trigger our own error
-		if (empty($plainContent)) {
-			throw new MultiKeyEncryptException('Cannot multikeyencrypt empty plain content');
-		}
-
-		// Set empty vars to be set by openssl by reference
-		$sealed = '';
-		$shareKeys = [];
-		$mappedShareKeys = [];
-
-		if (openssl_seal($plainContent, $sealed, $shareKeys, $keyFiles, 'RC4')) {
-			$i = 0;
-
-			// Ensure each shareKey is labelled with its corresponding key id
-			foreach ($keyFiles as $userId => $publicKey) {
-				$mappedShareKeys[$userId] = $shareKeys[$i];
-				$i++;
-			}
-
-			return [
-				'keys' => $mappedShareKeys,
-				'data' => $sealed
-			];
-		} else {
-			throw new MultiKeyEncryptException('multikeyencryption failed ' . openssl_error_string());
-		}
-	}
-
-	public function useLegacyBase64Encoding(): bool {
-		return $this->useLegacyBase64Encoding;
-	}
+    public const SUPPORTED_CIPHERS_AND_KEY_SIZE = [
+        'AES-256-CTR' => 32,
+        'AES-128-CTR' => 16,
+        'AES-256-CFB' => 32,
+        'AES-128-CFB' => 16,
+    ];
+    // one out of SUPPORTED_CIPHERS_AND_KEY_SIZE
+    public const DEFAULT_CIPHER = 'AES-256-CTR';
+    // default cipher from old Nextcloud versions
+    public const LEGACY_CIPHER = 'AES-128-CFB';
+
+    public const SUPPORTED_KEY_FORMATS = ['hash', 'password'];
+    // one out of SUPPORTED_KEY_FORMATS
+    public const DEFAULT_KEY_FORMAT = 'hash';
+    // default key format, old Nextcloud version encrypted the private key directly
+    // with the user password
+    public const LEGACY_KEY_FORMAT = 'password';
+
+    public const HEADER_START = 'HBEGIN';
+    public const HEADER_END = 'HEND';
+
+    // default encoding format, old Nextcloud versions used base64
+    public const BINARY_ENCODING_FORMAT = 'binary';
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var string */
+    private $user;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var IL10N */
+    private $l;
+
+    /** @var string|null */
+    private $currentCipher;
+
+    /** @var bool */
+    private $supportLegacy;
+
+    /**
+     * Use the legacy base64 encoding instead of the more space-efficient binary encoding.
+     */
+    private bool $useLegacyBase64Encoding;
+
+    /**
+     * @param ILogger $logger
+     * @param IUserSession $userSession
+     * @param IConfig $config
+     * @param IL10N $l
+     */
+    public function __construct(ILogger $logger, IUserSession $userSession, IConfig $config, IL10N $l) {
+        $this->logger = $logger;
+        $this->user = $userSession && $userSession->isLoggedIn() ? $userSession->getUser()->getUID() : '"no user given"';
+        $this->config = $config;
+        $this->l = $l;
+        $this->supportLegacy = $this->config->getSystemValueBool('encryption.legacy_format_support', false);
+        $this->useLegacyBase64Encoding = $this->config->getSystemValueBool('encryption.use_legacy_base64_encoding', false);
+    }
+
+    /**
+     * create new private/public key-pair for user
+     *
+     * @return array|bool
+     */
+    public function createKeyPair() {
+        $log = $this->logger;
+        $res = $this->getOpenSSLPKey();
+
+        if (!$res) {
+            $log->error("Encryption Library couldn't generate users key-pair for {$this->user}",
+                ['app' => 'encryption']);
+
+            if (openssl_error_string()) {
+                $log->error('Encryption library openssl_pkey_new() fails: ' . openssl_error_string(),
+                    ['app' => 'encryption']);
+            }
+        } elseif (openssl_pkey_export($res,
+            $privateKey,
+            null,
+            $this->getOpenSSLConfig())) {
+            $keyDetails = openssl_pkey_get_details($res);
+            $publicKey = $keyDetails['key'];
+
+            return [
+                'publicKey' => $publicKey,
+                'privateKey' => $privateKey
+            ];
+        }
+        $log->error('Encryption library couldn\'t export users private key, please check your servers OpenSSL configuration.' . $this->user,
+            ['app' => 'encryption']);
+        if (openssl_error_string()) {
+            $log->error('Encryption Library:' . openssl_error_string(),
+                ['app' => 'encryption']);
+        }
+
+        return false;
+    }
+
+    /**
+     * Generates a new private key
+     *
+     * @return resource
+     */
+    public function getOpenSSLPKey() {
+        $config = $this->getOpenSSLConfig();
+        return openssl_pkey_new($config);
+    }
+
+    /**
+     * get openSSL Config
+     *
+     * @return array
+     */
+    private function getOpenSSLConfig() {
+        $config = ['private_key_bits' => 4096];
+        $config = array_merge(
+            $config,
+            $this->config->getSystemValue('openssl', [])
+        );
+        return $config;
+    }
+
+    /**
+     * @param string $plainContent
+     * @param string $passPhrase
+     * @param int $version
+     * @param int $position
+     * @return false|string
+     * @throws EncryptionFailedException
+     */
+    public function symmetricEncryptFileContent($plainContent, $passPhrase, $version, $position) {
+        if (!$plainContent) {
+            $this->logger->error('Encryption Library, symmetrical encryption failed no content given',
+                ['app' => 'encryption']);
+            return false;
+        }
+
+        $iv = $this->generateIv();
+
+        $encryptedContent = $this->encrypt($plainContent,
+            $iv,
+            $passPhrase,
+            $this->getCipher());
+
+        // Create a signature based on the key as well as the current version
+        $sig = $this->createSignature($encryptedContent, $passPhrase.'_'.$version.'_'.$position);
+
+        // combine content to encrypt the IV identifier and actual IV
+        $catFile = $this->concatIV($encryptedContent, $iv);
+        $catFile = $this->concatSig($catFile, $sig);
+        return $this->addPadding($catFile);
+    }
+
+    /**
+     * generate header for encrypted file
+     *
+     * @param string $keyFormat see SUPPORTED_KEY_FORMATS
+     * @return string
+     * @throws \InvalidArgumentException
+     */
+    public function generateHeader($keyFormat = self::DEFAULT_KEY_FORMAT) {
+        if (in_array($keyFormat, self::SUPPORTED_KEY_FORMATS, true) === false) {
+            throw new \InvalidArgumentException('key format "' . $keyFormat . '" is not supported');
+        }
+
+        $header = self::HEADER_START
+            . ':cipher:' . $this->getCipher()
+            . ':keyFormat:' . $keyFormat;
+
+        if ($this->useLegacyBase64Encoding !== true) {
+            $header .= ':encoding:' . self::BINARY_ENCODING_FORMAT;
+        }
+
+        $header .= ':' . self::HEADER_END;
+
+        return $header;
+    }
+
+    /**
+     * @param string $plainContent
+     * @param string $iv
+     * @param string $passPhrase
+     * @param string $cipher
+     * @return string
+     * @throws EncryptionFailedException
+     */
+    private function encrypt($plainContent, $iv, $passPhrase = '', $cipher = self::DEFAULT_CIPHER) {
+        $options = $this->useLegacyBase64Encoding ? 0 : OPENSSL_RAW_DATA;
+        $encryptedContent = openssl_encrypt($plainContent,
+            $cipher,
+            $passPhrase,
+            $options,
+            $iv);
+
+        if (!$encryptedContent) {
+            $error = 'Encryption (symmetric) of content failed';
+            $this->logger->error($error . openssl_error_string(),
+                ['app' => 'encryption']);
+            throw new EncryptionFailedException($error);
+        }
+
+        return $encryptedContent;
+    }
+
+    /**
+     * return cipher either from config.php or the default cipher defined in
+     * this class
+     *
+     * @return string
+     */
+    private function getCachedCipher() {
+        if (isset($this->currentCipher)) {
+            return $this->currentCipher;
+        }
+
+        // Get cipher either from config.php or the default cipher defined in this class
+        $cipher = $this->config->getSystemValueString('cipher', self::DEFAULT_CIPHER);
+        if (!isset(self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher])) {
+            $this->logger->warning(
+                sprintf(
+                    'Unsupported cipher (%s) defined in config.php supported. Falling back to %s',
+                    $cipher,
+                    self::DEFAULT_CIPHER
+                ),
+                ['app' => 'encryption']
+            );
+            $cipher = self::DEFAULT_CIPHER;
+        }
+
+        // Remember current cipher to avoid frequent lookups
+        $this->currentCipher = $cipher;
+        return $this->currentCipher;
+    }
+
+    /**
+     * return current encryption cipher
+     *
+     * @return string
+     */
+    public function getCipher() {
+        return $this->getCachedCipher();
+    }
+
+    /**
+     * get key size depending on the cipher
+     *
+     * @param string $cipher
+     * @return int
+     * @throws \InvalidArgumentException
+     */
+    protected function getKeySize($cipher) {
+        if (isset(self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher])) {
+            return self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher];
+        }
+
+        throw new \InvalidArgumentException(
+            sprintf(
+                    'Unsupported cipher (%s) defined.',
+                    $cipher
+            )
+        );
+    }
+
+    /**
+     * get legacy cipher
+     *
+     * @return string
+     */
+    public function getLegacyCipher() {
+        if (!$this->supportLegacy) {
+            throw new ServerNotAvailableException('Legacy cipher is no longer supported!');
+        }
+
+        return self::LEGACY_CIPHER;
+    }
+
+    /**
+     * @param string $encryptedContent
+     * @param string $iv
+     * @return string
+     */
+    private function concatIV($encryptedContent, $iv) {
+        return $encryptedContent . '00iv00' . $iv;
+    }
+
+    /**
+     * @param string $encryptedContent
+     * @param string $signature
+     * @return string
+     */
+    private function concatSig($encryptedContent, $signature) {
+        return $encryptedContent . '00sig00' . $signature;
+    }
+
+    /**
+     * Note: This is _NOT_ a padding used for encryption purposes. It is solely
+     * used to achieve the PHP stream size. It has _NOTHING_ to do with the
+     * encrypted content and is not used in any crypto primitive.
+     *
+     * @param string $data
+     * @return string
+     */
+    private function addPadding($data) {
+        return $data . 'xxx';
+    }
+
+    /**
+     * generate password hash used to encrypt the users private key
+     *
+     * @param string $password
+     * @param string $cipher
+     * @param string $uid only used for user keys
+     * @return string
+     */
+    protected function generatePasswordHash($password, $cipher, $uid = '') {
+        $instanceId = $this->config->getSystemValue('instanceid');
+        $instanceSecret = $this->config->getSystemValue('secret');
+        $salt = hash('sha256', $uid . $instanceId . $instanceSecret, true);
+        $keySize = $this->getKeySize($cipher);
+
+        $hash = hash_pbkdf2(
+            'sha256',
+            $password,
+            $salt,
+            100000,
+            $keySize,
+            true
+        );
+
+        return $hash;
+    }
+
+    /**
+     * encrypt private key
+     *
+     * @param string $privateKey
+     * @param string $password
+     * @param string $uid for regular users, empty for system keys
+     * @return false|string
+     */
+    public function encryptPrivateKey($privateKey, $password, $uid = '') {
+        $cipher = $this->getCipher();
+        $hash = $this->generatePasswordHash($password, $cipher, $uid);
+        $encryptedKey = $this->symmetricEncryptFileContent(
+            $privateKey,
+            $hash,
+            0,
+            0
+        );
+
+        return $encryptedKey;
+    }
+
+    /**
+     * @param string $privateKey
+     * @param string $password
+     * @param string $uid for regular users, empty for system keys
+     * @return false|string
+     */
+    public function decryptPrivateKey($privateKey, $password = '', $uid = '') {
+        $header = $this->parseHeader($privateKey);
+
+        if (isset($header['cipher'])) {
+            $cipher = $header['cipher'];
+        } else {
+            $cipher = $this->getLegacyCipher();
+        }
+
+        if (isset($header['keyFormat'])) {
+            $keyFormat = $header['keyFormat'];
+        } else {
+            $keyFormat = self::LEGACY_KEY_FORMAT;
+        }
+
+        if ($keyFormat === self::DEFAULT_KEY_FORMAT) {
+            $password = $this->generatePasswordHash($password, $cipher, $uid);
+        }
+
+        $binaryEncoding = isset($header['encoding']) && $header['encoding'] === self::BINARY_ENCODING_FORMAT;
+
+        // If we found a header we need to remove it from the key we want to decrypt
+        if (!empty($header)) {
+            $privateKey = substr($privateKey,
+                strpos($privateKey,
+                    self::HEADER_END) + strlen(self::HEADER_END));
+        }
+
+        $plainKey = $this->symmetricDecryptFileContent(
+            $privateKey,
+            $password,
+            $cipher,
+            0,
+            0,
+            $binaryEncoding
+        );
+
+        if ($this->isValidPrivateKey($plainKey) === false) {
+            return false;
+        }
+
+        return $plainKey;
+    }
+
+    /**
+     * check if it is a valid private key
+     *
+     * @param string $plainKey
+     * @return bool
+     */
+    protected function isValidPrivateKey($plainKey) {
+        $res = openssl_get_privatekey($plainKey);
+        // TODO: remove resource check one php7.4 is not longer supported
+        if (is_resource($res) || (is_object($res) && get_class($res) === 'OpenSSLAsymmetricKey')) {
+            $sslInfo = openssl_pkey_get_details($res);
+            if (isset($sslInfo['key'])) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $keyFileContents
+     * @param string $passPhrase
+     * @param string $cipher
+     * @param int $version
+     * @param int|string $position
+     * @param boolean $binaryEncoding
+     * @return string
+     * @throws DecryptionFailedException
+     */
+    public function symmetricDecryptFileContent($keyFileContents, $passPhrase, $cipher = self::DEFAULT_CIPHER, $version = 0, $position = 0, bool $binaryEncoding = false) {
+        if ($keyFileContents == '') {
+            return '';
+        }
+
+        $catFile = $this->splitMetaData($keyFileContents, $cipher);
+
+        if ($catFile['signature'] !== false) {
+            try {
+                // First try the new format
+                $this->checkSignature($catFile['encrypted'], $passPhrase . '_' . $version . '_' . $position, $catFile['signature']);
+            } catch (GenericEncryptionException $e) {
+                // For compatibility with old files check the version without _
+                $this->checkSignature($catFile['encrypted'], $passPhrase . $version . $position, $catFile['signature']);
+            }
+        }
+
+        return $this->decrypt($catFile['encrypted'],
+            $catFile['iv'],
+            $passPhrase,
+            $cipher,
+            $binaryEncoding);
+    }
+
+    /**
+     * check for valid signature
+     *
+     * @param string $data
+     * @param string $passPhrase
+     * @param string $expectedSignature
+     * @throws GenericEncryptionException
+     */
+    private function checkSignature($data, $passPhrase, $expectedSignature) {
+        $enforceSignature = !$this->config->getSystemValueBool('encryption_skip_signature_check', false);
+
+        $signature = $this->createSignature($data, $passPhrase);
+        $isCorrectHash = hash_equals($expectedSignature, $signature);
+
+        if (!$isCorrectHash && $enforceSignature) {
+            throw new GenericEncryptionException('Bad Signature', $this->l->t('Bad Signature'));
+        } elseif (!$isCorrectHash && !$enforceSignature) {
+            $this->logger->info("Signature check skipped", ['app' => 'encryption']);
+        }
+    }
+
+    /**
+     * create signature
+     *
+     * @param string $data
+     * @param string $passPhrase
+     * @return string
+     */
+    private function createSignature($data, $passPhrase) {
+        $passPhrase = hash('sha512', $passPhrase . 'a', true);
+        return hash_hmac('sha256', $data, $passPhrase);
+    }
+
+
+    /**
+     * remove padding
+     *
+     * @param string $padded
+     * @param bool $hasSignature did the block contain a signature, in this case we use a different padding
+     * @return string|false
+     */
+    private function removePadding($padded, $hasSignature = false) {
+        if ($hasSignature === false && substr($padded, -2) === 'xx') {
+            return substr($padded, 0, -2);
+        } elseif ($hasSignature === true && substr($padded, -3) === 'xxx') {
+            return substr($padded, 0, -3);
+        }
+        return false;
+    }
+
+    /**
+     * split meta data from encrypted file
+     * Note: for now, we assume that the meta data always start with the iv
+     *       followed by the signature, if available
+     *
+     * @param string $catFile
+     * @param string $cipher
+     * @return array
+     */
+    private function splitMetaData($catFile, $cipher) {
+        if ($this->hasSignature($catFile, $cipher)) {
+            $catFile = $this->removePadding($catFile, true);
+            $meta = substr($catFile, -93);
+            $iv = substr($meta, strlen('00iv00'), 16);
+            $sig = substr($meta, 22 + strlen('00sig00'));
+            $encrypted = substr($catFile, 0, -93);
+        } else {
+            $catFile = $this->removePadding($catFile);
+            $meta = substr($catFile, -22);
+            $iv = substr($meta, -16);
+            $sig = false;
+            $encrypted = substr($catFile, 0, -22);
+        }
+
+        return [
+            'encrypted' => $encrypted,
+            'iv' => $iv,
+            'signature' => $sig
+        ];
+    }
+
+    /**
+     * check if encrypted block is signed
+     *
+     * @param string $catFile
+     * @param string $cipher
+     * @return bool
+     * @throws GenericEncryptionException
+     */
+    private function hasSignature($catFile, $cipher) {
+        $skipSignatureCheck = $this->config->getSystemValueBool('encryption_skip_signature_check', false);
+
+        $meta = substr($catFile, -93);
+        $signaturePosition = strpos($meta, '00sig00');
+
+        // If we no longer support the legacy format then everything needs a signature
+        if (!$skipSignatureCheck && !$this->supportLegacy && $signaturePosition === false) {
+            throw new GenericEncryptionException('Missing Signature', $this->l->t('Missing Signature'));
+        }
+
+        // Enforce signature for the new 'CTR' ciphers
+        if (!$skipSignatureCheck && $signaturePosition === false && stripos($cipher, 'ctr') !== false) {
+            throw new GenericEncryptionException('Missing Signature', $this->l->t('Missing Signature'));
+        }
+
+        return ($signaturePosition !== false);
+    }
+
+
+    /**
+     * @param string $encryptedContent
+     * @param string $iv
+     * @param string $passPhrase
+     * @param string $cipher
+     * @param boolean $binaryEncoding
+     * @return string
+     * @throws DecryptionFailedException
+     */
+    private function decrypt(string $encryptedContent, string $iv, string $passPhrase = '', string $cipher = self::DEFAULT_CIPHER, bool $binaryEncoding = false): string {
+        $options = $binaryEncoding === true ? OPENSSL_RAW_DATA : 0;
+        $plainContent = openssl_decrypt($encryptedContent,
+            $cipher,
+            $passPhrase,
+            $options,
+            $iv);
+
+        if ($plainContent) {
+            return $plainContent;
+        } else {
+            throw new DecryptionFailedException('Encryption library: Decryption (symmetric) of content failed: ' . openssl_error_string());
+        }
+    }
+
+    /**
+     * @param string $data
+     * @return array
+     */
+    protected function parseHeader($data) {
+        $result = [];
+
+        if (substr($data, 0, strlen(self::HEADER_START)) === self::HEADER_START) {
+            $endAt = strpos($data, self::HEADER_END);
+            $header = substr($data, 0, $endAt + strlen(self::HEADER_END));
+
+            // +1 not to start with an ':' which would result in empty element at the beginning
+            $exploded = explode(':',
+                substr($header, strlen(self::HEADER_START) + 1));
+
+            $element = array_shift($exploded);
+
+            while ($element !== self::HEADER_END) {
+                $result[$element] = array_shift($exploded);
+                $element = array_shift($exploded);
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * generate initialization vector
+     *
+     * @return string
+     * @throws GenericEncryptionException
+     */
+    private function generateIv() {
+        return random_bytes(16);
+    }
+
+    /**
+     * Generate a cryptographically secure pseudo-random 256-bit ASCII key, used
+     * as file key
+     *
+     * @return string
+     * @throws \Exception
+     */
+    public function generateFileKey() {
+        return random_bytes(32);
+    }
+
+    /**
+     * @param $encKeyFile
+     * @param $shareKey
+     * @param $privateKey
+     * @return string
+     * @throws MultiKeyDecryptException
+     */
+    public function multiKeyDecrypt($encKeyFile, $shareKey, $privateKey) {
+        if (!$encKeyFile) {
+            throw new MultiKeyDecryptException('Cannot multikey decrypt empty plain content');
+        }
+
+        if (openssl_open($encKeyFile, $plainContent, $shareKey, $privateKey, 'RC4')) {
+            return $plainContent;
+        } else {
+            throw new MultiKeyDecryptException('multikeydecrypt with share key failed:' . openssl_error_string());
+        }
+    }
+
+    /**
+     * @param string $plainContent
+     * @param array $keyFiles
+     * @return array
+     * @throws MultiKeyEncryptException
+     */
+    public function multiKeyEncrypt($plainContent, array $keyFiles) {
+        // openssl_seal returns false without errors if plaincontent is empty
+        // so trigger our own error
+        if (empty($plainContent)) {
+            throw new MultiKeyEncryptException('Cannot multikeyencrypt empty plain content');
+        }
+
+        // Set empty vars to be set by openssl by reference
+        $sealed = '';
+        $shareKeys = [];
+        $mappedShareKeys = [];
+
+        if (openssl_seal($plainContent, $sealed, $shareKeys, $keyFiles, 'RC4')) {
+            $i = 0;
+
+            // Ensure each shareKey is labelled with its corresponding key id
+            foreach ($keyFiles as $userId => $publicKey) {
+                $mappedShareKeys[$userId] = $shareKeys[$i];
+                $i++;
+            }
+
+            return [
+                'keys' => $mappedShareKeys,
+                'data' => $sealed
+            ];
+        } else {
+            throw new MultiKeyEncryptException('multikeyencryption failed ' . openssl_error_string());
+        }
+    }
+
+    public function useLegacyBase64Encoding(): bool {
+        return $this->useLegacyBase64Encoding;
+    }
 }

apps/encryption/lib/Command/FixEncryptedVersion.php

Indentation +282 added lines, -282 removed lines

@@ -36,286 +36,286 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class FixEncryptedVersion extends Command {
-	/** @var IConfig */
-	private $config;
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var IRootFolder  */
-	private $rootFolder;
-
-	/** @var IUserManager  */
-	private $userManager;
-
-	/** @var Util */
-	private $util;
-
-	/** @var View  */
-	private $view;
-
-	/** @var bool */
-	private $supportLegacy;
-
-	public function __construct(
-		IConfig $config,
-		ILogger $logger,
-		IRootFolder $rootFolder,
-		IUserManager $userManager,
-		Util $util,
-		View $view
-	) {
-		$this->config = $config;
-		$this->logger = $logger;
-		$this->rootFolder = $rootFolder;
-		$this->userManager = $userManager;
-		$this->util = $util;
-		$this->view = $view;
-		$this->supportLegacy = false;
-
-		parent::__construct();
-	}
-
-	protected function configure(): void {
-		parent::configure();
-
-		$this
-			->setName('encryption:fix-encrypted-version')
-			->setDescription('Fix the encrypted version if the encrypted file(s) are not downloadable.')
-			->addArgument(
-				'user',
-				InputArgument::REQUIRED,
-				'The id of the user whose files need fixing'
-			)->addOption(
-				'path',
-				'p',
-				InputArgument::OPTIONAL,
-				'Limit files to fix with path, e.g., --path="/Music/Artist". If path indicates a directory, all the files inside directory will be fixed.'
-			);
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$skipSignatureCheck = $this->config->getSystemValueBool('encryption_skip_signature_check', false);
-		$this->supportLegacy = $this->config->getSystemValueBool('encryption.legacy_format_support', false);
-
-		if ($skipSignatureCheck) {
-			$output->writeln("<error>Repairing is not possible when \"encryption_skip_signature_check\" is set. Please disable this flag in the configuration.</error>\n");
-			return 1;
-		}
-
-		if (!$this->util->isMasterKeyEnabled()) {
-			$output->writeln("<error>Repairing only works with master key encryption.</error>\n");
-			return 1;
-		}
-
-		$user = (string)$input->getArgument('user');
-		$pathToWalk = "/$user/files";
-
-		$pathOption = \trim(($input->getOption('path') ?? ''), '/');
-		if ($pathOption !== "") {
-			$pathToWalk = "$pathToWalk/$pathOption";
-		}
-
-		if ($user === '') {
-			$output->writeln("<error>No user id provided.</error>\n");
-			return 1;
-		}
-
-		if ($this->userManager->get($user) === null) {
-			$output->writeln("<error>User id $user does not exist. Please provide a valid user id</error>");
-			return 1;
-		}
-		return $this->walkPathOfUser($user, $pathToWalk, $output);
-	}
-
-	/**
-	 * @return int 0 for success, 1 for error
-	 */
-	private function walkPathOfUser(string $user, string $path, OutputInterface $output): int {
-		$this->setupUserFs($user);
-		if (!$this->view->file_exists($path)) {
-			$output->writeln("<error>Path \"$path\" does not exist. Please provide a valid path.</error>");
-			return 1;
-		}
-
-		if ($this->view->is_file($path)) {
-			$output->writeln("Verifying the content of file \"$path\"");
-			$this->verifyFileContent($path, $output);
-			return 0;
-		}
-		$directories = [];
-		$directories[] = $path;
-		while ($root = \array_pop($directories)) {
-			$directoryContent = $this->view->getDirectoryContent($root);
-			foreach ($directoryContent as $file) {
-				$path = $root . '/' . $file['name'];
-				if ($this->view->is_dir($path)) {
-					$directories[] = $path;
-				} else {
-					$output->writeln("Verifying the content of file \"$path\"");
-					$this->verifyFileContent($path, $output);
-				}
-			}
-		}
-		return 0;
-	}
-
-	/**
-	 * @param bool $ignoreCorrectEncVersionCall, setting this variable to false avoids recursion
-	 */
-	private function verifyFileContent(string $path, OutputInterface $output, bool $ignoreCorrectEncVersionCall = true): bool {
-		try {
-			/**
-			 * In encryption, the files are read in a block size of 8192 bytes
-			 * Read block size of 8192 and a bit more (808 bytes)
-			 * If there is any problem, the first block should throw the signature
-			 * mismatch error. Which as of now, is enough to proceed ahead to
-			 * correct the encrypted version.
-			 */
-			$handle = $this->view->fopen($path, 'rb');
-
-			if ($handle === false) {
-				$output->writeln("<warning>Failed to open file: \"$path\" skipping</warning>");
-				return true;
-			}
-
-			if (\fread($handle, 9001) !== false) {
-				$fileInfo = $this->view->getFileInfo($path);
-				if (!$fileInfo) {
-					$output->writeln("<warning>File info not found for file: \"$path\"</warning>");
-					return true;
-				}
-				$encryptedVersion = $fileInfo->getEncryptedVersion();
-				$stat = $this->view->stat($path);
-				if (($encryptedVersion == 0) && isset($stat['hasHeader']) && ($stat['hasHeader'] == true)) {
-					// The file has encrypted to false but has an encryption header
-					if ($ignoreCorrectEncVersionCall === true) {
-						// Lets rectify the file by correcting encrypted version
-						$output->writeln("<info>Attempting to fix the path: \"$path\"</info>");
-						return $this->correctEncryptedVersion($path, $output);
-					}
-					return false;
-				}
-				$output->writeln("<info>The file \"$path\" is: OK</info>");
-			}
-
-			\fclose($handle);
-
-			return true;
-		} catch (ServerNotAvailableException $e) {
-			// not a "bad signature" error and likely "legacy cipher" exception
-			// this could mean that the file is maybe not encrypted but the encrypted version is set
-			if (!$this->supportLegacy && $ignoreCorrectEncVersionCall === true) {
-				$output->writeln("<info>Attempting to fix the path: \"$path\"</info>");
-				return $this->correctEncryptedVersion($path, $output, true);
-			}
-			return false;
-		} catch (HintException $e) {
-			$this->logger->warning("Issue: " . $e->getMessage());
-			// If allowOnce is set to false, this becomes recursive.
-			if ($ignoreCorrectEncVersionCall === true) {
-				// Lets rectify the file by correcting encrypted version
-				$output->writeln("<info>Attempting to fix the path: \"$path\"</info>");
-				return $this->correctEncryptedVersion($path, $output);
-			}
-			return false;
-		}
-	}
-
-	/**
-	 * @param bool $includeZero whether to try zero version for unencrypted file
-	 */
-	private function correctEncryptedVersion(string $path, OutputInterface $output, bool $includeZero = false): bool {
-		$fileInfo = $this->view->getFileInfo($path);
-		if (!$fileInfo) {
-			$output->writeln("<warning>File info not found for file: \"$path\"</warning>");
-			return true;
-		}
-		$fileId = $fileInfo->getId();
-		if ($fileId === null) {
-			$output->writeln("<warning>File info contains no id for file: \"$path\"</warning>");
-			return true;
-		}
-		$encryptedVersion = $fileInfo->getEncryptedVersion();
-		$wrongEncryptedVersion = $encryptedVersion;
-
-		$storage = $fileInfo->getStorage();
-
-		$cache = $storage->getCache();
-		$fileCache = $cache->get($fileId);
-		if (!$fileCache) {
-			$output->writeln("<warning>File cache entry not found for file: \"$path\"</warning>");
-			return true;
-		}
-
-		if ($storage->instanceOfStorage('OCA\Files_Sharing\ISharedStorage')) {
-			$output->writeln("<info>The file: \"$path\" is a share. Please also run the script for the owner of the share</info>");
-			return true;
-		}
-
-		// Save original encrypted version so we can restore it if decryption fails with all version
-		$originalEncryptedVersion = $encryptedVersion;
-		if ($encryptedVersion >= 0) {
-			if ($includeZero) {
-				// try with zero first
-				$cacheInfo = ['encryptedVersion' => 0, 'encrypted' => 0];
-				$cache->put($fileCache->getPath(), $cacheInfo);
-				$output->writeln("<info>Set the encrypted version to 0 (unencrypted)</info>");
-				if ($this->verifyFileContent($path, $output, false) === true) {
-					$output->writeln("<info>Fixed the file: \"$path\" with version 0 (unencrypted)</info>");
-					return true;
-				}
-			}
-
-			// Test by decrementing the value till 1 and if nothing works try incrementing
-			$encryptedVersion--;
-			while ($encryptedVersion > 0) {
-				$cacheInfo = ['encryptedVersion' => $encryptedVersion, 'encrypted' => $encryptedVersion];
-				$cache->put($fileCache->getPath(), $cacheInfo);
-				$output->writeln("<info>Decrement the encrypted version to $encryptedVersion</info>");
-				if ($this->verifyFileContent($path, $output, false) === true) {
-					$output->writeln("<info>Fixed the file: \"$path\" with version " . $encryptedVersion . "</info>");
-					return true;
-				}
-				$encryptedVersion--;
-			}
-
-			// So decrementing did not work. Now lets increment. Max increment is till 5
-			$increment = 1;
-			while ($increment <= 5) {
-				/**
-				 * The wrongEncryptedVersion would not be incremented so nothing to worry about here.
-				 * Only the newEncryptedVersion is incremented.
-				 * For example if the wrong encrypted version is 4 then
-				 * cycle1 -> newEncryptedVersion = 5 ( 4 + 1)
-				 * cycle2 -> newEncryptedVersion = 6 ( 4 + 2)
-				 * cycle3 -> newEncryptedVersion = 7 ( 4 + 3)
-				 */
-				$newEncryptedVersion = $wrongEncryptedVersion + $increment;
-
-				$cacheInfo = ['encryptedVersion' => $newEncryptedVersion, 'encrypted' => $newEncryptedVersion];
-				$cache->put($fileCache->getPath(), $cacheInfo);
-				$output->writeln("<info>Increment the encrypted version to $newEncryptedVersion</info>");
-				if ($this->verifyFileContent($path, $output, false) === true) {
-					$output->writeln("<info>Fixed the file: \"$path\" with version " . $newEncryptedVersion . "</info>");
-					return true;
-				}
-				$increment++;
-			}
-		}
-
-		$cacheInfo = ['encryptedVersion' => $originalEncryptedVersion, 'encrypted' => $originalEncryptedVersion];
-		$cache->put($fileCache->getPath(), $cacheInfo);
-		$output->writeln("<info>No fix found for \"$path\", restored version to original: $originalEncryptedVersion</info>");
-
-		return false;
-	}
-
-	/**
-	 * Setup user file system
-	 */
-	private function setupUserFs(string $uid): void {
-		\OC_Util::tearDownFS();
-		\OC_Util::setupFS($uid);
-	}
+    /** @var IConfig */
+    private $config;
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var IRootFolder  */
+    private $rootFolder;
+
+    /** @var IUserManager  */
+    private $userManager;
+
+    /** @var Util */
+    private $util;
+
+    /** @var View  */
+    private $view;
+
+    /** @var bool */
+    private $supportLegacy;
+
+    public function __construct(
+        IConfig $config,
+        ILogger $logger,
+        IRootFolder $rootFolder,
+        IUserManager $userManager,
+        Util $util,
+        View $view
+    ) {
+        $this->config = $config;
+        $this->logger = $logger;
+        $this->rootFolder = $rootFolder;
+        $this->userManager = $userManager;
+        $this->util = $util;
+        $this->view = $view;
+        $this->supportLegacy = false;
+
+        parent::__construct();
+    }
+
+    protected function configure(): void {
+        parent::configure();
+
+        $this
+            ->setName('encryption:fix-encrypted-version')
+            ->setDescription('Fix the encrypted version if the encrypted file(s) are not downloadable.')
+            ->addArgument(
+                'user',
+                InputArgument::REQUIRED,
+                'The id of the user whose files need fixing'
+            )->addOption(
+                'path',
+                'p',
+                InputArgument::OPTIONAL,
+                'Limit files to fix with path, e.g., --path="/Music/Artist". If path indicates a directory, all the files inside directory will be fixed.'
+            );
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $skipSignatureCheck = $this->config->getSystemValueBool('encryption_skip_signature_check', false);
+        $this->supportLegacy = $this->config->getSystemValueBool('encryption.legacy_format_support', false);
+
+        if ($skipSignatureCheck) {
+            $output->writeln("<error>Repairing is not possible when \"encryption_skip_signature_check\" is set. Please disable this flag in the configuration.</error>\n");
+            return 1;
+        }
+
+        if (!$this->util->isMasterKeyEnabled()) {
+            $output->writeln("<error>Repairing only works with master key encryption.</error>\n");
+            return 1;
+        }
+
+        $user = (string)$input->getArgument('user');
+        $pathToWalk = "/$user/files";
+
+        $pathOption = \trim(($input->getOption('path') ?? ''), '/');
+        if ($pathOption !== "") {
+            $pathToWalk = "$pathToWalk/$pathOption";
+        }
+
+        if ($user === '') {
+            $output->writeln("<error>No user id provided.</error>\n");
+            return 1;
+        }
+
+        if ($this->userManager->get($user) === null) {
+            $output->writeln("<error>User id $user does not exist. Please provide a valid user id</error>");
+            return 1;
+        }
+        return $this->walkPathOfUser($user, $pathToWalk, $output);
+    }
+
+    /**
+     * @return int 0 for success, 1 for error
+     */
+    private function walkPathOfUser(string $user, string $path, OutputInterface $output): int {
+        $this->setupUserFs($user);
+        if (!$this->view->file_exists($path)) {
+            $output->writeln("<error>Path \"$path\" does not exist. Please provide a valid path.</error>");
+            return 1;
+        }
+
+        if ($this->view->is_file($path)) {
+            $output->writeln("Verifying the content of file \"$path\"");
+            $this->verifyFileContent($path, $output);
+            return 0;
+        }
+        $directories = [];
+        $directories[] = $path;
+        while ($root = \array_pop($directories)) {
+            $directoryContent = $this->view->getDirectoryContent($root);
+            foreach ($directoryContent as $file) {
+                $path = $root . '/' . $file['name'];
+                if ($this->view->is_dir($path)) {
+                    $directories[] = $path;
+                } else {
+                    $output->writeln("Verifying the content of file \"$path\"");
+                    $this->verifyFileContent($path, $output);
+                }
+            }
+        }
+        return 0;
+    }
+
+    /**
+     * @param bool $ignoreCorrectEncVersionCall, setting this variable to false avoids recursion
+     */
+    private function verifyFileContent(string $path, OutputInterface $output, bool $ignoreCorrectEncVersionCall = true): bool {
+        try {
+            /**
+             * In encryption, the files are read in a block size of 8192 bytes
+             * Read block size of 8192 and a bit more (808 bytes)
+             * If there is any problem, the first block should throw the signature
+             * mismatch error. Which as of now, is enough to proceed ahead to
+             * correct the encrypted version.
+             */
+            $handle = $this->view->fopen($path, 'rb');
+
+            if ($handle === false) {
+                $output->writeln("<warning>Failed to open file: \"$path\" skipping</warning>");
+                return true;
+            }
+
+            if (\fread($handle, 9001) !== false) {
+                $fileInfo = $this->view->getFileInfo($path);
+                if (!$fileInfo) {
+                    $output->writeln("<warning>File info not found for file: \"$path\"</warning>");
+                    return true;
+                }
+                $encryptedVersion = $fileInfo->getEncryptedVersion();
+                $stat = $this->view->stat($path);
+                if (($encryptedVersion == 0) && isset($stat['hasHeader']) && ($stat['hasHeader'] == true)) {
+                    // The file has encrypted to false but has an encryption header
+                    if ($ignoreCorrectEncVersionCall === true) {
+                        // Lets rectify the file by correcting encrypted version
+                        $output->writeln("<info>Attempting to fix the path: \"$path\"</info>");
+                        return $this->correctEncryptedVersion($path, $output);
+                    }
+                    return false;
+                }
+                $output->writeln("<info>The file \"$path\" is: OK</info>");
+            }
+
+            \fclose($handle);
+
+            return true;
+        } catch (ServerNotAvailableException $e) {
+            // not a "bad signature" error and likely "legacy cipher" exception
+            // this could mean that the file is maybe not encrypted but the encrypted version is set
+            if (!$this->supportLegacy && $ignoreCorrectEncVersionCall === true) {
+                $output->writeln("<info>Attempting to fix the path: \"$path\"</info>");
+                return $this->correctEncryptedVersion($path, $output, true);
+            }
+            return false;
+        } catch (HintException $e) {
+            $this->logger->warning("Issue: " . $e->getMessage());
+            // If allowOnce is set to false, this becomes recursive.
+            if ($ignoreCorrectEncVersionCall === true) {
+                // Lets rectify the file by correcting encrypted version
+                $output->writeln("<info>Attempting to fix the path: \"$path\"</info>");
+                return $this->correctEncryptedVersion($path, $output);
+            }
+            return false;
+        }
+    }
+
+    /**
+     * @param bool $includeZero whether to try zero version for unencrypted file
+     */
+    private function correctEncryptedVersion(string $path, OutputInterface $output, bool $includeZero = false): bool {
+        $fileInfo = $this->view->getFileInfo($path);
+        if (!$fileInfo) {
+            $output->writeln("<warning>File info not found for file: \"$path\"</warning>");
+            return true;
+        }
+        $fileId = $fileInfo->getId();
+        if ($fileId === null) {
+            $output->writeln("<warning>File info contains no id for file: \"$path\"</warning>");
+            return true;
+        }
+        $encryptedVersion = $fileInfo->getEncryptedVersion();
+        $wrongEncryptedVersion = $encryptedVersion;
+
+        $storage = $fileInfo->getStorage();
+
+        $cache = $storage->getCache();
+        $fileCache = $cache->get($fileId);
+        if (!$fileCache) {
+            $output->writeln("<warning>File cache entry not found for file: \"$path\"</warning>");
+            return true;
+        }
+
+        if ($storage->instanceOfStorage('OCA\Files_Sharing\ISharedStorage')) {
+            $output->writeln("<info>The file: \"$path\" is a share. Please also run the script for the owner of the share</info>");
+            return true;
+        }
+
+        // Save original encrypted version so we can restore it if decryption fails with all version
+        $originalEncryptedVersion = $encryptedVersion;
+        if ($encryptedVersion >= 0) {
+            if ($includeZero) {
+                // try with zero first
+                $cacheInfo = ['encryptedVersion' => 0, 'encrypted' => 0];
+                $cache->put($fileCache->getPath(), $cacheInfo);
+                $output->writeln("<info>Set the encrypted version to 0 (unencrypted)</info>");
+                if ($this->verifyFileContent($path, $output, false) === true) {
+                    $output->writeln("<info>Fixed the file: \"$path\" with version 0 (unencrypted)</info>");
+                    return true;
+                }
+            }
+
+            // Test by decrementing the value till 1 and if nothing works try incrementing
+            $encryptedVersion--;
+            while ($encryptedVersion > 0) {
+                $cacheInfo = ['encryptedVersion' => $encryptedVersion, 'encrypted' => $encryptedVersion];
+                $cache->put($fileCache->getPath(), $cacheInfo);
+                $output->writeln("<info>Decrement the encrypted version to $encryptedVersion</info>");
+                if ($this->verifyFileContent($path, $output, false) === true) {
+                    $output->writeln("<info>Fixed the file: \"$path\" with version " . $encryptedVersion . "</info>");
+                    return true;
+                }
+                $encryptedVersion--;
+            }
+
+            // So decrementing did not work. Now lets increment. Max increment is till 5
+            $increment = 1;
+            while ($increment <= 5) {
+                /**
+                 * The wrongEncryptedVersion would not be incremented so nothing to worry about here.
+                 * Only the newEncryptedVersion is incremented.
+                 * For example if the wrong encrypted version is 4 then
+                 * cycle1 -> newEncryptedVersion = 5 ( 4 + 1)
+                 * cycle2 -> newEncryptedVersion = 6 ( 4 + 2)
+                 * cycle3 -> newEncryptedVersion = 7 ( 4 + 3)
+                 */
+                $newEncryptedVersion = $wrongEncryptedVersion + $increment;
+
+                $cacheInfo = ['encryptedVersion' => $newEncryptedVersion, 'encrypted' => $newEncryptedVersion];
+                $cache->put($fileCache->getPath(), $cacheInfo);
+                $output->writeln("<info>Increment the encrypted version to $newEncryptedVersion</info>");
+                if ($this->verifyFileContent($path, $output, false) === true) {
+                    $output->writeln("<info>Fixed the file: \"$path\" with version " . $newEncryptedVersion . "</info>");
+                    return true;
+                }
+                $increment++;
+            }
+        }
+
+        $cacheInfo = ['encryptedVersion' => $originalEncryptedVersion, 'encrypted' => $originalEncryptedVersion];
+        $cache->put($fileCache->getPath(), $cacheInfo);
+        $output->writeln("<info>No fix found for \"$path\", restored version to original: $originalEncryptedVersion</info>");
+
+        return false;
+    }
+
+    /**
+     * Setup user file system
+     */
+    private function setupUserFs(string $uid): void {
+        \OC_Util::tearDownFS();
+        \OC_Util::setupFS($uid);
+    }
 }