aboutsummaryrefslogtreecommitdiff
path: root/example_test.go
diff options
context:
space:
mode:
authorOnur Gündüz <ogunduz@gmail.com>2026-03-10 11:58:37 +0100
committerOnur Gündüz <ogunduz@gmail.com>2026-03-10 11:58:37 +0100
commit03b95111f19a93ccee00e8e8e0afaab8112f5484 (patch)
treec0bfd7c5c768b441c901645a5a9a83c533eaf56f /example_test.go
parentbcb40853f819cdbea99ec5d0ab2ee7594efd7690 (diff)
downloadnoise-03b95111f19a93ccee00e8e8e0afaab8112f5484.tar.gz
noise-03b95111f19a93ccee00e8e8e0afaab8112f5484.zip
Init package
Diffstat (limited to 'example_test.go')
-rw-r--r--example_test.go173
1 files changed, 173 insertions, 0 deletions
diff --git a/example_test.go b/example_test.go
new file mode 100644
index 0000000..46a81b3
--- /dev/null
+++ b/example_test.go
@@ -0,0 +1,173 @@
+package noisehandshake_test
+
+import (
+ "fmt"
+ "log"
+
+ nhs "github.com/tetsuo/noisehandshake"
+)
+
+// Example demonstrates a basic XX handshake pattern.
+func Example() {
+ // Create initiator and responder
+ initiator, err := nhs.NewNoiseState(
+ nhs.PatternXX,
+ true,
+ &nhs.Config{},
+ )
+ if err != nil {
+ log.Fatal(err)
+ }
+
+ responder, err := nhs.NewNoiseState(
+ nhs.PatternXX,
+ false,
+ &nhs.Config{},
+ )
+ if err != nil {
+ log.Fatal(err)
+ }
+
+ // Initialize with prologue
+ prologue := []byte("MyProtocol v1.0")
+ initiator.Initialize(prologue, nil)
+ responder.Initialize(prologue, nil)
+
+ // Perform handshake
+ // Message 1: initiator -> responder
+ msg1, _ := initiator.Send([]byte("Hello"))
+ payload1, _ := responder.Recv(msg1)
+ fmt.Printf("Responder received: %s\n", payload1)
+
+ // Message 2: responder -> initiator
+ msg2, _ := responder.Send([]byte("World"))
+ payload2, _ := initiator.Recv(msg2)
+ fmt.Printf("Initiator received: %s\n", payload2)
+
+ // Message 3: initiator -> responder (finalizes)
+ msg3, _ := initiator.Send(nil)
+ responder.Recv(msg3)
+
+ // Handshake complete
+ if initiator.IsComplete() && responder.IsComplete() {
+ fmt.Println("Handshake complete!")
+
+ // Use transport keys for encrypted communication
+ plaintext := []byte("Secret")
+ ciphertext, _ := initiator.GetTX().Encrypt(nil, plaintext, nil)
+ decrypted, _ := responder.GetRX().Decrypt(nil, ciphertext, nil)
+ fmt.Printf("Transport message: %s\n", decrypted)
+ }
+
+ // Output:
+ // Responder received: Hello
+ // Initiator received: World
+ // Handshake complete!
+ // Transport message: Secret
+}
+
+// ExamplePSK demonstrates PSK handshake.
+func Example_psk() {
+ psk := []byte("my-32-byte-pre-shared-key-here!!")
+
+ initiator, _ := nhs.NewNoiseState(
+ nhs.PatternXXpsk0,
+ true,
+ &nhs.Config{PSK: psk},
+ )
+
+ responder, _ := nhs.NewNoiseState(
+ nhs.PatternXXpsk0,
+ false,
+ &nhs.Config{PSK: psk},
+ )
+
+ prologue := []byte("PSK Demo")
+ initiator.Initialize(prologue, nil)
+ responder.Initialize(prologue, nil)
+
+ // Complete handshake
+ msg1, _ := initiator.Send(nil)
+ responder.Recv(msg1)
+ msg2, _ := responder.Send(nil)
+ initiator.Recv(msg2)
+ msg3, _ := initiator.Send(nil)
+ responder.Recv(msg3)
+
+ fmt.Printf("PSK handshake complete: %v\n", initiator.IsComplete())
+
+ // Output:
+ // PSK handshake complete: true
+}
+
+// Example_ik demonstrates IK pattern with pre-known responder key.
+func Example_ik() {
+ // Responder has a known static key
+ responder, _ := nhs.NewNoiseState(
+ nhs.PatternIK,
+ false,
+ &nhs.Config{},
+ )
+ responderPublicKey := responder.GetStaticPublicKey()
+
+ // Initiator knows responder's key in advance
+ initiator, _ := nhs.NewNoiseState(
+ nhs.PatternIK,
+ true,
+ &nhs.Config{},
+ )
+
+ prologue := []byte("IK Demo")
+ initiator.Initialize(prologue, responderPublicKey)
+ responder.Initialize(prologue, nil)
+
+ // Complete 2-message handshake
+ msg1, _ := initiator.Send(nil)
+ responder.Recv(msg1)
+ msg2, _ := responder.Send(nil)
+ initiator.Recv(msg2)
+
+ fmt.Printf("IK handshake complete: %v\n", initiator.IsComplete())
+
+ // Output:
+ // IK handshake complete: true
+}
+
+// Example_customKeys demonstrates using custom static keypairs.
+func Example_customKeys() {
+ curve := nhs.DefaultCurve
+
+ // Generate static keypairs
+ initiatorStatic, _ := curve.GenerateKeyPair(nil)
+ responderStatic, _ := curve.GenerateKeyPair(nil)
+
+ // Create states with custom keys
+ initiator, _ := nhs.NewNoiseState(
+ nhs.PatternXX,
+ true,
+ &nhs.Config{StaticKeypair: initiatorStatic},
+ )
+
+ responder, _ := nhs.NewNoiseState(
+ nhs.PatternXX,
+ false,
+ &nhs.Config{StaticKeypair: responderStatic},
+ )
+
+ prologue := []byte{}
+ initiator.Initialize(prologue, nil)
+ responder.Initialize(prologue, nil)
+
+ // Complete handshake
+ msg1, _ := initiator.Send(nil)
+ responder.Recv(msg1)
+ msg2, _ := responder.Send(nil)
+ initiator.Recv(msg2)
+ msg3, _ := initiator.Send(nil)
+ responder.Recv(msg3)
+
+ fmt.Printf("Custom keys handshake: %v\n", initiator.IsComplete())
+
+ // Output:
+ // Custom keys handshake: true
+}