/usr/share/doc/libpion-doc/html/classpion_1_1http_1_1basic__auth.html is in libpion-doc 5.0.7+dfsg-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 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 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 | <!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pion: pion::http::basic_auth Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">pion
 <span id="projectnumber">5.0.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>pion</b></li><li class="navelem"><b>http</b></li><li class="navelem"><a class="el" href="classpion_1_1http_1_1basic__auth.html">basic_auth</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="classpion_1_1http_1_1basic__auth-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pion::http::basic_auth Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="basic__auth_8hpp_source.html">basic_auth.hpp</a>></code></p>
<p>Inherits <a class="el" href="classpion_1_1http_1_1auth.html">pion::http::auth</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a81644f280b0c499a06e0d44bccc83773"><td class="memItemLeft" align="right" valign="top"><a id="a81644f280b0c499a06e0d44bccc83773"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1basic__auth.html#a81644f280b0c499a06e0d44bccc83773">basic_auth</a> (user_manager_ptr userManager, const std::string &realm="PION")</td></tr>
<tr class="memdesc:a81644f280b0c499a06e0d44bccc83773"><td class="mdescLeft"> </td><td class="mdescRight">default constructor <br /></td></tr>
<tr class="separator:a81644f280b0c499a06e0d44bccc83773"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27a464fec905b9f071d1ecb3c026709b"><td class="memItemLeft" align="right" valign="top"><a id="a27a464fec905b9f071d1ecb3c026709b"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1basic__auth.html#a27a464fec905b9f071d1ecb3c026709b">~basic_auth</a> ()</td></tr>
<tr class="memdesc:a27a464fec905b9f071d1ecb3c026709b"><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <br /></td></tr>
<tr class="separator:a27a464fec905b9f071d1ecb3c026709b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a032fb3d76e1e4f4e484a97bae7f5b367"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1basic__auth.html#a032fb3d76e1e4f4e484a97bae7f5b367">handle_request</a> (const http::request_ptr &http_request_ptr, const tcp::connection_ptr &tcp_conn)</td></tr>
<tr class="separator:a032fb3d76e1e4f4e484a97bae7f5b367"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9da335bd02b00b82cff40cb333fe7ee7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1basic__auth.html#a9da335bd02b00b82cff40cb333fe7ee7">set_option</a> (const std::string &name, const std::string &value)</td></tr>
<tr class="separator:a9da335bd02b00b82cff40cb333fe7ee7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classpion_1_1http_1_1auth"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classpion_1_1http_1_1auth')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classpion_1_1http_1_1auth.html">pion::http::auth</a></td></tr>
<tr class="memitem:a464d923e5f67955ae6862f749ea79cd7 inherit pub_methods_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top"><a id="a464d923e5f67955ae6862f749ea79cd7"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a464d923e5f67955ae6862f749ea79cd7">auth</a> (user_manager_ptr userManager)</td></tr>
<tr class="memdesc:a464d923e5f67955ae6862f749ea79cd7 inherit pub_methods_classpion_1_1http_1_1auth"><td class="mdescLeft"> </td><td class="mdescRight">default constructor <br /></td></tr>
<tr class="separator:a464d923e5f67955ae6862f749ea79cd7 inherit pub_methods_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e58182470ebd406f5754064a890786c inherit pub_methods_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top"><a id="a8e58182470ebd406f5754064a890786c"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a8e58182470ebd406f5754064a890786c">~auth</a> ()</td></tr>
<tr class="memdesc:a8e58182470ebd406f5754064a890786c inherit pub_methods_classpion_1_1http_1_1auth"><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <br /></td></tr>
<tr class="separator:a8e58182470ebd406f5754064a890786c inherit pub_methods_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f3dee0db0f53e8c78a24970fcd920ea inherit pub_methods_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a4f3dee0db0f53e8c78a24970fcd920ea">add_restrict</a> (const std::string &resource)</td></tr>
<tr class="separator:a4f3dee0db0f53e8c78a24970fcd920ea inherit pub_methods_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a915cab76915bb3140007d4a432f881ce inherit pub_methods_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a915cab76915bb3140007d4a432f881ce">add_permit</a> (const std::string &resource)</td></tr>
<tr class="separator:a915cab76915bb3140007d4a432f881ce inherit pub_methods_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d2af1bf25e6e3342cafe8b1f2cf9df9 inherit pub_methods_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a5d2af1bf25e6e3342cafe8b1f2cf9df9">add_user</a> (std::string const &username, std::string const &password)</td></tr>
<tr class="separator:a5d2af1bf25e6e3342cafe8b1f2cf9df9 inherit pub_methods_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a850f65087e873e31de22b0a0fef79232 inherit pub_methods_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a850f65087e873e31de22b0a0fef79232">update_user</a> (std::string const &username, std::string const &password)</td></tr>
<tr class="separator:a850f65087e873e31de22b0a0fef79232 inherit pub_methods_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5bb4dce624e8cfe416951bbed3ddce43 inherit pub_methods_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a5bb4dce624e8cfe416951bbed3ddce43">remove_user</a> (std::string const &username)</td></tr>
<tr class="separator:a5bb4dce624e8cfe416951bbed3ddce43 inherit pub_methods_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa066cc49589f0629b5b6e2a0e7050516 inherit pub_methods_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top">virtual user_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#aa066cc49589f0629b5b6e2a0e7050516">get_user</a> (std::string const &username)</td></tr>
<tr class="separator:aa066cc49589f0629b5b6e2a0e7050516 inherit pub_methods_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ac8e9633bc2e16b21a564845ede483027"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1basic__auth.html#ac8e9633bc2e16b21a564845ede483027">handle_unauthorized</a> (const http::request_ptr &http_request_ptr, const tcp::connection_ptr &tcp_conn)</td></tr>
<tr class="separator:ac8e9633bc2e16b21a564845ede483027"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classpion_1_1http_1_1auth"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classpion_1_1http_1_1auth')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classpion_1_1http_1_1auth.html">pion::http::auth</a></td></tr>
<tr class="memitem:a4f3b8a875de1e36368caf01b525b592e inherit pro_methods_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a4f3b8a875de1e36368caf01b525b592e">need_authentication</a> (http::request_ptr const &http_request_ptr) const</td></tr>
<tr class="separator:a4f3b8a875de1e36368caf01b525b592e inherit pro_methods_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad3e5602c3e12026d5c2a3c418e03c505 inherit pro_methods_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#ad3e5602c3e12026d5c2a3c418e03c505">find_resource</a> (const <a class="el" href="classpion_1_1http_1_1auth.html#afba7081a3795e3010f0051e4e85a38e3">resource_set_type</a> &resource_set, const std::string &resource) const</td></tr>
<tr class="separator:ad3e5602c3e12026d5c2a3c418e03c505 inherit pro_methods_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af25a5d74ab812554d6c04379c856d019 inherit pro_methods_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top"><a id="af25a5d74ab812554d6c04379c856d019"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#af25a5d74ab812554d6c04379c856d019">set_logger</a> (<a class="el" href="structpion_1_1logger.html">logger</a> log_ptr)</td></tr>
<tr class="memdesc:af25a5d74ab812554d6c04379c856d019 inherit pro_methods_classpion_1_1http_1_1auth"><td class="mdescLeft"> </td><td class="mdescRight">sets the logger to be used <br /></td></tr>
<tr class="separator:af25a5d74ab812554d6c04379c856d019 inherit pro_methods_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:ae93865f8cdee463b021a8746aa802026"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1basic__auth.html#ae93865f8cdee463b021a8746aa802026">parse_authorization</a> (std::string const &authorization, std::string &credentials)</td></tr>
<tr class="separator:ae93865f8cdee463b021a8746aa802026"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54f121e4a3385e44d9503bc3cb9f3385"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1basic__auth.html#a54f121e4a3385e44d9503bc3cb9f3385">parse_credentials</a> (std::string const &credentials, std::string &username, std::string &password)</td></tr>
<tr class="separator:a54f121e4a3385e44d9503bc3cb9f3385"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_types_classpion_1_1http_1_1auth"><td colspan="2" onclick="javascript:toggleInherit('pro_types_classpion_1_1http_1_1auth')"><img src="closed.png" alt="-"/> Protected Types inherited from <a class="el" href="classpion_1_1http_1_1auth.html">pion::http::auth</a></td></tr>
<tr class="memitem:afba7081a3795e3010f0051e4e85a38e3 inherit pro_types_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top"><a id="afba7081a3795e3010f0051e4e85a38e3"></a>
typedef std::set< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#afba7081a3795e3010f0051e4e85a38e3">resource_set_type</a></td></tr>
<tr class="memdesc:afba7081a3795e3010f0051e4e85a38e3 inherit pro_types_classpion_1_1http_1_1auth"><td class="mdescLeft"> </td><td class="mdescRight">data type for a set of resources to be authenticated <br /></td></tr>
<tr class="separator:afba7081a3795e3010f0051e4e85a38e3 inherit pro_types_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57a2002495d45ac3ea508ee4186356b5 inherit pro_types_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top"><a id="a57a2002495d45ac3ea508ee4186356b5"></a>
typedef std::map< std::string, std::pair< boost::posix_time::ptime, user_ptr > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a57a2002495d45ac3ea508ee4186356b5">user_cache_type</a></td></tr>
<tr class="memdesc:a57a2002495d45ac3ea508ee4186356b5 inherit pro_types_classpion_1_1http_1_1auth"><td class="mdescLeft"> </td><td class="mdescRight">data type used to map authentication credentials to user objects <br /></td></tr>
<tr class="separator:a57a2002495d45ac3ea508ee4186356b5 inherit pro_types_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classpion_1_1http_1_1auth"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classpion_1_1http_1_1auth')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classpion_1_1http_1_1auth.html">pion::http::auth</a></td></tr>
<tr class="memitem:a936282ab441711ea3c5e52eab6ac9948 inherit pro_attribs_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top"><a id="a936282ab441711ea3c5e52eab6ac9948"></a>
<a class="el" href="structpion_1_1logger.html">logger</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a936282ab441711ea3c5e52eab6ac9948">m_logger</a></td></tr>
<tr class="memdesc:a936282ab441711ea3c5e52eab6ac9948 inherit pro_attribs_classpion_1_1http_1_1auth"><td class="mdescLeft"> </td><td class="mdescRight">primary logging interface used by this class <br /></td></tr>
<tr class="separator:a936282ab441711ea3c5e52eab6ac9948 inherit pro_attribs_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f85a718dc74306a6f62c931d2b4bc53 inherit pro_attribs_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top"><a id="a5f85a718dc74306a6f62c931d2b4bc53"></a>
user_manager_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a5f85a718dc74306a6f62c931d2b4bc53">m_user_manager</a></td></tr>
<tr class="memdesc:a5f85a718dc74306a6f62c931d2b4bc53 inherit pro_attribs_classpion_1_1http_1_1auth"><td class="mdescLeft"> </td><td class="mdescRight">container used to manager user objects <br /></td></tr>
<tr class="separator:a5f85a718dc74306a6f62c931d2b4bc53 inherit pro_attribs_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39970188567b9719e779dfe9ec0c901b inherit pro_attribs_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top"><a id="a39970188567b9719e779dfe9ec0c901b"></a>
<a class="el" href="classpion_1_1http_1_1auth.html#afba7081a3795e3010f0051e4e85a38e3">resource_set_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a39970188567b9719e779dfe9ec0c901b">m_restrict_list</a></td></tr>
<tr class="memdesc:a39970188567b9719e779dfe9ec0c901b inherit pro_attribs_classpion_1_1http_1_1auth"><td class="mdescLeft"> </td><td class="mdescRight">collection of resources that require authentication <br /></td></tr>
<tr class="separator:a39970188567b9719e779dfe9ec0c901b inherit pro_attribs_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c65c43c168549ae65ce443c10a9021a inherit pro_attribs_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top"><a id="a7c65c43c168549ae65ce443c10a9021a"></a>
<a class="el" href="classpion_1_1http_1_1auth.html#afba7081a3795e3010f0051e4e85a38e3">resource_set_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a7c65c43c168549ae65ce443c10a9021a">m_white_list</a></td></tr>
<tr class="memdesc:a7c65c43c168549ae65ce443c10a9021a inherit pro_attribs_classpion_1_1http_1_1auth"><td class="mdescLeft"> </td><td class="mdescRight">collection of resources that do NOT require authentication <br /></td></tr>
<tr class="separator:a7c65c43c168549ae65ce443c10a9021a inherit pro_attribs_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c1e57d2531c833a747ebbf9f3efe213 inherit pro_attribs_classpion_1_1http_1_1auth"><td class="memItemLeft" align="right" valign="top"><a id="a5c1e57d2531c833a747ebbf9f3efe213"></a>
boost::mutex </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1auth.html#a5c1e57d2531c833a747ebbf9f3efe213">m_resource_mutex</a></td></tr>
<tr class="memdesc:a5c1e57d2531c833a747ebbf9f3efe213 inherit pro_attribs_classpion_1_1http_1_1auth"><td class="mdescLeft"> </td><td class="mdescRight">mutex used to protect access to the resources <br /></td></tr>
<tr class="separator:a5c1e57d2531c833a747ebbf9f3efe213 inherit pro_attribs_classpion_1_1http_1_1auth"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classpion_1_1http_1_1basic__auth.html">basic_auth</a>: a base class for handling HTTP Authentication and session management in accordance with RFC 2617 <a href="http://tools.ietf.org/html/rfc2617">http://tools.ietf.org/html/rfc2617</a> </p>
<p>Definition at line <a class="el" href="basic__auth_8hpp_source.html#l00026">26</a> of file <a class="el" href="basic__auth_8hpp_source.html">basic_auth.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a032fb3d76e1e4f4e484a97bae7f5b367"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a032fb3d76e1e4f4e484a97bae7f5b367">§ </a></span>handle_request()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool pion::http::basic_auth::handle_request </td>
<td>(</td>
<td class="paramtype">const http::request_ptr & </td>
<td class="paramname"><em>http_request_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const tcp::connection_ptr & </td>
<td class="paramname"><em>tcp_conn</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>attempts to validate authentication of a new HTTP request. If request valid, pointer to user identity object (if any) will be preserved in the request and return "true". If request not authenticated, appropriate response is sent over tcp_conn and return "false";</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">http_request_ptr</td><td>the new HTTP request to handle </td></tr>
<tr><td class="paramname">tcp_conn</td><td>the TCP connection that has the new request</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if request valid and user identity inserted into request </dd></dl>
<p>Implements <a class="el" href="classpion_1_1http_1_1auth.html#ad59da7a2c24929b7dd4d41c5679bb8bf">pion::http::auth</a>.</p>
<p>Definition at line <a class="el" href="http__basic__auth_8cpp_source.html#l00035">35</a> of file <a class="el" href="http__basic__auth_8cpp_source.html">http_basic_auth.cpp</a>.</p>
<p>References <a class="el" href="http__basic__auth_8cpp_source.html#l00133">handle_unauthorized()</a>, <a class="el" href="auth_8hpp_source.html#l00156">pion::http::auth::m_user_manager</a>, <a class="el" href="http__auth_8cpp_source.html#l00037">pion::http::auth::need_authentication()</a>, <a class="el" href="http__basic__auth_8cpp_source.html#l00104">parse_authorization()</a>, and <a class="el" href="http__basic__auth_8cpp_source.html#l00114">parse_credentials()</a>.</p>
</div>
</div>
<a id="ac8e9633bc2e16b21a564845ede483027"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8e9633bc2e16b21a564845ede483027">§ </a></span>handle_unauthorized()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void pion::http::basic_auth::handle_unauthorized </td>
<td>(</td>
<td class="paramtype">const http::request_ptr & </td>
<td class="paramname"><em>http_request_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const tcp::connection_ptr & </td>
<td class="paramname"><em>tcp_conn</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>used to send responses when access to resource is not authorized</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">http_request_ptr</td><td>the new HTTP request to handle </td></tr>
<tr><td class="paramname">tcp_conn</td><td>the TCP connection that has the new request </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="http__basic__auth_8cpp_source.html#l00133">133</a> of file <a class="el" href="http__basic__auth_8cpp_source.html">http_basic_auth.cpp</a>.</p>
<p>References <a class="el" href="response__writer_8hpp_source.html#l00050">pion::http::response_writer::create()</a>, and <a class="el" href="connection_8hpp_source.html#l00596">pion::tcp::connection::finish()</a>.</p>
<p>Referenced by <a class="el" href="http__basic__auth_8cpp_source.html#l00035">handle_request()</a>.</p>
</div>
</div>
<a id="ae93865f8cdee463b021a8746aa802026"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae93865f8cdee463b021a8746aa802026">§ </a></span>parse_authorization()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool pion::http::basic_auth::parse_authorization </td>
<td>(</td>
<td class="paramtype">std::string const & </td>
<td class="paramname"><em>authorization</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>credentials</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>extracts base64 user credentials from authorization string</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">authorization</td><td>value of the HEADER_AUTHORIZATION </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="http__basic__auth_8cpp_source.html#l00104">104</a> of file <a class="el" href="http__basic__auth_8cpp_source.html">http_basic_auth.cpp</a>.</p>
<p>Referenced by <a class="el" href="http__basic__auth_8cpp_source.html#l00035">handle_request()</a>.</p>
</div>
</div>
<a id="a54f121e4a3385e44d9503bc3cb9f3385"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54f121e4a3385e44d9503bc3cb9f3385">§ </a></span>parse_credentials()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool pion::http::basic_auth::parse_credentials </td>
<td>(</td>
<td class="paramtype">std::string const & </td>
<td class="paramname"><em>credentials</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>username</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>password</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>parse base64 credentials and extract username/password </p>
<p>Definition at line <a class="el" href="http__basic__auth_8cpp_source.html#l00114">114</a> of file <a class="el" href="http__basic__auth_8cpp_source.html">http_basic_auth.cpp</a>.</p>
<p>References <a class="el" href="algorithm_8cpp_source.html#l00024">pion::algorithm::base64_decode()</a>.</p>
<p>Referenced by <a class="el" href="http__basic__auth_8cpp_source.html#l00035">handle_request()</a>.</p>
</div>
</div>
<a id="a9da335bd02b00b82cff40cb333fe7ee7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9da335bd02b00b82cff40cb333fe7ee7">§ </a></span>set_option()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void pion::http::basic_auth::set_option </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>sets a configuration option Valid options:</p><ul>
<li>"domain" - name of authentication domain</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the name of the option to change </td></tr>
<tr><td class="paramname">value</td><td>the value of the option </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classpion_1_1http_1_1auth.html#a575b866b9bc1e668ab6535cbc117c580">pion::http::auth</a>.</p>
<p>Definition at line <a class="el" href="http__basic__auth_8cpp_source.html#l00096">96</a> of file <a class="el" href="http__basic__auth_8cpp_source.html">http_basic_auth.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/pion/http/<a class="el" href="basic__auth_8hpp_source.html">basic_auth.hpp</a></li>
<li>src/<a class="el" href="http__basic__auth_8cpp_source.html">http_basic_auth.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
|