2 * FST module - FST Session implementation
3 * Copyright (c) 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 "fst/fst_internal.h"
15 #include "fst/fst_defs.h"
16 #include "fst/fst_ctrl_iface.h"
17 #ifdef CONFIG_FST_TEST
18 #include "fst/fst_ctrl_defs.h"
19 #endif /* CONFIG_FST_TEST */
21 #define US_80211_TU 1024
23 #define US_TO_TU(m) ((m) * / US_80211_TU)
24 #define TU_TO_US(m) ((m) * US_80211_TU)
26 #define FST_LLT_SWITCH_IMMEDIATELY 0
28 #define fst_printf_session(s, level, format, ...) \
29 fst_printf((level), "%u (0x%08x): [" MACSTR "," MACSTR "] :" format, \
30 (s)->id, (s)->data.fsts_id, \
31 MAC2STR((s)->data.old_peer_addr), \
32 MAC2STR((s)->data.new_peer_addr), \
35 #define fst_printf_siface(s, iface, level, format, ...) \
36 fst_printf_session((s), (level), "%s: " format, \
37 fst_iface_get_name(iface), ##__VA_ARGS__)
39 #define fst_printf_sframe(s, is_old, level, format, ...) \
40 fst_printf_siface((s), \
41 (is_old) ? (s)->data.old_iface : (s)->data.new_iface, \
42 (level), format, ##__VA_ARGS__)
44 #define FST_LLT_MS_DEFAULT 50
45 #define FST_ACTION_MAX_SUPPORTED FST_ACTION_ON_CHANNEL_TUNNEL
47 const char * const fst_action_names[] = {
48 [FST_ACTION_SETUP_REQUEST] = "Setup Request",
49 [FST_ACTION_SETUP_RESPONSE] = "Setup Response",
50 [FST_ACTION_TEAR_DOWN] = "Tear Down",
51 [FST_ACTION_ACK_REQUEST] = "Ack Request",
52 [FST_ACTION_ACK_RESPONSE] = "Ack Response",
53 [FST_ACTION_ON_CHANNEL_TUNNEL] = "On Channel Tunnel",
58 /* Session configuration that can be zeroed on reset */
59 u8 old_peer_addr[ETH_ALEN];
60 u8 new_peer_addr[ETH_ALEN];
61 struct fst_iface *new_iface;
62 struct fst_iface *old_iface;
64 u8 pending_setup_req_dlgt;
65 u32 fsts_id; /* FSTS ID, see spec, 8.4.2.147
66 * Session Transition element */
68 /* Session object internal fields which won't be zeroed on reset */
69 struct dl_list global_sessions_lentry;
70 u32 id; /* Session object ID used to identify
71 * specific session object */
72 struct fst_group *group;
73 enum fst_session_state state;
77 static struct dl_list global_sessions_list;
78 static u32 global_session_id = 0;
80 #define foreach_fst_session(s) \
81 dl_list_for_each((s), &global_sessions_list, \
82 struct fst_session, global_sessions_lentry)
84 #define foreach_fst_session_safe(s, temp) \
85 dl_list_for_each_safe((s), (temp), &global_sessions_list, \
86 struct fst_session, global_sessions_lentry)
89 static void fst_session_global_inc_id(void)
92 if (global_session_id == FST_INVALID_SESSION_ID)
97 int fst_session_global_init(void)
99 dl_list_init(&global_sessions_list);
104 void fst_session_global_deinit(void)
106 WPA_ASSERT(dl_list_empty(&global_sessions_list));
110 static inline void fst_session_notify_ctrl(struct fst_session *s,
111 enum fst_event_type event_type,
112 union fst_event_extra *extra)
114 foreach_fst_ctrl_call(on_event, event_type, NULL, s, extra);
118 static void fst_session_set_state(struct fst_session *s,
119 enum fst_session_state state,
120 union fst_session_state_switch_extra *extra)
122 if (s->state != state) {
123 union fst_event_extra evext = {
125 .old_state = s->state,
131 evext.session_state.extra = *extra;
132 fst_session_notify_ctrl(s, EVENT_FST_SESSION_STATE_CHANGED,
134 fst_printf_session(s, MSG_INFO, "State: %s => %s",
135 fst_session_state_name(s->state),
136 fst_session_state_name(state));
142 static u32 fst_find_free_session_id(void)
144 u32 i, id = FST_INVALID_SESSION_ID;
145 struct fst_session *s;
147 for (i = 0; i < (u32) -1; i++) {
148 Boolean in_use = FALSE;
150 foreach_fst_session(s) {
151 if (s->id == global_session_id) {
152 fst_session_global_inc_id();
158 id = global_session_id;
159 fst_session_global_inc_id();
168 static void fst_session_timeout_handler(void *eloop_data, void *user_ctx)
170 struct fst_session *s = user_ctx;
171 union fst_session_state_switch_extra extra = {
173 .reason = REASON_STT,
177 fst_printf_session(s, MSG_WARNING, "Session State Timeout");
178 fst_session_set_state(s, FST_SESSION_STATE_INITIAL, &extra);
182 static void fst_session_stt_arm(struct fst_session *s)
184 eloop_register_timeout(0, TU_TO_US(FST_DEFAULT_SESSION_TIMEOUT_TU),
185 fst_session_timeout_handler, NULL, s);
190 static void fst_session_stt_disarm(struct fst_session *s)
193 eloop_cancel_timeout(fst_session_timeout_handler, NULL, s);
194 s->stt_armed = FALSE;
199 static Boolean fst_session_is_in_transition(struct fst_session *s)
201 /* See spec, 10.32.2.2 Transitioning between states */
206 static int fst_session_is_in_progress(struct fst_session *s)
208 return s->state != FST_SESSION_STATE_INITIAL;
212 static int fst_session_is_ready_pending(struct fst_session *s)
214 return s->state == FST_SESSION_STATE_SETUP_COMPLETION &&
215 fst_session_is_in_transition(s);
219 static int fst_session_is_ready(struct fst_session *s)
221 return s->state == FST_SESSION_STATE_SETUP_COMPLETION &&
222 !fst_session_is_in_transition(s);
226 static int fst_session_is_switch_requested(struct fst_session *s)
228 return s->state == FST_SESSION_STATE_TRANSITION_DONE &&
229 fst_session_is_in_transition(s);
233 static struct fst_session *
234 fst_find_session_in_progress(const u8 *peer_addr, struct fst_group *g)
236 struct fst_session *s;
238 foreach_fst_session(s) {
240 (os_memcmp(s->data.old_peer_addr, peer_addr,
242 os_memcmp(s->data.new_peer_addr, peer_addr,
244 fst_session_is_in_progress(s))
252 static void fst_session_reset_ex(struct fst_session *s, enum fst_reason reason)
254 union fst_session_state_switch_extra evext = {
260 if (s->state == FST_SESSION_STATE_SETUP_COMPLETION ||
261 s->state == FST_SESSION_STATE_TRANSITION_DONE)
262 fst_session_tear_down_setup(s);
263 fst_session_stt_disarm(s);
264 os_memset(&s->data, 0, sizeof(s->data));
265 fst_session_set_state(s, FST_SESSION_STATE_INITIAL, &evext);
269 static int fst_session_send_action(struct fst_session *s, Boolean old_iface,
270 const void *payload, size_t size,
271 const struct wpabuf *extra_buf)
277 struct fst_iface *iface =
278 old_iface ? s->data.old_iface : s->data.new_iface;
280 WPA_ASSERT(payload != NULL);
281 WPA_ASSERT(size != 0);
283 action = *(const u8 *) payload;
285 WPA_ASSERT(action <= FST_ACTION_MAX_SUPPORTED);
288 fst_printf_session(s, MSG_ERROR,
289 "no %s interface for FST Action '%s' sending",
290 old_iface ? "old" : "new",
291 fst_action_names[action]);
295 len = sizeof(u8) /* category */ + size;
297 len += wpabuf_size(extra_buf);
299 buf = wpabuf_alloc(len);
301 fst_printf_session(s, MSG_ERROR,
302 "cannot allocate buffer of %zu bytes for FST Action '%s' sending",
303 len, fst_action_names[action]);
307 wpabuf_put_u8(buf, WLAN_ACTION_FST);
308 wpabuf_put_data(buf, payload, size);
310 wpabuf_put_buf(buf, extra_buf);
312 res = fst_iface_send_action(iface,
313 old_iface ? s->data.old_peer_addr :
314 s->data.new_peer_addr, buf);
316 fst_printf_siface(s, iface, MSG_ERROR,
317 "failed to send FST Action '%s'",
318 fst_action_names[action]);
320 fst_printf_siface(s, iface, MSG_DEBUG, "FST Action '%s' sent",
321 fst_action_names[action]);
328 static int fst_session_send_tear_down(struct fst_session *s)
330 struct fst_tear_down td;
333 if (!fst_session_is_in_progress(s)) {
334 fst_printf_session(s, MSG_ERROR, "No FST setup to tear down");
338 WPA_ASSERT(s->data.old_iface != NULL);
339 WPA_ASSERT(s->data.new_iface != NULL);
341 os_memset(&td, 0, sizeof(td));
343 td.action = FST_ACTION_TEAR_DOWN;
344 td.fsts_id = host_to_le32(s->data.fsts_id);
346 res = fst_session_send_action(s, TRUE, &td, sizeof(td), NULL);
348 fst_printf_sframe(s, TRUE, MSG_INFO, "FST TearDown sent");
350 fst_printf_sframe(s, TRUE, MSG_ERROR,
351 "failed to send FST TearDown");
357 static void fst_session_handle_setup_request(struct fst_iface *iface,
358 const struct ieee80211_mgmt *mgmt,
361 struct fst_session *s;
362 const struct fst_setup_req *req;
363 struct fst_iface *new_iface = NULL;
365 u8 new_iface_peer_addr[ETH_ALEN];
366 const struct wpabuf *peer_mbies;
369 if (frame_len < IEEE80211_HDRLEN + 1 + sizeof(*req)) {
370 fst_printf_iface(iface, MSG_WARNING,
371 "FST Request dropped: too short (%zu < %zu)",
373 IEEE80211_HDRLEN + 1 + sizeof(*req));
376 plen = frame_len - IEEE80211_HDRLEN - 1;
377 req = (const struct fst_setup_req *)
378 (((const u8 *) mgmt) + IEEE80211_HDRLEN + 1);
379 if (req->stie.element_id != WLAN_EID_SESSION_TRANSITION ||
380 req->stie.length < 11) {
381 fst_printf_iface(iface, MSG_WARNING,
382 "FST Request dropped: invalid STIE");
386 if (req->stie.new_band_id == req->stie.old_band_id) {
387 fst_printf_iface(iface, MSG_WARNING,
388 "FST Request dropped: new and old band IDs are the same");
392 g = fst_iface_get_group(iface);
394 if (plen > sizeof(*req)) {
395 fst_iface_update_mb_ie(iface, mgmt->sa, (const u8 *) (req + 1),
396 plen - sizeof(*req));
397 fst_printf_iface(iface, MSG_INFO,
398 "FST Request: MB IEs updated for " MACSTR,
402 peer_mbies = fst_iface_get_peer_mb_ie(iface, mgmt->sa);
404 new_iface = fst_group_get_new_iface_by_stie_and_mbie(
405 g, wpabuf_head(peer_mbies), wpabuf_len(peer_mbies),
406 &req->stie, new_iface_peer_addr);
408 fst_printf_iface(iface, MSG_INFO,
409 "FST Request: new iface (%s:" MACSTR
411 fst_iface_get_name(new_iface),
412 MAC2STR(new_iface_peer_addr));
416 new_iface = fst_group_find_new_iface_by_stie(
417 g, iface, mgmt->sa, &req->stie,
418 new_iface_peer_addr);
420 fst_printf_iface(iface, MSG_INFO,
421 "FST Request: new iface (%s:" MACSTR
423 fst_iface_get_name(new_iface),
424 MAC2STR(new_iface_peer_addr));
428 fst_printf_iface(iface, MSG_WARNING,
429 "FST Request dropped: new iface not found");
433 s = fst_find_session_in_progress(mgmt->sa, g);
435 union fst_session_state_switch_extra evext = {
437 .reason = REASON_SETUP,
442 * 10.32.2.2 Transitioning between states:
443 * Upon receipt of an FST Setup Request frame, the responder
444 * shall respond with an FST Setup Response frame unless it has
445 * a pending FST Setup Request frame addressed to the initiator
446 * and the responder has a numerically larger MAC address than
447 * the initiator’s MAC address, in which case, the responder
448 * shall delete the received FST Setup Request.
450 if (fst_session_is_ready_pending(s) &&
451 /* waiting for Setup Response */
452 os_memcmp(mgmt->da, mgmt->sa, ETH_ALEN) > 0) {
453 fst_printf_session(s, MSG_WARNING,
454 "FST Request dropped due to MAC comparison (our MAC is "
461 * State is SETUP_COMPLETION (either in transition or not) or
462 * TRANSITION_DONE (in transition).
463 * Setup Request arriving in this state could mean:
464 * 1. peer sent it before receiving our Setup Request (race
466 * 2. peer didn't receive our Setup Response. Peer is retrying
468 * 3. peer's FST state machines are out of sync due to some
471 * We will reset our session and create a new one instead.
474 fst_printf_session(s, MSG_WARNING,
475 "resetting due to FST request");
478 * If FST Setup Request arrived with the same FSTS ID as one we
479 * initialized before, there's no need to tear down the session.
480 * Moreover, as FSTS ID is the same, the other side will
481 * associate this tear down with the session it initiated that
482 * will break the sync.
484 if (le_to_host32(req->stie.fsts_id) != s->data.fsts_id)
485 fst_session_send_tear_down(s);
487 fst_printf_session(s, MSG_WARNING,
488 "Skipping TearDown as the FST request has the same FSTS ID as initiated");
489 fst_session_set_state(s, FST_SESSION_STATE_INITIAL, &evext);
490 fst_session_stt_disarm(s);
493 s = fst_session_create(g);
495 fst_printf(MSG_WARNING,
496 "FST Request dropped: cannot create session for %s and %s",
497 fst_iface_get_name(iface),
498 fst_iface_get_name(new_iface));
502 fst_session_set_iface(s, iface, TRUE);
503 fst_session_set_peer_addr(s, mgmt->sa, TRUE);
504 fst_session_set_iface(s, new_iface, FALSE);
505 fst_session_set_peer_addr(s, new_iface_peer_addr, FALSE);
506 fst_session_set_llt(s, FST_LLT_VAL_TO_MS(le_to_host32(req->llt)));
507 s->data.pending_setup_req_dlgt = req->dialog_token;
508 s->data.fsts_id = le_to_host32(req->stie.fsts_id);
510 fst_session_stt_arm(s);
512 fst_session_notify_ctrl(s, EVENT_FST_SETUP, NULL);
514 fst_session_set_state(s, FST_SESSION_STATE_SETUP_COMPLETION, NULL);
518 static void fst_session_handle_setup_response(struct fst_session *s,
519 struct fst_iface *iface,
520 const struct ieee80211_mgmt *mgmt,
523 const struct fst_setup_res *res;
524 size_t plen = frame_len - IEEE80211_HDRLEN - 1;
525 enum hostapd_hw_mode hw_mode;
527 union fst_session_state_switch_extra evext = {
531 if (iface != s->data.old_iface) {
532 fst_printf_session(s, MSG_WARNING,
533 "FST Response dropped: %s is not the old iface",
534 fst_iface_get_name(iface));
538 if (!fst_session_is_ready_pending(s)) {
539 fst_printf_session(s, MSG_WARNING,
540 "FST Response dropped due to wrong state: %s",
541 fst_session_state_name(s->state));
545 if (plen < sizeof(*res)) {
546 fst_printf_session(s, MSG_WARNING,
547 "Too short FST Response dropped");
550 res = (const struct fst_setup_res *)
551 (((const u8 *) mgmt) + IEEE80211_HDRLEN + 1);
552 if (res->stie.element_id != WLAN_EID_SESSION_TRANSITION ||
553 res->stie.length < 11) {
554 fst_printf_iface(iface, MSG_WARNING,
555 "FST Response dropped: invalid STIE");
559 if (res->dialog_token != s->data.pending_setup_req_dlgt) {
560 fst_printf_session(s, MSG_WARNING,
561 "FST Response dropped due to wrong dialog token (%u != %u)",
562 s->data.pending_setup_req_dlgt,
567 if (res->status_code == WLAN_STATUS_SUCCESS &&
568 le_to_host32(res->stie.fsts_id) != s->data.fsts_id) {
569 fst_printf_session(s, MSG_WARNING,
570 "FST Response dropped due to wrong FST Session ID (%u)",
571 le_to_host32(res->stie.fsts_id));
575 fst_session_stt_disarm(s);
577 if (res->status_code != WLAN_STATUS_SUCCESS) {
579 * 10.32.2.2 Transitioning between states
580 * The initiator shall set the STT to the value of the
581 * FSTSessionTimeOut field at ... and at each ACK frame sent in
582 * response to a received FST Setup Response with the Status
583 * Code field equal to PENDING_ADMITTING_FST_SESSION or
584 * PENDING_GAP_IN_BA_WINDOW.
586 evext.to_initial.reason = REASON_REJECT;
587 evext.to_initial.reject_code = res->status_code;
588 evext.to_initial.initiator = FST_INITIATOR_REMOTE;
589 fst_session_set_state(s, FST_SESSION_STATE_INITIAL, &evext);
590 fst_printf_session(s, MSG_WARNING,
591 "FST Setup rejected by remote side with status %u",
596 fst_iface_get_channel_info(s->data.new_iface, &hw_mode, &channel);
598 if (fst_hw_mode_to_band(hw_mode) != res->stie.new_band_id) {
599 evext.to_initial.reason = REASON_ERROR_PARAMS;
600 fst_session_set_state(s, FST_SESSION_STATE_INITIAL, &evext);
601 fst_printf_session(s, MSG_WARNING,
602 "invalid FST Setup parameters");
603 fst_session_tear_down_setup(s);
607 fst_printf_session(s, MSG_INFO,
608 "%s: FST Setup established for %s (llt=%u)",
609 fst_iface_get_name(s->data.old_iface),
610 fst_iface_get_name(s->data.new_iface),
613 fst_session_notify_ctrl(s, EVENT_FST_ESTABLISHED, NULL);
615 if (s->data.llt_ms == FST_LLT_SWITCH_IMMEDIATELY)
616 fst_session_initiate_switch(s);
620 static void fst_session_handle_tear_down(struct fst_session *s,
621 struct fst_iface *iface,
622 const struct ieee80211_mgmt *mgmt,
625 const struct fst_tear_down *td;
626 size_t plen = frame_len - IEEE80211_HDRLEN - 1;
627 union fst_session_state_switch_extra evext = {
629 .reason = REASON_TEARDOWN,
630 .initiator = FST_INITIATOR_REMOTE,
634 if (plen < sizeof(*td)) {
635 fst_printf_session(s, MSG_WARNING,
636 "Too short FST Tear Down dropped");
639 td = (const struct fst_tear_down *)
640 (((const u8 *) mgmt) + IEEE80211_HDRLEN + 1);
642 if (le_to_host32(td->fsts_id) != s->data.fsts_id) {
643 fst_printf_siface(s, iface, MSG_WARNING,
644 "tear down for wrong FST Setup ID (%u)",
645 le_to_host32(td->fsts_id));
649 fst_session_stt_disarm(s);
651 fst_session_set_state(s, FST_SESSION_STATE_INITIAL, &evext);
655 static void fst_session_handle_ack_request(struct fst_session *s,
656 struct fst_iface *iface,
657 const struct ieee80211_mgmt *mgmt,
660 const struct fst_ack_req *req;
661 size_t plen = frame_len - IEEE80211_HDRLEN - 1;
662 struct fst_ack_res res;
663 union fst_session_state_switch_extra evext = {
665 .reason = REASON_SWITCH,
666 .initiator = FST_INITIATOR_REMOTE,
670 if (!fst_session_is_ready(s) && !fst_session_is_switch_requested(s)) {
671 fst_printf_siface(s, iface, MSG_ERROR,
672 "cannot initiate switch due to wrong session state (%s)",
673 fst_session_state_name(s->state));
677 WPA_ASSERT(s->data.new_iface != NULL);
679 if (iface != s->data.new_iface) {
680 fst_printf_siface(s, iface, MSG_ERROR,
681 "Ack received on wrong interface");
685 if (plen < sizeof(*req)) {
686 fst_printf_session(s, MSG_WARNING,
687 "Too short FST Ack Request dropped");
690 req = (const struct fst_ack_req *)
691 (((const u8 *) mgmt) + IEEE80211_HDRLEN + 1);
693 if (le_to_host32(req->fsts_id) != s->data.fsts_id) {
694 fst_printf_siface(s, iface, MSG_WARNING,
695 "Ack for wrong FST Setup ID (%u)",
696 le_to_host32(req->fsts_id));
700 os_memset(&res, 0, sizeof(res));
702 res.action = FST_ACTION_ACK_RESPONSE;
703 res.dialog_token = req->dialog_token;
704 res.fsts_id = req->fsts_id;
706 if (!fst_session_send_action(s, FALSE, &res, sizeof(res), NULL)) {
707 fst_printf_sframe(s, FALSE, MSG_INFO, "FST Ack Response sent");
708 fst_session_stt_disarm(s);
709 fst_session_set_state(s, FST_SESSION_STATE_TRANSITION_DONE,
711 fst_session_set_state(s, FST_SESSION_STATE_TRANSITION_CONFIRMED,
713 fst_session_set_state(s, FST_SESSION_STATE_INITIAL, &evext);
719 fst_session_handle_ack_response(struct fst_session *s,
720 struct fst_iface *iface,
721 const struct ieee80211_mgmt *mgmt,
724 const struct fst_ack_res *res;
725 size_t plen = frame_len - IEEE80211_HDRLEN - 1;
726 union fst_session_state_switch_extra evext = {
728 .reason = REASON_SWITCH,
729 .initiator = FST_INITIATOR_LOCAL,
733 if (!fst_session_is_switch_requested(s)) {
734 fst_printf_siface(s, iface, MSG_ERROR,
735 "Ack Response in inappropriate session state (%s)",
736 fst_session_state_name(s->state));
740 WPA_ASSERT(s->data.new_iface != NULL);
742 if (iface != s->data.new_iface) {
743 fst_printf_siface(s, iface, MSG_ERROR,
744 "Ack response received on wrong interface");
748 if (plen < sizeof(*res)) {
749 fst_printf_session(s, MSG_WARNING,
750 "Too short FST Ack Response dropped");
753 res = (const struct fst_ack_res *)
754 (((const u8 *) mgmt) + IEEE80211_HDRLEN + 1);
756 if (le_to_host32(res->fsts_id) != s->data.fsts_id) {
757 fst_printf_siface(s, iface, MSG_ERROR,
758 "Ack response for wrong FST Setup ID (%u)",
759 le_to_host32(res->fsts_id));
763 fst_session_set_state(s, FST_SESSION_STATE_TRANSITION_CONFIRMED, NULL);
764 fst_session_set_state(s, FST_SESSION_STATE_INITIAL, &evext);
766 fst_session_stt_disarm(s);
770 struct fst_session * fst_session_create(struct fst_group *g)
772 struct fst_session *s;
775 WPA_ASSERT(!is_zero_ether_addr(own_addr));
777 id = fst_find_free_session_id();
778 if (id == FST_INVALID_SESSION_ID) {
779 fst_printf(MSG_ERROR, "Cannot assign new session ID");
783 s = os_zalloc(sizeof(*s));
785 fst_printf(MSG_ERROR, "Cannot allocate new session object");
791 s->state = FST_SESSION_STATE_INITIAL;
793 s->data.llt_ms = FST_LLT_MS_DEFAULT;
795 fst_printf(MSG_INFO, "Session %u created", s->id);
797 dl_list_add_tail(&global_sessions_list, &s->global_sessions_lentry);
799 foreach_fst_ctrl_call(on_session_added, s);
805 void fst_session_set_iface(struct fst_session *s, struct fst_iface *iface,
809 s->data.old_iface = iface;
811 s->data.new_iface = iface;
816 void fst_session_set_llt(struct fst_session *s, u32 llt)
818 s->data.llt_ms = llt;
822 void fst_session_set_peer_addr(struct fst_session *s, const u8 *addr,
825 u8 *a = is_old ? s->data.old_peer_addr : s->data.new_peer_addr;
827 os_memcpy(a, addr, ETH_ALEN);
831 int fst_session_initiate_setup(struct fst_session *s)
833 struct fst_setup_req req;
837 struct fst_session *_s;
839 if (fst_session_is_in_progress(s)) {
840 fst_printf_session(s, MSG_ERROR, "Session in progress");
844 if (is_zero_ether_addr(s->data.old_peer_addr)) {
845 fst_printf_session(s, MSG_ERROR, "No old peer MAC address");
849 if (is_zero_ether_addr(s->data.new_peer_addr)) {
850 fst_printf_session(s, MSG_ERROR, "No new peer MAC address");
854 if (!s->data.old_iface) {
855 fst_printf_session(s, MSG_ERROR, "No old interface defined");
859 if (!s->data.new_iface) {
860 fst_printf_session(s, MSG_ERROR, "No new interface defined");
864 if (s->data.new_iface == s->data.old_iface) {
865 fst_printf_session(s, MSG_ERROR,
866 "Same interface set as old and new");
870 if (!fst_iface_is_connected(s->data.old_iface, s->data.old_peer_addr,
872 fst_printf_session(s, MSG_ERROR,
873 "The preset old peer address is not connected");
877 if (!fst_iface_is_connected(s->data.new_iface, s->data.new_peer_addr,
879 fst_printf_session(s, MSG_ERROR,
880 "The preset new peer address is not connected");
884 _s = fst_find_session_in_progress(s->data.old_peer_addr, s->group);
886 fst_printf_session(s, MSG_ERROR,
887 "There is another session in progress (old): %u",
892 _s = fst_find_session_in_progress(s->data.new_peer_addr, s->group);
894 fst_printf_session(s, MSG_ERROR,
895 "There is another session in progress (new): %u",
900 dialog_token = fst_group_assign_dialog_token(s->group);
901 fsts_id = fst_group_assign_fsts_id(s->group);
903 os_memset(&req, 0, sizeof(req));
905 fst_printf_siface(s, s->data.old_iface, MSG_INFO,
906 "initiating FST setup for %s (llt=%u ms)",
907 fst_iface_get_name(s->data.new_iface), s->data.llt_ms);
909 req.action = FST_ACTION_SETUP_REQUEST;
910 req.dialog_token = dialog_token;
911 req.llt = host_to_le32(FST_LLT_MS_TO_VAL(s->data.llt_ms));
912 /* 8.4.2.147 Session Transition element */
913 req.stie.element_id = WLAN_EID_SESSION_TRANSITION;
914 req.stie.length = sizeof(req.stie) - 2;
915 req.stie.fsts_id = host_to_le32(fsts_id);
916 req.stie.session_control = SESSION_CONTROL(SESSION_TYPE_BSS, 0);
918 req.stie.new_band_id = fst_iface_get_band_id(s->data.new_iface);
919 req.stie.new_band_op = 1;
920 req.stie.new_band_setup = 0;
922 req.stie.old_band_id = fst_iface_get_band_id(s->data.old_iface);
923 req.stie.old_band_op = 1;
924 req.stie.old_band_setup = 0;
926 res = fst_session_send_action(s, TRUE, &req, sizeof(req),
927 fst_iface_get_mbie(s->data.old_iface));
929 s->data.fsts_id = fsts_id;
930 s->data.pending_setup_req_dlgt = dialog_token;
931 fst_printf_sframe(s, TRUE, MSG_INFO, "FST Setup Request sent");
932 fst_session_set_state(s, FST_SESSION_STATE_SETUP_COMPLETION,
935 fst_session_stt_arm(s);
942 int fst_session_respond(struct fst_session *s, u8 status_code)
944 struct fst_setup_res res;
945 enum hostapd_hw_mode hw_mode;
948 if (!fst_session_is_ready_pending(s)) {
949 fst_printf_session(s, MSG_ERROR, "incorrect state: %s",
950 fst_session_state_name(s->state));
954 if (is_zero_ether_addr(s->data.old_peer_addr)) {
955 fst_printf_session(s, MSG_ERROR, "No peer MAC address");
959 if (!s->data.old_iface) {
960 fst_printf_session(s, MSG_ERROR, "No old interface defined");
964 if (!s->data.new_iface) {
965 fst_printf_session(s, MSG_ERROR, "No new interface defined");
969 if (s->data.new_iface == s->data.old_iface) {
970 fst_printf_session(s, MSG_ERROR,
971 "Same interface set as old and new");
975 if (!fst_iface_is_connected(s->data.old_iface,
976 s->data.old_peer_addr, FALSE)) {
977 fst_printf_session(s, MSG_ERROR,
978 "The preset peer address is not in the peer list");
982 fst_session_stt_disarm(s);
984 os_memset(&res, 0, sizeof(res));
986 res.action = FST_ACTION_SETUP_RESPONSE;
987 res.dialog_token = s->data.pending_setup_req_dlgt;
988 res.status_code = status_code;
990 res.stie.element_id = WLAN_EID_SESSION_TRANSITION;
991 res.stie.length = sizeof(res.stie) - 2;
993 if (status_code == WLAN_STATUS_SUCCESS) {
994 res.stie.fsts_id = s->data.fsts_id;
995 res.stie.session_control = SESSION_CONTROL(SESSION_TYPE_BSS, 0);
997 fst_iface_get_channel_info(s->data.new_iface, &hw_mode,
999 res.stie.new_band_id = fst_hw_mode_to_band(hw_mode);
1000 res.stie.new_band_op = 1;
1001 res.stie.new_band_setup = 0;
1003 fst_iface_get_channel_info(s->data.old_iface, &hw_mode,
1005 res.stie.old_band_id = fst_hw_mode_to_band(hw_mode);
1006 res.stie.old_band_op = 1;
1007 res.stie.old_band_setup = 0;
1009 fst_printf_session(s, MSG_INFO,
1010 "%s: FST Setup Request accepted for %s (llt=%u)",
1011 fst_iface_get_name(s->data.old_iface),
1012 fst_iface_get_name(s->data.new_iface),
1015 fst_printf_session(s, MSG_WARNING,
1016 "%s: FST Setup Request rejected with code %d",
1017 fst_iface_get_name(s->data.old_iface),
1021 if (fst_session_send_action(s, TRUE, &res, sizeof(res),
1022 fst_iface_get_mbie(s->data.old_iface))) {
1023 fst_printf_sframe(s, TRUE, MSG_ERROR,
1024 "cannot send FST Setup Response with code %d",
1029 fst_printf_sframe(s, TRUE, MSG_INFO, "FST Setup Response sent");
1031 if (status_code != WLAN_STATUS_SUCCESS) {
1032 union fst_session_state_switch_extra evext = {
1034 .reason = REASON_REJECT,
1035 .reject_code = status_code,
1036 .initiator = FST_INITIATOR_LOCAL,
1039 fst_session_set_state(s, FST_SESSION_STATE_INITIAL, &evext);
1046 int fst_session_initiate_switch(struct fst_session *s)
1048 struct fst_ack_req req;
1052 if (!fst_session_is_ready(s)) {
1053 fst_printf_session(s, MSG_ERROR,
1054 "cannot initiate switch due to wrong setup state (%d)",
1059 dialog_token = fst_group_assign_dialog_token(s->group);
1061 WPA_ASSERT(s->data.new_iface != NULL);
1062 WPA_ASSERT(s->data.old_iface != NULL);
1064 fst_printf_session(s, MSG_INFO, "initiating FST switch: %s => %s",
1065 fst_iface_get_name(s->data.old_iface),
1066 fst_iface_get_name(s->data.new_iface));
1068 os_memset(&req, 0, sizeof(req));
1070 req.action = FST_ACTION_ACK_REQUEST;
1071 req.dialog_token = dialog_token;
1072 req.fsts_id = host_to_le32(s->data.fsts_id);
1074 res = fst_session_send_action(s, FALSE, &req, sizeof(req), NULL);
1076 fst_printf_sframe(s, FALSE, MSG_INFO, "FST Ack Request sent");
1077 fst_session_set_state(s, FST_SESSION_STATE_TRANSITION_DONE,
1079 fst_session_stt_arm(s);
1081 fst_printf_sframe(s, FALSE, MSG_ERROR,
1082 "Cannot send FST Ack Request");
1089 void fst_session_handle_action(struct fst_session *s,
1090 struct fst_iface *iface,
1091 const struct ieee80211_mgmt *mgmt,
1094 switch (mgmt->u.action.u.fst_action.action) {
1095 case FST_ACTION_SETUP_REQUEST:
1098 case FST_ACTION_SETUP_RESPONSE:
1099 fst_session_handle_setup_response(s, iface, mgmt, frame_len);
1101 case FST_ACTION_TEAR_DOWN:
1102 fst_session_handle_tear_down(s, iface, mgmt, frame_len);
1104 case FST_ACTION_ACK_REQUEST:
1105 fst_session_handle_ack_request(s, iface, mgmt, frame_len);
1107 case FST_ACTION_ACK_RESPONSE:
1108 fst_session_handle_ack_response(s, iface, mgmt, frame_len);
1110 case FST_ACTION_ON_CHANNEL_TUNNEL:
1112 fst_printf_sframe(s, FALSE, MSG_ERROR,
1113 "Unsupported FST Action frame");
1119 int fst_session_tear_down_setup(struct fst_session *s)
1122 union fst_session_state_switch_extra evext = {
1124 .reason = REASON_TEARDOWN,
1125 .initiator = FST_INITIATOR_LOCAL,
1129 res = fst_session_send_tear_down(s);
1131 fst_session_set_state(s, FST_SESSION_STATE_INITIAL, &evext);
1137 void fst_session_reset(struct fst_session *s)
1139 fst_session_reset_ex(s, REASON_RESET);
1143 void fst_session_delete(struct fst_session *s)
1145 fst_printf(MSG_INFO, "Session %u deleted", s->id);
1146 dl_list_del(&s->global_sessions_lentry);
1147 foreach_fst_ctrl_call(on_session_removed, s);
1152 struct fst_group * fst_session_get_group(struct fst_session *s)
1158 struct fst_iface * fst_session_get_iface(struct fst_session *s, Boolean is_old)
1160 return is_old ? s->data.old_iface : s->data.new_iface;
1164 u32 fst_session_get_id(struct fst_session *s)
1170 const u8 * fst_session_get_peer_addr(struct fst_session *s, Boolean is_old)
1172 return is_old ? s->data.old_peer_addr : s->data.new_peer_addr;
1176 u32 fst_session_get_llt(struct fst_session *s)
1178 return s->data.llt_ms;
1182 enum fst_session_state fst_session_get_state(struct fst_session *s)
1188 struct fst_session * fst_session_get_by_id(u32 id)
1190 struct fst_session *s;
1192 foreach_fst_session(s) {
1201 void fst_session_enum(struct fst_group *g, fst_session_enum_clb clb, void *ctx)
1203 struct fst_session *s;
1205 foreach_fst_session(s) {
1206 if (!g || s->group == g)
1207 clb(s->group, s, ctx);
1212 void fst_session_on_action_rx(struct fst_iface *iface,
1213 const struct ieee80211_mgmt *mgmt,
1216 struct fst_session *s;
1218 if (len < IEEE80211_HDRLEN + 2 ||
1219 mgmt->u.action.category != WLAN_ACTION_FST) {
1220 fst_printf_iface(iface, MSG_ERROR,
1221 "invalid Action frame received");
1225 if (mgmt->u.action.u.fst_action.action <= FST_ACTION_MAX_SUPPORTED) {
1226 fst_printf_iface(iface, MSG_DEBUG,
1227 "FST Action '%s' received!",
1228 fst_action_names[mgmt->u.action.u.fst_action.action]);
1230 fst_printf_iface(iface, MSG_WARNING,
1231 "unknown FST Action (%u) received!",
1232 mgmt->u.action.u.fst_action.action);
1236 if (mgmt->u.action.u.fst_action.action == FST_ACTION_SETUP_REQUEST) {
1237 fst_session_handle_setup_request(iface, mgmt, len);
1241 s = fst_find_session_in_progress(mgmt->sa, fst_iface_get_group(iface));
1243 fst_session_handle_action(s, iface, mgmt, len);
1245 fst_printf_iface(iface, MSG_WARNING,
1246 "FST Action '%s' dropped: no session in progress found",
1247 fst_action_names[mgmt->u.action.u.fst_action.action]);
1252 int fst_session_set_str_ifname(struct fst_session *s, const char *ifname,
1255 struct fst_group *g = fst_session_get_group(s);
1256 struct fst_iface *i;
1258 i = fst_group_get_iface_by_name(g, ifname);
1260 fst_printf_session(s, MSG_WARNING,
1261 "Cannot set iface %s: no such iface within group '%s'",
1262 ifname, fst_group_get_id(g));
1266 fst_session_set_iface(s, i, is_old);
1272 int fst_session_set_str_peer_addr(struct fst_session *s, const char *mac,
1275 u8 peer_addr[ETH_ALEN];
1276 int res = fst_read_peer_addr(mac, peer_addr);
1281 fst_session_set_peer_addr(s, peer_addr, is_old);
1287 int fst_session_set_str_llt(struct fst_session *s, const char *llt_str)
1290 long int llt = strtol(llt_str, &endp, 0);
1292 if (*endp || llt < 0 || (unsigned long int) llt > FST_MAX_LLT_MS) {
1293 fst_printf_session(s, MSG_WARNING,
1294 "Cannot set llt %s: Invalid llt value (1..%u expected)",
1295 llt_str, FST_MAX_LLT_MS);
1298 fst_session_set_llt(s, (u32) llt);
1304 void fst_session_global_on_iface_detached(struct fst_iface *iface)
1306 struct fst_session *s;
1308 foreach_fst_session(s) {
1309 if (fst_session_is_in_progress(s) &&
1310 (s->data.new_iface == iface ||
1311 s->data.old_iface == iface))
1312 fst_session_reset_ex(s, REASON_DETACH_IFACE);
1317 struct fst_session * fst_session_global_get_first_by_group(struct fst_group *g)
1319 struct fst_session *s;
1321 foreach_fst_session(s) {
1330 #ifdef CONFIG_FST_TEST
1332 static int get_group_fill_session(struct fst_group **g, struct fst_session *s)
1334 const u8 *old_addr, *new_addr;
1335 struct fst_get_peer_ctx *ctx;
1337 os_memset(s, 0, sizeof(*s));
1338 foreach_fst_group(*g) {
1339 s->data.new_iface = fst_group_first_iface(*g);
1340 if (s->data.new_iface)
1343 if (!s->data.new_iface)
1346 s->data.old_iface = dl_list_entry(s->data.new_iface->group_lentry.next,
1347 struct fst_iface, group_lentry);
1348 if (!s->data.old_iface)
1351 old_addr = fst_iface_get_peer_first(s->data.old_iface, &ctx, TRUE);
1355 new_addr = fst_iface_get_peer_first(s->data.new_iface, &ctx, TRUE);
1359 os_memcpy(s->data.old_peer_addr, old_addr, ETH_ALEN);
1360 os_memcpy(s->data.new_peer_addr, new_addr, ETH_ALEN);
1366 #define FST_MAX_COMMAND_WORD_NAME_LENGTH 16
1368 int fst_test_req_send_fst_request(const char *params)
1373 struct fst_setup_req req;
1374 struct fst_session s;
1375 struct fst_group *g;
1376 enum hostapd_hw_mode hw_mode;
1378 char additional_param[FST_MAX_COMMAND_WORD_NAME_LENGTH];
1380 if (params[0] != ' ')
1383 fsts_id = fst_read_next_int_param(params, &is_valid, &endp);
1387 if (get_group_fill_session(&g, &s))
1390 req.action = FST_ACTION_SETUP_REQUEST;
1391 req.dialog_token = g->dialog_token;
1392 req.llt = host_to_le32(FST_LLT_MS_DEFAULT);
1393 /* 8.4.2.147 Session Transition element */
1394 req.stie.element_id = WLAN_EID_SESSION_TRANSITION;
1395 req.stie.length = sizeof(req.stie) - 2;
1396 req.stie.fsts_id = host_to_le32(fsts_id);
1397 req.stie.session_control = SESSION_CONTROL(SESSION_TYPE_BSS, 0);
1399 fst_iface_get_channel_info(s.data.new_iface, &hw_mode, &channel);
1400 req.stie.new_band_id = fst_hw_mode_to_band(hw_mode);
1401 req.stie.new_band_op = 1;
1402 req.stie.new_band_setup = 0;
1404 fst_iface_get_channel_info(s.data.old_iface, &hw_mode, &channel);
1405 req.stie.old_band_id = fst_hw_mode_to_band(hw_mode);
1406 req.stie.old_band_op = 1;
1407 req.stie.old_band_setup = 0;
1409 if (!fst_read_next_text_param(endp, additional_param,
1410 sizeof(additional_param), &endp)) {
1411 if (!os_strcasecmp(additional_param, FST_CTR_PVAL_BAD_NEW_BAND))
1412 req.stie.new_band_id = req.stie.old_band_id;
1415 return fst_session_send_action(&s, TRUE, &req, sizeof(req),
1416 s.data.old_iface->mb_ie);
1420 int fst_test_req_send_fst_response(const char *params)
1425 struct fst_setup_res res;
1426 struct fst_session s;
1427 struct fst_group *g;
1428 enum hostapd_hw_mode hw_mode;
1431 char response[FST_MAX_COMMAND_WORD_NAME_LENGTH];
1432 struct fst_session *_s;
1434 if (params[0] != ' ')
1437 fsts_id = fst_read_next_int_param(params, &is_valid, &endp);
1441 if (get_group_fill_session(&g, &s))
1444 status_code = WLAN_STATUS_SUCCESS;
1445 if (!fst_read_next_text_param(endp, response, sizeof(response),
1447 if (!os_strcasecmp(response, FST_CS_PVAL_RESPONSE_REJECT))
1448 status_code = WLAN_STATUS_PENDING_ADMITTING_FST_SESSION;
1451 os_memset(&res, 0, sizeof(res));
1453 res.action = FST_ACTION_SETUP_RESPONSE;
1455 * If some session has just received an FST Setup Request, then
1456 * use the correct dialog token copied from this request.
1458 _s = fst_find_session_in_progress(fst_session_get_peer_addr(&s, TRUE),
1460 res.dialog_token = (_s && fst_session_is_ready_pending(_s)) ?
1461 _s->data.pending_setup_req_dlgt : g->dialog_token;
1462 res.status_code = status_code;
1464 res.stie.element_id = WLAN_EID_SESSION_TRANSITION;
1465 res.stie.length = sizeof(res.stie) - 2;
1467 if (res.status_code == WLAN_STATUS_SUCCESS) {
1468 res.stie.fsts_id = fsts_id;
1469 res.stie.session_control = SESSION_CONTROL(SESSION_TYPE_BSS, 0);
1471 fst_iface_get_channel_info(s.data.new_iface, &hw_mode,
1473 res.stie.new_band_id = fst_hw_mode_to_band(hw_mode);
1474 res.stie.new_band_op = 1;
1475 res.stie.new_band_setup = 0;
1477 fst_iface_get_channel_info(s.data.old_iface, &hw_mode,
1479 res.stie.old_band_id = fst_hw_mode_to_band(hw_mode);
1480 res.stie.old_band_op = 1;
1481 res.stie.old_band_setup = 0;
1484 if (!fst_read_next_text_param(endp, response, sizeof(response),
1486 if (!os_strcasecmp(response, FST_CTR_PVAL_BAD_NEW_BAND))
1487 res.stie.new_band_id = res.stie.old_band_id;
1490 return fst_session_send_action(&s, TRUE, &res, sizeof(res),
1491 s.data.old_iface->mb_ie);
1495 int fst_test_req_send_ack_request(const char *params)
1500 struct fst_ack_req req;
1501 struct fst_session s;
1502 struct fst_group *g;
1504 if (params[0] != ' ')
1507 fsts_id = fst_read_next_int_param(params, &is_valid, &endp);
1511 if (get_group_fill_session(&g, &s))
1514 os_memset(&req, 0, sizeof(req));
1515 req.action = FST_ACTION_ACK_REQUEST;
1516 req.dialog_token = g->dialog_token;
1517 req.fsts_id = fsts_id;
1519 return fst_session_send_action(&s, FALSE, &req, sizeof(req), NULL);
1523 int fst_test_req_send_ack_response(const char *params)
1528 struct fst_ack_res res;
1529 struct fst_session s;
1530 struct fst_group *g;
1532 if (params[0] != ' ')
1535 fsts_id = fst_read_next_int_param(params, &is_valid, &endp);
1539 if (get_group_fill_session(&g, &s))
1542 os_memset(&res, 0, sizeof(res));
1543 res.action = FST_ACTION_ACK_RESPONSE;
1544 res.dialog_token = g->dialog_token;
1545 res.fsts_id = fsts_id;
1547 return fst_session_send_action(&s, FALSE, &res, sizeof(res), NULL);
1551 int fst_test_req_send_tear_down(const char *params)
1556 struct fst_tear_down td;
1557 struct fst_session s;
1558 struct fst_group *g;
1560 if (params[0] != ' ')
1563 fsts_id = fst_read_next_int_param(params, &is_valid, &endp);
1567 if (get_group_fill_session(&g, &s))
1570 os_memset(&td, 0, sizeof(td));
1571 td.action = FST_ACTION_TEAR_DOWN;
1572 td.fsts_id = fsts_id;
1574 return fst_session_send_action(&s, TRUE, &td, sizeof(td), NULL);
1578 u32 fst_test_req_get_fsts_id(const char *params)
1583 struct fst_session *s;
1585 if (params[0] != ' ')
1586 return FST_FSTS_ID_NOT_FOUND;
1588 sid = fst_read_next_int_param(params, &is_valid, &endp);
1590 return FST_FSTS_ID_NOT_FOUND;
1592 s = fst_session_get_by_id(sid);
1594 return FST_FSTS_ID_NOT_FOUND;
1596 return s->data.fsts_id;
1600 int fst_test_req_get_local_mbies(const char *request, char *buf, size_t buflen)
1603 char ifname[FST_MAX_COMMAND_WORD_NAME_LENGTH];
1604 struct fst_group *g;
1605 struct fst_iface *iface;
1607 if (request[0] != ' ')
1610 if (fst_read_next_text_param(request, ifname, sizeof(ifname), &endp) ||
1613 g = dl_list_first(&fst_global_groups_list, struct fst_group,
1614 global_groups_lentry);
1617 iface = fst_group_get_iface_by_name(g, ifname);
1618 if (!iface || !iface->mb_ie)
1620 return wpa_snprintf_hex(buf, buflen, wpabuf_head(iface->mb_ie),
1621 wpabuf_len(iface->mb_ie));
1624 return os_snprintf(buf, buflen, "FAIL\n");
1627 #endif /* CONFIG_FST_TEST */