Laravel

Installation

1

composer require botbye/botbye-php-sdk

Configuration

Register the standalone BotbyePhishingClient in your AppServiceProvider. Phishing is separate from the evaluate BotbyeClient, is identified by a public, browser-safe clientKey, and only needs a PSR-18 HTTP client and a PSR-17 request factory (no server key, no stream factory). Registered as a singleton, on first use it makes a one-off, process-wide-guarded, best-effort server-integration init handshake that reports this server-side integration to BotBye; it is non-blocking.

Getting clientKey

clientKey is the public, browser-safe identifier of your phishing project. It travels in the asset URL path, so it is safe to expose — no secret token and no Base64 encoding are required.

Find it on the Get Started screen of your phishing project in the BotBye dashboard.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

<?php

namespace App\Providers;

use Botbye\Phishing\BotbyePhishingClient;
use Botbye\Phishing\BotbyePhishingConfig;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\HttpFactory;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        $this->app->singleton(BotbyePhishingClient::class, function () {
            $httpClient = new Client(['timeout' => 2.0]);
            $factory = new HttpFactory();

            return new BotbyePhishingClient(
                new BotbyePhishingConfig(
                    endpoint: 'https://verify.botbye.com',
                    clientKey: '<public-client-key>',
                ),
                httpClient: $httpClient,
                requestFactory: $factory,
            );
        });
    }
}

Usage

Anti-phishing needs two routes on your own origin: an SVG route — the URL your client code passes to getCatcher({ url }) — and a PNG route that the SVG references. The paths are arbitrary, so name them like ordinary static assets and let the route decide the format. A path that spells out the vendor or the feature (/api/phishing/…) is what a copied page is searched for and stripped of, and a format query param on the pixel URL reads the same way.

On the SVG route, pass innerPngUrl — the absolute URL of your PNG route: the returned SVG embeds it as its tracking pixel. It is required: the SVG catcher takes it as a constructor argument, so an SVG asset without one does not compile, and a blank one is rejected on the spot rather than reaching the wire. Build that URL from your own host — image_id is owned by the SDK and is not read from the forwarded query. skipExecution defaults to true, the script-less SVG; pass false only for browsers predating crossorigin on svg <image> (Chrome 118, Firefox 114, Safari 17.2), where the script-driven variant is the one that still reports.

These examples forward no query: format, image_id and executable are set by the call itself, and only module_name / module_version pass through from the browser's pixel query — which a catcher mounted on your own routes never receives.

If you would rather not read the request yourself, bind it once: BotbyePhishingClient::withExtractor($config, $httpClient, $requestFactory, $extractor) — where $extractor maps your request to a BotbyePhishingRequestInfo ($origin, $referer, $query) — and call fetchCatcher(BotbyePhishingCatcher::svg(…), $request), passing the request where the $origin header value would go. The extractor is then the only thing that reads the request — headers and query alike.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

use Botbye\Phishing\BotbyePhishingClient;
use Botbye\Phishing\BotbyePhishingCatcher;
use Illuminate\Support\Facades\Route;

// Absolute URL of your PNG route — the SVG catcher references it as innerPngUrl.
const PNG_CATCHER_URL = 'https://your-site.example/your-image-route.png';

Route::get('/your-image-route.svg', function (BotbyePhishingClient $phishing) {
    $res = $phishing->fetchCatcher(
        BotbyePhishingCatcher::svg(PNG_CATCHER_URL),
        request()->header('Origin'),
        request()->header('Referer'),
    );

    if ($res->error !== null) {
        return response($res->error->message, 502);
    }

    return response($res->body, $res->status)
        ->header('Content-Type', $res->headers['Content-Type'] ?? 'image/svg+xml');
});

Route::get('/your-image-route.png', function (BotbyePhishingClient $phishing) {
    $res = $phishing->fetchCatcher(
        BotbyePhishingCatcher::png(),
        request()->header('Origin'),
        request()->header('Referer'),
    );

    if ($res->error !== null) {
        return response($res->error->message, 502);
    }

    return response($res->body, $res->status)
        ->header('Content-Type', $res->headers['Content-Type'] ?? 'image/png');
});

Settings

Configuration parameters for phishing integration: