Skip to content

Commit c6736da

Browse files
fabpotfabpot
committed
added some indexes for the Security guide
1 parent d7d4f12 commit c6736da

File tree

4 files changed

+84
-0
lines changed

4 files changed

+84
-0
lines changed

‎guides/security/authentication.rst

+34
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
.. index::
2+
single: Security; Authentication
3+
14
Authentication
25
==============
36

@@ -11,6 +14,10 @@ not available, not sufficient, or just wrong.
1114
after the ``core.request`` one. All features described in this document
1215
are implemented as listeners to this event.
1316

17+
.. index::
18+
single: Security; Firewall
19+
pair: Security; Configuration
20+
1421
The Firewall Map
1522
----------------
1623

@@ -76,6 +83,9 @@ $request->getPathInfo())``.)
7683
will use the first configuration for which the pattern matches the request
7784
(so you need to define more specific configurations first).
7885

86+
.. index::
87+
pair: Security; Configuration
88+
7989
Authentication Mechanisms
8090
-------------------------
8191

@@ -152,6 +162,9 @@ X.509 certificate, an Authorization HTTP header, or use a form to login.
152162
HTTP Basic authentication is interoperable, but not secure. HTTP Digest is
153163
more secure, but not really interoperable in practice.
154164

165+
.. index::
166+
single: Security; HTTP Basic
167+
155168
HTTP Basic
156169
~~~~~~~~~~
157170

@@ -185,6 +198,9 @@ Configuring HTTP basic authentication is as simple as it can get:
185198
),
186199
));
187200
201+
.. index::
202+
single: Security; HTTP Digest
203+
188204
HTTP Digest
189205
~~~~~~~~~~~
190206

@@ -222,6 +238,9 @@ Configuring HTTP digest authentication is as simple as it can get:
222238

223239
To use HTTP Digest, you must store the user passwords in clear.
224240

241+
.. index::
242+
single: Security; Form based
243+
225244
Form based authentication
226245
~~~~~~~~~~~~~~~~~~~~~~~~~
227246

@@ -416,6 +435,9 @@ configuration example that shows how to override them all:
416435
),
417436
));
418437
438+
.. index::
439+
single: Security; X.509 certificates
440+
419441
X.509 Certificates
420442
~~~~~~~~~~~~~~~~~~
421443

@@ -484,6 +506,9 @@ of the ``SSL_CLIENT_S_DN_Email`` environment variable.)
484506
Certificate authentication only works when the user access the application
485507
via HTTPS.
486508

509+
.. index::
510+
single: Security; Anonymous Users
511+
487512
Anonymous Users
488513
~~~~~~~~~~~~~~~
489514

@@ -530,6 +555,9 @@ of the security context:
530555
All anonymous users automatically have the 'IS_AUTHENTICATED_ANONYMOUSLY'
531556
role.
532557

558+
.. index::
559+
single: Security; Stateless Authentication
560+
533561
Stateless Authentication
534562
------------------------
535563

@@ -574,6 +602,9 @@ cookie will be ever created by Symfony2):
574602
If you use a form login, Symfony2 will create a cookie even if you set
575603
``stateless`` to ``true``.
576604

605+
.. index::
606+
single: Security; Impersonating
607+
577608
Impersonating a User
578609
--------------------
579610

@@ -659,6 +690,9 @@ security, also change the parameter name via the ``parameter`` setting:
659690
),
660691
));
661692
693+
.. index::
694+
single: Security; Logout
695+
662696
Logout Users
663697
------------
664698

‎guides/security/authorization.rst

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
.. index::
2+
single: Security; Authorization
3+
14
Authorization
25
=============
36

@@ -7,6 +10,9 @@ but it also provides a standard and powerful way to decide if a user can
710
access any resource (a URL, a model object, a method call, ...) thanks to a
811
flexible access decision manager.
912

13+
.. index::
14+
single: Security; Access Control
15+
1016
Defining Access Control Rules for HTTP resources
1117
------------------------------------------------
1218

@@ -121,6 +127,9 @@ Access control rules can match a request in many different ways:
121127
),
122128
));
123129
130+
.. index::
131+
single: Security; HTTPS
132+
124133
Enforcing HTTP or HTTPS
125134
-----------------------
126135

