path: root/epan/dissectors/packet-iapp.c

/* packet-iapp.c
 * Routines for IAPP dissection
 * Copyright 2002, Alfred Arnold <aarnold@elsa.de>
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */

#include "config.h"

#include <epan/packet.h>
#include <epan/expert.h>

void proto_register_iapp(void);
void proto_reg_handoff_iapp(void);

static dissector_handle_t iapp_handle;

/* Initialize the protocol and registered fields */
static int proto_iapp;
static int hf_iapp_version;
static int hf_iapp_type;
static int hf_iapp_cap_forwarding;
static int hf_iapp_cap_wep;
static int hf_iapp_auth_status;
static int hf_iapp_auth_string;
static int hf_iapp_auth_uint;
static int hf_iapp_auth_ipaddr;
static int hf_iapp_auth_trailer;
static int hf_iapp_pdu_ssid;
static int hf_iapp_pdu_bytes;
static int hf_iapp_pdu_uint;
static int hf_iapp_pdu_phytype;
static int hf_iapp_pdu_regdomain;
static int hf_iapp_pdu_oui_ident;

/* Initialize the subtree pointers */
static int ett_iapp;
static int ett_iapp_pdu;
static int ett_iapp_subpdu;
static int ett_iapp_cap;
static int ett_iapp_auth;
static int ett_iapp_authinfo;

static expert_field ei_iapp_no_pdus;

#define UDP_PORT_IAPP     2313

#define IAPP_ANNOUNCE_REQUEST  0
#define IAPP_ANNOUNCE_RESPONSE 1
#define IAPP_HANDOVER_REQUEST  2
#define IAPP_HANDOVER_RESPONSE 3

#define IAPP_PDU_SSID 0
#define IAPP_PDU_BSSID 1
#define IAPP_PDU_OLDBSSID 2
#define IAPP_PDU_MSADDR 3
#define IAPP_PDU_CAPABILITY 4
#define IAPP_PDU_ANNOUNCEINT 5
#define IAPP_PDU_HOTIMEOUT 6
#define IAPP_PDU_MESSAGEID 7
#define IAPP_PDU_PHYTYPE 0x10
#define IAPP_PDU_REGDOMAIN 0x11
#define IAPP_PDU_CHANNEL 0x12
#define IAPP_PDU_BEACONINT 0x13
#define IAPP_PDU_OUIIDENT 0x80
#define IAPP_PDU_AUTHINFO 0x81

#define IAPP_CAP_FORWARDING 0x40
#define IAPP_CAP_WEP 0x20

#define IAPP_PHY_PROP 0x00
#define IAPP_PHY_FHSS 0x01
#define IAPP_PHY_DSSS 0x02
#define IAPP_PHY_IR 0x03
#define IAPP_PHY_OFDM 0x04

#define IAPP_DOM_FCC 0x10
#define IAPP_DOM_IC 0x20
#define IAPP_DOM_ETSI 0x30
#define IAPP_DOM_SPAIN 0x31
#define IAPP_DOM_FRANCE 0x32
#define IAPP_DOM_MKK 0x40

#define IAPP_AUTH_STATUS 0x01
#define IAPP_AUTH_USERNAME 0x02
#define IAPP_AUTH_PROVNAME 0x03
#define IAPP_AUTH_RXPKTS 0x04
#define IAPP_AUTH_TXPKTS 0x05
#define IAPP_AUTH_RXBYTES 0x06
#define IAPP_AUTH_TXBYTES 0x07
#define IAPP_AUTH_LOGINTIME 0x08
#define IAPP_AUTH_TIMELIMIT 0x09
#define IAPP_AUTH_VOLLIMIT 0x0a
#define IAPP_AUTH_ACCCYCLE 0x0b
#define IAPP_AUTH_RXGWORDS 0x0c
#define IAPP_AUTH_TXGWORDS 0x0d
#define IAPP_AUTH_IPADDR 0x0e
#define IAPP_AUTH_TRAILER 0xff

static const value_string iapp_vals[] = {
    {IAPP_ANNOUNCE_REQUEST, "Announce Request"},
    {IAPP_ANNOUNCE_RESPONSE, "Announce Response"},
    {IAPP_HANDOVER_REQUEST, "Handover Request"},
    {IAPP_HANDOVER_RESPONSE, "Handover Response"},
    {0, NULL}
};

