nl80211: Add MLME primitives to support external SME

This patch adds new nl80211 commands to allow user space to request
authentication and association (and also deauthentication and
disassociation). The commands are structured to allow separate
authentication and association steps, i.e., the interface between
kernel and user space is similar to the MLME SAP interface in IEEE
802.11 standard and an user space application takes the role of the
SME.

The patch introduces MLME-AUTHENTICATE.request,
MLME-{,RE}ASSOCIATE.request, MLME-DEAUTHENTICATE.request, and
MLME-DISASSOCIATE.request primitives. The authentication and
association commands request the actual operations in two steps
(assuming the driver supports this; if not, separate authentication
step is skipped; this could end up being a separate "connect"
command).

The initial implementation for mac80211 uses the current
net/mac80211/mlme.c for actual sending and processing of management
frames and the new nl80211 commands will just stop the current state
machine from moving automatically from authentication to association.
Future cleanup may move more of the MLME operations into cfg80211.

The goal of this design is to provide more control of authentication and
association process to user space without having to move the full MLME
implementation. This should be enough to allow IEEE 802.11r FT protocol
and 802.11s SAE authentication to be implemented. Obviously, this will
also bring the extra benefit of not having to use WEXT for association
requests with mac80211. An example implementation of a user space SME
using the new nl80211 commands is available for wpa_supplicant.

This patch is enough to get IEEE 802.11r FT protocol working with
over-the-air mechanism (over-the-DS will need additional MLME
primitives for handling the FT Action frames).

Signed-off-by: Jouni Malinen <j@w1.fi>
Signed-off-by: John W. Linville <linville@tuxdriver.com>

3 files changed, 162 insertions, 10 deletions

diff --git a/include/linux/ieee80211.h b/include/linux/ieee80211.h
index 382387e75b89..4b501b48ce86 100644
--- a/include/linux/ieee80211.h
+++ b/include/linux/ieee80211.h
@@ -867,6 +867,7 @@ struct ieee80211_ht_info {
 /* Authentication algorithms */
 #define WLAN_AUTH_OPEN 0
 #define WLAN_AUTH_SHARED_KEY 1
+#define WLAN_AUTH_FT 2
 #define WLAN_AUTH_LEAP 128
 
 #define WLAN_AUTH_CHALLENGE_LEN 128
diff --git a/include/linux/nl80211.h b/include/linux/nl80211.h
index 5ce68ae8314e..9685eaab40a9 100644
--- a/include/linux/nl80211.h
+++ b/include/linux/nl80211.h
@@ -161,24 +161,37 @@
  *      %NL80211_REG_TYPE_COUNTRY the alpha2 to which we have moved on
  *      to (%NL80211_ATTR_REG_ALPHA2).
  *
- * @NL80211_CMD_AUTHENTICATE: authentication notification (on the "mlme"
- *      multicast group). This event reports reception of an Authentication
+ * @NL80211_CMD_AUTHENTICATE: authentication request and notification.
+ *      This command is used both as a command (request to authenticate) and
+ *      as an event on the "mlme" multicast group indicating completion of the
+ *      authentication process.
+ *      When used as a command, %NL80211_ATTR_IFINDEX is used to identify the
+ *      interface. %NL80211_ATTR_MAC is used to specify PeerSTAAddress (and
+ *      BSSID in case of station mode). %NL80211_ATTR_SSID is used to specify
+ *      the SSID (mainly for association, but is included in authentication
+ *      request, too, to help BSS selection. %NL80211_ATTR_WIPHY_FREQ is used
+ *      to specify the frequence of the channel in MHz. %NL80211_ATTR_AUTH_TYPE
+ *      is used to specify the authentication type. %NL80211_ATTR_IE is used to
+ *      define IEs (VendorSpecificInfo, but also including RSN IE and FT IEs)
+ *      to be added to the frame.
+ *      When used as an event, this reports reception of an Authentication
  *      frame in station and IBSS modes when the local MLME processed the
  *      frame, i.e., it was for the local STA and was received in correct
  *      state. This is similar to MLME-AUTHENTICATE.confirm primitive in the
  *      MLME SAP interface (kernel providing MLME, userspace SME). The
  *      included NL80211_ATTR_FRAME attribute contains the management frame
  *      (including both the header and frame body, but not FCS).
- * @NL80211_CMD_ASSOCIATE: association notification; like
- *      NL80211_CMD_AUTHENTICATE but for Association Response and Reassociation
- *      Response frames (similar to MLME-ASSOCIATE.confirm or
- *      MLME-REASSOCIATE.confirm primitives).
- * @NL80211_CMD_DEAUTHENTICATE: deauthentication notification; like
+ * @NL80211_CMD_ASSOCIATE: association request and notification; like
+ *      NL80211_CMD_AUTHENTICATE but for Association and Reassociation
+ *      (similar to MLME-ASSOCIATE.request, MLME-REASSOCIATE.request,
+ *      MLME-ASSOCIATE.confirm or MLME-REASSOCIATE.confirm primitives).
+ * @NL80211_CMD_DEAUTHENTICATE: deauthentication request and notification; like
  *      NL80211_CMD_AUTHENTICATE but for Deauthentication frames (similar to
- *      MLME-DEAUTHENTICATE.indication primitive).
- * @NL80211_CMD_DISASSOCIATE: disassociation notification; like
+ *      MLME-DEAUTHENTICATION.request and MLME-DEAUTHENTICATE.indication
+ *      primitives).
+ * @NL80211_CMD_DISASSOCIATE: disassociation request and notification; like
  *      NL80211_CMD_AUTHENTICATE but for Disassociation frames (similar to
- *      MLME-DISASSOCIATE.indication primitive).
+ *      MLME-DISASSOCIATE.request and MLME-DISASSOCIATE.indication primitives).
  *
  * @NL80211_CMD_MAX: highest used command number
  * @__NL80211_CMD_AFTER_LAST: internal use
