Use an enum for EAP SM requests

Control requests will be extended for non-EAP uses later, so it makes
sense to have them be generic. Furthermore, having them defined as an
enum is easier for processing internally, and more generic for control
interfaces that may not use field names. The public ctrl_req_type /
field_name conversion function will be used later by the D-Bus control
interface too.

Signed-off-by: Dan Williams <dcbw@redhat.com>

diff --git a/src/common/defs.h b/src/common/defs.h
index 8abec07ffa9f5f7a4ee33a48c5cc6507926ffc89..7a10282af67673dd64c01046f7cc541967adce37 100644 (file)
--- a/src/common/defs.h
+++ b/src/common/defs.h
@@ -267,4 +267,17 @@ enum hostapd_hw_mode {
        NUM_HOSTAPD_MODES
 };
 
+/**
+ * enum wpa_ctrl_req_type - Control interface request types
+ */
+enum wpa_ctrl_req_type {
+       WPA_CTRL_REQ_EAP_IDENTITY,
+       WPA_CTRL_REQ_EAP_PASSWORD,
+       WPA_CTRL_REQ_EAP_NEW_PASSWORD,
+       WPA_CTRL_REQ_EAP_PIN,
+       WPA_CTRL_REQ_EAP_OTP,
+       WPA_CTRL_REQ_EAP_PASSPHRASE,
+       NUM_WPA_CTRL_REQS
+};
+
 #endif /* DEFS_H */

diff --git a/src/eap_peer/eap.c b/src/eap_peer/eap.c
index 17d3574c05fe9d6543dbddc0728f9e4e633a1228..91fa4a9ca884a47e1fd337edd2bc80cc270e542e 100644 (file)
--- a/src/eap_peer/eap.c
+++ b/src/eap_peer/eap.c
@@ -1468,16 +1468,11 @@ int eap_sm_get_status(struct eap_sm *sm, char *buf, size_t buflen, int verbose)
 
 
 #if defined(CONFIG_CTRL_IFACE) || !defined(CONFIG_NO_STDOUT_DEBUG)
