<!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">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: R509::Config::CAConfig
— Documentation by YARD 0.8.5
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
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">
<a href="../../_index.html">Index (C)</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="../Config.html" title="R509::Config (module)">Config</a></span></span>
»
<span class="title">CAConfig</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</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>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: R509::Config::CAConfig
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">R509::Config::CAConfig</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2">Extended by:</dt>
<dd class="r2"><span class='object_link'><a href="../IOHelpers.html" title="R509::IOHelpers (module)">IOHelpers</a></span></dd>
<dt class="r1">Includes:</dt>
<dd class="r1"><span class='object_link'><a href="../IOHelpers.html" title="R509::IOHelpers (module)">IOHelpers</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/r509/config.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Stores a configuration for our CA.</p>
</div>
</div>
<div class="tags">
</div>
<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="#ca_cert-instance_method" title="#ca_cert (instance method)">- (Object) <strong>ca_cert</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute ca_cert.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ca_issuers_location-instance_method" title="#ca_issuers_location (instance method)">- (Object) <strong>ca_issuers_location</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute ca_issuers_location.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#cdp_location-instance_method" title="#cdp_location (instance method)">- (Object) <strong>cdp_location</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute cdp_location.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#crl_list_file-instance_method" title="#crl_list_file (instance method)">- (Object) <strong>crl_list_file</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute crl_list_file.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#crl_number_file-instance_method" title="#crl_number_file (instance method)">- (Object) <strong>crl_number_file</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute crl_number_file.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#crl_start_skew_seconds-instance_method" title="#crl_start_skew_seconds (instance method)">- (Object) <strong>crl_start_skew_seconds</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute crl_start_skew_seconds.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#crl_validity_hours-instance_method" title="#crl_validity_hours (instance method)">- (Object) <strong>crl_validity_hours</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute crl_validity_hours.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#message_digest-instance_method" title="#message_digest (instance method)">- (Object) <strong>message_digest</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute message_digest.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ocsp_chain-instance_method" title="#ocsp_chain (instance method)">- (Object) <strong>ocsp_chain</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute ocsp_chain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ocsp_location-instance_method" title="#ocsp_location (instance method)">- (Object) <strong>ocsp_location</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute ocsp_location.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ocsp_start_skew_seconds-instance_method" title="#ocsp_start_skew_seconds (instance method)">- (Object) <strong>ocsp_start_skew_seconds</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute ocsp_start_skew_seconds.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ocsp_validity_hours-instance_method" title="#ocsp_validity_hours (instance method)">- (Object) <strong>ocsp_validity_hours</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute ocsp_validity_hours.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#from_yaml-class_method" title="from_yaml (class method)">+ (Object) <strong>from_yaml</strong>(conf_name, yaml_data, opts = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Loads the named configuration config from a yaml string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#load_from_hash-class_method" title="load_from_hash (class method)">+ (Object) <strong>load_from_hash</strong>(conf, opts = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Load the configuration from a data hash.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#load_yaml-class_method" title="load_yaml (class method)">+ (Object) <strong>load_yaml</strong>(conf_name, yaml_file, opts = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Loads the named configuration config from a yaml file.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<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)">- (CAConfig) <strong>initialize</strong>(opts = {}) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>OCSP signing delegate that constitutes the chain to attach to an OCSP
response.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#num_profiles-instance_method" title="#num_profiles (instance method)">- (Integer) <strong>num_profiles</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The number of profiles.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ocsp_cert-instance_method" title="#ocsp_cert (instance method)">- (R509::Cert) <strong>ocsp_cert</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Either a custom OCSP cert or the ca_cert.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#profile-instance_method" title="#profile (instance method)">- (R509::Config::CAProfile) <strong>profile</strong>(prof) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The config profile.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#set_profile-instance_method" title="#set_profile (instance method)">- (Object) <strong>set_profile</strong>(name, prof) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../IOHelpers.html" title="R509::IOHelpers (module)">IOHelpers</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../IOHelpers.html#read_data-instance_method" title="R509::IOHelpers#read_data (method)">read_data</a></span>, <span class='object_link'><a href="../IOHelpers.html#read_data-class_method" title="R509::IOHelpers.read_data (method)">read_data</a></span>, <span class='object_link'><a href="../IOHelpers.html#write_data-instance_method" title="R509::IOHelpers#write_data (method)">write_data</a></span>, <span class='object_link'><a href="../IOHelpers.html#write_data-class_method" title="R509::IOHelpers.write_data (method)">write_data</a></span></p>
<div id="constructor_details" class="method_details_list">
<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::Config::CAConfig (class)">CAConfig</a></span></tt>) <strong>initialize</strong>(opts = {})
</h3><div class="docstring">
<div class="discussion">
<p>OCSP signing delegate that constitutes the chain to attach to an OCSP
response</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opts</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a customizable set of options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
<ul class="option">
<li>
<span class="name">:ca_cert</span>
<span class="type">(<tt><span class='object_link'><a href="../Cert.html" title="R509::Cert (class)">R509::Cert</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>Cert+Key pair</p>
</div>
</li>
<li>
<span class="name">:crl_validity_hours</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">
— default:
<tt>168</tt>
</span>
— <div class='inline'>
<p>The number of hours that a CRL will be valid. Defaults to 7 days.</p>
</div>
</li>
<li>
<span class="name">:profiles</span>
<span class="type">(<tt>Hash<String, <span class='object_link'><a href="CAProfile.html" title="R509::Config::CAProfile (class)">R509::Config::CAProfile</a></span>></tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:message_digest</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
— default:
<tt>SHA1</tt>
</span>
— <div class='inline'>
<p>The hashing algorithm to use.</p>
</div>
</li>
<li>
<span class="name">:cdp_location</span>
<span class="type">(<tt>Array</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>array of strings (URLs)</p>
</div>
</li>
<li>
<span class="name">:ocsp_location</span>
<span class="type">(<tt>Array</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>array of strings (URLs)</p>
</div>
</li>
<li>
<span class="name">:ca_issuers_location</span>
<span class="type">(<tt>Array</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>array of strings (URLs)</p>
</div>
</li>
<li>
<span class="name">:crl_number_file</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>The file that we will save the CRL numbers to. defaults to a StringIO
object if not provided</p>
</div>
</li>
<li>
<span class="name">:crl_list_file</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>The file that we will save the CRL list data to. defaults to a StringIO
object if not provided</p>
</div>
</li>
<li>
<span class="name">:ocsp_cert</span>
<span class="type">(<tt><span class='object_link'><a href="../Cert.html" title="R509::Cert (class)">R509::Cert</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>An optional cert+key pair</p>
</div>
</li>
<li>
<span class="name">:ocsp_chain</span>
<span class="type">(<tt>Array<OpenSSL::X509::Certificate></tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>An optional array</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 315</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='kw'>not</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:ca_cert</span><span class='rparen'>)</span> <span class='kw'>then</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'>Config object requires that you pass :ca_cert</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span>
<span class='ivar'>@ca_cert</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ca_cert</span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='kw'>not</span> <span class='ivar'>@ca_cert</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'>Cert</span><span class='rparen'>)</span> <span class='kw'>then</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'>:ca_cert must be of type R509::Cert</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span>
<span class='comment'>#ocsp data
</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:ocsp_cert</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='kw'>not</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_cert</span><span class='rbracket'>]</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'>Cert</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='kw'>not</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_cert</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</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'>:ocsp_cert, if provided, must be of type R509::Cert</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:ocsp_cert</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='kw'>not</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_cert</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>and</span> <span class='kw'>not</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_cert</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_has_private_key?'>has_private_key?</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'>:ocsp_cert must contain a private key, not just a certificate</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span>
<span class='ivar'>@ocsp_cert</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_cert</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_cert</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_validate_ocsp_location'>validate_ocsp_location</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_location</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_validate_ca_issuers_location'>validate_ca_issuers_location</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ca_issuers_location</span><span class='rbracket'>]</span>
<span class='ivar'>@ocsp_chain</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_chain</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_chain</span><span class='rbracket'>]</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='ivar'>@ocsp_validity_hours</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_validity_hours</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>168</span>
<span class='ivar'>@ocsp_start_skew_seconds</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ocsp_start_skew_seconds</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>3600</span>
<span class='ivar'>@crl_validity_hours</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:crl_validity_hours</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>168</span>
<span class='ivar'>@crl_start_skew_seconds</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:crl_start_skew_seconds</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>3600</span>
<span class='ivar'>@crl_number_file</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:crl_number_file</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='kw'>nil</span>
<span class='ivar'>@crl_list_file</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:crl_list_file</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_validate_cdp_location'>validate_cdp_location</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:cdp_location</span><span class='rbracket'>]</span>
<span class='ivar'>@message_digest</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:message_digest</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>SHA1</span><span class='tstring_end'>"</span></span>
<span class='ivar'>@profiles</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:profiles</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:profiles</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_prof'>prof</span><span class='op'>|</span>
<span class='id identifier rubyid_set_profile'>set_profile</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_prof'>prof</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="ca_cert=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="ca_cert-instance_method">
- (<tt>Object</tt>) <strong>ca_cert</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute ca_cert</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ca_cert'>ca_cert</span>
<span class='ivar'>@ca_cert</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="ca_issuers_location=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="ca_issuers_location-instance_method">
- (<tt>Object</tt>) <strong>ca_issuers_location</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute ca_issuers_location</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ca_issuers_location'>ca_issuers_location</span>
<span class='ivar'>@ca_issuers_location</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="cdp_location=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="cdp_location-instance_method">
- (<tt>Object</tt>) <strong>cdp_location</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute cdp_location</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cdp_location'>cdp_location</span>
<span class='ivar'>@cdp_location</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="crl_list_file=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="crl_list_file-instance_method">
- (<tt>Object</tt>) <strong>crl_list_file</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute crl_list_file</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_crl_list_file'>crl_list_file</span>
<span class='ivar'>@crl_list_file</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="crl_number_file=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="crl_number_file-instance_method">
- (<tt>Object</tt>) <strong>crl_number_file</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute crl_number_file</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_crl_number_file'>crl_number_file</span>
<span class='ivar'>@crl_number_file</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="crl_start_skew_seconds=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="crl_start_skew_seconds-instance_method">
- (<tt>Object</tt>) <strong>crl_start_skew_seconds</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute crl_start_skew_seconds</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_crl_start_skew_seconds'>crl_start_skew_seconds</span>
<span class='ivar'>@crl_start_skew_seconds</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="crl_validity_hours=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="crl_validity_hours-instance_method">
- (<tt>Object</tt>) <strong>crl_validity_hours</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute crl_validity_hours</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_crl_validity_hours'>crl_validity_hours</span>
<span class='ivar'>@crl_validity_hours</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="message_digest=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="message_digest-instance_method">
- (<tt>Object</tt>) <strong>message_digest</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute message_digest</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_message_digest'>message_digest</span>
<span class='ivar'>@message_digest</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="ocsp_chain=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="ocsp_chain-instance_method">
- (<tt>Object</tt>) <strong>ocsp_chain</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute ocsp_chain</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ocsp_chain'>ocsp_chain</span>
<span class='ivar'>@ocsp_chain</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="ocsp_location=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="ocsp_location-instance_method">
- (<tt>Object</tt>) <strong>ocsp_location</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute ocsp_location</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ocsp_location'>ocsp_location</span>
<span class='ivar'>@ocsp_location</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="ocsp_start_skew_seconds=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="ocsp_start_skew_seconds-instance_method">
- (<tt>Object</tt>) <strong>ocsp_start_skew_seconds</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute ocsp_start_skew_seconds</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ocsp_start_skew_seconds'>ocsp_start_skew_seconds</span>
<span class='ivar'>@ocsp_start_skew_seconds</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="ocsp_validity_hours=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="ocsp_validity_hours-instance_method">
- (<tt>Object</tt>) <strong>ocsp_validity_hours</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute ocsp_validity_hours</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ocsp_validity_hours'>ocsp_validity_hours</span>
<span class='ivar'>@ocsp_validity_hours</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="from_yaml-class_method">
+ (<tt>Object</tt>) <strong>from_yaml</strong>(conf_name, yaml_data, opts = {})
</h3><div class="docstring">
<div class="discussion">
<p>Loads the named configuration config from a yaml string.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>conf_name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>The name of the config within the file. Note that a single yaml file can
contain more than one configuration.</p>
</div>
</li>
<li>
<span class='name'>yaml_data</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>The filename to load yaml config data from.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
502
503
504
505</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 502</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_yaml'>from_yaml</span><span class='lparen'>(</span><span class='id identifier rubyid_conf_name'>conf_name</span><span class='comma'>,</span> <span class='id identifier rubyid_yaml_data'>yaml_data</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_conf'>conf</span> <span class='op'>=</span> <span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_yaml_data'>yaml_data</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_from_hash'>load_from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='id identifier rubyid_conf_name'>conf_name</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="load_from_hash-class_method">
+ (<tt>Object</tt>) <strong>load_from_hash</strong>(conf, opts = {})
</h3><div class="docstring">
<div class="discussion">
<p>Load the configuration from a data hash. The same type that might be used
when loading from a YAML file.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>conf</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>A hash containing all the configuration options</p>
</div>
</li>
<li>
<span class='name'>opts</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a customizable set of options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
<ul class="option">
<li>
<span class="name">:ca_root_path</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>The root path for the CA. Defaults to the current working directory.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 394</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_from_hash'>load_from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_conf'>conf</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</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'>conf not found</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='const'>Hash</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'>conf must be a Hash</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_ca_root_path'>ca_root_path</span> <span class='op'>=</span> <span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ca_root_path</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>FileUtils</span><span class='period'>.</span><span class='id identifier rubyid_getwd'>getwd</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_directory?'>directory?</span><span class='lparen'>(</span><span class='id identifier rubyid_ca_root_path'>ca_root_path</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>R509Error</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ca_root_path is not a directory: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ca_root_path'>ca_root_path</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_ca_cert_hash'>ca_cert_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ca_cert</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='id identifier rubyid_ca_cert_hash'>ca_cert_hash</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>engine</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_ca_cert'>ca_cert</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_with_engine'>load_with_engine</span><span class='lparen'>(</span><span class='id identifier rubyid_ca_cert_hash'>ca_cert_hash</span><span class='comma'>,</span><span class='id identifier rubyid_ca_root_path'>ca_root_path</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_ca_cert'>ca_cert</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>and</span> <span class='id identifier rubyid_ca_cert_hash'>ca_cert_hash</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>pkcs12</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_ca_cert'>ca_cert</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_with_pkcs12'>load_with_pkcs12</span><span class='lparen'>(</span><span class='id identifier rubyid_ca_cert_hash'>ca_cert_hash</span><span class='comma'>,</span><span class='id identifier rubyid_ca_root_path'>ca_root_path</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_ca_cert'>ca_cert</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>and</span> <span class='id identifier rubyid_ca_cert_hash'>ca_cert_hash</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>cert</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_ca_cert'>ca_cert</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_with_key'>load_with_key</span><span class='lparen'>(</span><span class='id identifier rubyid_ca_cert_hash'>ca_cert_hash</span><span class='comma'>,</span><span class='id identifier rubyid_ca_root_path'>ca_root_path</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ocsp_cert</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ocsp_cert</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>engine</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_ocsp_cert'>ocsp_cert</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_with_engine'>load_with_engine</span><span class='lparen'>(</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ocsp_cert</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span><span class='id identifier rubyid_ca_root_path'>ca_root_path</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_ocsp_cert'>ocsp_cert</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>and</span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ocsp_cert</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>pkcs12</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_ocsp_cert'>ocsp_cert</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_with_pkcs12'>load_with_pkcs12</span><span class='lparen'>(</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ocsp_cert</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span><span class='id identifier rubyid_ca_root_path'>ca_root_path</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_ocsp_cert'>ocsp_cert</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>and</span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ocsp_cert</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>cert</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_ocsp_cert'>ocsp_cert</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_with_key'>load_with_key</span><span class='lparen'>(</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ocsp_cert</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span><span class='id identifier rubyid_ca_root_path'>ca_root_path</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_ocsp_chain'>ocsp_chain</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ocsp_chain</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_ocsp_chain_data'>ocsp_chain_data</span> <span class='op'>=</span> <span class='id identifier rubyid_read_data'>read_data</span><span class='lparen'>(</span><span class='id identifier rubyid_ca_root_path'>ca_root_path</span><span class='op'>+</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ocsp_chain</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_cert_regex'>cert_regex</span> <span class='op'>=</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>-----BEGIN CERTIFICATE-----.+?-----END CERTIFICATE-----</span><span class='regexp_end'>/m</span></span>
<span class='id identifier rubyid_ocsp_chain_data'>ocsp_chain_data</span><span class='period'>.</span><span class='id identifier rubyid_scan'>scan</span><span class='lparen'>(</span><span class='id identifier rubyid_cert_regex'>cert_regex</span><span class='rparen'>)</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_ocsp_chain'>ocsp_chain</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>X509</span><span class='op'>::</span><span class='const'>Certificate</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_cert'>cert</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='symbol'>:ca_cert</span> <span class='op'>=></span> <span class='id identifier rubyid_ca_cert'>ca_cert</span><span class='comma'>,</span>
<span class='symbol'>:ocsp_cert</span> <span class='op'>=></span> <span class='id identifier rubyid_ocsp_cert'>ocsp_cert</span><span class='comma'>,</span>
<span class='symbol'>:ocsp_chain</span> <span class='op'>=></span> <span class='id identifier rubyid_ocsp_chain'>ocsp_chain</span><span class='comma'>,</span>
<span class='symbol'>:crl_validity_hours</span> <span class='op'>=></span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>crl_validity_hours</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:ocsp_validity_hours</span> <span class='op'>=></span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ocsp_validity_hours</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:ocsp_start_skew_seconds</span> <span class='op'>=></span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ocsp_start_skew_seconds</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:ocsp_location</span> <span class='op'>=></span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ocsp_location</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:ca_issuers_location</span> <span class='op'>=></span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ca_issuers_location</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:cdp_location</span> <span class='op'>=></span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>cdp_location</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:message_digest</span> <span class='op'>=></span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>message_digest</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='kw'>if</span> <span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>crl_list</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:crl_list_file</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_ca_root_path'>ca_root_path</span> <span class='op'>+</span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>crl_list</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>crl_number</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:crl_number_file</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_ca_root_path'>ca_root_path</span> <span class='op'>+</span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>crl_number</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_profs'>profs</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>profiles</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</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_profile'>profile</span><span class='op'>|</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>profiles</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_profile'>profile</span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='kw'>not</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>subject_item_policy</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_subject_item_policy'>subject_item_policy</span> <span class='op'>=</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>Config</span><span class='op'>::</span><span class='const'>SubjectItemPolicy</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>subject_item_policy</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_profs'>profs</span><span class='lbracket'>[</span><span class='id identifier rubyid_profile'>profile</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>R509</span><span class='op'>::</span><span class='const'>Config</span><span class='op'>::</span><span class='const'>CAProfile</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:key_usage</span> <span class='op'>=></span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>key_usage</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:extended_key_usage</span> <span class='op'>=></span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>extended_key_usage</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:basic_constraints</span> <span class='op'>=></span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>basic_constraints</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:certificate_policies</span> <span class='op'>=></span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>certificate_policies</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:ocsp_no_check</span> <span class='op'>=></span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ocsp_no_check</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:inhibit_any_policy</span> <span class='op'>=></span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>inhibit_any_policy</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:policy_constraints</span> <span class='op'>=></span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>policy_constraints</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:name_constraints</span> <span class='op'>=></span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>name_constraints</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='symbol'>:subject_item_policy</span> <span class='op'>=></span> <span class='id identifier rubyid_subject_item_policy'>subject_item_policy</span><span class='rparen'>)</span>
<span class='kw'>end</span> <span class='kw'>unless</span> <span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>profiles</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:profiles</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_profs'>profs</span>
<span class='comment'># Create the instance.
</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="load_yaml-class_method">
+ (<tt>Object</tt>) <strong>load_yaml</strong>(conf_name, yaml_file, opts = {})
</h3><div class="docstring">
<div class="discussion">
<p>Loads the named configuration config from a yaml file.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>conf_name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>The name of the config within the file. Note that a single yaml file can
contain more than one configuration.</p>
</div>
</li>
<li>
<span class='name'>yaml_file</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>The filename to load yaml config data from.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
493
494
495
496</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 493</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_yaml'>load_yaml</span><span class='lparen'>(</span><span class='id identifier rubyid_conf_name'>conf_name</span><span class='comma'>,</span> <span class='id identifier rubyid_yaml_file'>yaml_file</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_conf'>conf</span> <span class='op'>=</span> <span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_load_file'>load_file</span><span class='lparen'>(</span><span class='id identifier rubyid_yaml_file'>yaml_file</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_from_hash'>load_from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='id identifier rubyid_conf_name'>conf_name</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="num_profiles-instance_method">
- (<tt>Integer</tt>) <strong>num_profiles</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The number of profiles</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'>
<p>The number of profiles</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
382
383
384</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 382</span>
<span class='kw'>def</span> <span class='id identifier rubyid_num_profiles'>num_profiles</span>
<span class='ivar'>@profiles</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="ocsp_cert-instance_method">
- (<tt><span class='object_link'><a href="../Cert.html" title="R509::Cert (class)">R509::Cert</a></span></tt>) <strong>ocsp_cert</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Either a custom OCSP cert or the ca_cert</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Cert.html" title="R509::Cert (class)">R509::Cert</a></span></tt>)</span>
—
<div class='inline'>
<p>either a custom OCSP cert or the ca_cert</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
359
360
361</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 359</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ocsp_cert'>ocsp_cert</span>
<span class='kw'>if</span> <span class='ivar'>@ocsp_cert</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>then</span> <span class='ivar'>@ca_cert</span> <span class='kw'>else</span> <span class='ivar'>@ocsp_cert</span> <span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="profile-instance_method">
- (<tt><span class='object_link'><a href="CAProfile.html" title="R509::Config::CAProfile (class)">R509::Config::CAProfile</a></span></tt>) <strong>profile</strong>(prof)
</h3><div class="docstring">
<div class="discussion">
<p>The config profile.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>prof</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="CAProfile.html" title="R509::Config::CAProfile (class)">R509::Config::CAProfile</a></span></tt>)</span>
—
<div class='inline'>
<p>The config profile.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
374
375
376
377
378
379</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 374</span>
<span class='kw'>def</span> <span class='id identifier rubyid_profile'>profile</span><span class='lparen'>(</span><span class='id identifier rubyid_prof'>prof</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@profiles</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='id identifier rubyid_prof'>prof</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'>unknown profile '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prof'>prof</span><span class='rbrace'>}</span><span class='tstring_content'>'</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='ivar'>@profiles</span><span class='lbracket'>[</span><span class='id identifier rubyid_prof'>prof</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="set_profile-instance_method">
- (<tt>Object</tt>) <strong>set_profile</strong>(name, prof)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>The name of the profile</p>
</div>
</li>
<li>
<span class='name'>prof</span>
<span class='type'>(<tt><span class='object_link'><a href="CAProfile.html" title="R509::Config::CAProfile (class)">R509::Config::CAProfile</a></span></tt>)</span>
—
<div class='inline'>
<p>The profile configuration</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
365
366
367
368
369
370</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/config.rb', line 365</span>
<span class='kw'>def</span> <span class='id identifier rubyid_set_profile'>set_profile</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_prof'>prof</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_prof'>prof</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'>CAProfile</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>profile is supposed to be a R509::Config::CAProfile</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='ivar'>@profiles</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_prof'>prof</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Apr 17 15:21:07 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.5 (ruby-1.9.3).
</div>
</body>
</html>