‎guides/security/overview.rst

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
.. index::
2+
single: Security
3+
14
Security
25
========
36

@@ -13,6 +16,9 @@ is distilled in three other documents: :doc:`Users </guides/security/users>`,
1316
:doc:`Authentication </guides/security/authentication>`, and
1417
:doc:`Authorization </guides/security/authorization>`.
1518

19+
.. index::
20+
pair: Security; Configuration
21+
1622
Configuration
1723
-------------
1824

‎guides/security/users.rst

+35
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
.. index::
2+
single: Security; Users
3+
14
Users
25
=====
36

@@ -14,6 +17,9 @@ assumption about the client/user PHP representation, it's up to the
1417
application to define a user class and hook it up with Symfony2 via a user
1518
provider class.
1619

20+
.. index::
21+
single: Security; UserProviderInterface
22+
1723
UserProviderInterface
1824
~~~~~~~~~~~~~~~~~~~~~
1925

@@ -36,6 +42,9 @@ exception.
3642
Symfony2 comes with the most common ones. See the next section for more
3743
information.
3844

45+
.. index::
46+
single: Security; AccountInterface
47+
3948
AccountInterface
4049
~~~~~~~~~~~~~~~~
4150

@@ -59,6 +68,9 @@ The user provider must return objects that implement
5968
* ``getUsername()``: Returns the username used to authenticate the user;
6069
* ``eraseCredentials()``: Removes sensitive data from the user.
6170

71+
.. index::
72+
single: Security; Password encoding
73+
6274
Encoding Passwords
6375
~~~~~~~~~~~~~~~~~~
6476

@@ -92,6 +104,9 @@ When encoding your passwords, it's better to also define a unique salt per user
92104
(the ``getSalt()`` method can return the primary key if users are persisted in
93105
a database for instance.)
94106

107+
.. index::
108+
single: Security; AdvancedAccountInterface
109+
95110
AdvancedAccountInterface
96111
~~~~~~~~~~~~~~~~~~~~~~~~
97112

@@ -123,6 +138,9 @@ will make the associated checks automatically::
123138
:class:`Symfony\\Component\\Security\\User\\AccountCheckerInterface`
124139
object to do the pre-authentication and post-authentication checks.
125140

141+
.. index::
142+
single: Security; User Providers
143+
126144
Defining a Provider
127145
-------------------
128146

@@ -132,6 +150,9 @@ comes with provider for in-memory users, Doctrine Entities, Doctrine
132150
Documents, and defines a base class for any DAO provider you might want to
133151
create.
134152

153+
.. index::
154+
single: Security; In-memory user provider
155+
135156
In-memory Provider
136157
~~~~~~~~~~~~~~~~~~
137158

@@ -187,6 +208,10 @@ or a prototype. It is also the best provider when writing unit tests:
187208
The above configuration defines two in-memory providers. As you can see, the
188209
second one uses 'sha1' to encode the user passwords.
189210

211+
.. index::
212+
single: Security; Doctrine Entity Provider
213+
single: Doctrine; Doctrine Entity Provider
214+
190215
Doctrine Entity Provider
191216
~~~~~~~~~~~~~~~~~~~~~~~~
192217

@@ -273,6 +298,10 @@ implement :class:`Symfony\\Component\\Security\\User\\UserProviderInterface`::
273298
:class:`Symfony\\Component\\Security\\User\\AccountCheckerInterface`
274299
implementation.
275300

301+
.. index::
302+
single: Security; Doctrine Document Provider
303+
single: Doctrine; Doctrine Document Provider
304+
276305
Doctrine Document Provider
277306
~~~~~~~~~~~~~~~~~~~~~~~~~~
278307

@@ -369,6 +398,9 @@ After authentication, the user is accessed via the security context::
369398
You can also check if the user is authenticated with the ``isAuthenticated()``
370399
method.
371400

401+
.. index::
402+
single: Security; Roles
403+
372404
Roles
373405
-----
374406

@@ -387,6 +419,9 @@ more about access control, roles, and voters.
387419
If you define your own roles with a dedicated Role class, don't use the
388420
``ROLE_`` prefix.
389421

422+
.. index::
423+
single: Security; Roles (Hierarchical)
424+
390425
Hierarchical Roles
391426
~~~~~~~~~~~~~~~~~~
392427

0 commit comments

Comments
 (0)