doc: getting started: improve examples (#154)

add example for default lib qr provider and add issuer too

see #152

.github/workflows/test-bacon.yml

@@ -10,11 +10,16 @@ jobs:
 
     strategy:
       matrix:
-        php-version: ['8.2', '8.3']
-        bacon-version: ['^2', '^3']
+        php-version: [8.2, 8.3, 8.4, 8.5]
+        bacon-version: ["^2", "^3"]
+        exclude:
+          - php-version: 8.4
+            bacon-version: "^2"
+          - php-version: 8.5
+            bacon-version: "^2"
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - uses: shivammathur/setup-php@v2
       with:

.github/workflows/test-endroid.yml

@@ -10,11 +10,24 @@ jobs:
 
     strategy:
       matrix:
-        php-version: ['8.2', '8.3']
-        endroid-version: ["^3","^4","^5"]
+        php-version: [8.2, 8.3, 8.4, 8.5]
+        endroid-version: ["^3", "^4", "^5", "^6"]
+        exclude:
+          - php-version: 8.4
+            endroid-version: "^3"
+          - php-version: 8.4
+            endroid-version: "^4"
+          - php-version: 8.4
+            endroid-version: "^5"
+          - php-version: 8.5
+            endroid-version: "^3"
+          - php-version: 8.5
+            endroid-version: "^4"
+          - php-version: 8.5
+            endroid-version: "^5"
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - uses: shivammathur/setup-php@v2
       with:

.github/workflows/test.yml

@@ -10,10 +10,10 @@ jobs:
 
     strategy:
       matrix:
-        php-version: ['8.2', '8.3']
+        php-version: [8.2, 8.3, 8.4, 8.5]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - uses: shivammathur/setup-php@v2
       with:

README.md

@@ -8,23 +8,16 @@ PHP library for [two-factor (or multi-factor) authentication](http://en.wikipedi
 <img src="https://raw.githubusercontent.com/RobThree/TwoFactorAuth/master/multifactorauthforeveryone.png">
 </p>
 
-## Warning:
-
-By default, this package uses the `lib/Providers/QRServerProvider.php` as QR code generator. This provider is __not__ suggested for applications where absolute security is needed, because it uses an external service for the QR code generation.
-
-
-You can make use of the included [Endroid](https://robthree.github.io/TwoFactorAuth/qr-codes/endroid.html) or [Bacon](https://robthree.github.io/TwoFactorAuth/qr-codes/bacon.html) providers which generate locally.
-
 ## Requirements
 
 * Requires PHP version >=8.2
-* [cURL](http://php.net/manual/en/book.curl.php) when using the provided `QRServerProvider` (default), `ImageChartsQRCodeProvider` or `QRicketProvider` but you can also provide your own QR-code provider.
 
 Optionally, you may need:
 
 * [sockets](https://www.php.net/manual/en/book.sockets.php) if you are using `NTPTimeProvider`
 * [endroid/qr-code](https://github.com/endroid/qr-code) if using `EndroidQrCodeProvider` or `EndroidQrCodeWithLogoProvider`.
 * [bacon/bacon-qr-code](https://github.com/Bacon/BaconQrCode) if using `BaconQrCodeProvider`.
+* [php-curl library](http://php.net/manual/en/book.curl.php) when using an external QR Code provider such as `QRServerProvider`, `ImageChartsQRCodeProvider`, `QRicketProvider` or any other custom provider connecting to an external service.
 
 ## Installation
 
@@ -40,7 +33,7 @@ If you need more in-depth information about the configuration available then you
 
 ## Integrations
 
-- [CakePHP 3](https://github.com/andrej-griniuk/cakephp-two-factor-auth)
+- [CakePHP plugin](https://github.com/andrej-griniuk/cakephp-two-factor-auth)
 - [CI4-Auth: a user, group, role and permission management library for Codeigniter 4](https://github.com/glewe/ci4-auth)
 
 ## License

demo/demo.php

@@ -11,8 +11,10 @@
                 include_once str_replace(array('RobThree\\Auth', '\\'), array(__DIR__.'/../lib', '/'), $className) . '.php';
             });
 
-            // substitute your company or app name here
-            $tfa = new RobThree\Auth\TwoFactorAuth(new RobThree\Auth\Providers\Qr\QRServerProvider());
+            $tfa = new RobThree\Auth\TwoFactorAuth(
+                new RobThree\Auth\Providers\Qr\QRServerProvider(),
+                "Acme Corp" // substitute your company or app name here
+            );
         ?>
         <li>First create a secret and associate it with a user</li>
         <?php

docs/getting-started.md

@@ -21,17 +21,20 @@ Example code:
 
 ```php
 use RobThree\Auth\TwoFactorAuth;
+use RobThree\Auth\Providers\Qr\QRServerProvider; // if using library's provider
 use RobThree\Auth\Providers\Qr\BaconQrCodeProvider; // if using Bacon
 use RobThree\Auth\Providers\Qr\EndroidQrCodeProvider; // if using Endroid
 
+// using the default Qr Code provider from the library
+$tfa = new TwoFactorAuth(new QRServerProvider(), "Your app name");
 // using Bacon
-$tfa = new TwoFactorAuth(new BaconQrCodeProvider());
+$tfa = new TwoFactorAuth(new BaconQrCodeProvider(), "Your app name");
 // using Endroid
-$tfa = new TwoFactorAuth(new EndroidQrCodeProvider());
+$tfa = new TwoFactorAuth(new EndroidQrCodeProvider(), "Your app name");
 // using a custom object implementing IQRCodeProvider interface
-$tfa = new TwoFactorAuth(new MyQrCodeProvider());
+$tfa = new TwoFactorAuth(new MyQrCodeProvider(), "Your app name");
 // using named argument and a variable
-$tfa = new TwoFactorAuth(qrcodeprovider: $qrGenerator);
+$tfa = new TwoFactorAuth(qrcodeprovider: $qrGenerator, issuer: "Your app name");
 ```
 
 ## 3. Shared secrets

lib/Providers/Qr/BaseHTTPQRCodeProvider.php

@@ -26,7 +26,6 @@ abstract class BaseHTTPQRCodeProvider implements IQRCodeProvider
             throw new QRException(curl_error($curlhandle));
         }
 
-        curl_close($curlhandle);
         return $data;
     }
 }

lib/Providers/Qr/EndroidQrCodeProvider.php

@@ -28,10 +28,13 @@ class EndroidQrCodeProvider implements IQRCodeProvider
 
     protected $endroid5 = false;
 
+    protected $endroid6 = false;
+
     public function __construct($bgcolor = 'ffffff', $color = '000000', $margin = 0, $errorcorrectionlevel = 'H')
     {
-        $this->endroid4 = method_exists(QrCode::class, 'create');
         $this->endroid5 = enum_exists(ErrorCorrectionLevel::class);
+        $this->endroid6 = $this->endroid5 && !method_exists(QrCode::class, 'setSize');
+        $this->endroid4 = $this->endroid6 || method_exists(QrCode::class, 'create');
 
         $this->bgcolor = $this->handleColor($bgcolor);
         $this->color = $this->handleColor($color);
@@ -56,6 +59,17 @@ class EndroidQrCodeProvider implements IQRCodeProvider
 
     protected function qrCodeInstance(string $qrText, int $size): QrCode
     {
+        if ($this->endroid6) {
+            return new QrCode(
+                data: $qrText,
+                errorCorrectionLevel: $this->errorcorrectionlevel,
+                size: $size,
+                margin: $this->margin,
+                foregroundColor: $this->color,
+                backgroundColor: $this->bgcolor
+            );
+        }
+
         $qrCode = new QrCode($qrText);
         $qrCode->setSize($size);
 
@@ -63,7 +77,6 @@ class EndroidQrCodeProvider implements IQRCodeProvider
         $qrCode->setMargin($this->margin);
         $qrCode->setBackgroundColor($this->bgcolor);
         $qrCode->setForegroundColor($this->color);
-
         return $qrCode;
     }
 

lib/Providers/Qr/EndroidQrCodeWithLogoProvider.php

@@ -33,11 +33,15 @@ class EndroidQrCodeWithLogoProvider extends EndroidQrCodeProvider
 
         $logo = null;
         if ($this->logoPath) {
-            $logo = Logo::create($this->logoPath);
-            if ($this->logoSize) {
-                $logo->setResizeToWidth($this->logoSize[0]);
-                if (isset($this->logoSize[1])) {
-                    $logo->setResizeToHeight($this->logoSize[1]);
+            if ($this->endroid6) {
+                $logo = new Logo($this->logoPath, ...$this->logoSize);
+            } else {
+                $logo = Logo::create($this->logoPath);
+                if ($this->logoSize) {
+                    $logo->setResizeToWidth($this->logoSize[0]);
+                    if (isset($this->logoSize[1])) {
+                        $logo->setResizeToHeight($this->logoSize[1]);
+                    }
                 }
             }
         }