/usr/include/tins/dot11/dot11_mgmt.h is in libtins-dev 1.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 | /*
* Copyright (c) 2012, Matias Fontanini
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#ifndef TINS_DOT11_DOT11_MGMT_H
#define TINS_DOT11_DOT11_MGMT_H
#include <vector>
#include <utility>
#include "../dot11/dot11_base.h"
namespace Tins {
/**
* \brief Abstract class that englobes all Management frames in the 802.11 protocol.
*/
class Dot11ManagementFrame : public Dot11 {
public:
/**
* The supported rates container type.
*/
typedef std::vector<float> rates_type;
/**
* The supported channels container type.
*/
typedef std::vector<std::pair<uint8_t, uint8_t> > channels_type;
/**
* The requested information container type.
*/
typedef std::vector<uint8_t> request_info_type;
/**
* This PDU's flag.
*/
static const PDU::PDUType pdu_flag = PDU::DOT11_MANAGEMENT;
enum ReasonCodes {
UNSPECIFIED = 1,
PREV_AUTH_NOT_VALID = 2,
STA_LEAVING_IBSS_ESS = 3,
INACTIVITY = 4,
CANT_HANDLE_STA = 5,
CLASS2_FROM_NO_AUTH = 6,
CLASS3_FROM_NO_AUTH = 7,
STA_LEAVING_BSS = 8,
STA_NOT_AUTH_WITH_STA = 9,
POW_CAP_NOT_VALID = 10,
SUPPORTED_CHANN_NOT_VALID = 11,
INVALID_CONTENT = 13,
MIC_FAIL = 14,
HANDSHAKE_TIMEOUT = 15,
GROUP_KEY_TIMEOUT = 16,
WRONG_HANDSHAKE = 17,
INVALID_GROUP_CIPHER = 18,
INVALID_PAIRWISE_CIPHER = 19,
INVALID_AKMP = 20,
UNSOPPORTED_RSN_VERSION = 21,
INVALID_RSN_CAPABILITIES = 22,
AUTH_FAILED = 23,
CIPHER_SUITE_REJECTED = 24,
UNSPECIFIED_QOS_REASON = 32,
NOT_ENOUGH_BANDWITH = 33,
POOR_CHANNEL = 34,
STA_OUT_OF_LIMITS = 35,
REQUESTED_BY_STA_LEAVING = 36,
REQUESTED_BY_STA_REJECT_MECHANISM = 37,
REQUESTED_BY_STA_REJECT_SETUP = 38,
REQUESTED_BY_STA_TIMEOUT = 39,
PEER_STA_NOT_SUPPORT_CIPHER = 45
};
/**
* Represents the IEEE 802.11 frames' capability information.
*/
TINS_BEGIN_PACK
class capability_information {
private:
#if TINS_IS_LITTLE_ENDIAN
uint16_t _ess:1,
_ibss:1,
_cf_poll:1,
_cf_poll_req:1,
_privacy:1,
_short_preamble:1,
_pbcc:1,
_channel_agility:1,
_spectrum_mgmt:1,
_qos:1,
_sst:1,
_apsd:1,
_reserved:1,
_dsss_ofdm:1,
_delayed_block_ack:1,
_immediate_block_ack:1;
#elif TINS_IS_BIG_ENDIAN
uint16_t _channel_agility:1,
_pbcc:1,
_short_preamble:1,
_privacy:1,
_cf_poll_req:1,
_cf_poll:1,
_ibss:1,
_ess:1,
_immediate_block_ack:1,
_delayed_block_ack:1,
_dsss_ofdm:1,
_reserved:1,
_apsd:1,
_sst:1,
_qos:1,
_spectrum_mgmt:1;
#endif
public:
/**
* \brief Getter for the ess flag.
*
* \return Bool indicating the flag's value.
*/
bool ess() const { return _ess; }
/**
* \brief Getter for the ibss flag.
*
* \return Bool indicating the flag's value.
*/
bool ibss() const { return _ibss; }
/**
* \brief Getter for the cf_poll flag.
*
* \return Bool indicating the flag's value.
*/
bool cf_poll() const { return _cf_poll; }
/**
* \brief Getter for the cf_poll_req flag.
*
* \return Bool indicating the flag's value.
*/
bool cf_poll_req() const { return _cf_poll_req; }
/**
* \brief Getter for the privacy flag.
*
* \return Bool indicating the flag's value.
*/
bool privacy() const { return _privacy; }
/**
* \brief Getter for the short_preamble flag.
*
* \return Bool indicating the flag's value.
*/
bool short_preamble() const { return _short_preamble; }
/**
* \brief Getter for the pbcc flag.
*
* \return Bool indicating the flag's value.
*/
bool pbcc() const { return _pbcc; }
/**
* \brief Getter for the channel_agility flag.
*
* \return Bool indicating the flag's value.
*/
bool channel_agility() const { return _channel_agility; }
/**
* \brief Getter for the spectrum_mgmt flag.
*
* \return Bool indicating the flag's value.
*/
bool spectrum_mgmt() const { return _spectrum_mgmt; }
/**
* \brief Getter for the qos flag.
*
* \return Bool indicating the flag's value.
*/
bool qos() const { return _qos; }
/**
* \brief Getter for the sst flag.
*
* \return Bool indicating the flag's value.
*/
bool sst() const { return _sst; }
/**
* \brief Getter for the apsd flag.
*
* \return Bool indicating the flag's value.
*/
bool apsd() const { return _apsd; }
/**
* \brief Getter for the reserved flag.
*
* \return Bool indicating the flag's value.
*/
bool reserved() const { return _reserved; }
/**
* \brief Getter for the dsss_ofdm flag.
*
* \return Bool indicating the flag's value.
*/
bool dsss_ofdm() const { return _dsss_ofdm; }
/**
* \brief Getter for the delayed_block_ack flag.
*
* \return Bool indicating the flag's value.
*/
bool delayed_block_ack() const { return _delayed_block_ack; }
/**
* \brief Getter for the immediate_block_ack flag.
*
* \return Bool indicating the flag's value.
*/
bool immediate_block_ack() const { return _immediate_block_ack; }
/**
* \brief Setter for the ess flag.
*
* \param new_value bool indicating the flag's new value.
*/
void ess(bool new_value) { _ess = new_value; }
/**
* \brief Setter for the ibss flag.
*
* \param new_value bool indicating the flag's new value.
*/
void ibss(bool new_value) { _ibss = new_value; }
/**
* \brief Setter for the cf_poll flag.
*
* \param new_value bool indicating the flag's new value.
*/
void cf_poll(bool new_value) { _cf_poll = new_value; }
/**
* \brief Setter for the cf_poll_req flag.
*
* \param new_value bool indicating the flag's new value.
*/
void cf_poll_req(bool new_value) { _cf_poll_req = new_value; }
/**
* \brief Setter for the privacy flag.
*
* \param new_value bool indicating the flag's new value.
*/
void privacy(bool new_value) { _privacy = new_value; }
/**
* \brief Setter for the short_preamble flag.
*
* \param new_value bool indicating the flag's new value.
*/
void short_preamble(bool new_value) { _short_preamble = new_value; }
/**
* \brief Setter for the pbcc flag.
*
* \param new_value bool indicating the flag's new value.
*/
void pbcc(bool new_value) { _pbcc = new_value; }
/**
* \brief Setter for the channel_agility flag.
*
* \param new_value bool indicating the flag's new value.
*/
void channel_agility(bool new_value) { _channel_agility = new_value; }
/**
* \brief Setter for the spectrum_mgmt flag.
*
* \param new_value bool indicating the flag's new value.
*/
void spectrum_mgmt(bool new_value) { _spectrum_mgmt = new_value; }
/**
* \brief Setter for the qos flag.
*
* \param new_value bool indicating the flag's new value.
*/
void qos(bool new_value) { _qos = new_value; }
/**
* \brief Setter for the sst flag.
*
* \param new_value bool indicating the flag's new value.
*/
void sst(bool new_value) { _sst = new_value; }
/**
* \brief Setter for the apsd flag.
*
* \param new_value bool indicating the flag's new value.
*/
void apsd(bool new_value) { _apsd = new_value; }
/**
* \brief Setter for the reserved flag.
*
* \param new_value bool indicating the flag's new value.
*/
void reserved(bool new_value) { _reserved = new_value; }
/**
* \brief Setter for the dsss_ofdm flag.
*
* \param new_value bool indicating the flag's new value.
*/
void dsss_ofdm(bool new_value) { _dsss_ofdm = new_value; }
/**
* \brief Setter for the delayed_block_ack flag.
*
* \param new_value bool indicating the flag's new value.
*/
void delayed_block_ack(bool new_value) { _delayed_block_ack = new_value; }
/**
* \brief Setter for the immediate_block_ack flag.
*
* \param new_value bool indicating the flag's new value.
*/
void immediate_block_ack(bool new_value) { _immediate_block_ack = new_value; }
} TINS_END_PACK;
TINS_BEGIN_PACK
struct fh_params_set {
uint16_t dwell_time;
uint8_t hop_set, hop_pattern, hop_index;
fh_params_set() {}
fh_params_set(uint16_t dwell_time, uint8_t hop_set,
uint8_t hop_pattern, uint8_t hop_index)
: dwell_time(dwell_time), hop_set(hop_set),
hop_pattern(hop_pattern), hop_index(hop_index) {}
} TINS_END_PACK;
TINS_BEGIN_PACK
struct cf_params_set {
uint8_t cfp_count, cfp_period;
uint16_t cfp_max_duration, cfp_dur_remaining;
cf_params_set() {}
cf_params_set(uint8_t cfp_count, uint8_t cfp_period,
uint16_t cfp_max_duration, uint16_t cfp_dur_remaining)
: cfp_count(cfp_count), cfp_period(cfp_period),
cfp_max_duration(cfp_max_duration),
cfp_dur_remaining(cfp_dur_remaining) {}
} TINS_END_PACK;
struct ibss_dfs_params {
static const size_t minimum_size = address_type::address_size + sizeof(uint8_t) + 2 * sizeof(uint8_t);
address_type dfs_owner;
uint8_t recovery_interval;
channels_type channel_map;
ibss_dfs_params() {}
ibss_dfs_params(const address_type &addr,
uint8_t recovery_interval, const channels_type &channels)
: dfs_owner(addr), recovery_interval(recovery_interval),
channel_map(channels) {}
};
struct country_params {
typedef std::vector<uint8_t> container_type;
// String identifier: 3 bytes
static const size_t minimum_size = 3 + sizeof(uint8_t) * 3;
std::string country;
container_type first_channel, number_channels, max_transmit_power;
country_params() {}
country_params(const std::string &country, const container_type &first,
const container_type &number, const container_type &max)
: country(country), first_channel(first), number_channels(number),
max_transmit_power(max) {}
};
struct fh_pattern_type {
typedef std::vector<uint8_t> container_type;
static const size_t minimum_size = sizeof(uint8_t) * 4;
uint8_t flag, number_of_sets, modulus, offset;
container_type random_table;
fh_pattern_type() {}
fh_pattern_type(uint8_t flag, uint8_t sets, uint8_t modulus,
uint8_t offset, const container_type& table)
: flag(flag), number_of_sets(sets), modulus(modulus),
offset(offset), random_table(table) {}
};
struct channel_switch_type {
uint8_t switch_mode, new_channel, switch_count;
channel_switch_type() {}
channel_switch_type(uint8_t mode, uint8_t channel, uint8_t count)
: switch_mode(mode), new_channel(channel), switch_count(count) { }
};
struct quiet_type {
uint8_t quiet_count, quiet_period;
uint16_t quiet_duration, quiet_offset;
quiet_type() {}
quiet_type(uint8_t count, uint8_t period, uint16_t duration,
uint16_t offset)
: quiet_count(count), quiet_period(period),
quiet_duration(duration), quiet_offset(offset) {}
};
struct bss_load_type {
uint16_t station_count;
uint16_t available_capacity;
uint8_t channel_utilization;
bss_load_type() {}
bss_load_type(uint16_t count, uint8_t utilization,
uint16_t capacity)
: station_count(count), available_capacity(capacity),
channel_utilization(utilization) {}
};
struct tim_type {
typedef std::vector<uint8_t> container_type;
uint8_t dtim_count, dtim_period, bitmap_control;
container_type partial_virtual_bitmap;
tim_type() {}
tim_type(uint8_t count, uint8_t period, uint8_t control,
const container_type &bitmap)
: dtim_count(count), dtim_period(period), bitmap_control(control),
partial_virtual_bitmap(bitmap) {}
};
/**
* \brief Getter for the second address.
*
* \return address_type containing the second address.
*/
address_type addr2() const { return _ext_header.addr2; }
/**
* \brief Getter for the third address.
*
* \return address_type containing the third address.
*/
address_type addr3() const { return _ext_header.addr3; }
/**
* \brief Getter for the fragment number.
*
* \return The stored fragment number.
*/
small_uint<4> frag_num() const {
#if TINS_IS_LITTLE_ENDIAN
return _ext_header.frag_seq & 0xf;
#else
return (_ext_header.frag_seq >> 8) & 0xf;
#endif
}
/**
* \brief Getter for the sequence number field.
*
* \return The stored sequence number.
*/
small_uint<12> seq_num() const {
#if TINS_IS_LITTLE_ENDIAN
return (_ext_header.frag_seq >> 4) & 0xfff;
#else
return (Endian::le_to_host<uint16_t>(_ext_header.frag_seq) >> 4) & 0xfff;
#endif
}
/**
* \brief Getter for the fourth address.
*
* \return address_type containing the fourth address.
*/
const address_type &addr4() const { return _addr4; }
/**
* \brief Setter for the second address.
*
* \param new_addr2 The new second address to be set.
*/
void addr2(const address_type &new_addr2);
/**
* \brief Setter for the third address.
*
* \param new_addr3 The new third address to be set.
*/
void addr3(const address_type &new_addr3);
/**
* \brief Setter for the fragment number.
*
* \param new_frag_num The new fragment number.
*/
void frag_num(small_uint<4> new_frag_num);
/**
* \brief Setter for the sequence number.
*
* \param new_seq_num The new sequence number.
*/
void seq_num(small_uint<12> new_seq_num);
/**
* \brief Setter for the fourth address.
*
* \param new_addr4 The new fourth address to be set.
*/
void addr4(const address_type &new_addr4);
// Option setter helpers
/**
* \brief Helper method to set the ssid.
*
* \param new_ssid The ssid to be set.
*/
void ssid(const std::string &new_ssid);
/**
* \brief Helper method to set the RSN information option.
*
* \param info The RSNInformation structure to be set.
*/
void rsn_information(const RSNInformation& info);
/**
* \brief Helper method to set the supported rates.
*
* \param new_rates The new rates to be set.
*/
void supported_rates(const rates_type &new_rates);
/**
* \brief Helper method to set the extended supported rates.
*
* \param new_rates The new rates to be set.
*/
void extended_supported_rates(const rates_type &new_rates);
/**
* \brief Helper method to set the QoS capabilities.
*
* \param new_qos_capabilities uint8_t with the capabilities.
*/
void qos_capability(uint8_t new_qos_capability);
/**
* \brief Helper method to set the power capabilities.
*
* \param min_power uint8_t indicating the minimum transmiting power capability.
* \param max_power uint8_t indicating the maximum transmiting power capability.
*/
void power_capability(uint8_t min_power, uint8_t max_power);
/**
* \brief Helper method to set the supported channels.
*
* \param new_channels A list of channels to be set.
*/
void supported_channels(const channels_type &new_channels);
/**
* \brief Helper method to set the EDCA Parameter Set.
*
* \param ac_be uint32_t with the value of the ac_be field.
* \param ac_bk uint32_t with the value of the ac_bk field.
* \param ac_vi uint32_t with the value of the ac_vi field.
* \param ac_vo uint32_t with the value of the ac_vo field.
*/
void edca_parameter_set(uint32_t ac_be, uint32_t ac_bk, uint32_t ac_vi, uint32_t ac_vo);
/**
* \brief Helper method to set the Request Information element.
*
* \param elements A list of elements.
*/
void request_information(const request_info_type elements);
/**
* \brief Helper method to set the FH parameter.
*
* \param fh_params the fh parameter set.
*/
void fh_parameter_set(fh_params_set fh_params);
/**
* \brief Helper method to set the DS parameter.
*
* \param current_channel uint8_t with the value of the current_channel field.
*/
void ds_parameter_set(uint8_t current_channel);
/**
* \brief Helper method to set the CF parameter.
*
* \param params the CF parammeters to be set.
*/
void cf_parameter_set(cf_params_set params);
/**
* \brief Helper method to set the IBSS parameter.
*
* \param atim_window uint16_t with the value of the ATIM window field.
*/
void ibss_parameter_set(uint16_t atim_window);
/**
* \brief Helper method to set the IBSS DFS tagged option.
*
* \param params The IBSS DFS data to be set.
*/
void ibss_dfs(const ibss_dfs_params ¶ms);
/**
* \brief Helper method to set the country tagged option.
*
* \param params The data to be used for this country option.
*/
void country(const country_params ¶ms);
/**
* \brief Helper method to set the FH parameters.
*
* \param prime_radix uint8_t with the value of the prime radix field.
* \param number_channels uint8_t with the value of the number channels field.
*/
void fh_parameters(uint8_t prime_radix, uint8_t number_channels);
/**
* \brief Helper method to set the FH pattern table.
*
* \param params The data to be used for this fh_pattern_table option.
*/
void fh_pattern_table(const fh_pattern_type ¶ms);
/**
* \brief Helper method to set the Power Constraint tagged option.
*
* \param local_power_constraint The value of the local power constraint field.
*/
void power_constraint(uint8_t local_power_constraint);
/**
* \brief Helper method to set the Channel Switch tagged option.
*
* \param data The value of the Channel Switch option.
*/
void channel_switch(const channel_switch_type &data);
/**
* \brief Helper method to set the Quiet tagged option.
*
* \param data The value of the quiet count field.
*/
void quiet(const quiet_type &data);
/**
* \brief Helper method to set the TPC Report tagged option.
*
* \param transmit_power uint8_t with the value of the transmit power field.
* \param link_margin uint8_t with the value of the link margin field.
*/
void tpc_report(uint8_t transmit_power, uint8_t link_margin);
/**
* \brief Helper method to set the ERP Information tagged option.
*
* \param value The value to set in this erp information option.
*/
void erp_information(uint8_t value);
/**
* \brief Helper method to set the BSS Load tagged option.
*
* \param data The value to set in this bss load option.
*/
void bss_load(const bss_load_type &data);
/**
* \brief Helper method to set the TIM tagged option.
*
* \brief data The value to set in this tim option.
*/
void tim(const tim_type &data);
/**
* \brief Helper method to set the Challenge Text tagged option.
*
* \brief text The challenge text to be added.
*/
void challenge_text(const std::string &text);
// Option searching helpers
/**
* \brief Helper method to search for this PDU's rsn information
* option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return std::string containing the ssid.
*/
RSNInformation rsn_information();
/**
* \brief Helper method to search for this PDU's ssid.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return std::string containing the ssid.
*/
std::string ssid() const;
/**
* \brief Helper method to get the supported rates.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return rates_type containing the supported rates.
*/
rates_type supported_rates() const;
/**
* \brief Helper method to get the extended supported rates.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return rates_type containing the extended supported rates.
*/
rates_type extended_supported_rates() const;
/**
* \brief Helper method to get the QOS capability.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return uint8_t containing the QOS capability.
*/
uint8_t qos_capability() const;
/**
* \brief Helper method to get the power capability.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return std::pair<uint8_t, uint8_t> containing the power capability.
*/
std::pair<uint8_t, uint8_t> power_capability() const;
/**
* \brief Helper method to get the supported channels.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return channels_type containing the power capability.
*/
channels_type supported_channels() const;
/**
* \brief Helper method to get the request information.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return request_info_type containing the request information.
*/
request_info_type request_information() const;
/**
* \brief Helper method to get the fh parameter set.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return fh_params_set containing the fh parameter set.
*/
fh_params_set fh_parameter_set() const;
/**
* \brief Helper method to get the ds parameter set.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return uint8_t containing the ds parameter set.
*/
uint8_t ds_parameter_set() const;
/**
* \brief Helper method to get the ibss parameter set.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return uint16_t containing the ibss parameter set.
*/
uint16_t ibss_parameter_set() const;
/**
* \brief Helper method to get the ibss dfs.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return ibss_dfs_params containing the ibss dfs.
*/
ibss_dfs_params ibss_dfs() const;
/**
* \brief Helper method to get the country option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return country_params containing the country attributes.
*/
country_params country() const;
/**
* \brief Helper method to get the fh parameters option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return std::pair<uint8_t, uint8_t> containing the fh parameters.
*/
std::pair<uint8_t, uint8_t> fh_parameters() const;
/**
* \brief Helper method to get the fh patterns option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return fh_pattern_type containing the fh patterns.
*/
fh_pattern_type fh_pattern_table() const;
/**
* \brief Helper method to get the power constraint option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return uint8_t containing the power constraint.
*/
uint8_t power_constraint() const;
/**
* \brief Helper method to get the channel switch option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return channel_switch_type containing the channel switch.
*/
channel_switch_type channel_switch() const;
/**
* \brief Helper method to get the quiet option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return quiet_type containing the quiet option value.
*/
quiet_type quiet() const;
/**
* \brief Helper method to get the tpc report option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return quiet_type containing the tpc report option value.
*/
std::pair<uint8_t, uint8_t> tpc_report() const;
/**
* \brief Helper method to get the erp information option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return quiet_type containing the erp information option value.
*/
uint8_t erp_information() const;
/**
* \brief Helper method to get the bss load option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return quiet_type containing the bss load option value.
*/
bss_load_type bss_load() const;
/**
* \brief Helper method to get the tim option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return tim_type containing the tim option value.
*/
tim_type tim() const;
/**
* \brief Helper method to get the challenge text option.
*
* An option_not_found exception is thrown if the option has not
* been set.
*
* \return std::string containing the challenge text option value.
*/
std::string challenge_text() const;
// ************************
/**
* \brief Returns the 802.11 frame's header length.
*
* \return An uint32_t with the header's size.
* \sa PDU::header_size()
*/
uint32_t header_size() const;
/**
* \brief Getter for the PDU's type.
*
* \sa PDU::pdu_type
*/
PDUType pdu_type() const { return pdu_flag; }
/**
* \brief Check wether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
bool matches_flag(PDUType flag) const {
return flag == pdu_flag || Dot11::matches_flag(flag);
}
protected:
TINS_BEGIN_PACK
struct ExtendedHeader {
uint8_t addr2[address_type::address_size];
uint8_t addr3[address_type::address_size];
uint16_t frag_seq;
} TINS_END_PACK;
Dot11ManagementFrame(const address_type &dst_hw_addr = address_type(),
const address_type &src_hw_addr = address_type());
/**
* \brief Constructs a Dot11ManagementFrame object from a buffer
* and adds all identifiable PDUs found in the buffer as children
* of this one.
*
* If the next PDU is not recognized, then a RawPDU is used.
*
* If there is not enough size for the header in the buffer
* or the input data is malformed, a malformed_packet exception
* is thrown.
*
* \param buffer The buffer from which this PDU will be constructed.
* \param total_sz The total size of the buffer.
*/
Dot11ManagementFrame(const uint8_t *buffer, uint32_t total_sz);
uint32_t write_ext_header(uint8_t *buffer, uint32_t total_sz);
uint32_t management_frame_size() {
return sizeof(ieee80211_header) + sizeof(_ext_header) +
((from_ds() && to_ds()) ? address_type::address_size : 0);
}
private:
static uint8_t *serialize_rates(const rates_type &rates);
static rates_type deserialize_rates(const option *option);
ExtendedHeader _ext_header;
address_type _addr4;
};
} // namespace Tins
#endif // TINS_DOT11_DOT11_MGMT_H
|