iwd/src/ie.h

/*
 *
 *  Wireless daemon for Linux
 *
 *  Copyright (C) 2013-2014  Intel Corporation. All rights reserved.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#include <stdbool.h>
#include <stddef.h>
#include <unistd.h>

struct l_uintset;

/*
 * Information elements, IEEE Std 802.11-2012 ch. 8.4.2 and
 * 802.11-2016 ch. 9.4.2.
 */
enum ie_type {
	IE_TYPE_SSID                                 = 0,
	IE_TYPE_SUPPORTED_RATES                      = 1,
	IE_TYPE_FH_PARAMETER_SET                     = 2,
	IE_TYPE_DSSS_PARAMETER_SET                   = 3,
	IE_TYPE_CF_PARAMETER_SET                     = 4,
	IE_TYPE_TIM                                  = 5,
	IE_TYPE_IBSS_PARAMETER_SET                   = 6,
	IE_TYPE_COUNTRY                              = 7,
	IE_TYPE_HOPPING_PATTERN_PARAMETERS           = 8,
	IE_TYPE_HOPPING_PATTERN_TABLE                = 9,
	IE_TYPE_REQUEST                              = 10,
	IE_TYPE_BSS_LOAD                             = 11,
	IE_TYPE_EDCA_PARAMETER_SET                   = 12,
	IE_TYPE_TSPEC                                = 13,
	IE_TYPE_TCLAS                                = 14,
	IE_TYPE_SCHEDULE                             = 15,
	IE_TYPE_CHALLENGE_TEXT                       = 16,
	/* Reserved 17 - 31 */
	IE_TYPE_POWER_CONSTRAINT                     = 32,
	IE_TYPE_POWER_CAPABILITY                     = 33,
	IE_TYPE_TPC_REQUEST                          = 34,
	IE_TYPE_TPC_REPORT                           = 35,
	IE_TYPE_SUPPORTED_CHANNELS                   = 36,
	IE_TYPE_CHANNEL_SWITCH_ANNOUNCEMENT          = 37,
	IE_TYPE_MEASUREMENT_REQUEST                  = 38,
	IE_TYPE_MEASUREMENT_REPORT                   = 39,
	IE_TYPE_QUIET                                = 40,
	IE_TYPE_IBSS_DFS                             = 41,
	IE_TYPE_ERP                                  = 42,
	IE_TYPE_TS_DELAY                             = 43,
	IE_TYPE_TCLAS_PROCESSING                     = 44,
	IE_TYPE_HT_CAPABILITIES                      = 45,
	IE_TYPE_QOS_CAPABILITY                       = 46,
	/* Reserved 47 */
	IE_TYPE_RSN                                  = 48,
	/* Reserved 49 */
	IE_TYPE_EXTENDED_SUPPORTED_RATES             = 50,
	IE_TYPE_AP_CHANNEL_REPORT                    = 51,
	IE_TYPE_NEIGHBOR_REPORT                      = 52,
	IE_TYPE_RCPI                                 = 53,
	IE_TYPE_MOBILITY_DOMAIN                      = 54,
	IE_TYPE_FAST_BSS_TRANSITION                  = 55,
	IE_TYPE_TIMEOUT_INTERVAL                     = 56,
	IE_TYPE_RIC_DATA                             = 57,
	IE_TYPE_DSE_REGISTERED_LOCATION              = 58,
	IE_TYPE_SUPPORTED_OPERATING_CLASSES          = 59,
	IE_TYPE_EXTENDED_CHANNEL_SWITCH_ANNOUNCEMENT = 60,
	IE_TYPE_HT_OPERATION                         = 61,
	IE_TYPE_SECONDARY_CHANNEL_OFFSET             = 62,
	IE_TYPE_BSS_AVERAGE_ACCESS_DELAY             = 63,
	IE_TYPE_ANTENNA                              = 64,
	IE_TYPE_RSNI                                 = 65,
	IE_TYPE_MEASUREMENT_PILOT_TRANSMISSION       = 66,
	IE_TYPE_BSS_AVAILABLE_ADMISSION_CAPACITY     = 67,
	IE_TYPE_BSS_AC_ACCESS_DELAY                  = 68,
	IE_TYPE_TIME_ADVERTISEMENT                   = 69,
	IE_TYPE_RM_ENABLED_CAPABILITIES              = 70,
	IE_TYPE_MULTIPLE_BSSID                       = 71,
	IE_TYPE_BSS_COEXISTENCE                      = 72,
	IE_TYPE_BSS_INTOLERANT_CHANNEL_REPORT        = 73,
	IE_TYPE_OVERLAPPING_BSS_SCAN_PARAMETERS      = 74,
	IE_TYPE_RIC_DESCRIPTOR                       = 75,
	IE_TYPE_MANAGEMENT_MIC                       = 76,
	IE_TYPE_EVENT_REQUEST                        = 78,
	IE_TYPE_EVENT_REPORT                         = 79,
	IE_TYPE_DIAGNOSTIC_REQUEST                   = 80,
	IE_TYPE_DIAGNOSTIC_REPORT                    = 81,
	IE_TYPE_LOCATION_PARAMETERS                  = 82,
	IE_TYPE_NONTRANSMITTED_BSSID_CAPABILITY      = 83,
	IE_TYPE_SSID_LIST                            = 84,
	IE_TYPE_MULTIPLE_BSSID_INDEX                 = 85,
	IE_TYPE_FMS_DESCRIPTOR                       = 86,
	IE_TYPE_FMS_REQUEST                          = 87,
	IE_TYPE_FMS_RESPONSE                         = 88,
	IE_TYPE_QOS_TRAFFIC_CAPABILITY               = 89,
	IE_TYPE_BSS_MAX_IDLE_PERIOD                  = 90,
	IE_TYPE_TFS_REQUEST                          = 91,
	IE_TYPE_TFS_RESPONSE                         = 92,
	IE_TYPE_WNM_SLEEP_MODE                       = 93,
	IE_TYPE_TIM_BROADCAST_REQUEST                = 94,
	IE_TYPE_TIM_BROADCAST_RESPONSE               = 95,
	IE_TYPE_COLLOCATED_INTERFERENCE_REPORT       = 96,
	IE_TYPE_CHANNEL_USAGE                        = 97,
	IE_TYPE_TIME_ZONE                            = 98,
	IE_TYPE_DMS_REQUEST                          = 99,
	IE_TYPE_DMS_RESPONSE                         = 100,
	IE_TYPE_LINK_IDENTIFIER                      = 101,
	IE_TYPE_WAKEUP_SCHEDULE                      = 102,
	IE_TYPE_CHANNEL_SWITCH_TIMING                = 104,
	IE_TYPE_PTI_CONTROL                          = 105,
	IE_TYPE_TPU_BUFFER_STATUS                    = 106,
	IE_TYPE_INTERWORKING                         = 107,
	IE_TYPE_ADVERTISEMENT_PROTOCOL               = 108,
	IE_TYPE_EXPEDITED_BANDWIDTH_REQUEST          = 109,
	IE_TYPE_QOS_MAP_SET                          = 110,
	IE_TYPE_ROAMING_CONSORTIUM                   = 111,
	IE_TYPE_EMERGENCY_ALERT_IDENTIFIER           = 112,
	IE_TYPE_MESH_CONFIGURATION                   = 113,
	IE_TYPE_MESH_ID                              = 114,
	IE_TYPE_MESH_LINK_METRIC_REPORT              = 115,
	IE_TYPE_CONGESTION_NOTIFICATION              = 116,
	IE_TYPE_MESH_PEERING_MANAGEMENT              = 117,
	IE_TYPE_MESH_CHANNEL_SWITCH_PARAMETERS       = 118,
	IE_TYPE_MESH_AWAKE_WINDOW                    = 119,
	IE_TYPE_BEACON_TIMING                        = 120,
	IE_TYPE_MCCAOP_SETUP_REQUEST                 = 121,
	IE_TYPE_MCCAOP_SETUP_REPLY                   = 122,
	IE_TYPE_MCCAOP_ADVERTISEMENT                 = 123,
	IE_TYPE_MCCAOP_TEARDOWN                      = 124,
	IE_TYPE_GANN                                 = 125,
	IE_TYPE_RANN                                 = 126,
	IE_TYPE_EXTENDED_CAPABILITIES                = 127,
	/* Reserved 128 - 129 */
	IE_TYPE_PREQ                                 = 130,
	IE_TYPE_PREP                                 = 131,
	IE_TYPE_PERR                                 = 132,
	/* Reserved 133 - 136 */
	IE_TYPE_PXU                                  = 137,
	IE_TYPE_PXUC                                 = 138,
	IE_TYPE_AUTHENTICATED_MESH_PEERING_EXCHANGE  = 139,
	IE_TYPE_MIC                                  = 140,
	IE_TYPE_DESTINATION_URI                      = 141,
	IE_TYPE_U_APSD_COEXISTENCE                   = 142,
	IE_TYPE_DMG_WAKEUP_SCHEDULE                  = 143,
	IE_TYPE_EXTENDED_SCHEDULE                    = 144,
	IE_TYPE_STA_AVAILABILITY                     = 145,
	IE_TYPE_DMG_TSPEC                            = 146,
	IE_TYPE_NEXT_DMG_ATI                         = 147,
	IE_TYPE_DMG_CAPABILITIES                     = 148,
	/* Reserved 149 - 150 */
	IE_TYPE_DMG_OPERATION                        = 151,
	IE_TYPE_DMG_BSS_PARAMETER_CHANGE             = 152,
	IE_TYPE_DMG_BEAM_REFINEMENT                  = 153,
	IE_TYPE_CHANNEL_MEASUREMENT_FEEDBACK         = 154,
	/* Reserved 155 - 156 */
	IE_TYPE_AWAKE_WINDOW                         = 157,
	IE_TYPE_MULTIBAND                            = 158,
	IE_TYPE_ADDBA_EXTENSION                      = 159,
	IE_TYPE_NEXTPCP_LIST                         = 160,
	IE_TYPE_PCP_HANDOVER                         = 161,
	IE_TYPE_DMG_LINK_MARGIN                      = 162,
	IE_TYPE_SWITCHING_STREAM                     = 163,
	IE_TYPE_SESSION_TRANSITION                   = 164,
	IE_TYPE_DYNAMIC_TONE_PAIRING_REPORT          = 165,
	IE_TYPE_CLUSTER_REPORT                       = 166,
	IE_TYPE_RELAY_CAPABILITIES                   = 167,
	IE_TYPE_RELAY_TRANSFER_PARAMETER_SET         = 168,
	IE_TYPE_BEAMLINK_MAINTENANCE                 = 169,
	IE_TYPE_MULTIPLE_MAC_SUBLAYERS               = 170,
	IE_TYPE_UPID                                 = 171,
	IE_TYPE_DMG_LINK_ADAPTATION_ACKNOWLEDGEMENT  = 172,
	/* Reserved 173 */
	IE_TYPE_MCCAOP_ADVERTISEMENT_OVERVIEW        = 174,
	IE_TYPE_QUIET_PERIOD_REQUEST                 = 175,
	/* Reserved 176 */
	IE_TYPE_QUIET_PERIOD_RESPONSE                = 177,
	/* Reserved 178-180 */
	IE_TYPE_QMF_POLICY                           = 181,
	IE_TYPE_ECAPC_POLICY                         = 182,
	IE_TYPE_CLUSTER_TIME_OFFSET                  = 183,
	IE_TYPE_INTRAACCESS_CATEGORY_PRIORITY        = 184,
	IE_TYPE_SCS_DESCRIPTOR                       = 185,
	IE_TYPE_QLOAD_REPORT                         = 186,
	IE_TYPE_HCCA_TXOP_UPDATE_COUNT               = 187,
	IE_TYPE_HIGHER_LAYER_STREAM_ID               = 188,
	IE_TYPE_GCR_GROUP_ADDRESS                    = 189,
	IE_TYPE_ANTENNA_SECTOR_ID_PATTERN            = 190,
	IE_TYPE_VHT_CAPABILITIES                     = 191,
	IE_TYPE_VHT_OPERATION                        = 192,
	IE_TYPE_EXTENDED_BSS_LOAD                    = 193,
	IE_TYPE_WIDE_BANDWIDTH_CHANNEL_SWITCH        = 194,
	IE_TYPE_TRANSMIT_POWER_ENVELOPE              = 195,
	IE_TYPE_CHANNEL_SWITCH_WRAPPER               = 196,
	IE_TYPE_AID                                  = 197,
	IE_TYPE_QUIET_CHANNEL                        = 198,
	IE_TYPE_OPERATING_MODE_NOTIFICATION          = 199,
	IE_TYPE_UPSIM                                = 200,
	IE_TYPE_REDUCED_NEIGHBOR_REPORT              = 201,
	IE_TYPE_TVHT_OPERATION                       = 202,
	/* Reserved 203 */
	IE_TYPE_DEVICE_LOCATION                      = 204,
	IE_TYPE_WHITE_SPACE_MAP                      = 205,
	IE_TYPE_FINE_TIMING_MEASUREMENT_PARAMETERS   = 206,
	/* Reserved 207 - 220 */
	IE_TYPE_VENDOR_SPECIFIC                      = 221,
	/* Reserved 222 - 254 */
	IE_TYPE_EXTENSION                            = 255,

