Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_certificate_set_x509_key_file.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_certificate_set_x509_key_file" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_certificate_set_x509_key_file \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_certificate_set_x509_key_file(gnutls_certificate_credentials_t " res ", const char * " certfile ", const char * " keyfile ", gnutls_x509_crt_fmt_t " type ");"
9 .SH ARGUMENTS
10 .IP "gnutls_certificate_credentials_t res" 12
11 is a \fBgnutls_certificate_credentials_t\fP structure.
12 .IP "const char * certfile" 12
13 is a file that containing the certificate list (path) for
14 the specified private key, in PKCS7 format, or a list of certificates
15 .IP "const char * keyfile" 12
16 is a file that contains the private key
17 .IP "gnutls_x509_crt_fmt_t type" 12
18 is PEM or DER
19 .SH "DESCRIPTION"
20 This function sets a certificate/private key pair in the
21 gnutls_certificate_credentials_t structure.  This function may be
22 called more than once (in case multiple keys/certificates exist for
23 the server).  For clients that wants to send more than its own end
24 entity certificate (e.g., also an intermediate CA cert) then put
25 the certificate chain in \fIcertfile\fP.
26
27 Currently only PKCS\-1 encoded RSA and DSA private keys are accepted by
28 this function.
29
30 This function can also accept PKCS \fB11\fP URLs. In that case it
31 will import the private key and certificate indicated by the urls.
32 .SH "RETURNS"
33 \fBGNUTLS_E_SUCCESS\fP on success, or an error code.
34 .SH "REPORTING BUGS"
35 Report bugs to <bug-gnutls@gnu.org>.
36 GnuTLS home page: http://www.gnu.org/software/gnutls/
37 General help using GNU software: http://www.gnu.org/gethelp/
38 .SH COPYRIGHT
39 Copyright \(co 2008 Free Software Foundation.
40 .br
41 Copying and distribution of this file, with or without modification,
42 are permitted in any medium without royalty provided the copyright
43 notice and this notice are preserved.
44 .SH "SEE ALSO"
45 The full documentation for
46 .B gnutls
47 is maintained as a Texinfo manual.  If the
48 .B info
49 and
50 .B gnutls
51 programs are properly installed at your site, the command
52 .IP
53 .B info gnutls
54 .PP
55 should give you access to the complete manual.