Bump the version

Metalnem · May 13, 2018 · 85febbe · 85febbe
1 parent b095488
commit 85febbe
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 40 deletions.
diff --git a/Noise/Noise.csproj b/Noise/Noise.csproj
@@ -6,7 +6,7 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageId>Noise.NET</PackageId>
     <Title>Noise.NET</Title>
-    <PackageVersion>0.9.7-rc</PackageVersion>
+    <PackageVersion>0.9.8-rc</PackageVersion>
     <Authors>Nemanja Mijailovic</Authors>
     <PackageProjectUrl>https://github.com/Metalnem/noise</PackageProjectUrl>
     <RepositoryUrl>https://github.com/Metalnem/noise</RepositoryUrl>

diff --git a/README.md b/README.md
@@ -73,5 +73,5 @@ for the complete example.
 ## Installation
 
 ```
-> dotnet add package Noise.NET --version 0.9.7-rc
+> dotnet add package Noise.NET --version 0.9.8-rc
 ```
diff --git a/docs/api/Noise.HandshakeState.html b/docs/api/Noise.HandshakeState.html
@@ -207,20 +207,21 @@ <h3 id="methods">Methods
   </h3>
   <span class="small pull-right mobile-hide">
     <span class="divider">|</span>
-    <a href="https://github.com/Metalnem/noise/new/master/apiSpec/new?filename=Noise_HandshakeState_Fallback_Noise_CipherFunction_Noise_HashFunction_.md&amp;value=---%0Auid%3A%20Noise.HandshakeState.Fallback(Noise.CipherFunction%2CNoise.HashFunction)%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>
+    <a href="https://github.com/Metalnem/noise/new/master/apiSpec/new?filename=Noise_HandshakeState_Fallback_Noise_Protocol_Noise_ProtocolConfig_.md&amp;value=---%0Auid%3A%20Noise.HandshakeState.Fallback(Noise.Protocol%2CNoise.ProtocolConfig)%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/Metalnem/noise/blob/master/Noise/HandshakeState.cs/#L45">View Source</a>
+    <a href="https://github.com/Metalnem/noise/blob/master/Noise/HandshakeState.cs/#L46">View Source</a>
   </span>
   <a id="Noise_HandshakeState_Fallback_" data-uid="Noise.HandshakeState.Fallback*"></a>
-  <h4 id="Noise_HandshakeState_Fallback_Noise_CipherFunction_Noise_HashFunction_" data-uid="Noise.HandshakeState.Fallback(Noise.CipherFunction,Noise.HashFunction)">Fallback(CipherFunction, HashFunction)</h4>
-  <div class="markdown level1 summary"><p>Converts an Alice-initiated pattern to a Bob-initiated
-XX pattern. Original PSK modifiers will not be preserved.</p>
+  <h4 id="Noise_HandshakeState_Fallback_Noise_Protocol_Noise_ProtocolConfig_" data-uid="Noise.HandshakeState.Fallback(Noise.Protocol,Noise.ProtocolConfig)">Fallback(Protocol, ProtocolConfig)</h4>
+  <div class="markdown level1 summary"><p>Converts an Alice-initiated pattern to a Bob-initiated pattern.
+The only fallback pattern currently supported is XXfallback.
+PSK modifiers are currently not supported with fallback protocols.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">void Fallback(CipherFunction cipher = null, HashFunction hash = null)</code></pre>
+    <pre><code class="lang-csharp hljs">void Fallback(Protocol protocol, ProtocolConfig config)</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -233,17 +234,15 @@ <h5 class="parameters">Parameters</h5>
     </thead>
     <tbody>
       <tr>
-        <td><a class="xref" href="Noise.CipherFunction.html">CipherFunction</a></td>
-        <td><span class="parametername">cipher</span></td>
-        <td><p>The cipher function (AESGCM or ChaChaPoly).
-If it's null, the original cipher function will be used.</p>
+        <td><a class="xref" href="Noise.Protocol.html">Protocol</a></td>
+        <td><span class="parametername">protocol</span></td>
+        <td><p>A concrete Noise protocol (e.g. Noise_XXfallback_25519_AESGCM_BLAKE2b).</p>
 </td>
       </tr>
       <tr>
-        <td><a class="xref" href="Noise.HashFunction.html">HashFunction</a></td>
-        <td><span class="parametername">hash</span></td>
-        <td><p>The hash function (SHA256, SHA512, BLAKE2s, or BLAKE2b).
-If it's null, the original hash function will be used.</p>
+        <td><a class="xref" href="Noise.ProtocolConfig.html">ProtocolConfig</a></td>
+        <td><span class="parametername">config</span></td>
+        <td><p>A set of parameters used to instantiate a <a class="xref" href="Noise.HandshakeState.html">HandshakeState</a>.</p>
 </td>
       </tr>
     </tbody>
