> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Eigene Auth-Guards implementieren

> Verstehen Sie die interne Struktur des Laravel-Authentifizierungssystems und lernen Sie auf Quellcode-Ebene, wie Sie eigene Auth-Guards über die Interfaces Guard und StatefulGuard implementieren.

## Interne Struktur der Laravel-Authentifizierung

### Die Facade `Auth` und `AuthManager`

Die Facade `Auth` ist ein Proxy für `Illuminate\Auth\AuthManager`. Der `AuthManager` verwaltet mehrere Guards nach dem Driver-Muster und erzeugt bzw. cacht anhand von `config/auth.php` die passende Guard-Instanz.

```php theme={null}
// Interne Verarbeitung von Auth::guard('web') (vereinfachtes AuthManager::guard())
public function guard($name = null)
{
    $name = $name ?: $this->getDefaultDriver();

    return $this->guards[$name] ?? ($this->guards[$name] = $this->resolve($name));
}
```

`resolve()` liest den `driver`-Key aus dem `guards`-Array in `config/auth.php` und ruft die zugehörige Factory-Closure auf. Die eingebauten Treiber `session` und `token` sind auf dieselbe Weise registriert.

### Unterschied zwischen `Guard`- und `StatefulGuard`-Interface

Ein Auth-Guard muss mindestens `Illuminate\Contracts\Auth\Guard` implementieren. Wenn Sie eine Sitzung aufrechterhalten wollen, implementieren Sie `StatefulGuard`.

<Accordion title="Guard-Interface (Illuminate\Contracts\Auth\Guard)">
  ```php theme={null}
  interface Guard
  {
      // Ist ein authentifizierter Nutzer vorhanden?
      public function check();

      // Handelt es sich um einen Gast (unauthentifiziert)?
      public function guest();

      // Aktuellen authentifizierten Nutzer zurückgeben (null bei Gast)
      public function user();

      // ID des aktuellen Nutzers zurückgeben
      public function id();

      // Prüfen, ob die Credentials gültig sind (ohne Login)
      public function validate(array $credentials = []);

      // Ist ein Nutzer gesetzt (auch ohne Login via setUser injizierbar)?
      public function hasUser();

      // Nutzer manuell setzen
      public function setUser(Authenticatable $user);
  }
  ```
</Accordion>

<Accordion title="StatefulGuard-Interface (Illuminate\Contracts\Auth\StatefulGuard)">
  `StatefulGuard` erbt von `Guard` und ergänzt Methoden zur Sitzungshaltung via Session/Cookies.

  ```php theme={null}
  interface StatefulGuard extends Guard
  {
      // Credentials prüfen und einloggen (mit remember-Flag)
      public function attempt(array $credentials = [], $remember = false);

      // Nur für einen Request authentifizieren, ohne Session zu speichern
      public function once(array $credentials = []);

      // Eine Nutzerinstanz direkt einloggen
      public function login(Authenticatable $user, $remember = false);

      // Per ID einloggen
      public function loginUsingId($id, $remember = false);

      // Per ID nur für einen Request authentifizieren
      public function onceUsingId($id);

      // Prüfen, ob per "Angemeldet bleiben"-Cookie eingeloggt wurde
      public function viaRemember();

      // Ausloggen
      public function logout();
  }
  ```
</Accordion>

<Info>
  Für Guards, die keine Session benötigen — z. B. API-Auth oder eigene Tokens —, reicht `Guard`. Für Admin-Logins mit Session implementieren Sie `StatefulGuard`.
</Info>

## Eigenen Guard implementieren

### Der Trait `GuardHelpers`

Die Methoden `check()`, `guest()`, `id()`, `hasUser()` des `Guard`-Interfaces sind fast immer gleich. Laravel bietet daher den Trait `Illuminate\Auth\GuardHelpers`. Damit müssen Sie nur `user()` und `validate()` implementieren.

```php theme={null}
// Standardimplementierung aus GuardHelpers (Auszug)
trait GuardHelpers
{
    protected $user;

    public function check(): bool
    {
        return ! is_null($this->user());
    }

    public function guest(): bool
    {
        return ! $this->check();
    }

    public function id(): mixed
    {
        return $this->user()?->getAuthIdentifier();
    }

    public function hasUser(): bool
    {
        return ! is_null($this->user);
    }

    public function setUser(Authenticatable $user): static
    {
        $this->user = $user;
        return $this;
    }
}
```

