/src/hostap/src/common/defs.h

Source (jump to first uncovered line)
/*
 * WPA Supplicant - Common definitions
 * Copyright (c) 2004-2018, Jouni Malinen <j@w1.fi>
 *
 * This software may be distributed under the terms of the BSD license.
 * See README for more details.
 */

#ifndef DEFS_H
#define DEFS_H

#define WPA_CIPHER_NONE BIT(0)
#define WPA_CIPHER_WEP40 BIT(1)
#define WPA_CIPHER_WEP104 BIT(2)
#define WPA_CIPHER_TKIP BIT(3)
#define WPA_CIPHER_CCMP BIT(4)
#define WPA_CIPHER_AES_128_CMAC BIT(5)
#define WPA_CIPHER_GCMP BIT(6)
#define WPA_CIPHER_SMS4 BIT(7)
#define WPA_CIPHER_GCMP_256 BIT(8)
#define WPA_CIPHER_CCMP_256 BIT(9)
#define WPA_CIPHER_BIP_GMAC_128 BIT(11)
#define WPA_CIPHER_BIP_GMAC_256 BIT(12)
#define WPA_CIPHER_BIP_CMAC_256 BIT(13)
#define WPA_CIPHER_GTK_NOT_USED BIT(14)

#define WPA_KEY_MGMT_IEEE8021X BIT(0)
#define WPA_KEY_MGMT_PSK BIT(1)
#define WPA_KEY_MGMT_NONE BIT(2)
#define WPA_KEY_MGMT_IEEE8021X_NO_WPA BIT(3)
#define WPA_KEY_MGMT_WPA_NONE BIT(4)
#define WPA_KEY_MGMT_FT_IEEE8021X BIT(5)
#define WPA_KEY_MGMT_FT_PSK BIT(6)
#define WPA_KEY_MGMT_IEEE8021X_SHA256 BIT(7)
#define WPA_KEY_MGMT_PSK_SHA256 BIT(8)
#define WPA_KEY_MGMT_WPS BIT(9)
#define WPA_KEY_MGMT_SAE BIT(10)
#define WPA_KEY_MGMT_FT_SAE BIT(11)
#define WPA_KEY_MGMT_WAPI_PSK BIT(12)
#define WPA_KEY_MGMT_WAPI_CERT BIT(13)
#define WPA_KEY_MGMT_CCKM BIT(14)
#define WPA_KEY_MGMT_IEEE8021X_SUITE_B BIT(16)
#define WPA_KEY_MGMT_IEEE8021X_SUITE_B_192 BIT(17)
#define WPA_KEY_MGMT_FILS_SHA256 BIT(18)
#define WPA_KEY_MGMT_FILS_SHA384 BIT(19)
#define WPA_KEY_MGMT_FT_FILS_SHA256 BIT(20)
#define WPA_KEY_MGMT_FT_FILS_SHA384 BIT(21)
#define WPA_KEY_MGMT_OWE BIT(22)
#define WPA_KEY_MGMT_DPP BIT(23)
#define WPA_KEY_MGMT_FT_IEEE8021X_SHA384 BIT(24)
#define WPA_KEY_MGMT_PASN BIT(25)
#define WPA_KEY_MGMT_SAE_EXT_KEY BIT(26)
#define WPA_KEY_MGMT_FT_SAE_EXT_KEY BIT(27)
#define WPA_KEY_MGMT_IEEE8021X_SHA384 BIT(28)


#define WPA_KEY_MGMT_FT (WPA_KEY_MGMT_FT_PSK | \
       WPA_KEY_MGMT_FT_IEEE8021X | \
       WPA_KEY_MGMT_FT_IEEE8021X_SHA384 | \
       WPA_KEY_MGMT_FT_SAE | \
       WPA_KEY_MGMT_FT_SAE_EXT_KEY | \
       WPA_KEY_MGMT_FT_FILS_SHA256 | \
       WPA_KEY_MGMT_FT_FILS_SHA384)