	/* Reserved extensions 0 - 8 */
	IE_TYPE_FTM_SYNCHRONIZATION_INFORMATION      = 256 + 9,
	IE_TYPE_EXTENDED_REQUEST                     = 256 + 10,
	IE_TYPE_ESTIMATED_SERVICE_PARAMETERS         = 256 + 11,
	IE_TYPE_FUTURE_CHANNEL_GUIDANCE              = 256 + 14,
	IE_TYPE_OWE_DH_PARAM                         = 256 + 32,
};

enum ie_rsn_cipher_suite {
	IE_RSN_CIPHER_SUITE_USE_GROUP_CIPHER	= 0x0001,
	IE_RSN_CIPHER_SUITE_WEP40		= 0x0002,
	IE_RSN_CIPHER_SUITE_TKIP		= 0x0004,
	IE_RSN_CIPHER_SUITE_CCMP		= 0x0008,
	IE_RSN_CIPHER_SUITE_WEP104		= 0x0010,
	IE_RSN_CIPHER_SUITE_BIP			= 0x0020,
	IE_RSN_CIPHER_SUITE_NO_GROUP_TRAFFIC	= 0x0040,
};

enum ie_rsn_akm_suite {
	IE_RSN_AKM_SUITE_8021X			= 0x0001,
	IE_RSN_AKM_SUITE_PSK			= 0x0002,
	IE_RSN_AKM_SUITE_FT_OVER_8021X		= 0x0004,
	IE_RSN_AKM_SUITE_FT_USING_PSK		= 0x0008,
	IE_RSN_AKM_SUITE_8021X_SHA256		= 0x0010,
	IE_RSN_AKM_SUITE_PSK_SHA256		= 0x0020,
	IE_RSN_AKM_SUITE_TDLS			= 0x0040,
	IE_RSN_AKM_SUITE_SAE_SHA256		= 0x0080,
	IE_RSN_AKM_SUITE_FT_OVER_SAE_SHA256	= 0x0100,
	IE_RSN_AKM_SUITE_AP_PEER_KEY_SHA256	= 0x0200,
	IE_RSN_AKM_SUITE_8021X_SUITE_B_SHA256	= 0x0400,
	IE_RSN_AKM_SUITE_8021X_SUITE_B_SHA384	= 0x0800,
	IE_RSN_AKM_SUITE_FT_OVER_8021X_SHA384	= 0x1000,
	IE_RSN_AKM_SUITE_OWE			= 0x2000,
};