### Beispiel: API-Token-Guard

In Anlehnung an `TokenGuard` implementieren wir einen einfachen API-Token-Guard. Er liest das Token aus Header oder Query und löst den Nutzer über `UserProvider` auf.

<Steps>
  <Step title="Guard-Klasse anlegen">
    Legen Sie die Klasse unter `app/Auth` an.

    ```php theme={null}
    <?php

    namespace App\Auth;

    use Illuminate\Auth\GuardHelpers;
    use Illuminate\Contracts\Auth\Guard;
    use Illuminate\Contracts\Auth\UserProvider;
    use Illuminate\Http\Request;

    class ApiTokenGuard implements Guard
    {
        use GuardHelpers;

        protected Request $request;

        public function __construct(UserProvider $provider, Request $request)
        {
            $this->provider = $provider;
            $this->request = $request;
        }

        /**
         * Aktuellen authentifizierten Nutzer zurückgeben
         */
        public function user(): ?\Illuminate\Contracts\Auth\Authenticatable
        {
            // Gecachten Nutzer zurückgeben, falls vorhanden
            if (! is_null($this->user)) {
                return $this->user;
            }

            $token = $this->getTokenForRequest();

            if (empty($token)) {
                return null;
            }

            // Nutzer über UserProvider laden
            $this->user = $this->provider->retrieveByCredentials([
                'api_token' => $token,
            ]);

            return $this->user;
        }

        /**
         * Credentials nur validieren (kein Login)
         */
        public function validate(array $credentials = []): bool
        {
            if (empty($credentials['api_token'])) {
                return false;
            }

            return (bool) $this->provider->retrieveByCredentials($credentials);
        }

        /**
         * Token aus dem Request holen
         *
         * Reihenfolge: Bearer-Header → Query-Parameter → Request-Body
         */
        protected function getTokenForRequest(): ?string
        {
            $token = $this->request->bearerToken();

            if (empty($token)) {
                $token = $this->request->query('api_token');
            }

            if (empty($token)) {
                $token = $this->request->input('api_token');
            }

            return $token ?: null;
        }

        /**
         * Request austauschen
         */
        public function setRequest(Request $request): static
        {
            $this->request = $request;
            return $this;
        }
    }
    ```
  </Step>

  <Step title="Guard im Service Provider registrieren">
    Registrieren Sie den Guard im `boot()` des `AppServiceProvider` per `Auth::extend()`.

    ```php theme={null}
    <?php

    namespace App\Providers;

    use App\Auth\ApiTokenGuard;
    use Illuminate\Contracts\Foundation\Application;
    use Illuminate\Support\Facades\Auth;
    use Illuminate\Support\ServiceProvider;

    class AppServiceProvider extends ServiceProvider
    {
        public function boot(): void
        {
            Auth::extend('api-token', function (Application $app, string $name, array $config) {
                // Provider aus der Config über Auth::createUserProvider() auflösen
                $provider = Auth::createUserProvider($config['provider'] ?? 'users');

                return new ApiTokenGuard($provider, $app->make('request'));
            });
        }
    }
    ```

    <Info>
      `Auth::createUserProvider()` liest `providers` aus `config/auth.php` und gibt die passende `UserProvider`-Instanz zurück. Solange Sie keinen eigenen Provider bauen, erhalten Sie damit den Standard-`EloquentUserProvider`.
    </Info>
  </Step>

  <Step title="Guard in config/auth.php konfigurieren">
    Ergänzen Sie den Guard in `config/auth.php`.

    ```php theme={null}
    'guards' => [
        'web' => [
            'driver'   => 'session',
            'provider' => 'users',
        ],

        // Ergänzter eigener Guard
        'api' => [
            'driver'   => 'api-token', // Muss dem ersten Argument von Auth::extend() entsprechen
            'provider' => 'users',
        ],
    ],
    ```
  </Step>

  <Step title="Guard auf Routen anwenden">
    Übergeben Sie den Guard-Namen an die `auth`-Middleware.

    ```php theme={null}
    // routes/api.php
    use Illuminate\Support\Facades\Route;

    Route::middleware('auth:api')->group(function () {
        Route::get('/user', function () {
            return auth()->user();
        });

        Route::get('/posts', [\App\Http\Controllers\PostController::class, 'index']);
    });
    ```

    Im Controller oder Code verwenden Sie den Guard über `Auth::guard('api')` oder `auth('api')`.

    ```php theme={null}
    $user = Auth::guard('api')->user();
    ```
  </Step>
