Linux Manuals session 3

gnutls_est_record_overhead_size – API function Synopsis#include <gnutls/gnutls.h> size_t gnutls_est_record_overhead_size(gnutls_protocol_t version, gnutls_cipher_algorithm_t cipher, gnutls_mac_algorithm_t mac, gnutls_compression_method_t comp, unsigned int flags); Argumentsgnutls_protocol_t version is a gnutls_protocol_t value gnutls_cipher_algorithm_t cipher is a gnutls_cipher_algorithm_t value gnutls_mac_algorithm_t mac is a gnutls_mac_algorithm_t value gnutls_compression_method_t comp is a gnutls_compression_method_t value unsigned int flags must be zeroDescriptionThis function will return the set size in…

gnutls_error_to_alert – API function Synopsis#include <gnutls/gnutls.h> int gnutls_error_to_alert(int err, int * level); Argumentsint err is a negative integer int * level the alert level will be stored thereDescriptionGet an alert depending on the error code returned by a gnutls function. All alerts sent by this function should be considered fatal. The only exception is when…

gnutls_error_is_fatal – API function Synopsis#include <gnutls/gnutls.h> int gnutls_error_is_fatal(int error); Argumentsint error is a GnuTLS error code, a negative error codeDescriptionIf a GnuTLS function returns a negative error code you may feed that value to this function to see if the error condition is fatal to a TLS session (i.e., must be terminated). Note that you…

gnutls_ecc_curve_list – API function Synopsis#include <gnutls/gnutls.h> const gnutls_ecc_curve_t * gnutls_ecc_curve_list( void); Arguments void DescriptionGet the list of supported elliptic curves. This function is not thread safe. ReturnsReturn a (0)-terminated list of gnutls_ecc_curve_t integers indicating the available curves. Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org CopyrightCopyright © 2001-2014 Free Software Foundation, Inc.. Copying…

gnutls_ecc_curve_get_size – API function Synopsis#include <gnutls/gnutls.h> int gnutls_ecc_curve_get_size(gnutls_ecc_curve_t curve); Argumentsgnutls_ecc_curve_t curve is an ECC curveDescriptionReturns the size in bytes of the curve. Returnsa the size or (0). Since3.0 Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org CopyrightCopyright © 2001-2014 Free Software Foundation, Inc.. Copying and distribution of this file, with or without modification,…

gnutls_ecc_curve_get_name – API function Synopsis#include <gnutls/gnutls.h> const char * gnutls_ecc_curve_get_name(gnutls_ecc_curve_t curve); Argumentsgnutls_ecc_curve_t curve is an ECC curveDescriptionConvert a gnutls_ecc_curve_t value to a string. Returnsa string that contains the name of the specified curve or NULL. Since3.0 Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org CopyrightCopyright © 2001-2014 Free Software Foundation, Inc.. Copying and…

gnutls_ecc_curve_get – API function Synopsis#include <gnutls/gnutls.h> gnutls_ecc_curve_t gnutls_ecc_curve_get(gnutls_session_t session); Argumentsgnutls_session_t session is a gnutls_session_t structure.DescriptionReturns the currently used elliptic curve. Only valid when using an elliptic curve ciphersuite. Returnsthe currently used curve, a gnutls_ecc_curve_t type. Since3.0 Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org CopyrightCopyright © 2001-2014 Free Software Foundation, Inc.. Copying and…

gnutls_dtls_set_timeouts – API function Synopsis#include <gnutls/dtls.h> void gnutls_dtls_set_timeouts(gnutls_session_t session, unsigned int retrans_timeout, unsigned int total_timeout); Argumentsgnutls_session_t session is a gnutls_session_t structure. unsigned int retrans_timeout The time at which a retransmission will occur in milliseconds unsigned int total_timeout The time at which the connection will be aborted, in milliseconds.DescriptionThis function will set the timeouts required for…

gnutls_dtls_set_mtu – API function Synopsis#include <gnutls/dtls.h> void gnutls_dtls_set_mtu(gnutls_session_t session, unsigned int mtu); Argumentsgnutls_session_t session is a gnutls_session_t structure. unsigned int mtu The maximum transfer unit of the transportDescriptionThis function will set the maximum transfer unit of the transport that DTLS packets are sent over. Note that this should exclude the IP (or IPv6) and UDP…