#define IE_AKM_IS_SAE(akm) \
	((akm == IE_RSN_AKM_SUITE_SAE_SHA256) || \
	(akm == IE_RSN_AKM_SUITE_FT_OVER_SAE_SHA256))

struct ie_tlv_iter {
	unsigned int max;
	unsigned int pos;
	const unsigned char *tlv;
	unsigned int tag;
	unsigned int len;
	const unsigned char *data;
};

#define MAX_BUILDER_SIZE (8 * 1024)

struct ie_tlv_builder {
	unsigned char buf[MAX_BUILDER_SIZE];

	unsigned int max;
	unsigned int pos;
	unsigned char *tlv;
	struct ie_tlv_builder *parent;

	unsigned int tag;
	unsigned int len;
};

struct ie_rsn_info {
	enum ie_rsn_cipher_suite group_cipher;
	uint16_t pairwise_ciphers;
	uint16_t akm_suites;
	bool preauthentication:1;
	bool no_pairwise:1;
	uint8_t ptksa_replay_counter:2;
	uint8_t gtksa_replay_counter:2;
	bool mfpr:1;
	bool mfpc:1;
	bool peerkey_enabled:1;
	bool spp_a_msdu_capable:1;
	bool spp_a_msdu_required:1;
	bool pbac:1;
	bool extended_key_id:1;
	uint8_t num_pmkids;
	const uint8_t *pmkids;
	enum ie_rsn_cipher_suite group_management_cipher;
};

