File: C:/Ruby27-x64/share/doc/ruby/html/OpenSSL.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module OpenSSL - 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-label-Examples">Examples</a>
<li><a href="#module-OpenSSL-label-Keys">Keys</a>
<li><a href="#module-OpenSSL-label-Creating+a+Key">Creating a Key</a>
<li><a href="#module-OpenSSL-label-Exporting+a+Key">Exporting a Key</a>
<li><a href="#module-OpenSSL-label-Loading+a+Key">Loading a Key</a>
<li><a href="#module-OpenSSL-label-Loading+an+Encrypted+Key">Loading an Encrypted Key</a>
<li><a href="#module-OpenSSL-label-RSA+Encryption">RSA Encryption</a>
<li><a href="#module-OpenSSL-label-Encryption+-26+Decryption">Encryption & Decryption</a>
<li><a href="#module-OpenSSL-label-Signatures">Signatures</a>
<li><a href="#module-OpenSSL-label-PBKDF2+Password-based+Encryption">PBKDF2 Password-based Encryption</a>
<li><a href="#module-OpenSSL-label-Encryption">Encryption</a>
<li><a href="#module-OpenSSL-label-Decryption">Decryption</a>
<li><a href="#module-OpenSSL-label-PKCS+-235+Password-based+Encryption">PKCS #5 Password-based Encryption</a>
<li><a href="#module-OpenSSL-label-Encryption">Encryption</a>
<li><a href="#module-OpenSSL-label-Decryption">Decryption</a>
<li><a href="#module-OpenSSL-label-X509+Certificates">X509 Certificates</a>
<li><a href="#module-OpenSSL-label-Creating+a+Certificate">Creating a Certificate</a>
<li><a href="#module-OpenSSL-label-Certificate+Extensions">Certificate Extensions</a>
<li><a href="#module-OpenSSL-label-Signing+a+Certificate">Signing a Certificate</a>
<li><a href="#module-OpenSSL-label-Loading+a+Certificate">Loading a Certificate</a>
<li><a href="#module-OpenSSL-label-Verifying+a+Certificate">Verifying a Certificate</a>
<li><a href="#module-OpenSSL-label-Certificate+Authority">Certificate Authority</a>
<li><a href="#module-OpenSSL-label-CA+Key">CA Key</a>
<li><a href="#module-OpenSSL-label-CA+Certificate">CA Certificate</a>
<li><a href="#module-OpenSSL-label-Certificate+Signing+Request">Certificate Signing Request</a>
<li><a href="#module-OpenSSL-label-Creating+a+Certificate+from+a+CSR">Creating a Certificate from a CSR</a>
<li><a href="#module-OpenSSL-label-SSL+and+TLS+Connections">SSL and TLS Connections</a>
<li><a href="#module-OpenSSL-label-SSL+Server">SSL Server</a>
<li><a href="#module-OpenSSL-label-SSL+client">SSL client</a>
<li><a href="#module-OpenSSL-label-Peer+Verification">Peer Verification</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-Digest">::Digest</a>
<li ><a href="#method-c-debug">::debug</a>
<li ><a href="#method-c-debug-3D">::debug=</a>
<li ><a href="#method-c-errors">::errors</a>
<li ><a href="#method-c-fips_mode">::fips_mode</a>
<li ><a href="#method-c-fips_mode-3D">::fips_mode=</a>
<li ><a href="#method-c-mem_check_start">::mem_check_start</a>
<li ><a href="#method-c-print_mem_leaks">::print_mem_leaks</a>
<li ><a href="#method-i-Digest">#Digest</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-OpenSSL">
<h1 id="module-OpenSSL" class="module">
module OpenSSL
</h1>
<section class="description">
<p><a href="OpenSSL.html"><code>OpenSSL</code></a> provides <a href="OpenSSL/SSL.html"><code>SSL</code></a>, TLS and general purpose cryptography. It wraps the <a href="https://www.openssl.org/">OpenSSL</a> library.</p>
<h1 id="module-OpenSSL-label-Examples">Examples<span><a href="#module-OpenSSL-label-Examples">¶</a> <a href="#top">↑</a></span></h1>
<p>All examples assume you have loaded <a href="OpenSSL.html"><code>OpenSSL</code></a> with:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'openssl'</span>
</pre>
<p>These examples build atop each other. For example the key created in the next is used in throughout these examples.</p>
<h2 id="module-OpenSSL-label-Keys">Keys<span><a href="#module-OpenSSL-label-Keys">¶</a> <a href="#top">↑</a></span></h2>
<h3 id="module-OpenSSL-label-Creating+a+Key">Creating a Key<span><a href="#module-OpenSSL-label-Creating+a+Key">¶</a> <a href="#top">↑</a></span></h3>
<p>This example creates a 2048 bit RSA keypair and writes it to the current directory.</p>
<pre class="ruby"><span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">2048</span>
<span class="ruby-identifier">open</span> <span class="ruby-string">'private_key.pem'</span>, <span class="ruby-string">'w'</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span> <span class="ruby-identifier">io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_pem</span> <span class="ruby-keyword">end</span>
<span class="ruby-identifier">open</span> <span class="ruby-string">'public_key.pem'</span>, <span class="ruby-string">'w'</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span> <span class="ruby-identifier">io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">public_key</span>.<span class="ruby-identifier">to_pem</span> <span class="ruby-keyword">end</span>
</pre>
<h3 id="module-OpenSSL-label-Exporting+a+Key">Exporting a Key<span><a href="#module-OpenSSL-label-Exporting+a+Key">¶</a> <a href="#top">↑</a></span></h3>
<p>Keys saved to disk without encryption are not secure as anyone who gets ahold of the key may use it unless it is encrypted. In order to securely export a key you may export it with a pass phrase.</p>
<pre class="ruby"><span class="ruby-identifier">cipher</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'AES-128-CBC'</span>
<span class="ruby-identifier">pass_phrase</span> = <span class="ruby-string">'my secure pass phrase goes here'</span>
<span class="ruby-identifier">key_secure</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">export</span> <span class="ruby-identifier">cipher</span>, <span class="ruby-identifier">pass_phrase</span>
<span class="ruby-identifier">open</span> <span class="ruby-string">'private.secure.pem'</span>, <span class="ruby-string">'w'</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">key_secure</span>
<span class="ruby-keyword">end</span>
</pre>
<p><a href="OpenSSL/Cipher.html#method-c-ciphers"><code>OpenSSL::Cipher.ciphers</code></a> returns a list of available ciphers.</p>
<h3 id="module-OpenSSL-label-Loading+a+Key">Loading a Key<span><a href="#module-OpenSSL-label-Loading+a+Key">¶</a> <a href="#top">↑</a></span></h3>
<p>A key can also be loaded from a file.</p>
<pre class="ruby"><span class="ruby-identifier">key2</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span> <span class="ruby-string">'private_key.pem'</span>
<span class="ruby-identifier">key2</span>.<span class="ruby-identifier">public?</span> <span class="ruby-comment"># => true</span>
<span class="ruby-identifier">key2</span>.<span class="ruby-identifier">private?</span> <span class="ruby-comment"># => true</span>
</pre>
<p>or</p>
<pre class="ruby"><span class="ruby-identifier">key3</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span> <span class="ruby-string">'public_key.pem'</span>
<span class="ruby-identifier">key3</span>.<span class="ruby-identifier">public?</span> <span class="ruby-comment"># => true</span>
<span class="ruby-identifier">key3</span>.<span class="ruby-identifier">private?</span> <span class="ruby-comment"># => false</span>
</pre>
<h3 id="module-OpenSSL-label-Loading+an+Encrypted+Key">Loading an Encrypted Key<span><a href="#module-OpenSSL-label-Loading+an+Encrypted+Key">¶</a> <a href="#top">↑</a></span></h3>
<p><a href="OpenSSL.html"><code>OpenSSL</code></a> will prompt you for your pass phrase when loading an encrypted key. If you will not be able to type in the pass phrase you may provide it when loading the key:</p>
<pre class="ruby"><span class="ruby-identifier">key4_pem</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span> <span class="ruby-string">'private.secure.pem'</span>
<span class="ruby-identifier">pass_phrase</span> = <span class="ruby-string">'my secure pass phrase goes here'</span>
<span class="ruby-identifier">key4</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">key4_pem</span>, <span class="ruby-identifier">pass_phrase</span>
</pre>
<h2 id="module-OpenSSL-label-RSA+Encryption">RSA Encryption<span><a href="#module-OpenSSL-label-RSA+Encryption">¶</a> <a href="#top">↑</a></span></h2>
<p>RSA provides encryption and decryption using the public and private keys. You can use a variety of padding methods depending upon the intended use of encrypted data.</p>
<h3 id="module-OpenSSL-label-Encryption+-26+Decryption">Encryption & Decryption<span><a href="#module-OpenSSL-label-Encryption+-26+Decryption">¶</a> <a href="#top">↑</a></span></h3>
<p>Asymmetric public/private key encryption is slow and victim to attack in cases where it is used without padding or directly to encrypt larger chunks of data. Typical use cases for RSA encryption involve “wrapping” a symmetric key with the public key of the recipient who would “unwrap” that symmetric key again using their private key. The following illustrates a simplified example of such a key transport scheme. It shouldn't be used in practice, though, standardized protocols should always be preferred.</p>
<pre class="ruby"><span class="ruby-identifier">wrapped_key</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">public_encrypt</span> <span class="ruby-identifier">key</span>
</pre>
<p>A symmetric key encrypted with the public key can only be decrypted with the corresponding private key of the recipient.</p>
<pre class="ruby"><span class="ruby-identifier">original_key</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">private_decrypt</span> <span class="ruby-identifier">wrapped_key</span>
</pre>
<p>By default PKCS#1 padding will be used, but it is also possible to use other forms of padding, see <a href="OpenSSL/PKey/RSA.html"><code>PKey::RSA</code></a> for further details.</p>
<h3 id="module-OpenSSL-label-Signatures">Signatures<span><a href="#module-OpenSSL-label-Signatures">¶</a> <a href="#top">↑</a></span></h3>
<p>Using “private_encrypt” to encrypt some data with the private key is equivalent to applying a digital signature to the data. A verifying party may validate the signature by comparing the result of decrypting the signature with “public_decrypt” to the original data. However, <a href="OpenSSL/PKey.html"><code>OpenSSL::PKey</code></a> already has methods “sign” and “verify” that handle digital signatures in a standardized way - “private_encrypt” and “public_decrypt” shouldn't be used in practice.</p>
<p>To sign a document, a cryptographically secure hash of the document is computed first, which is then signed using the private key.</p>
<pre class="ruby"><span class="ruby-identifier">digest</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA256</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">signature</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">sign</span> <span class="ruby-identifier">digest</span>, <span class="ruby-identifier">document</span>
</pre>
<p>To validate the signature, again a hash of the document is computed and the signature is decrypted using the public key. The result is then compared to the hash just computed, if they are equal the signature was valid.</p>
<pre class="ruby"><span class="ruby-identifier">digest</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA256</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">verify</span> <span class="ruby-identifier">digest</span>, <span class="ruby-identifier">signature</span>, <span class="ruby-identifier">document</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">'Valid'</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">'Invalid'</span>
<span class="ruby-keyword">end</span>
</pre>
<h2 id="module-OpenSSL-label-PBKDF2+Password-based+Encryption">PBKDF2 Password-based Encryption<span><a href="#module-OpenSSL-label-PBKDF2+Password-based+Encryption">¶</a> <a href="#top">↑</a></span></h2>
<p>If supported by the underlying <a href="OpenSSL.html"><code>OpenSSL</code></a> version used, Password-based Encryption should use the features of <a href="OpenSSL/PKCS5.html"><code>PKCS5</code></a>. If not supported or if required by legacy applications, the older, less secure methods specified in RFC 2898 are also supported (see below).</p>
<p><a href="OpenSSL/PKCS5.html"><code>PKCS5</code></a> supports PBKDF2 as it was specified in PKCS#5 <a href="http://www.rsa.com/rsalabs/node.asp?id=2127">v2.0</a>. It still uses a password, a salt, and additionally a number of iterations that will slow the key derivation process down. The slower this is, the more work it requires being able to brute-force the resulting key.</p>
<h3 id="module-OpenSSL-label-Encryption">Encryption<span><a href="#module-OpenSSL-label-Encryption">¶</a> <a href="#top">↑</a></span></h3>
<p>The strategy is to first instantiate a <a href="OpenSSL/Cipher.html"><code>Cipher</code></a> for encryption, and then to generate a random IV plus a key derived from the password using PBKDF2. PKCS #5 v2.0 recommends at least 8 bytes for the salt, the number of iterations largely depends on the hardware being used.</p>
<pre>cipher = OpenSSL::Cipher.new 'AES-128-CBC'
cipher.encrypt
iv = cipher.random_iv
pwd = 'some hopefully not to easily guessable password'
salt = OpenSSL::Random.random_bytes 16
iter = 20000
key_len = cipher.key_len
digest = OpenSSL::Digest::SHA256.new
key = OpenSSL::PKCS5.pbkdf2_hmac(pwd, salt, iter, key_len, digest)
cipher.key = key
Now encrypt the data:
encrypted = cipher.update document
encrypted << cipher.final</pre>
<h3 id="module-OpenSSL-label-Decryption">Decryption<span><a href="#module-OpenSSL-label-Decryption">¶</a> <a href="#top">↑</a></span></h3>
<p>Use the same steps as before to derive the symmetric AES key, this time setting the <a href="OpenSSL/Cipher.html"><code>Cipher</code></a> up for decryption.</p>
<pre>cipher = OpenSSL::Cipher.new 'AES-128-CBC'
cipher.decrypt
cipher.iv = iv # the one generated with #random_iv
pwd = 'some hopefully not to easily guessable password'
salt = ... # the one generated above
iter = 20000
key_len = cipher.key_len
digest = OpenSSL::Digest::SHA256.new
key = OpenSSL::PKCS5.pbkdf2_hmac(pwd, salt, iter, key_len, digest)
cipher.key = key
Now decrypt the data:
decrypted = cipher.update encrypted
decrypted << cipher.final</pre>
<h2 id="module-OpenSSL-label-PKCS+-235+Password-based+Encryption">PKCS #5 Password-based Encryption<span><a href="#module-OpenSSL-label-PKCS+-235+Password-based+Encryption">¶</a> <a href="#top">↑</a></span></h2>
<p>PKCS #5 is a password-based encryption standard documented at <a href="http://www.ietf.org/rfc/rfc2898.txt">RFC2898</a>. It allows a short password or passphrase to be used to create a secure encryption key. If possible, PBKDF2 as described above should be used if the circumstances allow it.</p>
<p>PKCS #5 uses a <a href="OpenSSL/Cipher.html"><code>Cipher</code></a>, a pass phrase and a salt to generate an encryption key.</p>
<pre class="ruby"><span class="ruby-identifier">pass_phrase</span> = <span class="ruby-string">'my secure pass phrase goes here'</span>
<span class="ruby-identifier">salt</span> = <span class="ruby-string">'8 octets'</span>
</pre>
<h3 id="module-OpenSSL-label-Encryption">Encryption<span><a href="#module-OpenSSL-label-Encryption">¶</a> <a href="#top">↑</a></span></h3>
<p>First set up the cipher for encryption</p>
<pre class="ruby"><span class="ruby-identifier">encryptor</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'AES-128-CBC'</span>
<span class="ruby-identifier">encryptor</span>.<span class="ruby-identifier">encrypt</span>
<span class="ruby-identifier">encryptor</span>.<span class="ruby-identifier">pkcs5_keyivgen</span> <span class="ruby-identifier">pass_phrase</span>, <span class="ruby-identifier">salt</span>
</pre>
<p>Then pass the data you want to encrypt through</p>
<pre class="ruby"><span class="ruby-identifier">encrypted</span> = <span class="ruby-identifier">encryptor</span>.<span class="ruby-identifier">update</span> <span class="ruby-string">'top secret document'</span>
<span class="ruby-identifier">encrypted</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">encryptor</span>.<span class="ruby-identifier">final</span>
</pre>
<h3 id="module-OpenSSL-label-Decryption">Decryption<span><a href="#module-OpenSSL-label-Decryption">¶</a> <a href="#top">↑</a></span></h3>
<p>Use a new <a href="OpenSSL/Cipher.html"><code>Cipher</code></a> instance set up for decryption</p>
<pre class="ruby"><span class="ruby-identifier">decryptor</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'AES-128-CBC'</span>
<span class="ruby-identifier">decryptor</span>.<span class="ruby-identifier">decrypt</span>
<span class="ruby-identifier">decryptor</span>.<span class="ruby-identifier">pkcs5_keyivgen</span> <span class="ruby-identifier">pass_phrase</span>, <span class="ruby-identifier">salt</span>
</pre>
<p>Then pass the data you want to decrypt through</p>
<pre class="ruby"><span class="ruby-identifier">plain</span> = <span class="ruby-identifier">decryptor</span>.<span class="ruby-identifier">update</span> <span class="ruby-identifier">encrypted</span>
<span class="ruby-identifier">plain</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">decryptor</span>.<span class="ruby-identifier">final</span>
</pre>
<h2 id="module-OpenSSL-label-X509+Certificates"><a href="OpenSSL/X509.html"><code>X509</code></a> Certificates<span><a href="#module-OpenSSL-label-X509+Certificates">¶</a> <a href="#top">↑</a></span></h2>
<h3 id="module-OpenSSL-label-Creating+a+Certificate">Creating a Certificate<span><a href="#module-OpenSSL-label-Creating+a+Certificate">¶</a> <a href="#top">↑</a></span></h3>
<p>This example creates a self-signed certificate using an RSA key and a SHA1 signature.</p>
<pre class="ruby"><span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">2048</span>
<span class="ruby-identifier">name</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">parse</span> <span class="ruby-string">'CN=nobody/DC=example'</span>
<span class="ruby-identifier">cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">cert</span>.<span class="ruby-identifier">version</span> = <span class="ruby-value">2</span>
<span class="ruby-identifier">cert</span>.<span class="ruby-identifier">serial</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">cert</span>.<span class="ruby-identifier">not_before</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
<span class="ruby-identifier">cert</span>.<span class="ruby-identifier">not_after</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> <span class="ruby-value">3600</span>
<span class="ruby-identifier">cert</span>.<span class="ruby-identifier">public_key</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">public_key</span>
<span class="ruby-identifier">cert</span>.<span class="ruby-identifier">subject</span> = <span class="ruby-identifier">name</span>
</pre>
<h3 id="module-OpenSSL-label-Certificate+Extensions">Certificate Extensions<span><a href="#module-OpenSSL-label-Certificate+Extensions">¶</a> <a href="#top">↑</a></span></h3>
<p>You can add extensions to the certificate with OpenSSL::SSL::ExtensionFactory to indicate the purpose of the certificate.</p>
<pre class="ruby"><span class="ruby-identifier">extension_factory</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">ExtensionFactory</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">cert</span>
<span class="ruby-identifier">cert</span>.<span class="ruby-identifier">add_extension</span> \
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">create_extension</span>(<span class="ruby-string">'basicConstraints'</span>, <span class="ruby-string">'CA:FALSE'</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">cert</span>.<span class="ruby-identifier">add_extension</span> \
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">create_extension</span>(
<span class="ruby-string">'keyUsage'</span>, <span class="ruby-string">'keyEncipherment,dataEncipherment,digitalSignature'</span>)
<span class="ruby-identifier">cert</span>.<span class="ruby-identifier">add_extension</span> \
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">create_extension</span>(<span class="ruby-string">'subjectKeyIdentifier'</span>, <span class="ruby-string">'hash'</span>)
</pre>
<p>The list of supported extensions (and in some cases their possible values) can be derived from the “objects.h” file in the <a href="OpenSSL.html"><code>OpenSSL</code></a> source code.</p>
<h3 id="module-OpenSSL-label-Signing+a+Certificate">Signing a Certificate<span><a href="#module-OpenSSL-label-Signing+a+Certificate">¶</a> <a href="#top">↑</a></span></h3>
<p>To sign a certificate set the issuer and use <a href="OpenSSL/X509/Certificate.html#method-i-sign"><code>OpenSSL::X509::Certificate#sign</code></a> with a digest algorithm. This creates a self-signed cert because we're using the same name and key to sign the certificate as was used to create the certificate.</p>
<pre class="ruby"><span class="ruby-identifier">cert</span>.<span class="ruby-identifier">issuer</span> = <span class="ruby-identifier">name</span>
<span class="ruby-identifier">cert</span>.<span class="ruby-identifier">sign</span> <span class="ruby-identifier">key</span>, <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">open</span> <span class="ruby-string">'certificate.pem'</span>, <span class="ruby-string">'w'</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span> <span class="ruby-identifier">io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">cert</span>.<span class="ruby-identifier">to_pem</span> <span class="ruby-keyword">end</span>
</pre>
<h3 id="module-OpenSSL-label-Loading+a+Certificate">Loading a Certificate<span><a href="#module-OpenSSL-label-Loading+a+Certificate">¶</a> <a href="#top">↑</a></span></h3>
<p>Like a key, a cert can also be loaded from a file.</p>
<pre class="ruby"><span class="ruby-identifier">cert2</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span> <span class="ruby-string">'certificate.pem'</span>
</pre>
<h3 id="module-OpenSSL-label-Verifying+a+Certificate">Verifying a Certificate<span><a href="#module-OpenSSL-label-Verifying+a+Certificate">¶</a> <a href="#top">↑</a></span></h3>
<p>Certificate#verify will return true when a certificate was signed with the given public key.</p>
<pre class="ruby"><span class="ruby-identifier">raise</span> <span class="ruby-string">'certificate can not be verified'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">cert2</span>.<span class="ruby-identifier">verify</span> <span class="ruby-identifier">key</span>
</pre>
<h2 id="module-OpenSSL-label-Certificate+Authority">Certificate Authority<span><a href="#module-OpenSSL-label-Certificate+Authority">¶</a> <a href="#top">↑</a></span></h2>
<p>A certificate authority (CA) is a trusted third party that allows you to verify the ownership of unknown certificates. The CA issues key signatures that indicate it trusts the user of that key. A user encountering the key can verify the signature by using the CA's public key.</p>
<h3 id="module-OpenSSL-label-CA+Key">CA Key<span><a href="#module-OpenSSL-label-CA+Key">¶</a> <a href="#top">↑</a></span></h3>
<p>CA keys are valuable, so we encrypt and save it to disk and make sure it is not readable by other users.</p>
<pre class="ruby"><span class="ruby-identifier">ca_key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">2048</span>
<span class="ruby-identifier">pass_phrase</span> = <span class="ruby-string">'my secure pass phrase goes here'</span>
<span class="ruby-identifier">cipher</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Cipher</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'AES-128-CBC'</span>
<span class="ruby-identifier">open</span> <span class="ruby-string">'ca_key.pem'</span>, <span class="ruby-string">'w'</span>, <span class="ruby-value">0400</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">ca_key</span>.<span class="ruby-identifier">export</span>(<span class="ruby-identifier">cipher</span>, <span class="ruby-identifier">pass_phrase</span>)
<span class="ruby-keyword">end</span>
</pre>
<h3 id="module-OpenSSL-label-CA+Certificate">CA Certificate<span><a href="#module-OpenSSL-label-CA+Certificate">¶</a> <a href="#top">↑</a></span></h3>
<p>A CA certificate is created the same way we created a certificate above, but with different extensions.</p>
<pre class="ruby"><span class="ruby-identifier">ca_name</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Name</span>.<span class="ruby-identifier">parse</span> <span class="ruby-string">'CN=ca/DC=example'</span>
<span class="ruby-identifier">ca_cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">serial</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">version</span> = <span class="ruby-value">2</span>
<span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">not_before</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
<span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">not_after</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> <span class="ruby-value">86400</span>
<span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">public_key</span> = <span class="ruby-identifier">ca_key</span>.<span class="ruby-identifier">public_key</span>
<span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">subject</span> = <span class="ruby-identifier">ca_name</span>
<span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">issuer</span> = <span class="ruby-identifier">ca_name</span>
<span class="ruby-identifier">extension_factory</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">ExtensionFactory</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">subject_certificate</span> = <span class="ruby-identifier">ca_cert</span>
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">issuer_certificate</span> = <span class="ruby-identifier">ca_cert</span>
<span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">add_extension</span> \
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">create_extension</span>(<span class="ruby-string">'subjectKeyIdentifier'</span>, <span class="ruby-string">'hash'</span>)
</pre>
<p>This extension indicates the CA's key may be used as a CA.</p>
<pre class="ruby"><span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">add_extension</span> \
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">create_extension</span>(<span class="ruby-string">'basicConstraints'</span>, <span class="ruby-string">'CA:TRUE'</span>, <span class="ruby-keyword">true</span>)
</pre>
<p>This extension indicates the CA's key may be used to verify signatures on both certificates and certificate revocations.</p>
<pre class="ruby"><span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">add_extension</span> \
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">create_extension</span>(
<span class="ruby-string">'keyUsage'</span>, <span class="ruby-string">'cRLSign,keyCertSign'</span>, <span class="ruby-keyword">true</span>)
</pre>
<p>Root CA certificates are self-signed.</p>
<pre class="ruby"><span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">sign</span> <span class="ruby-identifier">ca_key</span>, <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">new</span>
</pre>
<p>The CA certificate is saved to disk so it may be distributed to all the users of the keys this CA will sign.</p>
<pre class="ruby"><span class="ruby-identifier">open</span> <span class="ruby-string">'ca_cert.pem'</span>, <span class="ruby-string">'w'</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">to_pem</span>
<span class="ruby-keyword">end</span>
</pre>
<h3 id="module-OpenSSL-label-Certificate+Signing+Request">Certificate Signing Request<span><a href="#module-OpenSSL-label-Certificate+Signing+Request">¶</a> <a href="#top">↑</a></span></h3>
<p>The CA signs keys through a Certificate Signing Request (CSR). The CSR contains the information necessary to identify the key.</p>
<pre class="ruby"><span class="ruby-identifier">csr</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">csr</span>.<span class="ruby-identifier">version</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">csr</span>.<span class="ruby-identifier">subject</span> = <span class="ruby-identifier">name</span>
<span class="ruby-identifier">csr</span>.<span class="ruby-identifier">public_key</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">public_key</span>
<span class="ruby-identifier">csr</span>.<span class="ruby-identifier">sign</span> <span class="ruby-identifier">key</span>, <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">new</span>
</pre>
<p>A CSR is saved to disk and sent to the CA for signing.</p>
<pre class="ruby"><span class="ruby-identifier">open</span> <span class="ruby-string">'csr.pem'</span>, <span class="ruby-string">'w'</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">csr</span>.<span class="ruby-identifier">to_pem</span>
<span class="ruby-keyword">end</span>
</pre>
<h3 id="module-OpenSSL-label-Creating+a+Certificate+from+a+CSR">Creating a Certificate from a CSR<span><a href="#module-OpenSSL-label-Creating+a+Certificate+from+a+CSR">¶</a> <a href="#top">↑</a></span></h3>
<p>Upon receiving a CSR the CA will verify it before signing it. A minimal verification would be to check the CSR's signature.</p>
<pre class="ruby"><span class="ruby-identifier">csr</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span> <span class="ruby-string">'csr.pem'</span>
<span class="ruby-identifier">raise</span> <span class="ruby-string">'CSR can not be verified'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">csr</span>.<span class="ruby-identifier">verify</span> <span class="ruby-identifier">csr</span>.<span class="ruby-identifier">public_key</span>
</pre>
<p>After verification a certificate is created, marked for various usages, signed with the CA key and returned to the requester.</p>
<pre class="ruby"><span class="ruby-identifier">csr_cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">serial</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">version</span> = <span class="ruby-value">2</span>
<span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">not_before</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
<span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">not_after</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> <span class="ruby-value">600</span>
<span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">subject</span> = <span class="ruby-identifier">csr</span>.<span class="ruby-identifier">subject</span>
<span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">public_key</span> = <span class="ruby-identifier">csr</span>.<span class="ruby-identifier">public_key</span>
<span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">issuer</span> = <span class="ruby-identifier">ca_cert</span>.<span class="ruby-identifier">subject</span>
<span class="ruby-identifier">extension_factory</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">ExtensionFactory</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">subject_certificate</span> = <span class="ruby-identifier">csr_cert</span>
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">issuer_certificate</span> = <span class="ruby-identifier">ca_cert</span>
<span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">add_extension</span> \
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">create_extension</span>(<span class="ruby-string">'basicConstraints'</span>, <span class="ruby-string">'CA:FALSE'</span>)
<span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">add_extension</span> \
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">create_extension</span>(
<span class="ruby-string">'keyUsage'</span>, <span class="ruby-string">'keyEncipherment,dataEncipherment,digitalSignature'</span>)
<span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">add_extension</span> \
<span class="ruby-identifier">extension_factory</span>.<span class="ruby-identifier">create_extension</span>(<span class="ruby-string">'subjectKeyIdentifier'</span>, <span class="ruby-string">'hash'</span>)
<span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">sign</span> <span class="ruby-identifier">ca_key</span>, <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">open</span> <span class="ruby-string">'csr_cert.pem'</span>, <span class="ruby-string">'w'</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">csr_cert</span>.<span class="ruby-identifier">to_pem</span>
<span class="ruby-keyword">end</span>
</pre>
<h2 id="module-OpenSSL-label-SSL+and+TLS+Connections"><a href="OpenSSL/SSL.html"><code>SSL</code></a> and TLS Connections<span><a href="#module-OpenSSL-label-SSL+and+TLS+Connections">¶</a> <a href="#top">↑</a></span></h2>
<p>Using our created key and certificate we can create an <a href="OpenSSL/SSL.html"><code>SSL</code></a> or TLS connection. An SSLContext is used to set up an <a href="OpenSSL/SSL.html"><code>SSL</code></a> session.</p>
<pre class="ruby"><span class="ruby-identifier">context</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLContext</span>.<span class="ruby-identifier">new</span>
</pre>
<h3 id="module-OpenSSL-label-SSL+Server"><a href="OpenSSL/SSL.html"><code>SSL</code></a> Server<span><a href="#module-OpenSSL-label-SSL+Server">¶</a> <a href="#top">↑</a></span></h3>
<p>An <a href="OpenSSL/SSL.html"><code>SSL</code></a> server requires the certificate and private key to communicate securely with its clients:</p>
<pre class="ruby"><span class="ruby-identifier">context</span>.<span class="ruby-identifier">cert</span> = <span class="ruby-identifier">cert</span>
<span class="ruby-identifier">context</span>.<span class="ruby-identifier">key</span> = <span class="ruby-identifier">key</span>
</pre>
<p>Then create an SSLServer with a TCP server socket and the context. Use the SSLServer like an ordinary TCP server.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'socket'</span>
<span class="ruby-identifier">tcp_server</span> = <span class="ruby-constant">TCPServer</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">5000</span>
<span class="ruby-identifier">ssl_server</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLServer</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">tcp_server</span>, <span class="ruby-identifier">context</span>
<span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">ssl_connection</span> = <span class="ruby-identifier">ssl_server</span>.<span class="ruby-identifier">accept</span>
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">connection</span>.<span class="ruby-identifier">gets</span>
<span class="ruby-identifier">response</span> = <span class="ruby-node">"I got #{data.dump}"</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">response</span>
<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"I got #{data.dump}"</span>
<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword">end</span>
</pre>
<h3 id="module-OpenSSL-label-SSL+client"><a href="OpenSSL/SSL.html"><code>SSL</code></a> client<span><a href="#module-OpenSSL-label-SSL+client">¶</a> <a href="#top">↑</a></span></h3>
<p>An <a href="OpenSSL/SSL.html"><code>SSL</code></a> client is created with a TCP socket and the context. SSLSocket#connect must be called to initiate the <a href="OpenSSL/SSL.html"><code>SSL</code></a> handshake and start encryption. A key and certificate are not required for the client socket.</p>
<p>Note that SSLSocket#close doesn't close the underlying socket by default. <a href="Set.html"><code>Set</code></a> SSLSocket#sync_close to true if you want.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'socket'</span>
<span class="ruby-identifier">tcp_socket</span> = <span class="ruby-constant">TCPSocket</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'localhost'</span>, <span class="ruby-value">5000</span>
<span class="ruby-identifier">ssl_client</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLSocket</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">tcp_socket</span>, <span class="ruby-identifier">context</span>
<span class="ruby-identifier">ssl_client</span>.<span class="ruby-identifier">sync_close</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">ssl_client</span>.<span class="ruby-identifier">connect</span>
<span class="ruby-identifier">ssl_client</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">"hello server!"</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">ssl_client</span>.<span class="ruby-identifier">gets</span>
<span class="ruby-identifier">ssl_client</span>.<span class="ruby-identifier">close</span> <span class="ruby-comment"># shutdown the TLS connection and close tcp_socket</span>
</pre>
<h3 id="module-OpenSSL-label-Peer+Verification">Peer Verification<span><a href="#module-OpenSSL-label-Peer+Verification">¶</a> <a href="#top">↑</a></span></h3>
<p>An unverified <a href="OpenSSL/SSL.html"><code>SSL</code></a> connection does not provide much security. For enhanced security the client or server can verify the certificate of its peer.</p>
<p>The client can be modified to verify the server's certificate against the certificate authority's certificate:</p>
<pre class="ruby"><span class="ruby-identifier">context</span>.<span class="ruby-identifier">ca_file</span> = <span class="ruby-string">'ca_cert.pem'</span>
<span class="ruby-identifier">context</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'socket'</span>
<span class="ruby-identifier">tcp_socket</span> = <span class="ruby-constant">TCPSocket</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'localhost'</span>, <span class="ruby-value">5000</span>
<span class="ruby-identifier">ssl_client</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLSocket</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">tcp_socket</span>, <span class="ruby-identifier">context</span>
<span class="ruby-identifier">ssl_client</span>.<span class="ruby-identifier">connect</span>
<span class="ruby-identifier">ssl_client</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">"hello server!"</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">ssl_client</span>.<span class="ruby-identifier">gets</span>
</pre>
<p>If the server certificate is invalid or <code>context.ca_file</code> is not set when verifying peers an <a href="OpenSSL/SSL/SSLError.html"><code>OpenSSL::SSL::SSLError</code></a> will be raised.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="OPENSSL_FIPS">OPENSSL_FIPS
<dd><p>Boolean indicating whether <a href="OpenSSL.html"><code>OpenSSL</code></a> is FIPS-capable or not</p>
<dt id="OPENSSL_LIBRARY_VERSION">OPENSSL_LIBRARY_VERSION
<dd>
<dt id="OPENSSL_VERSION">OPENSSL_VERSION
<dd><p>Version of <a href="OpenSSL.html"><code>OpenSSL</code></a> the ruby <a href="OpenSSL.html"><code>OpenSSL</code></a> extension was built with</p>
<dt id="OPENSSL_VERSION_NUMBER">OPENSSL_VERSION_NUMBER
<dd><p>Version number of <a href="OpenSSL.html"><code>OpenSSL</code></a> the ruby <a href="OpenSSL.html"><code>OpenSSL</code></a> extension was built with (base 16)</p>
<dt id="VERSION">VERSION
<dd><p><a href="OpenSSL.html"><code>OpenSSL</code></a> ruby extension version</p>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-Digest" class="method-detail ">
<div class="method-heading">
<span class="method-name">Digest</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a <a href="OpenSSL/Digest.html"><code>Digest</code></a> subclass by <em>name</em></p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'openssl'</span>
<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span>(<span class="ruby-string">"MD5"</span>)
<span class="ruby-comment"># => OpenSSL::Digest::MD5</span>
<span class="ruby-constant">Digest</span>(<span class="ruby-string">"Foo"</span>)
<span class="ruby-comment"># => NameError: wrong constant name Foo</span>
</pre>
<div class="method-source-code" id="Digest-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/digest.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-constant">Digest</span>(<span class="ruby-identifier ruby-title">name</span>)
<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-debug" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
debug → true | false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="debug-source">
<pre>static VALUE
ossl_debug_get(VALUE self)
{
return dOSSL;
}</pre>
</div>
</div>
</div>
<div id="method-c-debug-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
debug = boolean → boolean
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Turns on or off debug mode. With debug mode, all erros added to the <a href="OpenSSL.html"><code>OpenSSL</code></a> error queue will be printed to stderr.</p>
<div class="method-source-code" id="debug-3D-source">
<pre>static VALUE
ossl_debug_set(VALUE self, VALUE val)
{
dOSSL = RTEST(val) ? Qtrue : Qfalse;
return val;
}</pre>
</div>
</div>
</div>
<div id="method-c-errors" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
errors → [String...]
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See any remaining errors held in queue.</p>
<p>Any errors you see here are probably due to a bug in Ruby's <a href="OpenSSL.html"><code>OpenSSL</code></a> implementation.</p>
<div class="method-source-code" id="errors-source">
<pre>VALUE
ossl_get_errors(VALUE _)
{
VALUE ary;
long e;
ary = rb_ary_new();
while ((e = ERR_get_error()) != 0){
rb_ary_push(ary, rb_str_new2(ERR_error_string(e, NULL)));
}
return ary;
}</pre>
</div>
</div>
</div>
<div id="method-c-fips_mode" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
fips_mode → true | false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="fips_mode-source">
<pre>static VALUE
ossl_fips_mode_get(VALUE self)
{
#ifdef OPENSSL_FIPS
VALUE enabled;
enabled = FIPS_mode() ? Qtrue : Qfalse;
return enabled;
#else
return Qfalse;
#endif
}</pre>
</div>
</div>
</div>
<div id="method-c-fips_mode-3D" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
fips_mode = boolean → boolean
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Turns FIPS mode on or off. Turning on FIPS mode will obviously only have an effect for FIPS-capable installations of the <a href="OpenSSL.html"><code>OpenSSL</code></a> library. Trying to do so otherwise will result in an error.</p>
<h3 id="method-c-fips_mode-3D-label-Examples">Examples<span><a href="#method-c-fips_mode-3D-label-Examples">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-constant">OpenSSL</span>.<span class="ruby-identifier">fips_mode</span> = <span class="ruby-keyword">true</span> <span class="ruby-comment"># turn FIPS mode on</span>
<span class="ruby-constant">OpenSSL</span>.<span class="ruby-identifier">fips_mode</span> = <span class="ruby-keyword">false</span> <span class="ruby-comment"># and off again</span>
</pre>
<div class="method-source-code" id="fips_mode-3D-source">
<pre>static VALUE
ossl_fips_mode_set(VALUE self, VALUE enabled)
{
#ifdef OPENSSL_FIPS
if (RTEST(enabled)) {
int mode = FIPS_mode();
if(!mode && !FIPS_mode_set(1)) /* turning on twice leads to an error */
ossl_raise(eOSSLError, "Turning on FIPS mode failed");
} else {
if(!FIPS_mode_set(0)) /* turning off twice is OK */
ossl_raise(eOSSLError, "Turning off FIPS mode failed");
}
return enabled;
#else
if (RTEST(enabled))
ossl_raise(eOSSLError, "This version of OpenSSL does not support FIPS mode");
return enabled;
#endif
}</pre>
</div>
</div>
</div>
<div id="method-c-mem_check_start" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
mem_check_start → nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Calls CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON). Starts tracking memory allocations. See also <a href="OpenSSL.html#method-c-print_mem_leaks"><code>OpenSSL.print_mem_leaks</code></a>.</p>
<p>This is available only when built with a capable <a href="OpenSSL.html"><code>OpenSSL</code></a> and –enable-debug configure option.</p>
<div class="method-source-code" id="mem_check_start-source">
<pre>static VALUE
mem_check_start(VALUE self)
{
CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-print_mem_leaks" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
print_mem_leaks → true | false
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>For debugging the Ruby/OpenSSL library. Calls CRYPTO_mem_leaks_fp(stderr). Prints detected memory leaks to standard error. This cleans the global state up thus you cannot use any methods of the library after calling this.</p>
<p>Returns <code>true</code> if leaks detected, <code>false</code> otherwise.</p>
<p>This is available only when built with a capable <a href="OpenSSL.html"><code>OpenSSL</code></a> and –enable-debug configure option.</p>
<h3 id="method-c-print_mem_leaks-label-Example">Example<span><a href="#method-c-print_mem_leaks-label-Example">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-constant">OpenSSL</span>.<span class="ruby-identifier">mem_check_start</span>
<span class="ruby-constant">NOT_GCED</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">256</span>)
<span class="ruby-keyword">END</span> {
<span class="ruby-constant">GC</span>.<span class="ruby-identifier">start</span>
<span class="ruby-constant">OpenSSL</span>.<span class="ruby-identifier">print_mem_leaks</span> <span class="ruby-comment"># will print the leakage</span>
}
</pre>
<div class="method-source-code" id="print_mem_leaks-source">
<pre>static VALUE
print_mem_leaks(VALUE self)
{
#if OPENSSL_VERSION_NUMBER >= 0x10100000
int ret;
#endif
BN_CTX_free(ossl_bn_ctx);
ossl_bn_ctx = NULL;
#if OPENSSL_VERSION_NUMBER >= 0x10100000
ret = CRYPTO_mem_leaks_fp(stderr);
if (ret < 0)
ossl_raise(eOSSLError, "CRYPTO_mem_leaks_fp");
return ret ? Qfalse : Qtrue;
#else
CRYPTO_mem_leaks_fp(stderr);
return Qnil;
#endif
}</pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-Digest" class="method-detail ">
<div class="method-heading">
<span class="method-name">Digest</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a <a href="OpenSSL/Digest.html"><code>Digest</code></a> subclass by <em>name</em></p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'openssl'</span>
<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span>(<span class="ruby-string">"MD5"</span>)
<span class="ruby-comment"># => OpenSSL::Digest::MD5</span>
<span class="ruby-constant">Digest</span>(<span class="ruby-string">"Foo"</span>)
<span class="ruby-comment"># => NameError: wrong constant name Foo</span>
</pre>
<div class="method-source-code" id="Digest-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/digest.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-constant">Digest</span>(<span class="ruby-identifier ruby-title">name</span>)
<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">end</span></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.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>