Section 3: library functions
NAME gnutls_kx_list – API function SYNOPSIS #include <gnutls/gnutls.h> const gnutls_kx_algorithm_t * gnutls_kx_list( void); ARGUMENTS void DESCRIPTION Get a list of supported key exchange algorithms. This function is not thread safe. RETURNS a (0)-terminated list of gnutls_kx_algorithm_t integers indicating the available key exchange algorithms. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT…
NAME gnutls_kx_get_name – API function SYNOPSIS #include <gnutls/gnutls.h> const char * gnutls_kx_get_name(gnutls_kx_algorithm_t algorithm); ARGUMENTS gnutls_kx_algorithm_t algorithm is a key exchange algorithm DESCRIPTION Convert a gnutls_kx_algorithm_t value to a string. RETURNS a pointer to a string that contains the name of the specified key exchange algorithm, or NULL. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>….
NAME gnutls_kx_get_id – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_kx_algorithm_t gnutls_kx_get_id(const char * name); ARGUMENTS const char * name is a KX name DESCRIPTION Convert a string to a gnutls_kx_algorithm_t value. The names are compared in a case insensitive way. RETURNS an id of the specified KX algorithm, or GNUTLS_KX_UNKNOWN on error. REPORTING BUGS Report bugs…
NAME gnutls_kx_get – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_kx_algorithm_t gnutls_kx_get(gnutls_session_t session); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. DESCRIPTION Get currently used key exchange algorithm. RETURNS the key exchange algorithm used in the last handshake, a gnutls_kx_algorithm_t value. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright © 2001-2014 Free Software…
NAME gnutls_key_generate – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_key_generate(gnutls_datum_t * key, unsigned int key_size); ARGUMENTS gnutls_datum_t * key is a pointer to a gnutls_datum_t which will contain a newly created key. unsigned int key_size The number of bytes of the key. DESCRIPTION Generates a random key of key_size bytes. RETURNS On success, GNUTLS_E_SUCCESS (0)…
NAME gnutls_init – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_init(gnutls_session_t * session, unsigned int flags); ARGUMENTS gnutls_session_t * session is a pointer to a gnutls_session_t structure. unsigned int flags indicate if this session is to be used for server or client. DESCRIPTION This function initializes the current session to null. Every session must be initialized…
NAME gnutls_ia_verify_endphase – API function SYNOPSIS #include <gnutls/extra.h> int gnutls_ia_verify_endphase(gnutls_session_t session, const char * checksum); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. const char * checksum 12-byte checksum data, received from gnutls_ia_recv(). DESCRIPTION Verify TLS/IA end phase checksum data. If verification fails, the GNUTLS_A_INNER_APPLICATION_VERIFICATION alert is sent to the other sie. This function is called…
NAME gnutls_ia_set_server_avp_ptr – Sets a pointer to be sent to TLS/IA callback SYNOPSIS #include <gnutls/extra.h> void gnutls_ia_set_server_avp_ptr(gnutls_ia_server_credentials_t cred, void * ptr); ARGUMENTS gnutls_ia_server_credentials_t cred is a gnutls_ia_client_credentials_t structure. void * ptr is the pointer DESCRIPTION Sets the pointer that will be provided to the TLS/IA callback function as the first argument. REPORTING BUGS Report bugs…
NAME gnutls_ia_set_server_avp_function – Used to set a AVP callback SYNOPSIS #include <gnutls/extra.h> void gnutls_ia_set_server_avp_function(gnutls_ia_server_credentials_t cred, gnutls_ia_avp_func avp_func); ARGUMENTS gnutls_ia_server_credentials_t cred is a gnutls_ia_server_credentials_t structure. gnutls_ia_avp_func avp_func DESCRIPTION Set the TLS/IA AVP callback handler used for the session. The callback’s function form is: int (*avp_func) (gnutls_session_t session, void *ptr, const char *last, size_t lastlen, char **next,…
NAME gnutls_ia_set_client_avp_ptr – Sets a pointer to be sent to TLS/IA callback SYNOPSIS #include <gnutls/extra.h> void gnutls_ia_set_client_avp_ptr(gnutls_ia_client_credentials_t cred, void * ptr); ARGUMENTS gnutls_ia_client_credentials_t cred is a gnutls_ia_client_credentials_t structure. void * ptr is the pointer DESCRIPTION Sets the pointer that will be provided to the TLS/IA callback function as the first argument. REPORTING BUGS Report bugs…
NAME gnutls_ia_set_client_avp_function – Used to set a AVP callback SYNOPSIS #include <gnutls/extra.h> void gnutls_ia_set_client_avp_function(gnutls_ia_client_credentials_t cred, gnutls_ia_avp_func avp_func); ARGUMENTS gnutls_ia_client_credentials_t cred is a gnutls_ia_client_credentials_t structure. gnutls_ia_avp_func avp_func is the callback function DESCRIPTION Set the TLS/IA AVP callback handler used for the session. The AVP callback is called to process AVPs received from the server, and to…
NAME gnutls_ia_send – API function SYNOPSIS #include <gnutls/extra.h> ssize_t gnutls_ia_send(gnutls_session_t session, const char * data, size_t sizeofdata); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. const char * data contains the data to send size_t sizeofdata is the length of the data DESCRIPTION Send TLS/IA application payload data. This function has the similar semantics with send()….
NAME gnutls_ia_recv – read data from the TLS/IA protocol SYNOPSIS #include <gnutls/extra.h> ssize_t gnutls_ia_recv(gnutls_session_t session, char * data, size_t sizeofdata); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. char * data the buffer that the data will be read into, must hold >= 12 bytes. size_t sizeofdata the number of requested bytes, must be >= 12….
NAME gnutls_ia_permute_inner_secret – API function SYNOPSIS #include <gnutls/extra.h> int gnutls_ia_permute_inner_secret(gnutls_session_t session, size_t session_keys_size, const char * session_keys); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. size_t session_keys_size Size of generated session keys (0 if none). const char * session_keys Generated session keys, used to permute inner secret (NULL if none). DESCRIPTION Permute the inner secret using…
NAME gnutls_ia_handshake_p – API function SYNOPSIS #include <gnutls/extra.h> int gnutls_ia_handshake_p(gnutls_session_t session); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. DESCRIPTION Predicate to be used after gnutls_handshake() to decide whether to invoke gnutls_ia_handshake(). Usable by both clients and servers. RETURN VALUE non-zero if TLS/IA handshake is expected, zero otherwise. REPORTING BUGS Report bugs to <bug-gnutls [at] gnu.org>….
NAME gnutls_ia_handshake – API function SYNOPSIS #include <gnutls/extra.h> int gnutls_ia_handshake(gnutls_session_t session); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. DESCRIPTION Perform a TLS/IA handshake. This should be called after gnutls_handshake() iff gnutls_ia_handshake_p(). RETURNS On success, GNUTLS_E_SUCCESS (zero) is returned, otherwise an error code is returned. REPORTING BUGS Report bugs to <bug-gnutls [at] gnu.org>. GnuTLS home page:…
NAME gnutls_ia_get_server_avp_ptr – Returns the pointer which is sent to TLS/IA callback SYNOPSIS #include <gnutls/extra.h> void * gnutls_ia_get_server_avp_ptr(gnutls_ia_server_credentials_t cred); ARGUMENTS gnutls_ia_server_credentials_t cred is a gnutls_ia_client_credentials_t structure. DESCRIPTION Returns the pointer that will be provided to the TLS/IA callback function as the first argument. RETURNS The server callback data pointer. REPORTING BUGS Report bugs to <bug-gnutls…
NAME gnutls_ia_get_client_avp_ptr – Returns the pointer which is sent to TLS/IA callback SYNOPSIS #include <gnutls/extra.h> void * gnutls_ia_get_client_avp_ptr(gnutls_ia_client_credentials_t cred); ARGUMENTS gnutls_ia_client_credentials_t cred is a gnutls_ia_client_credentials_t structure. DESCRIPTION Returns the pointer that will be provided to the TLS/IA callback function as the first argument. RETURNS The client callback data pointer. REPORTING BUGS Report bugs to <bug-gnutls…
NAME gnutls_ia_generate_challenge – API function SYNOPSIS #include <gnutls/extra.h> int gnutls_ia_generate_challenge(gnutls_session_t session, size_t buffer_size, char * buffer); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. size_t buffer_size size of output buffer. char * buffer pre-allocated buffer to contain buffer_size bytes of output. DESCRIPTION Generate an application challenge that the client cannot control or predict, based on the…
NAME gnutls_ia_free_server_credentials – Used to free an allocated #gnutls_ia_server_credentials_t structure SYNOPSIS #include <gnutls/extra.h> void gnutls_ia_free_server_credentials(gnutls_ia_server_credentials_t sc); ARGUMENTS gnutls_ia_server_credentials_t sc is a gnutls_ia_server_credentials_t structure. DESCRIPTION This structure is complex enough to manipulate directly thus this helper function is provided in order to free (deallocate) it. REPORTING BUGS Report bugs to <bug-gnutls [at] gnu.org>. GnuTLS home page:…