170 lines
13 KiB
HTML
170 lines
13 KiB
HTML
<!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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>PIP: PIEthUtilBase 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="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>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(initResizable);
|
|
/* @license-end */</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">PIP
|
|
 <span id="projectnumber">1.8.0</span>
|
|
</div>
|
|
<div id="projectbrief">Platform-Independent Primitives</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<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('',false,false,'search.php','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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('class_p_i_eth_util_base.html','');});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="class_p_i_eth_util_base-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PIEthUtilBase Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Base class for ethernet utils.
|
|
<a href="class_p_i_eth_util_base.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for PIEthUtilBase:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_p_i_eth_util_base__inherit__graph.png" border="0" usemap="#_p_i_eth_util_base_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="_p_i_eth_util_base_inherit__map" id="_p_i_eth_util_base_inherit__map">
|
|
<area shape="rect" id="node2" href="class_p_i_broadcast.html" title="Broadcast for all interfaces, including loopback. " alt="" coords="5,80,116,107"/>
|
|
<area shape="rect" id="node3" href="class_p_i_stream_packer.html" title="Simple packet wrap aroud any PIIODevice. " alt="" coords="140,80,275,107"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<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:a935d02f1ad790d9c7c56c295faf933fc"><td class="memItemLeft" align="right" valign="top"><a id="a935d02f1ad790d9c7c56c295faf933fc"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_eth_util_base.html#a935d02f1ad790d9c7c56c295faf933fc">setCryptEnabled</a> (bool on)</td></tr>
|
|
<tr class="memdesc:a935d02f1ad790d9c7c56c295faf933fc"><td class="mdescLeft"> </td><td class="mdescRight">Set crypt layer enabled. <br /></td></tr>
|
|
<tr class="separator:a935d02f1ad790d9c7c56c295faf933fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a236d43aab3c789aa8e13dbc9891d3f04"><td class="memItemLeft" align="right" valign="top"><a id="a236d43aab3c789aa8e13dbc9891d3f04"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_eth_util_base.html#a236d43aab3c789aa8e13dbc9891d3f04">cryptEnable</a> ()</td></tr>
|
|
<tr class="memdesc:a236d43aab3c789aa8e13dbc9891d3f04"><td class="mdescLeft"> </td><td class="mdescRight">Enable crypt layer. <br /></td></tr>
|
|
<tr class="separator:a236d43aab3c789aa8e13dbc9891d3f04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add574b4867213e919735dc17aaf6a660"><td class="memItemLeft" align="right" valign="top"><a id="add574b4867213e919735dc17aaf6a660"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_eth_util_base.html#add574b4867213e919735dc17aaf6a660">cryptDisable</a> ()</td></tr>
|
|
<tr class="memdesc:add574b4867213e919735dc17aaf6a660"><td class="mdescLeft"> </td><td class="mdescRight">Disable crypt layer. <br /></td></tr>
|
|
<tr class="separator:add574b4867213e919735dc17aaf6a660"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad05e492bb73b2761000ed35ae8e4e84a"><td class="memItemLeft" align="right" valign="top"><a id="ad05e492bb73b2761000ed35ae8e4e84a"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_eth_util_base.html#ad05e492bb73b2761000ed35ae8e4e84a">isCryptEnabled</a> () const</td></tr>
|
|
<tr class="memdesc:ad05e492bb73b2761000ed35ae8e4e84a"><td class="mdescLeft"> </td><td class="mdescRight">Returns if crypt layer enabled. <br /></td></tr>
|
|
<tr class="separator:ad05e492bb73b2761000ed35ae8e4e84a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1798e06d39958edc702bd1305bdb891b"><td class="memItemLeft" align="right" valign="top"><a id="a1798e06d39958edc702bd1305bdb891b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_eth_util_base.html#a1798e06d39958edc702bd1305bdb891b">setCryptKey</a> (const <a class="el" href="class_p_i_byte_array.html">PIByteArray</a> &k)</td></tr>
|
|
<tr class="memdesc:a1798e06d39958edc702bd1305bdb891b"><td class="mdescLeft"> </td><td class="mdescRight">Set crypt layer key to "k". <br /></td></tr>
|
|
<tr class="separator:a1798e06d39958edc702bd1305bdb891b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af767aecb3d1ec67811df1fa4bf98ed5d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_eth_util_base.html#af767aecb3d1ec67811df1fa4bf98ed5d">createCryptKey</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &k)</td></tr>
|
|
<tr class="separator:af767aecb3d1ec67811df1fa4bf98ed5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb42451017033d01487de9e34d9bc1bd"><td class="memItemLeft" align="right" valign="top"><a id="afb42451017033d01487de9e34d9bc1bd"></a>
|
|
<a class="el" href="class_p_i_byte_array.html">PIByteArray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_eth_util_base.html#afb42451017033d01487de9e34d9bc1bd">cryptKey</a> () const</td></tr>
|
|
<tr class="memdesc:afb42451017033d01487de9e34d9bc1bd"><td class="mdescLeft"> </td><td class="mdescRight">Returns crypt layer key. <br /></td></tr>
|
|
<tr class="separator:afb42451017033d01487de9e34d9bc1bd"><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:aece8c6e8f3947771371f647f29041c40"><td class="memItemLeft" align="right" valign="top"><a id="aece8c6e8f3947771371f647f29041c40"></a>
|
|
<a class="el" href="class_p_i_byte_array.html">PIByteArray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_eth_util_base.html#aece8c6e8f3947771371f647f29041c40">cryptData</a> (const <a class="el" href="class_p_i_byte_array.html">PIByteArray</a> &data)</td></tr>
|
|
<tr class="memdesc:aece8c6e8f3947771371f647f29041c40"><td class="mdescLeft"> </td><td class="mdescRight">Returns encrypted data if layer enabled, otherwise returns unchanged "data". <br /></td></tr>
|
|
<tr class="separator:aece8c6e8f3947771371f647f29041c40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20185c767428c8d1c1d84d687c770164"><td class="memItemLeft" align="right" valign="top"><a id="a20185c767428c8d1c1d84d687c770164"></a>
|
|
<a class="el" href="class_p_i_byte_array.html">PIByteArray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_eth_util_base.html#a20185c767428c8d1c1d84d687c770164">decryptData</a> (const <a class="el" href="class_p_i_byte_array.html">PIByteArray</a> &data)</td></tr>
|
|
<tr class="memdesc:a20185c767428c8d1c1d84d687c770164"><td class="mdescLeft"> </td><td class="mdescRight">Returns decrypted data if layer enabled, otherwise returns unchanged "data". If decryption was unsuccessfull returns empty PIByteArray. <br /></td></tr>
|
|
<tr class="separator:a20185c767428c8d1c1d84d687c770164"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Base class for ethernet utils. </p>
|
|
<h1><a class="anchor" id="PIEthUtilBase_synopsis"></a>
|
|
Synopsis</h1>
|
|
<p>PIEthUtilBase provides crypt layer for derived classes: <em><a class="el" href="class_p_i_stream_packer.html" title="Simple packet wrap aroud any PIIODevice. ">PIStreamPacker</a></em> and <em><a class="el" href="class_p_i_broadcast.html" title="Broadcast for all interfaces, including loopback. ">PIBroadcast</a></em>. All input and output (sended and received) data can be decrypted/encrypted by this layer.</p>
|
|
<p>By default crypt layer is disabled.</p>
|
|
<p>You can separetely enable it and set ready-to-use key by <em><a class="el" href="class_p_i_eth_util_base.html#a935d02f1ad790d9c7c56c295faf933fc" title="Set crypt layer enabled. ">setCryptEnabled()</a></em> and <em><a class="el" href="class_p_i_eth_util_base.html#a1798e06d39958edc702bd1305bdb891b" title="Set crypt layer key to "k". ">setCryptKey()</a></em>. Or you can use <em><a class="el" href="class_p_i_eth_util_base.html#af767aecb3d1ec67811df1fa4bf98ed5d">createCryptKey()</a></em> to generate key from your passphrase and automatic enable crypt layer.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>To use crypt layer, PIP should be built with crypt module, otherwise your in/out data will be lost.</dd></dl>
|
|
<p>You can use this class as base for your own classes. Use <em><a class="el" href="class_p_i_eth_util_base.html#aece8c6e8f3947771371f647f29041c40" title="Returns encrypted data if layer enabled, otherwise returns unchanged "data". ">cryptData()</a></em> and <em><a class="el" href="class_p_i_eth_util_base.html#a20185c767428c8d1c1d84d687c770164" title="Returns decrypted data if layer enabled, otherwise returns unchanged "data". If decryption was unsucc...">decryptData()</a></em> when send and receive your data. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="af767aecb3d1ec67811df1fa4bf98ed5d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af767aecb3d1ec67811df1fa4bf98ed5d">◆ </a></span>createCryptKey()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PIEthUtilBase::createCryptKey </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_p_i_string.html">PIString</a> & </td>
|
|
<td class="paramname"><em>k</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Generate crypt layer key by <em>PICrypt::hash</em> and set crypt layer enabled </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="class_p_i_eth_util_base.html">PIEthUtilBase</a></li>
|
|
<li class="footer">Generated on Fri Sep 28 2018 21:06:37 for PIP by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|