ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-11-23 13:40:55 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/_nim_b_l_e_security_8h_source.html
h2zero 6ae5666f7a v1.3.2
2022-01-15 15:23:57 -07:00

206 lines
26 KiB
HTML
Raw Blame History

<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp-nimble-cpp: K:/Users/Ryan/Desktop/thermo-git/components/esp-nimble-cpp/src/NimBLESecurity.h Source File</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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp
&#160;<span id="projectnumber">1.3.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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('_nim_b_l_e_security_8h_source.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="headertitle">
<div class="title">NimBLESecurity.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * NimBLESecurity.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created: on Feb 22 2020</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author H2zero</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Originally:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * BLESecurity.h</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Created on: Dec 17, 2017</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Author: chegewara</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef COMPONENTS_NIMBLESECURITY_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define COMPONENTS_NIMBLESECURITY_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#if defined(CONFIG_NIMBLE_CPP_IDF)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;host/ble_gap.h&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;nimble/nimble/host/include/host/ble_gap.h&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">/**** FIX COMPILATION ****/</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#undef min</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#undef max</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">/**************************/</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_NO_BOND 0x00 </span><span class="comment">/* relate to BTM_LE_AUTH_NO_BOND in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_BOND 0x01 </span><span class="comment">/* relate to BTM_LE_AUTH_BOND in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_MITM (1 &lt;&lt; 2) </span><span class="comment">/* relate to BTM_LE_AUTH_REQ_MITM in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_BOND_MITM (ESP_LE_AUTH_BOND | ESP_LE_AUTH_REQ_MITM)</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_SC_ONLY (1 &lt;&lt; 3) </span><span class="comment">/* relate to BTM_LE_AUTH_REQ_SC_ONLY in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_SC_BOND (ESP_LE_AUTH_BOND | ESP_LE_AUTH_REQ_SC_ONLY) </span><span class="comment">/* relate to BTM_LE_AUTH_REQ_SC_BOND in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_SC_MITM (ESP_LE_AUTH_REQ_MITM | ESP_LE_AUTH_REQ_SC_ONLY) </span><span class="comment">/* relate to BTM_LE_AUTH_REQ_SC_MITM in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#define ESP_LE_AUTH_REQ_SC_MITM_BOND (ESP_LE_AUTH_REQ_MITM | ESP_LE_AUTH_REQ_SC_ONLY | ESP_LE_AUTH_BOND) </span><span class="comment">/* relate to BTM_LE_AUTH_REQ_SC_MITM_BOND in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#define ESP_IO_CAP_OUT 0 </span><span class="comment">/* relate to BTM_IO_CAP_OUT in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#define ESP_IO_CAP_IO 1 </span><span class="comment">/* relate to BTM_IO_CAP_IO in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#define ESP_IO_CAP_IN 2 </span><span class="comment">/* relate to BTM_IO_CAP_IN in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#define ESP_IO_CAP_NONE 3 </span><span class="comment">/* relate to BTM_IO_CAP_NONE in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#define ESP_IO_CAP_KBDISP 4 </span><span class="comment">/* relate to BTM_IO_CAP_KBDISP in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#define ESP_BLE_ENC_KEY_MASK (1 &lt;&lt; 0) </span><span class="comment">/* relate to BTM_BLE_ENC_KEY_MASK in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#define ESP_BLE_ID_KEY_MASK (1 &lt;&lt; 1) </span><span class="comment">/* relate to BTM_BLE_ID_KEY_MASK in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="preprocessor">#define ESP_BLE_CSR_KEY_MASK (1 &lt;&lt; 2) </span><span class="comment">/* relate to BTM_BLE_CSR_KEY_MASK in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#define ESP_BLE_LINK_KEY_MASK (1 &lt;&lt; 3) </span><span class="comment">/* relate to BTM_BLE_LINK_KEY_MASK in stack/btm_api.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="keyword">typedef</span> uint8_t esp_ble_auth_req_t; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword">typedef</span> uint8_t esp_ble_io_cap_t; </div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security.html"> 67</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_security.html">NimBLESecurity</a> {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="class_nim_b_l_e_security.html">NimBLESecurity</a>();</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="class_nim_b_l_e_security.html">NimBLESecurity</a>();</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#a5cf0d3672a16f557032bcbf39a9e22f2">setAuthenticationMode</a>(esp_ble_auth_req_t auth_req);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#a1bb7902d5ceffaca86bd7638a74e35e3">setCapability</a>(esp_ble_io_cap_t iocap);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#adfc3caa3e1a5aedc3be5c0f1dc5c99ac">setInitEncryptionKey</a>(uint8_t init_key);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#aac8434faa02a6813b7efd87224e04714">setRespEncryptionKey</a>(uint8_t resp_key);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#ab2be50284a325ec8937abdab0baafd4b">setKeySize</a>(uint8_t key_size = 16);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security.html#a0bb1535e1b0d48566c17f681b7539f82">setStaticPIN</a>(uint32_t pin);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">//static char* esp_key_type_to_str(esp_ble_key_type_t key_type);</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="comment">private:</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="comment"> esp_ble_auth_req_t m_authReq;</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="comment"> esp_ble_io_cap_t m_iocap;</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment"> uint8_t m_initKey;</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment"> uint8_t m_respKey;</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"> uint8_t m_keySize;</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;}; <span class="comment">// BLESecurity</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html"> 94</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_nim_b_l_e_security_callbacks.html">NimBLESecurityCallbacks</a> {</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="class_nim_b_l_e_security_callbacks.html">NimBLESecurityCallbacks</a>() {};</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html#a1cfc9c48c02aece1736f9070dc6ff90f"> 103</a></span>&#160; <span class="keyword">virtual</span> uint32_t <a class="code" href="class_nim_b_l_e_security_callbacks.html#a1cfc9c48c02aece1736f9070dc6ff90f">onPassKeyRequest</a>() = 0;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; </div>
<div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html#aa984ec6f29741b49bdd7dbfde60177be"> 110</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security_callbacks.html#aa984ec6f29741b49bdd7dbfde60177be">onPassKeyNotify</a>(uint32_t pass_key) = 0;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html#a620de166c3fe26027871d18535839cdd"> 116</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_security_callbacks.html#a620de166c3fe26027871d18535839cdd">onSecurityRequest</a>() = 0 ;</div>
<div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html#a22a8079906070a13583daafd1521a125"> 120</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_security_callbacks.html#a22a8079906070a13583daafd1521a125">onAuthenticationComplete</a>(ble_gap_conn_desc*) = 0;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div>
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_security_callbacks.html#a2ce6a03693a43a55e51598d8b2654a92"> 127</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_security_callbacks.html#a2ce6a03693a43a55e51598d8b2654a92">onConfirmPIN</a>(uint32_t pin) = 0;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;}; <span class="comment">// BLESecurityCallbacks</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// COMPONENTS_NIMBLESECURITY_H_</span></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html">NimBLESecurityCallbacks</a></div><div class="ttdoc">Callbacks to handle GAP events related to authorization. Deprecated - provided for backward compatibi...</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.h:94</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html_a1cfc9c48c02aece1736f9070dc6ff90f"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html#a1cfc9c48c02aece1736f9070dc6ff90f">NimBLESecurityCallbacks::onPassKeyRequest</a></div><div class="ttdeci">virtual uint32_t onPassKeyRequest()=0</div><div class="ttdoc">Its request from peer device to input authentication pin code displayed on peer device....</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html_a22a8079906070a13583daafd1521a125"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html#a22a8079906070a13583daafd1521a125">NimBLESecurityCallbacks::onAuthenticationComplete</a></div><div class="ttdeci">virtual void onAuthenticationComplete(ble_gap_conn_desc *)=0</div><div class="ttdoc">Provides us information when authentication process is completed.</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html_a2ce6a03693a43a55e51598d8b2654a92"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html#a2ce6a03693a43a55e51598d8b2654a92">NimBLESecurityCallbacks::onConfirmPIN</a></div><div class="ttdeci">virtual bool onConfirmPIN(uint32_t pin)=0</div><div class="ttdoc">Called when using numeric comparison for authentication.</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html_a620de166c3fe26027871d18535839cdd"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html#a620de166c3fe26027871d18535839cdd">NimBLESecurityCallbacks::onSecurityRequest</a></div><div class="ttdeci">virtual bool onSecurityRequest()=0</div><div class="ttdoc">Here we can make decision if we want to let negotiate authorization with peer device or not.</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_callbacks_html_aa984ec6f29741b49bdd7dbfde60177be"><div class="ttname"><a href="class_nim_b_l_e_security_callbacks.html#aa984ec6f29741b49bdd7dbfde60177be">NimBLESecurityCallbacks::onPassKeyNotify</a></div><div class="ttdeci">virtual void onPassKeyNotify(uint32_t pass_key)=0</div><div class="ttdoc">Provide us 6-digits code to perform authentication. It requires that our device is capable to display...</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html"><div class="ttname"><a href="class_nim_b_l_e_security.html">NimBLESecurity</a></div><div class="ttdoc">A class to handle BLE security operations. Deprecated - provided for backward compatibility only.</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.h:67</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_a0bb1535e1b0d48566c17f681b7539f82"><div class="ttname"><a href="class_nim_b_l_e_security.html#a0bb1535e1b0d48566c17f681b7539f82">NimBLESecurity::setStaticPIN</a></div><div class="ttdeci">void setStaticPIN(uint32_t pin)</div><div class="ttdoc">Sets a static PIN used to authenticate/encrypt the connection.</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:105</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_a1bb7902d5ceffaca86bd7638a74e35e3"><div class="ttname"><a href="class_nim_b_l_e_security.html#a1bb7902d5ceffaca86bd7638a74e35e3">NimBLESecurity::setCapability</a></div><div class="ttdeci">void setCapability(esp_ble_io_cap_t iocap)</div><div class="ttdoc">Set our device IO capability to let end user perform authorization either by displaying or entering g...</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:58</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_a5cf0d3672a16f557032bcbf39a9e22f2"><div class="ttname"><a href="class_nim_b_l_e_security.html#a5cf0d3672a16f557032bcbf39a9e22f2">NimBLESecurity::setAuthenticationMode</a></div><div class="ttdeci">void setAuthenticationMode(esp_ble_auth_req_t auth_req)</div><div class="ttdoc">Set requested authentication mode.</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:40</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_aac8434faa02a6813b7efd87224e04714"><div class="ttname"><a href="class_nim_b_l_e_security.html#aac8434faa02a6813b7efd87224e04714">NimBLESecurity::setRespEncryptionKey</a></div><div class="ttdeci">void setRespEncryptionKey(uint8_t resp_key)</div><div class="ttdoc">Sets the keys we will accept during encryption.</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:86</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_ab2be50284a325ec8937abdab0baafd4b"><div class="ttname"><a href="class_nim_b_l_e_security.html#ab2be50284a325ec8937abdab0baafd4b">NimBLESecurity::setKeySize</a></div><div class="ttdeci">void setKeySize(uint8_t key_size=16)</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:94</div></div>
<div class="ttc" id="aclass_nim_b_l_e_security_html_adfc3caa3e1a5aedc3be5c0f1dc5c99ac"><div class="ttname"><a href="class_nim_b_l_e_security.html#adfc3caa3e1a5aedc3be5c0f1dc5c99ac">NimBLESecurity::setInitEncryptionKey</a></div><div class="ttdeci">void setInitEncryptionKey(uint8_t init_key)</div><div class="ttdoc">Sets the keys we will distibute during encryption.</div><div class="ttdef"><b>Definition:</b> NimBLESecurity.cpp:72</div></div>
<div class="ttc" id="animconfig_8h_html"><div class="ttname"><a href="nimconfig_8h.html">nimconfig.h</a></div></div>
</div><!-- fragment --></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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>NimBLESecurity.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink