Linux Manuals session 3

NAME gnutls_dtls_set_mtu – API function SYNOPSIS #include <gnutls/dtls.h> void gnutls_dtls_set_mtu(gnutls_session_t session, unsigned int mtu); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. unsigned int mtu The maximum transfer unit of the transport DESCRIPTION This function will set the maximum transfer unit of the transport that DTLS packets are sent over. Note that this should exclude the…

NAME 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); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. unsigned int mtu The maximum unencrypted transfer unit of the session DESCRIPTION This function will set the maximum size of the *unencrypted* records which will be sent over a DTLS session. It is equivalent…

NAME 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); ARGUMENTS gnutls_session_t session a new session gnutls_dtls_prestate_st * prestate contains the client’s prestate DESCRIPTION This 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…

NAME gnutls_dtls_get_timeout – API function SYNOPSIS #include <gnutls/dtls.h> unsigned int gnutls_dtls_get_timeout(gnutls_session_t session); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. DESCRIPTION This 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…

NAME gnutls_dtls_get_mtu – API function SYNOPSIS #include <gnutls/dtls.h> unsigned int gnutls_dtls_get_mtu(gnutls_session_t session); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. DESCRIPTION This 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. RETURNS the set maximum transfer unit. SINCE 3.0…

NAME gnutls_dtls_get_data_mtu – API function SYNOPSIS #include <gnutls/dtls.h> unsigned int gnutls_dtls_get_data_mtu(gnutls_session_t session); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. DESCRIPTION This 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(). RETURNS the maximum allowed transfer unit. SINCE 3.0 REPORTING…

NAME 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); ARGUMENTS gnutls_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…

NAME 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); ARGUMENTS gnutls_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…

NAME gnutls_digest_self_test – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_digest_self_test(unsigned all, gnutls_digest_algorithm_t digest); ARGUMENTS unsigned all if non-zero then tests to all ciphers are performed. gnutls_digest_algorithm_t digest the digest algorithm to use DESCRIPTION This function will run self tests on the provided digest. RETURNS Zero or a negative error code on error. SINCE 3.3.0 REPORTING…

NAME gnutls_digest_list – API function SYNOPSIS #include <gnutls/gnutls.h> const gnutls_digest_algorithm_t * gnutls_digest_list( void); ARGUMENTS void DESCRIPTION Get a list of hash (digest) algorithms supported by GnuTLS. This function is not thread safe. RETURNS Return a (0)-terminated list of gnutls_digest_algorithm_t integers indicating the available digests. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org…

NAME gnutls_digest_get_name – API function SYNOPSIS #include <gnutls/gnutls.h> const char * gnutls_digest_get_name(gnutls_digest_algorithm_t algorithm); ARGUMENTS gnutls_digest_algorithm_t algorithm is a digest algorithm DESCRIPTION Convert a gnutls_digest_algorithm_t value to a string. RETURNS a string that contains the name of the specified digest algorithm, or NULL. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright…

NAME gnutls_digest_get_id – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_digest_algorithm_t gnutls_digest_get_id(const char * name); ARGUMENTS const char * name is a digest algorithm name DESCRIPTION Convert a string to a gnutls_digest_algorithm_t value. The names are compared in a case insensitive way. RETURNS a gnutls_digest_algorithm_t id of the specified MAC algorithm string, or GNUTLS_DIG_UNKNOWN on failures. REPORTING…

NAME gnutls_dh_set_prime_bits – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_dh_set_prime_bits(gnutls_session_t session, unsigned int bits); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. unsigned int bits is the number of bits DESCRIPTION This function sets the number of bits, for use in a Diffie-Hellman key exchange. This is used both in DH ephemeral and DH anonymous cipher…

NAME gnutls_dh_params_init – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_dh_params_init(gnutls_dh_params_t * dh_params); ARGUMENTS gnutls_dh_params_t * dh_params Is a structure that will hold the prime numbers DESCRIPTION This function will initialize the DH parameters structure. RETURNS On success, GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error code is returned. REPORTING BUGS Report bugs to <bugs [at]…

NAME gnutls_dh_params_import_raw – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_dh_params_import_raw(gnutls_dh_params_t dh_params, const gnutls_datum_t * prime, const gnutls_datum_t * generator); ARGUMENTS gnutls_dh_params_t dh_params Is a structure that will hold the prime numbers const gnutls_datum_t * prime holds the new prime const gnutls_datum_t * generator holds the new generator DESCRIPTION This function will replace the pair of…

NAME gnutls_dh_params_import_pkcs3 – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_dh_params_import_pkcs3(gnutls_dh_params_t params, const gnutls_datum_t * pkcs3_params, gnutls_x509_crt_fmt_t format); ARGUMENTS gnutls_dh_params_t params A structure where the parameters will be copied to const gnutls_datum_t * pkcs3_params should contain a PKCS3 DHParams structure PEM or DER encoded gnutls_x509_crt_fmt_t format the format of params. PEM or DER. DESCRIPTION This function…

NAME gnutls_dh_params_generate2 – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_dh_params_generate2(gnutls_dh_params_t dparams, unsigned int bits); ARGUMENTS gnutls_dh_params_t dparams Is the structure that the DH parameters will be stored unsigned int bits is the prime’s number of bits DESCRIPTION This function will generate a new pair of prime and generator for use in the Diffie-Hellman key exchange….

NAME gnutls_dh_params_export_raw – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_dh_params_export_raw(gnutls_dh_params_t params, gnutls_datum_t * prime, gnutls_datum_t * generator, unsigned int * bits); ARGUMENTS gnutls_dh_params_t params Holds the DH parameters gnutls_datum_t * prime will hold the new prime gnutls_datum_t * generator will hold the new generator unsigned int * bits if non null will hold the secret…

NAME gnutls_dh_params_export_pkcs3 – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_dh_params_export_pkcs3(gnutls_dh_params_t params, gnutls_x509_crt_fmt_t format, unsigned char * params_data, size_t * params_data_size); ARGUMENTS gnutls_dh_params_t params Holds the DH parameters gnutls_x509_crt_fmt_t format the format of output params. One of PEM or DER. unsigned char * params_data will contain a PKCS3 DHParams structure PEM or DER encoded size_t *…

NAME gnutls_dh_params_export2_pkcs3 – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_dh_params_export2_pkcs3(gnutls_dh_params_t params, gnutls_x509_crt_fmt_t format, gnutls_datum_t * out); ARGUMENTS gnutls_dh_params_t params Holds the DH parameters gnutls_x509_crt_fmt_t format the format of output params. One of PEM or DER. gnutls_datum_t * out will contain a PKCS3 DHParams structure PEM or DER encoded DESCRIPTION This function will export the given…