doc/R509/Helpers.html in r509-0.10.0 vs doc/R509/Helpers.html in r509-1.0

- old
+ new

@@ -1,94 +1,96 @@ -<!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> Module: R509::Helpers - &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::Helpers"; 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 (H)</a> &raquo; <span class='title'><span class='object_link'><a href="../R509.html" title="R509 (module)">R509</a></span></span> &raquo; <span class="title">Helpers</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>Module: R509::Helpers + <div id="content"><h1>Module: R509::Helpers </h1> +<div class="box_info"> + -<dl class="box"> - - - <dt class="r1">Included in:</dt> - <dd class="r1"><span class='object_link'><a href="CSR.html" title="R509::CSR (class)">CSR</a></span>, <span class='object_link'><a href="Cert.html" title="R509::Cert (class)">Cert</a></span>, <span class='object_link'><a href="SPKI.html" title="R509::SPKI (class)">SPKI</a></span></dd> - + + <dl> + <dt>Included in:</dt> + <dd><span class='object_link'><a href="CSR.html" title="R509::CSR (class)">CSR</a></span>, <span class='object_link'><a href="Cert.html" title="R509::Cert (class)">Cert</a></span>, <span class='object_link'><a href="SPKI.html" title="R509::SPKI (class)">SPKI</a></span></dd> + </dl> - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/r509/helpers.rb</dd> + -</dl> -<div class="clear"></div> + <dl> + <dt>Defined in:</dt> + <dd>lib/r509/helpers.rb</dd> + </dl> + +</div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Various helper methods to reduce duplication across classes. These methods @@ -108,19 +110,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="#bit_length-instance_method" title="#bit_length (instance method)">- (Integer) <strong>bit_length</strong> </a> + <a href="#bit_length-instance_method" title="#bit_length (instance method)">#<strong>bit_length</strong> &#x21d2; Integer </a> (also: #bit_strength) @@ -142,11 +144,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#curve_name-instance_method" title="#curve_name (instance method)">- (String) <strong>curve_name</strong> </a> + <a href="#curve_name-instance_method" title="#curve_name (instance method)">#<strong>curve_name</strong> &#x21d2; String </a> </span> @@ -167,11 +169,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#dsa%3F-instance_method" title="#dsa? (instance method)">- (Boolean) <strong>dsa?</strong> </a> + <a href="#dsa%3F-instance_method" title="#dsa? (instance method)">#<strong>dsa?</strong> &#x21d2; Boolean </a> </span> @@ -191,11 +193,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#ec%3F-instance_method" title="#ec? (instance method)">- (Boolean) <strong>ec?</strong> </a> + <a href="#ec%3F-instance_method" title="#ec? (instance method)">#<strong>ec?</strong> &#x21d2; Boolean </a> </span> @@ -215,11 +217,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#key_algorithm-instance_method" title="#key_algorithm (instance method)">- (String) <strong>key_algorithm</strong> </a> + <a href="#key_algorithm-instance_method" title="#key_algorithm (instance method)">#<strong>key_algorithm</strong> &#x21d2; String </a> </span> @@ -239,11 +241,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#rsa%3F-instance_method" title="#rsa? (instance method)">- (Boolean) <strong>rsa?</strong> </a> + <a href="#rsa%3F-instance_method" title="#rsa? (instance method)">#<strong>rsa?</strong> &#x21d2; Boolean </a> </span> @@ -263,11 +265,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#to_der-instance_method" title="#to_der (instance method)">- (String) <strong>to_der</strong> </a> + <a href="#to_der-instance_method" title="#to_der (instance method)">#<strong>to_der</strong> &#x21d2; String </a> </span> @@ -287,11 +289,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#to_pem-instance_method" title="#to_pem (instance method)">- (String) <strong>to_pem</strong> </a> + <a href="#to_pem-instance_method" title="#to_pem (instance method)">#<strong>to_pem</strong> &#x21d2; String </a> </span> @@ -311,11 +313,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#write_der-instance_method" title="#write_der (instance method)">- (Object) <strong>write_der</strong>(filename_or_io) </a> + <a href="#write_der-instance_method" title="#write_der (instance method)">#<strong>write_der</strong>(filename_or_io) &#x21d2; Object </a> </span> @@ -335,11 +337,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#write_pem-instance_method" title="#write_pem (instance method)">- (Object) <strong>write_pem</strong>(filename_or_io) </a> + <a href="#write_pem-instance_method" title="#write_pem (instance method)">#<strong>write_pem</strong>(filename_or_io) &#x21d2; Object </a> </span> @@ -368,11 +370,11 @@ <div class="method_details first"> <h3 class="signature first" id="bit_length-instance_method"> - - (<tt>Integer</tt>) <strong>bit_length</strong> + #<strong>bit_length</strong> &#x21d2; <tt>Integer</tt> <span class="aliases">Also known as: <span class="names"><span id='bit_strength-instance_method'>bit_strength</span></span> @@ -413,22 +415,22 @@ <tr> <td> <pre class="lines"> +53 54 55 56 57 58 59 60 -61 -62</pre> +61</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 54</span> + <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 53</span> <span class='kw'>def</span> <span class='id identifier rubyid_bit_length'>bit_length</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_rsa?'>rsa?</span> <span class='kw'>return</span> <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_public_key'>public_key</span><span class='period'>.</span><span class='id identifier rubyid_n'>n</span><span class='period'>.</span><span class='id identifier rubyid_num_bits'>num_bits</span> <span class='kw'>elsif</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_dsa?'>dsa?</span> @@ -443,11 +445,11 @@ </div> <div class="method_details "> <h3 class="signature " id="curve_name-instance_method"> - - (<tt>String</tt>) <strong>curve_name</strong> + #<strong>curve_name</strong> &#x21d2; <tt>String</tt> @@ -485,20 +487,20 @@ <tr> <td> <pre class="lines"> +43 44 45 46 47 48 -49 -50</pre> +49</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 44</span> + <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 43</span> <span class='kw'>def</span> <span class='id identifier rubyid_curve_name'>curve_name</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ec?'>ec?</span> <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_public_key'>public_key</span><span class='period'>.</span><span class='id identifier rubyid_group'>group</span><span class='period'>.</span><span class='id identifier rubyid_curve_name'>curve_name</span> <span class='kw'>else</span> @@ -511,11 +513,11 @@ </div> <div class="method_details "> <h3 class="signature " id="dsa?-instance_method"> - - (<tt>Boolean</tt>) <strong>dsa?</strong> + #<strong>dsa?</strong> &#x21d2; <tt>Boolean</tt> @@ -552,29 +554,29 @@ <tr> <td> <pre class="lines"> +15 16 -17 -18</pre> +17</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 16</span> + <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 15</span> <span class='kw'>def</span> <span class='id identifier rubyid_dsa?'>dsa?</span> - <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_public_key'>public_key</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>PKey</span><span class='op'>::</span><span class='const'>DSA</span><span class='rparen'>)</span> + <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_public_key'>public_key</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>PKey</span><span class='op'>::</span><span class='const'>DSA</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="ec?-instance_method"> - - (<tt>Boolean</tt>) <strong>ec?</strong> + #<strong>ec?</strong> &#x21d2; <tt>Boolean</tt> @@ -611,29 +613,29 @@ <tr> <td> <pre class="lines"> +22 23 -24 -25</pre> +24</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 23</span> + <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 22</span> <span class='kw'>def</span> <span class='id identifier rubyid_ec?'>ec?</span> - <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_public_key'>public_key</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>PKey</span><span class='op'>::</span><span class='const'>EC</span><span class='rparen'>)</span> + <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_public_key'>public_key</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>PKey</span><span class='op'>::</span><span class='const'>EC</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="key_algorithm-instance_method"> - - (<tt>String</tt>) <strong>key_algorithm</strong> + #<strong>key_algorithm</strong> &#x21d2; <tt>String</tt> @@ -670,22 +672,22 @@ <tr> <td> <pre class="lines"> +29 30 31 32 33 34 35 36 -37 -38</pre> +37</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 30</span> + <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 29</span> <span class='kw'>def</span> <span class='id identifier rubyid_key_algorithm'>key_algorithm</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_rsa?'>rsa?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>RSA</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>elsif</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_dsa?'>dsa?</span> @@ -700,11 +702,11 @@ </div> <div class="method_details "> <h3 class="signature " id="rsa?-instance_method"> - - (<tt>Boolean</tt>) <strong>rsa?</strong> + #<strong>rsa?</strong> &#x21d2; <tt>Boolean</tt> @@ -741,29 +743,29 @@ <tr> <td> <pre class="lines"> +8 9 -10 -11</pre> +10</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 9</span> + <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 8</span> <span class='kw'>def</span> <span class='id identifier rubyid_rsa?'>rsa?</span> - <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_public_key'>public_key</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>PKey</span><span class='op'>::</span><span class='const'>RSA</span><span class='rparen'>)</span> + <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_public_key'>public_key</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>PKey</span><span class='op'>::</span><span class='const'>RSA</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="to_der-instance_method"> - - (<tt>String</tt>) <strong>to_der</strong> + #<strong>to_der</strong> &#x21d2; <tt>String</tt> @@ -800,29 +802,29 @@ <tr> <td> <pre class="lines"> +88 89 -90 -91</pre> +90</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 89</span> + <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 88</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_der'>to_der</span> - <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_to_der'>to_der</span> + <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_to_der'>to_der</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="to_pem-instance_method"> - - (<tt>String</tt>) <strong>to_pem</strong> + #<strong>to_pem</strong> &#x21d2; <tt>String</tt> @@ -859,29 +861,29 @@ <tr> <td> <pre class="lines"> +81 82 -83 -84</pre> +83</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 82</span> + <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 81</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_pem'>to_pem</span> - <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_to_pem'>to_pem</span> + <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_to_pem'>to_pem</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="write_der-instance_method"> - - (<tt>Object</tt>) <strong>write_der</strong>(filename_or_io) + #<strong>write_der</strong>(filename_or_io) &#x21d2; <tt>Object</tt> @@ -921,16 +923,16 @@ <tr> <td> <pre class="lines"> +74 75 -76 -77</pre> +76</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 75</span> + <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 74</span> <span class='kw'>def</span> <span class='id identifier rubyid_write_der'>write_der</span><span class='lparen'>(</span><span class='id identifier rubyid_filename_or_io'>filename_or_io</span><span class='rparen'>)</span> <span class='id identifier rubyid_write_data'>write_data</span><span class='lparen'>(</span><span class='id identifier rubyid_filename_or_io'>filename_or_io</span><span class='comma'>,</span> <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_to_der'>to_der</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> @@ -939,11 +941,11 @@ </div> <div class="method_details "> <h3 class="signature " id="write_pem-instance_method"> - - (<tt>Object</tt>) <strong>write_pem</strong>(filename_or_io) + #<strong>write_pem</strong>(filename_or_io) &#x21d2; <tt>Object</tt> @@ -983,16 +985,16 @@ <tr> <td> <pre class="lines"> +67 68 -69 -70</pre> +69</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 68</span> + <pre class="code"><span class="info file"># File 'lib/r509/helpers.rb', line 67</span> <span class='kw'>def</span> <span class='id identifier rubyid_write_pem'>write_pem</span><span class='lparen'>(</span><span class='id identifier rubyid_filename_or_io'>filename_or_io</span><span class='rparen'>)</span> <span class='id identifier rubyid_write_data'>write_data</span><span class='lparen'>(</span><span class='id identifier rubyid_filename_or_io'>filename_or_io</span><span class='comma'>,</span> <span class='id identifier rubyid_internal_obj'>internal_obj</span><span class='period'>.</span><span class='id identifier rubyid_to_pem'>to_pem</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> @@ -1002,13 +1004,14 @@ </div> </div> - <div id="footer"> - Generated on Sun Jan 26 13:37:25 2014 by + <div id="footer"> + Generated on Tue Dec 6 17:27:39 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