2 * IEEE 802.1X-2010 Controlled Port of PAE state machine - CP state machine
3 * Copyright (c) 2013-2014, Qualcomm Atheros, Inc.
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
9 #include "utils/includes.h"
11 #include "utils/common.h"
12 #include "utils/eloop.h"
13 #include "common/defs.h"
14 #include "common/ieee802_1x_defs.h"
15 #include "utils/state_machine.h"
16 #include "ieee802_1x_kay.h"
17 #include "ieee802_1x_secy_ops.h"
18 #include "pae/ieee802_1x_cp.h"
20 #define STATE_MACHINE_DATA struct ieee802_1x_cp_sm
21 #define STATE_MACHINE_DEBUG_PREFIX "CP"
23 static u64 default_cs_id = CS_ID_GCM_AES_128;
25 /* The variable defined in clause 12 in IEEE Std 802.1X-2010 */
26 enum connect_type { PENDING, UNAUTHENTICATED, AUTHENTICATED, SECURE };
28 struct ieee802_1x_cp_sm {
30 CP_BEGIN, CP_INIT, CP_CHANGE, CP_ALLOWED, CP_AUTHENTICATED,
31 CP_SECURED, CP_RECEIVE, CP_RECEIVING, CP_READY, CP_TRANSMIT,
32 CP_TRANSMITTING, CP_ABANDON, CP_RETIRE
40 enum connect_type connect;
41 u8 *authorization_data;
44 Boolean chgd_server; /* clear by CP */
46 u8 *authorization_data1;
47 enum confidentiality_offset cipher_offset;
49 Boolean new_sak; /* clear by CP */
50 struct ieee802_1x_mka_ki distributed_ki;
52 Boolean using_receive_sas;
53 Boolean all_receiving;
54 Boolean server_transmitting;
55 Boolean using_transmit_sa;
58 struct ieee802_1x_mka_ki *lki;
62 struct ieee802_1x_mka_ki *oki;
68 Boolean protect_frames;
69 enum validate_frames validate_frames;
71 Boolean replay_protect;
74 u64 current_cipher_suite;
75 enum confidentiality_offset confidentiality_offset;
76 Boolean controlled_port_enabled;
79 Boolean port_enabled; /* SecY->CP */
87 /* not defined IEEE Std 802.1X-2010 */
88 struct ieee802_1x_kay *kay;
91 static void ieee802_1x_cp_retire_when_timeout(void *eloop_ctx,
93 static void ieee802_1x_cp_transmit_when_timeout(void *eloop_ctx,
97 static int changed_cipher(struct ieee802_1x_cp_sm *sm)
99 return sm->confidentiality_offset != sm->cipher_offset ||
100 sm->current_cipher_suite != sm->cipher_suite;
104 static int changed_connect(struct ieee802_1x_cp_sm *sm)
106 return sm->connect != SECURE || sm->chgd_server || changed_cipher(sm);
114 sm->controlled_port_enabled = FALSE;
115 secy_cp_control_enable_port(sm->kay, sm->controlled_port_enabled);
117 sm->port_valid = FALSE;
129 sm->port_enabled = TRUE;
130 sm->chgd_server = FALSE;
136 SM_ENTRY(CP, CHANGE);
138 sm->port_valid = FALSE;
139 sm->controlled_port_enabled = FALSE;
140 secy_cp_control_enable_port(sm->kay, sm->controlled_port_enabled);
143 ieee802_1x_kay_delete_sas(sm->kay, sm->lki);
145 ieee802_1x_kay_delete_sas(sm->kay, sm->oki);
149 SM_STATE(CP, ALLOWED)
151 SM_ENTRY(CP, ALLOWED);
153 sm->protect_frames = FALSE;
154 sm->replay_protect = FALSE;
155 sm->validate_frames = Checked;
157 sm->port_valid = FALSE;
158 sm->controlled_port_enabled = TRUE;
160 secy_cp_control_enable_port(sm->kay, sm->controlled_port_enabled);
161 secy_cp_control_protect_frames(sm->kay, sm->protect_frames);
162 secy_cp_control_encrypt(sm->kay, sm->kay->macsec_encrypt);
163 secy_cp_control_validate_frames(sm->kay, sm->validate_frames);
164 secy_cp_control_replay(sm->kay, sm->replay_protect, sm->replay_window);
168 SM_STATE(CP, AUTHENTICATED)
170 SM_ENTRY(CP, AUTHENTICATED);
172 sm->protect_frames = FALSE;
173 sm->replay_protect = FALSE;
174 sm->validate_frames = Checked;
176 sm->port_valid = FALSE;
177 sm->controlled_port_enabled = TRUE;
179 secy_cp_control_enable_port(sm->kay, sm->controlled_port_enabled);
180 secy_cp_control_protect_frames(sm->kay, sm->protect_frames);
181 secy_cp_control_encrypt(sm->kay, sm->kay->macsec_encrypt);
182 secy_cp_control_validate_frames(sm->kay, sm->validate_frames);
183 secy_cp_control_replay(sm->kay, sm->replay_protect, sm->replay_window);
187 SM_STATE(CP, SECURED)
189 SM_ENTRY(CP, SECURED);
191 sm->chgd_server = FALSE;
193 sm->protect_frames = sm->kay->macsec_protect;
194 sm->replay_protect = sm->kay->macsec_replay_protect;
195 sm->validate_frames = sm->kay->macsec_validate;
197 /* NOTE: now no other than default cipher suite (AES-GCM-128) */
198 sm->current_cipher_suite = sm->cipher_suite;
199 secy_cp_control_current_cipher_suite(sm->kay, sm->current_cipher_suite);
201 sm->confidentiality_offset = sm->cipher_offset;
203 sm->port_valid = TRUE;
205 secy_cp_control_confidentiality_offset(sm->kay,
206 sm->confidentiality_offset);
207 secy_cp_control_protect_frames(sm->kay, sm->protect_frames);
208 secy_cp_control_encrypt(sm->kay, sm->kay->macsec_encrypt);
209 secy_cp_control_validate_frames(sm->kay, sm->validate_frames);
210 secy_cp_control_replay(sm->kay, sm->replay_protect, sm->replay_window);
214 SM_STATE(CP, RECEIVE)
216 SM_ENTRY(CP, RECEIVE);
217 /* RECEIVE state machine not keep with Figure 12-2 in
218 * IEEE Std 802.1X-2010 */
223 ieee802_1x_kay_set_old_sa_attr(sm->kay, sm->oki, sm->oan,
226 sm->lki = os_malloc(sizeof(*sm->lki));
228 wpa_printf(MSG_ERROR, "CP-%s: Out of memory", __func__);
231 os_memcpy(sm->lki, &sm->distributed_ki, sizeof(*sm->lki));
232 sm->lan = sm->distributed_an;
235 ieee802_1x_kay_set_latest_sa_attr(sm->kay, sm->lki, sm->lan,
237 ieee802_1x_kay_create_sas(sm->kay, sm->lki);
238 ieee802_1x_kay_enable_rx_sas(sm->kay, sm->lki);
240 sm->all_receiving = FALSE;
244 SM_STATE(CP, RECEIVING)
246 SM_ENTRY(CP, RECEIVING);
249 ieee802_1x_kay_set_latest_sa_attr(sm->kay, sm->lki, sm->lan,
251 sm->transmit_when = sm->transmit_delay;
252 eloop_cancel_timeout(ieee802_1x_cp_transmit_when_timeout, sm, NULL);
253 eloop_register_timeout(sm->transmit_when / 1000, 0,
254 ieee802_1x_cp_transmit_when_timeout, sm, NULL);
255 /* the electedSelf have been set before CP entering to RECEIVING
256 * but the CP will transmit from RECEIVING to READY under
257 * the !electedSelf when KaY is not key server */
258 ieee802_1x_cp_sm_step(sm);
259 sm->using_receive_sas = FALSE;
260 sm->server_transmitting = FALSE;
268 ieee802_1x_kay_enable_new_info(sm->kay);
272 SM_STATE(CP, TRANSMIT)
274 SM_ENTRY(CP, TRANSMIT);
276 sm->controlled_port_enabled = TRUE;
277 secy_cp_control_enable_port(sm->kay, sm->controlled_port_enabled);
279 ieee802_1x_kay_set_latest_sa_attr(sm->kay, sm->lki, sm->lan,
281 ieee802_1x_kay_enable_tx_sas(sm->kay, sm->lki);
282 sm->all_receiving = FALSE;
283 sm->server_transmitting = FALSE;
287 SM_STATE(CP, TRANSMITTING)
289 SM_ENTRY(CP, TRANSMITTING);
290 sm->retire_when = sm->orx ? sm->retire_delay : 0;
292 ieee802_1x_kay_set_old_sa_attr(sm->kay, sm->oki, sm->oan,
294 ieee802_1x_kay_enable_new_info(sm->kay);
295 eloop_cancel_timeout(ieee802_1x_cp_retire_when_timeout, sm, NULL);
296 eloop_register_timeout(sm->retire_when / 1000, 0,
297 ieee802_1x_cp_retire_when_timeout, sm, NULL);
298 sm->using_transmit_sa = FALSE;
302 SM_STATE(CP, ABANDON)
304 SM_ENTRY(CP, ABANDON);
306 ieee802_1x_kay_set_latest_sa_attr(sm->kay, sm->lki, sm->lan,
308 ieee802_1x_kay_delete_sas(sm->kay, sm->lki);
312 ieee802_1x_kay_set_latest_sa_attr(sm->kay, sm->lki, sm->lan,
320 SM_ENTRY(CP, RETIRE);
321 /* RETIRE state machine not keep with Figure 12-2 in
322 * IEEE Std 802.1X-2010 */
327 ieee802_1x_kay_set_old_sa_attr(sm->kay, sm->oki, sm->oan,
333 * CP state machine handler entry
337 if (!sm->port_enabled)
340 switch (sm->CP_state) {
346 SM_ENTER(CP, CHANGE);
350 if (sm->connect == UNAUTHENTICATED)
351 SM_ENTER(CP, ALLOWED);
352 else if (sm->connect == AUTHENTICATED)
353 SM_ENTER(CP, AUTHENTICATED);
354 else if (sm->connect == SECURE)
355 SM_ENTER(CP, SECURED);
359 if (sm->connect != UNAUTHENTICATED)
360 SM_ENTER(CP, CHANGE);
363 case CP_AUTHENTICATED:
364 if (sm->connect != AUTHENTICATED)
365 SM_ENTER(CP, CHANGE);
369 if (changed_connect(sm))
370 SM_ENTER(CP, CHANGE);
371 else if (sm->new_sak)
372 SM_ENTER(CP, RECEIVE);
376 if (sm->using_receive_sas)
377 SM_ENTER(CP, RECEIVING);
381 if (sm->new_sak || changed_connect(sm))
382 SM_ENTER(CP, ABANDON);
383 if (!sm->elected_self)
385 if (sm->elected_self &&
386 (sm->all_receiving || !sm->transmit_when))
387 SM_ENTER(CP, TRANSMIT);
391 if (sm->using_transmit_sa)
392 SM_ENTER(CP, TRANSMITTING);
395 case CP_TRANSMITTING:
396 if (!sm->retire_when || changed_connect(sm))
397 SM_ENTER(CP, RETIRE);
401 if (changed_connect(sm))
402 SM_ENTER(CP, CHANGE);
403 else if (sm->new_sak)
404 SM_ENTER(CP, RECEIVE);
408 if (sm->new_sak || changed_connect(sm))
409 SM_ENTER(CP, RECEIVE);
410 if (sm->server_transmitting)
411 SM_ENTER(CP, TRANSMIT);
414 if (changed_connect(sm))
415 SM_ENTER(CP, RETIRE);
416 else if (sm->new_sak)
417 SM_ENTER(CP, RECEIVE);
420 wpa_printf(MSG_ERROR, "CP: the state machine is not defined");
427 * ieee802_1x_cp_sm_init -
429 struct ieee802_1x_cp_sm * ieee802_1x_cp_sm_init(struct ieee802_1x_kay *kay)
431 struct ieee802_1x_cp_sm *sm;
433 sm = os_zalloc(sizeof(*sm));
435 wpa_printf(MSG_ERROR, "CP-%s: out of memory", __func__);
441 sm->port_valid = FALSE;
443 sm->chgd_server = FALSE;
445 sm->protect_frames = kay->macsec_protect;
446 sm->validate_frames = kay->macsec_validate;
447 sm->replay_protect = kay->macsec_replay_protect;
448 sm->replay_window = kay->macsec_replay_window;
450 sm->controlled_port_enabled = FALSE;
459 sm->current_cipher_suite = default_cs_id;
460 sm->cipher_suite = default_cs_id;
461 sm->cipher_offset = CONFIDENTIALITY_OFFSET_0;
462 sm->confidentiality_offset = sm->cipher_offset;
463 sm->transmit_delay = MKA_LIFE_TIME;
464 sm->retire_delay = MKA_SAK_RETIRE_TIME;
465 sm->CP_state = CP_BEGIN;
467 sm->authorization_data = NULL;
469 wpa_printf(MSG_DEBUG, "CP: state machine created");
471 secy_cp_control_protect_frames(sm->kay, sm->protect_frames);
472 secy_cp_control_encrypt(sm->kay, sm->kay->macsec_encrypt);
473 secy_cp_control_validate_frames(sm->kay, sm->validate_frames);
474 secy_cp_control_replay(sm->kay, sm->replay_protect, sm->replay_window);
475 secy_cp_control_enable_port(sm->kay, sm->controlled_port_enabled);
476 secy_cp_control_confidentiality_offset(sm->kay,
477 sm->confidentiality_offset);
486 static void ieee802_1x_cp_step_run(struct ieee802_1x_cp_sm *sm)
488 enum cp_states prev_state;
491 for (i = 0; i < 100; i++) {
492 prev_state = sm->CP_state;
494 if (prev_state == sm->CP_state)
500 static void ieee802_1x_cp_step_cb(void *eloop_ctx, void *timeout_ctx)
502 struct ieee802_1x_cp_sm *sm = eloop_ctx;
503 ieee802_1x_cp_step_run(sm);
508 * ieee802_1x_cp_sm_deinit -
510 void ieee802_1x_cp_sm_deinit(struct ieee802_1x_cp_sm *sm)
512 wpa_printf(MSG_DEBUG, "CP: state machine removed");
516 eloop_cancel_timeout(ieee802_1x_cp_retire_when_timeout, sm, NULL);
517 eloop_cancel_timeout(ieee802_1x_cp_transmit_when_timeout, sm, NULL);
518 eloop_cancel_timeout(ieee802_1x_cp_step_cb, sm, NULL);
521 os_free(sm->authorization_data);
527 * ieee802_1x_cp_connect_pending
529 void ieee802_1x_cp_connect_pending(void *cp_ctx)
531 struct ieee802_1x_cp_sm *sm = cp_ctx;
533 sm->connect = PENDING;
538 * ieee802_1x_cp_connect_unauthenticated
540 void ieee802_1x_cp_connect_unauthenticated(void *cp_ctx)
542 struct ieee802_1x_cp_sm *sm = (struct ieee802_1x_cp_sm *)cp_ctx;
544 sm->connect = UNAUTHENTICATED;
549 * ieee802_1x_cp_connect_authenticated
551 void ieee802_1x_cp_connect_authenticated(void *cp_ctx)
553 struct ieee802_1x_cp_sm *sm = cp_ctx;
555 sm->connect = AUTHENTICATED;
560 * ieee802_1x_cp_connect_secure
562 void ieee802_1x_cp_connect_secure(void *cp_ctx)
564 struct ieee802_1x_cp_sm *sm = cp_ctx;
566 sm->connect = SECURE;
571 * ieee802_1x_cp_set_chgdserver -
573 void ieee802_1x_cp_signal_chgdserver(void *cp_ctx)
575 struct ieee802_1x_cp_sm *sm = cp_ctx;
577 sm->chgd_server = TRUE;
582 * ieee802_1x_cp_set_electedself -
584 void ieee802_1x_cp_set_electedself(void *cp_ctx, Boolean status)
586 struct ieee802_1x_cp_sm *sm = cp_ctx;
587 sm->elected_self = status;
592 * ieee802_1x_cp_set_authorizationdata -
594 void ieee802_1x_cp_set_authorizationdata(void *cp_ctx, u8 *pdata, int len)
596 struct ieee802_1x_cp_sm *sm = cp_ctx;
597 os_free(sm->authorization_data);
598 sm->authorization_data = os_zalloc(len);
599 if (sm->authorization_data)
600 os_memcpy(sm->authorization_data, pdata, len);
605 * ieee802_1x_cp_set_ciphersuite -
607 void ieee802_1x_cp_set_ciphersuite(void *cp_ctx, u64 cs)
609 struct ieee802_1x_cp_sm *sm = cp_ctx;
610 sm->cipher_suite = cs;
615 * ieee802_1x_cp_set_offset -
617 void ieee802_1x_cp_set_offset(void *cp_ctx, enum confidentiality_offset offset)
619 struct ieee802_1x_cp_sm *sm = cp_ctx;
620 sm->cipher_offset = offset;
625 * ieee802_1x_cp_signal_newsak -
627 void ieee802_1x_cp_signal_newsak(void *cp_ctx)
629 struct ieee802_1x_cp_sm *sm = cp_ctx;
635 * ieee802_1x_cp_set_distributedki -
637 void ieee802_1x_cp_set_distributedki(void *cp_ctx,
638 const struct ieee802_1x_mka_ki *dki)
640 struct ieee802_1x_cp_sm *sm = cp_ctx;
641 os_memcpy(&sm->distributed_ki, dki, sizeof(struct ieee802_1x_mka_ki));
646 * ieee802_1x_cp_set_distributedan -
648 void ieee802_1x_cp_set_distributedan(void *cp_ctx, u8 an)
650 struct ieee802_1x_cp_sm *sm = cp_ctx;
651 sm->distributed_an = an;
656 * ieee802_1x_cp_set_usingreceivesas -
658 void ieee802_1x_cp_set_usingreceivesas(void *cp_ctx, Boolean status)
660 struct ieee802_1x_cp_sm *sm = cp_ctx;
661 sm->using_receive_sas = status;
666 * ieee802_1x_cp_set_allreceiving -
668 void ieee802_1x_cp_set_allreceiving(void *cp_ctx, Boolean status)
670 struct ieee802_1x_cp_sm *sm = cp_ctx;
671 sm->all_receiving = status;
676 * ieee802_1x_cp_set_servertransmitting -
678 void ieee802_1x_cp_set_servertransmitting(void *cp_ctx, Boolean status)
680 struct ieee802_1x_cp_sm *sm = cp_ctx;
681 sm->server_transmitting = status;
686 * ieee802_1x_cp_set_usingtransmitsas -
688 void ieee802_1x_cp_set_usingtransmitas(void *cp_ctx, Boolean status)
690 struct ieee802_1x_cp_sm *sm = cp_ctx;
691 sm->using_transmit_sa = status;
696 * ieee802_1x_cp_sm_step - Advance EAPOL state machines
697 * @sm: EAPOL state machine
699 * This function is called to advance CP state machines after any change
700 * that could affect their state.
702 void ieee802_1x_cp_sm_step(void *cp_ctx)
705 * Run ieee802_1x_cp_step_run from a registered timeout
706 * to make sure that other possible timeouts/events are processed
707 * and to avoid long function call chains.
709 struct ieee802_1x_cp_sm *sm = cp_ctx;
710 eloop_cancel_timeout(ieee802_1x_cp_step_cb, sm, NULL);
711 eloop_register_timeout(0, 0, ieee802_1x_cp_step_cb, sm, NULL);
715 static void ieee802_1x_cp_retire_when_timeout(void *eloop_ctx,
718 struct ieee802_1x_cp_sm *sm = eloop_ctx;
720 ieee802_1x_cp_step_run(sm);
725 ieee802_1x_cp_transmit_when_timeout(void *eloop_ctx, void *timeout_ctx)
727 struct ieee802_1x_cp_sm *sm = eloop_ctx;
728 sm->transmit_when = 0;
729 ieee802_1x_cp_step_run(sm);