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