nivalis 0.3.2

A typestate-driven, pure-Rust implementation of the Noise Protocol Framework
Documentation
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
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
//! Noise patterns presented on NoiseExplorer
//! https://noiseexplorer.com/patterns/

pub mod roles;

/// A single token in a Noise message pattern (one step).
#[derive(PartialEq)]
pub enum Token {
    /// Generate and send an ephemeral public key
    /// to the buffer
    E,
    /// Append encrypt_and_hash(s.public_key) to the buffer
    S,
    /// Call mix_key(DH(e, re))
    EE,
    /// Call mix_key(DH(e, rs)) or mix_key(DH(s, re))
    /// depending on the role
    ES,
    /// Call mix_key(DH(s, re)) or mix_key(DH(e, rs))
    /// depending on the role
    SE,
    /// Call mix_key(DH(s, rs))
    SS,
    /// Call mix_key_and_hash(psk)
    PSK,
}

/// The sequence of [`Token`]s exchanged in a single handshake message
pub struct MessagePattern {
    /// Tokens processed in order for this message
    pub tokens: &'static [Token],
}

/// The full definition of a Noise handshake with any pre-shared
/// ("pre-message") keys followed by the ordered sequence of handshake
/// messages.
/// 
/// Alternate between initiator and responder stating with the
/// initiator: `messages[0]` is sent by the initiator, `message[1]`
/// by the responder, etc.
#[derive(Copy, Clone)]
pub struct HandshakePattern {
    pre_messages_initiator: &'static [Token],
    pre_messages_responder: &'static [Token],
    messages: &'static [MessagePattern],
}

impl HandshakePattern {
    /// Returns `true` if this is a one-way pattern.
    pub const fn is_oneway(&self) -> bool {
        self.messages.len() == 1
    }

    /// Returns the ordered sequence of handshake messages.
    pub const fn messages(&self) -> &'static [MessagePattern] {
        self.messages
    }

    /// Returns the pre-message tokens known by the initiator
    /// before the handshake begins.
    pub const fn initiator_pre_messages(&self) -> &[Token] {
        self.pre_messages_initiator
    }

    /// Returns the pre-message tokens known by the responder
    /// before the handshake begins
    pub const fn responder_pre_messages(&self) -> &[Token] {
        self.pre_messages_responder
    }

    /// Returns `true` if any message in this pattern mixes in
    /// a pre-shared key ([`Token::PSK`])
    pub const fn has_psk(&self) -> bool {
        let mut i = 0;
        while i < self.messages.len() {
            let tokens = self.messages[i].tokens;
            let mut j = 0;
            while j < tokens.len() {
                if matches!(tokens[j], Token::PSK) {
                    return true;
                }
                j += 1;
            }
            i += 1;
        }
        false
    }

    const fn contains_s(tokens: &[Token]) -> bool {
        let mut i = 0;
        while i < tokens.len() {
            if matches!(tokens[i], Token::S) {
                return true;
            }
            i += 1;
        }
        false
    }

    const fn contains_e(tokens: &[Token]) -> bool {
        let mut i = 0;
        while i < tokens.len() {
            if matches!(tokens[i], Token::E) {
                return true;
            }
            i += 1;
        }
        false
    }

    /// Returns `true` if the peer's static key is known as a
    /// pre-message from the perspective of `is_initiator`.
    pub const fn peer_static_is_premessage(&self, is_initiator: bool) -> bool {
        let peer_pre = if is_initiator {
            self.pre_messages_responder
        } else {
            self.pre_messages_initiator
        };
        Self::contains_s(peer_pre)
    }

    /// Returns `true` if the peer's ephemeral key is known as a
    /// pre-message from the perspective of `is_initiator`.
    pub const fn peer_ephemeral_is_premessage(&self, is_initiator: bool) -> bool {
        let peer_pre = if is_initiator {
            self.pre_messages_responder
        } else {
            self.pre_messages_initiator
        };
        Self::contains_e(peer_pre)
    }

    /// Returns `true` if this pattern/role requires a local static key
    /// as a pre-message or the message sends `Token::S` in one of its own
    /// message.
    pub const fn local_static_required(&self, is_initiator: bool) -> bool {
        let own_pre = if is_initiator {
            self.pre_messages_initiator
        } else {
            self.pre_messages_responder
        };
        if Self::contains_s(own_pre) {
            return true;
        }
        let mut i = 0;
        while i < self.messages.len() {
            let sent_by_initiator = i % 2 == 0; // messages alternate, initiator sends first
            if sent_by_initiator == is_initiator && Self::contains_s(self.messages[i].tokens) {
                return true;
            }
            i += 1;
        }
        false
    }

    /// Returns `true` if this pattern/role requires a local ephemeral key
    /// as a pre-message or the message sends `Token::S` in one of its own
    /// message.
    /// 
    /// # Note
    /// 
    /// Unlike [`local_static_required`](Self::local_static_required),
    /// only checks pre-messages and always returns `false` otherwise.
    pub const fn local_ephemeral_required(&self, is_initiator: bool) -> bool {
        let own_pre = if is_initiator {
            self.pre_messages_initiator
        } else {
            self.pre_messages_responder
        };
        if Self::contains_e(own_pre) {
            return true;
        }

        false
    }
}

