Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_certificate_set_x509_simple_pkcs12_file.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_certificate_set_x509_simple_pkcs12_file" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_certificate_set_x509_simple_pkcs12_file \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_certificate_set_x509_simple_pkcs12_file(gnutls_certificate_credentials_t " res ", const char * " pkcs12file ", gnutls_x509_crt_fmt_t " type ", const char * " password ");"
9 .SH ARGUMENTS
10 .IP "gnutls_certificate_credentials_t res" 12
11 is a \fBgnutls_certificate_credentials_t\fP structure.
12 .IP "const char * pkcs12file" 12
13 filename of file containing PKCS\fB12\fP blob.
14 .IP "gnutls_x509_crt_fmt_t type" 12
15 is PEM or DER of the \fIpkcs12file\fP.
16 .IP "const char * password" 12
17 optional password used to decrypt PKCS\fB12\fP file, bags and keys.
18 .SH "DESCRIPTION"
19 This function sets a certificate/private key pair and/or a CRL in
20 the gnutls_certificate_credentials_t structure.  This function may
21 be called more than once (in case multiple keys/certificates exist
22 for the server).
23 .SH "MAC"
24 ed PKCS\fB12\fP files are supported.  Encrypted PKCS\fB12\fP bags are
25 supported.  Encrypted PKCS\fB8\fP private keys are supported.  However,
26 only password based security, and the same password for all
27 operations, are supported.
28
29 The private keys may be RSA PKCS\fB1\fP or DSA private keys encoded in
30 the OpenSSL way.
31
32 PKCS\fB12\fP file may contain many keys and/or certificates, and there
33 is no way to identify which key/certificate pair you want.  You
34 should make sure the PKCS\fB12\fP file only contain one key/certificate
35 pair and/or one CRL.
36
37 It is believed that the limitations of this function is acceptable
38 for most usage, and that any more flexibility would introduce
39 complexity that would make it harder to use this functionality at
40 all.
41 .SH "RETURNS"
42 \fBGNUTLS_E_SUCCESS\fP on success, or an error code.
43 .SH "REPORTING BUGS"
44 Report bugs to <bug-gnutls@gnu.org>.
45 GnuTLS home page: http://www.gnu.org/software/gnutls/
46 General help using GNU software: http://www.gnu.org/gethelp/
47 .SH COPYRIGHT
48 Copyright \(co 2008 Free Software Foundation.
49 .br
50 Copying and distribution of this file, with or without modification,
51 are permitted in any medium without royalty provided the copyright
52 notice and this notice are preserved.
53 .SH "SEE ALSO"
54 The full documentation for
55 .B gnutls
56 is maintained as a Texinfo manual.  If the
57 .B info
58 and
59 .B gnutls
60 programs are properly installed at your site, the command
61 .IP
62 .B info gnutls
63 .PP
64 should give you access to the complete manual.