Merge branch 'release/2.1.0'

Author: adrenth

.gitattributes

@@ -0,0 +1,7 @@
+#
+# Exclude files from exporting
+#
+
+/.gitattributes     export-ignore
+/.github            export-ignore
+/.gitignore         export-ignore

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.1.0] - 2022-02-15
+
+- Maintenance update:
+  - Added `.gitattributes` files
+  - Added composer/installers:^2.0 constraint to composer.json
+  - Code (readability) improvements
+  - Moved `Vdlp\BasicAuthentication\ServiceProvider` to `Vdlp\BasicAuthentication\ServiceProviders\BasicAuthenticationServiceProvider`
+  - Moved boot logic from `Plugin` to its own middleware class `Vdlp\BasicAuthentication\Http\Middleware\BasicAuthenticationMiddleware`
+  - Moved logic from AuthorizationHelper to `Vdlp\BasicAuthentication\Http\Middleware\BasicAuthenticationMiddleware`
+
+## [2.0.0] - 2021-07-13
+
+- Add support for PHP 7.4 and higher
+
+## [1.2.0] - 2021-06-09
+
+- Add console command for adding credentials
+
+## [1.1.0] - 2021-05-28
+
+- Add notification to settings view when basic authentication is disabled

Plugin.php

@@ -5,13 +5,12 @@
 namespace Vdlp\BasicAuthentication;
 
 use Backend\Helpers\Backend as BackendHelper;
-use Illuminate\Database\Eloquent\ModelNotFoundException;
-use Illuminate\Http\Request;
-use Symfony\Component\HttpFoundation\Exception\SuspiciousOperationException;
+use October\Rain\Foundation\Application;
+use October\Rain\Foundation\Http\Kernel;
 use System\Classes\PluginBase;
-use Vdlp\BasicAuthentication\Classes\AuthorizationHelper;
 use Vdlp\BasicAuthentication\Console\CreateCredentialsCommand;
