mirror of
https://github.com/leif-ibsen/SwiftECC.git
synced 2026-06-06 20:08:03 +00:00
750 lines
37 KiB
HTML
750 lines
37 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Recipient Class Reference</title>
|
|
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
|
|
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
|
|
<meta charset='utf-8'>
|
|
<script src="../js/jquery.min.js" defer></script>
|
|
<script src="../js/jazzy.js" defer></script>
|
|
|
|
<script src="../js/lunr.min.js" defer></script>
|
|
<script src="../js/typeahead.jquery.js" defer></script>
|
|
<script src="../js/jazzy.search.js" defer></script>
|
|
</head>
|
|
<body>
|
|
<a name="//apple_ref/swift/Class/Recipient" class="dashAnchor"></a>
|
|
<a title="Recipient Class Reference"></a>
|
|
<header>
|
|
<div class="content-wrapper">
|
|
<p><a href="../index.html">SwiftECC Docs</a> (100% documented)</p>
|
|
<div class="header-right">
|
|
<form role="search" action="../search.json">
|
|
<input type="text" placeholder="Search documentation" data-typeahead>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="content-wrapper">
|
|
<p id="breadcrumbs">
|
|
<a href="../index.html">SwiftECC Reference</a>
|
|
<img id="carat" src="../img/carat.png" alt=""/>
|
|
Recipient Class Reference
|
|
</p>
|
|
</div>
|
|
<div class="content-wrapper">
|
|
<nav class="sidebar">
|
|
<ul class="nav-groups">
|
|
<li class="nav-group-name">
|
|
<a href="../Classes.html">Classes</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/CipherSuite.html">CipherSuite</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/Domain.html">Domain</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/ECPrivateKey.html">ECPrivateKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/ECPublicKey.html">ECPublicKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/ECSignature.html">ECSignature</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/HPKEPrivateKey.html">HPKEPrivateKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/HPKEPublicKey.html">HPKEPublicKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/Recipient.html">Recipient</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/Sender.html">Sender</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="../Enums.html">Enumerations</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Enums/AEAD.html">AEAD</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Enums/AESCipher.html">AESCipher</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Enums/BlockMode.html">BlockMode</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Enums/ECCurve.html">ECCurve</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Enums/ECException.html">ECException</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Enums/HPKEException.html">HPKEException</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Enums/KDF.html">KDF</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Enums/KEM.html">KEM</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Enums/MessageDigestAlgorithm.html">MessageDigestAlgorithm</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="../Structs.html">Structures</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Structs/Base64.html">Base64</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Structs/Point.html">Point</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Structs/RP.html">RP</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="../Typealiases.html">Type Aliases</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Typealiases.html#/s:8SwiftECC4Bytea">Byte</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<article class="main-content">
|
|
<section>
|
|
<section class="section">
|
|
<h1>Recipient</h1>
|
|
<div class="declaration">
|
|
<div class="language">
|
|
|
|
<pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"Use the SwiftHPKE package"</span><span class="p">)</span>
|
|
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">Recipient</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<p>Based on its CipherSuite, a Recipient instance can decrypt a sequence of messages in one of four modes:</p>
|
|
|
|
<ul>
|
|
<li>Base mode</li>
|
|
<li>Preshared key mode</li>
|
|
<li>Authenticated mode</li>
|
|
<li>Authenticated, preshared key mode</li>
|
|
</ul>
|
|
|
|
<p>The decryption of the messages must be done in the order in which they were encrypted</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<div class="task-name-container">
|
|
<a name="/Initializers"></a>
|
|
<a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a>
|
|
<div class="section-name-container">
|
|
<a class="section-name-link" href="#/Initializers"></a>
|
|
<h3 class="section-name"><span>Initializers</span>
|
|
</h3>
|
|
</div>
|
|
</div>
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:8SwiftECC9RecipientC5suite10privateKey4info5encapAcA11CipherSuiteC_AA011HPKEPrivateF0CSays5UInt8VGANtKcfc"></a>
|
|
<a name="//apple_ref/swift/Method/init(suite:privateKey:info:encap:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:8SwiftECC9RecipientC5suite10privateKey4info5encapAcA11CipherSuiteC_AA011HPKEPrivateF0CSays5UInt8VGANtKcfc">init(suite:<wbr>privateKey:<wbr>info:<wbr>encap:<wbr>)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Creates a Recipient instance in base mode</p>
|
|
<div class="aside aside-throws">
|
|
<p class="aside-title">Throws</p>
|
|
An exception if one of the keys does not match <em>suite</em>
|
|
|
|
</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">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"Use the SwiftHPKE package"</span><span class="p">)</span>
|
|
<span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">suite</span><span class="p">:</span> <span class="kt"><a href="../Classes/CipherSuite.html">CipherSuite</a></span><span class="p">,</span> <span class="nv">privateKey</span><span class="p">:</span> <span class="kt"><a href="../Classes/HPKEPrivateKey.html">HPKEPrivateKey</a></span><span class="p">,</span> <span class="nv">info</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">,</span> <span class="nv">encap</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">)</span> <span class="k">throws</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>suite</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The CipherSuite of the Recipient</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>privateKey</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The recipient private key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>info</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The additional information</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>encap</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The encapsulated key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:8SwiftECC9RecipientC5suite10privateKey4info3psk0H2Id5encapAcA11CipherSuiteC_AA011HPKEPrivateF0CSays5UInt8VGA3PtKcfc"></a>
|
|
<a name="//apple_ref/swift/Method/init(suite:privateKey:info:psk:pskId:encap:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:8SwiftECC9RecipientC5suite10privateKey4info3psk0H2Id5encapAcA11CipherSuiteC_AA011HPKEPrivateF0CSays5UInt8VGA3PtKcfc">init(suite:<wbr>privateKey:<wbr>info:<wbr>psk:<wbr>pskId:<wbr>encap:<wbr>)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Creates a Recipient instance in preshared key mode</p>
|
|
<div class="aside aside-throws">
|
|
<p class="aside-title">Throws</p>
|
|
An exception if one of the keys does not match <em>suite</em>
|
|
|
|
</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">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"Use the SwiftHPKE package"</span><span class="p">)</span>
|
|
<span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">suite</span><span class="p">:</span> <span class="kt"><a href="../Classes/CipherSuite.html">CipherSuite</a></span><span class="p">,</span> <span class="nv">privateKey</span><span class="p">:</span> <span class="kt"><a href="../Classes/HPKEPrivateKey.html">HPKEPrivateKey</a></span><span class="p">,</span> <span class="nv">info</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">,</span> <span class="nv">psk</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">,</span> <span class="nv">pskId</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">,</span> <span class="nv">encap</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">)</span> <span class="k">throws</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>suite</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The CipherSuite of the Recipient</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>privateKey</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The recipient private key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>info</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The additional information</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>psk</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The preshared key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>pskId</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The preshared key id</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>encap</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The encapsulated key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:8SwiftECC9RecipientC5suite10privateKey4info14authentication5encapAcA11CipherSuiteC_AA011HPKEPrivateF0CSays5UInt8VGAA010HPKEPublicF0CAOtKcfc"></a>
|
|
<a name="//apple_ref/swift/Method/init(suite:privateKey:info:authentication:encap:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:8SwiftECC9RecipientC5suite10privateKey4info14authentication5encapAcA11CipherSuiteC_AA011HPKEPrivateF0CSays5UInt8VGAA010HPKEPublicF0CAOtKcfc">init(suite:<wbr>privateKey:<wbr>info:<wbr>authentication:<wbr>encap:<wbr>)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Creates a Recipient instance in authenticated mode</p>
|
|
<div class="aside aside-throws">
|
|
<p class="aside-title">Throws</p>
|
|
An exception if one of the keys does not match <em>suite</em>
|
|
|
|
</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">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"Use the SwiftHPKE package"</span><span class="p">)</span>
|
|
<span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">suite</span><span class="p">:</span> <span class="kt"><a href="../Classes/CipherSuite.html">CipherSuite</a></span><span class="p">,</span> <span class="nv">privateKey</span><span class="p">:</span> <span class="kt"><a href="../Classes/HPKEPrivateKey.html">HPKEPrivateKey</a></span><span class="p">,</span> <span class="nv">info</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">,</span> <span class="nv">authentication</span><span class="p">:</span> <span class="kt"><a href="../Classes/HPKEPublicKey.html">HPKEPublicKey</a></span><span class="p">,</span> <span class="nv">encap</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">)</span> <span class="k">throws</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>suite</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The CipherSuite of the Recipient</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>privateKey</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The recipient private key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>info</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The additional information</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>authentication</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The sender public key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>encap</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The encapsulated key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:8SwiftECC9RecipientC5suite10privateKey4info14authentication3psk0I2Id5encapAcA11CipherSuiteC_AA011HPKEPrivateF0CSays5UInt8VGAA010HPKEPublicF0CA3QtKcfc"></a>
|
|
<a name="//apple_ref/swift/Method/init(suite:privateKey:info:authentication:psk:pskId:encap:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:8SwiftECC9RecipientC5suite10privateKey4info14authentication3psk0I2Id5encapAcA11CipherSuiteC_AA011HPKEPrivateF0CSays5UInt8VGAA010HPKEPublicF0CA3QtKcfc">init(suite:<wbr>privateKey:<wbr>info:<wbr>authentication:<wbr>psk:<wbr>pskId:<wbr>encap:<wbr>)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Creates a Recipient instance in authenticated, preshared key mode</p>
|
|
<div class="aside aside-throws">
|
|
<p class="aside-title">Throws</p>
|
|
An exception if one of the keys does not match <em>suite</em>
|
|
|
|
</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">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"Use the SwiftHPKE package"</span><span class="p">)</span>
|
|
<span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">suite</span><span class="p">:</span> <span class="kt"><a href="../Classes/CipherSuite.html">CipherSuite</a></span><span class="p">,</span> <span class="nv">privateKey</span><span class="p">:</span> <span class="kt"><a href="../Classes/HPKEPrivateKey.html">HPKEPrivateKey</a></span><span class="p">,</span> <span class="nv">info</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">,</span> <span class="nv">authentication</span><span class="p">:</span> <span class="kt"><a href="../Classes/HPKEPublicKey.html">HPKEPublicKey</a></span><span class="p">,</span> <span class="nv">psk</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">,</span> <span class="nv">pskId</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">,</span> <span class="nv">encap</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">)</span> <span class="k">throws</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>suite</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The CipherSuite of the Recipient</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>privateKey</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The recipient private key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>info</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The additional information</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>authentication</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The sender public key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>psk</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The preshared key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>pskId</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The preshared key id</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>encap</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The encapsulated key</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="task-group">
|
|
<div class="task-name-container">
|
|
<a name="/Instance%20Methods"></a>
|
|
<a name="//apple_ref/swift/Section/Instance Methods" class="dashAnchor"></a>
|
|
<div class="section-name-container">
|
|
<a class="section-name-link" href="#/Instance%20Methods"></a>
|
|
<h3 class="section-name"><span>Instance Methods</span>
|
|
</h3>
|
|
</div>
|
|
</div>
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:8SwiftECC9RecipientC4open2ct3aadSays5UInt8VGAI_AItKF"></a>
|
|
<a name="//apple_ref/swift/Method/open(ct:aad:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:8SwiftECC9RecipientC4open2ct3aadSays5UInt8VGAI_AItKF">open(ct:<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 message</p>
|
|
<div class="aside aside-throws">
|
|
<p class="aside-title">Throws</p>
|
|
An exception if decryption fails or <em>self.suite.aead</em> is EXPORTONLY
|
|
|
|
</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">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"Use the SwiftHPKE package"</span><span class="p">)</span>
|
|
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">open</span><span class="p">(</span><span class="nv">ct</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="p">)</span> <span class="k">throws</span> <span class="o">-></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>ct</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The cipher text to decrypt</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>aad</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The associated data</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h4>Return Value</h4>
|
|
<p>The plain text</p>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:8SwiftECC9RecipientC12exportSecret7context1LSays5UInt8VGAI_SitKF"></a>
|
|
<a name="//apple_ref/swift/Method/exportSecret(context:L:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:8SwiftECC9RecipientC12exportSecret7context1LSays5UInt8VGAI_SitKF">exportSecret(context:<wbr>L:<wbr>)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Compute an export secret</p>
|
|
<div class="aside aside-throws">
|
|
<p class="aside-title">Throws</p>
|
|
An exception if L is negative or too large
|
|
|
|
</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">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"Use the SwiftHPKE package"</span><span class="p">)</span>
|
|
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">exportSecret</span><span class="p">(</span><span class="nv">context</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:8SwiftECC5Bytesa">Bytes</a></span><span class="p">,</span> <span class="kt">L</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></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>context</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The export context</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>L</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The length of the export secret</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h4>Return Value</h4>
|
|
<p>The export secret</p>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section id="footer">
|
|
<p>© 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-08-16)</p>
|
|
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
|
|
</section>
|
|
</article>
|
|
</div>
|
|
</body>
|
|
</html>
|