190 lines
9.6 KiB
HTML
190 lines
9.6 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title> Class KeyHelper | CapyKit Documentation </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content=" Class KeyHelper | CapyKit Documentation ">
|
|
|
|
|
|
<link rel="icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
|
<link rel="stylesheet" href="../public/main.css">
|
|
<meta name="docfx:navrel" content="../toc.html">
|
|
<meta name="docfx:tocrel" content="../toc.html">
|
|
|
|
<meta name="docfx:rel" content="../">
|
|
|
|
|
|
|
|
<meta name="loc:inThisArticle" content="In this article">
|
|
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<meta name="loc:tocFilter" content="Filter by title">
|
|
<meta name="loc:nextArticle" content="Next">
|
|
<meta name="loc:prevArticle" content="Previous">
|
|
<meta name="loc:themeLight" content="Light">
|
|
<meta name="loc:themeDark" content="Dark">
|
|
<meta name="loc:themeAuto" content="Auto">
|
|
<meta name="loc:changeTheme" content="Change theme">
|
|
<meta name="loc:copy" content="Copy">
|
|
<meta name="loc:downloadPdf" content="Download PDF">
|
|
|
|
<script type="module" src="./../public/docfx.min.js"></script>
|
|
|
|
<script>
|
|
const theme = localStorage.getItem('theme') || 'auto'
|
|
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
|
</script>
|
|
|
|
</head>
|
|
|
|
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
|
<header class="bg-body border-bottom">
|
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
|
<div class="container-xxl flex-nowrap">
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="CapyKit Documentation">
|
|
CapyKit Documentation
|
|
</a>
|
|
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
|
<i class="bi bi-three-dots"></i>
|
|
</button>
|
|
<div class="collapse navbar-collapse" id="navpanel">
|
|
<div id="navbar">
|
|
<form class="search" role="search" id="search">
|
|
<i class="bi bi-search"></i>
|
|
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="container-xxl">
|
|
|
|
<div class="content">
|
|
<div class="actionbar">
|
|
|
|
<nav id="breadcrumb"></nav>
|
|
</div>
|
|
|
|
<article data-uid="">
|
|
<h1 id="CapyKit_Helpers_KeyHelper"> Class KeyHelper</h1>
|
|
|
|
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
|
Assembly: CapyKit.dll</p>
|
|
<p>A class that contains methods for managing key creation and validation against a master key.</p>
|
|
<pre><code class="lang-csharp">public class KeyHelper
|
|
</code></pre>
|
|
<h4 id="inheritance">Inheritance</h4>
|
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
|
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a></p>
|
|
<h4 id="inherited-members">Inherited Members</h4>
|
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
|
<h4 id="extension-methods">Extension Methods</h4>
|
|
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<KeyHelper>(KeyHelper, KeyHelper)</a>,
|
|
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
|
<h2 id="methods">Methods</h2>
|
|
<h3 id="CapyKit_Helpers_KeyHelper_GenerateKey"> GenerateKey()</h3>
|
|
<p>Generates a random key.</p>
|
|
<pre><code class="lang-csharp">public string GenerateKey()
|
|
</code></pre>
|
|
<h4 id="returns">Returns</h4>
|
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
|
<p>The key.</p>
|
|
<h3 id="CapyKit_Helpers_KeyHelper_GetMasterKey"> GetMasterKey()</h3>
|
|
<p>Gets the master key.</p>
|
|
<pre><code class="lang-csharp">public byte[] GetMasterKey()
|
|
</code></pre>
|
|
<h4 id="returns-1">Returns</h4>
|
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
|
<p>An array of byte.</p>
|
|
<h4 id="exceptions">Exceptions</h4>
|
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></p>
|
|
<p>Thrown when the requested operation is invalid.</p>
|
|
<h3 id="CapyKit_Helpers_KeyHelper_GetNumParts"> GetNumParts()</h3>
|
|
<p>Gets the number parts.</p>
|
|
<pre><code class="lang-csharp">public int GetNumParts()
|
|
</code></pre>
|
|
<h4 id="returns-2">Returns</h4>
|
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
|
<p>The number parts.</p>
|
|
<h4 id="exceptions-1">Exceptions</h4>
|
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></p>
|
|
<p>Thrown when one or more arguments have unsupported or illegal values.</p>
|
|
<h3 id="CapyKit_Helpers_KeyHelper_GetSaltSize"> GetSaltSize()</h3>
|
|
<p>Gets the salt size.</p>
|
|
<pre><code class="lang-csharp">public int GetSaltSize()
|
|
</code></pre>
|
|
<h4 id="returns-3">Returns</h4>
|
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
|
<p>The salt size.</p>
|
|
<h3 id="CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____"> SetMasterKeyAccessor(Func<byte[]>)</h3>
|
|
<p>Sets the master key.</p>
|
|
<pre><code class="lang-csharp">public void SetMasterKeyAccessor(Func<byte[]> accessor)
|
|
</code></pre>
|
|
<h4 id="parameters">Parameters</h4>
|
|
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]></p>
|
|
<p>The accessor function.</p>
|
|
<h3 id="CapyKit_Helpers_KeyHelper_SetNumPartsAccessor_System_Func_System_Int32__"> SetNumPartsAccessor(Func<int>)</h3>
|
|
<p>Set and get the number of parts for the formatted key. Default is 2.</p>
|
|
<pre><code class="lang-csharp">public void SetNumPartsAccessor(Func<int> accessor)
|
|
</code></pre>
|
|
<h4 id="parameters-1">Parameters</h4>
|
|
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></p>
|
|
<p>The accessor function.</p>
|
|
<h3 id="CapyKit_Helpers_KeyHelper_SetSaltSizeAccessor_System_Func_System_Int32__"> SetSaltSizeAccessor(Func<int>)</h3>
|
|
<p>Sets the salt size (in bytes). Default is 4.</p>
|
|
<pre><code class="lang-csharp">public void SetSaltSizeAccessor(Func<int> accessor)
|
|
</code></pre>
|
|
<h4 id="parameters-2">Parameters</h4>
|
|
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></p>
|
|
<p>The accessor function.</p>
|
|
<h3 id="CapyKit_Helpers_KeyHelper_ValidateKey_System_String_"> ValidateKey(string)</h3>
|
|
<p>Validates the provided key.</p>
|
|
<pre><code class="lang-csharp">public bool ValidateKey(string providedKey)
|
|
</code></pre>
|
|
<h4 id="parameters-3">Parameters</h4>
|
|
<p><code>providedKey</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
|
<p>The provided key.</p>
|
|
<h4 id="returns-4">Returns</h4>
|
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
|
<p>True if it succeeds, false if it fails.</p>
|
|
<h4 id="see-also">See Also</h4>
|
|
<p><a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.<a href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_GetMasterKey">GetMasterKey</a>(),
|
|
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.<a href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____">SetMasterKeyAccessor</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]>),
|
|
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.masterKeyAccessor</p>
|
|
|
|
</article>
|
|
|
|
<div class="contribution d-print-none">
|
|
</div>
|
|
|
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
|
|
|
</div>
|
|
|
|
<div class="affix">
|
|
<nav id="affix"></nav>
|
|
</div>
|
|
</main>
|
|
|
|
<div class="container-xxl search-results" id="search-results"></div>
|
|
|
|
<footer class="border-top text-secondary">
|
|
<div class="container-xxl">
|
|
<div class="flex-fill">
|
|
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|