static const value_string iapp_pdu_type_vals[] = {
    {IAPP_PDU_SSID, "Network Name"},
    {IAPP_PDU_BSSID, "BSSID"},
    {IAPP_PDU_OLDBSSID, "Old BSSID"},
    {IAPP_PDU_MSADDR, "Mobile Station Address"},
    {IAPP_PDU_CAPABILITY, "Capabilities"},
    {IAPP_PDU_ANNOUNCEINT, "Announce Interval"},
    {IAPP_PDU_HOTIMEOUT, "Handover Timeout"},
    {IAPP_PDU_MESSAGEID, "Message ID"},
    {IAPP_PDU_PHYTYPE, "PHY Type"},
    {IAPP_PDU_REGDOMAIN, "Regulatory Domain"},
    {IAPP_PDU_CHANNEL, "Radio Channel"},
    {IAPP_PDU_BEACONINT, "Beacon Interval"},
    {IAPP_PDU_OUIIDENT, "OUI Identifier"},
    {IAPP_PDU_AUTHINFO, "ELSA Authentication Info"},
    {0, NULL}
};

static const value_string iapp_phy_vals[] = {
    {IAPP_PHY_PROP, "Proprietary"},
    {IAPP_PHY_FHSS, "FHSS"},
    {IAPP_PHY_DSSS, "DSSS"},
    {IAPP_PHY_IR, "Infrared"},
    {IAPP_PHY_OFDM, "OFDM"},
    {0, NULL}
};

static const value_string iapp_dom_vals[] = {
    {IAPP_DOM_FCC, "FCC (USA)"},
    {IAPP_DOM_IC, "IC (Canada)"},
    {IAPP_DOM_ETSI, "ETSI (Europe)"},
    {IAPP_DOM_SPAIN, "Spain"},
    {IAPP_DOM_FRANCE, "France"},
    {IAPP_DOM_MKK, "MKK (Japan)"},
    {0, NULL}
};

static const value_string iapp_auth_type_vals[] = {
    {IAPP_AUTH_STATUS, "Status"},
    {IAPP_AUTH_USERNAME, "User Name"},
    {IAPP_AUTH_PROVNAME, "Provider Name"},
    {IAPP_AUTH_RXPKTS, "Received Packets"},
    {IAPP_AUTH_TXPKTS, "Transmitted Packets"},
    {IAPP_AUTH_RXBYTES, "Received Octets"},
    {IAPP_AUTH_TXBYTES, "Transmitted Octets"},
    {IAPP_AUTH_LOGINTIME, "Session Time"},
    {IAPP_AUTH_TIMELIMIT, "Time Limit"},
    {IAPP_AUTH_VOLLIMIT, "Volume Limit"},
    {IAPP_AUTH_ACCCYCLE, "Accounting Cycle"},
    {IAPP_AUTH_TRAILER, "Authenticator"},
    {IAPP_AUTH_RXGWORDS, "Received Gigawords"},
    {IAPP_AUTH_TXGWORDS, "Transmitted Gigawords"},
    {IAPP_AUTH_IPADDR, "Client IP Address"},
    {0, NULL}
};


/* dissect a capability bit field */

static void dissect_caps(proto_tree *tree, tvbuff_t *tvb, int offset)
{
    proto_tree *captree;

    captree = proto_tree_add_subtree(tree, tvb, offset, 1, ett_iapp_cap, NULL, "Capabilities");
    proto_tree_add_item(captree, hf_iapp_cap_forwarding, tvb, offset, 1, ENC_NA);
    proto_tree_add_item(captree, hf_iapp_cap_wep, tvb, offset, 1, ENC_NA);
}