@@ -260,13 +259,23 @@ <h5 class="exceptions">Exceptions</h5>
       <tr>
         <td><span class="xref">System.ObjectDisposedException</span></td>
         <td><p>Thrown if the current instance has already been disposed.</p>
+</td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.ArgumentNullException</span></td>
+        <td><p>Thrown if either <code data-dev-comment-type="paramref" class="paramref">protocol</code> or <code data-dev-comment-type="paramref" class="paramref">config</code> is null.</p>
+</td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.ArgumentException</span></td>
+        <td><p>Thrown if <code data-dev-comment-type="paramref" class="paramref">protocol</code> is not XXfallback,
+or if the provided local static private key is empty.</p>
 </td>
       </tr>
       <tr>
         <td><span class="xref">System.InvalidOperationException</span></td>
-        <td><p>Throw if the handshake pattern is Bob-initiated or one-way, if this
-method was not called immediately after the first handshake message,
-or if the local static private key is empty.</p>
+        <td><p>Throw if the initial handshake pattern is Bob-initiated, or if this
+method was not called immediately after the first handshake message.</p>
 </td>
       </tr>
     </tbody>
@@ -276,7 +285,7 @@ <h5 class="exceptions">Exceptions</h5>
     <a href="https://github.com/Metalnem/noise/new/master/apiSpec/new?filename=Noise_HandshakeState_ReadMessage_System_ReadOnlySpan_System_Byte__System_Span_System_Byte__.md&amp;value=---%0Auid%3A%20Noise.HandshakeState.ReadMessage(System.ReadOnlySpan%7BSystem.Byte%7D%2CSystem.Span%7BSystem.Byte%7D)%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/Metalnem/noise/blob/master/Noise/HandshakeState.cs/#L109">View Source</a>
+    <a href="https://github.com/Metalnem/noise/blob/master/Noise/HandshakeState.cs/#L110">View Source</a>
   </span>
   <a id="Noise_HandshakeState_ReadMessage_" data-uid="Noise.HandshakeState.ReadMessage*"></a>
   <h4 id="Noise_HandshakeState_ReadMessage_System_ReadOnlySpan_System_Byte__System_Span_System_Byte__" data-uid="Noise.HandshakeState.ReadMessage(System.ReadOnlySpan{System.Byte},System.Span{System.Byte})">ReadMessage(ReadOnlySpan&lt;Byte&gt;, Span&lt;Byte&gt;)</h4>
@@ -373,7 +382,7 @@ <h5 class="exceptions">Exceptions</h5>
     <a href="https://github.com/Metalnem/noise/new/master/apiSpec/new?filename=Noise_HandshakeState_WriteMessage_System_ReadOnlySpan_System_Byte__System_Span_System_Byte__.md&amp;value=---%0Auid%3A%20Noise.HandshakeState.WriteMessage(System.ReadOnlySpan%7BSystem.Byte%7D%2CSystem.Span%7BSystem.Byte%7D)%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/Metalnem/noise/blob/master/Noise/HandshakeState.cs/#L74">View Source</a>
+    <a href="https://github.com/Metalnem/noise/blob/master/Noise/HandshakeState.cs/#L75">View Source</a>
   </span>
   <a id="Noise_HandshakeState_WriteMessage_" data-uid="Noise.HandshakeState.WriteMessage*"></a>
   <h4 id="Noise_HandshakeState_WriteMessage_System_ReadOnlySpan_System_Byte__System_Span_System_Byte__" data-uid="Noise.HandshakeState.WriteMessage(System.ReadOnlySpan{System.Byte},System.Span{System.Byte})">WriteMessage(ReadOnlySpan&lt;Byte&gt;, Span&lt;Byte&gt;)</h4>

diff --git a/docs/api/Noise.Protocol.html b/docs/api/Noise.Protocol.html
@@ -677,7 +677,7 @@ <h5 class="exceptions">Exceptions</h5>
 <p>- One or more pre-shared keys are not 32 bytes in length.</p>
 <p>- Number of pre-shared keys does not match the number of PSK modifiers.</p>
 <p>- Fallback modifier is present (fallback can only be applied by calling
-the <a class="xref" href="Noise.HandshakeState.html#Noise_HandshakeState_Fallback_Noise_CipherFunction_Noise_HashFunction_">Fallback(CipherFunction, HashFunction)</a> method on existing handshake state).</p>
+the <a class="xref" href="Noise.HandshakeState.html#Noise_HandshakeState_Fallback_Noise_Protocol_Noise_ProtocolConfig_">Fallback(Protocol, ProtocolConfig)</a> method on existing handshake state).</p>
 </td>
       </tr>
     </tbody>

