libaro/secure-id

A package to integrate secure-id

dev-main 2024-04-17 11:55 UTC

This package is auto-updated.

Last update: 2024-06-17 12:51:29 UTC


README

Description of the Laravel package

Latest Version on Packagist Total Downloads GitHub Actions

The Secure ID Laravel Package simplifies the integration of the Secure ID functionality into your Laravel projects. Secure ID is designed to facilitate a secure login procedure by generating sign requests, managing user responses through QR codes or SMS, and seamlessly logging users into your projects.

Installation

You can install the package via composer:

composer require libaro/secure-id

Publish the config file:

php artisan vendor:publish --provider="Libaro\SecureId\SecureIdServiceProvider" --tag="config"

The content of the config file:

return [
    'api_url' => env('SECURE_ID_API_URL', 'https://secureid.digitalhq.com/api/generate'),
    'api_key' => env('SECURE_ID_API_KEY'),
    'api_url_prefix' => env('SECURE_ID_API_URL_PREFIX', '/api/secure-id'),

    'webhook_handlers' => [
        \Support\Interfaces\SecureIdWebhookHandler::class,
    ],
];

Usage

The default WebhookHandler can be replaced by a custom handler in the config file for handling events to authenticating users.

class SecureIdWebhookHandler implements WebhookHandlerInterface
{
	public function handleWebhook(string $phone, string $code): void
	{
		event(new SMSSignRequestReceived($code, $phone));
	}
}

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Security

If you discover any security related issues, please email tim@libaro.be instead of using the issue tracker.

Credits

Props to:

License

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

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.