@@ -383,6 +396,11 @@ enum nl80211_commands {
  * @NL80211_ATTR_FRAME: frame data (binary attribute), including frame header
  *      and body, but not FCS; used, e.g., with NL80211_CMD_AUTHENTICATE and
  *      NL80211_CMD_ASSOCIATE events
+ * @NL80211_ATTR_SSID: SSID (binary attribute, 0..32 octets)
+ * @NL80211_ATTR_AUTH_TYPE: AuthenticationType, see &enum nl80211_auth_type,
+ *      represented as a u32
+ * @NL80211_ATTR_REASON_CODE: ReasonCode for %NL80211_CMD_DEAUTHENTICATE and
+ *      %NL80211_CMD_DISASSOCIATE, u16
  *
  * @NL80211_ATTR_MAX: highest attribute number currently defined
  * @__NL80211_ATTR_AFTER_LAST: internal use
@@ -464,6 +482,9 @@ enum nl80211_attrs {
         NL80211_ATTR_SUPPORTED_COMMANDS,
 
         NL80211_ATTR_FRAME,
+        NL80211_ATTR_SSID,
+        NL80211_ATTR_AUTH_TYPE,
+        NL80211_ATTR_REASON_CODE,
 
         /* add attributes here, update the policy in nl80211.c */
 
@@ -485,6 +506,9 @@ enum nl80211_attrs {
 #define NL80211_ATTR_REG_INITIATOR NL80211_ATTR_REG_INITIATOR
 #define NL80211_ATTR_REG_TYPE NL80211_ATTR_REG_TYPE
 #define NL80211_ATTR_FRAME NL80211_ATTR_FRAME
+#define NL80211_ATTR_SSID NL80211_ATTR_SSID
+#define NL80211_ATTR_AUTH_TYPE NL80211_ATTR_AUTH_TYPE
+#define NL80211_ATTR_REASON_CODE NL80211_ATTR_REASON_CODE
 
 #define NL80211_MAX_SUPP_RATES                  32
 #define NL80211_MAX_SUPP_REG_RULES              32
@@ -1018,4 +1042,18 @@ enum nl80211_bss {
         NL80211_BSS_MAX = __NL80211_BSS_AFTER_LAST - 1
 };
 
+/**
+ * enum nl80211_auth_type - AuthenticationType
+ *
+ * @NL80211_AUTHTYPE_OPEN_SYSTEM: Open System authentication
+ * @NL80211_AUTHTYPE_SHARED_KEY: Shared Key authentication (WEP only)
+ * @NL80211_AUTHTYPE_FT: Fast BSS Transition (IEEE 802.11r)
+ * @NL80211_AUTHTYPE_NETWORK_EAP: Network EAP (some Cisco APs and mainly LEAP)
+ */
+enum nl80211_auth_type {
+        NL80211_AUTHTYPE_OPEN_SYSTEM,
+        NL80211_AUTHTYPE_SHARED_KEY,
+        NL80211_AUTHTYPE_FT,
+        NL80211_AUTHTYPE_NETWORK_EAP,
+};
 #endif /* __LINUX_NL80211_H */
diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h
index ad44016021b1..0da9a55881a1 100644
--- a/include/net/cfg80211.h
+++ b/include/net/cfg80211.h
@@ -579,6 +579,105 @@ struct cfg80211_bss {
 };
 
 /**
+ * struct cfg80211_auth_request - Authentication request data
+ *
+ * This structure provides information needed to complete IEEE 802.11
+ * authentication.
+ * NOTE: This structure will likely change when more code from mac80211 is
+ * moved into cfg80211 so that non-mac80211 drivers can benefit from it, too.
+ * Before using this in a driver that does not use mac80211, it would be better
+ * to check the status of that work and better yet, volunteer to work on it.
+ *
+ * @chan: The channel to use or %NULL if not specified (auto-select based on
+ *      scan results)
+ * @peer_addr: The address of the peer STA (AP BSSID in infrastructure case);
+ *      this field is required to be present; if the driver wants to help with
+ *      BSS selection, it should use (yet to be added) MLME event to allow user
+ *      space SME to be notified of roaming candidate, so that the SME can then
+ *      use the authentication request with the recommended BSSID and whatever
+ *      other data may be needed for authentication/association
+ * @ssid: SSID or %NULL if not yet available
+ * @ssid_len: Length of ssid in octets
+ * @auth_type: Authentication type (algorithm)
+ * @ie: Extra IEs to add to Authentication frame or %NULL
+ * @ie_len: Length of ie buffer in octets
+ */
+struct cfg80211_auth_request {
+        struct ieee80211_channel *chan;
+        u8 *peer_addr;
+        const u8 *ssid;
+        size_t ssid_len;
+        enum nl80211_auth_type auth_type;
+        const u8 *ie;
+        size_t ie_len;
+};
+
+/**
+ * struct cfg80211_assoc_request - (Re)Association request data
+ *
+ * This structure provides information needed to complete IEEE 802.11
+ * (re)association.
+ * NOTE: This structure will likely change when more code from mac80211 is
+ * moved into cfg80211 so that non-mac80211 drivers can benefit from it, too.
+ * Before using this in a driver that does not use mac80211, it would be better
+ * to check the status of that work and better yet, volunteer to work on it.
+ *
+ * @chan: The channel to use or %NULL if not specified (auto-select based on
+ *      scan results)
+ * @peer_addr: The address of the peer STA (AP BSSID); this field is required
+ *      to be present and the STA must be in State 2 (authenticated) with the
+ *      peer STA
+ * @ssid: SSID
+ * @ssid_len: Length of ssid in octets
+ * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
+ * @ie_len: Length of ie buffer in octets
+ */
+struct cfg80211_assoc_request {
+        struct ieee80211_channel *chan;
+        u8 *peer_addr;
+        const u8 *ssid;
+        size_t ssid_len;
+        const u8 *ie;
+        size_t ie_len;
+};
+
+/**
+ * struct cfg80211_deauth_request - Deauthentication request data
+ *
+ * This structure provides information needed to complete IEEE 802.11
+ * deauthentication.
+ *
+ * @peer_addr: The address of the peer STA (AP BSSID); this field is required
+ *      to be present and the STA must be authenticated with the peer STA
+ * @ie: Extra IEs to add to Deauthentication frame or %NULL
+ * @ie_len: Length of ie buffer in octets
+ */
+struct cfg80211_deauth_request {
+        u8 *peer_addr;
+        u16 reason_code;
+        const u8 *ie;
+        size_t ie_len;
+};
+
+/**
+ * struct cfg80211_disassoc_request - Disassociation request data
+ *
+ * This structure provides information needed to complete IEEE 802.11
+ * disassocation.
+ *
+ * @peer_addr: The address of the peer STA (AP BSSID); this field is required
+ *      to be present and the STA must be associated with the peer STA
+ * @ie: Extra IEs to add to Disassociation frame or %NULL
+ * @ie_len: Length of ie buffer in octets
+ */
+struct cfg80211_disassoc_request {
+        u8 *peer_addr;
+        u16 reason_code;
+        const u8 *ie;
+        size_t ie_len;
+};
+
+/**
  * struct cfg80211_ops - backend description for wireless configuration
  *
  * This struct is registered by fullmac card drivers and/or wireless stacks
@@ -650,6 +749,11 @@ struct cfg80211_bss {
  *      the driver, and will be valid until passed to cfg80211_scan_done().
  *      For scan results, call cfg80211_inform_bss(); you can call this outside
  *      the scan/scan_done bracket too.
+ *
+ * @auth: Request to authenticate with the specified peer
+ * @assoc: Request to (re)associate with the specified peer
+ * @deauth: Request to deauthenticate from the specified peer
+ * @disassoc: Request to disassociate from the specified peer
  */
 struct cfg80211_ops {
         int     (*suspend)(struct wiphy *wiphy);
@@ -730,6 +834,15 @@ struct cfg80211_ops {
 
         int     (*scan)(struct wiphy *wiphy, struct net_device *dev,
                         struct cfg80211_scan_request *request);
+
+        int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
+                        struct cfg80211_auth_request *req);
+        int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
+                         struct cfg80211_assoc_request *req);
+        int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
+                          struct cfg80211_deauth_request *req);
+        int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
+                            struct cfg80211_disassoc_request *req);
 };
 
 /* temporary wext handlers */