Improve API client usability

app/Http/Controllers/Administration/UserController.php

@@ -139,4 +139,48 @@ public function getEmail(): array
 			'email' => $user->email,
 		];
 	}
+
+	/**
+	 * Returns the currently authenticated user.
+	 *
+	 * @return User
+	 */
+	public function getAuthenticatedUser(): User
+	{
+		/** @var User */
+		return Auth::user();
+	}
+
+	/**
+	 * Reset the token of the currently authenticated user.
+	 *
+	 * @return User
+	 *
+	 * @throws \Exception
+	 */
+	public function resetToken(): User
+	{
+		/** @var User $user */
+		$user = Auth::user();
+		$token = strtr(base64_encode(random_bytes(16)), '+/', '-_');
+		$user->token = hash('SHA512', $token);
+		$user->save();
+
+		$user->token = $token;
+
+		return $user;
+	}
+
+	/**
+	 * Disable the token of the currently authenticated user.
+	 *
+	 * @return void
+	 */
+	public function unsetToken(): void
+	{
+		/** @var User $user */
+		$user = Auth::user();
+		$user->token = null;
+		$user->save();
+	}
 }

app/Http/Kernel.php

@@ -85,6 +85,7 @@ class Kernel extends HttpKernel
 			\App\Http\Middleware\VerifyCsrfToken::class,
 			\Illuminate\Routing\Middleware\SubstituteBindings::class,
 			'admin',
+			\App\Http\Middleware\HasUserCheck::class,
 		],
 	];
 

app/Http/Middleware/HasUserCheck.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use App\Contracts\InternalLycheeException;
+use App\Exceptions\UnauthorizedException;
+use App\Http\Middleware\Checks\IsInstalled;
+use Closure;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Auth;
+
+class HasUserCheck
+{
+	private IsInstalled $isInstalled;
+
+	public function __construct(IsInstalled $isInstalled)
+	{
+		$this->isInstalled = $isInstalled;
+	}
+
+	/**
+	 * Handle an incoming request.
+	 *
+	 * @param Request $request
+	 * @param Closure $next
+	 *
+	 * @return mixed
+	 *
+	 * @throws UnauthorizedException
+	 * @throws InternalLycheeException
+	 */
+	public function handle(Request $request, Closure $next): mixed
+	{
+		if (!$this->isInstalled->assert()) {
+			return $next($request);
+		}
+
+		if (!Auth::hasUser()) {
+			throw new UnauthorizedException('Requires authentication');
+		}
+
+		return $next($request);
+	}
+}

app/Http/Middleware/VerifyCsrfToken.php

@@ -2,11 +2,13 @@
 
 namespace App\Http\Middleware;
 
-use App\Models\Configs;
+use App\Exceptions\Internal\QueryBuilderException;
+use App\Models\User;
 use Closure;
 use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;
 use Illuminate\Http\Request;
 use Illuminate\Session\TokenMismatchException;
