doc/man3/d2i_PrivateKey.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 d2i_PrivateKey_ex, d2i_PrivateKey, d2i_PublicKey, d2i_KeyParams,
   6 d2i_AutoPrivateKey_ex,  d2i_AutoPrivateKey, i2d_PrivateKey, i2d_PublicKey,
   7 i2d_KeyParams, i2d_KeyParams_bio, d2i_PrivateKey_ex_bio, d2i_PrivateKey_bio,
   8 d2i_PrivateKey_ex_fp, d2i_PrivateKey_fp, d2i_KeyParams_bio, i2d_PrivateKey_bio,
   9 i2d_PrivateKey_fp
  10 - decode and encode functions for reading and saving EVP_PKEY structures
  11
  12 =head1 SYNOPSIS
  13
  14  #include <openssl/evp.h>
  15
  16  EVP_PKEY *d2i_PrivateKey_ex(int type, EVP_PKEY **a, const unsigned char **pp,
  17                              long length, OPENSSL_CTX *libctx,
  18                              const char *propq);
  19  EVP_PKEY *d2i_PrivateKey(int type, EVP_PKEY **a, const unsigned char **pp,
  20                           long length);
  21  EVP_PKEY *d2i_PublicKey(int type, EVP_PKEY **a, const unsigned char **pp,
  22                          long length);
  23  EVP_PKEY *d2i_KeyParams(int type, EVP_PKEY **a, const unsigned char **pp,
  24                          long length);
  25  EVP_PKEY *d2i_AutoPrivateKey_ex(EVP_PKEY **a, const unsigned char **pp,
  26                                  long length, OPENSSL_CTX *libctx,
  27                                  const char *propq);
  28  EVP_PKEY *d2i_AutoPrivateKey(EVP_PKEY **a, const unsigned char **pp,
  29                               long length);
  30
  31  int i2d_PrivateKey(const EVP_PKEY *a, unsigned char **pp);
  32  int i2d_PublicKey(const EVP_PKEY *a, unsigned char **pp);
  33  int i2d_KeyParams(const EVP_PKEY *a, unsigned char **pp);
  34  int i2d_KeyParams_bio(BIO *bp, const EVP_PKEY *pkey);
  35  EVP_PKEY *d2i_KeyParams_bio(int type, EVP_PKEY **a, BIO *in);
  36
  37
  38  #include <openssl/x509.h>
  39
  40  EVP_PKEY *d2i_PrivateKey_ex_bio(BIO *bp, EVP_PKEY **a, OPENSSL_CTX *libctx,
  41                                  const char *propq);
  42  EVP_PKEY *d2i_PrivateKey_bio(BIO *bp, EVP_PKEY **a);
  43  EVP_PKEY *d2i_PrivateKey_ex_fp(FILE *fp, EVP_PKEY **a, OPENSSL_CTX *libctx,
  44                                 const char *propq);
  45  EVP_PKEY *d2i_PrivateKey_fp(FILE *fp, EVP_PKEY **a)
  46
  47  int i2d_PrivateKey_bio(BIO *bp, const EVP_PKEY *pkey);
  48  int i2d_PrivateKey_fp(FILE *fp, const EVP_PKEY *pkey);
  49
  50 =head1 DESCRIPTION
  51
  52 d2i_PrivateKey_ex() decodes a private key using algorithm I<type>. It attempts
  53 to use any key specific format or PKCS#8 unencrypted PrivateKeyInfo format. The
  54 I<type> parameter should be a public key algorithm constant such as
  55 B<EVP_PKEY_RSA>. An error occurs if the decoded key does not match I<type>. Some
  56 private key decoding implementations may use cryptographic algorithms (for
  57 example to automatically derive the public key if it is not explicitly
  58 included in the encoding). In this case the supplied library context I<libctx>
  59 and property query string I<propq> are used.
  60 d2i_PrivateKey() does the same as d2i_PrivateKey_ex() except that the default
  61 library context and property query string are used.
  62 d2i_PublicKey() does the same for public keys.
  63 d2i_KeyParams() does the same for key parameters.
  64
  65 The d2i_PrivateKey_ex_bio() and d2i_PrivateKey_bio() functions are similar to
  66 d2i_PrivateKey_ex() and d2i_PrivateKey() respectively except that they decode
  67 the data read from the given BIO. The d2i_PrivateKey_ex_fp() and
  68 d2i_PrivateKey_fp() functions are the same except that they read the data from
  69 the given FILE.
  70
  71 d2i_AutoPrivateKey_ex() and d2i_AutoPrivateKey() are similar to
  72 d2i_PrivateKey_ex() and d2i_PrivateKey() respectively except that they attempt
  73 to automatically detect the private key format.
  74
  75 i2d_PrivateKey() encodes I<a>. It uses a key specific format or, if none is
  76 defined for that key type, PKCS#8 unencrypted PrivateKeyInfo format.
  77 i2d_PublicKey() does the same for public keys.
  78 i2d_KeyParams() does the same for key parameters.
  79 These functions are similar to the d2i_X509() functions; see L<d2i_X509(3)>.
  80 i2d_PrivateKey_bio() and i2d_PrivateKey_fp() do the same thing except that they
  81 encode to a B<BIO> or B<FILE> respectrively. Again, these work similarly to the
  82 functions described in L<d2i_X509(3)>.
  83
  84 =head1 NOTES
  85
  86 All these functions use DER format and unencrypted keys. Applications wishing
  87 to encrypt or decrypt private keys should use other functions such as
  88 d2i_PKCS8PrivateKey() instead.
  89
  90 If the I<*a> is not NULL when calling d2i_PrivateKey() or d2i_AutoPrivateKey()
  91 (i.e. an existing structure is being reused) and the key format is PKCS#8
  92 then I<*a> will be freed and replaced on a successful call.
  93
  94 To decode a key with type B<EVP_PKEY_EC>, d2i_PublicKey() requires I<*a> to be
  95 a non-NULL EVP_PKEY structure assigned an EC_KEY structure referencing the proper
  96 EC_GROUP.
  97
  98 =head1 RETURN VALUES
  99
 100 The d2i_PrivateKey_ex(), d2i_PrivateKey(), d2i_AutoPrivateKey_ex(),
 101 d2i_AutoPrivateKey(), d2i_PrivateKey_ex_bio(), d2i_PrivateKey_bio(),
 102 d2i_PrivateKey_ex_fp(), d2i_PrivateKey_fp(), d2i_PublicKey(), d2i_KeyParams()
 103 and d2i_KeyParams_bio() functions return a valid B<EVP_KEY> structure or B<NULL>
 104 if an error occurs. The error code can be obtained by calling
 105 L<ERR_get_error(3)>.
 106
 107 i2d_PrivateKey(), i2d_PrivateKey_bio(), i2d_PrivateKey_fp(), i2d_PublicKey(),
 108 i2d_KeyParams() i2d_KeyParams_bio() return the number of bytes successfully
 109 encoded or a negative value if an error occurs. The error code can be obtained
 110 by calling L<ERR_get_error(3)>.
 111
 112 =head1 SEE ALSO
 113
 114 L<crypto(7)>,
 115 L<d2i_PKCS8PrivateKey_bio(3)>
 116
 117 =head1 HISTORY
 118
 119 d2i_PrivateKey_ex(), d2i_PrivateKey_ex_bio(), d2i_PrivateKey_ex_fp(), and
 120 d2i_AutoPrivateKey_ex() were added in OpenSSL 3.0.
 121
 122 =head1 COPYRIGHT
 123
 124 Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.
 125
 126 Licensed under the Apache License 2.0 (the "License").  You may not use
 127 this file except in compliance with the License.  You can obtain a copy
 128 in the file LICENSE in the source distribution or at
 129 L<https://www.openssl.org/source/license.html>.
 130
 131 =cut