Access Keys:
Skip to content (Access Key - 0)

CDS

Credential Delegation Service (CDS) Installation Guide

[ CDS: Administrators Guide | Design | Developers Guide | Users Guide | caGrid: Documentation Guides ]

Contents

Overview

This guide provides step by step details on how to install and configure the Credential Delegation Service version 1.4.

Prerequisites

In order to install and run the Credential Delegation Service (CDS), the following prerequisite software must be installed:

  1. Java 6 SDK
  2. Mysql 5 or Greater

Step 1: Install caGrid/CDS

In this step you will download and install the CDS using the caGrid Installer.  If you already have caGrid 1.4 installed on your machine you may proceed to the next step.  To install caGrid/CDS, complete the following steps:

Installer Prerequisites

The caGrid Installer installs all prerequisites except for Java and MySQL.

  • Java 6 JDK
    • Make sure the JAVA_HOME environment variable is set and points to the location where the JDK has been installed.
  • (Optional) If you are deploying caGrid core services locally, you may also need a MySQL database.
    Note
    MySQL is only required for the security services and GME. You can use 4.x (with transaction enabled; i.e., use InnoDB engine) or 5.x.

Installing caGrid 1.4 Using the Installer

Internet Resources Required by the Installer
Unless you are using a customized installer, the installer will need to be able to access these internet resources:
  1. Download the caGrid 1.4 Installer, unless you have a customized installer that you have been instructed to use for your grid. The downloaded installer should be contained in the file caGrid-installer-1.4.zip. If you are using a customized installer the name may vary.

  2. Unzip the file caGrid-installer-1.4.zip. This creates the directory caGrid-installer-1.4. This documentation refers to this directory as CAGRID_INSTALLER_LOCATION.

  3. From a command prompt, launch the installer using the following command:
    Do not launch the installer by double-clicking the jar file
     > cd *CAGRID_INSTALLER_LOCATION*
    
> java -jar caGrid-installer-1.4.jar
  4. Select the I agree to this license checkbox and then click  Next.
  5. Select the Install/Configure caGrid Software checkbox and then click  Next.
  6. The installer detects whether or not you have already installed Ant. It installs or reinstalls it, depending on your installation status. In either case, you must specify the location where you want to install Ant.

  7. The installer detects whether or not you have already installed Globus. It installs or reinstalls it, depending on your installation status. In either case, you must specify the location where you want to install Globus.

  8. The installer asks you for a location on your local file system to install caGrid. Specify a location to install caGrid and click  Next.
    To select a file location that is not in the User's Home directory, Click the Look In: drop down list and select a new starting location.
  9. The installer displays a list of tasks that the installer will perform. Click  Next to begin the installation process. At this time the installer downloads, builds, and installs several components. This process takes several minutes.

  10. Once the installer has completed installing all the components, click  Next.

  11. The installer prompts you to specify which Grid you want to configure your installation to use. The installer supports configuring caGrid to work out of the box with many community Grid environments. For testing and development purposes, we recommend selecting the Training Grid. If you do not want to configure caGrid to work with an existing Grid you may select that as well. The installer can also be modified to support additional Grids.
  12. The installer shows a summary of the tasks to be completed. Click  Next to configure caGrid to use the selected target Grids. This process takes several minutes.

  13. Once the installer has finished configuring caGrid to use the target Grid, click  Next. The final screen reminds you to set your ANT_HOME and GLOBUS_LOCATION environment variables. Set these variables immediately and click Finish.

Congratulations! You have successfully installed caGrid.
Add ANT_HOME/bin to PATH
You will be running the ant program from the command line so add ANT_HOME/bin to PATH.

The installer places caGrid in the directory you specified during installation. From this point forward we refer to this directory as CAGRID_HOME.

The CDS can be found in the directory CAGRID_HOME/projects/cds. From this point forward we refer to this directory as CDS_HOME.

The GAARDS UI or graphical user interface for administrating the CDS is located in CAGRID_HOME/projects/gaardsui. From this point forward we refer to this directory as GAARDS_UI_HOME.

Step 2: Obtain Host Credentials

The CDS requires that it runs as a secure service. In order to run a secure service, the container hosting the service must run with a host credential. A host credential consist of a X.509 certificate and private key.  In production environment it is very important that this credential be issued by a certificate authority that your environment trusts.  For the purposes of this guide we will provide instructions on how to obtain a host credential from Dorian.  Dorian is an open source service framework for issuing PKI credentials and is a trusted certificate authority in many Grid environments.   Most target Grids (selected in the last step) are configured with one or more Dorian instances.  For the purposes of this guide we will provide documentation on requesting a host credential from the Training Dorian, similar steps can be used for requesting a host credential from other Dorian instances.

