1 files changed, 166 insertions, 0 deletions
diff --git a/apps/encryption/lib/Session.php b/apps/encryption/lib/Session.php
new file mode 100644
index 00000000000..df1e5d664ad
--- /dev/null
+++ b/apps/encryption/lib/Session.php
@@ -0,0 +1,166 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+namespace OCA\Encryption;
+
+use OCA\Encryption\Exceptions\PrivateKeyMissingException;
+use OCP\ISession;
+
+class Session {
+
+	public const NOT_INITIALIZED = '0';
+	public const INIT_EXECUTED = '1';
+	public const INIT_SUCCESSFUL = '2';
+
+	/**
+	 * @param ISession $session
+	 */
+	public function __construct(
+		protected ISession $session,
+	) {
+	}
+
+	/**
+	 * Sets status of encryption app
+	 *
+	 * @param string $status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED
+	 */
+	public function setStatus($status) {
+		$this->session->set('encryptionInitialized', $status);
+	}
+
+	/**
+	 * Gets status if we already tried to initialize the encryption app
+	 *
+	 * @return string init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED
+	 */
+	public function getStatus() {
+		$status = $this->session->get('encryptionInitialized');
+		if (is_null($status)) {
+			$status = self::NOT_INITIALIZED;
+		}
+
+		return $status;
+	}
+
+	/**
+	 * check if encryption was initialized successfully
+	 *
+	 * @return bool
+	 */
+	public function isReady() {
+		$status = $this->getStatus();
+		return $status === self::INIT_SUCCESSFUL;
+	}
+
+	/**
+	 * Gets user or public share private key from session
+	 *
+	 * @return string $privateKey The user's plaintext private key
+	 * @throws Exceptions\PrivateKeyMissingException
+	 */
+	public function getPrivateKey() {
+		$key = $this->session->get('privateKey');
+		if (is_null($key)) {
+			throw new PrivateKeyMissingException('please try to log-out and log-in again');
+		}
+		return $key;
+	}
+
+	/**
+	 * check if private key is set
+	 *
+	 * @return boolean
+	 */
+	public function isPrivateKeySet() {
+		$key = $this->session->get('privateKey');
+		if (is_null($key)) {
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Sets user private key to session
+	 *
+	 * @param string $key users private key
+	 *
+	 * @note this should only be set on login
+	 */
+	public function setPrivateKey($key) {
+		$this->session->set('privateKey', $key);
+	}
+
+	/**
+	 * store data needed for the decrypt all operation in the session
+	 *
+	 * @param string $user
+	 * @param string $key
+	 */
+	public function prepareDecryptAll($user, $key) {
+		$this->session->set('decryptAll', true);
+		$this->session->set('decryptAllKey', $key);
+		$this->session->set('decryptAllUid', $user);
+	}
+
+	/**
+	 * check if we are in decrypt all mode
+	 *
+	 * @return bool
+	 */
+	public function decryptAllModeActivated() {
+		$decryptAll = $this->session->get('decryptAll');
+		return ($decryptAll === true);
+	}
+
+	/**
+	 * get uid used for decrypt all operation
+	 *
+	 * @return string
+	 * @throws \Exception
+	 */
+	public function getDecryptAllUid() {
+		$uid = $this->session->get('decryptAllUid');
+		if (is_null($uid) && $this->decryptAllModeActivated()) {
+			throw new \Exception('No uid found while in decrypt all mode');
+		} elseif (is_null($uid)) {
+			throw new \Exception('Please activate decrypt all mode first');
+		}
+
+		return $uid;
+	}
+
+	/**
+	 * get private key for decrypt all operation
+	 *
+	 * @return string
+	 * @throws PrivateKeyMissingException
+	 */
+	public function getDecryptAllKey() {
+		$privateKey = $this->session->get('decryptAllKey');
+		if (is_null($privateKey) && $this->decryptAllModeActivated()) {
+			throw new PrivateKeyMissingException('No private key found while in decrypt all mode');
+		} elseif (is_null($privateKey)) {
+			throw new PrivateKeyMissingException('Please activate decrypt all mode first');
+		}
+
+		return $privateKey;
+	}
+
+	/**
+	 * remove keys from session
+	 */
+	public function clear() {
+		$this->session->remove('publicSharePrivateKey');
+		$this->session->remove('privateKey');
+		$this->session->remove('encryptionInitialized');
+		$this->session->remove('decryptAll');
+		$this->session->remove('decryptAllKey');
+		$this->session->remove('decryptAllUid');
+	}
+}