doc/R509/CertificateAuthority/OptionsBuilder.html in r509-0.10.0 vs doc/R509/CertificateAuthority/OptionsBuilder.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::CertificateAuthority::OptionsBuilder
- — Documentation by YARD 0.8.6.1
+ — 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::CertificateAuthority::OptionsBuilder";
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 (O)</a> »
<span class='title'><span class='object_link'><a href="../../R509.html" title="R509 (module)">R509</a></span></span> » <span class='title'><span class='object_link'><a href="../CertificateAuthority.html" title="R509::CertificateAuthority (module)">CertificateAuthority</a></span></span>
»
<span class="title">OptionsBuilder</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::CertificateAuthority::OptionsBuilder
+ <div id="content"><h1>Class: R509::CertificateAuthority::OptionsBuilder
</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::CertificateAuthority::OptionsBuilder</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/certificate_authority/options_builder.rb</dd>
+
-</dl>
-<div class="clear"></div>
+
+ <dl>
+ <dt>Defined in:</dt>
+ <dd>lib/r509/certificate_authority/options_builder.rb</dd>
+ </dl>
+
+</div>
+
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A class to build hashes to send to the R509::CertificateAuthority::Signer.
These are built from R509::Config::CertProfile objects and additional data
@@ -120,19 +122,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="#build_and_enforce-instance_method" title="#build_and_enforce (instance method)">- (Hash) <strong>build_and_enforce</strong>(options) </a>
+ <a href="#build_and_enforce-instance_method" title="#build_and_enforce (instance method)">#<strong>build_and_enforce</strong>(options) ⇒ Hash </a>
</span>
@@ -153,11 +155,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (OptionsBuilder) <strong>initialize</strong>(config) </a>
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(config) ⇒ OptionsBuilder </a>
</span>
@@ -185,20 +187,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::CertificateAuthority::OptionsBuilder (class)">OptionsBuilder</a></span></tt>) <strong>initialize</strong>(config)
+ #<strong>initialize</strong>(config) ⇒ <tt><span class='object_link'><a href="" title="R509::CertificateAuthority::OptionsBuilder (class)">OptionsBuilder</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
-<p>A new instance of OptionsBuilder</p>
+<p>Returns a new instance of OptionsBuilder</p>
</div>
</div>
<div class="tags">
@@ -219,11 +221,11 @@
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/certificate_authority/options_builder.rb', line 4</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
- <span class='kw'>if</span> <span class='kw'>not</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='const'>R509</span><span class='op'>::</span><span class='const'>Config</span><span class='op'>::</span><span class='const'>CAConfig</span><span class='rparen'>)</span>
+ <span class='kw'>unless</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>R509</span><span class='op'>::</span><span class='const'>Config</span><span class='op'>::</span><span class='const'>CAConfig</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>You must supply a R509::Config::CAConfig object to this class at instantiation</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='ivar'>@config</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span>
<span class='kw'>end</span></pre>
</td>
@@ -239,21 +241,21 @@
<div class="method_details first">
<h3 class="signature first" id="build_and_enforce-instance_method">
- - (<tt>Hash</tt>) <strong>build_and_enforce</strong>(options)
+ #<strong>build_and_enforce</strong>(options) ⇒ <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
-<p>Hash of :message_digest, :subject, :extensions, and :csr/:spki ready to be
-passed to the Signer</p>
+<p>Returns Hash of :message_digest, :subject, :extensions, and :csr/:spki
+ready to be passed to the Signer</p>
</div>
</div>
<div class="tags">
@@ -439,19 +441,19 @@
<span class='kw'>def</span> <span class='id identifier rubyid_build_and_enforce'>build_and_enforce</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_profile'>profile</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_profile'>profile</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:profile_name</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='const'>R509</span><span class='op'>::</span><span class='const'>CertificateAuthority</span><span class='op'>::</span><span class='const'>Signer</span><span class='period'>.</span><span class='id identifier rubyid_check_options'>check_options</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
- <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:csr</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='kw'>not</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:csr</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_verify_signature'>verify_signature</span><span class='rparen'>)</span> <span class='kw'>or</span>
- <span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:spki</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='kw'>not</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:spki</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_verify_signature'>verify_signature</span><span class='rparen'>)</span>
+ <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:csr</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:csr</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_verify_signature'>verify_signature</span><span class='rparen'>)</span> <span class='op'>||</span>
+ <span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:spki</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:spki</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_verify_signature'>verify_signature</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'>"</span><span class='tstring_content'>Request signature is invalid.</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_raw_subject'>raw_subject</span><span class='comma'>,</span> <span class='id identifier rubyid_public_key'>public_key</span> <span class='op'>=</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>CertificateAuthority</span><span class='op'>::</span><span class='const'>Signer</span><span class='period'>.</span><span class='id identifier rubyid_extract_public_key_subject'>extract_public_key_subject</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_message_digest'>message_digest</span> <span class='op'>=</span> <span class='id identifier rubyid_enforce_md'>enforce_md</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:message_digest</span><span class='rbracket'>]</span><span class='comma'>,</span><span class='id identifier rubyid_profile'>profile</span><span class='rparen'>)</span>
- <span class='id identifier rubyid_subject'>subject</span> <span class='op'>=</span> <span class='id identifier rubyid_enforce_subject_item_policy'>enforce_subject_item_policy</span><span class='lparen'>(</span><span class='id identifier rubyid_raw_subject'>raw_subject</span><span class='comma'>,</span><span class='id identifier rubyid_profile'>profile</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_message_digest'>message_digest</span> <span class='op'>=</span> <span class='id identifier rubyid_enforce_md'>enforce_md</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:message_digest</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_profile'>profile</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_subject'>subject</span> <span class='op'>=</span> <span class='id identifier rubyid_enforce_subject_item_policy'>enforce_subject_item_policy</span><span class='lparen'>(</span><span class='id identifier rubyid_raw_subject'>raw_subject</span><span class='comma'>,</span> <span class='id identifier rubyid_profile'>profile</span><span class='rparen'>)</span>
<span class='id identifier rubyid_enforce_not_after'>enforce_not_after</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:not_after</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_extensions'>extensions</span> <span class='op'>=</span> <span class='id identifier rubyid_build_and_merge_extensions'>build_and_merge_extensions</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_profile'>profile</span><span class='comma'>,</span> <span class='id identifier rubyid_public_key'>public_key</span><span class='rparen'>)</span>
<span class='id identifier rubyid_build_hash'>build_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_subject'>subject</span><span class='comma'>,</span> <span class='id identifier rubyid_extensions'>extensions</span><span class='comma'>,</span> <span class='id identifier rubyid_message_digest'>message_digest</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
@@ -463,13 +465,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