Skip to content

config: use Strict Validation Rules by default #6908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions app/Config/Validation.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
namespace Config;

use CodeIgniter\Config\BaseConfig;
use CodeIgniter\Validation\CreditCardRules;
use CodeIgniter\Validation\FileRules;
use CodeIgniter\Validation\FormatRules;
use CodeIgniter\Validation\Rules;
use CodeIgniter\Validation\StrictRules\CreditCardRules;
use CodeIgniter\Validation\StrictRules\FileRules;
use CodeIgniter\Validation\StrictRules\FormatRules;
use CodeIgniter\Validation\StrictRules\Rules;

class Validation extends BaseConfig
{
Expand Down
2 changes: 2 additions & 0 deletions user_guide_src/source/installation/upgrade_430.rst
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,8 @@ Config
- app/Config/Security.php
- Changed the value of the property ``$redirect`` to ``false`` to prevent redirection when a CSRF
check fails. This is to make it easier to recognize that it is a CSRF error.
- app/Config/Validation.php
- The default Validation Rules have been changed to Strict Rules for better security. See :ref:`validation-traditional-and-strict-rules`.

All Changes
===========
Expand Down
24 changes: 17 additions & 7 deletions user_guide_src/source/libraries/validation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,10 +201,17 @@ Config for Validation
Traditional and Strict Rules
============================

CI4 has two kinds of Validation rule classes.
The default rule classes (**Traditional Rules**) have the namespace ``CodeIgniter\Validation``,
CodeIgniter 4 has two kinds of Validation rule classes.
The traditional rule classes (**Traditional Rules**) have the namespace ``CodeIgniter\Validation``,
and the new classes (**Strict Rules**) have ``CodeIgniter\Validation\StrictRules``, which provide strict validation.

.. note:: Since v4.3.0, **Strict Rules** are used by default for better security.

Traditional Rules
-----------------

.. warning:: When validating data that contains non-string values, such as JSON data, it is recommended to use **Strict Rules**.

The **Traditional Rules** implicitly assume that string values are validated,
and the input value may be converted implicitly to a string value.
It works for most basic cases like validating POST data.
Expand All @@ -213,14 +220,17 @@ However, for example, if you use JSON input data, it may be a type of bool/null/
When you validate the boolean ``true``, it is converted to string ``'1'`` with the Traditional rule classes.
If you validate it with the ``integer`` rule, ``'1'`` passes the validation.

The **Strict Rules** don't use implicit type conversion.
Strict Rules
------------

.. warning:: When validating data that contains non-string values, such as JSON data, it is recommended to use **Strict Rules**.
.. versionadded:: 4.2.0

The **Strict Rules** don't use implicit type conversion.

Using Strict Rules
------------------
Using Traditional Rules
-----------------------

If you want to use these rules, you need to change the rule classes in **app/Config/Validation.php**:
If you want to use traditional rules, you need to change the rule classes in **app/Config/Validation.php**:

.. literalinclude:: validation/003.php

Expand Down
8 changes: 4 additions & 4 deletions user_guide_src/source/libraries/validation/003.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
class Validation
{
public $ruleSets = [
\CodeIgniter\Validation\StrictRules\CreditCardRules::class,
\CodeIgniter\Validation\StrictRules\FileRules::class,
\CodeIgniter\Validation\StrictRules\FormatRules::class,
\CodeIgniter\Validation\StrictRules\Rules::class,
\CodeIgniter\Validation\CreditCardRules::class,
\CodeIgniter\Validation\FileRules::class,
\CodeIgniter\Validation\FormatRules::class,
\CodeIgniter\Validation\Rules::class,
];

// ...
Expand Down