doc/R509/Cert/Extensions/ExtendedKeyUsage.html in r509-0.8.1 vs doc/R509/Cert/Extensions/ExtendedKeyUsage.html in r509-0.9

- old
+ new

@@ -4,11 +4,11 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> Class: R509::Cert::Extensions::ExtendedKeyUsage - &mdash; Documentation by YARD 0.8.2.1 + &mdash; Documentation by YARD 0.8.5 </title> <link rel="stylesheet" href="../../../css/style.css" type="text/css" media="screen" charset="utf-8" /> @@ -117,78 +117,137 @@ <h2>Constant Summary</h2> <dl class="constants"> <dt id="OID-constant" class="">OID = - + <div class="docstring"> + <div class="discussion"> + +<p>friendly name for EKU OID</p> + + + </div> +</div> +<div class="tags"> + + +</div> </dt> <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>extendedKeyUsage</span><span class='tstring_end'>&quot;</span></span></pre></dd> <dt id="AU_WEB_SERVER_AUTH-constant" class="">AU_WEB_SERVER_AUTH = <div class="docstring"> <div class="discussion"> -<p>The OpenSSL friendly name for the "serverAuth" extended key use.</p> +<p>The OpenSSL short name for TLS Web Server Authentication</p> </div> </div> <div class="tags"> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>TLS Web Server Authentication</span><span class='tstring_end'>&quot;</span></span></pre></dd> + <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>serverAuth</span><span class='tstring_end'>&quot;</span></span></pre></dd> <dt id="AU_WEB_CLIENT_AUTH-constant" class="">AU_WEB_CLIENT_AUTH = <div class="docstring"> <div class="discussion"> -<p>The OpenSSL friendly name for the "clientAuth" extended key use.</p> +<p>The OpenSSL short name for TLS Web Client Authentication</p> </div> </div> <div class="tags"> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>TLS Web Client Authentication</span><span class='tstring_end'>&quot;</span></span></pre></dd> + <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>clientAuth</span><span class='tstring_end'>&quot;</span></span></pre></dd> <dt id="AU_CODE_SIGNING-constant" class="">AU_CODE_SIGNING = <div class="docstring"> <div class="discussion"> -<p>The OpenSSL friendly name for the "codeSigning" extended key use.</p> +<p>The OpenSSL short name for Code Signing</p> </div> </div> <div class="tags"> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Code Signing</span><span class='tstring_end'>&quot;</span></span></pre></dd> + <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>codeSigning</span><span class='tstring_end'>&quot;</span></span></pre></dd> <dt id="AU_EMAIL_PROTECTION-constant" class="">AU_EMAIL_PROTECTION = <div class="docstring"> <div class="discussion"> -<p>The OpenSSL friendly name for the "emailProtection" extended key use.</p> +<p>The OpenSSL short name for E-mail Protection</p> </div> </div> <div class="tags"> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>E-mail Protection</span><span class='tstring_end'>&quot;</span></span></pre></dd> + <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>emailProtection</span><span class='tstring_end'>&quot;</span></span></pre></dd> + <dt id="AU_OCSP_SIGNING-constant" class="">AU_OCSP_SIGNING = + <div class="docstring"> + <div class="discussion"> + +<p>The OpenSSL short name for OCSP Signing</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>OCSPSigning</span><span class='tstring_end'>&quot;</span></span></pre></dd> + + <dt id="AU_TIME_STAMPING-constant" class="">AU_TIME_STAMPING = + <div class="docstring"> + <div class="discussion"> + +<p>The OpenSSL short name for Time Stamping</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>timeStamping</span><span class='tstring_end'>&quot;</span></span></pre></dd> + + <dt id="AU_ANY_EXTENDED_KEY_USAGE-constant" class="">AU_ANY_EXTENDED_KEY_USAGE = + <div class="docstring"> + <div class="discussion"> + +<p>The OpenSSL short name for Any Extended Key Usage</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>anyExtendedKeyUsage</span><span class='tstring_end'>&quot;</span></span></pre></dd> + </dl> @@ -217,11 +276,11 @@ <span class="summary_desc"><div class='inline'> -<p>An array of the key uses allowed.</p> +<p>Returns the value of attribute allowed_uses.</p> </div></span> </li> @@ -263,10 +322,32 @@ <li class="public "> <span class="summary_signature"> + <a href="#any_extended_key_usage%3F-instance_method" title="#any_extended_key_usage? (instance method)">- (Boolean) <strong>any_extended_key_usage?</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#code_signing%3F-instance_method" title="#code_signing? (instance method)">- (Boolean) <strong>code_signing?</strong> </a> </span> @@ -333,10 +414,54 @@ <li class="public "> <span class="summary_signature"> + <a href="#ocsp_signing%3F-instance_method" title="#ocsp_signing? (instance method)">- (Boolean) <strong>ocsp_signing?</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#time_stamping%3F-instance_method" title="#time_stamping? (instance method)">- (Boolean) <strong>time_stamping?</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#web_client_authentication%3F-instance_method" title="#web_client_authentication? (instance method)">- (Boolean) <strong>web_client_authentication?</strong> </a> </span> @@ -407,23 +532,133 @@ <tr> <td> <pre class="lines"> -151 -152 -153 -154 -155</pre> +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287 +288</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 151</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 229</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='ivar'>@allowed_uses</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>,</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_use'>use</span><span class='op'>|</span> <span class='id identifier rubyid_use'>use</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='rbrace'>}</span> + <span class='ivar'>@allowed_uses</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</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='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_eku'>eku</span><span class='op'>|</span> + <span class='comment'># The following key usage purposes are defined: +</span> <span class='comment'># +</span> <span class='comment'># anyExtendedKeyUsage OBJECT IDENTIFIER ::= { id-ce-extKeyUsage 0 } +</span> <span class='comment'># +</span> <span class='comment'># id-kp OBJECT IDENTIFIER ::= { id-pkix 3 } +</span> <span class='comment'># id-kp-serverAuth OBJECT IDENTIFIER ::= { id-kp 1 } +</span> <span class='comment'># -- TLS WWW server authentication +</span> <span class='comment'># -- Key usage bits that may be consistent: digitalSignature, +</span> <span class='comment'># -- keyEncipherment or keyAgreement +</span> <span class='comment'># +</span> <span class='comment'># id-kp-clientAuth OBJECT IDENTIFIER ::= { id-kp 2 } +</span> <span class='comment'># -- TLS WWW client authentication +</span> <span class='comment'># -- Key usage bits that may be consistent: digitalSignature +</span> <span class='comment'># -- and/or keyAgreement +</span> <span class='comment'># +</span> <span class='comment'># id-kp-codeSigning OBJECT IDENTIFIER ::= { id-kp 3 } +</span> <span class='comment'># -- Signing of downloadable executable code +</span> <span class='comment'># -- Key usage bits that may be consistent: digitalSignature +</span> <span class='comment'># +</span> <span class='comment'># id-kp-emailProtection OBJECT IDENTIFIER ::= { id-kp 4 } +</span> <span class='comment'># -- Email protection +</span> <span class='comment'># -- Key usage bits that may be consistent: digitalSignature, +</span> <span class='comment'># -- nonRepudiation, and/or (keyEncipherment or keyAgreement) +</span> <span class='comment'># +</span> <span class='comment'># id-kp-timeStamping OBJECT IDENTIFIER ::= { id-kp 8 } +</span> <span class='comment'># -- Binding the hash of an object to a time +</span> <span class='comment'># -- Key usage bits that may be consistent: digitalSignature +</span> <span class='comment'># -- and/or nonRepudiation +</span> <span class='comment'># +</span> <span class='comment'># id-kp-OCSPSigning OBJECT IDENTIFIER ::= { id-kp 9 } +</span> <span class='comment'># -- Signing OCSP responses +</span> <span class='comment'># -- Key usage bits that may be consistent: digitalSignature +</span> <span class='comment'># -- and/or nonRepudiation +</span> + <span class='kw'>case</span> <span class='id identifier rubyid_eku'>eku</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> + <span class='kw'>when</span> <span class='const'>AU_WEB_SERVER_AUTH</span> + <span class='ivar'>@web_server_authentication</span> <span class='op'>=</span> <span class='kw'>true</span> + <span class='kw'>when</span> <span class='const'>AU_WEB_CLIENT_AUTH</span> + <span class='ivar'>@web_client_authentication</span> <span class='op'>=</span> <span class='kw'>true</span> + <span class='kw'>when</span> <span class='const'>AU_CODE_SIGNING</span> + <span class='ivar'>@code_signing</span> <span class='op'>=</span> <span class='kw'>true</span> + <span class='kw'>when</span> <span class='const'>AU_EMAIL_PROTECTION</span> + <span class='ivar'>@email_protection</span> <span class='op'>=</span> <span class='kw'>true</span> + <span class='kw'>when</span> <span class='const'>AU_OCSP_SIGNING</span> + <span class='ivar'>@ocsp_signing</span> <span class='op'>=</span> <span class='kw'>true</span> + <span class='kw'>when</span> <span class='const'>AU_TIME_STAMPING</span> + <span class='ivar'>@time_stamping</span> <span class='op'>=</span> <span class='kw'>true</span> + <span class='kw'>when</span> <span class='const'>AU_ANY_EXTENDED_KEY_USAGE</span> + <span class='ivar'>@any_extended_key_usage</span> <span class='op'>=</span> <span class='kw'>true</span> + <span class='kw'>end</span> + <span class='ivar'>@allowed_uses</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_eku'>eku</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> + <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -445,11 +680,11 @@ </h3><div class="docstring"> <div class="discussion"> -<p>An array of the key uses allowed. See the AU_* constants in this class.</p> +<p>Returns the value of attribute allowed_uses</p> </div> </div> <div class="tags"> @@ -459,16 +694,16 @@ <tr> <td> <pre class="lines"> -148 -149 -150</pre> +226 +227 +228</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 148</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 226</span> <span class='kw'>def</span> <span class='id identifier rubyid_allowed_uses'>allowed_uses</span> <span class='ivar'>@allowed_uses</span> <span class='kw'>end</span></pre> </td> @@ -540,26 +775,78 @@ <tr> <td> <pre class="lines"> -159 -160 -161</pre> +292 +293 +294</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 159</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 292</span> <span class='kw'>def</span> <span class='id identifier rubyid_allows?'>allows?</span><span class='lparen'>(</span> <span class='id identifier rubyid_friendly_use_name'>friendly_use_name</span> <span class='rparen'>)</span> <span class='ivar'>@allowed_uses</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span> <span class='id identifier rubyid_friendly_use_name'>friendly_use_name</span> <span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> + <h3 class="signature " id="any_extended_key_usage?-instance_method"> + + - (<tt>Boolean</tt>) <strong>any_extended_key_usage?</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>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +320 +321 +322</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 320</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_any_extended_key_usage?'>any_extended_key_usage?</span> + <span class='lparen'>(</span><span class='ivar'>@any_extended_key_usage</span> <span class='op'>==</span> <span class='kw'>true</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> <h3 class="signature " id="code_signing?-instance_method"> - (<tt>Boolean</tt>) <strong>code_signing?</strong> @@ -592,19 +879,19 @@ <tr> <td> <pre class="lines"> -171 -172 -173</pre> +304 +305 +306</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 171</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 304</span> <span class='kw'>def</span> <span class='id identifier rubyid_code_signing?'>code_signing?</span> - <span class='id identifier rubyid_allows?'>allows?</span><span class='lparen'>(</span> <span class='const'>AU_CODE_SIGNING</span> <span class='rparen'>)</span> + <span class='lparen'>(</span><span class='ivar'>@code_signing</span> <span class='op'>==</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -644,26 +931,130 @@ <tr> <td> <pre class="lines"> -175 -176 -177</pre> +308 +309 +310</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 175</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 308</span> <span class='kw'>def</span> <span class='id identifier rubyid_email_protection?'>email_protection?</span> - <span class='id identifier rubyid_allows?'>allows?</span><span class='lparen'>(</span> <span class='const'>AU_EMAIL_PROTECTION</span> <span class='rparen'>)</span> + <span class='lparen'>(</span><span class='ivar'>@email_protection</span> <span class='op'>==</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> + <h3 class="signature " id="ocsp_signing?-instance_method"> + + - (<tt>Boolean</tt>) <strong>ocsp_signing?</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>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +312 +313 +314</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 312</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_ocsp_signing?'>ocsp_signing?</span> + <span class='lparen'>(</span><span class='ivar'>@ocsp_signing</span> <span class='op'>==</span> <span class='kw'>true</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="time_stamping?-instance_method"> + + - (<tt>Boolean</tt>) <strong>time_stamping?</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>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +316 +317 +318</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 316</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_time_stamping?'>time_stamping?</span> + <span class='lparen'>(</span><span class='ivar'>@time_stamping</span> <span class='op'>==</span> <span class='kw'>true</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> <h3 class="signature " id="web_client_authentication?-instance_method"> - (<tt>Boolean</tt>) <strong>web_client_authentication?</strong> @@ -696,19 +1087,19 @@ <tr> <td> <pre class="lines"> -167 -168 -169</pre> +300 +301 +302</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 167</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 300</span> <span class='kw'>def</span> <span class='id identifier rubyid_web_client_authentication?'>web_client_authentication?</span> - <span class='id identifier rubyid_allows?'>allows?</span><span class='lparen'>(</span> <span class='const'>AU_WEB_CLIENT_AUTH</span> <span class='rparen'>)</span> + <span class='lparen'>(</span><span class='ivar'>@web_client_authentication</span> <span class='op'>==</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -748,19 +1139,19 @@ <tr> <td> <pre class="lines"> -163 -164 -165</pre> +296 +297 +298</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 163</span> + <pre class="code"><span class="info file"># File 'lib/r509/cert/extensions.rb', line 296</span> <span class='kw'>def</span> <span class='id identifier rubyid_web_server_authentication?'>web_server_authentication?</span> - <span class='id identifier rubyid_allows?'>allows?</span><span class='lparen'>(</span> <span class='const'>AU_WEB_SERVER_AUTH</span> <span class='rparen'>)</span> + <span class='lparen'>(</span><span class='ivar'>@web_server_authentication</span> <span class='op'>==</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> @@ -768,12 +1159,12 @@ </div> </div> <div id="footer"> - Generated on Thu Nov 8 14:19:28 2012 by + Generated on Tue Apr 16 10:49:58 2013 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.8.2.1 (ruby-1.9.3). + 0.8.5 (ruby-1.9.3). </div> </body> </html> \ No newline at end of file