static void
add_authval_str(proto_tree *tree, int type, int len, tvbuff_t *tvb, int offset)
{
    int val;

    switch (type)
    {
        case IAPP_AUTH_STATUS:
            val = tvb_get_uint8(tvb, offset);
            proto_tree_add_uint_format_value(tree, hf_iapp_auth_status, tvb, offset, 1, val, "%s", val ? "Authenticated" : "Not authenticated");
            break;
        case IAPP_AUTH_USERNAME:
        case IAPP_AUTH_PROVNAME:
            proto_tree_add_item(tree, hf_iapp_auth_string, tvb, offset, 1, ENC_ASCII);
            break;
        case IAPP_AUTH_RXPKTS:
        case IAPP_AUTH_TXPKTS:
        case IAPP_AUTH_RXBYTES:
        case IAPP_AUTH_TXBYTES:
        case IAPP_AUTH_RXGWORDS:
        case IAPP_AUTH_TXGWORDS:
        case IAPP_AUTH_VOLLIMIT:
            proto_tree_add_item(tree, hf_iapp_auth_uint, tvb, offset, 4, ENC_BIG_ENDIAN);
            break;
        case IAPP_AUTH_LOGINTIME:
        case IAPP_AUTH_TIMELIMIT:
        case IAPP_AUTH_ACCCYCLE:
            val = tvb_get_ntohl(tvb, offset);
            proto_tree_add_uint_format_value(tree, hf_iapp_auth_uint, tvb, offset, 4, val, "%d seconds", val);
            break;
        case IAPP_AUTH_IPADDR:
            proto_tree_add_item(tree, hf_iapp_auth_ipaddr, tvb, offset, 4, ENC_BIG_ENDIAN);
            break;
        case IAPP_AUTH_TRAILER:
            proto_tree_add_item(tree, hf_iapp_auth_trailer, tvb, offset, len, ENC_NA);
            break;
    }
}

/* dissect authentication info */

static void dissect_authinfo(proto_item *pitem, tvbuff_t *tvb, int offset, int sumlen)
{
    proto_tree *authtree, *value_tree;
    uint8_t pdu_type;
    uint16_t len;

    authtree = proto_item_add_subtree(pitem, ett_iapp_auth);

    while (sumlen > 0)
    {
        pdu_type = tvb_get_uint8(tvb, offset);
        len = tvb_get_ntohs(tvb, offset+1);

        value_tree = proto_tree_add_subtree_format(authtree, tvb, offset, len + 3,
            ett_iapp_authinfo, NULL, "%s (%d)",
            val_to_str_const(pdu_type, iapp_auth_type_vals, "Unknown PDU Type"),
            pdu_type);
        add_authval_str(value_tree, pdu_type, len, tvb, offset+3);

        sumlen -= (len + 3);
        offset += (len + 3);
    }
}

/* get displayable values of PDU contents */

static bool
append_pduval_str(proto_tree *tree, int type, int len, tvbuff_t *tvb, int offset,
    bool is_fhss)
{
    int val;

    switch (type)
    {
        case IAPP_PDU_SSID:
            proto_tree_add_item(tree, hf_iapp_pdu_ssid, tvb, offset, len, ENC_ASCII);
            break;
        case IAPP_PDU_BSSID:
        case IAPP_PDU_OLDBSSID:
        case IAPP_PDU_MSADDR:
            proto_tree_add_item(tree, hf_iapp_pdu_bytes, tvb, offset, len, ENC_NA);
            break;
        case IAPP_PDU_CAPABILITY:
            dissect_caps(tree, tvb, offset);
            break;
        case IAPP_PDU_ANNOUNCEINT:
            val = tvb_get_ntohs(tvb, offset);
            proto_tree_add_uint_format_value(tree, hf_iapp_pdu_uint, tvb, offset, 2, val, "%d seconds", val);
            break;
        case IAPP_PDU_HOTIMEOUT:
        case IAPP_PDU_BEACONINT:
            val = tvb_get_ntohs(tvb, offset);
            proto_tree_add_uint_format_value(tree, hf_iapp_pdu_uint, tvb, offset, 2, val, "%d Kus", val);
            break;
        case IAPP_PDU_MESSAGEID:
            proto_tree_add_item(tree, hf_iapp_pdu_uint, tvb, offset, 2, ENC_BIG_ENDIAN);
            break;
        case IAPP_PDU_PHYTYPE:
            proto_tree_add_item(tree, hf_iapp_pdu_phytype, tvb, offset, 1, ENC_BIG_ENDIAN);
            is_fhss = (tvb_get_uint8(tvb, offset) == IAPP_PHY_FHSS);
            break;
        case IAPP_PDU_REGDOMAIN:
            proto_tree_add_item(tree, hf_iapp_pdu_regdomain, tvb, offset, 1, ENC_BIG_ENDIAN);
            break;
        case IAPP_PDU_CHANNEL:
            if (is_fhss)
            {
                val = tvb_get_uint8(tvb, offset);
                proto_tree_add_uint_format(tree, hf_iapp_pdu_uint, tvb, offset, 1, val,
                        "Pattern set %d, sequence %d", ((val >> 6) & 3) + 1, (val & 31) + 1);
            }
            else
                proto_tree_add_item(tree, hf_iapp_pdu_uint, tvb, offset, 1, ENC_BIG_ENDIAN);
            break;
        case IAPP_PDU_OUIIDENT:
            proto_tree_add_item(tree, hf_iapp_pdu_oui_ident, tvb, offset, 3, ENC_BIG_ENDIAN);
            break;
    }
    return is_fhss;
}

