File: Account_8h-source.html

package info (click to toggle)
passenger 2.2.11debian-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 11,576 kB
  • ctags: 28,138
  • sloc: cpp: 66,323; ruby: 9,646; ansic: 2,425; python: 141; sh: 56; makefile: 29
file content (202 lines) | stat: -rw-r--r-- 17,906 bytes parent folder | download
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<!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: Account.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&nbsp;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&nbsp;List</span></a></li>
    </ul>
  </div>
<h1>Account.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 &amp; 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_ACCOUNT_H_</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_ACCOUNT_H_</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "StaticString.h"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "Utils.h"</span>
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 <span class="keyword">namespace </span>Passenger {
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 <span class="keyword">using namespace </span>boost;
<a name="l00037"></a>00037 <span class="keyword">using namespace </span>std;
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 <span class="comment">/*</span>
<a name="l00040"></a>00040 <span class="comment"> * SECURITY NOTES</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> * We want to avoid storing plain text passwords in memory, because attackers may be able</span>
<a name="l00043"></a>00043 <span class="comment"> * to read this process's memory, e.g. through core dumps or debuggers. So in this source</span>
<a name="l00044"></a>00044 <span class="comment"> * file, as well as in several others, we follow these guidelines:</span>
<a name="l00045"></a>00045 <span class="comment"> *</span>
<a name="l00046"></a>00046 <span class="comment"> * - Variables and arguments named userSuppliedPassword represent passwords</span>
<a name="l00047"></a>00047 <span class="comment"> *   supplied by a human, i.e. user input. These variables and arguments have the type</span>
<a name="l00048"></a>00048 <span class="comment"> *   'StaticString' instead of 'string', because we want to avoid accidentally copying</span>
<a name="l00049"></a>00049 <span class="comment"> *   the password values.</span>
<a name="l00050"></a>00050 <span class="comment"> * - Variables and arguments named passwordOrHash might also represent passwords. However,</span>
<a name="l00051"></a>00051 <span class="comment"> *   if it is a password, then it is guaranteed NOT to be supplied by a human, e.g. it's</span>
<a name="l00052"></a>00052 <span class="comment"> *   randomly generated. Therefore it's okay for passwordOrHash to be of type 'string'.</span>
<a name="l00053"></a>00053 <span class="comment"> * - If there is a need to copy the password for whatever reason, then it must be cleared</span>
<a name="l00054"></a>00054 <span class="comment"> *   with ZeroMemoryGuard (Utils.h) as soon as possible. Do not use memset(), the code</span>
<a name="l00055"></a>00055 <span class="comment"> *   for ZeroMemoryGuard explains why.</span>
<a name="l00056"></a>00056 <span class="comment"> */</span>
<a name="l00057"></a>00057 
<a name="l00058"></a>00058 <span class="keyword">class </span>Account {
<a name="l00059"></a>00059 <span class="keyword">public</span>:
<a name="l00060"></a>00060         <span class="keyword">enum</span> Rights {
<a name="l00061"></a>00061                 ALL                       = ~0,
<a name="l00062"></a>00062                 NONE                      = 0,
<a name="l00063"></a>00063                 
<a name="l00064"></a>00064                 <span class="comment">// ApplicationPool::Server rights.</span>
<a name="l00065"></a>00065                 GET                       = 1 &lt;&lt; 0,
<a name="l00066"></a>00066                 CLEAR                     = 1 &lt;&lt; 1,
<a name="l00067"></a>00067                 DETACH                    = 1 &lt;&lt; 2,
<a name="l00068"></a>00068                 GET_PARAMETERS            = 1 &lt;&lt; 3,
<a name="l00069"></a>00069                 SET_PARAMETERS            = 1 &lt;&lt; 4,
<a name="l00070"></a>00070                 INSPECT_BASIC_INFO        = 1 &lt;&lt; 5,
<a name="l00071"></a>00071                 INSPECT_SENSITIVE_INFO    = 1 &lt;&lt; 6,
<a name="l00072"></a>00072                 <span class="comment">//INSPECT_BACKEND_ADDRESSES = 1 &lt;&lt; 6,</span>
<a name="l00073"></a>00073                 <span class="comment">//INSPECT_DETACH_KEYS       = 1 &lt;&lt; 7,</span>
<a name="l00074"></a>00074                 
<a name="l00075"></a>00075                 <span class="comment">// BacktracesServer rights.</span>
<a name="l00076"></a>00076                 INSPECT_BACKTRACES        = 1 &lt;&lt; 8,
<a name="l00077"></a>00077                 
<a name="l00078"></a>00078                 <span class="comment">// Other rights.</span>
<a name="l00079"></a>00079                 EXIT                      = 1 &lt;&lt; 9
<a name="l00080"></a>00080         };
<a name="l00081"></a>00081 
<a name="l00082"></a>00082 <span class="keyword">private</span>:
<a name="l00083"></a>00083         <span class="keywordtype">string</span> username;
<a name="l00084"></a>00084         <span class="keywordtype">string</span> passwordOrHash;
<a name="l00085"></a>00085         <span class="keywordtype">bool</span> hashGiven;
<a name="l00086"></a>00086         Rights rights;
<a name="l00087"></a>00087 
<a name="l00088"></a>00088 <span class="keyword">public</span>:
<a name="l00089"></a>00089         <span class="comment">// Urgh, I can't use 'Rights' here as type because apparently bitwise</span>
<a name="l00090"></a>00090         <span class="comment">// ORing two enums results in an int type.</span>
<a name="l00091"></a>00091         
<a name="l00092"></a>00092         <span class="keyword">static</span> Rights parseRightsString(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;str, <span class="keywordtype">int</span> defaultValue = NONE) {
<a name="l00093"></a>00093                 vector&lt;string&gt; rights_vec;
<a name="l00094"></a>00094                 vector&lt;string&gt;::const_iterator it;
<a name="l00095"></a>00095                 <span class="keywordtype">int</span> result = defaultValue;
<a name="l00096"></a>00096                 
<a name="l00097"></a>00097                 <a class="code" href="group__Support.html#g4b8320aedc6a164a535c920234e3d8bf" title="Split the given string using the given separator.">split</a>(str, <span class="charliteral">','</span>, rights_vec);
<a name="l00098"></a>00098                 <span class="keywordflow">for</span> (it = rights_vec.begin(); it != rights_vec.end(); it++) {
<a name="l00099"></a>00099                         <span class="keywordflow">if</span> (*it == <span class="stringliteral">"all"</span>) {
<a name="l00100"></a>00100                                 result = ALL;
<a name="l00101"></a>00101                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">"none"</span>) {
<a name="l00102"></a>00102                                 result = NONE;
<a name="l00103"></a>00103                         
<a name="l00104"></a>00104                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">"get"</span>) {
<a name="l00105"></a>00105                                 result |= GET;
<a name="l00106"></a>00106                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">"clear"</span>) {
<a name="l00107"></a>00107                                 result |= CLEAR;
<a name="l00108"></a>00108                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">"detach"</span>) {
<a name="l00109"></a>00109                                 result |= DETACH;
<a name="l00110"></a>00110                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">"get_parameters"</span>) {
<a name="l00111"></a>00111                                 result |= GET_PARAMETERS;
<a name="l00112"></a>00112                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">"set_parameters"</span>) {
<a name="l00113"></a>00113                                 result |= SET_PARAMETERS;
<a name="l00114"></a>00114                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">"inspect_basic_info"</span>) {
<a name="l00115"></a>00115                                 result |= INSPECT_BASIC_INFO;
<a name="l00116"></a>00116                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">"inspect_sensitive_info"</span>) {
<a name="l00117"></a>00117                                 result |= INSPECT_SENSITIVE_INFO;
<a name="l00118"></a>00118                         
<a name="l00119"></a>00119                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">"inspect_backtraces"</span>) {
<a name="l00120"></a>00120                                 result |= INSPECT_BACKTRACES;
<a name="l00121"></a>00121                                 
<a name="l00122"></a>00122                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">"exit"</span>) {
<a name="l00123"></a>00123                                 result |= EXIT;
<a name="l00124"></a>00124                                 
<a name="l00125"></a>00125                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it != <span class="stringliteral">""</span>) {
<a name="l00126"></a>00126                                 <span class="keywordflow">throw</span> ArgumentException(<span class="stringliteral">"Unknown right '"</span> + *it + <span class="stringliteral">"'."</span>);
<a name="l00127"></a>00127                         }
<a name="l00128"></a>00128                 }
<a name="l00129"></a>00129                 
<a name="l00130"></a>00130                 <span class="keywordflow">return</span> (Rights) result;
<a name="l00131"></a>00131         }
<a name="l00132"></a>00132         
<a name="l00133"></a>00133         Account(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;username, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;passwordOrHash, <span class="keywordtype">bool</span> hashGiven, <span class="keywordtype">int</span> rights = ALL) {
<a name="l00134"></a>00134                 this-&gt;username       = username;
<a name="l00135"></a>00135                 this-&gt;passwordOrHash = passwordOrHash;
<a name="l00136"></a>00136                 this-&gt;hashGiven      = hashGiven;
<a name="l00137"></a>00137                 this-&gt;rights         = (Rights) rights;
<a name="l00138"></a>00138         }
<a name="l00139"></a>00139         
<a name="l00140"></a>00140         <span class="keywordtype">bool</span> checkPasswordOrHash(<span class="keyword">const</span> StaticString &amp;userSuppliedPassword)<span class="keyword"> const </span>{
<a name="l00141"></a>00141                 <span class="keywordflow">if</span> (hashGiven) {
<a name="l00142"></a>00142                         <span class="keywordflow">return</span> passwordOrHash == createHash(userSuppliedPassword);
<a name="l00143"></a>00143                 } <span class="keywordflow">else</span> {
<a name="l00144"></a>00144                         <span class="keywordflow">return</span> userSuppliedPassword == passwordOrHash;
<a name="l00145"></a>00145                 }
<a name="l00146"></a>00146         }
<a name="l00147"></a>00147         
<a name="l00148"></a>00148         <span class="keywordtype">bool</span> hasRights(<span class="keywordtype">int</span> rights)<span class="keyword"> const </span>{
<a name="l00149"></a>00149                 <span class="keywordflow">return</span> this-&gt;rights &amp; rights;
<a name="l00150"></a>00150         }
<a name="l00151"></a>00151         
<a name="l00152"></a>00152         <span class="keywordtype">void</span> setRights(<span class="keywordtype">int</span> rights) {
<a name="l00153"></a>00153                 this-&gt;rights = (Rights) rights;
<a name="l00154"></a>00154         }
<a name="l00155"></a>00155         
<a name="l00156"></a>00156         <span class="keywordtype">string</span> getUsername()<span class="keyword"> const </span>{
<a name="l00157"></a>00157                 <span class="keywordflow">return</span> username;
<a name="l00158"></a>00158         }
<a name="l00159"></a>00159         
<a name="l00160"></a>00160         <span class="keywordtype">string</span> getRawPassword()<span class="keyword"> const </span>{
<a name="l00161"></a>00161                 <span class="keywordflow">return</span> passwordOrHash;
<a name="l00162"></a>00162         }
<a name="l00163"></a>00163         
<a name="l00164"></a>00164         <span class="keyword">static</span> <span class="keywordtype">string</span> createHash(<span class="keyword">const</span> StaticString &amp;userSuppliedPassword) {
<a name="l00165"></a>00165                 <span class="comment">// TODO: use bcrypt or something</span>
<a name="l00166"></a>00166                 <span class="keywordflow">return</span> userSuppliedPassword;
<a name="l00167"></a>00167         }
<a name="l00168"></a>00168 };
<a name="l00169"></a>00169 
<a name="l00170"></a>00170 <span class="keyword">typedef</span> shared_ptr&lt;Account&gt; AccountPtr;
<a name="l00171"></a>00171 
<a name="l00172"></a>00172 } <span class="comment">// namespace Passenger</span>
<a name="l00173"></a>00173 
<a name="l00174"></a>00174 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_ACCOUNT_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:45 2010 for Passenger by&nbsp;
<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>