updated docs, workflows, security, composer.json

.github/workflows/continuous-integration.yml

@@ -0,0 +1,11 @@
+name: "Continuous Integration"
+
+on:
+  pull_request:
+  push:
+    branches:
+    tags:
+
+jobs:
+  ci:
+    uses: laminas/workflow-continuous-integration/.github/workflows/continuous-integration.yml@1.x

.github/workflows/docs-build.yml

@@ -0,0 +1,16 @@
+name: docs-build
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build Docs
+        uses: dotkernel/documentation-theme/github-actions/docs@main
+        env:
+          DEPLOY_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,8 +1,6 @@
 # dot-rbac-guard
 
-Defines authorization guards that authorize users to access certain parts of an application based on various criteria.
-If the authorization service can be used to check authorization on a narrow level, the guards are meant to work as gateways to bigger parts of an application.
-Usually, you'll want to use both methods in an application for additional security.
+Defines authorization guards that authorize users for accessing certain parts of an application based on various criteria. If the authorization service can be used to check authorization on a narrow level, the guards are meant to work as gateways to bigger parts of an application. Usually, you'll want to use both methods in an application for increased security.
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-rbac-guard)
 ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-rbac-guard/3.4.3)
@@ -12,7 +10,7 @@ Usually, you'll want to use both methods in an application for additional securi
 [![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-rbac-guard)](https://github.com/dotkernel/dot-rbac-guard/stargazers)
 [![GitHub license](https://img.shields.io/github/license/dotkernel/dot-rbac-guard)](https://github.com/dotkernel/dot-rbac-guard/blob/3.4.0/LICENSE.md)
 
-[![Build Static](https://github.com/dotkernel/dot-rbac-guard/actions/workflows/static-analysis.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-rbac-guard/actions/workflows/static-analysis.yml)
+[![Build Static](https://github.com/dotkernel/dot-rbac-guard/actions/workflows/continuous-integration.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-rbac-guard/actions/workflows/continuous-integration.yml)
 [![codecov](https://codecov.io/gh/dotkernel/dot-rbac-guard/graph/badge.svg?token=HB718GSIKS)](https://codecov.io/gh/dotkernel/dot-rbac-guard)
 
 [![SymfonyInsight](https://insight.symfony.com/projects/ebbe47ef-852a-47bd-94d4-9e1725a85377/big.svg)](https://insight.symfony.com/projects/ebbe47ef-852a-47bd-94d4-9e1725a85377)
@@ -25,17 +23,16 @@ Run the following command in your project's root directory
 $ composer require dotkernel/dot-rbac-guard
 ```
 
-Please note that this module is built around the authorization service defined in module dot-rbac. 
-Running the above command will also install that package. You'll have to first configure dot-rbac before using this module.
+Please note that this module is built around the authorization service defined in module dot-rbac. Running the above command will also install that package. You'll have to first configure dot-rbac before using this module.
 
 ## Configuration
 
 As with many DotKernel modules, we focus on the configuration based approach of customizing the module for your needs.
 
-After installing, make sure you merge the module's `ConfigProvider` with your application's config to make sure required dependencies and default module configuration is registered.
-Create a configuration file for this module in your 'config/autoload' folder
+After installing, merge the module's `ConfigProvider` with your application's config to make sure required dependencies and default module configuration are registered. Create a configuration file for this module in your 'config/autoload' folder.
+
+### authorization-guards.global.php
 
-##### authorization-guards.global.php
 ```php
 return [
     'dot_authorization' => [
@@ -137,9 +134,10 @@ return [
 ## Register the RbacGuardMiddleware in the pipe
 
 The last step in order to use this package is to register the middleware. This middleware triggers the authorization event.
-You MUST insert this middleware between the routing middleware and the dispatch middleware of the application, because the guards need the RouteResult in order to get the matched route and params.
+You MUST insert this middleware between the routing middleware and the dispatch middleware of the application, because the guards need the `RouteResult` in order to get the matched route and params.
+
+### middleware-pipeline.global.php
 
-##### middleware-pipeline.global.php
 ```php
 //...
 

SECURITY.md

@@ -0,0 +1,40 @@
+# Security Policy
+
+## Supported Versions
+
+
+| Version | Supported          | PHP Version                                                                                                      |
+|---------|--------------------|------------------------------------------------------------------------------------------------------------------|
+| 3.x     | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-rbac-guard/3.4.3) |
+| <= 2.x  | :x:                |                                                                                                                  |
+
+
+## Reporting Potential Security Issues
+
+If you have encountered a potential security vulnerability in this project,
+please report it to us at <security@dotkernel.com>. We will work with you to
+verify the vulnerability and patch it.
+
+When reporting issues, please provide the following information:
+
+- Component(s) affected
+- A description indicating how to reproduce the issue
+- A summary of the security vulnerability and impact
+
+We request that you contact us via the email address above and give the
+project contributors a chance to resolve the vulnerability and issue a new
+release prior to any public exposure; this helps protect the project's
+users, and provides them with a chance to upgrade and/or update in order to
+protect their applications.
+
+
+## Policy
+
+If we verify a reported security vulnerability, our policy is:
+
+- We will patch the current release branch, as well as the immediate prior minor
+  release branch.
+
+- After patching the release branches, we will immediately issue new security
+  fix releases for each patched release branch.
+

composer.json

@@ -47,7 +47,8 @@
     "config": {
         "sort-packages": true,
         "allow-plugins": {
-            "dealerdirect/phpcodesniffer-composer-installer": true
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "laminas/laminas-dependency-plugin": false
         }
     },
     "scripts": {

docs/book/index.md

@@ -0,0 +1 @@
+../../README.md

docs/book/v3/configuration.md

@@ -0,0 +1,105 @@
+# Configuration
+
+As with many DotKernel modules, we focus on the configuration based approach of customizing the module for your needs.
+
+After installing, merge the module's `ConfigProvider` with your application's config to make sure required dependencies and default module configuration are registered. Create a configuration file for this module in your 'config/autoload' folder.
+
+## authorization-guards.global.php
+
+```php
+return [
+    'dot_authorization' => [
+
+        //define how it will treat non-matching guard rules, allow all by default
+        'protection_policy' => \Dot\Rbac\Guard\GuardInterface::POLICY_ALLOW,
+
+        'event_listeners' => [
+            [
+                'type' => 'class or service name of the listener',
+                'priority' => 1,
+            ],
+        ],
+
+        //define custom guards here
+        'guard_manager' => [],
+
+        //register custom guards providers here
+        'guards_provider_manager' => [],
+
+        //define which guards provider to use, along with its configuration
+        //the guards provider should know how to build a list of GuardInterfaces based on its configuration
+        'guards_provider' => [
+            'type' => 'ArrayGuards',
+            'options' => [
+                'guards' => [
+                    [
+                        'type' => 'Route',
+                        'options' => [
+                            'rules' => [
+                                'premium' => ['admin'],
+                                'login' => ['guest'],
+                                'logout' => ['admin', 'user', 'viewer'],
+                                'account' => ['admin', 'user'],
+                                'home' => ['*'],
+                            ]
+                        ]
+                    ],
+                    [
+                        'type' => 'RoutePermission',
+                        'options' => [
+                            'rules' => [
+                                'premium' => ['premium'],
+                                'account' => ['my-account'],
+                                'logout' => ['only-logged'],
+                            ]
+                        ]
+                    ],
+                    [
+                        'type' => 'Controller',
+                        'options' => [
+                            'rules' => [
+                                [
+                                   'route' => 'controller route name',
+                                   'actions' => [//list of actions to apply, or empty array for all actions],
+                                   //by default, authorization pass if all permissions are present(AND)
+                                   'roles' => [//list of roles to allow],
+                               ],
+                            ]
+                        ]
+                    ],
+                    [
+                        'type' => 'ControllerPermission',
+                        'options' => [
+                            'rules' => [
+                                [
+                                    'route' => 'controller route name',
+                                    'actions' => [//list of actions to apply, or empty array for all actions],
+                                    //by default, authorization pass if all permissions are present(AND)
+                                    'permissions' => [//list of permissions to allow],
+                                ],
+                                [
+                                    'route' => 'controller route name',
+                                    'actions' => [//list of actions to apply, or empty array for all actions],
+                                    'permissions' => [
+                                        //permission can be defined in this way too, for all permission type guards
+                                        'permissions' => [//list of permissions],
+                                        'condition' => \Dot\Rbac\Guard\GuardInterface::CONDITION_OR,
+                                    ]
+                                ]
+                            ]
+                        ]
+                    ]
+                ]
+            ],
+        ],
+
+        //overwrite default messages
+        'messages_options' => [
+            'messages' => [
+                //MessagesOptions::UNAUTHORIZED => 'You must sign in first to access the requested content',
+                //MessagesOptions::FORBIDDEN => 'You don\'t have enough permissions to access the requested content',
+            ]
+        ],
+    ],
+];
+```

docs/book/v3/installation.md

@@ -0,0 +1,5 @@
+# Installation
+
+Run the following command in your project root directory
+
+    composer require dotkernel/dot-rbac-guard