<!-- Main build configutaion for Shibboleth java components - Walter Hoehn 06/04/2002 -->
-<project name="Shibboleth" default="dist-origin" basedir=".">
+<project name="Shibboleth" default="install" basedir=".">
<!-- Set global properties for this build -->
- <property name="distname" value="shibboleth" />
+ <property name="distnameWayf" value="shibboleth-wayf" />
<property name="root" value="." />
<property name="src" value="${root}/src/" />
<property name="tests" value="${root}/tests/" />
<property name="buildlibs" value="${root}/lib/" />
<property name="endorsed" value="${root}/endorsed/" />
<property name="distlibs" value="${root}/lib/" />
+ <property name="custom" value="${root}/custom/" />
<property name="dist" value="${root}/dist/" />
<property name="docs" value="${root}/doc/" />
<property name="javadocs" value="${docs}/api/" />
- <property name="year" value="2002"/>
+ <property name="year" value="2002-2005"/>
<property name="copyright" value="Copyright © ${year} UCAID. All Rights Reserved."/>
- <!-- Configure properties to find Tomcat and access the Manager application -->
- <property name="tomcat.home" value="/usr/local/tomcat"/>
- <property name="url" value="http://localhost:8080/manager"/>
- <property name="username" value="manager"/>
- <property name="password" value="password"/>
-
- <!-- Uncomment this for Tomcat Tasks
- <path id="tomcat.classpath">
- <fileset dir="${tomcat.home}/server/lib" includes="catalina-ant.jar"/>
- </path>
-
- <taskdef name="tomcatStart" classname="org.apache.catalina.ant.StartTask" classpathref="tomcat.classpath"/>
- <taskdef name="tomcatStop" classname="org.apache.catalina.ant.StopTask" classpathref="tomcat.classpath"/>
- <taskdef name="tomcatDeploy" classname="org.apache.catalina.ant.DeployTask" classpathref="tomcat.classpath"/>
- <taskdef name="tomcatUndeploy" classname="org.apache.catalina.ant.UndeployTask" classpathref="tomcat.classpath"/>
- -->
-
+
+ <!-- antcontrib tasks -->
+ <taskdef resource="net/sf/antcontrib/antcontrib.properties" classpath="${buildlibs}/ant-contrib.jar"/>
+
+
<!-- Construct the CLASSPATH -->
<path id="build.path">
<pathelement path="${classpath}" />
<pathelement location="${build}" />
+ <fileset dir="${custom}">
+ <include name="**/*.jar" />
+ </fileset>
+ <fileset dir="${endorsed}">
+ <include name="**/*.jar" />
+ </fileset>
<fileset dir="${libdir}">
<include name="**/*.jar" />
</fileset>
<!-- Prepare directory structure for project build-->
<target name="init">
- <mkdir dir="${build}" />
- <mkdir dir="${dist}" />
+ <mkdir dir="${build}" />
+ <mkdir dir="${dist}" />
+
+ <if>
+ <not> <available file="build.properties" /> </not>
+ <then>
+ <copy file="conf/default.build.properties" tofile="build.properties" />
+ </then>
+ </if>
+
+ <property file="build.properties" />
</target>
<!-- Compile classes and move them to ${build} -->
- <target name="compile" depends="init">
- <javac srcdir="${src}" destdir="${build}" includes="**/*.java" debug="on">
+ <target name="compile" depends="init"
+ description="Compile source files">
+ <!-- Compile the shib code into the build path -->
+ <javac srcdir="${src}" destdir="${build}" includes="**/*.java" debug="on" source="1.4">
<classpath refid="build.path" />
</javac>
+ <!-- Compile site-specific code into the build path -->
+ <javac srcdir="${custom}" destdir="${build}" includes="**/*.java" debug="on" source="1.4">
+ <classpath refid="build.path" />
+ </javac>
+ <!-- Copy xml schemas to the build path -->
<copy todir="${build}/schemas">
<fileset dir="${src}/schemas"/>
</copy>
- <copy todir="${build}/conf">
- <fileset dir="${src}/conf"/>
+ <!-- Copy any site-specific jars to the build path -->
+ <copy todir="${libdir}">
+ <fileset dir="${custom}" includes="**/*.jar" />
</copy>
</target>
-
- <target name="compile-tests" depends="compile">
- <javac srcdir="${tests}" destdir="${build}" includes="**/*.java" debug="on">
- <classpath refid="build.path" />
- </javac>
- </target>
<!-- Generate API docs -->
</javadoc>
</target>
- <!-- Create various product distributions and move them to ${dist} -->
-
- <target name="dist-all" depends="compile, test-all, package-all, clean-build" />
- <target name="package-all">
- <war warfile="${dist}/${distname}.war" webxml="${configroot}/all.xml" basedir="${approot}" update="no" />
- </target>
-
- <target name="dist-origin" depends="compile, test-origin, package-origin, clean-build" />
- <target name="package-origin">
- <war warfile="${dist}/${distname}.war" webxml="${configroot}/origin.xml" basedir="${approot}" update="no" />
- </target>
-
- <!-- Ant target used to test the Java Service Provider.
- *** You may not agree with these decisions.
- Tomcat must be stopped during the build.
- Compile everything, deploy the WAR, and delete the old directory
- so the WAR gets expanded when Tomcat restarts.
- Ant and Eclipse should agree on the Build directory, and the
- class files should remain in place after deployment.
- -->
- <target name="dist-target" depends="compile, package-target">
- <copy file="${dist}/${distname}.war" tofile="${tomcat.home}/webapps/${distname}.war" />
- <delete dir="${tomcat.home}/webapps/${distname}" quiet="yes" />
- </target>
-
- <target name="package-target">
- <war warfile="${dist}/${distname}.war" webxml="${configroot}/target.xml" basedir="${approot}" update="no" />
- </target>
- <target name="dist-wayf" depends="compile, package-wayf, clean-build" />
- <target name="package-wayf">
- <war warfile="${dist}/${distname}-wayf.war" webxml="${configroot}/wayf.xml" basedir="${approot}" update="no" />
- </target>
- <!-- Build utilities -->
+ <!-- Build command-line utilities -->
<target name="build-util" depends="compile">
<jar jarfile="${distlibs}/shib-util.jar" basedir="${build}" />
</target>
-
<!-- Cleanup after the build, test, and distribution processes -->
<target name="clean" depends="clean-all" />
<target name="clean-all" depends="clean-build, clean-dist, clean-test, clean-javadocs, clean-util" />
</fileset>
</delete>
</target>
+ <!-- For IDE development, run this target first to delete all
+ directories generated by the install process before
+ recreating and reinstalling everything. -->
+ <target name="clean-install" depends="init"
+ description="Delete old configuration and Tomcat webapp directories.">
+ <delete dir="${shib.home}" />
+ <delete dir="${shibsp.home}" />
+ <delete dir="${tomcat.home}/webapps/${shib.webapp.name}" />
+ <delete dir="${tomcat.home}/webapps/${shibsp.webapp.name}" />
+ </target>
+
+
+ <!-- Add to the classpath for unit tests -->
+ <path id="test.path">
+ <path refid="build.path"/>
+ <pathelement location="${tests}"/>
+ </path>
+
+ <!-- Compile classes needed for unit testing -->
+ <target name="compile-tests" depends="compile">
+ <javac srcdir="${tests}" destdir="${build}" includes="**/*.java" debug="on" source="1.4">
+ <classpath refid="build.path" />
+ </javac>
+ </target>
<!-- Run automated tests on compiled code -->
- <target name="test-all" depends="test-origin" />
- <target name="test-origin" depends="compile-tests">
+ <target name="test-all" depends="test-IdP, test-SP" />
+
+ <target name="test-IdP" depends="compile-tests">
<junit printsummary="no" fork="yes" haltonfailure="yes" haltonerror="yes" dir="${root}">
<jvmarg value="-Djava.endorsed.dirs=${endorsed}" />
- <classpath refid="build.path" />
+ <classpath refid="test.path" />
<formatter type="plain" />
<test name="edu.internet2.middleware.shibboleth.aa.arp.ArpTests" />
<test name="edu.internet2.middleware.shibboleth.aa.attrresolv.ResolverTests" />
+ <test name="edu.internet2.middleware.shibboleth.common.CredentialsTests" />
+ <test name="edu.internet2.middleware.shibboleth.common.provider.NameMapperTests" />
+ <test name="edu.internet2.middleware.shibboleth.common.TrustTests" />
+ <test name="edu.internet2.middleware.shibboleth.idp.provider.DNHostNameExtractionTests" />
+ <test name="edu.internet2.middleware.shibboleth.metadata.MetadataTests" />
</junit>
</target>
-
+
+ <target name="test-SP" depends="compile-tests">
+ <junit printsummary="no" fork="yes" haltonfailure="yes" haltonerror="yes" dir="${root}">
+ <jvmarg value="-Djava.endorsed.dirs=${endorsed}" />
+ <classpath refid="test.path" />
+ <formatter type="plain" />
+ <test name="edu.internet2.middleware.shibboleth.aap.AAPTests" />
+ </junit>
+ </target>
+
+
<!-- Tomcat Management -->
- <target name="start" description="Start a deployed webapp using Tomcat manager">
- <tomcatStop url="${url}" username="${username}" password="${password}" path="/${distname}"/>
+ <target name="setupTomcatTasks">
+ <path id="tomcat.classpath">
+ <fileset dir="${tomcat.home}/server/lib" includes="catalina-ant.jar"/>
+ </path>
+
+ <taskdef name="tomcatStart" classname="org.apache.catalina.ant.StartTask" classpathref="tomcat.classpath"/>
+ <taskdef name="tomcatStop" classname="org.apache.catalina.ant.StopTask" classpathref="tomcat.classpath"/>
+ <taskdef name="tomcatDeploy" classname="org.apache.catalina.ant.DeployTask" classpathref="tomcat.classpath"/>
+ <taskdef name="tomcatUndeploy" classname="org.apache.catalina.ant.UndeployTask" classpathref="tomcat.classpath"/>
+ </target>
+
+ <target name="tomcat.start" depends="setupTomcatTasks" description="Start a deployed webapp using Tomcat manager">
+ <tomcatStart url="${tomcat.url}" username="${tomcat.username}" password="${tomcat.password}" path="/${shib.webapp.name}"/>
</target>
- <target name="stop" description="Stop a deployed webapp using Tomcat manager">
- <tomcatStop url="${url}" username="${username}" password="${password}" path="/${distname}"/>
+ <target name="tomcat.stop" depends="setupTomcatTasks" description="Stop a deployed webapp using Tomcat manager">
+ <tomcatStop url="${tomcat.url}" username="${tomcat.username}" password="${tomcat.password}" path="/${shib.webapp.name}"/>
</target>
- <target name="deploy" description="Upload and deploy using Tomcat manager">
- <tomcatDeploy url="${url}" username="${username}" password="${password}" path="/${distname}"
- war="file:${basedir}/${dist}/${distname}.war"/>
+ <target name="tomcat.deploy" depends="setupTomcatTasks" description="Upload and deploy using Tomcat manager">
+ <tomcatDeploy url="${tomcat.url}" username="${tomcat.username}" password="${tomcat.password}" path="/${shib.webapp.name}"
+ war="file:${basedir}/${dist}/${shib.webapp.name}.war"/>
</target>
- <target name="undeploy" description="Undeploy using Tomcat manager">
- <tomcatUndeploy url="${url}" username="${username}" password="${password}" path="/${distname}"/>
+ <target name="tomcat.undeploy" depends="setupTomcatTasks" description="Undeploy using Tomcat manager">
+ <tomcatUndeploy url="${tomcat.url}" username="${tomcat.username}" password="${tomcat.password}" path="/${shib.webapp.name}"/>
</target>
+
- <!-- Automated key generation -->
+ <!-- Automated key generation for crypto handles -->
<target name="genSecret" depends="compile">
<taskdef name="genSecret" classname="edu.internet2.middleware.shibboleth.utils.HandleRepositorySecretGenerator" classpathref="build.path"/>
<genSecret keyStorePath="${appconfig}/handle.jks" keyStorePassword="shibhs" keyStoreKeyAlias="handleKey" keyStoreKeyPassword="shibhs" />
</target>
+
+ <!-- Generate salt for use with targetted id -->
<target name="genSalt" depends="compile">
<taskdef name="genSalt" classname="edu.internet2.middleware.shibboleth.utils.HandleRepositorySecretGenerator" classpathref="build.path"/>
<genSalt keyStorePath="${appconfig}/persistent.jks" keyStorePassword="shibhs" keyStoreKeyAlias="handleKey" keyStoreKeyPassword="shibhs" />
</target>
+
+ <target name="exampleCertificates">
+ <!--
+ This target provides an example of the generation of
+ self-signed Certificates for the IdP and SP. You may
+ change the cn= and use it to generate new identities
+ when you want to replace "example.org" with your real
+ organization dns. However,the generated key and
+ certificate also have to be defined to the Credentials
+ of the IdP and SP config files and added to the Metadata.
+ -->
+ <genkey alias="tomcat" storepass="exampleorg"
+ keystore="${tomcat.home}/conf/idp-example.jks"
+ keyalg="RSA" validity="365"
+ dname="cn=idp.example.org, o=example.org, c=US"
+ />
+ <genkey alias="tomcat" storepass="exampleorg"
+ keystore="${tomcat.home}/conf/sp-example.jks"
+ keyalg="RSA" validity="365"
+ dname="cn=sp.example.org, o=example.org, c=US"
+ />
+ </target>
+
+
+ <!-- Install Shibboleth -->
+ <target name="install.init">
+ <taskdef name="xinput" classname="edu.internet2.middleware.shibboleth.utils.ant.XInput" classpath="${build}" />
+ <typedef name="xoption" classname="edu.internet2.middleware.shibboleth.utils.ant.XInputOption" classpath="${build}" />
+ </target>
+
+ <target name="install.url">
+ <taskdef name="urlconvert" classname="edu.internet2.middleware.shibboleth.utils.ant.URLConvert" classpath="${build}"/>
+ <urlconvert path="${shib.home}" addProperty="shib.home.url"/>
+ <urlconvert path="${shibsp.home}" addProperty="shibsp.home.url"/>
+ </target>
+
+ <target name="install" depends="init, install.init" description="Install Shibboleth">
+ <if>
+ <xinput type="confirm" defaultvalue="y">Do you want to install the Shibboleth Identity Provider?</xinput>
+ <then>
+ <input message="What name do you want to use for the Identity Provider web application? [default: ${shib.webapp.name}]"
+ addproperty="shib.webapp.name.input" defaultValue="${shib.webapp.name}" />
+ <var name="shib.webapp.name" value="${shib.webapp.name.input}" />
+
+ <antcall target="install.idp" />
+ </then>
+ </if>
+ </target>
+
+ <target name="install.idp" depends="init, install.init">
+ <xinput message="Deploying the java web application. Do you want to install it directly onto the filesystem or use the tomcat manager application?"
+ addproperty="idp.install-type.input" type="menu" casesensitive="no" defaultValue="${idp.install-type}">
+ <xoption value="filesystem.prompt">filesystem</xoption>
+ <xoption>manager</xoption>
+ </xinput>
+ <var name="idp.install-type" value="${idp.install-type.input}" />
+
+ <antcall target="install.idp.${idp.install-type}" />
+ </target>
+
+ <!-- Prompt user for filesystem installation options and save them to build.properties -->
+ <target name="install.idp.filesystem.prompt" depends="init, install.init">
+ <input message="Select an installation base for the Shibboleth Identity Provider [default: ${shib.home}]"
+ addproperty="shib.home.input" defaultvalue="${shib.home}" />
+ <var name="shib.home" value="${shib.home.input}" />
+ <input message="Enter tomcat home directory [default: ${tomcat.home}]"
+ addproperty="tomcat.home.input" defaultvalue="${tomcat.home}" />
+ <var name="tomcat.home" value="${tomcat.home.input}" />
+
+ <if>
+ <available file="${shib.home}/etc" />
+ <then>
+ <xinput type="confirm" addproperty="copy-idp-conf">WARNING!! The directory `${shib.home}/etc` already exists. Do you want to overwrite the existing configuration?</xinput>
+ </then>
+ <else>
+ <property name="copy-idp-conf" value="y" />
+ </else>
+ </if>
+
+ <antcall target="install.idp.filesystem" />
+ <antcall target="savePropertyFile" />
+ </target>
+
+ <!-- Install Shibboleth IdP to filesystem using the properties in build.properties -->
+ <target name="install.idp.filesystem" depends="init, install.init, build-util, install.url"
+ description="Install Shibboleth IdP to filesystem using the properties in build.properties">
+
+ <!-- copy values to deployment descriptor and create war -->
+ <copy file="${configroot}/dist.idp.xml" tofile="${configroot}/idp.xml" overwrite="true" />
+ <replace file="${configroot}/idp.xml" token="$SHIB_HOME$" value="${shib.home.url}" />
+ <war warfile="${dist}/${shib.webapp.name}.war" webxml="${configroot}/idp.xml" basedir="${approot}" update="no" />
+ <delete file="${configroot}/idp.xml"/>
+ <copy file="${dist}/${shib.webapp.name}.war" tofile="${tomcat.home}/webapps/${shib.webapp.name}.war" />
+
+ <!-- copy IdP jars and utilities -->
+ <copy todir="${shib.home}/lib">
+ <fileset dir="lib" includesfile="conf/idp-lib.include" />
+ </copy>
+
+ <copy todir="${shib.home}/bin">
+ <fileset dir="bin"/>
+ </copy>
+ <chmod dir="${shib.home}/bin" perm="ug+rx" includes="**/*"/>
+
+ <mkdir dir="${shib.home}/logs" />
+
+ <!-- copy IdP configuration -->
+ <if>
+ <or>
+ <equals arg1="${copy-idp-conf}" arg2="y" />
+ <not> <available file="${shib.home}/etc" /> </not>
+ </or>
+ <then>
+ <delete dir="${shib.home}/etc" />
+ <antcall target="install.idp.filesystem.config" />
+ </then>
+ </if>
+ </target>
+
+ <!-- Install Shibboleth SP to filesystem using the properties in build.properties -->
+ <target name="install.sp.filesystem" depends="init, install.init, build-util, install.url"
+ description="Install Shibboleth SP to filesystem using the properties in build.properties">
+
+ <!-- copy values to deployment descriptor and create war -->
+ <copy file="${configroot}/dist.sp.xml" tofile="${configroot}/sp.xml" overwrite="true" />
+ <replace file="${configroot}/sp.xml" token="$SHIB_HOME$" value="${shibsp.home.url}" />
+ <war warfile="${dist}/${shibsp.webapp.name}.war" webxml="${configroot}/sp.xml" basedir="${approot}" update="no" />
+ <delete file="${configroot}/sp.xml"/>
+ <copy file="${dist}/${shibsp.webapp.name}.war" tofile="${tomcat.home}/webapps/${shibsp.webapp.name}.war" />
+
+ <!-- copy sp jars and utilities -->
+ <copy todir="${shibsp.home}/lib">
+ <fileset dir="lib" includesfile="conf/idp-lib.include" />
+ </copy>
+
+ <copy todir="${shibsp.home}/bin">
+ <fileset dir="bin"/>
+ </copy>
+ <chmod dir="${shibsp.home}/bin" perm="ug+rx" includes="**/*"/>
+
+ <mkdir dir="${shibsp.home}/logs" />
+
+ <!-- copy sp configuration -->
+ <if>
+ <or>
+ <equals arg1="${copy-sp-conf}" arg2="y" />
+ <not> <available file="${shibsp.home}/etc" /> </not>
+ </or>
+ <then>
+ <delete dir="${shibsp.home}/etc" />
+ <antcall target="install.sp.filesystem.config" />
+ </then>
+ </if>
+ </target>
+
+
+ <!-- copy shibboleth configuration to $SHIB_HOME/etc, overwriting any existing configuration -->
+ <target name="install.idp.filesystem.config" depends="init, install.init, install.url">
+ <mkdir dir="${shib.home}/etc" />
+ <copy todir="${shib.home}/etc" overwrite="true">
+ <fileset dir="${src}/conf" includesfile="conf/idp-conf.include"/>
+ </copy>
+ <move file="${shib.home}/etc/dist.idp.xml" tofile="${shib.home}/etc/idp.xml" overwrite="true" />
+ <replace file="${shib.home}/etc/idp.xml" token="$SHIB_HOME$" value="${shib.home.url}" />
+ </target>
+
+ <!-- copy SP configuration to $SHIB_HOME$/etc, overwriting any existing configuration -->
+ <target name="install.sp.filesystem.config" depends="init, install.init">
+ <mkdir dir="${shibsp.home}/etc" />
+ <copy todir="${shibsp.home}/etc" overwrite="true">
+ <fileset dir="${src}/conf" includesfile="conf/sp-conf.include"/>
+ </copy>
+ <move file="${shibsp.home}/etc/dist.sp.xml" tofile="${shibsp.home}/etc/sp.xml" overwrite="true" />
+ <replace file="${shibsp.home}/etc/sp.xml" token="$SHIB_HOME$" value="${shibsp.home.url}" />
+ </target>
+
+ <!-- install Shibboleth-IdP war using tomcat's manager app -->
+ <target name="install.idp.manager" depends="init, install.init">
+ <antcall target="setupTomcatTasks" />
+
+ <input message="Enter local tomcat directory [default: ${tomcat.home}]" addproperty="tomcat.home.input" defaultValue="${tomcat.home}" />
+ <var name="tomcat.home" value="${tomcat.home.input}" />
+
+ <input message="Enter tomcat url [default: ${tomcat.url}]" addproperty="tomcat.url.input" defaultValue="${tomcat.url}" />
+ <var name="tomcat.url" value="${tomcat.url.input}" />
+
+ <input message="Enter tomcat username [default: ${tomcat.username}]" addproperty="tomcat.username.input" defaultValue="${tomcat.username}" />
+ <var name="tomcat.username" value="${tomcat.username.input}" />
+
+ <input message="Enter tomcat password [default: ${tomcat.password}]" addproperty="tomcat.password.input" defaultValue="${tomcat.password}" />
+ <var name="tomcat.password" value="${tomcat.password.input}" />
+
+ <antcall target="tomcat.deploy" />
+ <antcall target="savePropertyFile" />
+ </target>
+
+ <!-- save configuration to build.properties -->
+ <target name="savePropertyFile">
+ <propertyfile file="build.properties">
+ <entry key="shib.home" value="${shib.home}" />
+ <entry key="shibsp.home" value="${shibsp.home}" />
+ <entry key="shib.webapp.name" value="${shib.webapp.name}" />
+ <entry key="shibsp.webapp.name" value="${shibsp.webapp.name}" />
+ <entry key="idp.install-type" value="${idp.install-type}" />
+ <entry key="tomcat.home" value="${tomcat.home}" />
+ <entry key="tomcat.url" value="${tomcat.url}" />
+ <entry key="tomcat.username" value="${tomcat.username}" />
+ <entry key="tomcat.password" value="${tomcat.password}" />
+ </propertyfile>
+ </target>
+
+ <!-- Create WAYF and move it to ${dist} -->
+ <target name="package-wayf" depends="compile">
+ <war warfile="${dist}/${distnameWayf}.war" webxml="${configroot}/wayf.xml" basedir="${approot}" update="no" />
+ </target>
+
</project>