Section 3: library functions
NAME gnutls_pkcs12_bag_set_crt – API function SYNOPSIS #include <gnutls/pkcs12.h> int gnutls_pkcs12_bag_set_crt(gnutls_pkcs12_bag_t bag, gnutls_x509_crt_t crt); ARGUMENTS gnutls_pkcs12_bag_t bag The bag gnutls_x509_crt_t crt the certificate to be copied. DESCRIPTION This function will insert the given certificate into the bag. This is just a wrapper over gnutls_pkcs12_bag_set_data(). RETURNS the index of the added bag on success, or a negative…
NAME gnutls_pkcs12_bag_set_crl – API function SYNOPSIS #include <gnutls/pkcs12.h> int gnutls_pkcs12_bag_set_crl(gnutls_pkcs12_bag_t bag, gnutls_x509_crl_t crl); ARGUMENTS gnutls_pkcs12_bag_t bag The bag gnutls_x509_crl_t crl the CRL to be copied. DESCRIPTION This function will insert the given CRL into the bag. This is just a wrapper over gnutls_pkcs12_bag_set_data(). RETURNS the index of the added bag on success, or a negative…
NAME gnutls_pkcs12_bag_init – API function SYNOPSIS #include <gnutls/pkcs12.h> int gnutls_pkcs12_bag_init(gnutls_pkcs12_bag_t * bag); ARGUMENTS gnutls_pkcs12_bag_t * bag The structure to be initialized DESCRIPTION This function will initialize a PKCS12 bag structure. PKCS12 Bags usually contain private keys, lists of X.509 Certificates and X.509 Certificate revocation lists. RETURNS On success, GNUTLS_E_SUCCESS (0) is returned, otherwise a negative…
NAME gnutls_pkcs12_bag_get_type – API function SYNOPSIS #include <gnutls/pkcs12.h> gnutls_pkcs12_bag_type_t gnutls_pkcs12_bag_get_type(gnutls_pkcs12_bag_t bag, int indx); ARGUMENTS gnutls_pkcs12_bag_t bag The bag int indx The element of the bag to get the type DESCRIPTION This function will return the bag’s type. RETURNS One of the gnutls_pkcs12_bag_type_t enumerations. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT…
NAME gnutls_pkcs12_bag_get_key_id – API function SYNOPSIS #include <gnutls/pkcs12.h> int gnutls_pkcs12_bag_get_key_id(gnutls_pkcs12_bag_t bag, int indx, gnutls_datum_t * id); ARGUMENTS gnutls_pkcs12_bag_t bag The bag int indx The bag’s element to add the id gnutls_datum_t * id where the ID will be copied (to be treated as const) DESCRIPTION This function will return the key ID, of the specified…
NAME gnutls_pkcs12_bag_get_friendly_name – API function SYNOPSIS #include <gnutls/pkcs12.h> int gnutls_pkcs12_bag_get_friendly_name(gnutls_pkcs12_bag_t bag, int indx, char ** name); ARGUMENTS gnutls_pkcs12_bag_t bag The bag int indx The bag’s element to add the id char ** name will hold a pointer to the name (to be treated as const) DESCRIPTION This function will return the friendly name, of the…
NAME gnutls_pkcs12_bag_get_data – API function SYNOPSIS #include <gnutls/pkcs12.h> int gnutls_pkcs12_bag_get_data(gnutls_pkcs12_bag_t bag, int indx, gnutls_datum_t * data); ARGUMENTS gnutls_pkcs12_bag_t bag The bag int indx The element of the bag to get the data from gnutls_datum_t * data where the bag’s data will be. Should be treated as constant. DESCRIPTION This function will return the bag’s data….
NAME gnutls_pkcs12_bag_get_count – API function SYNOPSIS #include <gnutls/pkcs12.h> int gnutls_pkcs12_bag_get_count(gnutls_pkcs12_bag_t bag); ARGUMENTS gnutls_pkcs12_bag_t bag The bag DESCRIPTION This function will return the number of the elements withing the bag. RETURNS Number of elements in bag, or an negative error code on error. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright…
NAME gnutls_pkcs12_bag_encrypt – API function SYNOPSIS #include <gnutls/pkcs12.h> int gnutls_pkcs12_bag_encrypt(gnutls_pkcs12_bag_t bag, const char * pass, unsigned int flags); ARGUMENTS gnutls_pkcs12_bag_t bag The bag const char * pass The password used for encryption, must be ASCII unsigned int flags should be one of gnutls_pkcs_encrypt_flags_t elements bitwise or’d DESCRIPTION This function will encrypt the given bag. RETURNS…
NAME gnutls_pkcs12_bag_deinit – API function SYNOPSIS #include <gnutls/pkcs12.h> void gnutls_pkcs12_bag_deinit(gnutls_pkcs12_bag_t bag); ARGUMENTS gnutls_pkcs12_bag_t bag The structure to be initialized DESCRIPTION This function will deinitialize a PKCS12 Bag structure. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright © 2001-2014 Free Software Foundation, Inc.. Copying and distribution of this file, with or…
NAME gnutls_pkcs12_bag_decrypt – API function SYNOPSIS #include <gnutls/pkcs12.h> int gnutls_pkcs12_bag_decrypt(gnutls_pkcs12_bag_t bag, const char * pass); ARGUMENTS gnutls_pkcs12_bag_t bag The bag const char * pass The password used for encryption, must be ASCII. DESCRIPTION This function will decrypt the given encrypted bag and return 0 on success. RETURNS On success, GNUTLS_E_SUCCESS (0) is returned, otherwise a…
NAME gnutls_pkcs11_type_get_name – API function SYNOPSIS #include <gnutls/pkcs11.h> const char * gnutls_pkcs11_type_get_name(gnutls_pkcs11_obj_type_t type); ARGUMENTS gnutls_pkcs11_obj_type_t type Holds the PKCS 11 object type, a gnutls_pkcs11_obj_type_t. DESCRIPTION This function will return a human readable description of the PKCS11 object type obj . It will return "Unknown" for unknown types. RETURNS human readable string labeling the PKCS11 object…
NAME gnutls_pkcs11_token_set_pin – API function SYNOPSIS #include <gnutls/pkcs11.h> int gnutls_pkcs11_token_set_pin(const char * token_url, const char * oldpin, const char * newpin, unsigned int flags); ARGUMENTS const char * token_url A PKCS 11 URL specifying a token const char * oldpin old user’s PIN const char * newpin new user’s PIN unsigned int flags one of…
NAME gnutls_pkcs11_token_init – API function SYNOPSIS #include <gnutls/pkcs11.h> int gnutls_pkcs11_token_init(const char * token_url, const char * so_pin, const char * label); ARGUMENTS const char * token_url A PKCS 11 URL specifying a token const char * so_pin Security Officer’s PIN const char * label A name to be used for the token DESCRIPTION This function…
NAME gnutls_pkcs11_token_get_url – API function SYNOPSIS #include <gnutls/pkcs11.h> int gnutls_pkcs11_token_get_url(unsigned int seq, gnutls_pkcs11_url_type_t detailed, char ** url); ARGUMENTS unsigned int seq sequence number starting from 0 gnutls_pkcs11_url_type_t detailed non zero if a detailed URL is required char ** url will contain an allocated url DESCRIPTION This function will return the URL for each token available…
NAME gnutls_pkcs11_token_get_random – API function SYNOPSIS #include <gnutls/pkcs11.h> int gnutls_pkcs11_token_get_random(const char * token_url, void * rnddata, size_t len); ARGUMENTS const char * token_url A PKCS 11 URL specifying a token void * rnddata A pointer to the memory area to be filled with random data size_t len The number of bytes of randomness to request…
NAME gnutls_pkcs11_token_get_mechanism – API function SYNOPSIS #include <gnutls/pkcs11.h> int gnutls_pkcs11_token_get_mechanism(const char * url, unsigned int idx, unsigned long * mechanism); ARGUMENTS const char * url should contain a PKCS 11 URL unsigned int idx The index of the mechanism unsigned long * mechanism The PKCS 11 mechanism ID DESCRIPTION This function will return the names…
NAME gnutls_pkcs11_token_get_info – API function SYNOPSIS #include <gnutls/pkcs11.h> int gnutls_pkcs11_token_get_info(const char * url, gnutls_pkcs11_token_info_t ttype, void * output, size_t * output_size); ARGUMENTS const char * url should contain a PKCS 11 URL gnutls_pkcs11_token_info_t ttype Denotes the type of information requested void * output where output will be stored size_t * output_size contains the maximum size…
NAME gnutls_pkcs11_token_get_flags – API function SYNOPSIS #include <gnutls/pkcs11.h> int gnutls_pkcs11_token_get_flags(const char * url, unsigned int * flags); ARGUMENTS const char * url should contain a PKCS 11 URL unsigned int * flags The output flags (GNUTLS_PKCS11_TOKEN_*) DESCRIPTION This function will return information about the PKCS 11 token flags. The supported flags are: GNUTLS_PKCS11_TOKEN_HW and GNUTLS_PKCS11_TOKEN_TRUSTED….
NAME gnutls_pkcs11_set_token_function – API function SYNOPSIS #include <gnutls/pkcs11.h> void gnutls_pkcs11_set_token_function(gnutls_pkcs11_token_callback_t fn, void * userdata); ARGUMENTS gnutls_pkcs11_token_callback_t fn The token callback void * userdata data to be supplied to callback DESCRIPTION This function will set a callback function to be used when a token needs to be inserted to continue PKCS 11 operations. SINCE 2.12.0 REPORTING…