diff --git a/Noise/Noise.csproj b/Noise/Noise.csproj index c97621c..33bbb1f 100644 --- a/Noise/Noise.csproj +++ b/Noise/Noise.csproj @@ -6,7 +6,7 @@ true Noise.NET Noise.NET - 0.9.7-rc + 0.9.8-rc Nemanja Mijailovic https://github.com/Metalnem/noise https://github.com/Metalnem/noise diff --git a/README.md b/README.md index 9a96c6a..cb45d4b 100644 --- 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 index d8f58d4..7520516 100644 --- a/docs/api/Noise.HandshakeState.html +++ b/docs/api/Noise.HandshakeState.html @@ -207,20 +207,21 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source -

Fallback(CipherFunction, HashFunction)

-

Converts an Alice-initiated pattern to a Bob-initiated -XX pattern. Original PSK modifiers will not be preserved.

+

Fallback(Protocol, ProtocolConfig)

+

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.

Declaration
- 
void Fallback(CipherFunction cipher = null, HashFunction hash = null)
+ 
void Fallback(Protocol protocol, ProtocolConfig config)
Parameters
@@ -233,17 +234,15 @@
Parameters
- - - + + - - - + + @@ -260,13 +259,23 @@
Exceptions
+ + + + + + + + - @@ -276,7 +285,7 @@
Exceptions
Improve this Doc - View Source + View Source

ReadMessage(ReadOnlySpan<Byte>, Span<Byte>)

@@ -373,7 +382,7 @@
Exceptions
Improve this Doc - View Source + View Source

WriteMessage(ReadOnlySpan<Byte>, Span<Byte>)

diff --git a/docs/api/Noise.Protocol.html b/docs/api/Noise.Protocol.html index 417bd9a..876b61d 100644 --- a/docs/api/Noise.Protocol.html +++ b/docs/api/Noise.Protocol.html @@ -677,7 +677,7 @@
Exceptions

- One or more pre-shared keys are not 32 bytes in length.

- Number of pre-shared keys does not match the number of PSK modifiers.

- Fallback modifier is present (fallback can only be applied by calling -the Fallback(CipherFunction, HashFunction) method on existing handshake state).

+the Fallback(Protocol, ProtocolConfig) method on existing handshake state).

diff --git a/docs/index.html b/docs/index.html index b3aaa07..ad71c47 100644 --- a/docs/index.html +++ b/docs/index.html @@ -129,7 +129,7 @@

Usage

See Noise.Examples 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/manifest.json b/docs/manifest.json
index 9858fd4..d093510 100644
--- 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
index 659f8fc..8a63abc 100644
--- 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
index 2eee8ab..dadbabf 100644
--- 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
 ```
CipherFunctioncipher

The cipher function (AESGCM or ChaChaPoly). -If it's null, the original cipher function will be used.

+ 		Protocolprotocol

A concrete Noise protocol (e.g. Noise_XXfallback_25519_AESGCM_BLAKE2b).
HashFunctionhash

The hash function (SHA256, SHA512, BLAKE2s, or BLAKE2b). -If it's null, the original hash function will be used.

+ 		ProtocolConfigconfig

A set of parameters used to instantiate a HandshakeState.
System.ObjectDisposedException

Thrown if the current instance has already been disposed.

+
System.ArgumentNullException

Thrown if either protocol or config is null.

+
System.ArgumentException

Thrown if protocol is not XXfallback, +or if the provided local static private key is empty.
System.InvalidOperationException

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.

+

Throw if the initial handshake pattern is Bob-initiated, or if this +method was not called immediately after the first handshake message.