Section 3: library functions
NAME gnutls_cipher_self_test – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_cipher_self_test(unsigned all, gnutls_cipher_algorithm_t cipher); ARGUMENTS unsigned all if non-zero then tests to all ciphers are performed. gnutls_cipher_algorithm_t cipher the encryption algorithm to use DESCRIPTION This function will run self tests on the provided cipher or all available ciphers if all is non-zero. RETURNS Zero or a…
NAME gnutls_cipher_list – API function SYNOPSIS #include <gnutls/gnutls.h> const gnutls_cipher_algorithm_t * gnutls_cipher_list( void); ARGUMENTS void DESCRIPTION Get a list of supported cipher algorithms. Note that not necessarily all ciphers are supported as TLS cipher suites. For example, DES is not supported as a cipher suite, but is supported for other purposes (e.g., PKCS8 or similar)….
NAME gnutls_cipher_init – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_cipher_init(gnutls_cipher_hd_t * handle, gnutls_cipher_algorithm_t cipher, const gnutls_datum_t * key, const gnutls_datum_t * iv); ARGUMENTS gnutls_cipher_hd_t * handle is a gnutls_cipher_hd_t structure. gnutls_cipher_algorithm_t cipher the encryption algorithm to use const gnutls_datum_t * key The key to be used for encryption const gnutls_datum_t * iv The IV to…
NAME gnutls_cipher_get_tag_size – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_cipher_get_tag_size(gnutls_cipher_algorithm_t algorithm); ARGUMENTS gnutls_cipher_algorithm_t algorithm is an encryption algorithm RETURNS the tag size of the authenticated encryption algorithm. SINCE 3.2.2 REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright © 2001-2014 Free Software Foundation, Inc.. Copying and distribution of this file, with…
NAME gnutls_cipher_get_name – API function SYNOPSIS #include <gnutls/gnutls.h> const char * gnutls_cipher_get_name(gnutls_cipher_algorithm_t algorithm); ARGUMENTS gnutls_cipher_algorithm_t algorithm is an encryption algorithm DESCRIPTION Convert a gnutls_cipher_algorithm_t type to a string. RETURNS a pointer to a string that contains the name of the specified cipher, or NULL. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org…
NAME gnutls_cipher_get_key_size – API function SYNOPSIS #include <gnutls/gnutls.h> size_t gnutls_cipher_get_key_size(gnutls_cipher_algorithm_t algorithm); ARGUMENTS gnutls_cipher_algorithm_t algorithm is an encryption algorithm DESCRIPTION Get key size for cipher. RETURNS length (in bytes) of the given cipher’s key size, or 0 if the given cipher is invalid. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright…
NAME gnutls_cipher_get_iv_size – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_cipher_get_iv_size(gnutls_cipher_algorithm_t algorithm); ARGUMENTS gnutls_cipher_algorithm_t algorithm is an encryption algorithm DESCRIPTION Get block size for encryption algorithm. RETURNS block size for encryption algorithm. SINCE 3.2.0 REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright © 2001-2014 Free Software Foundation, Inc.. Copying and distribution…
NAME gnutls_cipher_get_id – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_cipher_algorithm_t gnutls_cipher_get_id(const char * name); ARGUMENTS const char * name is a cipher algorithm name DESCRIPTION The names are compared in a case insensitive way. RETURNS return a gnutls_cipher_algorithm_t value corresponding to the specified cipher, or GNUTLS_CIPHER_UNKNOWN on error. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>….
NAME gnutls_cipher_get_block_size – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_cipher_get_block_size(gnutls_cipher_algorithm_t algorithm); ARGUMENTS gnutls_cipher_algorithm_t algorithm is an encryption algorithm RETURNS the block size of the encryption algorithm. SINCE 2.10.0 REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright © 2001-2014 Free Software Foundation, Inc.. Copying and distribution of this file, with or…
NAME gnutls_cipher_get – API function SYNOPSIS #include <gnutls/gnutls.h> gnutls_cipher_algorithm_t gnutls_cipher_get(gnutls_session_t session); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. DESCRIPTION Get currently used cipher. RETURNS the currently used cipher, a gnutls_cipher_algorithm_t type. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright © 2001-2014 Free Software Foundation, Inc.. Copying and distribution of this…
NAME gnutls_cipher_encrypt2 – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_cipher_encrypt2(gnutls_cipher_hd_t handle, const void * text, size_t textlen, void * ciphertext, size_t ciphertextlen); ARGUMENTS gnutls_cipher_hd_t handle is a gnutls_cipher_hd_t structure. const void * text the data to encrypt size_t textlen The length of data to encrypt void * ciphertext the encrypted data size_t ciphertextlen The available…
NAME gnutls_cipher_encrypt – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_cipher_encrypt(gnutls_cipher_hd_t handle, void * text, size_t textlen); ARGUMENTS gnutls_cipher_hd_t handle is a gnutls_cipher_hd_t structure. void * text the data to encrypt size_t textlen The length of data to encrypt DESCRIPTION This function will encrypt the given data using the algorithm specified by the context. RETURNS Zero…
NAME gnutls_cipher_deinit – API function SYNOPSIS #include <gnutls/crypto.h> void gnutls_cipher_deinit(gnutls_cipher_hd_t handle); ARGUMENTS gnutls_cipher_hd_t handle is a gnutls_cipher_hd_t structure. DESCRIPTION This function will deinitialize all resources occupied by the given encryption context. SINCE 2.10.0 REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright © 2001-2014 Free Software Foundation, Inc.. Copying and distribution…
NAME gnutls_cipher_decrypt2 – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_cipher_decrypt2(gnutls_cipher_hd_t handle, const void * ciphertext, size_t ciphertextlen, void * text, size_t textlen); ARGUMENTS gnutls_cipher_hd_t handle is a gnutls_cipher_hd_t structure. const void * ciphertext the data to encrypt size_t ciphertextlen The length of data to encrypt void * text the decrypted data size_t textlen The available…
NAME gnutls_cipher_decrypt – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_cipher_decrypt(gnutls_cipher_hd_t handle, void * ciphertext, size_t ciphertextlen); ARGUMENTS gnutls_cipher_hd_t handle is a gnutls_cipher_hd_t structure. void * ciphertext the data to encrypt size_t ciphertextlen The length of data to encrypt DESCRIPTION This function will decrypt the given data using the algorithm specified by the context. Note that…
NAME gnutls_cipher_add_auth – API function SYNOPSIS #include <gnutls/crypto.h> int gnutls_cipher_add_auth(gnutls_cipher_hd_t handle, const void * text, size_t text_size); ARGUMENTS gnutls_cipher_hd_t handle is a gnutls_cipher_hd_t structure. const void * text the data to be authenticated size_t text_size The length of the data DESCRIPTION This function operates on authenticated encryption with associated data (AEAD) ciphers and authenticate the…
NAME gnutls_check_version – API function SYNOPSIS #include <gnutls/gnutls.h> const char * gnutls_check_version(const char * req_version); ARGUMENTS const char * req_version version string to compare with, or NULL. DESCRIPTION Check GnuTLS Library version. See GNUTLS_VERSION for a suitable req_version string. RETURNS Check that the version of the library is at minimum the one given as a…
NAME gnutls_certificate_verify_peers3 – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_certificate_verify_peers3(gnutls_session_t session, const char * hostname, unsigned int * status); ARGUMENTS gnutls_session_t session is a gnutls session const char * hostname is the expected name of the peer; may be NULL unsigned int * status is the output of the verification DESCRIPTION This function will verify…
NAME gnutls_certificate_verify_peers2 – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_certificate_verify_peers2(gnutls_session_t session, unsigned int * status); ARGUMENTS gnutls_session_t session is a gnutls session unsigned int * status is the output of the verification DESCRIPTION This function will verify the peer’s certificate and store the status in the status variable as a bitwise or’d gnutls_certificate_status_t values or…
NAME gnutls_certificate_verify_peers – API function SYNOPSIS #include <gnutls/gnutls.h> int gnutls_certificate_verify_peers(gnutls_session_t session, gnutls_typed_vdata_st * data, unsigned int elements, unsigned int * status); ARGUMENTS gnutls_session_t session is a gnutls session gnutls_typed_vdata_st * data an array of typed data unsigned int elements the number of data elements unsigned int * status is the output of the verification DESCRIPTION…