doc/R509/OCSP/Response.html in r509-0.10.0 vs doc/R509/OCSP/Response.html in r509-1.0

- old
+ new

@@ -1,106 +1,108 @@ -<!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::OCSP::Response - &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::OCSP::Response"; 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 (R)</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="../OCSP.html" title="R509::OCSP (module)">OCSP</a></span></span> &raquo; <span class="title">Response</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::OCSP::Response + <div id="content"><h1>Class: R509::OCSP::Response </h1> - -<dl class="box"> +<div class="box_info"> - <dt class="r1">Inherits:</dt> - <dd class="r1"> + <dl> + <dt>Inherits:</dt> + <dd> <span class="inheritName">Object</span> <ul class="fullTree"> <li>Object</li> <li class="next">R509::OCSP::Response</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/ocsp.rb</dd> + -</dl> -<div class="clear"></div> + + <dl> + <dt>Defined in:</dt> + <dd>lib/r509/ocsp.rb</dd> + </dl> + +</div> + <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>builds OCSP responses</p> @@ -118,19 +120,19 @@ <h2> Class 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="#parse-class_method" title="parse (class method)">+ (R509::OCSP::Response) <strong>parse</strong>(ocsp_string) </a> + <a href="#parse-class_method" title="parse (class method)">.<strong>parse</strong>(ocsp_string) &#x21d2; R509::OCSP::Response </a> </span> @@ -149,19 +151,19 @@ </ul> <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="#basic-instance_method" title="#basic (instance method)">- (OpenSSL::OCSP::BasicResponse) <strong>basic</strong> </a> + <a href="#basic-instance_method" title="#basic (instance method)">#<strong>basic</strong> &#x21d2; OpenSSL::OCSP::BasicResponse </a> </span> @@ -179,11 +181,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#check_nonce-instance_method" title="#check_nonce (instance method)">- (R509::OCSP::Request::Nonce::CONSTANT) <strong>check_nonce</strong>(ocsp_request) </a> + <a href="#check_nonce-instance_method" title="#check_nonce (instance method)">#<strong>check_nonce</strong>(ocsp_request) &#x21d2; R509::OCSP::Request::Nonce::CONSTANT </a> </span> @@ -203,11 +205,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Response) <strong>initialize</strong>(ocsp_response) </a> + <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(ocsp_response) &#x21d2; Response </a> </span> @@ -229,11 +231,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#status-instance_method" title="#status (instance method)">- (OpenSSL::OCSP) <strong>status</strong> </a> + <a href="#status-instance_method" title="#status (instance method)">#<strong>status</strong> &#x21d2; OpenSSL::OCSP </a> </span> @@ -253,11 +255,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> @@ -277,11 +279,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#verify-instance_method" title="#verify (instance method)">- (Boolean) <strong>verify</strong>(certs) </a> + <a href="#verify-instance_method" title="#verify (instance method)">#<strong>verify</strong>(certs) &#x21d2; Boolean </a> </span> @@ -307,20 +309,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::OCSP::Response (class)">Response</a></span></tt>) <strong>initialize</strong>(ocsp_response) + #<strong>initialize</strong>(ocsp_response) &#x21d2; <tt><span class='object_link'><a href="" title="R509::OCSP::Response (class)">Response</a></span></tt> </h3><div class="docstring"> <div class="discussion"> -<p>A new instance of Response</p> +<p>Returns a new instance of Response</p> </div> </div> <div class="tags"> @@ -345,22 +347,22 @@ <tr> <td> <pre class="lines"> +10 11 12 13 14 -15 -16</pre> +15</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 11</span> + <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_ocsp_response'>ocsp_response</span><span class='rparen'>)</span> - <span class='kw'>if</span> <span class='kw'>not</span> <span class='id identifier rubyid_ocsp_response'>ocsp_response</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'>OCSP</span><span class='op'>::</span><span class='const'>Response</span><span class='rparen'>)</span> + <span class='kw'>unless</span> <span class='id identifier rubyid_ocsp_response'>ocsp_response</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'>OCSP</span><span class='op'>::</span><span class='const'>Response</span><span class='rparen'>)</span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>R509Error</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>You must pass an OpenSSL::OCSP::Response object to the constructor. See R509::OCSP::Response.parse if you are trying to parse</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>end</span> <span class='ivar'>@ocsp_response</span> <span class='op'>=</span> <span class='id identifier rubyid_ocsp_response'>ocsp_response</span> <span class='kw'>end</span></pre> </td> @@ -376,11 +378,11 @@ <div class="method_details first"> <h3 class="signature first" id="parse-class_method"> - + (<tt><span class='object_link'><a href="" title="R509::OCSP::Response (class)">R509::OCSP::Response</a></span></tt>) <strong>parse</strong>(ocsp_string) + .<strong>parse</strong>(ocsp_string) &#x21d2; <tt><span class='object_link'><a href="" title="R509::OCSP::Response (class)">R509::OCSP::Response</a></span></tt> @@ -430,19 +432,19 @@ <tr> <td> <pre class="lines"> +18 19 20 21 22 -23 -24</pre> +23</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 19</span> + <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 18</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_ocsp_string'>ocsp_string</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_ocsp_string'>ocsp_string</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>R509Error</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>You must pass a DER encoded OCSP response to this method</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>end</span> @@ -460,11 +462,11 @@ <div class="method_details first"> <h3 class="signature first" id="basic-instance_method"> - - (<tt>OpenSSL::OCSP::BasicResponse</tt>) <strong>basic</strong> + #<strong>basic</strong> &#x21d2; <tt>OpenSSL::OCSP::BasicResponse</tt> @@ -494,16 +496,16 @@ <tr> <td> <pre class="lines"> +36 37 -38 -39</pre> +38</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 37</span> + <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 36</span> <span class='kw'>def</span> <span class='id identifier rubyid_basic'>basic</span> <span class='ivar'>@ocsp_response</span><span class='period'>.</span><span class='id identifier rubyid_basic'>basic</span> <span class='kw'>end</span></pre> </td> @@ -512,20 +514,20 @@ </div> <div class="method_details "> <h3 class="signature " id="check_nonce-instance_method"> - - (<tt>R509::OCSP::Request::Nonce::CONSTANT</tt>) <strong>check_nonce</strong>(ocsp_request) + #<strong>check_nonce</strong>(ocsp_request) &#x21d2; <tt>R509::OCSP::Request::Nonce::CONSTANT</tt> </h3><div class="docstring"> <div class="discussion"> -<p>The status code of the nonce check</p> +<p>Returns the status code of the nonce check</p> </div> </div> <div class="tags"> @@ -573,16 +575,16 @@ <tr> <td> <pre class="lines"> +66 67 -68 -69</pre> +68</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 67</span> + <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 66</span> <span class='kw'>def</span> <span class='id identifier rubyid_check_nonce'>check_nonce</span><span class='lparen'>(</span><span class='id identifier rubyid_ocsp_request'>ocsp_request</span><span class='rparen'>)</span> <span class='id identifier rubyid_ocsp_request'>ocsp_request</span><span class='period'>.</span><span class='id identifier rubyid_check_nonce'>check_nonce</span><span class='lparen'>(</span><span class='ivar'>@ocsp_response</span><span class='period'>.</span><span class='id identifier rubyid_basic'>basic</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> @@ -591,20 +593,20 @@ </div> <div class="method_details "> <h3 class="signature " id="status-instance_method"> - - (<tt>OpenSSL::OCSP</tt>) <strong>status</strong> + #<strong>status</strong> &#x21d2; <tt>OpenSSL::OCSP</tt> </h3><div class="docstring"> <div class="discussion"> -<p>Response status of this response</p> +<p>Returns response status of this response</p> </div> </div> <div class="tags"> @@ -632,16 +634,16 @@ <tr> <td> <pre class="lines"> +26 27 -28 -29</pre> +28</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 27</span> + <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 26</span> <span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span> <span class='ivar'>@ocsp_response</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='kw'>end</span></pre> </td> @@ -650,20 +652,20 @@ </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> </h3><div class="docstring"> <div class="discussion"> -<p>Der encoded string</p> +<p>Returns der encoded string</p> </div> </div> <div class="tags"> @@ -691,16 +693,16 @@ <tr> <td> <pre class="lines"> +31 32 -33 -34</pre> +33</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 32</span> + <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 31</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_der'>to_der</span> <span class='ivar'>@ocsp_response</span><span class='period'>.</span><span class='id identifier rubyid_to_der'>to_der</span> <span class='kw'>end</span></pre> </td> @@ -709,20 +711,20 @@ </div> <div class="method_details "> <h3 class="signature " id="verify-instance_method"> - - (<tt>Boolean</tt>) <strong>verify</strong>(certs) + #<strong>verify</strong>(certs) &#x21d2; <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> -<p>True if the response is valid according to the given root</p> +<p>Returns true if the response is valid according to the given root</p> </div> </div> <div class="tags"> @@ -770,10 +772,11 @@ <tr> <td> <pre class="lines"> +42 43 44 45 46 47 @@ -789,49 +792,49 @@ 57 58 59 60 61 -62 -63</pre> +62</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 43</span> + <pre class="code"><span class="info file"># File 'lib/r509/ocsp.rb', line 42</span> <span class='kw'>def</span> <span class='id identifier rubyid_verify'>verify</span><span class='lparen'>(</span><span class='id identifier rubyid_certs'>certs</span><span class='rparen'>)</span> <span class='id identifier rubyid_store'>store</span> <span class='op'>=</span> <span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>X509</span><span class='op'>::</span><span class='const'>Store</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> - <span class='kw'>if</span> <span class='id identifier rubyid_certs'>certs</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> + <span class='kw'>if</span> <span class='id identifier rubyid_certs'>certs</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> <span class='id identifier rubyid_stack'>stack</span> <span class='op'>=</span> <span class='id identifier rubyid_certs'>certs</span> <span class='id identifier rubyid_certs'>certs</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_cert'>cert</span><span class='op'>|</span> <span class='id identifier rubyid_store'>store</span><span class='period'>.</span><span class='id identifier rubyid_add_cert'>add_cert</span><span class='lparen'>(</span><span class='id identifier rubyid_cert'>cert</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>else</span> <span class='id identifier rubyid_stack'>stack</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_certs'>certs</span><span class='rbracket'>]</span> <span class='id identifier rubyid_store'>store</span><span class='period'>.</span><span class='id identifier rubyid_add_cert'>add_cert</span><span class='lparen'>(</span><span class='id identifier rubyid_certs'>certs</span><span class='rparen'>)</span> <span class='kw'>end</span> - <span class='comment'>#suppress verbosity since #verify will output a warning if it does not match -</span> <span class='comment'>#as well as returning false. we just want the boolean + <span class='comment'># suppress verbosity since #verify will output a warning if it does not match +</span> <span class='comment'># as well as returning false. we just want the boolean </span> <span class='id identifier rubyid_original_verbosity'>original_verbosity</span> <span class='op'>=</span> <span class='gvar'>$VERBOSE</span> <span class='gvar'>$VERBOSE</span> <span class='op'>=</span> <span class='kw'>nil</span> - <span class='comment'>#still a bit unclear on why we add to store and pass in array to verify + <span class='comment'># still a bit unclear on why we add to store and pass in array to verify </span> <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@ocsp_response</span><span class='period'>.</span><span class='id identifier rubyid_basic'>basic</span><span class='period'>.</span><span class='id identifier rubyid_verify'>verify</span><span class='lparen'>(</span><span class='id identifier rubyid_stack'>stack</span><span class='comma'>,</span> <span class='id identifier rubyid_store'>store</span><span class='rparen'>)</span> <span class='gvar'>$VERBOSE</span> <span class='op'>=</span> <span class='id identifier rubyid_original_verbosity'>original_verbosity</span> - <span class='kw'>return</span> <span class='id identifier rubyid_result'>result</span> + <span class='id identifier rubyid_result'>result</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> - <div id="footer"> - Generated on Sun Jan 26 13:37:26 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