1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Passenger: RandomGenerator.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>RandomGenerator.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Phusion Passenger - http://www.modrails.com/</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright (c) 2010 Phusion</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span>
<a name="l00008"></a>00008 <span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span>
<a name="l00009"></a>00009 <span class="comment"> * in the Software without restriction, including without limitation the rights</span>
<a name="l00010"></a>00010 <span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
<a name="l00011"></a>00011 <span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span>
<a name="l00012"></a>00012 <span class="comment"> * furnished to do so, subject to the following conditions:</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * The above copyright notice and this permission notice shall be included in</span>
<a name="l00015"></a>00015 <span class="comment"> * all copies or substantial portions of the Software.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<a name="l00018"></a>00018 <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00019"></a>00019 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<a name="l00020"></a>00020 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<a name="l00021"></a>00021 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
<a name="l00022"></a>00022 <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
<a name="l00023"></a>00023 <span class="comment"> * THE SOFTWARE.</span>
<a name="l00024"></a>00024 <span class="comment"> */</span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_RANDOM_GENERATOR_H_</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_RANDOM_GENERATOR_H_</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="preprocessor">#include <boost/noncopyable.hpp></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <oxt/system_calls.hpp></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="preprocessor">#include "StaticString.h"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "Utils.h"</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include "Exceptions.h"</span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment">/**</span>
<a name="l00040"></a>00040 <span class="comment"> * A random </span>
<a name="l00041"></a>00041 <span class="comment"> */</span>
<a name="l00042"></a>00042 <span class="keyword">namespace </span>Passenger {
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">using namespace </span>std;
<a name="l00045"></a>00045 <span class="keyword">using namespace </span>boost;
<a name="l00046"></a>00046 <span class="keyword">using namespace </span>oxt;
<a name="l00047"></a>00047 <span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment">/**</span>
<a name="l00049"></a>00049 <span class="comment"> * A random data generator. Data is generated using /dev/urandom, and</span>
<a name="l00050"></a>00050 <span class="comment"> * is cryptographically secure. Unlike rand() and friends,</span>
<a name="l00051"></a>00051 <span class="comment"> * RandomGenerator does not require seeding.</span>
<a name="l00052"></a>00052 <span class="comment"> *</span>
<a name="l00053"></a>00053 <span class="comment"> * The reason why RandomGenerator isn't a singleton is because opening</span>
<a name="l00054"></a>00054 <span class="comment"> * /dev/urandom is *very* slow on Mac OS X and OpenBSD. Each object of</span>
<a name="l00055"></a>00055 <span class="comment"> * this class caches the /dev/urandom file handle.</span>
<a name="l00056"></a>00056 <span class="comment"> *</span>
<a name="l00057"></a>00057 <span class="comment"> * This class is thread-safe as long as there are no concurrent</span>
<a name="l00058"></a>00058 <span class="comment"> * calls to reopen() or close().</span>
<a name="l00059"></a>00059 <span class="comment"> */</span>
<a name="l00060"></a><a class="code" href="classPassenger_1_1RandomGenerator.html">00060</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1RandomGenerator.html" title="A random data generator.">RandomGenerator</a>: <span class="keyword">public</span> boost::noncopyable {
<a name="l00061"></a>00061 <span class="keyword">private</span>:
<a name="l00062"></a>00062 FILE *handle;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="keyword">public</span>:
<a name="l00065"></a>00065 <a class="code" href="classPassenger_1_1RandomGenerator.html" title="A random data generator.">RandomGenerator</a>(<span class="keywordtype">bool</span> open = <span class="keyword">true</span>) {
<a name="l00066"></a>00066 handle = NULL;
<a name="l00067"></a>00067 <span class="keywordflow">if</span> (open) {
<a name="l00068"></a>00068 reopen();
<a name="l00069"></a>00069 }
<a name="l00070"></a>00070 }
<a name="l00071"></a>00071
<a name="l00072"></a>00072 ~<a class="code" href="classPassenger_1_1RandomGenerator.html" title="A random data generator.">RandomGenerator</a>() {
<a name="l00073"></a>00073 this_thread::disable_syscall_interruption dsi;
<a name="l00074"></a>00074 close();
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="keywordtype">void</span> reopen() {
<a name="l00078"></a>00078 close();
<a name="l00079"></a>00079 handle = syscalls::fopen(<span class="stringliteral">"/dev/urandom"</span>, <span class="stringliteral">"r"</span>);
<a name="l00080"></a>00080 <span class="keywordflow">if</span> (handle == NULL) {
<a name="l00081"></a>00081 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system.">FileSystemException</a>(<span class="stringliteral">"Cannot open /dev/urandom"</span>,
<a name="l00082"></a>00082 errno, <span class="stringliteral">"/dev/urandom"</span>);
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084 }
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="keywordtype">void</span> close() {
<a name="l00087"></a>00087 <span class="keywordflow">if</span> (handle != NULL) {
<a name="l00088"></a>00088 syscalls::fclose(handle);
<a name="l00089"></a>00089 handle = NULL;
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> generateBytes(<span class="keywordtype">void</span> *buf, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
<a name="l00094"></a>00094 <span class="keywordtype">size_t</span> ret = syscalls::fread(buf, 1, size, handle);
<a name="l00095"></a>00095 <span class="keywordflow">if</span> (ret != size) {
<a name="l00096"></a>00096 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Cannot read sufficient data from /dev/urandom"</span>);
<a name="l00097"></a>00097 }
<a name="l00098"></a>00098 <span class="keywordflow">return</span> <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a>((<span class="keyword">const</span> <span class="keywordtype">char</span> *) buf, size);
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="keywordtype">string</span> generateByteString(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
<a name="l00102"></a>00102 <span class="keywordtype">char</span> buf[size];
<a name="l00103"></a>00103 generateBytes(buf, size);
<a name="l00104"></a>00104 <span class="keywordflow">return</span> string(buf, size);
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keywordtype">string</span> generateHexString(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
<a name="l00108"></a>00108 <span class="keywordtype">char</span> buf[size];
<a name="l00109"></a>00109 generateBytes(buf, size);
<a name="l00110"></a>00110 <span class="keywordflow">return</span> <a class="code" href="namespacePassenger.html#1d4b16a419fe7231bc8b7036266f8131" title="Convert the given binary data to hexadecimal.">toHex</a>(<a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a>(buf, size));
<a name="l00111"></a>00111 }
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keywordtype">int</span> generateInt() {
<a name="l00114"></a>00114 <span class="keywordtype">int</span> ret;
<a name="l00115"></a>00115 generateBytes(&ret, <span class="keyword">sizeof</span>(ret));
<a name="l00116"></a>00116 <span class="keywordflow">return</span> ret;
<a name="l00117"></a>00117 }
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> generateUint() {
<a name="l00120"></a>00120 <span class="keywordflow">return</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) generateInt();
<a name="l00121"></a>00121 }
<a name="l00122"></a>00122 };
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="keyword">typedef</span> shared_ptr<RandomGenerator> RandomGeneratorPtr;
<a name="l00125"></a>00125
<a name="l00126"></a>00126 } <span class="comment">// namespace Passenger</span>
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_RANDOM_GENERATOR_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