/* See chapter 8.4.1.4 for capability details */
enum ie_bss_capability {
	IE_BSS_CAP_ESS     = 0x0001,
	IE_BSS_CAP_IBSS    = 0x0002,
	IE_BSS_CAP_PRIVACY = 0x0010,
};

struct ie_ft_info {
	uint8_t mic_element_count;
	uint8_t mic[16];
	uint8_t anonce[32];
	uint8_t snonce[32];
	uint8_t r0khid[48];
	size_t r0khid_len;
	uint8_t r1khid[6];
	bool r1khid_present:1;
	uint8_t gtk_key_id;
	uint8_t gtk_len;
	uint8_t gtk_rsc[8];
	uint8_t gtk[40];
	uint16_t igtk_key_id;
	uint8_t igtk_ipn[6];
	uint8_t igtk_len;
	uint8_t igtk[24];
};

/* See chapter 8.4.2.47 for radio measurement capability details */
enum ie_rm_capability {
	IE_RM_CAP_NEIGHBOR_REPORT = 0x0002,
};

struct ie_neighbor_report_info {
	uint8_t addr[6];
	uint8_t reachable;
	bool spectrum_mgmt : 1;
	bool qos : 1;
	bool apsd : 1;
	bool rm : 1;
	bool delayed_block_ack : 1;
	bool immediate_block_ack : 1;
	bool security : 1;
	bool key_scope : 1;
	bool md : 1;
	bool ht : 1;
	uint8_t oper_class;
	uint8_t channel_num;
	uint8_t phy_type;
	uint8_t bss_transition_pref;
	bool bss_transition_pref_present : 1;
};