-use Vdlp\BasicAuthentication\Models\Credential;
+use Vdlp\BasicAuthentication\Http\Middleware\BasicAuthenticationMiddleware;
+use Vdlp\BasicAuthentication\ServiceProviders\BasicAuthenticationServiceProvider;
 
 final class Plugin extends PluginBase
 {
@@ -27,71 +26,28 @@ public function pluginDetails(): array
 
     public function register(): void
     {
-        $this->app->register(ServiceProvider::class);
+        $this->app->register(BasicAuthenticationServiceProvider::class);
 
         $this->registerConsoleCommand(CreateCredentialsCommand::class, CreateCredentialsCommand::class);
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @throws SuspiciousOperationException
-     */
     public function boot(): void
     {
-        if (
-            !config('basicauthentication.enabled')
-            || app()->runningInConsole()
-            || app()->runningUnitTests()
-            || app()->runningInBackend()
-        ) {
-            return;
-        }
-
-        /** @var AuthorizationHelper $authorizationHelper */
-        $authorizationHelper = resolve(AuthorizationHelper::class);
-
-        /** @var Request $request */
-        $request = resolve(Request::class);
-
-        if ($authorizationHelper->isIpAddressWhitelisted((string) $request->ip())) {
-            return;
-        }
-
-        try {
-            /** @var Credential $credential */
-            $credential = Credential::query()
-                ->where('hostname', '=', $request->getHost())
-                ->where('is_enabled', '=', true)
-                ->firstOrFail();
-        } catch (ModelNotFoundException $e) {
-            return;
-        }
-
-        if ($authorizationHelper->isUrlExcluded($request->getUri())) {
-            return;
-        }
-
-        $sessionKey = str_slug(str_replace('.', '_', $credential->getAttribute('hostname')) . '_basic_authentication');
-
-        if (session()->has($sessionKey)) {
-            return;
-        }
+        /** @var Application $application */
+        $application = $this->app;
 
         if (
-            $request->getUser() === $credential->getAttribute('username')
-            && $request->getPassword() === $credential->getAttribute('password')
+            (bool) config('basicauthentication.enabled', false) === false
+            || $application->runningInConsole()
+            || $application->runningUnitTests()
+            || $application->runningInBackend()
         ) {
-            session()->put($sessionKey, $request->getUser());
-
             return;
         }
 
-        header('WWW-Authenticate: Basic realm="' . $credential->getAttribute('realm') . '"');
-        header('HTTP/1.0 401 Unauthorized');
-
-        echo (string) trans('vdlp.basicauthentication::lang.output.unauthorized');
-        exit(0);
+        /** @var Kernel $kernel */
+        $kernel = $application['Illuminate\Contracts\Http\Kernel'];
+        $kernel->prependMiddleware(BasicAuthenticationMiddleware::class);
     }
 
     public function registerPermissions(): array

README.md

@@ -17,7 +17,7 @@ composer require vdlp/oc-basicauthentication-plugin
 To configure this plugin execute the following command:
 
 ```
-php artisan vendor:publish --provider="Vdlp\BasicAuthentication\ServiceProvider" --tag="config"
+php artisan vendor:publish --provider="Vdlp\BasicAuthentication\ServiceProviders\BasicAuthenticationServiceProvider" --tag="config"
 ```
 
 This will create a `config/basicauthentication.php` file in your app where you can modify the configuration if you don't want to use `.env` variables.

ServiceProvider.php

@@ -1,8 +1,8 @@
 {
     "name": "vdlp/oc-basicauthentication-plugin",
     "description": "Protect your website with Basic Authentication.",
-    "type": "october-plugin",
     "license": "GPL-2.0",
+    "type": "october-plugin",
     "authors": [
         {
             "name": "Van der Let & Partners",
@@ -14,6 +14,12 @@
     },
     "require": {
         "php": "^7.4 || ^8.0",
-        "composer/installers": "^1.0"
+        "composer/installers": "^1.0 || ^2.0"
+    },
+    "archive": {
+        "exclude": [
+            ".gitignore",
+            ".github"
+        ]
     }
 }

classes/AuthorizationHelper.php

@@ -13,6 +13,7 @@
     | BASIC_AUTHENTICATION_ENABLED to your .env file.
     |
     */
+
     'enabled' => (bool) env('BASIC_AUTHENTICATION_ENABLED', false),
 
     /*
@@ -23,6 +24,7 @@
     | Provide a comma separated list of IP addresses to whitelist.
     |
     */
+
     'whitelisted_ips' => env('BASIC_AUTHENTICATION_WHITELISTED_IPS', ''),
 
 ];

composer.json

@@ -34,8 +34,8 @@ public function handle(): void
                 ]);
 
             $this->info('Basic Authentication credentials have been added to the database.');
-        } catch (Throwable $e) {
-            $this->error('Could not create Basic Authentication credentials: ' . $e->getMessage());
+        } catch (Throwable $throwable) {
+            $this->error('Could not create Basic Authentication credentials: ' . $throwable->getMessage());
         }
     }
 }

config.php

@@ -6,8 +6,8 @@
 
 use Backend\Behaviors\FormController;
 use Backend\Behaviors\ListController;
-use Backend\Classes\NavigationManager;
 use Backend\Classes\Controller;
+use Backend\Classes\NavigationManager;
 use Illuminate\Contracts\Config\Repository;
 use System\Classes\SettingsManager;
 
@@ -34,6 +34,6 @@ public function __construct(Repository $config)
         NavigationManager::instance()->setContext('October.System', 'system', 'settings');
         SettingsManager::setContext('Vdlp.BasicAuthentication', 'credentials');
 
-        $this->enabled = $config->get('basicauthentication.enabled');
+        $this->enabled = (bool) $config->get('basicauthentication.enabled', false);
     }
 }

console/CreateCredentialsCommand.php

@@ -6,8 +6,8 @@
 
 use Backend\Behaviors\FormController;
 use Backend\Behaviors\ListController;
-use Backend\Classes\NavigationManager;
 use Backend\Classes\Controller;
+use Backend\Classes\NavigationManager;
 use Illuminate\Contracts\Config\Repository;
 use System\Classes\SettingsManager;
 
@@ -34,6 +34,6 @@ public function __construct(Repository $config)
         NavigationManager::instance()->setContext('October.System', 'system', 'settings');
         SettingsManager::setContext('Vdlp.BasicAuthentication', 'excludedurls');
 
-        $this->enabled = $config->get('basicauthentication.enabled');
+        $this->enabled = (bool) $config->get('basicauthentication.enabled', false);
     }
 }