aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOnur Gündüz <ogunduz@gmail.com>2026-03-11 17:04:59 +0100
committerOnur Gündüz <ogunduz@gmail.com>2026-03-11 17:04:59 +0100
commitf459c99bf33a0c0d3f9f678a3c46d6056d07d146 (patch)
tree8bfe0b907f19efe97bbe5103440ab7b7914c1e28 /README.md
parentf8b0eebe4a72bb71239edd7e874385d003252e4c (diff)
downloadnoise-f459c99bf33a0c0d3f9f678a3c46d6056d07d146.tar.gz
noise-f459c99bf33a0c0d3f9f678a3c46d6056d07d146.zip
Rename package to noise
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 23 insertions, 23 deletions
diff --git a/README.md b/README.md
index 9a78f5e..f8357e7 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-# noisehandshake
+# noise
-A pure Go implementation of the core [Noise Protocol](https://noiseprotocol.org/) handshake patterns.
+[Noise Protocol Framework](https://noiseprotocol.org/) implementation in Go.
-**Supported patterns**:
+**Supported handshake patterns**:
- **NN**: Basic ephemeral key exchange (no authentication)
- **XX**: Full mutual authentication with ephemeral and static keys
@@ -21,24 +21,24 @@ import (
"fmt"
"log"
- nhs "github.com/tetsuo/noisehandshake"
+ "github.com/tetsuo/noise"
)
func main() {
// Create initiator and responder
- initiator, err := nhs.NewNoiseState(
- nhs.PatternXX,
+ initiator, err := noise.NewNoiseState(
+ noise.PatternXX,
true, // initiator role
- &nhs.Config{},
+ &noise.Config{},
)
if err != nil {
log.Fatal(err)
}
- responder, err := nhs.NewNoiseState(
- nhs.PatternXX,
+ responder, err := noise.NewNoiseState(
+ noise.PatternXX,
false, // responder role
- &nhs.Config{},
+ &noise.Config{},
)
if err != nil {
log.Fatal(err)
@@ -93,16 +93,16 @@ func main() {
// Use a pre-shared key for authentication
psk := []byte("my-32-byte-pre-shared-key-here!!")
-initiator, _ := nhs.NewNoiseState(
- nhs.PatternXXpsk0,
+initiator, _ := noise.NewNoiseState(
+ noise.PatternXXpsk0,
true,
- &nhs.Config{PSK: psk},
+ &noise.Config{PSK: psk},
)
-responder, _ := nhs.NewNoiseState(
- nhs.PatternXXpsk0,
+responder, _ := noise.NewNoiseState(
+ noise.PatternXXpsk0,
false,
- &nhs.Config{PSK: psk},
+ &noise.Config{PSK: psk},
)
```
@@ -112,10 +112,10 @@ responder, _ := nhs.NewNoiseState(
// Responder's static public key is known in advance
responderStaticKey := getResponderPublicKey()
-initiator, _ := nhs.NewNoiseState(
- nhs.PatternIK,
+initiator, _ := noise.NewNoiseState(
+ noise.PatternIK,
true,
- &nhs.Config{},
+ &noise.Config{},
)
// Initialize with remote static key
@@ -126,7 +126,7 @@ initiator.Initialize(prologue, responderStaticKey)
```go
// Generate or load static keypair
-curve := nhs.DefaultCurve
+curve := noise.DefaultCurve
staticKeypair, _ := curve.GenerateKeyPair(nil)
// Or use a seed for deterministic keys
@@ -134,10 +134,10 @@ seed := make([]byte, 32)
// ... fill seed ...
staticKeypair, _ = curve.GenerateKeyPair(seed)
-initiator, _ := nhs.NewNoiseState(
- nhs.PatternXX,
+initiator, _ := noise.NewNoiseState(
+ noise.PatternXX,
true,
- &nhs.Config{StaticKeypair: staticKeypair},
+ &noise.Config{StaticKeypair: staticKeypair},
)
```