You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by sm...@apache.org on 2023/06/23 21:28:33 UTC

[directory-fortress-commander] branch jakarta4 updated: cleanup, parameterize version

This is an automated email from the ASF dual-hosted git repository.

smckinney pushed a commit to branch jakarta4
in repository https://gitbox.apache.org/repos/asf/directory-fortress-commander.git


The following commit(s) were added to refs/heads/jakarta4 by this push:
     new 7472bf2  cleanup, parameterize version
7472bf2 is described below

commit 7472bf2f36aaafebf9f97677d099ceb2dc66450e
Author: Shawn McKinney <sm...@symas.com>
AuthorDate: Fri Jun 23 16:28:25 2023 -0500

    cleanup, parameterize version
---
 README-MULTITENANCY.md   |  30 ++++++-------
 README-QUICKSTART.md     |  59 +++++++++++++-------------
 README-SECURITY-MODEL.md |   6 +--
 README.md                | 107 ++++++++++++++++++++++++-----------------------
 pom.xml                  |   8 ----
 5 files changed, 102 insertions(+), 108 deletions(-)

diff --git a/README-MULTITENANCY.md b/README-MULTITENANCY.md
index 9f77419..d97137d 100644
--- a/README-MULTITENANCY.md
+++ b/README-MULTITENANCY.md
@@ -44,17 +44,17 @@ For an overview of how fortress multitenancy works:
 
 Fortress Realm uses the tenant id inside the context.xml file:
 
- ```
- <Context path="/commander" reloadable="true">
-
-    <Realm className="org.apache.directory.fortress.realm.tomcat.Tc7AccessMgrProxy"
-           defaultRoles=""
-           containerType="TomcatContext"
-           realmClasspath=""
-           contextId="HOME"
-           />
- </Context>
- ```
+```xml
+<Context path="/commander" reloadable="true">
+
+   <Realm className="org.apache.directory.fortress.realm.tomcat.Tc7AccessMgrProxy"
+          defaultRoles=""
+          containerType="TomcatContext"
+          realmClasspath=""
+          contextId="HOME"
+          />
+</Context>
+```
 
  The operations for this particular instance will be on behalf of the home contextId.
 
@@ -63,9 +63,9 @@ Fortress Realm uses the tenant id inside the context.xml file:
 
 Fortress Web uses the tenant id inside the fortress.properties file:
 
- ```
- contextId=acme123
- ```
+```
+contextId=acme123
+```
 
  The operations for this instance will be scoped to acme123 tenant.
 