static inline int wpa_key_mgmt_wpa_ieee8021x(int akm)
{
  return !!(akm & (WPA_KEY_MGMT_IEEE8021X |
       WPA_KEY_MGMT_FT_IEEE8021X |
       WPA_KEY_MGMT_FT_IEEE8021X_SHA384 |
       WPA_KEY_MGMT_CCKM |
       WPA_KEY_MGMT_IEEE8021X_SHA256 |
       WPA_KEY_MGMT_IEEE8021X_SUITE_B |
       WPA_KEY_MGMT_IEEE8021X_SUITE_B_192 |
       WPA_KEY_MGMT_FILS_SHA256 |
       WPA_KEY_MGMT_FILS_SHA384 |
       WPA_KEY_MGMT_FT_FILS_SHA256 |
       WPA_KEY_MGMT_FT_FILS_SHA384 |
       WPA_KEY_MGMT_IEEE8021X_SHA384));
}

static inline int wpa_key_mgmt_wpa_psk_no_sae(int akm)
{
  return !!(akm & (WPA_KEY_MGMT_PSK |
       WPA_KEY_MGMT_FT_PSK |
       WPA_KEY_MGMT_PSK_SHA256));
}

static inline int wpa_key_mgmt_wpa_psk(int akm)
{
  return !!(akm & (WPA_KEY_MGMT_PSK |
       WPA_KEY_MGMT_FT_PSK |
       WPA_KEY_MGMT_PSK_SHA256 |
       WPA_KEY_MGMT_SAE |
       WPA_KEY_MGMT_SAE_EXT_KEY |
       WPA_KEY_MGMT_FT_SAE |
       WPA_KEY_MGMT_FT_SAE_EXT_KEY));
}

static inline int wpa_key_mgmt_ft(int akm)
{
  return !!(akm & WPA_KEY_MGMT_FT);
}

static inline int wpa_key_mgmt_only_ft(int akm)
{
  int ft = wpa_key_mgmt_ft(akm);
  akm &= ~WPA_KEY_MGMT_FT;
  return ft && !akm;
}

static inline int wpa_key_mgmt_ft_psk(int akm)
{
  return !!(akm & WPA_KEY_MGMT_FT_PSK);
}

static inline int wpa_key_mgmt_sae(int akm)
{
  return !!(akm & (WPA_KEY_MGMT_SAE |
       WPA_KEY_MGMT_SAE_EXT_KEY |
       WPA_KEY_MGMT_FT_SAE |
       WPA_KEY_MGMT_FT_SAE_EXT_KEY));
}

static inline int wpa_key_mgmt_sae_ext_key(int akm)
{
  return !!(akm & (WPA_KEY_MGMT_SAE_EXT_KEY |
       WPA_KEY_MGMT_FT_SAE_EXT_KEY));
}

static inline int wpa_key_mgmt_only_sae(int akm)
{
  return wpa_key_mgmt_sae(akm) &&
    !(akm & ~(WPA_KEY_MGMT_SAE |
        WPA_KEY_MGMT_SAE_EXT_KEY |
        WPA_KEY_MGMT_FT_SAE |
        WPA_KEY_MGMT_FT_SAE_EXT_KEY));
}

static inline int wpa_key_mgmt_fils(int akm)
{
  return !!(akm & (WPA_KEY_MGMT_FILS_SHA256 |
       WPA_KEY_MGMT_FILS_SHA384 |
       WPA_KEY_MGMT_FT_FILS_SHA256 |
       WPA_KEY_MGMT_FT_FILS_SHA384));
}

static inline int wpa_key_mgmt_sha256(int akm)
{
  return !!(akm & (WPA_KEY_MGMT_FT_IEEE8021X |
       WPA_KEY_MGMT_PSK_SHA256 |
       WPA_KEY_MGMT_IEEE8021X_SHA256 |
       WPA_KEY_MGMT_SAE |
       WPA_KEY_MGMT_FT_SAE |
       WPA_KEY_MGMT_IEEE8021X_SUITE_B |
       WPA_KEY_MGMT_FILS_SHA256 |
       WPA_KEY_MGMT_FT_FILS_SHA256));
}

