building guanxi

Mon, May 9, 2005

To get a fully functional Identity Provider (IdP), you need to build the 4 components of Guanxi, in the order:

  • SAMUEL - Contains the SAML functionality as well as XML utilites used by the WAYF
  • Guanxi::Common - Shared utility classes
  • Guanxi::WAYF - The Guanxi WAYF (Where Are You From) component
  • Guanxi::IdP - The Guanxi Identity Provider, which uses all of the above functionality

Building from cvs

The build files will work with minimal modification if you first create a directory, e.g. /usr/local/src/guanxi and execute the following commands from within that directory: cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/guanxi login cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/guanxi co -P guanxi cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/guanxi co -P gx_lib cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/guanxi co -P samuel Let's assume that you've created the directory, so we'll refer to it as [GUANXI_HOME]. You should now have a distribution that looks like: [GUANXI_HOME]/guanxi [GUANXI_HOME]/gx_lib [GUANXI_HOME]/samuel

Building SAMUEL

As most of the other modules require functionality provided by SAMUEL, you must build this first: cd [GUANXI_HOME]/samuel ant This will build SAMUEL in dist/jar/samuel.jar You can also use samel.jar as a standalone SAML 1.1 toolkit

Building Guanxi::Common

You must now build the common functionality for Guanxi: cd [GUANXI_HOME]/guanxi/Common Open build.properties and set the servlet-api-jar property to point to your servlet container's servlet api jar. A default one for Tomcat is provided to let you see what is required. ant This will build Guanxi::Common in dist/jar/guanxi-common.jar

Building Guanxi::WAYF

cd [GUANXI_HOME]/guanxi/WAYF Open build.properties and set the servlet-api-jar property to point to your servlet container's servlet api jar. A default one for Tomcat is provided to let you see what is required. ant This will build Guanxi::WAYF in dist/webapp You can copy the contents of dist/webapp to your servlet container's application directory, such as [TOMCAT_HOME]/webapps/wayf

Building Guanxi::IdP

This is the main Guanxi Identity Provider. cd [GUANXI_HOME]/guanxi/IdP Open build.properties and set the servlet-api-jar property to point to your servlet container's servlet api jar. A default one for Tomcat is provided to let you see what is required. If you're going to retrofit the Guanxi IdP to a Bodington VLE, then you must tell the IdP where to find Bodington's functionality, via the bodington.home property. You should set this to the root of your Bodington installation. A default one for Tomcat is provided to let you see what is required. ant This will build Guanxi::IdP in dist/webapp You can copy the contents of dist/webapp to your servlet container's application directory, such as [TOMCAT_HOME]/webapps/guanxi

How to tell if it's working

If you've built the IdP and copied it to: [SERVLET_CONTAINER_HOME]/webapps/guanxi you can try it out by pointing your browser at: http://your.site.com/guanxi/SSO You should see a login page.

Module Dependencies

SAMUEL saaj.jar xmlsec.jar

Guanxi::Common servlet-api.jar

Guanxi::WAYF guanxi-common.jar samuel.jar

Guanxi::IdP guanxi-common.jar samuel.jar ldap.jar saaj.jar xmlsec.jar bcprov-jdk14-128.jar

comments powered by Disqus