@@ -80,4 +80,4 @@ Why are there are two locations for setting the tenant id, [context.xml](https:/
  Only corporate employees may administer security policies within the customer's web app instances, not the customers themselves.  On the contrary, we may want to allow the customer to administer their own security data in which case we'd set both to acme123.
 
 ___________________________________________________________________________________
-#### END OF README-MULTITENANCY
\ No newline at end of file
+#### END OF README-MULTITENANCY
diff --git a/README-QUICKSTART.md b/README-QUICKSTART.md
index c6df6bb..1cdc5c8 100644
--- a/README-QUICKSTART.md
+++ b/README-QUICKSTART.md
@@ -16,7 +16,7 @@
    under the License.
 
 # README-QUICKSTART for Apache Fortress Web
- * Version 2.0.8
+ * Version 3.0.0
 
 -------------------------------------------------------------------------------
 ## Table of Contents
@@ -36,7 +36,8 @@ This document contains instructions to deploy a pre-built Fortress Web instance
 ## SECTION 1. Prerequisites
 
 Minimum software requirements:
- * Apache Tomcat8++
+ * Java SDK >= 17
+ * Apache Tomcat >= 10
  * Completed either section in Apache Fortress Core Quickstart:
     * *SECTION 3. Apache Fortress Core Integration Test* in [README-QUICKSTART-SLAPD.md](https://github.com/apache/directory-fortress-core/blob/master/README-QUICKSTART-SLAPD.md)
     * *SECTION 4. Apache Fortress Core Integration Test* in [README-QUICKSTART-APACHEDS.md](https://github.com/apache/directory-fortress-core/blob/master/README-QUICKSTART-APACHEDS.md)
@@ -52,30 +53,30 @@ Set the java system properties in tomcat with the target ldap server's coordinat
 
  a. For OpenLDAP:
 
- ```
- JAVA_OPTS="-Dversion=2.0.8 -Dfortress.admin.user=cn=Manager,dc=example,dc=com -Dfortress.admin.pw=secret -Dfortress.config.root=ou=Config,dc=example,dc=com"
- ```
+```
+JAVA_OPTS="-Dversion=[version] -Dfortress.admin.user=cn=Manager,dc=example,dc=com -Dfortress.admin.pw=secret -Dfortress.config.root=ou=Config,dc=example,dc=com"
+```
 
  b. For ApacheDS:
- ```
- JAVA_OPTS="$JAVA_OPTS -Dfortress.admin.user=uid=admin,ou=system -Dfortress.admin.pw=secret -Dfortress.config.root=ou=Config,dc=example,dc=com -Dfortress.port=10389"
- ```
+```
+JAVA_OPTS="$JAVA_OPTS -Dfortress.admin.user=uid=admin,ou=system -Dfortress.admin.pw=secret -Dfortress.config.root=ou=Config,dc=example,dc=com -Dfortress.port=10389"
+```
 
 3. Verify these settings match your target LDAP server.
 
 4. Download the fortress realm proxy jar into tomcat/lib folder:
 
-  ```
-  wget http://repo.maven.apache.org/maven2/org/apache/directory/fortress/fortress-realm-proxy/2.0.8/fortress-realm-proxy-2.0.8.jar -P $TOMCAT_HOME/lib
-  ```
+```
+wget http://repo.maven.apache.org/maven2/org/apache/directory/fortress/fortress-realm-proxy/[version]/fortress-realm-proxy-[version].jar -P $TOMCAT_HOME/lib
+```
 
   where *TOMCAT_HOME* matches your target env.
 
 5. Download the fortress web war into tomcat/webapps folder:
 
-  ```
-  wget http://repo.maven.apache.org/maven2/org/apache/directory/fortress/fortress-web/2.0.8/fortress-web-2.0.8.war -P $TOMCAT_HOME/webapps
-  ```
+```
+wget http://repo.maven.apache.org/maven2/org/apache/directory/fortress/fortress-web/[version]/fortress-web-[version].war -P $TOMCAT_HOME/webapps
+```
 
   where *TOMCAT_HOME* matches your target env.
 
@@ -88,15 +89,15 @@ From the Fortress Core package perform the following steps:
 
 1. Download the fortress web sample security policy from git:
 
- ```
- wget https://github.com/apache/directory-fortress-commander/blob/master/src/main/resources/FortressWebDemoUsers.xml -P ldap/setup
- ```
+```
+wget https://github.com/apache/directory-fortress-commander/blob/master/src/main/resources/FortressWebDemoUsers.xml -P ldap/setup
+```
 
 2. Run maven install with -Dload.file file:
 
- ```
- mvn install -Dload.file=ldap/setup/FortressWebDemoUsers.xml
- ```
+```
+mvn install -Dload.file=ldap/setup/FortressWebDemoUsers.xml
+```
 
  Notes:
   * This step must be completed before tests can be successfully run.
@@ -107,9 +108,9 @@ ________________________________________________________________________________
 
 1. Open browser and test (creds: test/password):
 
- ```
- http://hostname:8080/fortress-web
- ```
+```
+http://hostname:8080/fortress-web
+```
 
  where hostname is host or ip for your machine.
 
@@ -117,15 +118,15 @@ ________________________________________________________________________________
 
 3. Run the Selenium Web driver integration tests with Firefox (default):
 
- ```
- mvn test -Dtest=FortressWebSeleniumITCase
- ```
+```
+mvn test -Dtest=FortressWebSeleniumITCase
+```
 
 4. Run the tests using Chrome:
 
- ```
- mvn test -Dtest=FortressWebSeleniumITCase -Dweb.driver=chrome
- ```
+```
+mvn test -Dtest=FortressWebSeleniumITCase -Dweb.driver=chrome
+```
 
  Note: The Selenium tests require that:
  * Either Firefox or Chrome installed to target machine.
diff --git a/README-SECURITY-MODEL.md b/README-SECURITY-MODEL.md
index 93ab669..006d2a6 100644
--- a/README-SECURITY-MODEL.md
+++ b/README-SECURITY-MODEL.md
@@ -242,9 +242,9 @@ Fortress Web optionally enforces more rigorous checks.
 - By default, ARBAC is disabled in the Apache Fortress Web runtime.
 - To enable, add the following to fortress.properties:
 
- ```
- is.arbac02=true
- ```
+```
+is.arbac02=true
+```
 
 ### ARBAC Rational
 
diff --git a/README.md b/README.md
index 38b0b9d..74b3018 100644
--- a/README.md
+++ b/README.md
@@ -92,75 +92,75 @@ Everything else covered in the steps that follow.  Tested on Debian & Redhat sys
 1. Download the source.
 
  a. from git:
- ```
- git clone --branch 2.0.8 https://gitbox.apache.org/repos/asf/directory-fortress-commander.git/
- cd directory-fortress-commander
- ```
+```
+git clone --branch 2.0.8 https://gitbox.apache.org/repos/asf/directory-fortress-commander.git/
+cd directory-fortress-commander
+```
 
  b. or [apache fortress downloads](https://directory.apache.org/fortress/download/download-sources.html)
 
 2. Build the source.
 
- ```
- mvn clean install
- ```
+```
+mvn clean install
+```
 ___________________________________________________________________________________
 ## SECTION 3. Configure the Apache Fortress Web deployment
 
 #### 1. Copy the fortress.properties example:
 
- ```bash
- cp src/main/resources/fortress.properties.example src/main/resources/fortress.properties
- ```
+```bash
+cp src/main/resources/fortress.properties.example src/main/resources/fortress.properties
+```
 
 #### 2. Edit the file:
 
- ```bash
- vi src/main/resources/fortress.properties
- ```
+```bash
+vi src/main/resources/fortress.properties
+```
 
 #### 3. Choose Apache Directory or OpenLDAP server:
 
  a. Prepare fortress for ApacheDS usage:
 
- ```properties
- # This param tells fortress what type of ldap server in use:
- ldap.server.type=apacheds
+```properties
+# This param tells fortress what type of ldap server in use:
+ldap.server.type=apacheds
 
- # Use value from [Set Hostname Entry]:
- host=localhost
+# Use value from [Set Hostname Entry]:
+host=localhost
 
- # ApacheDS defaults to this:
- port=10389
+# ApacheDS defaults to this:
+port=10389
 
- # These credentials are used for read/write access to all nodes under suffix:
- admin.user=uid=admin,ou=system
- admin.pw=secret
- ```
+# These credentials are used for read/write access to all nodes under suffix:
+admin.user=uid=admin,ou=system
+admin.pw=secret
+```
 
  -- Or --
 
  b. Prepare fortress for OpenLDAP usage:
 
- ```properties
- # This param tells fortress what type of ldap server in use:
- ldap.server.type=openldap
+```properties
+# This param tells fortress what type of ldap server in use:
+ldap.server.type=openldap
 
- # Use value from [Set Hostname Entry]:
- host=localhost
+# Use value from [Set Hostname Entry]:
+host=localhost
 
- # OpenLDAP defaults to this:
- port=389
+# OpenLDAP defaults to this:
+port=389
 
- # These credentials are used for read/write access to all nodes under suffix:
- admin.user=cn=manager,dc=example,dc=com
- admin.pw=secret
+# These credentials are used for read/write access to all nodes under suffix:
+admin.user=cn=manager,dc=example,dc=com
+admin.pw=secret
 
 # Optional, If using audit view pages, enable this service account to the slapd access log database:
 log.admin.user=cn=manager,cn=log
 # For corresponding log user:
 log.admin.pw=secret
- ```
+```
 
 #### 3. Enable other options as needed.  
 
@@ -184,7 +184,7 @@ ________________________________________________________________________________
 
 1. If Tomcat has global security enabled you must add credentials to pom.xml:
 
-```
+```xml
   <plugin>
     <groupId>org.codehaus.mojo</groupId>
     <artifactId>tomcat-maven-plugin</artifactId>
@@ -201,10 +201,11 @@ ________________________________________________________________________________
 2. Load the Apache Fortress Realm Proxy jar to **TOMCAT_HOME**/lib/
 
 ```
-wget http://repo.maven.apache.org/maven2/org/apache/directory/fortress/fortress-realm-proxy/2.0.8/fortress-realm-proxy-2.0.8.jar -P $TOMCAT_HOME/lib
+wget http://repo.maven.apache.org/maven2/org/apache/directory/fortress/fortress-realm-proxy/[version]/fortress-realm-proxy-[version].jar -P $TOMCAT_HOME/lib
 ```
 
   where *TOMCAT_HOME* matches your target env.
+  where [version] matches a particular release of fortress, e.g. 3.0.0.
 
 3. Allow javax.swing in **TOMCAT_home**/bin/setenv.sh
 
@@ -263,7 +264,7 @@ This section describes the properties needed to control fortress web.
 
 1. LDAP Hostname coordinates.  The host name can be specified as a fully qualified domain name or IP address.
 
-```
+```properties
 # Host name and port of LDAP DIT:
 host=localhost
 port=10389
@@ -271,37 +272,37 @@ port=10389
 
 2. LDAP Server type.  Each LDAP server impl has different behavior on operations like password policies and audit.  If using a 3rd type of server that isn't formally supported, leave blank or type is other.
 
-```
+```properties
 # If ApacheDS server:
 ldap.server.type=apacheds
 ```
 
-```
+```properties
 # Else if OpenLDAP server:
 ldap.server.type=openldap
 ```
 
-```
+```properties
 # Else leave blank:
 #ldap.server.type=other
 ```
 
 3.  Set the credentials of service account.  Must have read/write privileges over the Fortress LDAP DIT:
 
-```
+```properties
 # If ApacheDS it will look something like this:
 admin.user=uid=admin,ou=system
 admin.pw=secret
 ```
 
-```
+```properties
 # Else If OpenLDAP it will look something like this:
 admin.user=cn=Manager,dc=example,dc=com
 ```
 
 4. Define the number of LDAP connections to use in the pool  This setting will be proportional to the number of concurrent users but won't be one-to-one.  The number of required ldap connections will be much lower than concurrent users:
 
-```
+```properties
 # This is min/max settings for LDAP connections.  For testing and low-volume instances this will work:
 min.admin.conn=1
 max.admin.conn=10
@@ -309,7 +310,7 @@ max.admin.conn=10
 
 5. Give coordinates to the Config node that contains all of the other Fortress properties.  This will match your LDAP's server's config node per Fortress Core setup.
 
-```
+```properties
 # This node contains fortress properties stored on behalf of connecting LDAP clients:
 config.realm=DEFAULT
 config.root=ou=Config,dc=example,dc=com
@@ -317,7 +318,7 @@ config.root=ou=Config,dc=example,dc=com
 
 6. If using LDAPS.
 
-```
+```properties
 # Used for SSL Connection to LDAP Server:
 enable.ldap.ssl=true
 enable.ldap.ssl.debug=true
@@ -327,14 +328,14 @@ trust.store.password=changeit
 
 7. To use REST instead of LDAP.  Points to fortress-rest instance.
 
-```
+```properties
 # This will override default LDAP manager implementations for the RESTful ones:
 enable.mgr.impl.rest=true
 ```
 
 8. If using REST, provide the credentials of user that has access to fortress-rest.
 
-```
+```properties
 # Optional parameters needed when Fortress client is connecting with the En Masse (rather than LDAP) server:
 http.user=demouser4
 http.pw=gX9JbCTxJW5RiH+otQEX0Ja0RIAoPBQf
@@ -344,33 +345,33 @@ http.port=8080
 
 9. To reenable the nav panel on startup.
 
-```
+```properties
 # The default is 'false':
 enable.nav.panel=true
 ```
 
 10. If using ApacheDS and setting password policies, point to the correction location.
 
-```
+```properties
 # ApacheDS stores its password policies objects here by default:
 apacheds.pwpolicy.root=ou=passwordPolicies,ads-interceptorId=authenticationInterceptor,ou=interceptors,ads-directoryServiceId=default,ou=config
 ```
 
 11. The fortress web runtime will cache user's permissions in their session if set to true.
 
-```
+```properties
 # Used by application security components:
 perms.cached=true
 ```
 
 12. Each instance of a fortress web can be scoped to one and only one tenant.  The default tenant is called HOME.
 
-```
+```properties
 # This is the default tenant or home context
 contextId=HOME
 ```
 
-```
+```properties
 # If you need to scope to a different tenant, supply its ID here:
 contextId=mytenantid
 ```
diff --git a/pom.xml b/pom.xml
index 318cabc..9073633 100644
--- a/pom.xml
+++ b/pom.xml
@@ -110,14 +110,6 @@
       <version>${wicket.version}</version>
     </dependency>
 
-<!--
-    <dependency>
-      <groupId>org.apache.wicket</groupId>
-      <artifactId>wicket-extensions</artifactId>
-      <version>${wicketstuff.version}</version>
-    </dependency>
--->
-
     <dependency>
       <groupId>org.wicketstuff</groupId>
       <artifactId>wicketstuff-inmethod-grid</artifactId>