| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/><meta name="viewport" content="width=device-width, initial-scale=1"/><title>Prometheus Client Library for Modern C++: prometheus::BasicAuthHandler 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="search/search.css" rel="stylesheet" type="text/css"/><script type="text/javascript" src="search/searchdata.js"></script><script type="text/javascript" src="search/search.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">Prometheus Client Library for Modern C++   </div>  </td> </tr> </tbody></table></div><!-- end header part --><!-- Generated by Doxygen 1.8.17 --><script type="text/javascript">/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */var searchBox = new SearchBox("searchBox", "search",false,'Search');/* @license-end */</script><script type="text/javascript" src="menudata.js"></script><script type="text/javascript" src="menu.js"></script><script type="text/javascript">/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */$(function() {  initMenu('',true,false,'search.php','Search');  $(document).ready(function() { init_search(); });});/* @license-end */</script><div id="main-nav"></div><!-- window showing the filter options --><div id="MSearchSelectWindow"     onmouseover="return searchBox.OnSearchSelectShow()"     onmouseout="return searchBox.OnSearchSelectHide()"     onkeydown="return searchBox.OnSearchSelectKey(event)"></div><!-- iframe showing the search results (closed by default) --><div id="MSearchResultsWindow"><iframe src="javascript:void(0)" frameborder="0"         name="MSearchResults" id="MSearchResults"></iframe></div><div id="nav-path" class="navpath">  <ul><li class="navelem"><b>prometheus</b></li><li class="navelem"><a class="el" href="classprometheus_1_1BasicAuthHandler.html">BasicAuthHandler</a></li>  </ul></div></div><!-- top --><div class="header">  <div class="summary"><a href="#pub-types">Public Types</a> |<a href="#pub-methods">Public Member Functions</a> |<a href="classprometheus_1_1BasicAuthHandler-members.html">List of all members</a>  </div>  <div class="headertitle"><div class="title">prometheus::BasicAuthHandler Class Reference</div>  </div></div><!--header--><div class="contents"><div class="dynheader">Inheritance diagram for prometheus::BasicAuthHandler:</div><div class="dyncontent"><div class="center"><img src="classprometheus_1_1BasicAuthHandler__inherit__graph.png" border="0" usemap="#prometheus_1_1BasicAuthHandler_inherit__map" alt="Inheritance graph"/></div><map name="prometheus_1_1BasicAuthHandler_inherit__map" id="prometheus_1_1BasicAuthHandler_inherit__map"><area shape="rect" title=" " alt="" coords="5,80,229,107"/><area shape="rect" title=" " alt="" coords="49,5,186,32"/></map><center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div><div class="dynheader">Collaboration diagram for prometheus::BasicAuthHandler:</div><div class="dyncontent"><div class="center"><img src="classprometheus_1_1BasicAuthHandler__coll__graph.png" border="0" usemap="#prometheus_1_1BasicAuthHandler_coll__map" alt="Collaboration graph"/></div><map name="prometheus_1_1BasicAuthHandler_coll__map" id="prometheus_1_1BasicAuthHandler_coll__map"><area shape="rect" title=" " alt="" coords="5,80,229,107"/><area shape="rect" title=" " alt="" coords="49,5,186,32"/></map><center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>Public Types</h2></td></tr><tr class="memitem:a40d2e3d810c8893d4c6809f77850fbe7"><td class="memItemLeft" align="right" valign="top"><a id="a40d2e3d810c8893d4c6809f77850fbe7"></a>using </td><td class="memItemRight" valign="bottom"><b>AuthFunc</b> = std::function< bool(const std::string &, const std::string &)></td></tr><tr class="separator:a40d2e3d810c8893d4c6809f77850fbe7"><td class="memSeparator" colspan="2"> </td></tr></table><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:ad4d95f481bc694b6239a4f980e07538f"><td class="memItemLeft" align="right" valign="top"><a id="ad4d95f481bc694b6239a4f980e07538f"></a> </td><td class="memItemRight" valign="bottom"><b>BasicAuthHandler</b> (AuthFunc callback, std::string realm)</td></tr><tr class="separator:ad4d95f481bc694b6239a4f980e07538f"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a7b61bfd34a18f27a061ddaf9f8a0e025"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classprometheus_1_1BasicAuthHandler.html#a7b61bfd34a18f27a061ddaf9f8a0e025">authorize</a> (CivetServer *server, mg_connection *conn) override</td></tr><tr class="separator:a7b61bfd34a18f27a061ddaf9f8a0e025"><td class="memSeparator" colspan="2"> </td></tr></table><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2><div class="textblock"><p>Handler for HTTP Basic authentication for Endpoints. </p></div><h2 class="groupheader">Member Function Documentation</h2><a id="a7b61bfd34a18f27a061ddaf9f8a0e025"></a><h2 class="memtitle"><span class="permalink"><a href="#a7b61bfd34a18f27a061ddaf9f8a0e025">◆ </a></span>authorize()</h2><div class="memitem"><div class="memproto"><table class="mlabels">  <tr>  <td class="mlabels-left">      <table class="memname">        <tr>          <td class="memname">bool prometheus::BasicAuthHandler::authorize </td>          <td>(</td>          <td class="paramtype">CivetServer * </td>          <td class="paramname"><em>server</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype">mg_connection * </td>          <td class="paramname"><em>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">override</span></span>  </td>  </tr></table></div><div class="memdoc"><p>Implements civetweb authorization interface.</p><p>Attempts to extract a username and password from the Authorization header to pass to the owning AuthHandler, <code>this->handler</code>. If handler returns true, permits the request to proceed. If handler returns false, or the Auth header is absent, rejects the request with 401 Unauthorized. </p></div></div></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.17</small></address></body></html>
 |