doc/crypto/d2i_PrivateKey.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 d2i_Private_key, d2i_AutoPrivateKey, i2d_PrivateKey - decode and encode
   6 functions for reading and saving EVP_PKEY structures
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/evp.h>
  11
  12  EVP_PKEY *d2i_PrivateKey(int type, EVP_PKEY **a, const unsigned char **pp,
  13                           long length);
  14  EVP_PKEY *d2i_AutoPrivateKey(EVP_PKEY **a, const unsigned char **pp,
  15                               long length);
  16  int i2d_PrivateKey(EVP_PKEY *a, unsigned char **pp);
  17
  18 =head1 DESCRIPTION
  19
  20 d2i_PrivateKey() decodes a private key using algorithm B<type>. It attempts to
  21 use any key specific format or PKCS#8 unencrypted PrivateKeyInfo format. The
  22 B<type> parameter should be a public key algorithm constant such as
  23 B<EVP_PKEY_RSA>. An error occurs if the decoded key does not match B<type>.
  24
  25 d2i_AutoPrivateKey() is similar to d2i_PrivateKey() except it attempts to
  26 automatically detect the private key format.
  27
  28 i2d_PrivateKey() encodes B<key>. It uses a key specific format or, if none is
  29 defined for that key type, PKCS#8 unencrypted PrivateKeyInfo format.
  30
  31 These functions are similar to the d2i_X509() functions, and you should refer to
  32 that page for a detailed description (see L<d2i_X509(3)>).
  33
  34 =head1 NOTES
  35
  36 All these functions use DER format and unencrypted keys. Applications wishing
  37 to encrypt or decrypt private keys should use other functions such as
  38 d2i_PKC8PrivateKey() instead.
  39
  40 If the B<*a> is not NULL when calling d2i_PrivateKey() or d2i_AutoPrivateKey()
  41 (i.e. an existing structure is being reused) and the key format is PKCS#8
  42 then B<*a> will be freed and replaced on a successful call.
  43
  44 =head1 RETURN VALUES
  45
  46 d2i_PrivateKey() and d2i_AutoPrivateKey() return a valid B<EVP_KEY> structure
  47 or B<NULL> if an error occurs. The error code can be obtained by calling
  48 L<ERR_get_error(3)>.
  49
  50 i2d_PrivateKey() returns the number of bytes successfully encoded or a
  51 negative value if an error occurs. The error code can be obtained by calling
  52 L<ERR_get_error(3)>.
  53
  54 =head1 SEE ALSO
  55
  56 L<crypto(3)>,
  57 L<d2i_PKCS8PrivateKey(3)>
  58
  59 =head1 COPYRIGHT
  60
  61 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
  62
  63 Licensed under the OpenSSL license (the "License").  You may not use
  64 this file except in compliance with the License.  You can obtain a copy
  65 in the file LICENSE in the source distribution or at
  66 L<https://www.openssl.org/source/license.html>.
  67
  68 =cut