Installation

Installation
Requirements
Composer Installation
- Troubleshooting
- IMPORTANT: composer error
Initial Setup
- Command Setup
- Manual Setup
Controller Filters

These instructions assume that you have already installed the CodeIgniter 4 app starter as the basis for your new project, set up your .env file, and created a database that you can access via the Spark CLI script.

Requirements

Composer
Codeigniter v4.2.7 or later
A created database that you can access via the Spark CLI script

Composer Installation

Installation is done through Composer. The example assumes you have it installed globally. If you have it installed as a phar, or otherwise you will need to adjust the way you call composer itself.

composer require codeigniter4/shield

Troubleshooting

IMPORTANT: composer error

If you get the following error:

Could not find a version of package codeigniter4/shield matching your minimum-stability (stable).
Require it with an explicit version constraint allowing its desired stability.

Run the following commands to change your minimum-stability in your project composer.json:
```
composer config minimum-stability dev
composer config prefer-stable true
```
Or specify an explicit version:
```
composer require codeigniter4/shield:dev-develop
```
The above specifies develop branch. See https://getcomposer.org/doc/articles/versions.md#branches
```
composer require codeigniter4/shield:^1.0.0-beta
```
The above specifies v1.0.0-beta or later and before v2.0.0. See https://getcomposer.org/doc/articles/versions.md#caret-version-range-

Initial Setup

Command Setup

Run the following command. This command handles steps 1-5 of Manual Setup and runs the migrations.
```
php spark shield:setup
```
Note If you want to customize table names, you must change the table names before running database migrations. See Customizing Shield.

Configure app/Config/Email.php to allow Shield to send emails with the Email Class.

<?php

namespace Config;

use CodeIgniter\Config\BaseConfig;

class Email extends BaseConfig
{
    /**
     * @var string
     */
    public $fromEmail = 'your_mail@example.com';

    /**
     * @var string
     */
    public $fromName = 'your name';

    // ...
}

Manual Setup

There are a few setup items to do before you can start using Shield in your project.

Copy the Auth.php and AuthGroups.php from vendor/codeigniter4/shield/src/Config/ into your project's config folder and update the namespace to Config. You will also need to have these classes extend the original classes. See the example below. These files contain all the settings, group, and permission information for your application and will need to be modified to meet the needs of your site.
```
// new file - app/Config/Auth.php
<?php

declare(strict_types=1);

namespace Config;

// ...
use CodeIgniter\Shield\Config\Auth as ShieldAuth;

class Auth extends ShieldAuth
{
    // ...
}
```

Helper Setup The setting helper needs to be included in almost every page. The simplest way to do this is to add it to the BaseController::initController() method:

public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger)
{
    $this->helpers = array_merge($this->helpers, ['setting']);

    // Do Not Edit This Line
    parent::initController($request, $response, $logger);
}

This requires that all of your controllers extend the BaseController, but that's a good practice anyway.

Routes Setup The default auth routes can be setup with a single call in app/Config/Routes.php:
```
service('auth')->routes($routes);
```
Security Setup Set Config\Security::$csrfProtection to 'session' (or set security.csrfProtection = session in your .env file) for security reasons, if you use Session Authenticator.
Migration Run the migrations.

Note If you want to customize table names, you must change the table names before running database migrations. See Customizing Shield.
```
php spark migrate --all
```
Note: migration error

When you run spark migrate --all, if you get Class "SQLite3" not found error:
1. Remove sample migration files in tests/_support/Database/Migrations/
2. Or install sqlite3 php extension
If you get Specified key was too long error:
1. Use InnoDB, not MyISAM.

Configure app/Config/Email.php to allow Shield to send emails.

<?php

namespace Config;

use CodeIgniter\Config\BaseConfig;

class Email extends BaseConfig
{
    /**
     * @var string
     */
    public $fromEmail = 'your_mail@example.com';

    /**
     * @var string
     */
    public $fromName = 'your name';

    // ...
}

Controller Filters

The Controller Filters you can use to protect your routes the shield provides are:

public $aliases = [
    // ...
    'session'     => \CodeIgniter\Shield\Filters\SessionAuth::class,
    'tokens'      => \CodeIgniter\Shield\Filters\TokenAuth::class,
    'chain'       => \CodeIgniter\Shield\Filters\ChainAuth::class,
    'auth-rates'  => \CodeIgniter\Shield\Filters\AuthRates::class,
    'group'       => \CodeIgniter\Shield\Filters\GroupFilter::class,
    'permission'  => \CodeIgniter\Shield\Filters\PermissionFilter::class,
    'force-reset' => \CodeIgniter\Shield\Filters\ForcePasswordResetFilter::class,
    'jwt'         => \CodeIgniter\Shield\Filters\JWTAuth::class,
];

Filters	Description
session and tokens	The `Session` and `AccessTokens` authenticators, respectively.
chained	The filter will check both authenticators in sequence to see if the user is logged in through either of authenticators, allowing a single API endpoint to work for both an SPA using session auth, and a mobile app using access tokens.
jwt	The `JWT` authenticator. See JWT Authentication.
auth-rates	Provides a good basis for rate limiting of auth-related routes.
group	Checks if the user is in one of the groups passed in.
permission	Checks if the user has the passed permissions.
force-reset	Checks if the user requires a password reset.

These can be used in any of the normal filter config settings, or within the routes file.

Note These filters are already loaded for you by the registrar class located at src/Config/Registrar.php.

Protect All Pages

If you want to limit all routes (e.g. localhost:8080/admin, localhost:8080/panel and ...), you need to add the following code in the app/Config/Filters.php file.

public $globals = [
    'before' => [
        // ...
        'session' => ['except' => ['login*', 'register', 'auth/a/*']],
    ],
    // ...
];

Rate Limiting

To help protect your authentication forms from being spammed by bots, it is recommended that you use the auth-rates filter on all of your authentication routes. This can be done with the following filter setup:

public $filters = [
    'auth-rates' => [
        'before' => [
            'login*', 'register', 'auth/*'
        ]
    ]
];

Forcing Password Reset

If your application requires a force password reset functionality, ensure that you exclude the auth pages and the actual password reset page from the before global. This will ensure that your users do not run into a too many redirects error. See:

public $globals = [
    'before' => [
        //...
        //...
        'force-reset' => ['except' => ['login*', 'register', 'auth/a/*', 'change-password', 'logout']]
    ]
];

In the example above, it is assumed that the page you have created for users to change their password after successful login is change-password.

Note If you have grouped or changed the default format of the routes, ensure that your code matches the new format(s) in the app/Config/Filter.php file.

For example, if you configured your routes like so:

$routes->group('accounts', static function($routes) {
    service('auth')->routes($routes);
});

Then the global before filter for session should look like so:

public $globals = [
    'before' => [
        // ...
        'session' => ['except' => ['accounts/login*', 'accounts/register', 'accounts/auth/a/*']]
    ]
]

The same should apply for the Rate Limiting and Forcing Password Reset.