/// Trait that determines the properties of a Noise handshake
/// pattern (ex: `N`, `NN`, `XX`, etc.)
pub trait Pattern: Copy + 'static {
    /// The Noise protocol name for this pattern. Used when 
    /// building the string for the pattern.
    const NAME: &'static str;
    /// The pre-message and message sequence defining the pattern.
    const HANDSHAKE: HandshakePattern;
}

/// The `N` pattern: one-way handshake where the initiator sends a 
/// single message to a responder whose static key is known in advance.
/// 
/// See [NoiseExplorer: N](https://noiseexplorer.com/patterns/N/).
#[derive(Copy, Clone)]
pub struct N;
impl Pattern for N {
    const NAME: &'static str = "N";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[MessagePattern {
            tokens: &[Token::E, Token::ES],
        }],
    };
}

/// The `K` pattern: a one-way handshake where both parties static
/// keys are known to each other in advance.
/// 
/// See [NoiseExplorer: K](https://noiseexplorer.com/patterns/K).
#[derive(Copy, Clone)]
pub struct K;
impl Pattern for K {
    const NAME: &'static str = "K";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[Token::S],
        pre_messages_responder: &[Token::S],
        messages: &[MessagePattern {
            tokens: &[Token::E, Token::ES, Token::SS],
        }],
    };
}

/// The `X` pattern: a one-way handshake where the responder's static
/// key is known in advance and the initiator transmits its own static
/// key within the message.
/// 
/// See [NoiseExplorer: X](https://noiseexplorer.com/patterns/X).
#[derive(Copy, Clone)]
pub struct X;
impl Pattern for X {
    const NAME: &'static str = "X";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[MessagePattern {
            tokens: &[Token::E, Token::ES, Token::S, Token::SS],
        }],
    };
}

/// The `NN` pattern: neither party's static key is known in advance
/// or transmitted.
/// 
/// See [NoiseExplorer: NN](https://noiseexplorer.com/patterns/NN).
#[derive(Copy, Clone)]
pub struct NN;
impl Pattern for NN {
    const NAME: &'static str = "NN";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE],
            },
        ],
    };
}

/// The `NK` pattern: the responder's static key is known to the
/// initiator in advance, the initiator is not authenticated.
/// 
/// See [NoiseExplorer: NK](https://noiseexplorer.com/patterns/NK).
#[derive(Copy, Clone)]
pub struct NK;
impl Pattern for NK {
    const NAME: &'static str = "NK";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::ES],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE],
            },
        ],
    };
}

/// The `NX` pattern: the responder transmits its static key during
/// the handshake.
/// 
/// See [NoiseExplorer: NX](https://noiseexplorer.com/patterns/NX).
#[derive(Copy, Clone)]
pub struct NX;
impl Pattern for NX {
    const NAME: &'static str = "NX";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::S, Token::ES],
            },
        ],
    };
}

/// The `XN` pattern: the initiator's static key is transmitted
/// during the handshake, the responder is unauthenticated.
/// 
/// See [NoiseExplorer: XN](https://noiseexplorer.com/patterns/XN)
#[derive(Copy, Clone)]
pub struct XN;
impl Pattern for XN {
    const NAME: &'static str = "XN";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE],
            },
            MessagePattern {
                tokens: &[Token::S, Token::SE],
            },
        ],
    };
}

/// The `XK` pattern: the responder's static key is known in advance,
/// the initiator sends his during the handshake.
/// 
/// See [NoiseExplorer: XK](https://noiseexplorer.com/patterns/XK).
#[derive(Copy, Clone)]
pub struct XK;
impl Pattern for XK {
    const NAME: &'static str = "XK";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::ES],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE],
            },
            MessagePattern {
                tokens: &[Token::S, Token::SE],
            },
        ],
    };
}

