29 Jan 2024

1) Library updates - JWT, WebAuthn, WebPush
2) New NFC login module
3) Small UI updates to user login/account pages.
4) LIB-NFCIN - Will now check valid user before creating hash.

Author: code-boxx

README.md

@@ -2,6 +2,14 @@
 Core Boxx is a PHP framework built with the concept of simplicity and modularity. Install and load only what you need, not bloated with unused features.
 <br><br>
 
+## :white_check_mark: "OUT OF THE BOX" FEATURES
+1) Pretty URL and routing.
+2) API endpoints with CORS support.
+3) Installable Progressive Web App.
+4) JSON Web Token sessions.
+5) Bootstrap HTML template.
+<br><br>
+
 ## :camera: SCREENSHOTS
 <p float="left">
   <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-1.png">
@@ -11,11 +19,6 @@ Core Boxx is a PHP framework built with the concept of simplicity and modularity
   <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-5.png">
   <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-6.png">
 </p>
-<br>
-
-## :floppy_disk: INSTALLATION
-- Copy the contents of `core/` into your HTTP folder.
-- Access `http://your-site.com/` in the browser and walk through the installer.
 <br><br>
 
 ## :ballot_box_with_check: REQUIREMENTS
@@ -26,6 +29,11 @@ Core Boxx is a PHP framework built with the concept of simplicity and modularity
 5) At least PHP 8.0
 <br><br>
 
+## :floppy_disk: INSTALLATION
+1) Manually download or git clone into your `http` folder.
+2) Access `http://your-site.com/` in the browser and walk through the installer.
+<br><br>
+
 ## :electric_plug: MODULES
 The rest of the folders are optional modules. To install the modules, check out their respective `README.md` files.
 
@@ -46,16 +54,9 @@ The rest of the folders are optional modules. To install the modules, check out
 * `web push` Send push notifications.
 <br><br>
 
-## :white_check_mark: "OUT OF THE BOX" FEATURES
-1) Pretty URL and routing.
-2) API endpoints with CORS support.
-3) Installable Progressive Web App.
-4) JSON Web Token sessions.
-5) Bootstrap HTML template.
-<br><br>
-
 ## :star: SUPPORT
