Section 3: library functions
NAME gnutls_pkcs11_copy_secret_key – API function SYNOPSIS #include <gnutls/pkcs11.h> int gnutls_pkcs11_copy_secret_key(const char * token_url, gnutls_datum_t * key, const char * label, unsigned int key_usage, unsigned int flags); ARGUMENTS const char * token_url A PKCS 11 URL specifying a token gnutls_datum_t * key The raw key const char * label A name to be used for the…
NAME gnutls_pkcs11_add_provider – API function SYNOPSIS #include <gnutls/pkcs11.h> int gnutls_pkcs11_add_provider(const char * name, const char * params); ARGUMENTS const char * name The filename of the module const char * params should be NULL DESCRIPTION This function will load and add a PKCS 11 module to the module list used in gnutls. After this function…
NAME gnutls_pk_to_sign – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_sign_algorithm_t gnutls_pk_to_sign(gnutls_pk_algorithm_t pk, gnutls_digest_algorithm_t hash); ARGUMENTS gnutls_pk_algorithm_t pk is a public key algorithm gnutls_digest_algorithm_t hash a hash algorithm DESCRIPTION This function maps public key and hash algorithms combinations to signature algorithms. RETURNS return a gnutls_sign_algorithm_t value, or GNUTLS_SIGN_UNKNOWN on error. REPORTING BUGS Report bugs to <bugs [at]…
NAME gnutls_pk_self_test – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_pk_self_test(unsigned all, gnutls_pk_algorithm_t pk); ARGUMENTS unsigned all if non-zero then tests to all public key algorithms are performed. gnutls_pk_algorithm_t pk the algorithm to use DESCRIPTION This function will run self tests on the provided public key algorithm. RETURNS Zero or a negative error code on error….
NAME gnutls_pk_list – API function SYNOPSIS #include <gnutls/gnutls.h> const gnutls_pk_algorithm_t * gnutls_pk_list( void); ARGUMENTS void DESCRIPTION Get a list of supported public key algorithms. This function is not thread safe. RETURNS a (0)-terminated list of gnutls_pk_algorithm_t integers indicating the available ciphers. SINCE 2.6.0 REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT…
NAME gnutls_pk_get_name – API function SYNOPSIS #include <gnutls/gnutls.h> const char * gnutls_pk_get_name(gnutls_pk_algorithm_t algorithm); ARGUMENTS gnutls_pk_algorithm_t algorithm is a public key algorithm DESCRIPTION Convert a gnutls_pk_algorithm_t value to a string. RETURNS a pointer to a string that contains the name of the specified public key algorithm, or NULL. SINCE 2.6.0 REPORTING BUGS Report bugs to <bugs…
NAME gnutls_pk_get_id – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_pk_algorithm_t gnutls_pk_get_id(const char * name); ARGUMENTS const char * name is a string containing a public key algorithm name. DESCRIPTION Convert a string to a gnutls_pk_algorithm_t value. The names are compared in a case insensitive way. For example, gnutls_pk_get_id("RSA") will return GNUTLS_PK_RSA. RETURNS a gnutls_pk_algorithm_t id of…
NAME gnutls_pk_bits_to_sec_param – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_sec_param_t gnutls_pk_bits_to_sec_param(gnutls_pk_algorithm_t algo, unsigned int bits); ARGUMENTS gnutls_pk_algorithm_t algo is a public key algorithm unsigned int bits is the number of bits DESCRIPTION This is the inverse of gnutls_sec_param_to_pk_bits(). Given an algorithm and the number of bits, it will return the security parameter. This is a rough…
NAME gnutls_pk_algorithm_get_name – API function SYNOPSIS #include <gnutls/gnutls.h> const char * gnutls_pk_algorithm_get_name(gnutls_pk_algorithm_t algorithm); ARGUMENTS gnutls_pk_algorithm_t algorithm is a pk algorithm DESCRIPTION Convert a gnutls_pk_algorithm_t value to a string. RETURNS a string that contains the name of the specified public key algorithm, or NULL. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT…
NAME gnutls_perror – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_perror(int error); ARGUMENTS int error is a GnuTLS error code, a negative error code DESCRIPTION This function is like perror(). The only difference is that it accepts an error number returned by a gnutls function. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org…
NAME gnutls_pem_base64_encode_alloc – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_pem_base64_encode_alloc(const char * msg, const gnutls_datum_t * data, gnutls_datum_t * result); ARGUMENTS const char * msg is a message to be put in the encoded header const gnutls_datum_t * data contains the raw data gnutls_datum_t * result will hold the newly allocated encoded data DESCRIPTION This…
NAME gnutls_pem_base64_encode – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_pem_base64_encode(const char * msg, const gnutls_datum_t * data, char * result, size_t * result_size); ARGUMENTS const char * msg is a message to be put in the header const gnutls_datum_t * data contain the raw data char * result the place where base64 data will be…
NAME gnutls_pem_base64_decode_alloc – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_pem_base64_decode_alloc(const char * header, const gnutls_datum_t * b64_data, gnutls_datum_t * result); ARGUMENTS const char * header The PEM header (eg. CERTIFICATE) const gnutls_datum_t * b64_data contains the encoded data gnutls_datum_t * result the place where decoded data lie DESCRIPTION This function will decode the given encoded…
NAME gnutls_pem_base64_decode – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_pem_base64_decode(const char * header, const gnutls_datum_t * b64_data, unsigned char * result, size_t * result_size); ARGUMENTS const char * header A null terminated string with the PEM header (eg. CERTIFICATE) const gnutls_datum_t * b64_data contain the encoded data unsigned char * result the place where decoded…
NAME gnutls_pcert_list_import_x509_raw – API function SYNOPSIS #include <gnutls/abstract.h> int gnutls_pcert_list_import_x509_raw(gnutls_pcert_st * pcerts, unsigned int * pcert_max, const gnutls_datum_t * data, gnutls_x509_crt_fmt_t format, unsigned int flags); ARGUMENTS gnutls_pcert_st * pcerts The structures to store the parsed certificate. Must not be initialized. unsigned int * pcert_max Initially must hold the maximum number of certs. It will be…
NAME gnutls_pcert_import_x509_raw – API function SYNOPSIS #include <gnutls/abstract.h> int gnutls_pcert_import_x509_raw(gnutls_pcert_st * pcert, const gnutls_datum_t * cert, gnutls_x509_crt_fmt_t format, unsigned int flags); ARGUMENTS gnutls_pcert_st * pcert The pcert structure const gnutls_datum_t * cert The raw certificate to be imported gnutls_x509_crt_fmt_t format The format of the certificate unsigned int flags zero for now DESCRIPTION This convenience function…
NAME gnutls_pcert_import_x509 – API function SYNOPSIS #include <gnutls/abstract.h> int gnutls_pcert_import_x509(gnutls_pcert_st * pcert, gnutls_x509_crt_t crt, unsigned int flags); ARGUMENTS gnutls_pcert_st * pcert The pcert structure gnutls_x509_crt_t crt The raw certificate to be imported unsigned int flags zero for now DESCRIPTION This convenience function will import the given certificate to a gnutls_pcert_st structure. The structure must be…
NAME gnutls_pcert_import_openpgp_raw – API function SYNOPSIS #include <gnutls/abstract.h> int gnutls_pcert_import_openpgp_raw(gnutls_pcert_st * pcert, const gnutls_datum_t * cert, gnutls_openpgp_crt_fmt_t format, gnutls_openpgp_keyid_t keyid, unsigned int flags); ARGUMENTS gnutls_pcert_st * pcert The pcert structure const gnutls_datum_t * cert The raw certificate to be imported gnutls_openpgp_crt_fmt_t format The format of the certificate gnutls_openpgp_keyid_t keyid The key ID to use (NULL…
NAME gnutls_pcert_import_openpgp – API function SYNOPSIS #include <gnutls/abstract.h> int gnutls_pcert_import_openpgp(gnutls_pcert_st * pcert, gnutls_openpgp_crt_t crt, unsigned int flags); ARGUMENTS gnutls_pcert_st * pcert The pcert structure gnutls_openpgp_crt_t crt The raw certificate to be imported unsigned int flags zero for now DESCRIPTION This convenience function will import the given certificate to a gnutls_pcert_st structure. The structure must be…
NAME gnutls_pcert_deinit – API function SYNOPSIS #include <gnutls/abstract.h> void gnutls_pcert_deinit(gnutls_pcert_st * pcert); ARGUMENTS gnutls_pcert_st * pcert The structure to be deinitialized DESCRIPTION This function will deinitialize a pcert structure. SINCE 3.0 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…