globus_gram_client_attr(3) | Library Functions Manual | globus_gram_client_attr(3) |
NAME¶
globus_gram_client_attr - GRAM Client Attribute Functions
- GRAM Client Attribute Functions.
SYNOPSIS¶
Macros¶
#define GLOBUS_GRAM_CLIENT_NO_ATTR
Default GRAM client operation attribute.
Typedefs¶
typedef void * globus_gram_client_attr_t
GRAM client operation attribute.
Functions¶
int globus_gram_client_attr_init
(globus_gram_client_attr_t *attr)
Initialize a GRAM client attribute. int globus_gram_client_attr_destroy
(globus_gram_client_attr_t *attr)
Destroy a GRAM client attribute. int
globus_gram_client_attr_set_credential
(globus_gram_client_attr_t attr, gss_cred_id_t credential)
Set a GRAM client attribute's security credential. int
globus_gram_client_attr_get_credential
(globus_gram_client_attr_t attr, gss_cred_id_t *credential)
Get a GRAM client attribute's security credential. int
globus_gram_client_attr_set_delegation_mode
(globus_gram_client_attr_t attr, globus_io_secure_delegation_mode_t
mode)
Set a GRAM client attribute's delegation mode. int
globus_gram_client_attr_get_delegation_mode
(globus_gram_client_attr_t attr, globus_io_secure_delegation_mode_t
*mode)
Get a GRAM client attribute's security credential.
Detailed Description¶
GRAM Client Attribute Functions.
Macro Definition Documentation¶
#define GLOBUS_GRAM_CLIENT_NO_ATTR¶
Default GRAM client operation attribute. The GLOBUS_GRAM_CLIENT_NO_ATTR macro defines a constant for use when a user of the GRAM client API does not want to specify any non-default GRAM attributes.
Typedef Documentation¶
typedef void* globus_gram_client_attr_t¶
GRAM client operation attribute. The globus_gram_client_attr_t type is an opaque type describing GRAM attributes. It can be accessed or modified by functions in the GRAM Client Attribute Functions documentation.
Function Documentation¶
int globus_gram_client_attr_destroy (globus_gram_client_attr_t * attr)¶
Destroy a GRAM client attribute. The globus_gram_client_attr_destroy() function destroys and frees a GRAM client attribute. After this function returns, the value pointed to by attr is no longer valid and must not be used.
Parameters
Returns
Return values
GLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR Invalid attribute
See also
int globus_gram_client_attr_get_credential (globus_gram_client_attr_t attr, gss_cred_id_t * credential)¶
Get a GRAM client attribute's security credential. The globus_gram_client_attr_get_credential() function gets the value of the credential in an attribute and modifies the credential parameter to point to it. This is a shallow copy.
Parameters
credential An output parameter that will be initialized to point to the GSSAPI credential which the attr is currently using.
Returns
Return values
GLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR Invalid attribute
GLOBUS_GRAM_PROTOCOL_ERROR_NULL_PARAMETER Null parameter
See also
int globus_gram_client_attr_get_delegation_mode (globus_gram_client_attr_t attr, globus_io_secure_delegation_mode_t * mode)¶
Get a GRAM client attribute's security credential. The globus_gram_client_attr_get_delegation_mode() function gets the value of the delegation_mode in an attribute and modifies the mode parameter to point to its value.
Parameters
mode An output parameter that will be set to point to the delegation mode which the attr is currently using.
Returns
Return values
GLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR Invalid attribute
GLOBUS_GRAM_PROTOCOL_ERROR_NULL_PARAMETER Null parameter
See also
int globus_gram_client_attr_init (globus_gram_client_attr_t * attr)¶
Initialize a GRAM client attribute. The globus_gram_client_attr_init() function creates a new opaque structure that can be used to specify custom attributes for performing GRAM client operations.
Parameters
Returns
Return values
GLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR Invalid attribute
GLOBUS_GRAM_PROTOCOL_ERROR_MALLOC_FAILED Out of memory
See also
int globus_gram_client_attr_set_credential (globus_gram_client_attr_t attr, gss_cred_id_t credential)¶
Set a GRAM client attribute's security credential. The globus_gram_client_attr_set_credential() function sets the value of the credential in an attribute to the GSSAPI credential named by the credential parameter. This is done as a shallow copy, so the value of credential must not be freed until the attribute will no longer be used.
Parameters
credential The GSSAPI credential to use with the attribute named by the attr parameter. This may be GSS_C_NO_CREDENTIAL to set the attribute to use the default security credential.
Returns
Return values
See also
int globus_gram_client_attr_set_delegation_mode (globus_gram_client_attr_t attr, globus_io_secure_delegation_mode_t mode)¶
Set a GRAM client attribute's delegation mode. The globus_gram_client_attr_set_delegation_mode() function sets the value of the delegation_mode in an attribute to the delegation mode in the mode parameter.
The GRAM client supports the following delegation modes:
- GLOBUS_IO_SECURE_DELEGATION_MODE_LIMITED_PROXY
- GLOBUS_IO_SECURE_DELEGATION_MODE_FULL_PROXY
Parameters
mode The new value of the delegation mode.
Returns
Return values
GLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR Invalid attribute
See also
Author¶
Generated automatically by Doxygen for globus_gram_client from the source code.
Version 14.6 | globus_gram_client |