.TH "globus_gsi_credential.h" 3 "Wed Feb 27 2019" "Version 8.1" "globus_gsi_credential" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gsi_credential.h \- Globus GSI Credential Library\&.  

.SH SYNOPSIS
.br
.PP
\fC#include 'globus_common\&.h'\fP
.br
\fC#include 'globus_error_openssl\&.h'\fP
.br
\fC#include 'globus_gsi_cred_constants\&.h'\fP
.br
\fC#include 'globus_gsi_callback\&.h'\fP
.br
\fC#include 'globus_gsi_cert_utils\&.h'\fP
.br
\fC#include 'openssl/x509\&.h'\fP
.br
\fC#include 'openssl/bio\&.h'\fP
.br
\fC#include 'openssl/ssl\&.h'\fP
.br
\fC#include 'globus_error_generic\&.h'\fP
.br

.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_GSI_CREDENTIAL_MODULE\fP"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef struct globus_l_gsi_cred_handle_s * \fBglobus_gsi_cred_handle_t\fP"
.br
.ti -1c
.RI "typedef struct globus_l_gsi_cred_handle_attrs_s * \fBglobus_gsi_cred_handle_attrs_t\fP"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_init\fP (\fBglobus_gsi_cred_handle_t\fP *handle, \fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs)"
.br
.RI "Initialize a Handle\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_destroy\fP (\fBglobus_gsi_cred_handle_t\fP handle)"
.br
.RI "Destroy the credential handle\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_copy\fP (\fBglobus_gsi_cred_handle_t\fP source, \fBglobus_gsi_cred_handle_t\fP *dest)"
.br
.RI "Copy a handle\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_attrs_init\fP (\fBglobus_gsi_cred_handle_attrs_t\fP *handle_attrs)"
.br
.RI "Initialize credential handle attributes\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_attrs_destroy\fP (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs)"
.br
.RI "Destroy credential handle attributes\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_attrs_copy\fP (\fBglobus_gsi_cred_handle_attrs_t\fP source, \fBglobus_gsi_cred_handle_attrs_t\fP *dest)"
.br
.RI "Copy credential handle attributes\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_read\fP (\fBglobus_gsi_cred_handle_t\fP handle, X509_NAME *desired_subject)"
.br
.RI "Read a credential\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_read_proxy\fP (\fBglobus_gsi_cred_handle_t\fP handle, const char *proxy_filename)"
.br
.RI "Read proxy credential\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_read_proxy_bio\fP (\fBglobus_gsi_cred_handle_t\fP handle, BIO *bio)"
.br
.RI "Read proxy credential from a BIO\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_read_key\fP (\fBglobus_gsi_cred_handle_t\fP handle, const char *key_filename, int(*pw_cb)())"
.br
.RI "Read a private key\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_read_cert\fP (\fBglobus_gsi_cred_handle_t\fP handle, const char *cert_filename)"
.br
.RI "Read a certificate chain from a file\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_read_cert_bio\fP (\fBglobus_gsi_cred_handle_t\fP handle, BIO *bio)"
.br
.RI "Read a certificate chain from a BIO\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_read_cert_buffer\fP (const char *pem_buf, \fBglobus_gsi_cred_handle_t\fP *out_handle, X509 **out_cert, STACK_OF(X509) **out_cert_chain, char **out_subject)"
.br
.RI "Read certificate chain from a buffer\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_read_pkcs12\fP (\fBglobus_gsi_cred_handle_t\fP handle, const char *pkcs12_filename)"
.br
.RI "Read certificate and key from a PKCS12 file\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_write\fP (\fBglobus_gsi_cred_handle_t\fP handle, BIO *bio)"
.br
.RI "Write Credential\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_write_proxy\fP (\fBglobus_gsi_cred_handle_t\fP handle, const char *proxy_filename)"
.br
.RI "Write a proxy credential\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_verify_cert_chain\fP (\fBglobus_gsi_cred_handle_t\fP cred_handle, globus_gsi_callback_data_t callback_data)"
.br
.RI "Verify credential\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_verify_cert_chain_when\fP (\fBglobus_gsi_cred_handle_t\fP cred_handle, globus_gsi_callback_data_t callback_data, time_t check_time)"
.br
.RI "Verify credential at a specific time\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_verify\fP (\fBglobus_gsi_cred_handle_t\fP handle)"
.br
.RI "Verify a credential\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_X509_subject_name\fP (\fBglobus_gsi_cred_handle_t\fP handle, X509_NAME **subject_name)"
.br
.RI "Get credential subject name\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_subject_name\fP (\fBglobus_gsi_cred_handle_t\fP handle, char **subject_name)"
.br
.RI "Get credential subject name\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_policies\fP (\fBglobus_gsi_cred_handle_t\fP handle, STACK_OF(OPENSSL_STRING) **policies)"
.br
.RI "Get certificate chain policies\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_policy_languages\fP (\fBglobus_gsi_cred_handle_t\fP handle, STACK_OF(ASN1_OBJECT) **languages)"
.br
.RI "Get certificate chain policy languages\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_X509_issuer_name\fP (\fBglobus_gsi_cred_handle_t\fP handle, X509_NAME **issuer_name)"
.br
.RI "Get credential issuer name object\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_issuer_name\fP (\fBglobus_gsi_cred_handle_t\fP handle, char **issuer_name)"
.br
.RI "Get issuer name\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_X509_identity_name\fP (\fBglobus_gsi_cred_handle_t\fP handle, X509_NAME **identity_name)"
.br
.RI "Get X\&.509 identity\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_identity_name\fP (\fBglobus_gsi_cred_handle_t\fP handle, char **identity_name)"
.br
.RI "Get identity name\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_set_cert\fP (\fBglobus_gsi_cred_handle_t\fP handle, X509 *cert)"
.br
.RI "Set the credential's certificate\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_set_key\fP (\fBglobus_gsi_cred_handle_t\fP handle, EVP_PKEY *key)"
.br
.RI "Set the credential's private key\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_set_cert_chain\fP (\fBglobus_gsi_cred_handle_t\fP handle, STACK_OF(X509) *cert_chain)"
.br
.RI "Set the certificate chain\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_cert\fP (\fBglobus_gsi_cred_handle_t\fP handle, X509 **cert)"
.br
.RI "Get the credential's certificate\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_key\fP (\fBglobus_gsi_cred_handle_t\fP handle, EVP_PKEY **key)"
.br
.RI "Get the credential's private key\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_cert_chain\fP (\fBglobus_gsi_cred_handle_t\fP handle, STACK_OF(X509) **cert_chain)"
.br
.RI "Get the certificate chain\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_handle_attrs\fP (\fBglobus_gsi_cred_handle_t\fP handle, \fBglobus_gsi_cred_handle_attrs_t\fP *handle_attrs)"
.br
.RI "Get the handle attributes\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_lifetime\fP (\fBglobus_gsi_cred_handle_t\fP handle, time_t *lifetime)"
.br
.RI "Get credential lifetime\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_goodtill\fP (\fBglobus_gsi_cred_handle_t\fP handle, time_t *goodtill)"
.br
.RI "Get credential expiration\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_cert_type\fP (\fBglobus_gsi_cred_handle_t\fP handle, globus_gsi_cert_utils_cert_type_t *type)"
.br
.RI "Get the X\&.509 certificate type\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_get_key_bits\fP (\fBglobus_gsi_cred_handle_t\fP handle, int *key_bits)"
.br
.RI "Get credential strength\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_attrs_set_search_order\fP (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs, \fBglobus_gsi_cred_type_t\fP search_order[])"
.br
.RI "Set the search order\&. "
.in -1c
.SH "Detailed Description"
.PP 
Globus GSI Credential Library\&. 


.PP
\fBAuthor:\fP
.RS 4
Sam Lang, Sam Meder 
.RE
.PP

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