-Like this project? Just give it a star. That will indirectly help grow my blog a little bit. :wink:
+1) Just give this project a star. That will indirectly drive more traffic a little bit. :wink:
+2) [Sponsor this project](https://github.com/sponsors/code-boxx). Even a small one time amount helps.
 <br><br>
 
 ## :bulb: DOCUMENTATION & CREDITS
@@ -83,4 +84,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

core/assets/core-boxx-1.png

@@ -22,4 +22,4 @@
 
 require_once __DIR__ . '/composer/autoload_real.php';
 
-return ComposerAutoloaderInit4227a9262042b7b77c23e4da01de8cd1::getLoader();
+return ComposerAutoloaderInitc4b25d4c67ba5f31d25bdba015db7cda::getLoader();

core/assets/core-boxx-2.png

@@ -2,7 +2,7 @@
 
 // autoload_real.php @generated by Composer
 
-class ComposerAutoloaderInit4227a9262042b7b77c23e4da01de8cd1
+class ComposerAutoloaderInitc4b25d4c67ba5f31d25bdba015db7cda
 {
     private static $loader;
 
@@ -24,12 +24,12 @@ public static function getLoader()
 
         require __DIR__ . '/platform_check.php';
 
-        spl_autoload_register(array('ComposerAutoloaderInit4227a9262042b7b77c23e4da01de8cd1', 'loadClassLoader'), true, true);
+        spl_autoload_register(array('ComposerAutoloaderInitc4b25d4c67ba5f31d25bdba015db7cda', 'loadClassLoader'), true, true);
         self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(__DIR__));
-        spl_autoload_unregister(array('ComposerAutoloaderInit4227a9262042b7b77c23e4da01de8cd1', 'loadClassLoader'));
+        spl_autoload_unregister(array('ComposerAutoloaderInitc4b25d4c67ba5f31d25bdba015db7cda', 'loadClassLoader'));
 
         require __DIR__ . '/autoload_static.php';
-        call_user_func(\Composer\Autoload\ComposerStaticInit4227a9262042b7b77c23e4da01de8cd1::getInitializer($loader));
+        call_user_func(\Composer\Autoload\ComposerStaticInitc4b25d4c67ba5f31d25bdba015db7cda::getInitializer($loader));
 
         $loader->register(true);
 

core/assets/core-boxx-3.png

@@ -4,7 +4,7 @@
 
 namespace Composer\Autoload;
 
-class ComposerStaticInit4227a9262042b7b77c23e4da01de8cd1
+class ComposerStaticInitc4b25d4c67ba5f31d25bdba015db7cda
 {
     public static $prefixLengthsPsr4 = array (
         'F' => 
@@ -27,9 +27,9 @@ class ComposerStaticInit4227a9262042b7b77c23e4da01de8cd1
     public static function getInitializer(ClassLoader $loader)
     {
         return \Closure::bind(function () use ($loader) {
-            $loader->prefixLengthsPsr4 = ComposerStaticInit4227a9262042b7b77c23e4da01de8cd1::$prefixLengthsPsr4;
-            $loader->prefixDirsPsr4 = ComposerStaticInit4227a9262042b7b77c23e4da01de8cd1::$prefixDirsPsr4;
-            $loader->classMap = ComposerStaticInit4227a9262042b7b77c23e4da01de8cd1::$classMap;
+            $loader->prefixLengthsPsr4 = ComposerStaticInitc4b25d4c67ba5f31d25bdba015db7cda::$prefixLengthsPsr4;
+            $loader->prefixDirsPsr4 = ComposerStaticInitc4b25d4c67ba5f31d25bdba015db7cda::$prefixDirsPsr4;
+            $loader->classMap = ComposerStaticInitc4b25d4c67ba5f31d25bdba015db7cda::$classMap;
 
         }, null, ClassLoader::class);
     }

core/assets/core-boxx-4.png

@@ -3,16 +3,16 @@
 require PATH_PAGES . "TEMPLATE-top.php"; ?>
 <!-- (A) HEADER -->
 <h1 class="mb-0">CORE BOXX</h1>
-<div class="text-secondary mb-4">open source modular php framework</div>
-<img class="img-fluid d-block mx-auto mb-4" style="max-height:450px;" src="<?=HOST_ASSETS?>head-core-boxx.webp">
+<div class="text-secondary mb-4"><small>
+  open source modular php framework
+</small></div>
 
-<!-- (B) HOW TO USE -->
+<!-- (B) QUICKSTART -->
 <h5 class="text-danger mb-2">
-  <i class="ico-sm icon-power"></i> HOW TO USE CORE BOXX
+  <i class="ico-sm icon-power"></i> QUICKSTART
 </h5>
 <div class="bg-white border p-4 mb-4">
-  <div class="fw-bold mb-2">BASICS</div>
-  <ul class="mb-4">
+  <ul class="mb-0">
     <li><a href="https://code-boxx.com/core-boxx-php-framework/#sec-tut" target="_blank">
       Very Fast Tutorial
     </a></li>
@@ -31,10 +31,18 @@
           PHP Variables
         </a>
     </li>
+    <li><a href="<?=HOST_BASE?>demo/clean">
+      Delete all demo files, give me a clean installation.
+    </a></li>
   </ul>
+</div>
 
-  <div class="fw-bold mb-2">DIVE DEEPER</div>
-  <ul class="mb-4">
+<!-- (C) MORE @TODO -->
+<h5 class="text-danger mb-2">
+  <i class="ico-sm icon-search"></i> DIVE DEEPER
+</h5>
+<div class="bg-white border p-4 mb-4">
+  <ul class="mb-0">
     <li><a href="https://code-boxx.com/core-boxx-core-library-reference/" target="_blank">
       Core Concepts
     </a></li>
@@ -48,32 +56,28 @@
       JWT Sessions
     </a></li>
   </ul>
-
-  <div class="fw-bold mb-2">NAH, I AM GOOD.</div>
-  <ul class="mb-0">
-    <li><a href="<?=HOST_BASE?>demo/clean">
-      Delete all demo files, give me a clean installation.
-    </a></li>
-  </ul>
 </div>
 
-<!-- (C) SUPPORT -->
+<!-- (D) SUPPORT -->
 <h5 class="text-danger mb-2">
   <i class="ico-sm icon-heart"></i> SUPPORT
 </h5>
+<div class="text-secondary mb-2"><small>
+  * Help keep Core Boxx alive, even if it is just a little bit.
+</small></div>
 <div class="bg-white border p-4 mb-4">
   <a class="my-1 btn btn-danger d-flex-inline" href="https://www.paypal.com/paypalme/wstoh/5" target="_blank">
     <i class="ico-sm icon-mug"></i> Buy me a coffee
   </a>
-  <a class="my-1 btn btn-danger d-flex-inline" href="https://payhip.com/codeboxx" target="_blank">
-    <i class="ico-sm icon-cart"></i> Code Boxx Store
-  </a>
   <a class="my-1 btn btn-danger d-flex-inline" href="https://github.com/sponsors/code-boxx" target="_blank">
     <i class="ico-sm icon-heart"></i> GitHub Sponsor
   </a>
+  <a class="my-1 btn btn-danger d-flex-inline" href="https://payhip.com/codeboxx" target="_blank">
+    <i class="ico-sm icon-cart"></i> Code Boxx Store
+  </a>
 </div>
 
-<!-- (D) ALL OTHER LINKS -->
+<!-- (E) ALL OTHER LINKS -->
 <h5 class="text-danger mb-2">
   <i class="ico-sm icon-sphere"></i> ALL THE LINKS
 </h5>
@@ -84,7 +88,7 @@
       FAQ
     </a></li>
     <li><a href="https://github.com/code-boxx/Core-Boxx-PHP-Framework/issues/new/choose" target="_blank">
-      Report a bug
+      Report a bug / Feature Request
     </a></li>
   </ul>
 
@@ -93,19 +97,16 @@
     <li><a href="https://code-boxx.com/" target="_blank">Code Boxx</a></li>
     <li><a href="https://www.youtube.com/c/CodeBoxx" target="_blank">YouTube</a></li>
     <li><a href="https://www.pinterest.com/codeboxx/" target="_blank">Pinterest</a></li>
-    <li><a href="https://rumble.com/c/c-5298498" target="_blank">Rumble</a></li>
+    <li><a href="https://www.facebook.com/real.code.boxx/" target="_blank">Facebook</a></li>
     <li><a href="https://github.com/code-boxx/" target="_blank">GitHub</a></li>
     <li><a href="https://codepen.io/code-boxx" target="_blank">CodePen</a></li>
-    <li><a href="https://dev.to/codeboxx" target="_blank">DEV</a></li>
-    <li><a href="https://facebook.com/real.code.boxx" target="_blank">Facebook</a></li>
   </ul>
 
-  <div class="fw-bold mb-2">CREDITS (BUILT WITH)</div>
+  <div class="fw-bold mb-2">CREDITS / BUILT WITH</div>
   <ul class="mb-0">
     <li><a href="https://getbootstrap.com/" target="_blank">Bootstrap</a></li>
     <li><a href="https://icomoon.io/" target="_blank">IcoMoon</a></li>
     <li><a href="https://github.com/firebase/php-jwt" target="_blank">PHP JWT</a></li>
   </ul>
 </div>
-
-<?php require PATH_PAGES . "TEMPLATE-bottom.php"; ?>
+<?php require PATH_PAGES . "TEMPLATE-bottom.php"; ?>

core/assets/head-core-boxx.webp

@@ -10,11 +10,17 @@ function __construct ($core) {
   // (B) CREATE NEW NFC LOGIN TOKEN
   //  $id : user id
   function add ($id) {
-    // (B1) UPDATE TOKEN
+    // (B1) CHECK VALID USER
+    if (!is_array($this->Users->get($id))) {
+      $this->error = "Invalid user";
+      return false;
+    }
+
+    // (B2) UPDATE TOKEN
     $token = $this->Core->random($this->nlen);
     $this->Users->hashAdd($id, "NFC", password_hash($token, PASSWORD_DEFAULT));
 
-    // (B2) RETURN ENCODED TOKEN
+    // (B3) RETURN ENCODED TOKEN
     require PATH_LIB . "JWT/autoload.php";
     return Firebase\JWT\JWT::encode([$id, $token], JWT_SECRET, JWT_ALGO);
   }

core/lib/JWT/autoload.php

@@ -0,0 +1,41 @@
+## CORE BOXX LOGIN WITH QR MODULE
+https://code-boxx.com/core-boxx-qr-login-module/
+
+## REQUIREMENTS
+* [Core Boxx](https://github.com/code-boxx/Core-Boxx-PHP-Framework/tree/main/core)
+* [Users Module](https://github.com/code-boxx/Core-Boxx-PHP-Framework/tree/main/users)
+* [Admin Module](https://github.com/code-boxx/Core-Boxx-PHP-Framework/tree/main/admin)
+
+## INSTALL
+* Copy this module into your existing Core Boxx project folder.
+* Access `http://your-site.com/install/QRIN`, this will automatically:
+  - Modify `pages/ADM-users.php`, load additional JS for QR.
+  - Add "QR Login" button to `pages/ADM-users-list.php`.
+  - Modify `pages/PAGE-login.php`, load additional JS and add "QR login" button.
+  - Delete `PAGE-install-QRIN.php` itself.
+
+## NOTES
+* Access admin users, select a user, "QR login".
+* Create a QR token for the user.
+* That's all, give the token to the user - Just scan to login.
+
+## LICENSE
+Copyright by Code Boxx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

core/lib/JWT/composer/autoload_real.php

@@ -0,0 +1,20 @@
+var uqr = {
+  // (A) SHOW WRITE QR PAGE
+  hqNull : null, // html null token button
+  show : id => cb.load({
+    page : "admin/users/qr", target : "cb-page-2",
+    data : { id : id },
+    onload : () => {
+      uqr.hqNull = document.getElementById("qr-null");
+      cb.page(2);
+    }
+  }),
+
+  // (B) NULLIFY QR TOKEN
+  null : id => cb.api({
+    mod : "qrin", act : "del",
+    data : { id : id },
+    passmsg : "Login token nullified.",
+    onpass : res => uqr.hqNull.disabled = true
+  })
+};

core/lib/JWT/composer/autoload_static.php

@@ -0,0 +1,62 @@
+var qrscan = {
+  // (A) PROPERTIES
+  scanner : null, // scanner object
+  
+  // (B) INITIALIZE
+  init : after => {
+    // (B1) ATTACH HTML
+    let hScan = document.createElement("div");
+    hScan.id = "qr-wrapA";
+    hScan.className = "d-none tran-zoom bg-dark";
+    hScan.innerHTML = `<div id="qr-wrapB">
+      <h3 class="mb-3 text-white">SCAN QR CODE</h3>
+      <div id="qr-cam" class="bg-light"></div>
+      <button type="button" class="mt-4 btn btn-danger d-flex-inline" onclick="qrscan.hide()">
+        <i class="ico-sm icon-cross"></i> Cancel
+      </button>
+    </div>`;
+    document.body.appendChild(hScan);
+
+    // (B2) CREATE QR SCANNER OBJECT
+    qrscan.scanner = new Html5QrcodeScanner("qr-cam", { fps: 10, qrbox: 250 });
+    qrscan.scanner.render((txt, res) => {
+      qrscan.hide();
+      after(txt);
+    });
+  },
+
+  // (C) SHOW SCANNER
+  show : () => cb.transit(() => {
+    document.getElementById("qr-wrapA").classList.remove("d-none");
+    document.body.classList.add("overflow-hidden");
+  }),
+
+  // (D) HIDE QR SCANNER
+  hide : () => {
+    // (D1) SEEMINGLY NO SMART WAY TO "STOP SCANNING"
+    let stop = document.getElementById("html5-qrcode-button-camera-stop"),
+        wrap = document.getElementById("qr-wrapA");
+    if (stop != null) {
+      if (stop.style.display!="none") { stop.click(); }
+    }
+
+    // (D2) HIDE SCANNER
+    cb.transit(() => {
+      wrap.classList.add("d-none");
+      document.body.classList.remove("overflow-hidden");
+    });
+  },
+
+  // (E) INITIALIZE QR LOGIN
+  go : () => {
+    if (qrscan.scanner==null) {
+      qrscan.init(token => cb.api({
+        mod : "qrin", act : "login",
+        data : { token : token },
+        passmsg : false,
+        onpass : () => location.href = cbhost.base
+      }));
+    }
+    qrscan.show();
+  }
+};

core/pages/PAGE-home.php

@@ -0,0 +1,9 @@
+#qr-wrapA {
+  position: fixed; top: 0; left: 0;
+  width:100vw; height: 100vh; z-index: 999;
+  background: #fff;
+}
+#qr-wrapB {
+  max-width: 600px; padding: 30px;
+  margin: 0 auto;
+}