Skip to content

Commit

Permalink
Dev (#13)
Browse files Browse the repository at this point in the history
+ Added `BinaryPayloadContainer`, `IBinaryPayloadContainer` and `SignedBinaryPayload`
+ Updated references
  • Loading branch information
nd1012 authored May 27, 2023
1 parent eb10e5c commit e7d1b23
Show file tree
Hide file tree
Showing 19 changed files with 2,396 additions and 18 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@ method will throw an exception.

**NOTE**: AES-256 and SHA-384+ (and HMAC-SHA-384+) are considered to be post
quantum safe algorithms, while currently no post quantum-safe asymmetric
algorithms are implemented.
algorithms are implemented in this main library (`wan24-Crypto-BC` does).

## Disclaimer

Expand Down
12 changes: 12 additions & 0 deletions docs/api/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@
<li>
<a href="wan24.Crypto.AsymmetricSignedPublicKey.SignedPublicKeyStoreAsync_Delegate.html" name="" title="AsymmetricSignedPublicKey.SignedPublicKeyStoreAsync_Delegate">AsymmetricSignedPublicKey.SignedPublicKeyStoreAsync_Delegate</a>
</li>
<li>
<a href="wan24.Crypto.BinaryPayloadContainer.html" name="" title="BinaryPayloadContainer">BinaryPayloadContainer</a>
</li>
<li>
<a href="wan24.Crypto.CryptoAlgorithmBase.html" name="" title="CryptoAlgorithmBase">CryptoAlgorithmBase</a>
</li>
Expand Down Expand Up @@ -179,6 +182,9 @@
<li>
<a href="wan24.Crypto.IAsymmetricPublicKey.html" name="" title="IAsymmetricPublicKey">IAsymmetricPublicKey</a>
</li>
<li>
<a href="wan24.Crypto.IBinaryPayloadContainer.html" name="" title="IBinaryPayloadContainer">IBinaryPayloadContainer</a>
</li>
<li>
<a href="wan24.Crypto.ICryptoAlgorithm.html" name="" title="ICryptoAlgorithm">ICryptoAlgorithm</a>
</li>
Expand Down Expand Up @@ -245,6 +251,12 @@
<li>
<a href="wan24.Crypto.SignatureContainer.html" name="" title="SignatureContainer">SignatureContainer</a>
</li>
<li>
<a href="wan24.Crypto.SignedBinaryPayload.html" name="" title="SignedBinaryPayload">SignedBinaryPayload</a>
</li>
<li>
<a href="wan24.Crypto.SignedBinaryPayload-1.html" name="" title="SignedBinaryPayload&lt;T&gt;">SignedBinaryPayload&lt;T&gt;</a>
</li>
<li>
<a href="wan24.Crypto.SignedPayload-1.html" name="" title="SignedPayload&lt;T&gt;">SignedPayload&lt;T&gt;</a>
</li>
Expand Down
862 changes: 862 additions & 0 deletions docs/api/wan24.Crypto.BinaryPayloadContainer.html

Large diffs are not rendered by default.

246 changes: 246 additions & 0 deletions docs/api/wan24.Crypto.IBinaryPayloadContainer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,246 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IBinaryPayloadContainer
| wan24-Crypto </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IBinaryPayloadContainer
| wan24-Crypto ">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">


<meta property="docfx:newtab" content="true">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="wan24.Crypto.IBinaryPayloadContainer">


<h1 id="wan24_Crypto_IBinaryPayloadContainer" data-uid="wan24.Crypto.IBinaryPayloadContainer" class="text-break">Interface IBinaryPayloadContainer
</h1>
<div class="markdown level0 summary"><p>Interface for a binary payload container</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">wan24.StreamSerializerExtensions.IStreamSerializerVersion.ObjectVersion</span>
</div>
<div>
<span class="xref">wan24.StreamSerializerExtensions.IStreamSerializerVersion.SerializedObjectVersion</span>
</div>
<div>
<span class="xref">wan24.StreamSerializerExtensions.IStreamSerializerVersion.SerializerVersion</span>
</div>
<div>
<span class="xref">wan24.StreamSerializerExtensions.IStreamSerializer.Serialize(System.IO.Stream)</span>
</div>
<div>
<span class="xref">wan24.StreamSerializerExtensions.IStreamSerializer.SerializeAsync(System.IO.Stream, System.Threading.CancellationToken)</span>
</div>
<div>
<span class="xref">wan24.StreamSerializerExtensions.IStreamSerializer.Deserialize(System.IO.Stream, System.Int32)</span>
</div>
<div>
<span class="xref">wan24.StreamSerializerExtensions.IStreamSerializer.DeserializeAsync(System.IO.Stream, System.Int32, System.Threading.CancellationToken)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="wan24.Crypto.html">wan24.Crypto</a></h6>
<h6><strong>Assembly</strong>: wan24Crypto.dll</h6>
<h5 id="wan24_Crypto_IBinaryPayloadContainer_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IBinaryPayloadContainer : IStreamSerializerVersion, IStreamSerializer</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/nd1012/wan24-Crypto/new/dev/apiSpec/new?filename=wan24_Crypto_IBinaryPayloadContainer_MaxPayloadLength.md&amp;value=---%0Auid%3A%20wan24.Crypto.IBinaryPayloadContainer.MaxPayloadLength%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/blob/dev/src/wan24-Crypto/IBinaryPayloadContainer.cs/#L17">View Source</a>
</span>
<a id="wan24_Crypto_IBinaryPayloadContainer_MaxPayloadLength_" data-uid="wan24.Crypto.IBinaryPayloadContainer.MaxPayloadLength*"></a>
<h4 id="wan24_Crypto_IBinaryPayloadContainer_MaxPayloadLength" data-uid="wan24.Crypto.IBinaryPayloadContainer.MaxPayloadLength">MaxPayloadLength</h4>
<div class="markdown level1 summary"><p>Maximum payload length in bytes</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">int MaxPayloadLength { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/nd1012/wan24-Crypto/new/dev/apiSpec/new?filename=wan24_Crypto_IBinaryPayloadContainer_MinPayloadLength.md&amp;value=---%0Auid%3A%20wan24.Crypto.IBinaryPayloadContainer.MinPayloadLength%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/blob/dev/src/wan24-Crypto/IBinaryPayloadContainer.cs/#L13">View Source</a>
</span>
<a id="wan24_Crypto_IBinaryPayloadContainer_MinPayloadLength_" data-uid="wan24.Crypto.IBinaryPayloadContainer.MinPayloadLength*"></a>
<h4 id="wan24_Crypto_IBinaryPayloadContainer_MinPayloadLength" data-uid="wan24.Crypto.IBinaryPayloadContainer.MinPayloadLength">MinPayloadLength</h4>
<div class="markdown level1 summary"><p>Minimum payload length in bytes</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">int MinPayloadLength { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/nd1012/wan24-Crypto/new/dev/apiSpec/new?filename=wan24_Crypto_IBinaryPayloadContainer_Payload.md&amp;value=---%0Auid%3A%20wan24.Crypto.IBinaryPayloadContainer.Payload%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/blob/dev/src/wan24-Crypto/IBinaryPayloadContainer.cs/#L21">View Source</a>
</span>
<a id="wan24_Crypto_IBinaryPayloadContainer_Payload_" data-uid="wan24.Crypto.IBinaryPayloadContainer.Payload*"></a>
<h4 id="wan24_Crypto_IBinaryPayloadContainer_Payload" data-uid="wan24.Crypto.IBinaryPayloadContainer.Payload">Payload</h4>
<div class="markdown level1 summary"><p>Payload</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">byte[] Payload { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/nd1012/wan24-Crypto/new/dev/apiSpec/new?filename=wan24_Crypto_IBinaryPayloadContainer.md&amp;value=---%0Auid%3A%20wan24.Crypto.IBinaryPayloadContainer%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/nd1012/wan24-Crypto/blob/dev/src/wan24-Crypto/IBinaryPayloadContainer.cs/#L8" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
(c) 2023 Andreas Zimmermann, wan24.de

</div>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Loading

0 comments on commit e7d1b23

Please sign in to comment.