static inline int wpa_key_mgmt_sha384(int akm)
{
  return !!(akm & (WPA_KEY_MGMT_IEEE8021X_SUITE_B_192 |
       WPA_KEY_MGMT_FT_IEEE8021X_SHA384 |
       WPA_KEY_MGMT_FILS_SHA384 |
       WPA_KEY_MGMT_FT_FILS_SHA384 |
       WPA_KEY_MGMT_IEEE8021X_SHA384));
}

static inline int wpa_key_mgmt_suite_b(int akm)
{
  return !!(akm & (WPA_KEY_MGMT_IEEE8021X_SUITE_B |
       WPA_KEY_MGMT_IEEE8021X_SUITE_B_192));
}

static inline int wpa_key_mgmt_wpa(int akm)
{
  return wpa_key_mgmt_wpa_ieee8021x(akm) ||
    wpa_key_mgmt_wpa_psk(akm) ||
    wpa_key_mgmt_fils(akm) ||
    wpa_key_mgmt_sae(akm) ||
    akm == WPA_KEY_MGMT_OWE ||
    akm == WPA_KEY_MGMT_DPP;
}

static inline int wpa_key_mgmt_wpa_any(int akm)
{
  return wpa_key_mgmt_wpa(akm) || (akm & WPA_KEY_MGMT_WPA_NONE);
}

static inline int wpa_key_mgmt_cckm(int akm)
{
  return akm == WPA_KEY_MGMT_CCKM;
}

static inline int wpa_key_mgmt_cross_akm(int akm)
{
  return !!(akm & (WPA_KEY_MGMT_PSK |
       WPA_KEY_MGMT_PSK_SHA256 |
       WPA_KEY_MGMT_SAE |
       WPA_KEY_MGMT_SAE_EXT_KEY));
}

#define WPA_PROTO_WPA BIT(0)
#define WPA_PROTO_RSN BIT(1)
#define WPA_PROTO_WAPI BIT(2)

#define WPA_AUTH_ALG_OPEN BIT(0)
#define WPA_AUTH_ALG_SHARED BIT(1)
#define WPA_AUTH_ALG_LEAP BIT(2)
#define WPA_AUTH_ALG_FT BIT(3)
#define WPA_AUTH_ALG_SAE BIT(4)
#define WPA_AUTH_ALG_FILS BIT(5)
#define WPA_AUTH_ALG_FILS_SK_PFS BIT(6)

static inline int wpa_auth_alg_fils(int alg)
{
  return !!(alg & (WPA_AUTH_ALG_FILS | WPA_AUTH_ALG_FILS_SK_PFS));
}

enum wpa_alg {
  WPA_ALG_NONE,
  WPA_ALG_WEP,
  WPA_ALG_TKIP,
  WPA_ALG_CCMP,
  WPA_ALG_BIP_CMAC_128,
  WPA_ALG_GCMP,
  WPA_ALG_SMS4,
  WPA_ALG_KRK,
  WPA_ALG_GCMP_256,
  WPA_ALG_CCMP_256,
  WPA_ALG_BIP_GMAC_128,
  WPA_ALG_BIP_GMAC_256,
  WPA_ALG_BIP_CMAC_256
};

static inline int wpa_alg_bip(enum wpa_alg alg)
{
  return alg == WPA_ALG_BIP_CMAC_128 ||
    alg == WPA_ALG_BIP_GMAC_128 ||
    alg == WPA_ALG_BIP_GMAC_256 ||
    alg == WPA_ALG_BIP_CMAC_256;
}

/**
 * enum wpa_states - wpa_supplicant state
 *
 * These enumeration values are used to indicate the current wpa_supplicant
 * state (wpa_s->wpa_state). The current state can be retrieved with
 * wpa_supplicant_get_state() function and the state can be changed by calling
 * wpa_supplicant_set_state(). In WPA state machine (wpa.c and preauth.c), the
 * wrapper functions wpa_sm_get_state() and wpa_sm_set_state() should be used
 * to access the state variable.
 */
