Skip to contentSkip to conversation

sae: add IWD_SAE_DEBUG for more SAE debug messages

PATCH In review James Prestwood 2 participants 3 messages Sep 26, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 sae: add IWD_SAE_DEBUG for more SAE debug messages

SAE will now check for IWD_SAE_DEBUG and enable more debug logging using the new macro, sae_debug.

---
 src/sae.c | 70 +++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 58 insertions(+), 12 deletions(-)
src/sae.c +58 -12
index 859ec94b..cfd4d650 100644
@@ -37,6 +37,9 @@
 #include "src/mpdu.h"
 #include "src/auth-proto.h"
 #include "src/sae.h"
+#include "src/module.h"
+
+static bool debug;
 
 /* SHA-512 is the highest supported hashing function as of 802.11-2020 */
 #define SAE_MAX_HASH_LEN 64
@@ -45,6 +48,12 @@
 #define SAE_SYNC_MAX		3
 #define SAE_MAX_ASSOC_RETRY	3
 
+#define sae_debug(fmat, ...) \
+({	\
+	if (debug) \
+		l_info("[SAE]: "fmat, ##__VA_ARGS__); \
+})
+
 enum sae_state {
 	SAE_STATE_NOTHING = 0,
 	SAE_STATE_COMMITTED = 1,
@@ -154,7 +163,7 @@ static int sae_choose_next_group(struct sae_sm *sm)
 			return -ENOENT;
 		}
 
-		l_debug("Forcing default SAE group 19");
+		sae_debug("Forcing default SAE group 19");
 
 		sm->group_retry++;
 		sm->group = 19;
@@ -176,6 +185,8 @@ static int sae_choose_next_group(struct sae_sm *sm)
 	sm->group = ecc_groups[sm->group_retry];
 
 get_curve:
+	sae_debug("Using group %u", sm->group);
+
 	sm->curve = l_ecc_curve_from_ike_group(sm->group);
 
 	return 0;
@@ -327,6 +338,9 @@ static int sae_reject(struct sae_sm *sm, uint16_t transaction, uint16_t status)
 		ptr += 2;
 	}
 
+	sae_debug("Rejecting exchange transaction=%u status=%u",
+			transaction, status);
+
 	sm->tx_auth(reject, ptr - reject, sm->user_data);
 
 	return status;
@@ -631,6 +645,9 @@ static bool sae_send_confirm(struct sae_sm *sm)
 	memcpy(ptr, confirm, r);
 	ptr += r;
 
+	sae_debug("Sending Confirm to "MAC" sc=%u",
+			MAC_STR(sm->handshake->aa), sm->sc);
+
 	sm->tx_auth(body, ptr - body, sm->user_data);
 	return true;
 }
