✨

Author: codemasher

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ on:
 name: "Continuous Integration"
 
 env:
-  PHP_EXTENSIONS: "" # caution: setting 'none' resets/disables shared extensions
+  PHP_EXTENSIONS: curl, fileinfo, gd, imagick, json, mbstring, sodium
   PHP_INI_VALUES: memory_limit=-1, error_reporting=-1, display_errors=On
 
 jobs:
@@ -38,10 +38,13 @@ jobs:
       fail-fast: true
       matrix:
         php-version:
+          - "7.4"
+          - "8.0"
           - "8.1"
           - "8.2"
           - "8.3"
           - "8.4"
+          - "8.5"
 
     steps:
       - name: "Checkout"
@@ -56,7 +59,7 @@ jobs:
           coverage: none
 
       - name: "Validate composer.json"
-        run: composer validate --ansi --strict
+        run: composer validate --no-interaction --ansi --verbose --with-dependencies
 
       - name: "Install dependencies with composer"
         uses: ramsey/composer-install@v3
@@ -67,9 +70,6 @@ jobs:
       - name: "Run phan"
         run: php vendor/bin/phan --target-php-version=${{ matrix.php-version }}
 
-      - name: "Run PHPStan"
-        run: php vendor/bin/phpstan
-
 
   tests:
     name: "Unit Tests"
@@ -83,10 +83,13 @@ jobs:
           - ubuntu-latest
           - windows-latest
         php-version:
+          - "7.4"
+          - "8.0"
           - "8.1"
           - "8.2"
           - "8.3"
           - "8.4"
+          - "8.5"
 
     steps:
       - name: "Checkout"

.idea/inspectionProfiles/Project_Default.xml

@@ -13,7 +13,7 @@
 	// that functions removed in php 7.0 exist.
 	// (See `backward_compatibility_checks` for additional options)
 	'target_php_version'              => null,
-	'minimum_target_php_version'      => '8.1',
+	'minimum_target_php_version'      => '7.4',
 
 	// A list of directories that should be parsed for class and
 	// method information. After excluding the directories

.phan/config.php

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 smiley <smiley@chillerlan.net>
+Copyright (c) 2026 smiley <smiley@chillerlan.net>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,10 +1,13 @@
 {
 	"$schema": "https://getcomposer.org/schema.json",
-	"name": "chillerlan/php-library-template-nodocs",
-	"description": "A PHP Library template/boilerplate.",
+	"name": "chillerlan/2fa-qrcode-bundle",
+	"description": "An authenticator and a QR Code generator bundled together for MFA in frameworks and applications.",
 	"license": "MIT",
 	"type": "library",
-	"keywords": ["boilerplate", "library-template"],
+	"keywords": [
+		"2fa", "authenticator", "qrcode", "google2fa", "hotp", "mfa",
+		"otp", "rfc4226", "rfc6238", "tfa", "totp", "two factor"
+	],
 	"authors": [
 		{
 			"name": "smiley",
@@ -13,7 +16,7 @@
 		},
 		{
 			"name": "Contributors",
-			"homepage":"https://github.com/chillerlan/php-library-template-nodocs/graphs/contributors"
+			"homepage":"https://github.com/chillerlan/2fa-qrcode-bundle/graphs/contributors"
 		}
 	],
 	"funding": [
@@ -22,42 +25,39 @@
 			"url": "https://ko-fi.com/codemasher"
 		}
 	],
