diff options
| author | Kazuki Yamaguchi <k@rhe.jp> | 2021-10-17 21:16:54 +0900 |
|---|---|---|
| committer | Kazuki Yamaguchi <k@rhe.jp> | 2021-10-17 21:16:54 +0900 |
| commit | 0c12273a7174d300bad342a053186ae172d2952d (patch) | |
| tree | bdc64bc3164b5d534717c7272a8d309a60021a76 | |
| parent | ad2abc0cd93977a35565178a3b4b4e50edbd8f0b (diff) | |
| download | ruby-openssl-0c12273a7174d300bad342a053186ae172d2952d.tar.gz | |
Sync with v2.2.1
116 files changed, 1031 insertions, 13200 deletions
diff --git a/CONTRIBUTING_md.html b/CONTRIBUTING_md.html index 28860683..117a1418 100644 --- a/CONTRIBUTING_md.html +++ b/CONTRIBUTING_md.html @@ -21,8 +21,6 @@ <link href="./css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="file"> <nav role="navigation"> <div id="project-navigation"> @@ -73,17 +71,14 @@ <div id="project-metadata"> - <div id="fileindex-section" class="nav-section"> + +<div id="fileindex-section" class="nav-section"> <h3>Pages</h3> <ul class="link-list"> - <li><a href="./CONTRIBUTING_md.html">CONTRIBUTING</a> - <li><a href="./History_md.html">History</a> - <li><a href="./README_md.html">README</a> - </ul> </div> @@ -118,7 +113,7 @@ <ul><li> <p>Have good commit messages</p> </li><li> -<p>Follow Ruby's coding style (<a href="https://bugs.ruby-lang.org/projects/ruby/wiki/DeveloperHowto">DeveloperHowTo</a>)</p> +<p>Follow Ruby’s coding style (<a href="https://bugs.ruby-lang.org/projects/ruby/wiki/DeveloperHowto">DeveloperHowTo</a>)</p> </li><li> <p>Pass the test suite successfully (see “Testing”)</p> </li><li> @@ -129,7 +124,7 @@ <p>We have a test suite!</p> -<p>Test cases are located under the <a href="https://github.com/ruby/openssl/tree/master/test">test/</a> directory.</p> +<p>Test cases are located under the {<code>test/</code><a href="https://github.com/ruby/openssl/tree/master/test">}</a> directory.</p> <p>You can run it with the following three commands:</p> @@ -143,7 +138,7 @@ $ rake test</pre> <p>First, you need to install <a href="https://www.docker.com/products/docker">Docker</a> and <a href="https://www.docker.com/products/docker-compose">Docker Compose</a> on your computer.</p> -<p>If you're on MacOS or Windows, we recommended to use the official <a href="https://www.docker.com/products/docker-toolbox">Docker Toolbox</a>. On Linux, follow the instructions for your package manager. For further information, please check the <a href="https://docs.docker.com/">official documentation</a>.</p> +<p>If you’re on MacOS or Windows, we recommended to use the official <a href="https://www.docker.com/products/docker-toolbox">Docker Toolbox</a>. On Linux, follow the instructions for your package manager. For further information, please check the <a href="https://docs.docker.com/">official documentation</a>.</p> <p>Once you have Docker and Docker Compose, running the following commands will build the container and execute the openssl tests. In this example, we will use Ruby version 2.3 with <a href="OpenSSL.html"><code>OpenSSL</code></a> version 1.0.2.</p> @@ -155,9 +150,9 @@ $ docker-compose run test # You may want an interactive shell for dubugging $ docker-compose run debug</pre> -<p>All possible values for <code>RUBY_VERSION</code> and <code>OPENSSL_VERSION</code> can be found in <a href="https://github.com/ruby/openssl/tree/master/.github/workflows/test.yml">test.yml</a>.</p> +<p>All possible values for <code>RUBY_VERSION</code> and <code>OPENSSL_VERSION</code> can be found in {<code>test.yml</code><a href="https://github.com/ruby/openssl/tree/master/.github/workflows/test.yml">}</a>.</p> -<p><strong>NOTE</strong>: these commands must be run from the openssl repository root, in order to use the <a href="https://github.com/ruby/openssl/blob/master/docker-compose.yml">docker-compose.yml</a> file we have provided.</p> +<p><strong>NOTE</strong>: these commands must be run from the openssl repository root, in order to use the {<code>docker-compose.yml</code><a href="https://github.com/ruby/openssl/blob/master/docker-compose.yml">}</a> file we have provided.</p> <p>This Docker image is built using the <a href="https://github.com/ruby/openssl/tree/master/tool/ruby-openssl-docker">Dockerfile</a> provided in the repository.</p> @@ -183,7 +178,7 @@ $ docker-compose run debug</pre> <p><em>Thanks for your contributions!</em></p> -<p><em>- The Ruby <a href="OpenSSL.html"><code>OpenSSL</code></a> team</em></p> +<p><em>- The Ruby OpenSSL team</em></p> </main> @@ -191,7 +186,7 @@ $ docker-compose run debug</pre> <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. + <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> diff --git a/History_md.html b/History_md.html index 473133f7..6e165f75 100644 --- a/History_md.html +++ b/History_md.html @@ -21,8 +21,6 @@ <link href="./css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="file"> <nav role="navigation"> <div id="project-navigation"> @@ -60,9 +58,13 @@ <h3>Table of Contents</h3> <ul class="link-list" role="directory"> + <li><a href="#label-Version+2.2.1">Version 2.2.1</a> + <li><a href="#label-Bug+fixes">Bug fixes</a> <li><a href="#label-Version+2.2.0">Version 2.2.0</a> <li><a href="#label-Compatibility+notes">Compatibility notes</a> <li><a href="#label-Notable+changes">Notable changes</a> + <li><a href="#label-Version+2.1.3">Version 2.1.3</a> + <li><a href="#label-Bug+fixes">Bug fixes</a> <li><a href="#label-Version+2.1.2">Version 2.1.2</a> <li><a href="#label-Version+2.1.1">Version 2.1.1</a> <li><a href="#label-Version+2.1.0">Version 2.1.0</a> @@ -97,17 +99,14 @@ <div id="project-metadata"> - <div id="fileindex-section" class="nav-section"> + +<div id="fileindex-section" class="nav-section"> <h3>Pages</h3> <ul class="link-list"> - <li><a href="./CONTRIBUTING_md.html">CONTRIBUTING</a> - <li><a href="./History_md.html">History</a> - <li><a href="./README_md.html">README</a> - </ul> </div> @@ -116,6 +115,17 @@ <main role="main" aria-label="Page History.md"> +<h1 id="label-Version+2.2.1">Version 2.2.1<span><a href="#label-Version+2.2.1">¶</a> <a href="#top">↑</a></span></h1> + +<p>Merged changes in 2.1.3. Additionally, the following issues are fixed by this release.</p> + +<h2 id="label-Bug+fixes">Bug fixes<span><a href="#label-Bug+fixes">¶</a> <a href="#top">↑</a></span></h2> +<ul><li> +<p>Fix crash in <code>OpenSSL::Timestamp::{Request,Response,TokenInfo}.new</code> when invalid arguments are given. {[GitHub #407]}[https://github.com/ruby/openssl/pull/407]</p> +</li><li> +<p>Fix <code>OpenSSL::Timestamp::Factory#create_timestamp</code> with LibreSSL on platforms where <code>time_t</code> has a different size from <code>long</code>. <a href="https://github.com/ruby/openssl/pull/454">[GitHub #454]</a></p> +</li></ul> + <h1 id="label-Version+2.2.0">Version 2.2.0<span><a href="#label-Version+2.2.0">¶</a> <a href="#top">↑</a></span></h1> <h2 id="label-Compatibility+notes">Compatibility notes<span><a href="#label-Compatibility+notes">¶</a> <a href="#top">↑</a></span></h2> @@ -143,7 +153,7 @@ </li><li> <p>Add <code>OpenSSL.fixed_length_secure_compare</code> for timing safe string comparison for strings of equal length. <a href="https://github.com/ruby/openssl/pull/269">[GitHub #269]</a></p> </li><li> -<p>Add <code>OpenSSL::SSL::SSLSocket#{finished_message,peer_finished_message} for last finished message sent and received. {[GitHub #250]}[https://github.com/ruby/openssl/pull/250]</code></p> +<p>Add <code>OpenSSL::SSL::SSLSocket#{finished_message,peer_finished_message}</code> for last finished message sent and received. {[GitHub #250]}[https://github.com/ruby/openssl/pull/250]</p> </li><li> <p>Add <code>OpenSSL::Timestamp</code> module for handing timestamp requests and responses. <a href="https://github.com/ruby/openssl/pull/204">[GitHub #204]</a></p> </li><li> @@ -151,9 +161,9 @@ </li><li> <p>Add <code>OpenSSL::ECPoint#add</code> for performing elliptic curve point addition. <a href="https://github.com/ruby/openssl/pull/261">[GitHub #261]</a></p> </li><li> -<p>Make <code>OpenSSL::PKey::RSA#{export,to_der} check key, factors, and crt_params to do proper private key serialization. {[GitHub #258]}[https://github.com/ruby/openssl/pull/258]</code></p> +<p>Make <code>OpenSSL::PKey::RSA#{export,to_der}</code> check <code>key</code>, <code>factors</code>, and <code>crt_params</code> to do proper private key serialization. {[GitHub #258]}[https://github.com/ruby/openssl/pull/258]</p> </li><li> -<p>Add <code>OpenSSL::SSL::{SSLSocket,SSLServer}#fileno, returning the underlying socket file descriptor number. {[GitHub #247]}[https://github.com/ruby/openssl/pull/247]</code></p> +<p>Add <code>OpenSSL::SSL::{SSLSocket,SSLServer}#fileno</code>, returning the underlying socket file descriptor number. {[GitHub #247]}[https://github.com/ruby/openssl/pull/247]</p> </li><li> <p>Support client certificates with TLS 1.3, and support post-handshake authentication with <a href="OpenSSL.html"><code>OpenSSL</code></a> 1.1.1+. <a href="https://github.com/ruby/openssl/pull/239">[GitHub #239]</a></p> </li><li> @@ -165,11 +175,38 @@ </li><li> <p>Ensure all valid IPv6 addresses are considered valid as elements of subjectAlternativeName in certificates. <a href="https://github.com/ruby/openssl/pull/185">[GitHub #185]</a></p> </li><li> -<p>Allow recipient's certificate to be omitted in PCKS7#decrypt. <a href="https://github.com/ruby/openssl/pull/183">[GitHub #183]</a></p> +<p>Allow recipient’s certificate to be omitted in PCKS7#decrypt. <a href="https://github.com/ruby/openssl/pull/183">[GitHub #183]</a></p> </li><li> <p>Add support for reading keys in PKCS #8 format and export via instance methods added to <code>OpenSSL::PKey</code> classes: <code>private_to_der</code>, <code>private_to_pem</code>, <code>public_to_der</code> and <code>public_to_pem</code>. <a href="https://github.com/ruby/openssl/pull/297">[GitHub #297]</a></p> </li></ul> +<h1 id="label-Version+2.1.3">Version 2.1.3<span><a href="#label-Version+2.1.3">¶</a> <a href="#top">↑</a></span></h1> + +<h2 id="label-Bug+fixes">Bug fixes<span><a href="#label-Bug+fixes">¶</a> <a href="#top">↑</a></span></h2> +<ul><li> +<p>Fix deprecation warnings on Ruby 3.0.</p> +</li><li> +<p>Add “.include” directive support in <code>OpenSSL::Config</code>. <a href="https://github.com/ruby/openssl/pull/216">[GitHub #216]</a></p> +</li><li> +<p>Fix handling of IPv6 address SANs. <a href="https://github.com/ruby/openssl/pull/185">[GitHub #185]</a></p> +</li><li> +<p>Hostname verification failure with <code>OpenSSL::SSL::SSLContext#verify_hostname=</code> sets a proper error code. <a href="https://github.com/ruby/openssl/pull/350">[GitHub #350]</a></p> +</li><li> +<p>Fix crash with <code>OpenSSL::BN.new(nil, 2)</code>. <a href="https://bugs.ruby-lang.org/issues/15760">[Bug #15760]</a></p> +</li><li> +<p><code>OpenSSL::SSL::SSLSocket#sys{read,write}</code> prevent internal string buffers from being modified by another thread. {[GitHub #453]}[https://github.com/ruby/openssl/pull/453]</p> +</li><li> +<p>Fix misuse of input record separator in <code>OpenSSL::Buffering</code> where it was for output.</p> +</li><li> +<p>Fix wrong interger casting in <code>OpenSSL::PKey::EC#dsa_verify_asn1</code>. <a href="https://github.com/ruby/openssl/pull/460">[GitHub #460]</a></p> +</li><li> +<p><code>extconf.rb</code> explicitly checks that OpenSSL’s version number is 1.0.1 or newer but also less than 3.0. Ruby/OpenSSL v2.1.x and v2.2.x will not support <a href="OpenSSL.html"><code>OpenSSL</code></a> 3.0 API. <a href="https://github.com/ruby/openssl/pull/458">[GitHub #458]</a></p> +</li><li> +<p>Activate <code>digest</code> gem correctly. <code>digest</code> library could go into an inconsistent state if there are multiple versions of <code>digest</code> is installed and <code>openssl</code> is <code>require</code>d before <code>digest</code>. <a href="https://github.com/ruby/openssl/pull/463">[GitHub #463]</a></p> +</li><li> +<p>Fix GC.compact compatibility. <a href="https://github.com/ruby/openssl/issues/464">[GitHub #464]</a> <a href="https://github.com/ruby/openssl/pull/465">[GitHub #465]</a></p> +</li></ul> + <h1 id="label-Version+2.1.2">Version 2.1.2<span><a href="#label-Version+2.1.2">¶</a> <a href="#top">↑</a></span></h1> <p>Merged changes in 2.0.9.</p> @@ -196,7 +233,7 @@ </li><li> <p><a href="OpenSSL/ASN1.html"><code>OpenSSL::ASN1</code></a> handles the indefinite length form better. <a href="OpenSSL/ASN1.html#method-c-decode"><code>OpenSSL::ASN1.decode</code></a> no longer wrongly treats the end-of-contents octets as part of the content. <a href="OpenSSL/ASN1/ASN1Data.html#attribute-i-infinite_length"><code>OpenSSL::ASN1::ASN1Data#infinite_length</code></a> is renamed to indefinite_length. <a href="https://github.com/ruby/openssl/pull/98">[GitHub #98]</a></p> </li><li> -<p><a href="OpenSSL/X509/Name.html#method-i-add_entry"><code>OpenSSL::X509::Name#add_entry</code></a> now accepts two additional keyword arguments 'loc' and 'set'. <a href="https://github.com/ruby/openssl/issues/94">[GitHub #94]</a></p> +<p><a href="OpenSSL/X509/Name.html#method-i-add_entry"><code>OpenSSL::X509::Name#add_entry</code></a> now accepts two additional keyword arguments ‘loc’ and ‘set’. <a href="https://github.com/ruby/openssl/issues/94">[GitHub #94]</a></p> </li><li> <p><a href="OpenSSL/SSL/SSLContext.html#method-i-min_version-3D"><code>OpenSSL::SSL::SSLContext#min_version=</code></a> and max_version= are added to replace ssl_version= that was built on top of the deprecated <a href="OpenSSL.html"><code>OpenSSL</code></a> C API. Use of that method and the constant OpenSSL::SSL::SSLContext::METHODS is now deprecated. <a href="https://github.com/ruby/openssl/pull/142">[GitHub #142]</a></p> </li><li> @@ -375,7 +412,7 @@ </li><li> <p><a href="OpenSSL/SSL/SSLContext.html#method-i-security_level-3D"><code>OpenSSL::SSL::SSLContext#security_level=</code></a> is added. You can set the “security level” of the SSL context. This is effective only when built with <a href="OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> </li><li> -<p>A new option 'verify_hostname' is added to <a href="OpenSSL/SSL/SSLContext.html"><code>OpenSSL::SSL::SSLContext</code></a>. When it is enabled, and the SNI hostname is also set, the hostname verification on the server certificate is automatically performed. It is now enabled by <a href="OpenSSL/SSL/SSLContext.html#method-i-set_params"><code>OpenSSL::SSL::SSLContext#set_params</code></a>. <a href="https://github.com/ruby/openssl/pull/60">[GH ruby/openssl#60]</a></p> +<p>A new option ‘verify_hostname’ is added to <a href="OpenSSL/SSL/SSLContext.html"><code>OpenSSL::SSL::SSLContext</code></a>. When it is enabled, and the SNI hostname is also set, the hostname verification on the server certificate is automatically performed. It is now enabled by <a href="OpenSSL/SSL/SSLContext.html#method-i-set_params"><code>OpenSSL::SSL::SSLContext#set_params</code></a>. <a href="https://github.com/ruby/openssl/pull/60">[GH ruby/openssl#60]</a></p> </li></ul> <h2 id="label-Removals">Removals<span><a href="#label-Removals">¶</a> <a href="#top">↑</a></span></h2> @@ -412,7 +449,7 @@ <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. + <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> @@ -21,8 +21,6 @@ <link href="./css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/IO/WaitReadable.html b/IO/WaitReadable.html index 579ff1c7..52585884 100644 --- a/IO/WaitReadable.html +++ b/IO/WaitReadable.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -75,25 +73,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/IO/WaitWritable.html b/IO/WaitWritable.html index a59d7d9d..fea0f78b 100644 --- a/IO/WaitWritable.html +++ b/IO/WaitWritable.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -75,25 +73,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/Integer.html b/Integer.html index 36d30877..20de35e2 100644 --- a/Integer.html +++ b/Integer.html @@ -21,8 +21,6 @@ <link href="./css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,24 +57,22 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-i-to_bn">#to_bn</a> - </ul> </div> @@ -92,68 +88,49 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-to_bn" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_bn</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Casts an <a href="Integer.html"><code>Integer</code></a> as an <a href="OpenSSL/BN.html"><code>OpenSSL::BN</code></a></p> -<p>See `man bn` for more info.</p> - - +<p>See ‘man bn` for more info.</p> - <div class="method-source-code" id="to_bn-source"> <pre><span class="ruby-comment"># File lib/openssl/bn.rb, line 37</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_bn</span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">BN</span><span class="ruby-operator">::</span><span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL.html b/OpenSSL.html index 864ac2ea..106a6203 100644 --- a/OpenSSL.html +++ b/OpenSSL.html @@ -21,8 +21,6 @@ <link href="./css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -99,32 +97,22 @@ - <!-- Method Quickref --> + +<!-- 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-fixed_length_secure_compare">::fixed_length_secure_compare</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-c-secure_compare">::secure_compare</a> - </ul> </div> @@ -208,7 +196,7 @@ <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> +<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> @@ -222,7 +210,7 @@ <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>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> @@ -368,7 +356,7 @@ decrypted << cipher.final</pre> <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> +<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-identifier">new</span>(<span class="ruby-string">'SHA1'</span>) @@ -392,7 +380,7 @@ decrypted << cipher.final</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> +<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> @@ -432,13 +420,13 @@ decrypted << cipher.final</pre> <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> +<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> +<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>( @@ -477,7 +465,7 @@ decrypted << cipher.final</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> +<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> @@ -556,7 +544,7 @@ decrypted << cipher.final</pre> <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. Set SSLSocket#sync_close to true if you want.</p> +<p>Note that SSLSocket#close doesn’t close the underlying socket by default. Set SSLSocket#sync_close to true if you want.</p> <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'socket'</span> @@ -575,7 +563,7 @@ decrypted << cipher.final</pre> <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> +<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> @@ -594,70 +582,42 @@ decrypted << cipher.final</pre> </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> - - </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> @@ -668,46 +628,29 @@ decrypted << cipher.final</pre> <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 lib/openssl/digest.rb, line 67</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) @@ -715,36 +658,22 @@ 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) @@ -754,38 +683,24 @@ ossl_debug_set(VALUE self, VALUE val) 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> - - +<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 _) @@ -801,36 +716,22 @@ ossl_get_errors(VALUE _) 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) @@ -845,31 +746,20 @@ ossl_fips_mode_get(VALUE self) #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> @@ -877,10 +767,7 @@ ossl_fips_mode_get(VALUE self) <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) @@ -903,38 +790,24 @@ ossl_fips_mode_set(VALUE self, VALUE enabled) #endif }</pre> </div> - </div> - - </div> - <div id="method-c-fixed_length_secure_compare" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> fixed_length_secure_compare(string, string) → boolean </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Constant time memory comparison for fixed length strings, such as results of <a href="OpenSSL/HMAC.html"><code>HMAC</code></a> calculations.</p> <p>Returns <code>true</code> if the strings are identical, <code>false</code> if they are of the same length but not identical. If the length is different, <code>ArgumentError</code> is raised.</p> - - - <div class="method-source-code" id="fixed_length_secure_compare-source"> <pre>static VALUE ossl_crypto_fixed_length_secure_compare(VALUE dummy, VALUE str1, VALUE str2) @@ -954,38 +827,24 @@ ossl_crypto_fixed_length_secure_compare(VALUE dummy, VALUE str1, VALUE str2) } }</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) @@ -994,31 +853,20 @@ mem_check_start(VALUE self) 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> @@ -1035,10 +883,7 @@ mem_check_start(VALUE self) <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) @@ -1047,8 +892,11 @@ print_mem_leaks(VALUE self) int ret; #endif - BN_CTX_free(ossl_bn_ctx); - ossl_bn_ctx = NULL; +#ifndef HAVE_RB_EXT_RACTOR_SAFE + // for Ruby 2.x + void ossl_bn_ctx_free(void); // ossl_bn.c + ossl_bn_ctx_free(); +#endif #if OPENSSL_VERSION_NUMBER >= 0x10100000 ret = CRYPTO_mem_leaks_fp(stderr); @@ -1061,36 +909,22 @@ print_mem_leaks(VALUE self) #endif }</pre> </div> - </div> - - </div> - <div id="method-c-secure_compare" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> secure_compare(string, string) → boolean </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Constant time memory comparison. Inputs are hashed using SHA-256 to mask the length of the secret. Returns <code>true</code> if the strings are identical, <code>false</code> otherwise.</p> - - - <div class="method-source-code" id="secure_compare-source"> <pre><span class="ruby-comment"># File lib/openssl.rb, line 33</span> <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">secure_compare</span>(<span class="ruby-identifier">a</span>, <span class="ruby-identifier">b</span>) @@ -1099,25 +933,20 @@ print_mem_leaks(VALUE self) <span class="ruby-constant">OpenSSL</span>.<span class="ruby-identifier">fixed_length_secure_compare</span>(<span class="ruby-identifier">hashed_a</span>, <span class="ruby-identifier">hashed_b</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">a</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">b</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/ASN1.html b/OpenSSL/ASN1.html index 9f7f7936..a66417e7 100644 --- a/OpenSSL/ASN1.html +++ b/OpenSSL/ASN1.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -80,18 +78,15 @@ - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-decode">::decode</a> - <li ><a href="#method-c-decode_all">::decode_all</a> - <li ><a href="#method-c-traverse">::traverse</a> - </ul> </div> @@ -219,53 +214,35 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="UNIVERSAL_TAG_NAME">UNIVERSAL_TAG_NAME - - <dd><p>Array storing tag names at the tag's index.</p> - - + <dd><p>Array storing tag names at the tag’s index.</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-decode" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::ASN1.decode(der) → ASN1Data </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Decodes a BER- or DER-encoded value and creates an <a href="ASN1/ASN1Data.html"><code>ASN1Data</code></a> instance. <em>der</em> may be a String or any object that features a <code>.to_der</code> method transforming it into a BER-/DER-encoded String+</p> <h2 id="method-c-decode-label-Example">Example<span><a href="#method-c-decode-label-Example">¶</a> <a href="#top">↑</a></span></h2> @@ -273,10 +250,7 @@ <pre class="ruby"><span class="ruby-identifier">der</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">binread</span>(<span class="ruby-string">'asn1data'</span>) <span class="ruby-identifier">asn1</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span>.<span class="ruby-identifier">decode</span>(<span class="ruby-identifier">der</span>) </pre> - - - <div class="method-source-code" id="decode-source"> <pre>static VALUE ossl_asn1_decode(VALUE self, VALUE obj) @@ -296,31 +270,20 @@ ossl_asn1_decode(VALUE self, VALUE obj) return ret; }</pre> </div> - </div> - - </div> - <div id="method-c-decode_all" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::ASN1.decode_all(der) → Array of ASN1Data </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Similar to decode with the difference that decode expects one distinct value represented in <em>der</em>. decode_all on the contrary decodes a sequence of sequential BER/DER values lined up in <em>der</em> and returns them as an array.</p> <h2 id="method-c-decode_all-label-Example">Example<span><a href="#method-c-decode_all-label-Example">¶</a> <a href="#top">↑</a></span></h2> @@ -328,10 +291,7 @@ ossl_asn1_decode(VALUE self, VALUE obj) <pre class="ruby"><span class="ruby-identifier">ders</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">binread</span>(<span class="ruby-string">'asn1data_seq'</span>) <span class="ruby-identifier">asn1_ary</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span>.<span class="ruby-identifier">decode_all</span>(<span class="ruby-identifier">ders</span>) </pre> - - - <div class="method-source-code" id="decode_all-source"> <pre>static VALUE ossl_asn1_decode_all(VALUE self, VALUE obj) @@ -359,31 +319,20 @@ ossl_asn1_decode_all(VALUE self, VALUE obj) return ary; }</pre> </div> - </div> - - </div> - <div id="method-c-traverse" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::ASN1.traverse(asn1) → nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>If a block is given, it prints out each of the elements encountered. Block parameters are (in that order):</p> <ul><li> <p>depth: The recursion depth, plus one with each constructed value being encountered (<a href="../Integer.html"><code>Integer</code></a>)</p> @@ -409,10 +358,7 @@ ossl_asn1_decode_all(VALUE self, VALUE obj) <span class="ruby-identifier">puts</span> <span class="ruby-node">"Header length: #{header_len} Tag: #{tag} Tag class: #{tag_class} Constructed: #{constructed}"</span> <span class="ruby-keyword">end</span> </pre> - - - <div class="method-source-code" id="traverse-source"> <pre>static VALUE ossl_asn1_traverse(VALUE self, VALUE obj) @@ -431,25 +377,20 @@ ossl_asn1_traverse(VALUE self, VALUE obj) return Qnil; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/ASN1/ASN1Data.html b/OpenSSL/ASN1/ASN1Data.html index 4fccbabf..879e7ba8 100644 --- a/OpenSSL/ASN1/ASN1Data.html +++ b/OpenSSL/ASN1/ASN1Data.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -71,26 +69,23 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-to_der">#to_der</a> - </ul> </div> @@ -188,21 +183,15 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-indefinite_length" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">indefinite_length</span><span @@ -210,12 +199,9 @@ </div> <div class="method-description"> - <p>Never <code>nil</code>. A boolean value indicating whether the encoding uses indefinite length (in the case of parsing) or whether an indefinite length form shall be used (in the encoding case). In DER, every value uses definite length form. But in scenarios where large amounts of data need to be transferred it might be desirable to have some kind of streaming support available. For example, huge OCTET STRINGs are preferably sent in smaller-sized chunks, each at a time. This is possible in BER by setting the length bytes of an encoding to zero and by this indicating that the following value will be sent in chunks. Indefinite length encodings are always constructed. The end of such a stream of chunks is indicated by sending a EOC (End of Content) tag. SETs and SEQUENCEs may use an indefinite length encoding, but also primitive types such as e.g. OCTET STRINGS or BIT STRINGS may leverage this functionality (cf. ITU-T X.690).</p> - </div> </div> - <div id="attribute-i-infinite_length" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">infinite_length</span><span @@ -223,12 +209,9 @@ </div> <div class="method-description"> - <p>Never <code>nil</code>. A boolean value indicating whether the encoding uses indefinite length (in the case of parsing) or whether an indefinite length form shall be used (in the encoding case). In DER, every value uses definite length form. But in scenarios where large amounts of data need to be transferred it might be desirable to have some kind of streaming support available. For example, huge OCTET STRINGs are preferably sent in smaller-sized chunks, each at a time. This is possible in BER by setting the length bytes of an encoding to zero and by this indicating that the following value will be sent in chunks. Indefinite length encodings are always constructed. The end of such a stream of chunks is indicated by sending a EOC (End of Content) tag. SETs and SEQUENCEs may use an indefinite length encoding, but also primitive types such as e.g. OCTET STRINGS or BIT STRINGS may leverage this functionality (cf. ITU-T X.690).</p> - </div> </div> - <div id="attribute-i-tag" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">tag</span><span @@ -236,12 +219,9 @@ </div> <div class="method-description"> - <p>An <a href="../../Integer.html"><code>Integer</code></a> representing the tag number of this <a href="ASN1Data.html"><code>ASN1Data</code></a>. Never <code>nil</code>.</p> - </div> </div> - <div id="attribute-i-tag_class" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">tag_class</span><span @@ -249,12 +229,9 @@ </div> <div class="method-description"> - <p>A Symbol representing the tag class of this <a href="ASN1Data.html"><code>ASN1Data</code></a>. Never <code>nil</code>. See <a href="ASN1Data.html"><code>ASN1Data</code></a> for possible values.</p> - </div> </div> - <div id="attribute-i-value" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">value</span><span @@ -262,38 +239,26 @@ </div> <div class="method-description"> - <p>Carries the value of a ASN.1 type. Please confer <a href="Constructive.html"><code>Constructive</code></a> and <a href="Primitive.html"><code>Primitive</code></a> for the mappings between ASN.1 data types and Ruby classes.</p> - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::ASN1::ASN1Data.new(value, tag, tag_class) → ASN1Data </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p><em>value</em>: Please have a look at <a href="Constructive.html"><code>Constructive</code></a> and <a href="Primitive.html"><code>Primitive</code></a> to see how Ruby types are mapped to ASN.1 types and vice versa.</p> <p><em>tag</em>: An <a href="../../Integer.html"><code>Integer</code></a> indicating the tag number.</p> @@ -305,10 +270,7 @@ <pre class="ruby"><span class="ruby-identifier">asn1_int</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1Data</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">42</span>, <span class="ruby-value">2</span>, <span class="ruby-value">:UNIVERSAL</span>) <span class="ruby-comment"># => Same as OpenSSL::ASN1::Integer.new(42)</span> <span class="ruby-identifier">tagged_int</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1Data</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">42</span>, <span class="ruby-value">0</span>, <span class="ruby-value">:CONTEXT_SPECIFIC</span>) <span class="ruby-comment"># implicitly 0-tagged INTEGER</span> </pre> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_asn1data_initialize(VALUE self, VALUE value, VALUE tag, VALUE tag_class) @@ -323,44 +285,29 @@ ossl_asn1data_initialize(VALUE self, VALUE value, VALUE tag, VALUE tag_class) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → DER-encoded String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Encodes this <a href="ASN1Data.html"><code>ASN1Data</code></a> into a DER-encoded String value. The result is DER-encoded except for the possibility of indefinite length forms. Indefinite length forms are not allowed in strict DER, so strictly speaking the result of such an encoding would be a BER-encoding.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_asn1data_to_der(VALUE self) @@ -377,25 +324,20 @@ ossl_asn1data_to_der(VALUE self) } }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/ASN1/ASN1Error.html b/OpenSSL/ASN1/ASN1Error.html index 4f5ba7d3..51201a1f 100644 --- a/OpenSSL/ASN1/ASN1Error.html +++ b/OpenSSL/ASN1/ASN1Error.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/ASN1/Constructive.html b/OpenSSL/ASN1/Constructive.html index 6ebe7462..cd50b3a7 100644 --- a/OpenSSL/ASN1/Constructive.html +++ b/OpenSSL/ASN1/Constructive.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -69,39 +67,32 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="ASN1Data.html">OpenSSL::ASN1::ASN1Data</a> - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><span class="include">Enumerable</span> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-each">#each</a> - <li ><a href="#method-i-to_der">#to_der</a> - </ul> </div> @@ -144,21 +135,15 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-tagging" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">tagging</span><span @@ -166,38 +151,26 @@ </div> <div class="method-description"> - <p>May be used as a hint for encoding a value either implicitly or explicitly by setting it either to <code>:IMPLICIT</code> or to <code>:EXPLICIT</code>. <em>tagging</em> is not set when a ASN.1 structure is parsed using <a href="../ASN1.html#method-c-decode"><code>OpenSSL::ASN1.decode</code></a>.</p> - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::ASN1::Primitive.new(value [, tag, tagging, tag_class ]) → Primitive </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p><em>value</em>: is mandatory.</p> <p><em>tag</em>: optional, may be specified for tagged values. If no <em>tag</em> is specified, the UNIVERSAL tag corresponding to the <a href="Primitive.html"><code>Primitive</code></a> sub-class is used by default.</p> @@ -212,10 +185,7 @@ <span class="ruby-identifier">zero_tagged_int</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span><span class="ruby-operator">::</span><span class="ruby-constant">Integer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">42</span>, <span class="ruby-value">0</span>, <span class="ruby-value">:IMPLICIT</span>) <span class="ruby-identifier">private_explicit_zero_tagged_int</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span><span class="ruby-operator">::</span><span class="ruby-constant">Integer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">42</span>, <span class="ruby-value">0</span>, <span class="ruby-value">:EXPLICIT</span>, <span class="ruby-value">:PRIVATE</span>) </pre> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_asn1_initialize(int argc, VALUE *argv, VALUE self) @@ -256,39 +226,27 @@ ossl_asn1_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-each" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> each { |asn1| block } → asn1_ary </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Calls the given block once for each element in self, passing that element as parameter <em>asn1</em>. If no block is given, an enumerator is returned instead.</p> <h2 id="method-i-each-label-Example">Example<span><a href="#method-i-each-label-Example">¶</a> <a href="#top">↑</a></span></h2> @@ -297,10 +255,7 @@ ossl_asn1_initialize(int argc, VALUE *argv, VALUE self) <span class="ruby-identifier">puts</span> <span class="ruby-identifier">asn1</span> <span class="ruby-keyword">end</span> </pre> - - - <div class="method-source-code" id="each-source"> <pre>static VALUE ossl_asn1cons_each(VALUE self) @@ -310,36 +265,22 @@ ossl_asn1cons_each(VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → DER-encoded String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See <a href="ASN1Data.html#method-i-to_der"><code>ASN1Data#to_der</code></a> for details.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_asn1cons_to_der(VALUE self) @@ -373,25 +314,20 @@ ossl_asn1cons_to_der(VALUE self) return to_der_internal(self, 1, indef_len, str); }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/ASN1/ObjectId.html b/OpenSSL/ASN1/ObjectId.html index a73c0ba2..81accddf 100644 --- a/OpenSSL/ASN1/ObjectId.html +++ b/OpenSSL/ASN1/ObjectId.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,36 +57,28 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="Primitive.html">OpenSSL::ASN1::Primitive</a> - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-register">::register</a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-ln">#ln</a> - <li ><a href="#method-i-long_name">#long_name</a> - <li ><a href="#method-i-oid">#oid</a> - <li ><a href="#method-i-short_name">#short_name</a> - <li ><a href="#method-i-sn">#sn</a> - </ul> </div> @@ -106,46 +96,30 @@ </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-register" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::ASN1::ObjectId.register(object_id, short_name, long_name) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>This adds a new <a href="ObjectId.html"><code>ObjectId</code></a> to the internal tables. Where <em>object_id</em> is the numerical form, <em>short_name</em> is the short name, and <em>long_name</em> is the long name.</p> <p>Returns <code>true</code> if successful. Raises an <a href="ASN1Error.html"><code>OpenSSL::ASN1::ASN1Error</code></a> if it fails.</p> - - - <div class="method-source-code" id="register-source"> <pre>static VALUE ossl_asn1obj_s_register(VALUE self, VALUE oid, VALUE sn, VALUE ln) @@ -160,44 +134,29 @@ ossl_asn1obj_s_register(VALUE self, VALUE oid, VALUE sn, VALUE ln) return Qtrue; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3D-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> oid == other_oid → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns <code>true</code> if <em>other_oid</em> is the same as <em>oid</em></p> - - - <div class="method-source-code" id="3D-3D-source"> <pre>static VALUE ossl_asn1obj_eq(VALUE self, VALUE other) @@ -217,43 +176,22 @@ ossl_asn1obj_eq(VALUE self, VALUE other) return nidSelf == nidOther ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-ln" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> ln → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-heading"> - <span class="method-callseq"> - long_name → string - </span> - - </div> - - <div class="method-description"> - <p>The long name of the <a href="ObjectId.html"><code>ObjectId</code></a>, as defined in <openssl/objects.h>.</p> - - - <div class="method-source-code" id="ln-source"> <pre>static VALUE ossl_asn1obj_get_ln(VALUE self) @@ -268,68 +206,43 @@ ossl_asn1obj_get_ln(VALUE self) return ret; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="ObjectId.html#method-i-long_name">long_name</a> </div> - - </div> - <div id="method-i-long_name" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">long_name</span><span - class="method-args">()</span> - + <span class="method-callseq"> + long_name → string + </span> </div> - <div class="method-description"> - - - - + <p>The long name of the <a href="ObjectId.html"><code>ObjectId</code></a>, as defined in <openssl/objects.h>.</p> - </div> - - <div class="aliases"> Alias for: <a href="ObjectId.html#method-i-ln">ln</a> </div> - </div> - <div id="method-i-oid" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> oid → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a String representing the Object Identifier in the dot notation, e.g. “1.2.3.4.5”</p> - - - <div class="method-source-code" id="oid-source"> <pre>static VALUE ossl_asn1obj_get_oid(VALUE self) @@ -346,71 +259,40 @@ ossl_asn1obj_get_oid(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-short_name" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">short_name</span><span - class="method-args">()</span> - + <span class="method-callseq"> + short_name → string + </span> </div> - <div class="method-description"> - - - - + <p>The short name of the <a href="ObjectId.html"><code>ObjectId</code></a>, as defined in <openssl/objects.h>.</p> - </div> - - <div class="aliases"> Alias for: <a href="ObjectId.html#method-i-sn">sn</a> </div> - </div> - <div id="method-i-sn" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sn → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-heading"> - <span class="method-callseq"> - short_name → string - </span> - - </div> - - <div class="method-description"> - <p>The short name of the <a href="ObjectId.html"><code>ObjectId</code></a>, as defined in <openssl/objects.h>.</p> - - - <div class="method-source-code" id="sn-source"> <pre>static VALUE ossl_asn1obj_get_sn(VALUE self) @@ -425,29 +307,23 @@ ossl_asn1obj_get_sn(VALUE self) return ret; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="ObjectId.html#method-i-short_name">short_name</a> </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/ASN1/Primitive.html b/OpenSSL/ASN1/Primitive.html index ee833b0e..81108229 100644 --- a/OpenSSL/ASN1/Primitive.html +++ b/OpenSSL/ASN1/Primitive.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -74,26 +72,23 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="ASN1Data.html">OpenSSL::ASN1::ASN1Data</a> - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-to_der">#to_der</a> - </ul> </div> @@ -158,7 +153,7 @@ <h3 id="class-OpenSSL::ASN1::Primitive-label-Additional+attributes">Additional attributes<span><a href="#class-OpenSSL::ASN1::Primitive-label-Additional+attributes">¶</a> <a href="#top">↑</a></span></h3> -<p><em>unused_bits</em>: if the underlying BIT STRING's length is a multiple of 8 then <em>unused_bits</em> is 0. Otherwise <em>unused_bits</em> indicates the number of bits that are to be ignored in the final octet of the BitString's <em>value</em>.</p> +<p><em>unused_bits</em>: if the underlying BIT STRING’s length is a multiple of 8 then <em>unused_bits</em> is 0. Otherwise <em>unused_bits</em> indicates the number of bits that are to be ignored in the final octet of the BitString’s <em>value</em>.</p> <h2 id="class-OpenSSL::ASN1::Primitive-label-OpenSSL-3A-3AASN1-3A-3AObjectId"><a href="ObjectId.html"><code>OpenSSL::ASN1::ObjectId</code></a><span><a href="#class-OpenSSL::ASN1::Primitive-label-OpenSSL-3A-3AASN1-3A-3AObjectId">¶</a> <a href="#top">↑</a></span></h2> @@ -194,21 +189,15 @@ prim_zero_tagged_explicit = <class>.new(value, 0, :EXPLICIT)</pre> </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-tagging" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">tagging</span><span @@ -216,38 +205,26 @@ prim_zero_tagged_explicit = <class>.new(value, 0, :EXPLICIT)</pre> </div> <div class="method-description"> - <p>May be used as a hint for encoding a value either implicitly or explicitly by setting it either to <code>:IMPLICIT</code> or to <code>:EXPLICIT</code>. <em>tagging</em> is not set when a ASN.1 structure is parsed using <a href="../ASN1.html#method-c-decode"><code>OpenSSL::ASN1.decode</code></a>.</p> - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::ASN1::Primitive.new(value [, tag, tagging, tag_class ]) → Primitive </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p><em>value</em>: is mandatory.</p> <p><em>tag</em>: optional, may be specified for tagged values. If no <em>tag</em> is specified, the UNIVERSAL tag corresponding to the <a href="Primitive.html"><code>Primitive</code></a> sub-class is used by default.</p> @@ -262,10 +239,7 @@ prim_zero_tagged_explicit = <class>.new(value, 0, :EXPLICIT)</pre> <span class="ruby-identifier">zero_tagged_int</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span><span class="ruby-operator">::</span><span class="ruby-constant">Integer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">42</span>, <span class="ruby-value">0</span>, <span class="ruby-value">:IMPLICIT</span>) <span class="ruby-identifier">private_explicit_zero_tagged_int</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">ASN1</span><span class="ruby-operator">::</span><span class="ruby-constant">Integer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">42</span>, <span class="ruby-value">0</span>, <span class="ruby-value">:EXPLICIT</span>, <span class="ruby-value">:PRIVATE</span>) </pre> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_asn1_initialize(int argc, VALUE *argv, VALUE self) @@ -306,44 +280,29 @@ ossl_asn1_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → DER-encoded String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See <a href="ASN1Data.html#method-i-to_der"><code>ASN1Data#to_der</code></a> for details.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_asn1prim_to_der(VALUE self) @@ -383,25 +342,20 @@ ossl_asn1prim_to_der(VALUE self) return to_der_internal(self, 0, 0, rb_str_drop_bytes(str, alllen - bodylen)); }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/BN.html b/OpenSSL/BN.html index 19dc58aa..d865d64d 100644 --- a/OpenSSL/BN.html +++ b/OpenSSL/BN.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,129 +57,77 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><span class="include">Comparable</span> - - </ul> </div> - <!-- Method Quickref --> + +<!-- 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_prime">::generate_prime</a> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-25">#%</a> - <li ><a href="#method-i-2A">#*</a> - <li ><a href="#method-i-2A-2A">#**</a> - <li ><a href="#method-i-2B">#+</a> - <li ><a href="#method-i-2B-40">#+@</a> - <li ><a href="#method-i-2D">#-</a> - <li ><a href="#method-i-2D-40">#-@</a> - <li ><a href="#method-i-2F">#/</a> - <li ><a href="#method-i-3C-3C">#<<</a> - <li ><a href="#method-i-3C-3D-3E">#<=></a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-3D-3D-3D">#===</a> - <li ><a href="#method-i-3E-3E">#>></a> - <li ><a href="#method-i-bit_set-3F">#bit_set?</a> - <li ><a href="#method-i-clear_bit-21">#clear_bit!</a> - <li ><a href="#method-i-cmp">#cmp</a> - <li ><a href="#method-i-coerce">#coerce</a> - <li ><a href="#method-i-copy">#copy</a> - <li ><a href="#method-i-eql-3F">#eql?</a> - <li ><a href="#method-i-gcd">#gcd</a> - <li ><a href="#method-i-hash">#hash</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-lshift-21">#lshift!</a> - <li ><a href="#method-i-mod_add">#mod_add</a> - <li ><a href="#method-i-mod_exp">#mod_exp</a> - <li ><a href="#method-i-mod_inverse">#mod_inverse</a> - <li ><a href="#method-i-mod_mul">#mod_mul</a> - <li ><a href="#method-i-mod_sqr">#mod_sqr</a> - <li ><a href="#method-i-mod_sub">#mod_sub</a> - <li ><a href="#method-i-negative-3F">#negative?</a> - <li ><a href="#method-i-num_bits">#num_bits</a> - <li ><a href="#method-i-num_bytes">#num_bytes</a> - <li ><a href="#method-i-odd-3F">#odd?</a> - <li ><a href="#method-i-one-3F">#one?</a> - <li ><a href="#method-i-pretty_print">#pretty_print</a> - <li ><a href="#method-i-prime-3F">#prime?</a> - <li ><a href="#method-i-prime_fasttest-3F">#prime_fasttest?</a> - <li ><a href="#method-i-rshift-21">#rshift!</a> - <li ><a href="#method-i-set_bit-21">#set_bit!</a> - <li ><a href="#method-i-sqr">#sqr</a> - <li ><a href="#method-i-to_bn">#to_bn</a> - <li ><a href="#method-i-to_i">#to_i</a> - <li ><a href="#method-i-to_int">#to_int</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-ucmp">#ucmp</a> - <li ><a href="#method-i-zero-3F">#zero?</a> - </ul> </div> @@ -197,39 +143,26 @@ </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_prime" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> generate_prime(bits, [, safe [, add [, rem]]]) → bn </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Generates a random prime number of bit length <em>bits</em>. If <em>safe</em> is set to <code>true</code>, generates a safe prime. If <em>add</em> is specified, generates a prime that fulfills condition <code>p % add = rem</code>.</p> <h3 id="method-c-generate_prime-label-Parameters">Parameters<span><a href="#method-c-generate_prime-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> @@ -242,10 +175,7 @@ </li><li> <p><em>rem</em> - <a href="BN.html"><code>BN</code></a></p> </li></ul> - - - <div class="method-source-code" id="generate_prime-source"> <pre>static VALUE ossl_bn_s_generate_prime(int argc, VALUE *argv, VALUE klass) @@ -278,57 +208,37 @@ ossl_bn_s_generate_prime(int argc, VALUE *argv, VALUE klass) return obj; }</pre> </div> - </div> - - </div> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::BN.new(bn) → aBN </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::BN.new(integer) → aBN </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::BN.new(string) → aBN </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::BN.new(string, 0 | 2 | 10 | 16) → aBN </span> - </div> - - <div class="method-description"> - <p>Construct a new <a href="../OpenSSL.html"><code>OpenSSL</code></a> BIGNUM object.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_bn_initialize(int argc, VALUE *argv, VALUE self) @@ -394,152 +304,89 @@ ossl_bn_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-25" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> bn % bn2 → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-2A" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> bn * bn2 → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-2A-2A" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> bn ** bn2 → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-2B" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> bn + bn2 → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-2B-40" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> +bn → aBN </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="2B-40-source"> <pre>static VALUE ossl_bn_uplus(VALUE self) @@ -547,63 +394,37 @@ ossl_bn_uplus(VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-2D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> bn - bn2 → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-2D-40" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> -bn → aBN </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="2D-40-source"> <pre>static VALUE ossl_bn_uminus(VALUE self) @@ -622,36 +443,22 @@ ossl_bn_uminus(VALUE self) return obj; }</pre> </div> - </div> - - </div> - <div id="method-i-2F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> bn1 / bn2 → [result, remainder] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Division of <a href="BN.html"><code>OpenSSL::BN</code></a> instances</p> - - - <div class="method-source-code" id="2F-source"> <pre>static VALUE ossl_bn_div(VALUE self, VALUE other) @@ -682,91 +489,54 @@ ossl_bn_div(VALUE self, VALUE other) return rb_ary_new3(2, obj1, obj2); }</pre> </div> - </div> - - </div> - <div id="method-i-3C-3C" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> bn << bits → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-3C-3D-3E" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name"><=></span><span class="method-args">(p1)</span> - </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="BN.html#method-i-cmp">cmp</a> </div> - </div> - <div id="method-i-3D-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> bn == obj → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns <code>true</code> only if <em>obj</em> has the same value as <em>bn</em>. Contrast this with <a href="BN.html#method-i-eql-3F"><code>OpenSSL::BN#eql?</code></a>, which requires obj to be <a href="BN.html"><code>OpenSSL::BN</code></a>.</p> - - - <div class="method-source-code" id="3D-3D-source"> <pre>static VALUE ossl_bn_eq(VALUE self, VALUE other) @@ -785,95 +555,57 @@ ossl_bn_eq(VALUE self, VALUE other) return Qfalse; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="BN.html#method-i-3D-3D-3D">===</a> </div> - - </div> - <div id="method-i-3D-3D-3D" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">===</span><span class="method-args">(p1)</span> - </div> - <div class="method-description"> - - - - + <p>Returns <code>true</code> only if <em>obj</em> has the same value as <em>bn</em>. Contrast this with <a href="BN.html#method-i-eql-3F"><code>OpenSSL::BN#eql?</code></a>, which requires obj to be <a href="BN.html"><code>OpenSSL::BN</code></a>.</p> - </div> - - <div class="aliases"> Alias for: <a href="BN.html#method-i-3D-3D">==</a> </div> - </div> - <div id="method-i-3E-3E" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> bn >> bits → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-bit_set-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> bit_set?(bit) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Tests bit <em>bit</em> in <em>bn</em> and returns <code>true</code> if set, <code>false</code> if not set.</p> - - - <div class="method-source-code" id="bit_set-3F-source"> <pre>static VALUE ossl_bn_is_bit_set(VALUE self, VALUE bit) @@ -889,91 +621,54 @@ ossl_bn_is_bit_set(VALUE self, VALUE bit) return Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-clear_bit-21" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> clear_bit!(bit) → self </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-cmp" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cmp(bn2) → integer </span> - </div> - - <div class="method-description"> - - - - </div> - <div class="aliases"> Also aliased as: <a href="BN.html#method-i-3C-3D-3E"><=></a> </div> - - </div> - <div id="method-i-coerce" class="method-detail "> - <div class="method-heading"> <span class="method-name">coerce</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="coerce-source"> <pre>static VALUE ossl_bn_coerce(VALUE self, VALUE other) @@ -994,82 +689,39 @@ ossl_bn_coerce(VALUE self, VALUE other) return rb_assoc_new(other, self); }</pre> </div> - </div> - - </div> - - <div id="method-i-copy" class="method-detail "> - + <div id="method-i-copy" class="method-detail method-alias"> <div class="method-heading"> <span class="method-name">copy</span><span class="method-args">(p1)</span> - - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - - <div class="method-source-code" id="copy-source"> - <pre>static VALUE -ossl_bn_copy(VALUE self, VALUE other) -{ - BIGNUM *bn1, *bn2; - - rb_check_frozen(self); - - if (self == other) return self; - - GetBN(self, bn1); - bn2 = GetBNPtr(other); - - if (!BN_copy(bn1, bn2)) { - ossl_raise(eBNError, NULL); - } - return self; -}</pre> - </div> - </div> - - + <div class="aliases"> + Alias for: <a href="BN.html#method-i-initialize_copy">initialize_copy</a> + </div> </div> - <div id="method-i-eql-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> eql?(obj) → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Returns <code>true</code> only if <em>obj</em> is a <code>OpenSSL::BN</code> with the same value as <em>bn</em>. Contrast this with OpenSSL::BN#==, which performs type conversions.</p> - - + <p>Returns <code>true</code> only if <em>obj</em> is a <code>OpenSSL::BN</code> with the same value as <em>bn</em>. Contrast this with <a href="BN.html#method-i-3D-3D"><code>OpenSSL::BN#==</code></a>, which performs type conversions.</p> - <div class="method-source-code" id="eql-3F-source"> <pre>static VALUE ossl_bn_eql(VALUE self, VALUE other) @@ -1084,65 +736,39 @@ ossl_bn_eql(VALUE self, VALUE other) return BN_cmp(bn1, bn2) ? Qfalse : Qtrue; }</pre> </div> - </div> - - </div> - <div id="method-i-gcd" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> gcd(bn2) → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-hash" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> hash → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a hash code for this object.</p> <p>See also Object#hash.</p> - - - <div class="method-source-code" id="hash-source"> <pre>static VALUE ossl_bn_hash(VALUE self) @@ -1166,33 +792,21 @@ ossl_bn_hash(VALUE self) return hash; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_bn_copy(VALUE self, VALUE other) @@ -1212,225 +826,145 @@ ossl_bn_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - + <div class="aliases"> + Also aliased as: <a href="BN.html#method-i-copy">copy</a> + </div> - </div> - <div id="method-i-lshift-21" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> lshift!(bits) → self </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-mod_add" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> mod_add(bn1, bn2) → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-mod_exp" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> mod_exp(bn1, bn2) → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-mod_inverse" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> mod_inverse(bn2) → aBN </span> - + <span class="method-click-advice">click to toggle source</span> </div> - - <div class="method-description"> - - - - + <div class="method-source-code" id="mod_inverse-source"> + <pre>static VALUE +ossl_bn_mod_inverse(VALUE self, VALUE other) +{ + BIGNUM *bn1, *bn2 = GetBNPtr(other), *result; + VALUE obj; + GetBN(self, bn1); + obj = NewBN(rb_obj_class(self)); + if (!(result = BN_mod_inverse(NULL, bn1, bn2, ossl_bn_ctx))) + ossl_raise(eBNError, "BN_mod_inverse"); + SetBN(obj, result); + return obj; +}</pre> + </div> </div> - - </div> - <div id="method-i-mod_mul" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> mod_mul(bn1, bn2) → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-mod_sqr" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> mod_sqr(bn2) → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-mod_sub" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> mod_sub(bn1, bn2) → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-negative-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> negative? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="negative-3F-source"> <pre>static VALUE ossl_bn_is_negative(VALUE self) @@ -1443,141 +977,81 @@ ossl_bn_is_negative(VALUE self) return BN_is_negative(bn) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-num_bits" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> num_bits → integer </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-num_bytes" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> num_bytes → integer </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-odd-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> odd? → true | false </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-one-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> one? → true | false </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-pretty_print" class="method-detail "> - <div class="method-heading"> <span class="method-name">pretty_print</span><span class="method-args">(q)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="pretty_print-source"> <pre><span class="ruby-comment"># File lib/openssl/bn.rb, line 20</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pretty_print</span>(<span class="ruby-identifier">q</span>) @@ -1587,48 +1061,32 @@ ossl_bn_is_negative(VALUE self) } <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-prime-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> prime? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> prime?(checks) → true | false </span> - </div> - - <div class="method-description"> - <p>Performs a Miller-Rabin probabilistic primality test with <em>checks</em> iterations. If <em>checks</em> is not specified, a number of iterations is used that yields a false positive rate of at most 2^-80 for random input.</p> <h3 id="method-i-prime-3F-label-Parameters">Parameters<span><a href="#method-i-prime-3F-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> <ul><li> <p><em>checks</em> - integer</p> </li></ul> - - - <div class="method-source-code" id="prime-3F-source"> <pre>static VALUE ossl_bn_is_prime(int argc, VALUE *argv, VALUE self) @@ -1653,45 +1111,30 @@ ossl_bn_is_prime(int argc, VALUE *argv, VALUE self) return Qnil; }</pre> </div> - </div> - - </div> - <div id="method-i-prime_fasttest-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> prime_fasttest? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> prime_fasttest?(checks) → true | false </span> - </div> - <div class="method-heading"> <span class="method-callseq"> prime_fasttest?(checks, trial_div) → true | false </span> - </div> - - <div class="method-description"> - <p>Performs a Miller-Rabin primality test. This is same as <a href="BN.html#method-i-prime-3F"><code>prime?</code></a> except this first attempts trial divisions with some small primes.</p> <h3 id="method-i-prime_fasttest-3F-label-Parameters">Parameters<span><a href="#method-i-prime_fasttest-3F-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> @@ -1700,10 +1143,7 @@ ossl_bn_is_prime(int argc, VALUE *argv, VALUE self) </li><li> <p><em>trial_div</em> - boolean</p> </li></ul> - - - <div class="method-source-code" id="prime_fasttest-3F-source"> <pre>static VALUE ossl_bn_is_prime_fasttest(int argc, VALUE *argv, VALUE self) @@ -1734,114 +1174,66 @@ ossl_bn_is_prime_fasttest(int argc, VALUE *argv, VALUE self) return Qnil; }</pre> </div> - </div> - - </div> - <div id="method-i-rshift-21" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> rshift!(bits) → self </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-set_bit-21" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_bit!(bit) → self </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-sqr" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sqr → aBN </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-to_bn" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_bn</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_bn-source"> <pre>static VALUE ossl_bn_to_bn(VALUE self) @@ -1849,36 +1241,22 @@ ossl_bn_to_bn(VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-to_i" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_i → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="to_i-source"> <pre>static VALUE ossl_bn_to_i(VALUE self) @@ -1898,70 +1276,45 @@ ossl_bn_to_i(VALUE self) return num; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="BN.html#method-i-to_int">to_int</a> </div> - - </div> - <div id="method-i-to_int" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">to_int</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="BN.html#method-i-to_i">to_i</a> </div> - </div> - <div id="method-i-to_s" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_s → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> to_s(base) → string </span> - </div> - - <div class="method-description"> - <h3 id="method-i-to_s-label-Parameters">Parameters<span><a href="#method-i-to_s-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> <ul><li> <p><em>base</em> - <a href="../Integer.html"><code>Integer</code></a> Valid values:</p> @@ -1975,10 +1328,7 @@ ossl_bn_to_i(VALUE self) <p>16 - hex</p> </li></ul> </li></ul> - - - <div class="method-source-code" id="to_s-source"> <pre>static VALUE ossl_bn_to_s(int argc, VALUE *argv, VALUE self) @@ -2020,79 +1370,50 @@ ossl_bn_to_s(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-ucmp" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> ucmp(bn2) → integer </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - <div id="method-i-zero-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> zero? → true | false </span> - </div> - - <div class="method-description"> - - - - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/BNError.html b/OpenSSL/BNError.html index 4aef1aec..a468d517 100644 --- a/OpenSSL/BNError.html +++ b/OpenSSL/BNError.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/Buffering.html b/OpenSSL/Buffering.html index 906bd93a..abaa0cfa 100644 --- a/OpenSSL/Buffering.html +++ b/OpenSSL/Buffering.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -60,71 +58,45 @@ <div id="class-metadata"> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><span class="include">Enumerable</span> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li class="calls-super" ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3C-3C">#<<</a> - <li ><a href="#method-i-close">#close</a> - <li ><a href="#method-i-each">#each</a> - <li ><a href="#method-i-each_byte">#each_byte</a> - <li ><a href="#method-i-each_line">#each_line</a> - <li ><a href="#method-i-eof">#eof</a> - <li ><a href="#method-i-eof-3F">#eof?</a> - <li ><a href="#method-i-flush">#flush</a> - <li ><a href="#method-i-getc">#getc</a> - <li ><a href="#method-i-gets">#gets</a> - <li ><a href="#method-i-print">#print</a> - <li ><a href="#method-i-printf">#printf</a> - <li ><a href="#method-i-puts">#puts</a> - <li ><a href="#method-i-read">#read</a> - <li ><a href="#method-i-read_nonblock">#read_nonblock</a> - <li ><a href="#method-i-readchar">#readchar</a> - <li ><a href="#method-i-readline">#readline</a> - <li ><a href="#method-i-readlines">#readlines</a> - <li ><a href="#method-i-readpartial">#readpartial</a> - <li ><a href="#method-i-ungetc">#ungetc</a> - <li ><a href="#method-i-write">#write</a> - <li ><a href="#method-i-write_nonblock">#write_nonblock</a> - </ul> </div> @@ -142,39 +114,28 @@ <p>This module allows an <a href="SSL/SSLSocket.html"><code>OpenSSL::SSL::SSLSocket</code></a> to behave like an <a href="../IO.html"><code>IO</code></a>.</p> -<p>You typically won't use this module directly, you can see it implemented in <a href="SSL/SSLSocket.html"><code>OpenSSL::SSL::SSLSocket</code></a>.</p> +<p>You typically won’t use this module directly, you can see it implemented in <a href="SSL/SSLSocket.html"><code>OpenSSL::SSL::SSLSocket</code></a>.</p> </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="BLOCK_SIZE">BLOCK_SIZE - <dd><p>Default size to read from or write to the SSLSocket for buffer operations.</p> - - </dl> </section> - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-sync" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">sync</span><span @@ -182,47 +143,33 @@ </div> <div class="method-description"> - <p>The “sync mode” of the SSLSocket.</p> <p>See IO#sync for full details.</p> - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-new" class="method-detail "> - <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(*)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - <p>Creates an instance of OpenSSL's buffering <a href="../IO.html"><code>IO</code></a> module.</p> - - + <p>Creates an instance of OpenSSL’s buffering <a href="../IO.html"><code>IO</code></a> module.</p> <div class="method-calls-super"> Calls superclass method </div> - - <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 63</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span>) @@ -232,41 +179,28 @@ <span class="ruby-ivar">@sync</span> = <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">sync</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3C-3C" class="method-detail "> - <div class="method-heading"> <span class="method-name"><<</span><span class="method-args">(s)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Writes <em>s</em> to the stream. <em>s</em> will be converted to a String using <code>.to_s</code> method.</p> - - - <div class="method-source-code" id="3C-3C-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 413</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span>(<span class="ruby-identifier">s</span>) @@ -274,33 +208,21 @@ <span class="ruby-keyword">self</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-close" class="method-detail "> - <div class="method-heading"> <span class="method-name">close</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Closes the SSLSocket and flushes any unwritten data.</p> - - - <div class="method-source-code" id="close-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 474</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span> @@ -308,35 +230,23 @@ <span class="ruby-identifier">sysclose</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-each" class="method-detail "> - <div class="method-heading"> <span class="method-name">each</span><span class="method-args">(eol=$/) { |line| ... }</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Executes the block for every line in the stream where lines are separated by <em>eol</em>.</p> <p>See also <a href="Buffering.html#method-i-gets"><code>gets</code></a></p> - - - <div class="method-source-code" id="each-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 250</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-identifier">eol</span>=<span class="ruby-identifier">$/</span>) @@ -345,37 +255,24 @@ <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="Buffering.html#method-i-each_line">each_line</a> </div> - - </div> - <div id="method-i-each_byte" class="method-detail "> - <div class="method-heading"> <span class="method-name">each_byte</span><span class="method-args">() { |byte| ... }</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Calls the given block once for each byte in the stream.</p> - - - <div class="method-source-code" id="each_byte-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 291</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each_byte</span> <span class="ruby-comment"># :yields: byte</span> @@ -384,89 +281,55 @@ <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-each_line" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">each_line</span><span class="method-args">(eol=$/)</span> - </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="Buffering.html#method-i-each">each</a> </div> - </div> - <div id="method-i-eof" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">eof</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="Buffering.html#method-i-eof-3F">eof?</a> </div> - </div> - <div id="method-i-eof-3F" class="method-detail "> - <div class="method-heading"> <span class="method-name">eof?</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Returns true if the stream is at file which means there is no more data to be read.</p> - - - <div class="method-source-code" id="eof-3F-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 322</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">eof?</span> @@ -474,37 +337,24 @@ <span class="ruby-ivar">@eof</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@rbuffer</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="Buffering.html#method-i-eof">eof</a> </div> - - </div> - <div id="method-i-flush" class="method-detail "> - <div class="method-heading"> <span class="method-name">flush</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Flushes buffered data to the SSLSocket.</p> - - - <div class="method-source-code" id="flush-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 462</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">flush</span> @@ -516,61 +366,40 @@ <span class="ruby-ivar">@sync</span> = <span class="ruby-identifier">osync</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-getc" class="method-detail "> - <div class="method-heading"> <span class="method-name">getc</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Reads one character from the stream. Returns nil if called at end of file.</p> - - - <div class="method-source-code" id="getc-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 284</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">getc</span> <span class="ruby-identifier">read</span>(<span class="ruby-value">1</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-gets" class="method-detail "> - <div class="method-heading"> <span class="method-name">gets</span><span class="method-args">(eol=$/, limit=nil)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Reads the next “line” from the stream. Lines are separated by <em>eol</em>. If <em>limit</em> is provided the result will not be longer than the given number of bytes.</p> <p><em>eol</em> may be a String or Regexp.</p> @@ -578,10 +407,7 @@ <p>Unlike IO#gets the line read will not be assigned to +$_+.</p> <p>Unlike IO#gets the separator must be provided if a limit is provided.</p> - - - <div class="method-source-code" id="gets-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 226</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gets</span>(<span class="ruby-identifier">eol</span>=<span class="ruby-identifier">$/</span>, <span class="ruby-identifier">limit</span>=<span class="ruby-keyword">nil</span>) @@ -602,35 +428,23 @@ <span class="ruby-identifier">consume_rbuff</span>(<span class="ruby-identifier">size</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-print" class="method-detail "> - <div class="method-heading"> <span class="method-name">print</span><span class="method-args">(*args)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Writes <em>args</em> to the stream.</p> <p>See IO#print for full details.</p> - - - <div class="method-source-code" id="print-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 441</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) @@ -640,35 +454,23 @@ <span class="ruby-keyword">nil</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-printf" class="method-detail "> - <div class="method-heading"> <span class="method-name">printf</span><span class="method-args">(s, *args)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Formats and writes to the stream converting parameters under control of the format string.</p> <p>See Kernel#sprintf for format string details.</p> - - - <div class="method-source-code" id="printf-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 454</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">printf</span>(<span class="ruby-identifier">s</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) @@ -676,35 +478,23 @@ <span class="ruby-keyword">nil</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-puts" class="method-detail "> - <div class="method-heading"> <span class="method-name">puts</span><span class="method-args">(*args)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Writes <em>args</em> to the stream along with a record separator.</p> <p>See IO#puts for full details.</p> - - - <div class="method-source-code" id="puts-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 423</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">puts</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) @@ -720,35 +510,23 @@ <span class="ruby-keyword">nil</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-read" class="method-detail "> - <div class="method-heading"> <span class="method-name">read</span><span class="method-args">(size=nil, buf=nil)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Reads <em>size</em> bytes from the stream. If <em>buf</em> is provided it must reference a string which will receive the data.</p> <p>See IO#read for full details.</p> - - - <div class="method-source-code" id="read-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 110</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read</span>(<span class="ruby-identifier">size</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">buf</span>=<span class="ruby-keyword">nil</span>) @@ -772,28 +550,19 @@ (<span class="ruby-identifier">size</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">ret</span>.<span class="ruby-identifier">empty?</span>) <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">ret</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-read_nonblock" class="method-detail "> - <div class="method-heading"> <span class="method-name">read_nonblock</span><span class="method-args">(maxlen, buf=nil, exception: true)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Reads at most <em>maxlen</em> bytes in the non-blocking manner.</p> <p>When no data can be read without blocking it raises <a href="SSL/SSLError.html"><code>OpenSSL::SSL::SSLError</code></a> extended by <a href="../IO/WaitReadable.html"><code>IO::WaitReadable</code></a> or <a href="../IO/WaitWritable.html"><code>IO::WaitWritable</code></a>.</p> @@ -819,10 +588,7 @@ <p>Note that one reason that <a href="Buffering.html#method-i-read_nonblock"><code>read_nonblock</code></a> writes to the underlying <a href="../IO.html"><code>IO</code></a> is when the peer requests a new TLS/SSL handshake. See openssl the FAQ for more details. <a href="http://www.openssl.org/support/faq.html">www.openssl.org/support/faq.html</a></p> <p>By specifying a keyword argument <em>exception</em> to <code>false</code>, you can indicate that <a href="Buffering.html#method-i-read_nonblock"><code>read_nonblock</code></a> should not raise an IO::Wait*able exception, but return the symbol <code>:wait_writable</code> or <code>:wait_readable</code> instead. At EOF, it will return <code>nil</code> instead of raising EOFError.</p> - - - <div class="method-source-code" id="read_nonblock-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 195</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read_nonblock</span>(<span class="ruby-identifier">maxlen</span>, <span class="ruby-identifier">buf</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-value">exception:</span> <span class="ruby-keyword">true</span>) @@ -845,33 +611,21 @@ <span class="ruby-identifier">ret</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-readchar" class="method-detail "> - <div class="method-heading"> <span class="method-name">readchar</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Reads a one-character string from the stream. Raises an EOFError at end of file.</p> - - - <div class="method-source-code" id="readchar-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 301</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">readchar</span> @@ -879,35 +633,23 @@ <span class="ruby-identifier">getc</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-readline" class="method-detail "> - <div class="method-heading"> <span class="method-name">readline</span><span class="method-args">(eol=$/)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Reads a line from the stream which is separated by <em>eol</em>.</p> <p>Raises EOFError if at end of file.</p> - - - <div class="method-source-code" id="readline-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 275</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">readline</span>(<span class="ruby-identifier">eol</span>=<span class="ruby-identifier">$/</span>) @@ -915,35 +657,23 @@ <span class="ruby-identifier">gets</span>(<span class="ruby-identifier">eol</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-readlines" class="method-detail "> - <div class="method-heading"> <span class="method-name">readlines</span><span class="method-args">(eol=$/)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Reads lines from the stream which are separated by <em>eol</em>.</p> <p>See also <a href="Buffering.html#method-i-gets"><code>gets</code></a></p> - - - <div class="method-source-code" id="readlines-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 262</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">readlines</span>(<span class="ruby-identifier">eol</span>=<span class="ruby-identifier">$/</span>) @@ -954,35 +684,23 @@ <span class="ruby-identifier">ary</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-readpartial" class="method-detail "> - <div class="method-heading"> <span class="method-name">readpartial</span><span class="method-args">(maxlen, buf=nil)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Reads at most <em>maxlen</em> bytes from the stream. If <em>buf</em> is provided it must reference a string which will receive the data.</p> <p>See IO#readpartial for full details.</p> - - - <div class="method-source-code" id="readpartial-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 137</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">readpartial</span>(<span class="ruby-identifier">maxlen</span>, <span class="ruby-identifier">buf</span>=<span class="ruby-keyword">nil</span>) @@ -1009,70 +727,46 @@ <span class="ruby-identifier">ret</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-ungetc" class="method-detail "> - <div class="method-heading"> <span class="method-name">ungetc</span><span class="method-args">(c)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Pushes character <em>c</em> back onto the stream such that a subsequent buffered character read will return it.</p> <p>Unlike IO#getc multiple bytes may be pushed back onto the stream.</p> <p>Has no effect on unbuffered reads (such as sysread).</p> - - - <div class="method-source-code" id="ungetc-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 314</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ungetc</span>(<span class="ruby-identifier">c</span>) <span class="ruby-ivar">@rbuffer</span>[<span class="ruby-value">0</span>,<span class="ruby-value">0</span>] = <span class="ruby-identifier">c</span>.<span class="ruby-identifier">chr</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-write" class="method-detail "> - <div class="method-heading"> <span class="method-name">write</span><span class="method-args">(*s)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Writes <em>s</em> to the stream. If the argument is not a String it will be converted using <code>.to_s</code> method. Returns the number of bytes written.</p> - - - <div class="method-source-code" id="write-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 360</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">s</span>) @@ -1082,28 +776,19 @@ <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-write_nonblock" class="method-detail "> - <div class="method-heading"> <span class="method-name">write_nonblock</span><span class="method-args">(s, exception: true)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Writes <em>s</em> in the non-blocking manner.</p> <p>If there is buffered data, it is flushed first. This may block.</p> @@ -1133,10 +818,7 @@ <p>Note that one reason that <a href="Buffering.html#method-i-write_nonblock"><code>write_nonblock</code></a> reads from the underlying <a href="../IO.html"><code>IO</code></a> is when the peer requests a new TLS/SSL handshake. See the openssl FAQ for more details. <a href="http://www.openssl.org/support/faq.html">www.openssl.org/support/faq.html</a></p> <p>By specifying a keyword argument <em>exception</em> to <code>false</code>, you can indicate that <a href="Buffering.html#method-i-write_nonblock"><code>write_nonblock</code></a> should not raise an IO::Wait*able exception, but return the symbol <code>:wait_writable</code> or <code>:wait_readable</code> instead.</p> - - - <div class="method-source-code" id="write_nonblock-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 404</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_nonblock</span>(<span class="ruby-identifier">s</span>, <span class="ruby-value">exception:</span> <span class="ruby-keyword">true</span>) @@ -1144,25 +826,20 @@ <span class="ruby-identifier">syswrite_nonblock</span>(<span class="ruby-identifier">s</span>, <span class="ruby-value">exception:</span> <span class="ruby-identifier">exception</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Buffering/Buffer.html b/OpenSSL/Buffering/Buffer.html index 5d9e647e..e10ceaec 100644 --- a/OpenSSL/Buffering/Buffer.html +++ b/OpenSSL/Buffering/Buffer.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,28 +57,24 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">String - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li class="calls-super" ><a href="#method-c-new">::new</a> - <li class="calls-super" ><a href="#method-i-3C-3C">#<<</a> - <li ><a href="#method-i-concat">#concat</a> - </ul> </div> @@ -98,60 +92,40 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="BINARY">BINARY - <dd> - - </dl> </section> - - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-new" class="method-detail "> - <div class="method-heading"> <span class="method-name">new</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - <div class="method-calls-super"> Calls superclass method </div> - - <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 29</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> @@ -160,46 +134,32 @@ <span class="ruby-identifier">force_encoding</span>(<span class="ruby-constant">BINARY</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3C-3C" class="method-detail "> - <div class="method-heading"> <span class="method-name"><<</span><span class="method-args">(string)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - <div class="method-calls-super"> Calls superclass method </div> - - <div class="method-source-code" id="3C-3C-source"> <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 35</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span> <span class="ruby-identifier">string</span> @@ -212,57 +172,40 @@ <span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="Buffer.html#method-i-concat">concat</a> </div> - - </div> - <div id="method-i-concat" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">concat</span><span class="method-args">(string)</span> - </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="Buffer.html#method-i-3C-3C"><<</a> </div> - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Cipher.html b/OpenSSL/Cipher.html index f4c78d61..4e5b36ef 100644 --- a/OpenSSL/Cipher.html +++ b/OpenSSL/Cipher.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -74,74 +72,47 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-ciphers">::ciphers</a> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-auth_data-3D">#auth_data=</a> - <li ><a href="#method-i-auth_tag">#auth_tag</a> - <li ><a href="#method-i-auth_tag-3D">#auth_tag=</a> - <li ><a href="#method-i-auth_tag_len-3D">#auth_tag_len=</a> - <li ><a href="#method-i-authenticated-3F">#authenticated?</a> - <li ><a href="#method-i-block_size">#block_size</a> - <li ><a href="#method-i-ccm_data_len-3D">#ccm_data_len=</a> - <li ><a href="#method-i-decrypt">#decrypt</a> - <li ><a href="#method-i-encrypt">#encrypt</a> - <li ><a href="#method-i-final">#final</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-iv-3D">#iv=</a> - <li ><a href="#method-i-iv_len">#iv_len</a> - <li ><a href="#method-i-iv_len-3D">#iv_len=</a> - <li ><a href="#method-i-key-3D">#key=</a> - <li ><a href="#method-i-key_len">#key_len</a> - <li ><a href="#method-i-key_len-3D">#key_len=</a> - <li ><a href="#method-i-name">#name</a> - <li ><a href="#method-i-padding-3D">#padding=</a> - <li ><a href="#method-i-pkcs5_keyivgen">#pkcs5_keyivgen</a> - <li ><a href="#method-i-random_iv">#random_iv</a> - <li ><a href="#method-i-random_key">#random_key</a> - <li ><a href="#method-i-reset">#reset</a> - <li ><a href="#method-i-update">#update</a> - </ul> </div> @@ -211,9 +182,9 @@ <p>Because of this, you will end up with a mode that explicitly requires an IV in any case. Although the IV can be seen as public information, i.e. it may be transmitted in public once generated, it should still stay unpredictable to prevent certain kinds of attacks. Therefore, ideally</p> -<p><strong>Always create a secure random IV for every encryption of your <a href="Cipher/Cipher.html"><code>Cipher</code></a></strong></p> +<p><strong>Always create a secure random IV for every encryption of your Cipher</strong></p> -<p>A new, random IV should be created for every encryption of data. Think of the IV as a nonce (number used once) - it's public but random and unpredictable. A secure random IV can be created as follows</p> +<p>A new, random IV should be created for every encryption of data. Think of the IV as a nonce (number used once) - it’s public but random and unpredictable. A secure random IV can be created as follows</p> <pre class="ruby"><span class="ruby-identifier">cipher</span> = <span class="ruby-operator">...</span> <span class="ruby-identifier">cipher</span>.<span class="ruby-identifier">encrypt</span> @@ -285,44 +256,28 @@ </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-ciphers" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Cipher.ciphers → array[string...] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the names of all available ciphers in an array.</p> - - - <div class="method-source-code" id="ciphers-source"> <pre>static VALUE ossl_s_ciphers(VALUE self) @@ -337,38 +292,24 @@ ossl_s_ciphers(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new(string) → cipher </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>The string must contain a valid cipher name like “AES-256-CBC”.</p> <p>A list of cipher names is available by calling <a href="Cipher.html#method-c-ciphers"><code>OpenSSL::Cipher.ciphers</code></a>.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_cipher_initialize(VALUE self, VALUE str) @@ -392,46 +333,31 @@ ossl_cipher_initialize(VALUE self, VALUE str) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-auth_data-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> auth_data = string → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Sets the cipher's additional authenticated data. This field must be set when using AEAD cipher modes such as GCM or CCM. If no associated data shall be used, this method must <strong>still</strong> be called with a value of “”. The contents of this field should be non-sensitive data which will be added to the ciphertext to generate the authentication tag which validates the contents of the ciphertext.</p> + <p>Sets the cipher’s additional authenticated data. This field must be set when using AEAD cipher modes such as GCM or CCM. If no associated data shall be used, this method must <strong>still</strong> be called with a value of “”. The contents of this field should be non-sensitive data which will be added to the ciphertext to generate the authentication tag which validates the contents of the ciphertext.</p> <p>The AAD must be set prior to encryption or decryption. In encryption mode, it must be set after calling <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> and setting <a href="Cipher.html#method-i-key-3D"><code>Cipher#key=</code></a> and <a href="Cipher.html#method-i-iv-3D"><code>Cipher#iv=</code></a>. When decrypting, the authenticated data must be set after key, iv and especially <strong>after</strong> the authentication tag has been set. I.e. set it only after calling <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a>, <a href="Cipher.html#method-i-key-3D"><code>Cipher#key=</code></a>, <a href="Cipher.html#method-i-iv-3D"><code>Cipher#iv=</code></a> and <a href="Cipher.html#method-i-auth_tag-3D"><code>Cipher#auth_tag=</code></a> first.</p> - - - <div class="method-source-code" id="auth_data-3D-source"> <pre>static VALUE ossl_cipher_set_auth_data(VALUE self, VALUE data) @@ -455,38 +381,24 @@ ossl_cipher_set_auth_data(VALUE self, VALUE data) return data; }</pre> </div> - </div> - - </div> - <div id="method-i-auth_tag" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> auth_tag(tag_len = 16) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Gets the authentication tag generated by Authenticated Encryption <a href="Cipher/Cipher.html"><code>Cipher</code></a> modes (GCM for example). This tag may be stored along with the ciphertext, then set on the decryption cipher to authenticate the contents of the ciphertext against changes. If the optional integer parameter <em>tag_len</em> is given, the returned tag will be <em>tag_len</em> bytes long. If the parameter is omitted, the default length of 16 bytes or the length previously set by <a href="Cipher.html#method-i-auth_tag_len-3D"><code>auth_tag_len=</code></a> will be used. For maximum security, the longest possible should be chosen.</p> <p>The tag may only be retrieved after calling <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a>.</p> - - - <div class="method-source-code" id="auth_tag-source"> <pre>static VALUE ossl_cipher_get_auth_tag(int argc, VALUE *argv, VALUE self) @@ -513,38 +425,24 @@ ossl_cipher_get_auth_tag(int argc, VALUE *argv, VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-auth_tag-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> auth_tag = string → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the authentication tag to verify the integrity of the ciphertext. This can be called only when the cipher supports AE. The tag must be set after calling <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a>, <a href="Cipher.html#method-i-key-3D"><code>Cipher#key=</code></a> and <a href="Cipher.html#method-i-iv-3D"><code>Cipher#iv=</code></a>, but before calling <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a>. After all decryption is performed, the tag is verified automatically in the call to <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a>.</p> <p>For OCB mode, the tag length must be supplied with <a href="Cipher.html#method-i-auth_tag_len-3D"><code>auth_tag_len=</code></a> beforehand.</p> - - - <div class="method-source-code" id="auth_tag-3D-source"> <pre>static VALUE ossl_cipher_set_auth_tag(VALUE self, VALUE vtag) @@ -567,38 +465,24 @@ ossl_cipher_set_auth_tag(VALUE self, VALUE vtag) return vtag; }</pre> </div> - </div> - - </div> - <div id="method-i-auth_tag_len-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> auth_tag_len = Integer → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the length of the authentication tag to be generated or to be given for AEAD ciphers that requires it as in input parameter. Note that not all AEAD ciphers support this method.</p> <p>In OCB mode, the length must be supplied both when encrypting and when decrypting, and must be before specifying an IV.</p> - - - <div class="method-source-code" id="auth_tag_len-3D-source"> <pre>static VALUE ossl_cipher_set_auth_tag_len(VALUE self, VALUE vlen) @@ -619,36 +503,22 @@ ossl_cipher_set_auth_tag_len(VALUE self, VALUE vlen) return vlen; }</pre> </div> - </div> - - </div> - <div id="method-i-authenticated-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> authenticated? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Indicated whether this <a href="Cipher/Cipher.html"><code>Cipher</code></a> instance uses an Authenticated Encryption mode.</p> - - - <div class="method-source-code" id="authenticated-3F-source"> <pre>static VALUE ossl_cipher_is_authenticated(VALUE self) @@ -660,36 +530,22 @@ ossl_cipher_is_authenticated(VALUE self) return (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-block_size" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> block_size → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the size in bytes of the blocks on which this <a href="Cipher/Cipher.html"><code>Cipher</code></a> operates on.</p> - - - <div class="method-source-code" id="block_size-source"> <pre>static VALUE ossl_cipher_block_size(VALUE self) @@ -701,38 +557,24 @@ ossl_cipher_block_size(VALUE self) return INT2NUM(EVP_CIPHER_CTX_block_size(ctx)); }</pre> </div> - </div> - - </div> - <div id="method-i-ccm_data_len-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> ccm_data_len = integer → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the length of the plaintext / ciphertext message that will be processed in CCM mode. Make sure to call this method after <a href="Cipher.html#method-i-key-3D"><code>key=</code></a> and <a href="Cipher.html#method-i-iv-3D"><code>iv=</code></a> have been set, and before <a href="Cipher.html#method-i-auth_data-3D"><code>auth_data=</code></a>.</p> <p>Only call this method after calling <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a>.</p> - - - <div class="method-source-code" id="ccm_data_len-3D-source"> <pre>static VALUE ossl_cipher_set_ccm_data_len(VALUE self, VALUE data_len) @@ -749,31 +591,20 @@ ossl_cipher_set_ccm_data_len(VALUE self, VALUE data_len) return data_len; }</pre> </div> - </div> - - </div> - <div id="method-i-decrypt" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> decrypt → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Initializes the <a href="Cipher/Cipher.html"><code>Cipher</code></a> for decryption.</p> <p>Make sure to call <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a> before using any of the following methods:</p> @@ -782,10 +613,7 @@ ossl_cipher_set_ccm_data_len(VALUE self, VALUE data_len) </li></ul> <p>Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, 0).</p> - - - <div class="method-source-code" id="decrypt-source"> <pre>static VALUE ossl_cipher_decrypt(int argc, VALUE *argv, VALUE self) @@ -793,31 +621,20 @@ ossl_cipher_decrypt(int argc, VALUE *argv, VALUE self) return ossl_cipher_init(argc, argv, self, 0); }</pre> </div> - </div> - - </div> - <div id="method-i-encrypt" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> encrypt → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Initializes the <a href="Cipher/Cipher.html"><code>Cipher</code></a> for encryption.</p> <p>Make sure to call <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a> before using any of the following methods:</p> @@ -826,10 +643,7 @@ ossl_cipher_decrypt(int argc, VALUE *argv, VALUE self) </li></ul> <p>Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, 1).</p> - - - <div class="method-source-code" id="encrypt-source"> <pre>static VALUE ossl_cipher_encrypt(int argc, VALUE *argv, VALUE self) @@ -837,38 +651,24 @@ ossl_cipher_encrypt(int argc, VALUE *argv, VALUE self) return ossl_cipher_init(argc, argv, self, 1); }</pre> </div> - </div> - - </div> - <div id="method-i-final" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> final → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the remaining data held in the cipher object. Further calls to <a href="Cipher.html#method-i-update"><code>Cipher#update</code></a> or <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a> will return garbage. This call should always be made as the last call of an encryption or decryption operation, after having fed the entire plaintext or ciphertext to the <a href="Cipher/Cipher.html"><code>Cipher</code></a> instance.</p> <p>If an authenticated cipher was used, a <a href="Cipher/CipherError.html"><code>CipherError</code></a> is raised if the tag could not be authenticated successfully. Only call this method after setting the authentication tag and passing the entire contents of the ciphertext into the cipher.</p> - - - <div class="method-source-code" id="final-source"> <pre>static VALUE ossl_cipher_final(VALUE self) @@ -887,33 +687,21 @@ ossl_cipher_final(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_cipher_copy(VALUE self, VALUE other) @@ -934,38 +722,24 @@ ossl_cipher_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-iv-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> iv = string → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the cipher IV. Please note that since you should never be using ECB mode, an IV is always explicitly required and should be set prior to encryption. The IV itself can be safely transmitted in public, but it should be unpredictable to prevent certain kinds of attacks. You may use <a href="Cipher.html#method-i-random_iv"><code>Cipher#random_iv</code></a> to create a secure random IV.</p> <p>Only call this method after calling <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a>.</p> - - - <div class="method-source-code" id="iv-3D-source"> <pre>static VALUE ossl_cipher_set_iv(VALUE self, VALUE iv) @@ -989,36 +763,22 @@ ossl_cipher_set_iv(VALUE self, VALUE iv) return iv; }</pre> </div> - </div> - - </div> - <div id="method-i-iv_len" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> iv_len → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the expected length in bytes for an IV for this <a href="Cipher/Cipher.html"><code>Cipher</code></a>.</p> - - - <div class="method-source-code" id="iv_len-source"> <pre>static VALUE ossl_cipher_iv_length(VALUE self) @@ -1035,36 +795,22 @@ ossl_cipher_iv_length(VALUE self) return INT2NUM(len); }</pre> </div> - </div> - - </div> - <div id="method-i-iv_len-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> iv_len = integer → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Sets the IV/nonce length of the <a href="Cipher/Cipher.html"><code>Cipher</code></a>. Normally block ciphers don't allow changing the IV length, but some make use of IV for 'nonce'. You may need this for interoperability with other applications.</p> - - + <p>Sets the IV/nonce length of the <a href="Cipher/Cipher.html"><code>Cipher</code></a>. Normally block ciphers don’t allow changing the IV length, but some make use of IV for ‘nonce’. You may need this for interoperability with other applications.</p> - <div class="method-source-code" id="iv_len-3D-source"> <pre>static VALUE ossl_cipher_set_iv_length(VALUE self, VALUE iv_length) @@ -1088,38 +834,24 @@ ossl_cipher_set_iv_length(VALUE self, VALUE iv_length) return iv_length; }</pre> </div> - </div> - - </div> - <div id="method-i-key-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> key = string → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the cipher key. To generate a key, you should either use a secure random byte string or, if the key is to be derived from a password, you should rely on PBKDF2 functionality provided by <a href="PKCS5.html"><code>OpenSSL::PKCS5</code></a>. To generate a secure random-based key, <a href="Cipher.html#method-i-random_key"><code>Cipher#random_key</code></a> may be used.</p> <p>Only call this method after calling <a href="Cipher.html#method-i-encrypt"><code>Cipher#encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>Cipher#decrypt</code></a>.</p> - - - <div class="method-source-code" id="key-3D-source"> <pre>static VALUE ossl_cipher_set_key(VALUE self, VALUE key) @@ -1142,36 +874,22 @@ ossl_cipher_set_key(VALUE self, VALUE key) return key; }</pre> </div> - </div> - - </div> - <div id="method-i-key_len" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> key_len → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the key length in bytes of the <a href="Cipher/Cipher.html"><code>Cipher</code></a>.</p> - - - <div class="method-source-code" id="key_len-source"> <pre>static VALUE ossl_cipher_key_length(VALUE self) @@ -1183,40 +901,26 @@ ossl_cipher_key_length(VALUE self) return INT2NUM(EVP_CIPHER_CTX_key_length(ctx)); }</pre> </div> - </div> - - </div> - <div id="method-i-key_len-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> key_len = integer → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the key length of the cipher. If the cipher is a fixed length cipher then attempting to set the key length to any value other than the fixed value is an error.</p> -<p>Under normal circumstances you do not need to call this method (and probably shouldn't).</p> +<p>Under normal circumstances you do not need to call this method (and probably shouldn’t).</p> <p>See EVP_CIPHER_CTX_set_key_length for further information.</p> - - - <div class="method-source-code" id="key_len-3D-source"> <pre>static VALUE ossl_cipher_set_key_length(VALUE self, VALUE key_length) @@ -1231,36 +935,22 @@ ossl_cipher_set_key_length(VALUE self, VALUE key_length) return key_length; }</pre> </div> - </div> - - </div> - <div id="method-i-name" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> name → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the name of the cipher which may differ slightly from the original name provided.</p> - - - <div class="method-source-code" id="name-source"> <pre>static VALUE ossl_cipher_name(VALUE self) @@ -1272,38 +962,24 @@ ossl_cipher_name(VALUE self) return rb_str_new2(EVP_CIPHER_name(EVP_CIPHER_CTX_cipher(ctx))); }</pre> </div> - </div> - - </div> - <div id="method-i-padding-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> padding = integer → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Enables or disables padding. By default encryption operations are padded using standard block padding and the padding is checked and removed when decrypting. If the pad parameter is zero then no padding is performed, the total amount of data encrypted or decrypted must then be a multiple of the block size or an error will occur.</p> <p>See EVP_CIPHER_CTX_set_padding for further information.</p> - - - <div class="method-source-code" id="padding-3D-source"> <pre>static VALUE ossl_cipher_set_padding(VALUE self, VALUE padding) @@ -1317,31 +993,20 @@ ossl_cipher_set_padding(VALUE self, VALUE padding) return padding; }</pre> </div> - </div> - - </div> - <div id="method-i-pkcs5_keyivgen" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> pkcs5_keyivgen(pass, salt = nil, iterations = 2048, digest = "MD5") → nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Generates and sets the key/IV based on a password.</p> <p><strong>WARNING</strong>: This method is only <a href="PKCS5.html"><code>PKCS5</code></a> v1.5 compliant when using RC2, RC4-40, or DES with MD5 or SHA1. Using anything else (like AES) will generate the key/iv using an <a href="../OpenSSL.html"><code>OpenSSL</code></a> specific method. This method is deprecated and should no longer be used. Use a <a href="PKCS5.html"><code>PKCS5</code></a> v2 key generation method from <a href="PKCS5.html"><code>OpenSSL::PKCS5</code></a> instead.</p> @@ -1352,14 +1017,11 @@ ossl_cipher_set_padding(VALUE self, VALUE padding) </li><li> <p><em>iterations</em> is an integer with a default of 2048.</p> </li><li> -<p><em>digest</em> is a <a href="Digest.html"><code>Digest</code></a> object that defaults to 'MD5'</p> +<p><em>digest</em> is a <a href="Digest.html"><code>Digest</code></a> object that defaults to ‘MD5’</p> </li></ul> <p>A minimum of 1000 iterations is recommended.</p> - - - <div class="method-source-code" id="pkcs5_keyivgen-source"> <pre>static VALUE ossl_cipher_pkcs5_keyivgen(int argc, VALUE *argv, VALUE self) @@ -1395,38 +1057,24 @@ ossl_cipher_pkcs5_keyivgen(int argc, VALUE *argv, VALUE self) return Qnil; }</pre> </div> - </div> - - </div> - <div id="method-i-random_iv" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> random_iv → iv </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Generate a random IV with <a href="Random.html#method-c-random_bytes"><code>OpenSSL::Random.random_bytes</code></a> and sets it to the cipher, and returns it.</p> <p>You must call <a href="Cipher.html#method-i-encrypt"><code>encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>decrypt</code></a> before calling this method.</p> - - - <div class="method-source-code" id="random_iv-source"> <pre><span class="ruby-comment"># File lib/openssl/cipher.rb, line 55</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">random_iv</span> @@ -1434,38 +1082,24 @@ ossl_cipher_pkcs5_keyivgen(int argc, VALUE *argv, VALUE self) <span class="ruby-keyword">self</span>.<span class="ruby-identifier">iv</span> = <span class="ruby-identifier">str</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-random_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> random_key → key </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Generate a random key with <a href="Random.html#method-c-random_bytes"><code>OpenSSL::Random.random_bytes</code></a> and sets it to the cipher, and returns it.</p> <p>You must call <a href="Cipher.html#method-i-encrypt"><code>encrypt</code></a> or <a href="Cipher.html#method-i-decrypt"><code>decrypt</code></a> before calling this method.</p> - - - <div class="method-source-code" id="random_key-source"> <pre><span class="ruby-comment"># File lib/openssl/cipher.rb, line 43</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">random_key</span> @@ -1473,38 +1107,24 @@ ossl_cipher_pkcs5_keyivgen(int argc, VALUE *argv, VALUE self) <span class="ruby-keyword">self</span>.<span class="ruby-identifier">key</span> = <span class="ruby-identifier">str</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-reset" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> reset → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Fully resets the internal state of the <a href="Cipher/Cipher.html"><code>Cipher</code></a>. By using this, the same <a href="Cipher/Cipher.html"><code>Cipher</code></a> instance may be used several times for encryption or decryption tasks.</p> <p>Internally calls EVP_CipherInit_ex(ctx, NULL, NULL, NULL, NULL, -1).</p> - - - <div class="method-source-code" id="reset-source"> <pre>static VALUE ossl_cipher_reset(VALUE self) @@ -1518,38 +1138,24 @@ ossl_cipher_reset(VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-update" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> update(data [, buffer]) → string or buffer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Encrypts data in a streaming fashion. Hand consecutive blocks of data to the <a href="Cipher.html#method-i-update"><code>update</code></a> method in order to encrypt it. Returns the encrypted data chunk. When done, the output of <a href="Cipher.html#method-i-final"><code>Cipher#final</code></a> should be additionally added to the result.</p> <p>If <em>buffer</em> is given, the encryption/decryption result will be written to it. <em>buffer</em> will be resized automatically.</p> - - - <div class="method-source-code" id="update-source"> <pre>static VALUE ossl_cipher_update(int argc, VALUE *argv, VALUE self) @@ -1590,25 +1196,20 @@ ossl_cipher_update(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Cipher/Cipher.html b/OpenSSL/Cipher/Cipher.html index 13a4e912..432bdc35 100644 --- a/OpenSSL/Cipher/Cipher.html +++ b/OpenSSL/Cipher/Cipher.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../Cipher.html">OpenSSL::Cipher</a> - </div> @@ -86,25 +83,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/Cipher/CipherError.html b/OpenSSL/Cipher/CipherError.html index 0ee2a147..a28d4ad1 100644 --- a/OpenSSL/Cipher/CipherError.html +++ b/OpenSSL/Cipher/CipherError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/Config.html b/OpenSSL/Config.html index 60229882..482dc11f 100644 --- a/OpenSSL/Config.html +++ b/OpenSSL/Config.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,55 +57,40 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><span class="include">Enumerable</span> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-c-parse">::parse</a> - <li ><a href="#method-c-parse_config">::parse_config</a> - <li ><a href="#method-i-5B-5D">#[]</a> - <li ><a href="#method-i-5B-5D-3D">#[]=</a> - <li ><a href="#method-i-add_value">#add_value</a> - <li ><a href="#method-i-each">#each</a> - <li ><a href="#method-i-get_value">#get_value</a> - <li ><a href="#method-i-inspect">#inspect</a> - <li ><a href="#method-i-sections">#sections</a> - <li ><a href="#method-i-to_s">#to_s</a> - </ul> </div> @@ -125,82 +108,54 @@ <p>Configuration for the openssl library.</p> -<p>Many system's installation of openssl library will depend on your system configuration. See the value of <a href="Config.html#DEFAULT_CONFIG_FILE"><code>OpenSSL::Config::DEFAULT_CONFIG_FILE</code></a> for the location of the file for your host.</p> +<p>Many system’s installation of openssl library will depend on your system configuration. See the value of <a href="Config.html#DEFAULT_CONFIG_FILE"><code>OpenSSL::Config::DEFAULT_CONFIG_FILE</code></a> for the location of the file for your host.</p> <p>See also <a href="http://www.openssl.org/docs/apps/config.html">www.openssl.org/docs/apps/config.html</a></p> </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="DEFAULT_CONFIG_FILE">DEFAULT_CONFIG_FILE - <dd><p>The default system configuration file for openssl</p> - - <dt id="ESCAPE_MAP">ESCAPE_MAP - <dd><p>escaped char map</p> - - <dt id="QUOTE_REGEXP_DQ">QUOTE_REGEXP_DQ - <dd><p>escape with backslash and doubled dq</p> - - <dt id="QUOTE_REGEXP_SQ">QUOTE_REGEXP_SQ - <dd><p>escape with backslash</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-new" class="method-detail "> - <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(filename = nil)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - <p>Creates an instance of OpenSSL's configuration class.</p> + <p>Creates an instance of OpenSSL’s configuration class.</p> <p>This can be used in contexts like <a href="X509/ExtensionFactory.html#attribute-i-config"><code>OpenSSL::X509::ExtensionFactory.config=</code></a></p> <p>If the optional <em>filename</em> parameter is provided, then it is read in and parsed via parse_config.</p> <p>This can raise <a href="../IO.html"><code>IO</code></a> exceptions based on the access, or availability of the file. A <a href="ConfigError.html"><code>ConfigError</code></a> exception may be raised depending on the validity of the data being configured.</p> - - - <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/openssl/config.rb, line 264</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">filename</span> = <span class="ruby-keyword">nil</span>) @@ -214,35 +169,23 @@ <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-c-parse" class="method-detail "> - <div class="method-heading"> <span class="method-name">parse</span><span class="method-args">(string)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Parses a given <em>string</em> as a blob that contains configuration for <a href="../OpenSSL.html"><code>OpenSSL</code></a>.</p> <p>If the source of the <a href="../IO.html"><code>IO</code></a> is a file, then consider using parse_config.</p> - - - <div class="method-source-code" id="parse-source"> <pre><span class="ruby-comment"># File lib/openssl/config.rb, line 37</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse</span>(<span class="ruby-identifier">string</span>) @@ -253,35 +196,23 @@ <span class="ruby-identifier">c</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-c-parse_config" class="method-detail "> - <div class="method-heading"> <span class="method-name">parse_config</span><span class="method-args">(io)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Parses the configuration data read from <em>io</em>, see also parse.</p> <p>Raises a <a href="ConfigError.html"><code>ConfigError</code></a> on invalid configuration data.</p> - - - <div class="method-source-code" id="parse_config-source"> <pre><span class="ruby-comment"># File lib/openssl/config.rb, line 53</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_config</span>(<span class="ruby-identifier">io</span>) @@ -292,36 +223,26 @@ <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-5B-5D" class="method-detail "> - <div class="method-heading"> <span class="method-name">[]</span><span class="method-args">(section)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Get a specific <em>section</em> from the current configuration</p> <p>Given the following configurating file being loaded:</p> @@ -338,38 +259,26 @@ <pre class="ruby"><span class="ruby-identifier">config</span>[<span class="ruby-string">'default'</span>] <span class="ruby-comment">#=> {"foo"=>"bar"}</span> </pre> - - - <div class="method-source-code" id="5B-5D-source"> <pre><span class="ruby-comment"># File lib/openssl/config.rb, line 360</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">section</span>) <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">section</span>] <span class="ruby-operator">||</span> {} <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-5B-5D-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">[]=</span><span class="method-args">(section, pairs)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>*Deprecated in v2.2.0*. This method will be removed in a future release.</p> <p>Sets a specific <em>section</em> name with a Hash <em>pairs</em>.</p> @@ -386,7 +295,7 @@ <span class="ruby-comment"># baz=buz</span> </pre> -<p>It's important to note that this will essentially merge any of the keys in <em>pairs</em> with the existing <em>section</em>. For example:</p> +<p>It’s important to note that this will essentially merge any of the keys in <em>pairs</em> with the existing <em>section</em>. For example:</p> <pre class="ruby"><span class="ruby-identifier">config</span>[<span class="ruby-string">'default'</span>] <span class="ruby-comment">#=> {"foo"=>"bar", "baz"=>"buz"}</span> @@ -395,10 +304,7 @@ <span class="ruby-identifier">config</span>[<span class="ruby-string">'default'</span>] <span class="ruby-comment">#=> {"foo"=>"changed", "baz"=>"buz"}</span> </pre> - - - <div class="method-source-code" id="5B-5D-3D-source"> <pre><span class="ruby-comment"># File lib/openssl/config.rb, line 399</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]=</span>(<span class="ruby-identifier">section</span>, <span class="ruby-identifier">pairs</span>) @@ -406,28 +312,19 @@ <span class="ruby-identifier">set_section</span>(<span class="ruby-identifier">section</span>, <span class="ruby-identifier">pairs</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-add_value" class="method-detail "> - <div class="method-heading"> <span class="method-name">add_value</span><span class="method-args">(section, key, value)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>*Deprecated in v2.2.0*. This method will be removed in a future release.</p> <p>Set the target <em>key</em> with a given <em>value</em> under a specific <em>section</em>.</p> @@ -449,10 +346,7 @@ <span class="ruby-comment">#=> [ default ]</span> <span class="ruby-comment"># foo=buzz</span> </pre> - - - <div class="method-source-code" id="add_value-source"> <pre><span class="ruby-comment"># File lib/openssl/config.rb, line 339</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_value</span>(<span class="ruby-identifier">section</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>) @@ -460,28 +354,19 @@ (<span class="ruby-ivar">@data</span>[<span class="ruby-identifier">section</span>] <span class="ruby-operator">||=</span> {})[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-each" class="method-detail "> - <div class="method-heading"> <span class="method-name">each</span><span class="method-args">() { |section, key, value| ... }</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>For a block.</p> <p>Receive the section and its pairs for the current configuration.</p> @@ -490,10 +375,7 @@ <span class="ruby-comment"># ...</span> <span class="ruby-keyword">end</span> </pre> - - - <div class="method-source-code" id="each-source"> <pre><span class="ruby-comment"># File lib/openssl/config.rb, line 464</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span> @@ -504,28 +386,19 @@ <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-get_value" class="method-detail "> - <div class="method-heading"> <span class="method-name">get_value</span><span class="method-args">(section, key)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Gets the value of <em>key</em> from the given <em>section</em></p> <p>Given the following configurating file being loaded:</p> @@ -542,10 +415,7 @@ <pre class="ruby"><span class="ruby-identifier">config</span>.<span class="ruby-identifier">get_value</span>(<span class="ruby-string">'default'</span>,<span class="ruby-string">'foo'</span>) <span class="ruby-comment">#=> "bar"</span> </pre> - - - <div class="method-source-code" id="get_value-source"> <pre><span class="ruby-comment"># File lib/openssl/config.rb, line 292</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_value</span>(<span class="ruby-identifier">section</span>, <span class="ruby-identifier">key</span>) @@ -556,94 +426,61 @@ <span class="ruby-identifier">get_key_string</span>(<span class="ruby-identifier">section</span>, <span class="ruby-identifier">key</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-inspect" class="method-detail "> - <div class="method-heading"> <span class="method-name">inspect</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>String representation of this configuration object, including the class name and its sections.</p> - - - <div class="method-source-code" id="inspect-source"> <pre><span class="ruby-comment"># File lib/openssl/config.rb, line 475</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span> <span class="ruby-node">"#<#{self.class.name} sections=#{sections.inspect}>"</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-sections" class="method-detail "> - <div class="method-heading"> <span class="method-name">sections</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Get the names of all sections in the current configuration</p> - - - <div class="method-source-code" id="sections-source"> <pre><span class="ruby-comment"># File lib/openssl/config.rb, line 413</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sections</span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">keys</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-to_s" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_s</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Get the parsable form of the current configuration</p> <p>Given the following configuration being created:</p> @@ -669,10 +506,7 @@ <span class="ruby-identifier">foo</span>=<span class="ruby-identifier">bar</span> <span class="ruby-identifier">baz</span>=<span class="ruby-identifier">buz</span> </pre> - - - <div class="method-source-code" id="to_s-source"> <pre><span class="ruby-comment"># File lib/openssl/config.rb, line 443</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span> @@ -687,25 +521,20 @@ <span class="ruby-identifier">ary</span>.<span class="ruby-identifier">join</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/ConfigError.html b/OpenSSL/ConfigError.html index 65f8a2e0..0c63451a 100644 --- a/OpenSSL/ConfigError.html +++ b/OpenSSL/ConfigError.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/Digest.html b/OpenSSL/Digest.html index fa24f394..27256700 100644 --- a/OpenSSL/Digest.html +++ b/OpenSSL/Digest.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -69,40 +67,30 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Digest::Class - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li class="calls-super" ><a href="#method-c-digest">::digest</a> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3C-3C">#<<</a> - <li ><a href="#method-i-block_length">#block_length</a> - <li ><a href="#method-i-digest_length">#digest_length</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-name">#name</a> - <li ><a href="#method-i-reset">#reset</a> - <li ><a href="#method-i-update">#update</a> - </ul> </div> @@ -177,36 +165,25 @@ </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-digest" class="method-detail "> - <div class="method-heading"> <span class="method-name">digest</span><span class="method-args">(name, data)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Return the hash value computed with <em>name</em> <a href="Digest.html"><code>Digest</code></a>. <em>name</em> is either the long name or short name of a supported digest algorithm.</p> <h3 id="method-c-digest-label-Examples">Examples<span><a href="#method-c-digest-label-Examples">¶</a> <a href="#top">↑</a></span></h3> @@ -218,46 +195,31 @@ <pre class="ruby"><span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span>.<span class="ruby-identifier">digest</span>(<span class="ruby-string">'SHA256'</span>, <span class="ruby-string">"abc"</span>) </pre> - - <div class="method-calls-super"> Calls superclass method </div> - - <div class="method-source-code" id="digest-source"> <pre><span class="ruby-comment"># File lib/openssl/digest.rb, line 29</span> <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">digest</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">data</span>) <span class="ruby-keyword">super</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">name</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new(string [, data]) → Digest </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Creates a <a href="Digest.html"><code>Digest</code></a> instance based on <em>string</em>, which is either the ln (long name) or sn (short name) of a supported digest algorithm.</p> <p>If <em>data</em> (a String) is given, it is used as the initial input to the <a href="Digest.html"><code>Digest</code></a> instance, i.e.</p> @@ -270,10 +232,7 @@ <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-identifier">new</span>(<span class="ruby-string">'sha256'</span>) <span class="ruby-identifier">digest</span>.<span class="ruby-identifier">update</span>(<span class="ruby-string">'digestdata'</span>) </pre> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_digest_initialize(int argc, VALUE *argv, VALUE self) @@ -300,67 +259,52 @@ ossl_digest_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3C-3C" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name"><<</span><span class="method-args">(p1)</span> - </div> - <div class="method-description"> - - - - + <p>Not every message digest can be computed in one single pass. If a message digest is to be computed from several subsequent sources, then each may be passed individually to the <a href="Digest.html"><code>Digest</code></a> instance.</p> + +<h3 id="method-i-3C-3C-label-Example">Example<span><a href="#method-i-3C-3C-label-Example">¶</a> <a href="#top">↑</a></span></h3> + +<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-identifier">new</span>(<span class="ruby-string">'SHA256'</span>) +<span class="ruby-identifier">digest</span>.<span class="ruby-identifier">update</span>(<span class="ruby-string">'First input'</span>) +<span class="ruby-identifier">digest</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'Second input'</span> <span class="ruby-comment"># equivalent to digest.update('Second input')</span> +<span class="ruby-identifier">result</span> = <span class="ruby-identifier">digest</span>.<span class="ruby-identifier">digest</span> +</pre> - </div> - - <div class="aliases"> Alias for: <a href="Digest.html#method-i-update">update</a> </div> - </div> - <div id="method-i-block_length" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> block_length → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the block length of the digest algorithm, i.e. the length in bytes of an individual block. Most modern algorithms partition a message to be digested into a sequence of fix-sized blocks that are processed consecutively.</p> <h3 id="method-i-block_length-label-Example">Example<span><a href="#method-i-block_length-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -368,10 +312,7 @@ ossl_digest_initialize(int argc, VALUE *argv, VALUE self) <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-identifier">new</span>(<span class="ruby-string">'SHA1'</span>) <span class="ruby-identifier">puts</span> <span class="ruby-identifier">digest</span>.<span class="ruby-identifier">block_length</span> <span class="ruby-comment"># => 64</span> </pre> - - - <div class="method-source-code" id="block_length-source"> <pre>static VALUE ossl_digest_block_length(VALUE self) @@ -383,31 +324,20 @@ ossl_digest_block_length(VALUE self) return INT2NUM(EVP_MD_CTX_block_size(ctx)); }</pre> </div> - </div> - - </div> - <div id="method-i-digest_length" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> digest_length → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the output size of the digest, i.e. the length in bytes of the final message digest result.</p> <h3 id="method-i-digest_length-label-Example">Example<span><a href="#method-i-digest_length-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -415,10 +345,7 @@ ossl_digest_block_length(VALUE self) <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-identifier">new</span>(<span class="ruby-string">'SHA1'</span>) <span class="ruby-identifier">puts</span> <span class="ruby-identifier">digest</span>.<span class="ruby-identifier">digest_length</span> <span class="ruby-comment"># => 20</span> </pre> - - - <div class="method-source-code" id="digest_length-source"> <pre>static VALUE ossl_digest_size(VALUE self) @@ -430,33 +357,21 @@ ossl_digest_size(VALUE self) return INT2NUM(EVP_MD_CTX_size(ctx)); }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_digest_copy(VALUE self, VALUE other) @@ -480,31 +395,20 @@ ossl_digest_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-name" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> name → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the sn of this <a href="Digest.html"><code>Digest</code></a> algorithm.</p> <h3 id="method-i-name-label-Example">Example<span><a href="#method-i-name-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -512,10 +416,7 @@ ossl_digest_copy(VALUE self, VALUE other) <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-identifier">new</span>(<span class="ruby-string">'SHA512'</span>) <span class="ruby-identifier">puts</span> <span class="ruby-identifier">digest</span>.<span class="ruby-identifier">name</span> <span class="ruby-comment"># => SHA512</span> </pre> - - - <div class="method-source-code" id="name-source"> <pre>static VALUE ossl_digest_name(VALUE self) @@ -527,36 +428,22 @@ ossl_digest_name(VALUE self) return rb_str_new2(EVP_MD_name(EVP_MD_CTX_md(ctx))); }</pre> </div> - </div> - - </div> - <div id="method-i-reset" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> reset → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Resets the <a href="Digest.html"><code>Digest</code></a> in the sense that any <a href="Digest.html#method-i-update"><code>Digest#update</code></a> that has been performed is abandoned and the <a href="Digest.html"><code>Digest</code></a> is set to its initial state again.</p> - - - <div class="method-source-code" id="reset-source"> <pre>static VALUE ossl_digest_reset(VALUE self) @@ -571,31 +458,20 @@ ossl_digest_reset(VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-update" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> update(string) → aString </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Not every message digest can be computed in one single pass. If a message digest is to be computed from several subsequent sources, then each may be passed individually to the <a href="Digest.html"><code>Digest</code></a> instance.</p> <h3 id="method-i-update-label-Example">Example<span><a href="#method-i-update-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -605,10 +481,7 @@ ossl_digest_reset(VALUE self) <span class="ruby-identifier">digest</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'Second input'</span> <span class="ruby-comment"># equivalent to digest.update('Second input')</span> <span class="ruby-identifier">result</span> = <span class="ruby-identifier">digest</span>.<span class="ruby-identifier">digest</span> </pre> - - - <div class="method-source-code" id="update-source"> <pre>VALUE ossl_digest_update(VALUE self, VALUE data) @@ -624,29 +497,23 @@ ossl_digest_update(VALUE self, VALUE data) return self; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="Digest.html#method-i-3C-3C"><<</a> </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Digest/DigestError.html b/OpenSSL/Digest/DigestError.html index d2e28910..af0b4161 100644 --- a/OpenSSL/Digest/DigestError.html +++ b/OpenSSL/Digest/DigestError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/Engine.html b/OpenSSL/Engine.html index 684e8f63..58662cff 100644 --- a/OpenSSL/Engine.html +++ b/OpenSSL/Engine.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,52 +57,36 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-by_id">::by_id</a> - <li ><a href="#method-c-cleanup">::cleanup</a> - <li ><a href="#method-c-engines">::engines</a> - <li ><a href="#method-c-load">::load</a> - <li ><a href="#method-i-cipher">#cipher</a> - <li ><a href="#method-i-cmds">#cmds</a> - <li ><a href="#method-i-ctrl_cmd">#ctrl_cmd</a> - <li ><a href="#method-i-digest">#digest</a> - <li ><a href="#method-i-finish">#finish</a> - <li ><a href="#method-i-id">#id</a> - <li ><a href="#method-i-inspect">#inspect</a> - <li ><a href="#method-i-load_private_key">#load_private_key</a> - <li ><a href="#method-i-load_public_key">#load_public_key</a> - <li ><a href="#method-i-name">#name</a> - <li ><a href="#method-i-set_default">#set_default</a> - </ul> </div> @@ -118,55 +100,39 @@ <section class="description"> -<p>This class is the access to openssl's ENGINE cryptographic module implementation.</p> +<p>This class is the access to openssl’s ENGINE cryptographic module implementation.</p> <p>See also, <a href="https://www.openssl.org/docs/crypto/engine.html">www.openssl.org/docs/crypto/engine.html</a></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-by_id" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Engine.by_id(name) → engine </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Fetches the engine as specified by the <em>id</em> String.</p> <pre>OpenSSL::Engine.by_id("openssl") => #<OpenSSL::Engine id="openssl" name="Software engine support"></pre> <p>See <a href="Engine.html#method-c-engines"><code>OpenSSL::Engine.engines</code></a> for the currently loaded engines.</p> - - - <div class="method-source-code" id="by_id-source"> <pre>static VALUE ossl_engine_s_by_id(VALUE klass, VALUE id) @@ -190,38 +156,24 @@ ossl_engine_s_by_id(VALUE klass, VALUE id) return obj; }</pre> </div> - </div> - - </div> - <div id="method-c-cleanup" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Engine.cleanup </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>It is only necessary to run cleanup when engines are loaded via <a href="Engine.html#method-c-load"><code>OpenSSL::Engine.load</code></a>. However, running cleanup before exit is recommended.</p> <p>Note that this is needed and works only in <a href="../OpenSSL.html"><code>OpenSSL</code></a> < 1.1.0.</p> - - - <div class="method-source-code" id="cleanup-source"> <pre>static VALUE ossl_engine_s_cleanup(VALUE self) @@ -232,36 +184,22 @@ ossl_engine_s_cleanup(VALUE self) return Qnil; }</pre> </div> - </div> - - </div> - <div id="method-c-engines" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Engine.engines → [engine, ...] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns an array of currently loaded engines.</p> - - - <div class="method-source-code" id="engines-source"> <pre>static VALUE ossl_engine_s_engines(VALUE klass) @@ -283,36 +221,22 @@ ossl_engine_s_engines(VALUE klass) return ary; }</pre> </div> - </div> - - </div> - <div id="method-c-load" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Engine.load(name = nil) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>This method loads engines. If <em>name</em> is nil, then all builtin engines are loaded. Otherwise, the given <em>name</em>, as a String, is loaded if available to your runtime, and returns true. If <em>name</em> is not found, then nil is returned.</p> - - - <div class="method-source-code" id="load-source"> <pre>static VALUE ossl_engine_s_load(int argc, VALUE *argv, VALUE klass) @@ -374,39 +298,27 @@ ossl_engine_s_load(int argc, VALUE *argv, VALUE klass) return Qnil; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-cipher" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cipher(name) → OpenSSL::Cipher </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a new instance of <a href="Cipher.html"><code>OpenSSL::Cipher</code></a> by <em>name</em>, if it is available in this engine.</p> <p>An <a href="Engine/EngineError.html"><code>EngineError</code></a> will be raised if the cipher is unavailable.</p> @@ -415,10 +327,7 @@ ossl_engine_s_load(int argc, VALUE *argv, VALUE klass) => #<OpenSSL::Engine id="openssl" name="Software engine support"> e.cipher("RC4") => #<OpenSSL::Cipher:0x007fc5cacc3048></pre> - - - <div class="method-source-code" id="cipher-source"> <pre>static VALUE ossl_engine_get_cipher(VALUE self, VALUE name) @@ -437,36 +346,22 @@ ossl_engine_get_cipher(VALUE self, VALUE name) return ossl_cipher_new(ciph); }</pre> </div> - </div> - - </div> - <div id="method-i-cmds" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cmds → [["name", "description", "flags"], ...] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns an array of command definitions for the current engine</p> - - - <div class="method-source-code" id="cmds-source"> <pre>static VALUE ossl_engine_get_cmds(VALUE self) @@ -490,38 +385,24 @@ ossl_engine_get_cmds(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-ctrl_cmd" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> ctrl_cmd(command, value = nil) → engine </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sends the given <em>command</em> to this engine.</p> <p>Raises an <a href="Engine/EngineError.html"><code>EngineError</code></a> if the command fails.</p> - - - <div class="method-source-code" id="ctrl_cmd-source"> <pre>static VALUE ossl_engine_ctrl_cmd(int argc, VALUE *argv, VALUE self) @@ -539,31 +420,20 @@ ossl_engine_ctrl_cmd(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-digest" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> digest(name) → OpenSSL::Digest </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a new instance of <a href="Digest.html"><code>OpenSSL::Digest</code></a> by <em>name</em>.</p> <p>Will raise an <a href="Engine/EngineError.html"><code>EngineError</code></a> if the digest is unavailable.</p> @@ -575,10 +445,7 @@ ossl_engine_ctrl_cmd(int argc, VALUE *argv, VALUE self) <span class="ruby-identifier">e</span>.<span class="ruby-identifier">digest</span>(<span class="ruby-string">"zomg"</span>) <span class="ruby-comment">#=> OpenSSL::Engine::EngineError: no such digest `zomg'</span> </pre> - - - <div class="method-source-code" id="digest-source"> <pre>static VALUE ossl_engine_get_digest(VALUE self, VALUE name) @@ -597,38 +464,24 @@ ossl_engine_get_digest(VALUE self, VALUE name) return ossl_digest_new(md); }</pre> </div> - </div> - - </div> - <div id="method-i-finish" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> finish → nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Releases all internal structural references for this engine.</p> <p>May raise an <a href="Engine/EngineError.html"><code>EngineError</code></a> if the engine is unavailable</p> - - - <div class="method-source-code" id="finish-source"> <pre>static VALUE ossl_engine_finish(VALUE self) @@ -641,31 +494,20 @@ ossl_engine_finish(VALUE self) return Qnil; }</pre> </div> - </div> - - </div> - <div id="method-i-id" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> id → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Gets the id for this engine.</p> <pre class="ruby"><span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Engine</span>.<span class="ruby-identifier">load</span> @@ -673,10 +515,7 @@ ossl_engine_finish(VALUE self) <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Engine</span>.<span class="ruby-identifier">engines</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">id</span> <span class="ruby-comment">#=> "rsax"</span> </pre> - - - <div class="method-source-code" id="id-source"> <pre>static VALUE ossl_engine_get_id(VALUE self) @@ -686,36 +525,22 @@ ossl_engine_get_id(VALUE self) return rb_str_new2(ENGINE_get_id(e)); }</pre> </div> - </div> - - </div> - <div id="method-i-inspect" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> inspect → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Pretty prints this engine.</p> - - - <div class="method-source-code" id="inspect-source"> <pre>static VALUE ossl_engine_inspect(VALUE self) @@ -727,38 +552,24 @@ ossl_engine_inspect(VALUE self) rb_obj_class(self), ENGINE_get_id(e), ENGINE_get_name(e)); }</pre> </div> - </div> - - </div> - <div id="method-i-load_private_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> load_private_key(id = nil, data = nil) → OpenSSL::PKey </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Loads the given private key identified by <em>id</em> and <em>data</em>.</p> <p>An <a href="Engine/EngineError.html"><code>EngineError</code></a> is raised of the <a href="PKey.html"><code>OpenSSL::PKey</code></a> is unavailable.</p> - - - <div class="method-source-code" id="load_private_key-source"> <pre>static VALUE ossl_engine_load_privkey(int argc, VALUE *argv, VALUE self) @@ -780,38 +591,24 @@ ossl_engine_load_privkey(int argc, VALUE *argv, VALUE self) return obj; }</pre> </div> - </div> - - </div> - <div id="method-i-load_public_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> load_public_key(id = nil, data = nil) → OpenSSL::PKey </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Loads the given public key identified by <em>id</em> and <em>data</em>.</p> <p>An <a href="Engine/EngineError.html"><code>EngineError</code></a> is raised of the <a href="PKey.html"><code>OpenSSL::PKey</code></a> is unavailable.</p> - - - <div class="method-source-code" id="load_public_key-source"> <pre>static VALUE ossl_engine_load_pubkey(int argc, VALUE *argv, VALUE self) @@ -831,31 +628,20 @@ ossl_engine_load_pubkey(int argc, VALUE *argv, VALUE self) return ossl_pkey_new(pkey); }</pre> </div> - </div> - - </div> - <div id="method-i-name" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> name → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Get the descriptive name for this engine.</p> <pre class="ruby"><span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Engine</span>.<span class="ruby-identifier">load</span> @@ -863,10 +649,7 @@ ossl_engine_load_pubkey(int argc, VALUE *argv, VALUE self) <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Engine</span>.<span class="ruby-identifier">engines</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">name</span> <span class="ruby-comment">#=> "RSAX engine support"</span> </pre> - - - <div class="method-source-code" id="name-source"> <pre>static VALUE ossl_engine_get_name(VALUE self) @@ -876,31 +659,20 @@ ossl_engine_get_name(VALUE self) return rb_str_new2(ENGINE_get_name(e)); }</pre> </div> - </div> - - </div> - <div id="method-i-set_default" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_default(flag) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Set the defaults for this engine with the given <em>flag</em>.</p> <p>These flags are used to control combinations of algorithm methods.</p> @@ -915,10 +687,7 @@ ossl_engine_get_name(VALUE self) </dd></dl> <p>See also <openssl/engine.h></p> - - - <div class="method-source-code" id="set_default-source"> <pre>static VALUE ossl_engine_set_default(VALUE self, VALUE flag) @@ -932,25 +701,20 @@ ossl_engine_set_default(VALUE self, VALUE flag) return Qtrue; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Engine/EngineError.html b/OpenSSL/Engine/EngineError.html index 0afd68b4..49fc3f9c 100644 --- a/OpenSSL/Engine/EngineError.html +++ b/OpenSSL/Engine/EngineError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/ExtConfig.html b/OpenSSL/ExtConfig.html index c8625510..5a8b9f84 100644 --- a/OpenSSL/ExtConfig.html +++ b/OpenSSL/ExtConfig.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -77,44 +75,30 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="HAVE_TLSEXT_HOST_NAME">HAVE_TLSEXT_HOST_NAME - <dd> - - <dt id="OPENSSL_NO_SOCK">OPENSSL_NO_SOCK - <dd> - - </dl> </section> - - - - </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. + <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> diff --git a/OpenSSL/HMAC.html b/OpenSSL/HMAC.html index 782933aa..555dfc35 100644 --- a/OpenSSL/HMAC.html +++ b/OpenSSL/HMAC.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -68,46 +66,33 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- 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-hexdigest">::hexdigest</a> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3C-3C">#<<</a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-digest">#digest</a> - <li ><a href="#method-i-hexdigest">#hexdigest</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-inspect">#inspect</a> - <li ><a href="#method-i-reset">#reset</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-update">#update</a> - </ul> </div> @@ -147,39 +132,26 @@ </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-digest" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> digest(digest, key, data) → aString </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the authentication code as a binary string. The <em>digest</em> parameter specifies the digest algorithm to use. This may be a String representing the algorithm name or an instance of <a href="Digest.html"><code>OpenSSL::Digest</code></a>.</p> <h3 id="method-c-digest-label-Example">Example<span><a href="#method-c-digest-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -190,10 +162,7 @@ <span class="ruby-identifier">hmac</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">HMAC</span>.<span class="ruby-identifier">digest</span>(<span class="ruby-string">'sha1'</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">data</span>) <span class="ruby-comment">#=> "\xDE|\x9B\x85\xB8\xB7\x8A\xA6\xBC\x8Az6\xF7\n\x90p\x1C\x9D\xB4\xD9"</span> </pre> - - - <div class="method-source-code" id="digest-source"> <pre>static VALUE ossl_hmac_s_digest(VALUE klass, VALUE digest, VALUE key, VALUE data) @@ -210,31 +179,20 @@ ossl_hmac_s_digest(VALUE klass, VALUE digest, VALUE key, VALUE data) return rb_str_new((const char *)buf, buf_len); }</pre> </div> - </div> - - </div> - <div id="method-c-hexdigest" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> hexdigest(digest, key, data) → aString </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the authentication code as a hex-encoded string. The <em>digest</em> parameter specifies the digest algorithm to use. This may be a String representing the algorithm name or an instance of <a href="Digest.html"><code>OpenSSL::Digest</code></a>.</p> <h3 id="method-c-hexdigest-label-Example">Example<span><a href="#method-c-hexdigest-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -245,10 +203,7 @@ ossl_hmac_s_digest(VALUE klass, VALUE digest, VALUE key, VALUE data) <span class="ruby-identifier">hmac</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">HMAC</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-string">'sha1'</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">data</span>) <span class="ruby-comment">#=> "de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9"</span> </pre> - - - <div class="method-source-code" id="hexdigest-source"> <pre>static VALUE ossl_hmac_s_hexdigest(VALUE klass, VALUE digest, VALUE key, VALUE data) @@ -271,31 +226,20 @@ ossl_hmac_s_hexdigest(VALUE klass, VALUE digest, VALUE key, VALUE data) return ret; }</pre> </div> - </div> - - </div> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new(key, digest) → hmac </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns an instance of <a href="HMAC.html"><code>OpenSSL::HMAC</code></a> set with the key and digest algorithm to be used. The instance represents the initial state of the message authentication code before any data has been processed. To process data with it, use the instance method <a href="HMAC.html#method-i-update"><code>update</code></a> with your data as an argument.</p> <h3 id="method-c-new-label-Example">Example<span><a href="#method-c-new-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -310,17 +254,14 @@ ossl_hmac_s_hexdigest(VALUE klass, VALUE digest, VALUE key, VALUE data) <h3 id="method-c-new-label-A+note+about+comparisons">A note about comparisons<span><a href="#method-c-new-label-A+note+about+comparisons">¶</a> <a href="#top">↑</a></span></h3> -<p>Two instances can be securely compared with #== in constant time:</p> +<p>Two instances can be securely compared with <a href="HMAC.html#method-i-3D-3D"><code>==</code></a> in constant time:</p> <pre class="ruby"> <span class="ruby-identifier">other_instance</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">HMAC</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'key'</span>, <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Digest</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'sha1'</span>)) <span class="ruby-comment">#=> f42bb0eeb018ebbd4597ae7213711ec60760843f</span> <span class="ruby-identifier">instance</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other_instance</span> <span class="ruby-comment">#=> true</span> </pre> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_hmac_initialize(VALUE self, VALUE key, VALUE digest) @@ -335,69 +276,56 @@ ossl_hmac_initialize(VALUE self, VALUE key, VALUE digest) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3C-3C" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name"><<</span><span class="method-args">(p1)</span> - </div> - <div class="method-description"> - - - - + <p>Returns <em>hmac</em> updated with the message to be authenticated. Can be called repeatedly with chunks of the message.</p> + +<h3 id="method-i-3C-3C-label-Example">Example<span><a href="#method-i-3C-3C-label-Example">¶</a> <a href="#top">↑</a></span></h3> + +<pre class="ruby"><span class="ruby-identifier">first_chunk</span> = <span class="ruby-string">'The quick brown fox jumps '</span> +<span class="ruby-identifier">second_chunk</span> = <span class="ruby-string">'over the lazy dog'</span> + +<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">first_chunk</span>) +<span class="ruby-comment">#=> 5b9a8038a65d571076d97fe783989e52278a492a</span> +<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">second_chunk</span>) +<span class="ruby-comment">#=> de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9</span> +</pre> - </div> - - <div class="aliases"> Alias for: <a href="HMAC.html#method-i-update">update</a> </div> - </div> - <div id="method-i-3D-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">==</span><span class="method-args">(other)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Securely compare with another <a href="HMAC.html"><code>HMAC</code></a> instance in constant time.</p> - - - <div class="method-source-code" id="3D-3D-source"> <pre><span class="ruby-comment"># File lib/openssl/hmac.rb, line 6</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>) @@ -407,31 +335,20 @@ ossl_hmac_initialize(VALUE self, VALUE key, VALUE digest) <span class="ruby-constant">OpenSSL</span>.<span class="ruby-identifier">fixed_length_secure_compare</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">digest</span>, <span class="ruby-identifier">other</span>.<span class="ruby-identifier">digest</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-digest" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> digest → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the authentication code an instance represents as a binary string.</p> <h3 id="method-i-digest-label-Example">Example<span><a href="#method-i-digest-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -441,10 +358,7 @@ ossl_hmac_initialize(VALUE self, VALUE key, VALUE digest) <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">digest</span> <span class="ruby-comment">#=> "\xF4+\xB0\xEE\xB0\x18\xEB\xBDE\x97\xAEr\x13q\x1E\xC6\a`\x84?"</span> </pre> - - - <div class="method-source-code" id="digest-source"> <pre>static VALUE ossl_hmac_digest(VALUE self) @@ -462,36 +376,22 @@ ossl_hmac_digest(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-hexdigest" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> hexdigest → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the authentication code an instance represents as a hex-encoded string.</p> - - - <div class="method-source-code" id="hexdigest-source"> <pre>static VALUE ossl_hmac_hexdigest(VALUE self) @@ -509,37 +409,24 @@ ossl_hmac_hexdigest(VALUE self) return ret; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="HMAC.html#method-i-inspect">inspect</a>, <a href="HMAC.html#method-i-to_s">to_s</a> </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_hmac_copy(VALUE self, VALUE other) @@ -557,59 +444,46 @@ ossl_hmac_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-inspect" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">inspect</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - + <p>Returns the authentication code as a hex-encoded string. The <em>digest</em> parameter specifies the digest algorithm to use. This may be a String representing the algorithm name or an instance of <a href="Digest.html"><code>OpenSSL::Digest</code></a>.</p> + +<h3 id="method-i-inspect-label-Example">Example<span><a href="#method-i-inspect-label-Example">¶</a> <a href="#top">↑</a></span></h3> + +<pre class="ruby"><span class="ruby-identifier">key</span> = <span class="ruby-string">'key'</span> +<span class="ruby-identifier">data</span> = <span class="ruby-string">'The quick brown fox jumps over the lazy dog'</span> + +<span class="ruby-identifier">hmac</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">HMAC</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-string">'sha1'</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">data</span>) +<span class="ruby-comment">#=> "de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9"</span> +</pre> - </div> - - <div class="aliases"> Alias for: <a href="HMAC.html#method-i-hexdigest">hexdigest</a> </div> - </div> - <div id="method-i-reset" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> reset → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns <em>hmac</em> as it was when it was first initialized, with all processed data cleared from it.</p> <h3 id="method-i-reset-label-Example">Example<span><a href="#method-i-reset-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -623,10 +497,7 @@ ossl_hmac_copy(VALUE self, VALUE other) <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">reset</span> <span class="ruby-comment">#=> f42bb0eeb018ebbd4597ae7213711ec60760843f</span> </pre> - - - <div class="method-source-code" id="reset-source"> <pre>static VALUE ossl_hmac_reset(VALUE self) @@ -639,59 +510,46 @@ ossl_hmac_reset(VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-to_s" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">to_s</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - + <p>Returns the authentication code as a hex-encoded string. The <em>digest</em> parameter specifies the digest algorithm to use. This may be a String representing the algorithm name or an instance of <a href="Digest.html"><code>OpenSSL::Digest</code></a>.</p> + +<h3 id="method-i-to_s-label-Example">Example<span><a href="#method-i-to_s-label-Example">¶</a> <a href="#top">↑</a></span></h3> + +<pre class="ruby"><span class="ruby-identifier">key</span> = <span class="ruby-string">'key'</span> +<span class="ruby-identifier">data</span> = <span class="ruby-string">'The quick brown fox jumps over the lazy dog'</span> + +<span class="ruby-identifier">hmac</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">HMAC</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-string">'sha1'</span>, <span class="ruby-identifier">key</span>, <span class="ruby-identifier">data</span>) +<span class="ruby-comment">#=> "de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9"</span> +</pre> - </div> - - <div class="aliases"> Alias for: <a href="HMAC.html#method-i-hexdigest">hexdigest</a> </div> - </div> - <div id="method-i-update" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> update(string) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns <em>hmac</em> updated with the message to be authenticated. Can be called repeatedly with chunks of the message.</p> <h3 id="method-i-update-label-Example">Example<span><a href="#method-i-update-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -704,10 +562,7 @@ ossl_hmac_reset(VALUE self) <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">second_chunk</span>) <span class="ruby-comment">#=> de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9</span> </pre> - - - <div class="method-source-code" id="update-source"> <pre>static VALUE ossl_hmac_update(VALUE self, VALUE data) @@ -721,29 +576,23 @@ ossl_hmac_update(VALUE self, VALUE data) return self; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="HMAC.html#method-i-3C-3C"><<</a> </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/HMACError.html b/OpenSSL/HMACError.html index 0c4ef959..d19bc6e2 100644 --- a/OpenSSL/HMACError.html +++ b/OpenSSL/HMACError.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -68,12 +66,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -117,25 +114,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/KDF.html b/OpenSSL/KDF.html index c7c8cb54..0df19309 100644 --- a/OpenSSL/KDF.html +++ b/OpenSSL/KDF.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -73,18 +71,15 @@ - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-hkdf">::hkdf</a> - <li ><a href="#method-c-pbkdf2_hmac">::pbkdf2_hmac</a> - <li ><a href="#method-c-scrypt">::scrypt</a> - </ul> </div> @@ -142,39 +137,26 @@ </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-hkdf" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> hkdf(ikm, salt:, info:, length:, hash:) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as specified in <a href="https://tools.ietf.org/html/rfc5869">RFC 5869</a>.</p> <p>New in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> @@ -196,10 +178,7 @@ <dd> <p>The hash function.</p> </dd></dl> - - - <div class="method-source-code" id="hkdf-source"> <pre>static VALUE kdf_hkdf(int argc, VALUE *argv, VALUE self) @@ -268,31 +247,20 @@ kdf_hkdf(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-c-pbkdf2_hmac" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> pbkdf2_hmac(pass, salt:, iterations:, length:, hash:) → aString </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>PKCS #5 PBKDF2 (Password-Based Key Derivation Function 2) in combination with <a href="HMAC.html"><code>HMAC</code></a>. Takes <em>pass</em>, <em>salt</em> and <em>iterations</em>, and then derives a key of <em>length</em> bytes.</p> <p>For more information about PBKDF2, see RFC 2898 Section 5.2 (<a href="https://tools.ietf.org/html/rfc2898#section-5.2">tools.ietf.org/html/rfc2898#section-5.2</a>).</p> @@ -314,10 +282,7 @@ kdf_hkdf(int argc, VALUE *argv, VALUE self) <dd> <p>The hash algorithm used with <a href="HMAC.html"><code>HMAC</code></a> for the PRF. May be a String representing the algorithm name, or an instance of <a href="Digest.html"><code>OpenSSL::Digest</code></a>.</p> </dd></dl> - - - <div class="method-source-code" id="pbkdf2_hmac-source"> <pre>static VALUE kdf_pbkdf2_hmac(int argc, VALUE *argv, VALUE self) @@ -352,31 +317,20 @@ kdf_pbkdf2_hmac(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-c-scrypt" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> scrypt(pass, salt:, N:, r:, p:, length:) → aString </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Derives a key from <em>pass</em> using given parameters with the scrypt password-based key derivation function. The result can be used for password storage.</p> <p>scrypt is designed to be memory-hard and more secure against brute-force attacks using custom hardwares than alternative KDFs such as PBKDF2 or bcrypt.</p> @@ -413,10 +367,7 @@ kdf_pbkdf2_hmac(int argc, VALUE *argv, VALUE self) <span class="ruby-identifier">dk</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">KDF</span>.<span class="ruby-identifier">scrypt</span>(<span class="ruby-identifier">pass</span>, <span class="ruby-value">salt:</span> <span class="ruby-identifier">salt</span>, <span class="ruby-value">N:</span> <span class="ruby-value">2</span><span class="ruby-operator">**</span><span class="ruby-value">14</span>, <span class="ruby-value">r:</span> <span class="ruby-value">8</span>, <span class="ruby-value">p:</span> <span class="ruby-value">1</span>, <span class="ruby-value">length:</span> <span class="ruby-value">32</span>) <span class="ruby-identifier">p</span> <span class="ruby-identifier">dk</span> <span class="ruby-comment">#=> "\xDA\xE4\xE2...\x7F\xA1\x01T"</span> </pre> - - - <div class="method-source-code" id="scrypt-source"> <pre>static VALUE kdf_scrypt(int argc, VALUE *argv, VALUE self) @@ -458,25 +409,20 @@ kdf_scrypt(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/KDF/KDFError.html b/OpenSSL/KDF/KDFError.html index d2200d33..3eb491db 100644 --- a/OpenSSL/KDF/KDFError.html +++ b/OpenSSL/KDF/KDFError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/Marshal.html b/OpenSSL/Marshal.html index 34f649d8..f65c8977 100644 --- a/OpenSSL/Marshal.html +++ b/OpenSSL/Marshal.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -62,16 +60,14 @@ - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-included">::included</a> - <li ><a href="#method-i-_dump">#_dump</a> - </ul> </div> @@ -87,107 +83,75 @@ </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-included" class="method-detail "> - <div class="method-heading"> <span class="method-name">included</span><span class="method-args">(base)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="included-source"> <pre><span class="ruby-comment"># File lib/openssl/marshal.rb, line 16</span> <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">included</span>(<span class="ruby-identifier">base</span>) <span class="ruby-identifier">base</span>.<span class="ruby-identifier">extend</span>(<span class="ruby-constant">ClassMethods</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-_dump" class="method-detail "> - <div class="method-heading"> <span class="method-name">_dump</span><span class="method-args">(_level)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="_dump-source"> <pre><span class="ruby-comment"># File lib/openssl/marshal.rb, line 26</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_dump</span>(<span class="ruby-identifier">_level</span>) <span class="ruby-identifier">to_der</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Marshal/ClassMethods.html b/OpenSSL/Marshal/ClassMethods.html index bd01a583..07ba245d 100644 --- a/OpenSSL/Marshal/ClassMethods.html +++ b/OpenSSL/Marshal/ClassMethods.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -62,14 +60,13 @@ - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-i-_load">#_load</a> - </ul> </div> @@ -85,66 +82,47 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-_load" class="method-detail "> - <div class="method-heading"> <span class="method-name">_load</span><span class="method-args">(string)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="_load-source"> <pre><span class="ruby-comment"># File lib/openssl/marshal.rb, line 21</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_load</span>(<span class="ruby-identifier">string</span>) <span class="ruby-identifier">new</span>(<span class="ruby-identifier">string</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Netscape.html b/OpenSSL/Netscape.html index fd5768f2..ef79bfb3 100644 --- a/OpenSSL/Netscape.html +++ b/OpenSSL/Netscape.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -77,25 +75,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/Netscape/SPKI.html b/OpenSSL/Netscape/SPKI.html index 209cbe46..e1a10e16 100644 --- a/OpenSSL/Netscape/SPKI.html +++ b/OpenSSL/Netscape/SPKI.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -69,44 +67,32 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-challenge">#challenge</a> - <li ><a href="#method-i-challenge-3D">#challenge=</a> - <li ><a href="#method-i-public_key">#public_key</a> - <li ><a href="#method-i-public_key-3D">#public_key=</a> - <li ><a href="#method-i-sign">#sign</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-to_text">#to_text</a> - <li ><a href="#method-i-verify">#verify</a> - </ul> </div> @@ -159,47 +145,31 @@ SignedPublicKeyAndChallenge ::= SEQUENCE { </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new([request]) → spki </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <h3 id="method-c-new-label-Parameters">Parameters<span><a href="#method-c-new-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> <ul><li> <p><em>request</em> - optional raw request, either in PEM or DER format.</p> </li></ul> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_spki_initialize(int argc, VALUE *argv, VALUE self) @@ -225,44 +195,29 @@ ossl_spki_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-challenge" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> challenge → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the challenge string associated with this <a href="SPKI.html"><code>SPKI</code></a>.</p> - - - <div class="method-source-code" id="challenge-source"> <pre>static VALUE ossl_spki_get_challenge(VALUE self) @@ -279,41 +234,27 @@ ossl_spki_get_challenge(VALUE self) spki->spkac->challenge->length); }</pre> </div> - </div> - - </div> - <div id="method-i-challenge-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> challenge = str → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <h3 id="method-i-challenge-3D-label-Parameters">Parameters<span><a href="#method-i-challenge-3D-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> <ul><li> <p><em>str</em> - the challenge string to be set for this instance</p> </li></ul> <p>Sets the challenge to be associated with the <a href="SPKI.html"><code>SPKI</code></a>. May be used by the server, e.g. to prevent replay.</p> - - - <div class="method-source-code" id="challenge-3D-source"> <pre>static VALUE ossl_spki_set_challenge(VALUE self, VALUE str) @@ -330,36 +271,22 @@ ossl_spki_set_challenge(VALUE self, VALUE str) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-public_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_key → pkey </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the public key associated with the <a href="SPKI.html"><code>SPKI</code></a>, an instance of <a href="../PKey.html"><code>OpenSSL::PKey</code></a>.</p> - - - <div class="method-source-code" id="public_key-source"> <pre>static VALUE ossl_spki_get_public_key(VALUE self) @@ -375,41 +302,27 @@ ossl_spki_get_public_key(VALUE self) return ossl_pkey_new(pkey); /* NO DUP - OK */ }</pre> </div> - </div> - - </div> - <div id="method-i-public_key-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_key = pub → pkey </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <h3 id="method-i-public_key-3D-label-Parameters">Parameters<span><a href="#method-i-public_key-3D-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> <ul><li> <p><em>pub</em> - the public key to be set for this instance</p> </li></ul> <p>Sets the public key to be associated with the <a href="SPKI.html"><code>SPKI</code></a>, an instance of <a href="../PKey.html"><code>OpenSSL::PKey</code></a>. This should be the public key corresponding to the private key used for signing the <a href="SPKI.html"><code>SPKI</code></a>.</p> - - - <div class="method-source-code" id="public_key-3D-source"> <pre>static VALUE ossl_spki_set_public_key(VALUE self, VALUE key) @@ -425,31 +338,20 @@ ossl_spki_set_public_key(VALUE self, VALUE key) return key; }</pre> </div> - </div> - - </div> - <div id="method-i-sign" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sign(key, digest) → spki </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <h3 id="method-i-sign-label-Parameters">Parameters<span><a href="#method-i-sign-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> <ul><li> <p><em>key</em> - the private key to be used for signing this instance</p> @@ -458,10 +360,7 @@ ossl_spki_set_public_key(VALUE self, VALUE key) </li></ul> <p>To sign an <a href="SPKI.html"><code>SPKI</code></a>, the private key corresponding to the public key set for this instance should be used, in addition to a digest algorithm in the form of an <a href="../Digest.html"><code>OpenSSL::Digest</code></a>. The private key should be an instance of <a href="../PKey.html"><code>OpenSSL::PKey</code></a>.</p> - - - <div class="method-source-code" id="sign-source"> <pre>static VALUE ossl_spki_sign(VALUE self, VALUE key, VALUE digest) @@ -480,36 +379,22 @@ ossl_spki_sign(VALUE self, VALUE key, VALUE digest) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → DER-encoded string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the DER encoding of this <a href="SPKI.html"><code>SPKI</code></a>.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_spki_to_der(VALUE self) @@ -531,36 +416,22 @@ ossl_spki_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_pem → PEM-encoded string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the PEM encoding of this <a href="SPKI.html"><code>SPKI</code></a>.</p> - - - <div class="method-source-code" id="to_pem-source"> <pre>static VALUE ossl_spki_to_pem(VALUE self) @@ -578,68 +449,42 @@ ossl_spki_to_pem(VALUE self) return str; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="SPKI.html#method-i-to_s">to_s</a> </div> - - </div> - <div id="method-i-to_s" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">to_s</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - + <p>Returns the PEM encoding of this <a href="SPKI.html"><code>SPKI</code></a>.</p> - </div> - - <div class="aliases"> Alias for: <a href="SPKI.html#method-i-to_pem">to_pem</a> </div> - </div> - <div id="method-i-to_text" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_text → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a textual representation of this <a href="SPKI.html"><code>SPKI</code></a>, useful for debugging purposes.</p> - - - <div class="method-source-code" id="to_text-source"> <pre>static VALUE ossl_spki_print(VALUE self) @@ -659,41 +504,27 @@ ossl_spki_print(VALUE self) return ossl_membio2str(out); }</pre> </div> - </div> - - </div> - <div id="method-i-verify" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> verify(key) → boolean </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <h3 id="method-i-verify-label-Parameters">Parameters<span><a href="#method-i-verify-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> <ul><li> <p><em>key</em> - the public key to be used for verifying the <a href="SPKI.html"><code>SPKI</code></a> signature</p> </li></ul> <p>Returns <code>true</code> if the signature is valid, <code>false</code> otherwise. To verify an <a href="SPKI.html"><code>SPKI</code></a>, the public key contained within the <a href="SPKI.html"><code>SPKI</code></a> should be used.</p> - - - <div class="method-source-code" id="verify-source"> <pre>static VALUE ossl_spki_verify(VALUE self, VALUE key) @@ -715,25 +546,20 @@ ossl_spki_verify(VALUE self, VALUE key) } }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Netscape/SPKIError.html b/OpenSSL/Netscape/SPKIError.html index 298d5dee..a4fe3c0d 100644 --- a/OpenSSL/Netscape/SPKIError.html +++ b/OpenSSL/Netscape/SPKIError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/OCSP.html b/OpenSSL/OCSP.html index cdfc5f44..3d3a40e9 100644 --- a/OpenSSL/OCSP.html +++ b/OpenSSL/OCSP.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -108,7 +106,7 @@ <span class="ruby-identifier">ocsp_uri</span> = <span class="ruby-constant">URI</span> <span class="ruby-identifier">ocsp_uris</span>[<span class="ruby-value">0</span>] </pre> -<p>To submit the request we'll POST the request to the <a href="OCSP.html"><code>OCSP</code></a> URI (per RFC 2560). Note that we only handle HTTP requests and don't handle any redirects in this example, so this is insufficient for serious use.</p> +<p>To submit the request we’ll POST the request to the <a href="OCSP.html"><code>OCSP</code></a> URI (per RFC 2560). Note that we only handle HTTP requests and don’t handle any redirects in this example, so this is insufficient for serious use.</p> <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'net/http'</span> @@ -168,194 +166,90 @@ end</pre> </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="NOCASIGN">NOCASIGN - <dd><p>(This flag is not used by <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.0.1g)</p> - - <dt id="NOCERTS">NOCERTS - <dd><p>Do not include certificates in the response</p> - - <dt id="NOCHAIN">NOCHAIN - <dd><p>Do not verify the certificate chain on the response</p> - - <dt id="NOCHECKS">NOCHECKS - <dd><p>Do not make additional signing certificate checks</p> - - <dt id="NODELEGATED">NODELEGATED - <dd><p>(This flag is not used by <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.0.1g)</p> - - <dt id="NOEXPLICIT">NOEXPLICIT - <dd><p>Do not check trust</p> - - <dt id="NOINTERN">NOINTERN - <dd><p>Do not search certificates contained in the response for a signer</p> - - <dt id="NOSIGS">NOSIGS - <dd><p>Do not check the signature on the response</p> - - <dt id="NOTIME">NOTIME - <dd><p>Do not include producedAt time in response</p> - - <dt id="NOVERIFY">NOVERIFY - <dd><p>Do not verify the response at all</p> - - <dt id="RESPID_KEY">RESPID_KEY - <dd><p>Identify the response by signing the certificate key ID</p> - - <dt id="RESPONSE_STATUS_INTERNALERROR">RESPONSE_STATUS_INTERNALERROR - <dd><p>Internal error in issuer</p> - - <dt id="RESPONSE_STATUS_MALFORMEDREQUEST">RESPONSE_STATUS_MALFORMEDREQUEST - <dd><p>Illegal confirmation request</p> - - <dt id="RESPONSE_STATUS_SIGREQUIRED">RESPONSE_STATUS_SIGREQUIRED - <dd><p>You must sign the request and resubmit</p> - - <dt id="RESPONSE_STATUS_SUCCESSFUL">RESPONSE_STATUS_SUCCESSFUL - <dd><p><a href="OCSP/Response.html"><code>Response</code></a> has valid confirmations</p> - - <dt id="RESPONSE_STATUS_TRYLATER">RESPONSE_STATUS_TRYLATER - <dd><p>Try again later</p> - - <dt id="RESPONSE_STATUS_UNAUTHORIZED">RESPONSE_STATUS_UNAUTHORIZED - <dd><p>Your request is unauthorized.</p> - - <dt id="REVOKED_STATUS_AFFILIATIONCHANGED">REVOKED_STATUS_AFFILIATIONCHANGED - - <dd><p>The certificate subject's name or other information changed</p> - - + <dd><p>The certificate subject’s name or other information changed</p> <dt id="REVOKED_STATUS_CACOMPROMISE">REVOKED_STATUS_CACOMPROMISE - <dd><p>This CA certificate was revoked due to a key compromise</p> - - <dt id="REVOKED_STATUS_CERTIFICATEHOLD">REVOKED_STATUS_CERTIFICATEHOLD - <dd><p>The certificate is on hold</p> - - <dt id="REVOKED_STATUS_CESSATIONOFOPERATION">REVOKED_STATUS_CESSATIONOFOPERATION - <dd><p>The certificate is no longer needed</p> - - <dt id="REVOKED_STATUS_KEYCOMPROMISE">REVOKED_STATUS_KEYCOMPROMISE - <dd><p>The certificate was revoked due to a key compromise</p> - - <dt id="REVOKED_STATUS_NOSTATUS">REVOKED_STATUS_NOSTATUS - <dd><p>The certificate was revoked for an unknown reason</p> - - <dt id="REVOKED_STATUS_REMOVEFROMCRL">REVOKED_STATUS_REMOVEFROMCRL - <dd><p>The certificate was previously on hold and should now be removed from the CRL</p> - - <dt id="REVOKED_STATUS_SUPERSEDED">REVOKED_STATUS_SUPERSEDED - <dd><p>The certificate was superseded by a new certificate</p> - - <dt id="REVOKED_STATUS_UNSPECIFIED">REVOKED_STATUS_UNSPECIFIED - <dd><p>The certificate was revoked for an unspecified reason</p> - - <dt id="TRUSTOTHER">TRUSTOTHER - <dd><p>Do not verify additional certificates</p> - - <dt id="V_CERTSTATUS_GOOD">V_CERTSTATUS_GOOD - - <dd><p>Indicates the certificate is not revoked but does not necessarily mean the certificate was issued or that this response is within the certificate's validity interval</p> - - + <dd><p>Indicates the certificate is not revoked but does not necessarily mean the certificate was issued or that this response is within the certificate’s validity interval</p> <dt id="V_CERTSTATUS_REVOKED">V_CERTSTATUS_REVOKED - <dd><p>Indicates the certificate has been revoked either permanently or temporarily (on hold).</p> - - <dt id="V_CERTSTATUS_UNKNOWN">V_CERTSTATUS_UNKNOWN - <dd><p>Indicates the responder does not know about the certificate being requested.</p> - - <dt id="V_RESPID_KEY">V_RESPID_KEY - <dd><p>The responder ID is based on the public key.</p> - - <dt id="V_RESPID_NAME">V_RESPID_NAME - <dd><p>The responder ID is based on the key name.</p> - - </dl> </section> - - - - </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. + <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> diff --git a/OpenSSL/OCSP/BasicResponse.html b/OpenSSL/OCSP/BasicResponse.html index 2b4c14a0..64237430 100644 --- a/OpenSSL/OCSP/BasicResponse.html +++ b/OpenSSL/OCSP/BasicResponse.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,44 +57,32 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-add_nonce">#add_nonce</a> - <li ><a href="#method-i-add_status">#add_status</a> - <li ><a href="#method-i-copy_nonce">#copy_nonce</a> - <li ><a href="#method-i-find_response">#find_response</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-responses">#responses</a> - <li ><a href="#method-i-sign">#sign</a> - <li ><a href="#method-i-status">#status</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-verify">#verify</a> - </ul> </div> @@ -114,44 +100,28 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::OCSP::BasicResponse.new(der_string = nil) → basic_response </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="BasicResponse.html"><code>BasicResponse</code></a>. If <em>der_string</em> is given, decodes <em>der_string</em> as DER.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ocspbres_initialize(int argc, VALUE *argv, VALUE self) @@ -176,44 +146,29 @@ ossl_ocspbres_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-add_nonce" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add_nonce(nonce = nil) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Adds <em>nonce</em> to this response. If no nonce was provided a random nonce will be added.</p> - - - <div class="method-source-code" id="add_nonce-source"> <pre>static VALUE ossl_ocspbres_add_nonce(int argc, VALUE *argv, VALUE self) @@ -237,31 +192,20 @@ ossl_ocspbres_add_nonce(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-add_status" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add_status(certificate_id, status, reason, revocation_time, this_update, next_update, extensions) → basic_response </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Adds a certificate status for <em>certificate_id</em>. <em>status</em> is the status, and must be one of these:</p> <ul><li> <p>OpenSSL::OCSP::V_CERTSTATUS_GOOD</p> @@ -278,10 +222,7 @@ ossl_ocspbres_add_nonce(int argc, VALUE *argv, VALUE self) <p><em>extensions</em> is an Array of <a href="../X509/Extension.html"><code>OpenSSL::X509::Extension</code></a> to be included in the <a href="SingleResponse.html"><code>SingleResponse</code></a>. This is also optional.</p> <p>Note that the times, <em>revocation_time</em>, <em>this_update</em> and <em>next_update</em> can be specified in either of <a href="../../Integer.html"><code>Integer</code></a> or Time object. If they are <a href="../../Integer.html"><code>Integer</code></a>, it is treated as the relative seconds from the current time.</p> - - - <div class="method-source-code" id="add_status-source"> <pre>static VALUE ossl_ocspbres_add_status(VALUE self, VALUE cid, VALUE status, @@ -349,36 +290,22 @@ ossl_ocspbres_add_status(VALUE self, VALUE cid, VALUE status, return self; }</pre> </div> - </div> - - </div> - <div id="method-i-copy_nonce" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> copy_nonce(request) → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Copies the nonce from <em>request</em> into this response. Returns 1 on success and 0 on failure.</p> - - - <div class="method-source-code" id="copy_nonce-source"> <pre>static VALUE ossl_ocspbres_copy_nonce(VALUE self, VALUE request) @@ -394,36 +321,22 @@ ossl_ocspbres_copy_nonce(VALUE self, VALUE request) return INT2NUM(ret); }</pre> </div> - </div> - - </div> - <div id="method-i-find_response" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> find_response(certificate_id) → SingleResponse | nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a <a href="SingleResponse.html"><code>SingleResponse</code></a> whose CertId matches with <em>certificate_id</em>, or <code>nil</code> if this <a href="BasicResponse.html"><code>BasicResponse</code></a> does not contain it.</p> - - - <div class="method-source-code" id="find_response-source"> <pre>static VALUE ossl_ocspbres_find_response(VALUE self, VALUE target) @@ -447,33 +360,21 @@ ossl_ocspbres_find_response(VALUE self, VALUE target) return ossl_ocspsres_new(sres_new); }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_ocspbres_initialize_copy(VALUE self, VALUE other) @@ -494,36 +395,22 @@ ossl_ocspbres_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-responses" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> responses → Array of SingleResponse </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns an Array of <a href="SingleResponse.html"><code>SingleResponse</code></a> for this <a href="BasicResponse.html"><code>BasicResponse</code></a>.</p> - - - <div class="method-source-code" id="responses-source"> <pre>static VALUE ossl_ocspbres_get_responses(VALUE self) @@ -550,48 +437,34 @@ ossl_ocspbres_get_responses(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-sign" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sign(cert, key, certs = nil, flags = 0, digest = nil) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Signs this <a href="../OCSP.html"><code>OCSP</code></a> response using the <em>cert</em>, <em>key</em> and optional <em>digest</em>. This behaves in the similar way as <a href="Request.html#method-i-sign"><code>OpenSSL::OCSP::Request#sign</code></a>.</p> <p><em>flags</em> can include:</p> <dl class="rdoc-list note-list"><dt>OpenSSL::OCSP::NOCERTS <dd> -<p>don't include certificates</p> +<p>don’t include certificates</p> </dd><dt>OpenSSL::OCSP::NOTIME <dd> -<p>don't set producedAt</p> +<p>don’t set producedAt</p> </dd><dt>OpenSSL::OCSP::RESPID_KEY <dd> -<p>use signer's public key hash as responderID</p> +<p>use signer’s public key hash as responderID</p> </dd></dl> - - - <div class="method-source-code" id="sign-source"> <pre>static VALUE ossl_ocspbres_sign(int argc, VALUE *argv, VALUE self) @@ -627,38 +500,24 @@ ossl_ocspbres_sign(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-status" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> status → statuses </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns an Array of statuses for this response. Each status contains a <a href="CertificateId.html"><code>CertificateId</code></a>, the status (0 for good, 1 for revoked, 2 for unknown), the reason for the status, the revocation time, the time of this update, the time for the next update and a list of <a href="../X509/Extension.html"><code>OpenSSL::X509::Extension</code></a>.</p> <p>This should be superseded by <a href="BasicResponse.html#method-i-responses"><code>BasicResponse#responses</code></a> and <a href="BasicResponse.html#method-i-find_response"><code>find_response</code></a> that return <a href="SingleResponse.html"><code>SingleResponse</code></a>.</p> - - - <div class="method-source-code" id="status-source"> <pre>static VALUE ossl_ocspbres_get_status(VALUE self) @@ -705,36 +564,22 @@ ossl_ocspbres_get_status(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Encodes this basic response into a DER-encoded string.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ocspbres_to_der(VALUE self) @@ -756,36 +601,22 @@ ossl_ocspbres_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-verify" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> verify(certificates, store, flags = 0) → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Verifies the signature of the response using the given <em>certificates</em> and <em>store</em>. This works in the similar way as <a href="Request.html#method-i-verify"><code>OpenSSL::OCSP::Request#verify</code></a>.</p> - - - <div class="method-source-code" id="verify-source"> <pre>static VALUE ossl_ocspbres_verify(int argc, VALUE *argv, VALUE self) @@ -857,25 +688,20 @@ ossl_ocspbres_verify(int argc, VALUE *argv, VALUE self) return result > 0 ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/OCSP/CertificateId.html b/OpenSSL/OCSP/CertificateId.html index 555ec179..f1ada8ed 100644 --- a/OpenSSL/OCSP/CertificateId.html +++ b/OpenSSL/OCSP/CertificateId.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,40 +57,30 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-cmp">#cmp</a> - <li ><a href="#method-i-cmp_issuer">#cmp_issuer</a> - <li ><a href="#method-i-hash_algorithm">#hash_algorithm</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-issuer_key_hash">#issuer_key_hash</a> - <li ><a href="#method-i-issuer_name_hash">#issuer_name_hash</a> - <li ><a href="#method-i-serial">#serial</a> - <li ><a href="#method-i-to_der">#to_der</a> - </ul> </div> @@ -110,60 +98,40 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::OCSP::CertificateId.new(subject, issuer, digest = nil) → certificate_id </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::OCSP::CertificateId.new(der_string) → certificate_id </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::OCSP::CertificateId.new(obj) → certificate_id </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="CertificateId.html"><code>OpenSSL::OCSP::CertificateId</code></a> for the given <em>subject</em> and <em>issuer</em> <a href="../X509.html"><code>X509</code></a> certificates. The <em>digest</em> is a digest algorithm that is used to compute the hash values. This defaults to SHA-1.</p> <p>If only one argument is given, decodes it as DER representation of a certificate ID or generates certificate ID from the object that responds to the <a href="CertificateId.html#method-i-to_der"><code>to_der</code></a> method.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ocspcid_initialize(int argc, VALUE *argv, VALUE self) @@ -202,44 +170,29 @@ ossl_ocspcid_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-cmp" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cmp(other) → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Compares this certificate id with <em>other</em> and returns <code>true</code> if they are the same.</p> - - - <div class="method-source-code" id="cmp-source"> <pre>static VALUE ossl_ocspcid_cmp(VALUE self, VALUE other) @@ -254,36 +207,22 @@ ossl_ocspcid_cmp(VALUE self, VALUE other) return (result == 0) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-cmp_issuer" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cmp_issuer(other) → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Compares this certificate id's issuer with <em>other</em> and returns <code>true</code> if they are the same.</p> - - + <p>Compares this certificate id’s issuer with <em>other</em> and returns <code>true</code> if they are the same.</p> - <div class="method-source-code" id="cmp_issuer-source"> <pre>static VALUE ossl_ocspcid_cmp_issuer(VALUE self, VALUE other) @@ -298,36 +237,22 @@ ossl_ocspcid_cmp_issuer(VALUE self, VALUE other) return (result == 0) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-hash_algorithm" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> hash_algorithm → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the ln (long name) of the hash algorithm used to generate the issuerNameHash and the issuerKeyHash values.</p> - - - <div class="method-source-code" id="hash_algorithm-source"> <pre>static VALUE ossl_ocspcid_get_hash_algorithm(VALUE self) @@ -349,33 +274,21 @@ ossl_ocspcid_get_hash_algorithm(VALUE self) return ossl_membio2str(out); }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_ocspcid_initialize_copy(VALUE self, VALUE other) @@ -396,36 +309,22 @@ ossl_ocspcid_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-issuer_key_hash" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> issuer_key_hash → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Returns the issuerKeyHash of this certificate ID, the hash of the issuer's public key.</p> - - + <p>Returns the issuerKeyHash of this certificate ID, the hash of the issuer’s public key.</p> - <div class="method-source-code" id="issuer_key_hash-source"> <pre>static VALUE ossl_ocspcid_get_issuer_key_hash(VALUE self) @@ -443,36 +342,22 @@ ossl_ocspcid_get_issuer_key_hash(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-issuer_name_hash" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> issuer_name_hash → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Returns the issuerNameHash of this certificate ID, the hash of the issuer's distinguished name calculated with the hashAlgorithm.</p> - - + <p>Returns the issuerNameHash of this certificate ID, the hash of the issuer’s distinguished name calculated with the hashAlgorithm.</p> - <div class="method-source-code" id="issuer_name_hash-source"> <pre>static VALUE ossl_ocspcid_get_issuer_name_hash(VALUE self) @@ -490,36 +375,22 @@ ossl_ocspcid_get_issuer_name_hash(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-serial" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> serial → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the serial number of the certificate for which status is being requested.</p> - - - <div class="method-source-code" id="serial-source"> <pre>static VALUE ossl_ocspcid_get_serial(VALUE self) @@ -533,36 +404,22 @@ ossl_ocspcid_get_serial(VALUE self) return asn1integer_to_num(serial); }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Encodes this certificate identifier into a DER-encoded string.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ocspcid_to_der(VALUE self) @@ -584,25 +441,20 @@ ossl_ocspcid_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/OCSP/OCSPError.html b/OpenSSL/OCSP/OCSPError.html index 1c06596a..c4522a6b 100644 --- a/OpenSSL/OCSP/OCSPError.html +++ b/OpenSSL/OCSP/OCSPError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/OCSP/Request.html b/OpenSSL/OCSP/Request.html index bc8fad89..0374f7c7 100644 --- a/OpenSSL/OCSP/Request.html +++ b/OpenSSL/OCSP/Request.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,42 +57,31 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-add_certid">#add_certid</a> - <li ><a href="#method-i-add_nonce">#add_nonce</a> - <li ><a href="#method-i-certid">#certid</a> - <li ><a href="#method-i-check_nonce">#check_nonce</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-sign">#sign</a> - <li ><a href="#method-i-signed-3F">#signed?</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-verify">#verify</a> - </ul> </div> @@ -112,51 +99,33 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::OCSP::Request.new → request </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::OCSP::Request.new(request_der) → request </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="Request.html"><code>OpenSSL::OCSP::Request</code></a>. The request may be created empty or from a <em>request_der</em> string.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ocspreq_initialize(int argc, VALUE *argv, VALUE self) @@ -181,44 +150,29 @@ ossl_ocspreq_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-add_certid" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add_certid(certificate_id) → request </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Adds <em>certificate_id</em> to the request.</p> - - - <div class="method-source-code" id="add_certid-source"> <pre>static VALUE ossl_ocspreq_add_certid(VALUE self, VALUE certid) @@ -239,38 +193,24 @@ ossl_ocspreq_add_certid(VALUE self, VALUE certid) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-add_nonce" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add_nonce(nonce = nil) → request </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Adds a <em>nonce</em> to the <a href="../OCSP.html"><code>OCSP</code></a> request. If no nonce is given a random one will be generated.</p> <p>The nonce is used to prevent replay attacks but some servers do not support it.</p> - - - <div class="method-source-code" id="add_nonce-source"> <pre>static VALUE ossl_ocspreq_add_nonce(int argc, VALUE *argv, VALUE self) @@ -294,36 +234,22 @@ ossl_ocspreq_add_nonce(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-certid" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> certid → [certificate_id, ...] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns all certificate IDs in this request.</p> - - - <div class="method-source-code" id="certid-source"> <pre>static VALUE ossl_ocspreq_get_certid(VALUE self) @@ -349,31 +275,20 @@ ossl_ocspreq_get_certid(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-check_nonce" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> check_nonce(response) → result </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Checks the nonce validity for this request and <em>response</em>.</p> <p>The return value is one of the following:</p> @@ -394,11 +309,8 @@ ossl_ocspreq_get_certid(VALUE self) <p>nonce present in response only.</p> </dd></dl> -<p>For most responses, clients can check <em>result</em> > 0. If a responder doesn't handle nonces <code>result.nonzero?</code> may be necessary. A result of <code>0</code> is always an error.</p> - - +<p>For most responses, clients can check <em>result</em> > 0. If a responder doesn’t handle nonces <code>result.nonzero?</code> may be necessary. A result of <code>0</code> is always an error.</p> - <div class="method-source-code" id="check_nonce-source"> <pre>static VALUE ossl_ocspreq_check_nonce(VALUE self, VALUE basic_resp) @@ -414,33 +326,21 @@ ossl_ocspreq_check_nonce(VALUE self, VALUE basic_resp) return INT2NUM(res); }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_ocspreq_initialize_copy(VALUE self, VALUE other) @@ -461,42 +361,28 @@ ossl_ocspreq_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-sign" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sign(cert, key, certs = nil, flags = 0, digest = nil) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Signs this <a href="../OCSP.html"><code>OCSP</code></a> request using <em>cert</em>, <em>key</em> and optional <em>digest</em>. If <em>digest</em> is not specified, SHA-1 is used. <em>certs</em> is an optional Array of additional certificates which are included in the request in addition to the signer certificate. Note that if <em>certs</em> is <code>nil</code> or not given, flag OpenSSL::OCSP::NOCERTS is enabled. Pass an empty array to include only the signer certificate.</p> <p><em>flags</em> is a bitwise OR of the following constants:</p> <dl class="rdoc-list note-list"><dt>OpenSSL::OCSP::NOCERTS <dd> -<p>Don't include any certificates in the request. <em>certs</em> will be ignored.</p> +<p>Don’t include any certificates in the request. <em>certs</em> will be ignored.</p> </dd></dl> - - - <div class="method-source-code" id="sign-source"> <pre>static VALUE ossl_ocspreq_sign(int argc, VALUE *argv, VALUE self) @@ -532,36 +418,22 @@ ossl_ocspreq_sign(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-signed-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> signed? → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns <code>true</code> if the request is signed, <code>false</code> otherwise. Note that the validity of the signature is <strong>not</strong> checked. Use <a href="Request.html#method-i-verify"><code>verify</code></a> to verify that.</p> - - - <div class="method-source-code" id="signed-3F-source"> <pre>static VALUE ossl_ocspreq_signed_p(VALUE self) @@ -572,33 +444,21 @@ ossl_ocspreq_signed_p(VALUE self) return OCSP_request_is_signed(req) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_der</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Returns this request as a DER-encoded string</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ocspreq_to_der(VALUE self) @@ -620,38 +480,24 @@ ossl_ocspreq_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-verify" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> verify(certificates, store, flags = 0) → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Verifies this request using the given <em>certificates</em> and <em>store</em>. <em>certificates</em> is an array of <a href="../X509/Certificate.html"><code>OpenSSL::X509::Certificate</code></a>, <em>store</em> is an <a href="../X509/Store.html"><code>OpenSSL::X509::Store</code></a>.</p> <p>Note that <code>false</code> is returned if the request does not have a signature. Use <a href="Request.html#method-i-signed-3F"><code>signed?</code></a> to check whether the request is signed or not.</p> - - - <div class="method-source-code" id="verify-source"> <pre>static VALUE ossl_ocspreq_verify(int argc, VALUE *argv, VALUE self) @@ -675,25 +521,20 @@ ossl_ocspreq_verify(int argc, VALUE *argv, VALUE self) return result > 0 ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/OCSP/Response.html b/OpenSSL/OCSP/Response.html index 1b6f80a6..d5bc8ebf 100644 --- a/OpenSSL/OCSP/Response.html +++ b/OpenSSL/OCSP/Response.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,36 +57,28 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-create">::create</a> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-basic">#basic</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-status">#status</a> - <li ><a href="#method-i-status_string">#status_string</a> - <li ><a href="#method-i-to_der">#to_der</a> - </ul> </div> @@ -106,44 +96,28 @@ </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-create" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::OCSP::Response.create(status, basic_response = nil) → response </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Creates an <a href="Response.html"><code>OpenSSL::OCSP::Response</code></a> from <em>status</em> and <em>basic_response</em>.</p> - - - <div class="method-source-code" id="create-source"> <pre>static VALUE ossl_ocspres_s_create(VALUE klass, VALUE status, VALUE basic_resp) @@ -163,43 +137,27 @@ ossl_ocspres_s_create(VALUE klass, VALUE status, VALUE basic_resp) return obj; }</pre> </div> - </div> - - </div> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::OCSP::Response.new → response </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::OCSP::Response.new(response_der) → response </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="Response.html"><code>OpenSSL::OCSP::Response</code></a>. The response may be created empty or from a <em>response_der</em> string.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ocspres_initialize(int argc, VALUE *argv, VALUE self) @@ -224,44 +182,29 @@ ossl_ocspres_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-basic" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> basic </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a <a href="BasicResponse.html"><code>BasicResponse</code></a> for this response</p> - - - <div class="method-source-code" id="basic-source"> <pre>static VALUE ossl_ocspres_get_basic(VALUE self) @@ -279,33 +222,21 @@ ossl_ocspres_get_basic(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_ocspres_initialize_copy(VALUE self, VALUE other) @@ -326,36 +257,22 @@ ossl_ocspres_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-status" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> status → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the status of the response.</p> - - - <div class="method-source-code" id="status-source"> <pre>static VALUE ossl_ocspres_status(VALUE self) @@ -369,36 +286,22 @@ ossl_ocspres_status(VALUE self) return INT2NUM(st); }</pre> </div> - </div> - - </div> - <div id="method-i-status_string" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> status_string → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a status string for the response.</p> - - - <div class="method-source-code" id="status_string-source"> <pre>static VALUE ossl_ocspres_status_string(VALUE self) @@ -412,36 +315,22 @@ ossl_ocspres_status_string(VALUE self) return rb_str_new2(OCSP_response_status_str(st)); }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns this response as a DER-encoded string.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ocspres_to_der(VALUE self) @@ -463,25 +352,20 @@ ossl_ocspres_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/OCSP/SingleResponse.html b/OpenSSL/OCSP/SingleResponse.html index f5063241..00f17e5d 100644 --- a/OpenSSL/OCSP/SingleResponse.html +++ b/OpenSSL/OCSP/SingleResponse.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,44 +57,32 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-cert_status">#cert_status</a> - <li ><a href="#method-i-certid">#certid</a> - <li ><a href="#method-i-check_validity">#check_validity</a> - <li ><a href="#method-i-extensions">#extensions</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-next_update">#next_update</a> - <li ><a href="#method-i-revocation_reason">#revocation_reason</a> - <li ><a href="#method-i-revocation_time">#revocation_time</a> - <li ><a href="#method-i-this_update">#this_update</a> - <li ><a href="#method-i-to_der">#to_der</a> - </ul> </div> @@ -114,44 +100,28 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::OCSP::SingleResponse.new(der_string) → SingleResponse </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="SingleResponse.html"><code>SingleResponse</code></a> from <em>der_string</em>.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ocspsres_initialize(VALUE self, VALUE arg) @@ -173,39 +143,27 @@ ossl_ocspsres_initialize(VALUE self, VALUE arg) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-cert_status" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cert_status → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the status of the certificate identified by the certid. The return value may be one of these constant:</p> <ul><li> <p>V_CERTSTATUS_GOOD</p> @@ -216,10 +174,7 @@ ossl_ocspsres_initialize(VALUE self, VALUE arg) </li></ul> <p>When the status is V_CERTSTATUS_REVOKED, the time at which the certificate was revoked can be retrieved by <a href="SingleResponse.html#method-i-revocation_time"><code>revocation_time</code></a>.</p> - - - <div class="method-source-code" id="cert_status-source"> <pre>static VALUE ossl_ocspsres_get_cert_status(VALUE self) @@ -235,36 +190,22 @@ ossl_ocspsres_get_cert_status(VALUE self) return INT2NUM(status); }</pre> </div> - </div> - - </div> - <div id="method-i-certid" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> certid → CertificateId </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the <a href="CertificateId.html"><code>CertificateId</code></a> for which this <a href="SingleResponse.html"><code>SingleResponse</code></a> is.</p> - - - <div class="method-source-code" id="certid-source"> <pre>static VALUE ossl_ocspsres_get_certid(VALUE self) @@ -278,40 +219,26 @@ ossl_ocspsres_get_certid(VALUE self) return ossl_ocspcertid_new(id); }</pre> </div> - </div> - - </div> - <div id="method-i-check_validity" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> check_validity(nsec = 0, maxsec = -1) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Checks the validity of thisUpdate and nextUpdate fields of this <a href="SingleResponse.html"><code>SingleResponse</code></a>. This checks the current time is within the range thisUpdate to nextUpdate.</p> <p>It is possible that the <a href="../OCSP.html"><code>OCSP</code></a> request takes a few seconds or the time is not accurate. To avoid rejecting a valid response, this method allows the times to be within <em>nsec</em> seconds of the current time.</p> -<p>Some responders don't set the nextUpdate field. This may cause a very old response to be considered valid. The <em>maxsec</em> parameter can be used to limit the age of responses.</p> - - +<p>Some responders don’t set the nextUpdate field. This may cause a very old response to be considered valid. The <em>maxsec</em> parameter can be used to limit the age of responses.</p> - <div class="method-source-code" id="check_validity-source"> <pre>static VALUE ossl_ocspsres_check_validity(int argc, VALUE *argv, VALUE self) @@ -340,36 +267,22 @@ ossl_ocspsres_check_validity(int argc, VALUE *argv, VALUE self) } }</pre> </div> - </div> - - </div> - <div id="method-i-extensions" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> extensions → Array of X509::Extension </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="extensions-source"> <pre>static VALUE ossl_ocspsres_get_extensions(VALUE self) @@ -391,33 +304,21 @@ ossl_ocspsres_get_extensions(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_ocspsres_initialize_copy(VALUE self, VALUE other) @@ -438,36 +339,22 @@ ossl_ocspsres_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-next_update" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> next_update → Time | nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="next_update-source"> <pre>static VALUE ossl_ocspsres_get_next_update(VALUE self) @@ -486,36 +373,22 @@ ossl_ocspsres_get_next_update(VALUE self) return asn1time_to_time(time); }</pre> </div> - </div> - - </div> - <div id="method-i-revocation_reason" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> revocation_reason → Integer | nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="revocation_reason-source"> <pre>static VALUE ossl_ocspsres_get_revocation_reason(VALUE self) @@ -533,36 +406,22 @@ ossl_ocspsres_get_revocation_reason(VALUE self) return INT2NUM(reason); }</pre> </div> - </div> - - </div> - <div id="method-i-revocation_time" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> revocation_time → Time | nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="revocation_time-source"> <pre>static VALUE ossl_ocspsres_get_revocation_time(VALUE self) @@ -583,36 +442,22 @@ ossl_ocspsres_get_revocation_time(VALUE self) return asn1time_to_time(time); }</pre> </div> - </div> - - </div> - <div id="method-i-this_update" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> this_update → Time </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="this_update-source"> <pre>static VALUE ossl_ocspsres_get_this_update(VALUE self) @@ -631,36 +476,22 @@ ossl_ocspsres_get_this_update(VALUE self) return asn1time_to_time(time); }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Encodes this <a href="SingleResponse.html"><code>SingleResponse</code></a> into a DER-encoded string.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ocspsres_to_der(VALUE self) @@ -682,25 +513,20 @@ ossl_ocspsres_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/OpenSSLError.html b/OpenSSL/OpenSSLError.html index 89d8db67..ec9a9aad 100644 --- a/OpenSSL/OpenSSLError.html +++ b/OpenSSL/OpenSSLError.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">StandardError - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/PKCS12.html b/OpenSSL/PKCS12.html index 72b60a06..efa7c490 100644 --- a/OpenSSL/PKCS12.html +++ b/OpenSSL/PKCS12.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,30 +57,25 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-create">::create</a> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-to_der">#to_der</a> - </ul> </div> @@ -100,21 +93,15 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-ca_certs" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">ca_certs</span><span @@ -123,11 +110,8 @@ <div class="method-description"> - - </div> </div> - <div id="attribute-i-certificate" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">certificate</span><span @@ -136,11 +120,8 @@ <div class="method-description"> - - </div> </div> - <div id="attribute-i-key" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">key</span><span @@ -149,37 +130,25 @@ <div class="method-description"> - - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-create" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> create(pass, name, key, cert [, ca, [, key_pbe [, cert_pbe [, key_iter [, mac_iter [, keytype]]]]]]) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <h3 id="method-c-create-label-Parameters">Parameters<span><a href="#method-c-create-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> <ul><li> <p><em>pass</em> - string</p> @@ -195,7 +164,7 @@ <p>The not_before and not_after fields must be filled in.</p> </li></ul> </li><li> -<p><em>ca</em> - An optional array of X509::Certificate's.</p> +<p><em>ca</em> - An optional array of X509::Certificate’s.</p> </li><li> <p><em>key_pbe</em> - string</p> </li><li> @@ -211,10 +180,7 @@ <p>Any optional arguments may be supplied as <code>nil</code> to preserve the <a href="../OpenSSL.html"><code>OpenSSL</code></a> defaults.</p> <p>See the <a href="../OpenSSL.html"><code>OpenSSL</code></a> documentation for PKCS12_create().</p> - - - <div class="method-source-code" id="create-source"> <pre>static VALUE ossl_pkcs12_s_create(int argc, VALUE *argv, VALUE self) @@ -264,55 +230,37 @@ ossl_pkcs12_s_create(int argc, VALUE *argv, VALUE self) return obj; }</pre> </div> - </div> - - </div> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new → pkcs12 </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(str) → pkcs12 </span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(str, pass) → pkcs12 </span> - </div> - - <div class="method-description"> - <h3 id="method-c-new-label-Parameters">Parameters<span><a href="#method-c-new-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> <ul><li> <p><em>str</em> - Must be a DER encoded <a href="PKCS12.html"><code>PKCS12</code></a> string.</p> </li><li> <p><em>pass</em> - string</p> </li></ul> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_pkcs12_initialize(int argc, VALUE *argv, VALUE self) @@ -364,41 +312,28 @@ ossl_pkcs12_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_pkcs12_initialize_copy(VALUE self, VALUE other) @@ -419,33 +354,21 @@ ossl_pkcs12_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_der</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_pkcs12_to_der(VALUE self) @@ -467,25 +390,20 @@ ossl_pkcs12_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKCS12/PKCS12Error.html b/OpenSSL/PKCS12/PKCS12Error.html index 466aa849..d2d41751 100644 --- a/OpenSSL/PKCS12/PKCS12Error.html +++ b/OpenSSL/PKCS12/PKCS12Error.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/PKCS5.html b/OpenSSL/PKCS5.html index 957d18d4..f2c04ec4 100644 --- a/OpenSSL/PKCS5.html +++ b/OpenSSL/PKCS5.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -62,16 +60,14 @@ - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-i-pbkdf2_hmac">#pbkdf2_hmac</a> - <li ><a href="#method-i-pbkdf2_hmac_sha1">#pbkdf2_hmac_sha1</a> - </ul> </div> @@ -87,41 +83,27 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-pbkdf2_hmac" class="method-detail "> - <div class="method-heading"> <span class="method-name">pbkdf2_hmac</span><span class="method-args">(pass, salt, iter, keylen, digest)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p><a href="PKCS5.html#method-i-pbkdf2_hmac"><code>OpenSSL::PKCS5.pbkdf2_hmac</code></a> has been renamed to <a href="KDF.html#method-c-pbkdf2_hmac"><code>OpenSSL::KDF.pbkdf2_hmac</code></a>. This method is provided for backwards compatibility.</p> - - - <div class="method-source-code" id="pbkdf2_hmac-source"> <pre><span class="ruby-comment"># File lib/openssl/pkcs5.rb, line 13</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pbkdf2_hmac</span>(<span class="ruby-identifier">pass</span>, <span class="ruby-identifier">salt</span>, <span class="ruby-identifier">iter</span>, <span class="ruby-identifier">keylen</span>, <span class="ruby-identifier">digest</span>) @@ -129,58 +111,41 @@ <span class="ruby-value">length:</span> <span class="ruby-identifier">keylen</span>, <span class="ruby-value">hash:</span> <span class="ruby-identifier">digest</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-pbkdf2_hmac_sha1" class="method-detail "> - <div class="method-heading"> <span class="method-name">pbkdf2_hmac_sha1</span><span class="method-args">(pass, salt, iter, keylen)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="pbkdf2_hmac_sha1-source"> <pre><span class="ruby-comment"># File lib/openssl/pkcs5.rb, line 18</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pbkdf2_hmac_sha1</span>(<span class="ruby-identifier">pass</span>, <span class="ruby-identifier">salt</span>, <span class="ruby-identifier">iter</span>, <span class="ruby-identifier">keylen</span>) <span class="ruby-identifier">pbkdf2_hmac</span>(<span class="ruby-identifier">pass</span>, <span class="ruby-identifier">salt</span>, <span class="ruby-identifier">iter</span>, <span class="ruby-identifier">keylen</span>, <span class="ruby-string">"sha1"</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKCS7.html b/OpenSSL/PKCS7.html index 8eedb6d1..fd87f715 100644 --- a/OpenSSL/PKCS7.html +++ b/OpenSSL/PKCS7.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,80 +57,50 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-encrypt">::encrypt</a> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-c-read_smime">::read_smime</a> - <li ><a href="#method-c-sign">::sign</a> - <li ><a href="#method-c-write_smime">::write_smime</a> - <li ><a href="#method-i-add_certificate">#add_certificate</a> - <li ><a href="#method-i-add_crl">#add_crl</a> - <li ><a href="#method-i-add_data">#add_data</a> - <li ><a href="#method-i-add_recipient">#add_recipient</a> - <li ><a href="#method-i-add_signer">#add_signer</a> - <li ><a href="#method-i-certificates">#certificates</a> - <li ><a href="#method-i-certificates-3D">#certificates=</a> - <li ><a href="#method-i-cipher-3D">#cipher=</a> - <li ><a href="#method-i-crls">#crls</a> - <li ><a href="#method-i-crls-3D">#crls=</a> - <li ><a href="#method-i-data-3D">#data=</a> - <li ><a href="#method-i-decrypt">#decrypt</a> - <li ><a href="#method-i-detached">#detached</a> - <li ><a href="#method-i-detached-3D">#detached=</a> - <li ><a href="#method-i-detached-3F">#detached?</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-recipients">#recipients</a> - <li ><a href="#method-i-signers">#signers</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-type">#type</a> - <li ><a href="#method-i-type-3D">#type=</a> - <li ><a href="#method-i-verify">#verify</a> - </ul> </div> @@ -148,35 +116,24 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="Signer">Signer - <dd> - - </dl> </section> - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-data" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">data</span><span @@ -185,11 +142,8 @@ <div class="method-description"> - - </div> </div> - <div id="attribute-i-error_string" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">error_string</span><span @@ -198,42 +152,27 @@ <div class="method-description"> - - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-encrypt" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> encrypt(certs, data, [, cipher [, flags]]) → pkcs7 </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="encrypt-source"> <pre>static VALUE ossl_pkcs7_s_encrypt(int argc, VALUE *argv, VALUE klass) @@ -283,43 +222,27 @@ ossl_pkcs7_s_encrypt(int argc, VALUE *argv, VALUE klass) return ret; }</pre> </div> - </div> - - </div> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new → pkcs7 </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(string) → pkcs7 </span> - </div> - - <div class="method-description"> - - <p>Many methods in this class aren't documented.</p> - - + <p>Many methods in this class aren’t documented.</p> - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_pkcs7_initialize(int argc, VALUE *argv, VALUE self) @@ -351,36 +274,22 @@ ossl_pkcs7_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-c-read_smime" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> read_smime(string) → pkcs7 </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="read_smime-source"> <pre>static VALUE ossl_pkcs7_s_read_smime(VALUE klass, VALUE arg) @@ -403,36 +312,22 @@ ossl_pkcs7_s_read_smime(VALUE klass, VALUE arg) return ret; }</pre> </div> - </div> - - </div> - <div id="method-c-sign" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sign(cert, key, data, [, certs [, flags]]) → pkcs7 </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="sign-source"> <pre>static VALUE ossl_pkcs7_s_sign(int argc, VALUE *argv, VALUE klass) @@ -474,36 +369,22 @@ ossl_pkcs7_s_sign(int argc, VALUE *argv, VALUE klass) return ret; }</pre> </div> - </div> - - </div> - <div id="method-c-write_smime" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> write_smime(pkcs7 [, data [, flags]]) → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="write_smime-source"> <pre>static VALUE ossl_pkcs7_s_write_smime(int argc, VALUE *argv, VALUE klass) @@ -536,41 +417,28 @@ ossl_pkcs7_s_write_smime(int argc, VALUE *argv, VALUE klass) return str; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-add_certificate" class="method-detail "> - <div class="method-heading"> <span class="method-name">add_certificate</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="add_certificate-source"> <pre>static VALUE ossl_pkcs7_add_certificate(VALUE self, VALUE cert) @@ -587,33 +455,21 @@ ossl_pkcs7_add_certificate(VALUE self, VALUE cert) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-add_crl" class="method-detail "> - <div class="method-heading"> <span class="method-name">add_crl</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="add_crl-source"> <pre>static VALUE ossl_pkcs7_add_crl(VALUE self, VALUE crl) @@ -630,33 +486,21 @@ ossl_pkcs7_add_crl(VALUE self, VALUE crl) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-add_data" class="method-detail "> - <div class="method-heading"> <span class="method-name">add_data</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="add_data-source"> <pre>static VALUE ossl_pkcs7_add_data(VALUE self, VALUE data) @@ -692,37 +536,24 @@ ossl_pkcs7_add_data(VALUE self, VALUE data) return data; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="PKCS7.html#method-i-data-3D">data=</a> </div> - - </div> - <div id="method-i-add_recipient" class="method-detail "> - <div class="method-heading"> <span class="method-name">add_recipient</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="add_recipient-source"> <pre>static VALUE ossl_pkcs7_add_recipient(VALUE self, VALUE recip) @@ -740,33 +571,21 @@ ossl_pkcs7_add_recipient(VALUE self, VALUE recip) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-add_signer" class="method-detail "> - <div class="method-heading"> <span class="method-name">add_signer</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="add_signer-source"> <pre>static VALUE ossl_pkcs7_add_signer(VALUE self, VALUE signer) @@ -788,33 +607,21 @@ ossl_pkcs7_add_signer(VALUE self, VALUE signer) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-certificates" class="method-detail "> - <div class="method-heading"> <span class="method-name">certificates</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="certificates-source"> <pre>static VALUE ossl_pkcs7_get_certificates(VALUE self) @@ -822,33 +629,21 @@ ossl_pkcs7_get_certificates(VALUE self) return ossl_x509_sk2ary(pkcs7_get_certs(self)); }</pre> </div> - </div> - - </div> - <div id="method-i-certificates-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">certificates=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="certificates-3D-source"> <pre>static VALUE ossl_pkcs7_set_certificates(VALUE self, VALUE ary) @@ -863,33 +658,21 @@ ossl_pkcs7_set_certificates(VALUE self, VALUE ary) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-cipher-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">cipher=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="cipher-3D-source"> <pre>static VALUE ossl_pkcs7_set_cipher(VALUE self, VALUE cipher) @@ -904,33 +687,21 @@ ossl_pkcs7_set_cipher(VALUE self, VALUE cipher) return cipher; }</pre> </div> - </div> - - </div> - <div id="method-i-crls" class="method-detail "> - <div class="method-heading"> <span class="method-name">crls</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="crls-source"> <pre>static VALUE ossl_pkcs7_get_crls(VALUE self) @@ -938,33 +709,21 @@ ossl_pkcs7_get_crls(VALUE self) return ossl_x509crl_sk2ary(pkcs7_get_crls(self)); }</pre> </div> - </div> - - </div> - <div id="method-i-crls-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">crls=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="crls-3D-source"> <pre>static VALUE ossl_pkcs7_set_crls(VALUE self, VALUE ary) @@ -979,61 +738,38 @@ ossl_pkcs7_set_crls(VALUE self, VALUE ary) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-data-3D" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">data=</span><span class="method-args">(p1)</span> - </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="PKCS7.html#method-i-add_data">add_data</a> </div> - </div> - <div id="method-i-decrypt" class="method-detail "> - <div class="method-heading"> <span class="method-name">decrypt</span><span class="method-args">(p1, p2 = v2, p3 = v3)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="decrypt-source"> <pre>static VALUE ossl_pkcs7_decrypt(int argc, VALUE *argv, VALUE self) @@ -1062,33 +798,21 @@ ossl_pkcs7_decrypt(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-detached" class="method-detail "> - <div class="method-heading"> <span class="method-name">detached</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="detached-source"> <pre>static VALUE ossl_pkcs7_get_detached(VALUE self) @@ -1098,33 +822,21 @@ ossl_pkcs7_get_detached(VALUE self) return PKCS7_get_detached(p7) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-detached-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">detached=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="detached-3D-source"> <pre>static VALUE ossl_pkcs7_set_detached(VALUE self, VALUE flag) @@ -1140,33 +852,21 @@ ossl_pkcs7_set_detached(VALUE self, VALUE flag) return flag; }</pre> </div> - </div> - - </div> - <div id="method-i-detached-3F" class="method-detail "> - <div class="method-heading"> <span class="method-name">detached?</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="detached-3F-source"> <pre>static VALUE ossl_pkcs7_detached_p(VALUE self) @@ -1176,33 +876,21 @@ ossl_pkcs7_detached_p(VALUE self) return PKCS7_is_detached(p7) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_pkcs7_copy(VALUE self, VALUE other) @@ -1225,33 +913,21 @@ ossl_pkcs7_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-recipients" class="method-detail "> - <div class="method-heading"> <span class="method-name">recipients</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="recipients-source"> <pre>static VALUE ossl_pkcs7_get_recipient(VALUE self) @@ -1281,33 +957,21 @@ ossl_pkcs7_get_recipient(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-signers" class="method-detail "> - <div class="method-heading"> <span class="method-name">signers</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="signers-source"> <pre>static VALUE ossl_pkcs7_get_signer(VALUE self) @@ -1335,33 +999,21 @@ ossl_pkcs7_get_signer(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_der</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_pkcs7_to_der(VALUE self) @@ -1383,33 +1035,21 @@ ossl_pkcs7_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_pem</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_pem-source"> <pre>static VALUE ossl_pkcs7_to_pem(VALUE self) @@ -1431,68 +1071,42 @@ ossl_pkcs7_to_pem(VALUE self) return str; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="PKCS7.html#method-i-to_s">to_s</a> </div> - - </div> - <div id="method-i-to_s" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">to_s</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="PKCS7.html#method-i-to_pem">to_pem</a> </div> - </div> - <div id="method-i-type" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> type → string or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="type-source"> <pre>static VALUE ossl_pkcs7_get_type(VALUE self) @@ -1513,36 +1127,22 @@ ossl_pkcs7_get_type(VALUE self) return Qnil; }</pre> </div> - </div> - - </div> - <div id="method-i-type-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> type = type → type </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="type-3D-source"> <pre>static VALUE ossl_pkcs7_set_type(VALUE self, VALUE type) @@ -1556,33 +1156,21 @@ ossl_pkcs7_set_type(VALUE self, VALUE type) return type; }</pre> </div> - </div> - - </div> - <div id="method-i-verify" class="method-detail "> - <div class="method-heading"> <span class="method-name">verify</span><span class="method-args">(p1, p2, p3 = v3, p4 = v4)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="verify-source"> <pre>static VALUE ossl_pkcs7_verify(int argc, VALUE *argv, VALUE self) @@ -1628,25 +1216,20 @@ ossl_pkcs7_verify(int argc, VALUE *argv, VALUE self) return (ok == 1) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKCS7/PKCS7Error.html b/OpenSSL/PKCS7/PKCS7Error.html index a894e532..66595096 100644 --- a/OpenSSL/PKCS7/PKCS7Error.html +++ b/OpenSSL/PKCS7/PKCS7Error.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/PKCS7/RecipientInfo.html b/OpenSSL/PKCS7/RecipientInfo.html index d02df5bb..179e9752 100644 --- a/OpenSSL/PKCS7/RecipientInfo.html +++ b/OpenSSL/PKCS7/RecipientInfo.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,30 +57,25 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-enc_key">#enc_key</a> - <li ><a href="#method-i-issuer">#issuer</a> - <li ><a href="#method-i-serial">#serial</a> - </ul> </div> @@ -98,41 +91,27 @@ </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-new" class="method-detail "> - <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_pkcs7ri_initialize(VALUE self, VALUE cert) @@ -149,41 +128,28 @@ ossl_pkcs7ri_initialize(VALUE self, VALUE cert) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-enc_key" class="method-detail "> - <div class="method-heading"> <span class="method-name">enc_key</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="enc_key-source"> <pre>static VALUE ossl_pkcs7ri_get_enc_key(VALUE self) @@ -195,33 +161,21 @@ ossl_pkcs7ri_get_enc_key(VALUE self) return asn1str_to_str(p7ri->enc_key); }</pre> </div> - </div> - - </div> - <div id="method-i-issuer" class="method-detail "> - <div class="method-heading"> <span class="method-name">issuer</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="issuer-source"> <pre>static VALUE ossl_pkcs7ri_get_issuer(VALUE self) @@ -233,33 +187,21 @@ ossl_pkcs7ri_get_issuer(VALUE self) return ossl_x509name_new(p7ri->issuer_and_serial->issuer); }</pre> </div> - </div> - - </div> - <div id="method-i-serial" class="method-detail "> - <div class="method-heading"> <span class="method-name">serial</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="serial-source"> <pre>static VALUE ossl_pkcs7ri_get_serial(VALUE self) @@ -271,25 +213,20 @@ ossl_pkcs7ri_get_serial(VALUE self) return asn1integer_to_num(p7ri->issuer_and_serial->serial); }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKCS7/SignerInfo.html b/OpenSSL/PKCS7/SignerInfo.html index d0fecc42..3962c5d8 100644 --- a/OpenSSL/PKCS7/SignerInfo.html +++ b/OpenSSL/PKCS7/SignerInfo.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,30 +57,25 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-issuer">#issuer</a> - <li ><a href="#method-i-serial">#serial</a> - <li ><a href="#method-i-signed_time">#signed_time</a> - </ul> </div> @@ -98,41 +91,27 @@ </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-new" class="method-detail "> - <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(p1, p2, p3)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_pkcs7si_initialize(VALUE self, VALUE cert, VALUE key, VALUE digest) @@ -153,41 +132,28 @@ ossl_pkcs7si_initialize(VALUE self, VALUE cert, VALUE key, VALUE digest) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-issuer" class="method-detail "> - <div class="method-heading"> <span class="method-name">issuer</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="issuer-source"> <pre>static VALUE ossl_pkcs7si_get_issuer(VALUE self) @@ -199,33 +165,21 @@ ossl_pkcs7si_get_issuer(VALUE self) return ossl_x509name_new(p7si->issuer_and_serial->issuer); }</pre> </div> - </div> - - </div> - <div id="method-i-serial" class="method-detail "> - <div class="method-heading"> <span class="method-name">serial</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="serial-source"> <pre>static VALUE ossl_pkcs7si_get_serial(VALUE self) @@ -237,33 +191,21 @@ ossl_pkcs7si_get_serial(VALUE self) return asn1integer_to_num(p7si->issuer_and_serial->serial); }</pre> </div> - </div> - - </div> - <div id="method-i-signed_time" class="method-detail "> - <div class="method-heading"> <span class="method-name">signed_time</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="signed_time-source"> <pre>static VALUE ossl_pkcs7si_get_signed_time(VALUE self) @@ -288,25 +230,20 @@ ossl_pkcs7si_get_signed_time(VALUE self) return Qnil; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKey.html b/OpenSSL/PKey.html index 5846d22b..8f37129d 100644 --- a/OpenSSL/PKey.html +++ b/OpenSSL/PKey.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -71,14 +69,13 @@ - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-read">::read</a> - </ul> </div> @@ -96,9 +93,9 @@ <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>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>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> @@ -117,46 +114,31 @@ </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-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> @@ -167,10 +149,7 @@ </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) @@ -207,25 +186,20 @@ ok: return ossl_pkey_new(pkey); }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKey/DH.html b/OpenSSL/PKey/DH.html index bcccd54e..fac868df 100644 --- a/OpenSSL/PKey/DH.html +++ b/OpenSSL/PKey/DH.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -68,67 +66,46 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="PKey.html">OpenSSL::PKey::PKey</a> - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../Marshal.html">OpenSSL::Marshal</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- 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">::generate</a> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-compute_key">#compute_key</a> - <li ><a href="#method-i-export">#export</a> - <li ><a href="#method-i-generate_key-21">#generate_key!</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-params">#params</a> - <li ><a href="#method-i-params_ok-3F">#params_ok?</a> - <li ><a href="#method-i-private-3F">#private?</a> - <li ><a href="#method-i-public-3F">#public?</a> - <li ><a href="#method-i-public_key">#public_key</a> - <li ><a href="#method-i-set_key">#set_key</a> - <li ><a href="#method-i-set_pqg">#set_pqg</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-to_text">#to_text</a> - </ul> </div> @@ -173,39 +150,26 @@ </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" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> generate(size [, generator]) → dh </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="DH.html"><code>DH</code></a> instance from scratch by generating the private and public components alike.</p> <h3 id="method-c-generate-label-Parameters">Parameters<span><a href="#method-c-generate-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> @@ -214,10 +178,7 @@ </li><li> <p><em>generator</em> is a small number > 1, typically 2 or 5.</p> </li></ul> - - - <div class="method-source-code" id="generate-source"> <pre>static VALUE ossl_dh_s_generate(int argc, VALUE *argv, VALUE klass) @@ -239,45 +200,30 @@ ossl_dh_s_generate(int argc, VALUE *argv, VALUE klass) return obj; }</pre> </div> - </div> - - </div> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new → dh </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(string) → dh </span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(size [, generator]) → dh </span> - </div> - - <div class="method-description"> - <p>Either generates a <a href="DH.html"><code>DH</code></a> instance from scratch or by reading already existing <a href="DH.html"><code>DH</code></a> parameters from <em>string</em>. Note that when reading a <a href="DH.html"><code>DH</code></a> instance from data that was encoded from a <a href="DH.html"><code>DH</code></a> instance by using <a href="DH.html#method-i-to_pem"><code>DH#to_pem</code></a> or <a href="DH.html#method-i-to_der"><code>DH#to_der</code></a> the result will <strong>not</strong> contain a public/private key pair yet. This needs to be generated using <a href="DH.html#method-i-generate_key-21"><code>DH#generate_key!</code></a> first.</p> <h3 id="method-c-new-label-Parameters">Parameters<span><a href="#method-c-new-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> @@ -298,10 +244,7 @@ ossl_dh_s_generate(int argc, VALUE *argv, VALUE klass) <span class="ruby-identifier">dh</span> = <span class="ruby-constant">DH</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-string">'parameters.pem'</span>)) <span class="ruby-comment"># -> dh, but no public/private key yet</span> <span class="ruby-identifier">dh</span>.<span class="ruby-identifier">generate_key!</span> <span class="ruby-comment"># -> dh with public and private key</span> </pre> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_dh_initialize(int argc, VALUE *argv, VALUE self) @@ -344,49 +287,34 @@ ossl_dh_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-compute_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> compute_key(pub_bn) → aString </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Returns a String containing a shared secret computed from the other party's public value. See DH_compute_key() for further information.</p> + <p>Returns a String containing a shared secret computed from the other party’s public value. See DH_compute_key() for further information.</p> <h3 id="method-i-compute_key-label-Parameters">Parameters<span><a href="#method-i-compute_key-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> <ul><li> <p><em>pub_bn</em> is a <a href="../BN.html"><code>OpenSSL::BN</code></a>, <strong>not</strong> the <a href="DH.html"><code>DH</code></a> instance returned by <a href="DH.html#method-i-public_key"><code>DH#public_key</code></a> as that contains the <a href="DH.html"><code>DH</code></a> parameters only.</p> </li></ul> - - - <div class="method-source-code" id="compute_key-source"> <pre>static VALUE ossl_dh_compute_key(VALUE self, VALUE pub) @@ -411,50 +339,22 @@ ossl_dh_compute_key(VALUE self, VALUE pub) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-export" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> export → aString </span> - <span class="method-click-advice">click to toggle source</span> - - </div> - - <div class="method-heading"> - <span class="method-callseq"> - to_pem → aString - </span> - </div> - - <div class="method-heading"> - <span class="method-callseq"> - to_s → aString - </span> - - </div> - - <div class="method-description"> - <p>Encodes this <a href="DH.html"><code>DH</code></a> to its PEM encoding. Note that any existing per-session public/private keys will <strong>not</strong> get encoded, just the Diffie-Hellman parameters will be encoded.</p> - - - <div class="method-source-code" id="export-source"> <pre>static VALUE ossl_dh_export(VALUE self) @@ -476,35 +376,23 @@ ossl_dh_export(VALUE self) return str; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="DH.html#method-i-to_pem">to_pem</a>, <a href="DH.html#method-i-to_s">to_s</a> </div> - - </div> - <div id="method-i-generate_key-21" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> generate_key! → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Generates a private and public key unless a private key already exists. If this <a href="DH.html"><code>DH</code></a> instance was generated from public <a href="DH.html"><code>DH</code></a> parameters (e.g. by encoding the result of <a href="DH.html#method-i-public_key"><code>DH#public_key</code></a>), then this method needs to be called first in order to generate the per-session keys before performing the actual key exchange.</p> <h3 id="method-i-generate_key-21-label-Example">Example<span><a href="#method-i-generate_key-21-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -514,10 +402,7 @@ ossl_dh_export(VALUE self) <span class="ruby-identifier">public_key</span>.<span class="ruby-identifier">generate_key!</span> <span class="ruby-identifier">puts</span> <span class="ruby-identifier">public_key</span>.<span class="ruby-identifier">private?</span> <span class="ruby-comment"># => true</span> </pre> - - - <div class="method-source-code" id="generate_key-21-source"> <pre>static VALUE ossl_dh_generate_key(VALUE self) @@ -530,33 +415,21 @@ ossl_dh_generate_key(VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_dh_initialize_copy(VALUE self, VALUE other) @@ -591,36 +464,22 @@ ossl_dh_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-params" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> params → hash </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Stores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you)</p> - - + <p>Stores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don’t use :-)) (I’s up to you)</p> - <div class="method-source-code" id="params-source"> <pre>static VALUE ossl_dh_get_params(VALUE self) @@ -643,36 +502,22 @@ ossl_dh_get_params(VALUE self) return hash; }</pre> </div> - </div> - - </div> - <div id="method-i-params_ok-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> params_ok? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Validates the Diffie-Hellman parameters associated with this instance. It checks whether a safe prime and a suitable generator are used. If this is not the case, <code>false</code> is returned.</p> - - - <div class="method-source-code" id="params_ok-3F-source"> <pre>static VALUE ossl_dh_check_params(VALUE self) @@ -688,36 +533,22 @@ ossl_dh_check_params(VALUE self) return codes == 0 ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-private-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> private? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Indicates whether this <a href="DH.html"><code>DH</code></a> instance has a private key associated with it or not. The private key may be retrieved with DH#priv_key.</p> - - - <div class="method-source-code" id="private-3F-source"> <pre>static VALUE ossl_dh_is_private(VALUE self) @@ -735,36 +566,22 @@ ossl_dh_is_private(VALUE self) #endif }</pre> </div> - </div> - - </div> - <div id="method-i-public-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Indicates whether this <a href="DH.html"><code>DH</code></a> instance has a public key associated with it or not. The public key may be retrieved with DH#pub_key.</p> - - - <div class="method-source-code" id="public-3F-source"> <pre>static VALUE ossl_dh_is_public(VALUE self) @@ -778,31 +595,20 @@ ossl_dh_is_public(VALUE self) return bn ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-public_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_key → aDH </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a new <a href="DH.html"><code>DH</code></a> instance that carries just the public information, i.e. the prime <em>p</em> and the generator <em>g</em>, but no public/private key yet. Such a pair may be generated using <a href="DH.html#method-i-generate_key-21"><code>DH#generate_key!</code></a>. The “public key” needed for a key exchange with <a href="DH.html#method-i-compute_key"><code>DH#compute_key</code></a> is considered as per-session information and may be retrieved with DH#pub_key once a key pair has been generated. If the current instance already contains private information (and thus a valid public/private key pair), this information will no longer be present in the new instance generated by <a href="DH.html#method-i-public_key"><code>DH#public_key</code></a>. This feature is helpful for publishing the Diffie-Hellman parameters without leaking any of the private per-session information.</p> <h3 id="method-i-public_key-label-Example">Example<span><a href="#method-i-public_key-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -811,10 +617,7 @@ ossl_dh_is_public(VALUE self) <span class="ruby-identifier">public_key</span> = <span class="ruby-identifier">dh</span>.<span class="ruby-identifier">public_key</span> <span class="ruby-comment"># contains only prime and generator</span> <span class="ruby-identifier">parameters</span> = <span class="ruby-identifier">public_key</span>.<span class="ruby-identifier">to_der</span> <span class="ruby-comment"># it's safe to publish this</span> </pre> - - - <div class="method-source-code" id="public_key-source"> <pre>static VALUE ossl_dh_to_public_key(VALUE self) @@ -833,90 +636,52 @@ ossl_dh_to_public_key(VALUE self) return obj; }</pre> </div> - </div> - - </div> - <div id="method-i-set_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_key(pub_key, priv_key) → self </span> - </div> - - <div class="method-description"> - <p>Sets <em>pub_key</em> and <em>priv_key</em> for the <a href="DH.html"><code>DH</code></a> instance. <em>priv_key</em> may be <code>nil</code>.</p> - - - </div> - - </div> - <div id="method-i-set_pqg" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_pqg(p, q, g) → self </span> - </div> - - <div class="method-description"> - <p>Sets <em>p</em>, <em>q</em>, <em>g</em> to the <a href="DH.html"><code>DH</code></a> instance.</p> - - - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → aString </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Encodes this <a href="DH.html"><code>DH</code></a> to its DER encoding. Note that any existing per-session public/private keys will <strong>not</strong> get encoded, just the Diffie-Hellman parameters will be encoded.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_dh_to_der(VALUE self) @@ -938,92 +703,58 @@ ossl_dh_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">to_pem</span><span - class="method-args">()</span> - + <span class="method-callseq"> + to_pem → aString + </span> </div> - <div class="method-description"> - - - - + <p>Encodes this <a href="DH.html"><code>DH</code></a> to its PEM encoding. Note that any existing per-session public/private keys will <strong>not</strong> get encoded, just the Diffie-Hellman parameters will be encoded.</p> - </div> - - <div class="aliases"> Alias for: <a href="DH.html#method-i-export">export</a> </div> - </div> - <div id="method-i-to_s" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">to_s</span><span - class="method-args">()</span> - + <span class="method-callseq"> + to_s → aString + </span> </div> - <div class="method-description"> - - - - + <p>Encodes this <a href="DH.html"><code>DH</code></a> to its PEM encoding. Note that any existing per-session public/private keys will <strong>not</strong> get encoded, just the Diffie-Hellman parameters will be encoded.</p> - </div> - - <div class="aliases"> Alias for: <a href="DH.html#method-i-export">export</a> </div> - </div> - <div id="method-i-to_text" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_text → aString </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Prints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you)</p> - - + <p>Prints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don’t use :-)) (I’s up to you)</p> - <div class="method-source-code" id="to_text-source"> <pre>static VALUE ossl_dh_to_text(VALUE self) @@ -1045,25 +776,20 @@ ossl_dh_to_text(VALUE self) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKey/DHError.html b/OpenSSL/PKey/DHError.html index 2724f5db..6edaf61e 100644 --- a/OpenSSL/PKey/DHError.html +++ b/OpenSSL/PKey/DHError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="PKeyError.html">OpenSSL::PKey::PKeyError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/PKey/DSA.html b/OpenSSL/PKey/DSA.html index f546b00e..7a64485f 100644 --- a/OpenSSL/PKey/DSA.html +++ b/OpenSSL/PKey/DSA.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,65 +57,45 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="PKey.html">OpenSSL::PKey::PKey</a> - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../Marshal.html">OpenSSL::Marshal</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- 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">::generate</a> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-export">#export</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-params">#params</a> - <li ><a href="#method-i-private-3F">#private?</a> - <li ><a href="#method-i-public-3F">#public?</a> - <li ><a href="#method-i-public_key">#public_key</a> - <li ><a href="#method-i-set_key">#set_key</a> - <li ><a href="#method-i-set_pqg">#set_pqg</a> - <li ><a href="#method-i-syssign">#syssign</a> - <li ><a href="#method-i-sysverify">#sysverify</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-to_text">#to_text</a> - </ul> </div> @@ -131,53 +109,37 @@ <section class="description"> -<p><a href="DSA.html"><code>DSA</code></a>, the Digital Signature Algorithm, is specified in NIST's FIPS 186-3. It is an asymmetric public key algorithm that may be used similar to e.g. <a href="RSA.html"><code>RSA</code></a>.</p> +<p><a href="DSA.html"><code>DSA</code></a>, the Digital Signature Algorithm, is specified in NIST’s FIPS 186-3. It is an asymmetric public key algorithm that may be used similar to e.g. <a href="RSA.html"><code>RSA</code></a>.</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" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> generate(size) → dsa </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="DSA.html"><code>DSA</code></a> instance by generating a private/public key pair from scratch.</p> <h3 id="method-c-generate-label-Parameters">Parameters<span><a href="#method-c-generate-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> <ul><li> <p><em>size</em> is an integer representing the desired key size.</p> </li></ul> - - - <div class="method-source-code" id="generate-source"> <pre>static VALUE ossl_dsa_s_generate(VALUE klass, VALUE size) @@ -193,45 +155,30 @@ ossl_dsa_s_generate(VALUE klass, VALUE size) return obj; }</pre> </div> - </div> - - </div> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new → dsa </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(size) → dsa </span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(string [, pass]) → dsa </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="DSA.html"><code>DSA</code></a> instance by reading an existing key from <em>string</em>.</p> <h3 id="method-c-new-label-Parameters">Parameters<span><a href="#method-c-new-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> @@ -249,10 +196,7 @@ ossl_dsa_s_generate(VALUE klass, VALUE size) DSA.new(1024) -> dsa DSA.new(File.read('dsa.pem')) -> dsa DSA.new(File.read('dsa.pem'), 'mypassword') -> dsa</pre> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_dsa_initialize(int argc, VALUE *argv, VALUE self) @@ -309,53 +253,27 @@ ossl_dsa_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-export" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> export([cipher, password]) → aString </span> - <span class="method-click-advice">click to toggle source</span> - - </div> - - <div class="method-heading"> - <span class="method-callseq"> - to_pem([cipher, password]) → aString - </span> - </div> - - <div class="method-heading"> - <span class="method-callseq"> - to_s([cipher, password]) → aString - </span> - - </div> - - <div class="method-description"> - <p>Encodes this <a href="DSA.html"><code>DSA</code></a> to its PEM encoding.</p> <h3 id="method-i-export-label-Parameters">Parameters<span><a href="#method-i-export-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> @@ -369,10 +287,7 @@ ossl_dsa_initialize(int argc, VALUE *argv, VALUE self) <pre>DSA.to_pem -> aString DSA.to_pem(cipher, 'mypassword') -> aString</pre> - - - <div class="method-source-code" id="export-source"> <pre>static VALUE ossl_dsa_export(int argc, VALUE *argv, VALUE self) @@ -408,37 +323,24 @@ ossl_dsa_export(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="DSA.html#method-i-to_pem">to_pem</a>, <a href="DSA.html#method-i-to_s">to_s</a> </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_dsa_initialize_copy(VALUE self, VALUE other) @@ -460,36 +362,22 @@ ossl_dsa_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-params" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> params → hash </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Stores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you)</p> - - + <p>Stores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don’t use :-)) (I’s up to you)</p> - <div class="method-source-code" id="params-source"> <pre>static VALUE ossl_dsa_get_params(VALUE self) @@ -512,36 +400,22 @@ ossl_dsa_get_params(VALUE self) return hash; }</pre> </div> - </div> - - </div> - <div id="method-i-private-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> private? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Indicates whether this <a href="DSA.html"><code>DSA</code></a> instance has a private key associated with it or not. The private key may be retrieved with DSA#private_key.</p> - - - <div class="method-source-code" id="private-3F-source"> <pre>static VALUE ossl_dsa_is_private(VALUE self) @@ -553,36 +427,22 @@ ossl_dsa_is_private(VALUE self) return DSA_PRIVATE(self, dsa) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-public-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Indicates whether this <a href="DSA.html"><code>DSA</code></a> instance has a public key associated with it or not. The public key may be retrieved with <a href="DSA.html#method-i-public_key"><code>DSA#public_key</code></a>.</p> - - - <div class="method-source-code" id="public-3F-source"> <pre>static VALUE ossl_dsa_is_public(VALUE self) @@ -596,31 +456,20 @@ ossl_dsa_is_public(VALUE self) return bn ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-public_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_key → aDSA </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a new <a href="DSA.html"><code>DSA</code></a> instance that carries just the public key information. If the current instance has also private key information, this will no longer be present in the new instance. This feature is helpful for publishing the public key information without leaking any of the private information.</p> <h3 id="method-i-public_key-label-Example">Example<span><a href="#method-i-public_key-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -629,10 +478,7 @@ ossl_dsa_is_public(VALUE self) <span class="ruby-identifier">pub_key</span> = <span class="ruby-identifier">dsa</span>.<span class="ruby-identifier">public_key</span> <span class="ruby-comment"># has only the public part available</span> <span class="ruby-identifier">pub_key_der</span> = <span class="ruby-identifier">pub_key</span>.<span class="ruby-identifier">to_der</span> <span class="ruby-comment"># it's safe to publish this</span> </pre> - - - <div class="method-source-code" id="public_key-source"> <pre>static VALUE ossl_dsa_to_public_key(VALUE self) @@ -655,85 +501,50 @@ ossl_dsa_to_public_key(VALUE self) return obj; }</pre> </div> - </div> - - </div> - <div id="method-i-set_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_key(pub_key, priv_key) → self </span> - </div> - - <div class="method-description"> - <p>Sets <em>pub_key</em> and <em>priv_key</em> for the <a href="DSA.html"><code>DSA</code></a> instance. <em>priv_key</em> may be <code>nil</code>.</p> - - - </div> - - </div> - <div id="method-i-set_pqg" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_pqg(p, q, g) → self </span> - </div> - - <div class="method-description"> - <p>Sets <em>p</em>, <em>q</em>, <em>g</em> to the <a href="DSA.html"><code>DSA</code></a> instance.</p> - - - </div> - - </div> - <div id="method-i-syssign" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> syssign(string) → aString </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Computes and returns the <a href="DSA.html"><code>DSA</code></a> signature of <em>string</em>, where <em>string</em> is expected to be an already-computed message digest of the original input data. The signature is issued using the private key of this <a href="DSA.html"><code>DSA</code></a> instance.</p> <h3 id="method-i-syssign-label-Parameters">Parameters<span><a href="#method-i-syssign-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> @@ -748,10 +559,7 @@ ossl_dsa_to_public_key(VALUE self) <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-identifier">digest</span>(<span class="ruby-string">'SHA1'</span>, <span class="ruby-identifier">doc</span>) <span class="ruby-identifier">sig</span> = <span class="ruby-identifier">dsa</span>.<span class="ruby-identifier">syssign</span>(<span class="ruby-identifier">digest</span>) </pre> - - - <div class="method-source-code" id="syssign-source"> <pre>static VALUE ossl_dsa_sign(VALUE self, VALUE data) @@ -779,31 +587,20 @@ ossl_dsa_sign(VALUE self, VALUE data) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-sysverify" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sysverify(digest, sig) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Verifies whether the signature is valid given the message digest input. It does so by validating <em>sig</em> using the public key of this <a href="DSA.html"><code>DSA</code></a> instance.</p> <h3 id="method-i-sysverify-label-Parameters">Parameters<span><a href="#method-i-sysverify-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> @@ -821,10 +618,7 @@ ossl_dsa_sign(VALUE self, VALUE data) <span class="ruby-identifier">sig</span> = <span class="ruby-identifier">dsa</span>.<span class="ruby-identifier">syssign</span>(<span class="ruby-identifier">digest</span>) <span class="ruby-identifier">puts</span> <span class="ruby-identifier">dsa</span>.<span class="ruby-identifier">sysverify</span>(<span class="ruby-identifier">digest</span>, <span class="ruby-identifier">sig</span>) <span class="ruby-comment"># => true</span> </pre> - - - <div class="method-source-code" id="sysverify-source"> <pre>static VALUE ossl_dsa_verify(VALUE self, VALUE digest, VALUE sig) @@ -848,36 +642,22 @@ ossl_dsa_verify(VALUE self, VALUE digest, VALUE sig) return Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → aString </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Encodes this <a href="DSA.html"><code>DSA</code></a> to its DER encoding.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_dsa_to_der(VALUE self) @@ -904,92 +684,82 @@ ossl_dsa_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">to_pem</span><span - class="method-args">(p1 = v1, p2 = v2)</span> - + <span class="method-callseq"> + to_pem([cipher, password]) → aString + </span> </div> - <div class="method-description"> - - - - + <p>Encodes this <a href="DSA.html"><code>DSA</code></a> to its PEM encoding.</p> + +<h3 id="method-i-to_pem-label-Parameters">Parameters<span><a href="#method-i-to_pem-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> +<ul><li> +<p><em>cipher</em> is an <a href="../Cipher.html"><code>OpenSSL::Cipher</code></a>.</p> +</li><li> +<p><em>password</em> is a string containing your password.</p> +</li></ul> + +<h3 id="method-i-to_pem-label-Examples">Examples<span><a href="#method-i-to_pem-label-Examples">¶</a> <a href="#top">↑</a></span></h3> + +<pre>DSA.to_pem -> aString +DSA.to_pem(cipher, 'mypassword') -> aString</pre> - </div> - - <div class="aliases"> Alias for: <a href="DSA.html#method-i-export">export</a> </div> - </div> - <div id="method-i-to_s" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">to_s</span><span - class="method-args">(p1 = v1, p2 = v2)</span> - + <span class="method-callseq"> + to_s([cipher, password]) → aString + </span> </div> - <div class="method-description"> - - - - + <p>Encodes this <a href="DSA.html"><code>DSA</code></a> to its PEM encoding.</p> + +<h3 id="method-i-to_s-label-Parameters">Parameters<span><a href="#method-i-to_s-label-Parameters">¶</a> <a href="#top">↑</a></span></h3> +<ul><li> +<p><em>cipher</em> is an <a href="../Cipher.html"><code>OpenSSL::Cipher</code></a>.</p> +</li><li> +<p><em>password</em> is a string containing your password.</p> +</li></ul> + +<h3 id="method-i-to_s-label-Examples">Examples<span><a href="#method-i-to_s-label-Examples">¶</a> <a href="#top">↑</a></span></h3> + +<pre>DSA.to_pem -> aString +DSA.to_pem(cipher, 'mypassword') -> aString</pre> - </div> - - <div class="aliases"> Alias for: <a href="DSA.html#method-i-export">export</a> </div> - </div> - <div id="method-i-to_text" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_text → aString </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Prints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) (I's up to you)</p> - - + <p>Prints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don’t use :-)) (I’s up to you)</p> - <div class="method-source-code" id="to_text-source"> <pre>static VALUE ossl_dsa_to_text(VALUE self) @@ -1011,25 +781,20 @@ ossl_dsa_to_text(VALUE self) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKey/DSAError.html b/OpenSSL/PKey/DSAError.html index d01ad182..47052abf 100644 --- a/OpenSSL/PKey/DSAError.html +++ b/OpenSSL/PKey/DSAError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="PKeyError.html">OpenSSL::PKey::PKeyError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/PKey/EC.html b/OpenSSL/PKey/EC.html index deb75021..4645a2da 100644 --- a/OpenSSL/PKey/EC.html +++ b/OpenSSL/PKey/EC.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,81 +57,53 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="PKey.html">OpenSSL::PKey::PKey</a> - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../Marshal.html">OpenSSL::Marshal</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-builtin_curves">::builtin_curves</a> - <li ><a href="#method-c-generate">::generate</a> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-check_key">#check_key</a> - <li ><a href="#method-i-dh_compute_key">#dh_compute_key</a> - <li ><a href="#method-i-dsa_sign_asn1">#dsa_sign_asn1</a> - <li ><a href="#method-i-dsa_verify_asn1">#dsa_verify_asn1</a> - <li ><a href="#method-i-export">#export</a> - <li ><a href="#method-i-generate_key">#generate_key</a> - <li ><a href="#method-i-generate_key-21">#generate_key!</a> - <li ><a href="#method-i-group">#group</a> - <li ><a href="#method-i-group-3D">#group=</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-private-3F">#private?</a> - <li ><a href="#method-i-private_key">#private_key</a> - <li ><a href="#method-i-private_key-3D">#private_key=</a> - <li ><a href="#method-i-private_key-3F">#private_key?</a> - <li ><a href="#method-i-public-3F">#public?</a> - <li ><a href="#method-i-public_key">#public_key</a> - <li ><a href="#method-i-public_key-3D">#public_key=</a> - <li ><a href="#method-i-public_key-3F">#public_key?</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_text">#to_text</a> - </ul> </div> @@ -162,65 +132,41 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="EXPLICIT_CURVE">EXPLICIT_CURVE - <dd> - - <dt id="NAMED_CURVE">NAMED_CURVE - <dd> - - </dl> </section> - - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-builtin_curves" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> builtin_curves → [[sn, comment], ...] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Obtains a list of all predefined curves by the <a href="../../OpenSSL.html"><code>OpenSSL</code></a>. Curve names are returned as sn.</p> <p>See the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_get_builtin_curves().</p> - - - <div class="method-source-code" id="builtin_curves-source"> <pre>static VALUE ossl_s_builtin_curves(VALUE self) { @@ -250,43 +196,27 @@ return ret; }</pre> </div> - </div> - - </div> - <div id="method-c-generate" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> generate(ec_group) → ec </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> generate(string) → ec </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="EC.html"><code>EC</code></a> instance with a new random private and public key.</p> - - - <div class="method-source-code" id="generate-source"> <pre>static VALUE ossl_ec_key_s_generate(VALUE klass, VALUE arg) @@ -308,71 +238,47 @@ ossl_ec_key_s_generate(VALUE klass, VALUE arg) return obj; }</pre> </div> - </div> - - </div> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC.new </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC.new(ec_key) </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC.new(ec_group) </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC.new("secp112r1") </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC.new(pem_string [, pwd]) </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC.new(der_string) </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="EC.html"><code>EC</code></a> object from given arguments.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ec_key_initialize(int argc, VALUE *argv, VALUE self) { @@ -432,46 +338,31 @@ ossl_ec_key_s_generate(VALUE klass, VALUE arg) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-check_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> check_key → true </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Raises an exception if the key is invalid.</p> <p>See the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_KEY_check_key()</p> - - - <div class="method-source-code" id="check_key-source"> <pre>static VALUE ossl_ec_key_check_key(VALUE self) { @@ -484,36 +375,22 @@ ossl_ec_key_s_generate(VALUE klass, VALUE arg) return Qtrue; }</pre> </div> - </div> - - </div> - <div id="method-i-dh_compute_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> dh_compute_key(pubkey) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for ECDH_compute_key()</p> - - - <div class="method-source-code" id="dh_compute_key-source"> <pre>static VALUE ossl_ec_key_dh_compute_key(VALUE self, VALUE pubkey) { @@ -538,36 +415,22 @@ ossl_ec_key_s_generate(VALUE klass, VALUE arg) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-dsa_sign_asn1" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> dsa_sign_asn1(data) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for ECDSA_sign()</p> - - - <div class="method-source-code" id="dsa_sign_asn1-source"> <pre>static VALUE ossl_ec_key_dsa_sign_asn1(VALUE self, VALUE data) { @@ -589,36 +452,22 @@ ossl_ec_key_s_generate(VALUE klass, VALUE arg) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-dsa_verify_asn1" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> dsa_verify_asn1(data, sig) → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for ECDSA_verify()</p> - - - <div class="method-source-code" id="dsa_verify_asn1-source"> <pre>static VALUE ossl_ec_key_dsa_verify_asn1(VALUE self, VALUE data, VALUE sig) { @@ -628,54 +477,33 @@ ossl_ec_key_s_generate(VALUE klass, VALUE arg) StringValue(data); StringValue(sig); - switch (ECDSA_verify(0, (unsigned char *) RSTRING_PTR(data), RSTRING_LENINT(data), (unsigned char *) RSTRING_PTR(sig), (int)RSTRING_LEN(sig), ec)) { - case 1: return Qtrue; - case 0: return Qfalse; - default: break; + switch (ECDSA_verify(0, (unsigned char *)RSTRING_PTR(data), RSTRING_LENINT(data), + (unsigned char *)RSTRING_PTR(sig), RSTRING_LENINT(sig), ec)) { + case 1: + return Qtrue; + case 0: + return Qfalse; + default: + ossl_raise(eECError, "ECDSA_verify"); } - - ossl_raise(eECError, "ECDSA_verify"); - - UNREACHABLE; }</pre> </div> - </div> - - </div> - <div id="method-i-export" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> export([cipher, pass_phrase]) → String </span> - <span class="method-click-advice">click to toggle source</span> - - </div> - - <div class="method-heading"> - <span class="method-callseq"> - to_pem([cipher, pass_phrase]) → String - </span> - </div> - - <div class="method-description"> - <p>Outputs the <a href="EC.html"><code>EC</code></a> key in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt the key. <em>cipher</em> must be an <a href="../Cipher.html"><code>OpenSSL::Cipher</code></a> instance. Note that encryption will only be effective for a private key, public keys will always be encoded in plain text.</p> - - - <div class="method-source-code" id="export-source"> <pre>static VALUE ossl_ec_key_export(int argc, VALUE *argv, VALUE self) { @@ -684,63 +512,49 @@ ossl_ec_key_s_generate(VALUE klass, VALUE arg) return ossl_ec_key_to_string(self, cipher, passwd, EXPORT_PEM); }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="EC.html#method-i-to_pem">to_pem</a> </div> - - </div> - <div id="method-i-generate_key" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">generate_key</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - + <p>Generates a new random private and public key.</p> + +<p>See also the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_KEY_generate_key()</p> + +<h3 id="method-i-generate_key-label-Example">Example<span><a href="#method-i-generate_key-label-Example">¶</a> <a href="#top">↑</a></span></h3> + +<pre class="ruby"><span class="ruby-identifier">ec</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">EC</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"prime256v1"</span>) +<span class="ruby-identifier">p</span> <span class="ruby-identifier">ec</span>.<span class="ruby-identifier">private_key</span> <span class="ruby-comment"># => nil</span> +<span class="ruby-identifier">ec</span>.<span class="ruby-identifier">generate_key!</span> +<span class="ruby-identifier">p</span> <span class="ruby-identifier">ec</span>.<span class="ruby-identifier">private_key</span> <span class="ruby-comment"># => #<OpenSSL::BN XXXXXX></span> +</pre> - </div> - - <div class="aliases"> Alias for: <a href="EC.html#method-i-generate_key-21">generate_key!</a> </div> - </div> - <div id="method-i-generate_key-21" class="method-detail "> - - <div class="method-heading"> - <span class="method-callseq"> - generate_key! → self - </span> - + <span class="method-name">generate_key!</span><span + class="method-args"> => self</span> <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Generates a new random private and public key.</p> <p>See also the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_KEY_generate_key()</p> @@ -752,10 +566,7 @@ ossl_ec_key_s_generate(VALUE klass, VALUE arg) <span class="ruby-identifier">ec</span>.<span class="ruby-identifier">generate_key!</span> <span class="ruby-identifier">p</span> <span class="ruby-identifier">ec</span>.<span class="ruby-identifier">private_key</span> <span class="ruby-comment"># => #<OpenSSL::BN XXXXXX></span> </pre> - - - <div class="method-source-code" id="generate_key-21-source"> <pre>static VALUE ossl_ec_key_generate_key(VALUE self) { @@ -768,40 +579,25 @@ ossl_ec_key_s_generate(VALUE klass, VALUE arg) return self; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="EC.html#method-i-generate_key">generate_key</a> </div> - - </div> - <div id="method-i-group" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> group → group </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the <a href="EC/Group.html"><code>EC::Group</code></a> that the key is associated with. Modifying the returned group does not affect <em>key</em>.</p> - - - <div class="method-source-code" id="group-source"> <pre>static VALUE ossl_ec_key_get_group(VALUE self) @@ -817,36 +613,22 @@ ossl_ec_key_get_group(VALUE self) return ec_group_new(group); }</pre> </div> - </div> - - </div> - <div id="method-i-group-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> group = group </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the <a href="EC/Group.html"><code>EC::Group</code></a> for the key. The group structure is internally copied so modification to <em>group</em> after assigning to a key has no effect on the key.</p> - - - <div class="method-source-code" id="group-3D-source"> <pre>static VALUE ossl_ec_key_set_group(VALUE self, VALUE group_v) @@ -863,33 +645,21 @@ ossl_ec_key_set_group(VALUE self, VALUE group_v) return group_v; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_ec_key_initialize_copy(VALUE self, VALUE other) @@ -913,36 +683,22 @@ ossl_ec_key_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-private-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> private? → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns whether this <a href="EC.html"><code>EC</code></a> instance has a private key. The private key (<a href="../BN.html"><code>BN</code></a>) can be retrieved with <a href="EC.html#method-i-private_key"><code>EC#private_key</code></a>.</p> - - - <div class="method-source-code" id="private-3F-source"> <pre>static VALUE ossl_ec_key_is_private(VALUE self) { @@ -953,40 +709,25 @@ ossl_ec_key_initialize_copy(VALUE self, VALUE other) return EC_KEY_get0_private_key(ec) ? Qtrue : Qfalse; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="EC.html#method-i-private_key-3F">private_key?</a> </div> - - </div> - <div id="method-i-private_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> private_key → OpenSSL::BN </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_KEY_get0_private_key()</p> - - - <div class="method-source-code" id="private_key-source"> <pre>static VALUE ossl_ec_key_get_private_key(VALUE self) { @@ -1000,36 +741,22 @@ ossl_ec_key_initialize_copy(VALUE self, VALUE other) return ossl_bn_new(bn); }</pre> </div> - </div> - - </div> - <div id="method-i-private_key-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> private_key = openssl_bn </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_KEY_set_private_key()</p> - - - <div class="method-source-code" id="private_key-3D-source"> <pre>static VALUE ossl_ec_key_set_private_key(VALUE self, VALUE private_key) { @@ -1053,64 +780,39 @@ ossl_ec_key_initialize_copy(VALUE self, VALUE other) return private_key; }</pre> </div> - </div> - - </div> - <div id="method-i-private_key-3F" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">private_key?</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - + <p>Returns whether this <a href="EC.html"><code>EC</code></a> instance has a private key. The private key (<a href="../BN.html"><code>BN</code></a>) can be retrieved with <a href="EC.html#method-i-private_key"><code>EC#private_key</code></a>.</p> - </div> - - <div class="aliases"> Alias for: <a href="EC.html#method-i-private-3F">private?</a> </div> - </div> - <div id="method-i-public-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public? → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns whether this <a href="EC.html"><code>EC</code></a> instance has a public key. The public key (<a href="EC/Point.html"><code>EC::Point</code></a>) can be retrieved with <a href="EC.html#method-i-public_key"><code>EC#public_key</code></a>.</p> - - - <div class="method-source-code" id="public-3F-source"> <pre>static VALUE ossl_ec_key_is_public(VALUE self) { @@ -1121,40 +823,25 @@ ossl_ec_key_initialize_copy(VALUE self, VALUE other) return EC_KEY_get0_public_key(ec) ? Qtrue : Qfalse; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="EC.html#method-i-public_key-3F">public_key?</a> </div> - - </div> - <div id="method-i-public_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_key → OpenSSL::PKey::EC::Point </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_KEY_get0_public_key()</p> - - - <div class="method-source-code" id="public_key-source"> <pre>static VALUE ossl_ec_key_get_public_key(VALUE self) { @@ -1168,36 +855,22 @@ ossl_ec_key_initialize_copy(VALUE self, VALUE other) return ec_point_new(point, EC_KEY_get0_group(ec)); }</pre> </div> - </div> - - </div> - <div id="method-i-public_key-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_key = ec_point </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_KEY_set_public_key()</p> - - - <div class="method-source-code" id="public_key-3D-source"> <pre>static VALUE ossl_ec_key_set_public_key(VALUE self, VALUE public_key) { @@ -1221,128 +894,79 @@ ossl_ec_key_initialize_copy(VALUE self, VALUE other) return public_key; }</pre> </div> - </div> - - </div> - <div id="method-i-public_key-3F" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">public_key?</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - + <p>Returns whether this <a href="EC.html"><code>EC</code></a> instance has a public key. The public key (<a href="EC/Point.html"><code>EC::Point</code></a>) can be retrieved with <a href="EC.html#method-i-public_key"><code>EC#public_key</code></a>.</p> - </div> - - <div class="aliases"> Alias for: <a href="EC.html#method-i-public-3F">public?</a> </div> - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for i2d_ECPrivateKey_bio()</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ec_key_to_der(VALUE self) { return ossl_ec_key_to_string(self, Qnil, Qnil, EXPORT_DER); }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">to_pem</span><span - class="method-args">(p1 = v1, p2 = v2)</span> - + <span class="method-callseq"> + to_pem([cipher, pass_phrase]) → String + </span> </div> - <div class="method-description"> - - - - + <p>Outputs the <a href="EC.html"><code>EC</code></a> key in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt the key. <em>cipher</em> must be an <a href="../Cipher.html"><code>OpenSSL::Cipher</code></a> instance. Note that encryption will only be effective for a private key, public keys will always be encoded in plain text.</p> - </div> - - <div class="aliases"> Alias for: <a href="EC.html#method-i-export">export</a> </div> - </div> - <div id="method-i-to_text" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_text → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_KEY_print()</p> - - - <div class="method-source-code" id="to_text-source"> <pre>static VALUE ossl_ec_key_to_text(VALUE self) { @@ -1363,25 +987,20 @@ ossl_ec_key_initialize_copy(VALUE self, VALUE other) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKey/EC/Group.html b/OpenSSL/PKey/EC/Group.html index 55253bed..42d18499 100644 --- a/OpenSSL/PKey/EC/Group.html +++ b/OpenSSL/PKey/EC/Group.html @@ -21,8 +21,6 @@ <link href="../../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,60 +57,40 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-asn1_flag">#asn1_flag</a> - <li ><a href="#method-i-asn1_flag-3D">#asn1_flag=</a> - <li ><a href="#method-i-cofactor">#cofactor</a> - <li ><a href="#method-i-curve_name">#curve_name</a> - <li ><a href="#method-i-degree">#degree</a> - <li ><a href="#method-i-eql-3F">#eql?</a> - <li ><a href="#method-i-generator">#generator</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-order">#order</a> - <li ><a href="#method-i-point_conversion_form">#point_conversion_form</a> - <li ><a href="#method-i-point_conversion_form-3D">#point_conversion_form=</a> - <li ><a href="#method-i-seed">#seed</a> - <li ><a href="#method-i-seed-3D">#seed=</a> - <li ><a href="#method-i-set_generator">#set_generator</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_text">#to_text</a> - </ul> </div> @@ -128,67 +106,46 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC::Group.new(ec_group) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC::Group.new(pem_or_der_encoded) </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC::Group.new(ec_method) </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC::Group.new(:GFp, bignum_p, bignum_a, bignum_b) </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC::Group.new(:GF2m, bignum_p, bignum_a, bignum_b) </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="Group.html"><code>EC::Group</code></a> object.</p> <p><em>ec_method</em> is a symbol that represents an EC_METHOD. Currently the following are supported:</p> @@ -203,10 +160,7 @@ </li></ul> <p>If the first argument is :GFp or :GF2m, creates a new curve with given parameters.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ec_group_initialize(int argc, VALUE *argv, VALUE self) { @@ -312,74 +266,49 @@ return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3D-3D" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">==</span><span - class="method-args">(p1)</span> - + <span class="method-callseq"> + group1 == group2 → true | false + </span> </div> - <div class="method-description"> - - - - + <p>Returns <code>true</code> if the two groups use the same curve and have the same parameters, <code>false</code> otherwise.</p> - </div> - - <div class="aliases"> Alias for: <a href="Group.html#method-i-eql-3F">eql?</a> </div> - </div> - <div id="method-i-asn1_flag" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> asn1_flag → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the flags set on the group.</p> <p>See also <a href="Group.html#method-i-asn1_flag-3D"><code>asn1_flag=</code></a>.</p> - - - <div class="method-source-code" id="asn1_flag-source"> <pre>static VALUE ossl_ec_group_get_asn1_flag(VALUE self) { @@ -392,31 +321,20 @@ return INT2NUM(flag); }</pre> </div> - </div> - - </div> - <div id="method-i-asn1_flag-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> asn1_flag = flags </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets flags on the group. The flag value is used to determine how to encode the group: encode explicit parameters or named curve using an OID.</p> <p>The flag value can be either of:</p> @@ -427,10 +345,7 @@ </li></ul> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_set_asn1_flag().</p> - - - <div class="method-source-code" id="asn1_flag-3D-source"> <pre>static VALUE ossl_ec_group_set_asn1_flag(VALUE self, VALUE flag_v) { @@ -442,38 +357,24 @@ return flag_v; }</pre> </div> - </div> - - </div> - <div id="method-i-cofactor" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> get_cofactor → cofactor_bn </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the cofactor of the group.</p> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get_cofactor()</p> - - - <div class="method-source-code" id="cofactor-source"> <pre>static VALUE ossl_ec_group_get_cofactor(VALUE self) { @@ -492,38 +393,24 @@ return bn_obj; }</pre> </div> - </div> - - </div> - <div id="method-i-curve_name" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> curve_name → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the curve name (sn).</p> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get_curve_name()</p> - - - <div class="method-source-code" id="curve_name-source"> <pre>static VALUE ossl_ec_group_get_curve_name(VALUE self) { @@ -540,36 +427,22 @@ return rb_str_new2(OBJ_nid2sn(nid)); }</pre> </div> - </div> - - </div> - <div id="method-i-degree" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> degree → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get_degree()</p> - - - <div class="method-source-code" id="degree-source"> <pre>static VALUE ossl_ec_group_get_degree(VALUE self) { @@ -580,43 +453,22 @@ return INT2NUM(EC_GROUP_get_degree(group)); }</pre> </div> - </div> - - </div> - <div id="method-i-eql-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> eql?(group2) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-heading"> - <span class="method-callseq"> - group1 == group2 → true | false - </span> - - </div> - - <div class="method-description"> - <p>Returns <code>true</code> if the two groups use the same curve and have the same parameters, <code>false</code> otherwise.</p> - - - <div class="method-source-code" id="eql-3F-source"> <pre>static VALUE ossl_ec_group_eql(VALUE a, VALUE b) { @@ -631,42 +483,27 @@ return Qtrue; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="Group.html#method-i-3D-3D">==</a> </div> - - </div> - <div id="method-i-generator" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> generator → ec_point </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the generator of the group.</p> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get0_generator()</p> - - - <div class="method-source-code" id="generator-source"> <pre>static VALUE ossl_ec_group_get_generator(VALUE self) { @@ -681,33 +518,21 @@ return ec_point_new(generator, group); }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_ec_group_initialize_copy(VALUE self, VALUE other) @@ -727,38 +552,24 @@ ossl_ec_group_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-order" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> get_order → order_bn </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the order of the group.</p> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get_order()</p> - - - <div class="method-source-code" id="order-source"> <pre>static VALUE ossl_ec_group_get_order(VALUE self) { @@ -777,38 +588,24 @@ ossl_ec_group_initialize_copy(VALUE self, VALUE other) return bn_obj; }</pre> </div> - </div> - - </div> - <div id="method-i-point_conversion_form" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> point_conversion_form → Symbol </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the form how <a href="Point.html"><code>EC::Point</code></a> data is encoded as ASN.1.</p> <p>See also <a href="Group.html#method-i-point_conversion_form-3D"><code>point_conversion_form=</code></a>.</p> - - - <div class="method-source-code" id="point_conversion_form-source"> <pre>static VALUE ossl_ec_group_get_point_conversion_form(VALUE self) { @@ -829,31 +626,20 @@ ossl_ec_group_initialize_copy(VALUE self, VALUE other) return ID2SYM(ret); }</pre> </div> - </div> - - </div> - <div id="method-i-point_conversion_form-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> point_conversion_form = form </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the form how <a href="Point.html"><code>EC::Point</code></a> data is encoded as ASN.1 as defined in X9.62.</p> <p><em>format</em> can be one of these:</p> @@ -869,10 +655,7 @@ ossl_ec_group_initialize_copy(VALUE self, VALUE other) </dd></dl> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_set_point_conversion_form()</p> - - - <div class="method-source-code" id="point_conversion_form-3D-source"> <pre>static VALUE ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) @@ -888,36 +671,22 @@ ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) return form_v; }</pre> </div> - </div> - - </div> - <div id="method-i-seed" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> seed → String or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_get0_seed()</p> - - - <div class="method-source-code" id="seed-source"> <pre>static VALUE ossl_ec_group_get_seed(VALUE self) { @@ -933,36 +702,22 @@ ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) return rb_str_new((const char *)EC_GROUP_get0_seed(group), seed_len); }</pre> </div> - </div> - - </div> - <div id="method-i-seed-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> seed = seed → seed </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_set_seed()</p> - - - <div class="method-source-code" id="seed-3D-source"> <pre>static VALUE ossl_ec_group_set_seed(VALUE self, VALUE seed) { @@ -977,38 +732,24 @@ ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) return seed; }</pre> </div> - </div> - - </div> - <div id="method-i-set_generator" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_generator(generator, order, cofactor) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the curve parameters. <em>generator</em> must be an instance of <a href="Point.html"><code>EC::Point</code></a> that is on the curve. <em>order</em> and <em>cofactor</em> are integers.</p> <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for EC_GROUP_set_generator()</p> - - - <div class="method-source-code" id="set_generator-source"> <pre>static VALUE ossl_ec_group_set_generator(VALUE self, VALUE generator, VALUE order, VALUE cofactor) { @@ -1027,108 +768,66 @@ ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for i2d_ECPKParameters_bio()</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ec_group_to_der(VALUE self) { return ossl_ec_group_to_string(self, EXPORT_DER); }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_pem → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for PEM_write_bio_ECPKParameters()</p> - - - <div class="method-source-code" id="to_pem-source"> <pre>static VALUE ossl_ec_group_to_pem(VALUE self) { return ossl_ec_group_to_string(self, EXPORT_PEM); }</pre> </div> - </div> - - </div> - <div id="method-i-to_text" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_text → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>See the <a href="../../../OpenSSL.html"><code>OpenSSL</code></a> documentation for ECPKParameters_print()</p> - - - <div class="method-source-code" id="to_text-source"> <pre>static VALUE ossl_ec_group_to_text(VALUE self) { @@ -1149,25 +848,20 @@ ossl_ec_group_set_point_conversion_form(VALUE self, VALUE form_v) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKey/EC/Group/Error.html b/OpenSSL/PKey/EC/Group/Error.html index f468eb96..bab3b910 100644 --- a/OpenSSL/PKey/EC/Group/Error.html +++ b/OpenSSL/PKey/EC/Group/Error.html @@ -21,8 +21,6 @@ <link href="../../../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../../../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/PKey/EC/Point.html b/OpenSSL/PKey/EC/Point.html index 64c19876..706be750 100644 --- a/OpenSSL/PKey/EC/Point.html +++ b/OpenSSL/PKey/EC/Point.html @@ -21,8 +21,6 @@ <link href="../../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,48 +57,34 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-add">#add</a> - <li ><a href="#method-i-eql-3F">#eql?</a> - <li ><a href="#method-i-infinity-3F">#infinity?</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-invert-21">#invert!</a> - <li ><a href="#method-i-make_affine-21">#make_affine!</a> - <li ><a href="#method-i-mul">#mul</a> - <li ><a href="#method-i-on_curve-3F">#on_curve?</a> - <li ><a href="#method-i-set_to_infinity-21">#set_to_infinity!</a> - <li ><a href="#method-i-to_bn">#to_bn</a> - <li ><a href="#method-i-to_octet_string">#to_octet_string</a> - </ul> </div> @@ -116,21 +100,15 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-group" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">group</span><span @@ -139,51 +117,34 @@ <div class="method-description"> - - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC::Point.new(point) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::PKey::EC::Point.new(group [, encoded_point]) </span> - </div> - - <div class="method-description"> - <p>Creates a new instance of <a href="Point.html"><code>OpenSSL::PKey::EC::Point</code></a>. If the only argument is an instance of <a href="Point.html"><code>EC::Point</code></a>, a copy is returned. Otherwise, creates a point that belongs to <em>group</em>.</p> <p><em>encoded_point</em> is the octet string representation of the point. This must be either a String or an <a href="../../BN.html"><code>OpenSSL::BN</code></a>.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ec_point_initialize(int argc, VALUE *argv, VALUE self) { @@ -234,72 +195,47 @@ return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3D-3D" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">==</span><span - class="method-args">(p1)</span> - + <span class="method-callseq"> + point1 == point2 → true | false + </span> </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="Point.html#method-i-eql-3F">eql?</a> </div> - </div> - <div id="method-i-add" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add(point) → point </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Performs elliptic curve point addition.</p> - - - <div class="method-source-code" id="add-source"> <pre>static VALUE ossl_ec_point_add(VALUE self, VALUE other) { @@ -323,43 +259,22 @@ return result; }</pre> </div> - </div> - - </div> - <div id="method-i-eql-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> eql?(point2) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-heading"> - <span class="method-callseq"> - point1 == point2 → true | false - </span> - - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="eql-3F-source"> <pre>static VALUE ossl_ec_point_eql(VALUE a, VALUE b) { @@ -381,40 +296,25 @@ return Qtrue; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="Point.html#method-i-3D-3D">==</a> </div> - - </div> - <div id="method-i-infinity-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> infinity? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="infinity-3F-source"> <pre>static VALUE ossl_ec_point_is_at_infinity(VALUE self) { @@ -433,33 +333,21 @@ UNREACHABLE; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_ec_point_initialize_copy(VALUE self, VALUE other) @@ -485,36 +373,22 @@ ossl_ec_point_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-invert-21" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> invert! → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="invert-21-source"> <pre>static VALUE ossl_ec_point_invert(VALUE self) { @@ -530,36 +404,22 @@ ossl_ec_point_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-make_affine-21" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> make_affine! → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="make_affine-21-source"> <pre>static VALUE ossl_ec_point_make_affine(VALUE self) { @@ -575,47 +435,31 @@ ossl_ec_point_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-mul" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> mul(bn1 [, bn2]) → point </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> mul(bns, points [, bn2]) → point </span> - </div> - - <div class="method-description"> - <p>Performs elliptic curve point multiplication.</p> <p>The first form calculates <code>bn1 * point + bn2 * G</code>, where <code>G</code> is the generator of the group of <em>point</em>. <em>bn2</em> may be omitted, and in that case, the result is just <code>bn1 * point</code>.</p> <p>The second form calculates <code>bns[0] * point + bns[1] * points[0] + ... + bns[-1] * points[-1] + bn2 * G</code>. <em>bn2</em> may be omitted. <em>bns</em> must be an array of <a href="../../BN.html"><code>OpenSSL::BN</code></a>. <em>points</em> must be an array of <a href="Point.html"><code>OpenSSL::PKey::EC::Point</code></a>. Please note that <code>points[0]</code> is not multiplied by <code>bns[0]</code>, but <code>bns[1]</code>.</p> - - - <div class="method-source-code" id="mul-source"> <pre>static VALUE ossl_ec_point_mul(int argc, VALUE *argv, VALUE self) { @@ -685,36 +529,22 @@ ossl_ec_point_initialize_copy(VALUE self, VALUE other) return result; }</pre> </div> - </div> - - </div> - <div id="method-i-on_curve-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> on_curve? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="on_curve-3F-source"> <pre>static VALUE ossl_ec_point_is_on_curve(VALUE self) { @@ -733,36 +563,22 @@ ossl_ec_point_initialize_copy(VALUE self, VALUE other) UNREACHABLE; }</pre> </div> - </div> - - </div> - <div id="method-i-set_to_infinity-21" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_to_infinity! → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="set_to_infinity-21-source"> <pre>static VALUE ossl_ec_point_set_to_infinity(VALUE self) { @@ -778,71 +594,46 @@ ossl_ec_point_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-to_bn" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_bn([conversion_form]) → OpenSSL::BN </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the octet string representation of the <a href="../EC.html"><code>EC</code></a> point as an instance of <a href="../../BN.html"><code>OpenSSL::BN</code></a>.</p> <p>If <em>conversion_form</em> is not given, the <em>point_conversion_form</em> attribute set to the group is used.</p> <p>See <a href="Point.html#method-i-to_octet_string"><code>to_octet_string</code></a> for more information.</p> - - - <div class="method-source-code" id="to_bn-source"> <pre><span class="ruby-comment"># File lib/openssl/pkey.rb, line 33</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_bn</span>(<span class="ruby-identifier">conversion_form</span> = <span class="ruby-identifier">group</span>.<span class="ruby-identifier">point_conversion_form</span>) <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">BN</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">to_octet_string</span>(<span class="ruby-identifier">conversion_form</span>), <span class="ruby-value">2</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-to_octet_string" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_octet_string(conversion_form) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the octet string representation of the elliptic curve point.</p> <p><em>conversion_form</em> specifies how the point is converted. Possible values are:</p> @@ -853,10 +644,7 @@ ossl_ec_point_initialize_copy(VALUE self, VALUE other) </li><li> <p><code>:hybrid</code></p> </li></ul> - - - <div class="method-source-code" id="to_octet_string-source"> <pre>static VALUE ossl_ec_point_to_octet_string(VALUE self, VALUE conversion_form) @@ -882,25 +670,20 @@ ossl_ec_point_to_octet_string(VALUE self, VALUE conversion_form) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKey/EC/Point/Error.html b/OpenSSL/PKey/EC/Point/Error.html index c19537ca..f5aec240 100644 --- a/OpenSSL/PKey/EC/Point/Error.html +++ b/OpenSSL/PKey/EC/Point/Error.html @@ -21,8 +21,6 @@ <link href="../../../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../../../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/PKey/ECError.html b/OpenSSL/PKey/ECError.html index 4d4d9e43..fc22b907 100644 --- a/OpenSSL/PKey/ECError.html +++ b/OpenSSL/PKey/ECError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="PKeyError.html">OpenSSL::PKey::PKeyError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/PKey/PKey.html b/OpenSSL/PKey/PKey.html index 8d64a341..5f981ef2 100644 --- a/OpenSSL/PKey/PKey.html +++ b/OpenSSL/PKey/PKey.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,40 +57,30 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-inspect">#inspect</a> - <li ><a href="#method-i-oid">#oid</a> - <li ><a href="#method-i-private_to_der">#private_to_der</a> - <li ><a href="#method-i-private_to_pem">#private_to_pem</a> - <li ><a href="#method-i-public_to_der">#public_to_der</a> - <li ><a href="#method-i-public_to_pem">#public_to_pem</a> - <li ><a href="#method-i-sign">#sign</a> - <li ><a href="#method-i-verify">#verify</a> - </ul> </div> @@ -117,44 +105,28 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Because <a href="PKey.html"><code>PKey</code></a> is an abstract class, actually calling this method explicitly will raise a NotImplementedError.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_pkey_initialize(VALUE self) @@ -165,44 +137,29 @@ ossl_pkey_initialize(VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-inspect" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> inspect → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a string describing the <a href="PKey.html"><code>PKey</code></a> object.</p> - - - <div class="method-source-code" id="inspect-source"> <pre>static VALUE ossl_pkey_inspect(VALUE self) @@ -217,36 +174,22 @@ ossl_pkey_inspect(VALUE self) OBJ_nid2sn(nid)); }</pre> </div> - </div> - - </div> - <div id="method-i-oid" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> oid → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the short name of the OID associated with <em>pkey</em>.</p> - - - <div class="method-source-code" id="oid-source"> <pre>static VALUE ossl_pkey_oid(VALUE self) @@ -259,43 +202,27 @@ ossl_pkey_oid(VALUE self) return rb_str_new_cstr(OBJ_nid2sn(nid)); }</pre> </div> - </div> - - </div> - <div id="method-i-private_to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> private_to_der → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> private_to_der(cipher, password) → string </span> - </div> - - <div class="method-description"> - <p>Serializes the private key to DER-encoded PKCS #8 format. If called without arguments, unencrypted PKCS #8 PrivateKeyInfo format is used. If called with a cipher name and a password, PKCS #8 EncryptedPrivateKeyInfo format with PBES2 encryption scheme is used.</p> - - - <div class="method-source-code" id="private_to_der-source"> <pre>static VALUE ossl_pkey_private_to_der(int argc, VALUE *argv, VALUE self) @@ -303,43 +230,27 @@ ossl_pkey_private_to_der(int argc, VALUE *argv, VALUE self) return do_pkcs8_export(argc, argv, self, 1); }</pre> </div> - </div> - - </div> - <div id="method-i-private_to_pem" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> private_to_pem → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> private_to_pem(cipher, password) → string </span> - </div> - - <div class="method-description"> - <p>Serializes the private key to PEM-encoded PKCS #8 format. See <a href="PKey.html#method-i-private_to_der"><code>private_to_der</code></a> for more details.</p> - - - <div class="method-source-code" id="private_to_pem-source"> <pre>static VALUE ossl_pkey_private_to_pem(int argc, VALUE *argv, VALUE self) @@ -347,36 +258,22 @@ ossl_pkey_private_to_pem(int argc, VALUE *argv, VALUE self) return do_pkcs8_export(argc, argv, self, 0); }</pre> </div> - </div> - - </div> - <div id="method-i-public_to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_to_der → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Serializes the public key to DER-encoded X.509 SubjectPublicKeyInfo format.</p> - - - <div class="method-source-code" id="public_to_der-source"> <pre>static VALUE ossl_pkey_public_to_der(VALUE self) @@ -384,36 +281,22 @@ ossl_pkey_public_to_der(VALUE self) return do_spki_export(self, 1); }</pre> </div> - </div> - - </div> - <div id="method-i-public_to_pem" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_to_pem → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Serializes the public key to PEM-encoded X.509 SubjectPublicKeyInfo format.</p> - - - <div class="method-source-code" id="public_to_pem-source"> <pre>static VALUE ossl_pkey_public_to_pem(VALUE self) @@ -421,31 +304,20 @@ ossl_pkey_public_to_pem(VALUE self) return do_spki_export(self, 0); }</pre> </div> - </div> - - </div> - <div id="method-i-sign" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sign(digest, data) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>To sign the String <em>data</em>, <em>digest</em>, an instance of <a href="../Digest.html"><code>OpenSSL::Digest</code></a>, must be provided. The return value is again a String containing the signature. A <a href="PKeyError.html"><code>PKeyError</code></a> is raised should errors occur. Any previous state of the <a href="../Digest.html"><code>Digest</code></a> instance is irrelevant to the signature outcome, the digest instance is reset to its initial state during the operation.</p> <h2 id="method-i-sign-label-Example">Example<span><a href="#method-i-sign-label-Example">¶</a> <a href="#top">↑</a></span></h2> @@ -455,10 +327,7 @@ ossl_pkey_public_to_pem(VALUE self) <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-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">2048</span>) <span class="ruby-identifier">signature</span> = <span class="ruby-identifier">pkey</span>.<span class="ruby-identifier">sign</span>(<span class="ruby-identifier">digest</span>, <span class="ruby-identifier">data</span>) </pre> - - - <div class="method-source-code" id="sign-source"> <pre>static VALUE ossl_pkey_sign(VALUE self, VALUE digest, VALUE data) @@ -495,31 +364,20 @@ ossl_pkey_sign(VALUE self, VALUE digest, VALUE data) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-verify" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> verify(digest, signature, data) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>To verify the String <em>signature</em>, <em>digest</em>, an instance of <a href="../Digest.html"><code>OpenSSL::Digest</code></a>, must be provided to re-compute the message digest of the original <em>data</em>, also a String. The return value is <code>true</code> if the signature is valid, <code>false</code> otherwise. A <a href="PKeyError.html"><code>PKeyError</code></a> is raised should errors occur. Any previous state of the <a href="../Digest.html"><code>Digest</code></a> instance is irrelevant to the validation outcome, the digest instance is reset to its initial state during the operation.</p> <h2 id="method-i-verify-label-Example">Example<span><a href="#method-i-verify-label-Example">¶</a> <a href="#top">↑</a></span></h2> @@ -531,10 +389,7 @@ ossl_pkey_sign(VALUE self, VALUE digest, VALUE data) <span class="ruby-identifier">pub_key</span> = <span class="ruby-identifier">pkey</span>.<span class="ruby-identifier">public_key</span> <span class="ruby-identifier">puts</span> <span class="ruby-identifier">pub_key</span>.<span class="ruby-identifier">verify</span>(<span class="ruby-identifier">digest</span>, <span class="ruby-identifier">signature</span>, <span class="ruby-identifier">data</span>) <span class="ruby-comment"># => true</span> </pre> - - - <div class="method-source-code" id="verify-source"> <pre>static VALUE ossl_pkey_verify(VALUE self, VALUE digest, VALUE sig, VALUE data) @@ -575,25 +430,20 @@ ossl_pkey_verify(VALUE self, VALUE digest, VALUE sig, VALUE data) } }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKey/PKeyError.html b/OpenSSL/PKey/PKeyError.html index ef83e844..bc13222a 100644 --- a/OpenSSL/PKey/PKeyError.html +++ b/OpenSSL/PKey/PKeyError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/PKey/RSA.html b/OpenSSL/PKey/RSA.html index 85018864..b9e47a43 100644 --- a/OpenSSL/PKey/RSA.html +++ b/OpenSSL/PKey/RSA.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,79 +57,52 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="PKey.html">OpenSSL::PKey::PKey</a> - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../Marshal.html">OpenSSL::Marshal</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- 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">::generate</a> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-blinding_off-21">#blinding_off!</a> - <li ><a href="#method-i-blinding_on-21">#blinding_on!</a> - <li ><a href="#method-i-export">#export</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-params">#params</a> - <li ><a href="#method-i-private-3F">#private?</a> - <li ><a href="#method-i-private_decrypt">#private_decrypt</a> - <li ><a href="#method-i-private_encrypt">#private_encrypt</a> - <li ><a href="#method-i-public-3F">#public?</a> - <li ><a href="#method-i-public_decrypt">#public_decrypt</a> - <li ><a href="#method-i-public_encrypt">#public_encrypt</a> - <li ><a href="#method-i-public_key">#public_key</a> - <li ><a href="#method-i-set_crt_params">#set_crt_params</a> - <li ><a href="#method-i-set_factors">#set_factors</a> - <li ><a href="#method-i-set_key">#set_key</a> - <li ><a href="#method-i-sign_pss">#sign_pss</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-to_text">#to_text</a> - <li ><a href="#method-i-verify_pss">#verify_pss</a> - </ul> </div> @@ -149,51 +120,33 @@ </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" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> generate(size) → RSA instance </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> generate(size, exponent) → RSA instance </span> - </div> - - <div class="method-description"> - <p>Generates an <a href="RSA.html"><code>RSA</code></a> keypair. <em>size</em> is an integer representing the desired key size. Keys smaller than 1024 should be considered insecure. <em>exponent</em> is an odd number normally 3, 17, or 65537.</p> - - - <div class="method-source-code" id="generate-source"> <pre>static VALUE ossl_rsa_s_generate(int argc, VALUE *argv, VALUE klass) @@ -216,45 +169,30 @@ ossl_rsa_s_generate(int argc, VALUE *argv, VALUE klass) return obj; }</pre> </div> - </div> - - </div> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new(key_size) → RSA instance </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(encoded_key) → RSA instance </span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(encoded_key, pass_phrase) → RSA instance </span> - </div> - - <div class="method-description"> - <p>Generates or loads an <a href="RSA.html"><code>RSA</code></a> keypair. If an integer <em>key_size</em> is given it represents the desired key size. Keys less than 1024 bits should be considered insecure.</p> <p>A key can instead be loaded from an <em>encoded_key</em> which must be PEM or DER encoded. A <em>pass_phrase</em> can be used to decrypt the key. If none is given <a href="../../OpenSSL.html"><code>OpenSSL</code></a> will prompt for the pass phrase.</p> @@ -265,10 +203,7 @@ ossl_rsa_s_generate(int argc, VALUE *argv, VALUE klass) <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">'rsa.pem'</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">'rsa.pem'</span>), <span class="ruby-string">'my pass phrase'</span> </pre> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_rsa_initialize(int argc, VALUE *argv, VALUE self) @@ -324,41 +259,28 @@ ossl_rsa_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-blinding_off-21" class="method-detail "> - <div class="method-heading"> <span class="method-name">blinding_off!</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="blinding_off-21-source"> <pre>static VALUE ossl_rsa_blinding_off(VALUE self) @@ -371,33 +293,21 @@ ossl_rsa_blinding_off(VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-blinding_on-21" class="method-detail "> - <div class="method-heading"> <span class="method-name">blinding_on!</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="blinding_on-21-source"> <pre>static VALUE ossl_rsa_blinding_on(VALUE self) @@ -412,50 +322,22 @@ ossl_rsa_blinding_on(VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-export" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> export([cipher, pass_phrase]) → PEM-format String </span> - <span class="method-click-advice">click to toggle source</span> - - </div> - - <div class="method-heading"> - <span class="method-callseq"> - to_pem([cipher, pass_phrase]) → PEM-format String - </span> - - </div> - - <div class="method-heading"> - <span class="method-callseq"> - to_s([cipher, pass_phrase]) → PEM-format String - </span> - </div> - - <div class="method-description"> - <p>Outputs this keypair in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt the key. <em>cipher</em> must be an <a href="../Cipher.html"><code>OpenSSL::Cipher</code></a> instance.</p> - - - <div class="method-source-code" id="export-source"> <pre>static VALUE ossl_rsa_export(int argc, VALUE *argv, VALUE self) @@ -497,37 +379,24 @@ ossl_rsa_export(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="RSA.html#method-i-to_pem">to_pem</a>, <a href="RSA.html#method-i-to_s">to_s</a> </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_rsa_initialize_copy(VALUE self, VALUE other) @@ -549,40 +418,26 @@ ossl_rsa_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-params" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> params → hash </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>THIS METHOD IS INSECURE, PRIVATE INFORMATION CAN LEAK OUT!!!</p> -<p>Stores all parameters of key to the hash. The hash has keys 'n', 'e', 'd', 'p', 'q', 'dmp1', 'dmq1', 'iqmp'.</p> +<p>Stores all parameters of key to the hash. The hash has keys ‘n’, ‘e’, ‘d’, ‘p’, ‘q’, ‘dmp1’, ‘dmq1’, ‘iqmp’.</p> -<p>Don't use :-)) (It's up to you)</p> - - +<p>Don’t use :-)) (It’s up to you)</p> - <div class="method-source-code" id="params-source"> <pre>static VALUE ossl_rsa_get_params(VALUE self) @@ -609,36 +464,22 @@ ossl_rsa_get_params(VALUE self) return hash; }</pre> </div> - </div> - - </div> - <div id="method-i-private-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> private? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Does this keypair contain a private key?</p> - - - <div class="method-source-code" id="private-3F-source"> <pre>static VALUE ossl_rsa_is_private(VALUE self) @@ -650,43 +491,27 @@ ossl_rsa_is_private(VALUE self) return RSA_PRIVATE(self, rsa) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-private_decrypt" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> private_decrypt(string) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> private_decrypt(string, padding) → String </span> - </div> - - <div class="method-description"> - <p>Decrypt <em>string</em>, which has been encrypted with the public key, with the private key. <em>padding</em> defaults to PKCS1_PADDING.</p> - - - <div class="method-source-code" id="private_decrypt-source"> <pre>static VALUE ossl_rsa_private_decrypt(int argc, VALUE *argv, VALUE self) @@ -714,43 +539,27 @@ ossl_rsa_private_decrypt(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-private_encrypt" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> private_encrypt(string) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> private_encrypt(string, padding) → String </span> - </div> - - <div class="method-description"> - <p>Encrypt <em>string</em> with the private key. <em>padding</em> defaults to PKCS1_PADDING. The encrypted string output can be decrypted using <a href="RSA.html#method-i-public_decrypt"><code>public_decrypt</code></a>.</p> - - - <div class="method-source-code" id="private_encrypt-source"> <pre>static VALUE ossl_rsa_private_encrypt(int argc, VALUE *argv, VALUE self) @@ -778,36 +587,22 @@ ossl_rsa_private_encrypt(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-public-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public? → true </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>The return value is always <code>true</code> since every private key is also a public key.</p> - - - <div class="method-source-code" id="public-3F-source"> <pre>static VALUE ossl_rsa_is_public(VALUE self) @@ -822,43 +617,27 @@ ossl_rsa_is_public(VALUE self) return Qtrue; }</pre> </div> - </div> - - </div> - <div id="method-i-public_decrypt" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_decrypt(string) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> public_decrypt(string, padding) → String </span> - </div> - - <div class="method-description"> - <p>Decrypt <em>string</em>, which has been encrypted with the private key, with the public key. <em>padding</em> defaults to PKCS1_PADDING.</p> - - - <div class="method-source-code" id="public_decrypt-source"> <pre>static VALUE ossl_rsa_public_decrypt(int argc, VALUE *argv, VALUE self) @@ -884,43 +663,27 @@ ossl_rsa_public_decrypt(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-public_encrypt" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_encrypt(string) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> public_encrypt(string, padding) → String </span> - </div> - - <div class="method-description"> - <p>Encrypt <em>string</em> with the public key. <em>padding</em> defaults to PKCS1_PADDING. The encrypted string output can be decrypted using <a href="RSA.html#method-i-private_decrypt"><code>private_decrypt</code></a>.</p> - - - <div class="method-source-code" id="public_encrypt-source"> <pre>static VALUE ossl_rsa_public_encrypt(int argc, VALUE *argv, VALUE self) @@ -946,36 +709,22 @@ ossl_rsa_public_encrypt(int argc, VALUE *argv, VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-public_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_key → RSA </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Makes new <a href="RSA.html"><code>RSA</code></a> instance containing the public key from the private key.</p> - - - <div class="method-source-code" id="public_key-source"> <pre>static VALUE ossl_rsa_to_public_key(VALUE self) @@ -995,112 +744,65 @@ ossl_rsa_to_public_key(VALUE self) return obj; }</pre> </div> - </div> - - </div> - <div id="method-i-set_crt_params" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_crt_params(dmp1, dmq1, iqmp) → self </span> - </div> - - <div class="method-description"> - <p>Sets <em>dmp1</em>, <em>dmq1</em>, <em>iqmp</em> for the <a href="RSA.html"><code>RSA</code></a> instance. They are calculated by <code>d mod (p - 1)</code>, <code>d mod (q - 1)</code> and <code>q^(-1) mod p</code> respectively.</p> - - - </div> - - </div> - <div id="method-i-set_factors" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_factors(p, q) → self </span> - </div> - - <div class="method-description"> - <p>Sets <em>p</em>, <em>q</em> for the <a href="RSA.html"><code>RSA</code></a> instance.</p> - - - </div> - - </div> - <div id="method-i-set_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_key(n, e, d) → self </span> - </div> - - <div class="method-description"> - <p>Sets <em>n</em>, <em>e</em>, <em>d</em> for the <a href="RSA.html"><code>RSA</code></a> instance.</p> - - - </div> - - </div> - <div id="method-i-sign_pss" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sign_pss(digest, data, salt_length:, mgf1_hash:) → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Signs <em>data</em> using the Probabilistic Signature Scheme (RSA-PSS) and returns the calculated signature.</p> <p><a href="RSAError.html"><code>RSAError</code></a> will be raised if an error occurs.</p> @@ -1131,10 +833,7 @@ ossl_rsa_to_public_key(VALUE self) <span class="ruby-identifier">puts</span> <span class="ruby-identifier">pub_key</span>.<span class="ruby-identifier">verify_pss</span>(<span class="ruby-string">"SHA256"</span>, <span class="ruby-identifier">signature</span>, <span class="ruby-identifier">data</span>, <span class="ruby-value">salt_length:</span> <span class="ruby-value">:auto</span>, <span class="ruby-value">mgf1_hash:</span> <span class="ruby-string">"SHA256"</span>) <span class="ruby-comment"># => true</span> </pre> - - - <div class="method-source-code" id="sign_pss-source"> <pre>static VALUE ossl_rsa_sign_pss(int argc, VALUE *argv, VALUE self) @@ -1200,36 +899,22 @@ ossl_rsa_sign_pss(int argc, VALUE *argv, VALUE self) ossl_raise(eRSAError, NULL); }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → DER-format String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Outputs this keypair in DER encoding.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_rsa_to_der(VALUE self) @@ -1260,96 +945,62 @@ ossl_rsa_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">to_pem</span><span - class="method-args">(p1 = v1, p2 = v2)</span> - + <span class="method-callseq"> + to_pem([cipher, pass_phrase]) → PEM-format String + </span> </div> - <div class="method-description"> - - - - + <p>Outputs this keypair in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt the key. <em>cipher</em> must be an <a href="../Cipher.html"><code>OpenSSL::Cipher</code></a> instance.</p> - </div> - - <div class="aliases"> Alias for: <a href="RSA.html#method-i-export">export</a> </div> - </div> - <div id="method-i-to_s" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name">to_s</span><span - class="method-args">(p1 = v1, p2 = v2)</span> - + <span class="method-callseq"> + to_s([cipher, pass_phrase]) → PEM-format String + </span> </div> - <div class="method-description"> - - - - + <p>Outputs this keypair in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt the key. <em>cipher</em> must be an <a href="../Cipher.html"><code>OpenSSL::Cipher</code></a> instance.</p> - </div> - - <div class="aliases"> Alias for: <a href="RSA.html#method-i-export">export</a> </div> - </div> - <div id="method-i-to_text" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_text → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>THIS METHOD IS INSECURE, PRIVATE INFORMATION CAN LEAK OUT!!!</p> <p>Dumps all parameters of a keypair to a String</p> -<p>Don't use :-)) (It's up to you)</p> - - +<p>Don’t use :-)) (It’s up to you)</p> - <div class="method-source-code" id="to_text-source"> <pre>static VALUE ossl_rsa_to_text(VALUE self) @@ -1371,31 +1022,20 @@ ossl_rsa_to_text(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-verify_pss" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> verify_pss(digest, signature, data, salt_length:, mgf1_hash:) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Verifies <em>data</em> using the Probabilistic Signature Scheme (RSA-PSS).</p> <p>The return value is <code>true</code> if the signature is valid, <code>false</code> otherwise. <a href="RSAError.html"><code>RSAError</code></a> will be raised if an error occurs.</p> @@ -1416,10 +1056,7 @@ ossl_rsa_to_text(VALUE self) <dd> <p>The hash algorithm used in MGF1.</p> </dd></dl> - - - <div class="method-source-code" id="verify_pss-source"> <pre>static VALUE ossl_rsa_verify_pss(int argc, VALUE *argv, VALUE self) @@ -1491,25 +1128,20 @@ ossl_rsa_verify_pss(int argc, VALUE *argv, VALUE self) ossl_raise(eRSAError, NULL); }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/PKey/RSAError.html b/OpenSSL/PKey/RSAError.html index b8b9305b..36ff86f5 100644 --- a/OpenSSL/PKey/RSAError.html +++ b/OpenSSL/PKey/RSAError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="PKeyError.html">OpenSSL::PKey::PKeyError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/Random.html b/OpenSSL/Random.html index f83612bb..4f37b6a5 100644 --- a/OpenSSL/Random.html +++ b/OpenSSL/Random.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -62,28 +60,20 @@ - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-egd">::egd</a> - <li ><a href="#method-c-egd_bytes">::egd_bytes</a> - <li ><a href="#method-c-load_random_file">::load_random_file</a> - <li ><a href="#method-c-random_add">::random_add</a> - <li ><a href="#method-c-random_bytes">::random_bytes</a> - <li ><a href="#method-c-seed">::seed</a> - <li ><a href="#method-c-status-3F">::status?</a> - <li ><a href="#method-c-write_random_file">::write_random_file</a> - </ul> </div> @@ -99,44 +89,28 @@ </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-egd" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> egd(filename) → true </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Same as <a href="Random.html#method-c-egd_bytes"><code>::egd_bytes</code></a> but queries 255 bytes by default.</p> - - - <div class="method-source-code" id="egd-source"> <pre>static VALUE ossl_rand_egd(VALUE self, VALUE filename) @@ -147,38 +121,24 @@ ossl_rand_egd(VALUE self, VALUE filename) return Qtrue; }</pre> </div> - </div> - - </div> - <div id="method-c-egd_bytes" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> egd_bytes(filename, length) → true </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Queries the entropy gathering daemon EGD on socket path given by <em>filename</em>.</p> <p>Fetches <em>length</em> number of bytes and uses ::add to seed the <a href="../OpenSSL.html"><code>OpenSSL</code></a> built-in PRNG.</p> - - - <div class="method-source-code" id="egd_bytes-source"> <pre>static VALUE ossl_rand_egd_bytes(VALUE self, VALUE filename, VALUE len) @@ -191,36 +151,22 @@ ossl_rand_egd_bytes(VALUE self, VALUE filename, VALUE len) return Qtrue; }</pre> </div> - </div> - - </div> - <div id="method-c-load_random_file" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> load_random_file(filename) → true </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Reads bytes from <em>filename</em> and adds them to the PRNG.</p> - - - <div class="method-source-code" id="load_random_file-source"> <pre>static VALUE ossl_rand_load_file(VALUE self, VALUE filename) @@ -231,31 +177,20 @@ ossl_rand_load_file(VALUE self, VALUE filename) return Qtrue; }</pre> </div> - </div> - - </div> - <div id="method-c-random_add" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add(str, entropy) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Mixes the bytes from <em>str</em> into the Pseudo <a href="Random.html"><code>Random</code></a> Number Generator(PRNG) state.</p> <p>Thus, if the data from <em>str</em> are unpredictable to an adversary, this increases the uncertainty about the state and makes the PRNG output less predictable.</p> @@ -270,10 +205,7 @@ ossl_rand_load_file(VALUE self, VALUE filename) <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Random</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">ary</span>.<span class="ruby-identifier">join</span>, <span class="ruby-value">0.0</span>) <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Random</span>.<span class="ruby-identifier">seed</span>(<span class="ruby-identifier">ary</span>.<span class="ruby-identifier">join</span>) </pre> - - - <div class="method-source-code" id="random_add-source"> <pre>static VALUE ossl_rand_add(VALUE self, VALUE str, VALUE entropy) @@ -284,31 +216,20 @@ ossl_rand_add(VALUE self, VALUE str, VALUE entropy) return self; }</pre> </div> - </div> - - </div> - <div id="method-c-random_bytes" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> random_bytes(length) → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Generates a String with <em>length</em> number of cryptographically strong pseudo-random bytes.</p> <h3 id="method-c-random_bytes-label-Example">Example<span><a href="#method-c-random_bytes-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -316,10 +237,7 @@ ossl_rand_add(VALUE self, VALUE str, VALUE entropy) <pre class="ruby"><span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">Random</span>.<span class="ruby-identifier">random_bytes</span>(<span class="ruby-value">12</span>) <span class="ruby-comment">#=> "..."</span> </pre> - - - <div class="method-source-code" id="random_bytes-source"> <pre>static VALUE ossl_rand_bytes(VALUE self, VALUE len) @@ -339,36 +257,22 @@ ossl_rand_bytes(VALUE self, VALUE len) return str; }</pre> </div> - </div> - - </div> - <div id="method-c-seed" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> seed(str) → str </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p><a href="Random.html#method-c-seed"><code>::seed</code></a> is equivalent to ::add where <em>entropy</em> is length of <em>str</em>.</p> - - - <div class="method-source-code" id="seed-source"> <pre>static VALUE ossl_rand_seed(VALUE self, VALUE str) @@ -379,36 +283,22 @@ ossl_rand_seed(VALUE self, VALUE str) return str; }</pre> </div> - </div> - - </div> - <div id="method-c-status-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> status? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Return <code>true</code> if the PRNG has been seeded with enough data, <code>false</code> otherwise.</p> - - - <div class="method-source-code" id="status-3F-source"> <pre>static VALUE ossl_rand_status(VALUE self) @@ -416,36 +306,22 @@ ossl_rand_status(VALUE self) return RAND_status() ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-c-write_random_file" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> write_random_file(filename) → true </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Writes a number of random generated bytes (currently 1024) to <em>filename</em> which can be used to initialize the PRNG by calling <a href="Random.html#method-c-load_random_file"><code>::load_random_file</code></a> in a later session.</p> - - - <div class="method-source-code" id="write_random_file-source"> <pre>static VALUE ossl_rand_write_file(VALUE self, VALUE filename) @@ -456,25 +332,20 @@ ossl_rand_write_file(VALUE self, VALUE filename) return Qtrue; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Random/RandomError.html b/OpenSSL/Random/RandomError.html index 5cd70276..d004dc9a 100644 --- a/OpenSSL/Random/RandomError.html +++ b/OpenSSL/Random/RandomError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/SSL.html b/OpenSSL/SSL.html index 7a70cf1a..0482e0ee 100644 --- a/OpenSSL/SSL.html +++ b/OpenSSL/SSL.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -62,14 +60,13 @@ - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-verify_certificate_identity">::verify_certificate_identity</a> - </ul> </div> @@ -87,300 +84,134 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="OP_ALL">OP_ALL - <dd> - - <dt id="OP_ALLOW_NO_DHE_KEX">OP_ALLOW_NO_DHE_KEX - <dd> - - <dt id="OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION">OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION - <dd> - - <dt id="OP_CIPHER_SERVER_PREFERENCE">OP_CIPHER_SERVER_PREFERENCE - <dd> - - <dt id="OP_CISCO_ANYCONNECT">OP_CISCO_ANYCONNECT - <dd> - - <dt id="OP_COOKIE_EXCHANGE">OP_COOKIE_EXCHANGE - <dd> - - <dt id="OP_CRYPTOPRO_TLSEXT_BUG">OP_CRYPTOPRO_TLSEXT_BUG - <dd> - - <dt id="OP_DONT_INSERT_EMPTY_FRAGMENTS">OP_DONT_INSERT_EMPTY_FRAGMENTS - <dd> - - <dt id="OP_EPHEMERAL_RSA">OP_EPHEMERAL_RSA - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.0.1k and 1.0.2.</p> - - <dt id="OP_LEGACY_SERVER_CONNECT">OP_LEGACY_SERVER_CONNECT - <dd> - - <dt id="OP_MICROSOFT_BIG_SSLV3_BUFFER">OP_MICROSOFT_BIG_SSLV3_BUFFER - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> - - <dt id="OP_MICROSOFT_SESS_ID_BUG">OP_MICROSOFT_SESS_ID_BUG - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> - - <dt id="OP_MSIE_SSLV2_RSA_PADDING">OP_MSIE_SSLV2_RSA_PADDING - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 0.9.7h and 0.9.8b.</p> - - <dt id="OP_NETSCAPE_CA_DN_BUG">OP_NETSCAPE_CA_DN_BUG - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> - - <dt id="OP_NETSCAPE_CHALLENGE_BUG">OP_NETSCAPE_CHALLENGE_BUG - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> - - <dt id="OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG">OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> - - <dt id="OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG">OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 0.9.8q and 1.0.0c.</p> - - <dt id="OP_NO_COMPRESSION">OP_NO_COMPRESSION - <dd> - - <dt id="OP_NO_ENCRYPT_THEN_MAC">OP_NO_ENCRYPT_THEN_MAC - <dd> - - <dt id="OP_NO_QUERY_MTU">OP_NO_QUERY_MTU - <dd> - - <dt id="OP_NO_RENEGOTIATION">OP_NO_RENEGOTIATION - <dd> - - <dt id="OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION">OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION - <dd> - - <dt id="OP_NO_SSLv2">OP_NO_SSLv2 - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> - - <dt id="OP_NO_SSLv3">OP_NO_SSLv3 - <dd> - - <dt id="OP_NO_TICKET">OP_NO_TICKET - <dd> - - <dt id="OP_NO_TLSv1">OP_NO_TLSv1 - <dd> - - <dt id="OP_NO_TLSv1_1">OP_NO_TLSv1_1 - <dd> - - <dt id="OP_NO_TLSv1_2">OP_NO_TLSv1_2 - <dd> - - <dt id="OP_NO_TLSv1_3">OP_NO_TLSv1_3 - <dd> - - <dt id="OP_PKCS1_CHECK_1">OP_PKCS1_CHECK_1 - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.0.1.</p> - - <dt id="OP_PKCS1_CHECK_2">OP_PKCS1_CHECK_2 - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.0.1.</p> - - <dt id="OP_SAFARI_ECDHE_ECDSA_BUG">OP_SAFARI_ECDHE_ECDSA_BUG - <dd> - - <dt id="OP_SINGLE_DH_USE">OP_SINGLE_DH_USE - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> - - <dt id="OP_SINGLE_ECDH_USE">OP_SINGLE_ECDH_USE - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> - - <dt id="OP_SSLEAY_080_CLIENT_DH_BUG">OP_SSLEAY_080_CLIENT_DH_BUG - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> - - <dt id="OP_SSLREF2_REUSE_CERT_TYPE_BUG">OP_SSLREF2_REUSE_CERT_TYPE_BUG - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.0.1h and 1.0.2.</p> - - <dt id="OP_TLSEXT_PADDING">OP_TLSEXT_PADDING - <dd> - - <dt id="OP_TLS_BLOCK_PADDING_BUG">OP_TLS_BLOCK_PADDING_BUG - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> - - <dt id="OP_TLS_D5_BUG">OP_TLS_D5_BUG - <dd><p>Deprecated in <a href="../OpenSSL.html"><code>OpenSSL</code></a> 1.1.0.</p> - - <dt id="OP_TLS_ROLLBACK_BUG">OP_TLS_ROLLBACK_BUG - <dd> - - <dt id="SSL2_VERSION">SSL2_VERSION - <dd><p><a href="SSL.html"><code>SSL</code></a> 2.0</p> - - <dt id="SSL3_VERSION">SSL3_VERSION - <dd><p><a href="SSL.html"><code>SSL</code></a> 3.0</p> - - <dt id="TLS1_1_VERSION">TLS1_1_VERSION - <dd><p>TLS 1.1</p> - - <dt id="TLS1_2_VERSION">TLS1_2_VERSION - <dd><p>TLS 1.2</p> - - <dt id="TLS1_3_VERSION">TLS1_3_VERSION - <dd><p>TLS 1.3</p> - - <dt id="TLS1_VERSION">TLS1_VERSION - <dd><p>TLS 1.0</p> - - <dt id="VERIFY_CLIENT_ONCE">VERIFY_CLIENT_ONCE - <dd> - - <dt id="VERIFY_FAIL_IF_NO_PEER_CERT">VERIFY_FAIL_IF_NO_PEER_CERT - <dd> - - <dt id="VERIFY_NONE">VERIFY_NONE - <dd> - - <dt id="VERIFY_PEER">VERIFY_PEER - <dd> - - </dl> </section> - - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-verify_certificate_identity" class="method-detail "> - <div class="method-heading"> <span class="method-name">verify_certificate_identity</span><span class="method-args">(cert, hostname)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="verify_certificate_identity-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 269</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verify_certificate_identity</span>(<span class="ruby-identifier">cert</span>, <span class="ruby-identifier">hostname</span>) @@ -415,25 +246,20 @@ <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/SSL/SSLContext.html b/OpenSSL/SSL/SSLContext.html index 5112e364..c80edeca 100644 --- a/OpenSSL/SSL/SSLContext.html +++ b/OpenSSL/SSL/SSLContext.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,70 +57,45 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-add_certificate">#add_certificate</a> - <li ><a href="#method-i-ciphers">#ciphers</a> - <li ><a href="#method-i-ciphers-3D">#ciphers=</a> - <li ><a href="#method-i-ecdh_curves-3D">#ecdh_curves=</a> - <li ><a href="#method-i-enable_fallback_scsv">#enable_fallback_scsv</a> - <li ><a href="#method-i-flush_sessions">#flush_sessions</a> - <li ><a href="#method-i-freeze">#freeze</a> - <li ><a href="#method-i-max_version-3D">#max_version=</a> - <li ><a href="#method-i-min_version-3D">#min_version=</a> - <li ><a href="#method-i-options">#options</a> - <li ><a href="#method-i-options-3D">#options=</a> - <li ><a href="#method-i-security_level">#security_level</a> - <li ><a href="#method-i-security_level-3D">#security_level=</a> - <li ><a href="#method-i-session_add">#session_add</a> - <li ><a href="#method-i-session_cache_mode">#session_cache_mode</a> - <li ><a href="#method-i-session_cache_mode-3D">#session_cache_mode=</a> - <li ><a href="#method-i-session_cache_size">#session_cache_size</a> - <li ><a href="#method-i-session_cache_size-3D">#session_cache_size=</a> - <li ><a href="#method-i-session_cache_stats">#session_cache_stats</a> - <li ><a href="#method-i-session_remove">#session_remove</a> - <li ><a href="#method-i-set_params">#set_params</a> - <li ><a href="#method-i-setup">#setup</a> - <li ><a href="#method-i-ssl_version-3D">#ssl_version=</a> - </ul> </div> @@ -142,82 +115,44 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="DEFAULT_2048">DEFAULT_2048 - <dd> - - <dt id="METHODS">METHODS - <dd><p>The list of available SSL/TLS methods. This constant is only provided for backwards compatibility.</p> - - <dt id="SESSION_CACHE_BOTH">SESSION_CACHE_BOTH - <dd><p>Both client and server sessions are added to the session cache</p> - - <dt id="SESSION_CACHE_CLIENT">SESSION_CACHE_CLIENT - <dd><p>Client sessions are added to the session cache</p> - - <dt id="SESSION_CACHE_NO_AUTO_CLEAR">SESSION_CACHE_NO_AUTO_CLEAR - <dd><p>Normally the session cache is checked for expired sessions every 255 connections. Since this may lead to a delay that cannot be controlled, the automatic flushing may be disabled and <a href="SSLContext.html#method-i-flush_sessions"><code>flush_sessions</code></a> can be called explicitly.</p> - - <dt id="SESSION_CACHE_NO_INTERNAL">SESSION_CACHE_NO_INTERNAL - <dd><p>Enables both <a href="SSLContext.html#SESSION_CACHE_NO_INTERNAL_LOOKUP"><code>SESSION_CACHE_NO_INTERNAL_LOOKUP</code></a> and <a href="SSLContext.html#SESSION_CACHE_NO_INTERNAL_STORE"><code>SESSION_CACHE_NO_INTERNAL_STORE</code></a>.</p> - - <dt id="SESSION_CACHE_NO_INTERNAL_LOOKUP">SESSION_CACHE_NO_INTERNAL_LOOKUP - <dd><p>Always perform external lookups of sessions even if they are in the internal cache.</p> <p>This flag has no effect on clients</p> - - <dt id="SESSION_CACHE_NO_INTERNAL_STORE">SESSION_CACHE_NO_INTERNAL_STORE - <dd><p>Never automatically store sessions in the internal store.</p> - - <dt id="SESSION_CACHE_OFF">SESSION_CACHE_OFF - <dd><p>No session caching for client or server</p> - - <dt id="SESSION_CACHE_SERVER">SESSION_CACHE_SERVER - <dd><p>Server sessions are added to the session cache</p> - - </dl> </section> - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-alpn_protocols" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">alpn_protocols</span><span @@ -225,17 +160,14 @@ </div> <div class="method-description"> - <p>An Enumerable of Strings. Each String represents a protocol to be advertised as the list of supported protocols for Application-Layer Protocol Negotiation. Supported in <a href="../../OpenSSL.html"><code>OpenSSL</code></a> 1.0.2 and higher. Has no effect on the server side. If not set explicitly, the ALPN extension will not be included in the handshake.</p> <h3 id="attribute-i-alpn_protocols-label-Example">Example<span><a href="#attribute-i-alpn_protocols-label-Example">¶</a> <a href="#top">↑</a></span></h3> <pre class="ruby"><span class="ruby-identifier">ctx</span>.<span class="ruby-identifier">alpn_protocols</span> = [<span class="ruby-string">"http/1.1"</span>, <span class="ruby-string">"spdy/2"</span>, <span class="ruby-string">"h2"</span>] </pre> - </div> </div> - <div id="attribute-i-alpn_select_cb" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">alpn_select_cb</span><span @@ -243,7 +175,6 @@ </div> <div class="method-description"> - <p>A callback invoked on the server side when the server needs to select a protocol from the list sent by the client. Supported in <a href="../../OpenSSL.html"><code>OpenSSL</code></a> 1.0.2 and higher. The callback must return a protocol of those advertised by the client. If none is acceptable, raising an error in the callback will cause the handshake to fail. Not setting this callback explicitly means not supporting the ALPN extension on the server - any protocols advertised by the client will be ignored.</p> <h3 id="attribute-i-alpn_select_cb-label-Example">Example<span><a href="#attribute-i-alpn_select_cb-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -253,10 +184,8 @@ <span class="ruby-identifier">protocols</span>.<span class="ruby-identifier">first</span> <span class="ruby-keyword">end</span> </pre> - </div> </div> - <div id="attribute-i-ca_file" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">ca_file</span><span @@ -264,12 +193,9 @@ </div> <div class="method-description"> - <p>The path to a file containing a PEM-format CA certificate</p> - </div> </div> - <div id="attribute-i-ca_path" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">ca_path</span><span @@ -277,14 +203,11 @@ </div> <div class="method-description"> - <p>The path to a directory containing CA certificates in PEM format.</p> -<p>Files are looked up by subject's <a href="../X509.html"><code>X509</code></a> name's hash value.</p> - +<p>Files are looked up by subject’s <a href="../X509.html"><code>X509</code></a> name’s hash value.</p> </div> </div> - <div id="attribute-i-cert" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">cert</span><span @@ -292,14 +215,11 @@ </div> <div class="method-description"> - <p>Context certificate</p> <p>The <em>cert</em>, <em>key</em>, and <em>extra_chain_cert</em> attributes are deprecated. It is recommended to use <a href="SSLContext.html#method-i-add_certificate"><code>add_certificate</code></a> instead.</p> - </div> </div> - <div id="attribute-i-cert_store" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">cert_store</span><span @@ -307,12 +227,9 @@ </div> <div class="method-description"> - <p>An <a href="../X509/Store.html"><code>OpenSSL::X509::Store</code></a> used for certificate verification.</p> - </div> </div> - <div id="attribute-i-client_ca" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">client_ca</span><span @@ -320,12 +237,9 @@ </div> <div class="method-description"> - <p>A certificate or Array of certificates that will be sent to the client.</p> - </div> </div> - <div id="attribute-i-client_cert_cb" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">client_cert_cb</span><span @@ -333,14 +247,11 @@ </div> <div class="method-description"> - <p>A callback invoked when a client certificate is requested by a server and no certificate has been set.</p> <p>The callback is invoked with a <a href="Session.html"><code>Session</code></a> and must return an Array containing an <a href="../X509/Certificate.html"><code>OpenSSL::X509::Certificate</code></a> and an <a href="../PKey.html"><code>OpenSSL::PKey</code></a>. If any other value is returned the handshake is suspended.</p> - </div> </div> - <div id="attribute-i-extra_chain_cert" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">extra_chain_cert</span><span @@ -348,14 +259,11 @@ </div> <div class="method-description"> - <p>An Array of extra <a href="../X509.html"><code>X509</code></a> certificates to be added to the certificate chain.</p> <p>The <em>cert</em>, <em>key</em>, and <em>extra_chain_cert</em> attributes are deprecated. It is recommended to use <a href="SSLContext.html#method-i-add_certificate"><code>add_certificate</code></a> instead.</p> - </div> </div> - <div id="attribute-i-key" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">key</span><span @@ -363,14 +271,11 @@ </div> <div class="method-description"> - <p>Context private key</p> <p>The <em>cert</em>, <em>key</em>, and <em>extra_chain_cert</em> attributes are deprecated. It is recommended to use <a href="SSLContext.html#method-i-add_certificate"><code>add_certificate</code></a> instead.</p> - </div> </div> - <div id="attribute-i-npn_protocols" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">npn_protocols</span><span @@ -378,17 +283,14 @@ </div> <div class="method-description"> - <p>An Enumerable of Strings. Each String represents a protocol to be advertised as the list of supported protocols for Next Protocol Negotiation. Supported in <a href="../../OpenSSL.html"><code>OpenSSL</code></a> 1.0.1 and higher. Has no effect on the client side. If not set explicitly, the NPN extension will not be sent by the server in the handshake.</p> <h3 id="attribute-i-npn_protocols-label-Example">Example<span><a href="#attribute-i-npn_protocols-label-Example">¶</a> <a href="#top">↑</a></span></h3> <pre class="ruby"><span class="ruby-identifier">ctx</span>.<span class="ruby-identifier">npn_protocols</span> = [<span class="ruby-string">"http/1.1"</span>, <span class="ruby-string">"spdy/2"</span>] </pre> - </div> </div> - <div id="attribute-i-npn_select_cb" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">npn_select_cb</span><span @@ -396,7 +298,6 @@ </div> <div class="method-description"> - <p>A callback invoked on the client side when the client needs to select a protocol from the list sent by the server. Supported in <a href="../../OpenSSL.html"><code>OpenSSL</code></a> 1.0.1 and higher. The client MUST select a protocol of those advertised by the server. If none is acceptable, raising an error in the callback will cause the handshake to fail. Not setting this callback explicitly means not supporting the NPN extension on the client - any protocols advertised by the server will be ignored.</p> <h3 id="attribute-i-npn_select_cb-label-Example">Example<span><a href="#attribute-i-npn_select_cb-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -406,10 +307,8 @@ <span class="ruby-identifier">protocols</span>.<span class="ruby-identifier">first</span> <span class="ruby-keyword">end</span> </pre> - </div> </div> - <div id="attribute-i-renegotiation_cb" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">renegotiation_cb</span><span @@ -417,10 +316,9 @@ </div> <div class="method-description"> - <p>A callback invoked whenever a new handshake is initiated on an established connection. May be used to disable renegotiation entirely.</p> -<p>The callback is invoked with the active <a href="SSLSocket.html"><code>SSLSocket</code></a>. The callback's return value is ignored. A normal return indicates “approval” of the renegotiation and will continue the process. To forbid renegotiation and to cancel the process, raise an exception within the callback.</p> +<p>The callback is invoked with the active <a href="SSLSocket.html"><code>SSLSocket</code></a>. The callback’s return value is ignored. A normal return indicates “approval” of the renegotiation and will continue the process. To forbid renegotiation and to cancel the process, raise an exception within the callback.</p> <h3 id="attribute-i-renegotiation_cb-label-Disable+client+renegotiation">Disable client renegotiation<span><a href="#attribute-i-renegotiation_cb-label-Disable+client+renegotiation">¶</a> <a href="#top">↑</a></span></h3> @@ -430,10 +328,8 @@ <span class="ruby-identifier">raise</span> <span class="ruby-constant">RuntimeError</span>, <span class="ruby-string">"Client renegotiation disabled"</span> <span class="ruby-keyword">end</span> </pre> - </div> </div> - <div id="attribute-i-servername_cb" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">servername_cb</span><span @@ -441,14 +337,11 @@ </div> <div class="method-description"> - <p>A callback invoked at connect time to distinguish between multiple server names.</p> <p>The callback is invoked with an <a href="SSLSocket.html"><code>SSLSocket</code></a> and a server name. The callback must return an <a href="SSLContext.html"><code>SSLContext</code></a> for the server name or nil.</p> - </div> </div> - <div id="attribute-i-session_get_cb" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">session_get_cb</span><span @@ -456,14 +349,11 @@ </div> <div class="method-description"> - - <p>A callback invoked on a server when a session is proposed by the client but the session could not be found in the server's internal cache.</p> + <p>A callback invoked on a server when a session is proposed by the client but the session could not be found in the server’s internal cache.</p> <p>The callback is invoked with the <a href="SSLSocket.html"><code>SSLSocket</code></a> and session id. The callback may return a <a href="Session.html"><code>Session</code></a> from an external cache.</p> - </div> </div> - <div id="attribute-i-session_id_context" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">session_id_context</span><span @@ -471,12 +361,9 @@ </div> <div class="method-description"> - <p>Sets the context in which a session can be reused. This allows sessions for multiple applications to be distinguished, for example, by name.</p> - </div> </div> - <div id="attribute-i-session_new_cb" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">session_new_cb</span><span @@ -484,14 +371,11 @@ </div> <div class="method-description"> - <p>A callback invoked when a new session was negotiated.</p> <p>The callback is invoked with an <a href="SSLSocket.html"><code>SSLSocket</code></a>. If <code>false</code> is returned the session will be removed from the internal cache.</p> - </div> </div> - <div id="attribute-i-session_remove_cb" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">session_remove_cb</span><span @@ -499,16 +383,13 @@ </div> <div class="method-description"> - <p>A callback invoked when a session is removed from the internal cache.</p> <p>The callback is invoked with an <a href="SSLContext.html"><code>SSLContext</code></a> and a <a href="Session.html"><code>Session</code></a>.</p> <p>IMPORTANT NOTE: It is currently not possible to use this safely in a multi-threaded application. The callback is called inside a global lock and it can randomly cause deadlock on Ruby thread switching.</p> - </div> </div> - <div id="attribute-i-ssl_timeout" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">ssl_timeout</span><span @@ -516,12 +397,9 @@ </div> <div class="method-description"> - <p>Maximum session lifetime in seconds.</p> - </div> </div> - <div id="attribute-i-timeout" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">timeout</span><span @@ -529,12 +407,9 @@ </div> <div class="method-description"> - <p>Maximum session lifetime in seconds.</p> - </div> </div> - <div id="attribute-i-tmp_dh_callback" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">tmp_dh_callback</span><span @@ -542,16 +417,13 @@ </div> <div class="method-description"> - <p>A callback invoked when DH parameters are required.</p> <p>The callback is invoked with the <a href="Session.html"><code>Session</code></a> for the key exchange, an flag indicating the use of an export cipher and the keylength required.</p> <p>The callback must return an <a href="../PKey/DH.html"><code>OpenSSL::PKey::DH</code></a> instance of the correct key length.</p> - </div> </div> - <div id="attribute-i-tmp_ecdh_callback" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">tmp_ecdh_callback</span><span @@ -559,16 +431,13 @@ </div> <div class="method-description"> - <p>A callback invoked when ECDH parameters are required.</p> <p>The callback is invoked with the <a href="Session.html"><code>Session</code></a> for the key exchange, an flag indicating the use of an export cipher and the keylength required.</p> <p>The callback is deprecated. This does not work with recent versions of <a href="../../OpenSSL.html"><code>OpenSSL</code></a>. Use <a href="SSLContext.html#method-i-ecdh_curves-3D"><code>OpenSSL::SSL::SSLContext#ecdh_curves=</code></a> instead.</p> - </div> </div> - <div id="attribute-i-verify_callback" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">verify_callback</span><span @@ -576,16 +445,13 @@ </div> <div class="method-description"> - <p>A callback for additional certificate verification. The callback is invoked for each certificate in the chain.</p> <p>The callback is invoked with two values. <em>preverify_ok</em> indicates indicates if the verification was passed (<code>true</code>) or not (<code>false</code>). <em>store_context</em> is an <a href="../X509/StoreContext.html"><code>OpenSSL::X509::StoreContext</code></a> containing the context used for certificate verification.</p> <p>If the callback returns <code>false</code>, the chain verification is immediately stopped and a bad_certificate alert is then sent.</p> - </div> </div> - <div id="attribute-i-verify_depth" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">verify_depth</span><span @@ -593,12 +459,9 @@ </div> <div class="method-description"> - <p>Number of CA certificates to walk when verifying a certificate chain.</p> - </div> </div> - <div id="attribute-i-verify_hostname" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">verify_hostname</span><span @@ -606,14 +469,11 @@ </div> <div class="method-description"> - <p>Whether to check the server certificate is valid for the hostname.</p> <p>In order to make this work, <a href="SSLContext.html#attribute-i-verify_mode"><code>verify_mode</code></a> must be set to VERIFY_PEER and the server hostname must be given by <a href="SSLSocket.html#method-i-hostname-3D"><code>OpenSSL::SSL::SSLSocket#hostname=</code></a>.</p> - </div> </div> - <div id="attribute-i-verify_mode" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">verify_mode</span><span @@ -621,7 +481,6 @@ </div> <div class="method-description"> - <p><a href="Session.html"><code>Session</code></a> verification mode.</p> <p>Valid modes are VERIFY_NONE, VERIFY_PEER, VERIFY_CLIENT_ONCE, VERIFY_FAIL_IF_NO_PEER_CERT and defined on <a href="../SSL.html"><code>OpenSSL::SSL</code></a></p> @@ -629,57 +488,39 @@ <p>The default mode is VERIFY_NONE, which does not perform any verification at all.</p> <p>See SSL_CTX_set_verify(3) for details.</p> - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new → ctx </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(:TLSv1) → ctx </span> - </div> - <div class="method-heading"> <span class="method-callseq"> new("SSLv23") → ctx </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="../SSL.html"><code>SSL</code></a> context.</p> <p>If an argument is given, <a href="SSLContext.html#method-i-ssl_version-3D"><code>ssl_version=</code></a> is called with the value. Note that this form is deprecated. New applications should use <a href="SSLContext.html#method-i-min_version-3D"><code>min_version=</code></a> and <a href="SSLContext.html#method-i-max_version-3D"><code>max_version=</code></a> as necessary.</p> - - - <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 122</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">version</span> = <span class="ruby-keyword">nil</span>) @@ -687,39 +528,27 @@ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">ssl_version</span> = <span class="ruby-identifier">version</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">version</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-add_certificate" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add_certificate(certiticate, pkey [, extra_certs]) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Adds a certificate to the context. <em>pkey</em> must be a corresponding private key with <em>certificate</em>.</p> <p>Multiple certificates with different public key type can be added by repeated calls of this method, and <a href="../../OpenSSL.html"><code>OpenSSL</code></a> will choose the most appropriate certificate during the handshake.</p> @@ -753,10 +582,7 @@ ctx.add_certificate(ecdsa_cert, ecdsa_pkey, [another_ca_cert])</pre> <h3 id="method-i-add_certificate-label-Note">Note<span><a href="#method-i-add_certificate-label-Note">¶</a> <a href="#top">↑</a></span></h3> <p><a href="../../OpenSSL.html"><code>OpenSSL</code></a> before the version 1.0.2 could handle only one extra chain across all key types. Calling this method discards the chain set previously.</p> - - - <div class="method-source-code" id="add_certificate-source"> <pre>static VALUE ossl_sslctx_add_certificate(int argc, VALUE *argv, VALUE self) @@ -827,36 +653,22 @@ ossl_sslctx_add_certificate(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-ciphers" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> ciphers → [[name, version, bits, alg_bits], ...] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>The list of cipher suites configured for this context.</p> - - - <div class="method-source-code" id="ciphers-source"> <pre>static VALUE ossl_sslctx_get_ciphers(VALUE self) @@ -881,50 +693,32 @@ ossl_sslctx_get_ciphers(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-ciphers-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> ciphers = "cipher1:cipher2:..." </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> ciphers = [name, ...] </span> - </div> - <div class="method-heading"> <span class="method-callseq"> ciphers = [[name, version, bits, alg_bits], ...] </span> - </div> - - <div class="method-description"> - <p>Sets the list of available cipher suites for this context. Note in a server context some ciphers require the appropriate certificates. For example, an RSA cipher suite can only be chosen when an RSA certificate is available.</p> - - - <div class="method-source-code" id="ciphers-3D-source"> <pre>static VALUE ossl_sslctx_set_ciphers(VALUE self, VALUE v) @@ -958,31 +752,20 @@ ossl_sslctx_set_ciphers(VALUE self, VALUE v) return v; }</pre> </div> - </div> - - </div> - <div id="method-i-ecdh_curves-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> ecdh_curves = curve_list → curve_list </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the list of “supported elliptic curves” for this context.</p> <p>For a TLS client, the list is directly used in the Supported Elliptic Curves Extension. For a server, the list is used by <a href="../../OpenSSL.html"><code>OpenSSL</code></a> to determine the set of shared curves. <a href="../../OpenSSL.html"><code>OpenSSL</code></a> will pick the most appropriate one from it.</p> @@ -1004,10 +787,7 @@ ossl_sslctx_set_ciphers(VALUE self, VALUE v) <span class="ruby-identifier">p</span> <span class="ruby-identifier">cli</span>.<span class="ruby-identifier">tmp_key</span>.<span class="ruby-identifier">group</span>.<span class="ruby-identifier">curve_name</span> <span class="ruby-comment"># => "prime256v1" (is an alias for NIST P-256)</span> </pre> - - - <div class="method-source-code" id="ecdh_curves-3D-source"> <pre>static VALUE ossl_sslctx_set_ecdh_curves(VALUE self, VALUE arg) @@ -1063,36 +843,22 @@ ossl_sslctx_set_ecdh_curves(VALUE self, VALUE arg) return arg; }</pre> </div> - </div> - - </div> - <div id="method-i-enable_fallback_scsv" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> enable_fallback_scsv() → nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Activate TLS_FALLBACK_SCSV for this context. See RFC 7507.</p> - - - <div class="method-source-code" id="enable_fallback_scsv-source"> <pre>static VALUE ossl_sslctx_enable_fallback_scsv(VALUE self) @@ -1105,36 +871,22 @@ ossl_sslctx_enable_fallback_scsv(VALUE self) return Qnil; }</pre> </div> - </div> - - </div> - <div id="method-i-flush_sessions" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> flush_sessions(time) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Removes sessions in the internal cache that have expired at <em>time</em>.</p> - - - <div class="method-source-code" id="flush_sessions-source"> <pre>static VALUE ossl_sslctx_flush_sessions(int argc, VALUE *argv, VALUE self) @@ -1160,78 +912,49 @@ ossl_sslctx_flush_sessions(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-freeze" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">freeze</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - + <p>This method is called automatically when a new <a href="SSLSocket.html"><code>SSLSocket</code></a> is created. However, it is not thread-safe and must be called before creating <a href="SSLSocket.html"><code>SSLSocket</code></a> objects in a multi-threaded program.</p> - </div> - - <div class="aliases"> Alias for: <a href="SSLContext.html#method-i-setup">setup</a> </div> - </div> - <div id="method-i-max_version-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> max_version = OpenSSL::SSL::TLS1_2_VERSION </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> max_version = :TLS1_2 </span> - </div> - <div class="method-heading"> <span class="method-callseq"> max_version = nil </span> - </div> - - <div class="method-description"> - <p>Sets the upper bound of the supported SSL/TLS protocol version. See <a href="SSLContext.html#method-i-min_version-3D"><code>min_version=</code></a> for the possible values.</p> - - - <div class="method-source-code" id="max_version-3D-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 183</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">max_version=</span>(<span class="ruby-identifier">version</span>) @@ -1239,48 +962,33 @@ ossl_sslctx_flush_sessions(int argc, VALUE *argv, VALUE self) <span class="ruby-ivar">@max_proto_version</span> = <span class="ruby-identifier">version</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-min_version-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> min_version = OpenSSL::SSL::TLS1_2_VERSION </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> min_version = :TLS1_2 </span> - </div> - <div class="method-heading"> <span class="method-callseq"> min_version = nil </span> - </div> - - <div class="method-description"> - <p>Sets the lower bound on the supported SSL/TLS protocol version. The version may be specified by an integer constant named OpenSSL::SSL::*_VERSION, a Symbol, or <code>nil</code> which means “any version”.</p> -<p>Be careful that you don't overwrite OpenSSL::SSL::OP_NO_{SSL,TLS}v* options by <a href="SSLContext.html#method-i-options-3D"><code>options=</code></a> once you have called <a href="SSLContext.html#method-i-min_version-3D"><code>min_version=</code></a> or <a href="SSLContext.html#method-i-max_version-3D"><code>max_version=</code></a>.</p> +<p>Be careful that you don’t overwrite OpenSSL::SSL::OP_NO_{SSL,TLS}v* options by <a href="SSLContext.html#method-i-options-3D"><code>options=</code></a> once you have called <a href="SSLContext.html#method-i-min_version-3D"><code>min_version=</code></a> or <a href="SSLContext.html#method-i-max_version-3D"><code>max_version=</code></a>.</p> <h3 id="method-i-min_version-3D-label-Example">Example<span><a href="#method-i-min_version-3D-label-Example">¶</a> <a href="#top">↑</a></span></h3> @@ -1291,10 +999,7 @@ ossl_sslctx_flush_sessions(int argc, VALUE *argv, VALUE self) <span class="ruby-identifier">sock</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_sock</span>, <span class="ruby-identifier">ctx</span>) <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">connect</span> <span class="ruby-comment"># Initiates a connection using either TLS 1.1 or TLS 1.2</span> </pre> - - - <div class="method-source-code" id="min_version-3D-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 171</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">min_version=</span>(<span class="ruby-identifier">version</span>) @@ -1302,33 +1007,21 @@ ossl_sslctx_flush_sessions(int argc, VALUE *argv, VALUE self) <span class="ruby-ivar">@min_proto_version</span> = <span class="ruby-identifier">version</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-options" class="method-detail "> - <div class="method-heading"> <span class="method-name">options</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Gets various <a href="../../OpenSSL.html"><code>OpenSSL</code></a> options.</p> - - - <div class="method-source-code" id="options-source"> <pre>static VALUE ossl_sslctx_get_options(VALUE self) @@ -1342,33 +1035,21 @@ ossl_sslctx_get_options(VALUE self) return ULONG2NUM((unsigned long)SSL_CTX_get_options(ctx)); }</pre> </div> - </div> - - </div> - <div id="method-i-options-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">options=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Sets various <a href="../../OpenSSL.html"><code>OpenSSL</code></a> options.</p> - - - <div class="method-source-code" id="options-3D-source"> <pre>static VALUE ossl_sslctx_set_options(VALUE self, VALUE options) @@ -1389,38 +1070,24 @@ ossl_sslctx_set_options(VALUE self, VALUE options) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-security_level" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> security_level → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the security level for the context.</p> <p>See also <a href="SSLContext.html#method-i-security_level-3D"><code>OpenSSL::SSL::SSLContext#security_level=</code></a>.</p> - - - <div class="method-source-code" id="security_level-source"> <pre>static VALUE ossl_sslctx_get_security_level(VALUE self) @@ -1437,31 +1104,20 @@ ossl_sslctx_get_security_level(VALUE self) #endif }</pre> </div> - </div> - - </div> - <div id="method-i-security_level-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> security_level = integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the security level for the context. <a href="../../OpenSSL.html"><code>OpenSSL</code></a> limits parameters according to the level. The “parameters” include: ciphersuites, curves, key sizes, certificate signature algorithms, protocol version and so on. For example, level 1 rejects parameters offering below 80 bits of security, such as ciphersuites using MD5 for the MAC or RSA keys shorter than 1024 bits.</p> <p>Note that attempts to set such parameters with insufficient security are also blocked. You need to lower the level first.</p> @@ -1469,10 +1125,7 @@ ossl_sslctx_get_security_level(VALUE self) <p>This feature is not supported in <a href="../../OpenSSL.html"><code>OpenSSL</code></a> < 1.1.0, and setting the level to other than 0 will raise NotImplementedError. Level 0 means everything is permitted, the same behavior as previous versions of <a href="../../OpenSSL.html"><code>OpenSSL</code></a>.</p> <p>See the manpage of SSL_CTX_set_security_level(3) for details.</p> - - - <div class="method-source-code" id="security_level-3D-source"> <pre>static VALUE ossl_sslctx_set_security_level(VALUE self, VALUE value) @@ -1494,36 +1147,22 @@ ossl_sslctx_set_security_level(VALUE self, VALUE value) return value; }</pre> </div> - </div> - - </div> - <div id="method-i-session_add" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> session_add(session) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Adds <em>session</em> to the session cache.</p> - - - <div class="method-source-code" id="session_add-source"> <pre>static VALUE ossl_sslctx_session_add(VALUE self, VALUE arg) @@ -1537,36 +1176,22 @@ ossl_sslctx_session_add(VALUE self, VALUE arg) return SSL_CTX_add_session(ctx, sess) == 1 ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-session_cache_mode" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> session_cache_mode → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>The current session cache mode.</p> - - - <div class="method-source-code" id="session_cache_mode-source"> <pre>static VALUE ossl_sslctx_get_session_cache_mode(VALUE self) @@ -1578,36 +1203,22 @@ ossl_sslctx_get_session_cache_mode(VALUE self) return LONG2NUM(SSL_CTX_get_session_cache_mode(ctx)); }</pre> </div> - </div> - - </div> - <div id="method-i-session_cache_mode-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> session_cache_mode=(integer) → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the <a href="../SSL.html"><code>SSL</code></a> session cache mode. Bitwise-or together the desired SESSION_CACHE_* constants to set. See SSL_CTX_set_session_cache_mode(3) for details.</p> - - - <div class="method-source-code" id="session_cache_mode-3D-source"> <pre>static VALUE ossl_sslctx_set_session_cache_mode(VALUE self, VALUE arg) @@ -1621,36 +1232,22 @@ ossl_sslctx_set_session_cache_mode(VALUE self, VALUE arg) return arg; }</pre> </div> - </div> - - </div> - <div id="method-i-session_cache_size" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> session_cache_size → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the current session cache size. Zero is used to represent an unlimited cache size.</p> - - - <div class="method-source-code" id="session_cache_size-source"> <pre>static VALUE ossl_sslctx_get_session_cache_size(VALUE self) @@ -1662,36 +1259,22 @@ ossl_sslctx_get_session_cache_size(VALUE self) return LONG2NUM(SSL_CTX_sess_get_cache_size(ctx)); }</pre> </div> - </div> - - </div> - <div id="method-i-session_cache_size-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> session_cache_size=(integer) → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the session cache size. Returns the previously valid session cache size. Zero is used to represent an unlimited session cache size.</p> - - - <div class="method-source-code" id="session_cache_size-3D-source"> <pre>static VALUE ossl_sslctx_set_session_cache_size(VALUE self, VALUE arg) @@ -1705,31 +1288,20 @@ ossl_sslctx_set_session_cache_size(VALUE self, VALUE arg) return arg; }</pre> </div> - </div> - - </div> - <div id="method-i-session_cache_stats" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> session_cache_stats → Hash </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a Hash containing the following keys:</p> <dl class="rdoc-list note-list"><dt>:accept <dd> @@ -1768,10 +1340,7 @@ ossl_sslctx_set_session_cache_size(VALUE self, VALUE arg) <dd> <p>Number of sessions proposed by clients that were found in the cache but had expired due to timeouts</p> </dd></dl> - - - <div class="method-source-code" id="session_cache_stats-source"> <pre>static VALUE ossl_sslctx_get_session_cache_stats(VALUE self) @@ -1798,36 +1367,22 @@ ossl_sslctx_get_session_cache_stats(VALUE self) return hash; }</pre> </div> - </div> - - </div> - <div id="method-i-session_remove" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> session_remove(session) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Removes <em>session</em> from the session cache.</p> - - - <div class="method-source-code" id="session_remove-source"> <pre>static VALUE ossl_sslctx_session_remove(VALUE self, VALUE arg) @@ -1841,40 +1396,26 @@ ossl_sslctx_session_remove(VALUE self, VALUE arg) return SSL_CTX_remove_session(ctx, sess) == 1 ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-set_params" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_params(params = {}) → params </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets saner defaults optimized for the use with HTTP-like protocols.</p> <p>If a Hash <em>params</em> is given, the parameters are overridden with it. The keys in <em>params</em> must be assignment methods on <a href="SSLContext.html"><code>SSLContext</code></a>.</p> <p>If the <a href="SSLContext.html#attribute-i-verify_mode"><code>verify_mode</code></a> is not VERIFY_NONE and <a href="SSLContext.html#attribute-i-ca_file"><code>ca_file</code></a>, <a href="SSLContext.html#attribute-i-ca_path"><code>ca_path</code></a> and <a href="SSLContext.html#attribute-i-cert_store"><code>cert_store</code></a> are not set then the system default certificate store is used.</p> - - - <div class="method-source-code" id="set_params-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 139</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_params</span>(<span class="ruby-identifier">params</span>={}) @@ -1889,43 +1430,27 @@ ossl_sslctx_session_remove(VALUE self, VALUE arg) <span class="ruby-keyword">return</span> <span class="ruby-identifier">params</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-setup" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> setup → Qtrue # first time </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> setup → nil # thereafter </span> - </div> - - <div class="method-description"> - <p>This method is called automatically when a new <a href="SSLSocket.html"><code>SSLSocket</code></a> is created. However, it is not thread-safe and must be called before creating <a href="SSLSocket.html"><code>SSLSocket</code></a> objects in a multi-threaded program.</p> - - - <div class="method-source-code" id="setup-source"> <pre>static VALUE ossl_sslctx_setup(VALUE self) @@ -2056,7 +1581,7 @@ ossl_sslctx_setup(VALUE self) if (!NIL_P(val)) { VALUE encoded = ssl_encode_npn_protocols(val); rb_ivar_set(self, id_npn_protocols_encoded, encoded); - SSL_CTX_set_next_protos_advertised_cb(ctx, ssl_npn_advertise_cb, (void *)encoded); + SSL_CTX_set_next_protos_advertised_cb(ctx, ssl_npn_advertise_cb, (void *)self); OSSL_Debug("SSL NPN advertise callback added"); } if (RTEST(rb_attr_get(self, id_i_npn_select_cb))) { @@ -2115,51 +1640,34 @@ ossl_sslctx_setup(VALUE self) return Qtrue; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="SSLContext.html#method-i-freeze">freeze</a> </div> - - </div> - <div id="method-i-ssl_version-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> ssl_version = :TLSv1 </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> ssl_version = "SSLv23" </span> - </div> - - <div class="method-description"> - <p>Sets the SSL/TLS protocol version for the context. This forces connections to use only the specified protocol version. This is deprecated and only provided for backwards compatibility. Use <a href="SSLContext.html#method-i-min_version-3D"><code>min_version=</code></a> and <a href="SSLContext.html#method-i-max_version-3D"><code>max_version=</code></a> instead.</p> <h3 id="method-i-ssl_version-3D-label-History"><a href="../../History_md.html">History</a><span><a href="#method-i-ssl_version-3D-label-History">¶</a> <a href="#top">↑</a></span></h3> <p>As the name hints, this used to call the SSL_CTX_set_ssl_version() function which sets the <a href="../SSL.html"><code>SSL</code></a> method used for connections created from the context. As of Ruby/OpenSSL 2.1, this accessor method is implemented to call <a href="SSLContext.html#method-i-min_version-3D"><code>min_version=</code></a> and <a href="SSLContext.html#method-i-max_version-3D"><code>max_version=</code></a> instead.</p> - - - <div class="method-source-code" id="ssl_version-3D-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 202</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ssl_version=</span>(<span class="ruby-identifier">meth</span>) @@ -2176,25 +1684,20 @@ ossl_sslctx_setup(VALUE self) <span class="ruby-ivar">@min_proto_version</span> = <span class="ruby-ivar">@max_proto_version</span> = <span class="ruby-identifier">version</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/SSL/SSLError.html b/OpenSSL/SSL/SSLError.html index f043e570..5a989d85 100644 --- a/OpenSSL/SSL/SSLError.html +++ b/OpenSSL/SSL/SSLError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/SSL/SSLErrorWaitReadable.html b/OpenSSL/SSL/SSLErrorWaitReadable.html index a2c40b4a..f6fbd500 100644 --- a/OpenSSL/SSL/SSLErrorWaitReadable.html +++ b/OpenSSL/SSL/SSLErrorWaitReadable.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,23 +57,19 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="SSLError.html">OpenSSL::SSL::SSLError</a> - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../../IO/WaitReadable.html">IO::WaitReadable</a> - - </ul> </div> @@ -93,25 +87,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/SSL/SSLErrorWaitWritable.html b/OpenSSL/SSL/SSLErrorWaitWritable.html index 71721836..b87e3170 100644 --- a/OpenSSL/SSL/SSLErrorWaitWritable.html +++ b/OpenSSL/SSL/SSLErrorWaitWritable.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,23 +57,19 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="SSLError.html">OpenSSL::SSL::SSLError</a> - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../../IO/WaitWritable.html">IO::WaitWritable</a> - - </ul> </div> @@ -93,25 +87,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/SSL/SSLServer.html b/OpenSSL/SSL/SSLServer.html index 4995a1f3..5e3e22c5 100644 --- a/OpenSSL/SSL/SSLServer.html +++ b/OpenSSL/SSL/SSLServer.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,45 +57,35 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="SocketForwarder.html">OpenSSL::SSL::SocketForwarder</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-accept">#accept</a> - <li ><a href="#method-i-close">#close</a> - <li ><a href="#method-i-listen">#listen</a> - <li ><a href="#method-i-shutdown">#shutdown</a> - <li ><a href="#method-i-to_io">#to_io</a> - </ul> </div> @@ -115,21 +103,15 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-start_immediately" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">start_immediately</span><span @@ -137,45 +119,32 @@ </div> <div class="method-description"> - <p>When true then <a href="SSLServer.html#method-i-accept"><code>accept</code></a> works exactly the same as TCPServer#accept</p> - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-new" class="method-detail "> - <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(svr, ctx)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Creates a new instance of <a href="SSLServer.html"><code>SSLServer</code></a>.</p> <ul><li> <p><em>srv</em> is an instance of TCPServer.</p> </li><li> <p><em>ctx</em> is an instance of <a href="SSLContext.html"><code>OpenSSL::SSL::SSLContext</code></a>.</p> </li></ul> - - - <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 488</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">svr</span>, <span class="ruby-identifier">ctx</span>) @@ -190,41 +159,28 @@ <span class="ruby-ivar">@start_immediately</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-accept" class="method-detail "> - <div class="method-heading"> <span class="method-name">accept</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Works similar to TCPServer#accept.</p> - - - <div class="method-source-code" id="accept-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 516</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">accept</span> @@ -247,157 +203,104 @@ <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-close" class="method-detail "> - <div class="method-heading"> <span class="method-name">close</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>See IO#close for details.</p> - - - <div class="method-source-code" id="close-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 537</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span> <span class="ruby-ivar">@svr</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-listen" class="method-detail "> - <div class="method-heading"> <span class="method-name">listen</span><span class="method-args">(backlog=Socket::SOMAXCONN)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>See TCPServer#listen for details.</p> - - - <div class="method-source-code" id="listen-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 506</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">listen</span>(<span class="ruby-identifier">backlog</span>=<span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOMAXCONN</span>) <span class="ruby-ivar">@svr</span>.<span class="ruby-identifier">listen</span>(<span class="ruby-identifier">backlog</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-shutdown" class="method-detail "> - <div class="method-heading"> <span class="method-name">shutdown</span><span class="method-args">(how=Socket::SHUT_RDWR)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>See BasicSocket#shutdown for details.</p> - - - <div class="method-source-code" id="shutdown-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 511</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">shutdown</span>(<span class="ruby-identifier">how</span>=<span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SHUT_RDWR</span>) <span class="ruby-ivar">@svr</span>.<span class="ruby-identifier">shutdown</span>(<span class="ruby-identifier">how</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-to_io" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_io</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Returns the TCPServer passed to the <a href="SSLServer.html"><code>SSLServer</code></a> when initialized.</p> - - - <div class="method-source-code" id="to_io-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 501</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_io</span> <span class="ruby-ivar">@svr</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/SSL/SSLSocket.html b/OpenSSL/SSL/SSLSocket.html index dae797da..99610994 100644 --- a/OpenSSL/SSL/SSLSocket.html +++ b/OpenSSL/SSL/SSLSocket.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,91 +57,57 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../Buffering.html">OpenSSL::Buffering</a> - - - <li><a class="include" href="SocketForwarder.html">OpenSSL::SSL::SocketForwarder</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-accept">#accept</a> - <li ><a href="#method-i-accept_nonblock">#accept_nonblock</a> - <li ><a href="#method-i-alpn_protocol">#alpn_protocol</a> - <li ><a href="#method-i-cert">#cert</a> - <li ><a href="#method-i-cipher">#cipher</a> - <li ><a href="#method-i-client_ca">#client_ca</a> - <li ><a href="#method-i-connect">#connect</a> - <li ><a href="#method-i-connect_nonblock">#connect_nonblock</a> - <li ><a href="#method-i-finished_message">#finished_message</a> - <li ><a href="#method-i-hostname-3D">#hostname=</a> - <li ><a href="#method-i-npn_protocol">#npn_protocol</a> - <li ><a href="#method-i-peer_cert">#peer_cert</a> - <li ><a href="#method-i-peer_cert_chain">#peer_cert_chain</a> - <li ><a href="#method-i-peer_finished_message">#peer_finished_message</a> - <li ><a href="#method-i-pending">#pending</a> - <li ><a href="#method-i-post_connection_check">#post_connection_check</a> - <li ><a href="#method-i-session">#session</a> - <li ><a href="#method-i-session-3D">#session=</a> - <li ><a href="#method-i-session_reused-3F">#session_reused?</a> - <li ><a href="#method-i-ssl_version">#ssl_version</a> - <li ><a href="#method-i-state">#state</a> - <li ><a href="#method-i-sysclose">#sysclose</a> - <li ><a href="#method-i-sysread">#sysread</a> - <li ><a href="#method-i-syswrite">#syswrite</a> - <li ><a href="#method-i-tmp_key">#tmp_key</a> - <li ><a href="#method-i-verify_result">#verify_result</a> - </ul> </div> @@ -159,21 +123,15 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-context" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">context</span><span @@ -181,12 +139,9 @@ </div> <div class="method-description"> - <p>The <a href="SSLContext.html"><code>SSLContext</code></a> object used in this connection.</p> - </div> </div> - <div id="attribute-i-hostname" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">hostname</span><span @@ -195,11 +150,8 @@ <div class="method-description"> - - </div> </div> - <div id="attribute-i-io" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">io</span><span @@ -207,12 +159,9 @@ </div> <div class="method-description"> - <p>The underlying <a href="../../IO.html"><code>IO</code></a> object.</p> - </div> </div> - <div id="attribute-i-sync_close" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">sync_close</span><span @@ -220,12 +169,9 @@ </div> <div class="method-description"> - <p>Whether to close the underlying socket as well, when the SSL/TLS connection is shut down. This defaults to <code>false</code>.</p> - </div> </div> - <div id="attribute-i-to_io" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">to_io</span><span @@ -233,45 +179,31 @@ </div> <div class="method-description"> - <p>The underlying <a href="../../IO.html"><code>IO</code></a> object.</p> - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new(io) → aSSLSocket </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(io, ctx) → aSSLSocket </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="../SSL.html"><code>SSL</code></a> socket from <em>io</em> which must be a real <a href="../../IO.html"><code>IO</code></a> object (not an IO-like object that responds to read/write).</p> <p>If <em>ctx</em> is provided the <a href="../SSL.html"><code>SSL</code></a> Sockets initial params will be taken from the context.</p> @@ -279,10 +211,7 @@ <p>The <a href="../Buffering.html"><code>OpenSSL::Buffering</code></a> module provides additional <a href="../../IO.html"><code>IO</code></a> methods.</p> <p>This method will freeze the <a href="SSLContext.html"><code>SSLContext</code></a> if one is provided; however, session management is still allowed in the frozen <a href="SSLContext.html"><code>SSLContext</code></a>.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ssl_initialize(int argc, VALUE *argv, VALUE self) @@ -321,44 +250,29 @@ ossl_ssl_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-accept" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> accept → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Waits for a SSL/TLS client to initiate a handshake. The handshake may be started after unencrypted data has been sent over the socket.</p> - - - <div class="method-source-code" id="accept-source"> <pre>static VALUE ossl_ssl_accept(VALUE self) @@ -368,31 +282,20 @@ ossl_ssl_accept(VALUE self) return ossl_start_ssl(self, SSL_accept, "SSL_accept", Qfalse); }</pre> </div> - </div> - - </div> - <div id="method-i-accept_nonblock" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> accept_nonblock([options]) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Initiates the SSL/TLS handshake as a server in non-blocking manner.</p> <pre class="ruby"><span class="ruby-comment"># emulates blocking accept</span> @@ -408,10 +311,7 @@ ossl_ssl_accept(VALUE self) </pre> <p>By specifying a keyword argument <em>exception</em> to <code>false</code>, you can indicate that <a href="SSLSocket.html#method-i-accept_nonblock"><code>accept_nonblock</code></a> should not raise an <a href="../../IO/WaitReadable.html"><code>IO::WaitReadable</code></a> or <a href="../../IO/WaitWritable.html"><code>IO::WaitWritable</code></a> exception, but return the symbol <code>:wait_readable</code> or <code>:wait_writable</code> instead.</p> - - - <div class="method-source-code" id="accept_nonblock-source"> <pre>static VALUE ossl_ssl_accept_nonblock(int argc, VALUE *argv, VALUE self) @@ -424,36 +324,22 @@ ossl_ssl_accept_nonblock(int argc, VALUE *argv, VALUE self) return ossl_start_ssl(self, SSL_accept, "SSL_accept", opts); }</pre> </div> - </div> - - </div> - <div id="method-i-alpn_protocol" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> alpn_protocol → String | nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the ALPN protocol string that was finally selected by the server during the handshake.</p> - - - <div class="method-source-code" id="alpn_protocol-source"> <pre>static VALUE ossl_ssl_alpn_protocol(VALUE self) @@ -471,36 +357,22 @@ ossl_ssl_alpn_protocol(VALUE self) return rb_str_new((const char *) out, outlen); }</pre> </div> - </div> - - </div> - <div id="method-i-cert" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cert → cert or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>The <a href="../X509.html"><code>X509</code></a> certificate for this socket endpoint.</p> - - - <div class="method-source-code" id="cert-source"> <pre>static VALUE ossl_ssl_get_cert(VALUE self) @@ -522,36 +394,22 @@ ossl_ssl_get_cert(VALUE self) return ossl_x509_new(cert); }</pre> </div> - </div> - - </div> - <div id="method-i-cipher" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cipher → nil or [name, version, bits, alg_bits] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the cipher suite actually used in the current session, or nil if no session has been established.</p> - - - <div class="method-source-code" id="cipher-source"> <pre>static VALUE ossl_ssl_get_cipher(VALUE self) @@ -564,38 +422,24 @@ ossl_ssl_get_cipher(VALUE self) return cipher ? ossl_ssl_cipher_to_ary(cipher) : Qnil; }</pre> </div> - </div> - - </div> - <div id="method-i-client_ca" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> client_ca → [x509name, ...] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Returns the list of client CAs. Please note that in contrast to <a href="SSLContext.html#attribute-i-client_ca"><code>SSLContext#client_ca=</code></a> no array of <a href="../X509/Certificate.html"><code>X509::Certificate</code></a> is returned but <a href="../X509/Name.html"><code>X509::Name</code></a> instances of the CA's subject distinguished name.</p> + <p>Returns the list of client CAs. Please note that in contrast to <a href="SSLContext.html#attribute-i-client_ca"><code>SSLContext#client_ca=</code></a> no array of <a href="../X509/Certificate.html"><code>X509::Certificate</code></a> is returned but <a href="../X509/Name.html"><code>X509::Name</code></a> instances of the CA’s subject distinguished name.</p> <p>In server mode, returns the list set by <a href="SSLContext.html#attribute-i-client_ca"><code>SSLContext#client_ca=</code></a>. In client mode, returns the list of client CAs sent from the server.</p> - - - <div class="method-source-code" id="client_ca-source"> <pre>static VALUE ossl_ssl_get_client_ca_list(VALUE self) @@ -609,36 +453,22 @@ ossl_ssl_get_client_ca_list(VALUE self) return ossl_x509name_sk2ary(ca); }</pre> </div> - </div> - - </div> - <div id="method-i-connect" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> connect → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Initiates an SSL/TLS handshake with a server. The handshake may be started after unencrypted data has been sent over the socket.</p> - - - <div class="method-source-code" id="connect-source"> <pre>static VALUE ossl_ssl_connect(VALUE self) @@ -648,31 +478,20 @@ ossl_ssl_connect(VALUE self) return ossl_start_ssl(self, SSL_connect, "SSL_connect", Qfalse); }</pre> </div> - </div> - - </div> - <div id="method-i-connect_nonblock" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> connect_nonblock([options]) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Initiates the SSL/TLS handshake as a client in non-blocking manner.</p> <pre class="ruby"><span class="ruby-comment"># emulates blocking connect</span> @@ -688,10 +507,7 @@ ossl_ssl_connect(VALUE self) </pre> <p>By specifying a keyword argument <em>exception</em> to <code>false</code>, you can indicate that <a href="SSLSocket.html#method-i-connect_nonblock"><code>connect_nonblock</code></a> should not raise an <a href="../../IO/WaitReadable.html"><code>IO::WaitReadable</code></a> or <a href="../../IO/WaitWritable.html"><code>IO::WaitWritable</code></a> exception, but return the symbol <code>:wait_readable</code> or <code>:wait_writable</code> instead.</p> - - - <div class="method-source-code" id="connect_nonblock-source"> <pre>static VALUE ossl_ssl_connect_nonblock(int argc, VALUE *argv, VALUE self) @@ -704,36 +520,22 @@ ossl_ssl_connect_nonblock(int argc, VALUE *argv, VALUE self) return ossl_start_ssl(self, SSL_connect, "SSL_connect", opts); }</pre> </div> - </div> - - </div> - <div id="method-i-finished_message" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> finished_message → "finished message" </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the last <strong>Finished</strong> message sent</p> - - - <div class="method-source-code" id="finished_message-source"> <pre>static VALUE ossl_ssl_get_finished(VALUE self) @@ -753,36 +555,22 @@ ossl_ssl_get_finished(VALUE self) return rb_str_new(buf, len); }</pre> </div> - </div> - - </div> - <div id="method-i-hostname-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> hostname = hostname → hostname </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the server hostname used for SNI. This needs to be set before <a href="SSLSocket.html#method-i-connect"><code>SSLSocket#connect</code></a>.</p> - - - <div class="method-source-code" id="hostname-3D-source"> <pre>static VALUE ossl_ssl_set_hostname(VALUE self, VALUE arg) @@ -804,36 +592,22 @@ ossl_ssl_set_hostname(VALUE self, VALUE arg) return arg; }</pre> </div> - </div> - - </div> - <div id="method-i-npn_protocol" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> npn_protocol → String | nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the protocol string that was finally selected by the client during the handshake.</p> - - - <div class="method-source-code" id="npn_protocol-source"> <pre>static VALUE ossl_ssl_npn_protocol(VALUE self) @@ -851,36 +625,22 @@ ossl_ssl_npn_protocol(VALUE self) return rb_str_new((const char *) out, outlen); }</pre> </div> - </div> - - </div> - <div id="method-i-peer_cert" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> peer_cert → cert or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>The <a href="../X509.html"><code>X509</code></a> certificate for this socket's peer.</p> - - + <p>The <a href="../X509.html"><code>X509</code></a> certificate for this socket’s peer.</p> - <div class="method-source-code" id="peer_cert-source"> <pre>static VALUE ossl_ssl_get_peer_cert(VALUE self) @@ -902,36 +662,22 @@ ossl_ssl_get_peer_cert(VALUE self) return obj; }</pre> </div> - </div> - - </div> - <div id="method-i-peer_cert_chain" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> peer_cert_chain → [cert, ...] or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>The <a href="../X509.html"><code>X509</code></a> certificate chain for this socket's peer.</p> - - + <p>The <a href="../X509.html"><code>X509</code></a> certificate chain for this socket’s peer.</p> - <div class="method-source-code" id="peer_cert_chain-source"> <pre>static VALUE ossl_ssl_get_peer_cert_chain(VALUE self) @@ -956,36 +702,22 @@ ossl_ssl_get_peer_cert_chain(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-peer_finished_message" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> peer_finished_message → "peer finished message" </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the last <strong>Finished</strong> message received</p> - - - <div class="method-source-code" id="peer_finished_message-source"> <pre>static VALUE ossl_ssl_get_peer_finished(VALUE self) @@ -1005,36 +737,22 @@ ossl_ssl_get_peer_finished(VALUE self) return rb_str_new(buf, len); }</pre> </div> - </div> - - </div> - <div id="method-i-pending" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> pending → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>The number of bytes that are immediately available for reading.</p> - - - <div class="method-source-code" id="pending-source"> <pre>static VALUE ossl_ssl_pending(VALUE self) @@ -1046,38 +764,24 @@ ossl_ssl_pending(VALUE self) return INT2NUM(SSL_pending(ssl)); }</pre> </div> - </div> - - </div> - <div id="method-i-post_connection_check" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> post_connection_check(hostname) → true </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Perform hostname verification following RFC 6125.</p> <p>This method MUST be called after calling <a href="SSLSocket.html#method-i-connect"><code>connect</code></a> to ensure that the hostname of a remote peer has been verified.</p> - - - <div class="method-source-code" id="post_connection_check-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 390</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post_connection_check</span>(<span class="ruby-identifier">hostname</span>) @@ -1096,36 +800,22 @@ ossl_ssl_pending(VALUE self) <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-session" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> session → aSession </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the SSLSession object currently used, or nil if the session is not established.</p> - - - <div class="method-source-code" id="session-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 411</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">session</span> @@ -1134,36 +824,22 @@ ossl_ssl_pending(VALUE self) <span class="ruby-keyword">nil</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-session-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> session = session → session </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the <a href="Session.html"><code>Session</code></a> to be used when the connection is established.</p> - - - <div class="method-source-code" id="session-3D-source"> <pre>static VALUE ossl_ssl_set_session(VALUE self, VALUE arg1) @@ -1180,36 +856,22 @@ ossl_ssl_set_session(VALUE self, VALUE arg1) return arg1; }</pre> </div> - </div> - - </div> - <div id="method-i-session_reused-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> session_reused? → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns <code>true</code> if a reused session was negotiated during the handshake.</p> - - - <div class="method-source-code" id="session_reused-3F-source"> <pre>static VALUE ossl_ssl_session_reused(VALUE self) @@ -1221,36 +883,22 @@ ossl_ssl_session_reused(VALUE self) return SSL_session_reused(ssl) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-ssl_version" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> ssl_version → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a String representing the SSL/TLS version that was negotiated for the connection, for example “TLSv1.2”.</p> - - - <div class="method-source-code" id="ssl_version-source"> <pre>static VALUE ossl_ssl_get_version(VALUE self) @@ -1262,36 +910,22 @@ ossl_ssl_get_version(VALUE self) return rb_str_new2(SSL_get_version(ssl)); }</pre> </div> - </div> - - </div> - <div id="method-i-state" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> state → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>A description of the current connection state. This is for diagnostic purposes only.</p> - - - <div class="method-source-code" id="state-source"> <pre>static VALUE ossl_ssl_get_state(VALUE self) @@ -1309,38 +943,24 @@ ossl_ssl_get_state(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-sysclose" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sysclose → nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sends “close notify” to the peer and tries to shut down the <a href="../SSL.html"><code>SSL</code></a> connection gracefully.</p> <p>If <a href="SSLSocket.html#attribute-i-sync_close"><code>sync_close</code></a> is set to <code>true</code>, the underlying <a href="../../IO.html"><code>IO</code></a> is also closed.</p> - - - <div class="method-source-code" id="sysclose-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 377</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sysclose</span> @@ -1349,43 +969,27 @@ ossl_ssl_get_state(VALUE self) <span class="ruby-identifier">io</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">sync_close</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-sysread" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sysread(length) → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> sysread(length, buffer) → buffer </span> - </div> - - <div class="method-description"> - <p>Reads <em>length</em> bytes from the <a href="../SSL.html"><code>SSL</code></a> connection. If a pre-allocated <em>buffer</em> is provided the data will be written into it.</p> - - - <div class="method-source-code" id="sysread-source"> <pre>static VALUE ossl_ssl_read(int argc, VALUE *argv, VALUE self) @@ -1393,36 +997,22 @@ ossl_ssl_read(int argc, VALUE *argv, VALUE self) return ossl_ssl_read_internal(argc, argv, self, 0); }</pre> </div> - </div> - - </div> - <div id="method-i-syswrite" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> syswrite(string) → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Writes <em>string</em> to the <a href="../SSL.html"><code>SSL</code></a> connection.</p> - - - <div class="method-source-code" id="syswrite-source"> <pre>static VALUE ossl_ssl_write(VALUE self, VALUE str) @@ -1430,36 +1020,22 @@ ossl_ssl_write(VALUE self, VALUE str) return ossl_ssl_write_internal(self, str, Qfalse); }</pre> </div> - </div> - - </div> - <div id="method-i-tmp_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> tmp_key → PKey or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the ephemeral key used in case of forward secrecy cipher.</p> - - - <div class="method-source-code" id="tmp_key-source"> <pre>static VALUE ossl_ssl_tmp_key(VALUE self) @@ -1473,38 +1049,24 @@ ossl_ssl_tmp_key(VALUE self) return ossl_pkey_new(key); }</pre> </div> - </div> - - </div> - <div id="method-i-verify_result" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> verify_result → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the result of the peer certificates verification. See verify(1) for error values and descriptions.</p> <p>If no peer certificate was presented X509_V_OK is returned.</p> - - - <div class="method-source-code" id="verify_result-source"> <pre>static VALUE ossl_ssl_get_verify_result(VALUE self) @@ -1516,25 +1078,20 @@ ossl_ssl_get_verify_result(VALUE self) return LONG2NUM(SSL_get_verify_result(ssl)); }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/SSL/Session.html b/OpenSSL/SSL/Session.html index 0569ed01..b593fe5b 100644 --- a/OpenSSL/SSL/Session.html +++ b/OpenSSL/SSL/Session.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,44 +57,32 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-id">#id</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-time">#time</a> - <li ><a href="#method-i-time-3D">#time=</a> - <li ><a href="#method-i-timeout">#timeout</a> - <li ><a href="#method-i-timeout-3D">#timeout=</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_text">#to_text</a> - </ul> </div> @@ -112,51 +98,33 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new(ssl_socket) → Session </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(string) → Session </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="Session.html"><code>Session</code></a> object from an instance of <a href="SSLSocket.html"><code>SSLSocket</code></a> or DER/PEM encoded String.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ssl_session_initialize(VALUE self, VALUE arg1) { @@ -197,44 +165,29 @@ return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3D-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> session1 == session2 → boolean </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns <code>true</code> if the two <a href="Session.html"><code>Session</code></a> is the same, <code>false</code> if not.</p> - - - <div class="method-source-code" id="3D-3D-source"> <pre>static VALUE ossl_ssl_session_eq(VALUE val1, VALUE val2) { @@ -249,36 +202,22 @@ } }</pre> </div> - </div> - - </div> - <div id="method-i-id" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> id → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the <a href="Session.html"><code>Session</code></a> ID.</p> - - - <div class="method-source-code" id="id-source"> <pre>static VALUE ossl_ssl_session_get_id(VALUE self) { @@ -293,33 +232,21 @@ return rb_str_new((const char *) p, i); }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_ssl_session_initialize_copy(VALUE self, VALUE other) @@ -341,36 +268,22 @@ ossl_ssl_session_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-time" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> time → Time </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the time at which the session was established.</p> - - - <div class="method-source-code" id="time-source"> <pre>static VALUE ossl_ssl_session_get_time(VALUE self) @@ -386,43 +299,27 @@ ossl_ssl_session_get_time(VALUE self) return rb_funcall(rb_cTime, rb_intern("at"), 1, LONG2NUM(t)); }</pre> </div> - </div> - - </div> - <div id="method-i-time-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> time = time </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> time = integer </span> - </div> - - <div class="method-description"> - <p>Sets start time of the session. Time resolution is in seconds.</p> - - - <div class="method-source-code" id="time-3D-source"> <pre>static VALUE ossl_ssl_session_set_time(VALUE self, VALUE time_v) { @@ -438,36 +335,22 @@ ossl_ssl_session_get_time(VALUE self) return ossl_ssl_session_get_time(self); }</pre> </div> - </div> - - </div> - <div id="method-i-timeout" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> timeout → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the timeout value set for the session, in seconds from the established time.</p> - - - <div class="method-source-code" id="timeout-source"> <pre>static VALUE ossl_ssl_session_get_timeout(VALUE self) @@ -481,36 +364,22 @@ ossl_ssl_session_get_timeout(VALUE self) return LONG2NUM(t); }</pre> </div> - </div> - - </div> - <div id="method-i-timeout-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> timeout = integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets how long until the session expires in seconds.</p> - - - <div class="method-source-code" id="timeout-3D-source"> <pre>static VALUE ossl_ssl_session_set_timeout(VALUE self, VALUE time_v) { @@ -523,36 +392,22 @@ ossl_ssl_session_get_timeout(VALUE self) return ossl_ssl_session_get_timeout(self); }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns an <a href="../ASN1.html"><code>ASN1</code></a> encoded String that contains the <a href="Session.html"><code>Session</code></a> object.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ssl_session_to_der(VALUE self) { @@ -574,36 +429,22 @@ ossl_ssl_session_get_timeout(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_pem → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns a PEM encoded String that contains the <a href="Session.html"><code>Session</code></a> object.</p> - - - <div class="method-source-code" id="to_pem-source"> <pre>static VALUE ossl_ssl_session_to_pem(VALUE self) { @@ -625,36 +466,22 @@ ossl_ssl_session_get_timeout(VALUE self) return ossl_membio2str(out); }</pre> </div> - </div> - - </div> - <div id="method-i-to_text" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_text → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Shows everything in the <a href="Session.html"><code>Session</code></a> object. This is for diagnostic purposes.</p> - - - <div class="method-source-code" id="to_text-source"> <pre>static VALUE ossl_ssl_session_to_text(VALUE self) { @@ -675,25 +502,20 @@ ossl_ssl_session_get_timeout(VALUE self) return ossl_membio2str(out); }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/SSL/Session/SessionError.html b/OpenSSL/SSL/Session/SessionError.html index eb25dca6..f06044f4 100644 --- a/OpenSSL/SSL/Session/SessionError.html +++ b/OpenSSL/SSL/Session/SessionError.html @@ -21,8 +21,6 @@ <link href="../../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/SSL/SocketForwarder.html b/OpenSSL/SSL/SocketForwarder.html index 35ee92af..1ae9719e 100644 --- a/OpenSSL/SSL/SocketForwarder.html +++ b/OpenSSL/SSL/SocketForwarder.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -62,28 +60,20 @@ - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-i-addr">#addr</a> - <li ><a href="#method-i-closed-3F">#closed?</a> - <li ><a href="#method-i-do_not_reverse_lookup-3D">#do_not_reverse_lookup=</a> - <li ><a href="#method-i-fcntl">#fcntl</a> - <li ><a href="#method-i-fileno">#fileno</a> - <li ><a href="#method-i-getsockopt">#getsockopt</a> - <li ><a href="#method-i-peeraddr">#peeraddr</a> - <li ><a href="#method-i-setsockopt">#setsockopt</a> - </ul> </div> @@ -99,297 +89,194 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-addr" class="method-detail "> - <div class="method-heading"> <span class="method-name">addr</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="addr-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 240</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">addr</span> <span class="ruby-identifier">to_io</span>.<span class="ruby-identifier">addr</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-closed-3F" class="method-detail "> - <div class="method-heading"> <span class="method-name">closed?</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="closed-3F-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 260</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">closed?</span> <span class="ruby-identifier">to_io</span>.<span class="ruby-identifier">closed?</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-do_not_reverse_lookup-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">do_not_reverse_lookup=</span><span class="method-args">(flag)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="do_not_reverse_lookup-3D-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 264</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_not_reverse_lookup=</span>(<span class="ruby-identifier">flag</span>) <span class="ruby-identifier">to_io</span>.<span class="ruby-identifier">do_not_reverse_lookup</span> = <span class="ruby-identifier">flag</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-fcntl" class="method-detail "> - <div class="method-heading"> <span class="method-name">fcntl</span><span class="method-args">(*args)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="fcntl-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 256</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fcntl</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) <span class="ruby-identifier">to_io</span>.<span class="ruby-identifier">fcntl</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-fileno" class="method-detail "> - <div class="method-heading"> <span class="method-name">fileno</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>The file descriptor for the socket.</p> - - - <div class="method-source-code" id="fileno-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 236</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fileno</span> <span class="ruby-identifier">to_io</span>.<span class="ruby-identifier">fileno</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-getsockopt" class="method-detail "> - <div class="method-heading"> <span class="method-name">getsockopt</span><span class="method-args">(level, optname)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="getsockopt-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 252</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">getsockopt</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">optname</span>) <span class="ruby-identifier">to_io</span>.<span class="ruby-identifier">getsockopt</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">optname</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-peeraddr" class="method-detail "> - <div class="method-heading"> <span class="method-name">peeraddr</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="peeraddr-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 244</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">peeraddr</span> <span class="ruby-identifier">to_io</span>.<span class="ruby-identifier">peeraddr</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-setsockopt" class="method-detail "> - <div class="method-heading"> <span class="method-name">setsockopt</span><span class="method-args">(level, optname, optval)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="setsockopt-source"> <pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 248</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setsockopt</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">optname</span>, <span class="ruby-identifier">optval</span>) <span class="ruby-identifier">to_io</span>.<span class="ruby-identifier">setsockopt</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">optname</span>, <span class="ruby-identifier">optval</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Timestamp.html b/OpenSSL/Timestamp.html index 9e4b1ba4..0d7815f4 100644 --- a/OpenSSL/Timestamp.html +++ b/OpenSSL/Timestamp.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -121,25 +119,19 @@ ts.verify(req, root, inter1, inter2) -> ts or raises an exception if validati </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/Timestamp/Factory.html b/OpenSSL/Timestamp/Factory.html index 3a9bbd52..ea33823f 100644 --- a/OpenSSL/Timestamp/Factory.html +++ b/OpenSSL/Timestamp/Factory.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -73,24 +71,22 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-i-create_timestamp">#create_timestamp</a> - </ul> </div> @@ -112,7 +108,7 @@ <h3 id="class-OpenSSL::Timestamp::Factory-label-Example-3A+Inclusion+of+-28untrusted-29+intermediate+certificates">Example: Inclusion of (untrusted) intermediate certificates<span><a href="#class-OpenSSL::Timestamp::Factory-label-Example-3A+Inclusion+of+-28untrusted-29+intermediate+certificates">¶</a> <a href="#top">↑</a></span></h3> -<p>Assume we received a timestamp request that has set <a href="Request.html#method-i-policy_id"><code>Request#policy_id</code></a> to <code>nil</code> and <a href="Request.html#method-i-cert_requested-3F"><code>Request#cert_requested?</code></a> to true. The raw request bytes are stored in a variable called <code>req_raw</code>. We'd still like to integrate the necessary intermediate certificates (in <code>inter1.cer</code> and <code>inter2.cer</code>) to simplify validation of the resulting <a href="Response.html"><code>Response</code></a>. <code>ts.p12</code> is a PKCS#12-compatible file including the private key and the timestamping certificate.</p> +<p>Assume we received a timestamp request that has set <a href="Request.html#method-i-policy_id"><code>Request#policy_id</code></a> to <code>nil</code> and <a href="Request.html#method-i-cert_requested-3F"><code>Request#cert_requested?</code></a> to true. The raw request bytes are stored in a variable called <code>req_raw</code>. We’d still like to integrate the necessary intermediate certificates (in <code>inter1.cer</code> and <code>inter2.cer</code>) to simplify validation of the resulting <a href="Response.html"><code>Response</code></a>. <code>ts.p12</code> is a PKCS#12-compatible file including the private key and the timestamping certificate.</p> <pre>req = OpenSSL::Timestamp::Request.new(raw_bytes) p12 = OpenSSL::PKCS12.new(File.open('ts.p12', 'rb'), 'pwd') @@ -176,21 +172,15 @@ factory.allowed_digests -> arra </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-additional_certs" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">additional_certs</span><span @@ -199,11 +189,8 @@ factory.allowed_digests -> arra <div class="method-description"> - - </div> </div> - <div id="attribute-i-allowed_digests" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">allowed_digests</span><span @@ -212,11 +199,8 @@ factory.allowed_digests -> arra <div class="method-description"> - - </div> </div> - <div id="attribute-i-default_policy_id" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">default_policy_id</span><span @@ -225,11 +209,8 @@ factory.allowed_digests -> arra <div class="method-description"> - - </div> </div> - <div id="attribute-i-gen_time" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">gen_time</span><span @@ -238,11 +219,8 @@ factory.allowed_digests -> arra <div class="method-description"> - - </div> </div> - <div id="attribute-i-serial_number" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">serial_number</span><span @@ -251,37 +229,25 @@ factory.allowed_digests -> arra <div class="method-description"> - - </div> </div> - </section> - - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-create_timestamp" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> create_timestamp(key, certificate, request) → Response </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Creates a <a href="Response.html"><code>Response</code></a> with the help of an <a href="../PKey.html"><code>OpenSSL::PKey</code></a>, an <a href="../X509/Certificate.html"><code>OpenSSL::X509::Certificate</code></a> and a <a href="Request.html"><code>Request</code></a>.</p> <p>Mandatory parameters for timestamp creation that need to be set in the Request:</p> @@ -303,10 +269,7 @@ factory.allowed_digests -> arra <p>In addition one of either <a href="Request.html#method-i-policy_id"><code>Request#policy_id</code></a> or <a href="Factory.html#attribute-i-default_policy_id"><code>Factory#default_policy_id</code></a> must be set.</p> <p>Raises a <a href="TimestampError.html"><code>TimestampError</code></a> if creation fails, though successfully created error responses may be returned.</p> - - - <div class="method-source-code" id="create_timestamp-source"> <pre>static VALUE ossl_tsfac_create_ts(VALUE self, VALUE key, VALUE certificate, VALUE request) @@ -435,25 +398,20 @@ end: return ret; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Timestamp/Request.html b/OpenSSL/Timestamp/Request.html index 42a8292f..d4660433 100644 --- a/OpenSSL/Timestamp/Request.html +++ b/OpenSSL/Timestamp/Request.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,50 +57,35 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-algorithm">#algorithm</a> - <li ><a href="#method-i-algorithm-3D">#algorithm=</a> - <li ><a href="#method-i-cert_requested-3D">#cert_requested=</a> - <li ><a href="#method-i-cert_requested-3F">#cert_requested?</a> - <li ><a href="#method-i-message_imprint">#message_imprint</a> - <li ><a href="#method-i-message_imprint-3D">#message_imprint=</a> - <li ><a href="#method-i-nonce">#nonce</a> - <li ><a href="#method-i-nonce-3D">#nonce=</a> - <li ><a href="#method-i-policy_id">#policy_id</a> - <li ><a href="#method-i-policy_id-3D">#policy_id=</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-version">#version</a> - <li ><a href="#method-i-version-3D">#version=</a> - </ul> </div> @@ -127,58 +110,38 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Timestamp::Request.new(file) → request </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Timestamp::Request.new(string) → request </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Timestamp::Request.new → empty request </span> - </div> - - <div class="method-description"> - <p>When creating a <a href="Request.html"><code>Request</code></a> with the <code>File</code> or <code>string</code> parameter, the corresponding <code>File</code> or <code>string</code> must be DER-encoded.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ts_req_initialize(int argc, VALUE *argv, VALUE self) @@ -195,51 +158,38 @@ ossl_ts_req_initialize(int argc, VALUE *argv, VALUE self) in = ossl_obj2bio(&arg); ts_req = d2i_TS_REQ_bio(in, &ts_req); BIO_free(in); - if (!ts_req) + if (!ts_req) { + DATA_PTR(self) = NULL; ossl_raise(eTimestampError, "Error when decoding the timestamp request"); + } DATA_PTR(self) = ts_req; return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-algorithm" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> algorithm → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Returns the 'short name' of the object identifier that represents the algorithm that was used to create the message imprint digest.</p> - - + <p>Returns the ‘short name’ of the object identifier that represents the algorithm that was used to create the message imprint digest.</p> - <div class="method-source-code" id="algorithm-source"> <pre>static VALUE ossl_ts_req_get_algorithm(VALUE self) @@ -254,41 +204,27 @@ ossl_ts_req_get_algorithm(VALUE self) return get_asn1obj(algor->algorithm); }</pre> </div> - </div> - - </div> - <div id="method-i-algorithm-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> algorithm = "string" → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Allows to set the object identifier or the 'short name' of the algorithm that was used to create the message imprint digest.</p> + <p>Allows to set the object identifier or the ‘short name’ of the algorithm that was used to create the message imprint digest.</p> <h3 id="method-i-algorithm-3D-label-Example-3A">Example:<span><a href="#method-i-algorithm-3D-label-Example-3A">¶</a> <a href="#top">↑</a></span></h3> <pre class="ruby"><span class="ruby-identifier">request</span>.<span class="ruby-identifier">algorithm</span> = <span class="ruby-string">"SHA1"</span> </pre> - - - <div class="method-source-code" id="algorithm-3D-source"> <pre>static VALUE ossl_ts_req_set_algorithm(VALUE self, VALUE algo) @@ -310,36 +246,22 @@ ossl_ts_req_set_algorithm(VALUE self, VALUE algo) return algo; }</pre> </div> - </div> - - </div> - <div id="method-i-cert_requested-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cert_requested = boolean → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Specify whether the response shall contain the timestamp authority's certificate or not. The default value is <code>true</code>.</p> - - + <p>Specify whether the response shall contain the timestamp authority’s certificate or not. The default value is <code>true</code>.</p> - <div class="method-source-code" id="cert_requested-3D-source"> <pre>static VALUE ossl_ts_req_set_cert_requested(VALUE self, VALUE requested) @@ -352,36 +274,22 @@ ossl_ts_req_set_cert_requested(VALUE self, VALUE requested) return requested; }</pre> </div> - </div> - - </div> - <div id="method-i-cert_requested-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cert_requested? → true or false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Indicates whether the response shall contain the timestamp authority's certificate or not.</p> - - + <p>Indicates whether the response shall contain the timestamp authority’s certificate or not.</p> - <div class="method-source-code" id="cert_requested-3F-source"> <pre>static VALUE ossl_ts_req_get_cert_requested(VALUE self) @@ -392,36 +300,22 @@ ossl_ts_req_get_cert_requested(VALUE self) return TS_REQ_get_cert_req(req) ? Qtrue: Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-message_imprint" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> message_imprint → string or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the message imprint (digest) of the data to be timestamped.</p> - - - <div class="method-source-code" id="message_imprint-source"> <pre>static VALUE ossl_ts_req_get_msg_imprint(VALUE self) @@ -440,36 +334,22 @@ ossl_ts_req_get_msg_imprint(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-message_imprint-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> message_imprint = "string" → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Set the message imprint digest.</p> - - - <div class="method-source-code" id="message_imprint-3D-source"> <pre>static VALUE ossl_ts_req_set_msg_imprint(VALUE self, VALUE hash) @@ -486,36 +366,22 @@ ossl_ts_req_set_msg_imprint(VALUE self, VALUE hash) return hash; }</pre> </div> - </div> - - </div> - <div id="method-i-nonce" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> nonce → BN or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the nonce (number used once) that the server shall include in its response.</p> - - - <div class="method-source-code" id="nonce-source"> <pre>static VALUE ossl_ts_req_get_nonce(VALUE self) @@ -529,36 +395,22 @@ ossl_ts_req_get_nonce(VALUE self) return asn1integer_to_num(nonce); }</pre> </div> - </div> - - </div> - <div id="method-i-nonce-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> nonce = number → BN </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the nonce (number used once) that the server shall include in its response. If the nonce is set, the server must return the same nonce value in a valid <a href="Response.html"><code>Response</code></a>.</p> - - - <div class="method-source-code" id="nonce-3D-source"> <pre>static VALUE ossl_ts_req_set_nonce(VALUE self, VALUE num) @@ -576,36 +428,22 @@ ossl_ts_req_set_nonce(VALUE self, VALUE num) return num; }</pre> </div> - </div> - - </div> - <div id="method-i-policy_id" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> policy_id → string or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Returns the 'short name' of the object identifier that represents the timestamp policy under which the server shall create the timestamp.</p> - - + <p>Returns the ‘short name’ of the object identifier that represents the timestamp policy under which the server shall create the timestamp.</p> - <div class="method-source-code" id="policy_id-source"> <pre>static VALUE ossl_ts_req_get_policy_id(VALUE self) @@ -618,41 +456,27 @@ ossl_ts_req_get_policy_id(VALUE self) return get_asn1obj(TS_REQ_get_policy_id(req)); }</pre> </div> - </div> - - </div> - <div id="method-i-policy_id-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> policy_id = "string" → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Allows to set the object identifier that represents the timestamp policy under which the server shall create the timestamp. This may be left <code>nil</code>, implying that the timestamp server will issue the timestamp using some default policy.</p> <h3 id="method-i-policy_id-3D-label-Example-3A">Example:<span><a href="#method-i-policy_id-3D-label-Example-3A">¶</a> <a href="#top">↑</a></span></h3> <pre class="ruby"><span class="ruby-identifier">request</span>.<span class="ruby-identifier">policy_id</span> = <span class="ruby-string">"1.2.3.4.5"</span> </pre> - - - <div class="method-source-code" id="policy_id-3D-source"> <pre>static VALUE ossl_ts_req_set_policy_id(VALUE self, VALUE oid) @@ -671,36 +495,22 @@ ossl_ts_req_set_policy_id(VALUE self, VALUE oid) return oid; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → DER-encoded string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>DER-encodes this <a href="Request.html"><code>Request</code></a>.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ts_req_to_der(VALUE self) @@ -724,36 +534,22 @@ ossl_ts_req_to_der(VALUE self) return asn1_to_der((void *)req, (int (*)(void *, unsigned char **))i2d_TS_REQ); }</pre> </div> - </div> - - </div> - <div id="method-i-version" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> version → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the version of this request. <code>1</code> is the default value.</p> - - - <div class="method-source-code" id="version-source"> <pre>static VALUE ossl_ts_req_get_version(VALUE self) @@ -764,36 +560,22 @@ ossl_ts_req_get_version(VALUE self) return LONG2NUM(TS_REQ_get_version(req)); }</pre> </div> - </div> - - </div> - <div id="method-i-version-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> version = number → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the version number for this <a href="Request.html"><code>Request</code></a>. This should be <code>1</code> for compliant servers.</p> - - - <div class="method-source-code" id="version-3D-source"> <pre>static VALUE ossl_ts_req_set_version(VALUE self, VALUE version) @@ -810,25 +592,20 @@ ossl_ts_req_set_version(VALUE self, VALUE version) return version; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Timestamp/Response.html b/OpenSSL/Timestamp/Response.html index e24542c8..166a9a74 100644 --- a/OpenSSL/Timestamp/Response.html +++ b/OpenSSL/Timestamp/Response.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,40 +57,30 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-failure_info">#failure_info</a> - <li ><a href="#method-i-status">#status</a> - <li ><a href="#method-i-status_text">#status_text</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-token">#token</a> - <li ><a href="#method-i-token_info">#token_info</a> - <li ><a href="#method-i-tsa_certificate">#tsa_certificate</a> - <li ><a href="#method-i-verify">#verify</a> - </ul> </div> @@ -110,90 +98,52 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="GRANTED">GRANTED - <dd><p>Indicates a successful response. Equal to <code>0</code>.</p> - - <dt id="GRANTED_WITH_MODS">GRANTED_WITH_MODS - <dd><p>Indicates a successful response that probably contains modifications from the initial request. Equal to <code>1</code>.</p> - - <dt id="REJECTION">REJECTION - <dd><p>Indicates a failure. No timestamp token was created. Equal to <code>2</code>.</p> - - <dt id="REVOCATION_NOTIFICATION">REVOCATION_NOTIFICATION - <dd><p>Indicates a failure. No timestamp token was created. A certificate has been revoked. Equal to <code>5</code>.</p> - - <dt id="REVOCATION_WARNING">REVOCATION_WARNING - <dd><p>Indicates a failure. No timestamp token was created. Revocation of a certificate is imminent. Equal to <code>4</code>.</p> - - <dt id="WAITING">WAITING - <dd><p>Indicates a failure. No timestamp token was created. Equal to <code>3</code>.</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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Timestamp::Response.new(file) → response </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Timestamp::Response.new(string) → response </span> - </div> - - <div class="method-description"> - - <p>Creates a <a href="Response.html"><code>Response</code></a> from a <code>File</code> or <code>string</code> parameter, the corresponding <code>File</code> or <code>string</code> must be DER-encoded. Please note that <a href="Response.html"><code>Response</code></a> is an immutable read-only class. If you'd like to create timestamps please refer to <a href="Factory.html"><code>Factory</code></a> instead.</p> - - + <p>Creates a <a href="Response.html"><code>Response</code></a> from a <code>File</code> or <code>string</code> parameter, the corresponding <code>File</code> or <code>string</code> must be DER-encoded. Please note that <a href="Response.html"><code>Response</code></a> is an immutable read-only class. If you’d like to create timestamps please refer to <a href="Factory.html"><code>Factory</code></a> instead.</p> - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ts_resp_initialize(VALUE self, VALUE der) @@ -205,46 +155,36 @@ ossl_ts_resp_initialize(VALUE self, VALUE der) in = ossl_obj2bio(&der); ts_resp = d2i_TS_RESP_bio(in, &ts_resp); BIO_free(in); - if (!ts_resp) + if (!ts_resp) { + DATA_PTR(self) = NULL; ossl_raise(eTimestampError, "Error when decoding the timestamp response"); + } DATA_PTR(self) = ts_resp; return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-failure_info" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> failure_info → nil or symbol </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>In cases no timestamp token has been created, this field contains further info about the reason why response creation failed. The method returns either nil (the request was successful and a timestamp token was created) or one of the following:</p> <ul><li> <p>:BAD_ALG - Indicates that the timestamp server rejects the message imprint algorithm used in the <a href="Request.html"><code>Request</code></a></p> @@ -263,10 +203,7 @@ ossl_ts_resp_initialize(VALUE self, VALUE der) </li><li> <p>:SYSTEM_FAILURE - <a href="../Timestamp.html"><code>Timestamp</code></a> creation failed due to an internal error that occurred on the timestamp server</p> </li></ul> - - - <div class="method-source-code" id="failure_info-source"> <pre>static VALUE ossl_ts_resp_get_failure_info(VALUE self) @@ -307,36 +244,22 @@ ossl_ts_resp_get_failure_info(VALUE self) ossl_raise(eTimestampError, "Unrecognized failure info."); }</pre> </div> - </div> - - </div> - <div id="method-i-status" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> status → BN (never nil) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns one of <a href="Response.html#GRANTED"><code>GRANTED</code></a>, <a href="Response.html#GRANTED_WITH_MODS"><code>GRANTED_WITH_MODS</code></a>, <a href="Response.html#REJECTION"><code>REJECTION</code></a>, <a href="Response.html#WAITING"><code>WAITING</code></a>, <a href="Response.html#REVOCATION_WARNING"><code>REVOCATION_WARNING</code></a> or <a href="Response.html#REVOCATION_NOTIFICATION"><code>REVOCATION_NOTIFICATION</code></a>. A timestamp token has been created only in case <code>status</code> is equal to <a href="Response.html#GRANTED"><code>GRANTED</code></a> or <a href="Response.html#GRANTED_WITH_MODS"><code>GRANTED_WITH_MODS</code></a>.</p> - - - <div class="method-source-code" id="status-source"> <pre>static VALUE ossl_ts_resp_get_status(VALUE self) @@ -352,36 +275,22 @@ ossl_ts_resp_get_status(VALUE self) return asn1integer_to_num(st); }</pre> </div> - </div> - - </div> - <div id="method-i-status_text" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> status_text → Array of strings or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>In cases of failure this field may contain an array of strings further describing the origin of the failure.</p> - - - <div class="method-source-code" id="status_text-source"> <pre>static VALUE ossl_ts_resp_get_status_text(VALUE self) @@ -405,36 +314,22 @@ ossl_ts_resp_get_status_text(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the <a href="Response.html"><code>Response</code></a> in DER-encoded form.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ts_resp_to_der(VALUE self) @@ -445,36 +340,22 @@ ossl_ts_resp_to_der(VALUE self) return asn1_to_der((void *)resp, (int (*)(void *, unsigned char **))i2d_TS_RESP); }</pre> </div> - </div> - - </div> - <div id="method-i-token" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> token → nil or OpenSSL::PKCS7 </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>If a timestamp token is present, this returns it in the form of a <a href="../PKCS7.html"><code>OpenSSL::PKCS7</code></a>.</p> - - - <div class="method-source-code" id="token-source"> <pre>static VALUE ossl_ts_resp_get_token(VALUE self) @@ -497,36 +378,22 @@ ossl_ts_resp_get_token(VALUE self) return obj; }</pre> </div> - </div> - - </div> - <div id="method-i-token_info" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> token_info → nil or OpenSSL::Timestamp::TokenInfo </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Get the response's token info if present.</p> - - + <p>Get the response’s token info if present.</p> - <div class="method-source-code" id="token_info-source"> <pre>static VALUE ossl_ts_resp_get_token_info(VALUE self) @@ -549,36 +416,22 @@ ossl_ts_resp_get_token_info(VALUE self) return obj; }</pre> </div> - </div> - - </div> - <div id="method-i-tsa_certificate" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> tsa_certificate → OpenSSL::X509::Certificate or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>If the <a href="Request.html"><code>Request</code></a> specified to request the TSA certificate (Request#cert_requested = true), then this field contains the certificate of the timestamp authority.</p> - - - <div class="method-source-code" id="tsa_certificate-source"> <pre>static VALUE ossl_ts_resp_get_tsa_certificate(VALUE self) @@ -598,52 +451,36 @@ ossl_ts_resp_get_tsa_certificate(VALUE self) return ossl_x509_new(cert); }</pre> </div> - </div> - - </div> - <div id="method-i-verify" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> verify(Request, root_store) → Response </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> verify(Request, root_store, [intermediate_cert]) → Response </span> - </div> - - <div class="method-description"> - <p>Verifies a timestamp token by checking the signature, validating the certificate chain implied by <a href="Response.html#method-i-tsa_certificate"><code>tsa_certificate</code></a> and by checking conformance to a given <a href="Request.html"><code>Request</code></a>. Mandatory parameters are the <a href="Request.html"><code>Request</code></a> associated to this <a href="Response.html"><code>Response</code></a>, and an <a href="../X509/Store.html"><code>OpenSSL::X509::Store</code></a> of trusted roots.</p> <p>Intermediate certificates can optionally be supplied for creating the certificate chain. These intermediate certificates must all be instances of <a href="../X509/Certificate.html"><code>OpenSSL::X509::Certificate</code></a>.</p> <p>If validation fails, several kinds of exceptions can be raised:</p> <ul><li> -<p>TypeError if types don't fit</p> +<p>TypeError if types don’t fit</p> </li><li> <p><a href="TimestampError.html"><code>TimestampError</code></a> if something is wrong with the timestamp token itself, if it is not conformant to the <a href="Request.html"><code>Request</code></a>, or if validation of the timestamp certificate chain fails.</p> </li></ul> - - - <div class="method-source-code" id="verify-source"> <pre>static VALUE ossl_ts_resp_verify(int argc, VALUE *argv, VALUE self) @@ -715,25 +552,20 @@ ossl_ts_resp_verify(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/Timestamp/TimestampError.html b/OpenSSL/Timestamp/TimestampError.html index bd730de3..1e1fee22 100644 --- a/OpenSSL/Timestamp/TimestampError.html +++ b/OpenSSL/Timestamp/TimestampError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">eOSSLError - </div> @@ -84,25 +81,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/Timestamp/TokenInfo.html b/OpenSSL/Timestamp/TokenInfo.html index 59484380..2263e0b5 100644 --- a/OpenSSL/Timestamp/TokenInfo.html +++ b/OpenSSL/Timestamp/TokenInfo.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,42 +57,31 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-algorithm">#algorithm</a> - <li ><a href="#method-i-gen_time">#gen_time</a> - <li ><a href="#method-i-message_imprint">#message_imprint</a> - <li ><a href="#method-i-nonce">#nonce</a> - <li ><a href="#method-i-ordering">#ordering</a> - <li ><a href="#method-i-policy_id">#policy_id</a> - <li ><a href="#method-i-serial_number">#serial_number</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-version">#version</a> - </ul> </div> @@ -112,51 +99,33 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Timestamp::TokenInfo.new(file) → token-info </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::Timestamp::TokenInfo.new(string) → token-info </span> - </div> - - <div class="method-description"> - - <p>Creates a <a href="TokenInfo.html"><code>TokenInfo</code></a> from a <code>File</code> or <code>string</code> parameter, the corresponding <code>File</code> or <code>string</code> must be DER-encoded. Please note that <a href="TokenInfo.html"><code>TokenInfo</code></a> is an immutable read-only class. If you'd like to create timestamps please refer to <a href="Factory.html"><code>Factory</code></a> instead.</p> - - + <p>Creates a <a href="TokenInfo.html"><code>TokenInfo</code></a> from a <code>File</code> or <code>string</code> parameter, the corresponding <code>File</code> or <code>string</code> must be DER-encoded. Please note that <a href="TokenInfo.html"><code>TokenInfo</code></a> is an immutable read-only class. If you’d like to create timestamps please refer to <a href="Factory.html"><code>Factory</code></a> instead.</p> - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_ts_token_info_initialize(VALUE self, VALUE der) @@ -168,56 +137,43 @@ ossl_ts_token_info_initialize(VALUE self, VALUE der) in = ossl_obj2bio(&der); info = d2i_TS_TST_INFO_bio(in, &info); BIO_free(in); - if (!info) + if (!info) { + DATA_PTR(self) = NULL; ossl_raise(eTimestampError, "Error when decoding the timestamp token info"); + } DATA_PTR(self) = info; return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-algorithm" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> algorithm → string or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Returns the 'short name' of the object identifier representing the algorithm that was used to derive the message imprint digest. For valid timestamps, this is the same value that was already given in the <a href="Request.html"><code>Request</code></a>. If status is GRANTED or GRANTED_WITH_MODS, this is never <code>nil</code>.</p> + <p>Returns the ‘short name’ of the object identifier representing the algorithm that was used to derive the message imprint digest. For valid timestamps, this is the same value that was already given in the <a href="Request.html"><code>Request</code></a>. If status is GRANTED or GRANTED_WITH_MODS, this is never <code>nil</code>.</p> <h3 id="method-i-algorithm-label-Example-3A">Example:<span><a href="#method-i-algorithm-label-Example-3A">¶</a> <a href="#top">↑</a></span></h3> <pre>algo = token_info.algorithm puts algo -> "SHA1"</pre> - - - <div class="method-source-code" id="algorithm-source"> <pre>static VALUE ossl_ts_token_info_get_algorithm(VALUE self) @@ -232,36 +188,22 @@ ossl_ts_token_info_get_algorithm(VALUE self) return get_asn1obj(algo->algorithm); }</pre> </div> - </div> - - </div> - <div id="method-i-gen_time" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> gen_time → Time </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns time when this timestamp token was created. If status is GRANTED or GRANTED_WITH_MODS, this is never <code>nil</code>.</p> - - - <div class="method-source-code" id="gen_time-source"> <pre>static VALUE ossl_ts_token_info_get_gen_time(VALUE self) @@ -272,41 +214,27 @@ ossl_ts_token_info_get_gen_time(VALUE self) return asn1time_to_time(TS_TST_INFO_get_time(info)); }</pre> </div> - </div> - - </div> - <div id="method-i-message_imprint" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> msg_imprint → string. </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the message imprint digest. For valid timestamps, this is the same value that was already given in the <a href="Request.html"><code>Request</code></a>. If status is GRANTED or GRANTED_WITH_MODS, this is never <code>nil</code>.</p> <h3 id="method-i-message_imprint-label-Example-3A">Example:<span><a href="#method-i-message_imprint-label-Example-3A">¶</a> <a href="#top">↑</a></span></h3> <pre>mi = token_info.msg_imprint puts mi -> "DEADBEEF"</pre> - - - <div class="method-source-code" id="message_imprint-source"> <pre>static VALUE ossl_ts_token_info_get_msg_imprint(VALUE self) @@ -324,36 +252,22 @@ ossl_ts_token_info_get_msg_imprint(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-nonce" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> nonce → BN or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>If the timestamp token is valid then this field contains the same nonce that was passed to the timestamp server in the initial <a href="Request.html"><code>Request</code></a>.</p> - - - <div class="method-source-code" id="nonce-source"> <pre>static VALUE ossl_ts_token_info_get_nonce(VALUE self) @@ -368,38 +282,24 @@ ossl_ts_token_info_get_nonce(VALUE self) return asn1integer_to_num(nonce); }</pre> </div> - </div> - - </div> - <div id="method-i-ordering" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> ordering → true, falses or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>If the ordering field is missing, or if the ordering field is present and set to false, then the genTime field only indicates the time at which the time-stamp token has been created by the TSA. In such a case, the ordering of time-stamp tokens issued by the same TSA or different TSAs is only possible when the difference between the genTime of the first time-stamp token and the genTime of the second time-stamp token is greater than the sum of the accuracies of the genTime for each time-stamp token.</p> <p>If the ordering field is present and set to true, every time-stamp token from the same TSA can always be ordered based on the genTime field, regardless of the genTime accuracy.</p> - - - <div class="method-source-code" id="ordering-source"> <pre>static VALUE ossl_ts_token_info_get_ordering(VALUE self) @@ -410,41 +310,27 @@ ossl_ts_token_info_get_ordering(VALUE self) return TS_TST_INFO_get_ordering(info) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-policy_id" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> policy_id → string or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the timestamp policy object identifier of the policy this timestamp was created under. If status is GRANTED or GRANTED_WITH_MODS, this is never <code>nil</code>.</p> <h3 id="method-i-policy_id-label-Example-3A">Example:<span><a href="#method-i-policy_id-label-Example-3A">¶</a> <a href="#top">↑</a></span></h3> <pre>id = token_info.policy_id puts id -> "1.2.3.4.5"</pre> - - - <div class="method-source-code" id="policy_id-source"> <pre>static VALUE ossl_ts_token_info_get_policy_id(VALUE self) @@ -455,36 +341,22 @@ ossl_ts_token_info_get_policy_id(VALUE self) return get_asn1obj(TS_TST_INFO_get_policy_id(info)); }</pre> </div> - </div> - - </div> - <div id="method-i-serial_number" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> serial_number → BN or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns serial number of the timestamp token. This value shall never be the same for two timestamp tokens issued by a dedicated timestamp authority. If status is GRANTED or GRANTED_WITH_MODS, this is never <code>nil</code>.</p> - - - <div class="method-source-code" id="serial_number-source"> <pre>static VALUE ossl_ts_token_info_get_serial_number(VALUE self) @@ -495,36 +367,22 @@ ossl_ts_token_info_get_serial_number(VALUE self) return asn1integer_to_num(TS_TST_INFO_get_serial(info)); }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the <a href="TokenInfo.html"><code>TokenInfo</code></a> in DER-encoded form.</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_ts_token_info_to_der(VALUE self) @@ -535,36 +393,22 @@ ossl_ts_token_info_to_der(VALUE self) return asn1_to_der((void *)info, (int (*)(void *, unsigned char **))i2d_TS_TST_INFO); }</pre> </div> - </div> - - </div> - <div id="method-i-version" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> version → Integer or nil </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the version number of the token info. With compliant servers, this value should be <code>1</code> if present. If status is GRANTED or GRANTED_WITH_MODS.</p> - - - <div class="method-source-code" id="version-source"> <pre>static VALUE ossl_ts_token_info_get_version(VALUE self) @@ -575,25 +419,20 @@ ossl_ts_token_info_get_version(VALUE self) return LONG2NUM(TS_TST_INFO_get_version(info)); }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509.html b/OpenSSL/X509.html index f9db42e8..14eb5f08 100644 --- a/OpenSSL/X509.html +++ b/OpenSSL/X509.html @@ -21,8 +21,6 @@ <link href="../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -75,25 +73,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/X509/Attribute.html b/OpenSSL/X509/Attribute.html index 4ee3311e..ceefd056 100644 --- a/OpenSSL/X509/Attribute.html +++ b/OpenSSL/X509/Attribute.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,49 +57,37 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../Marshal.html">OpenSSL::Marshal</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-oid">#oid</a> - <li ><a href="#method-i-oid-3D">#oid=</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-value">#value</a> - <li ><a href="#method-i-value-3D">#value=</a> - </ul> </div> @@ -117,44 +103,28 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new(oid [, value]) → attr </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_x509attr_initialize(int argc, VALUE *argv, VALUE self) @@ -181,41 +151,28 @@ ossl_x509attr_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3D-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">==</span><span class="method-args">(other)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="3D-3D-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 312</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>) @@ -223,33 +180,21 @@ ossl_x509attr_initialize(int argc, VALUE *argv, VALUE self) <span class="ruby-identifier">to_der</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">to_der</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_x509attr_initialize_copy(VALUE self, VALUE other) @@ -270,36 +215,22 @@ ossl_x509attr_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-oid" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> oid → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="oid-source"> <pre>static VALUE ossl_x509attr_get_oid(VALUE self) @@ -324,36 +255,22 @@ ossl_x509attr_get_oid(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-oid-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> oid = string → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="oid-3D-source"> <pre>static VALUE ossl_x509attr_set_oid(VALUE self, VALUE oid) @@ -375,36 +292,22 @@ ossl_x509attr_set_oid(VALUE self, VALUE oid) return oid; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_x509attr_to_der(VALUE self) @@ -426,36 +329,22 @@ ossl_x509attr_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-value" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> value → asn1 </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="value-source"> <pre>static VALUE ossl_x509attr_get_value(VALUE self) @@ -491,36 +380,22 @@ ossl_x509attr_get_value(VALUE self) return rb_funcall(mASN1, rb_intern("decode"), 1, str); }</pre> </div> - </div> - - </div> - <div id="method-i-value-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> value = asn1 → asn1 </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="value-3D-source"> <pre>static VALUE ossl_x509attr_set_value(VALUE self, VALUE value) @@ -561,25 +436,20 @@ ossl_x509attr_set_value(VALUE self, VALUE value) return value; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/AttributeError.html b/OpenSSL/X509/AttributeError.html index 01bb7e6d..a2cc4912 100644 --- a/OpenSSL/X509/AttributeError.html +++ b/OpenSSL/X509/AttributeError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/X509/CRL.html b/OpenSSL/X509/CRL.html index 63818136..238ac89a 100644 --- a/OpenSSL/X509/CRL.html +++ b/OpenSSL/X509/CRL.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,85 +57,54 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../Marshal.html">OpenSSL::Marshal</a> - - - <li><a class="include" href="Extension/AuthorityKeyIdentifier.html">OpenSSL::X509::Extension::AuthorityKeyIdentifier</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-add_extension">#add_extension</a> - <li ><a href="#method-i-add_revoked">#add_revoked</a> - <li ><a href="#method-i-extensions">#extensions</a> - <li ><a href="#method-i-extensions-3D">#extensions=</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-issuer">#issuer</a> - <li ><a href="#method-i-issuer-3D">#issuer=</a> - <li ><a href="#method-i-last_update">#last_update</a> - <li ><a href="#method-i-last_update-3D">#last_update=</a> - <li ><a href="#method-i-next_update">#next_update</a> - <li ><a href="#method-i-next_update-3D">#next_update=</a> - <li ><a href="#method-i-revoked">#revoked</a> - <li ><a href="#method-i-revoked-3D">#revoked=</a> - <li ><a href="#method-i-sign">#sign</a> - <li ><a href="#method-i-signature_algorithm">#signature_algorithm</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-to_text">#to_text</a> - <li ><a href="#method-i-verify">#verify</a> - <li ><a href="#method-i-version">#version</a> - <li ><a href="#method-i-version-3D">#version=</a> - </ul> </div> @@ -153,41 +120,27 @@ </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-new" class="method-detail "> - <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(p1 = v1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_x509crl_initialize(int argc, VALUE *argv, VALUE self) @@ -214,41 +167,28 @@ ossl_x509crl_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3D-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">==</span><span class="method-args">(other)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="3D-3D-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 347</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>) @@ -256,33 +196,21 @@ ossl_x509crl_initialize(int argc, VALUE *argv, VALUE self) <span class="ruby-identifier">to_der</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">to_der</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-add_extension" class="method-detail "> - <div class="method-heading"> <span class="method-name">add_extension</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="add_extension-source"> <pre>static VALUE ossl_x509crl_add_extension(VALUE self, VALUE extension) @@ -299,33 +227,21 @@ ossl_x509crl_add_extension(VALUE self, VALUE extension) return extension; }</pre> </div> - </div> - - </div> - <div id="method-i-add_revoked" class="method-detail "> - <div class="method-heading"> <span class="method-name">add_revoked</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="add_revoked-source"> <pre>static VALUE ossl_x509crl_add_revoked(VALUE self, VALUE revoked) @@ -344,33 +260,21 @@ ossl_x509crl_add_revoked(VALUE self, VALUE revoked) return revoked; }</pre> </div> - </div> - - </div> - <div id="method-i-extensions" class="method-detail "> - <div class="method-heading"> <span class="method-name">extensions</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Gets X509v3 extensions as array of X509Ext objects</p> - - - <div class="method-source-code" id="extensions-source"> <pre>static VALUE ossl_x509crl_get_extensions(VALUE self) @@ -395,33 +299,21 @@ ossl_x509crl_get_extensions(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-extensions-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">extensions=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Sets X509_EXTENSIONs</p> - - - <div class="method-source-code" id="extensions-3D-source"> <pre>static VALUE ossl_x509crl_set_extensions(VALUE self, VALUE ary) @@ -448,33 +340,21 @@ ossl_x509crl_set_extensions(VALUE self, VALUE ary) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_x509crl_copy(VALUE self, VALUE other) @@ -494,33 +374,21 @@ ossl_x509crl_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-issuer" class="method-detail "> - <div class="method-heading"> <span class="method-name">issuer</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="issuer-source"> <pre>static VALUE ossl_x509crl_get_issuer(VALUE self) @@ -532,33 +400,21 @@ ossl_x509crl_get_issuer(VALUE self) return ossl_x509name_new(X509_CRL_get_issuer(crl)); /* NO DUP - don't free */ }</pre> </div> - </div> - - </div> - <div id="method-i-issuer-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">issuer=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="issuer-3D-source"> <pre>static VALUE ossl_x509crl_set_issuer(VALUE self, VALUE issuer) @@ -573,33 +429,21 @@ ossl_x509crl_set_issuer(VALUE self, VALUE issuer) return issuer; }</pre> </div> - </div> - - </div> - <div id="method-i-last_update" class="method-detail "> - <div class="method-heading"> <span class="method-name">last_update</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="last_update-source"> <pre>static VALUE ossl_x509crl_get_last_update(VALUE self) @@ -615,33 +459,21 @@ ossl_x509crl_get_last_update(VALUE self) return asn1time_to_time(time); }</pre> </div> - </div> - - </div> - <div id="method-i-last_update-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">last_update=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="last_update-3D-source"> <pre>static VALUE ossl_x509crl_set_last_update(VALUE self, VALUE time) @@ -660,33 +492,21 @@ ossl_x509crl_set_last_update(VALUE self, VALUE time) return time; }</pre> </div> - </div> - - </div> - <div id="method-i-next_update" class="method-detail "> - <div class="method-heading"> <span class="method-name">next_update</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="next_update-source"> <pre>static VALUE ossl_x509crl_get_next_update(VALUE self) @@ -702,33 +522,21 @@ ossl_x509crl_get_next_update(VALUE self) return asn1time_to_time(time); }</pre> </div> - </div> - - </div> - <div id="method-i-next_update-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">next_update=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="next_update-3D-source"> <pre>static VALUE ossl_x509crl_set_next_update(VALUE self, VALUE time) @@ -747,33 +555,21 @@ ossl_x509crl_set_next_update(VALUE self, VALUE time) return time; }</pre> </div> - </div> - - </div> - <div id="method-i-revoked" class="method-detail "> - <div class="method-heading"> <span class="method-name">revoked</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="revoked-source"> <pre>static VALUE ossl_x509crl_get_revoked(VALUE self) @@ -800,33 +596,21 @@ ossl_x509crl_get_revoked(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-revoked-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">revoked=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="revoked-3D-source"> <pre>static VALUE ossl_x509crl_set_revoked(VALUE self, VALUE ary) @@ -858,33 +642,21 @@ ossl_x509crl_set_revoked(VALUE self, VALUE ary) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-sign" class="method-detail "> - <div class="method-heading"> <span class="method-name">sign</span><span class="method-args">(p1, p2)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="sign-source"> <pre>static VALUE ossl_x509crl_sign(VALUE self, VALUE key, VALUE digest) @@ -903,33 +675,21 @@ ossl_x509crl_sign(VALUE self, VALUE key, VALUE digest) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-signature_algorithm" class="method-detail "> - <div class="method-heading"> <span class="method-name">signature_algorithm</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="signature_algorithm-source"> <pre>static VALUE ossl_x509crl_get_signature_algorithm(VALUE self) @@ -951,33 +711,21 @@ ossl_x509crl_get_signature_algorithm(VALUE self) return ossl_membio2str(out); }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_der</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_x509crl_to_der(VALUE self) @@ -997,33 +745,21 @@ ossl_x509crl_to_der(VALUE self) return ossl_membio2str(out); }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_pem</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_pem-source"> <pre>static VALUE ossl_x509crl_to_pem(VALUE self) @@ -1043,65 +779,41 @@ ossl_x509crl_to_pem(VALUE self) return ossl_membio2str(out); }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="CRL.html#method-i-to_s">to_s</a> </div> - - </div> - <div id="method-i-to_s" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">to_s</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="CRL.html#method-i-to_pem">to_pem</a> </div> - </div> - <div id="method-i-to_text" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_text</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_text-source"> <pre>static VALUE ossl_x509crl_to_text(VALUE self) @@ -1121,33 +833,21 @@ ossl_x509crl_to_text(VALUE self) return ossl_membio2str(out); }</pre> </div> - </div> - - </div> - <div id="method-i-verify" class="method-detail "> - <div class="method-heading"> <span class="method-name">verify</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="verify-source"> <pre>static VALUE ossl_x509crl_verify(VALUE self, VALUE key) @@ -1169,33 +869,21 @@ ossl_x509crl_verify(VALUE self, VALUE key) } }</pre> </div> - </div> - - </div> - <div id="method-i-version" class="method-detail "> - <div class="method-heading"> <span class="method-name">version</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="version-source"> <pre>static VALUE ossl_x509crl_get_version(VALUE self) @@ -1209,33 +897,21 @@ ossl_x509crl_get_version(VALUE self) return LONG2NUM(ver); }</pre> </div> - </div> - - </div> - <div id="method-i-version-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">version=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="version-3D-source"> <pre>static VALUE ossl_x509crl_set_version(VALUE self, VALUE version) @@ -1254,25 +930,20 @@ ossl_x509crl_set_version(VALUE self, VALUE version) return version; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/CRLError.html b/OpenSSL/X509/CRLError.html index 20a7e822..6d15c8e0 100644 --- a/OpenSSL/X509/CRLError.html +++ b/OpenSSL/X509/CRLError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/X509/Certificate.html b/OpenSSL/X509/Certificate.html index e7e5a267..6df5f9b3 100644 --- a/OpenSSL/X509/Certificate.html +++ b/OpenSSL/X509/Certificate.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -69,109 +67,63 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../Marshal.html">OpenSSL::Marshal</a> - - - <li><a class="include" href="Extension/SubjectKeyIdentifier.html">OpenSSL::X509::Extension::SubjectKeyIdentifier</a> - - - <li><a class="include" href="Extension/AuthorityKeyIdentifier.html">OpenSSL::X509::Extension::AuthorityKeyIdentifier</a> - - - <li><a class="include" href="Extension/CRLDistributionPoints.html">OpenSSL::X509::Extension::CRLDistributionPoints</a> - - - <li><a class="include" href="Extension/AuthorityInfoAccess.html">OpenSSL::X509::Extension::AuthorityInfoAccess</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-add_extension">#add_extension</a> - <li ><a href="#method-i-check_private_key">#check_private_key</a> - <li ><a href="#method-i-extensions">#extensions</a> - <li ><a href="#method-i-extensions-3D">#extensions=</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-inspect">#inspect</a> - <li ><a href="#method-i-issuer">#issuer</a> - <li ><a href="#method-i-issuer-3D">#issuer=</a> - <li ><a href="#method-i-not_after">#not_after</a> - <li ><a href="#method-i-not_after-3D">#not_after=</a> - <li ><a href="#method-i-not_before">#not_before</a> - <li ><a href="#method-i-not_before-3D">#not_before=</a> - <li ><a href="#method-i-pretty_print">#pretty_print</a> - <li ><a href="#method-i-public_key">#public_key</a> - <li ><a href="#method-i-public_key-3D">#public_key=</a> - <li ><a href="#method-i-serial">#serial</a> - <li ><a href="#method-i-serial-3D">#serial=</a> - <li ><a href="#method-i-sign">#sign</a> - <li ><a href="#method-i-signature_algorithm">#signature_algorithm</a> - <li ><a href="#method-i-subject">#subject</a> - <li ><a href="#method-i-subject-3D">#subject=</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-to_text">#to_text</a> - <li ><a href="#method-i-verify">#verify</a> - <li ><a href="#method-i-version">#version</a> - <li ><a href="#method-i-version-3D">#version=</a> - </ul> </div> @@ -185,11 +137,11 @@ <section class="description"> -<p>Implementation of an X.509 certificate as specified in RFC 5280. Provides access to a certificate's attributes and allows certificates to be read from a string, but also supports the creation of new certificates from scratch.</p> +<p>Implementation of an X.509 certificate as specified in RFC 5280. Provides access to a certificate’s attributes and allows certificates to be read from a string, but also supports the creation of new certificates from scratch.</p> <h3 id="class-OpenSSL::X509::Certificate-label-Reading+a+certificate+from+a+file">Reading a certificate from a file<span><a href="#class-OpenSSL::X509::Certificate-label-Reading+a+certificate+from+a+file">¶</a> <a href="#top">↑</a></span></h3> -<p><a href="Certificate.html"><code>Certificate</code></a> is capable of handling DER-encoded certificates and certificates encoded in OpenSSL's PEM format.</p> +<p><a href="Certificate.html"><code>Certificate</code></a> is capable of handling DER-encoded certificates and certificates encoded in OpenSSL’s PEM format.</p> <pre class="ruby"><span class="ruby-identifier">raw</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span> <span class="ruby-string">"cert.cer"</span> <span class="ruby-comment"># DER- or PEM-encoded</span> <span class="ruby-identifier">certificate</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">raw</span> @@ -213,7 +165,7 @@ <p>The public key infrastructure (PKI) model relies on trusted certificate authorities (“root CAs”) that issue these certificates, so that end users need to base their trust just on a selected few authorities that themselves again vouch for subordinate CAs issuing their certificates to end users.</p> -<p>The <a href="../X509.html"><code>OpenSSL::X509</code></a> module provides the tools to set up an independent PKI, similar to scenarios where the 'openssl' command line tool is used for issuing certificates in a private PKI.</p> +<p>The <a href="../X509.html"><code>OpenSSL::X509</code></a> module provides the tools to set up an independent PKI, similar to scenarios where the ‘openssl’ command line tool is used for issuing certificates in a private PKI.</p> <h3 id="class-OpenSSL::X509::Certificate-label-Creating+a+root+CA+certificate+and+an+end-entity+certificate">Creating a root CA certificate and an end-entity certificate<span><a href="#class-OpenSSL::X509::Certificate-label-Creating+a+root+CA+certificate+and+an+end-entity+certificate">¶</a> <a href="#top">↑</a></span></h3> @@ -259,51 +211,33 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> new → cert </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> new(string) → cert </span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_x509_initialize(int argc, VALUE *argv, VALUE self) @@ -331,44 +265,29 @@ ossl_x509_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3D-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cert1 == cert2 → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Compares the two certificates. Note that this takes into account all fields, not just the issuer name and the serial number.</p> - - - <div class="method-source-code" id="3D-3D-source"> <pre>static VALUE ossl_x509_eq(VALUE self, VALUE other) @@ -383,36 +302,22 @@ ossl_x509_eq(VALUE self, VALUE other) return !X509_cmp(a, b) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-add_extension" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add_extension(extension) → extension </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="add_extension-source"> <pre>static VALUE ossl_x509_add_extension(VALUE self, VALUE extension) @@ -429,36 +334,22 @@ ossl_x509_add_extension(VALUE self, VALUE extension) return extension; }</pre> </div> - </div> - - </div> - <div id="method-i-check_private_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> check_private_key(key) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns <code>true</code> if <em>key</em> is the corresponding private key to the Subject Public Key Information, <code>false</code> otherwise.</p> - - - <div class="method-source-code" id="check_private_key-source"> <pre>static VALUE ossl_x509_check_private_key(VALUE self, VALUE key) @@ -477,36 +368,22 @@ ossl_x509_check_private_key(VALUE self, VALUE key) return Qtrue; }</pre> </div> - </div> - - </div> - <div id="method-i-extensions" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> extensions → [extension...] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="extensions-source"> <pre>static VALUE ossl_x509_get_extensions(VALUE self) @@ -530,36 +407,22 @@ ossl_x509_get_extensions(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-extensions-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> extensions = [ext...] → [ext...] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="extensions-3D-source"> <pre>static VALUE ossl_x509_set_extensions(VALUE self, VALUE ary) @@ -586,33 +449,21 @@ ossl_x509_set_extensions(VALUE self, VALUE ary) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_x509_copy(VALUE self, VALUE other) @@ -634,33 +485,21 @@ ossl_x509_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-inspect" class="method-detail "> - <div class="method-heading"> <span class="method-name">inspect</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="inspect-source"> <pre>static VALUE ossl_x509_inspect(VALUE self) @@ -676,36 +515,22 @@ ossl_x509_inspect(VALUE self) ossl_x509_get_not_after(self)); }</pre> </div> - </div> - - </div> - <div id="method-i-issuer" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> issuer → name </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="issuer-source"> <pre>static VALUE ossl_x509_get_issuer(VALUE self) @@ -721,36 +546,22 @@ ossl_x509_get_issuer(VALUE self) return ossl_x509name_new(name); }</pre> </div> - </div> - - </div> - <div id="method-i-issuer-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> issuer = name → name </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="issuer-3D-source"> <pre>static VALUE ossl_x509_set_issuer(VALUE self, VALUE issuer) @@ -765,36 +576,22 @@ ossl_x509_set_issuer(VALUE self, VALUE issuer) return issuer; }</pre> </div> - </div> - - </div> - <div id="method-i-not_after" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> not_after → time </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="not_after-source"> <pre>static VALUE ossl_x509_get_not_after(VALUE self) @@ -810,36 +607,22 @@ ossl_x509_get_not_after(VALUE self) return asn1time_to_time(asn1time); }</pre> </div> - </div> - - </div> - <div id="method-i-not_after-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> not_after = time → time </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="not_after-3D-source"> <pre>static VALUE ossl_x509_set_not_after(VALUE self, VALUE time) @@ -858,36 +641,22 @@ ossl_x509_set_not_after(VALUE self, VALUE time) return time; }</pre> </div> - </div> - - </div> - <div id="method-i-not_before" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> not_before → time </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="not_before-source"> <pre>static VALUE ossl_x509_get_not_before(VALUE self) @@ -903,36 +672,22 @@ ossl_x509_get_not_before(VALUE self) return asn1time_to_time(asn1time); }</pre> </div> - </div> - - </div> - <div id="method-i-not_before-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> not_before = time → time </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="not_before-3D-source"> <pre>static VALUE ossl_x509_set_not_before(VALUE self, VALUE time) @@ -951,33 +706,21 @@ ossl_x509_set_not_before(VALUE self, VALUE time) return time; }</pre> </div> - </div> - - </div> - <div id="method-i-pretty_print" class="method-detail "> - <div class="method-heading"> <span class="method-name">pretty_print</span><span class="method-args">(q)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="pretty_print-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 331</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pretty_print</span>(<span class="ruby-identifier">q</span>) @@ -991,36 +734,22 @@ ossl_x509_set_not_before(VALUE self, VALUE time) } <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-public_key" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_key → key </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="public_key-source"> <pre>static VALUE ossl_x509_get_public_key(VALUE self) @@ -1036,36 +765,22 @@ ossl_x509_get_public_key(VALUE self) return ossl_pkey_new(pkey); /* NO DUP - OK */ }</pre> </div> - </div> - - </div> - <div id="method-i-public_key-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> public_key = key </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="public_key-3D-source"> <pre>static VALUE ossl_x509_set_public_key(VALUE self, VALUE key) @@ -1081,36 +796,22 @@ ossl_x509_set_public_key(VALUE self, VALUE key) return key; }</pre> </div> - </div> - - </div> - <div id="method-i-serial" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> serial → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="serial-source"> <pre>static VALUE ossl_x509_get_serial(VALUE self) @@ -1122,36 +823,22 @@ ossl_x509_get_serial(VALUE self) return asn1integer_to_num(X509_get_serialNumber(x509)); }</pre> </div> - </div> - - </div> - <div id="method-i-serial-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> serial = integer → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="serial-3D-source"> <pre>static VALUE ossl_x509_set_serial(VALUE self, VALUE num) @@ -1164,36 +851,22 @@ ossl_x509_set_serial(VALUE self, VALUE num) return num; }</pre> </div> - </div> - - </div> - <div id="method-i-sign" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> sign(key, digest) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="sign-source"> <pre>static VALUE ossl_x509_sign(VALUE self, VALUE key, VALUE digest) @@ -1212,36 +885,22 @@ ossl_x509_sign(VALUE self, VALUE key, VALUE digest) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-signature_algorithm" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> signature_algorithm → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="signature_algorithm-source"> <pre>static VALUE ossl_x509_get_signature_algorithm(VALUE self) @@ -1263,36 +922,22 @@ ossl_x509_get_signature_algorithm(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-subject" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> subject → name </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="subject-source"> <pre>static VALUE ossl_x509_get_subject(VALUE self) @@ -1308,36 +953,22 @@ ossl_x509_get_subject(VALUE self) return ossl_x509name_new(name); }</pre> </div> - </div> - - </div> - <div id="method-i-subject-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> subject = name → name </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="subject-3D-source"> <pre>static VALUE ossl_x509_set_subject(VALUE self, VALUE subject) @@ -1352,36 +983,22 @@ ossl_x509_set_subject(VALUE self, VALUE subject) return subject; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_x509_to_der(VALUE self) @@ -1403,36 +1020,22 @@ ossl_x509_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_pem → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="to_pem-source"> <pre>static VALUE ossl_x509_to_pem(VALUE self) @@ -1454,68 +1057,42 @@ ossl_x509_to_pem(VALUE self) return str; }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="Certificate.html#method-i-to_s">to_s</a> </div> - - </div> - <div id="method-i-to_s" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">to_s</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="Certificate.html#method-i-to_pem">to_pem</a> </div> - </div> - <div id="method-i-to_text" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_text → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="to_text-source"> <pre>static VALUE ossl_x509_to_text(VALUE self) @@ -1538,36 +1115,22 @@ ossl_x509_to_text(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-verify" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> verify(key) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Verifies the signature of the certificate, with the public key <em>key</em>. <em>key</em> must be an instance of <a href="../PKey.html"><code>OpenSSL::PKey</code></a>.</p> - - - <div class="method-source-code" id="verify-source"> <pre>static VALUE ossl_x509_verify(VALUE self, VALUE key) @@ -1589,36 +1152,22 @@ ossl_x509_verify(VALUE self, VALUE key) } }</pre> </div> - </div> - - </div> - <div id="method-i-version" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> version → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="version-source"> <pre>static VALUE ossl_x509_get_version(VALUE self) @@ -1630,36 +1179,22 @@ ossl_x509_get_version(VALUE self) return LONG2NUM(X509_get_version(x509)); }</pre> </div> - </div> - - </div> - <div id="method-i-version-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> version = integer → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="version-3D-source"> <pre>static VALUE ossl_x509_set_version(VALUE self, VALUE version) @@ -1678,25 +1213,20 @@ ossl_x509_set_version(VALUE self, VALUE version) return version; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/CertificateError.html b/OpenSSL/X509/CertificateError.html index 1f11c6ad..abf2d18a 100644 --- a/OpenSSL/X509/CertificateError.html +++ b/OpenSSL/X509/CertificateError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/X509/Extension.html b/OpenSSL/X509/Extension.html index 8395476a..dfc6fc72 100644 --- a/OpenSSL/X509/Extension.html +++ b/OpenSSL/X509/Extension.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,61 +57,43 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../Marshal.html">OpenSSL::Marshal</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-critical-3D">#critical=</a> - <li ><a href="#method-i-critical-3F">#critical?</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-oid">#oid</a> - <li ><a href="#method-i-oid-3D">#oid=</a> - <li ><a href="#method-i-to_a">#to_a</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_h">#to_h</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-value">#value</a> - <li ><a href="#method-i-value-3D">#value=</a> - <li ><a href="#method-i-value_der">#value_der</a> - </ul> </div> @@ -129,60 +109,40 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> OpenSSL::X509::Extension.new(der) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::X509::Extension.new(oid, value) </span> - </div> - <div class="method-heading"> <span class="method-callseq"> OpenSSL::X509::Extension.new(oid, value, critical) </span> - </div> - - <div class="method-description"> - <p>Creates an <a href="../X509.html"><code>X509</code></a> extension.</p> <p>The extension may be created from <em>der</em> data or from an extension <em>oid</em> and <em>value</em>. The <em>oid</em> may be either an OID or an extension name. If <em>critical</em> is <code>true</code> the extension is marked critical.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_x509ext_initialize(int argc, VALUE *argv, VALUE self) @@ -209,41 +169,28 @@ ossl_x509ext_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3D-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">==</span><span class="method-args">(other)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="3D-3D-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 48</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>) @@ -251,33 +198,21 @@ ossl_x509ext_initialize(int argc, VALUE *argv, VALUE self) <span class="ruby-identifier">to_der</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">to_der</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-critical-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">critical=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="critical-3D-source"> <pre>static VALUE ossl_x509ext_set_critical(VALUE self, VALUE flag) @@ -290,33 +225,21 @@ ossl_x509ext_set_critical(VALUE self, VALUE flag) return flag; }</pre> </div> - </div> - - </div> - <div id="method-i-critical-3F" class="method-detail "> - <div class="method-heading"> <span class="method-name">critical?</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="critical-3F-source"> <pre>static VALUE ossl_x509ext_get_critical(VALUE obj) @@ -327,33 +250,21 @@ ossl_x509ext_get_critical(VALUE obj) return X509_EXTENSION_get_critical(ext) ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_x509ext_initialize_copy(VALUE self, VALUE other) @@ -374,33 +285,21 @@ ossl_x509ext_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-oid" class="method-detail "> - <div class="method-heading"> <span class="method-name">oid</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="oid-source"> <pre>static VALUE ossl_x509ext_get_oid(VALUE obj) @@ -425,33 +324,21 @@ ossl_x509ext_get_oid(VALUE obj) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-oid-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">oid=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="oid-3D-source"> <pre>static VALUE ossl_x509ext_set_oid(VALUE self, VALUE oid) @@ -472,66 +359,42 @@ ossl_x509ext_set_oid(VALUE self, VALUE oid) return oid; }</pre> </div> - </div> - - </div> - <div id="method-i-to_a" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_a</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_a-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 64</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_a</span> [ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">oid</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">value</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">critical?</span> ] <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_der</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_x509ext_to_der(VALUE obj) @@ -553,66 +416,42 @@ ossl_x509ext_to_der(VALUE obj) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-to_h" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_h</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_h-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 60</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span> <span class="ruby-comment"># {"oid"=>sn|ln, "value"=>value, "critical"=>true|false}</span> {<span class="ruby-string">"oid"</span><span class="ruby-operator">=></span><span class="ruby-keyword">self</span>.<span class="ruby-identifier">oid</span>,<span class="ruby-string">"value"</span><span class="ruby-operator">=></span><span class="ruby-keyword">self</span>.<span class="ruby-identifier">value</span>,<span class="ruby-string">"critical"</span><span class="ruby-operator">=></span><span class="ruby-keyword">self</span>.<span class="ruby-identifier">critical?</span>} <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-to_s" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_s</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_s-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 53</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span> <span class="ruby-comment"># "oid = critical, value"</span> @@ -622,33 +461,21 @@ ossl_x509ext_to_der(VALUE obj) <span class="ruby-identifier">str</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">value</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\n/</span>, <span class="ruby-string">", "</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-value" class="method-detail "> - <div class="method-heading"> <span class="method-name">value</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="value-source"> <pre>static VALUE ossl_x509ext_get_value(VALUE obj) @@ -667,33 +494,21 @@ ossl_x509ext_get_value(VALUE obj) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-value-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">value=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="value-3D-source"> <pre>static VALUE ossl_x509ext_set_value(VALUE self, VALUE data) @@ -714,33 +529,21 @@ ossl_x509ext_set_value(VALUE self, VALUE data) return data; }</pre> </div> - </div> - - </div> - <div id="method-i-value_der" class="method-detail "> - <div class="method-heading"> <span class="method-name">value_der</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="value_der-source"> <pre>static VALUE ossl_x509ext_get_value_der(VALUE obj) @@ -755,25 +558,20 @@ ossl_x509ext_get_value_der(VALUE obj) return rb_str_new((const char *)value->data, value->length); }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/Extension/AuthorityInfoAccess.html b/OpenSSL/X509/Extension/AuthorityInfoAccess.html index f70381f9..273097ad 100644 --- a/OpenSSL/X509/Extension/AuthorityInfoAccess.html +++ b/OpenSSL/X509/Extension/AuthorityInfoAccess.html @@ -21,8 +21,6 @@ <link href="../../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -60,29 +58,24 @@ <div id="class-metadata"> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="Helpers.html">OpenSSL::X509::Extension::Helpers</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-i-ca_issuer_uris">#ca_issuer_uris</a> - <li ><a href="#method-i-ocsp_uris">#ocsp_uris</a> - </ul> </div> @@ -98,43 +91,29 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-ca_issuer_uris" class="method-detail "> - <div class="method-heading"> <span class="method-name">ca_issuer_uris</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - <p>Get the information and services for the issuer from the certificate's authority information access extension exteension, as described in RFC5280 Section 4.2.2.1.</p> + <p>Get the information and services for the issuer from the certificate’s authority information access extension exteension, as described in RFC5280 Section 4.2.2.1.</p> <p>Returns an array of strings or nil or raises <a href="../../ASN1/ASN1Error.html"><code>ASN1::ASN1Error</code></a>.</p> - - - <div class="method-source-code" id="ca_issuer_uris-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 162</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ca_issuer_uris</span> @@ -148,35 +127,23 @@ <span class="ruby-identifier">ca_issuer</span>&.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:value</span>)&.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:last</span>)&.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:value</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-ocsp_uris" class="method-detail "> - <div class="method-heading"> <span class="method-name">ocsp_uris</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - <p>Get the URIs for <a href="../../OCSP.html"><code>OCSP</code></a> from the certificate's authority information access extension exteension, as described in RFC5280 Section 4.2.2.1.</p> + <p>Get the URIs for <a href="../../OCSP.html"><code>OCSP</code></a> from the certificate’s authority information access extension exteension, as described in RFC5280 Section 4.2.2.1.</p> <p>Returns an array of strings or nil or raises <a href="../../ASN1/ASN1Error.html"><code>ASN1::ASN1Error</code></a>.</p> - - - <div class="method-source-code" id="ocsp_uris-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 177</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ocsp_uris</span> @@ -190,25 +157,20 @@ <span class="ruby-identifier">ocsp</span>&.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:value</span>)&.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:last</span>)&.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:value</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/Extension/AuthorityKeyIdentifier.html b/OpenSSL/X509/Extension/AuthorityKeyIdentifier.html index 2c5eafe0..55e60b41 100644 --- a/OpenSSL/X509/Extension/AuthorityKeyIdentifier.html +++ b/OpenSSL/X509/Extension/AuthorityKeyIdentifier.html @@ -21,8 +21,6 @@ <link href="../../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -60,27 +58,23 @@ <div id="class-metadata"> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="Helpers.html">OpenSSL::X509::Extension::Helpers</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-i-authority_key_identifier">#authority_key_identifier</a> - </ul> </div> @@ -96,43 +90,29 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-authority_key_identifier" class="method-detail "> - <div class="method-heading"> <span class="method-name">authority_key_identifier</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - <p>Get the issuing certificate's key identifier from the authorityKeyIdentifier extension, as described in RFC5280 Section 4.2.1.1</p> + <p>Get the issuing certificate’s key identifier from the authorityKeyIdentifier extension, as described in RFC5280 Section 4.2.1.1</p> <p>Returns the binary String keyIdentifier or nil or raises <a href="../../ASN1/ASN1Error.html"><code>ASN1::ASN1Error</code></a>.</p> - - - <div class="method-source-code" id="authority_key_identifier-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 104</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">authority_key_identifier</span> @@ -151,25 +131,20 @@ <span class="ruby-identifier">key_id</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">key_id</span>.<span class="ruby-identifier">value</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/Extension/CRLDistributionPoints.html b/OpenSSL/X509/Extension/CRLDistributionPoints.html index 8af827c2..e890da4c 100644 --- a/OpenSSL/X509/Extension/CRLDistributionPoints.html +++ b/OpenSSL/X509/Extension/CRLDistributionPoints.html @@ -21,8 +21,6 @@ <link href="../../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -60,27 +58,23 @@ <div id="class-metadata"> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="Helpers.html">OpenSSL::X509::Extension::Helpers</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-i-crl_uris">#crl_uris</a> - </ul> </div> @@ -96,43 +90,29 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-crl_uris" class="method-detail "> - <div class="method-heading"> <span class="method-name">crl_uris</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - <p>Get the distributionPoint fullName URI from the certificate's <a href="../CRL.html"><code>CRL</code></a> distribution points extension, as described in RFC5280 Section 4.2.1.13</p> + <p>Get the distributionPoint fullName URI from the certificate’s <a href="../CRL.html"><code>CRL</code></a> distribution points extension, as described in RFC5280 Section 4.2.1.13</p> <p>Returns an array of strings or nil or raises <a href="../../ASN1/ASN1Error.html"><code>ASN1::ASN1Error</code></a>.</p> - - - <div class="method-source-code" id="crl_uris-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 129</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">crl_uris</span> @@ -159,25 +139,20 @@ <span class="ruby-identifier">crl_uris</span>&.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:value</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/Extension/Helpers.html b/OpenSSL/X509/Extension/Helpers.html index 08f6ef19..acc1a059 100644 --- a/OpenSSL/X509/Extension/Helpers.html +++ b/OpenSSL/X509/Extension/Helpers.html @@ -21,8 +21,6 @@ <link href="../../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -62,14 +60,13 @@ - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-i-find_extension">#find_extension</a> - </ul> </div> @@ -85,66 +82,47 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-find_extension" class="method-detail "> - <div class="method-heading"> <span class="method-name">find_extension</span><span class="method-args">(oid)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="find_extension-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 69</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find_extension</span>(<span class="ruby-identifier">oid</span>) <span class="ruby-identifier">extensions</span>.<span class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">oid</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">oid</span> } <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/Extension/SubjectKeyIdentifier.html b/OpenSSL/X509/Extension/SubjectKeyIdentifier.html index 29a0cd86..4d92ffdf 100644 --- a/OpenSSL/X509/Extension/SubjectKeyIdentifier.html +++ b/OpenSSL/X509/Extension/SubjectKeyIdentifier.html @@ -21,8 +21,6 @@ <link href="../../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -60,27 +58,23 @@ <div id="class-metadata"> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="Helpers.html">OpenSSL::X509::Extension::Helpers</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-i-subject_key_identifier">#subject_key_identifier</a> - </ul> </div> @@ -96,43 +90,29 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-subject_key_identifier" class="method-detail "> - <div class="method-heading"> <span class="method-name">subject_key_identifier</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - <p>Get the subject's key identifier from the subjectKeyIdentifier exteension, as described in RFC5280 Section 4.2.1.2.</p> + <p>Get the subject’s key identifier from the subjectKeyIdentifier exteension, as described in RFC5280 Section 4.2.1.2.</p> <p>Returns the binary String key identifier or nil or raises <a href="../../ASN1/ASN1Error.html"><code>ASN1::ASN1Error</code></a>.</p> - - - <div class="method-source-code" id="subject_key_identifier-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 82</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subject_key_identifier</span> @@ -147,25 +127,20 @@ <span class="ruby-identifier">ski_asn1</span>.<span class="ruby-identifier">value</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/ExtensionError.html b/OpenSSL/X509/ExtensionError.html index fca0125c..f160bc05 100644 --- a/OpenSSL/X509/ExtensionError.html +++ b/OpenSSL/X509/ExtensionError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/X509/ExtensionFactory.html b/OpenSSL/X509/ExtensionFactory.html index f88e3448..4ba70ea7 100644 --- a/OpenSSL/X509/ExtensionFactory.html +++ b/OpenSSL/X509/ExtensionFactory.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,42 +57,31 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-create_ext">#create_ext</a> - <li ><a href="#method-i-create_ext_from_array">#create_ext_from_array</a> - <li ><a href="#method-i-create_ext_from_hash">#create_ext_from_hash</a> - <li ><a href="#method-i-create_ext_from_string">#create_ext_from_string</a> - <li ><a href="#method-i-create_extension">#create_extension</a> - <li ><a href="#method-i-crl-3D">#crl=</a> - <li ><a href="#method-i-issuer_certificate-3D">#issuer_certificate=</a> - <li ><a href="#method-i-subject_certificate-3D">#subject_certificate=</a> - <li ><a href="#method-i-subject_request-3D">#subject_request=</a> - </ul> </div> @@ -110,21 +97,15 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-config" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">config</span><span @@ -133,11 +114,8 @@ <div class="method-description"> - - </div> </div> - <div id="attribute-i-crl" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">crl</span><span @@ -146,11 +124,8 @@ <div class="method-description"> - - </div> </div> - <div id="attribute-i-issuer_certificate" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">issuer_certificate</span><span @@ -159,11 +134,8 @@ <div class="method-description"> - - </div> </div> - <div id="attribute-i-subject_certificate" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">subject_certificate</span><span @@ -172,11 +144,8 @@ <div class="method-description"> - - </div> </div> - <div id="attribute-i-subject_request" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">subject_request</span><span @@ -185,39 +154,26 @@ <div class="method-description"> - - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-new" class="method-detail "> - <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(p1 = v1, p2 = v2, p3 = v3, p4 = v4)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_x509extfactory_initialize(int argc, VALUE *argv, VALUE self) @@ -241,51 +197,34 @@ ossl_x509extfactory_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-create_ext" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> create_ext(ln_or_sn, "value", critical = false) → X509::Extension </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> create_ext(ln_or_sn, "critical,value") → X509::Extension </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="Extension.html"><code>X509::Extension</code></a> with passed values. See also x509v3_config(5).</p> - - - <div class="method-source-code" id="create_ext-source"> <pre>static VALUE ossl_x509extfactory_create_ext(int argc, VALUE *argv, VALUE self) @@ -326,33 +265,21 @@ ossl_x509extfactory_create_ext(int argc, VALUE *argv, VALUE self) return obj; }</pre> </div> - </div> - - </div> - <div id="method-i-create_ext_from_array" class="method-detail "> - <div class="method-heading"> <span class="method-name">create_ext_from_array</span><span class="method-args">(ary)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="create_ext_from_array-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 28</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_ext_from_array</span>(<span class="ruby-identifier">ary</span>) @@ -360,66 +287,42 @@ ossl_x509extfactory_create_ext(int argc, VALUE *argv, VALUE self) <span class="ruby-identifier">create_ext</span>(<span class="ruby-identifier">ary</span>[<span class="ruby-value">0</span>], <span class="ruby-identifier">ary</span>[<span class="ruby-value">1</span>], <span class="ruby-identifier">ary</span>[<span class="ruby-value">2</span>]) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-create_ext_from_hash" class="method-detail "> - <div class="method-heading"> <span class="method-name">create_ext_from_hash</span><span class="method-args">(hash)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="create_ext_from_hash-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 40</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_ext_from_hash</span>(<span class="ruby-identifier">hash</span>) <span class="ruby-identifier">create_ext</span>(<span class="ruby-identifier">hash</span>[<span class="ruby-string">"oid"</span>], <span class="ruby-identifier">hash</span>[<span class="ruby-string">"value"</span>], <span class="ruby-identifier">hash</span>[<span class="ruby-string">"critical"</span>]) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-create_ext_from_string" class="method-detail "> - <div class="method-heading"> <span class="method-name">create_ext_from_string</span><span class="method-args">(str)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="create_ext_from_string-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 33</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_ext_from_string</span>(<span class="ruby-identifier">str</span>) <span class="ruby-comment"># "oid = critical, value"</span> @@ -429,33 +332,21 @@ ossl_x509extfactory_create_ext(int argc, VALUE *argv, VALUE self) <span class="ruby-identifier">create_ext</span>(<span class="ruby-identifier">oid</span>, <span class="ruby-identifier">value</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-create_extension" class="method-detail "> - <div class="method-heading"> <span class="method-name">create_extension</span><span class="method-args">(*arg)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="create_extension-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 20</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_extension</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arg</span>) @@ -466,33 +357,21 @@ ossl_x509extfactory_create_ext(int argc, VALUE *argv, VALUE self) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-crl-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">crl=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="crl-3D-source"> <pre>static VALUE ossl_x509extfactory_set_crl(VALUE self, VALUE crl) @@ -506,33 +385,21 @@ ossl_x509extfactory_set_crl(VALUE self, VALUE crl) return crl; }</pre> </div> - </div> - - </div> - <div id="method-i-issuer_certificate-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">issuer_certificate=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="issuer_certificate-3D-source"> <pre>static VALUE ossl_x509extfactory_set_issuer_cert(VALUE self, VALUE cert) @@ -546,33 +413,21 @@ ossl_x509extfactory_set_issuer_cert(VALUE self, VALUE cert) return cert; }</pre> </div> - </div> - - </div> - <div id="method-i-subject_certificate-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">subject_certificate=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="subject_certificate-3D-source"> <pre>static VALUE ossl_x509extfactory_set_subject_cert(VALUE self, VALUE cert) @@ -586,33 +441,21 @@ ossl_x509extfactory_set_subject_cert(VALUE self, VALUE cert) return cert; }</pre> </div> - </div> - - </div> - <div id="method-i-subject_request-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">subject_request=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="subject_request-3D-source"> <pre>static VALUE ossl_x509extfactory_set_subject_req(VALUE self, VALUE req) @@ -626,25 +469,20 @@ ossl_x509extfactory_set_subject_req(VALUE self, VALUE req) return req; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/Name.html b/OpenSSL/X509/Name.html index 3563e6fe..b3bf275c 100644 --- a/OpenSSL/X509/Name.html +++ b/OpenSSL/X509/Name.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,69 +57,46 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><span class="include">Comparable</span> - - - <li><a class="include" href="../Marshal.html">OpenSSL::Marshal</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-c-parse">::parse</a> - <li ><a href="#method-c-parse_openssl">::parse_openssl</a> - <li ><a href="#method-c-parse_rfc2253">::parse_rfc2253</a> - <li ><a href="#method-i-3C-3D-3E">#<=></a> - <li ><a href="#method-i-add_entry">#add_entry</a> - <li ><a href="#method-i-cmp">#cmp</a> - <li ><a href="#method-i-eql-3F">#eql?</a> - <li ><a href="#method-i-hash">#hash</a> - <li ><a href="#method-i-hash_old">#hash_old</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-pretty_print">#pretty_print</a> - <li ><a href="#method-i-to_a">#to_a</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-to_utf8">#to_utf8</a> - </ul> </div> @@ -146,107 +121,68 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="COMPAT">COMPAT - <dd><p>A flag for <a href="Name.html#method-i-to_s"><code>to_s</code></a>.</p> <p>Breaks the name returned into multiple lines if longer than 80 characters.</p> - - <dt id="DEFAULT_OBJECT_TYPE">DEFAULT_OBJECT_TYPE - <dd><p>The default object type for name entries.</p> - - <dt id="MULTILINE">MULTILINE - <dd><p>A flag for <a href="Name.html#method-i-to_s"><code>to_s</code></a>.</p> <p>Returns a multiline format.</p> - - <dt id="OBJECT_TYPE_TEMPLATE">OBJECT_TYPE_TEMPLATE - <dd><p>The default object type template for name entries.</p> - - <dt id="ONELINE">ONELINE - <dd><p>A flag for <a href="Name.html#method-i-to_s"><code>to_s</code></a>.</p> <p>Returns a more readable format than <a href="Name.html#RFC2253"><code>RFC2253</code></a>.</p> - - <dt id="RFC2253">RFC2253 - <dd><p>A flag for <a href="Name.html#method-i-to_s"><code>to_s</code></a>.</p> <p>Returns an <a href="Name.html#RFC2253"><code>RFC2253</code></a> format name.</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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> X509::Name.new → name </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> X509::Name.new(der) → name </span> - </div> - <div class="method-heading"> <span class="method-callseq"> X509::Name.new(distinguished_name) → name </span> - </div> - <div class="method-heading"> <span class="method-callseq"> X509::Name.new(distinguished_name, template) → name </span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="Name.html"><code>Name</code></a>.</p> <p>A name may be created from a DER encoded string <em>der</em>, an Array representing a <em>distinguished_name</em> or a <em>distinguished_name</em> along with a <em>template</em>.</p> @@ -256,11 +192,8 @@ <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">new</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_der</span> </pre> -<p>See <a href="Name.html#method-i-add_entry"><code>add_entry</code></a> for a description of the <em>distinguished_name</em> Array's contents</p> - - +<p>See <a href="Name.html#method-i-add_entry"><code>add_entry</code></a> for a description of the <em>distinguished_name</em> Array’s contents</p> - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_x509name_initialize(int argc, VALUE *argv, VALUE self) @@ -297,61 +230,38 @@ ossl_x509name_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-c-parse" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">parse</span><span class="method-args">(str, template=OBJECT_TYPE_TEMPLATE)</span> - </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="Name.html#method-c-parse_openssl">parse_openssl</a> </div> - </div> - <div id="method-c-parse_openssl" class="method-detail "> - <div class="method-heading"> <span class="method-name">parse_openssl</span><span class="method-args">(str, template=OBJECT_TYPE_TEMPLATE)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="parse_openssl-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 287</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_openssl</span>(<span class="ruby-identifier">str</span>, <span class="ruby-identifier">template</span>=<span class="ruby-constant">OBJECT_TYPE_TEMPLATE</span>) @@ -365,37 +275,24 @@ ossl_x509name_initialize(int argc, VALUE *argv, VALUE self) <span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ary</span>, <span class="ruby-identifier">template</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="Name.html#method-c-parse">parse</a> </div> - - </div> - <div id="method-c-parse_rfc2253" class="method-detail "> - <div class="method-heading"> <span class="method-name">parse_rfc2253</span><span class="method-args">(str, template=OBJECT_TYPE_TEMPLATE)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="parse_rfc2253-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 282</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_rfc2253</span>(<span class="ruby-identifier">str</span>, <span class="ruby-identifier">template</span>=<span class="ruby-constant">OBJECT_TYPE_TEMPLATE</span>) @@ -403,67 +300,45 @@ ossl_x509name_initialize(int argc, VALUE *argv, VALUE self) <span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ary</span>, <span class="ruby-identifier">template</span>) <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3C-3D-3E" class="method-detail method-alias"> - <div class="method-heading"> - <span class="method-name"><=></span><span - class="method-args">(p1)</span> - + <span class="method-callseq"> + name <=> other → -1 | 0 | 1 | nil + </span> </div> - <div class="method-description"> - - - - + <p>Compares this <a href="Name.html"><code>Name</code></a> with <em>other</em> and returns <code>0</code> if they are the same and <code>-1</code> or <code>+1</code> if they are greater or less than each other respectively. Returns <code>nil</code> if they are not comparable (i.e. different types).</p> - </div> - - <div class="aliases"> Alias for: <a href="Name.html#method-i-cmp">cmp</a> </div> - </div> - <div id="method-i-add_entry" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add_entry(oid, value [, type], loc: -1, set: 0) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Adds a new entry with the given <em>oid</em> and <em>value</em> to this name. The <em>oid</em> is an object identifier defined in ASN.1. Some common OIDs are:</p> <dl class="rdoc-list note-list"><dt>C <dd> @@ -486,10 +361,7 @@ ossl_x509name_initialize(int argc, VALUE *argv, VALUE self) </dd></dl> <p>The optional keyword parameters <em>loc</em> and <em>set</em> specify where to insert the new attribute. Refer to the manpage of X509_NAME_add_entry(3) for details. <em>loc</em> defaults to -1 and <em>set</em> defaults to 0. This appends a single-valued RDN to the end.</p> - - - <div class="method-source-code" id="add_entry-source"> <pre>static VALUE ossl_x509name_add_entry(int argc, VALUE *argv, VALUE self) @@ -521,43 +393,22 @@ VALUE ossl_x509name_add_entry(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-cmp" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> cmp(other) → -1 | 0 | 1 | nil </span> - <span class="method-click-advice">click to toggle source</span> - - </div> - - <div class="method-heading"> - <span class="method-callseq"> - name <=> other → -1 | 0 | 1 | nil - </span> - </div> - - <div class="method-description"> - - <p>Compares this <a href="Name.html"><code>Name</code></a> with <em>other</em> and returns <code>0</code> if they are the same and <code>-1</code> or +<code>1</code> if they are greater or less than each other respectively. Returns <code>nil</code> if they are not comparable (i.e. different types).</p> - - + <p>Compares this <a href="Name.html"><code>Name</code></a> with <em>other</em> and returns <code>0</code> if they are the same and <code>-1</code> or <code>+1</code> if they are greater or less than each other respectively. Returns <code>nil</code> if they are not comparable (i.e. different types).</p> - <div class="method-source-code" id="cmp-source"> <pre>static VALUE ossl_x509name_cmp(VALUE self, VALUE other) @@ -574,40 +425,25 @@ ossl_x509name_cmp(VALUE self, VALUE other) return INT2FIX(0); }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="Name.html#method-i-3C-3D-3E"><=></a> </div> - - </div> - <div id="method-i-eql-3F" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> eql?(other) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns true if <em>name</em> and <em>other</em> refer to the same hash key.</p> - - - <div class="method-source-code" id="eql-3F-source"> <pre>static VALUE ossl_x509name_eql(VALUE self, VALUE other) @@ -618,36 +454,22 @@ ossl_x509name_eql(VALUE self, VALUE other) return ossl_x509name_cmp0(self, other) == 0 ? Qtrue : Qfalse; }</pre> </div> - </div> - - </div> - <div id="method-i-hash" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> hash → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>The hash value returned is suitable for use as a certificate's filename in a CA path.</p> - - + <p>The hash value returned is suitable for use as a certificate’s filename in a CA path.</p> - <div class="method-source-code" id="hash-source"> <pre>static VALUE ossl_x509name_hash(VALUE self) @@ -662,36 +484,22 @@ ossl_x509name_hash(VALUE self) return ULONG2NUM(hash); }</pre> </div> - </div> - - </div> - <div id="method-i-hash_old" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> hash_old → integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns an MD5 based hash used in <a href="../../OpenSSL.html"><code>OpenSSL</code></a> 0.9.X.</p> - - - <div class="method-source-code" id="hash_old-source"> <pre>static VALUE ossl_x509name_hash_old(VALUE self) @@ -706,33 +514,21 @@ ossl_x509name_hash_old(VALUE self) return ULONG2NUM(hash); }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_x509name_initialize_copy(VALUE self, VALUE other) @@ -753,33 +549,21 @@ ossl_x509name_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-pretty_print" class="method-detail "> - <div class="method-heading"> <span class="method-name">pretty_print</span><span class="method-args">(q)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="pretty_print-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 301</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pretty_print</span>(<span class="ruby-identifier">q</span>) @@ -789,36 +573,22 @@ ossl_x509name_initialize_copy(VALUE self, VALUE other) } <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-to_a" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_a → [[name, data, type], ...] </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns an Array representation of the distinguished name suitable for passing to <a href="Name.html#method-c-new"><code>::new</code></a></p> - - - <div class="method-source-code" id="to_a-source"> <pre>static VALUE ossl_x509name_to_a(VALUE self) @@ -860,36 +630,22 @@ ossl_x509name_to_a(VALUE self) return ret; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_der → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Converts the name to DER encoding</p> - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_x509name_to_der(VALUE self) @@ -911,38 +667,25 @@ ossl_x509name_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-to_s" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_s → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-heading"> <span class="method-callseq"> to_s(format) → string </span> - </div> - - <div class="method-description"> - <p>Returns a String representation of the Distinguished <a href="Name.html"><code>Name</code></a>. <em>format</em> is one of:</p> <ul><li> <p><a href="Name.html#COMPAT"><code>OpenSSL::X509::Name::COMPAT</code></a></p> @@ -955,10 +698,7 @@ ossl_x509name_to_der(VALUE self) </li></ul> <p>If <em>format</em> is omitted, the largely broken and traditional <a href="../../OpenSSL.html"><code>OpenSSL</code></a> format is used.</p> - - - <div class="method-source-code" id="to_s-source"> <pre>static VALUE ossl_x509name_to_s(int argc, VALUE *argv, VALUE self) @@ -971,36 +711,22 @@ ossl_x509name_to_s(int argc, VALUE *argv, VALUE self) return x509name_print(self, NUM2ULONG(argv[0])); }</pre> </div> - </div> - - </div> - <div id="method-i-to_utf8" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> to_utf8 → string </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns an UTF-8 representation of the distinguished name, as specified in <a href="https://www.ietf.org/rfc/rfc2253.txt">RFC 2253</a>.</p> - - - <div class="method-source-code" id="to_utf8-source"> <pre>static VALUE ossl_x509name_to_utf8(VALUE self) @@ -1010,25 +736,20 @@ ossl_x509name_to_utf8(VALUE self) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/Name/RFC2253DN.html b/OpenSSL/X509/Name/RFC2253DN.html index 888ec0b5..ceb064a0 100644 --- a/OpenSSL/X509/Name/RFC2253DN.html +++ b/OpenSSL/X509/Name/RFC2253DN.html @@ -21,8 +21,6 @@ <link href="../../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="module"> <nav role="navigation"> <div id="project-navigation"> @@ -62,20 +60,16 @@ - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-i-expand_hexstring">#expand_hexstring</a> - <li ><a href="#method-i-expand_pair">#expand_pair</a> - <li ><a href="#method-i-expand_value">#expand_value</a> - <li ><a href="#method-i-scan">#scan</a> - </ul> </div> @@ -91,100 +85,54 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> - <dt id="AttributeType">AttributeType - <dd> - - <dt id="AttributeValue">AttributeValue - <dd> - - <dt id="HexChar">HexChar - <dd> - - <dt id="HexPair">HexPair - <dd> - - <dt id="HexString">HexString - <dd> - - <dt id="Pair">Pair - <dd> - - <dt id="QuoteChar">QuoteChar - <dd> - - <dt id="Special">Special - <dd> - - <dt id="StringChar">StringChar - <dd> - - <dt id="TypeAndValue">TypeAndValue - <dd> - - </dl> </section> - - - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-expand_hexstring" class="method-detail "> - <div class="method-heading"> <span class="method-name">expand_hexstring</span><span class="method-args">(str)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="expand_hexstring-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 237</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">expand_hexstring</span>(<span class="ruby-identifier">str</span>) @@ -194,33 +142,21 @@ <span class="ruby-keyword">return</span> <span class="ruby-identifier">a1</span>.<span class="ruby-identifier">value</span>, <span class="ruby-identifier">a1</span>.<span class="ruby-identifier">tag</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-expand_pair" class="method-detail "> - <div class="method-heading"> <span class="method-name">expand_pair</span><span class="method-args">(str)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="expand_pair-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 225</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">expand_pair</span>(<span class="ruby-identifier">str</span>) @@ -235,33 +171,21 @@ } <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-expand_value" class="method-detail "> - <div class="method-heading"> <span class="method-name">expand_value</span><span class="method-args">(str1, str2, str3)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="expand_value-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 244</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">expand_value</span>(<span class="ruby-identifier">str1</span>, <span class="ruby-identifier">str2</span>, <span class="ruby-identifier">str3</span>) @@ -271,33 +195,21 @@ <span class="ruby-keyword">return</span> <span class="ruby-identifier">value</span>, <span class="ruby-identifier">tag</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-scan" class="method-detail "> - <div class="method-heading"> <span class="method-name">scan</span><span class="method-args">(dn)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="scan-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 251</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">scan</span>(<span class="ruby-identifier">dn</span>) @@ -329,25 +241,20 @@ <span class="ruby-keyword">return</span> <span class="ruby-identifier">ary</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/NameError.html b/OpenSSL/X509/NameError.html index 6890123d..fdd94ea1 100644 --- a/OpenSSL/X509/NameError.html +++ b/OpenSSL/X509/NameError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/X509/Request.html b/OpenSSL/X509/Request.html index 3def61bf..b8ad3bfb 100644 --- a/OpenSSL/X509/Request.html +++ b/OpenSSL/X509/Request.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,71 +57,48 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <div id="includes-section" class="nav-section"> + +<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> - - <li><a class="include" href="../Marshal.html">OpenSSL::Marshal</a> - - </ul> </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-add_attribute">#add_attribute</a> - <li ><a href="#method-i-attributes">#attributes</a> - <li ><a href="#method-i-attributes-3D">#attributes=</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-public_key">#public_key</a> - <li ><a href="#method-i-public_key-3D">#public_key=</a> - <li ><a href="#method-i-sign">#sign</a> - <li ><a href="#method-i-signature_algorithm">#signature_algorithm</a> - <li ><a href="#method-i-subject">#subject</a> - <li ><a href="#method-i-subject-3D">#subject=</a> - <li ><a href="#method-i-to_der">#to_der</a> - <li ><a href="#method-i-to_pem">#to_pem</a> - <li ><a href="#method-i-to_s">#to_s</a> - <li ><a href="#method-i-to_text">#to_text</a> - <li ><a href="#method-i-verify">#verify</a> - <li ><a href="#method-i-version">#version</a> - <li ><a href="#method-i-version-3D">#version=</a> - </ul> </div> @@ -139,41 +114,27 @@ </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-new" class="method-detail "> - <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(p1 = v1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_x509req_initialize(int argc, VALUE *argv, VALUE self) @@ -200,41 +161,28 @@ ossl_x509req_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3D-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">==</span><span class="method-args">(other)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="3D-3D-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 363</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>) @@ -242,33 +190,21 @@ ossl_x509req_initialize(int argc, VALUE *argv, VALUE self) <span class="ruby-identifier">to_der</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">to_der</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-add_attribute" class="method-detail "> - <div class="method-heading"> <span class="method-name">add_attribute</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="add_attribute-source"> <pre>static VALUE ossl_x509req_add_attribute(VALUE self, VALUE attr) @@ -283,33 +219,21 @@ ossl_x509req_add_attribute(VALUE self, VALUE attr) return attr; }</pre> </div> - </div> - - </div> - <div id="method-i-attributes" class="method-detail "> - <div class="method-heading"> <span class="method-name">attributes</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="attributes-source"> <pre>static VALUE ossl_x509req_get_attributes(VALUE self) @@ -335,33 +259,21 @@ ossl_x509req_get_attributes(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-attributes-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">attributes=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="attributes-3D-source"> <pre>static VALUE ossl_x509req_set_attributes(VALUE self, VALUE ary) @@ -388,33 +300,21 @@ ossl_x509req_set_attributes(VALUE self, VALUE ary) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_x509req_copy(VALUE self, VALUE other) @@ -434,33 +334,21 @@ ossl_x509req_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-public_key" class="method-detail "> - <div class="method-heading"> <span class="method-name">public_key</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="public_key-source"> <pre>static VALUE ossl_x509req_get_public_key(VALUE self) @@ -476,33 +364,21 @@ ossl_x509req_get_public_key(VALUE self) return ossl_pkey_new(pkey); /* NO DUP - OK */ }</pre> </div> - </div> - - </div> - <div id="method-i-public_key-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">public_key=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="public_key-3D-source"> <pre>static VALUE ossl_x509req_set_public_key(VALUE self, VALUE key) @@ -518,33 +394,21 @@ ossl_x509req_set_public_key(VALUE self, VALUE key) return key; }</pre> </div> - </div> - - </div> - <div id="method-i-sign" class="method-detail "> - <div class="method-heading"> <span class="method-name">sign</span><span class="method-args">(p1, p2)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="sign-source"> <pre>static VALUE ossl_x509req_sign(VALUE self, VALUE key, VALUE digest) @@ -563,33 +427,21 @@ ossl_x509req_sign(VALUE self, VALUE key, VALUE digest) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-signature_algorithm" class="method-detail "> - <div class="method-heading"> <span class="method-name">signature_algorithm</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="signature_algorithm-source"> <pre>static VALUE ossl_x509req_get_signature_algorithm(VALUE self) @@ -612,33 +464,21 @@ ossl_x509req_get_signature_algorithm(VALUE self) return ossl_membio2str(out); }</pre> </div> - </div> - - </div> - <div id="method-i-subject" class="method-detail "> - <div class="method-heading"> <span class="method-name">subject</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="subject-source"> <pre>static VALUE ossl_x509req_get_subject(VALUE self) @@ -654,33 +494,21 @@ ossl_x509req_get_subject(VALUE self) return ossl_x509name_new(name); }</pre> </div> - </div> - - </div> - <div id="method-i-subject-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">subject=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="subject-3D-source"> <pre>static VALUE ossl_x509req_set_subject(VALUE self, VALUE subject) @@ -696,33 +524,21 @@ ossl_x509req_set_subject(VALUE self, VALUE subject) return subject; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_der</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_x509req_to_der(VALUE self) @@ -744,33 +560,21 @@ ossl_x509req_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - <div id="method-i-to_pem" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_pem</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_pem-source"> <pre>static VALUE ossl_x509req_to_pem(VALUE self) @@ -790,65 +594,41 @@ ossl_x509req_to_pem(VALUE self) return ossl_membio2str(out); }</pre> </div> - </div> - <div class="aliases"> Also aliased as: <a href="Request.html#method-i-to_s">to_s</a> </div> - - </div> - <div id="method-i-to_s" class="method-detail method-alias"> - <div class="method-heading"> <span class="method-name">to_s</span><span class="method-args">()</span> - </div> - <div class="method-description"> - - - - </div> - - <div class="aliases"> Alias for: <a href="Request.html#method-i-to_pem">to_pem</a> </div> - </div> - <div id="method-i-to_text" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_text</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_text-source"> <pre>static VALUE ossl_x509req_to_text(VALUE self) @@ -868,33 +648,21 @@ ossl_x509req_to_text(VALUE self) return ossl_membio2str(out); }</pre> </div> - </div> - - </div> - <div id="method-i-verify" class="method-detail "> - <div class="method-heading"> <span class="method-name">verify</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - <p>Checks that cert signature is made with PRIVversion of this PUBLIC 'key'</p> - - + <p>Checks that cert signature is made with PRIVversion of this PUBLIC ‘key’</p> - <div class="method-source-code" id="verify-source"> <pre>static VALUE ossl_x509req_verify(VALUE self, VALUE key) @@ -916,33 +684,21 @@ ossl_x509req_verify(VALUE self, VALUE key) } }</pre> </div> - </div> - - </div> - <div id="method-i-version" class="method-detail "> - <div class="method-heading"> <span class="method-name">version</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="version-source"> <pre>static VALUE ossl_x509req_get_version(VALUE self) @@ -956,33 +712,21 @@ ossl_x509req_get_version(VALUE self) return LONG2NUM(version); }</pre> </div> - </div> - - </div> - <div id="method-i-version-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">version=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="version-3D-source"> <pre>static VALUE ossl_x509req_set_version(VALUE self, VALUE version) @@ -1001,25 +745,20 @@ ossl_x509req_set_version(VALUE self, VALUE version) return version; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/RequestError.html b/OpenSSL/X509/RequestError.html index c40ceec8..0eeda107 100644 --- a/OpenSSL/X509/RequestError.html +++ b/OpenSSL/X509/RequestError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/X509/Revoked.html b/OpenSSL/X509/Revoked.html index 5abf4fc4..9ce99dec 100644 --- a/OpenSSL/X509/Revoked.html +++ b/OpenSSL/X509/Revoked.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,44 +57,32 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-3D-3D">#==</a> - <li ><a href="#method-i-add_extension">#add_extension</a> - <li ><a href="#method-i-extensions">#extensions</a> - <li ><a href="#method-i-extensions-3D">#extensions=</a> - <li ><a href="#method-i-initialize_copy">#initialize_copy</a> - <li ><a href="#method-i-serial">#serial</a> - <li ><a href="#method-i-serial-3D">#serial=</a> - <li ><a href="#method-i-time">#time</a> - <li ><a href="#method-i-time-3D">#time=</a> - <li ><a href="#method-i-to_der">#to_der</a> - </ul> </div> @@ -112,41 +98,27 @@ </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-new" class="method-detail "> - <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(*args)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_x509revoked_initialize(int argc, VALUE *argv, VALUE self) @@ -155,41 +127,28 @@ ossl_x509revoked_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-3D-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">==</span><span class="method-args">(other)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="3D-3D-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 354</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>) @@ -197,33 +156,21 @@ ossl_x509revoked_initialize(int argc, VALUE *argv, VALUE self) <span class="ruby-identifier">to_der</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">to_der</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-add_extension" class="method-detail "> - <div class="method-heading"> <span class="method-name">add_extension</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="add_extension-source"> <pre>static VALUE ossl_x509revoked_add_extension(VALUE self, VALUE ext) @@ -238,33 +185,21 @@ ossl_x509revoked_add_extension(VALUE self, VALUE ext) return ext; }</pre> </div> - </div> - - </div> - <div id="method-i-extensions" class="method-detail "> - <div class="method-heading"> <span class="method-name">extensions</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Gets X509v3 extensions as array of X509Ext objects</p> - - - <div class="method-source-code" id="extensions-source"> <pre>static VALUE ossl_x509revoked_get_extensions(VALUE self) @@ -289,33 +224,21 @@ ossl_x509revoked_get_extensions(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-extensions-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">extensions=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>Sets X509_EXTENSIONs</p> - - - <div class="method-source-code" id="extensions-3D-source"> <pre>static VALUE ossl_x509revoked_set_extensions(VALUE self, VALUE ary) @@ -343,33 +266,21 @@ ossl_x509revoked_set_extensions(VALUE self, VALUE ary) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-initialize_copy" class="method-detail "> - <div class="method-heading"> <span class="method-name">initialize_copy</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="initialize_copy-source"> <pre>static VALUE ossl_x509revoked_initialize_copy(VALUE self, VALUE other) @@ -390,33 +301,21 @@ ossl_x509revoked_initialize_copy(VALUE self, VALUE other) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-serial" class="method-detail "> - <div class="method-heading"> <span class="method-name">serial</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="serial-source"> <pre>static VALUE ossl_x509revoked_get_serial(VALUE self) @@ -428,33 +327,21 @@ ossl_x509revoked_get_serial(VALUE self) return asn1integer_to_num(X509_REVOKED_get0_serialNumber(rev)); }</pre> </div> - </div> - - </div> - <div id="method-i-serial-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">serial=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="serial-3D-source"> <pre>static VALUE ossl_x509revoked_set_serial(VALUE self, VALUE num) @@ -473,33 +360,21 @@ ossl_x509revoked_set_serial(VALUE self, VALUE num) return num; }</pre> </div> - </div> - - </div> - <div id="method-i-time" class="method-detail "> - <div class="method-heading"> <span class="method-name">time</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="time-source"> <pre>static VALUE ossl_x509revoked_get_time(VALUE self) @@ -515,33 +390,21 @@ ossl_x509revoked_get_time(VALUE self) return asn1time_to_time(time); }</pre> </div> - </div> - - </div> - <div id="method-i-time-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">time=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="time-3D-source"> <pre>static VALUE ossl_x509revoked_set_time(VALUE self, VALUE time) @@ -560,33 +423,21 @@ ossl_x509revoked_set_time(VALUE self, VALUE time) return time; }</pre> </div> - </div> - - </div> - <div id="method-i-to_der" class="method-detail "> - <div class="method-heading"> <span class="method-name">to_der</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="to_der-source"> <pre>static VALUE ossl_x509revoked_to_der(VALUE self) @@ -608,25 +459,20 @@ ossl_x509revoked_to_der(VALUE self) return str; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/RevokedError.html b/OpenSSL/X509/RevokedError.html index 25c7675f..e791a9ff 100644 --- a/OpenSSL/X509/RevokedError.html +++ b/OpenSSL/X509/RevokedError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/OpenSSL/X509/Store.html b/OpenSSL/X509/Store.html index 8e1dd530..9ea6a1ce 100644 --- a/OpenSSL/X509/Store.html +++ b/OpenSSL/X509/Store.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,46 +57,33 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-add_cert">#add_cert</a> - <li ><a href="#method-i-add_crl">#add_crl</a> - <li ><a href="#method-i-add_file">#add_file</a> - <li ><a href="#method-i-add_path">#add_path</a> - <li ><a href="#method-i-flags-3D">#flags=</a> - <li ><a href="#method-i-purpose-3D">#purpose=</a> - <li ><a href="#method-i-set_default_paths">#set_default_paths</a> - <li ><a href="#method-i-time-3D">#time=</a> - <li ><a href="#method-i-trust-3D">#trust=</a> - <li ><a href="#method-i-verify">#verify</a> - <li ><a href="#method-i-verify_callback-3D">#verify_callback=</a> - </ul> </div> @@ -120,7 +105,7 @@ <span class="ruby-identifier">cert_store</span>.<span class="ruby-identifier">set_default_paths</span> </pre> -<p>This will use your system's built-in certificates.</p> +<p>This will use your system’s built-in certificates.</p> <p>If your system does not have a default set of certificates you can obtain a set extracted from Mozilla CA certificate store by cURL maintainers here: <a href="https://curl.haxx.se/docs/caextract.html">curl.haxx.se/docs/caextract.html</a> (You may wish to use the firefox-db2pem.sh script to extract the certificates from a local install to avoid man-in-the-middle attacks.)</p> @@ -143,21 +128,15 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> - <div id="attribute-i-chain" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">chain</span><span @@ -165,12 +144,9 @@ </div> <div class="method-description"> - <p>The certificate chain constructed by the last call of <a href="Store.html#method-i-verify"><code>verify</code></a>.</p> - </div> </div> - <div id="attribute-i-error" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">error</span><span @@ -178,12 +154,9 @@ </div> <div class="method-description"> - <p>The error code set by the last call of <a href="Store.html#method-i-verify"><code>verify</code></a>.</p> - </div> </div> - <div id="attribute-i-error_string" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">error_string</span><span @@ -191,12 +164,9 @@ </div> <div class="method-description"> - <p>The description for the error code set by the last call of <a href="Store.html#method-i-verify"><code>verify</code></a>.</p> - </div> </div> - <div id="attribute-i-verify_callback" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">verify_callback</span><span @@ -204,45 +174,30 @@ </div> <div class="method-description"> - <p>The callback for additional certificate verification. It is invoked for each untrusted certificate in the chain.</p> <p>The callback is invoked with two values, a boolean that indicates if the pre-verification by <a href="../../OpenSSL.html"><code>OpenSSL</code></a> has succeeded or not, and the <a href="StoreContext.html"><code>StoreContext</code></a> in use. The callback must return either true or false.</p> - </div> </div> - </section> - - + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> - <div id="method-c-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> X509::Store.new → store </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Creates a new <a href="Store.html"><code>X509::Store</code></a>.</p> - - - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_x509store_initialize(int argc, VALUE *argv, VALUE self) @@ -267,44 +222,29 @@ ossl_x509store_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-add_cert" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add_cert(cert) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Adds the <a href="Certificate.html"><code>OpenSSL::X509::Certificate</code></a> <em>cert</em> to the certificate store.</p> - - - <div class="method-source-code" id="add_cert-source"> <pre>static VALUE ossl_x509store_add_cert(VALUE self, VALUE arg) @@ -321,36 +261,22 @@ ossl_x509store_add_cert(VALUE self, VALUE arg) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-add_crl" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add_crl(crl) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Adds the <a href="CRL.html"><code>OpenSSL::X509::CRL</code></a> <em>crl</em> to the store.</p> - - - <div class="method-source-code" id="add_crl-source"> <pre>static VALUE ossl_x509store_add_crl(VALUE self, VALUE arg) @@ -367,36 +293,22 @@ ossl_x509store_add_crl(VALUE self, VALUE arg) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-add_file" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add_file(file) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Adds the certificates in <em>file</em> to the certificate store. <em>file</em> is the path to the file, and the file contains one or more certificates in PEM format concatenated together.</p> - - - <div class="method-source-code" id="add_file-source"> <pre>static VALUE ossl_x509store_add_file(VALUE self, VALUE file) @@ -427,36 +339,22 @@ ossl_x509store_add_file(VALUE self, VALUE file) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-add_path" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> add_path(path) → self </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Adds <em>path</em> as the hash dir to be looked up by the store.</p> - - - <div class="method-source-code" id="add_path-source"> <pre>static VALUE ossl_x509store_add_path(VALUE self, VALUE dir) @@ -478,36 +376,22 @@ ossl_x509store_add_path(VALUE self, VALUE dir) return self; }</pre> </div> - </div> - - </div> - <div id="method-i-flags-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> flags = flags </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Sets <em>flags</em> to the <a href="Store.html"><code>Store</code></a>. <em>flags</em> consists of zero or more of the constants defined in with name V_FLAG_* or'ed together.</p> - - + <p>Sets <em>flags</em> to the <a href="Store.html"><code>Store</code></a>. <em>flags</em> consists of zero or more of the constants defined in with name V_FLAG_* or’ed together.</p> - <div class="method-source-code" id="flags-3D-source"> <pre>static VALUE ossl_x509store_set_flags(VALUE self, VALUE flags) @@ -521,32 +405,21 @@ ossl_x509store_set_flags(VALUE self, VALUE flags) return flags; }</pre> </div> - </div> - - </div> - <div id="method-i-purpose-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> purpose = purpose </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - <p>Sets the store's purpose to <em>purpose</em>. If specified, the verifications on the store will check every untrusted certificate's extensions are consistent with the purpose. The purpose is specified by constants:</p> + <p>Sets the store’s purpose to <em>purpose</em>. If specified, the verifications on the store will check every untrusted certificate’s extensions are consistent with the purpose. The purpose is specified by constants:</p> <ul><li> <p>X509::PURPOSE_SSL_CLIENT</p> </li><li> @@ -566,10 +439,7 @@ ossl_x509store_set_flags(VALUE self, VALUE flags) </li><li> <p>X509::PURPOSE_TIMESTAMP_SIGN</p> </li></ul> - - - <div class="method-source-code" id="purpose-3D-source"> <pre>static VALUE ossl_x509store_set_purpose(VALUE self, VALUE purpose) @@ -583,41 +453,27 @@ ossl_x509store_set_purpose(VALUE self, VALUE purpose) return purpose; }</pre> </div> - </div> - - </div> - <div id="method-i-set_default_paths" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> set_default_paths </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Configures <em>store</em> to look up CA certificates from the system default certificate store as needed basis. The location of the store can usually be determined by:</p> <ul><li> <p>OpenSSL::X509::DEFAULT_CERT_FILE</p> </li><li> <p>OpenSSL::X509::DEFAULT_CERT_DIR</p> </li></ul> - - - <div class="method-source-code" id="set_default_paths-source"> <pre>static VALUE ossl_x509store_set_default_paths(VALUE self) @@ -632,36 +488,22 @@ ossl_x509store_set_default_paths(VALUE self) return Qnil; }</pre> </div> - </div> - - </div> - <div id="method-i-time-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> time = time </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the time to be used in verifications.</p> - - - <div class="method-source-code" id="time-3D-source"> <pre>static VALUE ossl_x509store_set_time(VALUE self, VALUE time) @@ -670,36 +512,22 @@ ossl_x509store_set_time(VALUE self, VALUE time) return time; }</pre> </div> - </div> - - </div> - <div id="method-i-trust-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> trust = trust </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="trust-3D-source"> <pre>static VALUE ossl_x509store_set_trust(VALUE self, VALUE trust) @@ -713,31 +541,20 @@ ossl_x509store_set_trust(VALUE self, VALUE trust) return trust; }</pre> </div> - </div> - - </div> - <div id="method-i-verify" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> verify(cert, chain = nil) → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Performs a certificate verification on the <a href="Certificate.html"><code>OpenSSL::X509::Certificate</code></a> <em>cert</em>.</p> <p><em>chain</em> can be an array of <a href="Certificate.html"><code>OpenSSL::X509::Certificate</code></a> that is used to construct the certificate chain.</p> @@ -745,10 +562,7 @@ ossl_x509store_set_trust(VALUE self, VALUE trust) <p>If a block is given, it overrides the callback set by <a href="Store.html#method-i-verify_callback-3D"><code>verify_callback=</code></a>.</p> <p>After finishing the verification, the error information can be retrieved by <a href="Store.html#attribute-i-error"><code>error</code></a>, <a href="Store.html#attribute-i-error_string"><code>error_string</code></a>, and the resulting complete certificate chain can be retrieved by <a href="Store.html#attribute-i-chain"><code>chain</code></a>.</p> - - - <div class="method-source-code" id="verify-source"> <pre>static VALUE ossl_x509store_verify(int argc, VALUE *argv, VALUE self) @@ -770,33 +584,21 @@ ossl_x509store_verify(int argc, VALUE *argv, VALUE self) return result; }</pre> </div> - </div> - - </div> - <div id="method-i-verify_callback-3D" class="method-detail "> - <div class="method-heading"> <span class="method-name">verify_callback=</span><span class="method-args">(p1)</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - <p>General callback for <a href="../../OpenSSL.html"><code>OpenSSL</code></a> verify</p> - - - <div class="method-source-code" id="verify_callback-3D-source"> <pre>static VALUE ossl_x509store_set_vfy_cb(VALUE self, VALUE cb) @@ -810,25 +612,20 @@ ossl_x509store_set_vfy_cb(VALUE self, VALUE cb) return cb; }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/StoreContext.html b/OpenSSL/X509/StoreContext.html index e5f33ea2..2ed03771 100644 --- a/OpenSSL/X509/StoreContext.html +++ b/OpenSSL/X509/StoreContext.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,50 +57,35 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link">Object - </div> - <!-- Method Quickref --> + +<!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> - <li ><a href="#method-c-new">::new</a> - <li ><a href="#method-i-chain">#chain</a> - <li ><a href="#method-i-cleanup">#cleanup</a> - <li ><a href="#method-i-current_cert">#current_cert</a> - <li ><a href="#method-i-current_crl">#current_crl</a> - <li ><a href="#method-i-error">#error</a> - <li ><a href="#method-i-error-3D">#error=</a> - <li ><a href="#method-i-error_depth">#error_depth</a> - <li ><a href="#method-i-error_string">#error_string</a> - <li ><a href="#method-i-flags-3D">#flags=</a> - <li ><a href="#method-i-purpose-3D">#purpose=</a> - <li ><a href="#method-i-time-3D">#time=</a> - <li ><a href="#method-i-trust-3D">#trust=</a> - <li ><a href="#method-i-verify">#verify</a> - </ul> </div> @@ -120,44 +103,28 @@ </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-new" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> - new(store, cert = nil, chain = nil) + new(store, cert = nil, untrusted = nil) </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - + <p>Sets up a <a href="StoreContext.html"><code>StoreContext</code></a> for a verification of the X.509 certificate <em>cert</em>.</p> - <div class="method-source-code" id="new-source"> <pre>static VALUE ossl_x509stctx_initialize(int argc, VALUE *argv, VALUE self) @@ -167,15 +134,24 @@ ossl_x509stctx_initialize(int argc, VALUE *argv, VALUE self) X509_STORE *x509st; X509 *x509 = NULL; STACK_OF(X509) *x509s = NULL; + int state; rb_scan_args(argc, argv, "12", &store, &cert, &chain); GetX509StCtx(self, ctx); GetX509Store(store, x509st); - if(!NIL_P(cert)) x509 = DupX509CertPtr(cert); /* NEED TO DUP */ - if(!NIL_P(chain)) x509s = ossl_x509_ary2sk(chain); - if(X509_STORE_CTX_init(ctx, x509st, x509, x509s) != 1){ + if (!NIL_P(cert)) + x509 = DupX509CertPtr(cert); /* NEED TO DUP */ + if (!NIL_P(chain)) { + x509s = ossl_protect_x509_ary2sk(chain, &state); + if (state) { + X509_free(x509); + rb_jump_tag(state); + } + } + if (X509_STORE_CTX_init(ctx, x509st, x509, x509s) != 1){ + X509_free(x509); sk_X509_pop_free(x509s, X509_free); - ossl_raise(eX509StoreError, NULL); + ossl_raise(eX509StoreError, "X509_STORE_CTX_init"); } if (!NIL_P(t = rb_iv_get(store, "@time"))) ossl_x509stctx_set_time(self, t); @@ -185,44 +161,29 @@ ossl_x509stctx_initialize(int argc, VALUE *argv, VALUE self) return self; }</pre> </div> - </div> - - </div> - </section> - + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> - <div id="method-i-chain" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> chain → Array of X509::Certificate </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="chain-source"> <pre>static VALUE ossl_x509stctx_get_chain(VALUE self) @@ -250,69 +211,43 @@ ossl_x509stctx_get_chain(VALUE self) return ary; }</pre> </div> - </div> - - </div> - <div id="method-i-cleanup" class="method-detail "> - <div class="method-heading"> <span class="method-name">cleanup</span><span class="method-args">()</span> - <span class="method-click-advice">click to toggle source</span> - </div> - <div class="method-description"> - - - - <div class="method-source-code" id="cleanup-source"> <pre><span class="ruby-comment"># File lib/openssl/x509.rb, line 319</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cleanup</span> <span class="ruby-identifier">warn</span> <span class="ruby-node">"(#{caller.first}) OpenSSL::X509::StoreContext#cleanup is deprecated with no replacement"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">$VERBOSE</span> <span class="ruby-keyword">end</span></pre> </div> - </div> - - </div> - <div id="method-i-current_cert" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> current_cert → X509::Certificate </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="current_cert-source"> <pre>static VALUE ossl_x509stctx_get_curr_cert(VALUE self) @@ -324,36 +259,22 @@ ossl_x509stctx_get_curr_cert(VALUE self) return ossl_x509_new(X509_STORE_CTX_get_current_cert(ctx)); }</pre> </div> - </div> - - </div> - <div id="method-i-current_crl" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> current_crl → X509::CRL </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="current_crl-source"> <pre>static VALUE ossl_x509stctx_get_curr_crl(VALUE self) @@ -369,36 +290,22 @@ ossl_x509stctx_get_curr_crl(VALUE self) return ossl_x509crl_new(crl); }</pre> </div> - </div> - - </div> - <div id="method-i-error" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> error → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="error-source"> <pre>static VALUE ossl_x509stctx_get_err(VALUE self) @@ -410,36 +317,22 @@ ossl_x509stctx_get_err(VALUE self) return INT2NUM(X509_STORE_CTX_get_error(ctx)); }</pre> </div> - </div> - - </div> - <div id="method-i-error-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> error = error_code </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="error-3D-source"> <pre>static VALUE ossl_x509stctx_set_error(VALUE self, VALUE err) @@ -452,36 +345,22 @@ ossl_x509stctx_set_error(VALUE self, VALUE err) return err; }</pre> </div> - </div> - - </div> - <div id="method-i-error_depth" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> error_depth → Integer </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="error_depth-source"> <pre>static VALUE ossl_x509stctx_get_err_depth(VALUE self) @@ -493,36 +372,22 @@ ossl_x509stctx_get_err_depth(VALUE self) return INT2NUM(X509_STORE_CTX_get_error_depth(ctx)); }</pre> </div> - </div> - - </div> - <div id="method-i-error_string" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> error_string → String </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Returns the error string corresponding to the error code retrieved by <a href="StoreContext.html#method-i-error"><code>error</code></a>.</p> - - - <div class="method-source-code" id="error_string-source"> <pre>static VALUE ossl_x509stctx_get_err_string(VALUE self) @@ -536,36 +401,22 @@ ossl_x509stctx_get_err_string(VALUE self) return rb_str_new2(X509_verify_cert_error_string(err)); }</pre> </div> - </div> - - </div> - <div id="method-i-flags-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> flags = flags </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the verification flags to the context. See <a href="Store.html#method-i-flags-3D"><code>Store#flags=</code></a>.</p> - - - <div class="method-source-code" id="flags-3D-source"> <pre>static VALUE ossl_x509stctx_set_flags(VALUE self, VALUE flags) @@ -579,36 +430,22 @@ ossl_x509stctx_set_flags(VALUE self, VALUE flags) return flags; }</pre> </div> - </div> - - </div> - <div id="method-i-purpose-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> purpose = purpose </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the purpose of the context. See <a href="Store.html#method-i-purpose-3D"><code>Store#purpose=</code></a>.</p> - - - <div class="method-source-code" id="purpose-3D-source"> <pre>static VALUE ossl_x509stctx_set_purpose(VALUE self, VALUE purpose) @@ -622,36 +459,22 @@ ossl_x509stctx_set_purpose(VALUE self, VALUE purpose) return purpose; }</pre> </div> - </div> - - </div> - <div id="method-i-time-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> time = time </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - <p>Sets the time used in the verification. If not set, the current time is used.</p> - - - <div class="method-source-code" id="time-3D-source"> <pre>static VALUE ossl_x509stctx_set_time(VALUE self, VALUE time) @@ -666,36 +489,22 @@ ossl_x509stctx_set_time(VALUE self, VALUE time) return time; }</pre> </div> - </div> - - </div> - <div id="method-i-trust-3D" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> trust = trust </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="trust-3D-source"> <pre>static VALUE ossl_x509stctx_set_trust(VALUE self, VALUE trust) @@ -709,36 +518,22 @@ ossl_x509stctx_set_trust(VALUE self, VALUE trust) return trust; }</pre> </div> - </div> - - </div> - <div id="method-i-verify" class="method-detail "> - - <div class="method-heading"> <span class="method-callseq"> verify → true | false </span> - <span class="method-click-advice">click to toggle source</span> - </div> - - <div class="method-description"> - - - - <div class="method-source-code" id="verify-source"> <pre>static VALUE ossl_x509stctx_verify(VALUE self) @@ -760,25 +555,20 @@ ossl_x509stctx_verify(VALUE self) } }</pre> </div> - </div> - - </div> - </section> - - </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. + <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> diff --git a/OpenSSL/X509/StoreError.html b/OpenSSL/X509/StoreError.html index 285dc7c1..35211296 100644 --- a/OpenSSL/X509/StoreError.html +++ b/OpenSSL/X509/StoreError.html @@ -21,8 +21,6 @@ <link href="../../css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> @@ -59,12 +57,11 @@ <div id="class-metadata"> - <div id="parent-class-section" class="nav-section"> + +<div id="parent-class-section" class="nav-section"> <h3>Parent</h3> - <p class="link"><a href="../OpenSSLError.html">OpenSSL::OpenSSLError</a> - </div> @@ -82,25 +79,19 @@ </section> - <section id="5Buntitled-5D" class="documentation-section"> - - - - - - </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. + <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> diff --git a/README_md.html b/README_md.html index 568a030e..e8144693 100644 --- a/README_md.html +++ b/README_md.html @@ -21,8 +21,6 @@ <link href="./css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="file"> <nav role="navigation"> <div id="project-navigation"> @@ -71,17 +69,14 @@ <div id="project-metadata"> - <div id="fileindex-section" class="nav-section"> + +<div id="fileindex-section" class="nav-section"> <h3>Pages</h3> <ul class="link-list"> - <li><a href="./CONTRIBUTING_md.html">CONTRIBUTING</a> - <li><a href="./History_md.html">History</a> - <li><a href="./README_md.html">README</a> - </ul> </div> @@ -148,7 +143,7 @@ <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. + <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> diff --git a/css/rdoc.css b/css/rdoc.css index a52e44ff..ebe2e93a 100644 --- a/css/rdoc.css +++ b/css/rdoc.css @@ -79,6 +79,25 @@ pre { border-radius: 0.2em; } +table { + margin: 0; + border-spacing: 0; + border-collapse: collapse; +} + +table tr th, table tr td { + padding: 0.2em 0.4em; + border: 1px solid #ccc; +} + +table tr th { + background-color: #eceaed; +} + +table tr:nth-child(even) td { + background-color: #f5f4f6; +} + /* @group Generic Classes */ .initially-hidden { @@ -166,6 +185,7 @@ nav { width: 260px; font-family: Helvetica, sans-serif; font-size: 14px; + border-right: 1px solid #ccc; } main { @@ -276,7 +296,7 @@ ul.link-list .type { -webkit-border-radius: 5px; } -dl.label-list dt { +dl.note-list dt { float: left; margin-right: 1em; } diff --git a/fonts/SourceCodePro-Bold.ttf b/fonts/SourceCodePro-Bold.ttf Binary files differindex 61e3090c..dd00982d 100644 --- a/fonts/SourceCodePro-Bold.ttf +++ b/fonts/SourceCodePro-Bold.ttf diff --git a/fonts/SourceCodePro-Regular.ttf b/fonts/SourceCodePro-Regular.ttf Binary files differindex 85686d96..1decfb95 100644 --- a/fonts/SourceCodePro-Regular.ttf +++ b/fonts/SourceCodePro-Regular.ttf @@ -21,8 +21,6 @@ <link href="./css/rdoc.css" rel="stylesheet"> - - <body id="top" role="document" class="file"> <nav role="navigation"> <div id="project-navigation"> @@ -57,17 +55,14 @@ </div> <div id="project-metadata"> - <div id="fileindex-section" class="nav-section"> + +<div id="fileindex-section" class="nav-section"> <h3>Pages</h3> <ul class="link-list"> - <li><a href="./CONTRIBUTING_md.html">CONTRIBUTING</a> - <li><a href="./History_md.html">History</a> - <li><a href="./README_md.html">README</a> - </ul> </div> @@ -75,221 +70,113 @@ <h3>Class and Module Index</h3> <ul class="link-list"> - <li><a href="./IO.html">IO</a> - <li><a href="./IO/WaitReadable.html">IO::WaitReadable</a> - <li><a href="./IO/WaitWritable.html">IO::WaitWritable</a> - <li><a href="./Integer.html">Integer</a> - <li><a href="./OpenSSL.html">OpenSSL</a> - <li><a href="./OpenSSL/ASN1.html">OpenSSL::ASN1</a> - <li><a href="./OpenSSL/ASN1/ASN1Data.html">OpenSSL::ASN1::ASN1Data</a> - <li><a href="./OpenSSL/ASN1/ASN1Error.html">OpenSSL::ASN1::ASN1Error</a> - <li><a href="./OpenSSL/ASN1/Constructive.html">OpenSSL::ASN1::Constructive</a> - <li><a href="./OpenSSL/ASN1/ObjectId.html">OpenSSL::ASN1::ObjectId</a> - <li><a href="./OpenSSL/ASN1/Primitive.html">OpenSSL::ASN1::Primitive</a> - <li><a href="./OpenSSL/BN.html">OpenSSL::BN</a> - <li><a href="./OpenSSL/BNError.html">OpenSSL::BNError</a> - <li><a href="./OpenSSL/Buffering.html">OpenSSL::Buffering</a> - <li><a href="./OpenSSL/Buffering/Buffer.html">OpenSSL::Buffering::Buffer</a> - <li><a href="./OpenSSL/Cipher.html">OpenSSL::Cipher</a> - <li><a href="./OpenSSL/Cipher/Cipher.html">OpenSSL::Cipher::Cipher</a> - <li><a href="./OpenSSL/Cipher/CipherError.html">OpenSSL::Cipher::CipherError</a> - <li><a href="./OpenSSL/Config.html">OpenSSL::Config</a> - <li><a href="./OpenSSL/ConfigError.html">OpenSSL::ConfigError</a> - <li><a href="./OpenSSL/Digest.html">OpenSSL::Digest</a> - <li><a href="./OpenSSL/Digest/DigestError.html">OpenSSL::Digest::DigestError</a> - <li><a href="./OpenSSL/Engine.html">OpenSSL::Engine</a> - <li><a href="./OpenSSL/Engine/EngineError.html">OpenSSL::Engine::EngineError</a> - <li><a href="./OpenSSL/ExtConfig.html">OpenSSL::ExtConfig</a> - <li><a href="./OpenSSL/HMAC.html">OpenSSL::HMAC</a> - <li><a href="./OpenSSL/HMACError.html">OpenSSL::HMACError</a> - <li><a href="./OpenSSL/KDF.html">OpenSSL::KDF</a> - <li><a href="./OpenSSL/KDF/KDFError.html">OpenSSL::KDF::KDFError</a> - <li><a href="./OpenSSL/Marshal.html">OpenSSL::Marshal</a> - <li><a href="./OpenSSL/Marshal/ClassMethods.html">OpenSSL::Marshal::ClassMethods</a> - <li><a href="./OpenSSL/Netscape.html">OpenSSL::Netscape</a> - <li><a href="./OpenSSL/Netscape/SPKI.html">OpenSSL::Netscape::SPKI</a> - <li><a href="./OpenSSL/Netscape/SPKIError.html">OpenSSL::Netscape::SPKIError</a> - <li><a href="./OpenSSL/OCSP.html">OpenSSL::OCSP</a> - <li><a href="./OpenSSL/OCSP/BasicResponse.html">OpenSSL::OCSP::BasicResponse</a> - <li><a href="./OpenSSL/OCSP/CertificateId.html">OpenSSL::OCSP::CertificateId</a> - <li><a href="./OpenSSL/OCSP/OCSPError.html">OpenSSL::OCSP::OCSPError</a> - <li><a href="./OpenSSL/OCSP/Request.html">OpenSSL::OCSP::Request</a> - <li><a href="./OpenSSL/OCSP/Response.html">OpenSSL::OCSP::Response</a> - <li><a href="./OpenSSL/OCSP/SingleResponse.html">OpenSSL::OCSP::SingleResponse</a> - <li><a href="./OpenSSL/OpenSSLError.html">OpenSSL::OpenSSLError</a> - <li><a href="./OpenSSL/PKCS12.html">OpenSSL::PKCS12</a> - <li><a href="./OpenSSL/PKCS12/PKCS12Error.html">OpenSSL::PKCS12::PKCS12Error</a> - <li><a href="./OpenSSL/PKCS5.html">OpenSSL::PKCS5</a> - <li><a href="./OpenSSL/PKCS7.html">OpenSSL::PKCS7</a> - <li><a href="./OpenSSL/PKCS7/PKCS7Error.html">OpenSSL::PKCS7::PKCS7Error</a> - <li><a href="./OpenSSL/PKCS7/RecipientInfo.html">OpenSSL::PKCS7::RecipientInfo</a> - <li><a href="./OpenSSL/PKCS7/SignerInfo.html">OpenSSL::PKCS7::SignerInfo</a> - <li><a href="./OpenSSL/PKey.html">OpenSSL::PKey</a> - <li><a href="./OpenSSL/PKey/DH.html">OpenSSL::PKey::DH</a> - <li><a href="./OpenSSL/PKey/DHError.html">OpenSSL::PKey::DHError</a> - <li><a href="./OpenSSL/PKey/DSA.html">OpenSSL::PKey::DSA</a> - <li><a href="./OpenSSL/PKey/DSAError.html">OpenSSL::PKey::DSAError</a> - <li><a href="./OpenSSL/PKey/EC.html">OpenSSL::PKey::EC</a> - <li><a href="./OpenSSL/PKey/EC/Group.html">OpenSSL::PKey::EC::Group</a> - <li><a href="./OpenSSL/PKey/EC/Group/Error.html">OpenSSL::PKey::EC::Group::Error</a> - <li><a href="./OpenSSL/PKey/EC/Point.html">OpenSSL::PKey::EC::Point</a> - <li><a href="./OpenSSL/PKey/EC/Point/Error.html">OpenSSL::PKey::EC::Point::Error</a> - <li><a href="./OpenSSL/PKey/ECError.html">OpenSSL::PKey::ECError</a> - <li><a href="./OpenSSL/PKey/PKey.html">OpenSSL::PKey::PKey</a> - <li><a href="./OpenSSL/PKey/PKeyError.html">OpenSSL::PKey::PKeyError</a> - <li><a href="./OpenSSL/PKey/RSA.html">OpenSSL::PKey::RSA</a> - <li><a href="./OpenSSL/PKey/RSAError.html">OpenSSL::PKey::RSAError</a> - <li><a href="./OpenSSL/Random.html">OpenSSL::Random</a> - <li><a href="./OpenSSL/Random/RandomError.html">OpenSSL::Random::RandomError</a> - <li><a href="./OpenSSL/SSL.html">OpenSSL::SSL</a> - <li><a href="./OpenSSL/SSL/SSLContext.html">OpenSSL::SSL::SSLContext</a> - <li><a href="./OpenSSL/SSL/SSLError.html">OpenSSL::SSL::SSLError</a> - <li><a href="./OpenSSL/SSL/SSLErrorWaitReadable.html">OpenSSL::SSL::SSLErrorWaitReadable</a> - <li><a href="./OpenSSL/SSL/SSLErrorWaitWritable.html">OpenSSL::SSL::SSLErrorWaitWritable</a> - <li><a href="./OpenSSL/SSL/SSLServer.html">OpenSSL::SSL::SSLServer</a> - <li><a href="./OpenSSL/SSL/SSLSocket.html">OpenSSL::SSL::SSLSocket</a> - <li><a href="./OpenSSL/SSL/Session.html">OpenSSL::SSL::Session</a> - <li><a href="./OpenSSL/SSL/Session/SessionError.html">OpenSSL::SSL::Session::SessionError</a> - <li><a href="./OpenSSL/SSL/SocketForwarder.html">OpenSSL::SSL::SocketForwarder</a> - <li><a href="./OpenSSL/Timestamp.html">OpenSSL::Timestamp</a> - <li><a href="./OpenSSL/Timestamp/Factory.html">OpenSSL::Timestamp::Factory</a> - <li><a href="./OpenSSL/Timestamp/Request.html">OpenSSL::Timestamp::Request</a> - <li><a href="./OpenSSL/Timestamp/Response.html">OpenSSL::Timestamp::Response</a> - <li><a href="./OpenSSL/Timestamp/TimestampError.html">OpenSSL::Timestamp::TimestampError</a> - <li><a href="./OpenSSL/Timestamp/TokenInfo.html">OpenSSL::Timestamp::TokenInfo</a> - <li><a href="./OpenSSL/X509.html">OpenSSL::X509</a> - <li><a href="./OpenSSL/X509/Attribute.html">OpenSSL::X509::Attribute</a> - <li><a href="./OpenSSL/X509/AttributeError.html">OpenSSL::X509::AttributeError</a> - <li><a href="./OpenSSL/X509/CRL.html">OpenSSL::X509::CRL</a> - <li><a href="./OpenSSL/X509/CRLError.html">OpenSSL::X509::CRLError</a> - <li><a href="./OpenSSL/X509/Certificate.html">OpenSSL::X509::Certificate</a> - <li><a href="./OpenSSL/X509/CertificateError.html">OpenSSL::X509::CertificateError</a> - <li><a href="./OpenSSL/X509/Extension.html">OpenSSL::X509::Extension</a> - <li><a href="./OpenSSL/X509/Extension/AuthorityInfoAccess.html">OpenSSL::X509::Extension::AuthorityInfoAccess</a> - <li><a href="./OpenSSL/X509/Extension/AuthorityKeyIdentifier.html">OpenSSL::X509::Extension::AuthorityKeyIdentifier</a> - <li><a href="./OpenSSL/X509/Extension/CRLDistributionPoints.html">OpenSSL::X509::Extension::CRLDistributionPoints</a> - <li><a href="./OpenSSL/X509/Extension/Helpers.html">OpenSSL::X509::Extension::Helpers</a> - <li><a href="./OpenSSL/X509/Extension/SubjectKeyIdentifier.html">OpenSSL::X509::Extension::SubjectKeyIdentifier</a> - <li><a href="./OpenSSL/X509/ExtensionError.html">OpenSSL::X509::ExtensionError</a> - <li><a href="./OpenSSL/X509/ExtensionFactory.html">OpenSSL::X509::ExtensionFactory</a> - <li><a href="./OpenSSL/X509/Name.html">OpenSSL::X509::Name</a> - <li><a href="./OpenSSL/X509/Name/RFC2253DN.html">OpenSSL::X509::Name::RFC2253DN</a> - <li><a href="./OpenSSL/X509/NameError.html">OpenSSL::X509::NameError</a> - <li><a href="./OpenSSL/X509/Request.html">OpenSSL::X509::Request</a> - <li><a href="./OpenSSL/X509/RequestError.html">OpenSSL::X509::RequestError</a> - <li><a href="./OpenSSL/X509/Revoked.html">OpenSSL::X509::Revoked</a> - <li><a href="./OpenSSL/X509/RevokedError.html">OpenSSL::X509::RevokedError</a> - <li><a href="./OpenSSL/X509/Store.html">OpenSSL::X509::Store</a> - <li><a href="./OpenSSL/X509/StoreContext.html">OpenSSL::X509::StoreContext</a> - <li><a href="./OpenSSL/X509/StoreError.html">OpenSSL::X509::StoreError</a> - </ul> </div> @@ -351,14 +238,12 @@ <p>Security issues should be reported to ruby-core by following the process described on <a href="https://www.ruby-lang.org/en/security/">“Security at ruby-lang.org”</a>.</p> - </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. + <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> diff --git a/js/search_index.js b/js/search_index.js index aea01b1f..845a780e 100644 --- a/js/search_index.js +++ b/js/search_index.js @@ -1 +1 @@ -var search_data = {"index":{"searchIndex":["io","waitreadable","waitwritable","integer","openssl","asn1","asn1data","asn1error","constructive","objectid","primitive","bn","bnerror","buffering","buffer","cipher","cipher","ciphererror","config","configerror","digest","digesterror","engine","engineerror","extconfig","hmac","hmacerror","kdf","kdferror","marshal","classmethods","netscape","spki","spkierror","ocsp","basicresponse","certificateid","ocsperror","request","response","singleresponse","opensslerror","pkcs12","pkcs12error","pkcs5","pkcs7","pkcs7error","recipientinfo","signerinfo","pkey","dh","dherror","dsa","dsaerror","ec","group","error","point","error","ecerror","pkey","pkeyerror","rsa","rsaerror","random","randomerror","ssl","sslcontext","sslerror","sslerrorwaitreadable","sslerrorwaitwritable","sslserver","sslsocket","session","sessionerror","socketforwarder","timestamp","factory","request","response","timestamperror","tokeninfo","x509","attribute","attributeerror","crl","crlerror","certificate","certificateerror","extension","authorityinfoaccess","authoritykeyidentifier","crldistributionpoints","helpers","subjectkeyidentifier","extensionerror","extensionfactory","name","rfc2253dn","nameerror","request","requesterror","revoked","revokederror","store","storecontext","storeerror","%()","*()","**()","+()","+@()","-()","-@()","/()","<<()","<<()","<<()","<<()","<<()","<=>()","<=>()","==()","==()","==()","==()","==()","==()","==()","==()","==()","==()","==()","==()","===()",">>()","digest()","[]()","[]=()","_dump()","_load()","accept()","accept()","accept_nonblock()","add()","add_attribute()","add_cert()","add_certid()","add_certificate()","add_certificate()","add_crl()","add_crl()","add_data()","add_entry()","add_extension()","add_extension()","add_extension()","add_file()","add_nonce()","add_nonce()","add_path()","add_recipient()","add_revoked()","add_signer()","add_status()","add_value()","addr()","algorithm()","algorithm()","algorithm=()","alpn_protocol()","asn1_flag()","asn1_flag=()","attributes()","attributes=()","auth_data=()","auth_tag()","auth_tag=()","auth_tag_len=()","authenticated?()","authority_key_identifier()","basic()","bit_set?()","blinding_off!()","blinding_on!()","block_length()","block_size()","builtin_curves()","by_id()","ca_issuer_uris()","ccm_data_len=()","cert()","cert_requested=()","cert_requested?()","cert_status()","certid()","certid()","certificates()","certificates=()","chain()","challenge()","challenge=()","check_key()","check_nonce()","check_private_key()","check_validity()","cipher()","cipher()","cipher=()","ciphers()","ciphers()","ciphers=()","cleanup()","cleanup()","clear_bit!()","client_ca()","close()","close()","closed?()","cmds()","cmp()","cmp()","cmp()","cmp_issuer()","coerce()","cofactor()","compute_key()","concat()","connect()","connect_nonblock()","copy()","copy_nonce()","create()","create()","create_ext()","create_ext_from_array()","create_ext_from_hash()","create_ext_from_string()","create_extension()","create_timestamp()","critical=()","critical?()","crl=()","crl_uris()","crls()","crls=()","ctrl_cmd()","current_cert()","current_crl()","curve_name()","data=()","debug()","debug=()","decode()","decode_all()","decrypt()","decrypt()","degree()","detached()","detached=()","detached?()","dh_compute_key()","digest()","digest()","digest()","digest()","digest_length()","do_not_reverse_lookup=()","dsa_sign_asn1()","dsa_verify_asn1()","each()","each()","each()","each_byte()","each_line()","ecdh_curves=()","egd()","egd_bytes()","enable_fallback_scsv()","enc_key()","encrypt()","encrypt()","engines()","eof()","eof?()","eql?()","eql?()","eql?()","eql?()","error()","error=()","error_depth()","error_string()","errors()","expand_hexstring()","expand_pair()","expand_value()","export()","export()","export()","export()","extensions()","extensions()","extensions()","extensions()","extensions=()","extensions=()","extensions=()","failure_info()","fcntl()","fileno()","final()","find_extension()","find_response()","finish()","finished_message()","fips_mode()","fips_mode=()","fixed_length_secure_compare()","flags=()","flags=()","flush()","flush_sessions()","freeze()","gcd()","gen_time()","generate()","generate()","generate()","generate()","generate_key()","generate_key!()","generate_key!()","generate_prime()","generator()","get_value()","getc()","gets()","getsockopt()","group()","group=()","hash()","hash()","hash_algorithm()","hash_old()","hexdigest()","hexdigest()","hkdf()","hostname=()","id()","id()","included()","infinity?()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","inspect()","inspect()","inspect()","inspect()","inspect()","invert!()","issuer()","issuer()","issuer()","issuer()","issuer=()","issuer=()","issuer_certificate=()","issuer_key_hash()","issuer_name_hash()","iv=()","iv_len()","iv_len=()","key=()","key_len()","key_len=()","last_update()","last_update=()","listen()","ln()","load()","load_private_key()","load_public_key()","load_random_file()","long_name()","lshift!()","make_affine!()","max_version=()","mem_check_start()","message_imprint()","message_imprint()","message_imprint=()","min_version=()","mod_add()","mod_exp()","mod_inverse()","mod_mul()","mod_sqr()","mod_sub()","mul()","name()","name()","name()","negative?()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","next_update()","next_update()","next_update=()","nonce()","nonce()","nonce=()","not_after()","not_after=()","not_before()","not_before=()","npn_protocol()","num_bits()","num_bytes()","ocsp_uris()","odd?()","oid()","oid()","oid()","oid()","oid=()","oid=()","on_curve?()","one?()","options()","options=()","order()","ordering()","padding=()","params()","params()","params()","params_ok?()","parse()","parse()","parse_config()","parse_openssl()","parse_rfc2253()","pbkdf2_hmac()","pbkdf2_hmac()","pbkdf2_hmac_sha1()","peer_cert()","peer_cert_chain()","peer_finished_message()","peeraddr()","pending()","pkcs5_keyivgen()","point_conversion_form()","point_conversion_form=()","policy_id()","policy_id()","policy_id=()","post_connection_check()","pretty_print()","pretty_print()","pretty_print()","prime?()","prime_fasttest?()","print()","print_mem_leaks()","printf()","private?()","private?()","private?()","private?()","private_decrypt()","private_encrypt()","private_key()","private_key=()","private_key?()","private_to_der()","private_to_pem()","public?()","public?()","public?()","public?()","public_decrypt()","public_encrypt()","public_key()","public_key()","public_key()","public_key()","public_key()","public_key()","public_key()","public_key=()","public_key=()","public_key=()","public_key=()","public_key?()","public_to_der()","public_to_pem()","purpose=()","purpose=()","puts()","random_add()","random_bytes()","random_iv()","random_key()","read()","read()","read_nonblock()","read_smime()","readchar()","readline()","readlines()","readpartial()","recipients()","register()","reset()","reset()","reset()","responses()","revocation_reason()","revocation_time()","revoked()","revoked=()","rshift!()","scan()","scrypt()","sections()","secure_compare()","security_level()","security_level=()","seed()","seed()","seed=()","serial()","serial()","serial()","serial()","serial()","serial=()","serial=()","serial_number()","session()","session=()","session_add()","session_cache_mode()","session_cache_mode=()","session_cache_size()","session_cache_size=()","session_cache_stats()","session_remove()","session_reused?()","set_bit!()","set_crt_params()","set_default()","set_default_paths()","set_factors()","set_generator()","set_key()","set_key()","set_key()","set_params()","set_pqg()","set_pqg()","set_to_infinity!()","setsockopt()","setup()","short_name()","shutdown()","sign()","sign()","sign()","sign()","sign()","sign()","sign()","sign()","sign_pss()","signature_algorithm()","signature_algorithm()","signature_algorithm()","signed?()","signed_time()","signers()","sn()","sqr()","ssl_version()","ssl_version=()","state()","status()","status()","status()","status?()","status_string()","status_text()","subject()","subject()","subject=()","subject=()","subject_certificate=()","subject_key_identifier()","subject_request=()","sysclose()","sysread()","syssign()","sysverify()","syswrite()","this_update()","time()","time()","time=()","time=()","time=()","time=()","timeout()","timeout=()","tmp_key()","to_a()","to_a()","to_bn()","to_bn()","to_bn()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_h()","to_i()","to_int()","to_io()","to_octet_string()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_text()","to_text()","to_text()","to_text()","to_text()","to_text()","to_text()","to_text()","to_text()","to_text()","to_utf8()","token()","token_info()","traverse()","trust=()","trust=()","tsa_certificate()","type()","type=()","ucmp()","ungetc()","update()","update()","update()","value()","value()","value=()","value=()","value_der()","verify()","verify()","verify()","verify()","verify()","verify()","verify()","verify()","verify()","verify()","verify()","verify_callback=()","verify_certificate_identity()","verify_pss()","verify_result()","version()","version()","version()","version()","version()","version=()","version=()","version=()","version=()","write()","write_nonblock()","write_random_file()","write_smime()","zero?()","contributing","history","readme"],"longSearchIndex":["io","io::waitreadable","io::waitwritable","integer","openssl","openssl::asn1","openssl::asn1::asn1data","openssl::asn1::asn1error","openssl::asn1::constructive","openssl::asn1::objectid","openssl::asn1::primitive","openssl::bn","openssl::bnerror","openssl::buffering","openssl::buffering::buffer","openssl::cipher","openssl::cipher::cipher","openssl::cipher::ciphererror","openssl::config","openssl::configerror","openssl::digest","openssl::digest::digesterror","openssl::engine","openssl::engine::engineerror","openssl::extconfig","openssl::hmac","openssl::hmacerror","openssl::kdf","openssl::kdf::kdferror","openssl::marshal","openssl::marshal::classmethods","openssl::netscape","openssl::netscape::spki","openssl::netscape::spkierror","openssl::ocsp","openssl::ocsp::basicresponse","openssl::ocsp::certificateid","openssl::ocsp::ocsperror","openssl::ocsp::request","openssl::ocsp::response","openssl::ocsp::singleresponse","openssl::opensslerror","openssl::pkcs12","openssl::pkcs12::pkcs12error","openssl::pkcs5","openssl::pkcs7","openssl::pkcs7::pkcs7error","openssl::pkcs7::recipientinfo","openssl::pkcs7::signerinfo","openssl::pkey","openssl::pkey::dh","openssl::pkey::dherror","openssl::pkey::dsa","openssl::pkey::dsaerror","openssl::pkey::ec","openssl::pkey::ec::group","openssl::pkey::ec::group::error","openssl::pkey::ec::point","openssl::pkey::ec::point::error","openssl::pkey::ecerror","openssl::pkey::pkey","openssl::pkey::pkeyerror","openssl::pkey::rsa","openssl::pkey::rsaerror","openssl::random","openssl::random::randomerror","openssl::ssl","openssl::ssl::sslcontext","openssl::ssl::sslerror","openssl::ssl::sslerrorwaitreadable","openssl::ssl::sslerrorwaitwritable","openssl::ssl::sslserver","openssl::ssl::sslsocket","openssl::ssl::session","openssl::ssl::session::sessionerror","openssl::ssl::socketforwarder","openssl::timestamp","openssl::timestamp::factory","openssl::timestamp::request","openssl::timestamp::response","openssl::timestamp::timestamperror","openssl::timestamp::tokeninfo","openssl::x509","openssl::x509::attribute","openssl::x509::attributeerror","openssl::x509::crl","openssl::x509::crlerror","openssl::x509::certificate","openssl::x509::certificateerror","openssl::x509::extension","openssl::x509::extension::authorityinfoaccess","openssl::x509::extension::authoritykeyidentifier","openssl::x509::extension::crldistributionpoints","openssl::x509::extension::helpers","openssl::x509::extension::subjectkeyidentifier","openssl::x509::extensionerror","openssl::x509::extensionfactory","openssl::x509::name","openssl::x509::name::rfc2253dn","openssl::x509::nameerror","openssl::x509::request","openssl::x509::requesterror","openssl::x509::revoked","openssl::x509::revokederror","openssl::x509::store","openssl::x509::storecontext","openssl::x509::storeerror","openssl::bn#%()","openssl::bn#*()","openssl::bn#**()","openssl::bn#+()","openssl::bn#+@()","openssl::bn#-()","openssl::bn#-@()","openssl::bn#/()","openssl::bn#<<()","openssl::buffering#<<()","openssl::buffering::buffer#<<()","openssl::digest#<<()","openssl::hmac#<<()","openssl::bn#<=>()","openssl::x509::name#<=>()","openssl::asn1::objectid#==()","openssl::bn#==()","openssl::hmac#==()","openssl::pkey::ec::group#==()","openssl::pkey::ec::point#==()","openssl::ssl::session#==()","openssl::x509::attribute#==()","openssl::x509::crl#==()","openssl::x509::certificate#==()","openssl::x509::extension#==()","openssl::x509::request#==()","openssl::x509::revoked#==()","openssl::bn#===()","openssl::bn#>>()","openssl::digest()","openssl::config#[]()","openssl::config#[]=()","openssl::marshal#_dump()","openssl::marshal::classmethods#_load()","openssl::ssl::sslserver#accept()","openssl::ssl::sslsocket#accept()","openssl::ssl::sslsocket#accept_nonblock()","openssl::pkey::ec::point#add()","openssl::x509::request#add_attribute()","openssl::x509::store#add_cert()","openssl::ocsp::request#add_certid()","openssl::pkcs7#add_certificate()","openssl::ssl::sslcontext#add_certificate()","openssl::pkcs7#add_crl()","openssl::x509::store#add_crl()","openssl::pkcs7#add_data()","openssl::x509::name#add_entry()","openssl::x509::crl#add_extension()","openssl::x509::certificate#add_extension()","openssl::x509::revoked#add_extension()","openssl::x509::store#add_file()","openssl::ocsp::basicresponse#add_nonce()","openssl::ocsp::request#add_nonce()","openssl::x509::store#add_path()","openssl::pkcs7#add_recipient()","openssl::x509::crl#add_revoked()","openssl::pkcs7#add_signer()","openssl::ocsp::basicresponse#add_status()","openssl::config#add_value()","openssl::ssl::socketforwarder#addr()","openssl::timestamp::request#algorithm()","openssl::timestamp::tokeninfo#algorithm()","openssl::timestamp::request#algorithm=()","openssl::ssl::sslsocket#alpn_protocol()","openssl::pkey::ec::group#asn1_flag()","openssl::pkey::ec::group#asn1_flag=()","openssl::x509::request#attributes()","openssl::x509::request#attributes=()","openssl::cipher#auth_data=()","openssl::cipher#auth_tag()","openssl::cipher#auth_tag=()","openssl::cipher#auth_tag_len=()","openssl::cipher#authenticated?()","openssl::x509::extension::authoritykeyidentifier#authority_key_identifier()","openssl::ocsp::response#basic()","openssl::bn#bit_set?()","openssl::pkey::rsa#blinding_off!()","openssl::pkey::rsa#blinding_on!()","openssl::digest#block_length()","openssl::cipher#block_size()","openssl::pkey::ec::builtin_curves()","openssl::engine::by_id()","openssl::x509::extension::authorityinfoaccess#ca_issuer_uris()","openssl::cipher#ccm_data_len=()","openssl::ssl::sslsocket#cert()","openssl::timestamp::request#cert_requested=()","openssl::timestamp::request#cert_requested?()","openssl::ocsp::singleresponse#cert_status()","openssl::ocsp::request#certid()","openssl::ocsp::singleresponse#certid()","openssl::pkcs7#certificates()","openssl::pkcs7#certificates=()","openssl::x509::storecontext#chain()","openssl::netscape::spki#challenge()","openssl::netscape::spki#challenge=()","openssl::pkey::ec#check_key()","openssl::ocsp::request#check_nonce()","openssl::x509::certificate#check_private_key()","openssl::ocsp::singleresponse#check_validity()","openssl::engine#cipher()","openssl::ssl::sslsocket#cipher()","openssl::pkcs7#cipher=()","openssl::cipher::ciphers()","openssl::ssl::sslcontext#ciphers()","openssl::ssl::sslcontext#ciphers=()","openssl::engine::cleanup()","openssl::x509::storecontext#cleanup()","openssl::bn#clear_bit!()","openssl::ssl::sslsocket#client_ca()","openssl::buffering#close()","openssl::ssl::sslserver#close()","openssl::ssl::socketforwarder#closed?()","openssl::engine#cmds()","openssl::bn#cmp()","openssl::ocsp::certificateid#cmp()","openssl::x509::name#cmp()","openssl::ocsp::certificateid#cmp_issuer()","openssl::bn#coerce()","openssl::pkey::ec::group#cofactor()","openssl::pkey::dh#compute_key()","openssl::buffering::buffer#concat()","openssl::ssl::sslsocket#connect()","openssl::ssl::sslsocket#connect_nonblock()","openssl::bn#copy()","openssl::ocsp::basicresponse#copy_nonce()","openssl::ocsp::response::create()","openssl::pkcs12::create()","openssl::x509::extensionfactory#create_ext()","openssl::x509::extensionfactory#create_ext_from_array()","openssl::x509::extensionfactory#create_ext_from_hash()","openssl::x509::extensionfactory#create_ext_from_string()","openssl::x509::extensionfactory#create_extension()","openssl::timestamp::factory#create_timestamp()","openssl::x509::extension#critical=()","openssl::x509::extension#critical?()","openssl::x509::extensionfactory#crl=()","openssl::x509::extension::crldistributionpoints#crl_uris()","openssl::pkcs7#crls()","openssl::pkcs7#crls=()","openssl::engine#ctrl_cmd()","openssl::x509::storecontext#current_cert()","openssl::x509::storecontext#current_crl()","openssl::pkey::ec::group#curve_name()","openssl::pkcs7#data=()","openssl::debug()","openssl::debug=()","openssl::asn1::decode()","openssl::asn1::decode_all()","openssl::cipher#decrypt()","openssl::pkcs7#decrypt()","openssl::pkey::ec::group#degree()","openssl::pkcs7#detached()","openssl::pkcs7#detached=()","openssl::pkcs7#detached?()","openssl::pkey::ec#dh_compute_key()","openssl::digest::digest()","openssl::engine#digest()","openssl::hmac::digest()","openssl::hmac#digest()","openssl::digest#digest_length()","openssl::ssl::socketforwarder#do_not_reverse_lookup=()","openssl::pkey::ec#dsa_sign_asn1()","openssl::pkey::ec#dsa_verify_asn1()","openssl::asn1::constructive#each()","openssl::buffering#each()","openssl::config#each()","openssl::buffering#each_byte()","openssl::buffering#each_line()","openssl::ssl::sslcontext#ecdh_curves=()","openssl::random::egd()","openssl::random::egd_bytes()","openssl::ssl::sslcontext#enable_fallback_scsv()","openssl::pkcs7::recipientinfo#enc_key()","openssl::cipher#encrypt()","openssl::pkcs7::encrypt()","openssl::engine::engines()","openssl::buffering#eof()","openssl::buffering#eof?()","openssl::bn#eql?()","openssl::pkey::ec::group#eql?()","openssl::pkey::ec::point#eql?()","openssl::x509::name#eql?()","openssl::x509::storecontext#error()","openssl::x509::storecontext#error=()","openssl::x509::storecontext#error_depth()","openssl::x509::storecontext#error_string()","openssl::errors()","openssl::x509::name::rfc2253dn#expand_hexstring()","openssl::x509::name::rfc2253dn#expand_pair()","openssl::x509::name::rfc2253dn#expand_value()","openssl::pkey::dh#export()","openssl::pkey::dsa#export()","openssl::pkey::ec#export()","openssl::pkey::rsa#export()","openssl::ocsp::singleresponse#extensions()","openssl::x509::crl#extensions()","openssl::x509::certificate#extensions()","openssl::x509::revoked#extensions()","openssl::x509::crl#extensions=()","openssl::x509::certificate#extensions=()","openssl::x509::revoked#extensions=()","openssl::timestamp::response#failure_info()","openssl::ssl::socketforwarder#fcntl()","openssl::ssl::socketforwarder#fileno()","openssl::cipher#final()","openssl::x509::extension::helpers#find_extension()","openssl::ocsp::basicresponse#find_response()","openssl::engine#finish()","openssl::ssl::sslsocket#finished_message()","openssl::fips_mode()","openssl::fips_mode=()","openssl::fixed_length_secure_compare()","openssl::x509::store#flags=()","openssl::x509::storecontext#flags=()","openssl::buffering#flush()","openssl::ssl::sslcontext#flush_sessions()","openssl::ssl::sslcontext#freeze()","openssl::bn#gcd()","openssl::timestamp::tokeninfo#gen_time()","openssl::pkey::dh::generate()","openssl::pkey::dsa::generate()","openssl::pkey::ec::generate()","openssl::pkey::rsa::generate()","openssl::pkey::ec#generate_key()","openssl::pkey::dh#generate_key!()","openssl::pkey::ec#generate_key!()","openssl::bn::generate_prime()","openssl::pkey::ec::group#generator()","openssl::config#get_value()","openssl::buffering#getc()","openssl::buffering#gets()","openssl::ssl::socketforwarder#getsockopt()","openssl::pkey::ec#group()","openssl::pkey::ec#group=()","openssl::bn#hash()","openssl::x509::name#hash()","openssl::ocsp::certificateid#hash_algorithm()","openssl::x509::name#hash_old()","openssl::hmac::hexdigest()","openssl::hmac#hexdigest()","openssl::kdf::hkdf()","openssl::ssl::sslsocket#hostname=()","openssl::engine#id()","openssl::ssl::session#id()","openssl::marshal::included()","openssl::pkey::ec::point#infinity?()","openssl::bn#initialize_copy()","openssl::cipher#initialize_copy()","openssl::digest#initialize_copy()","openssl::hmac#initialize_copy()","openssl::ocsp::basicresponse#initialize_copy()","openssl::ocsp::certificateid#initialize_copy()","openssl::ocsp::request#initialize_copy()","openssl::ocsp::response#initialize_copy()","openssl::ocsp::singleresponse#initialize_copy()","openssl::pkcs12#initialize_copy()","openssl::pkcs7#initialize_copy()","openssl::pkey::dh#initialize_copy()","openssl::pkey::dsa#initialize_copy()","openssl::pkey::ec#initialize_copy()","openssl::pkey::ec::group#initialize_copy()","openssl::pkey::ec::point#initialize_copy()","openssl::pkey::rsa#initialize_copy()","openssl::ssl::session#initialize_copy()","openssl::x509::attribute#initialize_copy()","openssl::x509::crl#initialize_copy()","openssl::x509::certificate#initialize_copy()","openssl::x509::extension#initialize_copy()","openssl::x509::name#initialize_copy()","openssl::x509::request#initialize_copy()","openssl::x509::revoked#initialize_copy()","openssl::config#inspect()","openssl::engine#inspect()","openssl::hmac#inspect()","openssl::pkey::pkey#inspect()","openssl::x509::certificate#inspect()","openssl::pkey::ec::point#invert!()","openssl::pkcs7::recipientinfo#issuer()","openssl::pkcs7::signerinfo#issuer()","openssl::x509::crl#issuer()","openssl::x509::certificate#issuer()","openssl::x509::crl#issuer=()","openssl::x509::certificate#issuer=()","openssl::x509::extensionfactory#issuer_certificate=()","openssl::ocsp::certificateid#issuer_key_hash()","openssl::ocsp::certificateid#issuer_name_hash()","openssl::cipher#iv=()","openssl::cipher#iv_len()","openssl::cipher#iv_len=()","openssl::cipher#key=()","openssl::cipher#key_len()","openssl::cipher#key_len=()","openssl::x509::crl#last_update()","openssl::x509::crl#last_update=()","openssl::ssl::sslserver#listen()","openssl::asn1::objectid#ln()","openssl::engine::load()","openssl::engine#load_private_key()","openssl::engine#load_public_key()","openssl::random::load_random_file()","openssl::asn1::objectid#long_name()","openssl::bn#lshift!()","openssl::pkey::ec::point#make_affine!()","openssl::ssl::sslcontext#max_version=()","openssl::mem_check_start()","openssl::timestamp::request#message_imprint()","openssl::timestamp::tokeninfo#message_imprint()","openssl::timestamp::request#message_imprint=()","openssl::ssl::sslcontext#min_version=()","openssl::bn#mod_add()","openssl::bn#mod_exp()","openssl::bn#mod_inverse()","openssl::bn#mod_mul()","openssl::bn#mod_sqr()","openssl::bn#mod_sub()","openssl::pkey::ec::point#mul()","openssl::cipher#name()","openssl::digest#name()","openssl::engine#name()","openssl::bn#negative?()","openssl::asn1::asn1data::new()","openssl::asn1::constructive::new()","openssl::asn1::primitive::new()","openssl::bn::new()","openssl::buffering::new()","openssl::buffering::buffer::new()","openssl::cipher::new()","openssl::config::new()","openssl::digest::new()","openssl::hmac::new()","openssl::netscape::spki::new()","openssl::ocsp::basicresponse::new()","openssl::ocsp::certificateid::new()","openssl::ocsp::request::new()","openssl::ocsp::response::new()","openssl::ocsp::singleresponse::new()","openssl::pkcs12::new()","openssl::pkcs7::new()","openssl::pkcs7::recipientinfo::new()","openssl::pkcs7::signerinfo::new()","openssl::pkey::dh::new()","openssl::pkey::dsa::new()","openssl::pkey::ec::new()","openssl::pkey::ec::group::new()","openssl::pkey::ec::point::new()","openssl::pkey::pkey::new()","openssl::pkey::rsa::new()","openssl::ssl::sslcontext::new()","openssl::ssl::sslserver::new()","openssl::ssl::sslsocket::new()","openssl::ssl::session::new()","openssl::timestamp::request::new()","openssl::timestamp::response::new()","openssl::timestamp::tokeninfo::new()","openssl::x509::attribute::new()","openssl::x509::crl::new()","openssl::x509::certificate::new()","openssl::x509::extension::new()","openssl::x509::extensionfactory::new()","openssl::x509::name::new()","openssl::x509::request::new()","openssl::x509::revoked::new()","openssl::x509::store::new()","openssl::x509::storecontext::new()","openssl::ocsp::singleresponse#next_update()","openssl::x509::crl#next_update()","openssl::x509::crl#next_update=()","openssl::timestamp::request#nonce()","openssl::timestamp::tokeninfo#nonce()","openssl::timestamp::request#nonce=()","openssl::x509::certificate#not_after()","openssl::x509::certificate#not_after=()","openssl::x509::certificate#not_before()","openssl::x509::certificate#not_before=()","openssl::ssl::sslsocket#npn_protocol()","openssl::bn#num_bits()","openssl::bn#num_bytes()","openssl::x509::extension::authorityinfoaccess#ocsp_uris()","openssl::bn#odd?()","openssl::asn1::objectid#oid()","openssl::pkey::pkey#oid()","openssl::x509::attribute#oid()","openssl::x509::extension#oid()","openssl::x509::attribute#oid=()","openssl::x509::extension#oid=()","openssl::pkey::ec::point#on_curve?()","openssl::bn#one?()","openssl::ssl::sslcontext#options()","openssl::ssl::sslcontext#options=()","openssl::pkey::ec::group#order()","openssl::timestamp::tokeninfo#ordering()","openssl::cipher#padding=()","openssl::pkey::dh#params()","openssl::pkey::dsa#params()","openssl::pkey::rsa#params()","openssl::pkey::dh#params_ok?()","openssl::config::parse()","openssl::x509::name::parse()","openssl::config::parse_config()","openssl::x509::name::parse_openssl()","openssl::x509::name::parse_rfc2253()","openssl::kdf::pbkdf2_hmac()","openssl::pkcs5#pbkdf2_hmac()","openssl::pkcs5#pbkdf2_hmac_sha1()","openssl::ssl::sslsocket#peer_cert()","openssl::ssl::sslsocket#peer_cert_chain()","openssl::ssl::sslsocket#peer_finished_message()","openssl::ssl::socketforwarder#peeraddr()","openssl::ssl::sslsocket#pending()","openssl::cipher#pkcs5_keyivgen()","openssl::pkey::ec::group#point_conversion_form()","openssl::pkey::ec::group#point_conversion_form=()","openssl::timestamp::request#policy_id()","openssl::timestamp::tokeninfo#policy_id()","openssl::timestamp::request#policy_id=()","openssl::ssl::sslsocket#post_connection_check()","openssl::bn#pretty_print()","openssl::x509::certificate#pretty_print()","openssl::x509::name#pretty_print()","openssl::bn#prime?()","openssl::bn#prime_fasttest?()","openssl::buffering#print()","openssl::print_mem_leaks()","openssl::buffering#printf()","openssl::pkey::dh#private?()","openssl::pkey::dsa#private?()","openssl::pkey::ec#private?()","openssl::pkey::rsa#private?()","openssl::pkey::rsa#private_decrypt()","openssl::pkey::rsa#private_encrypt()","openssl::pkey::ec#private_key()","openssl::pkey::ec#private_key=()","openssl::pkey::ec#private_key?()","openssl::pkey::pkey#private_to_der()","openssl::pkey::pkey#private_to_pem()","openssl::pkey::dh#public?()","openssl::pkey::dsa#public?()","openssl::pkey::ec#public?()","openssl::pkey::rsa#public?()","openssl::pkey::rsa#public_decrypt()","openssl::pkey::rsa#public_encrypt()","openssl::netscape::spki#public_key()","openssl::pkey::dh#public_key()","openssl::pkey::dsa#public_key()","openssl::pkey::ec#public_key()","openssl::pkey::rsa#public_key()","openssl::x509::certificate#public_key()","openssl::x509::request#public_key()","openssl::netscape::spki#public_key=()","openssl::pkey::ec#public_key=()","openssl::x509::certificate#public_key=()","openssl::x509::request#public_key=()","openssl::pkey::ec#public_key?()","openssl::pkey::pkey#public_to_der()","openssl::pkey::pkey#public_to_pem()","openssl::x509::store#purpose=()","openssl::x509::storecontext#purpose=()","openssl::buffering#puts()","openssl::random::random_add()","openssl::random::random_bytes()","openssl::cipher#random_iv()","openssl::cipher#random_key()","openssl::buffering#read()","openssl::pkey::read()","openssl::buffering#read_nonblock()","openssl::pkcs7::read_smime()","openssl::buffering#readchar()","openssl::buffering#readline()","openssl::buffering#readlines()","openssl::buffering#readpartial()","openssl::pkcs7#recipients()","openssl::asn1::objectid::register()","openssl::cipher#reset()","openssl::digest#reset()","openssl::hmac#reset()","openssl::ocsp::basicresponse#responses()","openssl::ocsp::singleresponse#revocation_reason()","openssl::ocsp::singleresponse#revocation_time()","openssl::x509::crl#revoked()","openssl::x509::crl#revoked=()","openssl::bn#rshift!()","openssl::x509::name::rfc2253dn#scan()","openssl::kdf::scrypt()","openssl::config#sections()","openssl::secure_compare()","openssl::ssl::sslcontext#security_level()","openssl::ssl::sslcontext#security_level=()","openssl::pkey::ec::group#seed()","openssl::random::seed()","openssl::pkey::ec::group#seed=()","openssl::ocsp::certificateid#serial()","openssl::pkcs7::recipientinfo#serial()","openssl::pkcs7::signerinfo#serial()","openssl::x509::certificate#serial()","openssl::x509::revoked#serial()","openssl::x509::certificate#serial=()","openssl::x509::revoked#serial=()","openssl::timestamp::tokeninfo#serial_number()","openssl::ssl::sslsocket#session()","openssl::ssl::sslsocket#session=()","openssl::ssl::sslcontext#session_add()","openssl::ssl::sslcontext#session_cache_mode()","openssl::ssl::sslcontext#session_cache_mode=()","openssl::ssl::sslcontext#session_cache_size()","openssl::ssl::sslcontext#session_cache_size=()","openssl::ssl::sslcontext#session_cache_stats()","openssl::ssl::sslcontext#session_remove()","openssl::ssl::sslsocket#session_reused?()","openssl::bn#set_bit!()","openssl::pkey::rsa#set_crt_params()","openssl::engine#set_default()","openssl::x509::store#set_default_paths()","openssl::pkey::rsa#set_factors()","openssl::pkey::ec::group#set_generator()","openssl::pkey::dh#set_key()","openssl::pkey::dsa#set_key()","openssl::pkey::rsa#set_key()","openssl::ssl::sslcontext#set_params()","openssl::pkey::dh#set_pqg()","openssl::pkey::dsa#set_pqg()","openssl::pkey::ec::point#set_to_infinity!()","openssl::ssl::socketforwarder#setsockopt()","openssl::ssl::sslcontext#setup()","openssl::asn1::objectid#short_name()","openssl::ssl::sslserver#shutdown()","openssl::netscape::spki#sign()","openssl::ocsp::basicresponse#sign()","openssl::ocsp::request#sign()","openssl::pkcs7::sign()","openssl::pkey::pkey#sign()","openssl::x509::crl#sign()","openssl::x509::certificate#sign()","openssl::x509::request#sign()","openssl::pkey::rsa#sign_pss()","openssl::x509::crl#signature_algorithm()","openssl::x509::certificate#signature_algorithm()","openssl::x509::request#signature_algorithm()","openssl::ocsp::request#signed?()","openssl::pkcs7::signerinfo#signed_time()","openssl::pkcs7#signers()","openssl::asn1::objectid#sn()","openssl::bn#sqr()","openssl::ssl::sslsocket#ssl_version()","openssl::ssl::sslcontext#ssl_version=()","openssl::ssl::sslsocket#state()","openssl::ocsp::basicresponse#status()","openssl::ocsp::response#status()","openssl::timestamp::response#status()","openssl::random::status?()","openssl::ocsp::response#status_string()","openssl::timestamp::response#status_text()","openssl::x509::certificate#subject()","openssl::x509::request#subject()","openssl::x509::certificate#subject=()","openssl::x509::request#subject=()","openssl::x509::extensionfactory#subject_certificate=()","openssl::x509::extension::subjectkeyidentifier#subject_key_identifier()","openssl::x509::extensionfactory#subject_request=()","openssl::ssl::sslsocket#sysclose()","openssl::ssl::sslsocket#sysread()","openssl::pkey::dsa#syssign()","openssl::pkey::dsa#sysverify()","openssl::ssl::sslsocket#syswrite()","openssl::ocsp::singleresponse#this_update()","openssl::ssl::session#time()","openssl::x509::revoked#time()","openssl::ssl::session#time=()","openssl::x509::revoked#time=()","openssl::x509::store#time=()","openssl::x509::storecontext#time=()","openssl::ssl::session#timeout()","openssl::ssl::session#timeout=()","openssl::ssl::sslsocket#tmp_key()","openssl::x509::extension#to_a()","openssl::x509::name#to_a()","integer#to_bn()","openssl::bn#to_bn()","openssl::pkey::ec::point#to_bn()","openssl::asn1::asn1data#to_der()","openssl::asn1::constructive#to_der()","openssl::asn1::primitive#to_der()","openssl::netscape::spki#to_der()","openssl::ocsp::basicresponse#to_der()","openssl::ocsp::certificateid#to_der()","openssl::ocsp::request#to_der()","openssl::ocsp::response#to_der()","openssl::ocsp::singleresponse#to_der()","openssl::pkcs12#to_der()","openssl::pkcs7#to_der()","openssl::pkey::dh#to_der()","openssl::pkey::dsa#to_der()","openssl::pkey::ec#to_der()","openssl::pkey::ec::group#to_der()","openssl::pkey::rsa#to_der()","openssl::ssl::session#to_der()","openssl::timestamp::request#to_der()","openssl::timestamp::response#to_der()","openssl::timestamp::tokeninfo#to_der()","openssl::x509::attribute#to_der()","openssl::x509::crl#to_der()","openssl::x509::certificate#to_der()","openssl::x509::extension#to_der()","openssl::x509::name#to_der()","openssl::x509::request#to_der()","openssl::x509::revoked#to_der()","openssl::x509::extension#to_h()","openssl::bn#to_i()","openssl::bn#to_int()","openssl::ssl::sslserver#to_io()","openssl::pkey::ec::point#to_octet_string()","openssl::netscape::spki#to_pem()","openssl::pkcs7#to_pem()","openssl::pkey::dh#to_pem()","openssl::pkey::dsa#to_pem()","openssl::pkey::ec#to_pem()","openssl::pkey::ec::group#to_pem()","openssl::pkey::rsa#to_pem()","openssl::ssl::session#to_pem()","openssl::x509::crl#to_pem()","openssl::x509::certificate#to_pem()","openssl::x509::request#to_pem()","openssl::bn#to_s()","openssl::config#to_s()","openssl::hmac#to_s()","openssl::netscape::spki#to_s()","openssl::pkcs7#to_s()","openssl::pkey::dh#to_s()","openssl::pkey::dsa#to_s()","openssl::pkey::rsa#to_s()","openssl::x509::crl#to_s()","openssl::x509::certificate#to_s()","openssl::x509::extension#to_s()","openssl::x509::name#to_s()","openssl::x509::request#to_s()","openssl::netscape::spki#to_text()","openssl::pkey::dh#to_text()","openssl::pkey::dsa#to_text()","openssl::pkey::ec#to_text()","openssl::pkey::ec::group#to_text()","openssl::pkey::rsa#to_text()","openssl::ssl::session#to_text()","openssl::x509::crl#to_text()","openssl::x509::certificate#to_text()","openssl::x509::request#to_text()","openssl::x509::name#to_utf8()","openssl::timestamp::response#token()","openssl::timestamp::response#token_info()","openssl::asn1::traverse()","openssl::x509::store#trust=()","openssl::x509::storecontext#trust=()","openssl::timestamp::response#tsa_certificate()","openssl::pkcs7#type()","openssl::pkcs7#type=()","openssl::bn#ucmp()","openssl::buffering#ungetc()","openssl::cipher#update()","openssl::digest#update()","openssl::hmac#update()","openssl::x509::attribute#value()","openssl::x509::extension#value()","openssl::x509::attribute#value=()","openssl::x509::extension#value=()","openssl::x509::extension#value_der()","openssl::netscape::spki#verify()","openssl::ocsp::basicresponse#verify()","openssl::ocsp::request#verify()","openssl::pkcs7#verify()","openssl::pkey::pkey#verify()","openssl::timestamp::response#verify()","openssl::x509::crl#verify()","openssl::x509::certificate#verify()","openssl::x509::request#verify()","openssl::x509::store#verify()","openssl::x509::storecontext#verify()","openssl::x509::store#verify_callback=()","openssl::ssl::verify_certificate_identity()","openssl::pkey::rsa#verify_pss()","openssl::ssl::sslsocket#verify_result()","openssl::timestamp::request#version()","openssl::timestamp::tokeninfo#version()","openssl::x509::crl#version()","openssl::x509::certificate#version()","openssl::x509::request#version()","openssl::timestamp::request#version=()","openssl::x509::crl#version=()","openssl::x509::certificate#version=()","openssl::x509::request#version=()","openssl::buffering#write()","openssl::buffering#write_nonblock()","openssl::random::write_random_file()","openssl::pkcs7::write_smime()","openssl::bn#zero?()","","",""],"info":[["IO","","IO.html","",""],["IO::WaitReadable","","IO/WaitReadable.html","",""],["IO::WaitWritable","","IO/WaitWritable.html","",""],["Integer","","Integer.html","",""],["OpenSSL","","OpenSSL.html","","<p>OpenSSL provides SSL, TLS and general purpose cryptography. It wraps the OpenSSL library.\n<p>Examples\n<p>All …\n"],["OpenSSL::ASN1","","OpenSSL/ASN1.html","","<p>Abstract Syntax Notation One (or ASN.1) is a notation syntax to describe data structures and is defined …\n"],["OpenSSL::ASN1::ASN1Data","","OpenSSL/ASN1/ASN1Data.html","","<p>The top-level class representing any ASN.1 object. When parsed by ASN1.decode, tagged values are always …\n"],["OpenSSL::ASN1::ASN1Error","","OpenSSL/ASN1/ASN1Error.html","","<p>Generic error class for all errors raised in ASN1 and any of the classes defined in it.\n"],["OpenSSL::ASN1::Constructive","","OpenSSL/ASN1/Constructive.html","","<p>The parent class for all constructed encodings. The <em>value</em> attribute of a Constructive is always an Array …\n"],["OpenSSL::ASN1::ObjectId","","OpenSSL/ASN1/ObjectId.html","","<p>Represents the primitive object id for OpenSSL::ASN1\n"],["OpenSSL::ASN1::Primitive","","OpenSSL/ASN1/Primitive.html","","<p>The parent class for all primitive encodings. Attributes are the same as for ASN1Data, with the addition …\n"],["OpenSSL::BN","","OpenSSL/BN.html","",""],["OpenSSL::BNError","","OpenSSL/BNError.html","","<p>Generic Error for all of OpenSSL::BN (big num)\n"],["OpenSSL::Buffering","","OpenSSL/Buffering.html","","<p>OpenSSL IO buffering mix-in module.\n<p>This module allows an OpenSSL::SSL::SSLSocket to behave like an IO …\n"],["OpenSSL::Buffering::Buffer","","OpenSSL/Buffering/Buffer.html","","<p>A buffer which will retain binary encoding.\n"],["OpenSSL::Cipher","","OpenSSL/Cipher.html","","<p>Provides symmetric algorithms for encryption and decryption. The algorithms that are available depend …\n"],["OpenSSL::Cipher::Cipher","","OpenSSL/Cipher/Cipher.html","","<p>Deprecated.\n<p>This class is only provided for backwards compatibility. Use OpenSSL::Cipher.\n"],["OpenSSL::Cipher::CipherError","","OpenSSL/Cipher/CipherError.html","",""],["OpenSSL::Config","","OpenSSL/Config.html","","<p>OpenSSL::Config\n<p>Configuration for the openssl library.\n<p>Many system's installation of openssl library …\n"],["OpenSSL::ConfigError","","OpenSSL/ConfigError.html","","<p>General error for openssl library configuration files. Including formatting, parsing errors, etc.\n"],["OpenSSL::Digest","","OpenSSL/Digest.html","","<p>OpenSSL::Digest allows you to compute message digests (sometimes interchangeably called “hashes”) …\n"],["OpenSSL::Digest::DigestError","","OpenSSL/Digest/DigestError.html","","<p>Generic Exception class that is raised if an error occurs during a Digest operation.\n"],["OpenSSL::Engine","","OpenSSL/Engine.html","","<p>This class is the access to openssl's ENGINE cryptographic module implementation.\n<p>See also, www.openssl.org/docs/crypto/engine.html …\n"],["OpenSSL::Engine::EngineError","","OpenSSL/Engine/EngineError.html","","<p>This is the generic exception for OpenSSL::Engine related errors\n"],["OpenSSL::ExtConfig","","OpenSSL/ExtConfig.html","","<p>This module contains configuration information about the SSL extension, for example if socket support …\n"],["OpenSSL::HMAC","","OpenSSL/HMAC.html","","<p>OpenSSL::HMAC allows computing Hash-based Message Authentication Code (HMAC). It is a type of message …\n"],["OpenSSL::HMACError","","OpenSSL/HMACError.html","","<p>Document-class: OpenSSL::HMAC\n<p>OpenSSL::HMAC allows computing Hash-based Message Authentication Code ( …\n"],["OpenSSL::KDF","","OpenSSL/KDF.html","","<p>Provides functionality of various KDFs (key derivation function).\n<p>KDF is typically used for securely deriving …\n"],["OpenSSL::KDF::KDFError","","OpenSSL/KDF/KDFError.html","","<p>Generic exception class raised if an error occurs in OpenSSL::KDF module.\n"],["OpenSSL::Marshal","","OpenSSL/Marshal.html","",""],["OpenSSL::Marshal::ClassMethods","","OpenSSL/Marshal/ClassMethods.html","",""],["OpenSSL::Netscape","","OpenSSL/Netscape.html","","<p>OpenSSL::Netscape is a namespace for SPKI (Simple Public Key Infrastructure) which implements Signed …\n"],["OpenSSL::Netscape::SPKI","","OpenSSL/Netscape/SPKI.html","","<p>A Simple Public Key Infrastructure implementation (pronounced “spooky”). The structure is defined …\n"],["OpenSSL::Netscape::SPKIError","","OpenSSL/Netscape/SPKIError.html","","<p>Generic Exception class that is raised if an error occurs during an operation on an instance of OpenSSL::Netscape::SPKI …\n"],["OpenSSL::OCSP","","OpenSSL/OCSP.html","","<p>OpenSSL::OCSP implements Online Certificate Status Protocol requests and responses.\n<p>Creating and sending …\n"],["OpenSSL::OCSP::BasicResponse","","OpenSSL/OCSP/BasicResponse.html","","<p>An OpenSSL::OCSP::BasicResponse contains the status of a certificate check which is created from an …\n"],["OpenSSL::OCSP::CertificateId","","OpenSSL/OCSP/CertificateId.html","","<p>An OpenSSL::OCSP::CertificateId identifies a certificate to the CA so that a status check can be performed. …\n"],["OpenSSL::OCSP::OCSPError","","OpenSSL/OCSP/OCSPError.html","","<p>OCSP error class.\n"],["OpenSSL::OCSP::Request","","OpenSSL/OCSP/Request.html","","<p>An OpenSSL::OCSP::Request contains the certificate information for determining if a certificate has been …\n"],["OpenSSL::OCSP::Response","","OpenSSL/OCSP/Response.html","","<p>An OpenSSL::OCSP::Response contains the status of a certificate check which is created from an OpenSSL::OCSP::Request …\n"],["OpenSSL::OCSP::SingleResponse","","OpenSSL/OCSP/SingleResponse.html","","<p>An OpenSSL::OCSP::SingleResponse represents an OCSP SingleResponse structure, which contains the basic …\n"],["OpenSSL::OpenSSLError","","OpenSSL/OpenSSLError.html","","<p>Generic error, common for all classes under OpenSSL module\n"],["OpenSSL::PKCS12","","OpenSSL/PKCS12.html","","<p>Defines a file format commonly used to store private keys with accompanying public key certificates, …\n"],["OpenSSL::PKCS12::PKCS12Error","","OpenSSL/PKCS12/PKCS12Error.html","",""],["OpenSSL::PKCS5","","OpenSSL/PKCS5.html","",""],["OpenSSL::PKCS7","","OpenSSL/PKCS7.html","",""],["OpenSSL::PKCS7::PKCS7Error","","OpenSSL/PKCS7/PKCS7Error.html","",""],["OpenSSL::PKCS7::RecipientInfo","","OpenSSL/PKCS7/RecipientInfo.html","",""],["OpenSSL::PKCS7::SignerInfo","","OpenSSL/PKCS7/SignerInfo.html","",""],["OpenSSL::PKey","","OpenSSL/PKey.html","","<p>Asymmetric Public Key Algorithms\n<p>Asymmetric public key algorithms solve the problem of establishing and …\n"],["OpenSSL::PKey::DH","","OpenSSL/PKey/DH.html","","<p>An implementation of the Diffie-Hellman key exchange protocol based on discrete logarithms in finite …\n"],["OpenSSL::PKey::DHError","","OpenSSL/PKey/DHError.html","","<p>Generic exception that is raised if an operation on a DH PKey fails unexpectedly or in case an instantiation …\n"],["OpenSSL::PKey::DSA","","OpenSSL/PKey/DSA.html","","<p>DSA, the Digital Signature Algorithm, is specified in NIST's FIPS 186-3. It is an asymmetric public …\n"],["OpenSSL::PKey::DSAError","","OpenSSL/PKey/DSAError.html","","<p>Generic exception that is raised if an operation on a DSA PKey fails unexpectedly or in case an instantiation …\n"],["OpenSSL::PKey::EC","","OpenSSL/PKey/EC.html","","<p>OpenSSL::PKey::EC provides access to Elliptic Curve Digital Signature Algorithm (ECDSA) and Elliptic …\n"],["OpenSSL::PKey::EC::Group","","OpenSSL/PKey/EC/Group.html","",""],["OpenSSL::PKey::EC::Group::Error","","OpenSSL/PKey/EC/Group/Error.html","",""],["OpenSSL::PKey::EC::Point","","OpenSSL/PKey/EC/Point.html","",""],["OpenSSL::PKey::EC::Point::Error","","OpenSSL/PKey/EC/Point/Error.html","",""],["OpenSSL::PKey::ECError","","OpenSSL/PKey/ECError.html","",""],["OpenSSL::PKey::PKey","","OpenSSL/PKey/PKey.html","","<p>An abstract class that bundles signature creation (PKey#sign) and validation (PKey#verify) that is common …\n"],["OpenSSL::PKey::PKeyError","","OpenSSL/PKey/PKeyError.html","","<p>Raised when errors occur during PKey#sign or PKey#verify.\n"],["OpenSSL::PKey::RSA","","OpenSSL/PKey/RSA.html","","<p>RSA is an asymmetric public key algorithm that has been formalized in RFC 3447. It is in widespread use …\n"],["OpenSSL::PKey::RSAError","","OpenSSL/PKey/RSAError.html","","<p>Generic exception that is raised if an operation on an RSA PKey fails unexpectedly or in case an instantiation …\n"],["OpenSSL::Random","","OpenSSL/Random.html","",""],["OpenSSL::Random::RandomError","","OpenSSL/Random/RandomError.html","",""],["OpenSSL::SSL","","OpenSSL/SSL.html","","<p>Use SSLContext to set up the parameters for a TLS (former SSL) connection. Both client and server TLS …\n"],["OpenSSL::SSL::SSLContext","","OpenSSL/SSL/SSLContext.html","","<p>An SSLContext is used to set various options regarding certificates, algorithms, verification, session …\n"],["OpenSSL::SSL::SSLError","","OpenSSL/SSL/SSLError.html","","<p>Generic error class raised by SSLSocket and SSLContext.\n"],["OpenSSL::SSL::SSLErrorWaitReadable","","OpenSSL/SSL/SSLErrorWaitReadable.html","",""],["OpenSSL::SSL::SSLErrorWaitWritable","","OpenSSL/SSL/SSLErrorWaitWritable.html","",""],["OpenSSL::SSL::SSLServer","","OpenSSL/SSL/SSLServer.html","","<p>SSLServer represents a TCP/IP server socket with Secure Sockets Layer.\n"],["OpenSSL::SSL::SSLSocket","","OpenSSL/SSL/SSLSocket.html","",""],["OpenSSL::SSL::Session","","OpenSSL/SSL/Session.html","",""],["OpenSSL::SSL::Session::SessionError","","OpenSSL/SSL/Session/SessionError.html","",""],["OpenSSL::SSL::SocketForwarder","","OpenSSL/SSL/SocketForwarder.html","",""],["OpenSSL::Timestamp","","OpenSSL/Timestamp.html","","<p>Provides classes and methods to request, create and validate RFC3161-compliant timestamps. Request may …\n"],["OpenSSL::Timestamp::Factory","","OpenSSL/Timestamp/Factory.html","","<p>Used to generate a Response from scratch.\n<p>Please bear in mind that the implementation will always apply …\n"],["OpenSSL::Timestamp::Request","","OpenSSL/Timestamp/Request.html","","<p>Allows to create timestamp requests or parse existing ones. A Request is also needed for creating timestamps …\n"],["OpenSSL::Timestamp::Response","","OpenSSL/Timestamp/Response.html","","<p>Immutable and read-only representation of a timestamp response returned from a timestamp server after …\n"],["OpenSSL::Timestamp::TimestampError","","OpenSSL/Timestamp/TimestampError.html","","<p>Generic exception class of the Timestamp module.\n"],["OpenSSL::Timestamp::TokenInfo","","OpenSSL/Timestamp/TokenInfo.html","","<p>Immutable and read-only representation of a timestamp token info from a Response.\n"],["OpenSSL::X509","","OpenSSL/X509.html","",""],["OpenSSL::X509::Attribute","","OpenSSL/X509/Attribute.html","",""],["OpenSSL::X509::AttributeError","","OpenSSL/X509/AttributeError.html","",""],["OpenSSL::X509::CRL","","OpenSSL/X509/CRL.html","",""],["OpenSSL::X509::CRLError","","OpenSSL/X509/CRLError.html","",""],["OpenSSL::X509::Certificate","","OpenSSL/X509/Certificate.html","","<p>Implementation of an X.509 certificate as specified in RFC 5280. Provides access to a certificate's …\n"],["OpenSSL::X509::CertificateError","","OpenSSL/X509/CertificateError.html","",""],["OpenSSL::X509::Extension","","OpenSSL/X509/Extension.html","",""],["OpenSSL::X509::Extension::AuthorityInfoAccess","","OpenSSL/X509/Extension/AuthorityInfoAccess.html","",""],["OpenSSL::X509::Extension::AuthorityKeyIdentifier","","OpenSSL/X509/Extension/AuthorityKeyIdentifier.html","",""],["OpenSSL::X509::Extension::CRLDistributionPoints","","OpenSSL/X509/Extension/CRLDistributionPoints.html","",""],["OpenSSL::X509::Extension::Helpers","","OpenSSL/X509/Extension/Helpers.html","",""],["OpenSSL::X509::Extension::SubjectKeyIdentifier","","OpenSSL/X509/Extension/SubjectKeyIdentifier.html","",""],["OpenSSL::X509::ExtensionError","","OpenSSL/X509/ExtensionError.html","",""],["OpenSSL::X509::ExtensionFactory","","OpenSSL/X509/ExtensionFactory.html","",""],["OpenSSL::X509::Name","","OpenSSL/X509/Name.html","","<p>An X.509 name represents a hostname, email address or other entity associated with a public key.\n<p>You can …\n"],["OpenSSL::X509::Name::RFC2253DN","","OpenSSL/X509/Name/RFC2253DN.html","",""],["OpenSSL::X509::NameError","","OpenSSL/X509/NameError.html","",""],["OpenSSL::X509::Request","","OpenSSL/X509/Request.html","",""],["OpenSSL::X509::RequestError","","OpenSSL/X509/RequestError.html","",""],["OpenSSL::X509::Revoked","","OpenSSL/X509/Revoked.html","",""],["OpenSSL::X509::RevokedError","","OpenSSL/X509/RevokedError.html","",""],["OpenSSL::X509::Store","","OpenSSL/X509/Store.html","","<p>The X509 certificate store holds trusted CA certificates used to verify peer certificates.\n<p>The easiest …\n"],["OpenSSL::X509::StoreContext","","OpenSSL/X509/StoreContext.html","","<p>A StoreContext is used while validating a single certificate and holds the status involved.\n"],["OpenSSL::X509::StoreError","","OpenSSL/X509/StoreError.html","",""],["%","OpenSSL::BN","OpenSSL/BN.html#method-i-25","(p1)",""],["*","OpenSSL::BN","OpenSSL/BN.html#method-i-2A","(p1)",""],["**","OpenSSL::BN","OpenSSL/BN.html#method-i-2A-2A","(p1)",""],["+","OpenSSL::BN","OpenSSL/BN.html#method-i-2B","(p1)",""],["+@","OpenSSL::BN","OpenSSL/BN.html#method-i-2B-40","()",""],["-","OpenSSL::BN","OpenSSL/BN.html#method-i-2D","(p1)",""],["-@","OpenSSL::BN","OpenSSL/BN.html#method-i-2D-40","()",""],["/","OpenSSL::BN","OpenSSL/BN.html#method-i-2F","(p1)","<p>Division of OpenSSL::BN instances\n"],["<<","OpenSSL::BN","OpenSSL/BN.html#method-i-3C-3C","(p1)",""],["<<","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-3C-3C","(s)","<p>Writes <em>s</em> to the stream. <em>s</em> will be converted to a String using <code>.to_s</code> method.\n"],["<<","OpenSSL::Buffering::Buffer","OpenSSL/Buffering/Buffer.html#method-i-3C-3C","(string)",""],["<<","OpenSSL::Digest","OpenSSL/Digest.html#method-i-3C-3C","(p1)",""],["<<","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-3C-3C","(p1)",""],["<=>","OpenSSL::BN","OpenSSL/BN.html#method-i-3C-3D-3E","(p1)",""],["<=>","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-3C-3D-3E","(p1)",""],["==","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-3D-3D","(p1)","<p>Returns <code>true</code> if <em>other_oid</em> is the same as <em>oid</em>\n"],["==","OpenSSL::BN","OpenSSL/BN.html#method-i-3D-3D","(p1)","<p>Returns <code>true</code> only if <em>obj</em> has the same value as <em>bn</em>. Contrast this with OpenSSL::BN#eql?, which requires …\n"],["==","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-3D-3D","(other)","<p>Securely compare with another HMAC instance in constant time.\n"],["==","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-3D-3D","(p1)",""],["==","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-3D-3D","(p1)",""],["==","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-3D-3D","(p1)","<p>Returns <code>true</code> if the two Session is the same, <code>false</code> if not.\n"],["==","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-3D-3D","(other)",""],["==","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-3D-3D","(other)",""],["==","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-3D-3D","(p1)","<p>Compares the two certificates. Note that this takes into account all fields, not just the issuer name …\n"],["==","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-3D-3D","(other)",""],["==","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-3D-3D","(other)",""],["==","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-3D-3D","(other)",""],["===","OpenSSL::BN","OpenSSL/BN.html#method-i-3D-3D-3D","(p1)",""],[">>","OpenSSL::BN","OpenSSL/BN.html#method-i-3E-3E","(p1)",""],["Digest","OpenSSL","OpenSSL.html#method-c-Digest","(name)","<p>Returns a Digest subclass by <em>name</em>\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">require</span> <span class=\"ruby-string\">'openssl'</span>\n\n<span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Digest</span>(<span class=\"ruby-string\">"MD5"</span>)\n<span class=\"ruby-comment\"># => OpenSSL::Digest::MD5 ...</span>\n</pre>\n"],["[]","OpenSSL::Config","OpenSSL/Config.html#method-i-5B-5D","(section)","<p>Get a specific <em>section</em> from the current configuration\n<p>Given the following configurating file being loaded: …\n"],["[]=","OpenSSL::Config","OpenSSL/Config.html#method-i-5B-5D-3D","(section, pairs)","<p>*Deprecated in v2.2.0*. This method will be removed in a future release.\n<p>Sets a specific <em>section</em> name …\n"],["_dump","OpenSSL::Marshal","OpenSSL/Marshal.html#method-i-_dump","(_level)",""],["_load","OpenSSL::Marshal::ClassMethods","OpenSSL/Marshal/ClassMethods.html#method-i-_load","(string)",""],["accept","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-i-accept","()","<p>Works similar to TCPServer#accept.\n"],["accept","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-accept","()","<p>Waits for a SSL/TLS client to initiate a handshake. The handshake may be started after unencrypted data …\n"],["accept_nonblock","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-accept_nonblock","(p1 = {})","<p>Initiates the SSL/TLS handshake as a server in non-blocking manner.\n\n<pre># emulates blocking accept\nbegin\n ...</pre>\n"],["add","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-add","(p1)","<p>Performs elliptic curve point addition.\n"],["add_attribute","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-add_attribute","(p1)",""],["add_cert","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-add_cert","(p1)","<p>Adds the OpenSSL::X509::Certificate <em>cert</em> to the certificate store.\n"],["add_certid","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-add_certid","(p1)","<p>Adds <em>certificate_id</em> to the request.\n"],["add_certificate","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-add_certificate","(p1)",""],["add_certificate","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-add_certificate","(p1, p2, p3 = v3)","<p>Adds a certificate to the context. <em>pkey</em> must be a corresponding private key with <em>certificate</em>.\n<p>Multiple …\n"],["add_crl","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-add_crl","(p1)",""],["add_crl","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-add_crl","(p1)","<p>Adds the OpenSSL::X509::CRL <em>crl</em> to the store.\n"],["add_data","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-add_data","(p1)",""],["add_entry","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-add_entry","(p1, p2, p3 = v3, p4 = {})","<p>Adds a new entry with the given <em>oid</em> and <em>value</em> to this name. The <em>oid</em> is an object identifier defined …\n"],["add_extension","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-add_extension","(p1)",""],["add_extension","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-add_extension","(p1)",""],["add_extension","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-add_extension","(p1)",""],["add_file","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-add_file","(p1)","<p>Adds the certificates in <em>file</em> to the certificate store. <em>file</em> is the path to the file, and the file contains …\n"],["add_nonce","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-add_nonce","(p1 = v1)","<p>Adds <em>nonce</em> to this response. If no nonce was provided a random nonce will be added.\n"],["add_nonce","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-add_nonce","(p1 = v1)","<p>Adds a <em>nonce</em> to the OCSP request. If no nonce is given a random one will be generated.\n<p>The nonce is used …\n"],["add_path","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-add_path","(p1)","<p>Adds <em>path</em> as the hash dir to be looked up by the store.\n"],["add_recipient","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-add_recipient","(p1)",""],["add_revoked","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-add_revoked","(p1)",""],["add_signer","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-add_signer","(p1)",""],["add_status","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-add_status","(p1, p2, p3, p4, p5, p6, p7)","<p>Adds a certificate status for <em>certificate_id</em>. <em>status</em> is the status, and must be one of these:\n<p>OpenSSL::OCSP::V_CERTSTATUS_GOOD …\n"],["add_value","OpenSSL::Config","OpenSSL/Config.html#method-i-add_value","(section, key, value)","<p>*Deprecated in v2.2.0*. This method will be removed in a future release.\n<p>Set the target <em>key</em> with a given …\n"],["addr","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-addr","()",""],["algorithm","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-algorithm","()","<p>Returns the 'short name' of the object identifier that represents the algorithm that was used …\n"],["algorithm","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-algorithm","()","<p>Returns the 'short name' of the object identifier representing the algorithm that was used to …\n"],["algorithm=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-algorithm-3D","(p1)","<p>Allows to set the object identifier or the 'short name' of the algorithm that was used to create …\n"],["alpn_protocol","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-alpn_protocol","()","<p>Returns the ALPN protocol string that was finally selected by the server during the handshake.\n"],["asn1_flag","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-asn1_flag","()","<p>Returns the flags set on the group.\n<p>See also #asn1_flag=.\n"],["asn1_flag=","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-asn1_flag-3D","(p1)","<p>Sets flags on the group. The flag value is used to determine how to encode the group: encode explicit …\n"],["attributes","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-attributes","()",""],["attributes=","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-attributes-3D","(p1)",""],["auth_data=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-auth_data-3D","(p1)","<p>Sets the cipher's additional authenticated data. This field must be set when using AEAD cipher modes …\n"],["auth_tag","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-auth_tag","(p1 = v1)","<p>Gets the authentication tag generated by Authenticated Encryption Cipher modes (GCM for example). This …\n"],["auth_tag=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-auth_tag-3D","(p1)","<p>Sets the authentication tag to verify the integrity of the ciphertext. This can be called only when the …\n"],["auth_tag_len=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-auth_tag_len-3D","(p1)","<p>Sets the length of the authentication tag to be generated or to be given for AEAD ciphers that requires …\n"],["authenticated?","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-authenticated-3F","()","<p>Indicated whether this Cipher instance uses an Authenticated Encryption mode.\n"],["authority_key_identifier","OpenSSL::X509::Extension::AuthorityKeyIdentifier","OpenSSL/X509/Extension/AuthorityKeyIdentifier.html#method-i-authority_key_identifier","()","<p>Get the issuing certificate's key identifier from the authorityKeyIdentifier extension, as described …\n"],["basic","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-i-basic","()","<p>Returns a BasicResponse for this response\n"],["bit_set?","OpenSSL::BN","OpenSSL/BN.html#method-i-bit_set-3F","(p1)","<p>Tests bit <em>bit</em> in <em>bn</em> and returns <code>true</code> if set, <code>false</code> if not set.\n"],["blinding_off!","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-blinding_off-21","()",""],["blinding_on!","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-blinding_on-21","()",""],["block_length","OpenSSL::Digest","OpenSSL/Digest.html#method-i-block_length","()","<p>Returns the block length of the digest algorithm, i.e. the length in bytes of an individual block. Most …\n"],["block_size","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-block_size","()","<p>Returns the size in bytes of the blocks on which this Cipher operates on.\n"],["builtin_curves","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-c-builtin_curves","()","<p>Obtains a list of all predefined curves by the OpenSSL. Curve names are returned as sn.\n<p>See the OpenSSL …\n"],["by_id","OpenSSL::Engine","OpenSSL/Engine.html#method-c-by_id","(p1)","<p>Fetches the engine as specified by the <em>id</em> String.\n\n<pre>OpenSSL::Engine.by_id("openssl")\n => #<OpenSSL::Engine ...</pre>\n"],["ca_issuer_uris","OpenSSL::X509::Extension::AuthorityInfoAccess","OpenSSL/X509/Extension/AuthorityInfoAccess.html#method-i-ca_issuer_uris","()","<p>Get the information and services for the issuer from the certificate's authority information access …\n"],["ccm_data_len=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-ccm_data_len-3D","(p1)","<p>Sets the length of the plaintext / ciphertext message that will be processed in CCM mode. Make sure to …\n"],["cert","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-cert","()","<p>The X509 certificate for this socket endpoint.\n"],["cert_requested=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-cert_requested-3D","(p1)","<p>Specify whether the response shall contain the timestamp authority's certificate or not. The default …\n"],["cert_requested?","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-cert_requested-3F","()","<p>Indicates whether the response shall contain the timestamp authority's certificate or not.\n"],["cert_status","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-cert_status","()","<p>Returns the status of the certificate identified by the certid. The return value may be one of these …\n"],["certid","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-certid","()","<p>Returns all certificate IDs in this request.\n"],["certid","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-certid","()","<p>Returns the CertificateId for which this SingleResponse is.\n"],["certificates","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-certificates","()",""],["certificates=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-certificates-3D","(p1)",""],["chain","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-chain","()",""],["challenge","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-challenge","()","<p>Returns the challenge string associated with this SPKI.\n"],["challenge=","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-challenge-3D","(p1)","<p>Parameters\n<p><em>str</em> - the challenge string to be set for this instance\n\n<p>Sets the challenge to be associated with …\n"],["check_key","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-check_key","()","<p>Raises an exception if the key is invalid.\n<p>See the OpenSSL documentation for EC_KEY_check_key()\n"],["check_nonce","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-check_nonce","(p1)","<p>Checks the nonce validity for this request and <em>response</em>.\n<p>The return value is one of the following:\n<p>-1 … — "],["check_private_key","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-check_private_key","(p1)","<p>Returns <code>true</code> if <em>key</em> is the corresponding private key to the Subject Public Key Information, <code>false</code> otherwise. …\n"],["check_validity","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-check_validity","(p1 = v1, p2 = v2)","<p>Checks the validity of thisUpdate and nextUpdate fields of this SingleResponse. This checks the current …\n"],["cipher","OpenSSL::Engine","OpenSSL/Engine.html#method-i-cipher","(p1)","<p>Returns a new instance of OpenSSL::Cipher by <em>name</em>, if it is available in this engine.\n<p>An EngineError will …\n"],["cipher","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-cipher","()","<p>Returns the cipher suite actually used in the current session, or nil if no session has been established. …\n"],["cipher=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-cipher-3D","(p1)",""],["ciphers","OpenSSL::Cipher","OpenSSL/Cipher.html#method-c-ciphers","()","<p>Returns the names of all available ciphers in an array.\n"],["ciphers","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-ciphers","()","<p>The list of cipher suites configured for this context.\n"],["ciphers=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-ciphers-3D","(p1)","<p>Sets the list of available cipher suites for this context. Note in a server context some ciphers require …\n"],["cleanup","OpenSSL::Engine","OpenSSL/Engine.html#method-c-cleanup","()","<p>It is only necessary to run cleanup when engines are loaded via OpenSSL::Engine.load. However, running …\n"],["cleanup","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-cleanup","()",""],["clear_bit!","OpenSSL::BN","OpenSSL/BN.html#method-i-clear_bit-21","(p1)",""],["client_ca","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-client_ca","()","<p>Returns the list of client CAs. Please note that in contrast to SSLContext#client_ca= no array of X509::Certificate …\n"],["close","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-close","()","<p>Closes the SSLSocket and flushes any unwritten data.\n"],["close","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-i-close","()","<p>See IO#close for details.\n"],["closed?","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-closed-3F","()",""],["cmds","OpenSSL::Engine","OpenSSL/Engine.html#method-i-cmds","()","<p>Returns an array of command definitions for the current engine\n"],["cmp","OpenSSL::BN","OpenSSL/BN.html#method-i-cmp","(p1)",""],["cmp","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-cmp","(p1)","<p>Compares this certificate id with <em>other</em> and returns <code>true</code> if they are the same.\n"],["cmp","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-cmp","(p1)","<p>Compares this Name with <em>other</em> and returns <code>0</code> if they are the same and <code>-1</code> or +<code>1</code> if they are greater or …\n"],["cmp_issuer","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-cmp_issuer","(p1)","<p>Compares this certificate id's issuer with <em>other</em> and returns <code>true</code> if they are the same.\n"],["coerce","OpenSSL::BN","OpenSSL/BN.html#method-i-coerce","(p1)",""],["cofactor","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-cofactor","()","<p>Returns the cofactor of the group.\n<p>See the OpenSSL documentation for EC_GROUP_get_cofactor()\n"],["compute_key","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-compute_key","(p1)","<p>Returns a String containing a shared secret computed from the other party's public value. See DH_compute_key …\n"],["concat","OpenSSL::Buffering::Buffer","OpenSSL/Buffering/Buffer.html#method-i-concat","(string)",""],["connect","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-connect","()","<p>Initiates an SSL/TLS handshake with a server. The handshake may be started after unencrypted data has …\n"],["connect_nonblock","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-connect_nonblock","(p1 = {})","<p>Initiates the SSL/TLS handshake as a client in non-blocking manner.\n\n<pre># emulates blocking connect\nbegin ...</pre>\n"],["copy","OpenSSL::BN","OpenSSL/BN.html#method-i-copy","(p1)",""],["copy_nonce","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-copy_nonce","(p1)","<p>Copies the nonce from <em>request</em> into this response. Returns 1 on success and 0 on failure.\n"],["create","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-c-create","(p1, p2)","<p>Creates an OpenSSL::OCSP::Response from <em>status</em> and <em>basic_response</em>.\n"],["create","OpenSSL::PKCS12","OpenSSL/PKCS12.html#method-c-create","(p1, p2, p3, p4, p5 = v5, p6 = v6, p7 = v7, p8 = v8, p9 = v9, p10 = v10)","<p>Parameters\n<p><em>pass</em> - string\n<p><em>name</em> - A string describing the key.\n"],["create_ext","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-create_ext","(p1, p2, p3 = v3)","<p>Creates a new X509::Extension with passed values. See also x509v3_config(5).\n"],["create_ext_from_array","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-create_ext_from_array","(ary)",""],["create_ext_from_hash","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-create_ext_from_hash","(hash)",""],["create_ext_from_string","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-create_ext_from_string","(str)",""],["create_extension","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-create_extension","(*arg)",""],["create_timestamp","OpenSSL::Timestamp::Factory","OpenSSL/Timestamp/Factory.html#method-i-create_timestamp","(p1, p2, p3)","<p>Creates a Response with the help of an OpenSSL::PKey, an OpenSSL::X509::Certificate and a Request.\n<p>Mandatory …\n"],["critical=","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-critical-3D","(p1)",""],["critical?","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-critical-3F","()",""],["crl=","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-crl-3D","(p1)",""],["crl_uris","OpenSSL::X509::Extension::CRLDistributionPoints","OpenSSL/X509/Extension/CRLDistributionPoints.html#method-i-crl_uris","()","<p>Get the distributionPoint fullName URI from the certificate's CRL distribution points extension, …\n"],["crls","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-crls","()",""],["crls=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-crls-3D","(p1)",""],["ctrl_cmd","OpenSSL::Engine","OpenSSL/Engine.html#method-i-ctrl_cmd","(p1, p2 = v2)","<p>Sends the given <em>command</em> to this engine.\n<p>Raises an EngineError if the command fails.\n"],["current_cert","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-current_cert","()",""],["current_crl","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-current_crl","()",""],["curve_name","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-curve_name","()","<p>Returns the curve name (sn).\n<p>See the OpenSSL documentation for EC_GROUP_get_curve_name()\n"],["data=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-data-3D","(p1)",""],["debug","OpenSSL","OpenSSL.html#method-c-debug","()",""],["debug=","OpenSSL","OpenSSL.html#method-c-debug-3D","(p1)","<p>Turns on or off debug mode. With debug mode, all erros added to the OpenSSL error queue will be printed …\n"],["decode","OpenSSL::ASN1","OpenSSL/ASN1.html#method-c-decode","(p1)","<p>Decodes a BER- or DER-encoded value and creates an ASN1Data instance. <em>der</em> may be a String or any object …\n"],["decode_all","OpenSSL::ASN1","OpenSSL/ASN1.html#method-c-decode_all","(p1)","<p>Similar to #decode with the difference that #decode expects one distinct value represented in <em>der</em>. #decode_all …\n"],["decrypt","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-decrypt","(*args)","<p>Initializes the Cipher for decryption.\n<p>Make sure to call Cipher#encrypt or Cipher#decrypt before using …\n"],["decrypt","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-decrypt","(p1, p2 = v2, p3 = v3)",""],["degree","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-degree","()","<p>See the OpenSSL documentation for EC_GROUP_get_degree()\n"],["detached","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-detached","()",""],["detached=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-detached-3D","(p1)",""],["detached?","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-detached-3F","()",""],["dh_compute_key","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-dh_compute_key","(p1)","<p>See the OpenSSL documentation for ECDH_compute_key()\n"],["digest","OpenSSL::Digest","OpenSSL/Digest.html#method-c-digest","(name, data)","<p>Return the hash value computed with <em>name</em> Digest. <em>name</em> is either the long name or short name of a supported …\n"],["digest","OpenSSL::Engine","OpenSSL/Engine.html#method-i-digest","(p1)","<p>Returns a new instance of OpenSSL::Digest by <em>name</em>.\n<p>Will raise an EngineError if the digest is unavailable. …\n"],["digest","OpenSSL::HMAC","OpenSSL/HMAC.html#method-c-digest","(p1, p2, p3)","<p>Returns the authentication code as a binary string. The <em>digest</em> parameter specifies the digest algorithm …\n"],["digest","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-digest","()","<p>Returns the authentication code an instance represents as a binary string.\n<p>Example\n\n<pre>instance = OpenSSL::HMAC.new('key', ...</pre>\n"],["digest_length","OpenSSL::Digest","OpenSSL/Digest.html#method-i-digest_length","()","<p>Returns the output size of the digest, i.e. the length in bytes of the final message digest result.\n<p>Example …\n"],["do_not_reverse_lookup=","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-do_not_reverse_lookup-3D","(flag)",""],["dsa_sign_asn1","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-dsa_sign_asn1","(p1)","<p>See the OpenSSL documentation for ECDSA_sign()\n"],["dsa_verify_asn1","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-dsa_verify_asn1","(p1, p2)","<p>See the OpenSSL documentation for ECDSA_verify()\n"],["each","OpenSSL::ASN1::Constructive","OpenSSL/ASN1/Constructive.html#method-i-each","()","<p>Calls the given block once for each element in self, passing that element as parameter <em>asn1</em>. If no block …\n"],["each","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-each","(eol=$/)","<p>Executes the block for every line in the stream where lines are separated by <em>eol</em>.\n<p>See also #gets\n"],["each","OpenSSL::Config","OpenSSL/Config.html#method-i-each","()","<p>For a block.\n<p>Receive the section and its pairs for the current configuration.\n\n<pre>config.each do |section, ...</pre>\n"],["each_byte","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-each_byte","()","<p>Calls the given block once for each byte in the stream.\n"],["each_line","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-each_line","(eol=$/)",""],["ecdh_curves=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-ecdh_curves-3D","(p1)","<p>Sets the list of “supported elliptic curves” for this context.\n<p>For a TLS client, the list is …\n"],["egd","OpenSSL::Random","OpenSSL/Random.html#method-c-egd","(p1)","<p>Same as ::egd_bytes but queries 255 bytes by default.\n"],["egd_bytes","OpenSSL::Random","OpenSSL/Random.html#method-c-egd_bytes","(p1, p2)","<p>Queries the entropy gathering daemon EGD on socket path given by <em>filename</em>.\n<p>Fetches <em>length</em> number of bytes …\n"],["enable_fallback_scsv","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-enable_fallback_scsv","()","<p>Activate TLS_FALLBACK_SCSV for this context. See RFC 7507.\n"],["enc_key","OpenSSL::PKCS7::RecipientInfo","OpenSSL/PKCS7/RecipientInfo.html#method-i-enc_key","()",""],["encrypt","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-encrypt","(*args)","<p>Initializes the Cipher for encryption.\n<p>Make sure to call Cipher#encrypt or Cipher#decrypt before using …\n"],["encrypt","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-c-encrypt","(p1, p2, p3 = v3, p4 = v4)",""],["engines","OpenSSL::Engine","OpenSSL/Engine.html#method-c-engines","()","<p>Returns an array of currently loaded engines.\n"],["eof","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-eof","()",""],["eof?","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-eof-3F","()","<p>Returns true if the stream is at file which means there is no more data to be read.\n"],["eql?","OpenSSL::BN","OpenSSL/BN.html#method-i-eql-3F","(p1)","<p>Returns <code>true</code> only if <em>obj</em> is a <code>OpenSSL::BN</code> with the same value as <em>bn</em>. Contrast this with OpenSSL::BN#==, …\n"],["eql?","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-eql-3F","(p1)","<p>Returns <code>true</code> if the two groups use the same curve and have the same parameters, <code>false</code> otherwise.\n"],["eql?","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-eql-3F","(p1)",""],["eql?","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-eql-3F","(p1)","<p>Returns true if <em>name</em> and <em>other</em> refer to the same hash key.\n"],["error","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-error","()",""],["error=","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-error-3D","(p1)",""],["error_depth","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-error_depth","()",""],["error_string","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-error_string","()","<p>Returns the error string corresponding to the error code retrieved by #error.\n"],["errors","OpenSSL","OpenSSL.html#method-c-errors","()","<p>See any remaining errors held in queue.\n<p>Any errors you see here are probably due to a bug in Ruby's …\n"],["expand_hexstring","OpenSSL::X509::Name::RFC2253DN","OpenSSL/X509/Name/RFC2253DN.html#method-i-expand_hexstring","(str)",""],["expand_pair","OpenSSL::X509::Name::RFC2253DN","OpenSSL/X509/Name/RFC2253DN.html#method-i-expand_pair","(str)",""],["expand_value","OpenSSL::X509::Name::RFC2253DN","OpenSSL/X509/Name/RFC2253DN.html#method-i-expand_value","(str1, str2, str3)",""],["export","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-export","()","<p>Encodes this DH to its PEM encoding. Note that any existing per-session public/private keys will <strong>not</strong> …\n"],["export","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-export","(p1 = v1, p2 = v2)","<p>Encodes this DSA to its PEM encoding.\n<p>Parameters\n<p><em>cipher</em> is an OpenSSL::Cipher.\n"],["export","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-export","(p1 = v1, p2 = v2)","<p>Outputs the EC key in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt …\n"],["export","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-export","(p1 = v1, p2 = v2)","<p>Outputs this keypair in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt …\n"],["extensions","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-extensions","()",""],["extensions","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-extensions","()","<p>Gets X509v3 extensions as array of X509Ext objects\n"],["extensions","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-extensions","()",""],["extensions","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-extensions","()","<p>Gets X509v3 extensions as array of X509Ext objects\n"],["extensions=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-extensions-3D","(p1)","<p>Sets X509_EXTENSIONs\n"],["extensions=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-extensions-3D","(p1)",""],["extensions=","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-extensions-3D","(p1)","<p>Sets X509_EXTENSIONs\n"],["failure_info","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-failure_info","()","<p>In cases no timestamp token has been created, this field contains further info about the reason why response …\n"],["fcntl","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-fcntl","(*args)",""],["fileno","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-fileno","()","<p>The file descriptor for the socket.\n"],["final","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-final","()","<p>Returns the remaining data held in the cipher object. Further calls to Cipher#update or Cipher#final …\n"],["find_extension","OpenSSL::X509::Extension::Helpers","OpenSSL/X509/Extension/Helpers.html#method-i-find_extension","(oid)",""],["find_response","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-find_response","(p1)","<p>Returns a SingleResponse whose CertId matches with <em>certificate_id</em>, or <code>nil</code> if this BasicResponse does …\n"],["finish","OpenSSL::Engine","OpenSSL/Engine.html#method-i-finish","()","<p>Releases all internal structural references for this engine.\n<p>May raise an EngineError if the engine is …\n"],["finished_message","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-finished_message","()","<p>Returns the last <strong>Finished</strong> message sent\n"],["fips_mode","OpenSSL","OpenSSL.html#method-c-fips_mode","()",""],["fips_mode=","OpenSSL","OpenSSL.html#method-c-fips_mode-3D","(p1)","<p>Turns FIPS mode on or off. Turning on FIPS mode will obviously only have an effect for FIPS-capable installations …\n"],["fixed_length_secure_compare","OpenSSL","OpenSSL.html#method-c-fixed_length_secure_compare","(p1, p2)","<p>Constant time memory comparison for fixed length strings, such as results of HMAC calculations.\n<p>Returns …\n"],["flags=","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-flags-3D","(p1)","<p>Sets <em>flags</em> to the Store. <em>flags</em> consists of zero or more of the constants defined in with name V_FLAG_ …\n"],["flags=","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-flags-3D","(p1)","<p>Sets the verification flags to the context. See Store#flags=.\n"],["flush","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-flush","()","<p>Flushes buffered data to the SSLSocket.\n"],["flush_sessions","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-flush_sessions","(p1 = v1)","<p>Removes sessions in the internal cache that have expired at <em>time</em>.\n"],["freeze","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-freeze","()",""],["gcd","OpenSSL::BN","OpenSSL/BN.html#method-i-gcd","(p1)",""],["gen_time","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-gen_time","()","<p>Returns time when this timestamp token was created. If status is GRANTED or GRANTED_WITH_MODS, this is …\n"],["generate","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-c-generate","(p1, p2 = v2)","<p>Creates a new DH instance from scratch by generating the private and public components alike.\n<p>Parameters …\n"],["generate","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-c-generate","(p1)","<p>Creates a new DSA instance by generating a private/public key pair from scratch.\n<p>Parameters\n<p><em>size</em> is an …\n"],["generate","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-c-generate","(p1)","<p>Creates a new EC instance with a new random private and public key.\n"],["generate","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-c-generate","(p1, p2 = v2)","<p>Generates an RSA keypair. <em>size</em> is an integer representing the desired key size. Keys smaller than 1024 …\n"],["generate_key","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-generate_key","()",""],["generate_key!","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-generate_key-21","()","<p>Generates a private and public key unless a private key already exists. If this DH instance was generated …\n"],["generate_key!","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-generate_key-21","()","<p>Generates a new random private and public key.\n<p>See also the OpenSSL documentation for EC_KEY_generate_key …\n"],["generate_prime","OpenSSL::BN","OpenSSL/BN.html#method-c-generate_prime","(p1, p2 = v2, p3 = v3, p4 = v4)","<p>Generates a random prime number of bit length <em>bits</em>. If <em>safe</em> is set to <code>true</code>, generates a safe prime. …\n"],["generator","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-generator","()","<p>Returns the generator of the group.\n<p>See the OpenSSL documentation for EC_GROUP_get0_generator()\n"],["get_value","OpenSSL::Config","OpenSSL/Config.html#method-i-get_value","(section, key)","<p>Gets the value of <em>key</em> from the given <em>section</em>\n<p>Given the following configurating file being loaded:\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">config</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["getc","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-getc","()","<p>Reads one character from the stream. Returns nil if called at end of file.\n"],["gets","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-gets","(eol=$/, limit=nil)","<p>Reads the next “line” from the stream. Lines are separated by <em>eol</em>. If <em>limit</em> is provided the …\n"],["getsockopt","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-getsockopt","(level, optname)",""],["group","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-group","()","<p>Returns the EC::Group that the key is associated with. Modifying the returned group does not affect …\n"],["group=","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-group-3D","(p1)","<p>Sets the EC::Group for the key. The group structure is internally copied so modification to <em>group</em> after …\n"],["hash","OpenSSL::BN","OpenSSL/BN.html#method-i-hash","()","<p>Returns a hash code for this object.\n<p>See also Object#hash.\n"],["hash","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-hash","()","<p>The hash value returned is suitable for use as a certificate's filename in a CA path.\n"],["hash_algorithm","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-hash_algorithm","()","<p>Returns the ln (long name) of the hash algorithm used to generate the issuerNameHash and the issuerKeyHash …\n"],["hash_old","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-hash_old","()","<p>Returns an MD5 based hash used in OpenSSL 0.9.X.\n"],["hexdigest","OpenSSL::HMAC","OpenSSL/HMAC.html#method-c-hexdigest","(p1, p2, p3)","<p>Returns the authentication code as a hex-encoded string. The <em>digest</em> parameter specifies the digest algorithm …\n"],["hexdigest","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-hexdigest","()","<p>Returns the authentication code an instance represents as a hex-encoded string.\n"],["hkdf","OpenSSL::KDF","OpenSSL/KDF.html#method-c-hkdf","(p1, p2 = {})","<p>HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as specified in RFC 5869.\n<p>New in OpenSSL …\n"],["hostname=","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-hostname-3D","(p1)","<p>Sets the server hostname used for SNI. This needs to be set before SSLSocket#connect.\n"],["id","OpenSSL::Engine","OpenSSL/Engine.html#method-i-id","()","<p>Gets the id for this engine.\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Engine</span>.<span class=\"ruby-identifier\">load</span>\n<span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Engine</span>.<span class=\"ruby-identifier\">engines</span> <span class=\"ruby-comment\">#=> [#<OpenSSL::Engine#>, ...] ...</span>\n</pre>\n"],["id","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-id","()","<p>Returns the Session ID.\n"],["included","OpenSSL::Marshal","OpenSSL/Marshal.html#method-c-included","(base)",""],["infinity?","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-infinity-3F","()",""],["initialize_copy","OpenSSL::BN","OpenSSL/BN.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::Digest","OpenSSL/Digest.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKCS12","OpenSSL/PKCS12.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-initialize_copy","(p1)",""],["inspect","OpenSSL::Config","OpenSSL/Config.html#method-i-inspect","()","<p>String representation of this configuration object, including the class name and its sections.\n"],["inspect","OpenSSL::Engine","OpenSSL/Engine.html#method-i-inspect","()","<p>Pretty prints this engine.\n"],["inspect","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-inspect","()",""],["inspect","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-inspect","()","<p>Returns a string describing the PKey object.\n"],["inspect","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-inspect","()",""],["invert!","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-invert-21","()",""],["issuer","OpenSSL::PKCS7::RecipientInfo","OpenSSL/PKCS7/RecipientInfo.html#method-i-issuer","()",""],["issuer","OpenSSL::PKCS7::SignerInfo","OpenSSL/PKCS7/SignerInfo.html#method-i-issuer","()",""],["issuer","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-issuer","()",""],["issuer","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-issuer","()",""],["issuer=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-issuer-3D","(p1)",""],["issuer=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-issuer-3D","(p1)",""],["issuer_certificate=","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-issuer_certificate-3D","(p1)",""],["issuer_key_hash","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-issuer_key_hash","()","<p>Returns the issuerKeyHash of this certificate ID, the hash of the issuer's public key.\n"],["issuer_name_hash","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-issuer_name_hash","()","<p>Returns the issuerNameHash of this certificate ID, the hash of the issuer's distinguished name calculated …\n"],["iv=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-iv-3D","(p1)","<p>Sets the cipher IV. Please note that since you should never be using ECB mode, an IV is always explicitly …\n"],["iv_len","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-iv_len","()","<p>Returns the expected length in bytes for an IV for this Cipher.\n"],["iv_len=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-iv_len-3D","(p1)","<p>Sets the IV/nonce length of the Cipher. Normally block ciphers don't allow changing the IV length, …\n"],["key=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-key-3D","(p1)","<p>Sets the cipher key. To generate a key, you should either use a secure random byte string or, if the …\n"],["key_len","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-key_len","()","<p>Returns the key length in bytes of the Cipher.\n"],["key_len=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-key_len-3D","(p1)","<p>Sets the key length of the cipher. If the cipher is a fixed length cipher then attempting to set the …\n"],["last_update","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-last_update","()",""],["last_update=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-last_update-3D","(p1)",""],["listen","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-i-listen","(backlog=Socket::SOMAXCONN)","<p>See TCPServer#listen for details.\n"],["ln","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-ln","()","<p>The long name of the ObjectId, as defined in <openssl/objects.h>.\n"],["load","OpenSSL::Engine","OpenSSL/Engine.html#method-c-load","(p1 = v1)","<p>This method loads engines. If <em>name</em> is nil, then all builtin engines are loaded. Otherwise, the given …\n"],["load_private_key","OpenSSL::Engine","OpenSSL/Engine.html#method-i-load_private_key","(p1 = v1, p2 = v2)","<p>Loads the given private key identified by <em>id</em> and <em>data</em>.\n<p>An EngineError is raised of the OpenSSL::PKey is …\n"],["load_public_key","OpenSSL::Engine","OpenSSL/Engine.html#method-i-load_public_key","(p1 = v1, p2 = v2)","<p>Loads the given public key identified by <em>id</em> and <em>data</em>.\n<p>An EngineError is raised of the OpenSSL::PKey is …\n"],["load_random_file","OpenSSL::Random","OpenSSL/Random.html#method-c-load_random_file","(p1)","<p>Reads bytes from <em>filename</em> and adds them to the PRNG.\n"],["long_name","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-long_name","()",""],["lshift!","OpenSSL::BN","OpenSSL/BN.html#method-i-lshift-21","(p1)",""],["make_affine!","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-make_affine-21","()",""],["max_version=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-max_version-3D","(version)","<p>Sets the upper bound of the supported SSL/TLS protocol version. See #min_version= for the possible values. …\n"],["mem_check_start","OpenSSL","OpenSSL.html#method-c-mem_check_start","()","<p>Calls CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON). Starts tracking memory allocations. See also OpenSSL.print_mem_leaks …\n"],["message_imprint","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-message_imprint","()","<p>Returns the message imprint (digest) of the data to be timestamped.\n"],["message_imprint","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-message_imprint","()","<p>Returns the message imprint digest. For valid timestamps, this is the same value that was already given …\n"],["message_imprint=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-message_imprint-3D","(p1)","<p>Set the message imprint digest.\n"],["min_version=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-min_version-3D","(version)","<p>Sets the lower bound on the supported SSL/TLS protocol version. The version may be specified by an integer …\n"],["mod_add","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_add","(p1, p2)",""],["mod_exp","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_exp","(p1, p2)",""],["mod_inverse","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_inverse","(p1)",""],["mod_mul","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_mul","(p1, p2)",""],["mod_sqr","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_sqr","(p1)",""],["mod_sub","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_sub","(p1, p2)",""],["mul","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-mul","(p1, p2 = v2, p3 = v3)","<p>Performs elliptic curve point multiplication.\n<p>The first form calculates <code>bn1 * point + bn2 * G</code>, where …\n"],["name","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-name","()","<p>Returns the name of the cipher which may differ slightly from the original name provided.\n"],["name","OpenSSL::Digest","OpenSSL/Digest.html#method-i-name","()","<p>Returns the sn of this Digest algorithm.\n<p>Example\n\n<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-identifier\">new</span>(<span class=\"ruby-string\">'SHA512'</span>)\n<span class=\"ruby-identifier\">puts</span> <span class=\"ruby-identifier\">digest</span>.<span class=\"ruby-identifier\">name</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["name","OpenSSL::Engine","OpenSSL/Engine.html#method-i-name","()","<p>Get the descriptive name for this engine.\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Engine</span>.<span class=\"ruby-identifier\">load</span>\n<span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Engine</span>.<span class=\"ruby-identifier\">engines</span> <span class=\"ruby-comment\">#=> [#<OpenSSL::Engine#>, ...</span>\n</pre>\n"],["negative?","OpenSSL::BN","OpenSSL/BN.html#method-i-negative-3F","()",""],["new","OpenSSL::ASN1::ASN1Data","OpenSSL/ASN1/ASN1Data.html#method-c-new","(p1, p2, p3)","<p><em>value</em>: Please have a look at Constructive and Primitive to see how Ruby types are mapped to ASN.1 types …\n"],["new","OpenSSL::ASN1::Constructive","OpenSSL/ASN1/Constructive.html#method-c-new","(p1, p2 = v2, p3 = v3, p4 = v4)","<p><em>value</em>: is mandatory.\n<p><em>tag</em>: optional, may be specified for tagged values. If no <em>tag</em> is specified, the UNIVERSAL …\n"],["new","OpenSSL::ASN1::Primitive","OpenSSL/ASN1/Primitive.html#method-c-new","(p1, p2 = v2, p3 = v3, p4 = v4)","<p><em>value</em>: is mandatory.\n<p><em>tag</em>: optional, may be specified for tagged values. If no <em>tag</em> is specified, the UNIVERSAL …\n"],["new","OpenSSL::BN","OpenSSL/BN.html#method-c-new","(p1, p2 = v2)","<p>Construct a new OpenSSL BIGNUM object.\n"],["new","OpenSSL::Buffering","OpenSSL/Buffering.html#method-c-new","(*)","<p>Creates an instance of OpenSSL's buffering IO module.\n"],["new","OpenSSL::Buffering::Buffer","OpenSSL/Buffering/Buffer.html#method-c-new","()",""],["new","OpenSSL::Cipher","OpenSSL/Cipher.html#method-c-new","(p1)","<p>The string must contain a valid cipher name like “AES-256-CBC”.\n<p>A list of cipher names is available …\n"],["new","OpenSSL::Config","OpenSSL/Config.html#method-c-new","(filename = nil)","<p>Creates an instance of OpenSSL's configuration class.\n<p>This can be used in contexts like OpenSSL::X509::ExtensionFactory.config= …\n"],["new","OpenSSL::Digest","OpenSSL/Digest.html#method-c-new","(p1, p2 = v2)","<p>Creates a Digest instance based on <em>string</em>, which is either the ln (long name) or sn (short name) of a …\n"],["new","OpenSSL::HMAC","OpenSSL/HMAC.html#method-c-new","(p1, p2)","<p>Returns an instance of OpenSSL::HMAC set with the key and digest algorithm to be used. The instance represents …\n"],["new","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-c-new","(p1 = v1)","<p>Parameters\n<p><em>request</em> - optional raw request, either in PEM or DER format.\n\n"],["new","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-c-new","(p1 = v1)","<p>Creates a new BasicResponse. If <em>der_string</em> is given, decodes <em>der_string</em> as DER.\n"],["new","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-c-new","(p1, p2 = v2, p3 = v3)","<p>Creates a new OpenSSL::OCSP::CertificateId for the given <em>subject</em> and <em>issuer</em> X509 certificates. The …\n"],["new","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-c-new","(p1 = v1)","<p>Creates a new OpenSSL::OCSP::Request. The request may be created empty or from a <em>request_der</em> string. …\n"],["new","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-c-new","(p1 = v1)","<p>Creates a new OpenSSL::OCSP::Response. The response may be created empty or from a <em>response_der</em> string. …\n"],["new","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-c-new","(p1)","<p>Creates a new SingleResponse from <em>der_string</em>.\n"],["new","OpenSSL::PKCS12","OpenSSL/PKCS12.html#method-c-new","(p1 = v1, p2 = v2)","<p>Parameters\n<p><em>str</em> - Must be a DER encoded PKCS12 string.\n<p><em>pass</em> - string\n"],["new","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-c-new","(p1 = v1)","<p>Many methods in this class aren't documented.\n"],["new","OpenSSL::PKCS7::RecipientInfo","OpenSSL/PKCS7/RecipientInfo.html#method-c-new","(p1)",""],["new","OpenSSL::PKCS7::SignerInfo","OpenSSL/PKCS7/SignerInfo.html#method-c-new","(p1, p2, p3)",""],["new","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-c-new","(p1 = v1, p2 = v2)","<p>Either generates a DH instance from scratch or by reading already existing DH parameters from <em>string</em> …\n"],["new","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-c-new","(p1 = v1, p2 = v2)","<p>Creates a new DSA instance by reading an existing key from <em>string</em>.\n<p>Parameters\n<p><em>size</em> is an integer representing …\n"],["new","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-c-new","(p1 = v1, p2 = v2)","<p>Creates a new EC object from given arguments.\n"],["new","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-c-new","(p1, p2 = v2, p3 = v3, p4 = v4)","<p>Creates a new EC::Group object.\n<p><em>ec_method</em> is a symbol that represents an EC_METHOD. Currently the following …\n"],["new","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-c-new","(p1, p2 = v2)","<p>Creates a new instance of OpenSSL::PKey::EC::Point. If the only argument is an instance of EC::Point …\n"],["new","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-c-new","()","<p>Because PKey is an abstract class, actually calling this method explicitly will raise a NotImplementedError …\n"],["new","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-c-new","(p1 = v1, p2 = v2)","<p>Generates or loads an RSA keypair. If an integer <em>key_size</em> is given it represents the desired key size. …\n"],["new","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-c-new","(version = nil)","<p>Creates a new SSL context.\n<p>If an argument is given, #ssl_version= is called with the value. Note that …\n"],["new","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-c-new","(svr, ctx)","<p>Creates a new instance of SSLServer.\n<p><em>srv</em> is an instance of TCPServer.\n<p><em>ctx</em> is an instance of OpenSSL::SSL::SSLContext …\n"],["new","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-c-new","(p1, p2 = v2)","<p>Creates a new SSL socket from <em>io</em> which must be a real IO object (not an IO-like object that responds …\n"],["new","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-c-new","(p1)","<p>Creates a new Session object from an instance of SSLSocket or DER/PEM encoded String.\n"],["new","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-c-new","(p1 = v1)","<p>When creating a Request with the <code>File</code> or <code>string</code> parameter, the corresponding <code>File</code> or <code>string</code> must be DER-encoded. …\n"],["new","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-c-new","(p1)","<p>Creates a Response from a <code>File</code> or <code>string</code> parameter, the corresponding <code>File</code> or <code>string</code> must be DER-encoded. …\n"],["new","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-c-new","(p1)","<p>Creates a TokenInfo from a <code>File</code> or <code>string</code> parameter, the corresponding <code>File</code> or <code>string</code> must be DER-encoded. …\n"],["new","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-c-new","(p1, p2 = v2)",""],["new","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-c-new","(p1 = v1)",""],["new","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-c-new","(p1 = v1)",""],["new","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-c-new","(p1, p2 = v2, p3 = v3)","<p>Creates an X509 extension.\n<p>The extension may be created from <em>der</em> data or from an extension <em>oid</em> and <em>value</em> …\n"],["new","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-c-new","(p1 = v1, p2 = v2, p3 = v3, p4 = v4)",""],["new","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-c-new","(p1 = v1, p2 = v2)","<p>Creates a new Name.\n<p>A name may be created from a DER encoded string <em>der</em>, an Array representing a <em>distinguished_name</em> …\n"],["new","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-c-new","(p1 = v1)",""],["new","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-c-new","(*args)",""],["new","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-c-new","(*args)","<p>Creates a new X509::Store.\n"],["new","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-c-new","(p1, p2 = v2, p3 = v3)",""],["next_update","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-next_update","()",""],["next_update","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-next_update","()",""],["next_update=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-next_update-3D","(p1)",""],["nonce","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-nonce","()","<p>Returns the nonce (number used once) that the server shall include in its response.\n"],["nonce","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-nonce","()","<p>If the timestamp token is valid then this field contains the same nonce that was passed to the timestamp …\n"],["nonce=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-nonce-3D","(p1)","<p>Sets the nonce (number used once) that the server shall include in its response. If the nonce is set, …\n"],["not_after","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-not_after","()",""],["not_after=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-not_after-3D","(p1)",""],["not_before","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-not_before","()",""],["not_before=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-not_before-3D","(p1)",""],["npn_protocol","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-npn_protocol","()","<p>Returns the protocol string that was finally selected by the client during the handshake.\n"],["num_bits","OpenSSL::BN","OpenSSL/BN.html#method-i-num_bits","()",""],["num_bytes","OpenSSL::BN","OpenSSL/BN.html#method-i-num_bytes","()",""],["ocsp_uris","OpenSSL::X509::Extension::AuthorityInfoAccess","OpenSSL/X509/Extension/AuthorityInfoAccess.html#method-i-ocsp_uris","()","<p>Get the URIs for OCSP from the certificate's authority information access extension exteension, as …\n"],["odd?","OpenSSL::BN","OpenSSL/BN.html#method-i-odd-3F","()",""],["oid","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-oid","()","<p>Returns a String representing the Object Identifier in the dot notation, e.g. “1.2.3.4.5”\n"],["oid","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-oid","()","<p>Returns the short name of the OID associated with <em>pkey</em>.\n"],["oid","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-oid","()",""],["oid","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-oid","()",""],["oid=","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-oid-3D","(p1)",""],["oid=","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-oid-3D","(p1)",""],["on_curve?","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-on_curve-3F","()",""],["one?","OpenSSL::BN","OpenSSL/BN.html#method-i-one-3F","()",""],["options","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-options","()","<p>Gets various OpenSSL options.\n"],["options=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-options-3D","(p1)","<p>Sets various OpenSSL options.\n"],["order","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-order","()","<p>Returns the order of the group.\n<p>See the OpenSSL documentation for EC_GROUP_get_order()\n"],["ordering","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-ordering","()","<p>If the ordering field is missing, or if the ordering field is present and set to false, then the genTime …\n"],["padding=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-padding-3D","(p1)","<p>Enables or disables padding. By default encryption operations are padded using standard block padding …\n"],["params","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-params","()","<p>Stores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use …\n"],["params","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-params","()","<p>Stores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use …\n"],["params","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-params","()","<p>THIS METHOD IS INSECURE, PRIVATE INFORMATION CAN LEAK OUT!!!\n<p>Stores all parameters of key to the hash. …\n"],["params_ok?","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-params_ok-3F","()","<p>Validates the Diffie-Hellman parameters associated with this instance. It checks whether a safe prime …\n"],["parse","OpenSSL::Config","OpenSSL/Config.html#method-c-parse","(string)","<p>Parses a given <em>string</em> as a blob that contains configuration for OpenSSL.\n<p>If the source of the IO is a …\n"],["parse","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-c-parse","(str, template=OBJECT_TYPE_TEMPLATE)",""],["parse_config","OpenSSL::Config","OpenSSL/Config.html#method-c-parse_config","(io)","<p>Parses the configuration data read from <em>io</em>, see also #parse.\n<p>Raises a ConfigError on invalid configuration …\n"],["parse_openssl","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-c-parse_openssl","(str, template=OBJECT_TYPE_TEMPLATE)",""],["parse_rfc2253","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-c-parse_rfc2253","(str, template=OBJECT_TYPE_TEMPLATE)",""],["pbkdf2_hmac","OpenSSL::KDF","OpenSSL/KDF.html#method-c-pbkdf2_hmac","(p1, p2 = {})","<p>PKCS #5 PBKDF2 (Password-Based Key Derivation Function 2) in combination with HMAC. Takes <em>pass</em>, <em>salt</em> …\n"],["pbkdf2_hmac","OpenSSL::PKCS5","OpenSSL/PKCS5.html#method-i-pbkdf2_hmac","(pass, salt, iter, keylen, digest)","<p>OpenSSL::PKCS5.pbkdf2_hmac has been renamed to OpenSSL::KDF.pbkdf2_hmac. This method is provided for …\n"],["pbkdf2_hmac_sha1","OpenSSL::PKCS5","OpenSSL/PKCS5.html#method-i-pbkdf2_hmac_sha1","(pass, salt, iter, keylen)",""],["peer_cert","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-peer_cert","()","<p>The X509 certificate for this socket's peer.\n"],["peer_cert_chain","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-peer_cert_chain","()","<p>The X509 certificate chain for this socket's peer.\n"],["peer_finished_message","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-peer_finished_message","()","<p>Returns the last <strong>Finished</strong> message received\n"],["peeraddr","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-peeraddr","()",""],["pending","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-pending","()","<p>The number of bytes that are immediately available for reading.\n"],["pkcs5_keyivgen","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-pkcs5_keyivgen","(p1, p2 = v2, p3 = v3, p4 = v4)","<p>Generates and sets the key/IV based on a password.\n<p><strong>WARNING</strong>: This method is only PKCS5 v1.5 compliant when …\n"],["point_conversion_form","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-point_conversion_form","()","<p>Returns the form how EC::Point data is encoded as ASN.1.\n<p>See also #point_conversion_form=.\n"],["point_conversion_form=","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-point_conversion_form-3D","(p1)","<p>Sets the form how EC::Point data is encoded as ASN.1 as defined in X9.62.\n<p><em>format</em> can be one of these: …\n"],["policy_id","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-policy_id","()","<p>Returns the 'short name' of the object identifier that represents the timestamp policy under …\n"],["policy_id","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-policy_id","()","<p>Returns the timestamp policy object identifier of the policy this timestamp was created under. If status …\n"],["policy_id=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-policy_id-3D","(p1)","<p>Allows to set the object identifier that represents the timestamp policy under which the server shall …\n"],["post_connection_check","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-post_connection_check","(hostname)","<p>Perform hostname verification following RFC 6125.\n<p>This method MUST be called after calling #connect to …\n"],["pretty_print","OpenSSL::BN","OpenSSL/BN.html#method-i-pretty_print","(q)",""],["pretty_print","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-pretty_print","(q)",""],["pretty_print","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-pretty_print","(q)",""],["prime?","OpenSSL::BN","OpenSSL/BN.html#method-i-prime-3F","(p1 = v1)","<p>Performs a Miller-Rabin probabilistic primality test with <em>checks</em> iterations. If <em>checks</em> is not specified, …\n"],["prime_fasttest?","OpenSSL::BN","OpenSSL/BN.html#method-i-prime_fasttest-3F","(p1 = v1, p2 = v2)","<p>Performs a Miller-Rabin primality test. This is same as #prime? except this first attempts trial divisions …\n"],["print","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-print","(*args)","<p>Writes <em>args</em> to the stream.\n<p>See IO#print for full details.\n"],["print_mem_leaks","OpenSSL","OpenSSL.html#method-c-print_mem_leaks","()","<p>For debugging the Ruby/OpenSSL library. Calls CRYPTO_mem_leaks_fp(stderr). Prints detected memory leaks …\n"],["printf","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-printf","(s, *args)","<p>Formats and writes to the stream converting parameters under control of the format string.\n<p>See Kernel#sprintf …\n"],["private?","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-private-3F","()","<p>Indicates whether this DH instance has a private key associated with it or not. The private key may be …\n"],["private?","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-private-3F","()","<p>Indicates whether this DSA instance has a private key associated with it or not. The private key may …\n"],["private?","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-private-3F","()","<p>Returns whether this EC instance has a private key. The private key (BN) can be retrieved with EC#private_key …\n"],["private?","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-private-3F","()","<p>Does this keypair contain a private key?\n"],["private_decrypt","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-private_decrypt","(p1, p2 = v2)","<p>Decrypt <em>string</em>, which has been encrypted with the public key, with the private key. <em>padding</em> defaults …\n"],["private_encrypt","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-private_encrypt","(p1, p2 = v2)","<p>Encrypt <em>string</em> with the private key. <em>padding</em> defaults to PKCS1_PADDING. The encrypted string output …\n"],["private_key","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-private_key","()","<p>See the OpenSSL documentation for EC_KEY_get0_private_key()\n"],["private_key=","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-private_key-3D","(p1)","<p>See the OpenSSL documentation for EC_KEY_set_private_key()\n"],["private_key?","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-private_key-3F","()",""],["private_to_der","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-private_to_der","(*args)","<p>Serializes the private key to DER-encoded PKCS #8 format. If called without arguments, unencrypted PKCS …\n"],["private_to_pem","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-private_to_pem","(*args)","<p>Serializes the private key to PEM-encoded PKCS #8 format. See #private_to_der for more details.\n"],["public?","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-public-3F","()","<p>Indicates whether this DH instance has a public key associated with it or not. The public key may be …\n"],["public?","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-public-3F","()","<p>Indicates whether this DSA instance has a public key associated with it or not. The public key may be …\n"],["public?","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-public-3F","()","<p>Returns whether this EC instance has a public key. The public key (EC::Point) can be retrieved with …\n"],["public?","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-public-3F","()","<p>The return value is always <code>true</code> since every private key is also a public key.\n"],["public_decrypt","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-public_decrypt","(p1, p2 = v2)","<p>Decrypt <em>string</em>, which has been encrypted with the private key, with the public key. <em>padding</em> defaults …\n"],["public_encrypt","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-public_encrypt","(p1, p2 = v2)","<p>Encrypt <em>string</em> with the public key. <em>padding</em> defaults to PKCS1_PADDING. The encrypted string output can …\n"],["public_key","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-public_key","()","<p>Returns the public key associated with the SPKI, an instance of OpenSSL::PKey.\n"],["public_key","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-public_key","()","<p>Returns a new DH instance that carries just the public information, i.e. the prime <em>p</em> and the generator …\n"],["public_key","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-public_key","()","<p>Returns a new DSA instance that carries just the public key information. If the current instance has …\n"],["public_key","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-public_key","()","<p>See the OpenSSL documentation for EC_KEY_get0_public_key()\n"],["public_key","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-public_key","()","<p>Makes new RSA instance containing the public key from the private key.\n"],["public_key","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-public_key","()",""],["public_key","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-public_key","()",""],["public_key=","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-public_key-3D","(p1)","<p>Parameters\n<p><em>pub</em> - the public key to be set for this instance\n\n<p>Sets the public key to be associated with the …\n"],["public_key=","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-public_key-3D","(p1)","<p>See the OpenSSL documentation for EC_KEY_set_public_key()\n"],["public_key=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-public_key-3D","(p1)",""],["public_key=","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-public_key-3D","(p1)",""],["public_key?","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-public_key-3F","()",""],["public_to_der","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-public_to_der","()","<p>Serializes the public key to DER-encoded X.509 SubjectPublicKeyInfo format.\n"],["public_to_pem","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-public_to_pem","()","<p>Serializes the public key to PEM-encoded X.509 SubjectPublicKeyInfo format.\n"],["purpose=","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-purpose-3D","(p1)","<p>Sets the store's purpose to <em>purpose</em>. If specified, the verifications on the store will check every …\n"],["purpose=","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-purpose-3D","(p1)","<p>Sets the purpose of the context. See Store#purpose=.\n"],["puts","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-puts","(*args)","<p>Writes <em>args</em> to the stream along with a record separator.\n<p>See IO#puts for full details.\n"],["random_add","OpenSSL::Random","OpenSSL/Random.html#method-c-random_add","(p1, p2)","<p>Mixes the bytes from <em>str</em> into the Pseudo Random Number Generator(PRNG) state.\n<p>Thus, if the data from …\n"],["random_bytes","OpenSSL::Random","OpenSSL/Random.html#method-c-random_bytes","(p1)","<p>Generates a String with <em>length</em> number of cryptographically strong pseudo-random bytes.\n<p>Example\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Random</span>.<span class=\"ruby-identifier\">random_bytes</span>(<span class=\"ruby-value\">12</span>) <span class=\"ruby-operator\">...</span>\n</pre>\n"],["random_iv","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-random_iv","()","<p>Generate a random IV with OpenSSL::Random.random_bytes and sets it to the cipher, and returns it.\n<p>You …\n"],["random_key","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-random_key","()","<p>Generate a random key with OpenSSL::Random.random_bytes and sets it to the cipher, and returns it.\n<p>You …\n"],["read","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-read","(size=nil, buf=nil)","<p>Reads <em>size</em> bytes from the stream. If <em>buf</em> is provided it must reference a string which will receive the …\n"],["read","OpenSSL::PKey","OpenSSL/PKey.html#method-c-read","(p1, p2 = v2)","<p>Reads a DER or PEM encoded string from <em>string</em> or <em>io</em> and returns an instance of the appropriate PKey class. …\n"],["read_nonblock","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-read_nonblock","(maxlen, buf=nil, exception: true)","<p>Reads at most <em>maxlen</em> bytes in the non-blocking manner.\n<p>When no data can be read without blocking it raises …\n"],["read_smime","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-c-read_smime","(p1)",""],["readchar","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-readchar","()","<p>Reads a one-character string from the stream. Raises an EOFError at end of file.\n"],["readline","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-readline","(eol=$/)","<p>Reads a line from the stream which is separated by <em>eol</em>.\n<p>Raises EOFError if at end of file.\n"],["readlines","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-readlines","(eol=$/)","<p>Reads lines from the stream which are separated by <em>eol</em>.\n<p>See also #gets\n"],["readpartial","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-readpartial","(maxlen, buf=nil)","<p>Reads at most <em>maxlen</em> bytes from the stream. If <em>buf</em> is provided it must reference a string which will …\n"],["recipients","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-recipients","()",""],["register","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-c-register","(p1, p2, p3)","<p>This adds a new ObjectId to the internal tables. Where <em>object_id</em> is the numerical form, <em>short_name</em> is …\n"],["reset","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-reset","()","<p>Fully resets the internal state of the Cipher. By using this, the same Cipher instance may be used several …\n"],["reset","OpenSSL::Digest","OpenSSL/Digest.html#method-i-reset","()","<p>Resets the Digest in the sense that any Digest#update that has been performed is abandoned and the Digest …\n"],["reset","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-reset","()","<p>Returns <em>hmac</em> as it was when it was first initialized, with all processed data cleared from it.\n<p>Example …\n"],["responses","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-responses","()","<p>Returns an Array of SingleResponse for this BasicResponse.\n"],["revocation_reason","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-revocation_reason","()",""],["revocation_time","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-revocation_time","()",""],["revoked","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-revoked","()",""],["revoked=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-revoked-3D","(p1)",""],["rshift!","OpenSSL::BN","OpenSSL/BN.html#method-i-rshift-21","(p1)",""],["scan","OpenSSL::X509::Name::RFC2253DN","OpenSSL/X509/Name/RFC2253DN.html#method-i-scan","(dn)",""],["scrypt","OpenSSL::KDF","OpenSSL/KDF.html#method-c-scrypt","(p1, p2 = {})","<p>Derives a key from <em>pass</em> using given parameters with the scrypt password-based key derivation function. …\n"],["sections","OpenSSL::Config","OpenSSL/Config.html#method-i-sections","()","<p>Get the names of all sections in the current configuration\n"],["secure_compare","OpenSSL","OpenSSL.html#method-c-secure_compare","(a, b)","<p>Constant time memory comparison. Inputs are hashed using SHA-256 to mask the length of the secret. Returns …\n"],["security_level","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-security_level","()","<p>Returns the security level for the context.\n<p>See also OpenSSL::SSL::SSLContext#security_level=.\n"],["security_level=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-security_level-3D","(p1)","<p>Sets the security level for the context. OpenSSL limits parameters according to the level. The “parameters” …\n"],["seed","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-seed","()","<p>See the OpenSSL documentation for EC_GROUP_get0_seed()\n"],["seed","OpenSSL::Random","OpenSSL/Random.html#method-c-seed","(p1)","<p>::seed is equivalent to ::add where <em>entropy</em> is length of <em>str</em>.\n"],["seed=","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-seed-3D","(p1)","<p>See the OpenSSL documentation for EC_GROUP_set_seed()\n"],["serial","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-serial","()","<p>Returns the serial number of the certificate for which status is being requested.\n"],["serial","OpenSSL::PKCS7::RecipientInfo","OpenSSL/PKCS7/RecipientInfo.html#method-i-serial","()",""],["serial","OpenSSL::PKCS7::SignerInfo","OpenSSL/PKCS7/SignerInfo.html#method-i-serial","()",""],["serial","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-serial","()",""],["serial","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-serial","()",""],["serial=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-serial-3D","(p1)",""],["serial=","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-serial-3D","(p1)",""],["serial_number","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-serial_number","()","<p>Returns serial number of the timestamp token. This value shall never be the same for two timestamp tokens …\n"],["session","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-session","()","<p>Returns the SSLSession object currently used, or nil if the session is not established.\n"],["session=","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-session-3D","(p1)","<p>Sets the Session to be used when the connection is established.\n"],["session_add","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_add","(p1)","<p>Adds <em>session</em> to the session cache.\n"],["session_cache_mode","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_cache_mode","()","<p>The current session cache mode.\n"],["session_cache_mode=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_cache_mode-3D","(p1)","<p>Sets the SSL session cache mode. Bitwise-or together the desired SESSION_CACHE_* constants to set. …\n"],["session_cache_size","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_cache_size","()","<p>Returns the current session cache size. Zero is used to represent an unlimited cache size.\n"],["session_cache_size=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_cache_size-3D","(p1)","<p>Sets the session cache size. Returns the previously valid session cache size. Zero is used to represent …\n"],["session_cache_stats","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_cache_stats","()","<p>Returns a Hash containing the following keys:\n<p>:accept — Number of started SSL/TLS handshakes in server mode …\n"],["session_remove","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_remove","(p1)","<p>Removes <em>session</em> from the session cache.\n"],["session_reused?","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-session_reused-3F","()","<p>Returns <code>true</code> if a reused session was negotiated during the handshake.\n"],["set_bit!","OpenSSL::BN","OpenSSL/BN.html#method-i-set_bit-21","(p1)",""],["set_crt_params","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-set_crt_params","(p1, p2, p3)","<p>Sets <em>dmp1</em>, <em>dmq1</em>, <em>iqmp</em> for the RSA instance. They are calculated by <code>d mod (p - 1)</code>, <code>d mod (q - 1)</code> and …\n"],["set_default","OpenSSL::Engine","OpenSSL/Engine.html#method-i-set_default","(p1)","<p>Set the defaults for this engine with the given <em>flag</em>.\n<p>These flags are used to control combinations of …\n"],["set_default_paths","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-set_default_paths","()","<p>Configures <em>store</em> to look up CA certificates from the system default certificate store as needed basis. …\n"],["set_factors","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-set_factors","(p1, p2)","<p>Sets <em>p</em>, <em>q</em> for the RSA instance.\n"],["set_generator","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-set_generator","(p1, p2, p3)","<p>Sets the curve parameters. <em>generator</em> must be an instance of EC::Point that is on the curve. <em>order</em> and …\n"],["set_key","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-set_key","(p1, p2)","<p>Sets <em>pub_key</em> and <em>priv_key</em> for the DH instance. <em>priv_key</em> may be <code>nil</code>.\n"],["set_key","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-set_key","(p1, p2)","<p>Sets <em>pub_key</em> and <em>priv_key</em> for the DSA instance. <em>priv_key</em> may be <code>nil</code>.\n"],["set_key","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-set_key","(p1, p2, p3)","<p>Sets <em>n</em>, <em>e</em>, <em>d</em> for the RSA instance.\n"],["set_params","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-set_params","(params={})","<p>Sets saner defaults optimized for the use with HTTP-like protocols.\n<p>If a Hash <em>params</em> is given, the parameters …\n"],["set_pqg","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-set_pqg","(p1, p2, p3)","<p>Sets <em>p</em>, <em>q</em>, <em>g</em> to the DH instance.\n"],["set_pqg","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-set_pqg","(p1, p2, p3)","<p>Sets <em>p</em>, <em>q</em>, <em>g</em> to the DSA instance.\n"],["set_to_infinity!","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-set_to_infinity-21","()",""],["setsockopt","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-setsockopt","(level, optname, optval)",""],["setup","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-setup","()","<p>This method is called automatically when a new SSLSocket is created. However, it is not thread-safe and …\n"],["short_name","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-short_name","()",""],["shutdown","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-i-shutdown","(how=Socket::SHUT_RDWR)","<p>See BasicSocket#shutdown for details.\n"],["sign","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-sign","(p1, p2)","<p>Parameters\n<p><em>key</em> - the private key to be used for signing this instance\n<p><em>digest</em> - the digest to be used for …\n"],["sign","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-sign","(p1, p2, p3 = v3, p4 = v4, p5 = v5)","<p>Signs this OCSP response using the <em>cert</em>, <em>key</em> and optional <em>digest</em>. This behaves in the similar way as …\n"],["sign","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-sign","(p1, p2, p3 = v3, p4 = v4, p5 = v5)","<p>Signs this OCSP request using <em>cert</em>, <em>key</em> and optional <em>digest</em>. If <em>digest</em> is not specified, SHA-1 is used. …\n"],["sign","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-c-sign","(p1, p2, p3, p4 = v4, p5 = v5)",""],["sign","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-sign","(p1, p2)","<p>To sign the String <em>data</em>, <em>digest</em>, an instance of OpenSSL::Digest, must be provided. The return value is …\n"],["sign","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-sign","(p1, p2)",""],["sign","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-sign","(p1, p2)",""],["sign","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-sign","(p1, p2)",""],["sign_pss","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-sign_pss","(p1, p2, p3 = {})","<p>Signs <em>data</em> using the Probabilistic Signature Scheme (RSA-PSS) and returns the calculated signature.\n<p>RSAError …\n"],["signature_algorithm","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-signature_algorithm","()",""],["signature_algorithm","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-signature_algorithm","()",""],["signature_algorithm","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-signature_algorithm","()",""],["signed?","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-signed-3F","()","<p>Returns <code>true</code> if the request is signed, <code>false</code> otherwise. Note that the validity of the signature is <strong>not</strong> …\n"],["signed_time","OpenSSL::PKCS7::SignerInfo","OpenSSL/PKCS7/SignerInfo.html#method-i-signed_time","()",""],["signers","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-signers","()",""],["sn","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-sn","()","<p>The short name of the ObjectId, as defined in <openssl/objects.h>.\n"],["sqr","OpenSSL::BN","OpenSSL/BN.html#method-i-sqr","()",""],["ssl_version","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-ssl_version","()","<p>Returns a String representing the SSL/TLS version that was negotiated for the connection, for example …\n"],["ssl_version=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-ssl_version-3D","(meth)","<p>Sets the SSL/TLS protocol version for the context. This forces connections to use only the specified …\n"],["state","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-state","()","<p>A description of the current connection state. This is for diagnostic purposes only.\n"],["status","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-status","()","<p>Returns an Array of statuses for this response. Each status contains a CertificateId, the status (0 …\n"],["status","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-i-status","()","<p>Returns the status of the response.\n"],["status","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-status","()","<p>Returns one of GRANTED, GRANTED_WITH_MODS, REJECTION, WAITING, REVOCATION_WARNING or REVOCATION_NOTIFICATION …\n"],["status?","OpenSSL::Random","OpenSSL/Random.html#method-c-status-3F","()","<p>Return <code>true</code> if the PRNG has been seeded with enough data, <code>false</code> otherwise.\n"],["status_string","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-i-status_string","()","<p>Returns a status string for the response.\n"],["status_text","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-status_text","()","<p>In cases of failure this field may contain an array of strings further describing the origin of the failure. …\n"],["subject","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-subject","()",""],["subject","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-subject","()",""],["subject=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-subject-3D","(p1)",""],["subject=","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-subject-3D","(p1)",""],["subject_certificate=","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-subject_certificate-3D","(p1)",""],["subject_key_identifier","OpenSSL::X509::Extension::SubjectKeyIdentifier","OpenSSL/X509/Extension/SubjectKeyIdentifier.html#method-i-subject_key_identifier","()","<p>Get the subject's key identifier from the subjectKeyIdentifier exteension, as described in RFC5280 …\n"],["subject_request=","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-subject_request-3D","(p1)",""],["sysclose","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-sysclose","()","<p>Sends “close notify” to the peer and tries to shut down the SSL connection gracefully.\n<p>If sync_close …\n"],["sysread","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-sysread","(*args)","<p>Reads <em>length</em> bytes from the SSL connection. If a pre-allocated <em>buffer</em> is provided the data will be written …\n"],["syssign","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-syssign","(p1)","<p>Computes and returns the DSA signature of <em>string</em>, where <em>string</em> is expected to be an already-computed …\n"],["sysverify","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-sysverify","(p1, p2)","<p>Verifies whether the signature is valid given the message digest input. It does so by validating <em>sig</em> …\n"],["syswrite","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-syswrite","(p1)","<p>Writes <em>string</em> to the SSL connection.\n"],["this_update","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-this_update","()",""],["time","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-time","()","<p>Returns the time at which the session was established.\n"],["time","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-time","()",""],["time=","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-time-3D","(p1)","<p>Sets start time of the session. Time resolution is in seconds.\n"],["time=","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-time-3D","(p1)",""],["time=","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-time-3D","(p1)","<p>Sets the time to be used in verifications.\n"],["time=","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-time-3D","(p1)","<p>Sets the time used in the verification. If not set, the current time is used.\n"],["timeout","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-timeout","()","<p>Returns the timeout value set for the session, in seconds from the established time.\n"],["timeout=","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-timeout-3D","(p1)","<p>Sets how long until the session expires in seconds.\n"],["tmp_key","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-tmp_key","()","<p>Returns the ephemeral key used in case of forward secrecy cipher.\n"],["to_a","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-to_a","()",""],["to_a","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-to_a","()","<p>Returns an Array representation of the distinguished name suitable for passing to ::new\n"],["to_bn","Integer","Integer.html#method-i-to_bn","()","<p>Casts an Integer as an OpenSSL::BN\n<p>See `man bn` for more info.\n"],["to_bn","OpenSSL::BN","OpenSSL/BN.html#method-i-to_bn","()",""],["to_bn","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-to_bn","(conversion_form = group.point_conversion_form)","<p>Returns the octet string representation of the EC point as an instance of OpenSSL::BN.\n<p>If <em>conversion_form</em> …\n"],["to_der","OpenSSL::ASN1::ASN1Data","OpenSSL/ASN1/ASN1Data.html#method-i-to_der","()","<p>Encodes this ASN1Data into a DER-encoded String value. The result is DER-encoded except for the possibility …\n"],["to_der","OpenSSL::ASN1::Constructive","OpenSSL/ASN1/Constructive.html#method-i-to_der","()","<p>See ASN1Data#to_der for details.\n"],["to_der","OpenSSL::ASN1::Primitive","OpenSSL/ASN1/Primitive.html#method-i-to_der","()","<p>See ASN1Data#to_der for details.\n"],["to_der","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-to_der","()","<p>Returns the DER encoding of this SPKI.\n"],["to_der","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-to_der","()","<p>Encodes this basic response into a DER-encoded string.\n"],["to_der","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-to_der","()","<p>Encodes this certificate identifier into a DER-encoded string.\n"],["to_der","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-to_der","()","<p>Returns this request as a DER-encoded string\n"],["to_der","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-i-to_der","()","<p>Returns this response as a DER-encoded string.\n"],["to_der","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-to_der","()","<p>Encodes this SingleResponse into a DER-encoded string.\n"],["to_der","OpenSSL::PKCS12","OpenSSL/PKCS12.html#method-i-to_der","()",""],["to_der","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-to_der","()",""],["to_der","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-to_der","()","<p>Encodes this DH to its DER encoding. Note that any existing per-session public/private keys will <strong>not</strong> …\n"],["to_der","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-to_der","()","<p>Encodes this DSA to its DER encoding.\n"],["to_der","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-to_der","()","<p>See the OpenSSL documentation for i2d_ECPrivateKey_bio()\n"],["to_der","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-to_der","()","<p>See the OpenSSL documentation for i2d_ECPKParameters_bio()\n"],["to_der","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-to_der","()","<p>Outputs this keypair in DER encoding.\n"],["to_der","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-to_der","()","<p>Returns an ASN1 encoded String that contains the Session object.\n"],["to_der","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-to_der","()","<p>DER-encodes this Request.\n"],["to_der","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-to_der","()","<p>Returns the Response in DER-encoded form.\n"],["to_der","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-to_der","()","<p>Returns the TokenInfo in DER-encoded form.\n"],["to_der","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-to_der","()",""],["to_der","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-to_der","()",""],["to_der","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-to_der","()",""],["to_der","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-to_der","()",""],["to_der","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-to_der","()","<p>Converts the name to DER encoding\n"],["to_der","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-to_der","()",""],["to_der","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-to_der","()",""],["to_h","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-to_h","()",""],["to_i","OpenSSL::BN","OpenSSL/BN.html#method-i-to_i","()",""],["to_int","OpenSSL::BN","OpenSSL/BN.html#method-i-to_int","()",""],["to_io","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-i-to_io","()","<p>Returns the TCPServer passed to the SSLServer when initialized.\n"],["to_octet_string","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-to_octet_string","(p1)","<p>Returns the octet string representation of the elliptic curve point.\n<p><em>conversion_form</em> specifies how the …\n"],["to_pem","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-to_pem","()","<p>Returns the PEM encoding of this SPKI.\n"],["to_pem","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-to_pem","()",""],["to_pem","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-to_pem","()",""],["to_pem","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-to_pem","(p1 = v1, p2 = v2)",""],["to_pem","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-to_pem","(p1 = v1, p2 = v2)",""],["to_pem","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-to_pem","()","<p>See the OpenSSL documentation for PEM_write_bio_ECPKParameters()\n"],["to_pem","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-to_pem","(p1 = v1, p2 = v2)",""],["to_pem","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-to_pem","()","<p>Returns a PEM encoded String that contains the Session object.\n"],["to_pem","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-to_pem","()",""],["to_pem","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-to_pem","()",""],["to_pem","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-to_pem","()",""],["to_s","OpenSSL::BN","OpenSSL/BN.html#method-i-to_s","(p1 = v1)","<p>Parameters\n<p><em>base</em> - Integer Valid values:\n<p>0 - MPI\n"],["to_s","OpenSSL::Config","OpenSSL/Config.html#method-i-to_s","()","<p>Get the parsable form of the current configuration\n<p>Given the following configuration being created:\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">config</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["to_s","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-to_s","()",""],["to_s","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-to_s","()",""],["to_s","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-to_s","()",""],["to_s","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-to_s","()",""],["to_s","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-to_s","(p1 = v1, p2 = v2)",""],["to_s","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-to_s","(p1 = v1, p2 = v2)",""],["to_s","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-to_s","()",""],["to_s","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-to_s","()",""],["to_s","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-to_s","()",""],["to_s","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-to_s","(*args)","<p>Returns a String representation of the Distinguished Name. <em>format</em> is one of:\n<p>OpenSSL::X509::Name::COMPAT …\n"],["to_s","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-to_s","()",""],["to_text","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-to_text","()","<p>Returns a textual representation of this SPKI, useful for debugging purposes.\n"],["to_text","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-to_text","()","<p>Prints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) …\n"],["to_text","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-to_text","()","<p>Prints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don't use :-)) …\n"],["to_text","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-to_text","()","<p>See the OpenSSL documentation for EC_KEY_print()\n"],["to_text","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-to_text","()","<p>See the OpenSSL documentation for ECPKParameters_print()\n"],["to_text","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-to_text","()","<p>THIS METHOD IS INSECURE, PRIVATE INFORMATION CAN LEAK OUT!!!\n<p>Dumps all parameters of a keypair to a String …\n"],["to_text","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-to_text","()","<p>Shows everything in the Session object. This is for diagnostic purposes.\n"],["to_text","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-to_text","()",""],["to_text","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-to_text","()",""],["to_text","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-to_text","()",""],["to_utf8","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-to_utf8","()","<p>Returns an UTF-8 representation of the distinguished name, as specified in RFC 2253.\n"],["token","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-token","()","<p>If a timestamp token is present, this returns it in the form of a OpenSSL::PKCS7.\n"],["token_info","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-token_info","()","<p>Get the response's token info if present.\n"],["traverse","OpenSSL::ASN1","OpenSSL/ASN1.html#method-c-traverse","(p1)","<p>If a block is given, it prints out each of the elements encountered. Block parameters are (in that order): …\n"],["trust=","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-trust-3D","(p1)",""],["trust=","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-trust-3D","(p1)",""],["tsa_certificate","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-tsa_certificate","()","<p>If the Request specified to request the TSA certificate (Request#cert_requested = true), then this field …\n"],["type","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-type","()",""],["type=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-type-3D","(p1)",""],["ucmp","OpenSSL::BN","OpenSSL/BN.html#method-i-ucmp","(p1)",""],["ungetc","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-ungetc","(c)","<p>Pushes character <em>c</em> back onto the stream such that a subsequent buffered character read will return it. …\n"],["update","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-update","(p1, p2 = v2)","<p>Encrypts data in a streaming fashion. Hand consecutive blocks of data to the #update method in order …\n"],["update","OpenSSL::Digest","OpenSSL/Digest.html#method-i-update","(p1)","<p>Not every message digest can be computed in one single pass. If a message digest is to be computed from …\n"],["update","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-update","(p1)","<p>Returns <em>hmac</em> updated with the message to be authenticated. Can be called repeatedly with chunks of the …\n"],["value","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-value","()",""],["value","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-value","()",""],["value=","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-value-3D","(p1)",""],["value=","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-value-3D","(p1)",""],["value_der","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-value_der","()",""],["verify","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-verify","(p1)","<p>Parameters\n<p><em>key</em> - the public key to be used for verifying the SPKI signature\n\n<p>Returns <code>true</code> if the signature …\n"],["verify","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-verify","(p1, p2, p3 = v3)","<p>Verifies the signature of the response using the given <em>certificates</em> and <em>store</em>. This works in the similar …\n"],["verify","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-verify","(p1, p2, p3 = v3)","<p>Verifies this request using the given <em>certificates</em> and <em>store</em>. <em>certificates</em> is an array of OpenSSL::X509::Certificate …\n"],["verify","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-verify","(p1, p2, p3 = v3, p4 = v4)",""],["verify","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-verify","(p1, p2, p3)","<p>To verify the String <em>signature</em>, <em>digest</em>, an instance of OpenSSL::Digest, must be provided to re-compute …\n"],["verify","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-verify","(p1, p2, p3 = v3)","<p>Verifies a timestamp token by checking the signature, validating the certificate chain implied by tsa_certificate …\n"],["verify","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-verify","(p1)",""],["verify","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-verify","(p1)","<p>Verifies the signature of the certificate, with the public key <em>key</em>. <em>key</em> must be an instance of OpenSSL::PKey …\n"],["verify","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-verify","(p1)","<p>Checks that cert signature is made with PRIVversion of this PUBLIC 'key'\n"],["verify","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-verify","(p1, p2 = v2)","<p>Performs a certificate verification on the OpenSSL::X509::Certificate <em>cert</em>.\n<p><em>chain</em> can be an array of …\n"],["verify","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-verify","()",""],["verify_callback=","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-verify_callback-3D","(p1)","<p>General callback for OpenSSL verify\n"],["verify_certificate_identity","OpenSSL::SSL","OpenSSL/SSL.html#method-c-verify_certificate_identity","(cert, hostname)",""],["verify_pss","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-verify_pss","(p1, p2, p3, p4 = {})","<p>Verifies <em>data</em> using the Probabilistic Signature Scheme (RSA-PSS).\n<p>The return value is <code>true</code> if the signature …\n"],["verify_result","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-verify_result","()","<p>Returns the result of the peer certificates verification. See verify(1) for error values and descriptions. …\n"],["version","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-version","()","<p>Returns the version of this request. <code>1</code> is the default value.\n"],["version","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-version","()","<p>Returns the version number of the token info. With compliant servers, this value should be <code>1</code> if present. …\n"],["version","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-version","()",""],["version","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-version","()",""],["version","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-version","()",""],["version=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-version-3D","(p1)","<p>Sets the version number for this Request. This should be <code>1</code> for compliant servers.\n"],["version=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-version-3D","(p1)",""],["version=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-version-3D","(p1)",""],["version=","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-version-3D","(p1)",""],["write","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-write","(*s)","<p>Writes <em>s</em> to the stream. If the argument is not a String it will be converted using <code>.to_s</code> method. Returns …\n"],["write_nonblock","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-write_nonblock","(s, exception: true)","<p>Writes <em>s</em> in the non-blocking manner.\n<p>If there is buffered data, it is flushed first. This may block. …\n"],["write_random_file","OpenSSL::Random","OpenSSL/Random.html#method-c-write_random_file","(p1)","<p>Writes a number of random generated bytes (currently 1024) to <em>filename</em> which can be used to initialize …\n"],["write_smime","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-c-write_smime","(p1, p2 = v2, p3 = v3)",""],["zero?","OpenSSL::BN","OpenSSL/BN.html#method-i-zero-3F","()",""],["CONTRIBUTING","","CONTRIBUTING_md.html","","<p>Contributing to Ruby OpenSSL\n<p>Thank you for your interest in contributing to Ruby OpenSSL!\n<p>This documentation …\n"],["History","","History_md.html","","<p>Version 2.2.0\n<p>Compatibility notes\n<p>Remove unsupported MDC2, DSS, DSS1, and SHA algorithms.\n"],["README","","README_md.html","","<p>OpenSSL for Ruby\n<p><img src=\"https://github.com/ruby/openssl/workflows/CI/badge.svg\">\n<p>OpenSSL provides SSL …\n"]]}}
\ No newline at end of file +var search_data = {"index":{"searchIndex":["io","waitreadable","waitwritable","integer","openssl","asn1","asn1data","asn1error","constructive","objectid","primitive","bn","bnerror","buffering","buffer","cipher","cipher","ciphererror","config","configerror","digest","digesterror","engine","engineerror","extconfig","hmac","hmacerror","kdf","kdferror","marshal","classmethods","netscape","spki","spkierror","ocsp","basicresponse","certificateid","ocsperror","request","response","singleresponse","opensslerror","pkcs12","pkcs12error","pkcs5","pkcs7","pkcs7error","recipientinfo","signerinfo","pkey","dh","dherror","dsa","dsaerror","ec","group","error","point","error","ecerror","pkey","pkeyerror","rsa","rsaerror","random","randomerror","ssl","sslcontext","sslerror","sslerrorwaitreadable","sslerrorwaitwritable","sslserver","sslsocket","session","sessionerror","socketforwarder","timestamp","factory","request","response","timestamperror","tokeninfo","x509","attribute","attributeerror","crl","crlerror","certificate","certificateerror","extension","authorityinfoaccess","authoritykeyidentifier","crldistributionpoints","helpers","subjectkeyidentifier","extensionerror","extensionfactory","name","rfc2253dn","nameerror","request","requesterror","revoked","revokederror","store","storecontext","storeerror","%()","*()","**()","+()","+@()","-()","-@()","/()","<<()","<<()","<<()","<<()","<<()","<=>()","<=>()","==()","==()","==()","==()","==()","==()","==()","==()","==()","==()","==()","==()","===()",">>()","digest()","[]()","[]=()","_dump()","_load()","accept()","accept()","accept_nonblock()","add()","add_attribute()","add_cert()","add_certid()","add_certificate()","add_certificate()","add_crl()","add_crl()","add_data()","add_entry()","add_extension()","add_extension()","add_extension()","add_file()","add_nonce()","add_nonce()","add_path()","add_recipient()","add_revoked()","add_signer()","add_status()","add_value()","addr()","algorithm()","algorithm()","algorithm=()","alpn_protocol()","asn1_flag()","asn1_flag=()","attributes()","attributes=()","auth_data=()","auth_tag()","auth_tag=()","auth_tag_len=()","authenticated?()","authority_key_identifier()","basic()","bit_set?()","blinding_off!()","blinding_on!()","block_length()","block_size()","builtin_curves()","by_id()","ca_issuer_uris()","ccm_data_len=()","cert()","cert_requested=()","cert_requested?()","cert_status()","certid()","certid()","certificates()","certificates=()","chain()","challenge()","challenge=()","check_key()","check_nonce()","check_private_key()","check_validity()","cipher()","cipher()","cipher=()","ciphers()","ciphers()","ciphers=()","cleanup()","cleanup()","clear_bit!()","client_ca()","close()","close()","closed?()","cmds()","cmp()","cmp()","cmp()","cmp_issuer()","coerce()","cofactor()","compute_key()","concat()","connect()","connect_nonblock()","copy()","copy_nonce()","create()","create()","create_ext()","create_ext_from_array()","create_ext_from_hash()","create_ext_from_string()","create_extension()","create_timestamp()","critical=()","critical?()","crl=()","crl_uris()","crls()","crls=()","ctrl_cmd()","current_cert()","current_crl()","curve_name()","data=()","debug()","debug=()","decode()","decode_all()","decrypt()","decrypt()","degree()","detached()","detached=()","detached?()","dh_compute_key()","digest()","digest()","digest()","digest()","digest_length()","do_not_reverse_lookup=()","dsa_sign_asn1()","dsa_verify_asn1()","each()","each()","each()","each_byte()","each_line()","ecdh_curves=()","egd()","egd_bytes()","enable_fallback_scsv()","enc_key()","encrypt()","encrypt()","engines()","eof()","eof?()","eql?()","eql?()","eql?()","eql?()","error()","error=()","error_depth()","error_string()","errors()","expand_hexstring()","expand_pair()","expand_value()","export()","export()","export()","export()","extensions()","extensions()","extensions()","extensions()","extensions=()","extensions=()","extensions=()","failure_info()","fcntl()","fileno()","final()","find_extension()","find_response()","finish()","finished_message()","fips_mode()","fips_mode=()","fixed_length_secure_compare()","flags=()","flags=()","flush()","flush_sessions()","freeze()","gcd()","gen_time()","generate()","generate()","generate()","generate()","generate_key()","generate_key!()","generate_key!()","generate_prime()","generator()","get_value()","getc()","gets()","getsockopt()","group()","group=()","hash()","hash()","hash_algorithm()","hash_old()","hexdigest()","hexdigest()","hkdf()","hostname=()","id()","id()","included()","infinity?()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","initialize_copy()","inspect()","inspect()","inspect()","inspect()","inspect()","invert!()","issuer()","issuer()","issuer()","issuer()","issuer=()","issuer=()","issuer_certificate=()","issuer_key_hash()","issuer_name_hash()","iv=()","iv_len()","iv_len=()","key=()","key_len()","key_len=()","last_update()","last_update=()","listen()","ln()","load()","load_private_key()","load_public_key()","load_random_file()","long_name()","lshift!()","make_affine!()","max_version=()","mem_check_start()","message_imprint()","message_imprint()","message_imprint=()","min_version=()","mod_add()","mod_exp()","mod_inverse()","mod_mul()","mod_sqr()","mod_sub()","mul()","name()","name()","name()","negative?()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","next_update()","next_update()","next_update=()","nonce()","nonce()","nonce=()","not_after()","not_after=()","not_before()","not_before=()","npn_protocol()","num_bits()","num_bytes()","ocsp_uris()","odd?()","oid()","oid()","oid()","oid()","oid=()","oid=()","on_curve?()","one?()","options()","options=()","order()","ordering()","padding=()","params()","params()","params()","params_ok?()","parse()","parse()","parse_config()","parse_openssl()","parse_rfc2253()","pbkdf2_hmac()","pbkdf2_hmac()","pbkdf2_hmac_sha1()","peer_cert()","peer_cert_chain()","peer_finished_message()","peeraddr()","pending()","pkcs5_keyivgen()","point_conversion_form()","point_conversion_form=()","policy_id()","policy_id()","policy_id=()","post_connection_check()","pretty_print()","pretty_print()","pretty_print()","prime?()","prime_fasttest?()","print()","print_mem_leaks()","printf()","private?()","private?()","private?()","private?()","private_decrypt()","private_encrypt()","private_key()","private_key=()","private_key?()","private_to_der()","private_to_pem()","public?()","public?()","public?()","public?()","public_decrypt()","public_encrypt()","public_key()","public_key()","public_key()","public_key()","public_key()","public_key()","public_key()","public_key=()","public_key=()","public_key=()","public_key=()","public_key?()","public_to_der()","public_to_pem()","purpose=()","purpose=()","puts()","random_add()","random_bytes()","random_iv()","random_key()","read()","read()","read_nonblock()","read_smime()","readchar()","readline()","readlines()","readpartial()","recipients()","register()","reset()","reset()","reset()","responses()","revocation_reason()","revocation_time()","revoked()","revoked=()","rshift!()","scan()","scrypt()","sections()","secure_compare()","security_level()","security_level=()","seed()","seed()","seed=()","serial()","serial()","serial()","serial()","serial()","serial=()","serial=()","serial_number()","session()","session=()","session_add()","session_cache_mode()","session_cache_mode=()","session_cache_size()","session_cache_size=()","session_cache_stats()","session_remove()","session_reused?()","set_bit!()","set_crt_params()","set_default()","set_default_paths()","set_factors()","set_generator()","set_key()","set_key()","set_key()","set_params()","set_pqg()","set_pqg()","set_to_infinity!()","setsockopt()","setup()","short_name()","shutdown()","sign()","sign()","sign()","sign()","sign()","sign()","sign()","sign()","sign_pss()","signature_algorithm()","signature_algorithm()","signature_algorithm()","signed?()","signed_time()","signers()","sn()","sqr()","ssl_version()","ssl_version=()","state()","status()","status()","status()","status?()","status_string()","status_text()","subject()","subject()","subject=()","subject=()","subject_certificate=()","subject_key_identifier()","subject_request=()","sysclose()","sysread()","syssign()","sysverify()","syswrite()","this_update()","time()","time()","time=()","time=()","time=()","time=()","timeout()","timeout=()","tmp_key()","to_a()","to_a()","to_bn()","to_bn()","to_bn()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_der()","to_h()","to_i()","to_int()","to_io()","to_octet_string()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_pem()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_s()","to_text()","to_text()","to_text()","to_text()","to_text()","to_text()","to_text()","to_text()","to_text()","to_text()","to_utf8()","token()","token_info()","traverse()","trust=()","trust=()","tsa_certificate()","type()","type=()","ucmp()","ungetc()","update()","update()","update()","value()","value()","value=()","value=()","value_der()","verify()","verify()","verify()","verify()","verify()","verify()","verify()","verify()","verify()","verify()","verify()","verify_callback=()","verify_certificate_identity()","verify_pss()","verify_result()","version()","version()","version()","version()","version()","version=()","version=()","version=()","version=()","write()","write_nonblock()","write_random_file()","write_smime()","zero?()","contributing","history","readme"],"longSearchIndex":["io","io::waitreadable","io::waitwritable","integer","openssl","openssl::asn1","openssl::asn1::asn1data","openssl::asn1::asn1error","openssl::asn1::constructive","openssl::asn1::objectid","openssl::asn1::primitive","openssl::bn","openssl::bnerror","openssl::buffering","openssl::buffering::buffer","openssl::cipher","openssl::cipher::cipher","openssl::cipher::ciphererror","openssl::config","openssl::configerror","openssl::digest","openssl::digest::digesterror","openssl::engine","openssl::engine::engineerror","openssl::extconfig","openssl::hmac","openssl::hmacerror","openssl::kdf","openssl::kdf::kdferror","openssl::marshal","openssl::marshal::classmethods","openssl::netscape","openssl::netscape::spki","openssl::netscape::spkierror","openssl::ocsp","openssl::ocsp::basicresponse","openssl::ocsp::certificateid","openssl::ocsp::ocsperror","openssl::ocsp::request","openssl::ocsp::response","openssl::ocsp::singleresponse","openssl::opensslerror","openssl::pkcs12","openssl::pkcs12::pkcs12error","openssl::pkcs5","openssl::pkcs7","openssl::pkcs7::pkcs7error","openssl::pkcs7::recipientinfo","openssl::pkcs7::signerinfo","openssl::pkey","openssl::pkey::dh","openssl::pkey::dherror","openssl::pkey::dsa","openssl::pkey::dsaerror","openssl::pkey::ec","openssl::pkey::ec::group","openssl::pkey::ec::group::error","openssl::pkey::ec::point","openssl::pkey::ec::point::error","openssl::pkey::ecerror","openssl::pkey::pkey","openssl::pkey::pkeyerror","openssl::pkey::rsa","openssl::pkey::rsaerror","openssl::random","openssl::random::randomerror","openssl::ssl","openssl::ssl::sslcontext","openssl::ssl::sslerror","openssl::ssl::sslerrorwaitreadable","openssl::ssl::sslerrorwaitwritable","openssl::ssl::sslserver","openssl::ssl::sslsocket","openssl::ssl::session","openssl::ssl::session::sessionerror","openssl::ssl::socketforwarder","openssl::timestamp","openssl::timestamp::factory","openssl::timestamp::request","openssl::timestamp::response","openssl::timestamp::timestamperror","openssl::timestamp::tokeninfo","openssl::x509","openssl::x509::attribute","openssl::x509::attributeerror","openssl::x509::crl","openssl::x509::crlerror","openssl::x509::certificate","openssl::x509::certificateerror","openssl::x509::extension","openssl::x509::extension::authorityinfoaccess","openssl::x509::extension::authoritykeyidentifier","openssl::x509::extension::crldistributionpoints","openssl::x509::extension::helpers","openssl::x509::extension::subjectkeyidentifier","openssl::x509::extensionerror","openssl::x509::extensionfactory","openssl::x509::name","openssl::x509::name::rfc2253dn","openssl::x509::nameerror","openssl::x509::request","openssl::x509::requesterror","openssl::x509::revoked","openssl::x509::revokederror","openssl::x509::store","openssl::x509::storecontext","openssl::x509::storeerror","openssl::bn#%()","openssl::bn#*()","openssl::bn#**()","openssl::bn#+()","openssl::bn#+@()","openssl::bn#-()","openssl::bn#-@()","openssl::bn#/()","openssl::bn#<<()","openssl::buffering#<<()","openssl::buffering::buffer#<<()","openssl::digest#<<()","openssl::hmac#<<()","openssl::bn#<=>()","openssl::x509::name#<=>()","openssl::asn1::objectid#==()","openssl::bn#==()","openssl::hmac#==()","openssl::pkey::ec::group#==()","openssl::pkey::ec::point#==()","openssl::ssl::session#==()","openssl::x509::attribute#==()","openssl::x509::crl#==()","openssl::x509::certificate#==()","openssl::x509::extension#==()","openssl::x509::request#==()","openssl::x509::revoked#==()","openssl::bn#===()","openssl::bn#>>()","openssl::digest()","openssl::config#[]()","openssl::config#[]=()","openssl::marshal#_dump()","openssl::marshal::classmethods#_load()","openssl::ssl::sslserver#accept()","openssl::ssl::sslsocket#accept()","openssl::ssl::sslsocket#accept_nonblock()","openssl::pkey::ec::point#add()","openssl::x509::request#add_attribute()","openssl::x509::store#add_cert()","openssl::ocsp::request#add_certid()","openssl::pkcs7#add_certificate()","openssl::ssl::sslcontext#add_certificate()","openssl::pkcs7#add_crl()","openssl::x509::store#add_crl()","openssl::pkcs7#add_data()","openssl::x509::name#add_entry()","openssl::x509::crl#add_extension()","openssl::x509::certificate#add_extension()","openssl::x509::revoked#add_extension()","openssl::x509::store#add_file()","openssl::ocsp::basicresponse#add_nonce()","openssl::ocsp::request#add_nonce()","openssl::x509::store#add_path()","openssl::pkcs7#add_recipient()","openssl::x509::crl#add_revoked()","openssl::pkcs7#add_signer()","openssl::ocsp::basicresponse#add_status()","openssl::config#add_value()","openssl::ssl::socketforwarder#addr()","openssl::timestamp::request#algorithm()","openssl::timestamp::tokeninfo#algorithm()","openssl::timestamp::request#algorithm=()","openssl::ssl::sslsocket#alpn_protocol()","openssl::pkey::ec::group#asn1_flag()","openssl::pkey::ec::group#asn1_flag=()","openssl::x509::request#attributes()","openssl::x509::request#attributes=()","openssl::cipher#auth_data=()","openssl::cipher#auth_tag()","openssl::cipher#auth_tag=()","openssl::cipher#auth_tag_len=()","openssl::cipher#authenticated?()","openssl::x509::extension::authoritykeyidentifier#authority_key_identifier()","openssl::ocsp::response#basic()","openssl::bn#bit_set?()","openssl::pkey::rsa#blinding_off!()","openssl::pkey::rsa#blinding_on!()","openssl::digest#block_length()","openssl::cipher#block_size()","openssl::pkey::ec::builtin_curves()","openssl::engine::by_id()","openssl::x509::extension::authorityinfoaccess#ca_issuer_uris()","openssl::cipher#ccm_data_len=()","openssl::ssl::sslsocket#cert()","openssl::timestamp::request#cert_requested=()","openssl::timestamp::request#cert_requested?()","openssl::ocsp::singleresponse#cert_status()","openssl::ocsp::request#certid()","openssl::ocsp::singleresponse#certid()","openssl::pkcs7#certificates()","openssl::pkcs7#certificates=()","openssl::x509::storecontext#chain()","openssl::netscape::spki#challenge()","openssl::netscape::spki#challenge=()","openssl::pkey::ec#check_key()","openssl::ocsp::request#check_nonce()","openssl::x509::certificate#check_private_key()","openssl::ocsp::singleresponse#check_validity()","openssl::engine#cipher()","openssl::ssl::sslsocket#cipher()","openssl::pkcs7#cipher=()","openssl::cipher::ciphers()","openssl::ssl::sslcontext#ciphers()","openssl::ssl::sslcontext#ciphers=()","openssl::engine::cleanup()","openssl::x509::storecontext#cleanup()","openssl::bn#clear_bit!()","openssl::ssl::sslsocket#client_ca()","openssl::buffering#close()","openssl::ssl::sslserver#close()","openssl::ssl::socketforwarder#closed?()","openssl::engine#cmds()","openssl::bn#cmp()","openssl::ocsp::certificateid#cmp()","openssl::x509::name#cmp()","openssl::ocsp::certificateid#cmp_issuer()","openssl::bn#coerce()","openssl::pkey::ec::group#cofactor()","openssl::pkey::dh#compute_key()","openssl::buffering::buffer#concat()","openssl::ssl::sslsocket#connect()","openssl::ssl::sslsocket#connect_nonblock()","openssl::bn#copy()","openssl::ocsp::basicresponse#copy_nonce()","openssl::ocsp::response::create()","openssl::pkcs12::create()","openssl::x509::extensionfactory#create_ext()","openssl::x509::extensionfactory#create_ext_from_array()","openssl::x509::extensionfactory#create_ext_from_hash()","openssl::x509::extensionfactory#create_ext_from_string()","openssl::x509::extensionfactory#create_extension()","openssl::timestamp::factory#create_timestamp()","openssl::x509::extension#critical=()","openssl::x509::extension#critical?()","openssl::x509::extensionfactory#crl=()","openssl::x509::extension::crldistributionpoints#crl_uris()","openssl::pkcs7#crls()","openssl::pkcs7#crls=()","openssl::engine#ctrl_cmd()","openssl::x509::storecontext#current_cert()","openssl::x509::storecontext#current_crl()","openssl::pkey::ec::group#curve_name()","openssl::pkcs7#data=()","openssl::debug()","openssl::debug=()","openssl::asn1::decode()","openssl::asn1::decode_all()","openssl::cipher#decrypt()","openssl::pkcs7#decrypt()","openssl::pkey::ec::group#degree()","openssl::pkcs7#detached()","openssl::pkcs7#detached=()","openssl::pkcs7#detached?()","openssl::pkey::ec#dh_compute_key()","openssl::digest::digest()","openssl::engine#digest()","openssl::hmac::digest()","openssl::hmac#digest()","openssl::digest#digest_length()","openssl::ssl::socketforwarder#do_not_reverse_lookup=()","openssl::pkey::ec#dsa_sign_asn1()","openssl::pkey::ec#dsa_verify_asn1()","openssl::asn1::constructive#each()","openssl::buffering#each()","openssl::config#each()","openssl::buffering#each_byte()","openssl::buffering#each_line()","openssl::ssl::sslcontext#ecdh_curves=()","openssl::random::egd()","openssl::random::egd_bytes()","openssl::ssl::sslcontext#enable_fallback_scsv()","openssl::pkcs7::recipientinfo#enc_key()","openssl::cipher#encrypt()","openssl::pkcs7::encrypt()","openssl::engine::engines()","openssl::buffering#eof()","openssl::buffering#eof?()","openssl::bn#eql?()","openssl::pkey::ec::group#eql?()","openssl::pkey::ec::point#eql?()","openssl::x509::name#eql?()","openssl::x509::storecontext#error()","openssl::x509::storecontext#error=()","openssl::x509::storecontext#error_depth()","openssl::x509::storecontext#error_string()","openssl::errors()","openssl::x509::name::rfc2253dn#expand_hexstring()","openssl::x509::name::rfc2253dn#expand_pair()","openssl::x509::name::rfc2253dn#expand_value()","openssl::pkey::dh#export()","openssl::pkey::dsa#export()","openssl::pkey::ec#export()","openssl::pkey::rsa#export()","openssl::ocsp::singleresponse#extensions()","openssl::x509::crl#extensions()","openssl::x509::certificate#extensions()","openssl::x509::revoked#extensions()","openssl::x509::crl#extensions=()","openssl::x509::certificate#extensions=()","openssl::x509::revoked#extensions=()","openssl::timestamp::response#failure_info()","openssl::ssl::socketforwarder#fcntl()","openssl::ssl::socketforwarder#fileno()","openssl::cipher#final()","openssl::x509::extension::helpers#find_extension()","openssl::ocsp::basicresponse#find_response()","openssl::engine#finish()","openssl::ssl::sslsocket#finished_message()","openssl::fips_mode()","openssl::fips_mode=()","openssl::fixed_length_secure_compare()","openssl::x509::store#flags=()","openssl::x509::storecontext#flags=()","openssl::buffering#flush()","openssl::ssl::sslcontext#flush_sessions()","openssl::ssl::sslcontext#freeze()","openssl::bn#gcd()","openssl::timestamp::tokeninfo#gen_time()","openssl::pkey::dh::generate()","openssl::pkey::dsa::generate()","openssl::pkey::ec::generate()","openssl::pkey::rsa::generate()","openssl::pkey::ec#generate_key()","openssl::pkey::dh#generate_key!()","openssl::pkey::ec#generate_key!()","openssl::bn::generate_prime()","openssl::pkey::ec::group#generator()","openssl::config#get_value()","openssl::buffering#getc()","openssl::buffering#gets()","openssl::ssl::socketforwarder#getsockopt()","openssl::pkey::ec#group()","openssl::pkey::ec#group=()","openssl::bn#hash()","openssl::x509::name#hash()","openssl::ocsp::certificateid#hash_algorithm()","openssl::x509::name#hash_old()","openssl::hmac::hexdigest()","openssl::hmac#hexdigest()","openssl::kdf::hkdf()","openssl::ssl::sslsocket#hostname=()","openssl::engine#id()","openssl::ssl::session#id()","openssl::marshal::included()","openssl::pkey::ec::point#infinity?()","openssl::bn#initialize_copy()","openssl::cipher#initialize_copy()","openssl::digest#initialize_copy()","openssl::hmac#initialize_copy()","openssl::ocsp::basicresponse#initialize_copy()","openssl::ocsp::certificateid#initialize_copy()","openssl::ocsp::request#initialize_copy()","openssl::ocsp::response#initialize_copy()","openssl::ocsp::singleresponse#initialize_copy()","openssl::pkcs12#initialize_copy()","openssl::pkcs7#initialize_copy()","openssl::pkey::dh#initialize_copy()","openssl::pkey::dsa#initialize_copy()","openssl::pkey::ec#initialize_copy()","openssl::pkey::ec::group#initialize_copy()","openssl::pkey::ec::point#initialize_copy()","openssl::pkey::rsa#initialize_copy()","openssl::ssl::session#initialize_copy()","openssl::x509::attribute#initialize_copy()","openssl::x509::crl#initialize_copy()","openssl::x509::certificate#initialize_copy()","openssl::x509::extension#initialize_copy()","openssl::x509::name#initialize_copy()","openssl::x509::request#initialize_copy()","openssl::x509::revoked#initialize_copy()","openssl::config#inspect()","openssl::engine#inspect()","openssl::hmac#inspect()","openssl::pkey::pkey#inspect()","openssl::x509::certificate#inspect()","openssl::pkey::ec::point#invert!()","openssl::pkcs7::recipientinfo#issuer()","openssl::pkcs7::signerinfo#issuer()","openssl::x509::crl#issuer()","openssl::x509::certificate#issuer()","openssl::x509::crl#issuer=()","openssl::x509::certificate#issuer=()","openssl::x509::extensionfactory#issuer_certificate=()","openssl::ocsp::certificateid#issuer_key_hash()","openssl::ocsp::certificateid#issuer_name_hash()","openssl::cipher#iv=()","openssl::cipher#iv_len()","openssl::cipher#iv_len=()","openssl::cipher#key=()","openssl::cipher#key_len()","openssl::cipher#key_len=()","openssl::x509::crl#last_update()","openssl::x509::crl#last_update=()","openssl::ssl::sslserver#listen()","openssl::asn1::objectid#ln()","openssl::engine::load()","openssl::engine#load_private_key()","openssl::engine#load_public_key()","openssl::random::load_random_file()","openssl::asn1::objectid#long_name()","openssl::bn#lshift!()","openssl::pkey::ec::point#make_affine!()","openssl::ssl::sslcontext#max_version=()","openssl::mem_check_start()","openssl::timestamp::request#message_imprint()","openssl::timestamp::tokeninfo#message_imprint()","openssl::timestamp::request#message_imprint=()","openssl::ssl::sslcontext#min_version=()","openssl::bn#mod_add()","openssl::bn#mod_exp()","openssl::bn#mod_inverse()","openssl::bn#mod_mul()","openssl::bn#mod_sqr()","openssl::bn#mod_sub()","openssl::pkey::ec::point#mul()","openssl::cipher#name()","openssl::digest#name()","openssl::engine#name()","openssl::bn#negative?()","openssl::asn1::asn1data::new()","openssl::asn1::constructive::new()","openssl::asn1::primitive::new()","openssl::bn::new()","openssl::buffering::new()","openssl::buffering::buffer::new()","openssl::cipher::new()","openssl::config::new()","openssl::digest::new()","openssl::hmac::new()","openssl::netscape::spki::new()","openssl::ocsp::basicresponse::new()","openssl::ocsp::certificateid::new()","openssl::ocsp::request::new()","openssl::ocsp::response::new()","openssl::ocsp::singleresponse::new()","openssl::pkcs12::new()","openssl::pkcs7::new()","openssl::pkcs7::recipientinfo::new()","openssl::pkcs7::signerinfo::new()","openssl::pkey::dh::new()","openssl::pkey::dsa::new()","openssl::pkey::ec::new()","openssl::pkey::ec::group::new()","openssl::pkey::ec::point::new()","openssl::pkey::pkey::new()","openssl::pkey::rsa::new()","openssl::ssl::sslcontext::new()","openssl::ssl::sslserver::new()","openssl::ssl::sslsocket::new()","openssl::ssl::session::new()","openssl::timestamp::request::new()","openssl::timestamp::response::new()","openssl::timestamp::tokeninfo::new()","openssl::x509::attribute::new()","openssl::x509::crl::new()","openssl::x509::certificate::new()","openssl::x509::extension::new()","openssl::x509::extensionfactory::new()","openssl::x509::name::new()","openssl::x509::request::new()","openssl::x509::revoked::new()","openssl::x509::store::new()","openssl::x509::storecontext::new()","openssl::ocsp::singleresponse#next_update()","openssl::x509::crl#next_update()","openssl::x509::crl#next_update=()","openssl::timestamp::request#nonce()","openssl::timestamp::tokeninfo#nonce()","openssl::timestamp::request#nonce=()","openssl::x509::certificate#not_after()","openssl::x509::certificate#not_after=()","openssl::x509::certificate#not_before()","openssl::x509::certificate#not_before=()","openssl::ssl::sslsocket#npn_protocol()","openssl::bn#num_bits()","openssl::bn#num_bytes()","openssl::x509::extension::authorityinfoaccess#ocsp_uris()","openssl::bn#odd?()","openssl::asn1::objectid#oid()","openssl::pkey::pkey#oid()","openssl::x509::attribute#oid()","openssl::x509::extension#oid()","openssl::x509::attribute#oid=()","openssl::x509::extension#oid=()","openssl::pkey::ec::point#on_curve?()","openssl::bn#one?()","openssl::ssl::sslcontext#options()","openssl::ssl::sslcontext#options=()","openssl::pkey::ec::group#order()","openssl::timestamp::tokeninfo#ordering()","openssl::cipher#padding=()","openssl::pkey::dh#params()","openssl::pkey::dsa#params()","openssl::pkey::rsa#params()","openssl::pkey::dh#params_ok?()","openssl::config::parse()","openssl::x509::name::parse()","openssl::config::parse_config()","openssl::x509::name::parse_openssl()","openssl::x509::name::parse_rfc2253()","openssl::kdf::pbkdf2_hmac()","openssl::pkcs5#pbkdf2_hmac()","openssl::pkcs5#pbkdf2_hmac_sha1()","openssl::ssl::sslsocket#peer_cert()","openssl::ssl::sslsocket#peer_cert_chain()","openssl::ssl::sslsocket#peer_finished_message()","openssl::ssl::socketforwarder#peeraddr()","openssl::ssl::sslsocket#pending()","openssl::cipher#pkcs5_keyivgen()","openssl::pkey::ec::group#point_conversion_form()","openssl::pkey::ec::group#point_conversion_form=()","openssl::timestamp::request#policy_id()","openssl::timestamp::tokeninfo#policy_id()","openssl::timestamp::request#policy_id=()","openssl::ssl::sslsocket#post_connection_check()","openssl::bn#pretty_print()","openssl::x509::certificate#pretty_print()","openssl::x509::name#pretty_print()","openssl::bn#prime?()","openssl::bn#prime_fasttest?()","openssl::buffering#print()","openssl::print_mem_leaks()","openssl::buffering#printf()","openssl::pkey::dh#private?()","openssl::pkey::dsa#private?()","openssl::pkey::ec#private?()","openssl::pkey::rsa#private?()","openssl::pkey::rsa#private_decrypt()","openssl::pkey::rsa#private_encrypt()","openssl::pkey::ec#private_key()","openssl::pkey::ec#private_key=()","openssl::pkey::ec#private_key?()","openssl::pkey::pkey#private_to_der()","openssl::pkey::pkey#private_to_pem()","openssl::pkey::dh#public?()","openssl::pkey::dsa#public?()","openssl::pkey::ec#public?()","openssl::pkey::rsa#public?()","openssl::pkey::rsa#public_decrypt()","openssl::pkey::rsa#public_encrypt()","openssl::netscape::spki#public_key()","openssl::pkey::dh#public_key()","openssl::pkey::dsa#public_key()","openssl::pkey::ec#public_key()","openssl::pkey::rsa#public_key()","openssl::x509::certificate#public_key()","openssl::x509::request#public_key()","openssl::netscape::spki#public_key=()","openssl::pkey::ec#public_key=()","openssl::x509::certificate#public_key=()","openssl::x509::request#public_key=()","openssl::pkey::ec#public_key?()","openssl::pkey::pkey#public_to_der()","openssl::pkey::pkey#public_to_pem()","openssl::x509::store#purpose=()","openssl::x509::storecontext#purpose=()","openssl::buffering#puts()","openssl::random::random_add()","openssl::random::random_bytes()","openssl::cipher#random_iv()","openssl::cipher#random_key()","openssl::buffering#read()","openssl::pkey::read()","openssl::buffering#read_nonblock()","openssl::pkcs7::read_smime()","openssl::buffering#readchar()","openssl::buffering#readline()","openssl::buffering#readlines()","openssl::buffering#readpartial()","openssl::pkcs7#recipients()","openssl::asn1::objectid::register()","openssl::cipher#reset()","openssl::digest#reset()","openssl::hmac#reset()","openssl::ocsp::basicresponse#responses()","openssl::ocsp::singleresponse#revocation_reason()","openssl::ocsp::singleresponse#revocation_time()","openssl::x509::crl#revoked()","openssl::x509::crl#revoked=()","openssl::bn#rshift!()","openssl::x509::name::rfc2253dn#scan()","openssl::kdf::scrypt()","openssl::config#sections()","openssl::secure_compare()","openssl::ssl::sslcontext#security_level()","openssl::ssl::sslcontext#security_level=()","openssl::pkey::ec::group#seed()","openssl::random::seed()","openssl::pkey::ec::group#seed=()","openssl::ocsp::certificateid#serial()","openssl::pkcs7::recipientinfo#serial()","openssl::pkcs7::signerinfo#serial()","openssl::x509::certificate#serial()","openssl::x509::revoked#serial()","openssl::x509::certificate#serial=()","openssl::x509::revoked#serial=()","openssl::timestamp::tokeninfo#serial_number()","openssl::ssl::sslsocket#session()","openssl::ssl::sslsocket#session=()","openssl::ssl::sslcontext#session_add()","openssl::ssl::sslcontext#session_cache_mode()","openssl::ssl::sslcontext#session_cache_mode=()","openssl::ssl::sslcontext#session_cache_size()","openssl::ssl::sslcontext#session_cache_size=()","openssl::ssl::sslcontext#session_cache_stats()","openssl::ssl::sslcontext#session_remove()","openssl::ssl::sslsocket#session_reused?()","openssl::bn#set_bit!()","openssl::pkey::rsa#set_crt_params()","openssl::engine#set_default()","openssl::x509::store#set_default_paths()","openssl::pkey::rsa#set_factors()","openssl::pkey::ec::group#set_generator()","openssl::pkey::dh#set_key()","openssl::pkey::dsa#set_key()","openssl::pkey::rsa#set_key()","openssl::ssl::sslcontext#set_params()","openssl::pkey::dh#set_pqg()","openssl::pkey::dsa#set_pqg()","openssl::pkey::ec::point#set_to_infinity!()","openssl::ssl::socketforwarder#setsockopt()","openssl::ssl::sslcontext#setup()","openssl::asn1::objectid#short_name()","openssl::ssl::sslserver#shutdown()","openssl::netscape::spki#sign()","openssl::ocsp::basicresponse#sign()","openssl::ocsp::request#sign()","openssl::pkcs7::sign()","openssl::pkey::pkey#sign()","openssl::x509::crl#sign()","openssl::x509::certificate#sign()","openssl::x509::request#sign()","openssl::pkey::rsa#sign_pss()","openssl::x509::crl#signature_algorithm()","openssl::x509::certificate#signature_algorithm()","openssl::x509::request#signature_algorithm()","openssl::ocsp::request#signed?()","openssl::pkcs7::signerinfo#signed_time()","openssl::pkcs7#signers()","openssl::asn1::objectid#sn()","openssl::bn#sqr()","openssl::ssl::sslsocket#ssl_version()","openssl::ssl::sslcontext#ssl_version=()","openssl::ssl::sslsocket#state()","openssl::ocsp::basicresponse#status()","openssl::ocsp::response#status()","openssl::timestamp::response#status()","openssl::random::status?()","openssl::ocsp::response#status_string()","openssl::timestamp::response#status_text()","openssl::x509::certificate#subject()","openssl::x509::request#subject()","openssl::x509::certificate#subject=()","openssl::x509::request#subject=()","openssl::x509::extensionfactory#subject_certificate=()","openssl::x509::extension::subjectkeyidentifier#subject_key_identifier()","openssl::x509::extensionfactory#subject_request=()","openssl::ssl::sslsocket#sysclose()","openssl::ssl::sslsocket#sysread()","openssl::pkey::dsa#syssign()","openssl::pkey::dsa#sysverify()","openssl::ssl::sslsocket#syswrite()","openssl::ocsp::singleresponse#this_update()","openssl::ssl::session#time()","openssl::x509::revoked#time()","openssl::ssl::session#time=()","openssl::x509::revoked#time=()","openssl::x509::store#time=()","openssl::x509::storecontext#time=()","openssl::ssl::session#timeout()","openssl::ssl::session#timeout=()","openssl::ssl::sslsocket#tmp_key()","openssl::x509::extension#to_a()","openssl::x509::name#to_a()","integer#to_bn()","openssl::bn#to_bn()","openssl::pkey::ec::point#to_bn()","openssl::asn1::asn1data#to_der()","openssl::asn1::constructive#to_der()","openssl::asn1::primitive#to_der()","openssl::netscape::spki#to_der()","openssl::ocsp::basicresponse#to_der()","openssl::ocsp::certificateid#to_der()","openssl::ocsp::request#to_der()","openssl::ocsp::response#to_der()","openssl::ocsp::singleresponse#to_der()","openssl::pkcs12#to_der()","openssl::pkcs7#to_der()","openssl::pkey::dh#to_der()","openssl::pkey::dsa#to_der()","openssl::pkey::ec#to_der()","openssl::pkey::ec::group#to_der()","openssl::pkey::rsa#to_der()","openssl::ssl::session#to_der()","openssl::timestamp::request#to_der()","openssl::timestamp::response#to_der()","openssl::timestamp::tokeninfo#to_der()","openssl::x509::attribute#to_der()","openssl::x509::crl#to_der()","openssl::x509::certificate#to_der()","openssl::x509::extension#to_der()","openssl::x509::name#to_der()","openssl::x509::request#to_der()","openssl::x509::revoked#to_der()","openssl::x509::extension#to_h()","openssl::bn#to_i()","openssl::bn#to_int()","openssl::ssl::sslserver#to_io()","openssl::pkey::ec::point#to_octet_string()","openssl::netscape::spki#to_pem()","openssl::pkcs7#to_pem()","openssl::pkey::dh#to_pem()","openssl::pkey::dsa#to_pem()","openssl::pkey::ec#to_pem()","openssl::pkey::ec::group#to_pem()","openssl::pkey::rsa#to_pem()","openssl::ssl::session#to_pem()","openssl::x509::crl#to_pem()","openssl::x509::certificate#to_pem()","openssl::x509::request#to_pem()","openssl::bn#to_s()","openssl::config#to_s()","openssl::hmac#to_s()","openssl::netscape::spki#to_s()","openssl::pkcs7#to_s()","openssl::pkey::dh#to_s()","openssl::pkey::dsa#to_s()","openssl::pkey::rsa#to_s()","openssl::x509::crl#to_s()","openssl::x509::certificate#to_s()","openssl::x509::extension#to_s()","openssl::x509::name#to_s()","openssl::x509::request#to_s()","openssl::netscape::spki#to_text()","openssl::pkey::dh#to_text()","openssl::pkey::dsa#to_text()","openssl::pkey::ec#to_text()","openssl::pkey::ec::group#to_text()","openssl::pkey::rsa#to_text()","openssl::ssl::session#to_text()","openssl::x509::crl#to_text()","openssl::x509::certificate#to_text()","openssl::x509::request#to_text()","openssl::x509::name#to_utf8()","openssl::timestamp::response#token()","openssl::timestamp::response#token_info()","openssl::asn1::traverse()","openssl::x509::store#trust=()","openssl::x509::storecontext#trust=()","openssl::timestamp::response#tsa_certificate()","openssl::pkcs7#type()","openssl::pkcs7#type=()","openssl::bn#ucmp()","openssl::buffering#ungetc()","openssl::cipher#update()","openssl::digest#update()","openssl::hmac#update()","openssl::x509::attribute#value()","openssl::x509::extension#value()","openssl::x509::attribute#value=()","openssl::x509::extension#value=()","openssl::x509::extension#value_der()","openssl::netscape::spki#verify()","openssl::ocsp::basicresponse#verify()","openssl::ocsp::request#verify()","openssl::pkcs7#verify()","openssl::pkey::pkey#verify()","openssl::timestamp::response#verify()","openssl::x509::crl#verify()","openssl::x509::certificate#verify()","openssl::x509::request#verify()","openssl::x509::store#verify()","openssl::x509::storecontext#verify()","openssl::x509::store#verify_callback=()","openssl::ssl::verify_certificate_identity()","openssl::pkey::rsa#verify_pss()","openssl::ssl::sslsocket#verify_result()","openssl::timestamp::request#version()","openssl::timestamp::tokeninfo#version()","openssl::x509::crl#version()","openssl::x509::certificate#version()","openssl::x509::request#version()","openssl::timestamp::request#version=()","openssl::x509::crl#version=()","openssl::x509::certificate#version=()","openssl::x509::request#version=()","openssl::buffering#write()","openssl::buffering#write_nonblock()","openssl::random::write_random_file()","openssl::pkcs7::write_smime()","openssl::bn#zero?()","","",""],"info":[["IO","","IO.html","",""],["IO::WaitReadable","","IO/WaitReadable.html","",""],["IO::WaitWritable","","IO/WaitWritable.html","",""],["Integer","","Integer.html","",""],["OpenSSL","","OpenSSL.html","","<p>OpenSSL provides SSL, TLS and general purpose cryptography. It wraps the OpenSSL library.\n<p>Examples\n<p>All …\n"],["OpenSSL::ASN1","","OpenSSL/ASN1.html","","<p>Abstract Syntax Notation One (or ASN.1) is a notation syntax to describe data structures and is defined …\n"],["OpenSSL::ASN1::ASN1Data","","OpenSSL/ASN1/ASN1Data.html","","<p>The top-level class representing any ASN.1 object. When parsed by ASN1.decode, tagged values are always …\n"],["OpenSSL::ASN1::ASN1Error","","OpenSSL/ASN1/ASN1Error.html","","<p>Generic error class for all errors raised in ASN1 and any of the classes defined in it.\n"],["OpenSSL::ASN1::Constructive","","OpenSSL/ASN1/Constructive.html","","<p>The parent class for all constructed encodings. The <em>value</em> attribute of a Constructive is always an Array …\n"],["OpenSSL::ASN1::ObjectId","","OpenSSL/ASN1/ObjectId.html","","<p>Represents the primitive object id for OpenSSL::ASN1\n"],["OpenSSL::ASN1::Primitive","","OpenSSL/ASN1/Primitive.html","","<p>The parent class for all primitive encodings. Attributes are the same as for ASN1Data, with the addition …\n"],["OpenSSL::BN","","OpenSSL/BN.html","",""],["OpenSSL::BNError","","OpenSSL/BNError.html","","<p>Generic Error for all of OpenSSL::BN (big num)\n"],["OpenSSL::Buffering","","OpenSSL/Buffering.html","","<p>OpenSSL IO buffering mix-in module.\n<p>This module allows an OpenSSL::SSL::SSLSocket to behave like an IO …\n"],["OpenSSL::Buffering::Buffer","","OpenSSL/Buffering/Buffer.html","","<p>A buffer which will retain binary encoding.\n"],["OpenSSL::Cipher","","OpenSSL/Cipher.html","","<p>Provides symmetric algorithms for encryption and decryption. The algorithms that are available depend …\n"],["OpenSSL::Cipher::Cipher","","OpenSSL/Cipher/Cipher.html","","<p>Deprecated.\n<p>This class is only provided for backwards compatibility. Use OpenSSL::Cipher.\n"],["OpenSSL::Cipher::CipherError","","OpenSSL/Cipher/CipherError.html","",""],["OpenSSL::Config","","OpenSSL/Config.html","","<p>OpenSSL::Config\n<p>Configuration for the openssl library.\n<p>Many system’s installation of openssl library …\n"],["OpenSSL::ConfigError","","OpenSSL/ConfigError.html","","<p>General error for openssl library configuration files. Including formatting, parsing errors, etc.\n"],["OpenSSL::Digest","","OpenSSL/Digest.html","","<p>OpenSSL::Digest allows you to compute message digests (sometimes interchangeably called “hashes”) …\n"],["OpenSSL::Digest::DigestError","","OpenSSL/Digest/DigestError.html","","<p>Generic Exception class that is raised if an error occurs during a Digest operation.\n"],["OpenSSL::Engine","","OpenSSL/Engine.html","","<p>This class is the access to openssl’s ENGINE cryptographic module implementation.\n<p>See also, www.openssl.org/docs/crypto/engine.html …\n"],["OpenSSL::Engine::EngineError","","OpenSSL/Engine/EngineError.html","","<p>This is the generic exception for OpenSSL::Engine related errors\n"],["OpenSSL::ExtConfig","","OpenSSL/ExtConfig.html","","<p>This module contains configuration information about the SSL extension, for example if socket support …\n"],["OpenSSL::HMAC","","OpenSSL/HMAC.html","","<p>OpenSSL::HMAC allows computing Hash-based Message Authentication Code (HMAC). It is a type of message …\n"],["OpenSSL::HMACError","","OpenSSL/HMACError.html","","<p>Document-class: OpenSSL::HMAC\n<p>OpenSSL::HMAC allows computing Hash-based Message Authentication Code ( …\n"],["OpenSSL::KDF","","OpenSSL/KDF.html","","<p>Provides functionality of various KDFs (key derivation function).\n<p>KDF is typically used for securely deriving …\n"],["OpenSSL::KDF::KDFError","","OpenSSL/KDF/KDFError.html","","<p>Generic exception class raised if an error occurs in OpenSSL::KDF module.\n"],["OpenSSL::Marshal","","OpenSSL/Marshal.html","",""],["OpenSSL::Marshal::ClassMethods","","OpenSSL/Marshal/ClassMethods.html","",""],["OpenSSL::Netscape","","OpenSSL/Netscape.html","","<p>OpenSSL::Netscape is a namespace for SPKI (Simple Public Key Infrastructure) which implements Signed …\n"],["OpenSSL::Netscape::SPKI","","OpenSSL/Netscape/SPKI.html","","<p>A Simple Public Key Infrastructure implementation (pronounced “spooky”). The structure is defined …\n"],["OpenSSL::Netscape::SPKIError","","OpenSSL/Netscape/SPKIError.html","","<p>Generic Exception class that is raised if an error occurs during an operation on an instance of OpenSSL::Netscape::SPKI …\n"],["OpenSSL::OCSP","","OpenSSL/OCSP.html","","<p>OpenSSL::OCSP implements Online Certificate Status Protocol requests and responses.\n<p>Creating and sending …\n"],["OpenSSL::OCSP::BasicResponse","","OpenSSL/OCSP/BasicResponse.html","","<p>An OpenSSL::OCSP::BasicResponse contains the status of a certificate check which is created from an …\n"],["OpenSSL::OCSP::CertificateId","","OpenSSL/OCSP/CertificateId.html","","<p>An OpenSSL::OCSP::CertificateId identifies a certificate to the CA so that a status check can be performed. …\n"],["OpenSSL::OCSP::OCSPError","","OpenSSL/OCSP/OCSPError.html","","<p>OCSP error class.\n"],["OpenSSL::OCSP::Request","","OpenSSL/OCSP/Request.html","","<p>An OpenSSL::OCSP::Request contains the certificate information for determining if a certificate has been …\n"],["OpenSSL::OCSP::Response","","OpenSSL/OCSP/Response.html","","<p>An OpenSSL::OCSP::Response contains the status of a certificate check which is created from an OpenSSL::OCSP::Request …\n"],["OpenSSL::OCSP::SingleResponse","","OpenSSL/OCSP/SingleResponse.html","","<p>An OpenSSL::OCSP::SingleResponse represents an OCSP SingleResponse structure, which contains the basic …\n"],["OpenSSL::OpenSSLError","","OpenSSL/OpenSSLError.html","","<p>Generic error, common for all classes under OpenSSL module\n"],["OpenSSL::PKCS12","","OpenSSL/PKCS12.html","","<p>Defines a file format commonly used to store private keys with accompanying public key certificates, …\n"],["OpenSSL::PKCS12::PKCS12Error","","OpenSSL/PKCS12/PKCS12Error.html","",""],["OpenSSL::PKCS5","","OpenSSL/PKCS5.html","",""],["OpenSSL::PKCS7","","OpenSSL/PKCS7.html","",""],["OpenSSL::PKCS7::PKCS7Error","","OpenSSL/PKCS7/PKCS7Error.html","",""],["OpenSSL::PKCS7::RecipientInfo","","OpenSSL/PKCS7/RecipientInfo.html","",""],["OpenSSL::PKCS7::SignerInfo","","OpenSSL/PKCS7/SignerInfo.html","",""],["OpenSSL::PKey","","OpenSSL/PKey.html","","<p>Asymmetric Public Key Algorithms\n<p>Asymmetric public key algorithms solve the problem of establishing and …\n"],["OpenSSL::PKey::DH","","OpenSSL/PKey/DH.html","","<p>An implementation of the Diffie-Hellman key exchange protocol based on discrete logarithms in finite …\n"],["OpenSSL::PKey::DHError","","OpenSSL/PKey/DHError.html","","<p>Generic exception that is raised if an operation on a DH PKey fails unexpectedly or in case an instantiation …\n"],["OpenSSL::PKey::DSA","","OpenSSL/PKey/DSA.html","","<p>DSA, the Digital Signature Algorithm, is specified in NIST’s FIPS 186-3. It is an asymmetric public …\n"],["OpenSSL::PKey::DSAError","","OpenSSL/PKey/DSAError.html","","<p>Generic exception that is raised if an operation on a DSA PKey fails unexpectedly or in case an instantiation …\n"],["OpenSSL::PKey::EC","","OpenSSL/PKey/EC.html","","<p>OpenSSL::PKey::EC provides access to Elliptic Curve Digital Signature Algorithm (ECDSA) and Elliptic …\n"],["OpenSSL::PKey::EC::Group","","OpenSSL/PKey/EC/Group.html","",""],["OpenSSL::PKey::EC::Group::Error","","OpenSSL/PKey/EC/Group/Error.html","",""],["OpenSSL::PKey::EC::Point","","OpenSSL/PKey/EC/Point.html","",""],["OpenSSL::PKey::EC::Point::Error","","OpenSSL/PKey/EC/Point/Error.html","",""],["OpenSSL::PKey::ECError","","OpenSSL/PKey/ECError.html","",""],["OpenSSL::PKey::PKey","","OpenSSL/PKey/PKey.html","","<p>An abstract class that bundles signature creation (PKey#sign) and validation (PKey#verify) that is common …\n"],["OpenSSL::PKey::PKeyError","","OpenSSL/PKey/PKeyError.html","","<p>Raised when errors occur during PKey#sign or PKey#verify.\n"],["OpenSSL::PKey::RSA","","OpenSSL/PKey/RSA.html","","<p>RSA is an asymmetric public key algorithm that has been formalized in RFC 3447. It is in widespread use …\n"],["OpenSSL::PKey::RSAError","","OpenSSL/PKey/RSAError.html","","<p>Generic exception that is raised if an operation on an RSA PKey fails unexpectedly or in case an instantiation …\n"],["OpenSSL::Random","","OpenSSL/Random.html","",""],["OpenSSL::Random::RandomError","","OpenSSL/Random/RandomError.html","",""],["OpenSSL::SSL","","OpenSSL/SSL.html","","<p>Use SSLContext to set up the parameters for a TLS (former SSL) connection. Both client and server TLS …\n"],["OpenSSL::SSL::SSLContext","","OpenSSL/SSL/SSLContext.html","","<p>An SSLContext is used to set various options regarding certificates, algorithms, verification, session …\n"],["OpenSSL::SSL::SSLError","","OpenSSL/SSL/SSLError.html","","<p>Generic error class raised by SSLSocket and SSLContext.\n"],["OpenSSL::SSL::SSLErrorWaitReadable","","OpenSSL/SSL/SSLErrorWaitReadable.html","",""],["OpenSSL::SSL::SSLErrorWaitWritable","","OpenSSL/SSL/SSLErrorWaitWritable.html","",""],["OpenSSL::SSL::SSLServer","","OpenSSL/SSL/SSLServer.html","","<p>SSLServer represents a TCP/IP server socket with Secure Sockets Layer.\n"],["OpenSSL::SSL::SSLSocket","","OpenSSL/SSL/SSLSocket.html","",""],["OpenSSL::SSL::Session","","OpenSSL/SSL/Session.html","",""],["OpenSSL::SSL::Session::SessionError","","OpenSSL/SSL/Session/SessionError.html","",""],["OpenSSL::SSL::SocketForwarder","","OpenSSL/SSL/SocketForwarder.html","",""],["OpenSSL::Timestamp","","OpenSSL/Timestamp.html","","<p>Provides classes and methods to request, create and validate RFC3161-compliant timestamps. Request may …\n"],["OpenSSL::Timestamp::Factory","","OpenSSL/Timestamp/Factory.html","","<p>Used to generate a Response from scratch.\n<p>Please bear in mind that the implementation will always apply …\n"],["OpenSSL::Timestamp::Request","","OpenSSL/Timestamp/Request.html","","<p>Allows to create timestamp requests or parse existing ones. A Request is also needed for creating timestamps …\n"],["OpenSSL::Timestamp::Response","","OpenSSL/Timestamp/Response.html","","<p>Immutable and read-only representation of a timestamp response returned from a timestamp server after …\n"],["OpenSSL::Timestamp::TimestampError","","OpenSSL/Timestamp/TimestampError.html","","<p>Generic exception class of the Timestamp module.\n"],["OpenSSL::Timestamp::TokenInfo","","OpenSSL/Timestamp/TokenInfo.html","","<p>Immutable and read-only representation of a timestamp token info from a Response.\n"],["OpenSSL::X509","","OpenSSL/X509.html","",""],["OpenSSL::X509::Attribute","","OpenSSL/X509/Attribute.html","",""],["OpenSSL::X509::AttributeError","","OpenSSL/X509/AttributeError.html","",""],["OpenSSL::X509::CRL","","OpenSSL/X509/CRL.html","",""],["OpenSSL::X509::CRLError","","OpenSSL/X509/CRLError.html","",""],["OpenSSL::X509::Certificate","","OpenSSL/X509/Certificate.html","","<p>Implementation of an X.509 certificate as specified in RFC 5280. Provides access to a certificate’s …\n"],["OpenSSL::X509::CertificateError","","OpenSSL/X509/CertificateError.html","",""],["OpenSSL::X509::Extension","","OpenSSL/X509/Extension.html","",""],["OpenSSL::X509::Extension::AuthorityInfoAccess","","OpenSSL/X509/Extension/AuthorityInfoAccess.html","",""],["OpenSSL::X509::Extension::AuthorityKeyIdentifier","","OpenSSL/X509/Extension/AuthorityKeyIdentifier.html","",""],["OpenSSL::X509::Extension::CRLDistributionPoints","","OpenSSL/X509/Extension/CRLDistributionPoints.html","",""],["OpenSSL::X509::Extension::Helpers","","OpenSSL/X509/Extension/Helpers.html","",""],["OpenSSL::X509::Extension::SubjectKeyIdentifier","","OpenSSL/X509/Extension/SubjectKeyIdentifier.html","",""],["OpenSSL::X509::ExtensionError","","OpenSSL/X509/ExtensionError.html","",""],["OpenSSL::X509::ExtensionFactory","","OpenSSL/X509/ExtensionFactory.html","",""],["OpenSSL::X509::Name","","OpenSSL/X509/Name.html","","<p>An X.509 name represents a hostname, email address or other entity associated with a public key.\n<p>You can …\n"],["OpenSSL::X509::Name::RFC2253DN","","OpenSSL/X509/Name/RFC2253DN.html","",""],["OpenSSL::X509::NameError","","OpenSSL/X509/NameError.html","",""],["OpenSSL::X509::Request","","OpenSSL/X509/Request.html","",""],["OpenSSL::X509::RequestError","","OpenSSL/X509/RequestError.html","",""],["OpenSSL::X509::Revoked","","OpenSSL/X509/Revoked.html","",""],["OpenSSL::X509::RevokedError","","OpenSSL/X509/RevokedError.html","",""],["OpenSSL::X509::Store","","OpenSSL/X509/Store.html","","<p>The X509 certificate store holds trusted CA certificates used to verify peer certificates.\n<p>The easiest …\n"],["OpenSSL::X509::StoreContext","","OpenSSL/X509/StoreContext.html","","<p>A StoreContext is used while validating a single certificate and holds the status involved.\n"],["OpenSSL::X509::StoreError","","OpenSSL/X509/StoreError.html","",""],["%","OpenSSL::BN","OpenSSL/BN.html#method-i-25","(p1)",""],["*","OpenSSL::BN","OpenSSL/BN.html#method-i-2A","(p1)",""],["**","OpenSSL::BN","OpenSSL/BN.html#method-i-2A-2A","(p1)",""],["+","OpenSSL::BN","OpenSSL/BN.html#method-i-2B","(p1)",""],["+@","OpenSSL::BN","OpenSSL/BN.html#method-i-2B-40","()",""],["-","OpenSSL::BN","OpenSSL/BN.html#method-i-2D","(p1)",""],["-@","OpenSSL::BN","OpenSSL/BN.html#method-i-2D-40","()",""],["/","OpenSSL::BN","OpenSSL/BN.html#method-i-2F","(p1)","<p>Division of OpenSSL::BN instances\n"],["<<","OpenSSL::BN","OpenSSL/BN.html#method-i-3C-3C","(p1)",""],["<<","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-3C-3C","(s)","<p>Writes <em>s</em> to the stream. <em>s</em> will be converted to a String using <code>.to_s</code> method.\n"],["<<","OpenSSL::Buffering::Buffer","OpenSSL/Buffering/Buffer.html#method-i-3C-3C","(string)",""],["<<","OpenSSL::Digest","OpenSSL/Digest.html#method-i-3C-3C","(p1)","<p>Not every message digest can be computed in one single pass. If a message digest is to be computed from …\n"],["<<","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-3C-3C","(p1)","<p>Returns <em>hmac</em> updated with the message to be authenticated. Can be called repeatedly with chunks of the …\n"],["<=>","OpenSSL::BN","OpenSSL/BN.html#method-i-3C-3D-3E","(p1)",""],["<=>","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-3C-3D-3E","(p1)","<p>Compares this Name with <em>other</em> and returns <code>0</code> if they are the same and <code>-1</code> or <code>+1</code> if they are greater or …\n"],["==","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-3D-3D","(p1)","<p>Returns <code>true</code> if <em>other_oid</em> is the same as <em>oid</em>\n"],["==","OpenSSL::BN","OpenSSL/BN.html#method-i-3D-3D","(p1)","<p>Returns <code>true</code> only if <em>obj</em> has the same value as <em>bn</em>. Contrast this with OpenSSL::BN#eql?, which requires …\n"],["==","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-3D-3D","(other)","<p>Securely compare with another HMAC instance in constant time.\n"],["==","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-3D-3D","(p1)","<p>Returns <code>true</code> if the two groups use the same curve and have the same parameters, <code>false</code> otherwise.\n"],["==","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-3D-3D","(p1)",""],["==","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-3D-3D","(p1)","<p>Returns <code>true</code> if the two Session is the same, <code>false</code> if not.\n"],["==","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-3D-3D","(other)",""],["==","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-3D-3D","(other)",""],["==","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-3D-3D","(p1)","<p>Compares the two certificates. Note that this takes into account all fields, not just the issuer name …\n"],["==","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-3D-3D","(other)",""],["==","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-3D-3D","(other)",""],["==","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-3D-3D","(other)",""],["===","OpenSSL::BN","OpenSSL/BN.html#method-i-3D-3D-3D","(p1)","<p>Returns <code>true</code> only if <em>obj</em> has the same value as <em>bn</em>. Contrast this with OpenSSL::BN#eql?, which requires …\n"],[">>","OpenSSL::BN","OpenSSL/BN.html#method-i-3E-3E","(p1)",""],["Digest","OpenSSL","OpenSSL.html#method-c-Digest","(name)","<p>Returns a Digest subclass by <em>name</em>\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">require</span> <span class=\"ruby-string\">'openssl'</span>\n\n<span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Digest</span>(<span class=\"ruby-string\">"MD5"</span>)\n<span class=\"ruby-comment\"># => OpenSSL::Digest::MD5 ...</span>\n</pre>\n"],["[]","OpenSSL::Config","OpenSSL/Config.html#method-i-5B-5D","(section)","<p>Get a specific <em>section</em> from the current configuration\n<p>Given the following configurating file being loaded: …\n"],["[]=","OpenSSL::Config","OpenSSL/Config.html#method-i-5B-5D-3D","(section, pairs)","<p>*Deprecated in v2.2.0*. This method will be removed in a future release.\n<p>Sets a specific <em>section</em> name …\n"],["_dump","OpenSSL::Marshal","OpenSSL/Marshal.html#method-i-_dump","(_level)",""],["_load","OpenSSL::Marshal::ClassMethods","OpenSSL/Marshal/ClassMethods.html#method-i-_load","(string)",""],["accept","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-i-accept","()","<p>Works similar to TCPServer#accept.\n"],["accept","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-accept","()","<p>Waits for a SSL/TLS client to initiate a handshake. The handshake may be started after unencrypted data …\n"],["accept_nonblock","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-accept_nonblock","(p1 = {})","<p>Initiates the SSL/TLS handshake as a server in non-blocking manner.\n\n<pre># emulates blocking accept\nbegin\n ...</pre>\n"],["add","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-add","(p1)","<p>Performs elliptic curve point addition.\n"],["add_attribute","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-add_attribute","(p1)",""],["add_cert","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-add_cert","(p1)","<p>Adds the OpenSSL::X509::Certificate <em>cert</em> to the certificate store.\n"],["add_certid","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-add_certid","(p1)","<p>Adds <em>certificate_id</em> to the request.\n"],["add_certificate","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-add_certificate","(p1)",""],["add_certificate","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-add_certificate","(p1, p2, p3 = v3)","<p>Adds a certificate to the context. <em>pkey</em> must be a corresponding private key with <em>certificate</em>.\n<p>Multiple …\n"],["add_crl","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-add_crl","(p1)",""],["add_crl","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-add_crl","(p1)","<p>Adds the OpenSSL::X509::CRL <em>crl</em> to the store.\n"],["add_data","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-add_data","(p1)",""],["add_entry","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-add_entry","(p1, p2, p3 = v3, p4 = {})","<p>Adds a new entry with the given <em>oid</em> and <em>value</em> to this name. The <em>oid</em> is an object identifier defined …\n"],["add_extension","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-add_extension","(p1)",""],["add_extension","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-add_extension","(p1)",""],["add_extension","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-add_extension","(p1)",""],["add_file","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-add_file","(p1)","<p>Adds the certificates in <em>file</em> to the certificate store. <em>file</em> is the path to the file, and the file contains …\n"],["add_nonce","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-add_nonce","(p1 = v1)","<p>Adds <em>nonce</em> to this response. If no nonce was provided a random nonce will be added.\n"],["add_nonce","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-add_nonce","(p1 = v1)","<p>Adds a <em>nonce</em> to the OCSP request. If no nonce is given a random one will be generated.\n<p>The nonce is used …\n"],["add_path","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-add_path","(p1)","<p>Adds <em>path</em> as the hash dir to be looked up by the store.\n"],["add_recipient","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-add_recipient","(p1)",""],["add_revoked","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-add_revoked","(p1)",""],["add_signer","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-add_signer","(p1)",""],["add_status","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-add_status","(p1, p2, p3, p4, p5, p6, p7)","<p>Adds a certificate status for <em>certificate_id</em>. <em>status</em> is the status, and must be one of these:\n<p>OpenSSL::OCSP::V_CERTSTATUS_GOOD …\n"],["add_value","OpenSSL::Config","OpenSSL/Config.html#method-i-add_value","(section, key, value)","<p>*Deprecated in v2.2.0*. This method will be removed in a future release.\n<p>Set the target <em>key</em> with a given …\n"],["addr","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-addr","()",""],["algorithm","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-algorithm","()","<p>Returns the ‘short name’ of the object identifier that represents the algorithm that was used …\n"],["algorithm","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-algorithm","()","<p>Returns the ‘short name’ of the object identifier representing the algorithm that was used to …\n"],["algorithm=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-algorithm-3D","(p1)","<p>Allows to set the object identifier or the ‘short name’ of the algorithm that was used to create …\n"],["alpn_protocol","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-alpn_protocol","()","<p>Returns the ALPN protocol string that was finally selected by the server during the handshake.\n"],["asn1_flag","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-asn1_flag","()","<p>Returns the flags set on the group.\n<p>See also #asn1_flag=.\n"],["asn1_flag=","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-asn1_flag-3D","(p1)","<p>Sets flags on the group. The flag value is used to determine how to encode the group: encode explicit …\n"],["attributes","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-attributes","()",""],["attributes=","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-attributes-3D","(p1)",""],["auth_data=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-auth_data-3D","(p1)","<p>Sets the cipher’s additional authenticated data. This field must be set when using AEAD cipher modes …\n"],["auth_tag","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-auth_tag","(p1 = v1)","<p>Gets the authentication tag generated by Authenticated Encryption Cipher modes (GCM for example). This …\n"],["auth_tag=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-auth_tag-3D","(p1)","<p>Sets the authentication tag to verify the integrity of the ciphertext. This can be called only when the …\n"],["auth_tag_len=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-auth_tag_len-3D","(p1)","<p>Sets the length of the authentication tag to be generated or to be given for AEAD ciphers that requires …\n"],["authenticated?","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-authenticated-3F","()","<p>Indicated whether this Cipher instance uses an Authenticated Encryption mode.\n"],["authority_key_identifier","OpenSSL::X509::Extension::AuthorityKeyIdentifier","OpenSSL/X509/Extension/AuthorityKeyIdentifier.html#method-i-authority_key_identifier","()","<p>Get the issuing certificate’s key identifier from the authorityKeyIdentifier extension, as described …\n"],["basic","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-i-basic","()","<p>Returns a BasicResponse for this response\n"],["bit_set?","OpenSSL::BN","OpenSSL/BN.html#method-i-bit_set-3F","(p1)","<p>Tests bit <em>bit</em> in <em>bn</em> and returns <code>true</code> if set, <code>false</code> if not set.\n"],["blinding_off!","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-blinding_off-21","()",""],["blinding_on!","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-blinding_on-21","()",""],["block_length","OpenSSL::Digest","OpenSSL/Digest.html#method-i-block_length","()","<p>Returns the block length of the digest algorithm, i.e. the length in bytes of an individual block. Most …\n"],["block_size","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-block_size","()","<p>Returns the size in bytes of the blocks on which this Cipher operates on.\n"],["builtin_curves","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-c-builtin_curves","()","<p>Obtains a list of all predefined curves by the OpenSSL. Curve names are returned as sn.\n<p>See the OpenSSL …\n"],["by_id","OpenSSL::Engine","OpenSSL/Engine.html#method-c-by_id","(p1)","<p>Fetches the engine as specified by the <em>id</em> String.\n\n<pre>OpenSSL::Engine.by_id("openssl")\n => #<OpenSSL::Engine ...</pre>\n"],["ca_issuer_uris","OpenSSL::X509::Extension::AuthorityInfoAccess","OpenSSL/X509/Extension/AuthorityInfoAccess.html#method-i-ca_issuer_uris","()","<p>Get the information and services for the issuer from the certificate’s authority information access …\n"],["ccm_data_len=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-ccm_data_len-3D","(p1)","<p>Sets the length of the plaintext / ciphertext message that will be processed in CCM mode. Make sure to …\n"],["cert","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-cert","()","<p>The X509 certificate for this socket endpoint.\n"],["cert_requested=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-cert_requested-3D","(p1)","<p>Specify whether the response shall contain the timestamp authority’s certificate or not. The default …\n"],["cert_requested?","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-cert_requested-3F","()","<p>Indicates whether the response shall contain the timestamp authority’s certificate or not.\n"],["cert_status","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-cert_status","()","<p>Returns the status of the certificate identified by the certid. The return value may be one of these …\n"],["certid","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-certid","()","<p>Returns all certificate IDs in this request.\n"],["certid","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-certid","()","<p>Returns the CertificateId for which this SingleResponse is.\n"],["certificates","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-certificates","()",""],["certificates=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-certificates-3D","(p1)",""],["chain","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-chain","()",""],["challenge","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-challenge","()","<p>Returns the challenge string associated with this SPKI.\n"],["challenge=","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-challenge-3D","(p1)","<p>Parameters\n<p><em>str</em> - the challenge string to be set for this instance\n\n<p>Sets the challenge to be associated with …\n"],["check_key","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-check_key","()","<p>Raises an exception if the key is invalid.\n<p>See the OpenSSL documentation for EC_KEY_check_key()\n"],["check_nonce","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-check_nonce","(p1)","<p>Checks the nonce validity for this request and <em>response</em>.\n<p>The return value is one of the following:\n<p>-1 … — "],["check_private_key","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-check_private_key","(p1)","<p>Returns <code>true</code> if <em>key</em> is the corresponding private key to the Subject Public Key Information, <code>false</code> otherwise. …\n"],["check_validity","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-check_validity","(p1 = v1, p2 = v2)","<p>Checks the validity of thisUpdate and nextUpdate fields of this SingleResponse. This checks the current …\n"],["cipher","OpenSSL::Engine","OpenSSL/Engine.html#method-i-cipher","(p1)","<p>Returns a new instance of OpenSSL::Cipher by <em>name</em>, if it is available in this engine.\n<p>An EngineError will …\n"],["cipher","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-cipher","()","<p>Returns the cipher suite actually used in the current session, or nil if no session has been established. …\n"],["cipher=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-cipher-3D","(p1)",""],["ciphers","OpenSSL::Cipher","OpenSSL/Cipher.html#method-c-ciphers","()","<p>Returns the names of all available ciphers in an array.\n"],["ciphers","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-ciphers","()","<p>The list of cipher suites configured for this context.\n"],["ciphers=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-ciphers-3D","(p1)","<p>Sets the list of available cipher suites for this context. Note in a server context some ciphers require …\n"],["cleanup","OpenSSL::Engine","OpenSSL/Engine.html#method-c-cleanup","()","<p>It is only necessary to run cleanup when engines are loaded via OpenSSL::Engine.load. However, running …\n"],["cleanup","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-cleanup","()",""],["clear_bit!","OpenSSL::BN","OpenSSL/BN.html#method-i-clear_bit-21","(p1)",""],["client_ca","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-client_ca","()","<p>Returns the list of client CAs. Please note that in contrast to SSLContext#client_ca= no array of X509::Certificate …\n"],["close","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-close","()","<p>Closes the SSLSocket and flushes any unwritten data.\n"],["close","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-i-close","()","<p>See IO#close for details.\n"],["closed?","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-closed-3F","()",""],["cmds","OpenSSL::Engine","OpenSSL/Engine.html#method-i-cmds","()","<p>Returns an array of command definitions for the current engine\n"],["cmp","OpenSSL::BN","OpenSSL/BN.html#method-i-cmp","(p1)",""],["cmp","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-cmp","(p1)","<p>Compares this certificate id with <em>other</em> and returns <code>true</code> if they are the same.\n"],["cmp","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-cmp","(p1)","<p>Compares this Name with <em>other</em> and returns <code>0</code> if they are the same and <code>-1</code> or <code>+1</code> if they are greater or …\n"],["cmp_issuer","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-cmp_issuer","(p1)","<p>Compares this certificate id’s issuer with <em>other</em> and returns <code>true</code> if they are the same.\n"],["coerce","OpenSSL::BN","OpenSSL/BN.html#method-i-coerce","(p1)",""],["cofactor","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-cofactor","()","<p>Returns the cofactor of the group.\n<p>See the OpenSSL documentation for EC_GROUP_get_cofactor()\n"],["compute_key","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-compute_key","(p1)","<p>Returns a String containing a shared secret computed from the other party’s public value. See DH_compute_key …\n"],["concat","OpenSSL::Buffering::Buffer","OpenSSL/Buffering/Buffer.html#method-i-concat","(string)",""],["connect","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-connect","()","<p>Initiates an SSL/TLS handshake with a server. The handshake may be started after unencrypted data has …\n"],["connect_nonblock","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-connect_nonblock","(p1 = {})","<p>Initiates the SSL/TLS handshake as a client in non-blocking manner.\n\n<pre># emulates blocking connect\nbegin ...</pre>\n"],["copy","OpenSSL::BN","OpenSSL/BN.html#method-i-copy","(p1)",""],["copy_nonce","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-copy_nonce","(p1)","<p>Copies the nonce from <em>request</em> into this response. Returns 1 on success and 0 on failure.\n"],["create","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-c-create","(p1, p2)","<p>Creates an OpenSSL::OCSP::Response from <em>status</em> and <em>basic_response</em>.\n"],["create","OpenSSL::PKCS12","OpenSSL/PKCS12.html#method-c-create","(p1, p2, p3, p4, p5 = v5, p6 = v6, p7 = v7, p8 = v8, p9 = v9, p10 = v10)","<p>Parameters\n<p><em>pass</em> - string\n<p><em>name</em> - A string describing the key.\n"],["create_ext","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-create_ext","(p1, p2, p3 = v3)","<p>Creates a new X509::Extension with passed values. See also x509v3_config(5).\n"],["create_ext_from_array","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-create_ext_from_array","(ary)",""],["create_ext_from_hash","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-create_ext_from_hash","(hash)",""],["create_ext_from_string","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-create_ext_from_string","(str)",""],["create_extension","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-create_extension","(*arg)",""],["create_timestamp","OpenSSL::Timestamp::Factory","OpenSSL/Timestamp/Factory.html#method-i-create_timestamp","(p1, p2, p3)","<p>Creates a Response with the help of an OpenSSL::PKey, an OpenSSL::X509::Certificate and a Request.\n<p>Mandatory …\n"],["critical=","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-critical-3D","(p1)",""],["critical?","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-critical-3F","()",""],["crl=","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-crl-3D","(p1)",""],["crl_uris","OpenSSL::X509::Extension::CRLDistributionPoints","OpenSSL/X509/Extension/CRLDistributionPoints.html#method-i-crl_uris","()","<p>Get the distributionPoint fullName URI from the certificate’s CRL distribution points extension, …\n"],["crls","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-crls","()",""],["crls=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-crls-3D","(p1)",""],["ctrl_cmd","OpenSSL::Engine","OpenSSL/Engine.html#method-i-ctrl_cmd","(p1, p2 = v2)","<p>Sends the given <em>command</em> to this engine.\n<p>Raises an EngineError if the command fails.\n"],["current_cert","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-current_cert","()",""],["current_crl","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-current_crl","()",""],["curve_name","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-curve_name","()","<p>Returns the curve name (sn).\n<p>See the OpenSSL documentation for EC_GROUP_get_curve_name()\n"],["data=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-data-3D","(p1)",""],["debug","OpenSSL","OpenSSL.html#method-c-debug","()",""],["debug=","OpenSSL","OpenSSL.html#method-c-debug-3D","(p1)","<p>Turns on or off debug mode. With debug mode, all erros added to the OpenSSL error queue will be printed …\n"],["decode","OpenSSL::ASN1","OpenSSL/ASN1.html#method-c-decode","(p1)","<p>Decodes a BER- or DER-encoded value and creates an ASN1Data instance. <em>der</em> may be a String or any object …\n"],["decode_all","OpenSSL::ASN1","OpenSSL/ASN1.html#method-c-decode_all","(p1)","<p>Similar to #decode with the difference that #decode expects one distinct value represented in <em>der</em>. #decode_all …\n"],["decrypt","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-decrypt","(*args)","<p>Initializes the Cipher for decryption.\n<p>Make sure to call Cipher#encrypt or Cipher#decrypt before using …\n"],["decrypt","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-decrypt","(p1, p2 = v2, p3 = v3)",""],["degree","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-degree","()","<p>See the OpenSSL documentation for EC_GROUP_get_degree()\n"],["detached","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-detached","()",""],["detached=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-detached-3D","(p1)",""],["detached?","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-detached-3F","()",""],["dh_compute_key","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-dh_compute_key","(p1)","<p>See the OpenSSL documentation for ECDH_compute_key()\n"],["digest","OpenSSL::Digest","OpenSSL/Digest.html#method-c-digest","(name, data)","<p>Return the hash value computed with <em>name</em> Digest. <em>name</em> is either the long name or short name of a supported …\n"],["digest","OpenSSL::Engine","OpenSSL/Engine.html#method-i-digest","(p1)","<p>Returns a new instance of OpenSSL::Digest by <em>name</em>.\n<p>Will raise an EngineError if the digest is unavailable. …\n"],["digest","OpenSSL::HMAC","OpenSSL/HMAC.html#method-c-digest","(p1, p2, p3)","<p>Returns the authentication code as a binary string. The <em>digest</em> parameter specifies the digest algorithm …\n"],["digest","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-digest","()","<p>Returns the authentication code an instance represents as a binary string.\n<p>Example\n\n<pre>instance = OpenSSL::HMAC.new('key', ...</pre>\n"],["digest_length","OpenSSL::Digest","OpenSSL/Digest.html#method-i-digest_length","()","<p>Returns the output size of the digest, i.e. the length in bytes of the final message digest result.\n<p>Example …\n"],["do_not_reverse_lookup=","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-do_not_reverse_lookup-3D","(flag)",""],["dsa_sign_asn1","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-dsa_sign_asn1","(p1)","<p>See the OpenSSL documentation for ECDSA_sign()\n"],["dsa_verify_asn1","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-dsa_verify_asn1","(p1, p2)","<p>See the OpenSSL documentation for ECDSA_verify()\n"],["each","OpenSSL::ASN1::Constructive","OpenSSL/ASN1/Constructive.html#method-i-each","()","<p>Calls the given block once for each element in self, passing that element as parameter <em>asn1</em>. If no block …\n"],["each","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-each","(eol=$/)","<p>Executes the block for every line in the stream where lines are separated by <em>eol</em>.\n<p>See also #gets\n"],["each","OpenSSL::Config","OpenSSL/Config.html#method-i-each","()","<p>For a block.\n<p>Receive the section and its pairs for the current configuration.\n\n<pre>config.each do |section, ...</pre>\n"],["each_byte","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-each_byte","()","<p>Calls the given block once for each byte in the stream.\n"],["each_line","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-each_line","(eol=$/)",""],["ecdh_curves=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-ecdh_curves-3D","(p1)","<p>Sets the list of “supported elliptic curves” for this context.\n<p>For a TLS client, the list is …\n"],["egd","OpenSSL::Random","OpenSSL/Random.html#method-c-egd","(p1)","<p>Same as ::egd_bytes but queries 255 bytes by default.\n"],["egd_bytes","OpenSSL::Random","OpenSSL/Random.html#method-c-egd_bytes","(p1, p2)","<p>Queries the entropy gathering daemon EGD on socket path given by <em>filename</em>.\n<p>Fetches <em>length</em> number of bytes …\n"],["enable_fallback_scsv","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-enable_fallback_scsv","()","<p>Activate TLS_FALLBACK_SCSV for this context. See RFC 7507.\n"],["enc_key","OpenSSL::PKCS7::RecipientInfo","OpenSSL/PKCS7/RecipientInfo.html#method-i-enc_key","()",""],["encrypt","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-encrypt","(*args)","<p>Initializes the Cipher for encryption.\n<p>Make sure to call Cipher#encrypt or Cipher#decrypt before using …\n"],["encrypt","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-c-encrypt","(p1, p2, p3 = v3, p4 = v4)",""],["engines","OpenSSL::Engine","OpenSSL/Engine.html#method-c-engines","()","<p>Returns an array of currently loaded engines.\n"],["eof","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-eof","()",""],["eof?","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-eof-3F","()","<p>Returns true if the stream is at file which means there is no more data to be read.\n"],["eql?","OpenSSL::BN","OpenSSL/BN.html#method-i-eql-3F","(p1)","<p>Returns <code>true</code> only if <em>obj</em> is a <code>OpenSSL::BN</code> with the same value as <em>bn</em>. Contrast this with OpenSSL::BN#== …\n"],["eql?","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-eql-3F","(p1)","<p>Returns <code>true</code> if the two groups use the same curve and have the same parameters, <code>false</code> otherwise.\n"],["eql?","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-eql-3F","(p1)",""],["eql?","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-eql-3F","(p1)","<p>Returns true if <em>name</em> and <em>other</em> refer to the same hash key.\n"],["error","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-error","()",""],["error=","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-error-3D","(p1)",""],["error_depth","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-error_depth","()",""],["error_string","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-error_string","()","<p>Returns the error string corresponding to the error code retrieved by #error.\n"],["errors","OpenSSL","OpenSSL.html#method-c-errors","()","<p>See any remaining errors held in queue.\n<p>Any errors you see here are probably due to a bug in Ruby’s …\n"],["expand_hexstring","OpenSSL::X509::Name::RFC2253DN","OpenSSL/X509/Name/RFC2253DN.html#method-i-expand_hexstring","(str)",""],["expand_pair","OpenSSL::X509::Name::RFC2253DN","OpenSSL/X509/Name/RFC2253DN.html#method-i-expand_pair","(str)",""],["expand_value","OpenSSL::X509::Name::RFC2253DN","OpenSSL/X509/Name/RFC2253DN.html#method-i-expand_value","(str1, str2, str3)",""],["export","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-export","()","<p>Encodes this DH to its PEM encoding. Note that any existing per-session public/private keys will <strong>not</strong> …\n"],["export","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-export","(p1 = v1, p2 = v2)","<p>Encodes this DSA to its PEM encoding.\n<p>Parameters\n<p><em>cipher</em> is an OpenSSL::Cipher.\n"],["export","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-export","(p1 = v1, p2 = v2)","<p>Outputs the EC key in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt …\n"],["export","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-export","(p1 = v1, p2 = v2)","<p>Outputs this keypair in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt …\n"],["extensions","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-extensions","()",""],["extensions","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-extensions","()","<p>Gets X509v3 extensions as array of X509Ext objects\n"],["extensions","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-extensions","()",""],["extensions","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-extensions","()","<p>Gets X509v3 extensions as array of X509Ext objects\n"],["extensions=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-extensions-3D","(p1)","<p>Sets X509_EXTENSIONs\n"],["extensions=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-extensions-3D","(p1)",""],["extensions=","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-extensions-3D","(p1)","<p>Sets X509_EXTENSIONs\n"],["failure_info","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-failure_info","()","<p>In cases no timestamp token has been created, this field contains further info about the reason why response …\n"],["fcntl","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-fcntl","(*args)",""],["fileno","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-fileno","()","<p>The file descriptor for the socket.\n"],["final","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-final","()","<p>Returns the remaining data held in the cipher object. Further calls to Cipher#update or Cipher#final …\n"],["find_extension","OpenSSL::X509::Extension::Helpers","OpenSSL/X509/Extension/Helpers.html#method-i-find_extension","(oid)",""],["find_response","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-find_response","(p1)","<p>Returns a SingleResponse whose CertId matches with <em>certificate_id</em>, or <code>nil</code> if this BasicResponse does …\n"],["finish","OpenSSL::Engine","OpenSSL/Engine.html#method-i-finish","()","<p>Releases all internal structural references for this engine.\n<p>May raise an EngineError if the engine is …\n"],["finished_message","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-finished_message","()","<p>Returns the last <strong>Finished</strong> message sent\n"],["fips_mode","OpenSSL","OpenSSL.html#method-c-fips_mode","()",""],["fips_mode=","OpenSSL","OpenSSL.html#method-c-fips_mode-3D","(p1)","<p>Turns FIPS mode on or off. Turning on FIPS mode will obviously only have an effect for FIPS-capable installations …\n"],["fixed_length_secure_compare","OpenSSL","OpenSSL.html#method-c-fixed_length_secure_compare","(p1, p2)","<p>Constant time memory comparison for fixed length strings, such as results of HMAC calculations.\n<p>Returns …\n"],["flags=","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-flags-3D","(p1)","<p>Sets <em>flags</em> to the Store. <em>flags</em> consists of zero or more of the constants defined in with name V_FLAG_ …\n"],["flags=","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-flags-3D","(p1)","<p>Sets the verification flags to the context. See Store#flags=.\n"],["flush","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-flush","()","<p>Flushes buffered data to the SSLSocket.\n"],["flush_sessions","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-flush_sessions","(p1 = v1)","<p>Removes sessions in the internal cache that have expired at <em>time</em>.\n"],["freeze","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-freeze","()","<p>This method is called automatically when a new SSLSocket is created. However, it is not thread-safe and …\n"],["gcd","OpenSSL::BN","OpenSSL/BN.html#method-i-gcd","(p1)",""],["gen_time","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-gen_time","()","<p>Returns time when this timestamp token was created. If status is GRANTED or GRANTED_WITH_MODS, this is …\n"],["generate","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-c-generate","(p1, p2 = v2)","<p>Creates a new DH instance from scratch by generating the private and public components alike.\n<p>Parameters …\n"],["generate","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-c-generate","(p1)","<p>Creates a new DSA instance by generating a private/public key pair from scratch.\n<p>Parameters\n<p><em>size</em> is an …\n"],["generate","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-c-generate","(p1)","<p>Creates a new EC instance with a new random private and public key.\n"],["generate","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-c-generate","(p1, p2 = v2)","<p>Generates an RSA keypair. <em>size</em> is an integer representing the desired key size. Keys smaller than 1024 …\n"],["generate_key","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-generate_key","()","<p>Generates a new random private and public key.\n<p>See also the OpenSSL documentation for EC_KEY_generate_key …\n"],["generate_key!","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-generate_key-21","()","<p>Generates a private and public key unless a private key already exists. If this DH instance was generated …\n"],["generate_key!","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-generate_key-21","()","<p>Generates a new random private and public key.\n<p>See also the OpenSSL documentation for EC_KEY_generate_key …\n"],["generate_prime","OpenSSL::BN","OpenSSL/BN.html#method-c-generate_prime","(p1, p2 = v2, p3 = v3, p4 = v4)","<p>Generates a random prime number of bit length <em>bits</em>. If <em>safe</em> is set to <code>true</code>, generates a safe prime. …\n"],["generator","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-generator","()","<p>Returns the generator of the group.\n<p>See the OpenSSL documentation for EC_GROUP_get0_generator()\n"],["get_value","OpenSSL::Config","OpenSSL/Config.html#method-i-get_value","(section, key)","<p>Gets the value of <em>key</em> from the given <em>section</em>\n<p>Given the following configurating file being loaded:\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">config</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["getc","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-getc","()","<p>Reads one character from the stream. Returns nil if called at end of file.\n"],["gets","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-gets","(eol=$/, limit=nil)","<p>Reads the next “line” from the stream. Lines are separated by <em>eol</em>. If <em>limit</em> is provided the …\n"],["getsockopt","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-getsockopt","(level, optname)",""],["group","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-group","()","<p>Returns the EC::Group that the key is associated with. Modifying the returned group does not affect …\n"],["group=","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-group-3D","(p1)","<p>Sets the EC::Group for the key. The group structure is internally copied so modification to <em>group</em> after …\n"],["hash","OpenSSL::BN","OpenSSL/BN.html#method-i-hash","()","<p>Returns a hash code for this object.\n<p>See also Object#hash.\n"],["hash","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-hash","()","<p>The hash value returned is suitable for use as a certificate’s filename in a CA path.\n"],["hash_algorithm","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-hash_algorithm","()","<p>Returns the ln (long name) of the hash algorithm used to generate the issuerNameHash and the issuerKeyHash …\n"],["hash_old","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-hash_old","()","<p>Returns an MD5 based hash used in OpenSSL 0.9.X.\n"],["hexdigest","OpenSSL::HMAC","OpenSSL/HMAC.html#method-c-hexdigest","(p1, p2, p3)","<p>Returns the authentication code as a hex-encoded string. The <em>digest</em> parameter specifies the digest algorithm …\n"],["hexdigest","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-hexdigest","()","<p>Returns the authentication code an instance represents as a hex-encoded string.\n"],["hkdf","OpenSSL::KDF","OpenSSL/KDF.html#method-c-hkdf","(p1, p2 = {})","<p>HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as specified in RFC 5869.\n<p>New in OpenSSL …\n"],["hostname=","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-hostname-3D","(p1)","<p>Sets the server hostname used for SNI. This needs to be set before SSLSocket#connect.\n"],["id","OpenSSL::Engine","OpenSSL/Engine.html#method-i-id","()","<p>Gets the id for this engine.\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Engine</span>.<span class=\"ruby-identifier\">load</span>\n<span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Engine</span>.<span class=\"ruby-identifier\">engines</span> <span class=\"ruby-comment\">#=> [#<OpenSSL::Engine#>, ...] ...</span>\n</pre>\n"],["id","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-id","()","<p>Returns the Session ID.\n"],["included","OpenSSL::Marshal","OpenSSL/Marshal.html#method-c-included","(base)",""],["infinity?","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-infinity-3F","()",""],["initialize_copy","OpenSSL::BN","OpenSSL/BN.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::Digest","OpenSSL/Digest.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKCS12","OpenSSL/PKCS12.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-initialize_copy","(p1)",""],["initialize_copy","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-initialize_copy","(p1)",""],["inspect","OpenSSL::Config","OpenSSL/Config.html#method-i-inspect","()","<p>String representation of this configuration object, including the class name and its sections.\n"],["inspect","OpenSSL::Engine","OpenSSL/Engine.html#method-i-inspect","()","<p>Pretty prints this engine.\n"],["inspect","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-inspect","()","<p>Returns the authentication code as a hex-encoded string. The <em>digest</em> parameter specifies the digest algorithm …\n"],["inspect","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-inspect","()","<p>Returns a string describing the PKey object.\n"],["inspect","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-inspect","()",""],["invert!","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-invert-21","()",""],["issuer","OpenSSL::PKCS7::RecipientInfo","OpenSSL/PKCS7/RecipientInfo.html#method-i-issuer","()",""],["issuer","OpenSSL::PKCS7::SignerInfo","OpenSSL/PKCS7/SignerInfo.html#method-i-issuer","()",""],["issuer","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-issuer","()",""],["issuer","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-issuer","()",""],["issuer=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-issuer-3D","(p1)",""],["issuer=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-issuer-3D","(p1)",""],["issuer_certificate=","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-issuer_certificate-3D","(p1)",""],["issuer_key_hash","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-issuer_key_hash","()","<p>Returns the issuerKeyHash of this certificate ID, the hash of the issuer’s public key.\n"],["issuer_name_hash","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-issuer_name_hash","()","<p>Returns the issuerNameHash of this certificate ID, the hash of the issuer’s distinguished name calculated …\n"],["iv=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-iv-3D","(p1)","<p>Sets the cipher IV. Please note that since you should never be using ECB mode, an IV is always explicitly …\n"],["iv_len","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-iv_len","()","<p>Returns the expected length in bytes for an IV for this Cipher.\n"],["iv_len=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-iv_len-3D","(p1)","<p>Sets the IV/nonce length of the Cipher. Normally block ciphers don’t allow changing the IV length, …\n"],["key=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-key-3D","(p1)","<p>Sets the cipher key. To generate a key, you should either use a secure random byte string or, if the …\n"],["key_len","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-key_len","()","<p>Returns the key length in bytes of the Cipher.\n"],["key_len=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-key_len-3D","(p1)","<p>Sets the key length of the cipher. If the cipher is a fixed length cipher then attempting to set the …\n"],["last_update","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-last_update","()",""],["last_update=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-last_update-3D","(p1)",""],["listen","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-i-listen","(backlog=Socket::SOMAXCONN)","<p>See TCPServer#listen for details.\n"],["ln","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-ln","()","<p>The long name of the ObjectId, as defined in <openssl/objects.h>.\n"],["load","OpenSSL::Engine","OpenSSL/Engine.html#method-c-load","(p1 = v1)","<p>This method loads engines. If <em>name</em> is nil, then all builtin engines are loaded. Otherwise, the given …\n"],["load_private_key","OpenSSL::Engine","OpenSSL/Engine.html#method-i-load_private_key","(p1 = v1, p2 = v2)","<p>Loads the given private key identified by <em>id</em> and <em>data</em>.\n<p>An EngineError is raised of the OpenSSL::PKey is …\n"],["load_public_key","OpenSSL::Engine","OpenSSL/Engine.html#method-i-load_public_key","(p1 = v1, p2 = v2)","<p>Loads the given public key identified by <em>id</em> and <em>data</em>.\n<p>An EngineError is raised of the OpenSSL::PKey is …\n"],["load_random_file","OpenSSL::Random","OpenSSL/Random.html#method-c-load_random_file","(p1)","<p>Reads bytes from <em>filename</em> and adds them to the PRNG.\n"],["long_name","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-long_name","()","<p>The long name of the ObjectId, as defined in <openssl/objects.h>.\n"],["lshift!","OpenSSL::BN","OpenSSL/BN.html#method-i-lshift-21","(p1)",""],["make_affine!","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-make_affine-21","()",""],["max_version=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-max_version-3D","(version)","<p>Sets the upper bound of the supported SSL/TLS protocol version. See #min_version= for the possible values. …\n"],["mem_check_start","OpenSSL","OpenSSL.html#method-c-mem_check_start","()","<p>Calls CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON). Starts tracking memory allocations. See also OpenSSL.print_mem_leaks …\n"],["message_imprint","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-message_imprint","()","<p>Returns the message imprint (digest) of the data to be timestamped.\n"],["message_imprint","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-message_imprint","()","<p>Returns the message imprint digest. For valid timestamps, this is the same value that was already given …\n"],["message_imprint=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-message_imprint-3D","(p1)","<p>Set the message imprint digest.\n"],["min_version=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-min_version-3D","(version)","<p>Sets the lower bound on the supported SSL/TLS protocol version. The version may be specified by an integer …\n"],["mod_add","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_add","(p1, p2)",""],["mod_exp","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_exp","(p1, p2)",""],["mod_inverse","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_inverse","(p1)",""],["mod_mul","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_mul","(p1, p2)",""],["mod_sqr","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_sqr","(p1)",""],["mod_sub","OpenSSL::BN","OpenSSL/BN.html#method-i-mod_sub","(p1, p2)",""],["mul","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-mul","(p1, p2 = v2, p3 = v3)","<p>Performs elliptic curve point multiplication.\n<p>The first form calculates <code>bn1 * point + bn2 * G</code>, where …\n"],["name","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-name","()","<p>Returns the name of the cipher which may differ slightly from the original name provided.\n"],["name","OpenSSL::Digest","OpenSSL/Digest.html#method-i-name","()","<p>Returns the sn of this Digest algorithm.\n<p>Example\n\n<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-identifier\">new</span>(<span class=\"ruby-string\">'SHA512'</span>)\n<span class=\"ruby-identifier\">puts</span> <span class=\"ruby-identifier\">digest</span>.<span class=\"ruby-identifier\">name</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["name","OpenSSL::Engine","OpenSSL/Engine.html#method-i-name","()","<p>Get the descriptive name for this engine.\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Engine</span>.<span class=\"ruby-identifier\">load</span>\n<span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Engine</span>.<span class=\"ruby-identifier\">engines</span> <span class=\"ruby-comment\">#=> [#<OpenSSL::Engine#>, ...</span>\n</pre>\n"],["negative?","OpenSSL::BN","OpenSSL/BN.html#method-i-negative-3F","()",""],["new","OpenSSL::ASN1::ASN1Data","OpenSSL/ASN1/ASN1Data.html#method-c-new","(p1, p2, p3)","<p><em>value</em>: Please have a look at Constructive and Primitive to see how Ruby types are mapped to ASN.1 types …\n"],["new","OpenSSL::ASN1::Constructive","OpenSSL/ASN1/Constructive.html#method-c-new","(p1, p2 = v2, p3 = v3, p4 = v4)","<p><em>value</em>: is mandatory.\n<p><em>tag</em>: optional, may be specified for tagged values. If no <em>tag</em> is specified, the UNIVERSAL …\n"],["new","OpenSSL::ASN1::Primitive","OpenSSL/ASN1/Primitive.html#method-c-new","(p1, p2 = v2, p3 = v3, p4 = v4)","<p><em>value</em>: is mandatory.\n<p><em>tag</em>: optional, may be specified for tagged values. If no <em>tag</em> is specified, the UNIVERSAL …\n"],["new","OpenSSL::BN","OpenSSL/BN.html#method-c-new","(p1, p2 = v2)","<p>Construct a new OpenSSL BIGNUM object.\n"],["new","OpenSSL::Buffering","OpenSSL/Buffering.html#method-c-new","(*)","<p>Creates an instance of OpenSSL’s buffering IO module.\n"],["new","OpenSSL::Buffering::Buffer","OpenSSL/Buffering/Buffer.html#method-c-new","()",""],["new","OpenSSL::Cipher","OpenSSL/Cipher.html#method-c-new","(p1)","<p>The string must contain a valid cipher name like “AES-256-CBC”.\n<p>A list of cipher names is available …\n"],["new","OpenSSL::Config","OpenSSL/Config.html#method-c-new","(filename = nil)","<p>Creates an instance of OpenSSL’s configuration class.\n<p>This can be used in contexts like OpenSSL::X509::ExtensionFactory.config= …\n"],["new","OpenSSL::Digest","OpenSSL/Digest.html#method-c-new","(p1, p2 = v2)","<p>Creates a Digest instance based on <em>string</em>, which is either the ln (long name) or sn (short name) of a …\n"],["new","OpenSSL::HMAC","OpenSSL/HMAC.html#method-c-new","(p1, p2)","<p>Returns an instance of OpenSSL::HMAC set with the key and digest algorithm to be used. The instance represents …\n"],["new","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-c-new","(p1 = v1)","<p>Parameters\n<p><em>request</em> - optional raw request, either in PEM or DER format.\n\n"],["new","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-c-new","(p1 = v1)","<p>Creates a new BasicResponse. If <em>der_string</em> is given, decodes <em>der_string</em> as DER.\n"],["new","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-c-new","(p1, p2 = v2, p3 = v3)","<p>Creates a new OpenSSL::OCSP::CertificateId for the given <em>subject</em> and <em>issuer</em> X509 certificates. The …\n"],["new","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-c-new","(p1 = v1)","<p>Creates a new OpenSSL::OCSP::Request. The request may be created empty or from a <em>request_der</em> string. …\n"],["new","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-c-new","(p1 = v1)","<p>Creates a new OpenSSL::OCSP::Response. The response may be created empty or from a <em>response_der</em> string. …\n"],["new","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-c-new","(p1)","<p>Creates a new SingleResponse from <em>der_string</em>.\n"],["new","OpenSSL::PKCS12","OpenSSL/PKCS12.html#method-c-new","(p1 = v1, p2 = v2)","<p>Parameters\n<p><em>str</em> - Must be a DER encoded PKCS12 string.\n<p><em>pass</em> - string\n"],["new","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-c-new","(p1 = v1)","<p>Many methods in this class aren’t documented.\n"],["new","OpenSSL::PKCS7::RecipientInfo","OpenSSL/PKCS7/RecipientInfo.html#method-c-new","(p1)",""],["new","OpenSSL::PKCS7::SignerInfo","OpenSSL/PKCS7/SignerInfo.html#method-c-new","(p1, p2, p3)",""],["new","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-c-new","(p1 = v1, p2 = v2)","<p>Either generates a DH instance from scratch or by reading already existing DH parameters from <em>string</em> …\n"],["new","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-c-new","(p1 = v1, p2 = v2)","<p>Creates a new DSA instance by reading an existing key from <em>string</em>.\n<p>Parameters\n<p><em>size</em> is an integer representing …\n"],["new","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-c-new","(p1 = v1, p2 = v2)","<p>Creates a new EC object from given arguments.\n"],["new","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-c-new","(p1, p2 = v2, p3 = v3, p4 = v4)","<p>Creates a new EC::Group object.\n<p><em>ec_method</em> is a symbol that represents an EC_METHOD. Currently the following …\n"],["new","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-c-new","(p1, p2 = v2)","<p>Creates a new instance of OpenSSL::PKey::EC::Point. If the only argument is an instance of EC::Point …\n"],["new","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-c-new","()","<p>Because PKey is an abstract class, actually calling this method explicitly will raise a NotImplementedError …\n"],["new","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-c-new","(p1 = v1, p2 = v2)","<p>Generates or loads an RSA keypair. If an integer <em>key_size</em> is given it represents the desired key size. …\n"],["new","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-c-new","(version = nil)","<p>Creates a new SSL context.\n<p>If an argument is given, #ssl_version= is called with the value. Note that …\n"],["new","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-c-new","(svr, ctx)","<p>Creates a new instance of SSLServer.\n<p><em>srv</em> is an instance of TCPServer.\n<p><em>ctx</em> is an instance of OpenSSL::SSL::SSLContext …\n"],["new","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-c-new","(p1, p2 = v2)","<p>Creates a new SSL socket from <em>io</em> which must be a real IO object (not an IO-like object that responds …\n"],["new","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-c-new","(p1)","<p>Creates a new Session object from an instance of SSLSocket or DER/PEM encoded String.\n"],["new","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-c-new","(p1 = v1)","<p>When creating a Request with the <code>File</code> or <code>string</code> parameter, the corresponding <code>File</code> or <code>string</code> must be DER-encoded. …\n"],["new","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-c-new","(p1)","<p>Creates a Response from a <code>File</code> or <code>string</code> parameter, the corresponding <code>File</code> or <code>string</code> must be DER-encoded. …\n"],["new","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-c-new","(p1)","<p>Creates a TokenInfo from a <code>File</code> or <code>string</code> parameter, the corresponding <code>File</code> or <code>string</code> must be DER-encoded. …\n"],["new","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-c-new","(p1, p2 = v2)",""],["new","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-c-new","(p1 = v1)",""],["new","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-c-new","(p1 = v1)",""],["new","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-c-new","(p1, p2 = v2, p3 = v3)","<p>Creates an X509 extension.\n<p>The extension may be created from <em>der</em> data or from an extension <em>oid</em> and <em>value</em> …\n"],["new","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-c-new","(p1 = v1, p2 = v2, p3 = v3, p4 = v4)",""],["new","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-c-new","(p1 = v1, p2 = v2)","<p>Creates a new Name.\n<p>A name may be created from a DER encoded string <em>der</em>, an Array representing a <em>distinguished_name</em> …\n"],["new","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-c-new","(p1 = v1)",""],["new","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-c-new","(*args)",""],["new","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-c-new","(*args)","<p>Creates a new X509::Store.\n"],["new","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-c-new","(p1, p2 = v2, p3 = v3)","<p>Sets up a StoreContext for a verification of the X.509 certificate <em>cert</em>.\n"],["next_update","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-next_update","()",""],["next_update","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-next_update","()",""],["next_update=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-next_update-3D","(p1)",""],["nonce","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-nonce","()","<p>Returns the nonce (number used once) that the server shall include in its response.\n"],["nonce","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-nonce","()","<p>If the timestamp token is valid then this field contains the same nonce that was passed to the timestamp …\n"],["nonce=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-nonce-3D","(p1)","<p>Sets the nonce (number used once) that the server shall include in its response. If the nonce is set, …\n"],["not_after","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-not_after","()",""],["not_after=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-not_after-3D","(p1)",""],["not_before","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-not_before","()",""],["not_before=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-not_before-3D","(p1)",""],["npn_protocol","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-npn_protocol","()","<p>Returns the protocol string that was finally selected by the client during the handshake.\n"],["num_bits","OpenSSL::BN","OpenSSL/BN.html#method-i-num_bits","()",""],["num_bytes","OpenSSL::BN","OpenSSL/BN.html#method-i-num_bytes","()",""],["ocsp_uris","OpenSSL::X509::Extension::AuthorityInfoAccess","OpenSSL/X509/Extension/AuthorityInfoAccess.html#method-i-ocsp_uris","()","<p>Get the URIs for OCSP from the certificate’s authority information access extension exteension, as …\n"],["odd?","OpenSSL::BN","OpenSSL/BN.html#method-i-odd-3F","()",""],["oid","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-oid","()","<p>Returns a String representing the Object Identifier in the dot notation, e.g. “1.2.3.4.5”\n"],["oid","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-oid","()","<p>Returns the short name of the OID associated with <em>pkey</em>.\n"],["oid","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-oid","()",""],["oid","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-oid","()",""],["oid=","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-oid-3D","(p1)",""],["oid=","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-oid-3D","(p1)",""],["on_curve?","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-on_curve-3F","()",""],["one?","OpenSSL::BN","OpenSSL/BN.html#method-i-one-3F","()",""],["options","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-options","()","<p>Gets various OpenSSL options.\n"],["options=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-options-3D","(p1)","<p>Sets various OpenSSL options.\n"],["order","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-order","()","<p>Returns the order of the group.\n<p>See the OpenSSL documentation for EC_GROUP_get_order()\n"],["ordering","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-ordering","()","<p>If the ordering field is missing, or if the ordering field is present and set to false, then the genTime …\n"],["padding=","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-padding-3D","(p1)","<p>Enables or disables padding. By default encryption operations are padded using standard block padding …\n"],["params","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-params","()","<p>Stores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don’t use …\n"],["params","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-params","()","<p>Stores all parameters of key to the hash INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don’t use …\n"],["params","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-params","()","<p>THIS METHOD IS INSECURE, PRIVATE INFORMATION CAN LEAK OUT!!!\n<p>Stores all parameters of key to the hash. …\n"],["params_ok?","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-params_ok-3F","()","<p>Validates the Diffie-Hellman parameters associated with this instance. It checks whether a safe prime …\n"],["parse","OpenSSL::Config","OpenSSL/Config.html#method-c-parse","(string)","<p>Parses a given <em>string</em> as a blob that contains configuration for OpenSSL.\n<p>If the source of the IO is a …\n"],["parse","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-c-parse","(str, template=OBJECT_TYPE_TEMPLATE)",""],["parse_config","OpenSSL::Config","OpenSSL/Config.html#method-c-parse_config","(io)","<p>Parses the configuration data read from <em>io</em>, see also #parse.\n<p>Raises a ConfigError on invalid configuration …\n"],["parse_openssl","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-c-parse_openssl","(str, template=OBJECT_TYPE_TEMPLATE)",""],["parse_rfc2253","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-c-parse_rfc2253","(str, template=OBJECT_TYPE_TEMPLATE)",""],["pbkdf2_hmac","OpenSSL::KDF","OpenSSL/KDF.html#method-c-pbkdf2_hmac","(p1, p2 = {})","<p>PKCS #5 PBKDF2 (Password-Based Key Derivation Function 2) in combination with HMAC. Takes <em>pass</em>, <em>salt</em> …\n"],["pbkdf2_hmac","OpenSSL::PKCS5","OpenSSL/PKCS5.html#method-i-pbkdf2_hmac","(pass, salt, iter, keylen, digest)","<p>OpenSSL::PKCS5.pbkdf2_hmac has been renamed to OpenSSL::KDF.pbkdf2_hmac. This method is provided for …\n"],["pbkdf2_hmac_sha1","OpenSSL::PKCS5","OpenSSL/PKCS5.html#method-i-pbkdf2_hmac_sha1","(pass, salt, iter, keylen)",""],["peer_cert","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-peer_cert","()","<p>The X509 certificate for this socket’s peer.\n"],["peer_cert_chain","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-peer_cert_chain","()","<p>The X509 certificate chain for this socket’s peer.\n"],["peer_finished_message","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-peer_finished_message","()","<p>Returns the last <strong>Finished</strong> message received\n"],["peeraddr","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-peeraddr","()",""],["pending","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-pending","()","<p>The number of bytes that are immediately available for reading.\n"],["pkcs5_keyivgen","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-pkcs5_keyivgen","(p1, p2 = v2, p3 = v3, p4 = v4)","<p>Generates and sets the key/IV based on a password.\n<p><strong>WARNING</strong>: This method is only PKCS5 v1.5 compliant when …\n"],["point_conversion_form","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-point_conversion_form","()","<p>Returns the form how EC::Point data is encoded as ASN.1.\n<p>See also #point_conversion_form=.\n"],["point_conversion_form=","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-point_conversion_form-3D","(p1)","<p>Sets the form how EC::Point data is encoded as ASN.1 as defined in X9.62.\n<p><em>format</em> can be one of these: …\n"],["policy_id","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-policy_id","()","<p>Returns the ‘short name’ of the object identifier that represents the timestamp policy under …\n"],["policy_id","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-policy_id","()","<p>Returns the timestamp policy object identifier of the policy this timestamp was created under. If status …\n"],["policy_id=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-policy_id-3D","(p1)","<p>Allows to set the object identifier that represents the timestamp policy under which the server shall …\n"],["post_connection_check","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-post_connection_check","(hostname)","<p>Perform hostname verification following RFC 6125.\n<p>This method MUST be called after calling #connect to …\n"],["pretty_print","OpenSSL::BN","OpenSSL/BN.html#method-i-pretty_print","(q)",""],["pretty_print","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-pretty_print","(q)",""],["pretty_print","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-pretty_print","(q)",""],["prime?","OpenSSL::BN","OpenSSL/BN.html#method-i-prime-3F","(p1 = v1)","<p>Performs a Miller-Rabin probabilistic primality test with <em>checks</em> iterations. If <em>checks</em> is not specified, …\n"],["prime_fasttest?","OpenSSL::BN","OpenSSL/BN.html#method-i-prime_fasttest-3F","(p1 = v1, p2 = v2)","<p>Performs a Miller-Rabin primality test. This is same as #prime? except this first attempts trial divisions …\n"],["print","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-print","(*args)","<p>Writes <em>args</em> to the stream.\n<p>See IO#print for full details.\n"],["print_mem_leaks","OpenSSL","OpenSSL.html#method-c-print_mem_leaks","()","<p>For debugging the Ruby/OpenSSL library. Calls CRYPTO_mem_leaks_fp(stderr). Prints detected memory leaks …\n"],["printf","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-printf","(s, *args)","<p>Formats and writes to the stream converting parameters under control of the format string.\n<p>See Kernel#sprintf …\n"],["private?","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-private-3F","()","<p>Indicates whether this DH instance has a private key associated with it or not. The private key may be …\n"],["private?","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-private-3F","()","<p>Indicates whether this DSA instance has a private key associated with it or not. The private key may …\n"],["private?","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-private-3F","()","<p>Returns whether this EC instance has a private key. The private key (BN) can be retrieved with EC#private_key …\n"],["private?","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-private-3F","()","<p>Does this keypair contain a private key?\n"],["private_decrypt","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-private_decrypt","(p1, p2 = v2)","<p>Decrypt <em>string</em>, which has been encrypted with the public key, with the private key. <em>padding</em> defaults …\n"],["private_encrypt","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-private_encrypt","(p1, p2 = v2)","<p>Encrypt <em>string</em> with the private key. <em>padding</em> defaults to PKCS1_PADDING. The encrypted string output …\n"],["private_key","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-private_key","()","<p>See the OpenSSL documentation for EC_KEY_get0_private_key()\n"],["private_key=","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-private_key-3D","(p1)","<p>See the OpenSSL documentation for EC_KEY_set_private_key()\n"],["private_key?","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-private_key-3F","()","<p>Returns whether this EC instance has a private key. The private key (BN) can be retrieved with EC#private_key …\n"],["private_to_der","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-private_to_der","(*args)","<p>Serializes the private key to DER-encoded PKCS #8 format. If called without arguments, unencrypted PKCS …\n"],["private_to_pem","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-private_to_pem","(*args)","<p>Serializes the private key to PEM-encoded PKCS #8 format. See #private_to_der for more details.\n"],["public?","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-public-3F","()","<p>Indicates whether this DH instance has a public key associated with it or not. The public key may be …\n"],["public?","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-public-3F","()","<p>Indicates whether this DSA instance has a public key associated with it or not. The public key may be …\n"],["public?","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-public-3F","()","<p>Returns whether this EC instance has a public key. The public key (EC::Point) can be retrieved with …\n"],["public?","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-public-3F","()","<p>The return value is always <code>true</code> since every private key is also a public key.\n"],["public_decrypt","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-public_decrypt","(p1, p2 = v2)","<p>Decrypt <em>string</em>, which has been encrypted with the private key, with the public key. <em>padding</em> defaults …\n"],["public_encrypt","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-public_encrypt","(p1, p2 = v2)","<p>Encrypt <em>string</em> with the public key. <em>padding</em> defaults to PKCS1_PADDING. The encrypted string output can …\n"],["public_key","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-public_key","()","<p>Returns the public key associated with the SPKI, an instance of OpenSSL::PKey.\n"],["public_key","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-public_key","()","<p>Returns a new DH instance that carries just the public information, i.e. the prime <em>p</em> and the generator …\n"],["public_key","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-public_key","()","<p>Returns a new DSA instance that carries just the public key information. If the current instance has …\n"],["public_key","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-public_key","()","<p>See the OpenSSL documentation for EC_KEY_get0_public_key()\n"],["public_key","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-public_key","()","<p>Makes new RSA instance containing the public key from the private key.\n"],["public_key","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-public_key","()",""],["public_key","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-public_key","()",""],["public_key=","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-public_key-3D","(p1)","<p>Parameters\n<p><em>pub</em> - the public key to be set for this instance\n\n<p>Sets the public key to be associated with the …\n"],["public_key=","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-public_key-3D","(p1)","<p>See the OpenSSL documentation for EC_KEY_set_public_key()\n"],["public_key=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-public_key-3D","(p1)",""],["public_key=","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-public_key-3D","(p1)",""],["public_key?","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-public_key-3F","()","<p>Returns whether this EC instance has a public key. The public key (EC::Point) can be retrieved with …\n"],["public_to_der","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-public_to_der","()","<p>Serializes the public key to DER-encoded X.509 SubjectPublicKeyInfo format.\n"],["public_to_pem","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-public_to_pem","()","<p>Serializes the public key to PEM-encoded X.509 SubjectPublicKeyInfo format.\n"],["purpose=","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-purpose-3D","(p1)","<p>Sets the store’s purpose to <em>purpose</em>. If specified, the verifications on the store will check every …\n"],["purpose=","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-purpose-3D","(p1)","<p>Sets the purpose of the context. See Store#purpose=.\n"],["puts","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-puts","(*args)","<p>Writes <em>args</em> to the stream along with a record separator.\n<p>See IO#puts for full details.\n"],["random_add","OpenSSL::Random","OpenSSL/Random.html#method-c-random_add","(p1, p2)","<p>Mixes the bytes from <em>str</em> into the Pseudo Random Number Generator(PRNG) state.\n<p>Thus, if the data from …\n"],["random_bytes","OpenSSL::Random","OpenSSL/Random.html#method-c-random_bytes","(p1)","<p>Generates a String with <em>length</em> number of cryptographically strong pseudo-random bytes.\n<p>Example\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">OpenSSL</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Random</span>.<span class=\"ruby-identifier\">random_bytes</span>(<span class=\"ruby-value\">12</span>) <span class=\"ruby-operator\">...</span>\n</pre>\n"],["random_iv","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-random_iv","()","<p>Generate a random IV with OpenSSL::Random.random_bytes and sets it to the cipher, and returns it.\n<p>You …\n"],["random_key","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-random_key","()","<p>Generate a random key with OpenSSL::Random.random_bytes and sets it to the cipher, and returns it.\n<p>You …\n"],["read","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-read","(size=nil, buf=nil)","<p>Reads <em>size</em> bytes from the stream. If <em>buf</em> is provided it must reference a string which will receive the …\n"],["read","OpenSSL::PKey","OpenSSL/PKey.html#method-c-read","(p1, p2 = v2)","<p>Reads a DER or PEM encoded string from <em>string</em> or <em>io</em> and returns an instance of the appropriate PKey class. …\n"],["read_nonblock","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-read_nonblock","(maxlen, buf=nil, exception: true)","<p>Reads at most <em>maxlen</em> bytes in the non-blocking manner.\n<p>When no data can be read without blocking it raises …\n"],["read_smime","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-c-read_smime","(p1)",""],["readchar","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-readchar","()","<p>Reads a one-character string from the stream. Raises an EOFError at end of file.\n"],["readline","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-readline","(eol=$/)","<p>Reads a line from the stream which is separated by <em>eol</em>.\n<p>Raises EOFError if at end of file.\n"],["readlines","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-readlines","(eol=$/)","<p>Reads lines from the stream which are separated by <em>eol</em>.\n<p>See also #gets\n"],["readpartial","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-readpartial","(maxlen, buf=nil)","<p>Reads at most <em>maxlen</em> bytes from the stream. If <em>buf</em> is provided it must reference a string which will …\n"],["recipients","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-recipients","()",""],["register","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-c-register","(p1, p2, p3)","<p>This adds a new ObjectId to the internal tables. Where <em>object_id</em> is the numerical form, <em>short_name</em> is …\n"],["reset","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-reset","()","<p>Fully resets the internal state of the Cipher. By using this, the same Cipher instance may be used several …\n"],["reset","OpenSSL::Digest","OpenSSL/Digest.html#method-i-reset","()","<p>Resets the Digest in the sense that any Digest#update that has been performed is abandoned and the Digest …\n"],["reset","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-reset","()","<p>Returns <em>hmac</em> as it was when it was first initialized, with all processed data cleared from it.\n<p>Example …\n"],["responses","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-responses","()","<p>Returns an Array of SingleResponse for this BasicResponse.\n"],["revocation_reason","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-revocation_reason","()",""],["revocation_time","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-revocation_time","()",""],["revoked","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-revoked","()",""],["revoked=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-revoked-3D","(p1)",""],["rshift!","OpenSSL::BN","OpenSSL/BN.html#method-i-rshift-21","(p1)",""],["scan","OpenSSL::X509::Name::RFC2253DN","OpenSSL/X509/Name/RFC2253DN.html#method-i-scan","(dn)",""],["scrypt","OpenSSL::KDF","OpenSSL/KDF.html#method-c-scrypt","(p1, p2 = {})","<p>Derives a key from <em>pass</em> using given parameters with the scrypt password-based key derivation function. …\n"],["sections","OpenSSL::Config","OpenSSL/Config.html#method-i-sections","()","<p>Get the names of all sections in the current configuration\n"],["secure_compare","OpenSSL","OpenSSL.html#method-c-secure_compare","(a, b)","<p>Constant time memory comparison. Inputs are hashed using SHA-256 to mask the length of the secret. Returns …\n"],["security_level","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-security_level","()","<p>Returns the security level for the context.\n<p>See also OpenSSL::SSL::SSLContext#security_level=.\n"],["security_level=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-security_level-3D","(p1)","<p>Sets the security level for the context. OpenSSL limits parameters according to the level. The “parameters” …\n"],["seed","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-seed","()","<p>See the OpenSSL documentation for EC_GROUP_get0_seed()\n"],["seed","OpenSSL::Random","OpenSSL/Random.html#method-c-seed","(p1)","<p>::seed is equivalent to ::add where <em>entropy</em> is length of <em>str</em>.\n"],["seed=","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-seed-3D","(p1)","<p>See the OpenSSL documentation for EC_GROUP_set_seed()\n"],["serial","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-serial","()","<p>Returns the serial number of the certificate for which status is being requested.\n"],["serial","OpenSSL::PKCS7::RecipientInfo","OpenSSL/PKCS7/RecipientInfo.html#method-i-serial","()",""],["serial","OpenSSL::PKCS7::SignerInfo","OpenSSL/PKCS7/SignerInfo.html#method-i-serial","()",""],["serial","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-serial","()",""],["serial","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-serial","()",""],["serial=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-serial-3D","(p1)",""],["serial=","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-serial-3D","(p1)",""],["serial_number","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-serial_number","()","<p>Returns serial number of the timestamp token. This value shall never be the same for two timestamp tokens …\n"],["session","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-session","()","<p>Returns the SSLSession object currently used, or nil if the session is not established.\n"],["session=","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-session-3D","(p1)","<p>Sets the Session to be used when the connection is established.\n"],["session_add","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_add","(p1)","<p>Adds <em>session</em> to the session cache.\n"],["session_cache_mode","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_cache_mode","()","<p>The current session cache mode.\n"],["session_cache_mode=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_cache_mode-3D","(p1)","<p>Sets the SSL session cache mode. Bitwise-or together the desired SESSION_CACHE_* constants to set. …\n"],["session_cache_size","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_cache_size","()","<p>Returns the current session cache size. Zero is used to represent an unlimited cache size.\n"],["session_cache_size=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_cache_size-3D","(p1)","<p>Sets the session cache size. Returns the previously valid session cache size. Zero is used to represent …\n"],["session_cache_stats","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_cache_stats","()","<p>Returns a Hash containing the following keys:\n<p>:accept — Number of started SSL/TLS handshakes in server mode …\n"],["session_remove","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-session_remove","(p1)","<p>Removes <em>session</em> from the session cache.\n"],["session_reused?","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-session_reused-3F","()","<p>Returns <code>true</code> if a reused session was negotiated during the handshake.\n"],["set_bit!","OpenSSL::BN","OpenSSL/BN.html#method-i-set_bit-21","(p1)",""],["set_crt_params","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-set_crt_params","(p1, p2, p3)","<p>Sets <em>dmp1</em>, <em>dmq1</em>, <em>iqmp</em> for the RSA instance. They are calculated by <code>d mod (p - 1)</code>, <code>d mod (q - 1)</code> and …\n"],["set_default","OpenSSL::Engine","OpenSSL/Engine.html#method-i-set_default","(p1)","<p>Set the defaults for this engine with the given <em>flag</em>.\n<p>These flags are used to control combinations of …\n"],["set_default_paths","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-set_default_paths","()","<p>Configures <em>store</em> to look up CA certificates from the system default certificate store as needed basis. …\n"],["set_factors","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-set_factors","(p1, p2)","<p>Sets <em>p</em>, <em>q</em> for the RSA instance.\n"],["set_generator","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-set_generator","(p1, p2, p3)","<p>Sets the curve parameters. <em>generator</em> must be an instance of EC::Point that is on the curve. <em>order</em> and …\n"],["set_key","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-set_key","(p1, p2)","<p>Sets <em>pub_key</em> and <em>priv_key</em> for the DH instance. <em>priv_key</em> may be <code>nil</code>.\n"],["set_key","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-set_key","(p1, p2)","<p>Sets <em>pub_key</em> and <em>priv_key</em> for the DSA instance. <em>priv_key</em> may be <code>nil</code>.\n"],["set_key","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-set_key","(p1, p2, p3)","<p>Sets <em>n</em>, <em>e</em>, <em>d</em> for the RSA instance.\n"],["set_params","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-set_params","(params={})","<p>Sets saner defaults optimized for the use with HTTP-like protocols.\n<p>If a Hash <em>params</em> is given, the parameters …\n"],["set_pqg","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-set_pqg","(p1, p2, p3)","<p>Sets <em>p</em>, <em>q</em>, <em>g</em> to the DH instance.\n"],["set_pqg","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-set_pqg","(p1, p2, p3)","<p>Sets <em>p</em>, <em>q</em>, <em>g</em> to the DSA instance.\n"],["set_to_infinity!","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-set_to_infinity-21","()",""],["setsockopt","OpenSSL::SSL::SocketForwarder","OpenSSL/SSL/SocketForwarder.html#method-i-setsockopt","(level, optname, optval)",""],["setup","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-setup","()","<p>This method is called automatically when a new SSLSocket is created. However, it is not thread-safe and …\n"],["short_name","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-short_name","()","<p>The short name of the ObjectId, as defined in <openssl/objects.h>.\n"],["shutdown","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-i-shutdown","(how=Socket::SHUT_RDWR)","<p>See BasicSocket#shutdown for details.\n"],["sign","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-sign","(p1, p2)","<p>Parameters\n<p><em>key</em> - the private key to be used for signing this instance\n<p><em>digest</em> - the digest to be used for …\n"],["sign","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-sign","(p1, p2, p3 = v3, p4 = v4, p5 = v5)","<p>Signs this OCSP response using the <em>cert</em>, <em>key</em> and optional <em>digest</em>. This behaves in the similar way as …\n"],["sign","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-sign","(p1, p2, p3 = v3, p4 = v4, p5 = v5)","<p>Signs this OCSP request using <em>cert</em>, <em>key</em> and optional <em>digest</em>. If <em>digest</em> is not specified, SHA-1 is used. …\n"],["sign","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-c-sign","(p1, p2, p3, p4 = v4, p5 = v5)",""],["sign","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-sign","(p1, p2)","<p>To sign the String <em>data</em>, <em>digest</em>, an instance of OpenSSL::Digest, must be provided. The return value is …\n"],["sign","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-sign","(p1, p2)",""],["sign","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-sign","(p1, p2)",""],["sign","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-sign","(p1, p2)",""],["sign_pss","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-sign_pss","(p1, p2, p3 = {})","<p>Signs <em>data</em> using the Probabilistic Signature Scheme (RSA-PSS) and returns the calculated signature.\n<p>RSAError …\n"],["signature_algorithm","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-signature_algorithm","()",""],["signature_algorithm","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-signature_algorithm","()",""],["signature_algorithm","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-signature_algorithm","()",""],["signed?","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-signed-3F","()","<p>Returns <code>true</code> if the request is signed, <code>false</code> otherwise. Note that the validity of the signature is <strong>not</strong> …\n"],["signed_time","OpenSSL::PKCS7::SignerInfo","OpenSSL/PKCS7/SignerInfo.html#method-i-signed_time","()",""],["signers","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-signers","()",""],["sn","OpenSSL::ASN1::ObjectId","OpenSSL/ASN1/ObjectId.html#method-i-sn","()","<p>The short name of the ObjectId, as defined in <openssl/objects.h>.\n"],["sqr","OpenSSL::BN","OpenSSL/BN.html#method-i-sqr","()",""],["ssl_version","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-ssl_version","()","<p>Returns a String representing the SSL/TLS version that was negotiated for the connection, for example …\n"],["ssl_version=","OpenSSL::SSL::SSLContext","OpenSSL/SSL/SSLContext.html#method-i-ssl_version-3D","(meth)","<p>Sets the SSL/TLS protocol version for the context. This forces connections to use only the specified …\n"],["state","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-state","()","<p>A description of the current connection state. This is for diagnostic purposes only.\n"],["status","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-status","()","<p>Returns an Array of statuses for this response. Each status contains a CertificateId, the status (0 …\n"],["status","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-i-status","()","<p>Returns the status of the response.\n"],["status","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-status","()","<p>Returns one of GRANTED, GRANTED_WITH_MODS, REJECTION, WAITING, REVOCATION_WARNING or REVOCATION_NOTIFICATION …\n"],["status?","OpenSSL::Random","OpenSSL/Random.html#method-c-status-3F","()","<p>Return <code>true</code> if the PRNG has been seeded with enough data, <code>false</code> otherwise.\n"],["status_string","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-i-status_string","()","<p>Returns a status string for the response.\n"],["status_text","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-status_text","()","<p>In cases of failure this field may contain an array of strings further describing the origin of the failure. …\n"],["subject","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-subject","()",""],["subject","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-subject","()",""],["subject=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-subject-3D","(p1)",""],["subject=","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-subject-3D","(p1)",""],["subject_certificate=","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-subject_certificate-3D","(p1)",""],["subject_key_identifier","OpenSSL::X509::Extension::SubjectKeyIdentifier","OpenSSL/X509/Extension/SubjectKeyIdentifier.html#method-i-subject_key_identifier","()","<p>Get the subject’s key identifier from the subjectKeyIdentifier exteension, as described in RFC5280 …\n"],["subject_request=","OpenSSL::X509::ExtensionFactory","OpenSSL/X509/ExtensionFactory.html#method-i-subject_request-3D","(p1)",""],["sysclose","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-sysclose","()","<p>Sends “close notify” to the peer and tries to shut down the SSL connection gracefully.\n<p>If sync_close …\n"],["sysread","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-sysread","(*args)","<p>Reads <em>length</em> bytes from the SSL connection. If a pre-allocated <em>buffer</em> is provided the data will be written …\n"],["syssign","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-syssign","(p1)","<p>Computes and returns the DSA signature of <em>string</em>, where <em>string</em> is expected to be an already-computed …\n"],["sysverify","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-sysverify","(p1, p2)","<p>Verifies whether the signature is valid given the message digest input. It does so by validating <em>sig</em> …\n"],["syswrite","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-syswrite","(p1)","<p>Writes <em>string</em> to the SSL connection.\n"],["this_update","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-this_update","()",""],["time","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-time","()","<p>Returns the time at which the session was established.\n"],["time","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-time","()",""],["time=","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-time-3D","(p1)","<p>Sets start time of the session. Time resolution is in seconds.\n"],["time=","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-time-3D","(p1)",""],["time=","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-time-3D","(p1)","<p>Sets the time to be used in verifications.\n"],["time=","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-time-3D","(p1)","<p>Sets the time used in the verification. If not set, the current time is used.\n"],["timeout","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-timeout","()","<p>Returns the timeout value set for the session, in seconds from the established time.\n"],["timeout=","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-timeout-3D","(p1)","<p>Sets how long until the session expires in seconds.\n"],["tmp_key","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-tmp_key","()","<p>Returns the ephemeral key used in case of forward secrecy cipher.\n"],["to_a","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-to_a","()",""],["to_a","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-to_a","()","<p>Returns an Array representation of the distinguished name suitable for passing to ::new\n"],["to_bn","Integer","Integer.html#method-i-to_bn","()","<p>Casts an Integer as an OpenSSL::BN\n<p>See ‘man bn` for more info.\n"],["to_bn","OpenSSL::BN","OpenSSL/BN.html#method-i-to_bn","()",""],["to_bn","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-to_bn","(conversion_form = group.point_conversion_form)","<p>Returns the octet string representation of the EC point as an instance of OpenSSL::BN.\n<p>If <em>conversion_form</em> …\n"],["to_der","OpenSSL::ASN1::ASN1Data","OpenSSL/ASN1/ASN1Data.html#method-i-to_der","()","<p>Encodes this ASN1Data into a DER-encoded String value. The result is DER-encoded except for the possibility …\n"],["to_der","OpenSSL::ASN1::Constructive","OpenSSL/ASN1/Constructive.html#method-i-to_der","()","<p>See ASN1Data#to_der for details.\n"],["to_der","OpenSSL::ASN1::Primitive","OpenSSL/ASN1/Primitive.html#method-i-to_der","()","<p>See ASN1Data#to_der for details.\n"],["to_der","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-to_der","()","<p>Returns the DER encoding of this SPKI.\n"],["to_der","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-to_der","()","<p>Encodes this basic response into a DER-encoded string.\n"],["to_der","OpenSSL::OCSP::CertificateId","OpenSSL/OCSP/CertificateId.html#method-i-to_der","()","<p>Encodes this certificate identifier into a DER-encoded string.\n"],["to_der","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-to_der","()","<p>Returns this request as a DER-encoded string\n"],["to_der","OpenSSL::OCSP::Response","OpenSSL/OCSP/Response.html#method-i-to_der","()","<p>Returns this response as a DER-encoded string.\n"],["to_der","OpenSSL::OCSP::SingleResponse","OpenSSL/OCSP/SingleResponse.html#method-i-to_der","()","<p>Encodes this SingleResponse into a DER-encoded string.\n"],["to_der","OpenSSL::PKCS12","OpenSSL/PKCS12.html#method-i-to_der","()",""],["to_der","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-to_der","()",""],["to_der","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-to_der","()","<p>Encodes this DH to its DER encoding. Note that any existing per-session public/private keys will <strong>not</strong> …\n"],["to_der","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-to_der","()","<p>Encodes this DSA to its DER encoding.\n"],["to_der","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-to_der","()","<p>See the OpenSSL documentation for i2d_ECPrivateKey_bio()\n"],["to_der","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-to_der","()","<p>See the OpenSSL documentation for i2d_ECPKParameters_bio()\n"],["to_der","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-to_der","()","<p>Outputs this keypair in DER encoding.\n"],["to_der","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-to_der","()","<p>Returns an ASN1 encoded String that contains the Session object.\n"],["to_der","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-to_der","()","<p>DER-encodes this Request.\n"],["to_der","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-to_der","()","<p>Returns the Response in DER-encoded form.\n"],["to_der","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-to_der","()","<p>Returns the TokenInfo in DER-encoded form.\n"],["to_der","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-to_der","()",""],["to_der","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-to_der","()",""],["to_der","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-to_der","()",""],["to_der","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-to_der","()",""],["to_der","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-to_der","()","<p>Converts the name to DER encoding\n"],["to_der","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-to_der","()",""],["to_der","OpenSSL::X509::Revoked","OpenSSL/X509/Revoked.html#method-i-to_der","()",""],["to_h","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-to_h","()",""],["to_i","OpenSSL::BN","OpenSSL/BN.html#method-i-to_i","()",""],["to_int","OpenSSL::BN","OpenSSL/BN.html#method-i-to_int","()",""],["to_io","OpenSSL::SSL::SSLServer","OpenSSL/SSL/SSLServer.html#method-i-to_io","()","<p>Returns the TCPServer passed to the SSLServer when initialized.\n"],["to_octet_string","OpenSSL::PKey::EC::Point","OpenSSL/PKey/EC/Point.html#method-i-to_octet_string","(p1)","<p>Returns the octet string representation of the elliptic curve point.\n<p><em>conversion_form</em> specifies how the …\n"],["to_pem","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-to_pem","()","<p>Returns the PEM encoding of this SPKI.\n"],["to_pem","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-to_pem","()",""],["to_pem","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-to_pem","()","<p>Encodes this DH to its PEM encoding. Note that any existing per-session public/private keys will <strong>not</strong> …\n"],["to_pem","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-to_pem","(p1 = v1, p2 = v2)","<p>Encodes this DSA to its PEM encoding.\n<p>Parameters\n<p><em>cipher</em> is an OpenSSL::Cipher.\n"],["to_pem","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-to_pem","(p1 = v1, p2 = v2)","<p>Outputs the EC key in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt …\n"],["to_pem","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-to_pem","()","<p>See the OpenSSL documentation for PEM_write_bio_ECPKParameters()\n"],["to_pem","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-to_pem","(p1 = v1, p2 = v2)","<p>Outputs this keypair in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt …\n"],["to_pem","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-to_pem","()","<p>Returns a PEM encoded String that contains the Session object.\n"],["to_pem","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-to_pem","()",""],["to_pem","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-to_pem","()",""],["to_pem","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-to_pem","()",""],["to_s","OpenSSL::BN","OpenSSL/BN.html#method-i-to_s","(p1 = v1)","<p>Parameters\n<p><em>base</em> - Integer Valid values:\n<p>0 - MPI\n"],["to_s","OpenSSL::Config","OpenSSL/Config.html#method-i-to_s","()","<p>Get the parsable form of the current configuration\n<p>Given the following configuration being created:\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">config</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["to_s","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-to_s","()","<p>Returns the authentication code as a hex-encoded string. The <em>digest</em> parameter specifies the digest algorithm …\n"],["to_s","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-to_s","()","<p>Returns the PEM encoding of this SPKI.\n"],["to_s","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-to_s","()",""],["to_s","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-to_s","()","<p>Encodes this DH to its PEM encoding. Note that any existing per-session public/private keys will <strong>not</strong> …\n"],["to_s","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-to_s","(p1 = v1, p2 = v2)","<p>Encodes this DSA to its PEM encoding.\n<p>Parameters\n<p><em>cipher</em> is an OpenSSL::Cipher.\n"],["to_s","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-to_s","(p1 = v1, p2 = v2)","<p>Outputs this keypair in PEM encoding. If <em>cipher</em> and <em>pass_phrase</em> are given they will be used to encrypt …\n"],["to_s","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-to_s","()",""],["to_s","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-to_s","()",""],["to_s","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-to_s","()",""],["to_s","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-to_s","(*args)","<p>Returns a String representation of the Distinguished Name. <em>format</em> is one of:\n<p>OpenSSL::X509::Name::COMPAT …\n"],["to_s","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-to_s","()",""],["to_text","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-to_text","()","<p>Returns a textual representation of this SPKI, useful for debugging purposes.\n"],["to_text","OpenSSL::PKey::DH","OpenSSL/PKey/DH.html#method-i-to_text","()","<p>Prints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don’t use :-)) …\n"],["to_text","OpenSSL::PKey::DSA","OpenSSL/PKey/DSA.html#method-i-to_text","()","<p>Prints all parameters of key to buffer INSECURE: PRIVATE INFORMATIONS CAN LEAK OUT!!! Don’t use :-)) …\n"],["to_text","OpenSSL::PKey::EC","OpenSSL/PKey/EC.html#method-i-to_text","()","<p>See the OpenSSL documentation for EC_KEY_print()\n"],["to_text","OpenSSL::PKey::EC::Group","OpenSSL/PKey/EC/Group.html#method-i-to_text","()","<p>See the OpenSSL documentation for ECPKParameters_print()\n"],["to_text","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-to_text","()","<p>THIS METHOD IS INSECURE, PRIVATE INFORMATION CAN LEAK OUT!!!\n<p>Dumps all parameters of a keypair to a String …\n"],["to_text","OpenSSL::SSL::Session","OpenSSL/SSL/Session.html#method-i-to_text","()","<p>Shows everything in the Session object. This is for diagnostic purposes.\n"],["to_text","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-to_text","()",""],["to_text","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-to_text","()",""],["to_text","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-to_text","()",""],["to_utf8","OpenSSL::X509::Name","OpenSSL/X509/Name.html#method-i-to_utf8","()","<p>Returns an UTF-8 representation of the distinguished name, as specified in RFC 2253.\n"],["token","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-token","()","<p>If a timestamp token is present, this returns it in the form of a OpenSSL::PKCS7.\n"],["token_info","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-token_info","()","<p>Get the response’s token info if present.\n"],["traverse","OpenSSL::ASN1","OpenSSL/ASN1.html#method-c-traverse","(p1)","<p>If a block is given, it prints out each of the elements encountered. Block parameters are (in that order): …\n"],["trust=","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-trust-3D","(p1)",""],["trust=","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-trust-3D","(p1)",""],["tsa_certificate","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-tsa_certificate","()","<p>If the Request specified to request the TSA certificate (Request#cert_requested = true), then this field …\n"],["type","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-type","()",""],["type=","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-type-3D","(p1)",""],["ucmp","OpenSSL::BN","OpenSSL/BN.html#method-i-ucmp","(p1)",""],["ungetc","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-ungetc","(c)","<p>Pushes character <em>c</em> back onto the stream such that a subsequent buffered character read will return it. …\n"],["update","OpenSSL::Cipher","OpenSSL/Cipher.html#method-i-update","(p1, p2 = v2)","<p>Encrypts data in a streaming fashion. Hand consecutive blocks of data to the #update method in order …\n"],["update","OpenSSL::Digest","OpenSSL/Digest.html#method-i-update","(p1)","<p>Not every message digest can be computed in one single pass. If a message digest is to be computed from …\n"],["update","OpenSSL::HMAC","OpenSSL/HMAC.html#method-i-update","(p1)","<p>Returns <em>hmac</em> updated with the message to be authenticated. Can be called repeatedly with chunks of the …\n"],["value","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-value","()",""],["value","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-value","()",""],["value=","OpenSSL::X509::Attribute","OpenSSL/X509/Attribute.html#method-i-value-3D","(p1)",""],["value=","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-value-3D","(p1)",""],["value_der","OpenSSL::X509::Extension","OpenSSL/X509/Extension.html#method-i-value_der","()",""],["verify","OpenSSL::Netscape::SPKI","OpenSSL/Netscape/SPKI.html#method-i-verify","(p1)","<p>Parameters\n<p><em>key</em> - the public key to be used for verifying the SPKI signature\n\n<p>Returns <code>true</code> if the signature …\n"],["verify","OpenSSL::OCSP::BasicResponse","OpenSSL/OCSP/BasicResponse.html#method-i-verify","(p1, p2, p3 = v3)","<p>Verifies the signature of the response using the given <em>certificates</em> and <em>store</em>. This works in the similar …\n"],["verify","OpenSSL::OCSP::Request","OpenSSL/OCSP/Request.html#method-i-verify","(p1, p2, p3 = v3)","<p>Verifies this request using the given <em>certificates</em> and <em>store</em>. <em>certificates</em> is an array of OpenSSL::X509::Certificate …\n"],["verify","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-i-verify","(p1, p2, p3 = v3, p4 = v4)",""],["verify","OpenSSL::PKey::PKey","OpenSSL/PKey/PKey.html#method-i-verify","(p1, p2, p3)","<p>To verify the String <em>signature</em>, <em>digest</em>, an instance of OpenSSL::Digest, must be provided to re-compute …\n"],["verify","OpenSSL::Timestamp::Response","OpenSSL/Timestamp/Response.html#method-i-verify","(p1, p2, p3 = v3)","<p>Verifies a timestamp token by checking the signature, validating the certificate chain implied by tsa_certificate …\n"],["verify","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-verify","(p1)",""],["verify","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-verify","(p1)","<p>Verifies the signature of the certificate, with the public key <em>key</em>. <em>key</em> must be an instance of OpenSSL::PKey …\n"],["verify","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-verify","(p1)","<p>Checks that cert signature is made with PRIVversion of this PUBLIC ‘key’\n"],["verify","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-verify","(p1, p2 = v2)","<p>Performs a certificate verification on the OpenSSL::X509::Certificate <em>cert</em>.\n<p><em>chain</em> can be an array of …\n"],["verify","OpenSSL::X509::StoreContext","OpenSSL/X509/StoreContext.html#method-i-verify","()",""],["verify_callback=","OpenSSL::X509::Store","OpenSSL/X509/Store.html#method-i-verify_callback-3D","(p1)","<p>General callback for OpenSSL verify\n"],["verify_certificate_identity","OpenSSL::SSL","OpenSSL/SSL.html#method-c-verify_certificate_identity","(cert, hostname)",""],["verify_pss","OpenSSL::PKey::RSA","OpenSSL/PKey/RSA.html#method-i-verify_pss","(p1, p2, p3, p4 = {})","<p>Verifies <em>data</em> using the Probabilistic Signature Scheme (RSA-PSS).\n<p>The return value is <code>true</code> if the signature …\n"],["verify_result","OpenSSL::SSL::SSLSocket","OpenSSL/SSL/SSLSocket.html#method-i-verify_result","()","<p>Returns the result of the peer certificates verification. See verify(1) for error values and descriptions. …\n"],["version","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-version","()","<p>Returns the version of this request. <code>1</code> is the default value.\n"],["version","OpenSSL::Timestamp::TokenInfo","OpenSSL/Timestamp/TokenInfo.html#method-i-version","()","<p>Returns the version number of the token info. With compliant servers, this value should be <code>1</code> if present. …\n"],["version","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-version","()",""],["version","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-version","()",""],["version","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-version","()",""],["version=","OpenSSL::Timestamp::Request","OpenSSL/Timestamp/Request.html#method-i-version-3D","(p1)","<p>Sets the version number for this Request. This should be <code>1</code> for compliant servers.\n"],["version=","OpenSSL::X509::CRL","OpenSSL/X509/CRL.html#method-i-version-3D","(p1)",""],["version=","OpenSSL::X509::Certificate","OpenSSL/X509/Certificate.html#method-i-version-3D","(p1)",""],["version=","OpenSSL::X509::Request","OpenSSL/X509/Request.html#method-i-version-3D","(p1)",""],["write","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-write","(*s)","<p>Writes <em>s</em> to the stream. If the argument is not a String it will be converted using <code>.to_s</code> method. Returns …\n"],["write_nonblock","OpenSSL::Buffering","OpenSSL/Buffering.html#method-i-write_nonblock","(s, exception: true)","<p>Writes <em>s</em> in the non-blocking manner.\n<p>If there is buffered data, it is flushed first. This may block. …\n"],["write_random_file","OpenSSL::Random","OpenSSL/Random.html#method-c-write_random_file","(p1)","<p>Writes a number of random generated bytes (currently 1024) to <em>filename</em> which can be used to initialize …\n"],["write_smime","OpenSSL::PKCS7","OpenSSL/PKCS7.html#method-c-write_smime","(p1, p2 = v2, p3 = v3)",""],["zero?","OpenSSL::BN","OpenSSL/BN.html#method-i-zero-3F","()",""],["CONTRIBUTING","","CONTRIBUTING_md.html","","<p>Contributing to Ruby OpenSSL\n<p>Thank you for your interest in contributing to Ruby OpenSSL!\n<p>This documentation …\n"],["History","","History_md.html","","<p>Version 2.2.1\n<p>Merged changes in 2.1.3. Additionally, the following issues are fixed by this\nrelease.\n<p>Bug …\n"],["README","","README_md.html","","<p>OpenSSL for Ruby\n<p><img src=\"https://github.com/ruby/openssl/workflows/CI/badge.svg\">\n<p>OpenSSL provides SSL …\n"]]}}
\ No newline at end of file diff --git a/table_of_contents.html b/table_of_contents.html index e211da24..8eea10a6 100644 --- a/table_of_contents.html +++ b/table_of_contents.html @@ -21,943 +21,556 @@ <link href="./css/rdoc.css" rel="stylesheet"> - - <body id="top" class="table-of-contents"> <main role="main"> <h1 class="class">Table of Contents - RDoc Documentation</h1> - - <h2 id="pages">Pages</h2> <ul> - <li class="file"> <a href="CONTRIBUTING_md.html">CONTRIBUTING</a> <ul> - <li><a href="CONTRIBUTING_md.html#label-Contributing+to+Ruby+OpenSSL">Contributing to Ruby OpenSSL</a> - <li><a href="CONTRIBUTING_md.html#label-Bugs+and+feature+requests">Bugs and feature requests</a> - <li><a href="CONTRIBUTING_md.html#label-Submitting+patches">Submitting patches</a> - <li><a href="CONTRIBUTING_md.html#label-Testing">Testing</a> - <li><a href="CONTRIBUTING_md.html#label-Docker">Docker</a> - <li><a href="CONTRIBUTING_md.html#label-Relation+with+Ruby+source+tree">Relation with Ruby source tree</a> - <li><a href="CONTRIBUTING_md.html#label-Release+policy">Release policy</a> - <li><a href="CONTRIBUTING_md.html#label-Security">Security</a> - </ul> - </li> - <li class="file"> <a href="History_md.html">History</a> <ul> - + <li><a href="History_md.html#label-Version+2.2.1">Version 2.2.1</a> + <li><a href="History_md.html#label-Bug+fixes">Bug fixes</a> <li><a href="History_md.html#label-Version+2.2.0">Version 2.2.0</a> - <li><a href="History_md.html#label-Compatibility+notes">Compatibility notes</a> - <li><a href="History_md.html#label-Notable+changes">Notable changes</a> - + <li><a href="History_md.html#label-Version+2.1.3">Version 2.1.3</a> + <li><a href="History_md.html#label-Bug+fixes">Bug fixes</a> <li><a href="History_md.html#label-Version+2.1.2">Version 2.1.2</a> - <li><a href="History_md.html#label-Version+2.1.1">Version 2.1.1</a> - <li><a href="History_md.html#label-Version+2.1.0">Version 2.1.0</a> - <li><a href="History_md.html#label-Notable+changes">Notable changes</a> - <li><a href="History_md.html#label-Version+2.0.9">Version 2.0.9</a> - <li><a href="History_md.html#label-Security+fixes">Security fixes</a> - <li><a href="History_md.html#label-Bug+fixes">Bug fixes</a> - <li><a href="History_md.html#label-Version+2.0.8">Version 2.0.8</a> - <li><a href="History_md.html#label-Bug+fixes">Bug fixes</a> - <li><a href="History_md.html#label-Version+2.0.7">Version 2.0.7</a> - <li><a href="History_md.html#label-Bug+fixes">Bug fixes</a> - <li><a href="History_md.html#label-Version+2.0.6">Version 2.0.6</a> - <li><a href="History_md.html#label-Bug+fixes">Bug fixes</a> - <li><a href="History_md.html#label-Version+2.0.5">Version 2.0.5</a> - <li><a href="History_md.html#label-Bug+fixes">Bug fixes</a> - <li><a href="History_md.html#label-Version+2.0.4">Version 2.0.4</a> - <li><a href="History_md.html#label-Bug+fixes">Bug fixes</a> - <li><a href="History_md.html#label-Version+2.0.3">Version 2.0.3</a> - <li><a href="History_md.html#label-Bug+fixes">Bug fixes</a> - <li><a href="History_md.html#label-Version+2.0.2">Version 2.0.2</a> - <li><a href="History_md.html#label-Bug+fixes">Bug fixes</a> - <li><a href="History_md.html#label-Version+2.0.1">Version 2.0.1</a> - <li><a href="History_md.html#label-Bug+fixes">Bug fixes</a> - <li><a href="History_md.html#label-Version+2.0.0">Version 2.0.0</a> - <li><a href="History_md.html#label-Compatibility+notes">Compatibility notes</a> - <li><a href="History_md.html#label-Supported+platforms">Supported platforms</a> - <li><a href="History_md.html#label-Notable+changes">Notable changes</a> - <li><a href="History_md.html#label-Removals">Removals</a> - <li><a href="History_md.html#label-Deprecations">Deprecations</a> - </ul> - </li> - <li class="file"> <a href="README_md.html">README</a> <ul> - <li><a href="README_md.html#label-OpenSSL+for+Ruby">OpenSSL for Ruby</a> - <li><a href="README_md.html#label-Installation">Installation</a> - <li><a href="README_md.html#label-Usage">Usage</a> - <li><a href="README_md.html#label-Documentation">Documentation</a> - <li><a href="README_md.html#label-Contributing">Contributing</a> - <li><a href="README_md.html#label-Security">Security</a> - </ul> - </li> - </ul> - <h2 id="classes">Classes and Modules</h2> <ul> - <li class="class"> <a href="IO.html">IO</a> - </li> - <li class="module"> <a href="IO/WaitReadable.html">IO::WaitReadable</a> - </li> - <li class="module"> <a href="IO/WaitWritable.html">IO::WaitWritable</a> - </li> - <li class="class"> <a href="Integer.html">Integer</a> - </li> - <li class="module"> <a href="OpenSSL.html">OpenSSL</a> <ul> - <li><a href="OpenSSL.html#label-Examples">Examples</a> - <li><a href="OpenSSL.html#label-Keys">Keys</a> - <li><a href="OpenSSL.html#label-Creating+a+Key">Creating a Key</a> - <li><a href="OpenSSL.html#label-Exporting+a+Key">Exporting a Key</a> - <li><a href="OpenSSL.html#label-Loading+a+Key">Loading a Key</a> - <li><a href="OpenSSL.html#label-Loading+an+Encrypted+Key">Loading an Encrypted Key</a> - <li><a href="OpenSSL.html#label-RSA+Encryption">RSA Encryption</a> - <li><a href="OpenSSL.html#label-Encryption+-26+Decryption">Encryption & Decryption</a> - <li><a href="OpenSSL.html#label-Signatures">Signatures</a> - <li><a href="OpenSSL.html#label-PBKDF2+Password-based+Encryption">PBKDF2 Password-based Encryption</a> - <li><a href="OpenSSL.html#label-Encryption">Encryption</a> - <li><a href="OpenSSL.html#label-Decryption">Decryption</a> - <li><a href="OpenSSL.html#label-PKCS+-235+Password-based+Encryption">PKCS #5 Password-based Encryption</a> - <li><a href="OpenSSL.html#label-Encryption">Encryption</a> - <li><a href="OpenSSL.html#label-Decryption">Decryption</a> - <li><a href="OpenSSL.html#label-X509+Certificates">X509 Certificates</a> - <li><a href="OpenSSL.html#label-Creating+a+Certificate">Creating a Certificate</a> - <li><a href="OpenSSL.html#label-Certificate+Extensions">Certificate Extensions</a> - <li><a href="OpenSSL.html#label-Signing+a+Certificate">Signing a Certificate</a> - <li><a href="OpenSSL.html#label-Loading+a+Certificate">Loading a Certificate</a> - <li><a href="OpenSSL.html#label-Verifying+a+Certificate">Verifying a Certificate</a> - <li><a href="OpenSSL.html#label-Certificate+Authority">Certificate Authority</a> - <li><a href="OpenSSL.html#label-CA+Key">CA Key</a> - <li><a href="OpenSSL.html#label-CA+Certificate">CA Certificate</a> - <li><a href="OpenSSL.html#label-Certificate+Signing+Request">Certificate Signing Request</a> - <li><a href="OpenSSL.html#label-Creating+a+Certificate+from+a+CSR">Creating a Certificate from a CSR</a> - <li><a href="OpenSSL.html#label-SSL+and+TLS+Connections">SSL and TLS Connections</a> - <li><a href="OpenSSL.html#label-SSL+Server">SSL Server</a> - <li><a href="OpenSSL.html#label-SSL+client">SSL client</a> - <li><a href="OpenSSL.html#label-Peer+Verification">Peer Verification</a> - </ul> - </li> - <li class="module"> <a href="OpenSSL/ASN1.html">OpenSSL::ASN1</a> <ul> - <li><a href="OpenSSL/ASN1.html#label-ASN.1+class+hierarchy">ASN.1 class hierarchy</a> - <li><a href="OpenSSL/ASN1.html#label-Constructive">Constructive</a> - <li><a href="OpenSSL/ASN1.html#label-ASN1-3A-3ASet+and+ASN1-3A-3ASequence">ASN1::Set and ASN1::Sequence</a> - <li><a href="OpenSSL/ASN1.html#label-Primitive">Primitive</a> - <li><a href="OpenSSL/ASN1.html#label-Possible+values+for+tagging">Possible values for <em>tagging</em></a> - <li><a href="OpenSSL/ASN1.html#label-Possible+values+for+tag_class">Possible values for <em>tag_class</em></a> - <li><a href="OpenSSL/ASN1.html#label-Tag+constants">Tag constants</a> - <li><a href="OpenSSL/ASN1.html#label-UNIVERSAL_TAG_NAME+constant">UNIVERSAL_TAG_NAME constant</a> - <li><a href="OpenSSL/ASN1.html#label-Example+usage">Example usage</a> - <li><a href="OpenSSL/ASN1.html#label-Decoding+and+viewing+a+DER-encoded+file">Decoding and viewing a DER-encoded file</a> - <li><a href="OpenSSL/ASN1.html#label-Creating+an+ASN.1+structure+and+DER-encoding+it">Creating an ASN.1 structure and DER-encoding it</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/ASN1/ASN1Data.html">OpenSSL::ASN1::ASN1Data</a> <ul> - <li><a href="OpenSSL/ASN1/ASN1Data.html#label-The+role+of+ASN1Data+for+parsing+tagged+values">The role of ASN1Data for parsing tagged values</a> - <li><a href="OpenSSL/ASN1/ASN1Data.html#label-Example+of+a+parsed+implicitly+tagged+value">Example of a parsed implicitly tagged value</a> - <li><a href="OpenSSL/ASN1/ASN1Data.html#label-Example+of+a+parsed+explicitly+tagged+value">Example of a parsed explicitly tagged value</a> - <li><a href="OpenSSL/ASN1/ASN1Data.html#label-Example+-+Decoding+an+implicitly+tagged+INTEGER">Example - Decoding an implicitly tagged INTEGER</a> - <li><a href="OpenSSL/ASN1/ASN1Data.html#label-Example+-+Decoding+an+explicitly+tagged+INTEGER">Example - Decoding an explicitly tagged INTEGER</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/ASN1/ASN1Error.html">OpenSSL::ASN1::ASN1Error</a> - </li> - <li class="class"> <a href="OpenSSL/ASN1/Constructive.html">OpenSSL::ASN1::Constructive</a> <ul> - <li><a href="OpenSSL/ASN1/Constructive.html#label-SET+and+SEQUENCE">SET and SEQUENCE</a> - <li><a href="OpenSSL/ASN1/Constructive.html#label-Example+-+constructing+a+SEQUENCE">Example - constructing a SEQUENCE</a> - <li><a href="OpenSSL/ASN1/Constructive.html#label-Example+-+constructing+a+SET">Example - constructing a SET</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/ASN1/ObjectId.html">OpenSSL::ASN1::ObjectId</a> - </li> - <li class="class"> <a href="OpenSSL/ASN1/Primitive.html">OpenSSL::ASN1::Primitive</a> <ul> - <li><a href="OpenSSL/ASN1/Primitive.html#label-Primitive+sub-classes+and+their+mapping+to+Ruby+classes">Primitive sub-classes and their mapping to Ruby classes</a> - <li><a href="OpenSSL/ASN1/Primitive.html#label-OpenSSL-3A-3AASN1-3A-3ABitString">OpenSSL::ASN1::BitString</a> - <li><a href="OpenSSL/ASN1/Primitive.html#label-Additional+attributes">Additional attributes</a> - <li><a href="OpenSSL/ASN1/Primitive.html#label-OpenSSL-3A-3AASN1-3A-3AObjectId">OpenSSL::ASN1::ObjectId</a> - <li><a href="OpenSSL/ASN1/Primitive.html#label-Additional+attributes">Additional attributes</a> - <li><a href="OpenSSL/ASN1/Primitive.html#label-Examples">Examples</a> - <li><a href="OpenSSL/ASN1/Primitive.html#label-Creating+EndOfContent">Creating EndOfContent</a> - <li><a href="OpenSSL/ASN1/Primitive.html#label-Creating+any+other+Primitive">Creating any other Primitive</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/BN.html">OpenSSL::BN</a> - </li> - <li class="class"> <a href="OpenSSL/BNError.html">OpenSSL::BNError</a> - </li> - <li class="module"> <a href="OpenSSL/Buffering.html">OpenSSL::Buffering</a> - </li> - <li class="class"> <a href="OpenSSL/Buffering/Buffer.html">OpenSSL::Buffering::Buffer</a> - </li> - <li class="class"> <a href="OpenSSL/Cipher.html">OpenSSL::Cipher</a> <ul> - <li><a href="OpenSSL/Cipher.html#label-Listing+all+supported+algorithms">Listing all supported algorithms</a> - <li><a href="OpenSSL/Cipher.html#label-Instantiating+a+Cipher">Instantiating a Cipher</a> - <li><a href="OpenSSL/Cipher.html#label-Choosing+either+encryption+or+decryption+mode">Choosing either encryption or decryption mode</a> - <li><a href="OpenSSL/Cipher.html#label-Choosing+a+key">Choosing a key</a> - <li><a href="OpenSSL/Cipher.html#label-Choosing+an+IV">Choosing an IV</a> - <li><a href="OpenSSL/Cipher.html#label-Calling+Cipher-23final">Calling Cipher#final</a> - <li><a href="OpenSSL/Cipher.html#label-Encrypting+and+decrypting+some+data">Encrypting and decrypting some data</a> - <li><a href="OpenSSL/Cipher.html#label-Authenticated+Encryption+and+Associated+Data+-28AEAD-29">Authenticated Encryption and Associated Data (AEAD)</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/Cipher/Cipher.html">OpenSSL::Cipher::Cipher</a> - </li> - <li class="class"> <a href="OpenSSL/Cipher/CipherError.html">OpenSSL::Cipher::CipherError</a> - </li> - <li class="class"> <a href="OpenSSL/Config.html">OpenSSL::Config</a> <ul> - <li><a href="OpenSSL/Config.html#label-OpenSSL-3A-3AConfig">OpenSSL::Config</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/ConfigError.html">OpenSSL::ConfigError</a> - </li> - <li class="class"> <a href="OpenSSL/Digest.html">OpenSSL::Digest</a> <ul> - <li><a href="OpenSSL/Digest.html#label-Hashing+a+file">Hashing a file</a> - <li><a href="OpenSSL/Digest.html#label-Hashing+several+pieces+of+data+at+once">Hashing several pieces of data at once</a> - <li><a href="OpenSSL/Digest.html#label-Reuse+a+Digest+instance">Reuse a Digest instance</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/Digest/DigestError.html">OpenSSL::Digest::DigestError</a> - </li> - <li class="class"> <a href="OpenSSL/Engine.html">OpenSSL::Engine</a> - </li> - <li class="class"> <a href="OpenSSL/Engine/EngineError.html">OpenSSL::Engine::EngineError</a> - </li> - <li class="module"> <a href="OpenSSL/ExtConfig.html">OpenSSL::ExtConfig</a> - </li> - <li class="class"> <a href="OpenSSL/HMAC.html">OpenSSL::HMAC</a> <ul> - <li><a href="OpenSSL/HMAC.html#label-HMAC-SHA256+using+one-shot+interface">HMAC-SHA256 using one-shot interface</a> - <li><a href="OpenSSL/HMAC.html#label-HMAC-SHA256+using+incremental+interface">HMAC-SHA256 using incremental interface</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/HMACError.html">OpenSSL::HMACError</a> <ul> - <li><a href="OpenSSL/HMACError.html#label-HMAC-SHA256+using+one-shot+interface">HMAC-SHA256 using one-shot interface</a> - <li><a href="OpenSSL/HMACError.html#label-HMAC-SHA256+using+incremental+interface">HMAC-SHA256 using incremental interface</a> - </ul> - </li> - <li class="module"> <a href="OpenSSL/KDF.html">OpenSSL::KDF</a> <ul> - <li><a href="OpenSSL/KDF.html#label-Examples">Examples</a> - <li><a href="OpenSSL/KDF.html#label-Generating+a+128+bit+key+for+a+Cipher+-28e.g.+AES-29">Generating a 128 bit key for a Cipher (e.g. AES)</a> - <li><a href="OpenSSL/KDF.html#label-Storing+Passwords">Storing Passwords</a> - <li><a href="OpenSSL/KDF.html#label-Important+Note+on+Checking+Passwords">Important Note on Checking Passwords</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/KDF/KDFError.html">OpenSSL::KDF::KDFError</a> - </li> - <li class="module"> <a href="OpenSSL/Marshal.html">OpenSSL::Marshal</a> - </li> - <li class="module"> <a href="OpenSSL/Marshal/ClassMethods.html">OpenSSL::Marshal::ClassMethods</a> - </li> - <li class="module"> <a href="OpenSSL/Netscape.html">OpenSSL::Netscape</a> - </li> - <li class="class"> <a href="OpenSSL/Netscape/SPKI.html">OpenSSL::Netscape::SPKI</a> <ul> - <li><a href="OpenSSL/Netscape/SPKI.html#label-Examples">Examples</a> - <li><a href="OpenSSL/Netscape/SPKI.html#label-Creating+an+SPKI">Creating an SPKI</a> - <li><a href="OpenSSL/Netscape/SPKI.html#label-Verifying+an+SPKI+request">Verifying an SPKI request</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/Netscape/SPKIError.html">OpenSSL::Netscape::SPKIError</a> - </li> - <li class="module"> <a href="OpenSSL/OCSP.html">OpenSSL::OCSP</a> - </li> - <li class="class"> <a href="OpenSSL/OCSP/BasicResponse.html">OpenSSL::OCSP::BasicResponse</a> - </li> - <li class="class"> <a href="OpenSSL/OCSP/CertificateId.html">OpenSSL::OCSP::CertificateId</a> - </li> - <li class="class"> <a href="OpenSSL/OCSP/OCSPError.html">OpenSSL::OCSP::OCSPError</a> - </li> - <li class="class"> <a href="OpenSSL/OCSP/Request.html">OpenSSL::OCSP::Request</a> - </li> - <li class="class"> <a href="OpenSSL/OCSP/Response.html">OpenSSL::OCSP::Response</a> - </li> - <li class="class"> <a href="OpenSSL/OCSP/SingleResponse.html">OpenSSL::OCSP::SingleResponse</a> - </li> - <li class="class"> <a href="OpenSSL/OpenSSLError.html">OpenSSL::OpenSSLError</a> - </li> - <li class="class"> <a href="OpenSSL/PKCS12.html">OpenSSL::PKCS12</a> - </li> - <li class="class"> <a href="OpenSSL/PKCS12/PKCS12Error.html">OpenSSL::PKCS12::PKCS12Error</a> - </li> - <li class="module"> <a href="OpenSSL/PKCS5.html">OpenSSL::PKCS5</a> - </li> - <li class="class"> <a href="OpenSSL/PKCS7.html">OpenSSL::PKCS7</a> - </li> - <li class="class"> <a href="OpenSSL/PKCS7/PKCS7Error.html">OpenSSL::PKCS7::PKCS7Error</a> - </li> - <li class="class"> <a href="OpenSSL/PKCS7/RecipientInfo.html">OpenSSL::PKCS7::RecipientInfo</a> - </li> - <li class="class"> <a href="OpenSSL/PKCS7/SignerInfo.html">OpenSSL::PKCS7::SignerInfo</a> - </li> - <li class="module"> <a href="OpenSSL/PKey.html">OpenSSL::PKey</a> <ul> - <li><a href="OpenSSL/PKey.html#label-Asymmetric+Public+Key+Algorithms">Asymmetric Public Key Algorithms</a> - <li><a href="OpenSSL/PKey.html#label-Diffie-Hellman+Key+Exchange">Diffie-Hellman Key Exchange</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/PKey/DH.html">OpenSSL::PKey::DH</a> <ul> - <li><a href="OpenSSL/PKey/DH.html#label-Accessor+methods+for+the+Diffie-Hellman+parameters">Accessor methods for the Diffie-Hellman parameters</a> - <li><a href="OpenSSL/PKey/DH.html#label-Example+of+a+key+exchange">Example of a key exchange</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/PKey/DHError.html">OpenSSL::PKey::DHError</a> - </li> - <li class="class"> <a href="OpenSSL/PKey/DSA.html">OpenSSL::PKey::DSA</a> - </li> - <li class="class"> <a href="OpenSSL/PKey/DSAError.html">OpenSSL::PKey::DSAError</a> - </li> - <li class="class"> <a href="OpenSSL/PKey/EC.html">OpenSSL::PKey::EC</a> <ul> - <li><a href="OpenSSL/PKey/EC.html#label-Key+exchange">Key exchange</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/PKey/EC/Group.html">OpenSSL::PKey::EC::Group</a> - </li> - <li class="class"> <a href="OpenSSL/PKey/EC/Group/Error.html">OpenSSL::PKey::EC::Group::Error</a> - </li> - <li class="class"> <a href="OpenSSL/PKey/EC/Point.html">OpenSSL::PKey::EC::Point</a> - </li> - <li class="class"> <a href="OpenSSL/PKey/EC/Point/Error.html">OpenSSL::PKey::EC::Point::Error</a> - </li> - <li class="class"> <a href="OpenSSL/PKey/ECError.html">OpenSSL::PKey::ECError</a> - </li> - <li class="class"> <a href="OpenSSL/PKey/PKey.html">OpenSSL::PKey::PKey</a> - </li> - <li class="class"> <a href="OpenSSL/PKey/PKeyError.html">OpenSSL::PKey::PKeyError</a> - </li> - <li class="class"> <a href="OpenSSL/PKey/RSA.html">OpenSSL::PKey::RSA</a> - </li> - <li class="class"> <a href="OpenSSL/PKey/RSAError.html">OpenSSL::PKey::RSAError</a> - </li> - <li class="module"> <a href="OpenSSL/Random.html">OpenSSL::Random</a> - </li> - <li class="class"> <a href="OpenSSL/Random/RandomError.html">OpenSSL::Random::RandomError</a> - </li> - <li class="module"> <a href="OpenSSL/SSL.html">OpenSSL::SSL</a> - </li> - <li class="class"> <a href="OpenSSL/SSL/SSLContext.html">OpenSSL::SSL::SSLContext</a> - </li> - <li class="class"> <a href="OpenSSL/SSL/SSLError.html">OpenSSL::SSL::SSLError</a> - </li> - <li class="class"> <a href="OpenSSL/SSL/SSLErrorWaitReadable.html">OpenSSL::SSL::SSLErrorWaitReadable</a> - </li> - <li class="class"> <a href="OpenSSL/SSL/SSLErrorWaitWritable.html">OpenSSL::SSL::SSLErrorWaitWritable</a> - </li> - <li class="class"> <a href="OpenSSL/SSL/SSLServer.html">OpenSSL::SSL::SSLServer</a> - </li> - <li class="class"> <a href="OpenSSL/SSL/SSLSocket.html">OpenSSL::SSL::SSLSocket</a> - </li> - <li class="class"> <a href="OpenSSL/SSL/Session.html">OpenSSL::SSL::Session</a> - </li> - <li class="class"> <a href="OpenSSL/SSL/Session/SessionError.html">OpenSSL::SSL::Session::SessionError</a> - </li> - <li class="module"> <a href="OpenSSL/SSL/SocketForwarder.html">OpenSSL::SSL::SocketForwarder</a> - </li> - <li class="module"> <a href="OpenSSL/Timestamp.html">OpenSSL::Timestamp</a> <ul> - <li><a href="OpenSSL/Timestamp.html#label-Create+a+Response-3A">Create a Response:</a> - <li><a href="OpenSSL/Timestamp.html#label-Verify+a+timestamp+response-3A">Verify a timestamp response:</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/Timestamp/Factory.html">OpenSSL::Timestamp::Factory</a> <ul> - <li><a href="OpenSSL/Timestamp/Factory.html#label-Example-3A+Inclusion+of+-28untrusted-29+intermediate+certificates">Example: Inclusion of (untrusted) intermediate certificates</a> - <li><a href="OpenSSL/Timestamp/Factory.html#label-Attributes">Attributes</a> - <li><a href="OpenSSL/Timestamp/Factory.html#label-default_policy_id">default_policy_id</a> - <li><a href="OpenSSL/Timestamp/Factory.html#label-serial_number">serial_number</a> - <li><a href="OpenSSL/Timestamp/Factory.html#label-gen_time">gen_time</a> - <li><a href="OpenSSL/Timestamp/Factory.html#label-additional_certs">additional_certs</a> - <li><a href="OpenSSL/Timestamp/Factory.html#label-allowed_digests">allowed_digests</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/Timestamp/Request.html">OpenSSL::Timestamp::Request</a> - </li> - <li class="class"> <a href="OpenSSL/Timestamp/Response.html">OpenSSL::Timestamp::Response</a> - </li> - <li class="class"> <a href="OpenSSL/Timestamp/TimestampError.html">OpenSSL::Timestamp::TimestampError</a> - </li> - <li class="class"> <a href="OpenSSL/Timestamp/TokenInfo.html">OpenSSL::Timestamp::TokenInfo</a> - </li> - <li class="module"> <a href="OpenSSL/X509.html">OpenSSL::X509</a> - </li> - <li class="class"> <a href="OpenSSL/X509/Attribute.html">OpenSSL::X509::Attribute</a> - </li> - <li class="class"> <a href="OpenSSL/X509/AttributeError.html">OpenSSL::X509::AttributeError</a> - </li> - <li class="class"> <a href="OpenSSL/X509/CRL.html">OpenSSL::X509::CRL</a> - </li> - <li class="class"> <a href="OpenSSL/X509/CRLError.html">OpenSSL::X509::CRLError</a> - </li> - <li class="class"> <a href="OpenSSL/X509/Certificate.html">OpenSSL::X509::Certificate</a> <ul> - <li><a href="OpenSSL/X509/Certificate.html#label-Reading+a+certificate+from+a+file">Reading a certificate from a file</a> - <li><a href="OpenSSL/X509/Certificate.html#label-Saving+a+certificate+to+a+file">Saving a certificate to a file</a> - <li><a href="OpenSSL/X509/Certificate.html#label-Creating+a+root+CA+certificate+and+an+end-entity+certificate">Creating a root CA certificate and an end-entity certificate</a> - </ul> - </li> - <li class="class"> <a href="OpenSSL/X509/CertificateError.html">OpenSSL::X509::CertificateError</a> - </li> - <li class="class"> <a href="OpenSSL/X509/Extension.html">OpenSSL::X509::Extension</a> - </li> - <li class="module"> <a href="OpenSSL/X509/Extension/AuthorityInfoAccess.html">OpenSSL::X509::Extension::AuthorityInfoAccess</a> - </li> - <li class="module"> <a href="OpenSSL/X509/Extension/AuthorityKeyIdentifier.html">OpenSSL::X509::Extension::AuthorityKeyIdentifier</a> - </li> - <li class="module"> <a href="OpenSSL/X509/Extension/CRLDistributionPoints.html">OpenSSL::X509::Extension::CRLDistributionPoints</a> - </li> - <li class="module"> <a href="OpenSSL/X509/Extension/Helpers.html">OpenSSL::X509::Extension::Helpers</a> - </li> - <li class="module"> <a href="OpenSSL/X509/Extension/SubjectKeyIdentifier.html">OpenSSL::X509::Extension::SubjectKeyIdentifier</a> - </li> - <li class="class"> <a href="OpenSSL/X509/ExtensionError.html">OpenSSL::X509::ExtensionError</a> - </li> - <li class="class"> <a href="OpenSSL/X509/ExtensionFactory.html">OpenSSL::X509::ExtensionFactory</a> - </li> - <li class="class"> <a href="OpenSSL/X509/Name.html">OpenSSL::X509::Name</a> - </li> - <li class="module"> <a href="OpenSSL/X509/Name/RFC2253DN.html">OpenSSL::X509::Name::RFC2253DN</a> - </li> - <li class="class"> <a href="OpenSSL/X509/NameError.html">OpenSSL::X509::NameError</a> - </li> - <li class="class"> <a href="OpenSSL/X509/Request.html">OpenSSL::X509::Request</a> - </li> - <li class="class"> <a href="OpenSSL/X509/RequestError.html">OpenSSL::X509::RequestError</a> - </li> - <li class="class"> <a href="OpenSSL/X509/Revoked.html">OpenSSL::X509::Revoked</a> - </li> - <li class="class"> <a href="OpenSSL/X509/RevokedError.html">OpenSSL::X509::RevokedError</a> - </li> - <li class="class"> <a href="OpenSSL/X509/Store.html">OpenSSL::X509::Store</a> - </li> - <li class="class"> <a href="OpenSSL/X509/StoreContext.html">OpenSSL::X509::StoreContext</a> - </li> - <li class="class"> <a href="OpenSSL/X509/StoreError.html">OpenSSL::X509::StoreError</a> - </li> - </ul> <h2 id="methods">Methods</h2> @@ -4422,14 +4035,13 @@ <a href="OpenSSL/BN.html#method-i-zero-3F">#zero?</a> — <span class="container">OpenSSL::BN</span> - </ul> </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. + <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> |