To request a host credential from the Training Dorian, you must have must have an account.  Any user may request an account from the Training Dorian.  If you have an account with the Training Dorian, complete the steps below to get a host credential, otherwise click here for directions on requesting an account and then proceed with the steps below:

  1. Launch the GAARDS UI
  2. Log onto the Grid.
  3. From the MyAccount menu, select Request a Host Certificate, this launches the Request a Host Certificate window.
  4. From the Service drop down select the Dorian you wish to request a host certificate from.
  5. In the Host text box, enter the name of the host you are requesting a host certificate for.
  6. Specify the directory on the file system where the host credentials should be written to by clicking the Browse button.
  7. Click the Request Certificate button.

Request Host Certificate

Immediately after clicking the Request Certificate button, the UI will submit the host certificate request to Dorian. Upon receiving the request Dorian will either immediately approve the request or submit the request to administrator for approval. In the case where the request is immediately approved, the host credentials (certificate and private key) will be written to the directory specified. The file containing the certificate will be named THE_HOSTNAME_YOU_ENTERED-cert.pem, the file containing the private key will be named THE_HOSTNAME_YOU_ENTERED-key.pem.

In the case where host certificate request requires approval of an administrator, the file containing the private key will be named THE_HOSTNAME_YOU_ENTERED-key.pem. The host certificate WILL NOT be written since it is not issued until the request is approved.  You will need to wait for an administrator to approve your request before proceeding forward.  The GAARDS UI provide a means of checking the status of your request, for directions on how to do this click here.

Please note down the location that the host certificate and private key were written to. These will be needed later to configure your container.

Step 3: Configure a Secure Container

In this step we will configure a web service container that will host the CDS.   The CDS can be deployed to the Tomcat, JBoss, and Globus containers.  For the purposes of this guide we will  provide detailed instructions on how to use the caGrid Installer to install and configure a secure  Tomcat container.   You will need to supply the installer with the host credentials you created in the last step.

  1. From a command prompt, launch the caGrid Installer: 
    > cd \ CAGRID_INSTALLER_LOCATION
    
> java -jar caGrid-installer-1.4.jar
  2. Select the I agree to this license box and then click Next.
  3. Select the Install/Configure Grid Service Container box and then click Next.
  4. Select the Container to which you want to deploy your service. Because this guide will use a secure Tomcat, select the Should this container be secure? box and then click Next.
  5. In the hostname box, enter the hostname of your server. This should match the hostname you used when you created your host credentials. Click Next.
    If you plan on using this container to deploy a service that registers to an existing grid, it is important that you use a publicly resolvable DNS name (or static IP). Otherwise, you will need to manually edit configuration files later to correct this.
  6. From the Obtain host credentials method list, select the option that applies to your situation and click Next.
    Options:
    • If you do not yet have credentials for your service, select Use GAARDS to obtain host credentials.
    • If you have host credentials that are not in the default location, then select Browse to host credentials on the file system.
    • If you have host credentials that are in the default location, then select Host credentials are already installed.

    Default credential location:

    • On Windows, this will be a path like "C:\Documents and Settings\<USERNAME>\.cagrid\certificates".
    • On Linux/MAC this will be a path like "/Users/YOUR_USERNAME/.cagrid/certificates".
  7. If you selected Browse to host credentials on the file system, the next screen will prompt you for the location of your credentials. Enter the location of your host certificate in the Certificate text box. Enter the location of your private key in the Key text box. Click Next.
  8. The next screen asks where you want to install Tomcat. Enter that location in the Directory text box and click Next.
  9. A list of tasks appears that the installer will perform in order to install and configure Tomcat. Click Next.
  10. Once the installer has completed installing all of the components, click Next.
  11. Click Next. The final screen reminds you to set your ANT_HOME, GLOBUS_LOCATION and CATALINA_HOME environment variables. Set these variables immediately and click Finish.

Congratulations! You have successfully installed and configured your Tomcat container.

Step 4: Configure the CDS

The CDS is configured through a simple properties file, CDS_HOME/etc/cds.properties.  In most case you will only need to edit the following properties:

gaards.cds.db.user - The user id of the Mysql database user, this user should have privileges to create databases, otherwise you must created that database by hand.
gaards.cds.db.password - The password of the Mysql database user.
gaards.cds.dbkeymanager.key.encyption.password- The password used to encrypt private keys stored in the CDS database.

For complete details on configuring the CDS, consult the configuration guide.

Step 5: Add an Initial CDS Administrator (Optional)

The CDS maintains a group of administrators each of which is granted the ability to manage and review all credential delegated through the CDS. Maintaining a list of administrators is not required for operating a CDS, however administrative access is valuable in evaluating the actions of users as well as for helping debug problems. The CDS provides a command line tool for bootstrapping CDS with an initial administrator(s). To use it, type the following from a command prompt:

%> cd CDS_HOME
%> ant addAdmin

This will prompt you for the grid identity of the initial administrator to add, enter the grid identity of the user you want to add as the initial administrator and hit enter.

Step 6: Edit Service Metadata

CDS provides service metadata to clients and other services that describes information about the service, operations supported by the service, and information on the organization hosting the service.

