ESP3D/docs/html/authentication__service_8h.html
2020-01-06 14:46:56 +01:00

275 lines
17 KiB
HTML

<!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>ESP3D: esp3d/src/modules/authentication/authentication_service.h File 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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="projectlogo"><img alt="Logo" src="ESP3D_social_mini.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ESP3D
&#160;<span id="projectnumber">3.0</span>
</div>
<div id="projectbrief">Firmware for ESP boards connected to 3D Printer</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&amp;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&amp;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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('authentication__service_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">authentication_service.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="esp3d__config_8h_source.html">../../include/esp3d_config.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for authentication_service.h:</div>
<div class="dyncontent">
<div class="center"><img src="authentication__service_8h__incl.png" border="0" usemap="#esp3d_2src_2modules_2authentication_2authentication__service_8h" alt=""/></div>
<map name="esp3d_2src_2modules_2authentication_2authentication__service_8h" id="esp3d_2src_2modules_2authentication_2authentication__service_8h">
<area shape="rect" title=" " alt="" coords="446,5,664,47"/>
<area shape="rect" href="esp3d__config_8h.html" title=" " alt="" coords="492,95,618,136"/>
<area shape="rect" title=" " alt="" coords="308,259,386,285"/>
<area shape="rect" href="defines_8h.html" title=" " alt="" coords="23,184,154,211"/>
<area shape="rect" href="pins_8h.html" title=" " alt="" coords="178,184,292,211"/>
<area shape="rect" href="configuration_8h.html" title=" " alt="" coords="316,184,447,211"/>
<area shape="rect" href="sanity__esp3d_8h.html" title=" " alt="" coords="472,184,638,211"/>
<area shape="rect" href="hal_8h.html" title=" " alt="" coords="663,184,754,211"/>
<area shape="rect" href="debug__esp3d_8h.html" title=" " alt="" coords="778,184,929,211"/>
<area shape="rect" href="version_8h.html" title=" " alt="" coords="954,184,1084,211"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="authentication__service_8h__dep__incl.png" border="0" usemap="#esp3d_2src_2modules_2authentication_2authentication__service_8hdep" alt=""/></div>
<map name="esp3d_2src_2modules_2authentication_2authentication__service_8hdep" id="esp3d_2src_2modules_2authentication_2authentication__service_8hdep">
<area shape="rect" title=" " alt="" coords="5080,5,5297,47"/>
<area shape="rect" href="commands_8h.html" title=" " alt="" coords="4518,102,4705,129"/>
<area shape="rect" href="_e_s_p100_8cpp.html" title=" " alt="" coords="5,184,164,225"/>
<area shape="rect" href="_e_s_p101_8cpp.html" title=" " alt="" coords="188,184,347,225"/>
<area shape="rect" href="_e_s_p102_8cpp.html" title=" " alt="" coords="371,184,529,225"/>
<area shape="rect" href="_e_s_p103_8cpp.html" title=" " alt="" coords="553,184,712,225"/>
<area shape="rect" href="_e_s_p105_8cpp.html" title=" " alt="" coords="736,184,895,225"/>
<area shape="rect" href="_e_s_p106_8cpp.html" title=" " alt="" coords="919,184,1077,225"/>
<area shape="rect" href="_e_s_p107_8cpp.html" title=" " alt="" coords="1101,184,1260,225"/>
<area shape="rect" href="_e_s_p108_8cpp.html" title=" " alt="" coords="1284,184,1443,225"/>
<area shape="rect" href="_e_s_p110_8cpp.html" title=" " alt="" coords="1467,184,1625,225"/>
<area shape="rect" href="_e_s_p111_8cpp.html" title=" " alt="" coords="1649,184,1808,225"/>
<area shape="rect" href="_e_s_p112_8cpp.html" title=" " alt="" coords="1832,184,1991,225"/>
<area shape="rect" href="_e_s_p115_8cpp.html" title=" " alt="" coords="2015,184,2173,225"/>
<area shape="rect" href="_e_s_p120_8cpp.html" title=" " alt="" coords="2197,184,2356,225"/>
<area shape="rect" href="_e_s_p121_8cpp.html" title=" " alt="" coords="2380,184,2539,225"/>
<area shape="rect" href="_e_s_p130_8cpp.html" title=" " alt="" coords="2563,184,2721,225"/>
<area shape="rect" href="_e_s_p131_8cpp.html" title=" " alt="" coords="2745,184,2904,225"/>
<area shape="rect" href="_e_s_p150_8cpp.html" title=" " alt="" coords="2928,184,3087,225"/>
<area shape="rect" href="_e_s_p160_8cpp.html" title=" " alt="" coords="3111,184,3269,225"/>
<area shape="rect" href="_e_s_p161_8cpp.html" title=" " alt="" coords="3293,184,3452,225"/>
<area shape="rect" href="_e_s_p180_8cpp.html" title=" " alt="" coords="3476,184,3635,225"/>
<area shape="rect" href="_e_s_p181_8cpp.html" title=" " alt="" coords="3659,184,3817,225"/>
<area shape="rect" href="_e_s_p200_8cpp.html" title=" " alt="" coords="3841,184,4000,225"/>
<area shape="rect" href="_e_s_p201_8cpp.html" title=" " alt="" coords="4024,184,4183,225"/>
<area shape="rect" href="_e_s_p290_8cpp.html" title=" " alt="" coords="5039,184,5197,225"/>
<area shape="rect" href="_e_s_p400_8cpp.html" title=" " alt="" coords="5221,184,5380,225"/>
<area shape="rect" href="_e_s_p401_8cpp.html" title=" " alt="" coords="5404,184,5563,225"/>
<area shape="rect" href="_e_s_p410_8cpp.html" title=" " alt="" coords="5587,184,5745,225"/>
<area shape="rect" href="_e_s_p420_8cpp.html" title=" " alt="" coords="5769,184,5928,225"/>
<area shape="rect" href="_e_s_p444_8cpp.html" title=" " alt="" coords="5952,184,6111,225"/>
<area shape="rect" href="_e_s_p600_8cpp.html" title=" " alt="" coords="6135,184,6293,225"/>
<area shape="rect" href="_e_s_p610_8cpp.html" title=" " alt="" coords="6317,184,6476,225"/>
<area shape="rect" href="_e_s_p700_8cpp.html" title=" " alt="" coords="8945,184,9104,225"/>
<area shape="rect" href="_e_s_p710_8cpp.html" title=" " alt="" coords="6500,184,6659,225"/>
<area shape="rect" href="_e_s_p715_8cpp.html" title=" " alt="" coords="6683,184,6841,225"/>
<area shape="rect" href="_e_s_p720_8cpp.html" title=" " alt="" coords="6865,184,7024,225"/>
<area shape="rect" href="_e_s_p730_8cpp.html" title=" " alt="" coords="7048,184,7207,225"/>
<area shape="rect" href="_e_s_p740_8cpp.html" title=" " alt="" coords="7231,184,7389,225"/>
<area shape="rect" href="_e_s_p750_8cpp.html" title=" " alt="" coords="7413,184,7572,225"/>
<area shape="rect" href="_e_s_p780_8cpp.html" title=" " alt="" coords="7596,184,7755,225"/>
<area shape="rect" href="_e_s_p790_8cpp.html" title=" " alt="" coords="7779,184,7937,225"/>
<area shape="rect" href="_e_s_p800_8cpp.html" title=" " alt="" coords="7961,184,8120,225"/>
<area shape="rect" href="_e_s_p900_8cpp.html" title=" " alt="" coords="8144,184,8303,225"/>
<area shape="rect" href="handle-command_8cpp.html" title=" " alt="" coords="8327,184,8525,225"/>
<area shape="rect" href="handle-config_8cpp.html" title=" " alt="" coords="8550,184,8726,225"/>
<area shape="rect" href="gcode__host_8h.html" title=" " alt="" coords="5986,95,6157,136"/>
<area shape="rect" href="authentication__service_8cpp.html" title=" " alt="" coords="6232,95,6449,136"/>
<area shape="rect" href="_ftp_server_8cpp.html" title=" " alt="" coords="6473,95,6624,136"/>
<area shape="rect" href="handle-filenotfound_8cpp.html" title=" " alt="" coords="6648,95,6855,136"/>
<area shape="rect" href="handle-files_8cpp.html" title=" " alt="" coords="6879,95,7045,136"/>
<area shape="rect" href="handle-login_8cpp.html" title=" " alt="" coords="7069,95,7239,136"/>
<area shape="rect" href="handle-_s_d-files_8cpp.html" title=" " alt="" coords="7263,95,7450,136"/>
<area shape="rect" href="handle-updatefw_8cpp.html" title=" " alt="" coords="7475,95,7668,136"/>
<area shape="rect" href="upload-files_8cpp.html" title=" " alt="" coords="7693,95,7858,136"/>
<area shape="rect" href="upload-_s_d-files_8cpp.html" title=" " alt="" coords="7882,95,8069,136"/>
<area shape="rect" href="upload-updatefw_8cpp.html" title=" " alt="" coords="8093,95,8287,136"/>
<area shape="rect" href="http__server_8cpp.html" title=" " alt="" coords="8311,95,8469,136"/>
<area shape="rect" href="commands_8cpp.html" title=" " alt="" coords="4623,191,4824,218"/>
<area shape="rect" href="gcode__host_8cpp.html" title=" " alt="" coords="8750,184,8921,225"/>
<area shape="rect" href="serial__service_8cpp.html" title=" " alt="" coords="4848,184,5015,225"/>
<area shape="rect" href="telnet__server_8cpp.html" title=" " alt="" coords="4207,184,4375,225"/>
<area shape="rect" href="websocket__server_8cpp.html" title=" " alt="" coords="4400,184,4599,225"/>
<area shape="rect" href="esp3d_8cpp.html" title=" " alt="" coords="9128,191,9300,218"/>
</map>
</div>
</div>
<p><a href="authentication__service_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_authentication_service.html">AuthenticationService</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a3095411b68dbc51b5b535151b5bf0ae6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="authentication__service_8h.html#a3095411b68dbc51b5b535151b5bf0ae6">level_authenticate_type</a> { <a class="el" href="authentication__service_8h.html#a3095411b68dbc51b5b535151b5bf0ae6a162efbbc3db6c397f7d1b04b35720ff0">LEVEL_GUEST</a> = 0,
<a class="el" href="authentication__service_8h.html#a3095411b68dbc51b5b535151b5bf0ae6a06598e45d399ba6c77371ff2b42dd41c">LEVEL_USER</a> = 1,
<a class="el" href="authentication__service_8h.html#a3095411b68dbc51b5b535151b5bf0ae6a4ddf9e0f200403030b62492db571d9bb">LEVEL_ADMIN</a> = 2
}</td></tr>
<tr class="separator:a3095411b68dbc51b5b535151b5bf0ae6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a1236360c5600f8402ddbf916774dda2e"><td class="memItemLeft" align="right" valign="top">const char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="authentication__service_8h.html#a1236360c5600f8402ddbf916774dda2e">DEFAULT_ADMIN_LOGIN</a> [] = &quot;admin&quot;</td></tr>
<tr class="separator:a1236360c5600f8402ddbf916774dda2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20557149e20d47f2cb599157a60086ef"><td class="memItemLeft" align="right" valign="top">const char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="authentication__service_8h.html#a20557149e20d47f2cb599157a60086ef">DEFAULT_USER_LOGIN</a> [] = &quot;user&quot;</td></tr>
<tr class="separator:a20557149e20d47f2cb599157a60086ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a3095411b68dbc51b5b535151b5bf0ae6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3095411b68dbc51b5b535151b5bf0ae6">&#9670;&nbsp;</a></span>level_authenticate_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="authentication__service_8h.html#a3095411b68dbc51b5b535151b5bf0ae6">level_authenticate_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3095411b68dbc51b5b535151b5bf0ae6a162efbbc3db6c397f7d1b04b35720ff0"></a>LEVEL_GUEST&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a3095411b68dbc51b5b535151b5bf0ae6a06598e45d399ba6c77371ff2b42dd41c"></a>LEVEL_USER&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a3095411b68dbc51b5b535151b5bf0ae6a4ddf9e0f200403030b62492db571d9bb"></a>LEVEL_ADMIN&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="authentication__service_8h_source.html#l00025">25</a> of file <a class="el" href="authentication__service_8h_source.html">authentication_service.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a1236360c5600f8402ddbf916774dda2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1236360c5600f8402ddbf916774dda2e">&#9670;&nbsp;</a></span>DEFAULT_ADMIN_LOGIN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char DEFAULT_ADMIN_LOGIN[] = &quot;admin&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="authentication__service_8h_source.html#l00031">31</a> of file <a class="el" href="authentication__service_8h_source.html">authentication_service.h</a>.</p>
</div>
</div>
<a id="a20557149e20d47f2cb599157a60086ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20557149e20d47f2cb599157a60086ef">&#9670;&nbsp;</a></span>DEFAULT_USER_LOGIN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char DEFAULT_USER_LOGIN[] = &quot;user&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="authentication__service_8h_source.html#l00032">32</a> of file <a class="el" href="authentication__service_8h_source.html">authentication_service.h</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_26e324fd2d3b807b96644664d24a0768.html">esp3d</a></li><li class="navelem"><a class="el" href="dir_8d0579f238dc492a9f9393e76adf8153.html">src</a></li><li class="navelem"><a class="el" href="dir_2c1830491e0576ae3395f8c2f91c7d85.html">modules</a></li><li class="navelem"><a class="el" href="dir_c7f42237ed3c704f8fd50d3cd0ed10f3.html">authentication</a></li><li class="navelem"><a class="el" href="authentication__service_8h.html">authentication_service.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>