Skip to content

Latest commit

 

History

History
205 lines (165 loc) · 9.74 KB

README-QUICKSTART.md

File metadata and controls

205 lines (165 loc) · 9.74 KB
Raw

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

README-QUICKSTART for Apache Fortress Rest

  • version 3.0.0

Table of Contents

  • Document Overview
  • SECTION 1. Prerequisites
  • SECTION 2. Configure Tomcat and Deploy Fortress Rest
  • SECTION 3. Load Sample Security Policy
  • SECTION 4. Test
  • SECTION 5. Table with External Config Switches
  • SECTION 6. Sample Config

Document Overview

This document contains instructions to deploy a pre-built Apache Fortress Rest web archive (war) to Tomcat and configure the server for its use.

SECTION 1. Prerequisites

Minimum software requirements:

SECTION 2. Configure Tomcat and Deploy Fortress Rest

Set the java system properties in tomcat with the target ldap server's coordinates.

1. Edit the startup script for Tomcat

2. Set the java opts

a. For OpenLDAP:

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"

3. Verify these settings match your target LDAP server.

4. Download the fortress realm proxy jar into tomcat/lib folder:

wget https://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] is a particular fortress release, e.g. 3.0.0.

5. Download the fortress rest war into tomcat/webapps folder:

wget http://repo.maven.apache.org/maven2/org/apache/directory/fortress/fortress-rest/[version]/fortress-rest-[version].war -P $TOMCAT_HOME/webapps

where TOMCAT_HOME matches your target env. where [version] is a particular fortress release, e.g. 3.0.0.

6. Restart Tomcat.

SECTION 3. Load Sample Security Policy

1. Git the package.

a. from git:

git clone --branch [version]  https://gitbox.apache.org/repos/asf/directory-fortress-enmasse.git
cd directory-fortress-enmasse
mvn clean install

b. or apache fortress downloads

unzip fortress-rest-[version].zip
cd fortress-rest-[version]
mvn clean install

2. From the project folder, run maven install to Apache Fortress RBAC security policy for Rest server:

mvn install -Dload.file=src/main/resources/FortressRestServerPolicy.xml
  • This step creates test user, roles, needed for tests to be successfully run.

3. Optional, load a sample security policy for ARBAC.

mvn install -Dload.file=src/main/resources/FortressRestArbacSamplePolicy.xml

SECTION 4. Test

1. Smoke test a few services:

mvn test -Dtest=EmTest

2. Complete SECTION 7: Alternate testing procedures in Fortress Core README.md

SECTION 5. Table with External Config Switches

Below is the list of Fortress config properties that can be set via Java System Property.

# Name Sample Values
1 fortress.host localhost(default), myhostname, 10.14.74.28
2 fortress.port 389 (default), 636, 1389, 1636
3 fortress.admin.user cn=manager,dc=example,dc=com
4 fortress.admin.pw secret
5 fortress.min.admin.conn 1
6 fortress.max.admin.conn 10
7 fortress.log.user cn=log
8 fortress.log.pw secret
9 fortress.min.log.conn 1
10 fortress.max.log.conn 5
11 fortress.enable.ldap.ssl false(default), true
12 fortress.enable.ldap.starttls false(default), true
13 fortress.enable.ldap.ssl.debug false(default), true
14 fortress.trust.store mytruststore
15 fortress.trust.store.password changeit
16 fortress.trust.store.onclasspath false(default), true
17 fortress.config.realm default
18 fortress.config.root ou=config,dc=example,dc=com
19 fortress.ldap.server.type apacheds, openldap, other
20 fortress.is.arbac02 false(default), true

SECTION 6. Sample Config

Setting Apache Fortress external configurations via Java System properties can be done using the startup scripts for the server instance. For example, the following are valid configurations.

a. Connect to an OpenLDAP over localhost, port 389 (defaults) using unencrypted connections. The runtime has ARBAC02 checks enabled.

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  \
            -Dfortress.ldap.server.type=openldap                \
            -Dfortress.is.arbac02=true"

b. Connect to ApacheDS server over an encrypted connection, the truststore found on the classpath.

JAVA_OPTS=" -Dversion=[version]                                      \
            -Dfortress.host=mydomainname.com                     \
            -Dfortress.port=1636                                 \
            -Dfortress.ldap.server.type=apacheds                 \             
            -Dfortress.admin.user=uid=admin,ou=system            \ 
            -Dfortress.admin.pw=secret                           \ 
            -Dfortress.config.root=ou=Config,dc=example,dc=com   \
            -Dfortress.enable.ldap.ssl=true"                     \
            -Dfortress.trust.store=mystruststore                 \
            -Dfortress.trust.store.password=changeit             \
            -Dfortress.trust.store.onclasspath=true

c. This one OpenLDAP again, use encrypted connections, truststore located on fully qualified path.

JAVA_OPTS=" -Dversion=[version]                                                 \
           -Dfortress.host=mydomainname.com                                \
           -Dfortress.port=636                                             \
           -Dfortress.ldap.server.type=openldap                            \             
           -Dfortress.admin.user=cn=Manager,dc=example,dc=com              \ 
           -Dfortress.admin.pw=secret                                      \ 
           -Dfortress.config.root=ou=Config,dc=example,dc=com              \
           -Dfortress.enable.ldap.ssl=true"                                \
           -Dfortress.trust.store=/fully/qualified/file/name/mystruststore \
           -Dfortress.trust.store.password=changeit                        \
           -Dfortress.trust.store.onclasspath=false

END OF README-QUICKSTART