doc/R509/Cert/Extensions/AuthorityKeyIdentifier.html in r509-0.10.0 vs doc/R509/Cert/Extensions/AuthorityKeyIdentifier.html in r509-1.0

- old
+ new

@@ -1,80 +1,78 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<!DOCTYPE html> +<html> <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <meta charset="utf-8"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: R509::Cert::Extensions::AuthorityKeyIdentifier - &mdash; Documentation by YARD 0.8.6.1 + &mdash; Documentation by YARD 0.9.5 </title> <link rel="stylesheet" href="../../../css/style.css" type="text/css" 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; + pathId = "R509::Cert::Extensions::AuthorityKeyIdentifier"; relpath = '../../../'; - framesUrl = "../../../frames.html#!" + escape(window.location.href); </script> <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script> </head> <body> - <div id="header"> - <div id="menu"> + <div class="nav_wrap"> + <iframe id="nav" src="../../../class_list.html"></iframe> + <div id="resizer"></div> + </div> + + <div id="main" tabindex="-1"> + <div id="header"> + <div id="menu"> <a href="../../../_index.html">Index (A)</a> &raquo; <span class='title'><span class='object_link'><a href="../../../R509.html" title="R509 (module)">R509</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Cert.html" title="R509::Cert (class)">Cert</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Extensions.html" title="R509::Cert::Extensions (module)">Extensions</a></span></span> &raquo; <span class="title">AuthorityKeyIdentifier</span> - - <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> </div> - <div id="search"> + <div id="search"> <a class="full_list_link" id="class_list_link" href="../../../class_list.html"> - Class List + + <svg width="24" height="24"> + <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> + <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> + <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> + </svg> </a> - <a class="full_list_link" id="method_list_link" - href="../../../method_list.html"> - Method List - </a> - - <a class="full_list_link" id="file_list_link" - href="../../../file_list.html"> - File List - </a> - </div> - <div class="clear"></div> - </div> + <div class="clear"></div> + </div> - <iframe id="search_frame"></iframe> + <iframe id="search_frame" src="../../../class_list.html"></iframe> - <div id="content"><h1>Class: R509::Cert::Extensions::AuthorityKeyIdentifier + <div id="content"><h1>Class: R509::Cert::Extensions::AuthorityKeyIdentifier </h1> - -<dl class="box"> +<div class="box_info"> - <dt class="r1">Inherits:</dt> - <dd class="r1"> + <dl> + <dt>Inherits:</dt> + <dd> <span class="inheritName">OpenSSL::X509::Extension</span> <ul class="fullTree"> <li>Object</li> @@ -83,26 +81,30 @@ <li class="next">R509::Cert::Extensions::AuthorityKeyIdentifier</li> </ul> <a href="#" class="inheritanceTree">show all</a> - </dd> - + </dd> + </dl> + - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/r509/cert/extensions/authority_key_identifier.rb</dd> + -</dl> -<div class="clear"></div> + + <dl> + <dt>Defined in:</dt> + <dd>lib/r509/cert/extensions/authority_key_identifier.rb</dd> + </dl> + +</div> + <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>RFC 5280 Description (see: <a href="http://www.ietf.org/rfc/rfc5280.txt">www.ietf.org/rfc/rfc5280.txt</a>)</p> @@ -124,15 +126,14 @@ <div class="tags"> </div> <h2>Constant Summary</h2> - - <dl class="constants"> - - <dt id="OID-constant" class="">OID = - <div class="docstring"> + <dl class="constants"> + + <dt id="OID-constant" class="">OID = + <div class="docstring"> <div class="discussion"> <p>friendly name for Authority Key Identifier OID</p> @@ -140,15 +141,15 @@ </div> <div class="tags"> </div> - </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>authorityKeyIdentifier</span><span class='tstring_end'>&quot;</span></span></pre></dd> - - <dt id="AKI_EXTENSION_DEFAULT-constant" class="">AKI_EXTENSION_DEFAULT = - <div class="docstring"> + </dt> + <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>authorityKeyIdentifier</span><span class='tstring_end'>&quot;</span></span></pre></dd> + + <dt id="AKI_EXTENSION_DEFAULT-constant" class="">AKI_EXTENSION_DEFAULT = + <div class="docstring"> <div class="discussion"> <p>default extension behavior when generating</p> @@ -156,26 +157,25 @@ </div> <div class="tags"> </div> - </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>keyid</span><span class='tstring_end'>&quot;</span></span></pre></dd> - - </dl> - + </dt> + <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>keyid</span><span class='tstring_end'>&quot;</span></span></pre></dd> + + </dl> - <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> + <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> - <a href="#authority_cert_issuer-instance_method" title="#authority_cert_issuer (instance method)">- (R509::ASN1::GeneralName<sup>?</sup>) <strong>authority_cert_issuer</strong> </a> + <a href="#authority_cert_issuer-instance_method" title="#authority_cert_issuer (instance method)">#<strong>authority_cert_issuer</strong> &#x21d2; R509::ASN1::GeneralName<sup>?</sup> </a> </span> @@ -200,11 +200,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#authority_cert_serial_number-instance_method" title="#authority_cert_serial_number (instance method)">- (String<sup>?</sup>) <strong>authority_cert_serial_number</strong> </a> + <a href="#authority_cert_serial_number-instance_method" title="#authority_cert_serial_number (instance method)">#<strong>authority_cert_serial_number</strong> &#x21d2; String<sup>?</sup> </a> </span> @@ -230,11 +230,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#key_identifier-instance_method" title="#key_identifier (instance method)">- (String<sup>?</sup>) <strong>key_identifier</strong> </a> + <a href="#key_identifier-instance_method" title="#key_identifier (instance method)">#<strong>key_identifier</strong> &#x21d2; String<sup>?</sup> </a> </span> @@ -264,19 +264,19 @@ <h2> Instance Method Summary - <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">- (AuthorityKeyIdentifier) <strong>initialize</strong>(arg) </a> + <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(arg) &#x21d2; AuthorityKeyIdentifier </a> </span> @@ -305,20 +305,20 @@ <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::AuthorityKeyIdentifier (class)">AuthorityKeyIdentifier</a></span></tt>) <strong>initialize</strong>(arg) + #<strong>initialize</strong>(arg) &#x21d2; <tt><span class='object_link'><a href="" title="R509::Cert::Extensions::AuthorityKeyIdentifier (class)">AuthorityKeyIdentifier</a></span></tt> </h3><div class="docstring"> <div class="discussion"> -<p>A new instance of AuthorityKeyIdentifier</p> +<p>Returns a new instance of AuthorityKeyIdentifier</p> </div> </div> <div class="tags"> @@ -368,16 +368,31 @@ <span class="default"> </span> &mdash; <div class='inline'> -<p>Required if embedding issuer</p> +<p>Required if embedding issuer. This should be the issuing certificate&#39;s +issuer subject name.</p> </div> </li> <li> + <span class="name">:issuer_serial</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + &mdash; <div class='inline'> +<p>Required if embedding issuer. This should be the issuing certificate&#39;s +issuer serial number.</p> +</div> + + </li> + + <li> <span class="name">:value</span> <span class="type">(<tt>String</tt>)</span> <span class="default"> &mdash; default: @@ -386,12 +401,12 @@ </span> &mdash; <div class='inline'> <p>For the rules of :value see: <a href="http://www.openssl.org/docs/apps/x509v3_config.html#Authority_Key_Identifier_">www.openssl.org/docs/apps/x509v3_config.html#Authority_Key_Identifier_</a>. -If you want to embed issuer you MUST supply :issuer_certificate and not -:public_key</p> +If you want to embed issuer you MUST supply :issuer_subject and +:issuer_serial and not :public_key</p> </div> </li> <li> @@ -414,24 +429,24 @@ <tr> <td> <pre class="lines"> +40 41 42 43 44 45 46 -47 -48</pre> +47</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_key_identifier.rb', line 41</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_key_identifier.rb', line 40</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='kw'>unless</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> @@ -449,11 +464,11 @@ <span id=""></span> <div class="method_details first"> <h3 class="signature first" id="authority_cert_issuer-instance_method"> - - (<tt><span class='object_link'><a href="../../ASN1/GeneralName.html" title="R509::ASN1::GeneralName (class)">R509::ASN1::GeneralName</a></span></tt><sup>?</sup>) <strong>authority_cert_issuer</strong> <span class="extras">(readonly)</span> + #<strong>authority_cert_issuer</strong> &#x21d2; <tt><span class='object_link'><a href="../../ASN1/GeneralName.html" title="R509::ASN1::GeneralName (class)">R509::ASN1::GeneralName</a></span></tt><sup>?</sup> <span class="extras">(readonly)</span> @@ -485,16 +500,16 @@ <tr> <td> <pre class="lines"> +30 31 -32 -33</pre> +32</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_key_identifier.rb', line 31</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_key_identifier.rb', line 30</span> <span class='kw'>def</span> <span class='id identifier rubyid_authority_cert_issuer'>authority_cert_issuer</span> <span class='ivar'>@authority_cert_issuer</span> <span class='kw'>end</span></pre> </td> @@ -505,11 +520,11 @@ <span id=""></span> <div class="method_details "> <h3 class="signature " id="authority_cert_serial_number-instance_method"> - - (<tt>String</tt><sup>?</sup>) <strong>authority_cert_serial_number</strong> <span class="extras">(readonly)</span> + #<strong>authority_cert_serial_number</strong> &#x21d2; <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span> @@ -542,16 +557,16 @@ <tr> <td> <pre class="lines"> +33 34 -35 -36</pre> +35</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_key_identifier.rb', line 34</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_key_identifier.rb', line 33</span> <span class='kw'>def</span> <span class='id identifier rubyid_authority_cert_serial_number'>authority_cert_serial_number</span> <span class='ivar'>@authority_cert_serial_number</span> <span class='kw'>end</span></pre> </td> @@ -562,11 +577,11 @@ <span id=""></span> <div class="method_details "> <h3 class="signature " id="key_identifier-instance_method"> - - (<tt>String</tt><sup>?</sup>) <strong>key_identifier</strong> <span class="extras">(readonly)</span> + #<strong>key_identifier</strong> &#x21d2; <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span> @@ -598,16 +613,16 @@ <tr> <td> <pre class="lines"> +27 28 -29 -30</pre> +29</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_key_identifier.rb', line 28</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions/authority_key_identifier.rb', line 27</span> <span class='kw'>def</span> <span class='id identifier rubyid_key_identifier'>key_identifier</span> <span class='ivar'>@key_identifier</span> <span class='kw'>end</span></pre> </td> @@ -618,13 +633,14 @@ </div> </div> - <div id="footer"> - Generated on Sun Jan 26 13:37:29 2014 by + <div id="footer"> + Generated on Tue Dec 6 17:27:42 2016 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.8.6.1 (ruby-2.0.0). + 0.9.5 (ruby-2.4.0). </div> + </div> </body> </html> \ No newline at end of file