Main Page   Modules  

Attributes and Cntls
[Globus XIO GSI Driver]

Enumerations

Functions


Detailed Description

GSI driver specific attrs and cntls.

See also:
globus_xio_attr_cntl() , globus_xio_handle_cntl()

Enumeration Type Documentation

enum globus_xio_gsi_cmd_t
 

GSI driver specific cntls.

Enumeration values:
GLOBUS_XIO_GSI_SET_CREDENTIAL  See usage for: globus_xio_attr_cntl, globus_xio_handle_cntl.
GLOBUS_XIO_GSI_GET_CREDENTIAL  See usage for: globus_xio_attr_cntl, globus_xio_handle_cntl.
GLOBUS_XIO_GSI_SET_GSSAPI_REQ_FLAGS  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_GET_GSSAPI_REQ_FLAGS  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_SET_PROXY_MODE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_GET_PROXY_MODE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_SET_AUTHORIZATION_MODE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_GET_AUTHORIZATION_MODE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_SET_DELEGATION_MODE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_GET_DELEGATION_MODE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_SET_SSL_COMPATIBLE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_SET_ANON  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_SET_WRAP_MODE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_GET_WRAP_MODE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_SET_BUFFER_SIZE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_GET_BUFFER_SIZE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_SET_PROTECTION_LEVEL  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_GET_PROTECTION_LEVEL  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_GET_TARGET_NAME  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_SET_TARGET_NAME  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_GSI_GET_CONTEXT  See usage for: globus_xio_handle_cntl.
GLOBUS_XIO_GSI_GET_DELEGATED_CRED  See usage for: globus_xio_handle_cntl.
GLOBUS_XIO_GSI_GET_PEER_NAME  See usage for: globus_xio_handle_cntl.
GLOBUS_XIO_GSI_GET_LOCAL_NAME  See usage for: globus_xio_handle_cntl.
GLOBUS_XIO_GSI_INIT_DELEGATION  See usage for: globus_xio_handle_cntl.
GLOBUS_XIO_GSI_REGISTER_INIT_DELEGATION  See usage for: globus_xio_handle_cntl.
GLOBUS_XIO_GSI_ACCEPT_DELEGATION  See usage for: globus_xio_handle_cntl.
GLOBUS_XIO_GSI_REGISTER_ACCEPT_DELEGATION  See usage for: globus_xio_handle_cntl.
GLOBUS_XIO_GSI_FORCE_SERVER_MODE  See usage for: globus_xio_attr_cntl.


Function Documentation

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_SET_CREDENTIAL   ,
gss_cred_id_t    credential
 

Set the credential to be used.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
credential  The credential to set. The credential structure needs to remain valid for the lifetime of any xio datastructure it is used by.
Note:
If this is called with the handle_cntl, there must be no outstanding operations on the handle.

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_GSI_SET_CREDENTIAL   ,
gss_cred_id_t    credential
 

Set the credential to be used.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
credential  The credential to set. The credential structure needs to remain valid for the lifetime of any xio datastructure it is used by.
Note:
If this is called with the handle_cntl, there must be no outstanding operations on the handle.

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_GET_CREDENTIAL   ,
gss_cred_id_t *    credential
 

Get the credential to be used.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
credential  The credential that is currently set. This will only return a credential if a credential was explicitly set prior to this call. It will not return any credential automatically acquired during context initizalization.

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_GSI_GET_CREDENTIAL   ,
gss_cred_id_t *    credential
 

Get the credential to be used.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
credential  The credential that is currently set. This will only return a credential if a credential was explicitly set prior to this call. It will not return any credential automatically acquired during context initizalization.

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_SET_GSSAPI_REQ_FLAGS   ,
OM_uint32    req_flags
 

Set the GSSAPI req_flags to be used.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
req_flags  The req_flags to set

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_GET_GSSAPI_REQ_FLAGS   ,
OM_uint32 *    req_flags
 

Get the GSSAPI req_flags to be used.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
req_flags  The req flags currently in effect

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_SET_PROXY_MODE   ,
globus_xio_gsi_proxy_mode_t    proxy_mode
 

Set the proxy mode.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
proxy_mode  The proxy mode to set
Note:
Changing the proxy mode changes the req_flags

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_GET_PROXY_MODE   ,
globus_xio_gsi_proxy_mode_t   proxy_mode
 

Get the proxy mode.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
proxy_mode  The proxy mode that is currently in effect
Note:
Changing the proxy mode changes the req_flags

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_SET_AUTHORIZATION_MODE   ,
globus_xio_gsi_authorization_mode_t    authz_mode
 

Set the authorization mode.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
authz_mode  The authorization mode to set

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_GET_AUTHORIZATION_MODE   ,
globus_xio_gsi_authorization_mode_t   authz_mode
 

