IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2026-08-19 01:14:43 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix https://github.com/orgs/firefly-iii/discussions/11538

Browse Source
This commit is contained in:
James Cole
2026-01-17 16:02:59 +01:00
parent e7b67bc85e
commit 95c62d783a
3 changed files with 76 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+9 -1
View File
@@ -14,7 +14,15 @@ SITE_OWNER=mail@example.com
# Change it to a string of exactly 32 chars or use something like `php artisan key:generate` to generate it. # Change it to a string of exactly 32 chars or use something like `php artisan key:generate` to generate it.
# If you use Docker or similar, you can set this variable from a file by using APP_KEY_FILE # If you use Docker or similar, you can set this variable from a file by using APP_KEY_FILE
# #
# Avoid the "#" character in your APP_KEY, it may break things. # Try to avoid special characters like #, < and > in your app key. This string does not need full entropy
# When in doubt, follow the link below and pick one.
#
# https://www.random.org/strings/?num=5&len=32&digits=on&upperalpha=on&loweralpha=on&unique=on&format=html&rnd=new
#
# If you are a fancy linux nerd like me, use this command:
#
# head /dev/urandom | LC_ALL=C tr -dc 'A-Za-z0-9' | head -c 32 && echo
#
# #
APP_KEY=SomeRandomStringOf32CharsExactly APP_KEY=SomeRandomStringOf32CharsExactly
app/Console/Commands/Correction/RestoresOAuthKeys.php
+3
View File
@@ -27,6 +27,7 @@ namespace FireflyIII\Console\Commands\Correction;
use FireflyIII\Console\Commands\ShowsFriendlyMessages; use FireflyIII\Console\Commands\ShowsFriendlyMessages;
use FireflyIII\Support\System\OAuthKeys; use FireflyIII\Support\System\OAuthKeys;
use Illuminate\Console\Command; use Illuminate\Console\Command;
use Illuminate\Support\Facades\Log;
class RestoresOAuthKeys extends Command class RestoresOAuthKeys extends Command
{ {
@@ -40,7 +41,9 @@ class RestoresOAuthKeys extends Command
*/ */
public function handle(): int public function handle(): int
{ {
Log::debug('Restore OAuth Keys command.');
$this->restoreOAuthKeys(); $this->restoreOAuthKeys();
Log::debug('Done with OAuth Keys command.');
return 0; return 0;
} }
app/Support/System/OAuthKeys.php
+64 -19
View File
@@ -24,17 +24,16 @@ declare(strict_types=1);
namespace FireflyIII\Support\System; namespace FireflyIII\Support\System;
use Illuminate\Support\Facades\Log;
use FireflyIII\Exceptions\FireflyException; use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Support\Facades\FireflyConfig; use FireflyIII\Support\Facades\FireflyConfig;
use Illuminate\Contracts\Encryption\DecryptException; use Illuminate\Contracts\Encryption\DecryptException;
use Illuminate\Support\Facades\Artisan; use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Crypt; use Illuminate\Support\Facades\Crypt;
use Illuminate\Support\Facades\Log;
use Laravel\Passport\Console\KeysCommand; use Laravel\Passport\Console\KeysCommand;
use Psr\Container\ContainerExceptionInterface; use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface; use Psr\Container\NotFoundExceptionInterface;
use Safe\Exceptions\FilesystemException; use Safe\Exceptions\FilesystemException;
use function Safe\file_get_contents; use function Safe\file_get_contents;
use function Safe\file_put_contents; use function Safe\file_put_contents;
@@ -48,16 +47,26 @@ class OAuthKeys
public static function generateKeys(): void public static function generateKeys(): void
{ {
Log::debug('Will now run generateKeys()');
Artisan::registerCommand(new KeysCommand()); Artisan::registerCommand(new KeysCommand());
Artisan::call('firefly-iii:laravel-passport-keys'); Artisan::call('firefly-iii:laravel-passport-keys');
Log::debug('Done with generateKeys()');
} }
public static function hasKeyFiles(): bool public static function hasKeyFiles(): bool
{ {
$private = storage_path('oauth-private.key'); Log::debug('hasKeyFiles()');
$public = storage_path('oauth-public.key'); $private = storage_path('oauth-private.key');
$public = storage_path('oauth-public.key');
$privateExists = file_exists($private);
$publicExists = file_exists($public);
return file_exists($private) && file_exists($public); Log::debug(sprintf('Private key file at "%s" exists? %s', $private, var_export($privateExists, true)));
Log::debug(sprintf('Public key file at "%s" exists ? %s', $public, var_export($publicExists, true)));
$result = file_exists($private) && file_exists($public);
Log::debug(sprintf('Method will return %s', var_export($result, true)));
return $result;
} }
public static function keysInDatabase(): bool public static function keysInDatabase(): bool
@@ -65,17 +74,36 @@ class OAuthKeys
$privateKey = ''; $privateKey = '';
$publicKey = ''; $publicKey = '';
// better check if keys are in the database: // better check if keys are in the database:
if (FireflyConfig::has(self::PRIVATE_KEY) && FireflyConfig::has(self::PUBLIC_KEY)) { $hasPrivate = FireflyConfig::has(self::PRIVATE_KEY);
$hasPublic = FireflyConfig::has(self::PUBLIC_KEY);
Log::debug(sprintf('keysInDatabase: hasPrivate:%s, hasPublic:%s', var_export($hasPrivate, true), var_export($hasPublic, true)));
if ($hasPrivate && $hasPublic) {
try { try {
$privateKey = (string)FireflyConfig::get(self::PRIVATE_KEY)?->data; $privateKey = trim((string)FireflyConfig::get(self::PRIVATE_KEY)?->data);
$publicKey = (string)FireflyConfig::get(self::PUBLIC_KEY)?->data; $publicKey = trim((string)FireflyConfig::get(self::PUBLIC_KEY)?->data);
} catch (ContainerExceptionInterface|FireflyException|NotFoundExceptionInterface $e) { } catch (ContainerExceptionInterface | FireflyException | NotFoundExceptionInterface $e) {
Log::error(sprintf('Could not validate keysInDatabase(): %s', $e->getMessage())); Log::error(sprintf('Could not validate keysInDatabase(): %s', $e->getMessage()));
Log::error($e->getTraceAsString()); Log::error($e->getTraceAsString());
} }
} }
if ('' === $privateKey) {
Log::warning('Private key in DB is unexpectedly an empty string.');
}
if ('' === $publicKey) {
Log::warning('Public key in DB is unexpectedly an empty string.');
}
if ('' !== $privateKey) {
Log::debug(sprintf('SHA2 hash of private key in DB: %s', hash('sha256', $privateKey)));
}
if ('' !== $publicKey) {
Log::debug(sprintf('SHA2 hash of public key in DB : %s', hash('sha256', $publicKey)));
}
$return = '' !== $privateKey && '' !== $publicKey;
Log::debug(sprintf('keysInDatabase will return %s', var_export($return, true)));
return '' !== $privateKey && '' !== $publicKey; return $return;
} }
/** /**
@@ -86,12 +114,20 @@ class OAuthKeys
*/ */
public static function restoreKeysFromDB(): bool public static function restoreKeysFromDB(): bool
{ {
Log::debug('restoreKeysFromDB()');
$privateKey = (string)FireflyConfig::get(self::PRIVATE_KEY)?->data; $privateKey = (string)FireflyConfig::get(self::PRIVATE_KEY)?->data;
$publicKey = (string)FireflyConfig::get(self::PUBLIC_KEY)?->data; $publicKey = (string)FireflyConfig::get(self::PUBLIC_KEY)?->data;
if ('' === $privateKey) {
Log::warning('Private key is not in the database.');
}
if ('' === $publicKey) {
Log::warning('Public key is not in the database.');
}
try { try {
$privateContent = Crypt::decrypt($privateKey); $privateContent = trim(Crypt::decrypt($privateKey));
$publicContent = Crypt::decrypt($publicKey); $publicContent = trim(Crypt::decrypt($publicKey));
} catch (DecryptException $e) { } catch (DecryptException $e) {
Log::error('Could not decrypt pub/private keypair.'); Log::error('Could not decrypt pub/private keypair.');
Log::error($e->getMessage()); Log::error($e->getMessage());
@@ -99,23 +135,32 @@ class OAuthKeys
// delete config vars from DB: // delete config vars from DB:
FireflyConfig::delete(self::PRIVATE_KEY); FireflyConfig::delete(self::PRIVATE_KEY);
FireflyConfig::delete(self::PUBLIC_KEY); FireflyConfig::delete(self::PUBLIC_KEY);
Log::debug('Done with generateKeysFromDB(), return FALSE');
return false; return false;
} }
$private = storage_path('oauth-private.key'); $private = storage_path('oauth-private.key');
$public = storage_path('oauth-public.key'); $public = storage_path('oauth-public.key');
file_put_contents($private, $privateContent); file_put_contents($private, $privateContent);
file_put_contents($public, $publicContent); file_put_contents($public, $publicContent);
Log::debug(sprintf('Will store private key with hash "%s" in file "%s"', hash('sha256', $privateContent), $private));
Log::debug(sprintf('Will store public key with hash "%s" in file "%s"', hash('sha256', $publicContent), $public));
Log::debug('Done with generateKeysFromDB()');
return true; return true;
} }
public static function storeKeysInDB(): void public static function storeKeysInDB(): void
{ {
$private = storage_path('oauth-private.key'); $private = storage_path('oauth-private.key');
$public = storage_path('oauth-public.key'); $public = storage_path('oauth-public.key');
FireflyConfig::set(self::PRIVATE_KEY, Crypt::encrypt(file_get_contents($private))); $privateContent = file_get_contents($private);
FireflyConfig::set(self::PUBLIC_KEY, Crypt::encrypt(file_get_contents($public))); $publicContent = file_get_contents($public);
FireflyConfig::set(self::PRIVATE_KEY, Crypt::encrypt($privateContent));
FireflyConfig::set(self::PUBLIC_KEY, Crypt::encrypt($publicContent));
Log::debug(sprintf('Will store the content of file "%s" as "%s" in the database (hash: %s)', $private, self::PRIVATE_KEY, hash('sha256', $privateContent)));
Log::debug(sprintf('Will store the content of file "%s" as "%s" in the database (hash: %s)', $public, self::PUBLIC_KEY, hash('sha256', $publicContent)));
} }
public static function verifyKeysRoutine(): void public static function verifyKeysRoutine(): void