1*4724848cSchristos=pod 2*4724848cSchristos 3*4724848cSchristos=head1 NAME 4*4724848cSchristos 5*4724848cSchristosd2i_PrivateKey, d2i_PublicKey, d2i_AutoPrivateKey, 6*4724848cSchristosi2d_PrivateKey, i2d_PublicKey, 7*4724848cSchristosd2i_PrivateKey_bio, d2i_PrivateKey_fp 8*4724848cSchristos- decode and encode functions for reading and saving EVP_PKEY structures 9*4724848cSchristos 10*4724848cSchristos=head1 SYNOPSIS 11*4724848cSchristos 12*4724848cSchristos #include <openssl/evp.h> 13*4724848cSchristos 14*4724848cSchristos EVP_PKEY *d2i_PrivateKey(int type, EVP_PKEY **a, const unsigned char **pp, 15*4724848cSchristos long length); 16*4724848cSchristos EVP_PKEY *d2i_PublicKey(int type, EVP_PKEY **a, const unsigned char **pp, 17*4724848cSchristos long length); 18*4724848cSchristos EVP_PKEY *d2i_AutoPrivateKey(EVP_PKEY **a, const unsigned char **pp, 19*4724848cSchristos long length); 20*4724848cSchristos int i2d_PrivateKey(EVP_PKEY *a, unsigned char **pp); 21*4724848cSchristos int i2d_PublicKey(EVP_PKEY *a, unsigned char **pp); 22*4724848cSchristos 23*4724848cSchristos EVP_PKEY *d2i_PrivateKey_bio(BIO *bp, EVP_PKEY **a); 24*4724848cSchristos EVP_PKEY *d2i_PrivateKey_fp(FILE *fp, EVP_PKEY **a) 25*4724848cSchristos 26*4724848cSchristos=head1 DESCRIPTION 27*4724848cSchristos 28*4724848cSchristosd2i_PrivateKey() decodes a private key using algorithm B<type>. It attempts to 29*4724848cSchristosuse any key specific format or PKCS#8 unencrypted PrivateKeyInfo format. The 30*4724848cSchristosB<type> parameter should be a public key algorithm constant such as 31*4724848cSchristosB<EVP_PKEY_RSA>. An error occurs if the decoded key does not match B<type>. 32*4724848cSchristosd2i_PublicKey() does the same for public keys. 33*4724848cSchristos 34*4724848cSchristosd2i_AutoPrivateKey() is similar to d2i_PrivateKey() except it attempts to 35*4724848cSchristosautomatically detect the private key format. 36*4724848cSchristos 37*4724848cSchristosi2d_PrivateKey() encodes B<key>. It uses a key specific format or, if none is 38*4724848cSchristosdefined for that key type, PKCS#8 unencrypted PrivateKeyInfo format. 39*4724848cSchristosi2d_PublicKey() does the same for public keys. 40*4724848cSchristos 41*4724848cSchristosThese functions are similar to the d2i_X509() functions; see L<d2i_X509(3)>. 42*4724848cSchristos 43*4724848cSchristos=head1 NOTES 44*4724848cSchristos 45*4724848cSchristosAll the functions that operate on data in memory update the data pointer I<*pp> 46*4724848cSchristosafter a successful operation, just like the other d2i and i2d functions; 47*4724848cSchristossee L<d2i_X509(3)>. 48*4724848cSchristos 49*4724848cSchristosAll these functions use DER format and unencrypted keys. Applications wishing 50*4724848cSchristosto encrypt or decrypt private keys should use other functions such as 51*4724848cSchristosd2i_PKCS8PrivateKey() instead. 52*4724848cSchristos 53*4724848cSchristosIf the B<*a> is not NULL when calling d2i_PrivateKey() or d2i_AutoPrivateKey() 54*4724848cSchristos(i.e. an existing structure is being reused) and the key format is PKCS#8 55*4724848cSchristosthen B<*a> will be freed and replaced on a successful call. 56*4724848cSchristos 57*4724848cSchristosTo decode a key with type B<EVP_PKEY_EC>, d2i_PublicKey() requires B<*a> to be 58*4724848cSchristosa non-NULL EVP_PKEY structure assigned an EC_KEY structure referencing the proper 59*4724848cSchristosEC_GROUP. 60*4724848cSchristos 61*4724848cSchristos=head1 RETURN VALUES 62*4724848cSchristos 63*4724848cSchristosThe d2i_PrivateKey(), d2i_AutoPrivateKey(), d2i_PrivateKey_bio(), d2i_PrivateKey_fp(), 64*4724848cSchristosand d2i_PublicKey() functions return a valid B<EVP_KEY> structure or B<NULL> if an 65*4724848cSchristoserror occurs. The error code can be obtained by calling L<ERR_get_error(3)>. 66*4724848cSchristos 67*4724848cSchristosi2d_PrivateKey() and i2d_PublicKey() return the number of bytes successfully 68*4724848cSchristosencoded or a negative value if an error occurs. The error code can be obtained 69*4724848cSchristosby calling L<ERR_get_error(3)>. 70*4724848cSchristos 71*4724848cSchristos=head1 SEE ALSO 72*4724848cSchristos 73*4724848cSchristosL<crypto(7)>, 74*4724848cSchristosL<d2i_PKCS8PrivateKey_bio(3)> 75*4724848cSchristos 76*4724848cSchristos=head1 COPYRIGHT 77*4724848cSchristos 78*4724848cSchristosCopyright 2017-2021 The OpenSSL Project Authors. All Rights Reserved. 79*4724848cSchristos 80*4724848cSchristosLicensed under the OpenSSL license (the "License"). You may not use 81*4724848cSchristosthis file except in compliance with the License. You can obtain a copy 82*4724848cSchristosin the file LICENSE in the source distribution or at 83*4724848cSchristosL<https://www.openssl.org/source/license.html>. 84*4724848cSchristos 85*4724848cSchristos=cut 86