-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
233 additions
and
153 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 }} |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # Security Policy | ||
|
|
||
| ## Supported Versions | ||
|
|
||
|
|
||
| | Version | Supported | PHP Version | | ||
| |---------|--------------------|------------------------------------------------------------------------------------------------------------------| | ||
| | 3.x | :white_check_mark: |  | | ||
| | <= 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. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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', | ||
| ] | ||
| ], | ||
| ], | ||
| ]; | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Installation | ||
|
|
||
| Run the following command in your project root directory | ||
|
|
||
| ```bash | ||
| $ composer require dotkernel/dot-rbac | ||
| ``` |
Oops, something went wrong.