+use Illuminate\Support\Facades\Auth;
 
 class VerifyCsrfToken extends Middleware
 {
@@ -23,38 +25,28 @@ class VerifyCsrfToken extends Middleware
 
 	/**
 	 * The goal of this function is to allow to bypass the CSRF token requirement
-	 * if an Authorization value is provided in the header and matches the apiKey.
-	 *
-	 * FIXME: Do we want to hash this API key ? Might actually be a good idea...
+	 * if an Authorization value is provided in the header and matches the
+	 * token of a user.
 	 *
 	 * @param Request $request
 	 * @param Closure $next
 	 *
 	 * @return mixed
 	 *
 	 * @throws TokenMismatchException
+	 * @throws QueryBuilderException
 	 */
 	public function handle($request, Closure $next): mixed
 	{
-		if ($request->is('api/*')) {
-			/**
-			 * default value is ''
-			 * we force it in case of the migration has not been done.
-			 */
-			$apiKey = Configs::getValueAsString('api_key');
-
-			/*
-			 * if apiKey is the empty string we directly return the parent handle.
-			 */
-			if ($apiKey === '') {
-				return parent::handle($request, $next);
-			}
+		$token = $request->header('Authorization');
+		if ($request->is('api/*') && is_string($token)) {
+			/** @var User|null $user */
+			$user = User::query()
+				->where('token', '=', hash('SHA512', $token))
+				->first();
+			if ($user instanceof User) {
+				Auth::loginUsingId($user->id);
 
-			/*
-			 * We are currently checking for Authorization.
-			 * Do we also want to check if there is a POST value with the apiKey ?
-			 */
-			if ($request->header('Authorization') === $apiKey) {
 				return $next($request);
 			}
 		}

app/Locale/ChineseSimplified.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => '设置 OpenStreetMap 图层提供者',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => '智能相册',
 			'SHARED_ALBUMS' => '已共享的相册',

app/Locale/ChineseTraditional.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => '設置OpenStreetMap圖層提供者',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => '智能相簿',
 			'SHARED_ALBUMS' => '共享的相簿',

app/Locale/Czech.php

@@ -56,6 +56,12 @@ public function get_locale(): array
 			'SAVE_RISK' => 'Uložit změny, rizika jsou mi známa!',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Chytrá alba',
 			'SHARED_ALBUMS' => 'Sdílená alba',

app/Locale/Dutch.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Set OpenStreetMap tiles provider',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Slimme albums',
 			'SHARED_ALBUMS' => 'Shared albums',

app/Locale/English.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Set OpenStreetMap tiles provider',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Smart albums',
 			'SHARED_ALBUMS' => 'Shared albums',

app/Locale/French.php

@@ -58,6 +58,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Selectioner le fournisseur de données cartographiques',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Smart Albums',
 			'SHARED_ALBUMS' => 'Albums partagés',

app/Locale/German.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Speichere Provider für OpenStreetMap Karten',
 			'FULL_SETTINGS' => 'Alle Einstellungen',
 			'UPDATE' => 'Update',
+			'RESET' => 'Zurücksetzen',
+			'DISABLE_TOKEN_TOOLTIP' => 'Deaktivieren',
+			'ENABLE_TOKEN' => 'API-Schlüssel aktivieren',
+			'DISABLED_TOKEN_STATUS_MSG' => 'Deaktiviert',
+			'TOKEN_BUTTON' => 'API-Schlüssel ...',
+			'TOKEN_NOT_AVAILABLE' => 'Sie haben diesen Schlüssel bereits angesehen.',
 
 			'SAVE_RISK' => 'Änderungen speichern, ich kenne das Risiko!',
 

app/Locale/Greek.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Set OpenStreetMap tiles provider',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Έξυπνα λευκώματα',
 			'SHARED_ALBUMS' => 'Κοινόχρηστα λευκώματα',

app/Locale/Italian.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Set OpenStreetMap tiles provider',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Album smart',
 			'SHARED_ALBUMS' => 'Album condivisi',

app/Locale/NorwegianBokmal.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Lagre leverandør for OpenStreetMap fliser',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Automatiske album',
 			'SHARED_ALBUMS' => 'Delte album',

app/Locale/Polish.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Set OpenStreetMap tiles provider',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Inteligentne albumy',
 			'SHARED_ALBUMS' => 'Udostępnione albumy',

app/Locale/Portuguese.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Escolher OpenStreetMap tiles provider',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Smart álbums',
 			'SHARED_ALBUMS' => 'Álbums partilhados',

app/Locale/Russian.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Set OpenStreetMap tiles provider',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Метаальбомы',
 			'SHARED_ALBUMS' => 'Общие альбомы',

app/Locale/Slovak.php

@@ -56,6 +56,12 @@ public function get_locale(): array
 			'SAVE_RISK' => 'Zmeny uložiť, riziko je známe!',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Inteligentné albumy',
 			'SHARED_ALBUMS' => 'Zdieľané albumy',

app/Locale/Spanish.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Set OpenStreetMap tiles provider',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Álbumes inteligentes',
 			'SHARED_ALBUMS' => 'Álbumes compartidos',

app/Locale/Swedish.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Set OpenStreetMap tiles provider',
 			'FULL_SETTINGS' => 'Full Settings',
 			'UPDATE' => 'Update',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Smarta album',
 			'SHARED_ALBUMS' => 'Shared albums',

app/Locale/Vietnamese.php

@@ -55,6 +55,12 @@ public function get_locale(): array
 			'SET_MAP_PROVIDER' => 'Cài đặt nhà cung cấp ô bản đồ OpenStreetMap',
 			'FULL_SETTINGS' => 'Toàn bộ cài đặt',
 			'UPDATE' => 'Cập nhật',
+			'RESET' => 'Reset',
+			'DISABLE_TOKEN_TOOLTIP' => 'Disable',
+			'ENABLE_TOKEN' => 'Enable API token',
+			'DISABLED_TOKEN_STATUS_MSG' => 'disabled',
+			'TOKEN_BUTTON' => 'API token ...',
+			'TOKEN_NOT_AVAILABLE' => 'You already viewed this token.',
 
 			'SMART_ALBUMS' => 'Những album thông minh',
 			'SHARED_ALBUMS' => 'Những album được chia sẻ',