Section 3: library functions
NAME gnutls_packet_get – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_packet_get(gnutls_packet_t packet, gnutls_datum_t * data, unsigned char * sequence); ARGUMENTS gnutls_packet_t packet is a gnutls_packet_t structure. gnutls_datum_t * data will contain the data present in the packet structure (may be NULL) unsigned char * sequence the 8-bytes of the packet sequence number (may be NULL) DESCRIPTION…
NAME gnutls_packet_deinit – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_packet_deinit(gnutls_packet_t packet); ARGUMENTS gnutls_packet_t packet is a pointer to a gnutls_packet_st structure. DESCRIPTION This function will deinitialize all data associated with the received packet. SINCE 3.3.5 REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright © 2001-2014 Free Software Foundation, Inc.. Copying…
NAME gnutls_oprfi_enable_server – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_oprfi_enable_server(gnutls_session_t session, gnutls_oprfi_callback_func cb, void * userdata); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. gnutls_oprfi_callback_func cb function pointer to Opaque PRF extension server callback. void * userdata hook passed to callback function for passing application state. DESCRIPTION Request that the server should attempt to accept the…
NAME gnutls_oprfi_enable_client – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_oprfi_enable_client(gnutls_session_t session, size_t len, unsigned char * data); ARGUMENTS gnutls_session_t session is a gnutls_session_t structure. size_t len length of Opaque PRF data to use in client. unsigned char * data Opaque PRF data to use in client. DESCRIPTION Request that the client should attempt to negotiate…
NAME gnutls_openpgp_set_recv_key_function – API function SYNOPSIS #include <gnutls/openpgp.h> void gnutls_openpgp_set_recv_key_function(gnutls_session_t session, gnutls_openpgp_recv_key_func func); ARGUMENTS gnutls_session_t session a TLS session gnutls_openpgp_recv_key_func func the callback DESCRIPTION This funtion will set a key retrieval function for OpenPGP keys. This callback is only useful in server side, and will be used if the peer sent a key fingerprint instead…
NAME gnutls_openpgp_send_cert – API function SYNOPSIS #include <gnutls/gnutls.h> void gnutls_openpgp_send_cert(gnutls_session_t session, gnutls_openpgp_crt_status_t status); ARGUMENTS gnutls_session_t session is a pointer to a gnutls_session_t structure. gnutls_openpgp_crt_status_t status is one of GNUTLS_OPENPGP_CERT, or GNUTLS_OPENPGP_CERT_FINGERPRINT DESCRIPTION This function will order gnutls to send the key fingerprint instead of the key in the initial handshake procedure. This should be used…
NAME gnutls_openpgp_privkey_sign_hash – API function SYNOPSIS #include <gnutls/compat.h> int gnutls_openpgp_privkey_sign_hash(gnutls_openpgp_privkey_t key, const gnutls_datum_t * hash, gnutls_datum_t * signature); ARGUMENTS gnutls_openpgp_privkey_t key Holds the key const gnutls_datum_t * hash holds the data to be signed gnutls_datum_t * signature will contain newly allocated signature DESCRIPTION This function will sign the given hash using the private key. You…
NAME gnutls_openpgp_privkey_set_preferred_key_id – API function SYNOPSIS #include <gnutls/openpgp.h> int gnutls_openpgp_privkey_set_preferred_key_id(gnutls_openpgp_privkey_t key, const gnutls_openpgp_keyid_t keyid); ARGUMENTS gnutls_openpgp_privkey_t key the structure that contains the OpenPGP public key. const gnutls_openpgp_keyid_t keyid the selected keyid DESCRIPTION This allows setting a preferred key id for the given certificate. This key will be used by functions that involve key handling. If…
NAME gnutls_openpgp_privkey_sec_param – API function SYNOPSIS #include <gnutls/openpgp.h> gnutls_sec_param_t gnutls_openpgp_privkey_sec_param(gnutls_openpgp_privkey_t key); ARGUMENTS gnutls_openpgp_privkey_t key a key structure DESCRIPTION This function will return the security parameter appropriate with this private key. RETURNS On success, a valid security parameter is returned otherwise GNUTLS_SEC_PARAM_UNKNOWN is returned. SINCE 2.12.0 REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page:…
NAME gnutls_openpgp_privkey_init – API function SYNOPSIS #include <gnutls/openpgp.h> int gnutls_openpgp_privkey_init(gnutls_openpgp_privkey_t * key); ARGUMENTS gnutls_openpgp_privkey_t * key The structure to be initialized DESCRIPTION This function will initialize an OpenPGP key structure. RETURNS GNUTLS_E_SUCCESS on success, or an error code. REPORTING BUGS Report bugs to <bugs [at] gnutls.org>. Home page: http://www.gnutls.org COPYRIGHT Copyright © 2001-2014 Free Software…
NAME gnutls_openpgp_privkey_import – API function SYNOPSIS #include <gnutls/openpgp.h> int gnutls_openpgp_privkey_import(gnutls_openpgp_privkey_t key, const gnutls_datum_t * data, gnutls_openpgp_crt_fmt_t format, const char * password, unsigned int flags); ARGUMENTS gnutls_openpgp_privkey_t key The structure to store the parsed key. const gnutls_datum_t * data The RAW or BASE64 encoded key. gnutls_openpgp_crt_fmt_t format One of gnutls_openpgp_crt_fmt_t elements. const char * password not…
NAME gnutls_openpgp_privkey_get_subkey_revoked_status – API function SYNOPSIS #include <gnutls/openpgp.h> int gnutls_openpgp_privkey_get_subkey_revoked_status(gnutls_openpgp_privkey_t key, unsigned int idx); ARGUMENTS gnutls_openpgp_privkey_t key the structure that contains the OpenPGP private key. unsigned int idx is the subkey index DESCRIPTION Get revocation status of key. RETURNS true (1) if the key has been revoked, or false (0) if it has not, or…
NAME gnutls_openpgp_privkey_get_subkey_pk_algorithm – API function SYNOPSIS #include <gnutls/openpgp.h> gnutls_pk_algorithm_t gnutls_openpgp_privkey_get_subkey_pk_algorithm(gnutls_openpgp_privkey_t key, unsigned int idx, unsigned int * bits); ARGUMENTS gnutls_openpgp_privkey_t key is an OpenPGP key unsigned int idx is the subkey index unsigned int * bits if bits is non null it will hold the size of the parameters’ in bits DESCRIPTION This function will…
NAME gnutls_openpgp_privkey_get_subkey_idx – API function SYNOPSIS #include <gnutls/openpgp.h> int gnutls_openpgp_privkey_get_subkey_idx(gnutls_openpgp_privkey_t key, const gnutls_openpgp_keyid_t keyid); ARGUMENTS gnutls_openpgp_privkey_t key the structure that contains the OpenPGP private key. const gnutls_openpgp_keyid_t keyid the keyid. DESCRIPTION Get index of subkey. RETURNS the index of the subkey or a negative error value. SINCE 2.4.0 REPORTING BUGS Report bugs to <bugs [at]…
NAME gnutls_openpgp_privkey_get_subkey_id – API function SYNOPSIS #include <gnutls/openpgp.h> int gnutls_openpgp_privkey_get_subkey_id(gnutls_openpgp_privkey_t key, unsigned int idx, gnutls_openpgp_keyid_t keyid); ARGUMENTS gnutls_openpgp_privkey_t key the structure that contains the OpenPGP secret key. unsigned int idx the subkey index gnutls_openpgp_keyid_t keyid the buffer to save the keyid. DESCRIPTION Get the key-id for the subkey. RETURNS the 64-bit keyID of the OpenPGP…
NAME gnutls_openpgp_privkey_get_subkey_fingerprint – API function SYNOPSIS #include <gnutls/openpgp.h> int gnutls_openpgp_privkey_get_subkey_fingerprint(gnutls_openpgp_privkey_t key, unsigned int idx, void * fpr, size_t * fprlen); ARGUMENTS gnutls_openpgp_privkey_t key the raw data that contains the OpenPGP secret key. unsigned int idx the subkey index void * fpr the buffer to save the fingerprint, must hold at least 20 bytes. size_t *…
NAME gnutls_openpgp_privkey_get_subkey_expiration_time – API function SYNOPSIS #include <gnutls/openpgp.h> time_t gnutls_openpgp_privkey_get_subkey_expiration_time(gnutls_openpgp_privkey_t key, unsigned int idx); ARGUMENTS gnutls_openpgp_privkey_t key the structure that contains the OpenPGP private key. unsigned int idx the subkey index DESCRIPTION Get subkey expiration time. A value of ‘0’ means that the key doesn’t expire at all. RETURNS the time when the OpenPGP key…
NAME gnutls_openpgp_privkey_get_subkey_creation_time – API function SYNOPSIS #include <gnutls/openpgp.h> time_t gnutls_openpgp_privkey_get_subkey_creation_time(gnutls_openpgp_privkey_t key, unsigned int idx); ARGUMENTS gnutls_openpgp_privkey_t key the structure that contains the OpenPGP private key. unsigned int idx the subkey index DESCRIPTION Get subkey creation time. RETURNS the timestamp when the OpenPGP key was created. SINCE 2.4.0 REPORTING BUGS Report bugs to <bugs [at] gnutls.org>….
NAME gnutls_openpgp_privkey_get_subkey_count – API function SYNOPSIS #include <gnutls/openpgp.h> int gnutls_openpgp_privkey_get_subkey_count(gnutls_openpgp_privkey_t key); ARGUMENTS gnutls_openpgp_privkey_t key is an OpenPGP key DESCRIPTION This function will return the number of subkeys present in the given OpenPGP certificate. RETURNS the number of subkeys, or a negative error code on error. SINCE 2.4.0 REPORTING BUGS Report bugs to <bugs [at] gnutls.org>….
NAME gnutls_openpgp_privkey_get_revoked_status – API function SYNOPSIS #include <gnutls/openpgp.h> int gnutls_openpgp_privkey_get_revoked_status(gnutls_openpgp_privkey_t key); ARGUMENTS gnutls_openpgp_privkey_t key the structure that contains the OpenPGP private key. DESCRIPTION Get revocation status of key. RETURNS true (1) if the key has been revoked, or false (0) if it has not, or a negative error code indicates an error. SINCE 2.4.0 REPORTING…