doc/R509/Cert/Extensions/AuthorityInfoAccess.html in r509-0.9.2 vs doc/R509/Cert/Extensions/AuthorityInfoAccess.html in r509-0.10.0

- old
+ new

@@ -4,17 +4,17 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> Class: R509::Cert::Extensions::AuthorityInfoAccess - &mdash; Documentation by YARD 0.8.5 + &mdash; Documentation by YARD 0.8.6.1 </title> - <link rel="stylesheet" href="../../../css/style.css" type="text/css" media="screen" charset="utf-8" /> + <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" /> - <link rel="stylesheet" href="../../../css/common.css" type="text/css" media="screen" charset="utf-8" /> + <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" /> <script type="text/javascript" charset="utf-8"> hasFrames = window.top.frames.main ? true : false; relpath = '../../../'; framesUrl = "../../../frames.html#!" + escape(window.location.href); @@ -90,26 +90,40 @@ + <dt class="r2">Includes:</dt> + <dd class="r2"><span class='object_link'><a href="ValidationMixin.html" title="R509::Cert::Extensions::ValidationMixin (module)">ValidationMixin</a></span></dd> + + - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/r509/cert/extensions.rb</dd> + <dt class="r1 last">Defined in:</dt> + <dd class="r1 last">lib/r509/cert/extensions/authority_info_access.rb</dd> </dl> <div class="clear"></div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Implements the AuthorityInfoAccess certificate extension, with methods to -provide access to the components and meaning of the extension's contents.</p> +<p>RFC 5280 Description (see: <a +href="http://www.ietf.org/rfc/rfc5280.txt">www.ietf.org/rfc/rfc5280.txt</a>)</p> +<p>The authority information access extension indicates how to access +information and services for the issuer of the certificate in which the +extension appears. Information and services may include on-line validation +services and CA policy data. (The location of CRLs is not specified in +this extension; that information is provided by the cRLDistributionPoints +extension.) This extension may be included in end entity or CA +certificates. Conforming CAs MUST mark this extension as non-critical. You +can use this extension to parse an existing extension for easy access to +the contents or create a new one.</p> + </div> </div> <div class="tags"> @@ -144,11 +158,11 @@ <ul class="summary"> <li class="public "> <span class="summary_signature"> - <a href="#ca_issuers-instance_method" title="#ca_issuers (instance method)">- (Object) <strong>ca_issuers</strong> </a> + <a href="#ca_issuers-instance_method" title="#ca_issuers (instance method)">- (R509::ASN1::GeneralNames<sup>?</sup>) <strong>ca_issuers</strong> </a> </span> @@ -164,20 +178,20 @@ <span class="summary_desc"><div class='inline'> -<p>An array of the CA issuers data, if any.</p> +<p>An R509::ASN1::GeneralNames object of CA Issuers (or nil if not present).</p> </div></span> </li> <li class="public "> <span class="summary_signature"> - <a href="#ocsp-instance_method" title="#ocsp (instance method)">- (Object) <strong>ocsp</strong> </a> + <a href="#ocsp-instance_method" title="#ocsp (instance method)">- (R509::ASN1::GeneralNames<sup>?</sup>) <strong>ocsp</strong> </a> </span> @@ -193,11 +207,12 @@ <span class="summary_desc"><div class='inline'> -<p>An array of the OCSP data, if any.</p> +<p>An R509::ASN1::GeneralNames object of OCSP endpoints (or nil if not +present).</p> </div></span> </li> @@ -215,11 +230,11 @@ <ul class="summary"> <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">- (AuthorityInfoAccess) <strong>initialize</strong>(*args) </a> + <a href="#initialize-instance_method" title="#initialize (instance method)">- (AuthorityInfoAccess) <strong>initialize</strong>(arg) </a> </span> @@ -232,88 +247,200 @@ <span class="summary_desc"><div class='inline'> -<p>See OpenSSL::X509::Extension#initialize.</p> +<p>This method takes a hash or an existing Extension object to parse.</p> </div></span> </li> + <li class="public "> + <span class="summary_signature"> + + <a href="#to_h-instance_method" title="#to_h (instance method)">- (Hash) <strong>to_h</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#to_yaml-instance_method" title="#to_yaml (instance method)">- (YAML) <strong>to_yaml</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + </ul> + + <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> - - (<tt><span class='object_link'><a href="" title="R509::Cert::Extensions::AuthorityInfoAccess (class)">AuthorityInfoAccess</a></span></tt>) <strong>initialize</strong>(*args) + - (<tt><span class='object_link'><a href="" title="R509::Cert::Extensions::AuthorityInfoAccess (class)">AuthorityInfoAccess</a></span></tt>) <strong>initialize</strong>(arg) </h3><div class="docstring"> <div class="discussion"> -<p>See OpenSSL::X509::Extension#initialize</p> +<p>This method takes a hash or an existing Extension object to parse. If +passing a hash you must supply :ocsp_location and/or :ca_issuers_location. +These values must be in the form seen in the examples below.</p> </div> </div> <div class="tags"> + <div class="examples"> + <p class="tag_title">Examples:</p> + + + <pre class="example code"><code>R509::Cert::Extensions::AuthorityInfoAccess.new( + :ocsp_location =&gt; [ { :type =&gt; &quot;URI&quot;, :value =&gt; &quot;http://ocsp.domain.com&quot; } ], + :ca_issuers_location =&gt; [ { :type =&gt; &quot;dirName&quot;, :value =&gt; { :CN =&gt; &#39;myCN&#39;, :O =&gt; &#39;some Org&#39; } ] +)</code></pre> + + + <pre class="example code"><code><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>ASN1</span><span class='op'>::</span><span class='const'>GeneralName</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>IP</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:value</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> +<span class='const'>R509</span><span class='op'>::</span><span class='const'>Cert</span><span class='op'>::</span><span class='const'>Extensions</span><span class='op'>::</span><span class='const'>AuthorityInfoAccess</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> + <span class='symbol'>:ca_issuers_location</span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> +<span class='rparen'>)</span></code></pre> + + </div> +<p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>arg</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + &mdash; + <div class='inline'> +<p>a customizable set of options</p> +</div> + + </li> + +</ul> + + + + <p class="tag_title">Options Hash (<tt>arg</tt>):</p> + <ul class="option"> + + <li> + <span class="name">:ocsp_location</span> + <span class="type">(<tt>Array</tt>, <tt><span class='object_link'><a href="../../ASN1/GeneralNames.html" title="R509::ASN1::GeneralNames (class)">R509::ASN1::GeneralNames</a></span></tt>)</span> + <span class="default"> + + </span> + + &mdash; <div class='inline'> +<p>Array of hashes (see examples) or GeneralNames object</p> +</div> + + </li> + + <li> + <span class="name">:ca_issuers_location</span> + <span class="type">(<tt>Array</tt>)</span> + <span class="default"> + + </span> + + &mdash; <div class='inline'> +<p>Array of hashes (see examples) or GeneralNames object</p> +</div> + + </li> + + <li> + <span class="name">:critical</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + &mdash; default: + <tt>false</tt> + + </span> + + </li> + + </ul> + + + </div><table class="source_code"> <tr> <td> <pre class="lines"> -443 -444 -445 -446 -447 -448 -449 -450 -451 -452 -453 -454 -455 -456 -457 -458 -459 -460</pre> +50 +51 +52 +53 +54 +55 +56 +57</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 443</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_info_access.rb', line 50</span> -<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span> - - <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>ASN1</span><span class='period'>.</span><span class='id identifier rubyid_get_extension_payload'>get_extension_payload</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> - <span class='ivar'>@ocsp</span><span class='op'>=</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>ASN1</span><span class='op'>::</span><span class='const'>GeneralNames</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> - <span class='ivar'>@ca_issuers</span><span class='op'>=</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>ASN1</span><span class='op'>::</span><span class='const'>GeneralNames</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> - <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_access_description'>access_description</span><span class='op'>|</span> - <span class='comment'># AccessDescription ::= SEQUENCE { -</span> <span class='comment'># accessMethod OBJECT IDENTIFIER, -</span> <span class='comment'># accessLocation GeneralName } -</span> <span class='kw'>case</span> <span class='id identifier rubyid_access_description'>access_description</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> - <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>OCSP</span><span class='tstring_end'>&quot;</span></span> - <span class='ivar'>@ocsp</span><span class='period'>.</span><span class='id identifier rubyid_add_item'>add_item</span><span class='lparen'>(</span><span class='id identifier rubyid_access_description'>access_description</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> - <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>caIssuers</span><span class='tstring_end'>&quot;</span></span> - <span class='ivar'>@ca_issuers</span><span class='period'>.</span><span class='id identifier rubyid_add_item'>add_item</span><span class='lparen'>(</span><span class='id identifier rubyid_access_description'>access_description</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> - <span class='kw'>end</span> +<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span> + <span class='kw'>if</span> <span class='kw'>not</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>Cert</span><span class='op'>::</span><span class='const'>Extensions</span><span class='period'>.</span><span class='id identifier rubyid_is_extension?'>is_extension?</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span> + <span class='id identifier rubyid_arg'>arg</span> <span class='op'>=</span> <span class='id identifier rubyid_build_extension'>build_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span> <span class='kw'>end</span> + + <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span> + <span class='id identifier rubyid_parse_extension'>parse_extension</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -326,39 +453,52 @@ <span id=""></span> <div class="method_details first"> <h3 class="signature first" id="ca_issuers-instance_method"> - - (<tt>Object</tt>) <strong>ca_issuers</strong> <span class="extras">(readonly)</span> + - (<tt><span class='object_link'><a href="../../ASN1/GeneralNames.html" title="R509::ASN1::GeneralNames (class)">R509::ASN1::GeneralNames</a></span></tt><sup>?</sup>) <strong>ca_issuers</strong> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> -<p>An array of the CA issuers data, if any</p> +<p>An R509::ASN1::GeneralNames object of CA Issuers (or nil if not present)</p> </div> </div> <div class="tags"> +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../../ASN1/GeneralNames.html" title="R509::ASN1::GeneralNames (class)">R509::ASN1::GeneralNames</a></span></tt>, <tt>nil</tt>)</span> + + + + </li> + +</ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> -440 -441 -442</pre> +31 +32 +33</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 440</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_info_access.rb', line 31</span> <span class='kw'>def</span> <span class='id identifier rubyid_ca_issuers'>ca_issuers</span> <span class='ivar'>@ca_issuers</span> <span class='kw'>end</span></pre> </td> @@ -369,39 +509,53 @@ <span id=""></span> <div class="method_details "> <h3 class="signature " id="ocsp-instance_method"> - - (<tt>Object</tt>) <strong>ocsp</strong> <span class="extras">(readonly)</span> + - (<tt><span class='object_link'><a href="../../ASN1/GeneralNames.html" title="R509::ASN1::GeneralNames (class)">R509::ASN1::GeneralNames</a></span></tt><sup>?</sup>) <strong>ocsp</strong> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> -<p>An array of the OCSP data, if any</p> +<p>An R509::ASN1::GeneralNames object of OCSP endpoints (or nil if not +present)</p> </div> </div> <div class="tags"> +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../../ASN1/GeneralNames.html" title="R509::ASN1::GeneralNames (class)">R509::ASN1::GeneralNames</a></span></tt>, <tt>nil</tt>)</span> + + + + </li> + +</ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> -438 -439 -440</pre> +28 +29 +30</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 438</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_info_access.rb', line 28</span> <span class='kw'>def</span> <span class='id identifier rubyid_ocsp'>ocsp</span> <span class='ivar'>@ocsp</span> <span class='kw'>end</span></pre> </td> @@ -410,15 +564,131 @@ </div> </div> + <div id="instance_method_details" class="method_details_list"> + <h2>Instance Method Details</h2> + + + <div class="method_details first"> + <h3 class="signature first" id="to_h-instance_method"> + + - (<tt>Hash</tt>) <strong>to_h</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + + + </div> </div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + </li> + +</ul> +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +60 +61 +62 +63 +64 +65</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_info_access.rb', line 60</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span> + <span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:critical</span> <span class='op'>=&gt;</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_critical?'>critical?</span> <span class='rbrace'>}</span> + <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_location</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>Cert</span><span class='op'>::</span><span class='const'>Extensions</span><span class='period'>.</span><span class='id identifier rubyid_names_to_h'>names_to_h</span><span class='lparen'>(</span><span class='ivar'>@ocsp</span><span class='period'>.</span><span class='id identifier rubyid_names'>names</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@ocsp</span><span class='period'>.</span><span class='id identifier rubyid_names'>names</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> + <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:ca_issuers_location</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>Cert</span><span class='op'>::</span><span class='const'>Extensions</span><span class='period'>.</span><span class='id identifier rubyid_names_to_h'>names_to_h</span><span class='lparen'>(</span><span class='ivar'>@ca_issuers</span><span class='period'>.</span><span class='id identifier rubyid_names'>names</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@ca_issuers</span><span class='period'>.</span><span class='id identifier rubyid_names'>names</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> + <span class='id identifier rubyid_hash'>hash</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="to_yaml-instance_method"> + + - (<tt>YAML</tt>) <strong>to_yaml</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>YAML</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +68 +69 +70</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_info_access.rb', line 68</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_to_yaml'>to_yaml</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span><span class='period'>.</span><span class='id identifier rubyid_to_yaml'>to_yaml</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + <div id="footer"> - Generated on Tue Apr 23 10:46:07 2013 by + Generated on Sun Jan 26 13:37:29 2014 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.8.5 (ruby-1.9.3). + 0.8.6.1 (ruby-2.0.0). </div> </body> </html> \ No newline at end of file