aboutsummaryrefslogtreecommitdiff
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
parentf8b0eebe4a72bb71239edd7e874385d003252e4c (diff)
downloadnoise-f459c99bf33a0c0d3f9f678a3c46d6056d07d146.tar.gz
noise-f459c99bf33a0c0d3f9f678a3c46d6056d07d146.zip
Rename package to noise
-rw-r--r--README.md46
-rw-r--r--cipher.go2
-rw-r--r--dh.go2
-rw-r--r--example_test.go54
-rw-r--r--go.mod2
-rw-r--r--hkdf.go4
-rw-r--r--noise.go5
-rw-r--r--noise_test.go52
-rw-r--r--symmetric_state.go2
9 files changed, 84 insertions, 85 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},
)
```
diff --git a/cipher.go b/cipher.go
index 6b0266e..ab2d0eb 100644
--- a/cipher.go
+++ b/cipher.go
@@ -1,4 +1,4 @@
-package noisehandshake
+package noise
import (
"crypto/cipher"
diff --git a/dh.go b/dh.go
index b2180b8..0059c70 100644
--- a/dh.go
+++ b/dh.go
@@ -1,4 +1,4 @@
-package noisehandshake
+package noise
import (
"crypto/rand"
diff --git a/example_test.go b/example_test.go
index e0d52c4..f44c3ab 100644
--- a/example_test.go
+++ b/example_test.go
@@ -1,28 +1,28 @@
-package noisehandshake_test
+package noise_test
import (
"fmt"
"log"
- nhs "github.com/tetsuo/noisehandshake"
+ "github.com/tetsuo/noise"
)
// Example demonstrates a basic XX handshake pattern.
func Example() {
// Create initiator and responder
- initiator, err := nhs.NewNoiseState(
- nhs.PatternXX,
+ initiator, err := noise.NewNoiseState(
+ noise.PatternXX,
true,
- &nhs.Config{},
+ &noise.Config{},
)
if err != nil {
log.Fatal(err)
}
- responder, err := nhs.NewNoiseState(
- nhs.PatternXX,
+ responder, err := noise.NewNoiseState(
+ noise.PatternXX,
false,
- &nhs.Config{},
+ &noise.Config{},
)
if err != nil {
log.Fatal(err)
@@ -70,16 +70,16 @@ func Example() {
func Example_psk() {
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},
)
prologue := []byte("PSK Demo")
@@ -103,18 +103,18 @@ func Example_psk() {
// Example_ik demonstrates IK pattern with pre-known responder key.
func Example_ik() {
// Responder has a known static key
- responder, _ := nhs.NewNoiseState(
- nhs.PatternIK,
+ responder, _ := noise.NewNoiseState(
+ noise.PatternIK,
false,
- &nhs.Config{},
+ &noise.Config{},
)
responderPublicKey := responder.StaticPublicKey()
// Initiator knows responder's key in advance
- initiator, _ := nhs.NewNoiseState(
- nhs.PatternIK,
+ initiator, _ := noise.NewNoiseState(
+ noise.PatternIK,
true,
- &nhs.Config{},
+ &noise.Config{},
)
prologue := []byte("IK Demo")
@@ -135,23 +135,23 @@ func Example_ik() {
// Example_customKeys demonstrates using custom static keypairs.
func Example_customKeys() {
- curve := nhs.DefaultCurve
+ curve := noise.DefaultCurve
// Generate static keypairs
initiatorStatic, _ := curve.GenerateKeyPair(nil)
responderStatic, _ := curve.GenerateKeyPair(nil)
// Create states with custom keys
- initiator, _ := nhs.NewNoiseState(
- nhs.PatternXX,
+ initiator, _ := noise.NewNoiseState(
+ noise.PatternXX,
true,
- &nhs.Config{StaticKeypair: initiatorStatic},
+ &noise.Config{StaticKeypair: initiatorStatic},
)
- responder, _ := nhs.NewNoiseState(
- nhs.PatternXX,
+ responder, _ := noise.NewNoiseState(
+ noise.PatternXX,
false,
- &nhs.Config{StaticKeypair: responderStatic},
+ &noise.Config{StaticKeypair: responderStatic},
)
prologue := []byte{}
diff --git a/go.mod b/go.mod
index 331580d..85453b4 100644
--- a/go.mod
+++ b/go.mod
@@ -1,4 +1,4 @@
-module github.com/tetsuo/noisehandshake
+module github.com/tetsuo/noise
go 1.25.0
diff --git a/hkdf.go b/hkdf.go
index 264821f..1176e5e 100644
--- a/hkdf.go
+++ b/hkdf.go
@@ -1,4 +1,4 @@
-package noisehandshake
+package noise
import (
"crypto/hmac"
@@ -16,7 +16,7 @@ const (
func newBLAKE2b512() hash.Hash {
h, err := blake2b.New512(nil)
if err != nil {
- panic(fmt.Sprintf("noisehandshake: could not create BLAKE2b-512 hash: %v", err))
+ panic(fmt.Sprintf("noise: could not create BLAKE2b-512 hash: %v", err))
}
return h
}
diff --git a/noise.go b/noise.go
index 0ba6f73..ad70e11 100644
--- a/noise.go
+++ b/noise.go
@@ -1,6 +1,5 @@
-// Package noisehandshake implements cryptographic handshake patterns as defined
-// in the Noise Protocol Framework.
-package noisehandshake
+// Package noise implements the Noise Protocol Framework.
+package noise
import (
"bytes"
diff --git a/noise_test.go b/noise_test.go
index 6fc5f5a..29bce82 100644
--- a/noise_test.go
+++ b/noise_test.go
@@ -1,23 +1,23 @@
-package noisehandshake_test
+package noise_test
import (
"bytes"
"testing"
- nhs "github.com/tetsuo/noisehandshake"
+ "github.com/tetsuo/noise"
)
func TestBasicHandshakeXX(t *testing.T) {
// Create initiator
- initiatorConfig := &nhs.Config{}
- initiator, err := nhs.NewNoiseState(nhs.PatternXX, true, initiatorConfig)
+ initiatorConfig := &noise.Config{}
+ initiator, err := noise.NewNoiseState(noise.PatternXX, true, initiatorConfig)
if err != nil {
t.Fatalf("Failed to create initiator: %v", err)
}
// Create responder
- responderConfig := &nhs.Config{}
- responder, err := nhs.NewNoiseState(nhs.PatternXX, false, responderConfig)
+ responderConfig := &noise.Config{}
+ responder, err := noise.NewNoiseState(noise.PatternXX, false, responderConfig)
if err != nil {
t.Fatalf("Failed to create responder: %v", err)
}
@@ -102,12 +102,12 @@ func TestBasicHandshakeXX(t *testing.T) {
func TestHandshakeWithPayloadXX(t *testing.T) {
// Create initiator and responder
- initiator, err := nhs.NewNoiseState(nhs.PatternXX, true, &nhs.Config{})
+ initiator, err := noise.NewNoiseState(noise.PatternXX, true, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create initiator: %v", err)
}
- responder, err := nhs.NewNoiseState(nhs.PatternXX, false, &nhs.Config{})
+ responder, err := noise.NewNoiseState(noise.PatternXX, false, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create responder: %v", err)
}
@@ -169,12 +169,12 @@ func TestHandshakeWithPayloadXX(t *testing.T) {
func TestTransportMessagesXX(t *testing.T) {
// Complete a handshake
- initiator, err := nhs.NewNoiseState(nhs.PatternXX, true, &nhs.Config{})
+ initiator, err := noise.NewNoiseState(noise.PatternXX, true, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create initiator: %v", err)
}
- responder, err := nhs.NewNoiseState(nhs.PatternXX, false, &nhs.Config{})
+ responder, err := noise.NewNoiseState(noise.PatternXX, false, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create responder: %v", err)
}
@@ -231,12 +231,12 @@ func TestTransportMessagesXX(t *testing.T) {
}
func TestNNPattern(t *testing.T) {
- initiator, err := nhs.NewNoiseState(nhs.PatternNN, true, &nhs.Config{})
+ initiator, err := noise.NewNoiseState(noise.PatternNN, true, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create initiator: %v", err)
}
- responder, err := nhs.NewNoiseState(nhs.PatternNN, false, &nhs.Config{})
+ responder, err := noise.NewNoiseState(noise.PatternNN, false, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create responder: %v", err)
}
@@ -279,12 +279,12 @@ func TestNNPattern(t *testing.T) {
func TestPSKHandshakeXXpsk0(t *testing.T) {
psk := []byte("my-shared-secret-key-32-bytes!!!")
- initiator, err := nhs.NewNoiseState(nhs.PatternXXpsk0, true, &nhs.Config{PSK: psk})
+ initiator, err := noise.NewNoiseState(noise.PatternXXpsk0, true, &noise.Config{PSK: psk})
if err != nil {
t.Fatalf("Failed to create initiator: %v", err)
}
- responder, err := nhs.NewNoiseState(nhs.PatternXXpsk0, false, &nhs.Config{PSK: psk})
+ responder, err := noise.NewNoiseState(noise.PatternXXpsk0, false, &noise.Config{PSK: psk})
if err != nil {
t.Fatalf("Failed to create responder: %v", err)
}
@@ -328,14 +328,14 @@ func TestPSKHandshakeXXpsk0(t *testing.T) {
func TestIKPattern(t *testing.T) {
// Responder generates static key in advance
- responder, err := nhs.NewNoiseState(nhs.PatternIK, false, &nhs.Config{})
+ responder, err := noise.NewNoiseState(noise.PatternIK, false, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create responder: %v", err)
}
responderStaticPub := responder.StaticPublicKey()
// Initiator knows responder's static public key
- initiator, err := nhs.NewNoiseState(nhs.PatternIK, true, &nhs.Config{})
+ initiator, err := noise.NewNoiseState(noise.PatternIK, true, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create initiator: %v", err)
}
@@ -376,13 +376,13 @@ func TestIKPattern(t *testing.T) {
func TestXKPattern(t *testing.T) {
// Responder has a known static key; initiator knows it in advance
- responder, err := nhs.NewNoiseState(nhs.PatternXK, false, &nhs.Config{})
+ responder, err := noise.NewNoiseState(noise.PatternXK, false, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create responder: %v", err)
}
responderStaticPub := responder.StaticPublicKey()
- initiator, err := nhs.NewNoiseState(nhs.PatternXK, true, &nhs.Config{})
+ initiator, err := noise.NewNoiseState(noise.PatternXK, true, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create initiator: %v", err)
}
@@ -447,11 +447,11 @@ func TestXKPattern(t *testing.T) {
func TestNNpsk0Pattern(t *testing.T) {
psk := []byte("nNpsk0-shared-secret-32-bytes!!!")
- initiator, err := nhs.NewNoiseState(nhs.PatternNNpsk0, true, &nhs.Config{PSK: psk})
+ initiator, err := noise.NewNoiseState(noise.PatternNNpsk0, true, &noise.Config{PSK: psk})
if err != nil {
t.Fatalf("Failed to create initiator: %v", err)
}
- responder, err := nhs.NewNoiseState(nhs.PatternNNpsk0, false, &nhs.Config{PSK: psk})
+ responder, err := noise.NewNoiseState(noise.PatternNNpsk0, false, &noise.Config{PSK: psk})
if err != nil {
t.Fatalf("Failed to create responder: %v", err)
}
@@ -490,11 +490,11 @@ func TestNNpsk0Pattern(t *testing.T) {
func TestRemoteStaticPublicKey(t *testing.T) {
// After an XX handshake, each side should know the other's static public key
- initiator, err := nhs.NewNoiseState(nhs.PatternXX, true, &nhs.Config{})
+ initiator, err := noise.NewNoiseState(noise.PatternXX, true, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create initiator: %v", err)
}
- responder, err := nhs.NewNoiseState(nhs.PatternXX, false, &nhs.Config{})
+ responder, err := noise.NewNoiseState(noise.PatternXX, false, &noise.Config{})
if err != nil {
t.Fatalf("Failed to create responder: %v", err)
}
@@ -524,8 +524,8 @@ func TestRemoteStaticPublicKey(t *testing.T) {
}
func TestSendAfterComplete(t *testing.T) {
- initiator, _ := nhs.NewNoiseState(nhs.PatternNN, true, &nhs.Config{})
- responder, _ := nhs.NewNoiseState(nhs.PatternNN, false, &nhs.Config{})
+ initiator, _ := noise.NewNoiseState(noise.PatternNN, true, &noise.Config{})
+ responder, _ := noise.NewNoiseState(noise.PatternNN, false, &noise.Config{})
initiator.Initialize(nil, nil)
responder.Initialize(nil, nil)
@@ -544,13 +544,13 @@ func TestSendAfterComplete(t *testing.T) {
}
func TestPSKInvalidLength(t *testing.T) {
- _, err := nhs.NewNoiseState(nhs.PatternXXpsk0, true, &nhs.Config{PSK: []byte("short")})
+ _, err := noise.NewNoiseState(noise.PatternXXpsk0, true, &noise.Config{PSK: []byte("short")})
if err == nil {
t.Error("Expected error for PSK shorter than 32 bytes")
}
longPSK := make([]byte, 33)
- _, err = nhs.NewNoiseState(nhs.PatternXXpsk0, true, &nhs.Config{PSK: longPSK})
+ _, err = noise.NewNoiseState(noise.PatternXXpsk0, true, &noise.Config{PSK: longPSK})
if err == nil {
t.Error("Expected error for PSK longer than 32 bytes")
}
diff --git a/symmetric_state.go b/symmetric_state.go
index 13ac4cc..f46c9a7 100644
--- a/symmetric_state.go
+++ b/symmetric_state.go
@@ -1,4 +1,4 @@
-package noisehandshake
+package noise
// symmetricState extends CipherState with hashing and key derivation.
type symmetricState struct {