:orphan:

.. index:: pair: group; Wi-Fi security
.. _doxid-group__tapi__wifi__security:

Wi-Fi security
==============

.. toctree::
	:hidden:

	enum_tapi_wifi_cipher.rst
	enum_tapi_wifi_key_mgmt.rst
	enum_tapi_wifi_pmf.rst
	enum_tapi_wifi_policy.rst

Overview
~~~~~~~~

Common Wi-Fi security definitions

Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...<details-group__tapi__wifi__security>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// typedefs

	typedef enum :ref:`tapi_wifi_policy<doxid-group__tapi__wifi__security_1ga39d9cd2f1710de98d09009f7882448dc>` :ref:`tapi_wifi_policy<doxid-group__tapi__wifi__security_1gadb687ee07778f8d15e09d3f98cb374bb>`;
	typedef enum :ref:`tapi_wifi_cipher<doxid-group__tapi__wifi__security_1gae9d9a8aabc79419808d57d6e02c4362b>` :ref:`tapi_wifi_cipher<doxid-group__tapi__wifi__security_1ga204486b7039172897bc9f84215e0fdbb>`;
	typedef enum :ref:`tapi_wifi_key_mgmt<doxid-group__tapi__wifi__security_1ga34690954d12acd025543eb35d081a7d4>` :ref:`tapi_wifi_key_mgmt<doxid-group__tapi__wifi__security_1ga97a6580a4aa1748cf3cb4a386f265dac>`;
	typedef enum :ref:`tapi_wifi_pmf<doxid-group__tapi__wifi__security_1gaf76a8a5e79a2b7c51e72e0c9e54cdc68>` :ref:`tapi_wifi_pmf<doxid-group__tapi__wifi__security_1gab3f38168c841590b7eec720e17f15f9c>`;

	// enums

	enum :ref:`tapi_wifi_cipher<doxid-group__tapi__wifi__security_1gae9d9a8aabc79419808d57d6e02c4362b>`;
	enum :ref:`tapi_wifi_key_mgmt<doxid-group__tapi__wifi__security_1ga34690954d12acd025543eb35d081a7d4>`;
	enum :ref:`tapi_wifi_pmf<doxid-group__tapi__wifi__security_1gaf76a8a5e79a2b7c51e72e0c9e54cdc68>`;
	enum :ref:`tapi_wifi_policy<doxid-group__tapi__wifi__security_1ga39d9cd2f1710de98d09009f7882448dc>`;

	// macros

	#define :ref:`TAPI_WIFI_CIPHER_MAPPING_LIST<doxid-group__tapi__wifi__security_1ga45f838f1c06479006b868814cee474d5>`
	#define :ref:`TAPI_WIFI_POLICY_MAPPING_LIST<doxid-group__tapi__wifi__security_1ga7fc2b8cf97b87862127b9f4fadaf850f>`
	#define :ref:`TEST_GET_WIFI_CIPHER_PARAM<doxid-group__tapi__wifi__security_1ga7d81914e1a0e33d5a2d484783618b142>`(var_name_)
	#define :ref:`TEST_GET_WIFI_POLICY_PARAM<doxid-group__tapi__wifi__security_1ga44f0516c553c31e07d18fbed733089c2>`(var_name_)
	#define :ref:`TEST_WIFI_CIPHER_PARAM<doxid-group__tapi__wifi__security_1ga464dcee5298a109b03a25ded0fe401ec>`(var_name_)
	#define :ref:`TEST_WIFI_POLICY_PARAM<doxid-group__tapi__wifi__security_1gaba4e1a45fc025cc285a02cdd4e8d6dc6>`(var_name_)

.. _details-group__tapi__wifi__security:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Common Wi-Fi security definitions

Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved.

Typedefs
--------

.. index:: pair: typedef; tapi_wifi_policy
.. _doxid-group__tapi__wifi__security_1gadb687ee07778f8d15e09d3f98cb374bb:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef enum :ref:`tapi_wifi_policy<doxid-group__tapi__wifi__security_1ga39d9cd2f1710de98d09009f7882448dc>` tapi_wifi_policy

Supported Wi-Fi security protocols.

