Author: Linux Manual

gnutls_heartbeat_ping – API function Synopsis#include <gnutls/gnutls.h> int gnutls_heartbeat_ping(gnutls_session_t session, size_t data_size, unsigned int max_tries, unsigned int flags); Argumentsgnutls_session_t session is a gnutls_session_t structure. size_t data_size is the length of the ping payload. unsigned int max_tries if flags is GNUTLS_HEARTBEAT_WAIT then this sets the number of retransmissions. Use zero for indefinite (until timeout). unsigned int flags…

gnutls_heartbeat_get_timeout – API function Synopsis#include <gnutls/gnutls.h> unsigned int gnutls_heartbeat_get_timeout(gnutls_session_t session); Argumentsgnutls_session_t session is a gnutls_session_t structure.DescriptionThis function will return the milliseconds remaining for a retransmission of the previously sent ping message. This function is useful when ping is used in non-blocking mode, to estimate when to call gnutls_heartbeat_ping() if no packets have been received. Returnsthe…

gnutls_heartbeat_enable – API function Synopsis#include <gnutls/gnutls.h> void gnutls_heartbeat_enable(gnutls_session_t session, unsigned int type); Argumentsgnutls_session_t session is a gnutls_session_t structure. unsigned int type one of the GNUTLS_HB_* flagsDescriptionIf 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 heartbeat messages. If the type…

gnutls_heartbeat_allowed – API function Synopsis#include <gnutls/gnutls.h> int gnutls_heartbeat_allowed(gnutls_session_t session, unsigned int type); Argumentsgnutls_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_SENDDescriptionThis function will check whether heartbeats are allowed to be sent or received in this session. ReturnsNon zero if heartbeats are allowed. Since3.1.2 Reporting BugsReport bugs to <bugs [at] gnutls.org>….

gnutls_hash_output – API function Synopsis#include <gnutls/crypto.h> void gnutls_hash_output(gnutls_hash_hd_t handle, void * digest); Argumentsgnutls_hash_hd_t handle is a gnutls_hash_hd_t structure. void * digest is the output value of the hashDescriptionThis function will output the current hash value and reset the state of the hash. Since2.10.0 Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org CopyrightCopyright ©…

gnutls_hash_init – API function Synopsis#include <gnutls/crypto.h> int gnutls_hash_init(gnutls_hash_hd_t * dig, gnutls_digest_algorithm_t algorithm); Argumentsgnutls_hash_hd_t * dig is a gnutls_hash_hd_t structure. gnutls_digest_algorithm_t algorithm the hash algorithm to useDescriptionThis function will initialize an context that can be used to produce a Message Digest of data. This will effectively use the current crypto backend in use by gnutls or…

gnutls_hash_get_len – API function Synopsis#include <gnutls/crypto.h> int gnutls_hash_get_len(gnutls_digest_algorithm_t algorithm); Argumentsgnutls_digest_algorithm_t algorithm the hash algorithm to useDescriptionThis function will return the length of the output data of the given hash algorithm. ReturnsThe length or zero on error. Since2.10.0 Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org CopyrightCopyright © 2001-2014 Free Software Foundation, Inc.. Copying…

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); Argumentsgnutls_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 hashDescriptionThis convenience function will hash…

gnutls_hash_deinit – API function Synopsis#include <gnutls/crypto.h> void gnutls_hash_deinit(gnutls_hash_hd_t handle, void * digest); Argumentsgnutls_hash_hd_t handle is a gnutls_hash_hd_t structure. void * digest is the output value of the hashDescriptionThis function will deinitialize all resources occupied by the given hash context. Since2.10.0 Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org CopyrightCopyright © 2001-2014 Free Software…

gnutls_hash – API function Synopsis#include <gnutls/crypto.h> int gnutls_hash(gnutls_hash_hd_t handle, const void * text, size_t textlen); Argumentsgnutls_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 hashDescriptionThis function will hash the given data using the algorithm specified by the context. ReturnsZero or a negative error…

gnutls_handshake_set_timeout – API function Synopsis#include <gnutls/gnutls.h> void gnutls_handshake_set_timeout(gnutls_session_t session, unsigned int ms); Argumentsgnutls_session_t session is a gnutls_session_t structure. unsigned int ms is a timeout value in millisecondsDescriptionThis 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 for a reasonable default value….

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); Argumentsgnutls_session_t session is a gnutls_session_t structure. const gnutls_datum_t * random a random value of 32-bytesDescriptionThis function will explicitly set the server or client hello random value in the subsequent TLS handshake. The random value should be a 32-byte value. Note that this…

gnutls_handshake_set_private_extensions – API function Synopsis#include <gnutls/gnutls.h> void gnutls_handshake_set_private_extensions(gnutls_session_t session, int allow); Argumentsgnutls_session_t session is a gnutls_session_t structure. int allow is an integer (0 or 1)DescriptionThis 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 these cipher suites will not…

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); Argumentsgnutls_session_t session is a gnutls_session_t structure. gnutls_handshake_post_client_hello_func func is the function to be calledDescriptionThis 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 to adjust settings based on…

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); Argumentsgnutls_session_t session is a gnutls_session_t structure. size_t max is the maximum number.DescriptionThis 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 typically large enough. Set this…

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); Argumentsgnutls_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 calledDescriptionThis function will…

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); Argumentsgnutls_session_t session is a gnutls_session_t structure.DescriptionThis 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 the available handshake descriptions. Returnsthe…

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); Argumentsgnutls_session_t session is a gnutls_session_t structure.DescriptionThis 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 the available handshake descriptions. Returnsthe…

gnutls_handshake_description_get_name – API function Synopsis#include <gnutls/gnutls.h> const char * gnutls_handshake_description_get_name(gnutls_handshake_description_t type); Argumentsgnutls_handshake_description_t type is a handshake message descriptionDescriptionConvert a gnutls_handshake_description_t value to a string. Returnsa string that contains the name of the specified handshake message or NULL. Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org CopyrightCopyright © 2001-2014 Free Software Foundation, Inc.. Copying…

gnutls_handshake – API function Synopsis#include <gnutls/gnutls.h> int gnutls_handshake(gnutls_session_t session); Argumentsgnutls_session_t session is a gnutls_session_t structure.DescriptionThis 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 the client has asked to…