-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmka.c
More file actions
2700 lines (2136 loc) · 86.2 KB
/
Copy pathmka.c
File metadata and controls
2700 lines (2136 loc) · 86.2 KB
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
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* mka.c
*
* Lightweight MACsec stack
* MACsec Key Agreement protocol layer.
* This file contains the MKA protocol logic used to build, parse and process
* MKA-related protocol data structures required for MACsec key management.
*
* Copyright (c) 2026 Michal Sarnovsky
*
* SPDX-License-Identifier: MIT
*
* This file is part of the lightweight MACsec stack.
* See LICENSE file in the project root for full license text.
*/
#include "mka.h"
static const uint8_t macsec_mka_dst_mac[6] = {0x01u, 0x80u, 0xC2u, 0x00u, 0x00u, 0x03u};
#define MACSEC_MKA_VERSION_ID 1u
#define MACSEC_MKA_ALGORITHM_AGILITY 0x0080C201u
#define MACSEC_MKA_DEFAULT_TX_INTERVAL_MS 2000u
#define MACSEC_MKA_DEFAULT_CAPABILITY 2u
#define MACSEC_MKA_PEER_TIMEOUT_MULTIPLIER 3u
#define MACSEC_MKA_PARAM_LIVE_PEER_LIST 1u
#define MACSEC_MKA_PARAM_POTENTIAL_PEER_LIST 2u
#define MACSEC_MKA_PARAM_SAK_USE 3u
#define MACSEC_MKA_PARAM_DISTRIBUTED_SAK 4u
static void macsec_mka_raise_events(macsec_mka_ctx_t *ctx, macsec_mka_event_flags_t events);
static void macsec_mka_schedule_tx(macsec_mka_ctx_t *ctx, macsec_mka_tx_reason_flags_t reasons);
static int macsec_mka_key_server_select_an(const macsec_mka_ctx_t *ctx, uint8_t *an_out);
static int macsec_mka_key_server_ensure_sak(macsec_mka_ctx_t *ctx);
static int macsec_mka_start_rekey(macsec_mka_ctx_t *ctx, const char *reason);
#if (MACSEC_DEBUG_LEVEL >= MACSEC_DEBUG_LEVEL_ERROR)
static const char *macsec_mka_state_name(macsec_mka_state_t state)
{
switch (state)
{
case MACSEC_MKA_STATE_INIT:
return "INIT";
case MACSEC_MKA_STATE_WAIT_PEER:
return "WAIT_PEER";
case MACSEC_MKA_STATE_PEER_DISCOVERED:
return "PEER_DISCOVERED";
case MACSEC_MKA_STATE_PEER_LIVE:
return "PEER_LIVE";
case MACSEC_MKA_STATE_OPERATIONAL:
return "OPERATIONAL";
case MACSEC_MKA_STATE_ERROR:
return "ERROR";
default:
return "UNKNOWN";
}
}
static const char *macsec_mka_sak_state_name(macsec_mka_sak_state_t state)
{
switch (state)
{
case MACSEC_MKA_SAK_STATE_NONE:
return "NONE";
case MACSEC_MKA_SAK_STATE_CANDIDATE:
return "CANDIDATE";
case MACSEC_MKA_SAK_STATE_DISTRIBUTION_PENDING:
return "DISTRIBUTION_PENDING";
case MACSEC_MKA_SAK_STATE_DISTRIBUTED:
return "DISTRIBUTED";
case MACSEC_MKA_SAK_STATE_INSTALL_PENDING:
return "INSTALL_PENDING";
case MACSEC_MKA_SAK_STATE_ACTIVE:
return "ACTIVE";
case MACSEC_MKA_SAK_STATE_CONFIRMED:
return "CONFIRMED";
case MACSEC_MKA_SAK_STATE_RETIRING:
return "RETIRING";
default:
return "UNKNOWN";
}
}
#endif
static macsec_bool_t macsec_mka_state_transition_allowed(macsec_mka_state_t old_state,
macsec_mka_state_t new_state)
{
if (old_state == new_state)
{
return MACSEC_TRUE;
}
/*
* An unrecoverable error may be entered from any state.
*/
if (new_state == MACSEC_MKA_STATE_ERROR)
{
return MACSEC_TRUE;
}
switch (old_state)
{
case MACSEC_MKA_STATE_INIT:
return (new_state == MACSEC_MKA_STATE_WAIT_PEER) ? MACSEC_TRUE : MACSEC_FALSE;
case MACSEC_MKA_STATE_WAIT_PEER:
return ((new_state == MACSEC_MKA_STATE_PEER_DISCOVERED) ||
(new_state == MACSEC_MKA_STATE_PEER_LIVE))
? MACSEC_TRUE
: MACSEC_FALSE;
case MACSEC_MKA_STATE_PEER_DISCOVERED:
return ((new_state == MACSEC_MKA_STATE_WAIT_PEER) ||
(new_state == MACSEC_MKA_STATE_PEER_LIVE))
? MACSEC_TRUE
: MACSEC_FALSE;
case MACSEC_MKA_STATE_PEER_LIVE:
return ((new_state == MACSEC_MKA_STATE_WAIT_PEER) ||
(new_state == MACSEC_MKA_STATE_PEER_DISCOVERED) ||
(new_state == MACSEC_MKA_STATE_OPERATIONAL))
? MACSEC_TRUE
: MACSEC_FALSE;
case MACSEC_MKA_STATE_OPERATIONAL:
return ((new_state == MACSEC_MKA_STATE_WAIT_PEER) ||
(new_state == MACSEC_MKA_STATE_PEER_DISCOVERED) ||
(new_state == MACSEC_MKA_STATE_PEER_LIVE))
? MACSEC_TRUE
: MACSEC_FALSE;
case MACSEC_MKA_STATE_ERROR:
/*
* Recovery requires clear + init, not a direct transition.
*/
return MACSEC_FALSE;
default:
return MACSEC_FALSE;
}
}
static void macsec_mka_set_state(macsec_mka_ctx_t *ctx, macsec_mka_state_t new_state,
const char *reason)
{
macsec_mka_state_t old_state;
(void) reason;
macsec_assert(ctx != NULL);
old_state = ctx->state;
if (old_state == new_state)
{
return;
}
if (!macsec_mka_state_transition_allowed(old_state, new_state))
{
MACSEC_ERROR(("MKA invalid state transition %s(%u) -> %s(%u): %s\n",
macsec_mka_state_name(old_state), (unsigned) old_state,
macsec_mka_state_name(new_state), (unsigned) new_state,
(reason != NULL) ? reason : "no reason"));
macsec_mka_raise_events(ctx, MACSEC_MKA_EVENT_ERROR);
macsec_mka_set_state(ctx, MACSEC_MKA_STATE_ERROR, "MKA initialization failed");
ctx->pending_events |= MACSEC_MKA_EVENT_ERROR;
return;
}
MACSEC_MEDIUM(("MKA state %s(%u) -> %s(%u): %s\n", macsec_mka_state_name(old_state),
(unsigned) old_state, macsec_mka_state_name(new_state), (unsigned) new_state,
(reason != NULL) ? reason : "no reason"));
ctx->state = new_state;
}
static macsec_bool_t macsec_mka_sak_transition_allowed(macsec_mka_sak_state_t old_state,
macsec_mka_sak_state_t new_state)
{
if (old_state == new_state)
{
return MACSEC_TRUE;
}
switch (old_state)
{
case MACSEC_MKA_SAK_STATE_NONE:
return (new_state == MACSEC_MKA_SAK_STATE_CANDIDATE) ? MACSEC_TRUE : MACSEC_FALSE;
case MACSEC_MKA_SAK_STATE_CANDIDATE:
return ((new_state == MACSEC_MKA_SAK_STATE_DISTRIBUTION_PENDING) ||
(new_state == MACSEC_MKA_SAK_STATE_INSTALL_PENDING) ||
(new_state == MACSEC_MKA_SAK_STATE_NONE))
? MACSEC_TRUE
: MACSEC_FALSE;
case MACSEC_MKA_SAK_STATE_DISTRIBUTION_PENDING:
return ((new_state == MACSEC_MKA_SAK_STATE_DISTRIBUTED) ||
(new_state == MACSEC_MKA_SAK_STATE_NONE))
? MACSEC_TRUE
: MACSEC_FALSE;
case MACSEC_MKA_SAK_STATE_DISTRIBUTED:
return ((new_state == MACSEC_MKA_SAK_STATE_INSTALL_PENDING) ||
(new_state == MACSEC_MKA_SAK_STATE_RETIRING))
? MACSEC_TRUE
: MACSEC_FALSE;
case MACSEC_MKA_SAK_STATE_INSTALL_PENDING:
return ((new_state == MACSEC_MKA_SAK_STATE_ACTIVE) ||
(new_state == MACSEC_MKA_SAK_STATE_RETIRING))
? MACSEC_TRUE
: MACSEC_FALSE;
case MACSEC_MKA_SAK_STATE_ACTIVE:
return ((new_state == MACSEC_MKA_SAK_STATE_CONFIRMED) ||
(new_state == MACSEC_MKA_SAK_STATE_RETIRING))
? MACSEC_TRUE
: MACSEC_FALSE;
case MACSEC_MKA_SAK_STATE_CONFIRMED:
return ((new_state == MACSEC_MKA_SAK_STATE_ACTIVE) ||
(new_state == MACSEC_MKA_SAK_STATE_RETIRING))
? MACSEC_TRUE
: MACSEC_FALSE;
case MACSEC_MKA_SAK_STATE_RETIRING:
return (new_state == MACSEC_MKA_SAK_STATE_NONE) ? MACSEC_TRUE : MACSEC_FALSE;
default:
return MACSEC_FALSE;
}
}
static void macsec_mka_set_sak_state(macsec_mka_ctx_t *ctx, macsec_mka_sak_t *sak,
macsec_mka_sak_state_t new_state, const char *reason)
{
macsec_mka_sak_state_t old_state;
(void) reason;
macsec_assert(ctx != NULL);
macsec_assert(sak != NULL);
old_state = sak->lifecycle_state;
if (old_state == new_state)
{
return;
}
if (!macsec_mka_sak_transition_allowed(old_state, new_state))
{
MACSEC_ERROR(("MKA invalid SAK transition %s(%u) -> %s(%u): key=%lu an=%u reason=%s\n",
macsec_mka_sak_state_name(old_state), (unsigned) old_state,
macsec_mka_sak_state_name(new_state), (unsigned) new_state,
(unsigned long) sak->key_number, sak->an,
(reason != NULL) ? reason : "no reason"));
macsec_mka_set_state(ctx, MACSEC_MKA_STATE_ERROR, "invalid SAK state transition");
return;
}
MACSEC_MEDIUM(("MKA SAK state %s(%u) -> %s(%u): key=%lu an=%u reason=%s\n",
macsec_mka_sak_state_name(old_state), (unsigned) old_state,
macsec_mka_sak_state_name(new_state), (unsigned) new_state,
(unsigned long) sak->key_number, sak->an,
(reason != NULL) ? reason : "no reason"));
sak->lifecycle_state = new_state;
}
static void macsec_mka_sak_clear(macsec_mka_sak_t *sak)
{
macsec_assert(sak != NULL);
macsec_zeroize(sak, sizeof(*sak));
sak->origin = MACSEC_MKA_SAK_ORIGIN_NONE;
sak->lifecycle_state = MACSEC_MKA_SAK_STATE_NONE;
}
static int macsec_mka_move_latest_to_old(macsec_mka_ctx_t *ctx, const char *reason)
{
macsec_check(ctx != NULL, MACSEC_ERR_PARAM);
if (ctx->latest_sak.lifecycle_state == MACSEC_MKA_SAK_STATE_NONE)
{
return MACSEC_ERR_NOT_READY;
}
if (ctx->old_sak.lifecycle_state != MACSEC_MKA_SAK_STATE_NONE)
{
MACSEC_ERROR(("MKA cannot start overlapping rekey: old key=%lu an=%u state=%u\n",
(unsigned long) ctx->old_sak.key_number, ctx->old_sak.an,
(unsigned) ctx->old_sak.lifecycle_state));
return MACSEC_ERR_BUSY;
}
/*
* Only a SAK that reached the data-plane needs an old-key overlap.
* A candidate that was never installed can be securely superseded
* without occupying old_sak.
*/
if (!ctx->latest_sak.rx_installed && !ctx->latest_sak.tx_installed)
{
MACSEC_MEDIUM(("MKA uninstalled latest SAK superseded: key_number=%lu an=%u\n",
(unsigned long) ctx->latest_sak.key_number, ctx->latest_sak.an));
macsec_mka_sak_clear(&ctx->latest_sak);
return MACSEC_ERR_OK;
}
ctx->old_sak = ctx->latest_sak;
ctx->old_sak.peer_rx_confirmed = MACSEC_FALSE;
ctx->old_sak.peer_tx_confirmed = MACSEC_FALSE;
macsec_mka_set_sak_state(ctx, &ctx->old_sak, MACSEC_MKA_SAK_STATE_RETIRING, reason);
if (ctx->old_sak.lifecycle_state != MACSEC_MKA_SAK_STATE_RETIRING)
{
return MACSEC_ERR_STATE;
}
MACSEC_MEDIUM(("MKA latest SAK moved to old slot: key_number=%lu an=%u rx=%u tx=%u\n",
(unsigned long) ctx->old_sak.key_number, ctx->old_sak.an,
ctx->old_sak.rx_installed ? 1u : 0u, ctx->old_sak.tx_installed ? 1u : 0u));
macsec_mka_sak_clear(&ctx->latest_sak);
return MACSEC_ERR_OK;
}
static void macsec_mka_raise_events(macsec_mka_ctx_t *ctx, macsec_mka_event_flags_t events)
{
macsec_assert(ctx != NULL);
if (events == MACSEC_MKA_EVENT_NONE)
{
return;
}
ctx->pending_events |= events;
MACSEC_INFO(("MKA events raised: requested=0x%08lX pending=0x%08lX\n", (unsigned long) events,
(unsigned long) ctx->pending_events));
}
static void macsec_mka_schedule_tx(macsec_mka_ctx_t *ctx, macsec_mka_tx_reason_flags_t reasons)
{
macsec_assert(ctx != NULL);
if (reasons == MACSEC_MKA_TX_REASON_NONE)
{
return;
}
ctx->tx_reasons |= reasons;
MACSEC_INFO(("MKA TX scheduled: requested=0x%08lX pending=0x%08lX\n", (unsigned long) reasons,
(unsigned long) ctx->tx_reasons));
}
static void macsec_mka_build_sci(uint8_t sci[MACSEC_MKA_SCI_LEN], const uint8_t mac[6],
uint16_t port_id)
{
memcpy(&sci[0], mac, 6u);
macsec_wr_be16(&sci[6], port_id);
}
static macsec_bool_t macsec_mka_local_wins_key_server(const macsec_mka_ctx_t *ctx)
{
if (!ctx->peer.valid)
{
return MACSEC_TRUE;
}
if (ctx->key_server_priority < ctx->peer.key_server_priority)
{
return MACSEC_TRUE;
}
if (ctx->key_server_priority > ctx->peer.key_server_priority)
{
return MACSEC_FALSE;
}
/*
* Tie-breaker for early implementation.
* Lower SCI wins.
*/
return macsec_compare(ctx->local_sci, ctx->peer.sci, MACSEC_MKA_SCI_LEN) < 0;
}
macsec_bool_t macsec_mka_is_eapol_mka(const uint8_t *frame, size_t frame_len)
{
if ((frame == NULL) || (frame_len < 18u))
{
return MACSEC_FALSE;
}
if (macsec_rd_be16(&frame[12]) != MACSEC_MKA_ETHERTYPE_EAPOL)
{
return MACSEC_FALSE;
}
if (frame[15] != MACSEC_MKA_EAPOL_TYPE_MKA)
{
return MACSEC_FALSE;
}
return MACSEC_TRUE;
}
int macsec_mka_parse_basic(const uint8_t *frame, size_t frame_len, macsec_mka_basic_t *out)
{
const uint8_t *p;
uint16_t eth_type;
uint16_t eapol_len;
uint16_t body_len;
size_t expected_len;
size_t cak_name_len;
size_t basic_end_offset;
size_t icv_offset;
macsec_assert(frame != NULL);
macsec_assert(out != NULL);
macsec_check(frame_len >= (14u + 4u + 4u + 28u + 16u), MACSEC_ERR_BUFFER);
memset(out, 0, sizeof(*out));
memcpy(out->dst_mac, &frame[0], 6u);
memcpy(out->src_mac, &frame[6], 6u);
eth_type = macsec_rd_be16(&frame[12]);
macsec_check(eth_type == MACSEC_MKA_ETHERTYPE_EAPOL, MACSEC_ERR_PARAM);
p = &frame[14];
out->eapol_version = p[0];
out->eapol_type = p[1];
out->eapol_len = macsec_rd_be16(&p[2]);
macsec_check(out->eapol_type == MACSEC_MKA_EAPOL_TYPE_MKA, MACSEC_ERR_UNSUPPORTED);
eapol_len = out->eapol_len;
expected_len = 14u + 4u + eapol_len;
macsec_check(frame_len >= expected_len, MACSEC_ERR_BUFFER);
macsec_check(eapol_len >= (4u + 28u + MACSEC_MKA_ICV_LEN), MACSEC_ERR_BUFFER);
/*
* Basic Parameter Set starts immediately after EAPOL header.
*/
p = &frame[18];
out->mka_version = p[0];
out->key_server_priority = p[1];
out->key_server = (p[2] & 0x80u) ? 1 : 0;
out->macsec_desired = (p[2] & 0x40u) ? 1 : 0;
out->macsec_capability = (uint8_t) ((p[2] >> 4u) & 0x03u);
body_len = (uint16_t) (((uint16_t) (p[2] & 0x0Fu) << 8u) | p[3]);
out->body_len = body_len;
macsec_check(body_len >= 28u, MACSEC_ERR_BUFFER);
/*
* Basic parameter set total = 4 B header + body_len.
* ICV follows at the end of the MKPDU.
*/
basic_end_offset = 18u + 4u + body_len;
icv_offset = 14u + 4u + eapol_len - MACSEC_MKA_ICV_LEN;
macsec_check(basic_end_offset <= icv_offset, MACSEC_ERR_BUFFER);
macsec_check((icv_offset + MACSEC_MKA_ICV_LEN) <= frame_len, MACSEC_ERR_BUFFER);
p += 4u;
memcpy(out->sci, p, MACSEC_MKA_SCI_LEN);
p += MACSEC_MKA_SCI_LEN;
memcpy(out->actor_mi, p, MACSEC_MKA_MI_LEN);
p += MACSEC_MKA_MI_LEN;
out->actor_mn = macsec_rd_be32(p);
p += 4u;
out->algorithm_agility = macsec_rd_be32(p);
p += 4u;
cak_name_len = body_len - 28u;
macsec_check(cak_name_len <= MACSEC_MKA_CA_NAME_MAX_LEN, MACSEC_ERR_BUFFER);
memcpy(out->cak_name, p, cak_name_len);
out->cak_name_len = cak_name_len;
memcpy(out->icv, &frame[icv_offset], MACSEC_MKA_ICV_LEN);
MACSEC_INFO(("MKA Basic parsed: eapol_len=%u body_len=%u mn=%lu priority=%u key_server=%u "
"desired=%u cap=%u cak_name_len=%lu\n",
out->eapol_len, out->body_len, (unsigned long) out->actor_mn,
out->key_server_priority, out->key_server ? 1u : 0u, out->macsec_desired ? 1u : 0u,
out->macsec_capability, (unsigned long) out->cak_name_len));
MACSEC_INFO_HEX(("MKA Basic src MAC", out->src_mac, 6));
MACSEC_INFO_HEX(("MKA Basic SCI", out->sci, MACSEC_MKA_SCI_LEN));
MACSEC_INFO_HEX(("MKA Basic actor MI", out->actor_mi, MACSEC_MKA_MI_LEN));
MACSEC_INFO_HEX(("MKA Basic ICV", out->icv, MACSEC_MKA_ICV_LEN));
return MACSEC_ERR_OK;
}
int macsec_mka_init(macsec_mka_ctx_t *ctx, const uint8_t *cak, size_t cak_len, const uint8_t *ckn,
size_t ckn_len, const uint8_t local_mac[6], uint16_t port_id,
uint8_t key_server_priority, uint32_t tx_interval_ms)
{
int ret;
macsec_assert(ctx != NULL);
macsec_assert(local_mac != NULL);
memset(ctx, 0, sizeof(*ctx));
/*
* These values are also produced by memset(), but keeping them explicit
* documents the initial states and protects the code if enum values are
* changed later.
*/
ctx->state = MACSEC_MKA_STATE_INIT;
macsec_mka_sak_clear(&ctx->latest_sak);
macsec_mka_sak_clear(&ctx->old_sak);
memcpy(ctx->local_mac, local_mac, MACSEC_MKA_SRC_LEN);
macsec_mka_build_sci(ctx->local_sci, local_mac, port_id);
macsec_random(ctx->local_mi, MACSEC_MKA_MI_LEN);
ctx->local_mn = 1u;
ctx->key_server_priority = key_server_priority;
/*
* Until a valid peer is known, the local participant provisionally
* considers itself the Key Server. Election is repeated after peer data
* is received.
*/
ctx->local_key_server = MACSEC_TRUE;
ctx->macsec_desired = MACSEC_TRUE;
ctx->macsec_capability = MACSEC_MKA_DEFAULT_CAPABILITY;
ctx->key_server_next_key_number = 1u;
ctx->key_server_next_an = 0u;
ctx->tx_interval_ms =
(tx_interval_ms != 0u) ? tx_interval_ms : MACSEC_MKA_DEFAULT_TX_INTERVAL_MS;
MACSEC_MEDIUM(("MKA init: priority=%u tx_interval=%lu ms port=%u\n", ctx->key_server_priority,
(unsigned long) ctx->tx_interval_ms, (unsigned) port_id));
MACSEC_MEDIUM_HEX(("MKA local MAC", ctx->local_mac, MACSEC_MKA_SRC_LEN));
MACSEC_MEDIUM_HEX(("MKA local SCI", ctx->local_sci, MACSEC_MKA_SCI_LEN));
MACSEC_MEDIUM_HEX(("MKA local MI", ctx->local_mi, MACSEC_MKA_MI_LEN));
ret = macsec_mka_crypto_init(&ctx->crypto);
if (ret != MACSEC_ERR_OK)
{
MACSEC_ERROR(("MKA crypto init failed ret=%d\n", ret));
macsec_mka_raise_events(ctx, MACSEC_MKA_EVENT_ERROR);
macsec_mka_set_state(ctx, MACSEC_MKA_STATE_ERROR, "crypto initialization failed");
return ret;
}
ret = macsec_mka_crypto_set_psk(&ctx->crypto, cak, cak_len, ckn, ckn_len);
if (ret != MACSEC_ERR_OK)
{
MACSEC_ERROR(("MKA set PSK failed ret=%d cak_len=%lu ckn_len=%lu\n", ret,
(unsigned long) cak_len, (unsigned long) ckn_len));
macsec_mka_raise_events(ctx, MACSEC_MKA_EVENT_ERROR);
macsec_mka_set_state(ctx, MACSEC_MKA_STATE_ERROR, "PSK configuration failed");
return ret;
}
ret = macsec_mka_crypto_derive_ick_kek(&ctx->crypto);
if (ret != MACSEC_ERR_OK)
{
MACSEC_ERROR(("MKA derive ICK/KEK failed ret=%d\n", ret));
macsec_mka_raise_events(ctx, MACSEC_MKA_EVENT_ERROR);
macsec_mka_set_state(ctx, MACSEC_MKA_STATE_ERROR, "ICK/KEK derivation failed");
return ret;
}
MACSEC_MEDIUM_HEX(("MKA derived ICK", ctx->crypto.keys.ick, 16));
MACSEC_MEDIUM_HEX(("MKA derived KEK", ctx->crypto.keys.kek, 16));
ctx->verify_icv = MACSEC_TRUE;
ctx->last_icv_valid = MACSEC_FALSE;
macsec_mka_set_state(ctx, MACSEC_MKA_STATE_WAIT_PEER, "MKA initialization complete");
/*
* Initial transmission is scheduled only after crypto initialization,
* PSK setup and key derivation have all succeeded.
*/
macsec_mka_raise_events(ctx, MACSEC_MKA_EVENT_TX_INITIAL);
macsec_mka_schedule_tx(ctx, MACSEC_MKA_TX_REASON_INITIAL);
MACSEC_MEDIUM(("MKA init done: state=%u events=0x%08lX tx_reasons=0x%08lX\n",
(unsigned) ctx->state, (unsigned long) ctx->pending_events,
(unsigned long) ctx->tx_reasons));
return MACSEC_ERR_OK;
}
void macsec_mka_clear(macsec_mka_ctx_t *ctx)
{
macsec_assert(ctx != NULL);
MACSEC_MEDIUM(("MKA clear\n"));
macsec_mka_crypto_clear(&ctx->crypto);
macsec_zeroize(ctx, sizeof(*ctx));
}
macsec_mka_state_t macsec_mka_get_state(const macsec_mka_ctx_t *ctx)
{
macsec_assert(ctx != NULL);
return ctx->state;
}
macsec_mka_event_flags_t macsec_mka_take_events(macsec_mka_ctx_t *ctx)
{
macsec_mka_event_flags_t events;
macsec_assert(ctx != NULL);
events = ctx->pending_events;
ctx->pending_events = MACSEC_MKA_EVENT_NONE;
MACSEC_INFO(("MKA events taken: events=0x%08lX\n", (unsigned long) events));
return events;
}
int macsec_mka_take_sak_for_install(macsec_mka_ctx_t *ctx, macsec_mka_sak_t *sak)
{
macsec_bool_t available;
macsec_check(ctx != NULL, MACSEC_ERR_PARAM);
macsec_check(sak != NULL, MACSEC_ERR_PARAM);
/*
* The output must never contain stale key material when no SAK can
* currently be returned.
*/
memset(sak, 0, sizeof(*sak));
if (ctx->latest_sak.lifecycle_state == MACSEC_MKA_SAK_STATE_NONE)
{
return MACSEC_ERR_NOT_READY;
}
/*
* Validate the stored SAK before exposing it to macsec.c.
*
* Invalid internal SAK data indicates an MKA state-machine error rather
* than a caller parameter error.
*/
if ((ctx->latest_sak.sak_len != 16u) && (ctx->latest_sak.sak_len != 32u))
{
return MACSEC_ERR_STATE;
}
if (ctx->latest_sak.an >= MACSEC_FRAME_MAX_SA)
{
return MACSEC_ERR_STATE;
}
if (ctx->latest_sak.key_number == 0u)
{
return MACSEC_ERR_STATE;
}
available = MACSEC_FALSE;
/*
* A SAK received from the remote Key Server can be installed as soon
* as it has been successfully authenticated and unwrapped.
*/
if ((ctx->latest_sak.origin == MACSEC_MKA_SAK_ORIGIN_REMOTE_KEY_SERVER) &&
(ctx->latest_sak.lifecycle_state == MACSEC_MKA_SAK_STATE_CANDIDATE))
{
available = MACSEC_TRUE;
}
/*
* A locally generated Key Server SAK must first be distributed in a
* successfully transmitted MKPDU.
*/
if ((ctx->latest_sak.origin == MACSEC_MKA_SAK_ORIGIN_LOCAL_KEY_SERVER) &&
(ctx->latest_sak.lifecycle_state == MACSEC_MKA_SAK_STATE_DISTRIBUTED))
{
available = MACSEC_TRUE;
}
/*
* INSTALL_PENDING is intentionally returned again.
*
* This supports retry when RX or TX installation failed, or when the
* corresponding installation confirmation could not be completed.
*/
if (ctx->latest_sak.lifecycle_state == MACSEC_MKA_SAK_STATE_INSTALL_PENDING)
{
if ((ctx->latest_sak.origin == MACSEC_MKA_SAK_ORIGIN_REMOTE_KEY_SERVER) ||
(ctx->latest_sak.origin == MACSEC_MKA_SAK_ORIGIN_LOCAL_KEY_SERVER))
{
available = MACSEC_TRUE;
}
}
if (!available)
{
return MACSEC_ERR_NOT_READY;
}
/*
* A fully installed SAK should already be ACTIVE. Do not repeatedly
* return it even if the lifecycle state was left inconsistent.
*/
if (ctx->latest_sak.rx_installed && ctx->latest_sak.tx_installed)
{
return MACSEC_ERR_NOT_READY;
}
if ((ctx->old_sak.lifecycle_state != MACSEC_MKA_SAK_STATE_NONE) &&
((ctx->latest_sak.an & 0x03u) == (ctx->old_sak.an & 0x03u)))
{
MACSEC_ERROR(("MKA SAK AN collision before installation: "
"latest_key=%lu latest_an=%u "
"old_key=%lu old_an=%u\n",
(unsigned long) ctx->latest_sak.key_number, ctx->latest_sak.an & 0x03u,
(unsigned long) ctx->old_sak.key_number, ctx->old_sak.an & 0x03u));
return MACSEC_ERR_STATE;
}
/*
* Move the SAK into the installation lifecycle only on its first
* handoff. Retry calls keep the existing direction flags unchanged.
*/
if (ctx->latest_sak.lifecycle_state != MACSEC_MKA_SAK_STATE_INSTALL_PENDING)
{
macsec_mka_set_sak_state(ctx, &ctx->latest_sak, MACSEC_MKA_SAK_STATE_INSTALL_PENDING,
"SAK handed to MACsec data-plane");
}
/*
* Copy the current state after the lifecycle transition so that the
* caller receives INSTALL_PENDING together with the current RX/TX
* installation flags.
*/
*sak = ctx->latest_sak;
return MACSEC_ERR_OK;
}
int macsec_mka_notify_sak_installed(macsec_mka_ctx_t *ctx, uint32_t key_number, uint8_t an,
macsec_mka_install_directions_t installed_directions,
uint32_t lowest_pn)
{
uint32_t normalized_lowest_pn;
macsec_assert(ctx != NULL);
if (ctx->latest_sak.lifecycle_state == MACSEC_MKA_SAK_STATE_NONE)
{
return MACSEC_ERR_NOT_READY;
}
if (ctx->latest_sak.lifecycle_state != MACSEC_MKA_SAK_STATE_INSTALL_PENDING)
{
return MACSEC_ERR_STATE;
}
if (ctx->latest_sak.key_number != key_number)
{
return MACSEC_ERR_PARAM;
}
if ((ctx->latest_sak.an & 0x03u) != (an & 0x03u))
{
return MACSEC_ERR_PARAM;
}
if ((installed_directions == MACSEC_MKA_INSTALL_NONE) ||
((installed_directions & (uint8_t) ~(MACSEC_MKA_INSTALL_RX | MACSEC_MKA_INSTALL_TX)) != 0u))
{
return MACSEC_ERR_PARAM;
}
normalized_lowest_pn = (lowest_pn != 0u) ? lowest_pn : 1u;
if ((installed_directions & MACSEC_MKA_INSTALL_RX) != 0u)
{
ctx->latest_sak.rx_installed = MACSEC_TRUE;
}
if ((installed_directions & MACSEC_MKA_INSTALL_TX) != 0u)
{
ctx->latest_sak.tx_installed = MACSEC_TRUE;
/*
* frame_crypto has a single active TX SA. Installing the latest TX
* SAK therefore means that the old SAK is no longer used for TX,
* although it may remain installed for RX during the overlap.
*/
if (ctx->old_sak.lifecycle_state == MACSEC_MKA_SAK_STATE_RETIRING)
{
ctx->old_sak.tx_installed = MACSEC_FALSE;
}
}
ctx->latest_sak.lowest_pn = normalized_lowest_pn;
MACSEC_MEDIUM(("MKA SAK installation notified: key_number=%lu an=%u directions=0x%02X rx=%u "
"tx=%u lowest_pn=%lu\n",
(unsigned long) ctx->latest_sak.key_number, ctx->latest_sak.an,
installed_directions, ctx->latest_sak.rx_installed ? 1u : 0u,
ctx->latest_sak.tx_installed ? 1u : 0u, (unsigned long) normalized_lowest_pn));
if (!ctx->latest_sak.rx_installed || !ctx->latest_sak.tx_installed)
{
return MACSEC_ERR_OK;
}
macsec_mka_set_sak_state(ctx, &ctx->latest_sak, MACSEC_MKA_SAK_STATE_ACTIVE,
"SAK installed for RX and TX");
if (ctx->latest_sak.lifecycle_state != MACSEC_MKA_SAK_STATE_ACTIVE)
{
return MACSEC_ERR_STATE;
}
macsec_mka_raise_events(ctx, MACSEC_MKA_EVENT_SAK_ACTIVE | MACSEC_MKA_EVENT_TX_SAK_USE);
/*
* Peer confirmation may have arrived before local installation
* completed. In that case complete the lifecycle now.
*/
if (ctx->latest_sak.peer_rx_confirmed && ctx->latest_sak.peer_tx_confirmed)
{
macsec_mka_set_sak_state(ctx, &ctx->latest_sak, MACSEC_MKA_SAK_STATE_CONFIRMED,
"locally installed SAK was already confirmed by peer");
if (ctx->latest_sak.lifecycle_state != MACSEC_MKA_SAK_STATE_CONFIRMED)
{
return MACSEC_ERR_STATE;
}
macsec_mka_raise_events(ctx, MACSEC_MKA_EVENT_SAK_CONFIRMED);
if (ctx->old_sak.lifecycle_state == MACSEC_MKA_SAK_STATE_RETIRING)
{
macsec_mka_raise_events(ctx, MACSEC_MKA_EVENT_SAK_RETIRE_REQUIRED);
}
}
macsec_mka_schedule_tx(ctx, MACSEC_MKA_TX_REASON_SAK_USE);
if (ctx->peer.valid && ctx->peer.live)
{
macsec_mka_set_state(ctx, MACSEC_MKA_STATE_OPERATIONAL,
"active SAK installed in data-plane");
if (ctx->state != MACSEC_MKA_STATE_OPERATIONAL)
{
return MACSEC_ERR_STATE;
}
}
return MACSEC_ERR_OK;
}
int macsec_mka_notify_sak_retired(macsec_mka_ctx_t *ctx, uint32_t key_number, uint8_t an)
{
macsec_assert(ctx != NULL);
if (ctx->old_sak.lifecycle_state == MACSEC_MKA_SAK_STATE_NONE)
{
return MACSEC_ERR_NOT_READY;
}
if (ctx->old_sak.key_number != key_number)
{
MACSEC_ERROR(("MKA old SAK retirement rejected: key_number=%lu expected=%lu\n",
(unsigned long) key_number, (unsigned long) ctx->old_sak.key_number));
return MACSEC_ERR_PARAM;
}
if ((ctx->old_sak.an & 0x03u) != (an & 0x03u))
{
MACSEC_ERROR(("MKA old SAK retirement rejected: AN=%u expected=%u\n", an & 0x03u,
ctx->old_sak.an & 0x03u));
return MACSEC_ERR_PARAM;
}
if (ctx->old_sak.lifecycle_state != MACSEC_MKA_SAK_STATE_RETIRING)
{
return MACSEC_ERR_STATE;
}
MACSEC_MEDIUM(("MKA old SAK retired: key_number=%lu an=%u\n",
(unsigned long) ctx->old_sak.key_number, ctx->old_sak.an));
macsec_mka_set_sak_state(ctx, &ctx->old_sak, MACSEC_MKA_SAK_STATE_NONE,
"retiring old SAK removed from data-plane");
if (ctx->old_sak.lifecycle_state != MACSEC_MKA_SAK_STATE_NONE)
{
return MACSEC_ERR_STATE;
}
macsec_mka_sak_clear(&ctx->old_sak);
macsec_mka_raise_events(ctx, MACSEC_MKA_EVENT_SAK_RETIRED);
return MACSEC_ERR_OK;
}
static macsec_bool_t macsec_mka_frame_contains_peer_entry(const uint8_t *frame, size_t frame_len,
const uint8_t mi[MACSEC_MKA_MI_LEN],
uint32_t *mn_out, uint8_t *list_type_out)
{
uint16_t eapol_len;
size_t pos;
size_t end;
if ((frame == NULL) || (mi == NULL) || (frame_len < 90u))
{
MACSEC_INFO(("MKA peer-list scan skipped: frame_len=%lu\n", (unsigned long) frame_len));
return MACSEC_FALSE;
}
if (list_type_out != NULL)
{
*list_type_out = 0u;
}
eapol_len = macsec_rd_be16(&frame[16]);
if (eapol_len < MACSEC_MKA_ICV_LEN)
{
MACSEC_ERROR(("MKA peer-list scan invalid EAPOL length=%u\n", eapol_len));
return MACSEC_FALSE;
}
end = 14u + 4u + eapol_len - MACSEC_MKA_ICV_LEN;
if (end > frame_len)
{
MACSEC_ERROR(("MKA peer-list scan invalid end=%lu frame_len=%lu\n", (unsigned long) end,
(unsigned long) frame_len));
return MACSEC_FALSE;
}