</Steps>

## Einfache Guards per Closure

Mit `Auth::viaRequest()` definieren Sie einen Guard ohne Klasse — praktisch für Prototypen und sehr einfache Auth.

```php theme={null}
use Illuminate\Http\Request;
use App\Models\User;

// In AppServiceProvider::boot()
Auth::viaRequest('custom-token', function (Request $request): ?User {
    $token = $request->bearerToken();

    if (empty($token)) {
        return null;
    }

    return User::where('api_token', $token)->first();
});
```

Konfiguration in `config/auth.php`:

```php theme={null}
'guards' => [
    'api' => [
        'driver' => 'custom-token',
    ],
],
```

<Warning>
  Ein per `Auth::viaRequest()` definierter Guard nutzt keinen `UserProvider`; Provider-Methoden wie `retrieveById()` funktionieren nicht. Für Produktion empfehlen wir klassenbasierte Guards per `Auth::extend()`.
</Warning>

## Einen eigenen `UserProvider` implementieren

Wenn Nutzerinformationen nicht aus der Datenbank stammen (externe API, LDAP …), implementieren Sie `Illuminate\Contracts\Auth\UserProvider`.

```php theme={null}
<?php

namespace App\Auth;

use App\Models\User;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Contracts\Auth\UserProvider;

class ApiUserProvider implements UserProvider
{
    public function __construct(
        protected string $apiBaseUrl,
        protected string $model = User::class,
    ) {}

    /**
     * Nutzer per ID laden
     */
    public function retrieveById(mixed $identifier): ?Authenticatable
    {
        return ($this->model)::find($identifier);
    }

    /**
     * Nutzer über "Angemeldet bleiben"-Token laden
     * Für Guards ohne Session reicht null
     */
    public function retrieveByToken(mixed $identifier, string $token): ?Authenticatable
    {
        return null;
    }

    /**
     * "Angemeldet bleiben"-Token aktualisieren
     * Für Guards ohne Session leer lassen
     */
    public function updateRememberToken(Authenticatable $user, string $token): void {}

    /**
     * Nutzer per Credentials laden
     * Wird von validate() und user() des Guards aufgerufen
     */
    public function retrieveByCredentials(array $credentials): ?Authenticatable
    {
        if (empty($credentials['api_token'])) {
            return null;
        }

        // Beispiel: Token an externer API prüfen und Nutzerinfo holen
        $response = \Illuminate\Support\Facades\Http::withToken($credentials['api_token'])
            ->get("{$this->apiBaseUrl}/auth/me");

        if (! $response->successful()) {
            return null;
        }

        $data = $response->json();

        // Mit lokalem Nutzer verknüpfen oder Modell dynamisch anlegen
        return User::firstOrCreate(
            ['external_id' => $data['id']],
            ['name' => $data['name'], 'email' => $data['email']],
        );
    }

    /**
     * Credentials des geladenen Nutzers prüfen
     * Bei Token-Auth genügt true, wenn retrieveByCredentials erfolgreich war
     */
    public function validateCredentials(Authenticatable $user, array $credentials): bool
    {
        return true;
    }

    /**
     * Muss das Passwort neu gehasht werden?
     * Bei Token-Auth immer false
     */
    public function rehashPasswordIfRequired(Authenticatable $user, array $credentials, bool $force = false): void {}
}
```

### Eigenen `UserProvider` registrieren

```php theme={null}
// AppServiceProvider::boot()
Auth::provider('api-user', function (Application $app, array $config) {
    return new \App\Auth\ApiUserProvider(
        config('services.auth_api.base_url'),
        $config['model'] ?? \App\Models\User::class,
    );
});
```