enum wpa_states {
  /**
   * WPA_DISCONNECTED - Disconnected state
   *
   * This state indicates that client is not associated, but is likely to
   * start looking for an access point. This state is entered when a
   * connection is lost.
   */
  WPA_DISCONNECTED,

  /**
   * WPA_INTERFACE_DISABLED - Interface disabled
   *
   * This state is entered if the network interface is disabled, e.g.,
   * due to rfkill. wpa_supplicant refuses any new operations that would
   * use the radio until the interface has been enabled.
   */
  WPA_INTERFACE_DISABLED,

  /**
   * WPA_INACTIVE - Inactive state (wpa_supplicant disabled)
   *
   * This state is entered if there are no enabled networks in the
   * configuration. wpa_supplicant is not trying to associate with a new
   * network and external interaction (e.g., ctrl_iface call to add or
   * enable a network) is needed to start association.
   */
  WPA_INACTIVE,

  /**
   * WPA_SCANNING - Scanning for a network
   *
   * This state is entered when wpa_supplicant starts scanning for a
   * network.
   */
  WPA_SCANNING,

  /**
   * WPA_AUTHENTICATING - Trying to authenticate with a BSS/SSID
   *
   * This state is entered when wpa_supplicant has found a suitable BSS
   * to authenticate with and the driver is configured to try to
   * authenticate with this BSS. This state is used only with drivers
   * that use wpa_supplicant as the SME.
   */
  WPA_AUTHENTICATING,

  /**
   * WPA_ASSOCIATING - Trying to associate with a BSS/SSID
   *
   * This state is entered when wpa_supplicant has found a suitable BSS
   * to associate with and the driver is configured to try to associate
   * with this BSS in ap_scan=1 mode. When using ap_scan=2 mode, this
   * state is entered when the driver is configured to try to associate
   * with a network using the configured SSID and security policy.
   */
  WPA_ASSOCIATING,

  /**
   * WPA_ASSOCIATED - Association completed
   *
   * This state is entered when the driver reports that association has
   * been successfully completed with an AP. If IEEE 802.1X is used
   * (with or without WPA/WPA2), wpa_supplicant remains in this state
   * until the IEEE 802.1X/EAPOL authentication has been completed.
   */
  WPA_ASSOCIATED,

  /**
   * WPA_4WAY_HANDSHAKE - WPA 4-Way Key Handshake in progress
   *
   * This state is entered when WPA/WPA2 4-Way Handshake is started. In
   * case of WPA-PSK, this happens when receiving the first EAPOL-Key
   * frame after association. In case of WPA-EAP, this state is entered
   * when the IEEE 802.1X/EAPOL authentication has been completed.
   */
  WPA_4WAY_HANDSHAKE,

  /**
   * WPA_GROUP_HANDSHAKE - WPA Group Key Handshake in progress
   *
   * This state is entered when 4-Way Key Handshake has been completed
   * (i.e., when the supplicant sends out message 4/4) and when Group
   * Key rekeying is started by the AP (i.e., when supplicant receives
   * message 1/2).
   */
  WPA_GROUP_HANDSHAKE,

  /**
   * WPA_COMPLETED - All authentication completed
   *
   * This state is entered when the full authentication process is
   * completed. In case of WPA2, this happens when the 4-Way Handshake is
   * successfully completed. With WPA, this state is entered after the
   * Group Key Handshake; with IEEE 802.1X (non-WPA) connection is
   * completed after dynamic keys are received (or if not used, after
   * the EAP authentication has been completed). With static WEP keys and
   * plaintext connections, this state is entered when an association
   * has been completed.
   *
   * This state indicates that the supplicant has completed its
   * processing for the association phase and that data connection is
   * fully configured.
   */
  WPA_COMPLETED
};

#define MLME_SETPROTECTION_PROTECT_TYPE_NONE 0
#define MLME_SETPROTECTION_PROTECT_TYPE_RX 1
#define MLME_SETPROTECTION_PROTECT_TYPE_TX 2
#define MLME_SETPROTECTION_PROTECT_TYPE_RX_TX 3

#define MLME_SETPROTECTION_KEY_TYPE_GROUP 0
#define MLME_SETPROTECTION_KEY_TYPE_PAIRWISE 1


