Generate API docs as markdown
This commit is contained in:
parent
ab7b83abbb
commit
85e90f7bd5
120 changed files with 14227 additions and 76482 deletions
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Interface IPasswordAlgorithm | CapyKit Documentation </title>
|
||||
<title> Interface IPasswordAlgorithm | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Interface IPasswordAlgorithm | CapyKit Documentation ">
|
||||
<meta name="title" content=" Interface IPasswordAlgorithm | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Defines the contract for password encryption algorithms.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<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">
|
||||
|
|
@ -70,183 +70,59 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.IPasswordAlgorithm">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_IPasswordAlgorithm"> Interface IPasswordAlgorithm</h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_IPasswordAlgorithm" data-uid="CapyKit.IPasswordAlgorithm" class="text-break">
|
||||
Interface IPasswordAlgorithm
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Defines the contract for password encryption algorithms.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface IPasswordAlgorithm</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_IPasswordAlgorithm_AlgorithmName_" data-uid="CapyKit.IPasswordAlgorithm.AlgorithmName*"></a>
|
||||
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_AlgorithmName" data-uid="CapyKit.IPasswordAlgorithm.AlgorithmName">
|
||||
AlgorithmName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the name of the algorithm.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">string AlgorithmName { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_IPasswordAlgorithm_Compare_" data-uid="CapyKit.IPasswordAlgorithm.Compare*"></a>
|
||||
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_Compare_System_String_System_Byte___System_Object___" data-uid="CapyKit.IPasswordAlgorithm.Compare(System.String,System.Byte[],System.Object[])">
|
||||
Compare(string, byte[], params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">bool Compare(string password, byte[] encryptedValue, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The plaintext password to compare.</p>
|
||||
</dd>
|
||||
<dt><code>encryptedValue</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>The encrypted value to compare against.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional arguments for the encryption process, such as salt and length.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>True if the given <code class="paramref">password</code> matches the <code class="paramref">encryptedValue</code>,
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Defines the contract for password encryption algorithms.</p>
|
||||
<pre><code class="lang-csharp">public interface IPasswordAlgorithm
|
||||
</code></pre>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<IPasswordAlgorithm>(IPasswordAlgorithm, IPasswordAlgorithm)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_AlgorithmName"> AlgorithmName</h3>
|
||||
<p>Gets the name of the algorithm.</p>
|
||||
<pre><code class="lang-csharp">string AlgorithmName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_Compare_System_String_System_Byte___System_Object___"> Compare(string, byte[], params object[])</h3>
|
||||
<p>Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.</p>
|
||||
<pre><code class="lang-csharp">bool Compare(string password, byte[] encryptedValue, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password to compare.</p>
|
||||
<p><code>encryptedValue</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The encrypted value to compare against.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments for the encryption process, such as salt and length.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p>True if the given <code class="paramref">password</code> matches the <code class="paramref">encryptedValue</code>,
|
||||
false if they are different.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_IPasswordAlgorithm_Encrypt_" data-uid="CapyKit.IPasswordAlgorithm.Encrypt*"></a>
|
||||
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___" data-uid="CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])">
|
||||
Encrypt(string, params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Encrypts the given password using a defined algorithm.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">byte[] Encrypt(string password, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The plaintext password.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional arguments for the encryption process, such as salt and length.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>A byte array with the hashed <code class="paramref">password</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___"> Encrypt(string, params object[])</h3>
|
||||
<p>Encrypts the given password using a defined algorithm.</p>
|
||||
<pre><code class="lang-csharp">byte[] Encrypt(string password, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments for the encryption process, such as salt and length.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A byte array with the hashed <code class="paramref">password</code>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue