Fasáda SafeFetch

Všetko ide cez jednu fasádu, RoundlyConsulting\SafeFetch\Facades\SafeFetch (globálny alias SafeFetch), ktorá je skratkou nad singletonom SafeFetchManager, a cez makro Http::safe() na HTTP klientovi Laravelu:

use Illuminate\Support\Facades\Http;
use RoundlyConsulting\SafeFetch\Facades\SafeFetch;

Http::safe()->withToken($token)->post($url, $payload);          // guard any Laravel request
SafeFetch::guard(Http::withToken($token), $policy)->post($url);  // the same, without the macro
SafeFetch::http($policy)->get($url);                             // a new guarded request

$vetted = SafeFetch::vet($url);              // VettedDestination, or DestinationRejected / DestinationUnavailable
SafeFetch::allows($url);                     // bool — never throws a verdict
SafeFetch::precheck($url);                   // CanonicalUrl — every rule except the DNS lookup

$page = SafeFetch::fetch($url, maxBytes: 1_000_000);              // a capped GET into memory
$file = SafeFetch::download($url, $path, maxBytes: 50_000_000);   // the same GET, streamed to a file
SafeFetch::truncated($response);             // was a guarded response cut at maxResponseBytes?

SafeFetch::policy();                         // the configured DestinationPolicy, to tighten or loosen per call
SafeFetch::networks()->isPrivate('169.254.169.254');                    // true — cloud metadata
SafeFetch::urls()->canonicalise('HTTPS://Example.COM.:443/a?b#frag');   // CanonicalUrl: https://example.com/a?b

Metódy manažéra

Po nainštalovaní SafeFetch::fake() sa dá každé overenie fake volať aj na fasáde — pozrite Testovanie. vetHop() je na manažéri verejná, ale interná: je to volanie middleware ochrany pre každý krok, aby fake videl všetky kroky. SafeFetchManager::TRUNCATED_HEADER ('Safe-Fetch-Truncated') pomenúva hlavičku orezania.

Makro Http::safe()

PendingRequest::safe(?DestinationPolicy $policy = null): PendingRequest poskytuje Http::safe(), Http::withToken($t)->safe() aj $pool->safe(). Ak by iný balík zaregistroval makro safe po tomto, potichu by ho nahradil, preto bezpečnostne kritický kód volá SafeFetch::guard() alebo SafeFetch::http().

Dátové objekty

V RoundlyConsulting\SafeFetch\DataTransferObjects, všetky final readonly:

Ďalšie verejné typy: Enums\Reason a výnimky (Verdikty a výnimky), Contracts\HostResolver a Support\SystemHostResolver, Support\PrivateNetworks (URL adresy a blokované siete), Rules\SafeUrl, Commands\CheckCommand, Events\DestinationRefused a Testing\SafeFetchFake, Testing\FakeHostResolver a Testing\RecordedVet. Všetko ostatné v Support\ a Http\ je interné.