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 /OpenSSL/Engine.html | |
| parent | ad2abc0cd93977a35565178a3b4b4e50edbd8f0b (diff) | |
| download | ruby-openssl-0c12273a7174d300bad342a053186ae172d2952d.tar.gz | |
Sync with v2.2.1
Diffstat (limited to 'OpenSSL/Engine.html')
| -rw-r--r-- | OpenSSL/Engine.html | 254 |
1 files changed, 9 insertions, 245 deletions
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> |