gnutls_certificate_set_retrieve_function(3) gnutls gnutls_certificate_set_retrieve_function(3)
NAME
gnutls_certificate_set_retrieve_function - API function
SYNOPSIS
#include <gnutls/gnutls.h>
void gnutls_certificate_set_retrieve_function(gnutls_certificate_credentials_t cred, gnutls_certificate_retrieve_function * func);
ARGUMENTS
gnutls_certificate_credentials_t cred
is a gnutls_certificate_credentials_t structure.
gnutls_certificate_retrieve_function * func
is the callback function
DESCRIPTION
This function sets a callback to be called in order to retrieve the certificate to be used in the handshake. You are advised to use
gnutls_certificate_set_retrieve_function2() because it is much more efficient in the processing it requires from gnutls.
The callback's function prototype is: int (*callback)(gnutls_session_t, const gnutls_datum_t* req_ca_dn, int nreqs, const gnutls_pk_algo-
rithm_t* pk_algos, int pk_algos_length, gnutls_retr2_st* st);
req_ca_cert is only used in X.509 certificates. Contains a list with the CA names that the server considers trusted. Normally we should
send a certificate that is signed by one of these CAs. These names are DER encoded. To get a more meaningful value use the function
gnutls_x509_rdn_get().
pk_algos contains a list with server's acceptable signature algorithms. The certificate returned should support the server's given algo-
rithms.
st should contain the certificates and private keys.
If the callback function is provided then gnutls will call it, in the handshake, after the certificate request message has been received.
In server side pk_algos and req_ca_dn are NULL.
The callback function should set the certificate list to be sent, and return 0 on success. If no certificate was selected then the number
of certificates should be set to zero. The value (-1) indicates error and the handshake will be terminated.
SINCE
3.0
REPORTING BUGS
Report bugs to <bug-gnutls@gnu.org>.
General guidelines for reporting bugs: http://www.gnu.org/gethelp/
GnuTLS home page: http://www.gnu.org/software/gnutls/
COPYRIGHT
Copyright (C) 2012 Free Software Foundation, Inc..
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
SEE ALSO
The full documentation for gnutls is maintained as a Texinfo manual. If the info and gnutls programs are properly installed at your site,
the command
info gnutls
should give you access to the complete manual. As an alternative you may obtain the manual from:
http://www.gnu.org/software/gnutls/manual/
gnutls 3.1.15 gnutls_certificate_set_retrieve_function(3)