<!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::CRL::FileReaderWriter
— Documentation by YARD 0.8.6.1
</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;
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 (F)</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="../CRL.html" title="R509::CRL (module)">CRL</a></span></span>
»
<span class="title">FileReaderWriter</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::CRL::FileReaderWriter
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="ReaderWriter.html" title="R509::CRL::ReaderWriter (class)">ReaderWriter</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="ReaderWriter.html" title="R509::CRL::ReaderWriter (class)">ReaderWriter</a></span></li>
<li class="next">R509::CRL::FileReaderWriter</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/r509/crl/reader_writer.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>File-based implementation of the CRL reader/writer. Uses the
crl_number_file and crl_list_file attributes in CAConfig</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="#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>
</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)">- (FileReaderWriter) <strong>initialize</strong> </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of FileReaderWriter.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#read_list-instance_method" title="#read_list (instance method)">- (Object) <strong>read_list</strong>(admin) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Reads a CRL list file from a file or StringIO.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#read_number-instance_method" title="#read_number (instance method)">- (Object) <strong>read_number</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>read the CRL number from a file or StringIO.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#remove_list_entry-instance_method" title="#remove_list_entry (instance method)">- (Object) <strong>remove_list_entry</strong>(serial) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Remove a CRL list entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#write_list_entry-instance_method" title="#write_list_entry (instance method)">- (Object) <strong>write_list_entry</strong>(serial, revoke_time, reason) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Appends a CRL list entry to a file or StringIO.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#write_number-instance_method" title="#write_number (instance method)">- (Object) <strong>write_number</strong>(crl_number) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>write the CRL number to a file or StringIO.</p>
</div></span>
</li>
</ul>
<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::CRL::FileReaderWriter (class)">FileReaderWriter</a></span></tt>) <strong>initialize</strong>
</h3><div class="docstring">
<div class="discussion">
<p>A new instance of FileReaderWriter</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/crl/reader_writer.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='ivar'>@crl_number_file</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@crl_list_file</span> <span class='op'>=</span> <span class='kw'>nil</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="crl_list_file=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" 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">
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/crl/reader_writer.rb', line 37</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">
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/crl/reader_writer.rb', line 37</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>
</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="read_list-instance_method">
- (<tt>Object</tt>) <strong>read_list</strong>(admin)
</h3><div class="docstring">
<div class="discussion">
<p>Reads a CRL list file from a file or StringIO</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>admin</span>
<span class='type'>(<tt><span class='object_link'><a href="Administrator.html" title="R509::CRL::Administrator (class)">R509::CRL::Administrator</a></span></tt>)</span>
—
<div class='inline'>
<p>the parent CRL Administrator object</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/crl/reader_writer.rb', line 46</span>
<span class='kw'>def</span> <span class='id identifier rubyid_read_list'>read_list</span><span class='lparen'>(</span><span class='id identifier rubyid_admin'>admin</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@crl_list_file</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_read_data'>read_data</span><span class='lparen'>(</span><span class='ivar'>@crl_list_file</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_each_line'>each_line</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='op'>|</span>
<span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_chomp!'>chomp!</span>
<span class='id identifier rubyid_serial'>serial</span><span class='comma'>,</span> <span class='id identifier rubyid_revoke_time'>revoke_time</span><span class='comma'>,</span> <span class='id identifier rubyid_reason'>reason</span> <span class='op'>=</span> <span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>3</span><span class='rparen'>)</span>
<span class='id identifier rubyid_serial'>serial</span> <span class='op'>=</span> <span class='id identifier rubyid_serial'>serial</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='id identifier rubyid_reason'>reason</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_reason'>reason</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='id identifier rubyid_reason'>reason</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='id identifier rubyid_revoke_time'>revoke_time</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_revoke_time'>revoke_time</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='id identifier rubyid_revoke_time'>revoke_time</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='id identifier rubyid_admin'>admin</span><span class='period'>.</span><span class='id identifier rubyid_revoke_cert'>revoke_cert</span><span class='lparen'>(</span><span class='id identifier rubyid_serial'>serial</span><span class='comma'>,</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span> <span class='id identifier rubyid_revoke_time'>revoke_time</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="read_number-instance_method">
- (<tt>Object</tt>) <strong>read_number</strong>
</h3><div class="docstring">
<div class="discussion">
<p>read the CRL number from a file or StringIO</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
94
95
96
97
98</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/crl/reader_writer.rb', line 94</span>
<span class='kw'>def</span> <span class='id identifier rubyid_read_number'>read_number</span>
<span class='kw'>return</span> <span class='int'>0</span> <span class='kw'>if</span> <span class='ivar'>@crl_number_file</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_read_data'>read_data</span><span class='lparen'>(</span><span class='ivar'>@crl_number_file</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="remove_list_entry-instance_method">
- (<tt>Object</tt>) <strong>remove_list_entry</strong>(serial)
</h3><div class="docstring">
<div class="discussion">
<p>Remove a CRL list entry</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>serial</span>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'>
<p>serial number of the certificate to remove from the list</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/crl/reader_writer.rb', line 75</span>
<span class='kw'>def</span> <span class='id identifier rubyid_remove_list_entry'>remove_list_entry</span><span class='lparen'>(</span><span class='id identifier rubyid_serial'>serial</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@crl_list_file</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_read_data'>read_data</span><span class='lparen'>(</span><span class='ivar'>@crl_list_file</span><span class='rparen'>)</span>
<span class='id identifier rubyid_updated_list'>updated_list</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_each_line'>each_line</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='op'>|</span>
<span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_chomp!'>chomp!</span>
<span class='id identifier rubyid_revoke_info'>revoke_info</span> <span class='op'>=</span> <span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>3</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_revoke_info'>revoke_info</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>!=</span> <span class='id identifier rubyid_serial'>serial</span>
<span class='id identifier rubyid_updated_list'>updated_list</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_line'>line</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_write_data'>write_data</span><span class='lparen'>(</span><span class='ivar'>@crl_list_file</span><span class='comma'>,</span> <span class='id identifier rubyid_updated_list'>updated_list</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='op'>+</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="write_list_entry-instance_method">
- (<tt>Object</tt>) <strong>write_list_entry</strong>(serial, revoke_time, reason)
</h3><div class="docstring">
<div class="discussion">
<p>Appends a CRL list entry to a file or StringIO</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>serial</span>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'>
<p>serial number of the certificate to revoke</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
—
<div class='inline'>
<p>reason for revocation</p>
</div>
</li>
<li>
<span class='name'>revoke_time</span>
<span class='type'>(<tt>Integer</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68
69
70
71</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/crl/reader_writer.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_write_list_entry'>write_list_entry</span><span class='lparen'>(</span><span class='id identifier rubyid_serial'>serial</span><span class='comma'>,</span> <span class='id identifier rubyid_revoke_time'>revoke_time</span><span class='comma'>,</span> <span class='id identifier rubyid_reason'>reason</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@crl_list_file</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_entry'>entry</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_serial'>serial</span><span class='comma'>,</span><span class='id identifier rubyid_revoke_time'>revoke_time</span><span class='comma'>,</span><span class='id identifier rubyid_reason'>reason</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>,</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_write_data'>write_data</span><span class='lparen'>(</span><span class='ivar'>@crl_list_file</span><span class='comma'>,</span> <span class='id identifier rubyid_entry'>entry</span><span class='op'>+</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span> <span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:ascii-8bit</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="write_number-instance_method">
- (<tt>Object</tt>) <strong>write_number</strong>(crl_number)
</h3><div class="docstring">
<div class="discussion">
<p>write the CRL number to a file or StringIO</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
101
102
103
104
105</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/r509/crl/reader_writer.rb', line 101</span>
<span class='kw'>def</span> <span class='id identifier rubyid_write_number'>write_number</span><span class='lparen'>(</span><span class='id identifier rubyid_crl_number'>crl_number</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@crl_number_file</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_write_data'>write_data</span><span class='lparen'>(</span><span class='ivar'>@crl_number_file</span><span class='comma'>,</span><span class='id identifier rubyid_crl_number'>crl_number</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Jan 26 13:37:27 2014 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.6.1 (ruby-2.0.0).
</div>
</body>
</html>