alexgeno/phone-verification-bundle

A bundle for phone verification via the Symfony Notifier SMS channel. Any SMS service can be used as a sender. Redis or MongoDB can be used as a storage.

v1.0.2 2023-09-20 15:08 UTC

Requires

• php: ^8.0
• alexgeno/phone-verification: ^1.0
• symfony/console: ^6.0
• symfony/framework-bundle: ^6.0
• symfony/notifier: ^6.0
• symfony/translation: ^6.0

Requires (Dev)

• doctrine/mongodb-odm-bundle: ^4.6
• friendsofphp/php-cs-fixer: ^3.26
• m6web/redis-mock: ^5.6
• php-mock/php-mock-phpunit: ^2.7
• phpstan/phpstan: ^1.10
• predis/predis: ^2.2
• snc/redis-bundle: ^4.6
• symfony/message-bird-notifier: ^6.0
• symfony/test-pack: ^1.1
• symfony/twilio-notifier: ^6.0
• symfony/vonage-notifier: ^6.0
• symfony/yaml: ^6.0

Suggests

• doctrine/mongodb-odm-bundle: required to use MongoDB as a storage
• predis/predis: required to use Redis as a storage
• snc/redis-bundle: required to use Redis as a storage
• symfony/message-bird-notifier: required to use Messagebird as a sender's notification channel
• symfony/twilio-notifier: required to use Twilio as a sender's notification channel
• symfony/vonage-notifier: required to use Vonage as a sender's notification channel

MIT

• Alexey Geno

• redis
• mongodb
• Authentication
• sms
• mongo
• phone
• twilio
• notification
• signup
• otp
• authy
• signin
• clickatell
• turbosms
• smsapi
• verify
• verification
• 2fa
• messagebird
• sipgate
• vonage
• Africastalking
• jusibe
• cmsms
• notification-channel
• 2factor
• SmsPoh
• vodafone
• 46elks
• sms77
• verify-by-phone
• all-my-sms
• touch-sms
• smsc-ru
• sms-broadcast

README

Signing in or signing up on a modern website or mobile app typically follows these steps:

• A user initiates verification by submitting a phone number
• The user receives an SMS or a call with a one-time password (OTP)
• The user completes verification by submitting the OTP

This library is built on top of alexeygeno/phone-verification-php and allows to set this up

Supported features

• Easy switching between different storages and SMS services
• Configurable length and expiration time for OTP
• Configurable rate limits
• Localization
• Usage with dependency injection and console commands
• Flex recipe for quick start

Requirements

• Symfony 6.x
• Any of the SMS services available in Symfony Notifier SMS Channel: symfony/vonage-notifier, symfony/twilio-notifier, symfony/message-bird-notifier and many more
• Any of the supported storages: snc/redis-bundle, doctrine/mongodb-odm-bundle

Installation

composer require alexgeno/phone-verification-bundle snc/redis-bundle predis/predis symfony/vonage-notifier

Note: Redis as a storage and Vonage as an SMS service are defaults in the configuration

Usage

Dependency injection

public function initiate(\AlexGeno\PhoneVerification\Manager\Initiator $manager)
{
    $manager->initiate('[phone]');
}

public function complete(\AlexGeno\PhoneVerification\Manager\Completer $manager)
{
    $manager->complete('[phone]', 1234);
}

Console commands

bin/console phone-verification:initiate --to=[phone]

bin/console phone-verification:complete --to=[phone] --otp=1234

Routes

curl -X POST localhost/phone-verification/initiate/[phone]
{"ok":true,"message":"Sms has been sent. Check your Phone!"}

curl -X POST localhost/phone-verification/complete/[phone]/1234
{"ok":true,"message":"The verification is done!"}

Configuration

The bundle will be automatically enabled and configured by a Flex recipe. In case you don't use Flex, see docs/CONFIGURATION.md on how to manually do it

Different storages and SMS services

To switch between available storages and SMS services, install the respective package and update the configuration. For example, to use Mongodb as a storage and Twilio as an SMS service:

composer require doctrine/mongodb-odm-bundle symfony/twilio-notifier

alex_geno_phone_verification:
    storage:
        driver: mongodb
        # ...
    sender:
        transport: twilio
# ...

If the available options are not sufficient, you can add a custom storage (implementing \AlexGeno\PhoneVerification\Storage\I) or/and a sender (implementing \AlexGeno\PhoneVerification\Sender\I), and decorate the respective services (alex_geno_phone_verification.sender, alex_geno_phone_verification.storage) with them

Note: if you use Mongodb as a storage take a look at docs/MIGRATIONS.md