Linux Manuals session 3

gnutls_pkcs12_bag_decrypt – API function Synopsis#include <gnutls/pkcs12.h> int gnutls_pkcs12_bag_decrypt(gnutls_pkcs12_bag_t bag, const char * pass); Argumentsgnutls_pkcs12_bag_t bag The bag const char * pass The password used for encryption, must be ASCII.DescriptionThis function will decrypt the given encrypted bag and return 0 on success. ReturnsOn success, GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error code is returned. Reporting…

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); Argumentsgnutls_pkcs11_obj_type_t type Holds the PKCS 11 object type, a gnutls_pkcs11_obj_type_t.DescriptionThis function will return a human readable description of the PKCS11 object type obj . It will return "Unknown" for unknown types. Returnshuman readable string labeling the PKCS11 object type  type . Since2.12.0 Reporting BugsReport bugs…

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); Argumentsconst 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 gnutls_pin_flag_t.DescriptionThis function will…

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); Argumentsconst 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 tokenDescriptionThis function will initialize (format) a token….

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); Argumentsunsigned 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 urlDescriptionThis function will return the URL for each token available in system. The url has…

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); Argumentsconst 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 requestDescriptionThis function will get…

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); Argumentsconst char * url should contain a PKCS 11 URL unsigned int idx The index of the mechanism unsigned long * mechanism The PKCS 11 mechanism IDDescriptionThis function will return the names of the supported mechanisms by…

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); Argumentsconst 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 of the output…

gnutls_pkcs11_token_get_flags – API function Synopsis#include <gnutls/pkcs11.h> int gnutls_pkcs11_token_get_flags(const char * url, unsigned int * flags); Argumentsconst char * url should contain a PKCS 11 URL unsigned int * flags The output flags (GNUTLS_PKCS11_TOKEN_*)DescriptionThis function will return information about the PKCS 11 token flags. The supported flags are: GNUTLS_PKCS11_TOKEN_HW and GNUTLS_PKCS11_TOKEN_TRUSTED. ReturnsGNUTLS_E_SUCCESS (0) on success or…

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); Argumentsgnutls_pkcs11_token_callback_t fn The token callback void * userdata data to be supplied to callbackDescriptionThis function will set a callback function to be used when a token needs to be inserted to continue PKCS 11 operations. Since2.12.0 Reporting BugsReport bugs to <bugs [at] gnutls.org>….

gnutls_pkcs11_set_pin_function – API function Synopsis#include <gnutls/pkcs11.h> void gnutls_pkcs11_set_pin_function(gnutls_pin_callback_t fn, void * userdata); Argumentsgnutls_pin_callback_t fn The PIN callback, a gnutls_pin_callback_t() function. void * userdata data to be supplied to callbackDescriptionThis function will set a callback function to be used when a PIN is required for PKCS 11 operations. See gnutls_pin_callback_t() on how the callback should behave….

gnutls_pkcs11_reinit – API function Synopsis#include <gnutls/pkcs11.h> int gnutls_pkcs11_reinit( void); Arguments void DescriptionThis function will reinitialize the PKCS 11 subsystem in gnutls. This is required by PKCS 11 when an application uses fork(). The reinitialization function must be called on the child. Note that since GnuTLS 3.3.0, the reinitialization of the PKCS 11 subsystem occurs automatically…

gnutls_pkcs11_privkey_status – API function Synopsis#include <gnutls/pkcs11.h> int gnutls_pkcs11_privkey_status(gnutls_pkcs11_privkey_t key); Argumentsgnutls_pkcs11_privkey_t key Holds the keyDescriptionChecks the status of the private key token. Returnsthis function will return non-zero if the token holding the private key is still available (inserted), and zero otherwise. Since3.1.9 Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org CopyrightCopyright © 2001-2014 Free…

gnutls_pkcs11_privkey_set_pin_function – API function Synopsis#include <gnutls/pkcs11.h> void gnutls_pkcs11_privkey_set_pin_function(gnutls_pkcs11_privkey_t key, gnutls_pin_callback_t fn, void * userdata); Argumentsgnutls_pkcs11_privkey_t key The private key gnutls_pin_callback_t fn the callback void * userdata data associated with the callbackDescriptionThis function will set a callback function to be used when required to access the object. This function overrides the global set using gnutls_pkcs11_set_pin_function(). Since3.1.0…

gnutls_pkcs11_privkey_init – API function Synopsis#include <gnutls/pkcs11.h> int gnutls_pkcs11_privkey_init(gnutls_pkcs11_privkey_t * key); Argumentsgnutls_pkcs11_privkey_t * key The structure to be initializedDescriptionThis function will initialize an private key structure. ReturnsOn success, GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org CopyrightCopyright © 2001-2014 Free Software Foundation, Inc.. Copying and…

gnutls_pkcs11_privkey_import_url – API function Synopsis#include <gnutls/pkcs11.h> int gnutls_pkcs11_privkey_import_url(gnutls_pkcs11_privkey_t pkey, const char * url, unsigned int flags); Argumentsgnutls_pkcs11_privkey_t pkey The structure to store the parsed key const char * url a PKCS 11 url identifying the key unsigned int flags Or sequence of GNUTLS_PKCS11_OBJ_* flagsDescriptionThis function will "import" a PKCS 11 URL identifying a private key…

gnutls_pkcs11_privkey_get_pk_algorithm – API function Synopsis#include <gnutls/pkcs11.h> int gnutls_pkcs11_privkey_get_pk_algorithm(gnutls_pkcs11_privkey_t key, unsigned int * bits); Argumentsgnutls_pkcs11_privkey_t key should contain a gnutls_pkcs11_privkey_t structure unsigned int * bits if bits is non null it will hold the size of the parameters’ in bitsDescriptionThis function will return the public key algorithm of a private key. Returnsa member of the gnutls_pk_algorithm_t…

gnutls_pkcs11_privkey_get_info – API function Synopsis#include <gnutls/pkcs11.h> int gnutls_pkcs11_privkey_get_info(gnutls_pkcs11_privkey_t pkey, gnutls_pkcs11_obj_info_t itype, void * output, size_t * output_size); Argumentsgnutls_pkcs11_privkey_t pkey should contain a gnutls_pkcs11_privkey_t structure gnutls_pkcs11_obj_info_t itype Denotes the type of information requested void * output where output will be stored size_t * output_size contains the maximum size of the output and will be overwritten with…

gnutls_pkcs11_privkey_generate3 – API function Synopsis#include <gnutls/pkcs11.h> int gnutls_pkcs11_privkey_generate3(const char * url, gnutls_pk_algorithm_t pk, unsigned int bits, const char * label, const gnutls_datum_t * cid, gnutls_x509_crt_fmt_t fmt, gnutls_datum_t * pubkey, unsigned int flags); Argumentsconst char * url a token URL gnutls_pk_algorithm_t pk the public key algorithm unsigned int bits the security bits const char * label…

gnutls_pkcs11_privkey_generate2 – API function Synopsis#include <gnutls/pkcs11.h> int gnutls_pkcs11_privkey_generate2(const char * url, gnutls_pk_algorithm_t pk, unsigned int bits, const char * label, gnutls_x509_crt_fmt_t fmt, gnutls_datum_t * pubkey, unsigned int flags); Argumentsconst char * url a token URL gnutls_pk_algorithm_t pk the public key algorithm unsigned int bits the security bits const char * label a label gnutls_x509_crt_fmt_t fmt…