Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
@weaverryan
weaverryan committed Jul 2, 2011
2 parents 8383f1e + 8e66cc9 commit 6f8aa81
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 51 deletions.
94 changes: 47 additions & 47 deletions book/security.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ authentication (i.e. the old-school username/password box):
encoders:
Symfony\Component\Security\Core\User\User: plaintext
.. code-block:: xml
<!-- app/config/config.xml -->
Expand All @@ -83,10 +83,10 @@ authentication (i.e. the old-school username/password box):
<encoder class="Symfony\Component\Security\Core\User\User" algorithm="plaintext" />
</config>
</srv:container>
</srv:container>
.. code-block:: php
// app/config/config.php
$container->loadFromExtension('security', array(
'firewalls' => array(
Expand Down Expand Up @@ -147,14 +147,14 @@ Firewalls (Authentication)
When a user makes a request to a URL that's protected by a firewall, the
security system is activated. The job of the firewall is to determine whether
or not the user needs to be authenticated, and if he does, to send a response
back to the user initiating the authentication process.
back to the user initiating the authentication process.

A firewall is activated when the URL of an incoming request matches the configured
firewall's regular expression ``pattern`` config value. In this example, the
``pattern`` (``^/``) will match *every* incoming request. The fact that the
firewall is activated does *not* mean, however, that the HTTP authentication
username and password box is displayed for every URL. For example, any user
can access ``/foo`` without being prompted to authenticate.
can access ``/foo`` without being prompted to authenticate.

.. image:: /images/book/security_anonymous_user_access.png
:align: center
Expand Down Expand Up @@ -238,7 +238,7 @@ the request flow is always the same:
But with HTTP authentication, the user submits its credentials directly
to the original URL (e.g. ``/admin/foo``) and then the page is returned
to the user in that same request (i.e. no redirect).

These types of idiosyncrasies shouldn't cause you any problems, but they're
good to keep in mind.

Expand Down Expand Up @@ -277,7 +277,7 @@ First, enable form login under your firewall:
form_login:
login_path: /login
check_path: /login_check
.. code-block:: xml
<!-- app/config/config.xml -->
Expand All @@ -292,10 +292,10 @@ First, enable form login under your firewall:
<form-login login_path="/login" check_path="/login_check" />
</firewall>
</config>
</srv:container>
</srv:container>
.. code-block:: php
// app/config/config.php
$container->loadFromExtension('security', array(
'firewalls' => array(
Expand All @@ -315,19 +315,19 @@ First, enable form login under your firewall:
If you don't need to customize your ``login_path`` or ``check_path``
values (the values used here are the default values), you can shorten
your configuration:

.. configuration-block::

.. code-block:: yaml
form_login: ~
.. code-block:: xml
<form-login />
.. code-block:: php
'form_login' => array(),
Now, when the security system initiates the authentication process, it will
Expand Down Expand Up @@ -519,7 +519,7 @@ see :doc:`/cookbook/security/form_login`.
.. sidebar:: Avoid Common Pitfalls

When setting up your login form, watch out for a few common pitfalls.

**1. Create the correct routes**

First, be sure that you've defined the ``/login`` and ``/login_check``
Expand Down Expand Up @@ -582,7 +582,7 @@ see :doc:`/cookbook/security/form_login`.
Also, if your firewall does *not* allow for anonymous users, you'll need
to create a special firewall that allows anonymous users for the login
page:

.. configuration-block::

.. code-block:: yaml
Expand All @@ -599,10 +599,10 @@ see :doc:`/cookbook/security/form_login`.
<firewall name="login_firewall" pattern="^/login$">
<anonymous />
</firewall>
</firewall>
<firewall name="secured_area" pattern="^/">
<login_form />
</firewall>
</firewall>
.. code-block:: php
Expand All @@ -618,7 +618,7 @@ see :doc:`/cookbook/security/form_login`.
),
**3. Be sure ``/login_check`` is behind a firewall**

Next, make sure that your ``check_path`` URL (e.g. ``/login_check``)
is behind the firewall you're using for your form login (in this example,
the single firewall matches *all* URLs, including ``/login_check``). If
Expand Down Expand Up @@ -673,7 +673,7 @@ You can define as many URL patterns as you need - each is a regular expression.
access_control:
- { path: ^/admin/users, roles: ROLE_SUPER_ADMIN }
- { path: ^/admin, roles: ROLE_ADMIN }
.. code-block:: xml
<!-- app/config/config.xml -->
Expand All @@ -683,10 +683,10 @@ You can define as many URL patterns as you need - each is a regular expression.
<rule path="^/admin/users" role="ROLE_SUPER_ADMIN" />
<rule path="^/admin" role="ROLE_ADMIN" />
</access-control>
</config>
</config>
.. code-block:: php
// app/config/config.php
$container->loadFromExtension('security', array(
// ...
Expand Down Expand Up @@ -829,7 +829,7 @@ In fact, you've seen this already in the example in this chapter.
users:
ryan: { password: ryanpass, roles: 'ROLE_USER' }
admin: { password: kitten, roles: 'ROLE_ADMIN' }
.. code-block:: xml
<!-- app/config/config.xml -->
Expand All @@ -842,7 +842,7 @@ In fact, you've seen this already in the example in this chapter.
</config>
.. code-block:: php
// app/config/config.php
$container->loadFromExtension('security', array(
// ...
Expand All @@ -869,9 +869,9 @@ by Symfony (:class:`Symfony\\Component\\Security\\Core\\User\\User`).
If your username is completely numeric (e.g. ``77``) or contains a dash
(e.g. ``user-name``), you should use that alternative syntax when specifying
users in YAML:

.. code-block:: yaml
users:
- { name: 77, password: pass, roles: 'ROLE_USER' }
- { name: user-name, password: pass, roles: 'ROLE_USER' }
Expand Down Expand Up @@ -913,7 +913,7 @@ be stored in the database.
* @ORM\Column(type="string", length="255")
*/
protected $username;
// ...
}
Expand Down Expand Up @@ -1001,7 +1001,7 @@ do the following:
algorithm: sha1
iterations: 1
encode_as_base64: false
.. code-block:: xml
<!-- app/config/config.xml -->
Expand All @@ -1016,7 +1016,7 @@ do the following:
</config>
.. code-block:: php
// app/config/config.php
$container->loadFromExtension('security', array(
// ...
Expand Down Expand Up @@ -1058,7 +1058,7 @@ configure the encoder for that user:
encoders:
Acme\UserBundle\Entity\User: sha512
.. code-block:: xml
<!-- app/config/config.xml -->
Expand All @@ -1069,7 +1069,7 @@ configure the encoder for that user:
</config>
.. code-block:: php
// app/config/config.php
$container->loadFromExtension('security', array(
// ...
Expand Down Expand Up @@ -1119,7 +1119,7 @@ look like:
Anonymous users are technically authenticated, meaning that the ``isAuthenticated()``
method of an anonymous user object will return true. To check if your
user is actually authenticated, check for the ``IS_AUTHENTICATED_FULLY``
role.
role.

Using Multiple User Providers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -1189,7 +1189,7 @@ the user from both the ``in_memory`` and ``user_db`` providers.
If you have no reasons to separate your ``in_memory`` users from your
``user_db`` users, you can accomplish this even more easily by combining
the two sources into a single provider:

.. configuration-block::

.. code-block:: yaml
Expand Down Expand Up @@ -1244,7 +1244,7 @@ the first provider is always used:
realm: "Secured Demo Area"
provider: in_memory
form_login: ~
.. code-block:: xml
<!-- app/config/config.xml -->
Expand All @@ -1257,7 +1257,7 @@ the first provider is always used:
</config>
.. code-block:: php
// app/config/config.php
$container->loadFromExtension('security', array(
'firewalls' => array(
Expand Down Expand Up @@ -1360,7 +1360,7 @@ the firewall can handle this automatically for you when you activate the
path: /logout
target: /
# ...
.. code-block:: xml
<!-- app/config/config.xml -->
Expand All @@ -1373,7 +1373,7 @@ the firewall can handle this automatically for you when you activate the
</config>
.. code-block:: php
// app/config/config.php
$container->loadFromExtension('security', array(
'firewalls' => array(
Expand All @@ -1395,15 +1395,15 @@ them, you can omit them entirely and shorten your configuration:
.. configuration-block::

.. code-block:: yaml
logout: ~
.. code-block:: xml
<logout />
.. code-block:: php
'logout' => array(),
Note that you will *not* need to implement a controller for the ``/logout``
Expand Down Expand Up @@ -1456,13 +1456,13 @@ the built-in helper function:
.. configuration-block::

.. code-block:: html+jinja

{% if is_granted('ROLE_ADMIN') %}
<a href="...">Delete</a>
{% endif %}

.. code-block:: html+php

<?php if ($view['security']->isGranted('ROLE_ADMIN')): ?>
<a href="...">Delete</a>
<?php endif; ?>
Expand Down Expand Up @@ -1659,6 +1659,6 @@ Learn more from the Cookbook

.. _`security component`: https://github.com/symfony/Security
.. _`SecurityExtraBundle`: https://github.com/schmittjoh/SecurityExtraBundle
.. _`FOSUserBundle`: https://github.com/FriendsOfSymfony/UserBundle
.. _`FOSUserBundle`: https://github.com/FriendsOfSymfony/FOSUserBundle
.. _`implement the \Serializable interface`: http://php.net/manual/en/class.serializable.php
.. _`functions-online.com`: http://www.functions-online.com/sha1.html
4 changes: 2 additions & 2 deletions book/templating.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ template. First, create the template that you'll need to reuse.

.. code-block:: html+jinja

{# src/Acme/ArticleBundle/Resources/Article/articleDetails.html.twig #}
{# src/Acme/ArticleBundle/Resources/views/Article/articleDetails.html.twig #}
<h1>{{ article.title }}</h1>
<h3 class="byline">by {{ article.authorName }}</h3>

Expand All @@ -494,7 +494,7 @@ template. First, create the template that you'll need to reuse.

.. code-block:: php
<!-- src/Acme/ArticleBundle/Resources/Article/articleDetails.html.php -->
<!-- src/Acme/ArticleBundle/Resources/views/Article/articleDetails.html.php -->
<h2><?php echo $article->getTitle() ?></h2>
<h3 class="byline">by <?php echo $article->getAuthorName() ?></h3>
Expand Down
2 changes: 1 addition & 1 deletion cookbook/doctrine/common_extensions.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ with an extensions library that offers `Sluggable`_, `Translatable`_, `Timestamp

See the bundle for more details.

.. _`DoctrineExtensionsBundle`: https://github.com/stof/DoctrineExtensionsBundle
.. _`DoctrineExtensionsBundle`: https://github.com/stof/StofDoctrineExtensionsBundle
.. _`Sluggable`: https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/sluggable.md
.. _`Translatable`: https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/translatable.md
.. _`Timestampable`: https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/timestampable.md
Expand Down
2 changes: 1 addition & 1 deletion cookbook/doctrine/migrations.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Make sure you have both the ``doctrine-migrations`` and ``DoctrineMigrationsBund
libraries configured in your project. Follow these steps to install the
libraries in the Symfony Standard distribution.

Add the following to ``bin/deps``. This will register the Migrations Bundle
Add the following to ``deps``. This will register the Migrations Bundle
and the doctrine-migrations library as dependencies in your application:

.. code-block:: text
Expand Down

0 comments on commit 6f8aa81

Please sign in to comment.