Section 3: library functions
NAME gnutls_heartbeat_enable – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_heartbeat_enable(gnutls_session_t session, unsigned int type); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. unsigned int type one of the GNUTLS_HB_* flags DESCRIPTION If this function is called with the GNUTLS_HB_PEER_ALLOWED_TO_SEND type , GnuTLS will allow heartbeat messages to be received. Moreover it also request the peer to accept…
NAME gnutls_heartbeat_allowed – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_heartbeat_allowed(gnutls_session_t session, unsigned int type); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. unsigned int type one of GNUTLS_HB_LOCAL_ALLOWED_TO_SEND and GNUTLS_HB_PEER_ALLOWED_TO_SEND DESCRIPTION This function will check whether heartbeats are allowed to be sent or received in this session. RETURNS Non zero if heartbeats are allowed. SINCE 3.1.2…
NAME gnutls_hash_output – API function SYNOPSIS #include <gnutls/crypto.h> void gnutls_hash_output(gnutls_hash_hd_t handle, void * digest); ARGUMENTS gnutls_hash_hd_t handle is a gnutls_hash_hd_t structure. void * digest is the output value of the hash DESCRIPTION This function will output the current hash value and reset the state of the hash. SINCE 2.10.0 REPORTING BUGS Report bugs to <bugs…
NAME gnutls_hash_init – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_hash_init(gnutls_hash_hd_t * dig, gnutls_digest_algorithm_t algorithm); ARGUMENTS gnutls_hash_hd_t * dig is a gnutls_hash_hd_t structure. gnutls_digest_algorithm_t algorithm the hash algorithm to use DESCRIPTION This function will initialize an context that can be used to produce a Message Digest of data. This will effectively use the current crypto backend…
NAME gnutls_hash_get_len – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_hash_get_len(gnutls_digest_algorithm_t algorithm); ARGUMENTS gnutls_digest_algorithm_t algorithm the hash algorithm to use DESCRIPTION This function will return the length of the output data of the given hash algorithm. RETURNS The length or zero on error. SINCE 2.10.0 REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org…
NAME gnutls_hash_fast – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_hash_fast(gnutls_digest_algorithm_t algorithm, const void * text, size_t textlen, void * digest); ARGUMENTS gnutls_digest_algorithm_t algorithm the hash algorithm to use const void * text the data to hash size_t textlen The length of data to hash void * digest is the output value of the hash DESCRIPTION…
NAME gnutls_hash_deinit – API function SYNOPSIS #include <gnutls/crypto.h> void gnutls_hash_deinit(gnutls_hash_hd_t handle, void * digest); ARGUMENTS gnutls_hash_hd_t handle is a gnutls_hash_hd_t structure. void * digest is the output value of the hash DESCRIPTION This function will deinitialize all resources occupied by the given hash context. SINCE 2.10.0 REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home…
NAME gnutls_hash – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_hash(gnutls_hash_hd_t handle, const void * text, size_t textlen); ARGUMENTS gnutls_hash_hd_t handle is a gnutls_cipher_hd_t structure. const void * text the data to hash size_t textlen The length of data to hash DESCRIPTION This function will hash the given data using the algorithm specified by the context….
NAME gnutls_handshake_set_timeout – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_handshake_set_timeout(gnutls_session_t session, unsigned int ms); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. unsigned int ms is a timeout value in milliseconds DESCRIPTION This function sets the timeout for the handshake process to the provided value. Use an ms value of zero to disable timeout, or GNUTLS_DEFAULT_HANDSHAKE_TIMEOUT…
NAME gnutls_handshake_set_random – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_handshake_set_random(gnutls_session_t session, const gnutls_datum_t * random); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. const gnutls_datum_t * random a random value of 32-bytes DESCRIPTION This function will explicitly set the server or client hello random value in the subsequent TLS handshake. The random value should be a…
NAME gnutls_handshake_set_private_extensions – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_handshake_set_private_extensions(gnutls_session_t session, int allow); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. int allow is an integer (0 or 1) DESCRIPTION This function will enable or disable the use of private cipher suites (the ones that start with 0xFF). By default or if allow is 0 then…
NAME gnutls_handshake_set_post_client_hello_function – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_handshake_set_post_client_hello_function(gnutls_session_t session, gnutls_handshake_post_client_hello_func func); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. gnutls_handshake_post_client_hello_func func is the function to be called DESCRIPTION This function will set a callback to be called after the client hello has been received (callback valid in server side only). This allows the server…
NAME gnutls_handshake_set_max_packet_length – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_handshake_set_max_packet_length(gnutls_session_t session, size_t max); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. size_t max is the maximum number. DESCRIPTION This function will set the maximum size of all handshake messages. Handshakes over this size are rejected with GNUTLS_E_HANDSHAKE_TOO_LARGE error code. The default value is 128kb which is…
NAME gnutls_handshake_set_hook_function – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_handshake_set_hook_function(gnutls_session_t session, unsigned int htype, int post, gnutls_handshake_hook_func func); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure unsigned int htype the gnutls_handshake_description_t of the message to hook at int post GNUTLS_HOOK_* depending on when the hook function should be called gnutls_handshake_hook_func func is the function to be…
NAME gnutls_handshake_get_last_out – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_handshake_description_t gnutls_handshake_get_last_out(gnutls_session_t session); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. DESCRIPTION This function is only useful to check where the last performed handshake failed. If the previous handshake succeed or was not performed at all then no meaningful value will be returned. Check gnutls_handshake_description_t in gnutls.h for…
NAME gnutls_handshake_get_last_in – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_handshake_description_t gnutls_handshake_get_last_in(gnutls_session_t session); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. DESCRIPTION This function is only useful to check where the last performed handshake failed. If the previous handshake succeed or was not performed at all then no meaningful value will be returned. Check gnutls_handshake_description_t in gnutls.h for…
NAME gnutls_handshake_description_get_name – API function SYNOPSIS #include <gnutls/gnutls.h> const char * gnutls_handshake_description_get_name(gnutls_handshake_description_t type); ARGUMENTS gnutls_handshake_description_t type is a handshake message description DESCRIPTION Convert a gnutls_handshake_description_t value to a string. RETURNS a string that contains the name of the specified handshake message or NULL. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT…
NAME gnutls_handshake – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_handshake(gnutls_session_t session); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. DESCRIPTION This function does the handshake of the TLS/SSL protocol, and initializes the TLS connection. This function will fail if any problem is encountered, and will return a negative error code. In case of a client, if…
NAME gnutls_global_set_time_function – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_global_set_time_function(gnutls_time_func time_func); ARGUMENTS gnutls_time_func time_func it’s the system time function, a gnutls_time_func() callback. DESCRIPTION This is the function where you can override the default system time function. The application provided function should behave the same as the standard function. SINCE 2.12.0 REPORTING BUGS Report bugs to…
NAME gnutls_global_set_mutex – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_global_set_mutex(mutex_init_func init, mutex_deinit_func deinit, mutex_lock_func lock, mutex_unlock_func unlock); ARGUMENTS mutex_init_func init mutex initialization function mutex_deinit_func deinit mutex deinitialization function mutex_lock_func lock mutex locking function mutex_unlock_func unlock mutex unlocking function DESCRIPTION With this function you are allowed to override the default mutex locks used in some parts…