/// The `XX` pattern: neither party's static key is known in advance,
/// both send them during the handshake.
/// 
/// See [NoiseExplorer: XX](https://noiseexplorer.com/patterns/XX).
#[derive(Copy, Clone)]
pub struct XX;
impl Pattern for XX {
    const NAME: &'static str = "XX";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::S, Token::ES],
            },
            MessagePattern {
                tokens: &[Token::S, Token::SE],
            },
        ],
    };
}

/// The `KN` pattern: The initiator's static key is known in advance,
/// the responder is not authenticated.
/// 
/// See [NoiseExplorer: KN](https://noiseexplorer.com/patterns/KN).
#[derive(Copy, Clone)]
pub struct KN;
impl Pattern for KN {
    const NAME: &'static str = "KN";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[Token::S],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE],
            },
        ],
    };
}

/// The `KK` pattern: both party's static keys are known to each
/// other in advance.
/// 
/// See [NoiseExplorer: KK](https://noiseexplorer.com/patterns/KK).
#[derive(Copy, Clone)]
pub struct KK;
impl Pattern for KK {
    const NAME: &'static str = "KK";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[Token::S],
        pre_messages_responder: &[Token::S],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::ES, Token::SS],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE],
            },
        ],
    };
}

/// The `KX` pattern: The initiator's static key is known in advance,
/// the responder send his during the handshake.
/// 
/// See [NoiseExplorer: KX](https://noiseexplorer.com/patterns/KX).
#[derive(Copy, Clone)]
pub struct KX;
impl Pattern for KX {
    const NAME: &'static str = "KX";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[Token::S],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE, Token::S, Token::ES],
            },
        ],
    };
}

/// The `IN` pattern: the initiator sends his static key in the first
/// message, the responder is not authenticated.
/// 
/// See [NoiseExplorer: IN](https://noiseexplorer.com/patterns/IN).
#[derive(Copy, Clone)]
pub struct IN;
impl Pattern for IN {
    const NAME: &'static str = "IN";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::S],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE],
            },
        ],
    };
}

/// The `IK` pattern: the responder's static key is known in advance,
/// the initiator send his in the first message.
/// 
/// See [NoiseExplorer: IK](https://noiseexplorer.com/patterns/IK).
#[derive(Copy, Clone)]
pub struct IK;
impl Pattern for IK {
    const NAME: &'static str = "IK";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::ES, Token::S, Token::SS],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE],
            },
        ],
    };
}

/// The `IX` pattern: neither static keys are known in advance,
/// the initiator sends his in the first message and the responder
/// in his response.
/// 
/// See [NoiseExplorer: IX](https://noiseexplorer.com/patterns/IX).
#[derive(Copy, Clone)]
pub struct IX;
impl Pattern for IX {
    const NAME: &'static str = "IX";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::S],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE, Token::S, Token::ES],
            },
        ],
    };
}

/// The `Npsk0` pattern: the `N` pattern with a pre-shared key mixed
/// in at the start of the message.
/// 
/// See [NoiseExplorer: Npsk0](https://noiseexplorer.com/patterns/Npsk0).
#[derive(Copy, Clone)]
pub struct Npsk0;
impl Pattern for Npsk0 {
    const NAME: &'static str = "Npsk0";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[MessagePattern {
            tokens: &[Token::PSK, Token::E, Token::ES],
        }],
    };
}

/// The `Kpsk0` pattern: the `K` pattern with a pre-shard key mixed 
/// in at the start of the message.
/// 
/// See [NoiseExplorer: Kpsk0](https://noiseexplorer.com/patterns/Kpsk0).
#[derive(Copy, Clone)]
pub struct Kpsk0;
impl Pattern for Kpsk0 {
    const NAME: &'static str = "Kpsk0";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[Token::S],
        pre_messages_responder: &[Token::S],
        messages: &[MessagePattern {
            tokens: &[Token::PSK, Token::E, Token::ES, Token::SS],
        }],
    };
}

/// The `Xpsk1` pattern: the `X` pattern with a pre-shared key mixed
/// in at the end of the message.
/// 
/// See [NoiseExplorer: Xpsk1](https://noiseexplorer.com/patterns/Xpsk1).
#[derive(Copy, Clone)]
pub struct Xpsk1;
impl Pattern for Xpsk1 {
    const NAME: &'static str = "Xpsk1";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[MessagePattern {
            tokens: &[Token::E, Token::ES, Token::S, Token::SS, Token::PSK],
        }],
    };
}

/// The `NNpsk0` pattern: the `NN` pattern with a pre-shared key mixed
/// in at the start of the first message.
/// 
/// See [NoiseExplorer: NNpsk0](https://noiseexplorer.com/patterns/NNpsk0).
#[derive(Copy, Clone)]
pub struct NNpsk0;
impl Pattern for NNpsk0 {
    const NAME: &'static str = "NNpsk0";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::PSK, Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE],
            },
        ],
    };
}

