← Back to branch summary

~ubuntu-branches/ubuntu/quantal/gnutls26/quantal-security

« back to all changes in this revision

Viewing changes to doc/manpages/gnutls_certificate_set_retrieve_function.3

  • Committer: Package Import Robot
  • Author(s): Andreas Metzler
  • Date: 2011-10-01 15:28:13 UTC
  • mfrom: (12.1.20 sid)
  • Revision ID: package-import@ubuntu.com-20111001152813-yygm1c4cxonfxhzy
Tags: 2.12.11-1
http://bugs.debian.org/640639
* New upstream version.
  + Allow CA importing of 0 certificates to succeed. Closes: #640639
* Add libp11-kit-dev to libgnutls-dev dependencies. (see #643811)
* [20_guiledocstring.diff] guile: Fix docstring extraction with CPP 4.5+.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manpages/gnutls_certificate_set_retrieve_function.3
 
1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
 
2
.TH "gnutls_certificate_set_retrieve_function" 3 "2.12.6.1" "gnutls" "gnutls"
 
3
.SH NAME
 
4
gnutls_certificate_set_retrieve_function \- API function
 
5
.SH SYNOPSIS
 
6
.B #include <gnutls/gnutls.h>
 
7
.sp
 
8
.BI "void gnutls_certificate_set_retrieve_function(gnutls_certificate_credentials_t " cred ", gnutls_certificate_retrieve_function * " func ");"
 
9
.SH ARGUMENTS
 
10
.IP "gnutls_certificate_credentials_t cred" 12
 
11
is a \fBgnutls_certificate_credentials_t\fP structure.
 
12
.IP "gnutls_certificate_retrieve_function * func" 12
 
13
is the callback function
 
14
.SH "DESCRIPTION"
 
15
This function sets a callback to be called in order to retrieve the
 
16
certificate to be used in the handshake.
 
17
 
 
18
The callback's function prototype is:
 
19
int (*callback)(gnutls_session_t, const gnutls_datum_t* req_ca_dn, int nreqs,
 
20
const gnutls_pk_algorithm_t* pk_algos, int pk_algos_length, gnutls_retr2_st* st);
 
21
 
 
22
\fIreq_ca_cert\fP is only used in X.509 certificates.
 
23
Contains a list with the CA names that the server considers trusted.
 
24
Normally we should send a certificate that is signed
 
25
by one of these CAs. These names are DER encoded. To get a more
 
26
meaningful value use the function \fBgnutls_x509_rdn_get()\fP.
 
27
 
 
28
\fIpk_algos\fP contains a list with server's acceptable signature algorithms.
 
29
The certificate returned should support the server's given algorithms.
 
30
 
 
31
\fIst\fP should contain the certificates and private keys.
 
32
 
 
33
If the callback function is provided then gnutls will call it, in the
 
34
handshake, after the certificate request message has been received.
 
35
 
 
36
In server side pk_algos and req_ca_dn are NULL.
 
37
 
 
38
The callback function should set the certificate list to be sent,
 
39
and return 0 on success. If no certificate was selected then the
 
40
number of certificates should be set to zero. The value (\-1)
 
41
indicates error and the handshake will be terminated.
 
42
.SH "REPORTING BUGS"
 
43
Report bugs to <bug-gnutls@gnu.org>.
 
44
GnuTLS home page: http://www.gnu.org/software/gnutls/
 
45
General help using GNU software: http://www.gnu.org/gethelp/
 
46
.SH COPYRIGHT
 
47
Copyright \(co 2008 Free Software Foundation.
 
48
.br
 
49
Copying and distribution of this file, with or without modification,
 
50
are permitted in any medium without royalty provided the copyright
 
51
notice and this notice are preserved.
 
52
.SH "SEE ALSO"
 
53
The full documentation for
 
54
.B gnutls
 
55
is maintained as a Texinfo manual.  If the
 
56
.B info
 
57
and
 
58
.B gnutls
 
59
programs are properly installed at your site, the command
 
60
.IP
 
61
.B info gnutls
 
62
.PP
 
63
should give you access to the complete manual.