Admin Control Panel v2.0

✎ Editing: pkey.html ← Back

<?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>pkey</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>

<ul id="index">
 <li><a href="#NAME">NAME</a></li>
 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
 <li><a href="#OPTIONS">OPTIONS</a></li>
 <li><a href="#EXAMPLES">EXAMPLES</a></li>
 <li><a href="#SEE-ALSO">SEE ALSO</a></li>
 <li><a href="#COPYRIGHT">COPYRIGHT</a></li>
</ul>

openssl-pkey, pkey - public or private key processing tool

<h1 id="SYNOPSIS">SYNOPSIS</h1>

openssl pkey [-help] [-inform PEM|DER] [-outform PEM|DER] [-in filename] [-passin arg] [-out filename] [-passout arg] [-traditional] [-cipher] [-text] [-text_pub] [-noout] [-pubin] [-pubout] [-engine id] [-check] [-pubcheck]

<h1 id="DESCRIPTION">DESCRIPTION</h1>

The pkey command processes public or private keys. They can be converted between various forms and their components printed out.

<h1 id="OPTIONS">OPTIONS</h1>

<dl>

Print out a usage message.

</dd>
<dt id="inform-DER-PEM">-inform DER|PEM</dt>
<dd>

This specifies the input format DER or PEM. The default format is PEM.

</dd>
<dt id="outform-DER-PEM">-outform DER|PEM</dt>
<dd>

This specifies the output format, the options have the same meaning and default as the -inform option.

</dd>
<dt id="in-filename">-in filename</dt>
<dd>

This specifies the input filename to read a key from or standard input if this option is not specified. If the key is encrypted a pass phrase will be prompted for.

</dd>
<dt id="passin-arg">-passin arg</dt>
<dd>

The input file password source. For more information about the format of arg see <a href="../man1/openssl.html">&quot;Pass Phrase Options&quot; in openssl(1)</a>.

</dd>
<dt id="out-filename">-out filename</dt>
<dd>

This specifies the output filename to write a key to or standard output if this option is not specified. If any encryption options are set then a pass phrase will be prompted for. The output filename should not be the same as the input filename.

</dd>
<dt id="passout-password">-passout password</dt>
<dd>

The output file password source. For more information about the format of arg see <a href="../man1/openssl.html">&quot;Pass Phrase Options&quot; in openssl(1)</a>.

</dd>
<dt id="traditional">-traditional</dt>
<dd>

Normally a private key is written using standard format: this is PKCS#8 form with the appropriate encryption algorithm (if any). If the -traditional option is specified then the older &quot;traditional&quot; format is used instead.

</dd>
<dt id="cipher">-cipher</dt>
<dd>

These options encrypt the private key with the supplied cipher. Any algorithm name accepted by EVP_get_cipherbyname() is acceptable such as des3.

</dd>
<dt id="text">-text</dt>
<dd>

Prints out the various public or private key components in plain text in addition to the encoded version.

</dd>
<dt id="text_pub">-text_pub</dt>
<dd>

Print out only public key components even if a private key is being processed.

</dd>
<dt id="noout">-noout</dt>
<dd>

Do not output the encoded version of the key.

</dd>
<dt id="pubin">-pubin</dt>
<dd>

By default a private key is read from the input file: with this option a public key is read instead.

</dd>
<dt id="pubout">-pubout</dt>
<dd>

By default a private key is output: with this option a public key will be output instead. This option is automatically set if the input is a public key.

</dd>
<dt id="engine-id">-engine id</dt>
<dd>

Specifying an engine (by its unique id string) will cause pkey to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms.

</dd>
<dt id="check">-check</dt>
<dd>

This option checks the consistency of a key pair for both public and private components.

</dd>
<dt id="pubcheck">-pubcheck</dt>
<dd>

This option checks the correctness of either a public key or the public component of a key pair.

</dd>
</dl>

<h1 id="EXAMPLES">EXAMPLES</h1>

To remove the pass phrase on an RSA private key:

<pre><code> openssl pkey -in key.pem -out keyout.pem</code></pre>

To encrypt a private key using triple DES:

<pre><code> openssl pkey -in key.pem -des3 -out keyout.pem</code></pre>

To convert a private key from PEM to DER format:

<pre><code> openssl pkey -in key.pem -outform DER -out keyout.der</code></pre>

To print out the components of a private key to standard output:

<pre><code> openssl pkey -in key.pem -text -noout</code></pre>

To print out the public components of a private key to standard output:

<pre><code> openssl pkey -in key.pem -text_pub -noout</code></pre>

To just output the public part of a private key:

<pre><code> openssl pkey -in key.pem -pubout -out pubkey.pem</code></pre>

<a href="../man1/genpkey.html">genpkey(1)</a>, <a href="../man1/rsa.html">rsa(1)</a>, <a href="../man1/pkcs8.html">pkcs8(1)</a>, <a href="../man1/dsa.html">dsa(1)</a>, <a href="../man1/genrsa.html">genrsa(1)</a>, <a href="../man1/gendsa.html">gendsa(1)</a>

<h1 id="COPYRIGHT">COPYRIGHT</h1>

Licensed under the OpenSSL license (the &quot;License&quot;). 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>.

</body>

</html>

Cancel