Download the PHP package elshaden/apiato-otpkey without Composer
On this page you can find all versions of the php package elshaden/apiato-otpkey. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package apiato-otpkey
Apiato 2FA Container
Multi-Factor Authentication MFA , 2FA.
This Container is used to manage the 2 Factor Authentication using any app like Google Authenticator
Note: This container is not fully tested, use with caution.
Installation
Only Works in Existing Apiato Application
Read more about the Apiato container installer in the docs!
Steps
composer require elshaden/apiato-otpkey
Add the use HasOtpKeyTrait in the User Model
Migrate the table 'otp_keys'
and you are ready to go
Check Config File in Configs Dir for any changes
Usage
To find if user has MFA Key
This will return the full record of the Otp Key.
To Create New MFA key
` This will return : The Otp_key Record created with otp Key ( basse 64 TOTP key) QR code inform of Base 64 Image and the user Id
Update the Key
` This will regnertae the Key and updates the record
To generate a QR code for a given code
`
To Verfiy a given Token is valid ( the six numbers in the authenticator)
`
Generate Code
`
This will generate a 6 Digits Code based on the user token, at any given time The code should match any authenticator App's such as Google Authenticator
API Endpoints
| Endpoint | Method | Parameteres | Usage | Response |
|---|---|---|---|---|
| /otpkeys | POST | user_id | Creates New User Token | string "id", int "user_id", string "code", image "qr_code" |
| /validate-otpkeys | POST | id , pin , slots | Validates 6 digits pin | bool "result" |
| /validate-usercode | POST | pin | Validates pin By User Bearer Token | bool "result" |
| /generate-otpkey | GET | Generates 6 Digits pin From Bearer Token | int "code" |
In Addition to Find, delete and Update OtpToken for any user.
Note when validating the Otp in validate-otpkeys slots means validate the key for past
For example 10 Slots means 10 * 30 seconds = 300 seconds / 60 = 5 minutes. So the Otp is valid for the pas 5 minutes.
For 5 Minutes Token, slots = 5 * 60 = 300
For one day Token, slots = 24 60 60 = 86400
the longer the period the more time it takes to check the validity, so please try to be conservative.