Edit the service metadata to reflect your organization as follows:

  1. Open the CDS service metadata file, CDS_HOME/etc/serviceMetadata.xml.
  2. In the hostingResearchCenter element near the bottom of the file, do the following.
    1. Supply your ResearchCenter infomation.
    2. Supply your Address. This is the address that is used when mapping your service on the caGrid Portal.
    3. Supply the PointOfContact. This is the person responsible for maintaining the service.
      A completed example: 
      <ns1:hostingResearchCenter>
  <ns53:ResearchCenter displayName="Ohio State University" shortName="OSU" xmlns:ns53="gme://caGrid.caBIG/1.0/gov.nih.nci.cagrid.metadata.common">
   <ns53:Address country="US" locality="Columbus" postalCode="43210" stateProvince="OH" street1="3190 Graves Hall" street2="333 W. 10th Ave."/>
   <ns53:pointOfContactCollection>
    <ns53:PointOfContact affiliation="OSU" email="John.Doe@osumc.edu" firstName="John" lastName="Doe" phoneNumber="(555) 555-5555" role="Maintainer"/>
   </ns53:pointOfContactCollection>
  </ns53:ResearchCenter>
 </ns1:hostingResearchCenter>
      Note
      By default, the CDS registers with and publishes its service metadata to the Index Service. The default Index Service is configured as the Index Service of the target grid you selected when you installed the CDS. You can find configuration details on registering and publishing to the Index Service, including disabling registration and changing which Index Service to register with, on the Registration and Discovery page.

Step 7: Deploy the CDS

At this point we have completed configuring the CDS and the Tomcat container the CDS will run in. We are now ready to deploy the CDS to the Secure Tomcat Container.  This can be done as follows from a command prompt:

 >cd CDS_HOME
 > ant deployTomcat
If you chose to use a JBoss container, the CDS can easily be deployed by typing the following at a command prompt:

 > cd CDS_HOME
 > ant deployJBoss
Although the installer does not support configuring a secure Globus container, the CDS can be deployed to a secure Globus container by typing the following at the command prompt:
 > cd CDS_HOME
 > ant deployGlobus
No matter which container you choose you should see a significant amount of output to the screen, if the deployment is successful you should see the words "BUILD SUCCESSFUL" outputted to the screen.

Step 9: Verify the Installation

Once you have deployed the CDS, you have completed the installation and configuration of the CDS. Next we will verify that the installation was successful, however before doing so we must start the the CDS. This is done by starting the container that the CDS was deployed to. To start a secure Tomcat container run the startup script (startup.sh or startup.bat) located in CATALINA_HOME/bin.   Please check the Tomcat log files (CATALINA_HOME/log/catalina.out) to ensure that there are no error or stacktraces and that the container successfully started and bound to the port you specified during the installation.   Once the container has started we are ready to verify that the CDS installation was successful.   To accomplish this we will use the GAARDS UI which is a graphical user interface for administering security services such as the CDS.   Specifically we verify that we can delegate a credential to the CDS. To do this, configure the GAARDS UI to be able to communicate with the CDS we just instantiated by completing the following steps:

  1. Type the following from a command prompt: 
    $ cd GAARDS_UI_HOME
$ ant ui
  2. From the Window menu select Preferences , this will launch the Preference window.
  3. On the left side of the window there will be a preferences tree, expand the Delegation node and then click on the Delegation Service(s) node.   On the right side of the screen you should see a list of Delegation Service(s).
  4. In the Display Name text field enter Localhost.
  5. In the Service URL text field enter "https://localhost:8443/wsrf/services/cagrid/CredentialDelegationService", replacing the port (8443) with the port you configured during installation.
  6. Click the Add button.
  7. Click the Save button.

Next we must log in so we can delegate our credential. To accomplish this complete the following steps:

  1. Click the Login button, this will bring up a Login screen.
  2. From the Credential Provider list, select the Dorian that issued your administrators credential.
  3. From the Organization list, select the identity provider of the administrator.
  4. In the User ID text box, enter the user id of the administrator.
  5. In the Password text box, enter the password of the administrator.
  6. Click the Authenticate button.

Now that you have logged in, you can delegate your credential by completing the following steps:

  1. From the MyAccount menu, select Delegate Credential, this will launch the Delegate Credential Window.
  2. From the Delegation Service drop down select Localhost.
  3. From the Delegation Lifetime (Hours) drop down select 2.
  4. From the Issued Credential Lifetime (Hours) drop down select 1.
  5. Click the Delegate button, this will bring up a window for specifying the Identity Delegation Policy.
  6. In the Grid Identity text box enter the grid identity of a user you would like to delegate your credential to.   For testing purposed enter your grid identity, you can cut and paste your identity from the Credential text box.
  7. Click the Add button.
  8. Click the Delegate button, your credential will be delegated to the CDS.
Congratulations you have successfully installed the CDS.

CDS Preferences

Login Window

Delegate Credential

Identity Delegation Policy
Last edited by
Joe George (616 days ago) , ...
Adaptavist Theme Builder Powered by Atlassian Confluence