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