diff --git a/docs/index.html b/docs/index.html
@@ -129,7 +129,7 @@ <h2 id="usage">Usage</h2>
 <p>See <a href="https://github.com/Metalnem/noise/tree/master/Noise.Examples">Noise.Examples</a>
 for the complete example.</p>
 <h2 id="installation">Installation</h2>
-<pre><code>&gt; dotnet add package Noise.NET --version 0.9.7-rc
+<pre><code>&gt; dotnet add package Noise.NET --version 0.9.8-rc
 </code></pre>
 </article>
           </div>

diff --git a/docs/manifest.json b/docs/manifest.json
@@ -56,7 +56,7 @@
       "output": {
         ".html": {
           "relative_path": "api/Noise.HandshakeState.html",
-          "hash": "3k3ST6YBH7af+z3aU/WAlQ=="
+          "hash": "wUnJPR0qrmQcBx90Rzlg7A=="
         }
       },
       "is_incremental": false,
@@ -107,7 +107,7 @@
           "hash": "mJzYaUqJMvMqPxYVCVdSLQ=="
         }
       },
-      "is_incremental": false,
+      "is_incremental": true,
       "version": ""
     },
     {
@@ -128,7 +128,7 @@
       "output": {
         ".html": {
           "relative_path": "api/Noise.Protocol.html",
-          "hash": "fBqwGYm8uj2jWyDop57P0g=="
+          "hash": "YSCcflaUGh0j93212oGf7w=="
         }
       },
       "is_incremental": false,
@@ -188,7 +188,7 @@
       "output": {
         ".html": {
           "relative_path": "index.html",
-          "hash": "co/gfFUvbwc3mBLAegJhyQ=="
+          "hash": "cbs0Q336z93wg8Xy72jbcQ=="
         }
       },
       "is_incremental": false,
@@ -202,21 +202,21 @@
         "incrementalPhase": "build"
       },
       "processors": {
-        "TocDocumentProcessor": {
+        "ResourceDocumentProcessor": {
           "can_incremental": false,
-          "details": "Processor TocDocumentProcessor cannot suppport incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
+          "details": "Processor ResourceDocumentProcessor cannot suppport incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
           "incrementalPhase": "build"
         },
-        "ResourceDocumentProcessor": {
+        "TocDocumentProcessor": {
           "can_incremental": false,
-          "details": "Processor ResourceDocumentProcessor cannot suppport incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
+          "details": "Processor TocDocumentProcessor cannot suppport incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
           "incrementalPhase": "build"
         },
-        "ConceptualDocumentProcessor": {
+        "ManagedReferenceDocumentProcessor": {
           "can_incremental": true,
           "incrementalPhase": "build"
         },
-        "ManagedReferenceDocumentProcessor": {
+        "ConceptualDocumentProcessor": {
           "can_incremental": true,
           "incrementalPhase": "build"
         }

diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml
@@ -217,12 +217,12 @@ references:
   commentId: T:Noise.HandshakeState
   fullName: Noise.HandshakeState
   nameWithType: HandshakeState
-- uid: Noise.HandshakeState.Fallback(Noise.CipherFunction,Noise.HashFunction)
-  name: Fallback(CipherFunction, HashFunction)
-  href: api/Noise.HandshakeState.html#Noise_HandshakeState_Fallback_Noise_CipherFunction_Noise_HashFunction_
-  commentId: M:Noise.HandshakeState.Fallback(Noise.CipherFunction,Noise.HashFunction)
-  fullName: Noise.HandshakeState.Fallback(Noise.CipherFunction, Noise.HashFunction)
-  nameWithType: HandshakeState.Fallback(CipherFunction, HashFunction)
+- uid: Noise.HandshakeState.Fallback(Noise.Protocol,Noise.ProtocolConfig)
+  name: Fallback(Protocol, ProtocolConfig)
+  href: api/Noise.HandshakeState.html#Noise_HandshakeState_Fallback_Noise_Protocol_Noise_ProtocolConfig_
+  commentId: M:Noise.HandshakeState.Fallback(Noise.Protocol,Noise.ProtocolConfig)
+  fullName: Noise.HandshakeState.Fallback(Noise.Protocol, Noise.ProtocolConfig)
+  nameWithType: HandshakeState.Fallback(Protocol, ProtocolConfig)
 - uid: Noise.HandshakeState.Fallback*
   name: Fallback
   href: api/Noise.HandshakeState.html#Noise_HandshakeState_Fallback_

diff --git a/index.md b/index.md
@@ -77,5 +77,5 @@ for the complete example.
 ## Installation
 
 ```
-> dotnet add package Noise.NET --version 0.9.7-rc
+> dotnet add package Noise.NET --version 0.9.8-rc
 ```