Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_certificate_set_verify_function.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_certificate_set_verify_function" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_certificate_set_verify_function \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "void gnutls_certificate_set_verify_function(gnutls_certificate_credentials_t " cred ", gnutls_certificate_verify_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_verify_function * func" 12
13 is the callback function
14 .SH "DESCRIPTION"
15 This function sets a callback to be called when peer's certificate
16 has been received in order to verify it on receipt rather than
17 doing after the handshake is completed.
18
19 The callback's function prototype is:
20 int (*callback)(gnutls_session_t);
21
22 If the callback function is provided then gnutls will call it, in the
23 handshake, just after the certificate message has been received.
24 To verify or obtain the certificate the \fBgnutls_certificate_verify_peers2()\fP,
25 \fBgnutls_certificate_type_get()\fP, \fBgnutls_certificate_get_peers()\fP functions
26 can be used.
27
28 The callback function should return 0 for the handshake to continue
29 or non\-zero to terminate.
30 .SH "SINCE"
31 2.10.0
32 .SH "REPORTING BUGS"
33 Report bugs to <bug-gnutls@gnu.org>.
34 GnuTLS home page: http://www.gnu.org/software/gnutls/
35 General help using GNU software: http://www.gnu.org/gethelp/
36 .SH COPYRIGHT
37 Copyright \(co 2008 Free Software Foundation.
38 .br
39 Copying and distribution of this file, with or without modification,
40 are permitted in any medium without royalty provided the copyright
41 notice and this notice are preserved.
42 .SH "SEE ALSO"
43 The full documentation for
44 .B gnutls
45 is maintained as a Texinfo manual.  If the
46 .B info
47 and
48 .B gnutls
49 programs are properly installed at your site, the command
50 .IP
51 .B info gnutls
52 .PP
53 should give you access to the complete manual.