Update website
This commit is contained in:
parent
41ce1aa076
commit
ea0eb1c6e0
4222 changed files with 721797 additions and 14 deletions
149
admin/phpMyAdmin/vendor/pragmarx/google2fa-qrcode/README.md
vendored
Normal file
149
admin/phpMyAdmin/vendor/pragmarx/google2fa-qrcode/README.md
vendored
Normal file
|
|
@ -0,0 +1,149 @@
|
|||
# Google2FA QRCode
|
||||
|
||||
<p align="center">
|
||||
<a href="https://packagist.org/packages/pragmarx/google2fa-qrcode"><img alt="Latest Stable Version" src="https://img.shields.io/packagist/v/pragmarx/google2fa-qrcode.svg?style=flat-square"></a>
|
||||
<a href="LICENSE.md"><img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square"></a>
|
||||
<a href="https://scrutinizer-ci.com/g/antonioribeiro/google2fa/?branch=master"><img alt="Code Quality" src="https://img.shields.io/scrutinizer/g/antonioribeiro/google2fa.svg?style=flat-square"></a>
|
||||
<a href="https://travis-ci.org/antonioribeiro/google2fa"><img alt="Build" src="https://img.shields.io/travis/antonioribeiro/google2fa.svg?style=flat-square"></a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://packagist.org/packages/pragmarx/google2fa-qrcode"><img alt="Downloads" src="https://img.shields.io/packagist/dt/pragmarx/google2fa-qrcode.svg?style=flat-square"></a>
|
||||
<a href="https://scrutinizer-ci.com/g/antonioribeiro/google2fa/?branch=master"><img alt="Coverage" src="https://img.shields.io/scrutinizer/coverage/g/antonioribeiro/google2fa.svg?style=flat-square"></a>
|
||||
<a href="https://styleci.io/repos/24296182"><img alt="StyleCI" src="https://styleci.io/repos/24296182/shield"></a>
|
||||
<a href="https://travis-ci.org/antonioribeiro/google2fa"><img alt="PHP" src="https://img.shields.io/badge/PHP-5.4%20--%207.3-brightgreen.svg?style=flat-square"></a>
|
||||
</p>
|
||||
|
||||
### QRCode For Google2FA
|
||||
|
||||
This is package is [Goole2FA](https://github.com/antonioribeiro/google2fa) integrated with a QRCode generator, providing an easy way to plot QRCode for your two factor authentication. For documentation related to Google2FA, please check the [documentation of the main package](https://github.com/antonioribeiro/google2fa).
|
||||
|
||||
## Requirements
|
||||
|
||||
- PHP 5.4+
|
||||
|
||||
## Installing
|
||||
|
||||
Use Composer to install it:
|
||||
|
||||
```
|
||||
composer require pragmarx/google2fa-qrcode
|
||||
```
|
||||
|
||||
## Using It
|
||||
|
||||
### Instantiate it directly
|
||||
|
||||
```php
|
||||
use PragmaRX\Google2FAQRCode\Google2FA;
|
||||
|
||||
$google2fa = new Google2FA();
|
||||
|
||||
return $google2fa->generateSecretKey();
|
||||
```
|
||||
|
||||
## Generating QRCodes
|
||||
|
||||
The securer way of creating QRCode is to do it yourself or using a library. First you have to install the BaconQrCode package, as stated above, then you just have to generate the inline string using:
|
||||
|
||||
```php
|
||||
$inlineUrl = $google2fa->getQRCodeInline(
|
||||
$companyName,
|
||||
$companyEmail,
|
||||
$secretKey
|
||||
);
|
||||
```
|
||||
|
||||
And use it in your blade template this way:
|
||||
|
||||
```html
|
||||
<img src="{{ $inlineUrl }}">
|
||||
```
|
||||
|
||||
```php
|
||||
$secretKey = $google2fa->generateSecretKey(16, $userId);
|
||||
```
|
||||
|
||||
## Show the QR Code to your user, via Google Apis
|
||||
|
||||
It's insecure to use it via Google Apis, so you have to enable it before using it.
|
||||
|
||||
```php
|
||||
$google2fa->setAllowInsecureCallToGoogleApis(true);
|
||||
|
||||
$google2fa_url = $google2fa->getQRCodeGoogleUrl(
|
||||
'YourCompany',
|
||||
$user->email,
|
||||
$user->google2fa_secret
|
||||
);
|
||||
|
||||
/// and in your view:
|
||||
|
||||
<img src="{{ $google2fa_url }}" alt="">
|
||||
```
|
||||
|
||||
And they should see and scan the QR code to their applications:
|
||||
|
||||
|
||||
|
||||
And to verify, you just have to:
|
||||
|
||||
```php
|
||||
$secret = $request->input('secret');
|
||||
|
||||
$valid = $google2fa->verifyKey($user->google2fa_secret, $secret);
|
||||
```
|
||||
|
||||
## Replacing the QRCode rendering service
|
||||
|
||||
If you want to use a different service, you just have to
|
||||
|
||||
```php
|
||||
$google2fa->setQrcodeService(new YourService())
|
||||
->getQRCodeInline(
|
||||
$companyName,
|
||||
$companyEmail,
|
||||
$secretKey
|
||||
);
|
||||
```
|
||||
|
||||
## Built-in QRCode rendering services
|
||||
|
||||
Beginning on version 2.0 the rendering service is optional, so you have to manually install one of those packages in order to generate QRCodes:
|
||||
|
||||
- [BaconQrCode](https://github.com/Bacon/BaconQrCode): renders PNG by default, but requires the Imagick PHP extension. You can configure it to use different backends, but you'll have to instantiate it yourself.
|
||||
- [chillerlan/php-qrcode](https://github.com/chillerlan/php-qrcode): renders SVG by default and don't require the Imagick PHP extension, but can also generate other formats, which may require Imagick.
|
||||
|
||||
## Using a diffent image backend
|
||||
|
||||
```php
|
||||
$google2fa->setQrcodeService(
|
||||
new \PragmaRX\Google2FAQRCode\QRCode\Bacon(
|
||||
new \BaconQrCode\Renderer\Image\SvgImageBackEnd()
|
||||
)
|
||||
);
|
||||
|
||||
// or
|
||||
|
||||
$google2fa = new Google2FA(
|
||||
new Bacon(
|
||||
new \BaconQrCode\Renderer\Image\SvgImageBackEnd()
|
||||
)
|
||||
);
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
The package tests were written with [PHPUnit](https://phpunit.de/).
|
||||
|
||||
## Authors
|
||||
|
||||
- [Antonio Carlos Ribeiro](http://twitter.com/iantonioribeiro)
|
||||
- [All Contributors](https://github.com/antonioribeiro/google2fa/graphs/contributors)
|
||||
|
||||
## License
|
||||
|
||||
Google2FAQRCode is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.
|
||||
|
||||
## Contributing
|
||||
|
||||
Pull requests and issues are more than welcome.
|
||||
Loading…
Add table
Add a link
Reference in a new issue