From b858b23927d976c8e91f5c1855d1d17b0e66b10e Mon Sep 17 00:00:00 2001 From: Luke Taylor Date: Fri, 7 Jan 2011 19:23:06 +0000 Subject: [PATCH] SEC-1651: Added first draft of dependencies appendix to reference manual. --- .../src/docbook/appendix-dependencies.xml | 289 ++++++++++++++++++ docs/manual/src/docbook/springsecurity.xml | 1 + 2 files changed, 290 insertions(+) create mode 100644 docs/manual/src/docbook/appendix-dependencies.xml diff --git a/docs/manual/src/docbook/appendix-dependencies.xml b/docs/manual/src/docbook/appendix-dependencies.xml new file mode 100644 index 0000000000..abef463f25 --- /dev/null +++ b/docs/manual/src/docbook/appendix-dependencies.xml @@ -0,0 +1,289 @@ + + + + + Spring Security Dependencies + + + This appendix provides a reference of the modules in Spring Security and the additional + dependencies that they require in order to function in a running application. We don't include + dependenices that are only used when building or testing Spring Security itself. Nor do we include + transitive dependencies which are required by external dependencies. + + The version of Spring required is listed on the project website, so the specific versions are omitted + for Spring dependencies below. Note that some of the dependencies listed as optional + below may still be required for other non-security functionality in a Spring application. + + Where a module depends on another Spring Security module, the non-optional dependencies of the + module it depends on are also assumed to be required and are not listed separately. + +
+ <literal>spring-security-core</literal> + The core module must be included in any project using Spring Security. + + Core Depenendencies + + + + + + + Dependency + Version + Description + + + + + aopalliance + 1.0 + Required for method security implementation. + + + ehcache + 1.6.2 + Required if the ehcache-based user cache implementation is used (optional). + + + spring-aop + + Method security is based on Spring AOP + + + spring-beans + + Required for Spring configuration + + + spring-expression + + Required for expression-based method security + + + spring-jdbc + + Required if using a database to store user data (optional). + + + spring-tx + + Required if using a database to store user data (optional). + + + spring-web + + Required for clients which use HTTP remoting support (optional). + + + aspectjrt + 1.6.10 + Required if using AspectJ support (optional). + + + jsr250-api + 1.0 + Required if you are using JSR-250 method-security annotations (optional). + + + +
+ + +
+ +
+ <literal>spring-security-web</literal> + This module is typically required in web applications which use the Servlet API. + + Web Dependencies + + + + + + + Dependency + Version + Description + + + + + spring-security-core + + + + + spring-web + + Spring web support classes are used extensively. + + + spring-jdbc + + Required for JDBC-based persistent remember-me token repository (optional). + + + spring-tx + + Required by remember-me persistent token repository implementations (optional). + + + +
+ +
+ +
+ <literal>spring-security-ldap</literal> + This module is only required if you are using LDAP authentication. + + LDAP Dependencies + + + + + + + Dependency + Version + Description + + + + + spring-security-core + + + + + spring-ldap-core + 1.3.0 + LDAP support is based on Spring LDAP. + + + spring-tx + + Data exception classes are required. + + + apache-ds The modules apacheds-core, + apacheds-core-entry, apacheds-protocol-shared, + apacheds-protocol-ldap and apacheds-server-jndi are required. + + 1.5.5 + Required if you are using an embedded LDAP server (optional). + + + shared-ldap + 0.9.15 + Required if you are using an embedded LDAP server (optional). + + + ldapsdk + 4.1 + + Mozilla LdapSDK. Used for decoding LDAP password policy controls if you are + using password-policy functionality with OpenLDAP, for example. + + + + + +
+ +
+ +
+ <literal>spring-security-config</literal> + This module is required if you are using Spring Security namespace configuration. + + Config Dependencies + + + + + + + Dependency + Version + Description + + + + + spring-security-core + + + + + spring-security-web + + Required if you are using any web-related namespace configuration (optional). + + + spring-security-ldap + + Required if you are using the LDAP namespace options (optional). + + + spring-security-openid + + Required if you are using OpenID authentication (optional). + + + aspectjweaver + 1.6.10 + Required if using the protect-pointcut namespace syntax (optional). + + + +
+ +
+ +
+ <literal>spring-security-acl</literal> + The ACL module. + + ACL Dependencies + + + + + + + Dependency + Version + Description + + + + + spring-security-core + + + + + ehcache + 1.6.2 + Required if the ehcache-based ACL cache implementation is used (optional if you are using your own implementation). + + + spring-jdbc + + Required if you are using the default JDBC-based AclService (optional if you implement your own). + + + spring-tx + + Required if you are using the default JDBC-based AclService (optional if you implement your own). + + + +
+ +
+ + \ No newline at end of file diff --git a/docs/manual/src/docbook/springsecurity.xml b/docs/manual/src/docbook/springsecurity.xml index aded484602..d6ef831d70 100644 --- a/docs/manual/src/docbook/springsecurity.xml +++ b/docs/manual/src/docbook/springsecurity.xml @@ -170,4 +170,5 @@ +