fix typo
[java-idp.git] / build.xml
index 71f691b..496087c 100755 (executable)
--- a/build.xml
+++ b/build.xml
-<project name="Shibboleth Identity Provider" basedir="." default="package">
-       
-       <tstamp>
-               <format property="build-date" pattern="ddMMyyyy'T'kkmmss" timezone="GMT"/>
-       </tstamp>\r
-
-       <!-- User based property file that overrides any property below -->
-       <property file="${user.name}-build.properties"/>
-               
-       <!-- Project based property file -->\r
-    <property file="build.properties" />\r
-\r
-    <!-- Load ant-contrib tasks -->\r
+<project name="Shibboleth Identity Provider" basedir="." default="install">
+
+    <!-- User based property file that overrides any property below -->
+    <property file="${user.name}-build.properties" />
+
+    <!-- Project based property file -->
+    <property file="build.properties" />
+
+    <!-- Installation specific property file -->
+    <property file="install.properties" />
+
+    <!-- Load ant-contrib tasks -->
     <taskdef resource="net/sf/antcontrib/antlib.xml" />
-       
-       <!-- Load Checkstyle tasks -->
-       <taskdef resource="checkstyletask.properties" />\r
-\r
-    <!-- Classpath for building core classes-->\r
-    <path id="build-path">\r
-        <fileset dir="${build-lib.dir}" includes="**/*.jar" />\r
-        <fileset dir="${lib.dir}" includes="**/*.jar" />\r
-    </path>\r
-\r
-    <!-- Classpath for testing classes-->\r
-    <path id="test-path">\r
-        <path refid="build-path" />\r
-        <pathelement location="${core-classes.dir}" />\r
-        <pathelement location="${core-src.dir}" />\r
+
+    <!-- Load Internet2 ant extensions -->
+    <taskdef resource="edu/internet2/middleware/ant/antlib.xml" />
+
+    <!-- Load Checkstyle tasks -->
+    <taskdef resource="checkstyletask.properties" />
+
+    <!-- Classpath for building core classes-->
+    <path id="build-path">
+        <fileset dir="${build-lib.dir}" includes="**/*.jar" />
+        <fileset dir="${lib.dir}" includes="**/*.jar" />
+    </path>
+
+    <!-- Classpath for testing classes-->
+    <path id="test-path">
+        <path refid="build-path" />
+        <pathelement location="${core-classes.dir}" />
+        <pathelement location="${core-src.dir}" />
         <pathelement location="${test-classes.dir}" />
