What is esgf-getCredentials?

A tool to retrieve user credentials from ESGF. It have one graphic interface and another command line interface.

Getting started

Pre-requisites

JDK or OpenJDK 6 and upper versions

Download

Download the jar -> getESGFCredentials-0.1.jar 476.4 KB new

Other versions..

Run it

Go to download folder:

• In Windows:
  • Open ESGFToolsUI-v0.8.jar
• Command-line interpreter:

     java -jar ESGFToolsUI-v0.8.jar
  

---

Command line UI Guide

Command line help

$ java -jar getESGFCredentials-0.1.jar --help

Basic usage

esgf-getcredentials --openid <openid> [other options]

Summary of options

-o <openid> --openid <openid>	OpenID endpoint from where myproxy information can be gathered
-p <password> --password <password>	OpenID passphrase
--output <path>	Path of folder where the retrieved certificates will be stored[default: /home/terryk/.esg]
-w --writeall	Generate all credentials files. The files generated are the same files generated with opts: --credentials --cacertspem --cacertsjks --cacerts --jkskeystore --jcekskeystore
-b --bootstrap	To bootstrapping certificates in myproxy service
--credentials	Write user certificate and private key in pem format
--cacertspem	Write trust CA certificates in pem format
--cacertsjks	Write trust CA certificates in JKS keystore format
--cacerts	Write trust CA certificates in a folder
--keystorejks	Write JKS keystore file. This keystore contains certificate, certificate chain and private key of user
--keystorejceks	Write JCEKS keystore file. This keystore contains certificate, certificate chain and private key of user
-d --debug	Turn debugging info on
-h --help	Show this screen
--version	Show version

}}}

To view specific use cases -->

---

Graphic UI Guide

• In Windows:
  • Open ESGFToolsUI-v0.8.jar
• Command-line interpreter:

     java -jar ESGFToolsUI-v0.8.jar
  

Setting user

You can select your IdP provider in the top drop-down list. If your IdP provider isn't in the list of providers. Select "Custom OpenID URL", with this option the GUI interface change to be able write OpenID URL's

Setting output files

You can select in "Generate" section what output files will be generated in the output folder.

credentials.pem	It's a pem file that contains the x509 user certificate and the RSA private key
keystore (JKS type)	It's a keystore in format JKS which is build with user cert, cert chain and private key
keystore (JCEKS type)	It's a keystore in format JCEKS which is build with user cert, cert chain and private key
esgf-truststore.ts	CA's certificates in keystore in format JKS
certificates	CA's certificate files and policy files in a folder
ca-certificates.pem	CA's certificates in pem format

Retrieve credentials

Click on "retrieve credentials" button. If all goes well a success message is shown. However, if some error happens then the Exception is showed

Advanced options

1. You can bootstrap the certificates. For that, select the check box "bootstrap certificates" in "Select Lib" section

2. You can change the output folder. The default is $USER_HOME/.esg
   

3. You can download a multilib myproxy version to select it in the "Select Lib" section
   • MyProxyLogon lib v1.0
   • MyProxy lib v2.0.6

MultiLib jar -> getESGFCredentialsMultLib-0.1.jar 2.3 MB new

---

Specific use cases

Aria2

1. Get a metalink of ESGF Files example_metalink​
   ESGFToolsUI generates metalinks of ESGF files. For more info https://meteo.unican.es/trac/wiki/ESGFToolsUI#ExporttoMetalink

2. Retrieve ESGF credentials in $USER_HOME/.esg

   java -jar getESGFCredentials-0.1.jar --openid <openid> --password <password> --credentials --cacertspem
   

3. Run aria2c with credentials and example_metalink​

   aria2c --private-key=$USER_HOME/.esg/credentials.pem --certificate=$USER_HOME/.esg/credentials.pem --check-certificate=true --ca-certificate=$USER_HOME/.esg/ca-certificates.pem ta_6hrPlev_IPSL-CM5A-LR_esmrcp85_r1i1p1.metalink
   

WGET (OPENSSL)

java -jar getESGFCredentials-0.0.2.jar -o <openid> -p <password> --credentials --cacerts --cacertsjks

WGET (GNU TLS)

java -jar getESGFCredentials-0.0.2.jar -o <openid> -p <password> --credentials --cacerts --cacertsjks

ToolsUI

java -jar getESGFCredentials-0.0.2.jar -o <openid> -p <password> --keystorejks --cacertsjks

ESGF WGET Script (Linux)

java -jar getESGFCredentials-0.0.2.jar -o <openid> -p <password> --credentials --cacerts --cacertsjks

ESGF WGET Script (cygwin)

java -jar getESGFCredentials-0.0.2.jar -o <openid> -p <password> --credentials --cacertspem --cacertsjks

NETCDF DAP

​https://www.unidata.ucar.edu/software/netcdf/docs/netcdf/DAP-Support.html

java -jar getESGFCredentials-0.0.2.jar -o <openid> -p <password> --credentials --cacerts --cacertspem --output <path>

Developers Guide

Github

​https://github.com/SantanderMetGroup/esgf-getcredentials

Architecture

See Also

• ESGFToolsUI - a desktop client for ​ESGF services