Skip to content

Security documentation: The Big Picture is missing #7532

Closed
@jkufner

Description

@jkufner

Hello,
I'm digging through Symfony's Security components trying to implement a custom security bundle, and I really miss one thing: The Big Picture. There is a lot written about individual components and even source code is quite understandable, but there is nothing about how these components work together.

The workflow diagrams in HttpKernel documentation are extremely helpful. There should be similar diagrams included in Security component documentation. How all these components interact with each other? What happens during ordinary HTTP request? What happens during login? What happens during subsequent HTTP requests? …? …?

The documentation says there are some components (Guards missing, btw) and that's it. No relation between them is provided. No context. Nothing about basic principles nor ideas.

Security is important and must be well understood to make it right. A cookbook without context is not enough — it helps when one understands, but does not make him understand. Symfony Security component is powerful and complex, so it is hard to get into it.

Someone who has deep understanding of the Security component, please, draw few diagrams how it works. It will help many other developers.

Also, please don't think about what could be done and how great it would be, at least not for now. The first step to get there is to draw where we are now.


Related issues:

Activity

javiereguiluz

javiereguiluz commented on Mar 7, 2017

@javiereguiluz
Member

We agree that the Symfony Security docs need a lot of improvements. This is in our priority list ... but it's taking us a lot of time because of the massive complexity of the Security internals.

In any case, to focus all our discussions about this in one place, we've created a meta issue in #7496 and we've linked this issue from there. That's why we're closing your issue ... but only to avoid duplicated discussions. We won't forget about what you said here. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @jkufner@javiereguiluz@xabbuh

        Issue actions

          Security documentation: The Big Picture is missing · Issue #7532 · symfony/symfony-docs