Difference between revisions of "How to use VOMS api library"

From Gcube Wiki
Jump to: navigation, search
(New page: == Package Installation == === Download === The VOMS api library can be downloaded from [https://grids16.eng.it/BuildReport/download?dirName=recent%20builds&configurationName=org_dilige...)
 
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
[[Category:TO BE REMOVED]]
 +
 
== Package Installation ==
 
== Package Installation ==
  
 
=== Download ===  
 
=== Download ===  
  
−
The VOMS api library can be downloaded from [https://grids16.eng.it/BuildReport/download?dirName=recent%20builds&configurationName=org_diligentproject_dvos_0_4_0&buildName=BUILD_2&moduleName=org.diligentproject.dvos.voms-api.SERVICEARCHIVE_0_4_0&what=tgz here].
+
The VOMS api library can be downloaded from [https://grids16.eng.it/BuildReport/builds/recent%20builds/org.gcube.HEAD/BUILD_471/org.gcube.vo-management.voms-api.HEAD/tgz here].
  
 
=== Installation Procedure ===
 
=== Installation Procedure ===
 
The following steps have to be performed in order to use this library:
 
The following steps have to be performed in order to use this library:
−
* uncompress the ''org.diligentproject.dvos.voms-api.SERVICEARCHIVE-0.4.0-0.tar.gz'' file
+
* uncompress the ''org.gcube.vo-management.voms-api-0.0.0-0.tar.gz'' file
−
* copy dvos.voms-api.jar in a convenient directory
+
* copy ''org.gcube.vomanagement.voms-api.jar'' in a convenient directory
 
* Edit a vomsAPI.properties file based on the template provided in the SA.
 
* Edit a vomsAPI.properties file based on the template provided in the SA.
−
* Move your vomsAPI.properties in client working directory in order to use the settings chosen.
+
==== VOMS API properties file ====
 +
vomsAPI.properties file is contained in SA and basically is composed of 3 sections:
 +
information about MyProxyCA server
 +
<source lang="xml">
 +
# MyProxy server e.g.:grids04.eng.it
 +
MYPROXY_HOST=YOUR_MYPROXYCA_SERVER
 +
# MyProxy server port, default value is 7512
 +
MYPROXY_PORT=YOUR_MYPROXYCA_SERVER_PORT
 +
 
 +
# Information about simpleCA to be used
 +
 
 +
# Certification authority, e.g.: /O=Grid/OU=GlobusTest/OU=simpleCA-gauss.eng.it/CN=Globus Simple CA
 +
SIMPLE_CA=YOUR_CA
 +
 
 +
# Common Name prefix to build a Distinguished Name (DN),
 +
# e.g.: /O=Grid/OU=GlobusTest/OU=simpleCA-gauss.eng.it/OU=eng.it/CN= for a CN=test to obtain a valid DN for the VOMS
 +
CN_prefix=CN_prefix
 +
</source>
 +
information about VOMS server
 +
<source lang="xml">
 +
# VOMS host
 +
VOMS_HOST=YOUR_VOMS
 +
#VO Name defined in VOMS, e.g: d4science
 +
VO_NAME=YOUR_VO_NAME
 +
# Default voms port is "8443"
 +
VOMS_PORT=8443
 +
# Default voms protocol is "https"
 +
VOMS_PROTOCOL=https
 +
</source>
 +
CLIENT credentials: the credentials to be specified by client to contact VOMS. They should have VO-Admin privileges in VO group.
 +
<source lang="xml">
 +
# CLIENT creds: specify the triple (CLIENT_CERT, CLIENT_KEY, CLIENT_PWD) or CLIENT_PROXY
 +
# e.g: triple (CLIENT_CERT, CLIENT_KEY, CLIENT_PWD)
 +
# Overwrite the .pem certificate of the host, default path is /etc/grid-security/hostpubliccert.pem
 +
# CLIENT_CERT=$HOME/user_cert.pem
 +
# The .pem key of the host, default path is /etc/grid-security/hostprivatekey.pem
 +
# CLIENT_KEY=$HOME/user_key.pem
 +
# The password to decrypt private key
 +
# CLIENT_PWD=
 +
 
 +
# e.g: CLIENT_PROXY
 +
# client creds as a proxy certifcate, eg $HOME/proxy
 +
# CLIENT_PROXY=
 +
</source>
 +
 
 +
== Using VOMS API library ==
 +
This VOMS api library version DOESN'T need to use a VOMS servlet.

Latest revision as of 18:59, 6 July 2016


Package Installation

Download

The VOMS api library can be downloaded from here.

Installation Procedure

The following steps have to be performed in order to use this library:

  • uncompress the org.gcube.vo-management.voms-api-0.0.0-0.tar.gz file
  • copy org.gcube.vomanagement.voms-api.jar in a convenient directory
  • Edit a vomsAPI.properties file based on the template provided in the SA.

VOMS API properties file

vomsAPI.properties file is contained in SA and basically is composed of 3 sections: information about MyProxyCA server 

# MyProxy server e.g.:grids04.eng.it
MYPROXY_HOST=YOUR_MYPROXYCA_SERVER
# MyProxy server port, default value is 7512
MYPROXY_PORT=YOUR_MYPROXYCA_SERVER_PORT
 
# Information about simpleCA to be used
 
# Certification authority, e.g.: /O=Grid/OU=GlobusTest/OU=simpleCA-gauss.eng.it/CN=Globus Simple CA
SIMPLE_CA=YOUR_CA
 
# Common Name prefix to build a Distinguished Name (DN), 
# e.g.: /O=Grid/OU=GlobusTest/OU=simpleCA-gauss.eng.it/OU=eng.it/CN= for a CN=test to obtain a valid DN for the VOMS
CN_prefix=CN_prefix

information about VOMS server 

# VOMS host 
VOMS_HOST=YOUR_VOMS
 #VO Name defined in VOMS, e.g: d4science
VO_NAME=YOUR_VO_NAME
# Default voms port is "8443"
VOMS_PORT=8443
# Default voms protocol is "https"
VOMS_PROTOCOL=https

CLIENT credentials: the credentials to be specified by client to contact VOMS. They should have VO-Admin privileges in VO group. 

# CLIENT creds: specify the triple (CLIENT_CERT, CLIENT_KEY, CLIENT_PWD) or CLIENT_PROXY
# e.g: triple (CLIENT_CERT, CLIENT_KEY, CLIENT_PWD)
# Overwrite the .pem certificate of the host, default path is /etc/grid-security/hostpubliccert.pem
# CLIENT_CERT=$HOME/user_cert.pem
# The .pem key of the host, default path is /etc/grid-security/hostprivatekey.pem
# CLIENT_KEY=$HOME/user_key.pem
# The password to decrypt private key
# CLIENT_PWD=
 
# e.g: CLIENT_PROXY
# client creds as a proxy certifcate, eg $HOME/proxy
# CLIENT_PROXY=

Using VOMS API library

This VOMS api library version DOESN'T need to use a VOMS servlet.

Retrieved from "https://wiki.gcube-system.org/index.php?title=How_to_use_VOMS_api_library&oldid=25277"