.TH "globus_gsi_proxy_operations" 3 "Tue Jul 5 2022" "Version 9.8" "globus_gsi_proxy_core" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gsi_proxy_operations \- Proxy Operations
.PP
 \- Initiate a proxy operation\&.  

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

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_create_req\fP (\fBglobus_gsi_proxy_handle_t\fP handle, BIO *output_bio)"
.br
.RI "Create a proxy credential request\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_inquire_req\fP (\fBglobus_gsi_proxy_handle_t\fP handle, BIO *input_bio)"
.br
.RI "Inquire a proxy credential request\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_resign_cert\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t issuer_credential, globus_gsi_cred_handle_t peer_credential, globus_gsi_cred_handle_t *resigned_credential)"
.br
.RI "Resign an existing certificate into a proxy\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_sign_req\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t issuer_credential, BIO *output_bio)"
.br
.RI "Sign a proxy certificate request\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_create_signed\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t issuer, globus_gsi_cred_handle_t *proxy_credential)"
.br
.RI "Create Signed Proxy Certificate\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_proxy_assemble_cred\fP (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t *proxy_credential, BIO *input_bio)"
.br
.RI "Assemble a proxy credential\&. "
.in -1c
.SH "Detailed Description"
.PP 
Initiate a proxy operation\&. 

This module contains the API functions for a user to request proxy request generation, proxy request inspection and proxy request signature\&. 
.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_gsi_proxy_assemble_cred (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t * proxy_credential, BIO * input_bio)"

.PP
Assemble a proxy credential\&. This function assembles a proxy credential\&. It reads a signed proxy certificate and a associated certificate chain from the input_bio and combines them with a private key previously generated by a call to \fBglobus_gsi_proxy_create_req()\fP\&. The resulting credential is then returned through the proxy_credential parameter\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP A GSI Proxy handle to use for the assemble operation\&. 
.br
\fIproxy_credential\fP This parameter will contain the assembled credential upon successful return\&. 
.br
\fIinput_bio\fP A BIO to read a signed certificate and corresponding certificate chain from\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS if no error occurred, an error object ID otherwise 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_create_req (\fBglobus_gsi_proxy_handle_t\fP handle, BIO * output_bio)"

.PP
Create a proxy credential request\&. This function creates a proxy credential request, an unsigned certificate and the corresponding private key, based on the handle that is passed in\&.
.PP
The public part of the request is written to the BIO supplied in the output_bio parameter\&. After the request is written, the PROXYCERTINFO extension contained in the handle is written to the BIO\&.
.PP
The proxy handle is updated with the private key\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP A GSI Proxy handle to use for the request operation\&. 
.br
\fIoutput_bio\fP A BIO to write the resulting request structure to\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_create_signed (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t issuer, globus_gsi_cred_handle_t * proxy_credential)"

.PP
Create Signed Proxy Certificate\&. 
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP The proxy handle used to create and sign the proxy certificate 
.br
\fIissuer\fP The issuing credential, used for signing the proxy certificate 
.br
\fIproxy_credential\fP The new proxy credential, containing the signed cert, private key, etc\&.
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS if no error occurred, an error object ID otherwise 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_inquire_req (\fBglobus_gsi_proxy_handle_t\fP handle, BIO * input_bio)"

.PP
Inquire a proxy credential request\&. This function reads the public part of a proxy credential request from input_bio and if the request contains a ProxyCertInfo extension, updates the handle with the information contained in the extension\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP A GSI Proxy handle to use for the inquire operation\&. 
.br
\fIinput_bio\fP A BIO to read a request structure from\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_resign_cert (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t issuer_credential, globus_gsi_cred_handle_t peer_credential, globus_gsi_cred_handle_t * resigned_credential)"

.PP
Resign an existing certificate into a proxy\&. This function use the public key in a existing certificate to create a new proxy certificate chained to the issuers credentials\&. This operation will add a ProxyCertInfo extension to the proxy certificate if values contained in the extension are specified in the handle\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP A GSI Proxy handle to use for the signing operation\&. 
.br
\fIissuer_credential\fP The credential structure to be used for signing the proxy certificate\&. 
.br
\fIpeer_credential\fP The credential structure that contains the certificate to be resigned\&. 
.br
\fIresigned_credential\fP A credential structure that upon return will contain the resigned certificate and associated certificate chain\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_proxy_sign_req (\fBglobus_gsi_proxy_handle_t\fP handle, globus_gsi_cred_handle_t issuer_credential, BIO * output_bio)"

.PP
Sign a proxy certificate request\&. This function signs the public part of a proxy credential request, i\&.e\&. the unsigned certificate, previously read by \fBglobus_gsi_proxy_inquire_req()\fP using the supplied issuer_credential\&. This operation will add a ProxyCertInfo extension to the proxy certificate if values contained in the extension are specified in the handle\&. The resulting signed certificate is written to the output_bio\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP A GSI Proxy handle to use for the signing operation\&. 
.br
\fIissuer_credential\fP The credential structure to be used for signing the proxy certificate\&. 
.br
\fIoutput_bio\fP A BIO to write the resulting certificate to\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless an error occurred, in which case, a globus error object ID is returned 
.RE
.PP

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