gnutls_dtls_set_data_mtu – API function Synopsis#include <gnutls/dtls.h> int gnutls_dtls_set_data_mtu(gnutls_session_t session, unsigned int mtu); Argumentsgnutls_session_t session is a gnutls_session_t structure. unsigned int mtu The maximum unencrypted transfer unit of the sessionDescriptionThis function will set the maximum size of the *unencrypted* records which will be sent over a DTLS session. It is equivalent to calculating the DTLS packet…

gnutls_dtls_prestate_set – API function Synopsis#include <gnutls/dtls.h> void gnutls_dtls_prestate_set(gnutls_session_t session, gnutls_dtls_prestate_st * prestate); Argumentsgnutls_session_t session a new session gnutls_dtls_prestate_st * prestate contains the client’s prestateDescriptionThis function will associate the prestate acquired by the cookie authentication with the client, with the newly established session. This functions must be called after a successful gnutls_dtls_cookie_verify() and should be succeeded…

gnutls_dtls_get_timeout – API function Synopsis#include <gnutls/dtls.h> unsigned int gnutls_dtls_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 handshake message. This function is useful when DTLS is used in non-blocking mode, to estimate when to call gnutls_handshake() if no packets have been received. Returnsthe…

gnutls_dtls_get_mtu – API function Synopsis#include <gnutls/dtls.h> unsigned int gnutls_dtls_get_mtu(gnutls_session_t session); Argumentsgnutls_session_t session is a gnutls_session_t structure.DescriptionThis function will return the MTU size as set with gnutls_dtls_set_mtu(). This is not the actual MTU of data you can transmit. Use gnutls_dtls_get_data_mtu() for that reason. Returnsthe set maximum transfer unit. Since3.0 Reporting BugsReport bugs to <bugs [at] gnutls.org>….

gnutls_dtls_get_data_mtu – API function Synopsis#include <gnutls/dtls.h> unsigned int gnutls_dtls_get_data_mtu(gnutls_session_t session); Argumentsgnutls_session_t session is a gnutls_session_t structure.DescriptionThis function will return the actual maximum transfer unit for application data. I.e. DTLS headers are subtracted from the actual MTU which is set using gnutls_dtls_set_mtu(). Returnsthe maximum allowed transfer unit. Since3.0 Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home…

gnutls_dtls_cookie_verify – API function Synopsis#include <gnutls/dtls.h> int gnutls_dtls_cookie_verify(gnutls_datum_t * key, void * client_data, size_t client_data_size, void * _msg, size_t msg_size, gnutls_dtls_prestate_st * prestate); Argumentsgnutls_datum_t * key is a random key to be used at cookie generation void * client_data contains data identifying the client (i.e. address) size_t client_data_size The size of client’s data void *…

gnutls_dtls_cookie_send – API function Synopsis#include <gnutls/dtls.h> int gnutls_dtls_cookie_send(gnutls_datum_t * key, void * client_data, size_t client_data_size, gnutls_dtls_prestate_st * prestate, gnutls_transport_ptr_t ptr, gnutls_push_func push_func); Argumentsgnutls_datum_t * key is a random key to be used at cookie generation void * client_data contains data identifying the client (i.e. address) size_t client_data_size The size of client’s data gnutls_dtls_prestate_st * prestate…

gnutls_digest_self_test – API function Synopsis#include <gnutls/gnutls.h> int gnutls_digest_self_test(unsigned all, gnutls_digest_algorithm_t digest); Argumentsunsigned all if non-zero then tests to all ciphers are performed. gnutls_digest_algorithm_t digest the digest algorithm to useDescriptionThis function will run self tests on the provided digest. ReturnsZero or a negative error code on error. Since3.3.0 Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home…

gnutls_digest_list – API function Synopsis#include <gnutls/gnutls.h> const gnutls_digest_algorithm_t * gnutls_digest_list( void); Arguments void DescriptionGet a list of hash (digest) algorithms supported by GnuTLS. This function is not thread safe. ReturnsReturn a (0)-terminated list of gnutls_digest_algorithm_t integers indicating the available digests. Reporting BugsReport bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org CopyrightCopyright © 2001-2014 Free Software…

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

gnutls_digest_get_id – API function Synopsis#include <gnutls/gnutls.h> gnutls_digest_algorithm_t gnutls_digest_get_id(const char * name); Argumentsconst char * name is a digest algorithm nameDescriptionConvert a string to a gnutls_digest_algorithm_t value. The names are compared in a case insensitive way. Returnsa gnutls_digest_algorithm_t id of the specified MAC algorithm string, or GNUTLS_DIG_UNKNOWN on failures. Reporting BugsReport bugs to <bugs [at] gnutls.org>….