Ergänzung im `providers`-Abschnitt von `config/auth.php`:

```php theme={null}
'providers' => [
    'users' => [
        'driver' => 'eloquent',
        'model'  => App\Models\User::class,
    ],

    // Eigener Provider
    'api-users' => [
        'driver' => 'api-user',
        'model'  => App\Models\User::class,
    ],
],
```

Kombinieren von Guard und Provider:

```php theme={null}
'guards' => [
    'api' => [
        'driver'   => 'api-token',
        'provider' => 'api-users', // Eigenen Provider angeben
    ],
],
```

## Praktische Anwendungsfälle

### Multi-Auth (getrennter Guard für Admins und Nutzer)

<Steps>
  <Step title="Admin-Modell erstellen">
    Legen Sie ein Eloquent-Modell für Administratoren an. Durch Ableiten von `Authenticatable` funktioniert es mit dem Auth-System.

    ```bash theme={null}
    php artisan make:model Admin -m
    ```

    ```php theme={null}
    <?php

    namespace App\Models;

    use Illuminate\Foundation\Auth\User as Authenticatable;

    class Admin extends Authenticatable
    {
        protected $fillable = ['name', 'email', 'password'];

        protected $hidden = ['password', 'remember_token'];
    }
    ```
  </Step>

  <Step title="config/auth.php konfigurieren">
    ```php theme={null}
    'guards' => [
        'web' => [
            'driver'   => 'session',
            'provider' => 'users',
        ],
        'admin' => [
            'driver'   => 'session',
            'provider' => 'admins', // Admin-Provider
        ],
    ],

    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model'  => App\Models\User::class,
        ],
        'admins' => [
            'driver' => 'eloquent',
            'model'  => App\Models\Admin::class, // Admin-Modell
        ],
    ],
    ```
  </Step>

  <Step title="Routen und Middleware definieren">
    ```php theme={null}
    // routes/web.php

    // Reguläre Nutzer-Routen (Default-Guard web)
    Route::middleware('auth')->group(function () {
        Route::get('/dashboard', [DashboardController::class, 'index']);
    });

    // Admin-Routen (admin-Guard)
    Route::prefix('admin')->middleware('auth:admin')->group(function () {
        Route::get('/dashboard', [AdminDashboardController::class, 'index']);
    });
    ```
  </Step>

  <Step title="Login mit spezifiziertem Guard">
    ```php theme={null}
    <?php

    namespace App\Http\Controllers\Admin;

    use Illuminate\Http\Request;
    use Illuminate\Support\Facades\Auth;

    class LoginController extends Controller
    {
        public function store(Request $request)
        {
            $credentials = $request->validate([
                'email'    => 'required|email',
                'password' => 'required',
            ]);

            // Explizit den admin-Guard verwenden
            if (Auth::guard('admin')->attempt($credentials)) {
                $request->session()->regenerate();
                return redirect()->intended('/admin/dashboard');
            }

            return back()->withErrors(['email' => 'Anmeldedaten sind ungültig.']);
        }

        public function destroy(Request $request)
        {
            Auth::guard('admin')->logout();
            $request->session()->invalidate();
            $request->session()->regenerateToken();

            return redirect('/admin/login');
        }
    }
    ```
  </Step>
</Steps>

### Externe API-Authentifizierung per JWT

Beispiel für einen Guard, der einen externen JWT-Auth-Dienst nutzt.

```php theme={null}
<?php

namespace App\Auth;

use App\Models\User;
use Illuminate\Auth\GuardHelpers;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Contracts\Auth\UserProvider;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Http;

class JwtGuard implements Guard
{
    use GuardHelpers;

    protected Request $request;
    protected ?array $payload = null;

    public function __construct(UserProvider $provider, Request $request)
    {
        $this->provider = $provider;
        $this->request  = $request;
    }

    public function user(): ?\Illuminate\Contracts\Auth\Authenticatable
    {
        if (! is_null($this->user)) {
            return $this->user;
        }

        $token = $this->request->bearerToken();

        if (empty($token)) {
            return null;
        }

        // JWT beim externen Dienst prüfen
        $payload = $this->verifyToken($token);

        if (is_null($payload)) {
            return null;
        }

        $this->payload = $payload;

        $this->user = $this->provider->retrieveById($payload['sub']);

        return $this->user;
    }

    public function validate(array $credentials = []): bool
    {
        if (empty($credentials['token'])) {
            return false;
        }

        return ! is_null($this->verifyToken($credentials['token']));
    }

    /**
     * JWT prüfen und Payload zurückgeben
     */
    protected function verifyToken(string $token): ?array
    {
        $response = Http::withToken($token)
            ->get(config('services.auth.verify_url'));

        if (! $response->successful()) {
            return null;
        }

        return $response->json();
    }

    /**
     * Validiertes JWT-Payload liefern
     */
    public function payload(): ?array
    {
        return $this->payload;
    }
}
```

