124 lines
4.9 KiB
HTML
124 lines
4.9 KiB
HTML
|
<?xml version="1.0" ?>
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<title>d2i_PrivateKey</title>
|
||
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||
|
|
<link rev="made" href="mailto:root@localhost" />
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body style="background-color: white">
|
||
|
|
|
||
|
|
|
||
|
|
<!-- INDEX BEGIN -->
|
||
|
|
<div name="index">
|
||
|
|
<p><a name="__index__"></a></p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
|
||
|
|
<li><a href="#name">NAME</a></li>
|
||
|
|
<li><a href="#synopsis">SYNOPSIS</a></li>
|
||
|
|
<li><a href="#description">DESCRIPTION</a></li>
|
||
|
|
<li><a href="#notes">NOTES</a></li>
|
||
|
|
<li><a href="#return_values">RETURN VALUES</a></li>
|
||
|
|
<li><a href="#see_also">SEE ALSO</a></li>
|
||
|
|
<li><a href="#copyright">COPYRIGHT</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<hr name="index" />
|
||
|
|
</div>
|
||
|
|
<!-- INDEX END -->
|
||
|
|
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="name">NAME</a></h1>
|
||
|
|
<p>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
|
||
|
|
- decode and encode functions for reading and saving EVP_PKEY structures</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="synopsis">SYNOPSIS</a></h1>
|
||
|
|
<pre>
|
||
|
|
#include <openssl/evp.h></pre>
|
||
|
|
<pre>
|
||
|
|
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(EVP_PKEY **a, const unsigned char **pp,
|
||
|
|
long length);</pre>
|
||
|
|
<pre>
|
||
|
|
int i2d_PrivateKey(const EVP_PKEY *a, unsigned char **pp);
|
||
|
|
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);</pre>
|
||
|
|
<pre>
|
||
|
|
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);</pre>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="description">DESCRIPTION</a></h1>
|
||
|
|
<p>d2i_PrivateKey() decodes a private key using algorithm <strong>type</strong>. It attempts to
|
||
|
|
use any key specific format or PKCS#8 unencrypted PrivateKeyInfo format. The
|
||
|
|
<strong>type</strong> parameter should be a public key algorithm constant such as
|
||
|
|
<strong>EVP_PKEY_RSA</strong>. An error occurs if the decoded key does not match <strong>type</strong>.
|
||
|
|
d2i_PublicKey() does the same for public keys.
|
||
|
|
d2i_KeyParams() does the same for key parameters.</p>
|
||
|
|
<p>d2i_AutoPrivateKey() is similar to d2i_PrivateKey() except it attempts to
|
||
|
|
automatically detect the private key format.</p>
|
||
|
|
<p>i2d_PrivateKey() encodes <strong>key</strong>. 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 <em>d2i_X509(3)</em>.</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="notes">NOTES</a></h1>
|
||
|
|
<p>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.</p>
|
||
|
|
<p>If the <strong>*a</strong> 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 <strong>*a</strong> will be freed and replaced on a successful call.</p>
|
||
|
|
<p>To decode a key with type <strong>EVP_PKEY_EC</strong>, d2i_PublicKey() requires <strong>*a</strong> to be
|
||
|
|
a non-NULL EVP_PKEY structure assigned an EC_KEY structure referencing the proper
|
||
|
|
EC_GROUP.</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="return_values">RETURN VALUES</a></h1>
|
||
|
|
<p>The d2i_PrivateKey(), d2i_AutoPrivateKey(), d2i_PrivateKey_bio(), d2i_PrivateKey_fp(),
|
||
|
|
d2i_PublicKey(), d2i_KeyParams() and d2i_KeyParams_bio() functions return a valid
|
||
|
|
<strong>EVP_KEY</strong> structure or <strong>NULL</strong> if an error occurs. The error code can be
|
||
|
|
obtained by calling <em>ERR_get_error(3)</em>.</p>
|
||
|
|
<p>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 <em>ERR_get_error(3)</em>.</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="see_also">SEE ALSO</a></h1>
|
||
|
|
<p><em>crypto(7)</em>,
|
||
|
|
<em>d2i_PKCS8PrivateKey_bio(3)</em></p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="copyright">COPYRIGHT</a></h1>
|
||
|
|
<p>Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.</p>
|
||
|
|
<p>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
|
||
|
|
in the file LICENSE in the source distribution or at
|
||
|
|
<a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
|
||
|
|
</html>
|