Middleware, pravidlo a scopes

Odporúčané poradie: sentinel.signed → auth → sentinel.idempotent → (route-model binding) → sentinel.verified.

sentinel.verified

Route::get('/invoices/{invoice}', ShowInvoice::class)->middleware('sentinel.verified');
Route::put('/invoices/{invoice}/lines/{line}', UpdateLine::class)->middleware('sentinel.verified:invoice@financial');

• Beží po route-model bindingu — ak ho deklarujete ako middleware routy v skupinách web alebo api, platí to automaticky. Pomenovaný parameter bez @seal overí všetky pečate daného modelu.
• Zlyhanie pri middleware.verified_reaction = abort (predvolené) vyhodí SealVerificationFailedHttpException: status middleware.verified_status (409) a všeobecnú preloženú správu — stav ani dôvod sa klientovi nikdy neprezradia. Jej getPrevious() je TamperedModelException pre report() vo vašom exception handleri.
• S report sa zistenie nahlási (TamperDetected, log) a požiadavka pokračuje.
• Pomenovaný parameter, ktorý nie je naviazaný alebo nie je zapečatiteľný, vyhodí SealingMisconfiguredException (500, bezpečné zlyhanie).

Typované parametre

Každý middleware má statického pomocníka, ktorý sa overí už pri deklarácii routy — preklep zlyhá pri načítaní rout, nie až pri požiadavke:

use RoundlyConsulting\Sentinel\Http\Middleware\EnsureIdempotency;
use RoundlyConsulting\Sentinel\Http\Middleware\VerifyHttpSignature;
use RoundlyConsulting\Sentinel\Http\Middleware\VerifySeals;

Route::put('/invoices/{invoice}', UpdateInvoice::class)->middleware(VerifySeals::using('invoice@financial'));
Route::post('/orders', StoreOrder::class)->middleware(EnsureIdempotency::required(ttl: 3600));
Route::post('/partner/events', PartnerEvents::class)->middleware(VerifyHttpSignature::profile('partners'));

IntactSeal a verifySeals()

use RoundlyConsulting\Sentinel\Rules\IntactSeal;

$request->validate([
    'invoice_id' => ['required', new IntactSeal(Invoice::class, seal: 'financial')],                        // the key
    'invoice_number' => ['required', new IntactSeal(Invoice::class, seal: 'financial', column: 'number')],  // a unique column
]);

$report = Invoice::query()->withSeals()->get()->verifySeals();   // reuses the eager-loaded seals
Invoice::query()->whereSealed()->count();
Invoice::query()->whereNotSealed('identity')->get();

new IntactSeal(string $model, ?string $seal = null, ?string $column = null): vstupom je kľúč modelu alebo hodnota stĺpca column — neplatný názov stĺpca vyhodí SealingMisconfiguredException::invalidColumn už pri vytvorení pravidla, nie pri jeho behu. Model sa načíta s pozastaveným overením pri načítaní a potom sa overí (jedna pečať, alebo všetky, ak žiadnu neuvediete): chýbajúci model zlyhá ako exists, model, ktorý nie je neporušený, so sentinel::validation.intact_seal — stav ani dôvod sa neprezradia.

Makrá

Makrá HTTP klienta sa registrujú na PendingRequest pri štarte a verifySeals() na Eloquent kolekciách — každé len vtedy, ak makro s rovnakým názvom ešte neexistuje.

Query scopes

Invoice::query()->whereSealed()->get();               // has a seal row for the default seal
Invoice::query()->whereSealed('identity')->get();
Invoice::query()->whereNotSealed()->count();          // no seal row (unsealed or deleted)
Invoice::query()->withSeals()->get();                 // eager-load sentinelSeals

$invoice->sentinelSeals je vzťah MorphMany k uloženým riadkom Models\Seal.