.. index:: pair: typedef; tapi_wifi_cipher
.. _doxid-group__tapi__wifi__security_1ga204486b7039172897bc9f84215e0fdbb:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef enum :ref:`tapi_wifi_cipher<doxid-group__tapi__wifi__security_1gae9d9a8aabc79419808d57d6e02c4362b>` tapi_wifi_cipher

Supported Wi-Fi encryption protocols.

.. index:: pair: typedef; tapi_wifi_key_mgmt
.. _doxid-group__tapi__wifi__security_1ga97a6580a4aa1748cf3cb4a386f265dac:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef enum :ref:`tapi_wifi_key_mgmt<doxid-group__tapi__wifi__security_1ga34690954d12acd025543eb35d081a7d4>` tapi_wifi_key_mgmt

Supported Wi-Fi authenticated key management protocols.

.. index:: pair: typedef; tapi_wifi_pmf
.. _doxid-group__tapi__wifi__security_1gab3f38168c841590b7eec720e17f15f9c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef enum :ref:`tapi_wifi_pmf<doxid-group__tapi__wifi__security_1gaf76a8a5e79a2b7c51e72e0c9e54cdc68>` tapi_wifi_pmf

Supported Wi-Fi Protected Management Frames (PMF).

Macros
------

.. index:: pair: define; TAPI_WIFI_CIPHER_MAPPING_LIST
.. _doxid-group__tapi__wifi__security_1ga45f838f1c06479006b868814cee474d5:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TAPI_WIFI_CIPHER_MAPPING_LIST

The list of values allowed for parameter of type :ref:`tapi_wifi_cipher <doxid-group__tapi__wifi__security_1ga204486b7039172897bc9f84215e0fdbb>`.

.. index:: pair: define; TAPI_WIFI_POLICY_MAPPING_LIST
.. _doxid-group__tapi__wifi__security_1ga7fc2b8cf97b87862127b9f4fadaf850f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TAPI_WIFI_POLICY_MAPPING_LIST

The list of values allowed for parameter of type :ref:`tapi_wifi_policy <doxid-group__tapi__wifi__security_1gadb687ee07778f8d15e09d3f98cb374bb>`.

.. index:: pair: define; TEST_GET_WIFI_CIPHER_PARAM
.. _doxid-group__tapi__wifi__security_1ga7d81914e1a0e33d5a2d484783618b142:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_GET_WIFI_CIPHER_PARAM(var_name_)

Get the value of parameter of type :ref:`tapi_wifi_cipher <doxid-group__tapi__wifi__security_1ga204486b7039172897bc9f84215e0fdbb>`.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- var_name\_

		- Name of the variable is used to get the value of "var_name\_" parameter.

.. index:: pair: define; TEST_GET_WIFI_POLICY_PARAM
.. _doxid-group__tapi__wifi__security_1ga44f0516c553c31e07d18fbed733089c2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_GET_WIFI_POLICY_PARAM(var_name_)

Get the value of parameter of type :ref:`tapi_wifi_policy <doxid-group__tapi__wifi__security_1gadb687ee07778f8d15e09d3f98cb374bb>`.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- var_name\_

		- Name of the variable is used to get the value of "var_name\_" parameter.

.. index:: pair: define; TEST_WIFI_CIPHER_PARAM
.. _doxid-group__tapi__wifi__security_1ga464dcee5298a109b03a25ded0fe401ec:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_WIFI_CIPHER_PARAM(var_name_)

Return the value of parameter of type :ref:`tapi_wifi_cipher <doxid-group__tapi__wifi__security_1ga204486b7039172897bc9f84215e0fdbb>`.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- var_name\_

		- Name of the variable is used to get the value of "var_name\_" parameter (OUT).

.. index:: pair: define; TEST_WIFI_POLICY_PARAM
.. _doxid-group__tapi__wifi__security_1gaba4e1a45fc025cc285a02cdd4e8d6dc6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TEST_WIFI_POLICY_PARAM(var_name_)

Return the value of parameter of type :ref:`tapi_wifi_policy <doxid-group__tapi__wifi__security_1gadb687ee07778f8d15e09d3f98cb374bb>`.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- var_name\_

		- Name of the variable is used to get the value of "var_name\_" parameter.