-       <pathelement location="${test-classes.dir}/data" />
-       <pathelement location="${test-classes.dir}/log4j.xml" />\r
-        <pathelement location="${test-src.dir}" />\r
-        <pathelement location="${classpathres.dir}" />\r
-    </path>\r
-\r
-    <!-- Prepare directory structure for build -->\r
-    <target name="build-init">\r
-        <mkdir dir="${build.dir}" />\r
-    </target>\r
-\r
-    <!-- Compile core (non-test) classes -->\r
-    <target name="compile-core" depends="build-init, clean-compile">\r
-        <mkdir dir="${core-classes.dir}" />\r
-\r
-        <javac srcdir="${core-src.dir}" destdir="${core-classes.dir}" includes="**/*.java" debug="on" source="1.5">\r
-            <classpath refid="build-path" />\r
-        </javac>\r
-\r
-    </target>\r
-\r
-    <!-- Compile unit test classes -->\r
-    <target name="compile-test" depends="compile-core">\r
-        <mkdir dir="${test-classes.dir}" />\r
-\r
-        <javac srcdir="${test-src.dir}" destdir="${test-classes.dir}" includes="**/*.java" debug="on" source="1.5">\r
-            <classpath refid="test-path" />\r
-        </javac>\r
-\r
-    </target>\r
-\r
-    <!-- Compile and run unit tests -->\r
-    <target name="test" depends="compile-core, compile-test" description="Runs the unit tests for the project.">\r
-        <mkdir dir="${test-results.dir}" />\r
-\r
-       <echo message="Excuting unit tests using endorsed directory ${java.endorsed.dirs}" />\r
-        <junit printsummary="off" fork="yes" forkmode="once" haltonerror="false" haltonfailure="false" dir="${basedir}" errorproperty="testFailed">\r
-               <jvmarg value="-Djava.endorsed.dirs=${java.endorsed.dirs}" />\r
-            <classpath refid="test-path" />\r
-            <formatter type="xml" />\r
-            <batchtest todir="${test-results.dir}">\r
-                <fileset dir="${test-classes.dir}">\r
-                    <include name="**/*Test.class" />\r
-                </fileset>\r
-            </batchtest>\r
-        </junit>\r
-       <junitreport todir="${test-results.dir}">\r
-         <fileset dir="${test-results.dir}">\r
-           <include name="TEST-*.xml"/>\r
-         </fileset>\r
-         <report format="frames" todir="${test-report.dir}"/>\r
-       </junitreport>
-       
-       <echo message="Test report available at ${test-report.dir}/index.html" />
-       <fail if="testFailed" message="Test failure; see ${test-report.dir}/index.html for more information."/>\r
-    </target>\r
-\r
-    <!-- Javadoc core (non-test) classes -->\r
-    <target name="javadoc" description="Creates the JavaDoc documentatin for the project.">\r
-        <mkdir dir="${javadoc.dir}" />\r
-        <javadoc packagenames="org.opensaml.*" \r
-                    sourcepath="${core-src.dir}" \r
-                    destdir="${javadoc.dir}" \r
-                    author="false" version="true" \r
-                    windowtitle="${ant.project.name} ${version} Java API" \r
-                    doctitle="${ant.project.name} ${version} Java API" \r
-                    bottom="${copyright}"\r
-                    overview="${core-src.dir}/overview.html">\r
-            <classpath refid="build-path" />\r
-        </javadoc>\r
-    </target>\r
-\r
-    <!-- Removes previously compiled files -->\r
-    <target name="clean-compile">\r
-        <delete dir="${build.dir}" />\r
-    </target>\r
-\r
-    <!-- Removes all build generated content -->\r
-    <target name="clean" depends="clean-compile" description="Removes any artifact produced by the build process.">\r
+        <pathelement location="${test-classes.dir}/data" />
+        <pathelement location="${test-classes.dir}/log4j.xml" />
+        <pathelement location="${test-src.dir}" />
+        <pathelement location="${classpathres.dir}" />
+    </path>
+
+    <!-- Prepare directory structure for build -->
+    <target name="build-init">
+        <mkdir dir="${build.dir}" />
+    </target>
+
+    <!-- Compile core (non-test) classes -->
+    <target name="compile-core" depends="build-init, clean-compile">
+        <mkdir dir="${core-prep-source.dir}" />
+        <mkdir dir="${core-classes.dir}" />
+
+        <copy todir="${core-prep-source.dir}" preservelastmodified="true">
+            <fileset dir="${core-src.dir}" />
+            <filterset begintoken="$" endtoken="$">
+                <filter token="IDP_HOME" value="${idp.home}" />
+                <filter token="IDP_VERSION" value="${version}" />
+            </filterset>
+        </copy>
+
+        <javac srcdir="${core-prep-source.dir}"
+               destdir="${core-classes.dir}"
+               includes="**/*.java"
+               debug="on"
+               source="1.5">
+            <classpath refid="build-path" />
+        </javac>
+
+        <delete dir="${core-prep-source.dir}" />
+
+    </target>
+
+    <!-- Compile unit test classes -->
+    <target name="compile-test" depends="compile-core">
+        <mkdir dir="${test-classes.dir}" />
+
+        <javac srcdir="${test-src.dir}" destdir="${test-classes.dir}" includes="**/*.java" debug="on" source="1.5">
+            <classpath refid="test-path" />
+        </javac>
+
+    </target>
+
+    <!-- Compile and run unit tests -->
+    <target name="test" depends="compile-core, compile-test" description="Runs the unit tests for the project.">
+        <mkdir dir="${test-results.dir}" />
+
+        <echo message="Excuting unit tests using endorsed directory ${java.endorsed.dirs}" />
+        <junit printsummary="off"
+               fork="yes"
+               forkmode="once"
+               haltonerror="false"
+               haltonfailure="false"
+               dir="${basedir}"
+               errorproperty="testFailed">
+            <jvmarg value="-Djava.endorsed.dirs=${java.endorsed.dirs}" />
+            <classpath refid="test-path" />
+            <formatter type="xml" />
+            <batchtest todir="${test-results.dir}">
+                <fileset dir="${test-classes.dir}">
+                    <include name="**/*Test.class" />
+                </fileset>
+            </batchtest>
+        </junit>
+        <junitreport todir="${test-results.dir}">
+            <fileset dir="${test-results.dir}">
+                <include name="TEST-*.xml" />
+            </fileset>
+            <report format="frames" todir="${test-report.dir}" />
+        </junitreport>
+
+        <echo message="Test report available at ${test-report.dir}/index.html" />
+        <fail if="testFailed" message="Test failure; see ${test-report.dir}/index.html for more information." />
+    </target>
+
+    <!-- Javadoc core (non-test) classes -->
+    <target name="javadoc" description="Creates the JavaDoc documentatin for the project.">
+        <mkdir dir="${javadoc.dir}" />
+        <javadoc packagenames="org.opensaml.*"
+                 sourcepath="${core-src.dir}"
+                 destdir="${javadoc.dir}"
+                 author="false"
+                 version="true"
+                 windowtitle="${ant.project.name} ${version} Java API"
+                 doctitle="${ant.project.name} ${version} Java API"
+                 bottom="${copyright}"
+                 overview="${core-src.dir}/overview.html">
+            <classpath refid="build-path" />
+        </javadoc>
+    </target>
+
+    <!-- Removes previously compiled files -->
+    <target name="clean-compile">
+        <delete dir="${build.dir}" />
+        <delete dir="${dist.dir}" />
+    </target>
+
+    <!-- Removes all build generated content -->
+    <target name="clean" depends="clean-compile" description="Removes any artifact produced by the build process.">
         <delete dir="${javadoc.dir}" />