/**
 * enum mfp_options - Management frame protection (IEEE 802.11w) options
 */
enum mfp_options {
  NO_MGMT_FRAME_PROTECTION = 0,
  MGMT_FRAME_PROTECTION_OPTIONAL = 1,
  MGMT_FRAME_PROTECTION_REQUIRED = 2,
};
#define MGMT_FRAME_PROTECTION_DEFAULT 3

/**
 * enum hostapd_hw_mode - Hardware mode
 */
enum hostapd_hw_mode {
  HOSTAPD_MODE_IEEE80211B,
  HOSTAPD_MODE_IEEE80211G,
  HOSTAPD_MODE_IEEE80211A,
  HOSTAPD_MODE_IEEE80211AD,
  HOSTAPD_MODE_IEEE80211ANY,
  NUM_HOSTAPD_MODES
};

/**
 * enum wpa_ctrl_req_type - Control interface request types
 */
enum wpa_ctrl_req_type {
  WPA_CTRL_REQ_UNKNOWN,
  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,
  WPA_CTRL_REQ_SIM,
  WPA_CTRL_REQ_PSK_PASSPHRASE,
  WPA_CTRL_REQ_EXT_CERT_CHECK,
  NUM_WPA_CTRL_REQS
};

/* Maximum number of EAP methods to store for EAP server user information */
#define EAP_MAX_METHODS 8

enum mesh_plink_state {
  PLINK_IDLE = 1,
  PLINK_OPN_SNT,
  PLINK_OPN_RCVD,
  PLINK_CNF_RCVD,
  PLINK_ESTAB,
  PLINK_HOLDING,
  PLINK_BLOCKED, /* not defined in the IEEE 802.11 standard */
};

enum set_band {
  WPA_SETBAND_AUTO = 0,
  WPA_SETBAND_5G = BIT(0),
  WPA_SETBAND_2G = BIT(1),
  WPA_SETBAND_6G = BIT(2),
};

enum wpa_radio_work_band {
  BAND_2_4_GHZ = BIT(0),
  BAND_5_GHZ = BIT(1),
  BAND_60_GHZ = BIT(2),
};

enum beacon_rate_type {
  BEACON_RATE_LEGACY,
  BEACON_RATE_HT,
  BEACON_RATE_VHT,
  BEACON_RATE_HE
};

enum eap_proxy_sim_state {
  SIM_STATE_ERROR,
};

#define OCE_STA BIT(0)
#define OCE_STA_CFON BIT(1)
#define OCE_AP BIT(2)

/* enum chan_width - Channel width definitions */
enum chan_width {
  CHAN_WIDTH_20_NOHT,
  CHAN_WIDTH_20,
  CHAN_WIDTH_40,
  CHAN_WIDTH_80,
  CHAN_WIDTH_80P80,
  CHAN_WIDTH_160,
  CHAN_WIDTH_2160,
  CHAN_WIDTH_4320,
  CHAN_WIDTH_6480,
  CHAN_WIDTH_8640,
  CHAN_WIDTH_320,
  CHAN_WIDTH_UNKNOWN
};

/* VHT/EDMG/etc. channel widths
 * Note: The first four values are used in hostapd.conf and as such, must
 * maintain their defined values. Other values are used internally. */
enum oper_chan_width {
  CONF_OPER_CHWIDTH_USE_HT = 0,
  CONF_OPER_CHWIDTH_80MHZ = 1,
  CONF_OPER_CHWIDTH_160MHZ = 2,
  CONF_OPER_CHWIDTH_80P80MHZ = 3,
  CONF_OPER_CHWIDTH_2160MHZ,
  CONF_OPER_CHWIDTH_4320MHZ,
  CONF_OPER_CHWIDTH_6480MHZ,
  CONF_OPER_CHWIDTH_8640MHZ,
  CONF_OPER_CHWIDTH_40MHZ_6GHZ,
  CONF_OPER_CHWIDTH_320MHZ,
};

