xtwoend/hyperf-otp

OTP service support TOTP

dev-master / 1.0.x-dev 2021-04-13 05:42 UTC

Requires

• hyperf-ext/mail: ^2.1
• hyperf/guzzle: ^2.1
• spomky-labs/otphp: ^10.0

MIT

• Abdul Hafidz Anshari

README

This package is for easy setup for OTP validation process. No hassle, just plug and play. Following the steps mentioned below and you will be able to get a fully working OTP Validation system. You can use this later for authentication or e-commerce production selling, order confirmation.

Installation

Install Package

Require this package with composer:

composer require xtwoend/hyperf-otp

Publish Config

Once done, publish the config to your config folder using:

php bin/hyperf.php vendor:publish xtwoend/hyperf-otp

This command will create a config/otp.php file.

Email Configs

From the .env file the email configs are setup. No other changes required.

SMS Configs

As the SMS Gateways use different methods and also extra headers and params, you may need to update the sms configs in the otp.php file.

Migrate Database

Run the following command to create the otps table.

php bin/hyperf.php migrate

It will create a otps table with the required columns.

Environment

Add the following Key-Value pair to the .env file in the Laravel application

# Basic OTP Configs
OTP_SERVICE='enabled'
OTP_TABLE_NAME='otps'
OTP_TIMEOUT=120
OTP_DIGIT=5
OTP_RESEND_SERVICE='enabled'
OTP_MAX_RETRY=2
OTP_MAX_RESEND=1
# Company and Service
OTP_SERVICE_NAME=
OTP_COMPANY_NAME=
# OTP via Email / SMS
OTP_SEND_BY_EMAIL=1
OTP_SEND_BY_SMS=1
# Email Configurations
OTP_EMAIL_FROM=
OTP_EMAIL_FROM_NAME=
OTP_EMAIL_SUBJECT=
# SMS Configurations
OTP_SMSC_URL='https://sms'
OTP_SMSC_METHOD=
OTP_COUNTRY_CODE=
OTP_SMSC_OVER_JSON=
OTP_SMSC_PARAM_TO_NAME=
OTP_SMSC_PARAM_MSG_NAME=
OTP_SMSC_USER=
OTP_SMSC_PASS=

Definitions

Definition of the features in config are:

• service : enable/disable OTP Service
• timeout: timeout for OTP
• digit: OTP Digit
• resend-service: enable/disable resend Service
• max-retry: max retry for a single request
• max-resend: max resend for a single request
• service-name: for which the service is used
• company-name: for which company
• send-by: there are 2 ways to share otp (Email/SMS)
• email: this key specifies the required information for email (e.g. from, name, subject etc.)
• sms: configure with SMS gateway to send SMS. (Universal Configurator)

OTP Request Templates

Once the template files are published, open template/

Sample Controller

Below is a sample for calling the OTP Validator in OtpController.

namespace App\Controllers;

use Xtwoend\HyperfOtp\Object\OtpRequestObject;
use Xtwoend\HyperfOtp\OtpValidator;
use Xtwoend\HyperfOtp\Object\OtpValidateRequestObject;

class OtpController extends Controller
{
    /**
     * @return array
     */
    public function requestForOtp()
    {
        return OtpValidator::requestOtp(
            new OtpRequestObject('1432', 'buy-shirt', '01711084714', '[e-mail]')
        );
    }

    /**
     * @param Request $request
     * @return array
     */
    public function validateOtp(RequestInterface $request)
    {
        $uniqId = $request->input('uniqueId');
        $otp = $request->input('otp');
        return OtpValidator::validateOtp(
            new OtpValidateRequestObject($uniqId,$otp)
        );
    }

    /**
     * @param Request $request
     * @return array
     */
    public function resendOtp(RequestInterface $request)
    {
        $uniqueId = $request->input('uniqueId');
        return OtpValidator::resendOtp($uniqueId);
    }

}

Add the following to the routes/web.php file.

Route::get('/test/otp-request', 'OtpController@requestForOtp');
Route::get('/test/otp-validate', 'OtpController@validateOtp');
Route::get('/test/otp-resend', 'OtpController@resendOtp');

Response/Error Descriptions

The below table describes the error codes generated in the response and their corresponding meanings.

{
  "code": 201,
  "message": "OTP Sent to the recipient",
  "requestId": 1432,
  "type": "buy-shirt"
}

Request OTP Response Codes

Code	Meanings
201	Successfully Generated OTP and shared.
400	Bad request.
501	Resend Service Disabled.
503	Service Unavailable.

