.TH "globus_gss_assist.h" 3 "Tue Jul 5 2022" "Version 12.7" "globus_gss_assist" \" -*- nroff -*- .ad l .nh .SH NAME globus_gss_assist.h \- GSS Assist Header\&. .SH SYNOPSIS .br .PP \fC#include 'gssapi\&.h'\fP .br \fC#include \fP .br \fC#include \fP .br \fC#include 'globus_gss_assist_constants\&.h'\fP .br .SS "Macros" .in +1c .ti -1c .RI "#define \fBGLOBUS_GSI_GSS_ASSIST_MODULE\fP" .br .ti -1c .RI "#define \fBGlobusGssAssistFreeDNArray\fP(dn_a)" .br .RI "Free array of distinguished names\&. " .in -1c .SS "Functions" .in +1c .ti -1c .RI "int \fBglobus_gss_assist_token_get_fd\fP (void *arg, void **bufp, size_t *sizep)" .br .RI "Get token from a FILE *\&. " .ti -1c .RI "int \fBglobus_gss_assist_token_send_fd\fP (void *arg, void *buf, size_t size)" .br .RI "Send token via a FILE *\&. " .ti -1c .RI "int \fBglobus_gss_assist_token_send_fd_ex\fP (void *exp, void *buf, size_t size)" .br .RI "Send a token to a FILE *\&. " .ti -1c .RI "int \fBglobus_gss_assist_token_send_fd_without_length\fP (void *arg, void *buf, size_t size)" .br .RI "Send token to a FILE *\&. " .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_acquire_cred\fP (OM_uint32 *, gss_cred_usage_t, gss_cred_id_t *)" .br .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_read_vhost_cred_dir\fP (OM_uint32 *minor_status, const char *dir, gss_cred_id_t **output_credentials_array, size_t *output_credentials_array_size)" .br .RI "Acquire all GSSAPI credentials in a directory\&. " .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_acquire_cred_ext\fP (OM_uint32 *, char *, OM_uint32, const gss_OID_set, gss_cred_usage_t, gss_cred_id_t *, gss_OID_set *, OM_uint32 *)" .br .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_accept_sec_context\fP (OM_uint32 *, gss_ctx_id_t *, const gss_cred_id_t, char **, OM_uint32 *, int *, int *, gss_cred_id_t *, int(*get_token)(void *, void **, size_t *), void *get_context, int(*send_token)(void *, void *, size_t), void *send_context)" .br .RI "Accept a Security Context\&. " .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_accept_sec_context_async\fP (OM_uint32 *minor_status, gss_ctx_id_t *context_handle, const gss_cred_id_t cred_handle, char **src_name_char, OM_uint32 *ret_flags, int *user_to_user_flag, void *input_buffer, size_t input_buffer_len, void **output_bufferp, size_t *output_buffer_lenp, gss_cred_id_t *delegated_cred_handle)" .br .RI "Accept a Security Context Without Blocking\&. " .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_init_sec_context\fP (OM_uint32 *, const gss_cred_id_t, gss_ctx_id_t *, char *, OM_uint32, OM_uint32 *, int *, int(*get_token)(void *, void **, size_t *), void *get_arg, int(*send_token)(void *, void *, size_t), void *send_arg)" .br .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_init_sec_context_async\fP (OM_uint32 *minor_status, const gss_cred_id_t cred_handle, gss_ctx_id_t *context_handle, char *target_name_char, OM_uint32 req_flags, OM_uint32 *ret_flags, void *input_buffer, size_t input_buffer_len, void **output_bufferp, size_t *output_buffer_lenp)" .br .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_display_status\fP (FILE *, char *, OM_uint32, OM_uint32, int)" .br .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_display_status_str\fP (char **, char *, OM_uint32, OM_uint32, int)" .br .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_wrap_send\fP (OM_uint32 *minor_status, const gss_ctx_id_t context_handle, char *data, size_t length, int *token_status, int(*gss_assist_send_token)(void *, void *, size_t), void *gss_assist_send_context, FILE *fperr)" .br .RI "Wrap\&. " .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_get_unwrap\fP (OM_uint32 *minor_status, const gss_ctx_id_t context_handle, char **data, size_t *length, int *token_status, int(*gss_assist_get_token)(void *, void **, size_t *), void *gss_assist_get_context, FILE *fperr)" .br .RI "Get Unwrap\&. " .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_will_handle_restrictions\fP (OM_uint32 *minor_status, gss_ctx_id_t *context_handle)" .br .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_export_sec_context\fP (OM_uint32 *minor_status, gss_ctx_id_t *context_handle, int *token_status, int fdp, FILE *fperr)" .br .ti -1c .RI "OM_uint32 \fBglobus_gss_assist_import_sec_context\fP (OM_uint32 *minor_status, gss_ctx_id_t *context_handle, int *token_status, int fdp, FILE *fperr)" .br .ti -1c .RI "globus_result_t \fBglobus_gss_assist_authorization_host_name\fP (char *hostname, gss_name_t *authorization_hostname)" .br .ti -1c .RI "int \fBglobus_gss_assist_gridmap\fP (char *globusidp, char **useridp)" .br .RI "Look up the default mapping for a Grid identity in a gridmap file\&. " .ti -1c .RI "int \fBglobus_gss_assist_userok\fP (char *globusid, char *userid)" .br .RI "Gridmap entry existence check\&. " .ti -1c .RI "int \fBglobus_gss_assist_map_local_user\fP (char *local_user, char **globusidp)" .br .RI "Look up the default Grid identity associated with a local user name\&. " .ti -1c .RI "globus_result_t \fBglobus_gss_assist_lookup_all_globusid\fP (char *username, char **dns[], int *dn_count)" .br .RI "Look up all Grid IDs associated with a local user ID\&. " .ti -1c .RI "globus_result_t \fBglobus_gss_assist_map_and_authorize\fP (gss_ctx_id_t context, char *service, char *desired_identity, char *identity_buffer, unsigned int identity_buffer_length)" .br .RI "Authorize the peer of a security context to use a service\&. " .ti -1c .RI "globus_result_t \fBglobus_gss_assist_map_and_authorize_sharing\fP (char *shared_user_certificate, gss_ctx_id_t context, char *desired_identity, char *identity_buffer, unsigned int identity_buffer_length)" .br .RI "Authorize a particular credential for shared access\&. " .in -1c .SH "Detailed Description" .PP GSS Assist Header\&. .SH "Function Documentation" .PP .SS "globus_result_t globus_gss_assist_authorization_host_name (char * hostname, gss_name_t * authorization_hostname)" Create a GSS Name structure from the given hostname\&. This function tries to resolve the given host name string to the canonical DNS name for the host\&. .PP \fBParameters\fP .RS 4 \fIhostname\fP The host name or numerical address to be resolved and transform into a GSS Name .br \fIauthorization_hostname\fP The resulting GSS Name .RE .PP \fBReturns\fP .RS 4 GLOBUS_SUCCESS on successful completion, a error object otherwise .RE .PP .SS "OM_uint32 globus_gss_assist_wrap_send (OM_uint32 * minor_status, const gss_ctx_id_t context_handle, char * data, size_t length, int * token_status, int(*)(void *, void *, size_t) gss_assist_send_token, void * gss_assist_send_context, FILE * fperr)" .PP Wrap\&. .PP \fBParameters\fP .RS 4 \fIminor_status\fP GSSAPI return code\&. If the call was successful, the minor status is equal to GLOBUS_SUCCESS\&. Otherwise, it is an error object ID for which .br globus_error_get() and globus_object_free() can be used to get and destroy it\&. .br \fIcontext_handle\fP the context\&. .br \fIdata\fP pointer to application data to wrap and send .br \fIlength\fP length of the \fIdata\fP array .br \fItoken_status\fP assist routine get/send token status .br \fIgss_assist_send_token\fP a send_token routine .br \fIgss_assist_send_context\fP first arg for the send_token .br \fIfperr\fP file handle to write error message to\&. .RE .PP \fBReturns\fP .RS 4 GSS_S_COMPLETE on success Other GSSAPI errors on failure\&. .br .RE .PP \fBSee also\fP .RS 4 gss_wrap() .RE .PP .SH "Author" .PP Generated automatically by Doxygen for globus_gss_assist from the source code\&.