enum key_flag {
  KEY_FLAG_MODIFY     = BIT(0),
  KEY_FLAG_DEFAULT    = BIT(1),
  KEY_FLAG_RX     = BIT(2),
  KEY_FLAG_TX     = BIT(3),
  KEY_FLAG_GROUP      = BIT(4),
  KEY_FLAG_PAIRWISE   = BIT(5),
  KEY_FLAG_PMK      = BIT(6),
  KEY_FLAG_NEXT     = BIT(7),
  /* Used flag combinations */
  KEY_FLAG_RX_TX      = KEY_FLAG_RX | KEY_FLAG_TX,
  KEY_FLAG_GROUP_RX_TX    = KEY_FLAG_GROUP | KEY_FLAG_RX_TX,
  KEY_FLAG_GROUP_RX_TX_DEFAULT  = KEY_FLAG_GROUP_RX_TX |
            KEY_FLAG_DEFAULT,
  KEY_FLAG_GROUP_RX   = KEY_FLAG_GROUP | KEY_FLAG_RX,
  KEY_FLAG_GROUP_TX_DEFAULT = KEY_FLAG_GROUP | KEY_FLAG_TX |
            KEY_FLAG_DEFAULT,
  KEY_FLAG_PAIRWISE_RX_TX   = KEY_FLAG_PAIRWISE | KEY_FLAG_RX_TX,
  KEY_FLAG_PAIRWISE_RX    = KEY_FLAG_PAIRWISE | KEY_FLAG_RX,
  KEY_FLAG_PAIRWISE_RX_TX_MODIFY  = KEY_FLAG_PAIRWISE_RX_TX |
            KEY_FLAG_MODIFY,
  KEY_FLAG_PAIRWISE_NEXT    = KEY_FLAG_PAIRWISE_RX | KEY_FLAG_NEXT,
  /* Max allowed flags for each key type */
  KEY_FLAG_PAIRWISE_MASK    = KEY_FLAG_PAIRWISE_RX_TX_MODIFY |
            KEY_FLAG_NEXT,
  KEY_FLAG_GROUP_MASK   = KEY_FLAG_GROUP_RX_TX_DEFAULT,
  KEY_FLAG_PMK_MASK   = KEY_FLAG_PMK,
};

static inline int check_key_flag(enum key_flag key_flag)
{
  return !!(!key_flag ||
      ((key_flag & (KEY_FLAG_PAIRWISE | KEY_FLAG_MODIFY)) &&
       (key_flag & ~KEY_FLAG_PAIRWISE_MASK)) ||
      ((key_flag & KEY_FLAG_GROUP) &&
       (key_flag & ~KEY_FLAG_GROUP_MASK)) ||
      ((key_flag & KEY_FLAG_PMK) &&
       (key_flag & ~KEY_FLAG_PMK_MASK)));
}

enum ptk0_rekey_handling {
  PTK0_REKEY_ALLOW_ALWAYS,
  PTK0_REKEY_ALLOW_LOCAL_OK,
  PTK0_REKEY_ALLOW_NEVER
};

enum frame_encryption {
  FRAME_ENCRYPTION_UNKNOWN = -1,
  FRAME_NOT_ENCRYPTED = 0,
  FRAME_ENCRYPTED = 1
};

#define MAX_NUM_MLD_LINKS 15

enum sae_pwe {
  SAE_PWE_HUNT_AND_PECK = 0,
  SAE_PWE_HASH_TO_ELEMENT = 1,
  SAE_PWE_BOTH = 2,
  SAE_PWE_FORCE_HUNT_AND_PECK = 3,
  SAE_PWE_NOT_SET = 4,
};

enum wpa_p2p_mode {
  WPA_P2P_MODE_WFD_R1 = 0,
  WPA_P2P_MODE_WFD_R2 = 1,
  WPA_P2P_MODE_WFD_PCC  = 2,
};

#define USEC_80211_TU 1024

#define USEC_TO_TU(m) ((m) / USEC_80211_TU)
#define TU_TO_USEC(m) ((m) * USEC_80211_TU)

#endif /* DEFS_H */

Coverage Report

Created: 2025-04-24 06:18