-typedef enum {
-       TYPE_IDENTITY, TYPE_PASSWORD, TYPE_OTP, TYPE_PIN, TYPE_NEW_PASSWORD,
-       TYPE_PASSPHRASE
-} eap_ctrl_req_type;
-
-static void eap_sm_request(struct eap_sm *sm, eap_ctrl_req_type type,
+static void eap_sm_request(struct eap_sm *sm, enum wpa_ctrl_req_type field,
                           const char *msg, size_t msglen)
 {
        struct eap_peer_config *config;
-       char *field, *txt, *tmp;
+       char *txt = NULL, *tmp;
 
        if (sm == NULL)
                return;
@@ -1485,29 +1480,20 @@ static void eap_sm_request(struct eap_sm *sm, eap_ctrl_req_type type,
        if (config == NULL)
                return;
 
-       switch (type) {
-       case TYPE_IDENTITY:
-               field = "IDENTITY";
-               txt = "Identity";
+       switch (field) {
+       case WPA_CTRL_REQ_EAP_IDENTITY:
                config->pending_req_identity++;
                break;
-       case TYPE_PASSWORD:
-               field = "PASSWORD";
-               txt = "Password";
+       case WPA_CTRL_REQ_EAP_PASSWORD:
                config->pending_req_password++;
                break;
-       case TYPE_NEW_PASSWORD:
-               field = "NEW_PASSWORD";
-               txt = "New Password";
+       case WPA_CTRL_REQ_EAP_NEW_PASSWORD:
                config->pending_req_new_password++;
                break;
-       case TYPE_PIN:
-               field = "PIN";
-               txt = "PIN";
+       case WPA_CTRL_REQ_EAP_PIN:
                config->pending_req_pin++;
                break;
-       case TYPE_OTP:
-               field = "OTP";
+       case WPA_CTRL_REQ_EAP_OTP:
                if (msg) {
                        tmp = os_malloc(msglen + 3);
                        if (tmp == NULL)
@@ -1526,9 +1512,7 @@ static void eap_sm_request(struct eap_sm *sm, eap_ctrl_req_type type,
                        txt = config->pending_req_otp;
                }
                break;
-       case TYPE_PASSPHRASE:
-               field = "PASSPHRASE";
-               txt = "Private key passphrase";
+       case WPA_CTRL_REQ_EAP_PASSPHRASE:
                config->pending_req_passphrase++;
                break;
        default:
@@ -1561,7 +1545,7 @@ const char * eap_sm_get_method_name(struct eap_sm *sm)
  */
 void eap_sm_request_identity(struct eap_sm *sm)
 {
-       eap_sm_request(sm, TYPE_IDENTITY, NULL, 0);
+       eap_sm_request(sm, WPA_CTRL_REQ_EAP_IDENTITY, NULL, 0);
 }
 
 
@@ -1576,7 +1560,7 @@ void eap_sm_request_identity(struct eap_sm *sm)
  */
 void eap_sm_request_password(struct eap_sm *sm)
 {
-       eap_sm_request(sm, TYPE_PASSWORD, NULL, 0);
+       eap_sm_request(sm, WPA_CTRL_REQ_EAP_PASSWORD, NULL, 0);
 }
 
 
@@ -1591,7 +1575,7 @@ void eap_sm_request_password(struct eap_sm *sm)
  */
 void eap_sm_request_new_password(struct eap_sm *sm)
 {
-       eap_sm_request(sm, TYPE_NEW_PASSWORD, NULL, 0);
+       eap_sm_request(sm, WPA_CTRL_REQ_EAP_NEW_PASSWORD, NULL, 0);
 }
 
 
@@ -1606,7 +1590,7 @@ void eap_sm_request_new_password(struct eap_sm *sm)
  */
 void eap_sm_request_pin(struct eap_sm *sm)
 {
-       eap_sm_request(sm, TYPE_PIN, NULL, 0);
+       eap_sm_request(sm, WPA_CTRL_REQ_EAP_PIN, NULL, 0);
 }
 
 
@@ -1622,7 +1606,7 @@ void eap_sm_request_pin(struct eap_sm *sm)
  */
 void eap_sm_request_otp(struct eap_sm *sm, const char *msg, size_t msg_len)
 {
-       eap_sm_request(sm, TYPE_OTP, msg, msg_len);
+       eap_sm_request(sm, WPA_CTRL_REQ_EAP_OTP, msg, msg_len);
 }
 
 
@@ -1637,7 +1621,7 @@ void eap_sm_request_otp(struct eap_sm *sm, const char *msg, size_t msg_len)
  */
 void eap_sm_request_passphrase(struct eap_sm *sm)
 {
-       eap_sm_request(sm, TYPE_PASSPHRASE, NULL, 0);
+       eap_sm_request(sm, WPA_CTRL_REQ_EAP_PASSPHRASE, NULL, 0);
 }
 
 

diff --git a/src/eap_peer/eap.h b/src/eap_peer/eap.h
index 15e451e8a6d9b6125ba5341f0aebdcf0e02e6610..f35197f42c5776074d6dfda31aab55ffb3e72edb 100644 (file)
--- a/src/eap_peer/eap.h
+++ b/src/eap_peer/eap.h
@@ -216,10 +216,10 @@ struct eapol_callbacks {
        /**
         * eap_param_needed - Notify that EAP parameter is needed
         * @ctx: eapol_ctx from eap_peer_sm_init() call
-        * @field: Field name (e.g., "IDENTITY")
+        * @field: Field indicator (e.g., WPA_CTRL_REQ_EAP_IDENTITY)
         * @txt: User readable text describing the required parameter
         */
-       void (*eap_param_needed)(void *ctx, const char *field,
+       void (*eap_param_needed)(void *ctx, enum wpa_ctrl_req_type field,
                                 const char *txt);
 
        /**

diff --git a/src/eapol_supp/eapol_supp_sm.c b/src/eapol_supp/eapol_supp_sm.c
index 88ba123515cc3bbd3ef1ee9ecfa5967d5609fb1f..ffc66197a9090edc4942f9519c9bc82a56d88381 100644 (file)
--- a/src/eapol_supp/eapol_supp_sm.c
+++ b/src/eapol_supp/eapol_supp_sm.c
@@ -1813,7 +1813,7 @@ static void eapol_sm_notify_pending(void *ctx)
 
 
 #if defined(CONFIG_CTRL_IFACE) || !defined(CONFIG_NO_STDOUT_DEBUG)
-static void eapol_sm_eap_param_needed(void *ctx, const char *field,
+static void eapol_sm_eap_param_needed(void *ctx, enum wpa_ctrl_req_type field,
                                      const char *txt)
 {
        struct eapol_sm *sm = ctx;

diff --git a/src/eapol_supp/eapol_supp_sm.h b/src/eapol_supp/eapol_supp_sm.h
index 48813a9943bd0de0d1ff1a353d493eb9002b164f..bcb00b5b1486c0b367f59d93bbf38c78b3b9a67d 100644 (file)
--- a/src/eapol_supp/eapol_supp_sm.h
+++ b/src/eapol_supp/eapol_supp_sm.h
@@ -208,10 +208,10 @@ struct eapol_ctx {
        /**
         * eap_param_needed - Notify that EAP parameter is needed
         * @ctx: Callback context (ctx)
-        * @field: Field name (e.g., "IDENTITY")
+        * @field: Field indicator (e.g., WPA_CTRL_REQ_EAP_IDENTITY)
         * @txt: User readable text describing the required parameter
         */
-       void (*eap_param_needed)(void *ctx, const char *field,
+       void (*eap_param_needed)(void *ctx, enum wpa_ctrl_req_type field,
                                 const char *txt);
 
        /**

diff --git a/wpa_supplicant/wpas_glue.c b/wpa_supplicant/wpas_glue.c
index c02fdd09aa4ef2b8245f811c27e70319ca6572a9..e4cb6137f38bbe696679066b23ecc73a1d4b456d 100644 (file)
--- a/wpa_supplicant/wpas_glue.c
+++ b/wpa_supplicant/wpas_glue.c
@@ -587,13 +587,60 @@ static int wpa_supplicant_tdls_peer_addset(
 #endif /* CONFIG_TDLS */
 
 
+const char * wpa_supplicant_ctrl_req_to_string(enum wpa_ctrl_req_type field,
+                                              const char *default_txt,
+                                              const char **txt)
+{
+       const char *ret = NULL;
+
+       *txt = default_txt;
+
+       switch (field) {
+       case WPA_CTRL_REQ_EAP_IDENTITY:
+               *txt = "Identity";
+               ret = "IDENTITY";
+               break;
+       case WPA_CTRL_REQ_EAP_PASSWORD:
+               *txt = "Password";
+               ret = "PASSWORD";
+               break;
+       case WPA_CTRL_REQ_EAP_NEW_PASSWORD:
+               *txt = "New Password";
+               ret = "NEW_PASSWORD";
+               break;
+       case WPA_CTRL_REQ_EAP_PIN:
+               *txt = "PIN";
+               ret = "PIN";
+               break;
+       case WPA_CTRL_REQ_EAP_OTP:
+               ret = "OTP";
+               break;
+       case WPA_CTRL_REQ_EAP_PASSPHRASE:
+               *txt = "Private key passphrase";
+               ret = "PASSPHRASE";
+               break;
+       default:
+               break;
+       }
+
+       /* txt needs to be something */
+       if (*txt == NULL) {
+               wpa_printf(MSG_WARNING, "No message for request %d", field);
+               ret = NULL;
+       }
+
+       return ret;
+}
+
 #ifdef IEEE8021X_EAPOL
 #if defined(CONFIG_CTRL_IFACE) || !defined(CONFIG_NO_STDOUT_DEBUG)
-static void wpa_supplicant_eap_param_needed(void *ctx, const char *field,
-                                           const char *txt)
+static void wpa_supplicant_eap_param_needed(void *ctx,
+                                           enum wpa_ctrl_req_type field,
+                                           const char *default_txt)
 {
        struct wpa_supplicant *wpa_s = ctx;
        struct wpa_ssid *ssid = wpa_s->current_ssid;
+       const char *field_name, *txt = NULL;
        char *buf;
        size_t buflen;
        int len;
@@ -601,13 +648,21 @@ static void wpa_supplicant_eap_param_needed(void *ctx, const char *field,
        if (ssid == NULL)
                return;
 
+       field_name = wpa_supplicant_ctrl_req_to_string(field, default_txt,
+                                                      &txt);
+       if (field_name == NULL) {
+               wpa_printf(MSG_WARNING, "Unhandled EAP param %d needed",
+                          field);
+               return;
+       }
+
        buflen = 100 + os_strlen(txt) + ssid->ssid_len;
        buf = os_malloc(buflen);
        if (buf == NULL)
                return;
        len = os_snprintf(buf, buflen,
                          WPA_CTRL_REQ "%s-%d:%s needed for SSID ",
-                         field, ssid->id, txt);
+                         field_name, ssid->id, txt);
        if (len < 0 || (size_t) len >= buflen) {
                os_free(buf);
                return;

diff --git a/wpa_supplicant/wpas_glue.h b/wpa_supplicant/wpas_glue.h
index b571e4df1714bc0edd1be3818a959c947a5afbdb..563eb7bea92871982d3e58389a0cb161f154f371 100644 (file)
--- a/wpa_supplicant/wpas_glue.h
+++ b/wpa_supplicant/wpas_glue.h
@@ -20,4 +20,8 @@ int wpa_supplicant_init_wpa(struct wpa_supplicant *wpa_s);
 void wpa_supplicant_rsn_supp_set_config(struct wpa_supplicant *wpa_s,
                                        struct wpa_ssid *ssid);
 
+const char * wpa_supplicant_ctrl_req_to_string(enum wpa_ctrl_req_type field,
+                                              const char *default_txt,
+                                              const char **txt);
+
 #endif /* WPAS_GLUE_H */