WinStd/group___win_std_mem_sanitize.html

147 lines
9.9 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: Auto-sanitize Memory Management</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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
<td id="projectalign">
<div id="projectname">WinStd
</div>
<div id="projectbrief">Windows Win32 API using Standard C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle"><div class="title">Auto-sanitize Memory Management</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" 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="classwinstd_1_1sanitizing__allocator.html">winstd::sanitizing_allocator&lt; _Ty &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An allocator template that sanitizes each memory block before it is destroyed or reallocated. <a href="classwinstd_1_1sanitizing__allocator.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1sanitizing__blob.html">winstd::sanitizing_blob&lt; N &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sanitizing BLOB. <a href="classwinstd_1_1sanitizing__blob.html#details">More...</a><br /></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 id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gafaf527687e080349d49b51c2362c32e8" id="r_gafaf527687e080349d49b51c2362c32e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">typedef</a> std::basic_string&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">char</a>, std::char_traits&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">char</a> &gt;, <a class="el" href="classwinstd_1_1sanitizing__allocator.html">sanitizing_allocator</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">char</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gafaf527687e080349d49b51c2362c32e8">winstd::sanitizing_string</a></td></tr>
<tr class="memdesc:gafaf527687e080349d49b51c2362c32e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">A sanitizing variant of std::string. <br /></td></tr>
<tr class="separator:gafaf527687e080349d49b51c2362c32e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga57776f4affaac5040ba220302003eedc" id="r_ga57776f4affaac5040ba220302003eedc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">typedef</a> std::basic_string&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">wchar_t</a>, std::char_traits&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">wchar_t</a> &gt;, <a class="el" href="classwinstd_1_1sanitizing__allocator.html">sanitizing_allocator</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">wchar_t</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga57776f4affaac5040ba220302003eedc">winstd::sanitizing_wstring</a></td></tr>
<tr class="memdesc:ga57776f4affaac5040ba220302003eedc"><td class="mdescLeft">&#160;</td><td class="mdescRight">A sanitizing variant of std::wstring. <br /></td></tr>
<tr class="separator:ga57776f4affaac5040ba220302003eedc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa149b89d04cc80c125023a14e241e8bd" id="r_gaa149b89d04cc80c125023a14e241e8bd"><td class="memItemLeft" align="right" valign="top"><a id="gaa149b89d04cc80c125023a14e241e8bd" name="gaa149b89d04cc80c125023a14e241e8bd"></a>
<a class="el" href="classwinstd_1_1ref__unique__ptr.html">typedef</a> <a class="el" href="#gafaf527687e080349d49b51c2362c32e8">sanitizing_string</a>&#160;</td><td class="memItemRight" valign="bottom"><b>winstd::sanitizing_tstring</b></td></tr>
<tr class="memdesc:gaa149b89d04cc80c125023a14e241e8bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multi-byte / Wide-character sanitizing string (according to _UNICODE) <br /></td></tr>
<tr class="separator:gaa149b89d04cc80c125023a14e241e8bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gafaf527687e080349d49b51c2362c32e8" name="gafaf527687e080349d49b51c2362c32e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafaf527687e080349d49b51c2362c32e8">&#9670;&#160;</a></span>sanitizing_string</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">typedef</a> std::basic_string&lt;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">char</a>, std::char_traits&lt;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">char</a>&gt;, <a class="el" href="classwinstd_1_1sanitizing__allocator.html">sanitizing_allocator</a>&lt;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">char</a>&gt; &gt; <a class="el" href="#gafaf527687e080349d49b51c2362c32e8">winstd::sanitizing_string</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A sanitizing variant of std::string. </p>
<dl class="section note"><dt>Note</dt><dd><code>sanitizing_string</code> introduces a performance penalty. However, it provides an additional level of security. Use for security sensitive data memory storage only. </dd></dl>
</div>
</div>
<a id="ga57776f4affaac5040ba220302003eedc" name="ga57776f4affaac5040ba220302003eedc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga57776f4affaac5040ba220302003eedc">&#9670;&#160;</a></span>sanitizing_wstring</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">typedef</a> std::basic_string&lt;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">wchar_t</a>, std::char_traits&lt;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">wchar_t</a>&gt;, <a class="el" href="classwinstd_1_1sanitizing__allocator.html">sanitizing_allocator</a>&lt;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">wchar_t</a>&gt; &gt; <a class="el" href="#ga57776f4affaac5040ba220302003eedc">winstd::sanitizing_wstring</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A sanitizing variant of std::wstring. </p>
<dl class="section note"><dt>Note</dt><dd><code>sanitizing_wstring</code> introduces a performance penalty. However, it provides an additional level of security. Use for security sensitive data memory storage only. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 11 2024 20:42:49 for WinStd by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>