Section 3: library functions
NAME gnutls_strerror_name – API function SYNOPSIS #include <gnutls/gnutls.h> const char * gnutls_strerror_name(int error); ARGUMENTS int error is an error returned by a gnutls function. DESCRIPTION Return the GnuTLS error code define as a string. For example, gnutls_strerror_name (GNUTLS_E_DH_PRIME_UNACCEPTABLE) will return the string "GNUTLS_E_DH_PRIME_UNACCEPTABLE". RETURNS A string corresponding to the symbol name of the error code….
NAME gnutls_strerror – API function SYNOPSIS #include <gnutls/gnutls.h> const char * gnutls_strerror(int error); ARGUMENTS int error is a GnuTLS error code, a negative error code DESCRIPTION This function is similar to strerror. The difference is that it accepts an error number returned by a gnutls function; In case of an unknown error a descriptive string…
NAME gnutls_store_pubkey – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_store_pubkey(const char * db_name, gnutls_tdb_t tdb, const char * host, const char * service, gnutls_certificate_type_t cert_type, const gnutls_datum_t * cert, time_t expiration, unsigned int flags); ARGUMENTS const char * db_name A file specifying the stored keys (use NULL for the default) gnutls_tdb_t tdb A storage structure…
NAME gnutls_store_commitment – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_store_commitment(const char * db_name, gnutls_tdb_t tdb, const char * host, const char * service, gnutls_digest_algorithm_t hash_algo, const gnutls_datum_t * hash, time_t expiration, unsigned int flags); ARGUMENTS const char * db_name A file specifying the stored keys (use NULL for the default) gnutls_tdb_t tdb A storage structure…
NAME gnutls_srtp_set_profile_direct – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_srtp_set_profile_direct(gnutls_session_t session, const char * profiles, const char ** err_pos); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. const char * profiles is a string that contains the supported SRTP profiles, separated by colons. const char ** err_pos In case of an error this will have the…
NAME gnutls_srtp_set_profile – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_srtp_set_profile(gnutls_session_t session, gnutls_srtp_profile_t profile); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. gnutls_srtp_profile_t profile is the profile id to add. DESCRIPTION This function is to be used by both clients and servers, to declare what SRTP profiles they support, to negotiate with the peer. RETURNS On success,…
NAME gnutls_srtp_set_mki – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_srtp_set_mki(gnutls_session_t session, const gnutls_datum_t * mki); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. const gnutls_datum_t * mki holds the MKI DESCRIPTION This function sets the Master Key Identifier, to be used by this session (if any). RETURNS On success, GNUTLS_E_SUCCESS (0) is returned, otherwise a negative…
NAME gnutls_srtp_get_selected_profile – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_srtp_get_selected_profile(gnutls_session_t session, gnutls_srtp_profile_t * profile); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. gnutls_srtp_profile_t * profile will hold the profile DESCRIPTION This function allows you to get the negotiated SRTP profile. RETURNS On success, GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error code is returned. Since 3.1.4…
NAME gnutls_srtp_get_profile_name – API function SYNOPSIS #include <gnutls/gnutls.h> const char * gnutls_srtp_get_profile_name(gnutls_srtp_profile_t profile); ARGUMENTS gnutls_srtp_profile_t profile The profile to look up a string for DESCRIPTION This function allows you to get the corresponding name for a SRTP protection profile. RETURNS On success, the name of a SRTP profile as a string, otherwise NULL. Since 3.1.4…
NAME gnutls_srtp_get_profile_id – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_srtp_get_profile_id(const char * name, gnutls_srtp_profile_t * profile); ARGUMENTS const char * name The name of the profile to look up gnutls_srtp_profile_t * profile Will hold the profile id DESCRIPTION This function allows you to look up a profile based on a string. RETURNS On success, GNUTLS_E_SUCCESS…
NAME gnutls_srtp_get_mki – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_srtp_get_mki(gnutls_session_t session, gnutls_datum_t * mki); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. gnutls_datum_t * mki will hold the MKI DESCRIPTION This function exports the negotiated Master Key Identifier, received by the peer if any. The returned value in mki should be treated as constant and valid…
NAME gnutls_srtp_get_keys – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_srtp_get_keys(gnutls_session_t session, void * key_material, unsigned int key_material_size, gnutls_datum_t * client_key, gnutls_datum_t * client_salt, gnutls_datum_t * server_key, gnutls_datum_t * server_salt); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. void * key_material Space to hold the generated key material unsigned int key_material_size The maximum size of the key…
NAME gnutls_sign_list – API function SYNOPSIS #include <gnutls/gnutls.h> const gnutls_sign_algorithm_t * gnutls_sign_list( void); ARGUMENTS void DESCRIPTION Get a list of supported public key signature algorithms. RETURNS a (0)-terminated list of gnutls_sign_algorithm_t integers indicating the available ciphers. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright © 2001-2014 Free Software Foundation, Inc…..
NAME gnutls_sign_is_secure – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_sign_is_secure(gnutls_sign_algorithm_t algorithm); ARGUMENTS gnutls_sign_algorithm_t algorithm is a sign algorithm RETURNS Non-zero if the provided signature algorithm is considered to be secure. 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,…
NAME gnutls_sign_get_pk_algorithm – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_pk_algorithm_t gnutls_sign_get_pk_algorithm(gnutls_sign_algorithm_t sign); ARGUMENTS gnutls_sign_algorithm_t sign is a signature algorithm DESCRIPTION This function returns the public key algorithm corresponding to the given signature algorithms. SINCE 3.1.1 RETURNS return a gnutls_pk_algorithm_t value, or GNUTLS_PK_UNKNOWN on error. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT…
NAME gnutls_sign_get_name – API function SYNOPSIS #include <gnutls/gnutls.h> const char * gnutls_sign_get_name(gnutls_sign_algorithm_t algorithm); ARGUMENTS gnutls_sign_algorithm_t algorithm is a sign algorithm DESCRIPTION Convert a gnutls_sign_algorithm_t value to a string. RETURNS a string that contains the name of the specified sign algorithm, or NULL. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright…
NAME gnutls_sign_get_id – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_sign_algorithm_t gnutls_sign_get_id(const char * name); ARGUMENTS const char * name is a sign algorithm name DESCRIPTION The names are compared in a case insensitive way. RETURNS return a gnutls_sign_algorithm_t value corresponding to the specified algorithm, or GNUTLS_SIGN_UNKNOWN on error. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>….
NAME gnutls_sign_get_hash_algorithm – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_digest_algorithm_t gnutls_sign_get_hash_algorithm(gnutls_sign_algorithm_t sign); ARGUMENTS gnutls_sign_algorithm_t sign is a signature algorithm DESCRIPTION This function returns the digest algorithm corresponding to the given signature algorithms. SINCE 3.1.1 RETURNS return a gnutls_digest_algorithm_t value, or GNUTLS_DIG_UNKNOWN on error. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright…
NAME gnutls_sign_callback_set – API function SYNOPSIS #include <gnutls/compat.h> void gnutls_sign_callback_set(gnutls_session_t session, gnutls_sign_func sign_func, void * userdata); ARGUMENTS gnutls_session_t session is a gnutls session gnutls_sign_func sign_func function pointer to application’s sign callback. void * userdata void pointer that will be passed to sign callback. DESCRIPTION Set the callback function. The function must have this prototype: typedef…
NAME gnutls_sign_callback_get – API function SYNOPSIS #include <gnutls/compat.h> gnutls_sign_func gnutls_sign_callback_get(gnutls_session_t session, void ** userdata); ARGUMENTS gnutls_session_t session is a gnutls session void ** userdata if non-NULL, will be set to abstract callback pointer. DESCRIPTION Retrieve the callback function, and its userdata pointer. RETURNS The function pointer set by gnutls_sign_callback_set(), or if not set, NULL. DEPRECATED…