@@ -827,6 +844,8 @@ static int sae_process_confirm(struct sae_sm *sm, const uint8_t *from,
 
 	sm->state = SAE_STATE_ACCEPTED;
 
+	sae_debug("Sending Associate to "MAC, MAC_STR(sm->handshake->aa));
+
 	sm->tx_assoc(sm->user_data);
 
 	return 0;
@@ -844,6 +863,8 @@ static bool sae_send_commit(struct sae_sm *sm, bool retry)
 	if (r < 0)
 		return false;
 
+	sae_debug("Sending Commit to "MAC, MAC_STR(hs->aa));
+
 	sm->tx_auth(commit, r, sm->user_data);
 
 	return true;
@@ -858,6 +879,8 @@ static bool sae_assoc_timeout(struct auth_proto *ap)
 
 	sm->assoc_retry++;
 
+	sae_debug("Retry Associate to "MAC, MAC_STR(sm->handshake->aa));
+
 	sm->tx_assoc(sm->user_data);
 
 	return true;
@@ -921,6 +944,8 @@ static int sae_process_anti_clogging(struct sae_sm *sm, const uint8_t *ptr,
 		return -EBADMSG;
 	}
 
+	sae_debug("Processed anti-clogging token");
+
 	l_free(sm->token);
 	sm->token = l_memdup(ptr, len);
 	sm->token_len = len;
@@ -1036,6 +1061,9 @@ static int sae_verify_committed(struct sae_sm *sm, uint16_t transaction,
 			goto reject_unsupp_group;
 		}
 
+		sae_debug("AP rejected group, trying again with group %u",
+				sm->group);
+
 		sm->sync = 0;
 		sae_send_commit(sm, false);
 
@@ -1297,8 +1325,6 @@ static int sae_verify_packet(struct sae_sm *sm, uint16_t trans,
 				uint16_t status, const uint8_t *frame,
 				size_t len)
 {
-	l_debug("rx trans=%u, state=%s", trans, sae_state_to_str(sm->state));
-
 	if (trans != SAE_STATE_COMMITTED && trans != SAE_STATE_CONFIRMED)
 		return -EBADMSG;
 
@@ -1324,16 +1350,23 @@ static int sae_rx_authenticate(struct auth_proto *ap,
 	const struct mmpdu_header *hdr = (const struct mmpdu_header *) frame;
 	const struct mmpdu_authentication *auth = mmpdu_body(hdr);
 	int ret;
+	uint16_t transaction = L_LE16_TO_CPU(auth->transaction_sequence);
+	uint16_t status = L_LE16_TO_CPU(auth->status);
+
+	sae_debug("Received frame transaction=%u status=%u state=%s",
+			transaction, status, sae_state_to_str(sm->state));
 
 	len -= mmpdu_header_len(hdr);
 
-	ret = sae_verify_packet(sm, L_LE16_TO_CPU(auth->transaction_sequence),
-					L_LE16_TO_CPU(auth->status),
-					auth->ies, len - 6);
-	if (ret != 0)
+	ret = sae_verify_packet(sm, transaction, status, auth->ies, len - 6);
+	if (ret != 0) {
+		if (ret < 0 && ret != -EAGAIN)
+			sae_debug("Frame did not verify (%s)", strerror(-ret));
+
 		return ret;
+	}
 
-	switch (L_LE16_TO_CPU(auth->transaction_sequence)) {
+	switch (transaction) {
 	case SAE_STATE_COMMITTED:
 		return sae_process_commit(sm, hdr->address_2, auth->ies,
 						len - 6);
@@ -1341,8 +1374,7 @@ static int sae_rx_authenticate(struct auth_proto *ap,
 		return sae_process_confirm(sm, hdr->address_2, auth->ies,
 						len - 6);
 	default:
-		l_error("invalid transaction sequence %u",
-				L_LE16_TO_CPU(auth->transaction_sequence));
+		l_error("invalid transaction sequence %u", transaction);
 	}
 
 	/* should never get here */
@@ -1442,12 +1474,26 @@ struct auth_proto *sae_sm_new(struct handshake_state *hs,
 						hs->authenticator_rsnxe;
 
 	if (ie_rsnxe_capable(rsnxe, IE_RSNX_SAE_H2E) && hs->ecc_sae_pts) {
-		l_debug("Using SAE H2E");
+		sae_debug("Using SAE H2E");
 		sm->sae_type = CRYPTO_SAE_HASH_TO_ELEMENT;
 	} else {
-		l_debug("Using SAE Hunting and Pecking");
+		sae_debug("Using SAE Hunting and Pecking");
 		sm->sae_type = CRYPTO_SAE_LOOPING;
 	}
 
 	return &sm->ap;
 }
+
+static int sae_init(void)
+{
+	if (getenv("IWD_SAE_DEBUG"))
+		debug = true;
+
+	return 0;
+}
+
+static void sae_exit(void)
+{
+}
+
+IWD_MODULE(sae, sae_init, sae_exit);
Signature · 1 line
2.34.3
#1 lore raw

PATCH 2/2 test-runner: add custom verbose option iwd-sae

Enables IWD_SAE_DEBUG to be set in the test-runner environment

---
 tools/utils.py | 3 +++
 1 file changed, 3 insertions(+)
tools/utils.py +3 -0
index a1b3e041..a07c3183 100644
@@ -449,6 +449,9 @@ class Namespace:
 		if Process.is_verbose('iwd-rtnl'):
 			env['IWD_RTNL_DEBUG'] = '1'
 
+		if Process.is_verbose('iwd-sae'):
+			env['IWD_SAE_DEBUG'] = '1'
+
 		proc = self.start_process(args, env=env)
 
 		proc.wait_for_service(self, 'net.connman.iwd', 20)
Signature · 1 line
2.34.3
#2 lore raw
In reply to James Prestwood

Hi James,

Quoted 6 lines · James Prestwood

SAE will now check for IWD_SAE_DEBUG and enable more debug logging using the new macro, sae_debug.

---
  src/sae.c | 70 +++++++++++++++++++++++++++++++++++++++++++++----------
  1 file changed, 58 insertions(+), 12 deletions(-)

Both applied, thanks.

Regards,
-Denis