-	"homepage": "https://github.com/chillerlan/php-library-template-nodocs",
+	"homepage": "https://github.com/chillerlan/2fa-qrcode-bundle",
 	"support": {
-		"issues": "https://github.com/chillerlan/php-library-template-nodocs/issues",
-		"source": "https://github.com/chillerlan/php-library-template-nodocs"
+		"issues": "https://github.com/chillerlan/2fa-qrcode-bundle/issues",
+		"source": "https://github.com/chillerlan/2fa-qrcode-bundle"
 	},
 	"minimum-stability": "stable",
 	"prefer-stable": true,
 	"require": {
-		"php": "^8.1"
+		"php": "^7.4 || ^8.0",
+		"chillerlan/php-authenticator": "^4.5.0",
+		"chillerlan/php-qrcode": "^5.0.5",
+		"chillerlan/php-settings-container": "^2.1.6"
 	},
 	"require-dev": {
-		"phan/phan": "^5.5.0",
+		"phan/phan": "^5.5.2",
 		"phpmd/phpmd": "^2.15",
-		"phpstan/phpstan": "^2.1.22",
-		"phpstan/phpstan-deprecation-rules": "^2.0.3",
-		"phpunit/phpunit": "^10.5",
-		"slevomat/coding-standard": "^8.15",
-		"squizlabs/php_codesniffer": "^3.10"
-	},
-	"suggest": {
+		"phpunit/phpunit": "^9.6",
+		"slevomat/coding-standard": "^8.28",
+		"squizlabs/php_codesniffer": "^4.0"
 	},
 	"autoload": {
 		"psr-4": {
-			"chillerlan\\LibraryTemplate\\": "src"
+			"chillerlan\\TwoFactorQRCode\\": "src"
 		}
 	},
 	"autoload-dev": {
 		"psr-4": {
-			"chillerlan\\LibraryTemplateTest\\": "tests"
+			"chillerlan\\TwoFactorQRCodeTest\\": "tests"
 		}
 	},
 	"scripts": {
 		"phan": "@php vendor/bin/phan",
 		"phpcs": "@php vendor/bin/phpcs -v",
-		"phpstan": "@php vendor/bin/phpstan",
-		"phpstan-baseline": "@php vendor/bin/phpstan --generate-baseline",
 		"phpunit": "@php vendor/bin/phpunit"
 	},
 	"config": {

composer.json

@@ -2,15 +2,89 @@
 /**
  * example.php
  *
- * @created      08.03.2024
+ * @created      15.03.2026
  * @author       smiley <smiley@chillerlan.net>
- * @copyright    2024 smiley
+ * @copyright    2026 smiley
  * @license      MIT
  */
 declare(strict_types=1);
 
+use chillerlan\TwoFactorQRCode\TwoFactorQRCode;
+use chillerlan\TwoFactorQRCode\TwoFactorQRCodeOptions;
+
 require_once __DIR__.'/../vendor/autoload.php';
 
-$example = new \chillerlan\LibraryTemplate\Example;
+/**
+ * invocation
+ */
+
+// an options array, e.g. populated from framework config
+$options = [
+	'secret_length' => 128,
+	'adjacent'      => 2,
+];
+
+// invoke settings and TwoFactorQRCode instance
+$twoFactorQRCodeOptions = new TwoFactorQRCodeOptions($options);
+$twoFactorQRCode        = new TwoFactorQRCode($twoFactorQRCodeOptions);
+
+
+/**
+ * installation
+ */
+
+// crate a secret, present it to the user as text
+$newSecret = $twoFactorQRCode->createSecret();
+
+// also create a QR Code and present it to the user
+$qrcode    = $twoFactorQRCode->getQRCode('label', 'issuer');
+
+// generate a backup code and present it as well, save the counter value
+$backup    = $twoFactorQRCode->createBackupCode(0);
+
+// during the registration, let the user supply an OTP withthe above data abd verify it
+if($twoFactorQRCode->verifyOTP('069420')){
+	// proceed with installation, save data
+	echo 'yay!';
+}
+
+
+/**
+ * normal usage, log-ins, reverification etc.
+ */
+
+// set the secret from the user's data
+$twoFactorQRCode->setSecret('GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ');
+
+// present the useer with a form field for the OTP and verify it
+if($twoFactorQRCode->verifyOTP('420069')){
+	// redirect to wherever the user was headed
+}
+
+
+/**
+ * using a backup code
+ */
+
+// the user lost access to their authenticator, send them to a form separate from the usual OTP input
+// verify the given OTP against the stored counter value
+if($twoFactorQRCode->verifyBackupCode('694711', 0)){
+	// after verification, create a new backup code and save the new counter value
+	$newBackup = $twoFactorQRCode->createBackupCode(1);
+	// present the new backup code to the user and make them triple check that they have carefully saved it,
+	// then redirect them to wherever they were headed
+}
+
+
+/**
+ * utility
+ */
+
+// alternatively you can set the secret as raw binary, e.g. for migration
+$twoFactorQRCode->setRawSecret('decoded binary string');
+
+// you can then retrieve the properly encoded secret
+$secret = $twoFactorQRCode->getSecret();
 
-echo $example->hello();
+// you can also retrieve the raw secret
+$rawSecert = $twoFactorQRCode->getRawSecret();

examples/example.php

@@ -1,21 +1,20 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
          bootstrap="vendor/autoload.php"
-         cacheDirectory=".build/phpunit-cache"
+         cacheResultFile=".build/phpunit.result.cache"
          colors="true"
+         verbose="true"
 >
 	<testsuites>
-		<testsuite name="chillerlan test suite">
+		<testsuite name="php-authenticator test suite">
 			<directory>tests</directory>
 		</testsuite>
 	</testsuites>
-	<source>
+	<coverage processUncoveredFiles="true">
 		<include>
-			<directory>src</directory>
+			<directory suffix=".php">src</directory>
 		</include>
-	</source>
-	<coverage>
 		<report>
 			<clover outputFile=".build/coverage/clover.xml"/>
 			<xml outputDirectory=".build/coverage/coverage-xml"/>