/// The `NNpsk2` pattern: the `NN` pattern with a pre-shared key mixed
/// in at the end of the second message.
///
/// See [NoiseExplorer: NNpsk2](https://noiseexplorer.com/patterns/NNpsk2).
#[derive(Copy, Clone)]
pub struct NNpsk2;
impl Pattern for NNpsk2 {
    const NAME: &'static str = "NNpsk2";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::PSK],
            },
        ],
    };
}

/// The `NKpsk0` pattern: the `NK` pattern with a pre-shared key
/// mixed in at the start of the first message.
/// 
/// See [NoiseExplorer: NKpsk0](https://noiseexplorer.com/patterns/NKpsk0).
#[derive(Copy, Clone)]
pub struct NKpsk0;
impl Pattern for NKpsk0 {
    const NAME: &'static str = "NKpsk0";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[
            MessagePattern {
                tokens: &[Token::PSK, Token::E, Token::ES],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE],
            },
        ],
    };
}

/// The `NKpsk2` pattern: the `NK` pattern with a pre-shared key mixed
/// in at the end of the second message.
/// 
/// See [NoiseExplorer: NKpsk2](https://noiseexplorer.com/patterns/NKpsk2).
#[derive(Copy, Clone)]
pub struct NKpsk2;
impl Pattern for NKpsk2 {
    const NAME: &'static str = "NKpsk2";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::ES],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::PSK],
            },
        ],
    };
}

/// The `NXpsk2` pattern: the `NX` pattern with a pre-shared key mixed
/// in at the end of the second message.
/// 
/// See [NoiseExplorer: NXpsk2](https://noiseexplorer.com/patterns/NXpsk2).
#[derive(Copy, Clone)]
pub struct NXpsk2;
impl Pattern for NXpsk2 {
    const NAME: &'static str = "NXpsk2";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::S, Token::ES, Token::PSK],
            },
        ],
    };
}

/// The `XNpsk3` pattern: the `XN` pattern with a pre-shared key mixed
/// in at the end of the third message.
/// 
/// See [NoiseExplorer: XNpsk3](https://noiseexplorer.com/patterns/XNpsk3).
#[derive(Copy, Clone)]
pub struct XNpsk3;
impl Pattern for XNpsk3 {
    const NAME: &'static str = "XNpsk3";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE],
            },
            MessagePattern {
                tokens: &[Token::S, Token::SE, Token::PSK],
            },
        ],
    };
}

/// The `XKpsk3` pattern: the `XK` pattern with a pre-shared key mixed
/// in at the end of the third message.
/// 
/// See [NoiseExplorer: XKpsk3](https://noiseexplorer.com/patterns/XKpsk3).
#[derive(Copy, Clone)]
pub struct XKpsk3;
impl Pattern for XKpsk3 {
    const NAME: &'static str = "XKpsk3";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::ES],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE],
            },
            MessagePattern {
                tokens: &[Token::S, Token::SE, Token::PSK],
            },
        ],
    };
}

/// The `XXpsk3` pattern: the `XX` pattern with a pre-shared key mixed
/// in at the end of the third message.
/// 
/// See [NoiseExplorer: XXpsk3](https://noiseexplorer.com/patterns/XXpsk3).
#[derive(Copy, Clone)]
pub struct XXpsk3;
impl Pattern for XXpsk3 {
    const NAME: &'static str = "XXpsk3";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::S, Token::ES],
            },
            MessagePattern {
                tokens: &[Token::S, Token::SE, Token::PSK],
            },
        ],
    };
}

/// The `KNpsk0` pattern: the `KN` pattern with a pre-shared key mixed
/// in at the start of the first message.
/// 
/// See [NoiseExplorer: KNpsk0](https://noiseexplorer.com/patterns/KNpsk0).
#[derive(Copy, Clone)]
pub struct KNpsk0;
impl Pattern for KNpsk0 {
    const NAME: &'static str = "KNpsk0";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[Token::S],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::PSK, Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE],
            },
        ],
    };
}

/// The `KNpsk2` pattern: the `KN` pattern with a pre-shared key mixed
/// in at the end of the second message.
/// 
/// See [NoiseExplorer: KNpsk2](https://noiseexplorer.com/patterns/KNpsk2).
#[derive(Copy, Clone)]
pub struct KNpsk2;
impl Pattern for KNpsk2 {
    const NAME: &'static str = "KNpsk2";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[Token::S],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE, Token::PSK],
            },
        ],
    };
}

