Shibboleth Developers

[Tom Scavo <>]

Perhaps you will find the attached installation notes useful.  My
sketchy notes are based on a more detailed write-up by Howard Gilbert:

http://tpappsrv.its.yale.edu/tp/shibboleth_eclipse.htm

Hope this helps,
Tom

On 5/11/05, Walter Hoehn 
<>
 wrote:
> Shibboleth Developers 
> <>
> 
> -Walter
> 
> On May 11, 2005, at 7:38 AM, Atif Suleman wrote:
> 
> > Hi
> >
> > Could you direct me to the mailing list for Java Shib Target
> > developers.
> >
> > I have checked out the Java Shib Target souce code and having probelms
> > compling it in Eclipse.
> >
> > Thanks.
> 
>
Shibboleth-Eclipse Installation Notes (2005-05-08)

Install: J2SE 5.0 ==> Tomcat 5.5 ==> Eclipse 3.0 ==> Shibboleth HEAD
Target OS: WinXP Pro

Outline:
1. Install J2SE
   a. test
2. Install Tomcat
   a. create JAVA_HOME environment variable
   b. modify tomcat-users.xml
   c. test
3. SSL-enable Tomcat
   a. create SSL certificate
   b. modify server.xml
   c. test
4. Install Eclipse
   a. create workspace
   b. define TOMCAT_HOME classpath variable
   c. define tomcat.home ant property
5. Install Eclipse plugins
   a. install Sysdeo Tomcat Launcher
   b. install XMLBuddy
6. Install Shibboleth from Eclipse
   a. add CVS repository
   b. checkout Shibboleth source code
   c. checkout Resource Manager source code
   d. specify hostname
   e. build Shibboleth
   f. build Resource Manager
   g. test

Instructions:

1. Download and install J2SE 5.0 Update 3:
   http://java.sun.com/j2se/1.5.0/index.jsp
   
   By default, the installer will create two directories:
   C:\program files\java\jdk1.5.0_03
   C:\program files\java\jre1.5.0_03
   but you can install into any base directory, for instance:
   C:\java\jdk1.5.0_03
   C:\java\jre1.5.0_03
   
   Test:
   C:\> \java\jdk1.5.0_03\bin\java -version
   java version "1.5.0_03"
   
2. Download and install Tomcat 5.5.9 (an implementation of J2EE 1.4):
   http://jakarta.apache.org/tomcat/
   http://jakarta.apache.org/site/downloads/downloads_tomcat-5.cgi
   
   Get file jakarta-tomcat-5.5.9.zip from any apache mirror.
   Expand the ZIP file into any directory (e.g., C:\tomcat-5.5.9):
   C:\tomcat-5.5.9\bin
   C:\tomcat-5.5.9\common
   etc.
   
   Create JAVA_HOME environment variable:
   Control Panel > System > Advanced > Environment Variables > New
   Variable Name:  JAVA_HOME
   Variable Value: C:\java\jdk1.5.0_03
   
   Add the following lines to C:\tomcat-5.5.9\conf\tomcat-users.xml:
   <!-- for the /manager application -->
   <user name="manager" password="tomcat" roles="manager"/>
   <!-- for the /shibboleth application -->
   <user name="gridshib" password="tomcat" roles="user"/>
   <user name="test" password="tomcat" roles="user"/>
   
   Startup tomcat:
   C:\> cd \tomcat-5.5.9\bin
   C:\tomcat-5.5.9\bin> startup
   Using CATALINA_BASE:   C:\tomcat-5.5.9
   Using CATALINA_HOME:   C:\tomcat-5.5.9
   Using CATALINA_TMPDIR: C:\tomcat-5.5.9\temp
   Using JAVA_HOME:       C:\java\jdk1.5.0_03

   Test the tomcat server:
   Browse http://localhost:8080/
   Click on link "Tomcat Manager"
   Login with username "manager"
   
   Shutdown tomcat:
   C:\tomcat-5.5.9\bin> shutdown
   Using CATALINA_BASE:   C:\tomcat-5.5.9
   Using CATALINA_HOME:   C:\tomcat-5.5.9
   Using CATALINA_TMPDIR: C:\tomcat-5.5.9\temp
   Using JAVA_HOME:       C:\java\jdk1.5.0_03

3. SSL-enable Tomcat:
   http://localhost:8080/tomcat-docs/ssl-howto.html
   
   Create SSL certificate:
   C:\> C:\java\jdk1.5.0_03\bin\keytool -genkey -alias tomcat -keyalg RSA 
-validity 365 -dname "cn=shibboleth.example.org, o=example.org, c=US" 
-keystore C:\tomcat-5.5.9\conf\example.jks -storepass exampleorg -keypass 
exampleorg
   
   Backup $CATALINA_HOME/conf/server.xml.
   
   Setup an SSL connector in server.xml:
    <Connector port="8443" maxHttpHeaderSize="8192"
               maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
               enableLookups="false" disableUploadTimeout="true"
               acceptCount="100" scheme="https" secure="true"
               clientAuth="false" sslProtocol="TLS" 
               keystoreFile="conf/example.jks" keystorePass="exampleorg" />
   
   Startup tomcat:
   C:\tomcat-5.5.9\bin> startup
   
   Browse: https://localhost:8443/
   (click "Yes" in the resulting Security Alert)
   
   Shutdown tomcat:
   C:\tomcat-5.5.9\bin> shutdown
   