void ie_tlv_iter_init(struct ie_tlv_iter *iter, const unsigned char *tlv,
			unsigned int len);
void ie_tlv_iter_recurse(struct ie_tlv_iter *iter,
			struct ie_tlv_iter *recurse);
bool ie_tlv_iter_next(struct ie_tlv_iter *iter);

static inline unsigned int ie_tlv_iter_get_tag(struct ie_tlv_iter *iter)
{
	return iter->tag;
}

static inline unsigned int ie_tlv_iter_get_length(struct ie_tlv_iter *iter)
{
	return iter->len;
}

static inline const unsigned char *ie_tlv_iter_get_data(
						struct ie_tlv_iter *iter)
{
	return iter->data;
}

void *ie_tlv_extract_wsc_payload(const uint8_t *ies, size_t len,
							ssize_t *out_len);
void *ie_tlv_encapsulate_wsc_payload(const uint8_t *data, size_t len,
							size_t *out_len);

bool ie_tlv_builder_init(struct ie_tlv_builder *builder);
bool ie_tlv_builder_set_length(struct ie_tlv_builder *builder,
			unsigned int new_len);
bool ie_tlv_builder_next(struct ie_tlv_builder *builder, unsigned int new_tag);
unsigned char *ie_tlv_builder_get_data(struct ie_tlv_builder *builder);
bool ie_tlv_builder_recurse(struct ie_tlv_builder *builder,
			struct ie_tlv_builder *recurse);
void ie_tlv_builder_finalize(struct ie_tlv_builder *builder,
			unsigned int *out_len);

uint32_t ie_rsn_cipher_suite_to_cipher(enum ie_rsn_cipher_suite suite);

int ie_parse_rsne(struct ie_tlv_iter *iter, struct ie_rsn_info *info);
int ie_parse_rsne_from_data(const uint8_t *data, size_t len,
				struct ie_rsn_info *info);
bool ie_build_rsne(const struct ie_rsn_info *info, uint8_t *to);

int ie_parse_wpa(struct ie_tlv_iter *iter, struct ie_rsn_info *out_info);
int ie_parse_wpa_from_data(const uint8_t *data, size_t len,
						struct ie_rsn_info *info);
bool is_ie_wpa_ie(const uint8_t *data, uint8_t len);
bool ie_build_wpa(const struct ie_rsn_info *info, uint8_t *to);

int ie_parse_bss_load(struct ie_tlv_iter *iter, uint16_t *out_sta_count,
			uint8_t *out_channel_utilization,
			uint16_t *out_admission_capacity);
int ie_parse_bss_load_from_data(const uint8_t *data, uint8_t len,
				uint16_t *out_sta_count,
				uint8_t *out_channel_utilization,
				uint16_t *out_admission_capacity);

int ie_parse_supported_rates(struct ie_tlv_iter *iter,
				struct l_uintset **set);
int ie_parse_supported_rates_from_data(const uint8_t *data, uint8_t len,
				struct l_uintset **set);

int ie_parse_mobility_domain(struct ie_tlv_iter *iter, uint16_t *mdid,
				bool *ft_over_ds, bool *resource_req);
int ie_parse_mobility_domain_from_data(const uint8_t *data, uint8_t len,
				uint16_t *mdid,
				bool *ft_over_ds, bool *resource_req);
bool ie_build_mobility_domain(uint16_t mdid, bool ft_over_ds,
				bool resource_req, uint8_t *to);

int ie_parse_fast_bss_transition(struct ie_tlv_iter *iter,
				struct ie_ft_info *info);
int ie_parse_fast_bss_transition_from_data(const uint8_t *data, uint8_t len,
				struct ie_ft_info *info);
bool ie_build_fast_bss_transition(const struct ie_ft_info *info, uint8_t *to);

int ie_parse_neighbor_report(struct ie_tlv_iter *iter,
				struct ie_neighbor_report_info *info);