1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module OpenSSL::PKey - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li><a href="#module-OpenSSL::PKey-label-Asymmetric+Public+Key+Algorithms">Asymmetric Public Key Algorithms</a>
<li><a href="#module-OpenSSL::PKey-label-Diffie-Hellman+Key+Exchange">Diffie-Hellman Key Exchange</a>
</ul>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-generate_key">::generate_key</a>
<li ><a href="#method-c-generate_parameters">::generate_parameters</a>
<li ><a href="#method-c-read">::read</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-OpenSSL::PKey">
<h1 id="module-OpenSSL::PKey" class="module">
module OpenSSL::PKey
</h1>
<section class="description">
<h2 id="module-OpenSSL::PKey-label-Asymmetric+Public+Key+Algorithms">Asymmetric Public Key Algorithms<span><a href="#module-OpenSSL::PKey-label-Asymmetric+Public+Key+Algorithms">¶</a> <a href="#top">↑</a></span></h2>
<p>Asymmetric public key algorithms solve the problem of establishing and sharing secret keys to en-/decrypt messages. The key in such an algorithm consists of two parts: a public key that may be distributed to others and a private key that needs to remain secret.</p>
<p>Messages encrypted with a public key can only be decrypted by recipients that are in possession of the associated private key. Since public key algorithms are considerably slower than symmetric key algorithms (cf. <a href="Cipher.html"><code>OpenSSL::Cipher</code></a>) they are often used to establish a symmetric key shared between two parties that are in possession of each other’s public key.</p>
<p>Asymmetric algorithms offer a lot of nice features that are used in a lot of different areas. A very common application is the creation and validation of digital signatures. To sign a document, the signatory generally uses a message digest algorithm (cf. <a href="Digest.html"><code>OpenSSL::Digest</code></a>) to compute a digest of the document that is then encrypted (i.e. signed) using the private key. Anyone in possession of the public key may then verify the signature by computing the message digest of the original document on their own, decrypting the signature using the signatory’s public key and comparing the result to the message digest they previously computed. The signature is valid if and only if the decrypted signature is equal to this message digest.</p>
<p>The <a href="PKey/PKey.html"><code>PKey</code></a> module offers support for three popular public/private key algorithms:</p>
<ul><li>
<p><a href="PKey/RSA.html"><code>RSA</code></a> (<a href="PKey/RSA.html"><code>OpenSSL::PKey::RSA</code></a>)</p>
</li><li>
<p><a href="PKey/DSA.html"><code>DSA</code></a> (<a href="PKey/DSA.html"><code>OpenSSL::PKey::DSA</code></a>)</p>
</li><li>
<p>Elliptic Curve Cryptography (<a href="PKey/EC.html"><code>OpenSSL::PKey::EC</code></a>)</p>
</li></ul>
<p>Each of these implementations is in fact a sub-class of the abstract <a href="PKey/PKey.html"><code>PKey</code></a> class which offers the interface for supporting digital signatures in the form of <a href="PKey/PKey.html#method-i-sign"><code>PKey#sign</code></a> and <a href="PKey/PKey.html#method-i-verify"><code>PKey#verify</code></a>.</p>
<h2 id="module-OpenSSL::PKey-label-Diffie-Hellman+Key+Exchange">Diffie-Hellman Key Exchange<span><a href="#module-OpenSSL::PKey-label-Diffie-Hellman+Key+Exchange">¶</a> <a href="#top">↑</a></span></h2>
<p>Finally <a href="PKey/PKey.html"><code>PKey</code></a> also features <a href="PKey/DH.html"><code>OpenSSL::PKey::DH</code></a>, an implementation of the Diffie-Hellman key exchange protocol based on discrete logarithms in finite fields, the same basis that <a href="PKey/DSA.html"><code>DSA</code></a> is built on. The Diffie-Hellman protocol can be used to exchange (symmetric) keys over insecure channels without needing any prior joint knowledge between the participating parties. As the security of <a href="PKey/DH.html"><code>DH</code></a> demands relatively long “public keys” (i.e. the part that is overtly transmitted between participants) <a href="PKey/DH.html"><code>DH</code></a> tends to be quite slow. If security or speed is your primary concern, <a href="PKey/EC.html"><code>OpenSSL::PKey::EC</code></a> offers another implementation of the Diffie-Hellman protocol.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-generate_key" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
OpenSSL::PKey.generate_key(algo_name [, options]) → pkey
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
OpenSSL::PKey.generate_key(pkey [, options]) → pkey
</span>
</div>
<div class="method-description">
<p>Generates a new key (pair).</p>
<p>If a String is given as the first argument, it generates a new random key for the algorithm specified by the name just as <a href="PKey.html#method-c-generate_parameters"><code>::generate_parameters</code></a> does. If an <a href="PKey/PKey.html"><code>OpenSSL::PKey::PKey</code></a> is given instead, it generates a new random key for the same algorithm as the key, using the parameters the key contains.</p>
<p>See <a href="PKey.html#method-c-generate_parameters"><code>::generate_parameters</code></a> for the details of <em>options</em> and the given block.</p>
<h2 id="method-c-generate_key-label-Example">Example<span><a href="#method-c-generate_key-label-Example">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">pkey_params</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span>.<span class="ruby-identifier">generate_parameters</span>(<span class="ruby-string">"DSA"</span>, <span class="ruby-string">"dsa_paramgen_bits"</span> <span class="ruby-operator">=></span> <span class="ruby-value">2048</span>)
<span class="ruby-identifier">pkey_params</span>.<span class="ruby-identifier">priv_key</span> <span class="ruby-comment">#=> nil</span>
<span class="ruby-identifier">pkey</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span>.<span class="ruby-identifier">generate_key</span>(<span class="ruby-identifier">pkey_params</span>)
<span class="ruby-identifier">pkey</span>.<span class="ruby-identifier">priv_key</span> <span class="ruby-comment">#=> #<OpenSSL::BN 6277...</span>
</pre>
<div class="method-source-code" id="generate_key-source">
<pre>static VALUE
ossl_pkey_s_generate_key(int argc, VALUE *argv, VALUE self)
{
return pkey_generate(argc, argv, self, 0);
}</pre>
</div>
</div>
</div>
<div id="method-c-generate_parameters" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
OpenSSL::PKey.generate_parameters(algo_name [, options]) → pkey
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generates new parameters for the algorithm. <em>algo_name</em> is a String that represents the algorithm. The optional argument <em>options</em> is a Hash that specifies the options specific to the algorithm. The order of the options can be important.</p>
<p>A block can be passed optionally. The meaning of the arguments passed to the block varies depending on the implementation of the algorithm. The block may be called once or multiple times, or may not even be called.</p>
<p>For the supported options, see the documentation for the ‘openssl genpkey’ utility command.</p>
<h2 id="method-c-generate_parameters-label-Example">Example<span><a href="#method-c-generate_parameters-label-Example">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">pkey</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span>.<span class="ruby-identifier">generate_parameters</span>(<span class="ruby-string">"DSA"</span>, <span class="ruby-string">"dsa_paramgen_bits"</span> <span class="ruby-operator">=></span> <span class="ruby-value">2048</span>)
<span class="ruby-identifier">p</span> <span class="ruby-identifier">pkey</span>.<span class="ruby-identifier">p</span>.<span class="ruby-identifier">num_bits</span> <span class="ruby-comment">#=> 2048</span>
</pre>
<div class="method-source-code" id="generate_parameters-source">
<pre>static VALUE
ossl_pkey_s_generate_parameters(int argc, VALUE *argv, VALUE self)
{
return pkey_generate(argc, argv, self, 1);
}</pre>
</div>
</div>
</div>
<div id="method-c-read" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
OpenSSL::PKey.read(string [, pwd ]) → PKey
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
OpenSSL::PKey.read(io [, pwd ]) → PKey
</span>
</div>
<div class="method-description">
<p>Reads a DER or PEM encoded string from <em>string</em> or <em>io</em> and returns an instance of the appropriate <a href="PKey/PKey.html"><code>PKey</code></a> class.</p>
<h3 id="method-c-read-label-Parameters">Parameters<span><a href="#method-c-read-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
<ul><li>
<p><em>string</em> is a DER- or PEM-encoded string containing an arbitrary private or public key.</p>
</li><li>
<p><em>io</em> is an instance of <a href="../IO.html"><code>IO</code></a> containing a DER- or PEM-encoded arbitrary private or public key.</p>
</li><li>
<p><em>pwd</em> is an optional password in case <em>string</em> or <em>io</em> is an encrypted PEM resource.</p>
</li></ul>
<div class="method-source-code" id="read-source">
<pre>static VALUE
ossl_pkey_new_from_data(int argc, VALUE *argv, VALUE self)
{
EVP_PKEY *pkey;
BIO *bio;
VALUE data, pass;
rb_scan_args(argc, argv, "11", &data, &pass);
bio = ossl_obj2bio(&data);
pkey = ossl_pkey_read_generic(bio, ossl_pem_passwd_value(pass));
BIO_free(bio);
if (!pkey)
ossl_raise(ePKeyError, "Could not parse PKey");
return ossl_pkey_new(pkey);
}</pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|
