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
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
//! # Key Exchange
//!
//! This module provides a secure key exchange mechanism based on the X25519 function.
//! It allows two parties to establish a shared secret over an insecure channel.
//! The implementation follows the key exchange protocol defined in libsodium.
//!
//! ## Overview
//!
//! The key exchange mechanism in this module uses the X25519 function, which is an
//! elliptic curve Diffie-Hellman key exchange using Curve25519. This allows two parties
//! to establish a shared secret that can be used for symmetric encryption. The shared
//! secret is automatically hashed using BLAKE2b before being used as session keys.
//!
//! ## Features
//!
//! - **High security**: Based on the X25519 function (Curve25519)
//! - **Forward secrecy**: New session keys can be generated for each session
//! - **Authenticated**: Both parties can verify the identity of the other party
//! - **Bidirectional**: Generates separate keys for sending and receiving
//!
//! ## Usage
//!
//! The typical workflow is as follows:
//!
//! 1. Both the client and server generate their own keypairs
//! 2. They exchange their public keys over any channel (doesn't need to be secure)
//! 3. The client computes session keys using `client_session_keys()`
//! 4. The server computes session keys using `server_session_keys()`
//! 5. Both parties now have matching session keys for bidirectional communication
//!
//! ```rust
//! use libsodium_rs as sodium;
//! use sodium::crypto_kx;
//! use sodium::ensure_init;
//!
//! // Initialize libsodium
//! ensure_init().expect("Failed to initialize libsodium");
//!
//! // Client and server each generate their keypairs
//! let client_keypair = crypto_kx::KeyPair::generate().unwrap();
//! let (client_pk, client_sk) = (client_keypair.public_key, client_keypair.secret_key);
//! let server_keypair = crypto_kx::KeyPair::generate().unwrap();
//! let (server_pk, server_sk) = (server_keypair.public_key, server_keypair.secret_key);
//!
//! // Exchange public keys (this would happen over a network in practice)
//!
//! // Client computes session keys
//! let client_keys = crypto_kx::client_session_keys(
//! &client_pk,
//! &client_sk,
//! &server_pk,
//! ).unwrap();
//!
//! // Server computes session keys
//! let server_keys = crypto_kx::server_session_keys(
//! &server_pk,
//! &server_sk,
//! &client_pk,
//! ).unwrap();
//!
//! // Now client_keys.tx matches server_keys.rx
//! // and client_keys.rx matches server_keys.tx
//! assert_eq!(client_keys.tx, server_keys.rx);
//! assert_eq!(client_keys.rx, server_keys.tx);
//!
//! // These keys can now be used for symmetric encryption
//! ```
//!
//! ## Security Considerations
//!
//! - Keep secret keys private at all times
//! - Public keys can be freely shared
//! - Generate new keypairs for each communication session for forward secrecy
//! - The session keys should be used with appropriate symmetric encryption algorithms
//! - For maximum security, authenticate the public keys through a trusted channel
//! - The shared secret established through X25519 is automatically hashed before being used as session keys
//! - Be aware that X25519 is based on Curve25519, which has a cofactor of 8
//! - The key exchange protocol provides protection against man-in-the-middle attacks
//! when public keys are properly authenticated
//! - The session keys are derived using BLAKE2b, which is resistant to length extension attacks
//! - Different keys are used for each direction to prevent reflection attacks
use crate::;
use libsodium_sys;
/// Number of bytes in a public key (32)
///
/// This is the size of a Curve25519 public key used in the X25519 key exchange.
pub const PUBLICKEYBYTES: usize = crypto_kx_PUBLICKEYBYTES as usize;
/// Number of bytes in a secret key (32)
///
/// This is the size of a Curve25519 secret key used in the X25519 key exchange.
pub const SECRETKEYBYTES: usize = crypto_kx_SECRETKEYBYTES as usize;
/// Number of bytes in a session key (32)
///
/// This is the size of the symmetric keys generated through the key exchange.
/// These keys can be used for symmetric encryption algorithms like XChaCha20-Poly1305.
pub const SESSIONKEYBYTES: usize = crypto_kx_SESSIONKEYBYTES as usize;
/// A public key for key exchange
///
/// This represents a Curve25519 public key used in the X25519 key exchange.
/// Public keys can be freely shared with other parties.
///
/// ## Size
///
/// A public key is always exactly `PUBLICKEYBYTES` (32) bytes.
///
/// ## Security Considerations
///
/// While public keys can be freely shared, it's important to authenticate
/// them through a trusted channel to prevent man-in-the-middle attacks.
///
/// ## Usage
///
/// Public keys are typically generated with the `KeyPair::generate()` function
/// and then shared with the other party to establish a secure communication channel.
;
/// A secret key for key exchange
///
/// This represents a Curve25519 secret key used in the X25519 key exchange.
/// Secret keys must be kept private and never shared.
///
/// ## Size
///
/// A secret key is always exactly `SECRETKEYBYTES` (32) bytes.
///
/// ## Security Considerations
///
/// Secret keys should be generated using a secure random number generator
/// and should never be exposed. When a secret key is no longer needed,
/// it should be securely erased from memory.
///
/// ## Security
///
/// Secret keys should be protected with the same care as passwords or encryption keys.
/// They should never be transmitted over a network or stored in plaintext.
///
/// ## Usage
///
/// Secret keys are typically generated with the `KeyPair::generate()` function
/// and used locally to compute shared session keys.
;
/// A key pair for key exchange
///
/// Contains both a public key and a secret key for use with crypto_kx functions.
/// The key pair is used to establish a secure communication channel between
/// two parties using the X25519 key exchange protocol.
/// A pair of session keys for bidirectional communication
///
/// This struct contains two symmetric keys for secure bidirectional communication:
/// - `tx`: Used for encrypting outgoing messages (and decrypting by the other party)
/// - `rx`: Used for decrypting incoming messages (and encrypting by the other party)
///
/// Using separate keys for each direction provides additional security by preventing
/// reflection attacks and ensuring that encryption and decryption operations use
/// different keys.
///
/// ## Size
///
/// Each session key is exactly `SESSIONKEYBYTES` (32) bytes.
///
/// ## Usage
///
/// Session keys are computed using either `client_session_keys()` or `server_session_keys()`
/// and then used with symmetric encryption algorithms like XChaCha20-Poly1305.
///
/// ```rust
/// use libsodium_rs as sodium;
/// use sodium::crypto_kx;
/// use sodium::crypto_secretbox;
/// use sodium::random;
/// use sodium::ensure_init;
///
/// // Initialize libsodium
/// ensure_init().expect("Failed to initialize libsodium");
///
/// // Generate keypairs and compute session keys (abbreviated)
/// let client_keypair = crypto_kx::KeyPair::generate().unwrap();
/// let client_pk = client_keypair.public_key;
/// let client_sk = client_keypair.secret_key;
/// let server_keypair = crypto_kx::KeyPair::generate().unwrap();
/// let server_pk = server_keypair.public_key;
/// let server_sk = server_keypair.secret_key;
/// let client_keys = crypto_kx::client_session_keys(&client_pk, &client_sk, &server_pk).unwrap();
///
/// // Use the tx key for encryption
/// let nonce = crypto_secretbox::Nonce::generate();
/// let message = b"Hello, server!";
///
/// // Create a key from the session key bytes
/// let tx_key = crypto_secretbox::Key::from_bytes(&client_keys.tx).unwrap();
///
/// // Encrypt the message
/// let ciphertext = crypto_secretbox::seal(message, &nonce, &tx_key);
///
/// // The server would decrypt using its rx key (which matches client's tx key)
/// ```
/// Computes session keys for a client
///
/// This function computes a pair of session keys that can be used for secure
/// communication between a client and a server. It must be called by the client
/// using the client's keypair and the server's public key.
///
/// The client and server roles are important because they determine the order
/// of inputs to the key derivation function, ensuring that the client's tx key
/// matches the server's rx key, and vice versa.
///
/// ## Algorithm Details
///
/// The session keys are derived using the X25519 function to compute a shared secret,
/// which is then hashed using BLAKE2b to produce two separate keys for sending and receiving.
/// This ensures that different keys are used in each direction and that the raw output of
/// the X25519 function is never directly used as a cryptographic key.
///
/// ## Security Considerations
///
/// - The client must verify the authenticity of the server's public key
/// - The resulting session keys should be used with appropriate symmetric encryption
/// - The client's tx key corresponds to the server's rx key, and vice versa
/// - The session keys are derived using BLAKE2b, which is resistant to length extension attacks
/// - Different keys are used for each direction to prevent reflection attacks
/// - The key exchange provides forward secrecy if new keypairs are generated for each session
///
/// ## Arguments
///
/// * `client_pk` - The client's public key
/// * `client_sk` - The client's secret key
/// * `server_pk` - The server's public key
///
/// ## Returns
///
/// * `Result<SessionKeys>` - A pair of session keys for bidirectional communication
///
/// ## Errors
///
/// Returns an error if the key computation fails, which can happen if:
/// - The public keys are invalid
/// - The secret key is invalid
/// - The public keys represent the same identity (client_pk == server_pk)
///
/// ## Example
///
/// ```rust
/// use libsodium_rs as sodium;
/// use sodium::crypto_kx;
/// use sodium::ensure_init;
///
/// // Initialize libsodium
/// ensure_init().expect("Failed to initialize libsodium");
///
/// // Generate keypairs for client and server
/// let client_keypair = crypto_kx::KeyPair::generate().unwrap();
/// let client_pk = client_keypair.public_key;
/// let client_sk = client_keypair.secret_key;
/// let server_keypair = crypto_kx::KeyPair::generate().unwrap();
/// let server_pk = server_keypair.public_key;
/// let server_sk = server_keypair.secret_key;
///
/// // Client computes session keys
/// let client_keys = crypto_kx::client_session_keys(
/// &client_pk,
/// &client_sk,
/// &server_pk,
/// ).unwrap();
///
/// // Now client_keys.tx can be used to encrypt messages to the server,
/// // and client_keys.rx can be used to decrypt messages from the server.
/// ```
/// Server side: compute session keys
///
/// This function computes a pair of session keys for secure bidirectional
/// communication between a client and a server. It must be called by the server
/// using the server's keypair and the client's public key.
///
/// ## Algorithm Details
///
/// The session keys are derived using the X25519 function to compute a shared secret,
/// which is then hashed using BLAKE2b to produce two separate keys for sending and receiving.
/// This ensures that different keys are used in each direction and that the raw output of
/// the X25519 function is never directly used as a cryptographic key.
///
/// ## Security Considerations
///
/// - The server must verify the authenticity of the client's public key
/// - The resulting session keys should be used with appropriate symmetric encryption
/// - The server's tx key corresponds to the client's rx key, and vice versa
/// - The session keys are derived using BLAKE2b, which is resistant to length extension attacks
/// - Different keys are used for each direction to prevent reflection attacks
/// - The key exchange provides forward secrecy if new keypairs are generated for each session
///
/// ## Arguments
///
/// * `server_pk` - The server's public key
/// * `server_sk` - The server's secret key
/// * `client_pk` - The client's public key
///
/// ## Returns
///
/// * `Result<SessionKeys>` - A pair of session keys for bidirectional communication
///
/// ## Errors
///
/// Returns an error if the key computation fails, which can happen if:
/// - The public keys are invalid
/// - The secret key is invalid
/// - The public keys represent the same identity (server_pk == client_pk)
///
/// ## Example
///
/// ```rust
/// use libsodium_rs as sodium;
/// use sodium::crypto_kx;
/// use sodium::ensure_init;
///
/// // Initialize libsodium
/// ensure_init().expect("Failed to initialize libsodium");
///
/// // Generate keypairs for client and server
/// let client_keypair = crypto_kx::KeyPair::generate().unwrap();
/// let client_pk = client_keypair.public_key;
/// let client_sk = client_keypair.secret_key;
/// let server_keypair = crypto_kx::KeyPair::generate().unwrap();
/// let server_pk = server_keypair.public_key;
/// let server_sk = server_keypair.secret_key;
///
/// // Server computes session keys
/// let server_keys = crypto_kx::server_session_keys(
/// &server_pk,
/// &server_sk,
/// &client_pk,
/// ).unwrap();
///
/// // Now server_keys.tx can be used to encrypt messages to the client,
/// // and server_keys.rx can be used to decrypt messages from the client.
/// ```