Skip to content

Commit

Permalink
Release 3.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@leif-ibsen
leif-ibsen committed Apr 5, 2022
1 parent 0150d74 commit b7cb66e
Show file tree
Hide file tree
Showing 40 changed files with 1,488 additions and 66 deletions.
2 changes: 1 addition & 1 deletion docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-03-27)</p>
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-04-05)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
417 changes: 417 additions & 0 deletions docs/Classes/ChaChaPoly.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Classes/Domain.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1837,7 +1837,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-03-27)</p>
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-04-05)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
144 changes: 139 additions & 5 deletions docs/Classes/ECPrivateKey.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -951,10 +951,10 @@ <h4>Return Value</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Decrypts a byte array message with ECIES</p>
<p>Decrypts a byte array message with ECIES using the AES cipher</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
An exception if the message authentication fails or the message is too short
An exception if message authentication fails or the message is too short

</div>

Expand Down Expand Up @@ -1030,10 +1030,10 @@ <h4>Return Value</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Decrypts a Data message with ECIES</p>
<p>Decrypts a Data message with ECIES using the AES cipher</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
An exception if the message authentication fails or the message is too short
An exception if message authentication fails or the message is too short

</div>

Expand Down Expand Up @@ -1096,6 +1096,140 @@ <h4>Return Value</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8SwiftECC12ECPrivateKeyC010decryptChaF03msg3aadSays5UInt8VGAI_AItKF"></a>
<a name="//apple_ref/swift/Method/decryptChaCha(msg:aad:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SwiftECC12ECPrivateKeyC010decryptChaF03msg3aadSays5UInt8VGAI_AItKF">decryptChaCha(msg:<wbr>aad:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Decrypts a byte array message with ECIES using the ChaCha20 cipher</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
An exception if message authentication fails or the message is too short

</div>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">decryptChaCha</span><span class="p">(</span><span class="nv">msg</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">,</span> <span class="nv">aad</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span> <span class="o">=</span> <span class="p">[])</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>msg</em>
</code>
</td>
<td>
<div>
<p>The bytes to decrypt</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>aad</em>
</code>
</td>
<td>
<div>
<p>Additional authenticated data - an empty array is default</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The decrypted message</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8SwiftECC12ECPrivateKeyC010decryptChaF03msg3aad10Foundation4DataVAI_AItKF"></a>
<a name="//apple_ref/swift/Method/decryptChaCha(msg:aad:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SwiftECC12ECPrivateKeyC010decryptChaF03msg3aad10Foundation4DataVAI_AItKF">decryptChaCha(msg:<wbr>aad:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Decrypts a Data message with ECIES using the ChaCha20 cipher</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
An exception if message authentication fails or the message is too short

</div>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">decryptChaCha</span><span class="p">(</span><span class="nv">msg</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="nv">aad</span><span class="p">:</span> <span class="kt">Data</span> <span class="o">=</span> <span class="kt">Data</span><span class="p">())</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Data</span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>msg</em>
</code>
</td>
<td>
<div>
<p>The data to decrypt</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>aad</em>
</code>
</td>
<td>
<div>
<p>Additional authenticated data - empty data is default</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The decrypted message</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -1204,7 +1338,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-03-27)</p>
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-04-05)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
130 changes: 127 additions & 3 deletions docs/Classes/ECPublicKey.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -698,7 +698,7 @@ <h4>Return Value</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Encrypts a byte array with ECIES</p>
<p>Encrypts a byte array with ECIES using the AES cipher</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -772,7 +772,7 @@ <h4>Return Value</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Encrypts a Data structure with ECIES</p>
<p>Encrypts a Data structure with ECIES using the AES cipher</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -833,12 +833,136 @@ <h4>Return Value</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8SwiftECC11ECPublicKeyC010encryptChaF03msg3aadSays5UInt8VGAI_AItF"></a>
<a name="//apple_ref/swift/Method/encryptChaCha(msg:aad:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SwiftECC11ECPublicKeyC010encryptChaF03msg3aadSays5UInt8VGAI_AItF">encryptChaCha(msg:<wbr>aad:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Encrypts a byte array with ECIES using the ChaCha20 cipher</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">encryptChaCha</span><span class="p">(</span><span class="nv">msg</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">,</span> <span class="nv">aad</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span> <span class="o">=</span> <span class="p">[])</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>msg</em>
</code>
</td>
<td>
<div>
<p>The bytes to encrypt</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>aad</em>
</code>
</td>
<td>
<div>
<p>Additional authenticated data - an empty array is default</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The encrypted message and tag</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8SwiftECC11ECPublicKeyC010encryptChaF03msg3aad10Foundation4DataVAI_AItF"></a>
<a name="//apple_ref/swift/Method/encryptChaCha(msg:aad:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SwiftECC11ECPublicKeyC010encryptChaF03msg3aad10Foundation4DataVAI_AItF">encryptChaCha(msg:<wbr>aad:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Encrypts a Data structure with ECIES using the ChaCha20 cipher</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">encryptChaCha</span><span class="p">(</span><span class="nv">msg</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="nv">aad</span><span class="p">:</span> <span class="kt">Data</span> <span class="o">=</span> <span class="kt">Data</span><span class="p">())</span> <span class="o">-&gt;</span> <span class="kt">Data</span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>msg</em>
</code>
</td>
<td>
<div>
<p>The data to encrypt</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>aad</em>
</code>
</td>
<td>
<div>
<p>Additional authenticated data - empty data is default</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The encrypted message and tag</p>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-03-27)</p>
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-04-05)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/ECSignature.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-03-27)</p>
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-04-05)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-03-27)</p>
<p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-04-05)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit b7cb66e

Please sign in to comment.