Skip to content

Commit

Permalink
feat(RAMF): Implement payload wrapping (#71) [skip ci] ab24ca5
Browse files Browse the repository at this point in the history
  • Loading branch information
kodiakhq[bot] committed Jul 19, 2020
1 parent b2df5c2 commit 7d053fe
Show file tree
Hide file tree
Showing 35 changed files with 638 additions and 257 deletions.
16 changes: 14 additions & 2 deletions api/relaynet/alltypes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,16 @@ <h5><a href="../tech.relaycorp.relaynet.wrappers.x509/-certificate-exception/ind
<p>Relaynet PKI certificate exception.</p>
</tr>
<tr>
<h5><a href="../tech.relaycorp.relaynet.messages.payloads/-empty-payload-plaintext/index.html">tech.relaycorp.relaynet.messages.payloads.EmptyPayloadPlaintext</a></h5>
<h5><a href="../tech.relaycorp.relaynet.messages.payloads/-empty-payload/index.html">tech.relaycorp.relaynet.messages.payloads.EmptyPayload</a></h5>
<p>Empty payload plaintext.</p>
</tr>
<tr>
<h5><a href="../tech.relaycorp.relaynet.messages.payloads/-encrypted-payload/index.html">tech.relaycorp.relaynet.messages.payloads.EncryptedPayload</a></h5>
</tr>
<tr>
<h5><a href="../tech.relaycorp.relaynet.ramf/-encrypted-r-a-m-f-message/index.html">tech.relaycorp.relaynet.ramf.EncryptedRAMFMessage</a></h5>
</tr>
<tr>
<h5><a href="../tech.relaycorp.relaynet.wrappers.cms/-enveloped-data-exception.html">tech.relaycorp.relaynet.wrappers.cms.EnvelopedDataException</a></h5>
</tr>
<tr>
Expand All @@ -55,7 +61,7 @@ <h5><a href="../tech.relaycorp.relaynet.messages/-parcel/index.html">tech.relayc
<p>Parcel</p>
</tr>
<tr>
<h5><a href="../tech.relaycorp.relaynet.messages.payloads/-payload-plaintext/index.html">tech.relaycorp.relaynet.messages.payloads.PayloadPlaintext</a></h5>
<h5><a href="../tech.relaycorp.relaynet.messages.payloads/-payload/index.html">tech.relaycorp.relaynet.messages.payloads.Payload</a></h5>
<p>RAMF payload in plaintext form.</p>
</tr>
<tr>
Expand All @@ -77,6 +83,12 @@ <h5><a href="../tech.relaycorp.relaynet.messages.payloads/-service-message/index
<h5><a href="../tech.relaycorp.relaynet/-symmetric-encryption/index.html">tech.relaycorp.relaynet.SymmetricEncryption</a></h5>
<p>Supported block ciphers</p>
</tr>
<tr>
<h5><a href="../tech.relaycorp.relaynet.messages.payloads/-unencrypted-payload/index.html">tech.relaycorp.relaynet.messages.payloads.UnencryptedPayload</a></h5>
</tr>
<tr>
<h5><a href="../tech.relaycorp.relaynet.ramf/-unencrypted-r-a-m-f-message/index.html">tech.relaycorp.relaynet.ramf.UnencryptedRAMFMessage</a></h5>
</tr>
</tbody>
</table>
</BODY>
Expand Down
166 changes: 136 additions & 30 deletions api/relaynet/index-outline.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<a href="../../index.html">relaynet</a>&nbsp;/&nbsp;<a href="../index.html">tech.relaycorp.relaynet.messages.payloads</a>&nbsp;/&nbsp;<a href="./index.html">CargoMessageSet</a><br/>
<br/>
<h1>CargoMessageSet</h1>
<code><span class="keyword">class </span><span class="identifier">CargoMessageSet</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-payload-plaintext/index.html"><span class="identifier">PayloadPlaintext</span></a></code>
<code><span class="keyword">class </span><span class="identifier">CargoMessageSet</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-encrypted-payload/index.html"><span class="identifier">EncryptedPayload</span></a></code>
<p>Cargo message set.</p>
<h3>Constructors</h3>
<table>
Expand Down Expand Up @@ -40,11 +40,11 @@ <h3>Functions</h3>
<tbody>
<tr>
<td>
<h4><a href="serialize.html">serialize</a></h4>
<h4><a href="serialize-plaintext.html">serializePlaintext</a></h4>
</td>
<td>
<p>Serialize cargo message set.</p>
<code><span class="keyword">fun </span><span class="identifier">serialize</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html"><span class="identifier">ByteArray</span></a></code></td>
<code><span class="keyword">fun </span><span class="identifier">serializePlaintext</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html"><span class="identifier">ByteArray</span></a></code></td>
</tr>
</tbody>
</table>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>CargoMessageSet.serialize - relaynet</title>
<title>CargoMessageSet.serializePlaintext - relaynet</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">relaynet</a>&nbsp;/&nbsp;<a href="../index.html">tech.relaycorp.relaynet.messages.payloads</a>&nbsp;/&nbsp;<a href="index.html">CargoMessageSet</a>&nbsp;/&nbsp;<a href="./serialize.html">serialize</a><br/>
<a href="../../index.html">relaynet</a>&nbsp;/&nbsp;<a href="../index.html">tech.relaycorp.relaynet.messages.payloads</a>&nbsp;/&nbsp;<a href="index.html">CargoMessageSet</a>&nbsp;/&nbsp;<a href="./serialize-plaintext.html">serializePlaintext</a><br/>
<br/>
<h1>serialize</h1>
<a name="tech.relaycorp.relaynet.messages.payloads.CargoMessageSet$serialize()"></a>
<code><span class="keyword">fun </span><span class="identifier">serialize</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html"><span class="identifier">ByteArray</span></a></code>
<h1>serializePlaintext</h1>
<a name="tech.relaycorp.relaynet.messages.payloads.CargoMessageSet$serializePlaintext()"></a>
<code><span class="keyword">fun </span><span class="identifier">serializePlaintext</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html"><span class="identifier">ByteArray</span></a></code>
<p>Serialize cargo message set.</p>
</BODY>
</HTML>

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>EmptyPayload.<init> - relaynet</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">relaynet</a>&nbsp;/&nbsp;<a href="../index.html">tech.relaycorp.relaynet.messages.payloads</a>&nbsp;/&nbsp;<a href="index.html">EmptyPayload</a>&nbsp;/&nbsp;<a href="./-init-.html">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<a name="tech.relaycorp.relaynet.messages.payloads.EmptyPayload$&lt;init&gt;()"></a>
<code><span class="identifier">EmptyPayload</span><span class="symbol">(</span><span class="symbol">)</span></code>
<p>Empty payload plaintext.</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>EmptyPayload.deserialize - relaynet</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">relaynet</a>&nbsp;/&nbsp;<a href="../index.html">tech.relaycorp.relaynet.messages.payloads</a>&nbsp;/&nbsp;<a href="index.html">EmptyPayload</a>&nbsp;/&nbsp;<a href="./deserialize.html">deserialize</a><br/>
<br/>
<h1>deserialize</h1>
<a name="tech.relaycorp.relaynet.messages.payloads.EmptyPayload.Companion$deserialize(kotlin.ByteArray)"></a>
<code><span class="keyword">fun </span><span class="identifier">deserialize</span><span class="symbol">(</span><span class="identifier" id="tech.relaycorp.relaynet.messages.payloads.EmptyPayload.Companion$deserialize(kotlin.ByteArray)/serialization">serialization</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html"><span class="identifier">ByteArray</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">EmptyPayload</span></a></code>
<p>Deserialize empty payload plaintext.</p>
<h3>Exceptions</h3>
<p><a name="RAMFException"></a>
<code>RAMFException</code> - if <code>serialization</code> is not empty</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>EmptyPayload - relaynet</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">relaynet</a>&nbsp;/&nbsp;<a href="../index.html">tech.relaycorp.relaynet.messages.payloads</a>&nbsp;/&nbsp;<a href="./index.html">EmptyPayload</a><br/>
<br/>
<h1>EmptyPayload</h1>
<code><span class="keyword">class </span><span class="identifier">EmptyPayload</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-unencrypted-payload/index.html"><span class="identifier">UnencryptedPayload</span></a></code>
<p>Empty payload plaintext.</p>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="-init-.html">&lt;init&gt;</a></h4>
</td>
<td>
<p>Empty payload plaintext.</p>
<code><span class="identifier">EmptyPayload</span><span class="symbol">(</span><span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="serialize-plaintext.html">serializePlaintext</a></h4>
</td>
<td>
<p>Serialize empty payload plaintext.</p>
<code><span class="keyword">fun </span><span class="identifier">serializePlaintext</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html"><span class="identifier">ByteArray</span></a></code></td>
</tr>
</tbody>
</table>
<h3>Companion Object Functions</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="deserialize.html">deserialize</a></h4>
</td>
<td>
<p>Deserialize empty payload plaintext.</p>
<code><span class="keyword">fun </span><span class="identifier">deserialize</span><span class="symbol">(</span><span class="identifier" id="tech.relaycorp.relaynet.messages.payloads.EmptyPayload.Companion$deserialize(kotlin.ByteArray)/serialization">serialization</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html"><span class="identifier">ByteArray</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">EmptyPayload</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>EmptyPayload.serializePlaintext - relaynet</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">relaynet</a>&nbsp;/&nbsp;<a href="../index.html">tech.relaycorp.relaynet.messages.payloads</a>&nbsp;/&nbsp;<a href="index.html">EmptyPayload</a>&nbsp;/&nbsp;<a href="./serialize-plaintext.html">serializePlaintext</a><br/>
<br/>
<h1>serializePlaintext</h1>
<a name="tech.relaycorp.relaynet.messages.payloads.EmptyPayload$serializePlaintext()"></a>
<code><span class="keyword">fun </span><span class="identifier">serializePlaintext</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html"><span class="identifier">ByteArray</span></a></code>
<p>Serialize empty payload plaintext.</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>EncryptedPayload.<init> - relaynet</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">relaynet</a>&nbsp;/&nbsp;<a href="../index.html">tech.relaycorp.relaynet.messages.payloads</a>&nbsp;/&nbsp;<a href="index.html">EncryptedPayload</a>&nbsp;/&nbsp;<a href="./-init-.html">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<a name="tech.relaycorp.relaynet.messages.payloads.EncryptedPayload$&lt;init&gt;()"></a>
<code><span class="identifier">EncryptedPayload</span><span class="symbol">(</span><span class="symbol">)</span></code>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>EncryptedPayload.encrypt - relaynet</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">relaynet</a>&nbsp;/&nbsp;<a href="../index.html">tech.relaycorp.relaynet.messages.payloads</a>&nbsp;/&nbsp;<a href="index.html">EncryptedPayload</a>&nbsp;/&nbsp;<a href="./encrypt.html">encrypt</a><br/>
<br/>
<h1>encrypt</h1>
<a name="tech.relaycorp.relaynet.messages.payloads.EncryptedPayload$encrypt(tech.relaycorp.relaynet.wrappers.x509.Certificate, tech.relaycorp.relaynet.SymmetricEncryption)"></a>
<code><span class="keyword">fun </span><span class="identifier">encrypt</span><span class="symbol">(</span><span class="identifier" id="tech.relaycorp.relaynet.messages.payloads.EncryptedPayload$encrypt(tech.relaycorp.relaynet.wrappers.x509.Certificate, tech.relaycorp.relaynet.SymmetricEncryption)/recipientCertificate">recipientCertificate</span><span class="symbol">:</span>&nbsp;<a href="../../tech.relaycorp.relaynet.wrappers.x509/-certificate/index.html"><span class="identifier">Certificate</span></a><span class="symbol">, </span><span class="identifier" id="tech.relaycorp.relaynet.messages.payloads.EncryptedPayload$encrypt(tech.relaycorp.relaynet.wrappers.x509.Certificate, tech.relaycorp.relaynet.SymmetricEncryption)/symmetricEncryptionAlgorithm">symmetricEncryptionAlgorithm</span><span class="symbol">:</span>&nbsp;<a href="../../tech.relaycorp.relaynet/-symmetric-encryption/index.html"><span class="identifier">SymmetricEncryption</span></a>&nbsp;<span class="symbol">=</span>&nbsp;SymmetricEncryption.AES_128<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html"><span class="identifier">ByteArray</span></a></code>
</BODY>
</HTML>
Loading

0 comments on commit 7d053fe

Please sign in to comment.