Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nd1012 committed Sep 16, 2023
1 parent 9b5c8bc commit b147ace
Show file tree
Hide file tree
Showing 10 changed files with 432 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,18 @@ <h5>Inherited Members</h5>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.GetDecryptorAsync(System.IO.Stream, wan24.Crypto.CryptoOptions, System.Threading.CancellationToken)</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.EnsureValidKeyLength(System.Byte[])</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.IsKeyLengthValid(System.Int32)</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.CreateIvBytes()</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.GetValidLengthKey(System.Byte[], System.Int32)</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.ReadFixedIvBytes(System.IO.Stream, wan24.Crypto.CryptoOptions)</span>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,18 @@ <h5>Inherited Members</h5>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.GetDecryptorAsync(System.IO.Stream, wan24.Crypto.CryptoOptions, System.Threading.CancellationToken)</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.EnsureValidKeyLength(System.Byte[])</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.IsKeyLengthValid(System.Int32)</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.CreateIvBytes()</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.GetValidLengthKey(System.Byte[], System.Int32)</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.ReadFixedIvBytes(System.IO.Stream, wan24.Crypto.CryptoOptions)</span>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,18 @@ <h5>Inherited Members</h5>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.GetDecryptorAsync(System.IO.Stream, wan24.Crypto.CryptoOptions, System.Threading.CancellationToken)</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.EnsureValidKeyLength(System.Byte[])</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.IsKeyLengthValid(System.Int32)</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.CreateIvBytes()</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.GetValidLengthKey(System.Byte[], System.Int32)</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.ReadFixedIvBytes(System.IO.Stream, wan24.Crypto.CryptoOptions)</span>
</div>
Expand Down
105 changes: 103 additions & 2 deletions docs/api/wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@ <h5>Inherited Members</h5>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.CreateIvBytes()</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.GetValidLengthKey(System.Byte[], System.Int32)</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.ReadFixedIvBytes(System.IO.Stream, wan24.Crypto.CryptoOptions)</span>
</div>
Expand Down Expand Up @@ -656,7 +659,7 @@ <h3 id="methods">Methods
<a href="https://github.com/nd1012/wan24-Crypto-BC/new/main/apiSpec/new?filename=wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_CreateAes_wan24_Crypto_CryptoOptions_.md&amp;value=---%0Auid%3A%20wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.CreateAes(wan24.Crypto.CryptoOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionAes256GcmAlgorithm.cs/#L71">View Source</a>
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionAes256GcmAlgorithm.cs/#L77">View Source</a>
</span>
<a id="wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_CreateAes_" data-uid="wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.CreateAes*"></a>
<h4 id="wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_CreateAes_wan24_Crypto_CryptoOptions_" data-uid="wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.CreateAes(wan24.Crypto.CryptoOptions)">CreateAes(CryptoOptions)</h4>
Expand Down Expand Up @@ -706,7 +709,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/nd1012/wan24-Crypto-BC/new/main/apiSpec/new?filename=wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_CreateCipher_System_Boolean_wan24_Crypto_CryptoOptions_.md&amp;value=---%0Auid%3A%20wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.CreateCipher(System.Boolean%2Cwan24.Crypto.CryptoOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionAes256GcmAlgorithm.cs/#L64">View Source</a>
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionAes256GcmAlgorithm.cs/#L70">View Source</a>
</span>
<a id="wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_CreateCipher_" data-uid="wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.CreateCipher*"></a>
<h4 id="wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_CreateCipher_System_Boolean_wan24_Crypto_CryptoOptions_" data-uid="wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.CreateCipher(System.Boolean,wan24.Crypto.CryptoOptions)">CreateCipher(Boolean, CryptoOptions)</h4>
Expand Down Expand Up @@ -759,6 +762,104 @@ <h5 class="returns">Returns</h5>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">wan24.Crypto.BC.BouncyCastleAeadStreamCipherAlgorithmBase&lt;wan24.Crypto.BC.EncryptionAes256GcmAlgorithm&gt;.CreateCipher(System.Boolean, wan24.Crypto.CryptoOptions)</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/nd1012/wan24-Crypto-BC/new/main/apiSpec/new?filename=wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_EnsureValidKeyLength_System_Byte___.md&amp;value=---%0Auid%3A%20wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.EnsureValidKeyLength(System.Byte%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionAes256GcmAlgorithm.cs/#L67">View Source</a>
</span>
<a id="wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_EnsureValidKeyLength_" data-uid="wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.EnsureValidKeyLength*"></a>
<h4 id="wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_EnsureValidKeyLength_System_Byte___" data-uid="wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.EnsureValidKeyLength(System.Byte[])">EnsureValidKeyLength(Byte[])</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override byte[] EnsureValidKeyLength(byte[] key)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td><span class="parametername">key</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">wan24.Crypto.EncryptionAlgorithmBase.EnsureValidKeyLength(System.Byte[])</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/nd1012/wan24-Crypto-BC/new/main/apiSpec/new?filename=wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_IsKeyLengthValid_System_Int32_.md&amp;value=---%0Auid%3A%20wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.IsKeyLengthValid(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionAes256GcmAlgorithm.cs/#L64">View Source</a>
</span>
<a id="wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_IsKeyLengthValid_" data-uid="wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.IsKeyLengthValid*"></a>
<h4 id="wan24_Crypto_BC_EncryptionAes256GcmAlgorithm_IsKeyLengthValid_System_Int32_" data-uid="wan24.Crypto.BC.EncryptionAes256GcmAlgorithm.IsKeyLengthValid(System.Int32)">IsKeyLengthValid(Int32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool IsKeyLengthValid(int len)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">len</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">wan24.Crypto.EncryptionAlgorithmBase.IsKeyLengthValid(System.Int32)</span></div>
</article>
</div>

Expand Down
105 changes: 103 additions & 2 deletions docs/api/wan24.Crypto.BC.EncryptionChaCha20Algorithm.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@ <h5>Inherited Members</h5>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.CreateIvBytes()</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.GetValidLengthKey(System.Byte[], System.Int32)</span>
</div>
<div>
<span class="xref">wan24.Crypto.EncryptionAlgorithmBase.ReadFixedIvBytes(System.IO.Stream, wan24.Crypto.CryptoOptions)</span>
</div>
Expand Down Expand Up @@ -656,7 +659,7 @@ <h3 id="methods">Methods
<a href="https://github.com/nd1012/wan24-Crypto-BC/new/main/apiSpec/new?filename=wan24_Crypto_BC_EncryptionChaCha20Algorithm_CreateChaCha_wan24_Crypto_CryptoOptions_.md&amp;value=---%0Auid%3A%20wan24.Crypto.BC.EncryptionChaCha20Algorithm.CreateChaCha(wan24.Crypto.CryptoOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionChaCha20Algorithm.cs/#L71">View Source</a>
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionChaCha20Algorithm.cs/#L77">View Source</a>
</span>
<a id="wan24_Crypto_BC_EncryptionChaCha20Algorithm_CreateChaCha_" data-uid="wan24.Crypto.BC.EncryptionChaCha20Algorithm.CreateChaCha*"></a>
<h4 id="wan24_Crypto_BC_EncryptionChaCha20Algorithm_CreateChaCha_wan24_Crypto_CryptoOptions_" data-uid="wan24.Crypto.BC.EncryptionChaCha20Algorithm.CreateChaCha(wan24.Crypto.CryptoOptions)">CreateChaCha(CryptoOptions)</h4>
Expand Down Expand Up @@ -706,7 +709,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/nd1012/wan24-Crypto-BC/new/main/apiSpec/new?filename=wan24_Crypto_BC_EncryptionChaCha20Algorithm_CreateCipher_System_Boolean_wan24_Crypto_CryptoOptions_.md&amp;value=---%0Auid%3A%20wan24.Crypto.BC.EncryptionChaCha20Algorithm.CreateCipher(System.Boolean%2Cwan24.Crypto.CryptoOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionChaCha20Algorithm.cs/#L64">View Source</a>
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionChaCha20Algorithm.cs/#L70">View Source</a>
</span>
<a id="wan24_Crypto_BC_EncryptionChaCha20Algorithm_CreateCipher_" data-uid="wan24.Crypto.BC.EncryptionChaCha20Algorithm.CreateCipher*"></a>
<h4 id="wan24_Crypto_BC_EncryptionChaCha20Algorithm_CreateCipher_System_Boolean_wan24_Crypto_CryptoOptions_" data-uid="wan24.Crypto.BC.EncryptionChaCha20Algorithm.CreateCipher(System.Boolean,wan24.Crypto.CryptoOptions)">CreateCipher(Boolean, CryptoOptions)</h4>
Expand Down Expand Up @@ -759,6 +762,104 @@ <h5 class="returns">Returns</h5>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">wan24.Crypto.BC.BouncyCastleStreamCipherAlgorithmBase&lt;wan24.Crypto.BC.EncryptionChaCha20Algorithm&gt;.CreateCipher(System.Boolean, wan24.Crypto.CryptoOptions)</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/nd1012/wan24-Crypto-BC/new/main/apiSpec/new?filename=wan24_Crypto_BC_EncryptionChaCha20Algorithm_EnsureValidKeyLength_System_Byte___.md&amp;value=---%0Auid%3A%20wan24.Crypto.BC.EncryptionChaCha20Algorithm.EnsureValidKeyLength(System.Byte%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionChaCha20Algorithm.cs/#L67">View Source</a>
</span>
<a id="wan24_Crypto_BC_EncryptionChaCha20Algorithm_EnsureValidKeyLength_" data-uid="wan24.Crypto.BC.EncryptionChaCha20Algorithm.EnsureValidKeyLength*"></a>
<h4 id="wan24_Crypto_BC_EncryptionChaCha20Algorithm_EnsureValidKeyLength_System_Byte___" data-uid="wan24.Crypto.BC.EncryptionChaCha20Algorithm.EnsureValidKeyLength(System.Byte[])">EnsureValidKeyLength(Byte[])</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override byte[] EnsureValidKeyLength(byte[] key)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td><span class="parametername">key</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">wan24.Crypto.EncryptionAlgorithmBase.EnsureValidKeyLength(System.Byte[])</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/nd1012/wan24-Crypto-BC/new/main/apiSpec/new?filename=wan24_Crypto_BC_EncryptionChaCha20Algorithm_IsKeyLengthValid_System_Int32_.md&amp;value=---%0Auid%3A%20wan24.Crypto.BC.EncryptionChaCha20Algorithm.IsKeyLengthValid(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/nd1012/wan24-Crypto-BC/blob/main/src/wan24-Crypto-BC/EncryptionChaCha20Algorithm.cs/#L64">View Source</a>
</span>
<a id="wan24_Crypto_BC_EncryptionChaCha20Algorithm_IsKeyLengthValid_" data-uid="wan24.Crypto.BC.EncryptionChaCha20Algorithm.IsKeyLengthValid*"></a>
<h4 id="wan24_Crypto_BC_EncryptionChaCha20Algorithm_IsKeyLengthValid_System_Int32_" data-uid="wan24.Crypto.BC.EncryptionChaCha20Algorithm.IsKeyLengthValid(System.Int32)">IsKeyLengthValid(Int32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool IsKeyLengthValid(int len)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">len</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">wan24.Crypto.EncryptionAlgorithmBase.IsKeyLengthValid(System.Int32)</span></div>
</article>
</div>

Expand Down
Loading

0 comments on commit b147ace

Please sign in to comment.