|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.globus.myproxy.MyProxy
public class MyProxy
This class provides an API for communicating with MyProxy servers. It provides main functions for retrieving, removing and storing credentials on MyProxy server. It also provides functions for getting credential information and changing passwords.
More information about MyProxy is available on the MyProxy Home Page.
Field Summary | |
---|---|
protected Authorization |
authorization
The authorization policy in effect for the target MyProxy server. |
static int |
CHANGE_PASSWORD
The integer command number for the MyProxy Password Change command (4). |
protected org.ietf.jgss.GSSContext |
context
The GSSContext for communication with the MyProxy server. |
static int |
DEFAULT_KEYBITS
The default key size (2048 bits). |
static int |
DEFAULT_PORT
The default MyProxy server port (7512). |
static int |
DESTROY_PROXY
The integer command number for the MyProxy 'Destroy' command (3). |
static int |
GET_PROXY
The integer command number for the MyProxy 'Get' command (0). |
static int |
GET_TRUSTROOTS
The integer command number for the MyProxy 'Get Trustroots' command (7). |
protected java.lang.String |
host
The hostname of the target MyProxy server. |
static int |
INFO_PROXY
The integer command number for the MyProxy 'Info' command (2). |
static int |
MIN_PASSWORD_LENGTH
|
static java.lang.String |
MYPROXY_PROTOCOL_VERSION
|
protected int |
port
The port of the target MyProxy server (default 7512). |
static int |
PUT_PROXY
The integer command number for the MyProxy 'Put' command (1). |
static int |
RETRIEVE_CREDENTIAL
The integer command number for the MyProxy 'Retrieve' command (6). |
static int |
STORE_CREDENTIAL
The integer command number for the MyProxy 'Store' command (5). |
protected java.lang.String[] |
trustrootData
|
protected java.lang.String[] |
trustrootFilenames
Trustroot information and path constant. |
Constructor Summary | |
---|---|
MyProxy()
Initialize the MyProxy client object with the default authorization policy. |
|
MyProxy(java.lang.String host,
int port)
Prepare to connect to the MyProxy server at the specified host and port using the default authorization policy. |
Method Summary | |
---|---|
void |
bootstrapTrust()
Bootstraps trustroot information from the MyProxy server. |
void |
changePassword(org.ietf.jgss.GSSCredential credential,
ChangePasswordParams params)
Changes the password of the credential on the MyProxy server. |
void |
destroy(org.ietf.jgss.GSSCredential credential,
DestroyParams params)
Removes delegated credentials from the MyProxy server. |
void |
destroy(org.ietf.jgss.GSSCredential credential,
java.lang.String username,
java.lang.String passphrase)
Removes delegated credentials from the MyProxy server. |
static void |
destroy(java.lang.String host,
int port,
org.ietf.jgss.GSSCredential credential,
java.lang.String username,
java.lang.String passphrase)
Deprecated. Use non-static methods instead. |
static void |
destroy(java.lang.String host,
int port,
org.ietf.jgss.GSSCredential credential,
java.lang.String username,
java.lang.String passphrase,
java.lang.String subjectDN)
Deprecated. Use non-static methods instead. |
org.ietf.jgss.GSSCredential |
get(org.ietf.jgss.GSSCredential credential,
GetParams params)
Retrieves delegated credentials from the MyProxy server. |
org.ietf.jgss.GSSCredential |
get(org.ietf.jgss.GSSCredential credential,
java.lang.String username,
java.lang.String passphrase,
int lifetime)
Retrieves delegated credentials from the MyProxy server. |
static org.ietf.jgss.GSSCredential |
get(java.lang.String host,
int port,
org.ietf.jgss.GSSCredential credential,
java.lang.String username,
java.lang.String passphrase,
int lifetime)
Deprecated. Use non-static methods instead. |
static org.ietf.jgss.GSSCredential |
get(java.lang.String host,
int port,
org.ietf.jgss.GSSCredential credential,
java.lang.String username,
java.lang.String passphrase,
int lifetime,
java.lang.String subjectDN)
Deprecated. Use non-static methods instead. |
org.ietf.jgss.GSSCredential |
get(java.lang.String username,
java.lang.String passphrase,
int lifetime)
Retrieves delegated credentials from MyProxy server Anonymously (without local credentials) Notes: Performs simple verification of private/public keys of the delegated credential. |
Authorization |
getAuthorization()
Get MyProxy server authorization mechanism. |
java.lang.String |
getHost()
Get MyProxy server hostname. |
int |
getPort()
Get MyProxy server port. |
static java.lang.String |
getTrustRootPath()
Returns the trusted certificates directory location where writeTrustRoots() will store certificates. |
void |
getTrustroots(org.ietf.jgss.GSSCredential credential,
GetTrustrootsParams params)
Retrieves trustroot information from the MyProxy server. |
CredentialInfo[] |
info(org.ietf.jgss.GSSCredential credential,
InfoParams params)
Retrieves credential information from MyProxy server. |
CredentialInfo |
info(org.ietf.jgss.GSSCredential credential,
java.lang.String username,
java.lang.String passphrase)
Retrieves credential information from MyProxy server. |
void |
put(org.ietf.jgss.GSSCredential credential,
InitParams params)
Delegate credentials to a MyProxy server. |
void |
put(org.ietf.jgss.GSSCredential credential,
java.lang.String username,
java.lang.String passphrase,
int lifetime)
Delegate credentials to a MyProxy server. |
static void |
put(java.lang.String host,
int port,
org.ietf.jgss.GSSCredential credential,
java.lang.String username,
java.lang.String passphrase,
int lifetime)
Deprecated. Use non-static methods instead. |
static void |
put(java.lang.String host,
int port,
org.ietf.jgss.GSSCredential credential,
java.lang.String username,
java.lang.String passphrase,
int lifetime,
java.lang.String subjectDN)
Deprecated. Use non-static methods instead. |
void |
setAuthorization(Authorization authorization)
Set MyProxy server authorization mechanism. |
void |
setHost(java.lang.String host)
Set MyProxy server hostname. |
void |
setPort(int port)
Set MyProxy server port. |
void |
store(org.ietf.jgss.GSSCredential credential,
java.security.cert.X509Certificate[] certs,
OpenSSLKey key,
StoreParams params)
Store credentials on a MyProxy server. |
boolean |
writeTrustRoots()
Writes the retrieved trust roots to the Globus trusted certificates directory. |
boolean |
writeTrustRoots(java.lang.String directory)
Writes the retrieved trust roots to a trusted certificates directory. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int MIN_PASSWORD_LENGTH
public static final java.lang.String MYPROXY_PROTOCOL_VERSION
public static final int DEFAULT_PORT
public static final int DEFAULT_KEYBITS
public static final int GET_PROXY
public static final int PUT_PROXY
public static final int INFO_PROXY
public static final int DESTROY_PROXY
public static final int CHANGE_PASSWORD
public static final int STORE_CREDENTIAL
public static final int RETRIEVE_CREDENTIAL
public static final int GET_TRUSTROOTS
protected java.lang.String host
protected int port
protected Authorization authorization
protected org.ietf.jgss.GSSContext context
protected java.lang.String[] trustrootFilenames
protected java.lang.String[] trustrootData
Constructor Detail |
---|
public MyProxy()
public MyProxy(java.lang.String host, int port)
host
- The hostname of the MyProxy server.port
- The port number of the MyProxy server.Method Detail |
---|
public void setHost(java.lang.String host)
host
- The hostname of the MyProxy server.public java.lang.String getHost()
public void setPort(int port)
port
- The port number of the MyProxy server.public int getPort()
public void setAuthorization(Authorization authorization)
authorization
- The authorization mechanism for the MyProxy server.public Authorization getAuthorization()
public void put(org.ietf.jgss.GSSCredential credential, java.lang.String username, java.lang.String passphrase, int lifetime) throws MyProxyException
credential
- The GSI credentials to use.username
- The username to store the credentials under.passphrase
- The passphrase to use to encrypt the stored
credentials.lifetime
- The maximum lifetime of credentials delegated by the server
(in seconds).
MyProxyException
- If an error occurred during the operation.public void put(org.ietf.jgss.GSSCredential credential, InitParams params) throws MyProxyException
credential
- The GSI credentials to use.params
- The parameters for the put operation.
MyProxyException
- If an error occurred during the operation.public void store(org.ietf.jgss.GSSCredential credential, java.security.cert.X509Certificate[] certs, OpenSSLKey key, StoreParams params) throws MyProxyException
credential
- The local GSI credentials to use for authentication.certs
- The certificate(s) to store.key
- The private key to store (typically encrypted).params
- The parameters for the store operation.
MyProxyException
- If an error occurred during the operation.public void destroy(org.ietf.jgss.GSSCredential credential, java.lang.String username, java.lang.String passphrase) throws MyProxyException
credential
- The local GSI credentials to use for authentication.username
- The username of the credentials to remove.passphrase
- The passphrase of the credentials to remove.
MyProxyException
- If an error occurred during the operation.public void destroy(org.ietf.jgss.GSSCredential credential, DestroyParams params) throws MyProxyException
credential
- The local GSI credentials to use for authentication.params
- The parameters for the destroy operation.
MyProxyException
- If an error occurred during the operation.public void changePassword(org.ietf.jgss.GSSCredential credential, ChangePasswordParams params) throws MyProxyException
credential
- The local GSI credentials to use for authentication.params
- The parameters for the change password operation.
MyProxyException
- If an error occurred during the operation.public CredentialInfo info(org.ietf.jgss.GSSCredential credential, java.lang.String username, java.lang.String passphrase) throws MyProxyException
credential
- The local GSI credentials to use for authentication.username
- The username of the credentials to remove.passphrase
- The passphrase of the credentials to remove.
MyProxyException
- If an error occurred during the operation.public CredentialInfo[] info(org.ietf.jgss.GSSCredential credential, InfoParams params) throws MyProxyException
credential
- The local GSI credentials to use for authentication.params
- The parameters for the info operation.
MyProxyException
- If an error occurred during the operation.public org.ietf.jgss.GSSCredential get(java.lang.String username, java.lang.String passphrase, int lifetime) throws MyProxyException
username
- The username of the credentials to retrieve.passphrase
- The passphrase of the credentials to retrieve.lifetime
- The requested lifetime of the retrieved credential (in seconds).
MyProxyException
- If an error occurred during the operation.public org.ietf.jgss.GSSCredential get(org.ietf.jgss.GSSCredential credential, java.lang.String username, java.lang.String passphrase, int lifetime) throws MyProxyException
credential
- The local GSI credentials to use for authentication.
Can be set to null if no local credentials.username
- The username of the credentials to retrieve.passphrase
- The passphrase of the credentials to retrieve.lifetime
- The requested lifetime of the retrieved credential (in seconds).
MyProxyException
- If an error occurred during the operation.public org.ietf.jgss.GSSCredential get(org.ietf.jgss.GSSCredential credential, GetParams params) throws MyProxyException
credential
- The local GSI credentials to use for authentication.
Can be set to null if no local credentials.params
- The parameters for the get operation.
MyProxyException
- If an error occurred during the operation.public void getTrustroots(org.ietf.jgss.GSSCredential credential, GetTrustrootsParams params) throws MyProxyException
credential
- The local GSI credentials to use for authentication.
Can be set to null if no local credentials.params
- The parameters for the get-trustroots operation.
MyProxyException
- If an error occurred during the operation.public void bootstrapTrust() throws MyProxyException
MyProxyException
- If an error occurred during the operation.public static void put(java.lang.String host, int port, org.ietf.jgss.GSSCredential credential, java.lang.String username, java.lang.String passphrase, int lifetime) throws MyProxyException
host
- The hostname of MyProxy server.port
- The port number of MyProxy server.credential
- The GSI credentials to use.username
- The username to store the credentials under.passphrase
- The passphrase to use to encrypt the stored
credentials.lifetime
- The requested lifetime of the stored credentials (in seconds).
MyProxyException
- If an error occurred during the put operation.public static void put(java.lang.String host, int port, org.ietf.jgss.GSSCredential credential, java.lang.String username, java.lang.String passphrase, int lifetime, java.lang.String subjectDN) throws MyProxyException
host
- The hostname of MyProxy server.port
- The port number of MyProxy server.credential
- The GSI credentials to use.username
- The username to store the credentials under.passphrase
- The passphrase to use to encrypt the stored
credentials.lifetime
- The requested lifetime of the stored credentials (in seconds).subjectDN
- The expected subject name of MyProxy server. This
is used for security purposes. If null, host
authentication will be performed.
MyProxyException
- If an error occurred during the put operation.public static void destroy(java.lang.String host, int port, org.ietf.jgss.GSSCredential credential, java.lang.String username, java.lang.String passphrase) throws MyProxyException
host
- The hostname of MyProxy server.port
- The port number of MyProxy server.credential
- The GSI credentials to use.username
- The username of the credentials to remove.passphrase
- The passphrase of the credentials to remove.
Right now it is ignored by the MyProxy sever.
MyProxyException
- If an error occurred during the operation.public static void destroy(java.lang.String host, int port, org.ietf.jgss.GSSCredential credential, java.lang.String username, java.lang.String passphrase, java.lang.String subjectDN) throws MyProxyException
host
- The hostname of MyProxy server.port
- The port number of MyProxy server.credential
- The GSI credentials to use.username
- The username of the credentials to remove.passphrase
- The passphrase of the credentials to remove.
Right now it is ignored by the MyProxy sever.subjectDN
- The expected subject name of MyProxy server. This
is used for security purposes. If null, host
authentication will be performed.
MyProxyException
- If an error occurred during the operation.public static org.ietf.jgss.GSSCredential get(java.lang.String host, int port, org.ietf.jgss.GSSCredential credential, java.lang.String username, java.lang.String passphrase, int lifetime) throws MyProxyException
host
- The hostname of MyProxy server.port
- The port number of MyProxy server.credential
- The GSI credentials to use.username
- The username of the credentials to retrieve.passphrase
- The passphrase of the credentials to retrieve.lifetime
- The requested lifetime of the retrieved credential (in seconds).
MyProxyException
- If an error occurred during the operation.public static org.ietf.jgss.GSSCredential get(java.lang.String host, int port, org.ietf.jgss.GSSCredential credential, java.lang.String username, java.lang.String passphrase, int lifetime, java.lang.String subjectDN) throws MyProxyException
host
- The hostname of MyProxy server.port
- The port number of MyProxy server.credential
- The GSI credentials to use.username
- The username of the credentials to retrieve.passphrase
- The passphrase of the credentials to retrieve.lifetime
- The requested lifetime of the retrieved credential (in seconds).subjectDN
- The expected subject name of MyProxy server. This
is used for security purposes. If null, host
authentication will be performed.
MyProxyException
- If an error occurred during the operation.public static java.lang.String getTrustRootPath()
public boolean writeTrustRoots() throws java.io.IOException
java.io.IOException
public boolean writeTrustRoots(java.lang.String directory) throws java.io.IOException
directory
- path where the trust roots should be written
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |