Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_certificate_verify_peers2.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_certificate_verify_peers2" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_certificate_verify_peers2 \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_certificate_verify_peers2(gnutls_session_t " session ", unsigned int * " status ");"
9 .SH ARGUMENTS
10 .IP "gnutls_session_t session" 12
11 is a gnutls session
12 .IP "unsigned int * status" 12
13 is the output of the verification
14 .SH "DESCRIPTION"
15 This function will try to verify the peer's certificate and return
16 its status (trusted, invalid etc.).  The value of \fIstatus\fP should
17 be one or more of the gnutls_certificate_status_t enumerated
18 elements bitwise or'd. To avoid denial of service attacks some
19 default upper limits regarding the certificate key size and chain
20 size are set. To override them use
21 \fBgnutls_certificate_set_verify_limits()\fP.
22
23 Note that you must also check the peer's name in order to check if
24 the verified certificate belongs to the actual peer.
25
26 This function uses \fBgnutls_x509_crt_list_verify()\fP with the CAs in
27 the credentials as trusted CAs.
28 .SH "RETURNS"
29 a negative error code on error and zero on success.
30 .SH "REPORTING BUGS"
31 Report bugs to <bug-gnutls@gnu.org>.
32 GnuTLS home page: http://www.gnu.org/software/gnutls/
33 General help using GNU software: http://www.gnu.org/gethelp/
34 .SH COPYRIGHT
35 Copyright \(co 2008 Free Software Foundation.
36 .br
37 Copying and distribution of this file, with or without modification,
38 are permitted in any medium without royalty provided the copyright
39 notice and this notice are preserved.
40 .SH "SEE ALSO"
41 The full documentation for
42 .B gnutls
43 is maintained as a Texinfo manual.  If the
44 .B info
45 and
46 .B gnutls
47 programs are properly installed at your site, the command
48 .IP
49 .B info gnutls
50 .PP
51 should give you access to the complete manual.