/* code to dissect a list of PDUs */

static void
dissect_pdus(tvbuff_t *tvb, packet_info *pinfo, int offset, proto_tree *pdutree, proto_item *pduitem, int pdulen)
{
    uint8_t pdu_type;
    uint16_t len;
    proto_item *ti;
    bool is_fhss;
    proto_tree *subtree;

    if (!pdulen)
    {
        expert_add_info(pinfo, pduitem, &ei_iapp_no_pdus);
        return;
    }

    is_fhss = false;
    while (pdulen > 0)
    {
        pdu_type = tvb_get_uint8(tvb, offset);
        len = tvb_get_ntohs(tvb, offset+1);

        subtree = proto_tree_add_subtree_format(pdutree, tvb, offset, len + 3,
            ett_iapp_subpdu, &ti, "%s (%d)",
            val_to_str_const(pdu_type, iapp_pdu_type_vals, "Unknown PDU Type"),
            pdu_type);
        is_fhss = append_pduval_str(subtree, pdu_type, len, tvb,
            offset+3, is_fhss);

        if (pdu_type == IAPP_PDU_AUTHINFO)
            dissect_authinfo(ti, tvb, offset + 3, len);

        pdulen -= (len + 3);
        offset += (len + 3);
    }
}

/* code to dissect an IAPP packet */
static int
dissect_iapp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data _U_)
{
    proto_item *ti, *pduitem;
    proto_tree *iapp_tree, *pdutree;
    uint8_t ia_version;
    uint8_t ia_type;
    const char *codestrval;

    col_set_str(pinfo->cinfo, COL_PROTOCOL, "IAPP");

    col_clear(pinfo->cinfo, COL_INFO);

    ia_version = tvb_get_uint8(tvb, 0);
    ia_type = tvb_get_uint8(tvb, 1);

    codestrval = val_to_str_const(ia_type, iapp_vals, "Unknown Packet");
    col_add_fstr(pinfo->cinfo, COL_INFO, "%s(%d) (version=%d)", codestrval, ia_type, ia_version);

    ti = proto_tree_add_item(tree, proto_iapp, tvb, 0, -1, ENC_NA);
    iapp_tree = proto_item_add_subtree(ti, ett_iapp);

    /* common header for all IAPP frames */

    proto_tree_add_item(iapp_tree, hf_iapp_version, tvb, 0, 1, ENC_BIG_ENDIAN);
    proto_tree_add_item(iapp_tree, hf_iapp_type, tvb, 1, 1, ENC_BIG_ENDIAN);

    pdutree = proto_tree_add_subtree(iapp_tree, tvb, 2, -1,
            ett_iapp_pdu, &pduitem, "Protocol data units");

    dissect_pdus(tvb, pinfo, 2, pdutree, pduitem,
            tvb_captured_length_remaining(tvb, 2));

    return tvb_captured_length(tvb);
}


/* Register the protocol with Wireshark */

/* this format is require because a script is used to build the C function
   that calls all the protocol registration.
*/

