surface/laravel-webfinger

A Laravel package to create an ActivityPub webfinger.

1.2.0 2023-03-12 00:00 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^9.0|^10.0|^11.0
• illuminate/http: ^9.0|^10.0|^11.0
• illuminate/support: ^9.0|^10.0|^11.0

Requires (Dev)

• larastan/larastan: ^2.9.2
• nunomaduro/collision: ^6.4|^8.1.1
• nunomaduro/phpinsights: ^2.11
• orchestra/testbench: ^7.0|^8.21.1|^9.0
• phpro/grumphp: ^2.5
• phpstan/phpstan: ^1.10.60
• phpunit/phpunit: ^9.6.17|^10.5.13
• slevomat/coding-standard: ^8.15
• squizlabs/php_codesniffer: ^3.9

MIT

• Trevor Morris

• laravel
• webfinger
• mastodon
• activitypub
• trovster
• laravel-webfinger

README

This creates a webfinger, a way to attach information to an email address, or an other online resource. Once installed you should see your JSON webfinger profile at /.well-known/webfinger.

Installation

You can install the package via composer:

composer require surface/laravel-webfinger

You must add the configuration to your .env file:

WEBFINGER_INSTANCE=mastodon.instance
WEBFINGER_USERNAME=your-username

You can publish the config file with:

php artisan vendor:publish --provider="Surface\LaravelWebfinger\LaravelWebfingerServiceProvider"

Extending the Resource

The resource which is converted to the JSON response is bound to the service container. This allows you to easily override the resource and add extra information. To change the binding, add the following to your app service provider.

use App\Http\Resources\Webfinger as WebfingerResource;
use Surface\LaravelWebfinger\Http\Resources\Webfinger as PackageWebfinger;
use Surface\LaravelWebfinger\Service\Webfinger as WebfingerService;

$this->app->bind(
    PackageWebfinger::class,
    static fn (Container $app): WebfingerResource => new WebfingerResource(
        ...$app->make(WebfingerService::class)
    )
);

Then you would create your custom resource which extends the base.

<?php

namespace App\Http\Resources;

use Illuminate\Http\Request;
use Illuminate\Support\Stringable;
use Surface\LaravelWebfinger\Http\Resources\Webfinger as JsonResource;

class Webfinger extends JsonResource
{
    protected string $website;

    public function __construct(protected Stringable $instance, protected Stringable $username)
    {
        parent::__construct($instance, $username);

        $this->website = 'https://www.example.com';
    }

    public function links(Request $request): array
    {
        return [
            ...parent::links($request),
            [
                'rel' => 'self',
                'type' => 'text/html',
                'href' => $this->website,
            ],
        ];
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• Trevor Morris

License

The MIT License (MIT). Please see License File for more information.