Skip to content
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

Updated csrf_in_login_form.rst to include new labels #5942

Closed
wants to merge 3 commits into from

Conversation

Raistlfiren
Copy link
Contributor

Updated CSRF documentation to rename intention and csrf_provider. They were renamed in SF 3.0 to csrf_token_id and csrf_token_generator. In SF 2.8 intention is depreciated and in SF 2.8 csrf_provider is still being used.

Q A
Doc fix? yes
New docs? no
Applies to 3.0
Fixed tickets #3059

…n_generator

Updated CSRF documentation to rename intention and csrf_provider. They were renamed in SF 3.0 to csrf_token_id and csrf_token_generator.
@stof
Copy link
Member

stof commented Dec 1, 2015

the csrf_provider change is also done in 2.8 (deprecating the old one). Otherwise, it would not have matched our upgrade policy

@stof
Copy link
Member

stof commented Dec 1, 2015

and the change should be done in the 2.8 branch actually, to avoid using the deprecated names

@@ -33,7 +37,9 @@ provider available in the Security component:
# ...
form_login:
# ...
csrf_provider: security.csrf.token_manager
# Use csrf_provider in SF <2.8
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need for such comment. this is why we have a versionned doc. Just put a versionadded section saying that the name has changed in 2.8

@xabbuh
Copy link
Member

xabbuh commented Dec 1, 2015

We can add something like the following below the configuration block:

.. versionadded:: 2.8
    The ``intention`` and ``csrf_token_generator`` options were introduced
    in Symfony 2.8. Prior, you had to use the ``csrf_token_id`` and ``csrf_provider``
    options.

@Raistlfiren You can make the changes here. We should be able to safely backport the PR to the 2.8 branch when merging and then merge things up to the master branch.

@GuGuss
Copy link

GuGuss commented Dec 2, 2015

Need a new commit to rebuild this PR on Platform.sh.

@ogizanagi
Copy link
Contributor

The SecurityBundle configuration reference should also be updated: http://symfony.com/doc/2.8/reference/configuration/security.html

@ghost
Copy link

ghost commented Dec 10, 2015

I was a little bit confused while upgrading to Symfony 3.0.
This documentation should be updated for 2.8, 3.0 and 3.1:
http://symfony.com/doc/master/cookbook/security/csrf_in_login_form.html

@javiereguiluz
Copy link
Member

We're getting more and more reports from users suffering this issue while upgrading to 3.0. Let me know if we can help you in any way to get this merged soon. Thanks!

@xabbuh
Copy link
Member

xabbuh commented Jan 15, 2016

Thank you @Raistlfiren for starting this. I have taken your changes and finished them in #6152. That's why I close here. However, you will still get the full credit for your contribution as I kept all your commits.

@xabbuh xabbuh closed this Jan 15, 2016
weaverryan added a commit that referenced this pull request Jan 16, 2016
…lfiren, Aaron Valandra, xabbuh)

This PR was merged into the 2.7 branch.

Discussion
----------

csrf_token_generator and csrf_token_id documentation

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes (symfony/symfony#6554, symfony/symfony#9587)
| Applies to    | 2.4+
| Fixed tickets | #3059, #5942

Commits
-------

304d7a5 finish csrf_token_generator and csrf_token_id docs
3ceb61c Improper markdown for versionadded.
91b5e2e Updated documentation as requested by @stof and @xabbuh
0044aa2 Updated csrf_in_login_form.rst to include csrf_token_id and csrf_token_generator
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants