Differential D2554 Diff 7156 src/app/Backends/PGP.php

Changeset View

Standalone View

src/app/Backends/PGP.php

This file was added.

				<?php

				namespace App\Backends;

				use App\User;

				class PGP
				{
				/** @var \Crypt_GPG GnuPG engine instance */
				private static $gpg;

				/** @var array Crypt_GPG configuration */
				private static $config = [];


				/**
				* Remove all files from the user homedir
				*
				* @param \App\User $user User object
				* @param bool $del Delete also the homedir itself
				*/
				public static function homedirCleanup(User $user, bool $del = false): void
				{
				$config = self::getConfig($user, true);
				$homedir = self::$config['homedir'];

				// Remove all files from the filesystem
				$fs = new \Illuminate\Filesystem\Filesystem();
				$fs->deleteDirectory($homedir, !$del);

				// Remove all files from the Enigma database
				// Note: This will cause existing files in the Roundcube filesystem
				// to be removed, but only if the user used the Enigma functionality
				Roundcube::enigmaCleanup($user->email);
				}

				/**
				* Generate a keypair.
				* This will also initialize the user GPG homedir content.
				*
				* @param \App\User $user User object
				*
				* @throws \Exception
				*/
				public static function keypairCreate(User $user): void
				{
				// Make sure the homedir is empty
				self::homedirCleanup($user);

				$keygen = new \Crypt_GPG_KeyGenerator(self::$config);

				$key = $keygen
				// ->setPassphrase()
				// ->setExpirationDate(0)
				->setKeyParams(\Crypt_GPG_SubKey::ALGORITHM_DSA, 3072)
				->setSubKeyParams(\Crypt_GPG_SubKey::ALGORITHM_ELGAMAL_ENC, 3072)
				->generateKey(null, $user->email);

				// Store the keypair in Roundcube Enigma storage
				self::dbSave(true);

				// TODO: Register the public key in DNS

				// FIXME: Should we remove the files from the worker filesystem?
				// They are still in database and Roundcube hosts' filesystem
				}

				/**
				* List (public and private) keys from a user keyring.
				*
				* @param \App\User $user User object
				*
				* @returns \Crypt_GPG_Key[] List of keys
				* @throws \Exception
				*/
				public static function listKeys(User $user): array
				{
				$gpg = self::initGPG($user);

				return $gpg->getKeys('');
				}

				/**
				* Debug logging callback
				*/
				public static function logDebug($msg): void
				{
				\Log::debug("[GPG] $msg");
				}

				/**
				* Prepare Crypt_GPG configuration
				*/
				private static function getConfig(User $user, $nosync = false): array
				{
				if (!empty(self::$config) && self::$config['email'] == $user->email) {
				return self::$config;
				}

				$debug = \config('app.debug');
				$binary = \config('pgp.binary');
				$agent = \config('pgp.agent');
				$gpgconf = \config('pgp.gpgconf');
				$homedir = \config('pgp.homedir');

				$options = [
				'email' => $user->email, // this one is not a Crypt_GPG option
				'homedir' => self::setHomedir($homedir, $user),
				'debug' => $debug ? 'App\Backends\PGP::logDebug' : null,
				];

				if ($binary) {
				$options['binary'] = $binary;
				}

				if ($agent) {
				$options['agent'] = $agent;
				}

				if ($gpgconf) {
				$options['gpgconf'] = $gpgconf;
				}

				self::$config = $options;

				// Sync the homedir directory content with the Enigma storage
				if (!$nosync) {
				self::dbSync();
				}

				return $options;
				}

				/**
				* Initialize Crypt_GPG
				*/
				private static function initGPG(User $user)
				{
				return self::$gpg = new \Crypt_GPG(self::getConfig($user));
				}

				/**
				* Prepare a homedir for the user (storage/keys/XX/user@email.addr)
				*/
				private static function setHomedir(string $homedir, User $user): string
				{
				if (!$homedir) {
				vanmeeuwenUnsubmitted Not Done Inline Actions It may be useful to use `\Illuminate\Support\Facades\Storage` in this function? vanmeeuwen: It may be useful to use `\Illuminate\Support\Facades\Storage` in this function?
				throw new \Exception("Option 'pgp.homedir' not set");
				}

				if (!file_exists($homedir)) {
				throw new \Exception("Keys directory doesn't exists: $homedir");
				}

				if (!is_writable($homedir)) {
				throw new \Exception("Keys directory isn't writeable: $homedir");
				}

				// Create a subfolder using two first digits of the user ID
				$homedir .= '/' . sprintf('%02d', substr((string) $user->id, 0, 2));

				if (!file_exists($homedir)) {
				mkdir($homedir, 0700);
				}

				// Create the user homedir
				$homedir .= '/' . $user->email;

				if (!file_exists($homedir)) {
				mkdir($homedir, 0700);
				}

				if (!file_exists($homedir)) {
				throw new \Exception("Unable to create keys directory: $homedir");
				}

				if (!is_writable($homedir)) {
				throw new \Exception("Unable to write to keys directory: $homedir");
				}

				return $homedir;
				}

				/**
				* Synchronize keys database of a user
				*/
				private static function dbSync(): void
				{
				Roundcube::enigmaSync(self::$config['email'], self::$config['homedir']);
				}

				/**
				* Save the keys database
				*/
				private static function dbSave($is_empty = false): void
				{
				Roundcube::enigmaSave(self::$config['email'], self::$config['homedir'], $is_empty);
				}
				}