radiotap.h

/*
 * Copyright (c) 2017, 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.
 *
 */

#include <tins/config.h>

#if !defined(TINS_RADIOTAP_H) && defined(TINS_HAVE_DOT11)
#define TINS_RADIOTAP_H

#include <tins/macros.h>
#include <tins/pdu.h>
#include <tins/endianness.h>
#include <tins/pdu_option.h>

namespace Tins {
class PacketSender;

class TINS_API RadioTap : public PDU {
public:
    static const PDU::PDUType pdu_flag = PDU::RADIOTAP;

    static const endian_type endianness = LE;

    enum ChannelType {
        TURBO   = 0x10,
        CCK     = 0x20,
        OFDM    = 0x40,
        TWO_GZ  = 0x80,
        FIVE_GZ = 0x100,
        PASSIVE = 0x200,
        DYN_CCK_OFDM = 0x400,
        GFSK    = 0x800
    };
    
    enum PresentFlags {
        TSFT                = 1 << 0,
        TSTF                = 1 << 0, 
        FLAGS               = 1 << 1,
        RATE                = 1 << 2,
        CHANNEL             = 1 << 3,
        FHSS                = 1 << 4,
        DBM_SIGNAL          = 1 << 5,
        DBM_NOISE           = 1 << 6,
        LOCK_QUALITY        = 1 << 7,
        TX_ATTENUATION      = 1 << 8,
        DB_TX_ATTENUATION   = 1 << 9,
        DBM_TX_ATTENUATION  = 1 << 10,
        ANTENNA             = 1 << 11,
        DB_SIGNAL           = 1 << 12,
        DB_NOISE            = 1 << 13,
        RX_FLAGS            = 1 << 14,
        TX_FLAGS            = 1 << 15,
        DATA_RETRIES        = 1 << 17,
        XCHANNEL            = 1 << 18,
        CHANNEL_PLUS        = 1 << 18,
        MCS                 = 1 << 19
    };
    
    enum FrameFlags {
        CFP           = 1,
        PREAMBLE      = 2,
        WEP           = 4,
        FRAGMENTATION = 8,
        FCS           = 16,
        PADDING       = 32,
        FAILED_FCS    = 64,
        SHORT_GI      = 128
    };

    TINS_BEGIN_PACK
    struct mcs_type {
        uint8_t known;
        uint8_t flags;
        uint8_t mcs;
    } TINS_END_PACK;

    TINS_BEGIN_PACK
    struct xchannel_type {
        uint32_t flags;
        uint16_t frequency;
        uint8_t channel;
        uint8_t max_power;
    } TINS_END_PACK;
    
    typedef PDUOption<RadioTap::PresentFlags, RadioTap> option;

    typedef std::vector<uint8_t> options_payload_type;

    RadioTap();
    
    RadioTap(const uint8_t* buffer, uint32_t total_sz);
    
    /* Setters */
    
    #ifndef _WIN32

    void send(PacketSender& sender, const NetworkInterface& iface);
    #endif
    
    void version(uint8_t new_version);
    
    void padding(uint8_t new_padding);
    
    void length(uint16_t new_length);
    
    void tsft(uint64_t new_tsft);
    
    void flags(FrameFlags new_flags);
    
    void rate(uint8_t new_rate);
    
    void channel(uint16_t new_freq, uint16_t new_type);
    
    void dbm_signal(int8_t new_dbm_signal);
    
    void dbm_noise(int8_t new_dbm_noise);
    
    void signal_quality(uint8_t new_signal_quality);

    void antenna(uint8_t new_antenna);
    
    void db_signal(uint8_t new_db_signal);

    void rx_flags(uint16_t new_rx_flag);

    void tx_flags(uint16_t new_tx_flag);

    void xchannel(xchannel_type new_xchannel);

    void data_retries(uint8_t new_data_retries);

    void mcs(const mcs_type& new_mcs);
    
    /* Getters */
    
    uint8_t version() const;

    uint8_t padding() const;
    
    uint16_t length() const;
    
    uint64_t tsft() const;
    
    FrameFlags flags() const;
    
    uint8_t rate() const;
    
    uint16_t channel_freq() const;
    
    uint16_t channel_type() const;
    
    int8_t dbm_signal() const;
    
    int8_t dbm_noise() const;
    
    uint16_t signal_quality() const;

    uint8_t antenna() const;

    uint8_t db_signal() const;
    
    xchannel_type xchannel() const;
    
    uint8_t data_retries() const;

    uint16_t rx_flags() const;

    uint16_t tx_flags() const;
    
    mcs_type mcs() const;

    PresentFlags present() const;
    
    bool matches_response(const uint8_t* ptr, uint32_t total_sz) const;
    
    uint32_t header_size() const;
    
    uint32_t trailer_size() const;
    
    void add_option(const option& opt);

    const options_payload_type& options_payload() const;

    RadioTap* clone() const {
        return new RadioTap(*this);
    }
    
    PDUType pdu_type() const {
        return pdu_flag;
    }
private:
    TINS_BEGIN_PACK
    struct radiotap_header {
    #if TINS_IS_LITTLE_ENDIAN
        uint8_t it_version; 
        uint8_t it_pad;
    #else
        uint8_t it_pad;
        uint8_t it_version;
    #endif // TINS_IS_LITTLE_ENDIAN 
        uint16_t it_len;
    } TINS_END_PACK;
    
    void write_serialization(uint8_t* buffer, uint32_t total_sz);
    option do_find_option(PresentFlags type) const;

    radiotap_header header_;
    options_payload_type options_payload_;
};
}

#endif // TINS_RADIOTAP_H