Get the authorization mode.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
authz_mode  The authorization mode that is currently in effect

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_SET_DELEGATION_MODE   ,
globus_xio_gsi_delegation_mode_t    delegation_mode
 

Set the delegation mode.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
delegation_mode  The delegation mode to use
Note:
Changing the delegation mode changes the req_flags

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_GET_DELEGATION_MODE   ,
globus_xio_gsi_delegation_mode_t   delegation_mode
 

Get the delegation mode.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
delegation_mode  The delegation mode currently in effect

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_SET_WRAP_MODE   ,
globus_boolean_t    wrap_mode
 

Set the wrapping mode.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

This mode determines whether tokens will be wrapped with a Globus IO style header or not.

Parameters:
wrap_mode  The wrapping mode to use

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_GET_WRAP_MODE   ,
globus_boolean_t *    wrap_mode
 

Get the wrapping mode.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

This mode determines whether tokens will be wrapped with a Globus IO style header or not.

Parameters:
wrap_mode  The wrapping mode currently in use.

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_SET_BUFFER_SIZE   ,
globus_size_t    buffer_size
 

Set the read buffer size.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

The read buffer is used for buffering wrapped data, is initialized with a default size of 128K and scaled dynamically to always be able to fit whole tokens.

Parameters:
buffer_size  The size of the read buffer

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_GET_BUFFER_SIZE   ,
globus_size_t *    buffer_size
 

Get the read buffer size.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

The read buffer is used for buffering wrapped data, is initialized with a default size of 128K and scaled dynamically to always be able to fit whole tokens.

Parameters:
buffer_size  The size of the read buffer

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_SET_PROTECTION_LEVEL   ,
globus_xio_gsi_protection_level_t    protection_level
 

Set the protection level.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
protection_level  The protection level to set
Note:
Changing the proxy mode changes the req_flags

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_GET_PROTECTION_LEVEL   ,
globus_xio_gsi_protection_level_t   protection_level
 

Get the protection level.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
protection_level  The current protection level

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_GET_TARGET_NAME   ,
gss_name_t *    target_name
 

Set the expected peer name.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
target_name  The expected peer name

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_GSI_SET_TARGET_NAME   ,
gss_name_t    target_name
 

Get the expected peer name.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
target_name  The expected peer name

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_GSI_GET_CONTEXT   ,
gss_ctx_id_t *    context
 

Get the GSS context.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
context  The GSS context

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_GSI_GET_PEER_NAME   ,
gss_name_t *    peer_name
 

Get the name of the peer.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
peer_name  The GSS name of the peer.

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_GSI_INIT_DELEGATION   ,
gss_cred_id_t    credential,
gss_OID_set    restriction_oids,
gss_buffer_set_t    restriction_buffers,
OM_uint32    time_req
 

Initialize delegation-at-any-time process.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
credential  The GSS credential to delegate
restriction_oids  The OIDS for X.509 extensions to embed in the delegated credential
restriction_buffers  The corresponding bodies for the X.509 extensions
time_req  The lifetime of the delegated credential

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_GSI_REGISTER_INIT_DELEGATION   ,
gss_cred_id_t    credential,
gss_OID_set    restriction_oids,
gss_buffer_set_t    restriction_buffers,
OM_uint32    time_req,
globus_xio_gsi_delegation_init_callback_t    callback,
void *    callback_arg
 

Initialize non-blocking delegation-at-any-time process.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
credential  The GSS credential to delegate
restriction_oids  The OIDS for X.509 extensions to embed in the delegated credential
restriction_buffers  The corresponding bodies for the X.509 extensions
time_req  The lifetime of the delegated credential
callback  The callback to call when the operation completes
callback_arg  The arguments to pass to the callback

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_GSI_ACCEPT_DELEGATION   ,
gss_cred_id_t *    credential,
gss_OID_set    restriction_oids,
gss_buffer_set_t    restriction_buffers,
OM_uint32    time_req
 

Accept delegation-at-any-time process.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
credential  The delegated GSS credential
restriction_oids  The OIDS for X.509 extensions to embed in the delegated credential
restriction_buffers  The corresponding bodies for the X.509 extensions
time_req  The requested lifetime of the delegated credential

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_GSI_REGISTER_ACCEPT_DELEGATION   ,
gss_OID_set    restriction_oids,
gss_buffer_set_t    restriction_buffers,
OM_uint32    time_req,
globus_xio_gsi_delegation_accept_callback_t    callback,
void *    callback_arg
 

Accept non-blocking delegation-at-any-time process.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
restriction_oids  The OIDS for X.509 extensions to embed in the delegated credential
restriction_buffers  The corresponding bodies for the X.509 extensions
time_req  The lifetime of the delegated credential
callback  The callback to call when the operation completes
callback_arg  The arguments to pass to the callback


about globus | globus toolkit | dev.globus

Comments? webmaster@globus.org