intcgsi_plugin(structsoap*soap,structsoap_plugin*plugin,void*arg)
Generic constructor for the cgsi_plugin
Parameterssoap The soap structure for the request
plugin Pointer to the plugin data structure
arg The parameters for the plugin creation
Returns
0 if successful, -1 otherwise
intcgsi_plugin_clr_flags(structsoap*soap,intis_server,intflags)
Adjust CGSI-plugin's behaviour by clearing one or more flags. If a flag is not present in args then it is
unaffected by this operation. If a flag is currently cleared then attempting to clear it will have no
effect.
Parameterssoap The soap structure from gSOAP
is_server 0 if client, 1 if server
flags Bitwise OR of the flags to be cleared.
Returns
0 on success, -1 on error.
intcgsi_plugin_get_flags(structsoap*soap,intis_server)
Discover the current set of flags that are in effect.
Parameterssoap The soap structure from gSOAP
is_server 0 if client, 1 if server
Returns
the set of flags or -1 on error
intcgsi_plugin_set_credentials(structsoap*soap,intis_server,constchar*x509_cert,constchar*x509_key)
Set credentials without using environment variables
Parameterssoap The soap structure for the request
is_server 0 if client, 1 if server
x509_cert The certificate. If it is a proxy, you only need to specify this one
x509_key The key. Will be ignored if x509_cert is NULL!
Returns
0 on success, -1 on error.
intcgsi_plugin_set_flags(structsoap*soap,intis_server,intflags)
Adjust CGSI-plugin's behaviour by setting one or more flags. If a flag is not present in args then that
flag is unaffected by this operation. If a flag is currently set then attempting to set it will have no
effect.
Parameterssoap The soap structure from gSOAP
is_server 0 if client, 1 if server
flags Bitwise OR of the flags to be set.
Returns
0 on success, -1 on error.
voidclear_default_proxy_file(intunlink_file)
Clears the env variable used by GSI to specify the proxy filename
Parametersunlink_file Set to 1 if you want to destroy the credential file as well
intclient_cgsi_plugin(structsoap*soap,structsoap_plugin*plugin,void*arg)
Client constructor for the cgsi_plugin
Parameterssoap The soap structure for the request
plugin Pointer to the plugin data structure
arg The parameters for the plugin creation (CGSI_OPT_CLIENT assumed)
Returns
0 if successful, -1 otherwise
intexport_delegated_credentials(structsoap*soap,char*filename)
Export the delegated credentials (if available) to a file
Parameterssoap The soap structure for the request
filename Name of the file where the credentials are to be written
Returns
0 if successful, -1 otherwise
char*get_client_ca(structsoap*soap)
Returns the client CA
Parameterssoap The soap structure for the request
Returns
The client CA is allocated in the soap structure (DON'T free), NULL otherwise
intget_client_dn(structsoap*soap,char*dn,size_tdnlen)
Gets the Distinguished name (DN) of the client
Parameterssoap The soap structure for the request
dn Pointer to a buffer where the DN is to be written
dnlen The length of the buffer
Returns
0 if successful, -1 otherwise
char**get_client_roles(structsoap*soap,int*nbfqans)
Returns the client VO roles if they were provided in the certificate
Parameterssoap The soap structure for the request
nbfqans The number of returned Fully Qualified Attribute Names
Returns
The client roles are malloced in the soap structure (DON'T free), NULL otherwise
intget_client_username(structsoap*soap,char*username,size_tdnlen)
Gets the username (DN) of the client
Parameterssoap The soap structure for the request
username Pointer to a buffer where the username is to be written
dnlen The length of the buffer
Returns
0 if successful, -1 otherwise
char*get_client_voname(structsoap*soap)
Returns the client VO name if it was provided in the certificate
Parameterssoap The soap structure for the request
Returns
The client voname is malloced in the soap structure (DON'T free), NULL otherwise
intget_delegated_credentials(structsoap*soap,void**buffer,size_t*length)
Make the delegated credential available as a token in memory. The soap structure retains ownership of the
memory. The user should not free the pointer returned by this function, nor use it after the soap object
becomes invalid.
Parameterssoap The soap structure that is the target of the request
buffer Pointer to a void pointer which will be set to reference the credential token.
length Pointer to a length that will be set to the size of the credential token
Returns
0 if successful, -1 otherwise
inthas_delegated_credentials(structsoap*soap)
Checks whether the client delegated credentials to the server
Parameterssoap The soap structure for the request
Returns
1 if there are some delegated credentials, 0 otherwise
intis_context_established(structsoap*soap)
Checks whether the security context has been established properly
Parameterssoap The soap structure for the request
Returns
1 if context established, 0 otherwise
intretrieve_userca_and_voms_creds(structsoap*soap)intretrieve_voms_creds(structsoap*soap)
Parses the optional VOMS extension of the peer certificate. It has to be called before
get_client_voname() and get_client_roles()!
Parameterssoap The soap structure for the request
Returns
0 if successful, -1 otherwise SOAP Fault structure contains the detailed description.
intserver_cgsi_plugin(structsoap*soap,structsoap_plugin*plugin,void*arg)
Server constructor for the cgsi_plugin
Parameterssoap The soap structure for the request
plugin Pointer to the plugin data structure
arg The parameters for the plugin creation (CGSI_OPT_SERVER assumed)
Returns
0 if successful, -1 otherwise
intset_default_proxy_file(structsoap*soap,char*filename)
Sets the env variable for GSI to use the proxy in the specified filename
Parameterssoap The soap structure for the request
filename Name of the file where credentials are stored
Returns
0 if successful, -1 otherwise
intsoap_cgsi_init(structsoap*soap,intcgsi_options)
Helper function to create the gsoap object and the cgsi_plugin at the same time. This function assumes
that a client plugin is specified, to create a server plugin, use the CGSI_OPT_SERVER option.
Parameterssoap The soap structure for the request
cgsi_options The parameters for the plugin creation (bitwise or of the different options).
Returns
0 if successful, -1 otherwise