-       <delete dir="${reports.dir}" />\r
-        <delete dir="${dist.dir}" />\r
-    </target>\r
-\r
-    <!-- Create JAR file -->\r
-    <target name="package" depends="compile-core, test" description="Creates the project library jar file.">\r
-        <mkdir dir="${dist.dir}" />\r
-\r
-        <if>\r
-            <equals arg1="${jdk.target}" arg2="1.4" />\r
-            <then>\r
-                <java classname="com.rc.retroweaver.Weaver">\r
-                    <arg value="-source" />\r
-                    <arg value="${core-classes.dir}" />\r
-                    <classpath>\r
-                        <fileset dir="${thirdpaty-lib.dir}">\r
-                            <include name="**/*.jar" />\r
-                        </fileset>\r
-                    </classpath>\r
-                </java>\r
-\r
-                <echo message="**************************************************************" />\r
-                <echo message="    Remember, you must include the retroweaver-rt jar" />\r
-                <echo message="    file, located in the thirdparty-lib directory, along with the" />\r
-                <echo message="    ${jar.name} on your" />\r
-                <echo message="    classpath in order to use this with JDK 1.4" />\r
-                <echo message="**************************************************************" />\r
-\r
-            </then>\r
-        </if>\r
-\r
-        <jar destfile="${dist.dir}/${jar.name}" whenempty="fail">\r
-               <fileset dir="${classpathres.dir}" />
-               <fileset dir="${metainf.dir}" />
-               <fileset dir="${webinf.dir}" />
-               <fileset dir="${webpages.dir}" />
-               <zipfileset dir="${core-classes.dir}" prefix="/WEB-INF/classes/" />
-               <zipfileset dir="${lib.dir}" prefix="/WEB-INF/lib/" />\r
-       </jar>\r
-\r
-    </target>\r
-\r
-    <!-- **************************************************************** -->\r
-    <!-- ***                                                          *** -->\r
-    <!-- ***                     Developer Tasks                      *** -->\r
-    <!-- ***                                                          *** -->\r
-    <!-- **************************************************************** -->\r
-       
-       <!-- Checks code against style guidelines -->
-       <target name="checkstyle" description="Developer task: Produces coding standard compliance report.">
-               <mkdir dir="${reports.dir}" />
-               
-               <checkstyle config="${basedir}/checkstyle.xml"
-                                       failOnViolation="false"
-                       classpathref="build-path">
-                       <fileset dir="src" includes="**/*.java" />
-                       <formatter type="plain" toFile="${reports.dir}/checkstyle-report.txt" />
-               </checkstyle>
-       </target>
-       \r
-    <!-- Create TGZ source distribution -->
-    <target name="tgz-src-dist" depends="package, javadoc" description="Developer task: Creates the tar, gzipped source distribution.">
-        <tar tarfile="${dist.dir}/${src-dist.name}.tgz" compression="gzip">
-               <tarfileset dir="${build-lib.dir}" prefix="/build-lib/" />
-               <tarfileset dir="${lib.dir}" prefix="/lib/" />
-               <tarfileset dir="${resources.dir}" prefix="/resources/" />
-               <tarfileset dir="${core-src.dir}" prefix="/src/" />
-               <tarfileset dir="${test-src.dir}" prefix="/test/" />
-               <tarfileset dir="${doc.dir}" prefix="/doc/" />
-               <tarfileset file="${dist.dir}/${jar.name}" prefix="/dist/" />
-               <tarfileset file="${basedir}/*.*" prefix="/" />
-        </tar>
-       <checksum file="${dist.dir}/${src-dist.name}.tgz" />
+        <delete dir="${reports.dir}" />
+        <delete dir="${dist.dir}" />
+    </target>
+
+    <!-- Create JAR file -->
+    <target name="package" depends="compile-core" description="Creates the project library jar file.">
+        <mkdir dir="${dist.dir}" />
+
+        <jar destfile="${dist.dir}/${jar.name}" whenempty="fail">
+            <fileset dir="${classpathres.dir}" />
+            <zipfileset dir="${metainf.dir}" prefix="META-INF/" />
+            <zipfileset dir="${core-classes.dir}" />
+        </jar>
+
     </target>
 
-    <!-- Create TGZ binary distribution -->
-    <target name="tgz-bin-dist" depends="package, javadoc" description="Developer task: Creates the tar, gzipped binary distribution.">
-        <tar tarfile="${dist.dir}/${bin-dist.name}.tgz" compression="gzip">
-               <tarfileset dir="${lib.dir}" prefix="/lib/" />\r
-               <tarfileset dir="${resources.dir}" prefix="/resources/" />
-               <tarfileset dir="${doc.dir}" prefix="/doc/" />
-               <tarfileset file="${dist.dir}/${jar.name}" prefix="/dist/" />
-        </tar>
-       <checksum file="${dist.dir}/${bin-dist.name}.tgz" />
+    <target name="install" description="Installs the identity provider software.">
+        <input message="Is this a new installation? Answering yes will overwrite your current configuration. [yes|no]"
+               addproperty="new.install"
+               defaultvalue="no" />
+
+        <if>
+            <equals arg1="${new.install}" arg2="yes" />
+            <then>
+                <input message="Where should the Shibboleth Identity Provider software be installed? [default: ${idp.home}]"
+                       addproperty="idp.home.input"
+                       defaultvalue="${idp.home}" />
+                <var name="idp.home" value="${idp.home.input}" />
+
+                <input message="What is the hostname of the Shibboleth Identity Provider server? [default: ${idp.hostname}]"
+                       addproperty="idp.hostname.input"
+                       defaultvalue="${idp.hostname}" />
+                <var name="idp.hostname" value="${idp.hostname.input}" />
+                
+                <input message="A keystore is about to be generated for you. Please enter a password that will be used to protect it."
+                       addproperty="idp.keystore.pass" />
+
+                <propertyfile file="install.properties">
+                    <entry key="idp.home" value="${idp.home.input}" />
+                    <entry key="idp.hostname" value="${idp.hostname.input}" />
+                </propertyfile>
+
+                <mkdir dir="${idp.home}" />
+                <mkdir dir="${idp.home}/bin" />
+                <mkdir dir="${idp.home}/conf" />
+                <mkdir dir="${idp.home}/credentials" />
+                <mkdir dir="${idp.home}/lib" />
+                <mkdir dir="${idp.home}/lib/endorsed" />
+                <mkdir dir="${idp.home}/logs" />
+                <mkdir dir="${idp.home}/metadata" />
+                <mkdir dir="${idp.home}/war" />
+
+                <var name="idp.entity.id" value="https://${idp.hostname}/idp/shibboleth" />
+
+                <regexSplit input="${idp.hostname}" regex="^.*\.(.*\..*$)" addproperty="idp.scope" />
+
+                <echo message="Generating signing and encryption key, certificate, and keystore. " />
+                <selfSignedCert hostname="${idp.hostname}"
+                                privateKeyFile="${idp.home}/credentials/idp.key"
+                                certificateFile="${idp.home}/credentials/idp.crt"
+                                keystoreFile="${idp.home}/credentials/idp.jks"
+                                keystorePassword="${idp.keystore.pass}"
+                                uriSubjectAltName="${idp.entity.id}"/>
+
+                <copy todir="${idp.home}/bin" preservelastmodified="true">
+                    <fileset dir="${tools.dir}" />
+                    <filterset begintoken="$" endtoken="$">
+                        <filter token="IDP_HOME" value="${idp.home}" />
+                        <filter token="IDP_VERSION" value="${version}" />
+                    </filterset>
+                </copy>
+                <chmod file="${idp.home}/bin/*.sh" perm="+x" />
+
+                <copy todir="${idp.home}/conf" preservelastmodified="true" overwrite="true">
+                    <fileset dir="${conf.dir}" />
+                    <filterset begintoken="$" endtoken="$">
+                        <filter token="IDP_HOME" value="${idp.home}" />
+                        <filter token="IDP_VERSION" value="${version}" />
+                        <filter token="IDP_ENTITY_ID" value="${idp.entity.id}" />
+                        <filter token="IDP_SCOPE" value="${idp.scope}" />
+                        <filter token="IDP_CERTIFICATE" value="${idp.cert}" />
+                        <filter token="IDP_HOSTNAME" value="${idp.hostname}" />
+                    </filterset>
+                </copy>
+
+                <stringFromFile input="${idp.home}/credentials/idp.crt" addProperty="idp.cert" />
+                <regexSplit input="${idp.cert}"
+                            regex="\A.*-----\s((?:.*\s)*)-----END.*\Z"
+                            addproperty="idp.metadata.cert" />
+                <copy todir="${idp.home}/metadata" preservelastmodified="true" overwrite="true">
+                    <fileset dir="${metadata.dir}" />
+                    <filterset begintoken="$" endtoken="$">
+                        <filter token="IDP_ENTITY_ID" value="${idp.entity.id}" />
+                        <filter token="IDP_SCOPE" value="${idp.scope}" />
+                        <filter token="IDP_CERTIFICATE" value="${idp.metadata.cert}" />
+                        <filter token="IDP_HOSTNAME" value="${idp.hostname}" />
+                    </filterset>
+                </copy>
+            </then>
+        </if>
+
+        <copy todir="${idp.home}/lib" preservelastmodified="true">
+            <fileset dir="${lib.dir}" />
+            <fileset file="${dist.dir}/${jar.name}" />
+            <fileset file="${build-lib.dir}/servlet-2.4.jar" />
+        </copy>
+            
+        <copy todir="${idp.home}/lib/endorsed" preservelastmodified="true" failonerror="false">
+            <fileset dir="endorsed" />
+        </copy>
+
+        <copy todir="${webinf-temp.dir}">
+            <fileset dir="${webinf.dir}" />
+            <filterset begintoken="$" endtoken="$">
+                <filter token="IDP_HOME" value="${idp.home}" />
+                <filter token="IDP_VERSION" value="${version}" />
+            </filterset>
+        </copy>
+
+        <jar destfile="${idp.home}/war/${war.name}" whenempty="fail">
+            <zipfileset dir="${webinf-temp.dir}" prefix="WEB-INF/" />
+            <zipfileset dir="${webpages.dir}" prefix="" />
+            <zipfileset dir="${lib.dir}" prefix="WEB-INF/lib/" />
+            <zipfileset file="${dist.dir}/${jar.name}" prefix="WEB-INF/lib/" />
+        </jar>
     </target>
 
