Difference between revisions of "RCauth Delegation Server & MasterPortal - Building from Source"

From PDP/Grid Wiki
Jump to navigationJump to search
(mp dependencies)
(mp dependencies (myproxy and ncsa-security-all)
Line 1: Line 1:
 
= Introduction =
 
= Introduction =
 
 
  
 
= Building the Master Portal =
 
= Building the Master Portal =
Line 15: Line 13:
 
== Dependencies ==
 
== Dependencies ==
  
The '''master-portal-client''' module is based on a modified version of the [http://grid.ncsa.illinois.edu/myproxy/oauth/client/index.xhtml OA4MP Client], while the the '''master-portal-server''' module is based on a modified version of the [http://grid.ncsa.illinois.edu/myproxy/oauth/server/index.xhtml OA4MP Server]. The upstream OA4MP implementation is under a project called [https://sourceforge.net/p/cilogon/code/HEAD/tree/trunk/edu.uiuc.ncsa/myproxy/ myproxy] with a parent project called [https://sourceforge.net/p/cilogon/code/HEAD/tree/trunk/edu.uiuc.ncsa/ncsa-security-all/ ncsa-security-all]. We forked both the '''myproxy''' and the '''ncsa-security-all''' projects to complete them with the following features:
+
The '''master-portal-client''' module is based on a modified version of the [http://grid.ncsa.illinois.edu/myproxy/oauth/client/index.xhtml OA4MP Client], while the the '''master-portal-server''' module is based on a modified version of the [http://grid.ncsa.illinois.edu/myproxy/oauth/server/index.xhtml OA4MP Server]. The upstream OA4MP implementation is under a project called [https://sourceforge.net/p/cilogon/code/HEAD/tree/trunk/edu.uiuc.ncsa/myproxy/ myproxy] with a parent project called [https://sourceforge.net/p/cilogon/code/HEAD/tree/trunk/edu.uiuc.ncsa/ncsa-security-all/ ncsa-security-all]. These two project also stand at basis of the [http://www.cilogon.org/ CILogon] project. We forked both the '''myproxy''' and the '''ncsa-security-all''' projects to complete them with the following features:
  
 
* the [[OAuth_for_MyProxy_GetProxy_Endpoint | /getproxy]] endpoint
 
* the [[OAuth_for_MyProxy_GetProxy_Endpoint | /getproxy]] endpoint
Line 23: Line 21:
  
 
We also considered implementing these modifications into the Master Portal project directly, but we abandoned this approach because it would have meant extensive code duplication from the upstream OA4MP project. The implemented features are generic enough so that it might benefit the upstream OA4MP project as well, and might, some day end up being merged into it.  
 
We also considered implementing these modifications into the Master Portal project directly, but we abandoned this approach because it would have meant extensive code duplication from the upstream OA4MP project. The implemented features are generic enough so that it might benefit the upstream OA4MP project as well, and might, some day end up being merged into it.  
 +
 +
=== ncsa-security-all-fork ===
 +
 +
The '''ncsa-security-all''' forked project can be found on [https://github.com/ttomttom/ncsa-security-all-fork github]. In order to keep in sync with the upstream code we have two branches. The 'master' branch holds a clean copy of the upstream ncsa-security-all project, while the 'devel' branch holds the actual forked code. Whenever there's an update on the master branch we can merge it into the 'devel' branch to keep our fork up to date.
 +
 +
In order to build the Master Portal you will need to clone the '''devel''' branch from ncsa-security-all-fork, compile it, and install it in your local maven repository. You do this by executing the following:
 +
 +
git clone -b devel https://github.com/ttomttom/ncsa-security-all-fork.git
 +
cd ncsa-security-all-fork/ncsa-security-all
 +
mvn package install
 +
 +
'''Note!''' Make sure to do this only BEFORE you compile [[#myproxy-fork | myproxy-fork]]!
  
 
=== myproxy-fork ===
 
=== myproxy-fork ===
=== ncsa-security-all-fork ===
+
 +
The '''myproxy''' forked project can be found on [https://github.com/ttomttom/myproxy-fork github]. Just as with [[#myproxy-fork | myproxy-fork]], in order to keep in sync with the upstream code we have two branches. The 'master' branch holds a clean copy of the upstream myproxy project, while the 'devel' branch holds the actual forked code. Whenever there's an update on the master branch we can merge it into the 'devel' branch to keep our fork up to date.
 +
 
 +
In order to build the Master Portal you will need to clone the '''devel''' branch from myproxy-fork, compile it, and install it in your local maven repository. You do this by executing the following:
 +
 
 +
git clone -b devel https://github.com/ttomttom/myproxy-fork.git
 +
cd myproxy-fork/myproxy
 +
mvn package install
 +
 
 +
'''Note!''' Make sure to do this only AFTER you complied and installed [[#ncsa-security-all-fork | ncsa-security-all-fork]] otherwise it will fail to find the right dependencies!
 +
 
 
== Master Portal ==
 
== Master Portal ==
 
== Master Portal - CLI ==
 
== Master Portal - CLI ==

Revision as of 14:59, 15 July 2016

Introduction

Building the Master Portal

The Master Portal source code is currently hosted on github. The main (maven) project is called 'aarc-master-portal', which is just a parent project containing the following (maven) modules:

  • master-portal-client : contains the MP Client component which makes requests to the Delegation Server.
  • master-portal-server : contains the MP Server component which takes requests from registered Portals.
  • master-portal-common : contains a set of common constants and utility classes shared between the MP Client and MP server. Both master-portal-client and master-portal-server include this module as a dependency

Make sure to have the required dependencies ready before compiling the Master Portal.

Dependencies

The master-portal-client module is based on a modified version of the OA4MP Client, while the the master-portal-server module is based on a modified version of the OA4MP Server. The upstream OA4MP implementation is under a project called myproxy with a parent project called ncsa-security-all. These two project also stand at basis of the CILogon project. We forked both the myproxy and the ncsa-security-all projects to complete them with the following features:

  • the /getproxy endpoint
  • an updated set of executable commands from the MyProxy Protocol (GET with VONAME and VOMSES, INFO, PUT, STORE)

The /getproxy endpoint is a new endpoint we are using on the Master Portal Server to serve proxies, while the updated MyProxy commands set is used by the Master Portal to save (INFO, PUT, STORE) user proxies in a MyProxy Credential Store, and retrieve (GET) proxies with voms extensions.

We also considered implementing these modifications into the Master Portal project directly, but we abandoned this approach because it would have meant extensive code duplication from the upstream OA4MP project. The implemented features are generic enough so that it might benefit the upstream OA4MP project as well, and might, some day end up being merged into it.

ncsa-security-all-fork

The ncsa-security-all forked project can be found on github. In order to keep in sync with the upstream code we have two branches. The 'master' branch holds a clean copy of the upstream ncsa-security-all project, while the 'devel' branch holds the actual forked code. Whenever there's an update on the master branch we can merge it into the 'devel' branch to keep our fork up to date.

In order to build the Master Portal you will need to clone the devel branch from ncsa-security-all-fork, compile it, and install it in your local maven repository. You do this by executing the following:

git clone -b devel https://github.com/ttomttom/ncsa-security-all-fork.git
cd ncsa-security-all-fork/ncsa-security-all
mvn package install 

Note! Make sure to do this only BEFORE you compile myproxy-fork!

myproxy-fork

The myproxy forked project can be found on github. Just as with myproxy-fork, in order to keep in sync with the upstream code we have two branches. The 'master' branch holds a clean copy of the upstream myproxy project, while the 'devel' branch holds the actual forked code. Whenever there's an update on the master branch we can merge it into the 'devel' branch to keep our fork up to date.

In order to build the Master Portal you will need to clone the devel branch from myproxy-fork, compile it, and install it in your local maven repository. You do this by executing the following:

git clone -b devel https://github.com/ttomttom/myproxy-fork.git
cd myproxy-fork/myproxy
mvn package install 

Note! Make sure to do this only AFTER you complied and installed ncsa-security-all-fork otherwise it will fail to find the right dependencies!

Master Portal

Master Portal - CLI

Building the Delegation Server

Delegation Server

Delegation Server - CLI