.TH "globus_gss_assist_credential" 3 "Wed Feb 27 2019" "Version 12.2" "globus_gss_assist" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gss_assist_credential \- Acquire Credential\&.  

.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "OM_uint32 \fBglobus_gss_assist_acquire_cred\fP (OM_uint32 *minor_status, gss_cred_usage_t cred_usage, gss_cred_id_t *output_cred_handle)"
.br
.ti -1c
.RI "OM_uint32 \fBglobus_gss_assist_acquire_cred_ext\fP (OM_uint32 *minor_status, char *desired_name_char, OM_uint32 time_req, const gss_OID_set desired_mechs, gss_cred_usage_t cred_usage, gss_cred_id_t *output_cred_handle, gss_OID_set *actual_mechs, OM_uint32 *time_rec)"
.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\&. "
.in -1c
.SH "Detailed Description"
.PP 
Acquire Credential\&. 

The functions in this section are used to acquire security credentials\&. 
.SH "Function Documentation"
.PP 
.SS "OM_uint32 globus_gss_assist_acquire_cred (OM_uint32 * minor_status, gss_cred_usage_t cred_usage, gss_cred_id_t * output_cred_handle)"
Called once at the start of the process, to obtain the credentials the process is running under\&. The
.PP
\fBParameters:\fP
.RS 4
\fIminor_status\fP pointer for return code 
.br
\fIcred_usage\fP GSS_C_INITIATE, GSS_C_ACCEPT, or GSS_C_BOTH 
.br
\fIoutput_cred_handle\fP Pointer to the returned handle\&. This needs to be passed to many gss routines\&.
.RE
.PP
\fBReturns:\fP
.RS 4
GSS_S_COMPLETE on success Other GSSAPI return codes 
.RE
.PP

.SS "OM_uint32 globus_gss_assist_acquire_cred_ext (OM_uint32 * minor_status, char * desired_name_char, OM_uint32 time_req, const gss_OID_set desired_mechs, gss_cred_usage_t cred_usage, gss_cred_id_t * output_cred_handle, gss_OID_set * actual_mechs, OM_uint32 * time_rec)"
Called once at the start of the process, to obtain the credentials the process is running under\&. All the parameters of the gss_acquire_cred(), except the desired_name is a string of the form: [type:]name\&. This will be imported with the type\&.
.PP
\fBReturns:\fP
.RS 4
GSS_S_COMPLETE on success Other GSSPI return codes
.RE
.PP
\fBSee also:\fP
.RS 4
globus_gss_acquire_cred 
.RE
.PP

.SS "OM_uint32 globus_gss_assist_read_vhost_cred_dir (OM_uint32 * minor_status, const char * dir, gss_cred_id_t ** output_credentials_array, size_t * output_credentials_array_size)"

.PP
Acquire all GSSAPI credentials in a directory\&. This function loads all of the credentials available in the vhost credential directory and returns them in its output parameters\&.
.PP
The credentials directory is expected to contain a directory for each credential, with the directory containing cert\&.pem and privkey\&.pem files\&.
.PP
If the dir parameter is NULL, then this function uses the \fCX509_VHOST_CRED_DIR\fP environment variable, or the default \fC/etc/grid-security/vhosts/\fP if it is not set\&. 
.PP
\fBParameters:\fP
.RS 4
\fIminor_status\fP Mechanism-specific error code 
.br
\fIdir\fP Optional directory name to override X509_VHOST_CRED_DIR 
.br
\fIoutput_credentials_array\fP Pointer to a dynamic array allocated to hold credentials 
.br
\fIoutput_credentials_array_size\fP Pointer to be set to the resulting size (in bytes) of the output_credentials_array 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus_gss_assist from the source code\&.