Skip to content

Commit 9526dad

Browse files
committed
minor #7450 Documented the security options related to redirections (javiereguiluz)
This PR was squashed before being merged into the 2.7 branch (closes #7450). Discussion ---------- Documented the security options related to redirections Commits ------- 6b5543d Documented the security options related to redirections
2 parents 64671f5 + 6b5543d commit 9526dad

File tree

1 file changed

+31
-4
lines changed

1 file changed

+31
-4
lines changed

reference/configuration/security.rst

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -318,10 +318,37 @@ request to the ``check_path`` URL.
318318
Redirecting after Login
319319
~~~~~~~~~~~~~~~~~~~~~~~
320320

321-
* ``always_use_default_target_path`` (type: ``boolean``, default: ``false``)
322-
* ``default_target_path`` (type: ``string``, default: ``/``)
323-
* ``target_path_parameter`` (type: ``string``, default: ``_target_path``)
324-
* ``use_referer`` (type: ``boolean``, default: ``false``)
321+
always_use_default_target_path
322+
..............................
323+
324+
**type**: ``boolean`` **default**: ``false``
325+
326+
If ``true``, users are always redirected to the default target path regardless
327+
of the previous URL that was stored in the session.
328+
329+
default_target_path
330+
....................
331+
332+
**type**: ``string`` **default**: ``/``
333+
334+
The page users are redirected to when there is no previous page stored in the
335+
session (for example, when the users browse the login page directly).
336+
337+
target_path_parameter
338+
.....................
339+
340+
**type**: ``string`` **default**: ``_target_path``
341+
342+
When using a login form, if you include an HTML element to set the target path,
343+
this option lets you change the name of the HTML element itself.
344+
345+
use_referer
346+
...........
347+
348+
**type**: ``boolean`` **default**: ``false``
349+
350+
If ``true``, the user is redirected to the value stored in the ``HTTP_REFERER``
351+
header when no previous URL was stored in the session.
325352

326353
.. _reference-security-pbkdf2:
327354

0 commit comments

Comments
 (0)