MLAPI/docs/html/M_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper_Decrypt.htm

24 lines
10 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>CryptographyHelper.Decrypt Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="Decrypt method" /><meta name="System.Keywords" content="CryptographyHelper.Decrypt method" /><meta name="Microsoft.Help.F1" content="MLAPI.NetworkingManagerComponents.Cryptography.CryptographyHelper.Decrypt" /><meta name="Microsoft.Help.Id" content="M:MLAPI.NetworkingManagerComponents.Cryptography.CryptographyHelper.Decrypt(System.Byte[],System.Byte[])" /><meta name="Description" content="Decrypts a message with AES with a given key and a salt that is encoded as the first 16 bytes of the buffer" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="MLAPI.NetworkingManagerComponents.Cryptography" /><meta name="file" content="M_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper_Decrypt" /><meta name="guid" content="M_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper_Decrypt" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">MLAPI API Reference<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html\N_MLAPI_Attributes.htm" title="MLAPI API Reference" tocid="roottoc">MLAPI API Reference</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/N_MLAPI_NetworkingManagerComponents_Cryptography.htm" title="MLAPI.NetworkingManagerComponents.Cryptography" tocid="N_MLAPI_NetworkingManagerComponents_Cryptography">MLAPI.NetworkingManagerComponents.Cryptography</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/T_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper.htm" title="CryptographyHelper Class" tocid="T_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper">CryptographyHelper Class</a></div><div class="toclevel1" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/Methods_T_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper.htm" title="CryptographyHelper Methods" tocid="Methods_T_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper">CryptographyHelper Methods</a></div><div class="toclevel2 current" data-toclevel="2"><a data-tochassubtree="false" href="../html/M_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper_Decrypt.htm" title="Decrypt Method " tocid="M_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper_Decrypt">Decrypt Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/M_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper_Encrypt.htm" title="Encrypt Method " tocid="M_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper_Encrypt">Encrypt Method </a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn"><h1>CryptographyHelper<span id="LSTC7938D09_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC7938D09_0?cpp=::|nu=.");</script>Decrypt Method </h1></td><td class="logoColumn"><img width="600" src="../icons/MLAPI_Logo.png" /></td></tr></table><span class="introStyle"></span> <p style="color: #dc143c; font-size: 8.5pt; font-weight: bold;">[This is preliminary documentation and is subject to change.]</p><div class="summary">
Decrypts a message with AES with a given key and a salt that is encoded as the first 16 bytes of the buffer
</div><p> </p>
<strong>Namespace:</strong>
 <a href="N_MLAPI_NetworkingManagerComponents_Cryptography.htm">MLAPI.NetworkingManagerComponents.Cryptography</a><br />
<strong>Assembly:</strong>
 MLAPI (in MLAPI.dll) Version: 1.0.0.0 (1.0.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID1RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EACA_tab1" class="codeSnippetContainerTabSingle">C#</div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EACA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EACA');return false;" title="Copy">Copy</a></div></div><div id="ID0EACA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">static</span> <span class="identifier">byte</span>[] <span class="identifier">Decrypt</span>(
<span class="identifier">byte</span>[] <span class="parameter">encryptedBuffer</span>,
<span class="identifier">byte</span>[] <span class="parameter">key</span>
)</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EACA");</script><a id="HT_RequestExampleLink" href="https://github.com/TwoTenPvP/MLAPI/issues/new" target="_blank" class="button" title="Request an example for this topic">Request Example</a>
<script type="text/javascript">
var HT_requestExampleLink = document.getElementById("HT_RequestExampleLink");
var HT_requestExampleLinkText = HT_requestExampleLink.innerHTML;
if(HT_requestExampleLink.href.substring(0, 4).toLowerCase() == "http")
HT_requestExampleLink.href += "?title=";
else
HT_requestExampleLink.href += "?subject=MLAPI API Reference: ";
HT_requestExampleLink.href += "Add an Example for " + encodeURIComponent(document.title) + "&amp;body=" +
encodeURIComponent("Please add an example for " + document.title + ".%0D%0DTODO (optional): Describe a specific " +
"scenario you would like to see addressed.%0D%0DHelp Topic: " + window.location.href).replace(/%250D/g, "%0D");
HT_requestExampleLink.innerHTML = HT_requestExampleLinkText;
</script><a target="_blank" class="button" href="https://github.com/TwoTenPvP/MLAPI/blob/master/MLAPI/NetworkingManagerComponents/Cryptography/CryptographyHelper.cs#L19" title="View the source code">View Source</a><h4 class="subHeading">Parameters</h4><dl><dt><span class="parameter">encryptedBuffer</span></dt><dd>Type: <span id="LSTC7938D09_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC7938D09_1?cpp=array&lt;");</script><a href="http://msdn2.microsoft.com/en-us/library/yyb1w04y" target="_blank">System<span id="LSTC7938D09_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC7938D09_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Byte</a><span id="LSTC7938D09_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC7938D09_3?cpp=&gt;|vb=()|nu=[]");</script><br />The buffer with the salt</dd><dt><span class="parameter">key</span></dt><dd>Type: <span id="LSTC7938D09_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC7938D09_4?cpp=array&lt;");</script><a href="http://msdn2.microsoft.com/en-us/library/yyb1w04y" target="_blank">System<span id="LSTC7938D09_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC7938D09_5?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Byte</a><span id="LSTC7938D09_6"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC7938D09_6?cpp=&gt;|vb=()|nu=[]");</script><br />The key to use</dd></dl><h4 class="subHeading">Return Value</h4>Type: <span id="LSTC7938D09_7"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC7938D09_7?cpp=array&lt;");</script><a href="http://msdn2.microsoft.com/en-us/library/yyb1w04y" target="_blank">Byte</a><span id="LSTC7938D09_8"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC7938D09_8?cpp=&gt;|vb=()|nu=[]");</script><br />The decrypted byte array</div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID2RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="T_MLAPI_NetworkingManagerComponents_Cryptography_CryptographyHelper.htm">CryptographyHelper Class</a></div><div class="seeAlsoStyle"><a href="N_MLAPI_NetworkingManagerComponents_Cryptography.htm">MLAPI.NetworkingManagerComponents.Cryptography Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>