Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_certificate_get_peers.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_certificate_get_peers" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_certificate_get_peers \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "const gnutls_datum_t * gnutls_certificate_get_peers(gnutls_session_t                               " session ", unsigned int * " list_size ");"
9 .SH ARGUMENTS
10 .IP "gnutls_session_t                               session" 12
11 is a gnutls session
12 .IP "unsigned int * list_size" 12
13 is the length of the certificate list
14 .SH "DESCRIPTION"
15 Get the peer's raw certificate (chain) as sent by the peer.  These
16 certificates are in raw format (DER encoded for X.509).  In case of
17 a X.509 then a certificate list may be present.  The first
18 certificate in the list is the peer's certificate, following the
19 issuer's certificate, then the issuer's issuer etc.
20
21 In case of OpenPGP keys a single key will be returned in raw
22 format.
23 .SH "RETURNS"
24 return a pointer to a \fBgnutls_datum_t\fP containing our
25 certificates, or \fBNULL\fP in case of an error or if no certificate
26 was used.
27 .SH "REPORTING BUGS"
28 Report bugs to <bug-gnutls@gnu.org>.
29 GnuTLS home page: http://www.gnu.org/software/gnutls/
30 General help using GNU software: http://www.gnu.org/gethelp/
31 .SH COPYRIGHT
32 Copyright \(co 2008 Free Software Foundation.
33 .br
34 Copying and distribution of this file, with or without modification,
35 are permitted in any medium without royalty provided the copyright
36 notice and this notice are preserved.
37 .SH "SEE ALSO"
38 The full documentation for
39 .B gnutls
40 is maintained as a Texinfo manual.  If the
41 .B info
42 and
43 .B gnutls
44 programs are properly installed at your site, the command
45 .IP
46 .B info gnutls
47 .PP
48 should give you access to the complete manual.