doc/man3/PEM_read_bio_PrivateKey.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 pem_password_cb,
   6 PEM_read_bio_PrivateKey_ex, PEM_read_bio_PrivateKey,
   7 PEM_read_PrivateKey_ex, PEM_read_PrivateKey,
   8 PEM_write_bio_PrivateKey_ex, PEM_write_bio_PrivateKey,
   9 PEM_write_bio_PrivateKey_traditional,
  10 PEM_write_PrivateKey_ex, PEM_write_PrivateKey,
  11 PEM_write_bio_PKCS8PrivateKey, PEM_write_PKCS8PrivateKey,
  12 PEM_write_bio_PKCS8PrivateKey_nid, PEM_write_PKCS8PrivateKey_nid,
  13 PEM_read_bio_PUBKEY_ex, PEM_read_bio_PUBKEY,
  14 PEM_read_PUBKEY_ex, PEM_read_PUBKEY,
  15 PEM_write_bio_PUBKEY_ex, PEM_write_bio_PUBKEY,
  16 PEM_write_PUBKEY_ex, PEM_write_PUBKEY,
  17 PEM_read_bio_RSAPrivateKey, PEM_read_RSAPrivateKey,
  18 PEM_write_bio_RSAPrivateKey, PEM_write_RSAPrivateKey,
  19 PEM_read_bio_RSAPublicKey, PEM_read_RSAPublicKey, PEM_write_bio_RSAPublicKey,
  20 PEM_write_RSAPublicKey, PEM_read_bio_RSA_PUBKEY, PEM_read_RSA_PUBKEY,
  21 PEM_write_bio_RSA_PUBKEY, PEM_write_RSA_PUBKEY, PEM_read_bio_DSAPrivateKey,
  22 PEM_read_DSAPrivateKey, PEM_write_bio_DSAPrivateKey, PEM_write_DSAPrivateKey,
  23 PEM_read_bio_DSA_PUBKEY, PEM_read_DSA_PUBKEY, PEM_write_bio_DSA_PUBKEY,
  24 PEM_write_DSA_PUBKEY, PEM_read_bio_Parameters_ex, PEM_read_bio_Parameters,
  25 PEM_write_bio_Parameters, PEM_read_bio_DSAparams, PEM_read_DSAparams,
  26 PEM_write_bio_DSAparams, PEM_write_DSAparams, PEM_read_bio_DHparams,
  27 PEM_read_DHparams, PEM_write_bio_DHparams, PEM_write_DHparams,
  28 PEM_read_bio_X509, PEM_read_X509, PEM_write_bio_X509, PEM_write_X509,
  29 PEM_read_bio_X509_AUX, PEM_read_X509_AUX, PEM_write_bio_X509_AUX,
  30 PEM_write_X509_AUX, PEM_read_bio_X509_REQ, PEM_read_X509_REQ,
  31 PEM_write_bio_X509_REQ, PEM_write_X509_REQ, PEM_write_bio_X509_REQ_NEW,
  32 PEM_write_X509_REQ_NEW, PEM_read_bio_X509_CRL, PEM_read_X509_CRL,
  33 PEM_write_bio_X509_CRL, PEM_write_X509_CRL, PEM_read_bio_PKCS7, PEM_read_PKCS7,
  34 PEM_write_bio_PKCS7, PEM_write_PKCS7 - PEM routines
  35
  36 =head1 SYNOPSIS
  37
  38  #include <openssl/pem.h>
  39
  40  typedef int pem_password_cb(char *buf, int size, int rwflag, void *u);
  41
  42  EVP_PKEY *PEM_read_bio_PrivateKey_ex(BIO *bp, EVP_PKEY **x,
  43                                       pem_password_cb *cb, void *u,
  44                                       OSSL_LIB_CTX *libctx, const char *propq);
  45  EVP_PKEY *PEM_read_bio_PrivateKey(BIO *bp, EVP_PKEY **x,
  46                                    pem_password_cb *cb, void *u);
  47  EVP_PKEY *PEM_read_PrivateKey_ex(FILE *fp, EVP_PKEY **x, pem_password_cb *cb,
  48                                   void *u, OSSL_LIB_CTX *libctx,
  49                                   const char *propq);
  50  EVP_PKEY *PEM_read_PrivateKey(FILE *fp, EVP_PKEY **x,
  51                                pem_password_cb *cb, void *u);
  52  int PEM_write_bio_PrivateKey_ex(BIO *bp, const EVP_PKEY *x,
  53                                  const EVP_CIPHER *enc,
  54                                  unsigned char *kstr, int klen,
  55                                  pem_password_cb *cb, void *u,
  56                                  OSSL_LIB_CTX *libctx, const char *propq);
  57  int PEM_write_bio_PrivateKey(BIO *bp, const EVP_PKEY *x, const EVP_CIPHER *enc,
  58                               unsigned char *kstr, int klen,
  59                               pem_password_cb *cb, void *u);
  60  int PEM_write_bio_PrivateKey_traditional(BIO *bp, EVP_PKEY *x,
  61                                           const EVP_CIPHER *enc,
  62                                           unsigned char *kstr, int klen,
  63                                           pem_password_cb *cb, void *u);
  64  int PEM_write_PrivateKey_ex(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
  65                              unsigned char *kstr, int klen,
  66                              pem_password_cb *cb, void *u,
  67                              OSSL_LIB_CTX *libctx, const char *propq);
  68  int PEM_write_PrivateKey(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
  69                           unsigned char *kstr, int klen,
  70                           pem_password_cb *cb, void *u);
  71  int PEM_write_bio_PKCS8PrivateKey(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
  72                                    char *kstr, int klen,
  73                                    pem_password_cb *cb, void *u);
  74  int PEM_write_PKCS8PrivateKey(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
  75                                char *kstr, int klen,
  76                                pem_password_cb *cb, void *u);
  77  int PEM_write_bio_PKCS8PrivateKey_nid(BIO *bp, const EVP_PKEY *x, int nid,
  78                                        char *kstr, int klen,
  79                                        pem_password_cb *cb, void *u);
  80  int PEM_write_PKCS8PrivateKey_nid(FILE *fp, const EVP_PKEY *x, int nid,
  81                                    char *kstr, int klen,
  82                                    pem_password_cb *cb, void *u);
  83
  84  EVP_PKEY *PEM_read_bio_PUBKEY_ex(BIO *bp, EVP_PKEY **x,
  85                                   pem_password_cb *cb, void *u,
  86                                   OSSL_LIB_CTX *libctx, const char *propq);
  87  EVP_PKEY *PEM_read_bio_PUBKEY(BIO *bp, EVP_PKEY **x,
  88                                pem_password_cb *cb, void *u);
  89  EVP_PKEY *PEM_read_PUBKEY_ex(FILE *fp, EVP_PKEY **x,
  90                               pem_password_cb *cb, void *u,
  91                               OSSL_LIB_CTX *libctx, const char *propq);
  92  EVP_PKEY *PEM_read_PUBKEY(FILE *fp, EVP_PKEY **x,
  93                            pem_password_cb *cb, void *u);
  94  int PEM_write_bio_PUBKEY_ex(BIO *bp, EVP_PKEY *x,
  95                              OSSL_LIB_CTX *libctx, const char *propq);
  96  int PEM_write_bio_PUBKEY(BIO *bp, EVP_PKEY *x);
  97  int PEM_write_PUBKEY_ex(FILE *fp, EVP_PKEY *x,
  98                          OSSL_LIB_CTX *libctx, const char *propq);
  99  int PEM_write_PUBKEY(FILE *fp, EVP_PKEY *x);
 100
 101  EVP_PKEY *PEM_read_bio_Parameters_ex(BIO *bp, EVP_PKEY **x,
 102                                       OSSL_LIB_CTX *libctx, const char *propq);
 103  EVP_PKEY *PEM_read_bio_Parameters(BIO *bp, EVP_PKEY **x);
 104  int PEM_write_bio_Parameters(BIO *bp, const EVP_PKEY *x);
 105
 106  X509 *PEM_read_bio_X509(BIO *bp, X509 **x, pem_password_cb *cb, void *u);
 107  X509 *PEM_read_X509(FILE *fp, X509 **x, pem_password_cb *cb, void *u);
 108  int PEM_write_bio_X509(BIO *bp, X509 *x);
 109  int PEM_write_X509(FILE *fp, X509 *x);
 110
 111  X509 *PEM_read_bio_X509_AUX(BIO *bp, X509 **x, pem_password_cb *cb, void *u);
 112  X509 *PEM_read_X509_AUX(FILE *fp, X509 **x, pem_password_cb *cb, void *u);
 113  int PEM_write_bio_X509_AUX(BIO *bp, X509 *x);
 114  int PEM_write_X509_AUX(FILE *fp, X509 *x);
 115
 116  X509_REQ *PEM_read_bio_X509_REQ(BIO *bp, X509_REQ **x,
 117                                  pem_password_cb *cb, void *u);
 118  X509_REQ *PEM_read_X509_REQ(FILE *fp, X509_REQ **x,
 119                              pem_password_cb *cb, void *u);
 120  int PEM_write_bio_X509_REQ(BIO *bp, X509_REQ *x);
 121  int PEM_write_X509_REQ(FILE *fp, X509_REQ *x);
 122  int PEM_write_bio_X509_REQ_NEW(BIO *bp, X509_REQ *x);
 123  int PEM_write_X509_REQ_NEW(FILE *fp, X509_REQ *x);
 124
 125  X509_CRL *PEM_read_bio_X509_CRL(BIO *bp, X509_CRL **x,
 126                                  pem_password_cb *cb, void *u);
 127  X509_CRL *PEM_read_X509_CRL(FILE *fp, X509_CRL **x,
 128                              pem_password_cb *cb, void *u);
 129  int PEM_write_bio_X509_CRL(BIO *bp, X509_CRL *x);
 130  int PEM_write_X509_CRL(FILE *fp, X509_CRL *x);
 131
 132  PKCS7 *PEM_read_bio_PKCS7(BIO *bp, PKCS7 **x, pem_password_cb *cb, void *u);
 133  PKCS7 *PEM_read_PKCS7(FILE *fp, PKCS7 **x, pem_password_cb *cb, void *u);
 134  int PEM_write_bio_PKCS7(BIO *bp, PKCS7 *x);
 135  int PEM_write_PKCS7(FILE *fp, PKCS7 *x);
 136
 137 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
 138 B<OPENSSL_API_COMPAT> with a suitable version value, see
 139 L<openssl_user_macros(7)>:
 140
 141  RSA *PEM_read_bio_RSAPrivateKey(BIO *bp, RSA **x,
 142                                  pem_password_cb *cb, void *u);
 143  RSA *PEM_read_RSAPrivateKey(FILE *fp, RSA **x,
 144                              pem_password_cb *cb, void *u);
 145  int PEM_write_bio_RSAPrivateKey(BIO *bp, RSA *x, const EVP_CIPHER *enc,
 146                                  unsigned char *kstr, int klen,
 147                                  pem_password_cb *cb, void *u);
 148  int PEM_write_RSAPrivateKey(FILE *fp, RSA *x, const EVP_CIPHER *enc,
 149                              unsigned char *kstr, int klen,
 150                              pem_password_cb *cb, void *u);
 151
 152  RSA *PEM_read_bio_RSAPublicKey(BIO *bp, RSA **x,
 153                                 pem_password_cb *cb, void *u);
 154  RSA *PEM_read_RSAPublicKey(FILE *fp, RSA **x,
 155                             pem_password_cb *cb, void *u);
 156  int PEM_write_bio_RSAPublicKey(BIO *bp, RSA *x);
 157  int PEM_write_RSAPublicKey(FILE *fp, RSA *x);
 158
 159  RSA *PEM_read_bio_RSA_PUBKEY(BIO *bp, RSA **x,
 160                               pem_password_cb *cb, void *u);
 161  RSA *PEM_read_RSA_PUBKEY(FILE *fp, RSA **x,
 162                           pem_password_cb *cb, void *u);
 163  int PEM_write_bio_RSA_PUBKEY(BIO *bp, RSA *x);
 164  int PEM_write_RSA_PUBKEY(FILE *fp, RSA *x);
 165
 166  DSA *PEM_read_bio_DSAPrivateKey(BIO *bp, DSA **x,
 167                                  pem_password_cb *cb, void *u);
 168  DSA *PEM_read_DSAPrivateKey(FILE *fp, DSA **x,
 169                              pem_password_cb *cb, void *u);
 170  int PEM_write_bio_DSAPrivateKey(BIO *bp, DSA *x, const EVP_CIPHER *enc,
 171                                  unsigned char *kstr, int klen,
 172                                  pem_password_cb *cb, void *u);
 173  int PEM_write_DSAPrivateKey(FILE *fp, DSA *x, const EVP_CIPHER *enc,
 174                              unsigned char *kstr, int klen,
 175                              pem_password_cb *cb, void *u);
 176
 177  DSA *PEM_read_bio_DSA_PUBKEY(BIO *bp, DSA **x,
 178                               pem_password_cb *cb, void *u);
 179  DSA *PEM_read_DSA_PUBKEY(FILE *fp, DSA **x,
 180                           pem_password_cb *cb, void *u);
 181  int PEM_write_bio_DSA_PUBKEY(BIO *bp, DSA *x);
 182  int PEM_write_DSA_PUBKEY(FILE *fp, DSA *x);
 183  DSA *PEM_read_bio_DSAparams(BIO *bp, DSA **x, pem_password_cb *cb, void *u);
 184  DSA *PEM_read_DSAparams(FILE *fp, DSA **x, pem_password_cb *cb, void *u);
 185  int PEM_write_bio_DSAparams(BIO *bp, DSA *x);
 186  int PEM_write_DSAparams(FILE *fp, DSA *x);
 187
 188  DH *PEM_read_bio_DHparams(BIO *bp, DH **x, pem_password_cb *cb, void *u);
 189  DH *PEM_read_DHparams(FILE *fp, DH **x, pem_password_cb *cb, void *u);
 190  int PEM_write_bio_DHparams(BIO *bp, DH *x);
 191  int PEM_write_DHparams(FILE *fp, DH *x);
 192
 193 =head1 DESCRIPTION
 194
 195 All of the functions described on this page that have a I<TYPE> of B<DH>, B<DSA>
 196 and B<RSA> are deprecated. Applications should use OSSL_ENCODER_to_bio() and
 197 OSSL_DECODER_from_bio() instead.
 198
 199 The PEM functions read or write structures in PEM format. In
 200 this sense PEM format is simply base64 encoded data surrounded
 201 by header lines.
 202
 203 For more details about the meaning of arguments see the
 204 B<PEM FUNCTION ARGUMENTS> section.
 205
 206 Each operation has four functions associated with it. For
 207 brevity the term "B<I<TYPE>> functions" will be used below to collectively
 208 refer to the B<PEM_read_bio_I<TYPE>>(), B<PEM_read_I<TYPE>>(),
 209 B<PEM_write_bio_I<TYPE>>(), and B<PEM_write_I<TYPE>>() functions.
 210
 211 Some operations have additional variants that take a library context I<libctx>
 212 and a property query string I<propq>.
 213
 214 The B<PrivateKey> functions read or write a private key in PEM format using
 215 an EVP_PKEY structure. The write routines use PKCS#8 private key format and are
 216 equivalent to PEM_write_bio_PKCS8PrivateKey(). The read functions transparently
 217 handle traditional and PKCS#8 format encrypted and unencrypted keys.
 218
 219 PEM_write_bio_PrivateKey_traditional() writes out a private key in the
 220 "traditional" format with a simple private key marker and should only
 221 be used for compatibility with legacy programs.
 222
 223 PEM_write_bio_PKCS8PrivateKey() and PEM_write_PKCS8PrivateKey() write a private
 224 key in an EVP_PKEY structure in PKCS#8 EncryptedPrivateKeyInfo format using
 225 PKCS#5 v2.0 password based encryption algorithms. The I<cipher> argument
 226 specifies the encryption algorithm to use: unlike some other PEM routines the
 227 encryption is applied at the PKCS#8 level and not in the PEM headers. If
 228 I<cipher> is NULL then no encryption is used and a PKCS#8 PrivateKeyInfo
 229 structure is used instead.
 230
 231 PEM_write_bio_PKCS8PrivateKey_nid() and PEM_write_PKCS8PrivateKey_nid()
 232 also write out a private key as a PKCS#8 EncryptedPrivateKeyInfo however
 233 it uses PKCS#5 v1.5 or PKCS#12 encryption algorithms instead. The algorithm
 234 to use is specified in the I<nid> parameter and should be the NID of the
 235 corresponding OBJECT IDENTIFIER (see NOTES section).
 236
 237 The B<PUBKEY> functions process a public key using an EVP_PKEY
 238 structure. The public key is encoded as a SubjectPublicKeyInfo
 239 structure.
 240
 241 The B<RSAPrivateKey> functions process an RSA private key using an
 242 RSA structure. The write routines uses traditional format. The read
 243 routines handles the same formats as the B<PrivateKey>
 244 functions but an error occurs if the private key is not RSA.
 245
 246 The B<RSAPublicKey> functions process an RSA public key using an
 247 RSA structure. The public key is encoded using a PKCS#1 RSAPublicKey
 248 structure.
 249
 250 The B<RSA_PUBKEY> functions also process an RSA public key using
 251 an RSA structure. However, the public key is encoded using a
 252 SubjectPublicKeyInfo structure and an error occurs if the public
 253 key is not RSA.
 254
 255 The B<DSAPrivateKey> functions process a DSA private key using a
 256 DSA structure. The write routines uses traditional format. The read
 257 routines handles the same formats as the B<PrivateKey>
 258 functions but an error occurs if the private key is not DSA.
 259
 260 The B<DSA_PUBKEY> functions process a DSA public key using
 261 a DSA structure. The public key is encoded using a
 262 SubjectPublicKeyInfo structure and an error occurs if the public
 263 key is not DSA.
 264
 265 The B<Parameters> functions read or write key parameters in PEM format using
 266 an EVP_PKEY structure.  The encoding depends on the type of key; for DSA key
 267 parameters, it will be a Dss-Parms structure as defined in RFC2459, and for DH
 268 key parameters, it will be a PKCS#3 DHparameter structure.  I<These functions
 269 only exist for the B<BIO> type>.
 270
 271 The B<DSAparams> functions process DSA parameters using a DSA
 272 structure. The parameters are encoded using a Dss-Parms structure
 273 as defined in RFC2459.
 274
 275 The B<DHparams> functions process DH parameters using a DH
 276 structure. The parameters are encoded using a PKCS#3 DHparameter
 277 structure.
 278
 279 The B<X509> functions process an X509 certificate using an X509
 280 structure. They will also process a trusted X509 certificate but
 281 any trust settings are discarded.
 282
 283 The B<X509_AUX> functions process a trusted X509 certificate using
 284 an X509 structure.
 285
 286 The B<X509_REQ> and B<X509_REQ_NEW> functions process a PKCS#10
 287 certificate request using an X509_REQ structure. The B<X509_REQ>
 288 write functions use B<CERTIFICATE REQUEST> in the header whereas
 289 the B<X509_REQ_NEW> functions use B<NEW CERTIFICATE REQUEST>
 290 (as required by some CAs). The B<X509_REQ> read functions will
 291 handle either form so there are no B<X509_REQ_NEW> read functions.
 292
 293 The B<X509_CRL> functions process an X509 CRL using an X509_CRL
 294 structure.
 295
 296 The B<PKCS7> functions process a PKCS#7 ContentInfo using a PKCS7
 297 structure.
 298
 299 =head1 PEM FUNCTION ARGUMENTS
 300
 301 The PEM functions have many common arguments.
 302
 303 The I<bp> BIO parameter (if present) specifies the BIO to read from
 304 or write to.
 305
 306 The I<fp> FILE parameter (if present) specifies the FILE pointer to
 307 read from or write to.
 308
 309 The PEM read functions all take an argument I<B<TYPE> **x> and return
 310 a I<B<TYPE> *> pointer. Where I<B<TYPE>> is whatever structure the function
 311 uses. If I<x> is NULL then the parameter is ignored. If I<x> is not
 312 NULL but I<*x> is NULL then the structure returned will be written
 313 to I<*x>. If neither I<x> nor I<*x> is NULL then an attempt is made
 314 to reuse the structure at I<*x> (but see BUGS and EXAMPLES sections).
 315 Irrespective of the value of I<x> a pointer to the structure is always
 316 returned (or NULL if an error occurred).
 317
 318 The PEM functions which write private keys take an I<enc> parameter
 319 which specifies the encryption algorithm to use, encryption is done
 320 at the PEM level. If this parameter is set to NULL then the private
 321 key is written in unencrypted form.
 322
 323 The I<cb> argument is the callback to use when querying for the pass
 324 phrase used for encrypted PEM structures (normally only private keys).
 325
 326 For the PEM write routines if the I<kstr> parameter is not NULL then
 327 I<klen> bytes at I<kstr> are used as the passphrase and I<cb> is
 328 ignored.
 329
 330 If the I<cb> parameters is set to NULL and the I<u> parameter is not
 331 NULL then the I<u> parameter is interpreted as a null terminated string
 332 to use as the passphrase. If both I<cb> and I<u> are NULL then the
 333 default callback routine is used which will typically prompt for the
 334 passphrase on the current terminal with echoing turned off.
 335
 336 The default passphrase callback is sometimes inappropriate (for example
 337 in a GUI application) so an alternative can be supplied. The callback
 338 routine has the following form:
 339
 340  int cb(char *buf, int size, int rwflag, void *u);
 341
 342 I<buf> is the buffer to write the passphrase to. I<size> is the maximum
 343 length of the passphrase (i.e. the size of buf). I<rwflag> is a flag
 344 which is set to 0 when reading and 1 when writing. A typical routine
 345 will ask the user to verify the passphrase (for example by prompting
 346 for it twice) if I<rwflag> is 1. The I<u> parameter has the same
 347 value as the I<u> parameter passed to the PEM routine. It allows
 348 arbitrary data to be passed to the callback by the application
 349 (for example a window handle in a GUI application). The callback
 350 I<must> return the number of characters in the passphrase or -1 if
 351 an error occurred.
 352
 353 Some implementations may need to use cryptographic algorithms during their
 354 operation. If this is the case and I<libctx> and I<propq> parameters have been
 355 passed then any algorithm fetches will use that library context and property
 356 query string. Otherwise the default library context and property query string
 357 will be used.
 358
 359 =head1 NOTES
 360
 361 The old B<PrivateKey> write routines are retained for compatibility.
 362 New applications should write private keys using the
 363 PEM_write_bio_PKCS8PrivateKey() or PEM_write_PKCS8PrivateKey() routines
 364 because they are more secure (they use an iteration count of 2048 whereas
 365 the traditional routines use a count of 1) unless compatibility with older
 366 versions of OpenSSL is important.
 367
 368 The B<PrivateKey> read routines can be used in all applications because
 369 they handle all formats transparently.
 370
 371 A frequent cause of problems is attempting to use the PEM routines like
 372 this:
 373
 374  X509 *x;
 375
 376  PEM_read_bio_X509(bp, &x, 0, NULL);
 377
 378 this is a bug because an attempt will be made to reuse the data at I<x>
 379 which is an uninitialised pointer.
 380
 381 These functions make no assumption regarding the pass phrase received from the
 382 password callback.
 383 It will simply be treated as a byte sequence.
 384
 385 =head1 PEM ENCRYPTION FORMAT
 386
 387 These old B<PrivateKey> routines use a non standard technique for encryption.
 388
 389 The private key (or other data) takes the following form:
 390
 391  -----BEGIN RSA PRIVATE KEY-----
 392  Proc-Type: 4,ENCRYPTED
 393  DEK-Info: DES-EDE3-CBC,3F17F5316E2BAC89
 394
 395  ...base64 encoded data...
 396  -----END RSA PRIVATE KEY-----
 397
 398 The line beginning with I<Proc-Type> contains the version and the
 399 protection on the encapsulated data. The line beginning I<DEK-Info>
 400 contains two comma separated values: the encryption algorithm name as
 401 used by EVP_get_cipherbyname() and an initialization vector used by the
 402 cipher encoded as a set of hexadecimal digits. After those two lines is
 403 the base64-encoded encrypted data.
 404
 405 The encryption key is derived using EVP_BytesToKey(). The cipher's
 406 initialization vector is passed to EVP_BytesToKey() as the I<salt>
 407 parameter. Internally, B<PKCS5_SALT_LEN> bytes of the salt are used
 408 (regardless of the size of the initialization vector). The user's
 409 password is passed to EVP_BytesToKey() using the I<data> and I<datal>
 410 parameters. Finally, the library uses an iteration count of 1 for
 411 EVP_BytesToKey().
 412
 413 The I<key> derived by EVP_BytesToKey() along with the original initialization
 414 vector is then used to decrypt the encrypted data. The I<iv> produced by
 415 EVP_BytesToKey() is not utilized or needed, and NULL should be passed to
 416 the function.
 417
 418 The pseudo code to derive the key would look similar to:
 419
 420  EVP_CIPHER* cipher = EVP_des_ede3_cbc();
 421  EVP_MD* md = EVP_md5();
 422
 423  unsigned int nkey = EVP_CIPHER_get_key_length(cipher);
 424  unsigned int niv = EVP_CIPHER_get_iv_length(cipher);
 425  unsigned char key[nkey];
 426  unsigned char iv[niv];
 427
 428  memcpy(iv, HexToBin("3F17F5316E2BAC89"), niv);
 429  rc = EVP_BytesToKey(cipher, md, iv /*salt*/, pword, plen, 1, key, NULL /*iv*/);
 430  if (rc != nkey)
 431      /* Error */
 432
 433  /* On success, use key and iv to initialize the cipher */
 434
 435 =head1 BUGS
 436
 437 The PEM read routines in some versions of OpenSSL will not correctly reuse
 438 an existing structure. Therefore, the following:
 439
 440  PEM_read_bio_X509(bp, &x, 0, NULL);
 441
 442 where I<x> already contains a valid certificate, may not work, whereas:
 443
 444  X509_free(x);
 445  x = PEM_read_bio_X509(bp, NULL, 0, NULL);
 446
 447 is guaranteed to work.
 448
 449 =head1 RETURN VALUES
 450
 451 The read routines return either a pointer to the structure read or NULL
 452 if an error occurred.
 453
 454 The write routines return 1 for success or 0 for failure.
 455
 456 =head1 EXAMPLES
 457
 458 Although the PEM routines take several arguments in almost all applications
 459 most of them are set to 0 or NULL.
 460
 461 To read a certificate with a library context in PEM format from a BIO:
 462
 463  X509 *x = X509_new_ex(libctx, NULL);
 464
 465  if (x == NULL)
 466      /* Error */
 467
 468  if (PEM_read_bio_X509(bp, &x, 0, NULL) == NULL)
 469      /* Error */
 470
 471 Read a certificate in PEM format from a BIO:
 472
 473  X509 *x;
 474
 475  x = PEM_read_bio_X509(bp, NULL, 0, NULL);
 476  if (x == NULL)
 477      /* Error */
 478
 479 Alternative method:
 480
 481  X509 *x = NULL;
 482
 483  if (!PEM_read_bio_X509(bp, &x, 0, NULL))
 484      /* Error */
 485
 486 Write a certificate to a BIO:
 487
 488  if (!PEM_write_bio_X509(bp, x))
 489      /* Error */
 490
 491 Write a private key (using traditional format) to a BIO using
 492 triple DES encryption, the pass phrase is prompted for:
 493
 494  if (!PEM_write_bio_PrivateKey(bp, key, EVP_des_ede3_cbc(), NULL, 0, 0, NULL))
 495      /* Error */
 496
 497 Write a private key (using PKCS#8 format) to a BIO using triple
 498 DES encryption, using the pass phrase "hello":
 499
 500  if (!PEM_write_bio_PKCS8PrivateKey(bp, key, EVP_des_ede3_cbc(),
 501                                     NULL, 0, 0, "hello"))
 502      /* Error */
 503
 504 Read a private key from a BIO using a pass phrase callback:
 505
 506  key = PEM_read_bio_PrivateKey(bp, NULL, pass_cb, "My Private Key");
 507  if (key == NULL)
 508      /* Error */
 509
 510 Skeleton pass phrase callback:
 511
 512  int pass_cb(char *buf, int size, int rwflag, void *u)
 513  {
 514
 515      /* We'd probably do something else if 'rwflag' is 1 */
 516      printf("Enter pass phrase for \"%s\"\n", (char *)u);
 517
 518      /* get pass phrase, length 'len' into 'tmp' */
 519      char *tmp = "hello";
 520      if (tmp == NULL) /* An error occurred */
 521          return -1;
 522
 523      size_t len = strlen(tmp);
 524
 525      if (len > size)
 526          len = size;
 527      memcpy(buf, tmp, len);
 528      return len;
 529  }
 530
 531 =head1 SEE ALSO
 532
 533 L<EVP_EncryptInit(3)>, L<EVP_BytesToKey(3)>,
 534 L<passphrase-encoding(7)>
 535
 536 =head1 HISTORY
 537
 538 The old Netscape certificate sequences were no longer documented
 539 in OpenSSL 1.1.0; applications should use the PKCS7 standard instead
 540 as they will be formally deprecated in a future releases.
 541
 542 PEM_read_bio_PrivateKey_ex(), PEM_read_PrivateKey_ex(),
 543 PEM_read_bio_PUBKEY_ex(), PEM_read_PUBKEY_ex() and
 544 PEM_read_bio_Parameters_ex() were introduced in OpenSSL 3.0.
 545
 546 The functions PEM_read_bio_RSAPrivateKey(), PEM_read_RSAPrivateKey(),
 547 PEM_write_bio_RSAPrivateKey(), PEM_write_RSAPrivateKey(),
 548 PEM_read_bio_RSAPublicKey(), PEM_read_RSAPublicKey(),
 549 PEM_write_bio_RSAPublicKey(), PEM_write_RSAPublicKey(),
 550 PEM_read_bio_RSA_PUBKEY(), PEM_read_RSA_PUBKEY(),
 551 PEM_write_bio_RSA_PUBKEY(), PEM_write_RSA_PUBKEY(),
 552 PEM_read_bio_DSAPrivateKey(), PEM_read_DSAPrivateKey(),
 553 PEM_write_bio_DSAPrivateKey(), PEM_write_DSAPrivateKey(),
 554 PEM_read_bio_DSA_PUBKEY(), PEM_read_DSA_PUBKEY(),
 555 PEM_write_bio_DSA_PUBKEY(), PEM_write_DSA_PUBKEY();
 556 PEM_read_bio_DSAparams(), PEM_read_DSAparams(),
 557 PEM_write_bio_DSAparams(), PEM_write_DSAparams(),
 558 PEM_read_bio_DHparams(), PEM_read_DHparams(),
 559 PEM_write_bio_DHparams() and PEM_write_DHparams() were deprecated in 3.0.
 560
 561
 562 =head1 COPYRIGHT
 563
 564 Copyright 2001-2021 The OpenSSL Project Authors. All Rights Reserved.
 565
 566 Licensed under the Apache License 2.0 (the "License").  You may not use
 567 this file except in compliance with the License.  You can obtain a copy
 568 in the file LICENSE in the source distribution or at
 569 L<https://www.openssl.org/source/license.html>.
 570
 571 =cut