Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_privkey_import_pkcs8.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_privkey_import_pkcs8" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_privkey_import_pkcs8 \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_privkey_import_pkcs8(gnutls_x509_privkey_t " key ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", const char * " password ", unsigned int " flags ");"
9 .SH ARGUMENTS
10 .IP "gnutls_x509_privkey_t key" 12
11 The structure to store the parsed key
12 .IP "const gnutls_datum_t * data" 12
13 The DER or PEM encoded key.
14 .IP "gnutls_x509_crt_fmt_t format" 12
15 One of DER or PEM
16 .IP "const char * password" 12
17 the password to decrypt the key (if it is encrypted).
18 .IP "unsigned int flags" 12
19 0 if encrypted or GNUTLS_PKCS_PLAIN if not encrypted.
20 .SH "DESCRIPTION"
21 This function will convert the given DER or PEM encoded PKCS8 2.0
22 encrypted key to the native gnutls_x509_privkey_t format. The
23 output will be stored in \fIkey\fP.  Both RSA and DSA keys can be
24 imported, and flags can only be used to indicate an unencrypted
25 key.
26
27 The \fIpassword\fP can be either ASCII or UTF\-8 in the default PBES2
28 encryption schemas, or ASCII for the PKCS12 schemas.
29
30 If the Certificate is PEM encoded it should have a header of
31 "ENCRYPTED PRIVATE KEY", or "PRIVATE KEY". You only need to
32 specify the flags if the key is DER encoded, since in that case
33 the encryption status cannot be auto\-detected.
34 .SH "RETURNS"
35 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
36 negative error value.
37 .SH "REPORTING BUGS"
38 Report bugs to <bug-gnutls@gnu.org>.
39 GnuTLS home page: http://www.gnu.org/software/gnutls/
40 General help using GNU software: http://www.gnu.org/gethelp/
41 .SH COPYRIGHT
42 Copyright \(co 2008 Free Software Foundation.
43 .br
44 Copying and distribution of this file, with or without modification,
45 are permitted in any medium without royalty provided the copyright
46 notice and this notice are preserved.
47 .SH "SEE ALSO"
48 The full documentation for
49 .B gnutls
50 is maintained as a Texinfo manual.  If the
51 .B info
52 and
53 .B gnutls
54 programs are properly installed at your site, the command
55 .IP
56 .B info gnutls
57 .PP
58 should give you access to the complete manual.