-    <!-- Create ZIP source distribution -->
-    <target name="zip-src-dist" depends="package, javadoc" description="Developer task: Creates the zipped source distribution.">
-        <zip zipfile="${dist.dir}/${src-dist.name}.zip" whenempty="fail">
-               <zipfileset dir="${build-lib.dir}" prefix="build-lib/" />
-               <zipfileset dir="${lib.dir}" prefix="lib/" />\r
-               <zipfileset dir="${resources.dir}" prefix="/resources/" />
-               <zipfileset dir="${core-src.dir}" prefix="src/" />
-               <zipfileset dir="${test-src.dir}" prefix="test/" />
-               <zipfileset dir="${doc.dir}" prefix="doc/" />
-               <zipfileset file="${dist.dir}/${jar.name}" prefix="/dist/" />
-               <zipfileset file="${basedir}/*.*" prefix="" />
-        </zip>
-       <checksum file="${dist.dir}/${src-dist.name}.zip" />
+    <!-- **************************************************************** -->
+    <!-- ***                                                          *** -->
+    <!-- ***                     Developer Tasks                      *** -->
+    <!-- ***                                                          *** -->
+    <!-- **************************************************************** -->
+
+    <!-- Checks code against style guidelines -->
+    <target name="checkstyle" description="Developer task: Produces coding standard compliance report.">
+        <mkdir dir="${reports.dir}" />
+
+        <checkstyle config="${basedir}/checkstyle.xml" failOnViolation="false" classpathref="build-path">
+            <fileset dir="src" includes="**/*.java" />
+            <formatter type="plain" toFile="${reports.dir}/checkstyle-report.txt" />
+        </checkstyle>
     </target>
 
-    <!-- Create ZIP binary distribution -->
-    <target name="zip-bin-dist" depends="package, javadoc"  description="Developer task: Creates the zipped binary distribution.">
-        <zip zipfile="${dist.dir}/${bin-dist.name}.zip" whenempty="fail">
-               <zipfileset dir="${lib.dir}" prefix="lib/" />\r
-               <zipfileset dir="${resources.dir}" prefix="/resources/" />
-               <zipfileset dir="${doc.dir}" prefix="doc/" />
-               <zipfileset file="${dist.dir}/${jar.name}" prefix="/dist/" />
-        </zip>
-       <checksum file="${dist.dir}/${bin-dist.name}.zip" />
-    </target>\r
-\r
-</project>
\ No newline at end of file
+</project>