doc/manpages/gnutls_x509_privkey_export.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_x509_privkey_export" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_x509_privkey_export \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/x509.h>
   7 .sp
   8 .BI "int gnutls_x509_privkey_export(gnutls_x509_privkey_t " key ", gnutls_x509_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_x509_privkey_t key" 12
  11 Holds the key
  12 .IP "gnutls_x509_crt_fmt_t format" 12
  13 the format of output params. One of PEM or DER.
  14 .IP "void * output_data" 12
  15 will contain a private key PEM or DER encoded
  16 .IP "size_t * output_data_size" 12
  17 holds the size of output_data (and will be
  18 replaced by the actual size of parameters)
  19 .SH "DESCRIPTION"
  20 This function will export the private key to a PKCS1 structure for
  21 RSA keys, or an integer sequence for DSA keys.  The DSA keys are in
  22 the same format with the parameters used by openssl.
  23
  24 If the buffer provided is not long enough to hold the output, then
  25 *\fIoutput_data_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP
  26 will be returned.
  27
  28 If the structure is PEM encoded, it will have a header
  29 of "BEGIN RSA PRIVATE KEY".
  30 .SH "RETURNS"
  31 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
  32 negative error value.
  33 .SH "REPORTING BUGS"
  34 Report bugs to <bug-gnutls@gnu.org>.
  35 GnuTLS home page: http://www.gnu.org/software/gnutls/
  36 General help using GNU software: http://www.gnu.org/gethelp/
  37 .SH COPYRIGHT
  38 Copyright \(co 2008 Free Software Foundation.
  39 .br
  40 Copying and distribution of this file, with or without modification,
  41 are permitted in any medium without royalty provided the copyright
  42 notice and this notice are preserved.
  43 .SH "SEE ALSO"
  44 The full documentation for
  45 .B gnutls
  46 is maintained as a Texinfo manual.  If the
  47 .B info
  48 and
  49 .B gnutls
  50 programs are properly installed at your site, the command
  51 .IP
  52 .B info gnutls
  53 .PP
  54 should give you access to the complete manual.