/// The `KKpsk0` pattern: the `KK` pattern with a pre-shared key mixed
/// in at the end of the second message.
/// 
/// See [NoiseExplorer: KKpsk0](https://noiseexplorer.com/patterns/KKpsk0).
#[derive(Copy, Clone)]
pub struct KKpsk0;
impl Pattern for KKpsk0 {
    const NAME: &'static str = "KKpsk0";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[Token::S],
        pre_messages_responder: &[Token::S],
        messages: &[
            MessagePattern {
                tokens: &[Token::PSK, Token::E, Token::ES, Token::SS],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE],
            },
        ],
    };
}

/// The `KKpsk2` pattern: the `KK` pattern with a pre-shared key mixed
/// in at the end of the second message.
/// 
/// See [NoiseExplorer: KKpsk2](https://noiseexplorer.com/patterns/KKpsk2).
#[derive(Copy, Clone)]
pub struct KKpsk2;
impl Pattern for KKpsk2 {
    const NAME: &'static str = "KKpsk2";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[Token::S],
        pre_messages_responder: &[Token::S],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::ES, Token::SS],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE, Token::PSK],
            },
        ],
    };
}

/// The `KXpsk2` pattern: the `KX` pattern with a pre-shared key mixed
/// in at the end of the second message.
/// 
/// See [NoiseExplorer: KXpsk2](https://noiseexplorer.com/patterns/KXpsk2).
#[derive(Copy, Clone)]
pub struct KXpsk2;
impl Pattern for KXpsk2 {
    const NAME: &'static str = "KXpsk2";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[Token::S],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E],
            },
            MessagePattern {
                tokens: &[
                    Token::E,
                    Token::EE,
                    Token::SE,
                    Token::S,
                    Token::ES,
                    Token::PSK,
                ],
            },
        ],
    };
}

/// The `INpsk1` pattern: the `IN` pattern with a pre-shared key mixed
/// in at the end of the first message.
/// 
/// See [NoiseExplorer: INpsk1](https://noiseexplorer.com/patterns/INpsk1).
#[derive(Copy, Clone)]
pub struct INpsk1;
impl Pattern for INpsk1 {
    const NAME: &'static str = "INpsk1";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::S, Token::PSK],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE],
            },
        ],
    };
}

/// The `INpsk2` pattern: the `IN` pattern with a pre-shared key mixed
/// in at the end of the second message.
/// 
/// See [NoiseExplorer: INpsk2](https://noiseexplorer.com/patterns/INpsk2).
#[derive(Copy, Clone)]
pub struct INpsk2;
impl Pattern for INpsk2 {
    const NAME: &'static str = "INpsk2";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::S],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE, Token::PSK],
            },
        ],
    };
}

/// The `IKpsk1` pattern: the `IK` pattern with a pre-shared key mixed
/// in at the end of the first message.
/// 
/// See [NoiseExplorer: IKpsk1](https://noiseexplorer.com/patterns/IKpsk1).
#[derive(Copy, Clone)]
pub struct IKpsk1;
impl Pattern for IKpsk1 {
    const NAME: &'static str = "IKpsk1";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::ES, Token::S, Token::SS, Token::PSK],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE],
            },
        ],
    };
}

/// The `IKpsk2` pattern: the `IK` pattern with a pre-shared key mixed
/// in at the end of the second message.
/// 
/// See [NoiseExplorer: IKpsk2](https://noiseexplorer.com/patterns/IKpsk2).
#[derive(Copy, Clone)]
pub struct IKpsk2;
impl Pattern for IKpsk2 {
    const NAME: &'static str = "IKpsk2";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[Token::S],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::ES, Token::S, Token::SS],
            },
            MessagePattern {
                tokens: &[Token::E, Token::EE, Token::SE, Token::PSK],
            },
        ],
    };
}

/// The `IXpsk2` pattern: the `IX` pattern with a pre-shared key mixed
/// in at the end of the second message.
/// 
/// See [NoiseExplorer: IXpsk2](https://noiseexplorer.com/patterns/IXpsk2).
#[derive(Copy, Clone)]
pub struct IXpsk2;
impl Pattern for IXpsk2 {
    const NAME: &'static str = "IXpsk2";
    const HANDSHAKE: HandshakePattern = HandshakePattern {
        pre_messages_initiator: &[],
        pre_messages_responder: &[],
        messages: &[
            MessagePattern {
                tokens: &[Token::E, Token::S],
            },
            MessagePattern {
                tokens: &[
                    Token::E,
                    Token::EE,
                    Token::SE,
                    Token::S,
                    Token::ES,
                    Token::PSK,
                ],
            },
        ],
    };
}