aboutsummaryrefslogtreecommitdiff
path: root/noise.go
blob: ad70e113e14f2b245acfe5933b3a83828ce2e3de (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
// Package noise implements the Noise Protocol Framework.
package noise

import (
	"bytes"
	"errors"
	"fmt"
	"slices"
)

// Token represents a handshake pattern token.
type Token int

const (
	// Preshare tokens.
	TokenPreshareIS Token = iota - 2
	TokenPreshareRS

	// Message tokens.
	TokenPSK
	TokenE
	TokenS
	TokenEE
	TokenES
	TokenSE
	TokenSS
)

// HandshakePattern defines a Noise handshake pattern.
type HandshakePattern struct {
	Name     string
	Messages [][]Token
	Preshare []Token
}

// Predefined handshake patterns.
var (
	// PatternNN is the NN handshake pattern.
	// No static keys, no pre-shared keys.
	PatternNN = &HandshakePattern{
		Name: "NN",
		Messages: [][]Token{
			{TokenE},
			{TokenE, TokenEE},
		},
	}

	// PatternNNpsk0 is the NN handshake pattern with a pre-shared key.
	// Both parties mix the PSK before sending their ephemeral key.
	PatternNNpsk0 = &HandshakePattern{
		Name: "NNpsk0",
		Messages: [][]Token{
			{TokenPSK, TokenE},
			{TokenE, TokenEE},
		},
	}

	// PatternXX is the XX handshake pattern.
	// Both parties have static keys, but they are not pre-shared.
	PatternXX = &HandshakePattern{
		Name: "XX",
		Messages: [][]Token{
			{TokenE},
			{TokenE, TokenEE, TokenS, TokenES},
			{TokenS, TokenSE},
		},
	}

	// PatternXXpsk0 is the XX handshake pattern with a pre-shared key.
	// Both parties mix the PSK before sending their ephemeral key.
	PatternXXpsk0 = &HandshakePattern{
		Name: "XXpsk0",
		Messages: [][]Token{
			{TokenPSK, TokenE},
			{TokenE, TokenEE, TokenS, TokenES},
			{TokenS, TokenSE},
		},
	}

	// PatternIK is the IK handshake pattern.
	// The initiator knows the responder's static public key in advance.
	PatternIK = &HandshakePattern{
		Name:     "IK",
		Preshare: []Token{TokenPreshareRS},
		Messages: [][]Token{
			{TokenE, TokenES, TokenS, TokenSS},
			{TokenE, TokenEE, TokenSE},
		},
	}

	// PatternXK is the XK handshake pattern.
	// The responder has a static key, but the initiator does not know it in advance.
	PatternXK = &HandshakePattern{
		Name:     "XK",
		Preshare: []Token{TokenPreshareRS},
		Messages: [][]Token{
			{TokenE, TokenES},
			{TokenE, TokenEE},
			{TokenS, TokenSE},
		},
	}
)

// NoiseState represents a Noise Protocol handshake state.
type NoiseState struct {
	*symmetricState

	// Static and ephemeral keypairs.
	s *KeyPair
	e *KeyPair

	// Remote keys.
	re []byte
	rs []byte

	// PSK. Only used if handshake pattern includes PSK token.
	psk []byte

	// Pattern and state.
	pattern        *HandshakePattern
	handshakeQueue [][]Token
	initiator      bool
	isPskHandshake bool
	complete       bool

	// Final transport keys and hash.
	tx   *CipherState
	rx   *CipherState
	hash []byte
}

// Config holds configuration for NoiseState.
type Config struct {
	Curve         *Curve
	StaticKeypair *KeyPair
	PSK           []byte
}

// NewNoiseState creates a new Noise Protocol state.
func NewNoiseState(pattern *HandshakePattern, initiator bool, config *Config) (*NoiseState, error) {
	if config == nil {
		config = &Config{}
	}
	if config.Curve == nil {
		config.Curve = DefaultCurve
	}

	// Generate static keypair if not provided
	staticKP := config.StaticKeypair
	if staticKP == nil {
		var err error
		staticKP, err = config.Curve.GenerateKeyPair(nil)
		if err != nil {
			return nil, err
		}
	}

	// Copy handshake pattern
	handshakeQueue := make([][]Token, 0)
	if pattern.Preshare != nil {
		for _, t := range pattern.Preshare {
			handshakeQueue = append(handshakeQueue, []Token{t})
		}
	}
	for _, msg := range pattern.Messages {
		msgCopy := make([]Token, len(msg))
		copy(msgCopy, msg)
		handshakeQueue = append(handshakeQueue, msgCopy)
	}

	if config.PSK != nil && len(config.PSK) != 32 {
		return nil, fmt.Errorf("noise: PSK must be exactly 32 bytes, got %d", len(config.PSK))
	}

	isPskHandshake := config.PSK != nil && hasPskToken(handshakeQueue)

	ns := &NoiseState{
		symmetricState: newSymmetricState(config.Curve),
		s:              staticKP,
		e:              nil,
		re:             nil,
		rs:             nil,
		psk:            config.PSK,
		pattern:        pattern,
		handshakeQueue: handshakeQueue,
		initiator:      initiator,
		isPskHandshake: isPskHandshake,
		complete:       false,
		tx:             nil,
		rx:             nil,
		hash:           nil,
	}

	return ns, nil
}

// Initialize initializes the handshake with prologue and optional remote static key.
func (ns *NoiseState) Initialize(prologue, remoteStatic []byte) error {
	// Build protocol name
	protocolName := fmt.Sprintf("Noise_%s_%s_%s_BLAKE2b",
		ns.pattern.Name,
		ns.curve.ALG(),
		"ChaChaPoly")

	// Initialize symmetric state with protocol name
	ns.initializeSymmetric([]byte(protocolName))

	// Mix prologue
	ns.mixHash(prologue)

	// Process preshare tokens
	for len(ns.handshakeQueue) > 0 && len(ns.handshakeQueue[0]) == 1 {
		token := ns.handshakeQueue[0][0]
		if token != TokenPreshareRS && token != TokenPreshareIS {
			break
		}

		ns.handshakeQueue = ns.handshakeQueue[1:]

		takeRemoteKey := (ns.initiator && token == TokenPreshareRS) ||
			(!ns.initiator && token == TokenPreshareIS)

		if takeRemoteKey {
			if remoteStatic == nil {
				return errors.New("remote static key required for preshare")
			}
			ns.rs = make([]byte, len(remoteStatic))
			copy(ns.rs, remoteStatic)
		}

		var key []byte
		if takeRemoteKey {
			key = ns.rs
		} else {
			key = ns.s.PublicKey
		}

		ns.mixHash(key)
	}

	return nil
}

// Send sends a handshake message with optional payload.
func (ns *NoiseState) Send(payload []byte) ([]byte, error) {
	if len(ns.handshakeQueue) == 0 {
		return nil, errors.New("handshake already complete")
	}

	if payload == nil {
		payload = []byte{}
	}

	var buf bytes.Buffer
	patterns := ns.handshakeQueue[0]
	ns.handshakeQueue = ns.handshakeQueue[1:]

	for _, token := range patterns {
		switch token {
		case TokenPSK:
			ns.mixKeyAndHash(ns.psk)

		case TokenE:
			if ns.e == nil {
				var err error
				ns.e, err = ns.curve.GenerateKeyPair(nil)
				if err != nil {
					return nil, err
				}
			}
			ns.mixHash(ns.e.PublicKey)
			if ns.isPskHandshake {
				ns.mixKeyNormal(ns.e.PublicKey)
			}
			buf.Write(ns.e.PublicKey)

		case TokenS:
			ciphertext, err := ns.encryptAndHash(ns.s.PublicKey)
			if err != nil {
				return nil, err
			}
			buf.Write(ciphertext)

		case TokenEE, TokenES, TokenSE, TokenSS:
			useStatic := getKeyPattern(token, ns.initiator)
			localKey := ns.s
			if !useStatic.local {
				localKey = ns.e
			}
			remoteKey := ns.rs
			if !useStatic.remote {
				remoteKey = ns.re
			}
			if err := ns.mixKey(remoteKey, localKey); err != nil {
				return nil, err
			}

		default:
			return nil, fmt.Errorf("unexpected token: %d", token)
		}
	}

	// Encrypt payload
	ciphertext, err := ns.encryptAndHash(payload)
	if err != nil {
		return nil, err
	}
	buf.Write(ciphertext)

	// Finalize if handshake complete
	if len(ns.handshakeQueue) == 0 {
		if err := ns.final(); err != nil {
			return nil, err
		}
	}

	return buf.Bytes(), nil
}

// Recv receives and processes a handshake message.
func (ns *NoiseState) Recv(message []byte) ([]byte, error) {
	if len(ns.handshakeQueue) == 0 {
		return nil, errors.New("handshake already complete")
	}

	offset := 0
	patterns := ns.handshakeQueue[0]
	ns.handshakeQueue = ns.handshakeQueue[1:]

	for _, token := range patterns {
		switch token {
		case TokenPSK:
			ns.mixKeyAndHash(ns.psk)

		case TokenE:
			if offset+PublicKeyLength > len(message) {
				return nil, errors.New("insufficient bytes for public key")
			}
			ns.re = make([]byte, PublicKeyLength)
			copy(ns.re, message[offset:offset+PublicKeyLength])
			offset += PublicKeyLength

			ns.mixHash(ns.re)
			if ns.isPskHandshake {
				ns.mixKeyNormal(ns.re)
			}

		case TokenS:
			klen := PublicKeyLength
			if ns.cs.HasKey() {
				klen = PublicKeyLength + MacBytes
			}
			if offset+klen > len(message) {
				return nil, errors.New("insufficient bytes for static key")
			}
			var err error
			ns.rs, err = ns.decryptAndHash(message[offset : offset+klen])
			if err != nil {
				return nil, err
			}
			offset += klen

		case TokenEE, TokenES, TokenSE, TokenSS:
			useStatic := getKeyPattern(token, ns.initiator)
			localKey := ns.s
			if !useStatic.local {
				localKey = ns.e
			}
			remoteKey := ns.rs
			if !useStatic.remote {
				remoteKey = ns.re
			}
			if err := ns.mixKey(remoteKey, localKey); err != nil {
				return nil, err
			}

		default:
			return nil, fmt.Errorf("unexpected token: %d", token)
		}
	}

	// Decrypt payload
	payload, err := ns.decryptAndHash(message[offset:])
	if err != nil {
		return nil, err
	}

	// Finalize if handshake complete
	if len(ns.handshakeQueue) == 0 {
		if err := ns.final(); err != nil {
			return nil, err
		}
	}

	return payload, nil
}

// final completes the handshake and derives transport keys.
func (ns *NoiseState) final() error {
	ns.hash = ns.handshakeHash()

	keys, err := ns.split()
	if err != nil {
		return err
	}

	if ns.initiator {
		ns.tx = keys[0]
		ns.rx = keys[1]
	} else {
		ns.tx = keys[1]
		ns.rx = keys[0]
	}

	ns.complete = true

	// Clear handshake state
	ns.clearHandshake()

	return nil
}

// clearHandshake clears sensitive handshake data.
func (ns *NoiseState) clearHandshake() {
	if ns.e != nil {
		for i := range ns.e.SecretKey {
			ns.e.SecretKey[i] = 0
		}
		for i := range ns.e.PublicKey {
			ns.e.PublicKey[i] = 0
		}
		ns.e = nil
	}
	if ns.re != nil {
		for i := range ns.re {
			ns.re[i] = 0
		}
		ns.re = nil
	}
	// Zero static private key
	if ns.s != nil {
		for i := range ns.s.SecretKey {
			ns.s.SecretKey[i] = 0
		}
	}
	// Zero PSK
	if ns.psk != nil {
		for i := range ns.psk {
			ns.psk[i] = 0
		}
		ns.psk = nil
	}
}

// IsComplete returns true if handshake is complete.
func (ns *NoiseState) IsComplete() bool {
	return ns.complete
}

// Hash returns the handshake hash (only valid after completion).
func (ns *NoiseState) Hash() []byte {
	if ns.hash != nil {
		result := make([]byte, len(ns.hash))
		copy(result, ns.hash)
		return result
	}
	return nil
}

// Tx returns the transmit cipher state (only valid after completion).
func (ns *NoiseState) Tx() *CipherState {
	return ns.tx
}

// Rx returns the receive cipher state (only valid after completion).
func (ns *NoiseState) Rx() *CipherState {
	return ns.rx
}

// StaticPublicKey returns the local static public key.
func (ns *NoiseState) StaticPublicKey() []byte {
	if ns.s != nil {
		key := make([]byte, len(ns.s.PublicKey))
		copy(key, ns.s.PublicKey)
		return key
	}
	return nil
}

// RemoteStaticPublicKey returns a copy of the remote static public key (rs).
func (ns *NoiseState) RemoteStaticPublicKey() []byte {
	if ns.rs == nil {
		return nil
	}
	key := make([]byte, len(ns.rs))
	copy(key, ns.rs)
	return key
}

// keyPatternResult holds which keys to use.
type keyPatternResult struct {
	local  bool
	remote bool
}

// getKeyPattern determines which keys to use based on token and role.
func getKeyPattern(token Token, initiator bool) (result keyPatternResult) {
	switch token {
	case TokenEE:
		// Both ephemeral
		result.local = false
		result.remote = false

	case TokenES:
		// Initiator: ephemeral local, static remote
		// Responder: static local, ephemeral remote
		result.local = !initiator
		result.remote = initiator

	case TokenSE:
		// Initiator: static local, ephemeral remote
		// Responder: ephemeral local, static remote
		result.local = initiator
		result.remote = !initiator

	case TokenSS:
		// Both static
		result.local = true
		result.remote = true
	}

	return result
}

// hasPskToken checks if handshake pattern contains PSK token.
func hasPskToken(handshake [][]Token) bool {
	for _, msg := range handshake {
		if slices.Contains(msg, TokenPSK) {
			return true
		}
	}
	return false
}