Credential Handle Management
Create/Destroy/Modify a GSI Credential Handle.
More...Initializing and Destroying a Handle
Copying a Handle
Getting the Handle Attributes
Getting the Credential Expiration
Getting the Credential Lifetime
Getting the Credential Strength
Setting and Getting the Certificate
Setting and Getting the Credential Key
Setting and Getting the Certificate Chain
Get Cred Cert X509 Subject Name object
Get X509 Identity Name
Get Cred Cert Subject Name
Get Policies from Cert Chain
Get Policy Languages from Cert Chain
Get Cred Cert X509 Issuer Name object
Get Issuer Name
Get Identity Name
Credential validation functions
Typedefs
Detailed Description
Create/Destroy/Modify a GSI Credential Handle.
Within the Globus GSI Credential Library, all credential operations require a handle parameter. Currenlty only one operation may be in progress at once per credential handle.
This section defines operations to create, modify and destroy GSI Credential handles.
Typedef Documentation
Function Documentation
|
Initializes a credential handle to be used credential handling functions. Takes a set of handle attributes that are immutable to the handle. The handle attributes are only pointed to by the handle, so the lifetime of the attributes needs to be as long as that of the handle.
- Parameters:
-
handle | The handle to be initialized |
handle_attrs | The immutable attributes of the handle |
- Returns:
- GLOBUS_SUCCESS or an error captured in a globus_result_t
|
|
Destroys the credential handle.
- Parameters:
-
handle | The credential handle to be destroyed |
- Returns:
- GLOBUS_SUCCESS
|
|
Copies a credential handle.
- Parameters:
-
source | The handle to be copied |
dest | The destination of the copy |
- Returns:
- GLOBUS_SUCCESS or an error captured in a globus_result_t
|
|
This function retreives a copy of the credential handle attributes
- Parameters:
-
handle | The credential handle to retrieve the attributes from |
attrs | Contains the credential attributes on return |
- Returns:
- GLOBUS_SUCCESS or an error captured in a globus_result_t
|
|
This function retreives the expiration time of the credential contained in the handle
- Parameters:
-
cred_handle | The credential handle to retrieve the expiration time from |
goodtill | Contains the expiration time on return |
- Returns:
- GLOBUS_SUCCESS or an error captured in a globus_result_t
|
|
This function retreives the lifetime of the credential contained in a handle
- Parameters:
-
cred_handle | The credential handle to retrieve the lifetime from |
lifetime | Contains the lifetime on return |
- Returns:
- GLOBUS_SUCCESS or an error captured in a globus_result_t
|
|
This function retreives the key strength of the credential contained in a handle
- Parameters:
-
cred_handle | The credential handle to retrieve the strength from |
key_bits | Contains the number of bits in the key on return |
- Returns:
- GLOBUS_SUCCESS or an error captured in a globus_result_t
|
|
Set the Credential's Certificate. The X509 cert that is passed in should be a valid X509 certificate object
- Parameters:
-
handle | The credential handle to set the certificate on |
cert | The X509 cert to set in the cred handle. The cert passed in can be NULL which will set the cert in the handle to NULL, freeing the current cert in the handle. |
- Returns:
- GLOBUS_SUCCESS or an error object id if an error
|
|
Get the certificate of a credential
- Parameters:
-
handle | The credential handle to get the certificate from |
cert | The resulting X509 certificate, a duplicate of the certificate in the credential handle. This variable should be freed when the user is finished with it using the function X509_free. |
- Returns:
- GLOBUS_SUCCESS if no error, otherwise an error object id is returned
|
|
Set the private key of the credential handle
- Parameters:
-
handle | The handle on which to set the key. |
key | The private key to set the handle's key to. This value can be NULL, in which case the current handle's key is freed. |
|
|
Get the credential handle's private key.
- Parameters:
-
handle | The credential handle containing the private key to get |
key | The private key which after this function returns is set to a duplicate of the private key of the credential handle. This variable needs to be freed by the user when it is no longer used via the function EVP_PKEY_free. |
- Returns:
- GLOBUS_SUCCESS or an error object identifier
|
|
Set the certificate chain of the credential handle
- Parameters:
-
handle | The handle containing the certificate chain field to set |
cert_chain | The certificate chain to set the handle's certificate chain to |
- Returns:
- GLOBUS_SUCCESS if no error, otherwise an error object id is returned
|
|
Get the certificate chain of the credential handle.
- Parameters:
-
handle | The credential handle containing the certificate chain to get |
cert_chain | The certificate chain to set as a duplicate of the cert chain in the credential handle. This variable (or the variable it points to) needs to be freed when the user is finished with it using sk_X509_free. |
- Returns:
- GLOBUS_SUCCESS if no error, otherwise an error object id is returned
|
|
Get the credential handle's certificate subject name
- Parameters:
-
handle | The credential handle containing the certificate to get the subject name of |
subject_name | The subject name as an X509_NAME object. This should be freed using X509_NAME_free when the user is finished with it |
- Returns:
- GLOBUS_SUCCESS if no error, a error object id otherwise
|
|
Get the identity's X509 subject name from the credential handle
- Parameters:
-
handle | The credential handle containing the certificate to get the identity from |
identity_name | The identity certificate's X509 subject name |
- Returns:
- GLOBUS_SUCCESS if no error, otherwise an error object identifier is returned
|
|
Get the credential handle's certificate subject name
- Parameters:
-
handle | The credential handle containing the certificate to get the subject name of |
subject_name | The subject name as a string. This should be freed using free() when the user is finished with it |
- Returns:
- GLOBUS_SUCCESS if no error, a error object id otherwise
|
|
Get the Policies from the Cert Chain in the handle. The policies will be null-terminated as they are added to the handle. If a policy for a cert in the chain doesn't exist, the string in the stack will be set to the static string GLOBUS_NULL_POLICIES
- Parameters:
-
handle | the handle to get the cert chain containing the policies |
policies | the stack of policies retrieved from the handle's cert chain |
- Returns:
- GLOBUS_SUCCESS or an error object if an error occurred
|
globus_result_t globus_gsi_cred_get_policy_languages |
( |
globus_gsi_cred_handle_t |
handle, |
|
|
STACK_OF(ASN1_OBJECT)** |
policy_languages |
|
) |
|
|
|
Get the policy languages from the cert chain in the handle.
- Parameters:
-
handle | the handle to get the cert chain containing the policies |
policy_languages | the stack of policies retrieved from the handle's cert chain |
- Returns:
- GLOBUS_SUCCESS or an error object if an error occurred
|
|
Get the credential handle's certificate issuer name
- Parameters:
-
handle | The credential handle containing the certificate to get the issuer name of |
issuer_name | The issuer name as an X509_NAME object. This should be freed using X509_NAME_free when the user is finished with it |
- Returns:
- GLOBUS_SUCCESS if no error, a error object id otherwise
|
|
Get the issuer's subject name from the credential handle
- Parameters:
-
handle | The credential handle containing the certificate to get the issuer of |
issuer_name | The issuer certificate's subject name |
- Returns:
- GLOBUS_SUCCESS if no error, otherwise an error object identifier is returned
|
|
Get the identity's subject name from the credential handle
- Parameters:
-
handle | The credential handle containing the certificate to get the identity of |
identity_name | The identity certificate's subject name |
- Returns:
- GLOBUS_SUCCESS if no error, otherwise an error object identifier is returned
|
globus_result_t globus_gsi_cred_verify_cert_chain |
( |
globus_gsi_cred_handle_t |
cred_handle, |
|
|
globus_gsi_callback_data_t |
callback_data |
|
) |
|
|
|
This function performs path valiadtion on the certificate chain contained in the credential handle.
- Parameters:
-
cred_handle | The credential handle containing the certificate chain to be validated |
callback_data | A initialized callback data structure |
- Returns:
- GLOBUS_SUCCESS if no error, otherwise an error object identifier is returned
|
|
This function ensures that the certificate and private key in the credential handle match.
- Parameters:
-
handle | The credential handle containing the certificate and key to be validated |
- Returns:
- GLOBUS_SUCCESS if no error, otherwise an error object identifier is returned
|
about globus |
globus toolkit |
dev.globus
Comments? webmaster@globus.org