Merge pull request #10 from TomHAnderson/feature/regenerate

Add command to regenerate api_key

Author: TomHAnderson

README.md

@@ -142,6 +142,11 @@ Unassign a Scope from an ApiKey
 php artisan apikey:scope:remove {apiKeyName} {scopeName}
 ```
 
+Regenerate an ApiKey (assign a new Bearer token)
+```shell
+php artisan apikey:regenerate {name}
+```
+
 Delete a Scope
 ```shell
 php artisan apikey:scope:delete {scopeName}

src/Console/Command/RegenerateApiKey.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiSkeletons\Laravel\Doctrine\ApiKey\Console\Command;
+
+use ApiSkeletons\Laravel\Doctrine\ApiKey\Entity\ApiKey;
+
+// phpcs:disable SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingAnyTypeHint
+final class RegenerateApiKey extends Command
+{
+    /**
+     * The name and signature of the console command.
+     */
+    protected $signature = 'apikey:regenerate {name}';
+
+    /**
+     * The console command description.
+     */
+    protected $description = 'Regenerate an apikey';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): mixed
+    {
+        $name = $this->argument('name');
+
+        $apiKeyRepository = $this->apiKeyService->getEntityManager()
+            ->getRepository(ApiKey::class);
+
+        $apiKey = $apiKeyRepository->findOneBy(['name' => $name]);
+
+        if (! $apiKey) {
+            $this->error('ApiKey not found by name: ' . $name);
+
+            return 1;
+        }
+
+        $apiKey = $apiKeyRepository->regenerate($apiKey);
+
+        $this->apiKeyService->getEntityManager()->flush();
+        $this->printApiKeys([$apiKey]);
+
+        return 0;
+    }
+}

src/Repository/ApiKeyRepository.php

@@ -13,13 +13,21 @@
 use ApiSkeletons\Laravel\Doctrine\ApiKey\Exception\InvalidName;
 use DateTime;
 use Doctrine\ORM\EntityRepository;
+use Doctrine\ORM\ORMException;
 use Illuminate\Support\Str;
 
 use function preg_match;
 use function request;
 
 class ApiKeyRepository extends EntityRepository
 {
+    /**
+     * Create a new ApiKey entity
+     *
+     * @throws DuplicateName
+     * @throws InvalidName
+     * @throws ORMException
+     */
     public function generate(string $name): ApiKey
     {
         // Verify name is unique
@@ -33,9 +41,7 @@ public function generate(string $name): ApiKey
             throw new InvalidName('Please provide a valid name: [a-z0-9-]');
         }
 
-        do {
-            $key = Str::random(64);
-        } while ($this->findBy(['api_key' => $key]));
+        $key = $this->generateKey();
 
         $apiKey = new ApiKey();
         $apiKey
@@ -51,6 +57,31 @@ public function generate(string $name): ApiKey
         return $apiKey;
     }
 
+    /**
+     * Assign a new api_key to an existing ApiKey entity
+     */
+    public function regenerate(ApiKey $apiKey): ApiKey
+    {
+        $apiKey->setApiKey($this->generateKey());
+
+        return $apiKey;
+    }
+
+    /**
+     * Generate a unique api_key
+     */
+    protected function generateKey(): string
+    {
+        do {
+            $key = Str::random(64);
+        } while ($this->findBy(['api_key' => $key]));
+
+        return $key;
+    }
+
+    /**
+     * Change the active status of an ApiKey entity
+     */
     public function updateActive(ApiKey $apiKey, bool $status): ApiKey
     {
         $apiKey
@@ -63,6 +94,11 @@ public function updateActive(ApiKey $apiKey, bool $status): ApiKey
         return $apiKey;
     }
 
+    /**
+     * Add an existing scope to an existing ApiKey entity
+     *
+     * @throws DuplicateScopeForApiKey
+     */
     public function addScope(ApiKey $apiKey, Scope $scope): ApiKey
     {
         // Do not add scopes twice
@@ -80,6 +116,11 @@ public function addScope(ApiKey $apiKey, Scope $scope): ApiKey
         return $apiKey;
     }
 
+    /**
+     * Remove a scope from an ApiKey
+     *
+     * @throws ApiKeyDoesNotHaveScope
+     */
     public function removeScope(ApiKey $apiKey, Scope $scope): ApiKey
     {
         $found = false;
@@ -104,11 +145,17 @@ public function removeScope(ApiKey $apiKey, Scope $scope): ApiKey
         return $apiKey;
     }
 
+    /**
+     * Validate an API key name
+     */
     public function isValidName(string $name): bool
     {
         return (bool) preg_match('/^[a-z0-9-]{1,255}$/', $name);
     }
 
+    /**
+     * Create a new entity for logging admin events whenever one is triggered
+     */
     protected function logAdminEvent(ApiKey $apiKey, string $eventName): AdminEvent
     {
         $adminEvent = (new AdminEvent())

src/ServiceProvider.php

@@ -35,6 +35,7 @@ public function boot(): void
                 Console\Command\GenerateScope::class,
                 Console\Command\PrintApiKey::class,
                 Console\Command\PrintScope::class,
+                Console\Command\RegenerateApiKey::class,
                 Console\Command\RemoveScope::class,
             ]);
         }

test/Feature/Console/Command/RegenerateApiKeyTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace ApiSkeletonsTest\Laravel\Doctrine\ApiKey\Feature\Console\Command;
+
+use ApiSkeletons\Laravel\Doctrine\ApiKey\Entity\ApiKey;
+use ApiSkeletons\Laravel\Doctrine\ApiKey\Entity\Scope;
+use ApiSkeletonsTest\Laravel\Doctrine\ApiKey\TestCase;
+use DateTime;
+
+final class ReenerateApiKeyTest extends TestCase
+{
+    public function testReenerateApiKey(): void
+    {
+        $entityManager = $this->createDatabase(app('em'));
+
+        $apiKey =  $entityManager->getRepository(ApiKey::class)
+            ->generate('testing');
+        $entityManager->flush();
+
+        $this->artisan('apikey:regenerate', [
+            'name' => 'testing',
+        ])->assertExitCode(0);
+    }
+
+    public function testInvalidNameThrowsError(): void
+    {
+        $this->createDatabase(app('em'));
+
+        $this->artisan('apikey:regenerate', [
+            'name' => 'test^ing',
+        ])->assertExitCode(1);
+    }
+}

test/Feature/Repository/ApiKeyRepositoryTest.php

@@ -36,6 +36,20 @@ public function testGenerate(): void
         }
     }
 
+    public function testRegenerate(): void
+    {
+        $entityManager = $this->createDatabase(app('em'));
+        $repository = $entityManager->getRepository(ApiKey::class);
+
+        $apiKey = $repository->generate('testing');
+        $entityManager->flush();
+
+        $oldKey = $apiKey->getApiKey();
+        $apiKey = $repository->regenerate($apiKey);
+
+        $this->assertNotEquals($oldKey, $apiKey->getApiKey());
+    }
+
     public function testGenerateValidatesName(): void
     {
         $this->expectException(InvalidName::class);