4. Download and install Eclipse 3.0.2:
   http://www.eclipse.org/downloads/index.php
   
   Get the file eclipse-SDK-3.0.2-win32.zip from any Eclipse mirror.
   Expand the ZIP file into any directory (e.g., C\eclipse-3.0.2):
   C\eclipse-3.0.2\configuration
   C\eclipse-3.0.2\features
   etc.
   
   Test the installation:
   Simply launch the eclipse application.
   
   Create a workspace
   When the "Workspace Launcher" appears, browse to or create a workspace 
directory:
   shib-cvs-head-20050508
   (If you subsequently change the workspace, repeat the configuration steps 
below.)
   
   Define TOMCAT_HOME classpath variable:
   Window > Preferences > Java > Build Path > Classpath Variables > New
     Name: TOMCAT_HOME
     Path: C:\tomcat-5.5.9
   Press OK twice.
   
   Define tomcat.home ant property:
   Window > Preferences > Ant > Runtime > Properties > Add Property
     Name: tomcat.home
     Value: C:\tomcat-5.5.9
   Press OK twice.
   
5. Install Eclipse plugins:
   http://www.eclipseplugincentral.com/

   Download and install Sysdeo Eclipse Tomcat Launcher plugin:
   http://www.sysdeo.com/eclipse/tomcatPlugin.html
   
   Get the file tomcatPluginV3.zip from the Sysdeo site.
   Expand the ZIP file into the Eclipse plugins directory.
   
   Test the installation:
   Launch the eclipse application and note the tomcat icons in the toolbar.
   
   Configure Sysdeo Eclipse Tomcat Launcher:
   Window > Preferences > Tomcat
     Tomcat version: Version 5.x
     Tomcat home: C:\tomcat-5.5.9
     Configuration file: C:\tomcat-5.5.9\conf\server.xml
   Press OK.
   
   Download and install XMLBuddy plugin:
   http://xmlbuddy.com/
   
   Get the file xmlbuddy_2.0.22.zip from the xmlbuddy site.
   Expand the ZIP file into the Eclipse plugins directory.
   
   Test:
   Right-click on an XML document to "Open With XMLBuddy".
   
6. Install and configure Shibboleth (from source)
   http://tpappsrv.its.yale.edu/tp/shibboleth_eclipse.htm

   Check out Shibboleth source from CVS:
   http://anoncvs.internet2.edu/cgi-bin/viewcvs.cgi/?cvsroot=Shibboleth
   
   Add CVS Repository:
   Window > Open Perspective > CVS Repository Exploring
   Right-click in "CVS Repositories" panel
   New > Repository Location
     Host: anoncvs.internet2.edu
     Repository path: /home/cvs/shibboleth
     User: anoncvs
     Password: [blank]
     Connection type: pserver
   Press Finish
    
   Check out Shibboleth source code:
   
:pserver::/home/cvs/shibboleth
 > HEAD > shibboleth > java
   Right-click on "java" folder
   Check Out As > Check out as a project in the workspace
     Project Name: shib
   Press Finish
   
   Check out Resource Manager source code:
   
:pserver::/home/cvs/shibboleth
 > HEAD > shib-filter
   Right-click on "shib-filter" folder
   Check Out As > Check out as a project in the workspace
     Project Name: shib-filter
   Press Finish
   
   Specify hostname:
   C:\Windows\System32\drivers\etc\hosts
   Append line to hosts file (which is a text file):
   127.0.0.1 shibboleth.example.org
   
   Build Shibboleth:
   Window > Open Perspective > Other > Resource
   Right-click on shib > build.xml
   Run > Ant Build...
   Check "dist-IdP-SP" and "distcopy" only
   Target execution order: dist-IdP-Sp, distcopy
   Press Run.
   
   Build Resource Manager:
   Right-click on shib-filter > build.xml
   Run > Ant Build...
   Check "build", "deploy" and "deploy-testapp" only
   Target execution order: build, deploy, deploy-testapp
   Press Run.
   
   Startup tomcat:
   Press the start tomcat button on the toolbar or choose 
   Tomcat > Start Tomcat
   
   Look for the following INFO messages on the console:
   INFO: Deploying web application archive secure.war
   INFO: AuthenticationFilter initialized, instance #1 in Test Secure 
Application
   INFO: Deploying web application archive shibboleth.war
   AuthenticationFilter initialized, instance #2 in Shibboleth
   
   Test:
   http://shibboleth.example.org:8080/secure/test.txt
     Username: gridshib
     Password: tomcat
   Output: /secure/test.txt
   
   Shutdown tomcat:
   Press the stop tomcat button on the toolbar or choose 
   Tomcat > Stop Tomcat