void
proto_register_iapp(void)
{

    static hf_register_info hf[] = {
        { &hf_iapp_version,
            { "Version", "iapp.version", FT_UINT8, BASE_DEC, NULL, 0x00, NULL, HFILL }
        },
        { &hf_iapp_type,
            { "Type", "iapp.type", FT_UINT8, BASE_DEC, VALS(iapp_vals), 0x00, NULL, HFILL }
        },
        { &hf_iapp_cap_forwarding,
            { "Forwarding", "iapp.cap.forwarding", FT_BOOLEAN, 8, TFS(&tfs_yes_no), IAPP_CAP_FORWARDING, NULL, HFILL }
        },
        { &hf_iapp_cap_wep,
            { "WEP", "iapp.cap.wep", FT_BOOLEAN, 8, TFS(&tfs_yes_no), IAPP_CAP_WEP, NULL, HFILL }
        },
        { &hf_iapp_auth_status,
            { "Status", "iapp.auth.status", FT_UINT8, BASE_DEC, NULL, 0x00, NULL, HFILL }
        },
        { &hf_iapp_auth_uint,
            { "Value", "iapp.auth.uint", FT_UINT32, BASE_DEC, NULL, 0x00, NULL, HFILL }
        },
        { &hf_iapp_auth_string,
            { "Value", "iapp.auth.string", FT_STRING, BASE_NONE, NULL, 0x00, NULL, HFILL }
        },
        { &hf_iapp_auth_ipaddr,
            { "IP Address", "iapp.auth.ipaddr", FT_IPv4, BASE_NONE, NULL, 0x00, NULL, HFILL }
        },
        { &hf_iapp_auth_trailer,
            { "Trailer", "iapp.auth.trailer", FT_BYTES, BASE_NONE, NULL, 0x00, NULL, HFILL }
        },
        { &hf_iapp_pdu_ssid,
            { "SSID", "iapp.pdu.ssid", FT_STRING, BASE_NONE, NULL, 0x00, NULL, HFILL }
        },
        { &hf_iapp_pdu_bytes,
            { "Value", "iapp.pdu.bytes", FT_BYTES, BASE_NONE, NULL, 0x00, NULL, HFILL }
        },
        { &hf_iapp_pdu_uint,
            { "Value", "iapp.pdu.uint", FT_UINT32, BASE_DEC, NULL, 0x00, NULL, HFILL }
        },
        { &hf_iapp_pdu_phytype,
            { "PHY Type", "iapp.pdu.phytype", FT_UINT8, BASE_DEC, VALS(iapp_phy_vals), 0x00, NULL, HFILL }
        },
        { &hf_iapp_pdu_regdomain,
            { "Reg domain", "iapp.pdu.regdomain", FT_UINT8, BASE_DEC, VALS(iapp_dom_vals), 0x00, NULL, HFILL }
        },
        { &hf_iapp_pdu_oui_ident,
            { "OUI", "iapp.pdu.oui_ident", FT_UINT24, BASE_OUI, NULL, 0x00, NULL, HFILL }
        },
    };

    static int *ett[] = {
        &ett_iapp,
        &ett_iapp_pdu,
        &ett_iapp_subpdu,
        &ett_iapp_cap,
        &ett_iapp_auth,
        &ett_iapp_authinfo
    };

    static ei_register_info ei[] = {
        { &ei_iapp_no_pdus, { "iapp.no_pdus", PI_PROTOCOL, PI_NOTE, "No PDUs found", EXPFILL }},
    };

    expert_module_t* expert_iapp;

/* Register the protocol name and description */
    proto_iapp = proto_register_protocol("Inter-Access-Point Protocol", "IAPP", "iapp");

/* Required function calls to register the header fields and subtrees used */
    proto_register_field_array(proto_iapp, hf, array_length(hf));
    proto_register_subtree_array(ett, array_length(ett));
    expert_iapp = expert_register_protocol(proto_iapp);
    expert_register_field_array(expert_iapp, ei, array_length(ei));

    iapp_handle = register_dissector("iapp", dissect_iapp, proto_iapp);
}


/* If this dissector uses sub-dissector registration add a registration routine.
   This format is required because a script is used to find these routines and
   create the code that calls these routines.
*/
void
proto_reg_handoff_iapp(void)
{
    dissector_add_uint_with_preference("udp.port", UDP_PORT_IAPP, iapp_handle);
}
/*
 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 4
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * vi: set shiftwidth=4 tabstop=8 expandtab:
 * :indentSize=4:tabSize=8:noTabs=true:
 */