Latest update.
This commit is contained in:
+66
-24
@@ -2,21 +2,29 @@
|
||||
|
||||
=head1 NAME
|
||||
|
||||
d2i_PrivateKey, d2i_PublicKey, d2i_KeyParams, d2i_AutoPrivateKey,
|
||||
i2d_PrivateKey, i2d_PublicKey, i2d_KeyParams, i2d_KeyParams_bio,
|
||||
d2i_PrivateKey_bio, d2i_PrivateKey_fp, d2i_KeyParams_bio
|
||||
d2i_PrivateKey_ex, d2i_PrivateKey, d2i_PublicKey, d2i_KeyParams,
|
||||
d2i_AutoPrivateKey_ex, d2i_AutoPrivateKey, i2d_PrivateKey, i2d_PublicKey,
|
||||
i2d_KeyParams, i2d_KeyParams_bio, d2i_PrivateKey_ex_bio, d2i_PrivateKey_bio,
|
||||
d2i_PrivateKey_ex_fp, d2i_PrivateKey_fp, d2i_KeyParams_bio, i2d_PrivateKey_bio,
|
||||
i2d_PrivateKey_fp
|
||||
- decode and encode functions for reading and saving EVP_PKEY structures
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
#include <openssl/evp.h>
|
||||
|
||||
EVP_PKEY *d2i_PrivateKey_ex(int type, EVP_PKEY **a, const unsigned char **pp,
|
||||
long length, OPENSSL_CTX *libctx,
|
||||
const char *propq);
|
||||
EVP_PKEY *d2i_PrivateKey(int type, EVP_PKEY **a, const unsigned char **pp,
|
||||
long length);
|
||||
EVP_PKEY *d2i_PublicKey(int type, EVP_PKEY **a, const unsigned char **pp,
|
||||
long length);
|
||||
EVP_PKEY *d2i_KeyParams(int type, EVP_PKEY **a, const unsigned char **pp,
|
||||
long length);
|
||||
EVP_PKEY *d2i_AutoPrivateKey_ex(EVP_PKEY **a, const unsigned char **pp,
|
||||
long length, OPENSSL_CTX *libctx,
|
||||
const char *propq);
|
||||
EVP_PKEY *d2i_AutoPrivateKey(EVP_PKEY **a, const unsigned char **pp,
|
||||
long length);
|
||||
|
||||
@@ -24,28 +32,54 @@ d2i_PrivateKey_bio, d2i_PrivateKey_fp, d2i_KeyParams_bio
|
||||
int i2d_PublicKey(const EVP_PKEY *a, unsigned char **pp);
|
||||
int i2d_KeyParams(const EVP_PKEY *a, unsigned char **pp);
|
||||
int i2d_KeyParams_bio(BIO *bp, const EVP_PKEY *pkey);
|
||||
|
||||
EVP_PKEY *d2i_PrivateKey_bio(BIO *bp, EVP_PKEY **a);
|
||||
EVP_PKEY *d2i_PrivateKey_fp(FILE *fp, EVP_PKEY **a)
|
||||
EVP_PKEY *d2i_KeyParams_bio(int type, EVP_PKEY **a, BIO *in);
|
||||
|
||||
|
||||
#include <openssl/x509.h>
|
||||
|
||||
EVP_PKEY *d2i_PrivateKey_ex_bio(BIO *bp, EVP_PKEY **a, OPENSSL_CTX *libctx,
|
||||
const char *propq);
|
||||
EVP_PKEY *d2i_PrivateKey_bio(BIO *bp, EVP_PKEY **a);
|
||||
EVP_PKEY *d2i_PrivateKey_ex_fp(FILE *fp, EVP_PKEY **a, OPENSSL_CTX *libctx,
|
||||
const char *propq);
|
||||
EVP_PKEY *d2i_PrivateKey_fp(FILE *fp, EVP_PKEY **a)
|
||||
|
||||
int i2d_PrivateKey_bio(BIO *bp, const EVP_PKEY *pkey);
|
||||
int i2d_PrivateKey_fp(FILE *fp, const EVP_PKEY *pkey);
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
d2i_PrivateKey() decodes a private key using algorithm B<type>. It attempts to
|
||||
use any key specific format or PKCS#8 unencrypted PrivateKeyInfo format. The
|
||||
B<type> parameter should be a public key algorithm constant such as
|
||||
B<EVP_PKEY_RSA>. An error occurs if the decoded key does not match B<type>.
|
||||
d2i_PrivateKey_ex() decodes a private key using algorithm I<type>. It attempts
|
||||
to use any key specific format or PKCS#8 unencrypted PrivateKeyInfo format. The
|
||||
I<type> parameter should be a public key algorithm constant such as
|
||||
B<EVP_PKEY_RSA>. An error occurs if the decoded key does not match I<type>. Some
|
||||
private key decoding implementations may use cryptographic algorithms (for
|
||||
example to automatically derive the public key if it is not explicitly
|
||||
included in the encoding). In this case the supplied library context I<libctx>
|
||||
and property query string I<propq> are used.
|
||||
d2i_PrivateKey() does the same as d2i_PrivateKey_ex() except that the default
|
||||
library context and property query string are used.
|
||||
d2i_PublicKey() does the same for public keys.
|
||||
d2i_KeyParams() does the same for key parameters.
|
||||
|
||||
d2i_AutoPrivateKey() is similar to d2i_PrivateKey() except it attempts to
|
||||
automatically detect the private key format.
|
||||
The d2i_PrivateKey_ex_bio() and d2i_PrivateKey_bio() functions are similar to
|
||||
d2i_PrivateKey_ex() and d2i_PrivateKey() respectively except that they decode
|
||||
the data read from the given BIO. The d2i_PrivateKey_ex_fp() and
|
||||
d2i_PrivateKey_fp() functions are the same except that they read the data from
|
||||
the given FILE.
|
||||
|
||||
i2d_PrivateKey() encodes B<key>. It uses a key specific format or, if none is
|
||||
d2i_AutoPrivateKey_ex() and d2i_AutoPrivateKey() are similar to
|
||||
d2i_PrivateKey_ex() and d2i_PrivateKey() respectively except that they attempt
|
||||
to automatically detect the private key format.
|
||||
|
||||
i2d_PrivateKey() encodes I<a>. It uses a key specific format or, if none is
|
||||
defined for that key type, PKCS#8 unencrypted PrivateKeyInfo format.
|
||||
i2d_PublicKey() does the same for public keys.
|
||||
i2d_KeyParams() does the same for key parameters.
|
||||
These functions are similar to the d2i_X509() functions; see L<d2i_X509(3)>.
|
||||
i2d_PrivateKey_bio() and i2d_PrivateKey_fp() do the same thing except that they
|
||||
encode to a B<BIO> or B<FILE> respectrively. Again, these work similarly to the
|
||||
functions described in L<d2i_X509(3)>.
|
||||
|
||||
=head1 NOTES
|
||||
|
||||
@@ -53,33 +87,41 @@ All these functions use DER format and unencrypted keys. Applications wishing
|
||||
to encrypt or decrypt private keys should use other functions such as
|
||||
d2i_PKCS8PrivateKey() instead.
|
||||
|
||||
If the B<*a> is not NULL when calling d2i_PrivateKey() or d2i_AutoPrivateKey()
|
||||
If the I<*a> is not NULL when calling d2i_PrivateKey() or d2i_AutoPrivateKey()
|
||||
(i.e. an existing structure is being reused) and the key format is PKCS#8
|
||||
then B<*a> will be freed and replaced on a successful call.
|
||||
then I<*a> will be freed and replaced on a successful call.
|
||||
|
||||
To decode a key with type B<EVP_PKEY_EC>, d2i_PublicKey() requires B<*a> to be
|
||||
To decode a key with type B<EVP_PKEY_EC>, d2i_PublicKey() requires I<*a> to be
|
||||
a non-NULL EVP_PKEY structure assigned an EC_KEY structure referencing the proper
|
||||
EC_GROUP.
|
||||
|
||||
=head1 RETURN VALUES
|
||||
|
||||
The d2i_PrivateKey(), d2i_AutoPrivateKey(), d2i_PrivateKey_bio(), d2i_PrivateKey_fp(),
|
||||
d2i_PublicKey(), d2i_KeyParams() and d2i_KeyParams_bio() functions return a valid
|
||||
B<EVP_KEY> structure or B<NULL> if an error occurs. The error code can be
|
||||
obtained by calling L<ERR_get_error(3)>.
|
||||
The d2i_PrivateKey_ex(), d2i_PrivateKey(), d2i_AutoPrivateKey_ex(),
|
||||
d2i_AutoPrivateKey(), d2i_PrivateKey_ex_bio(), d2i_PrivateKey_bio(),
|
||||
d2i_PrivateKey_ex_fp(), d2i_PrivateKey_fp(), d2i_PublicKey(), d2i_KeyParams()
|
||||
and d2i_KeyParams_bio() functions return a valid B<EVP_KEY> structure or B<NULL>
|
||||
if an error occurs. The error code can be obtained by calling
|
||||
L<ERR_get_error(3)>.
|
||||
|
||||
i2d_PrivateKey(), i2d_PublicKey(), i2d_KeyParams() i2d_KeyParams_bio() return
|
||||
the number of bytes successfully encoded or a negative value if an error occurs.
|
||||
The error code can be obtained by calling L<ERR_get_error(3)>.
|
||||
i2d_PrivateKey(), i2d_PrivateKey_bio(), i2d_PrivateKey_fp(), i2d_PublicKey(),
|
||||
i2d_KeyParams() i2d_KeyParams_bio() return the number of bytes successfully
|
||||
encoded or a negative value if an error occurs. The error code can be obtained
|
||||
by calling L<ERR_get_error(3)>.
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
L<crypto(7)>,
|
||||
L<d2i_PKCS8PrivateKey_bio(3)>
|
||||
|
||||
=head1 HISTORY
|
||||
|
||||
d2i_PrivateKey_ex(), d2i_PrivateKey_ex_bio(), d2i_PrivateKey_ex_fp(), and
|
||||
d2i_AutoPrivateKey_ex() were added in OpenSSL 3.0.
|
||||
|
||||
=head1 COPYRIGHT
|
||||
|
||||
Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.
|
||||
Copyright 2017-2020 The OpenSSL Project Authors. All Rights Reserved.
|
||||
|
||||
Licensed under the Apache License 2.0 (the "License"). You may not use
|
||||
this file except in compliance with the License. You can obtain a copy
|
||||
|
||||
Reference in New Issue
Block a user