浏览代码

Polish Authentication Docs Structure

Rob Winch 5 年之前
父节点
当前提交
7eb8a3daf5

+ 1 - 0
docs/manual/src/docs/asciidoc/_includes/servlet/authentication/architecture/abstract-authentication-processing-filter.adoc

@@ -1,3 +1,4 @@
+[[servlet-authentication-abstractprocessingfilter]]
 = AbstractAuthenticationProcessingFilter
 = AbstractAuthenticationProcessingFilter
 :figures: images/servlet/authentication/architecture
 :figures: images/servlet/authentication/architecture
 :icondir: images/icons
 :icondir: images/icons

+ 2 - 7
docs/manual/src/docs/asciidoc/_includes/servlet/authentication/architecture/index.adoc

@@ -1,8 +1,3 @@
-[[servlet-authentication-architecture]]
-= Authentication Architecture
-
-This section builds on <<servlet-architecture,Servlet Architecture and Implementation>> by digging deeper into how <<authentication>> works within Servlet based applications.
-
 include::security-context-holder.adoc[leveloffset=+1]
 include::security-context-holder.adoc[leveloffset=+1]
 
 
 include::security-context.adoc[leveloffset=+1]
 include::security-context.adoc[leveloffset=+1]
@@ -11,10 +6,10 @@ include::authentication.adoc[leveloffset=+1]
 
 
 include::granted-authority.adoc[leveloffset=+1]
 include::granted-authority.adoc[leveloffset=+1]
 
 
-include::abstract-authentication-processing-filter.adoc[leveloffset=+1]
-
 include::authentication-entry-point.adoc[leveloffset=+1]
 include::authentication-entry-point.adoc[leveloffset=+1]
 
 
+include::abstract-authentication-processing-filter.adoc[leveloffset=+1]
+
 include::authentication-manager.adoc[leveloffset=+1]
 include::authentication-manager.adoc[leveloffset=+1]
 
 
 // authenticationmanager
 // authenticationmanager

+ 16 - 2
docs/manual/src/docs/asciidoc/_includes/servlet/authentication/index.adoc

@@ -4,10 +4,24 @@
 Spring Security provides comprehensive support for <<authentication>>.
 Spring Security provides comprehensive support for <<authentication>>.
 This section discusses:
 This section discusses:
 
 
-* <<servlet-authentication-unpwd>>
+[[servlet-authentication-architecture]]
+*Architecture Components*
+
+* <<servlet-authentication-securitycontextholder>> - The `SecurityContextHolder` is where Spring Security stores the details of who is <<authentication,authenticated>>.
+* <<servlet-authentication-securitycontext>> - is obtained from the `SecurityContextHolder` and contains the `Authentication` of the currently authenticated user.
+* <<servlet-authentication-authentication>> - Can be the input to `AuthenticationManager` to provide the credentials a user has provided to authenticate or the current user from the `SecurityContext`.
+* <<servlet-authentication-granted-authority>> - An authority that is granted to the principal on the `Authentication` (i.e. roles, scopes, etc.)
+* <<servlet-authentication-authenticationentrypoint>> - used for requesting credentials from a client (i.e. redirecting to a log in page, sending a `WWW-Authenticate` response, etc.)
+* <<servlet-authentication-abstractprocessingfilter>> - a base `Filter` used for authentication
+* <<servlet-authentication-authenticationmanager>> -  the API that defines how Spring Security's Filters perform  <<authentication,authentication>>.
+
+*Authentication Mechanisms*
+
+* <<servlet-authentication-unpwd>> - how to authenticate with a username/password
 // FIXME: Add other mechanisms
 // FIXME: Add other mechanisms
 
 
-include::architecture/index.adoc[leveloffset=+1]
+// We intentionally do not increase leveloffset, this is just for organization vs document structure
+include::architecture/index.adoc[]
 
 
 include::unpwd/index.adoc[leveloffset=+1]
 include::unpwd/index.adoc[leveloffset=+1]