OTP Validate Response Codes

Code	Meanings
200	Correct OTP.
400	Invalid OTP.
404	OTP Expired/Not Found.
413	Max Retry Exceeded.

License

MIT

Special Thanks

• Nahid Bin Azhar For the Feedback.

Support

• For any bugs, please help to create an issue.
• For any problem installing or configurations, feel free to knock me. [e-mail]

Featured Article

• How to create a laravel OTP/Security code verification for e-commerce website

Example SMS Gateways Configuration

Muthofun

If you are trying to integrate one of most popular SMS gateway of Bangladesh, muthofun is a popular Bulk SMS Gateway in our country. Here is a sample configuration for the Muthofun SMS Gateway

'smsc' => [
    'url' => env('OTP_SMSC_URL'),
    'method' => env('OTP_SMSC_METHOD', 'GET'),
    'add_code' => env('OTP_COUNTRY_CODE',null),
    'json' => env('OTP_SMSC_OVER_JSON',1),
    'headers' => [],
    'params' => [
        'send_to_param_name' => env('OTP_SMSC_PARAM_TO_NAME','number'),
        'msg_param_name' => env('OTP_SMSC_PARAM_MSG_NAME','msg'),
        'others' => [
            'user' => env('OTP_SMSC_USER'),
            'password' => env('OTP_SMSC_PASS'),
            'unicode' => 1
        ],
    ]
];

.env file will be as the following

OTP_SMSC_URL='http://clients.muthofun.com:8901/esmsgw/sendsms.jsp?'
OTP_SMSC_METHOD='GET'
OTP_COUNTRY_CODE='88'
OTP_SMSC_OVER_JSON=0
OTP_SMSC_PARAM_TO_NAME='mobiles'
OTP_SMSC_PARAM_MSG_NAME='sms'
OTP_SMSC_USER='YourUserName'
OTP_SMSC_PASS='YourPassWord'

Infobip

Example for integrating with the infobip SMS platform, renowned SMS Gateway.

using GET method

'smsc' => [
    'url' => env('OTP_SMSC_URL'),
    'method' => env('OTP_SMSC_METHOD', 'GET'),
    'add_code' => env('OTP_COUNTRY_CODE',null),
    'json' => env('OTP_SMSC_OVER_JSON',1),
    'headers' => [],
    'params' => [
        'send_to_param_name' => env('OTP_SMSC_PARAM_TO_NAME','number'),
        'msg_param_name' => env('OTP_SMSC_PARAM_MSG_NAME','msg'),
        'others' => [
            'username' => env('OTP_SMSC_USER'),
            'password' => env('OTP_SMSC_PASS'),
            'from' => 'InfoSMS',
            'flash' => true
        ],
    ]
];

.env file will be as the following

OTP_SMSC_URL='https://{baseUrl}/sms/1/text/query?'
OTP_SMSC_METHOD='GET'
OTP_COUNTRY_CODE='88'
OTP_SMSC_OVER_JSON=0
OTP_SMSC_PARAM_TO_NAME='to'
OTP_SMSC_PARAM_MSG_NAME='text'
OTP_SMSC_USER='YourUserName'
OTP_SMSC_PASS='YourPassWord'

msg91

Sample for integrating with the msg91 SMS gateway.

using GET method

'smsc' => [
        'url' => env('OTP_SMSC_URL'),
        'method' => env('OTP_SMSC_METHOD', 'GET'),
        'add_code' => env('OTP_COUNTRY_CODE',null),
        'json' => env('OTP_SMSC_OVER_JSON',1),
        'headers' => [],
        'params' => [
            'send_to_param_name' => env('OTP_SMSC_PARAM_TO_NAME','number'),
            'msg_param_name' => env('OTP_SMSC_PARAM_MSG_NAME','msg'),
            'others' => [
                'authkey' => 'YourAuthKey',
                'sender' => 'YourSenderId',
                'route' => '1',
                'country' => '88',
            ],
        ],
        'wrapper' => 'sms',
    ];

.env file will be as the following

OTP_SMSC_URL='https://control.msg91.com/api/v2/sendsms?'
OTP_SMSC_METHOD='POST'
OTP_COUNTRY_CODE='88'
OTP_SMSC_OVER_JSON=1
OTP_SMSC_PARAM_TO_NAME='to'
OTP_SMSC_PARAM_MSG_NAME='text'
OTP_SMSC_USER='YourUserName'
OTP_SMSC_PASS='YourPassWord'