Registrierung im `AppServiceProvider`:

```php theme={null}
Auth::extend('jwt', function (Application $app, string $name, array $config) {
    return new \App\Auth\JwtGuard(
        Auth::createUserProvider($config['provider'] ?? 'users'),
        $app->make('request'),
    );
});
```

<Tip>
  Sie können auch guard-spezifische Methoden nutzen: `Auth::guard('jwt')->payload()`. `Auth::guard()` liefert die Guard-Instanz selbst — daher sind auch Methoden außerhalb des Interfaces erreichbar.
</Tip>

## Tests

In Unit-Tests eines eigenen Guards mocken Sie den `UserProvider` und prüfen das Verhalten.

```php theme={null}
<?php

namespace Tests\Unit\Auth;

use App\Auth\ApiTokenGuard;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Contracts\Auth\UserProvider;
use Illuminate\Http\Request;
use PHPUnit\Framework\MockObject\MockObject;
use Tests\TestCase;

class ApiTokenGuardTest extends TestCase
{
    private UserProvider&MockObject $provider;
    private ApiTokenGuard $guard;

    protected function setUp(): void
    {
        parent::setUp();

        $this->provider = $this->createMock(UserProvider::class);
    }

    public function test_user_returns_null_when_no_token(): void
    {
        $request = Request::create('/');
        $guard   = new ApiTokenGuard($this->provider, $request);

        $this->assertNull($guard->user());
    }

    public function test_user_returns_user_with_valid_bearer_token(): void
    {
        $mockUser = $this->createMock(Authenticatable::class);

        $this->provider
            ->expects($this->once())
            ->method('retrieveByCredentials')
            ->with(['api_token' => 'valid-token'])
            ->willReturn($mockUser);

        $request = Request::create('/');
        $request->headers->set('Authorization', 'Bearer valid-token');

        $guard = new ApiTokenGuard($this->provider, $request);

        $this->assertSame($mockUser, $guard->user());
    }

    public function test_check_returns_false_when_no_token(): void
    {
        $request = Request::create('/');
        $guard   = new ApiTokenGuard($this->provider, $request);

        $this->assertFalse($guard->check());
    }

    public function test_validate_returns_false_without_api_token_credential(): void
    {
        $request = Request::create('/');
        $guard   = new ApiTokenGuard($this->provider, $request);

        $this->assertFalse($guard->validate([]));
    }
}
```

In Feature-Tests können Sie per `ActingAs` einen Nutzer für einen bestimmten Guard setzen.

```php theme={null}
// Für einen bestimmten Guard authentifizieren und testen
$this->actingAs($user, 'api')
    ->getJson('/api/user')
    ->assertOk();
```

## Verwandte Seiten

<Card title="Authentifizierung (Einstieg)" icon="shield-check" href="/de/authentication">
  Starter-Kits und Standard-Auth-Flows.
</Card>

<Card title="Service Container" icon="box" href="/de/service-container">
  Verstehen Sie den Service Container, den die Guard-Registrierung nutzt.
</Card>


## Related topics

- [GeneratorCommand — Eigene make:-Befehle implementieren](/de/advanced/generator-command.md)
- [Eigene Validierungsregeln](/de/advanced/custom-validation-rules.md)
- [Laravel Fortify und Starter-Kits](/de/advanced/fortify.md)
- [Eigene Casts in Eloquent](/de/advanced/eloquent-casts.md)
- [Einen eigenen Provider für das AI SDK erstellen](/de/advanced/ai-sdk-custom-provider.md)