Move api key reset to authenticator, set api_key on registration

includes/controller/users_controller.php

@@ -234,7 +234,7 @@ function user_controller()
     }
 
     if (empty($user_source->api_key)) {
-        User_reset_api_key($user_source, false);
+        auth()->resetApiKey($user_source);
     }
 
     if ($user_source->state->force_active) {

includes/model/User_model.php

@@ -137,22 +137,6 @@ function User_validate_planned_departure_date($planned_arrival_date, $planned_de
     return new ValidationResult(true, $planned_departure_date);
 }
 
-/**
- * Generates a new api key for given user.
- *
- * @param User $user
- * @param bool $log
- */
-function User_reset_api_key($user, $log = true)
-{
-    $user->api_key = bin2hex(random_bytes(32));
-    $user->save();
-
-    if ($log) {
-        engelsystem_log(sprintf('API key resetted (%s).', User_Nick_render($user, true)));
-    }
-}
-
 /**
  * @param User $user
  * @return float

includes/pages/user_myshifts.php

@@ -35,7 +35,8 @@ function user_myshifts()
     $shifts_user = User::find($shift_entry_id);
     if ($request->has('reset')) {
         if ($request->input('reset') == 'ack') {
-            User_reset_api_key($user);
+            auth()->resetApiKey($user);
+            engelsystem_log(sprintf('API key resetted (%s).', User_Nick_render($user, true)));
             success(__('Key changed.'));
             throw_redirect(url('/users', ['action' => 'view', 'user_id' => $shifts_user->id]));
         }

includes/pages/user_shifts.php

@@ -263,7 +263,7 @@ function view_user_shifts()
     $shiftCalendarRenderer = shiftCalendarRendererByShiftFilter($shiftsFilter);
 
     if (empty($user->api_key)) {
-        User_reset_api_key($user, false);
+        auth()->resetApiKey($user);
     }
 
     $filled = [

src/Factories/User.php

@@ -296,17 +296,20 @@ class User
         $defaultGroup = Group::find($this->authenticator->getDefaultRole());
         $user->groups()->attach($defaultGroup);
 
+        auth()->resetApiKey($user);
         if ($this->determineIsPasswordEnabled() && array_key_exists('password', $data)) {
             auth()->setPassword($user, $data['password']);
         }
 
         $assignedAngelTypeNames = $this->assignAngelTypes($user, $rawData);
 
-        $this->logger->info(sprintf(
-            'User %s signed up as: %s',
-            sprintf('%s (%u)', $user->displayName, $user->id),
-            join(', ', $assignedAngelTypeNames),
-        ));
+        $this->logger->info(
+            'User {user} signed up as: {angeltypes}',
+            [
+                'user' => sprintf('%s (%u)', $user->displayName, $user->id),
+                'angeltypes' => join(', ', $assignedAngelTypeNames),
+            ]
+        );
 
         $this->dbConnection->commit();
 

src/Helpers/Authenticator.php

@@ -187,6 +187,12 @@ class Authenticator
         return $this->user;
     }
 
+    public function resetApiKey(User $user): void
+    {
+        $user->api_key = bin2hex(random_bytes(32));
+        $user->save();
+    }
+
     /**
      * Get the user by its api key
      */

tests/Unit/Factories/UserTest.php

@@ -18,6 +18,7 @@ use Engelsystem\Test\Unit\ServiceProviderTest;
 use Engelsystem\Test\Utils\SignUpConfig;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 use Symfony\Component\HttpFoundation\Session\Session;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;
@@ -48,7 +49,7 @@ class UserTest extends ServiceProviderTest
         $this->config->set('oauth', []);
         $this->session = new Session(new MockArraySessionStorage());
         $this->app->instance(SessionInterface::class, $this->session);
-        $this->app->instance(LoggerInterface::class, $this->getMockForAbstractClass(LoggerInterface::class));
+        $this->app->instance(LoggerInterface::class, new NullLogger());
 
         $this->app->instance(ServerRequestInterface::class, new Request());
         $this->app->instance(Authenticator::class, $this->app->make(Authenticator::class));
@@ -112,6 +113,7 @@ class UserTest extends ServiceProviderTest
         $this->assertSame('fritz', $user->name);
         $this->assertSame('fritz@example.com', $user->email);
         $this->assertSame(false, $user->state->arrived);
+        $this->assertNotEmpty($user->api_key);
     }
 
     /**

tests/Unit/Helpers/AuthenticatorTest.php

@@ -12,6 +12,7 @@ use Engelsystem\Models\User\User;
 use Engelsystem\Test\Unit\HasDatabase;
 use Engelsystem\Test\Unit\Helpers\Stub\UserModelImplementation;
 use Engelsystem\Test\Unit\ServiceProviderTest;
+use Illuminate\Support\Str;
 use PHPUnit\Framework\MockObject\MockObject;
 use Psr\Http\Message\ServerRequestInterface;
 use Symfony\Component\HttpFoundation\Session\Session;
@@ -183,6 +184,27 @@ class AuthenticatorTest extends ServiceProviderTest
         $this->assertEquals('F00Bar', $user->api_key);
     }
 
+    /**
+     * @covers \Engelsystem\Helpers\Authenticator::resetApiKey
+     */
+    public function testResetApiKey(): void
+    {
+        $this->initDatabase();
+
+        $user = User::factory()->create();
+        $oldKey = $user->api_key;
+
+        $auth = new Authenticator(new Request(), new Session(new MockArraySessionStorage()), new User());
+        $auth->resetApiKey($user);
+
+        $updatedUser = User::all()->last();
+        $newApiKey = $updatedUser->api_key;
+
+        $this->assertNotEquals($oldKey, $newApiKey);
+        $this->assertTrue(Str::isAscii($newApiKey));
+        $this->assertEquals(64, Str::length($newApiKey));
+    }
+
     /**
      * @covers \Engelsystem\Helpers\Authenticator::can
      */