inet::ieee80211::Ieee80211MgmtSta Class Reference

Used in 802.11 infrastructure mode: handles management frames for a station (STA). More...

#include <Ieee80211MgmtSta.h>

Inheritance diagram for inet::ieee80211::Ieee80211MgmtSta:

Classes
struct	ApInfo
struct	AssociatedApInfo
struct	ScanningInfo

Public Member Functions
	Ieee80211MgmtSta ()
virtual const ApInfo *	getAssociatedAp ()
Public Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Types
typedef std::list< ApInfo >	AccessPointList
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleTimer (cMessage *msg) override
	Implements abstract Ieee80211MgmtBase method. More...
virtual void	handleCommand (int msgkind, cObject *ctrl) override
	Implements abstract Ieee80211MgmtBase method. More...
virtual void	startAuthentication (ApInfo *ap, simtime_t timeout)
	Utility function: sends authentication request. More...
virtual void	startAssociation (ApInfo *ap, simtime_t timeout)
	Utility function: sends association request. More...
virtual ApInfo *	lookupAP (const MacAddress &address)
	Utility function: looks up AP in our AP list. More...
virtual void	clearAPList ()
	Utility function: clear the AP list, and cancel any pending authentications. More...
virtual void	changeChannel (int channelNum)
	Utility function: switches to the given radio channel. More...
virtual void	storeAPInfo (Packet *packet, const Ptr< const Ieee80211MgmtHeader > &header, const Ptr< const Ieee80211BeaconFrame > &body)
	Stores AP info received in a beacon or probe response. More...
virtual bool	scanNextChannel ()
	Switches to the next channel to scan; returns true if done (there wasn't any more channel to scan). More...
virtual void	sendProbeRequest ()
	Broadcasts a Probe Request. More...
virtual void	beaconLost ()
	Missed a few consecutive beacons. More...
virtual void	sendScanConfirm ()
	Sends back result of scanning to the agent. More...
virtual void	sendAuthenticationConfirm (ApInfo *ap, Ieee80211PrimResultCode resultCode)
	Sends back result of authentication to the agent. More...
virtual void	sendAssociationConfirm (ApInfo *ap, Ieee80211PrimResultCode resultCode)
	Sends back result of association to the agent. More...
virtual void	disassociate ()
	Utility function: Cancel the existing association. More...
virtual void	sendConfirm (Ieee80211PrimConfirm *confirm, Ieee80211PrimResultCode resultCode)
	Utility function: sends a confirmation to the agent. More...
virtual void	sendManagementFrame (const char *name, const Ptr< Ieee80211MgmtFrame > &body, int subtype, const MacAddress &address)
	Utility function: sends a management frame. More...
virtual void	receiveSignal (cComponent *source, simsignal_t signalID, intval_t value, cObject *details) override
	Called by the signal handler whenever a change occurs we're interested in. More...
virtual Ieee80211PrimResultCode	statusCodeToPrimResultCode (int statusCode)
	Utility function: converts Ieee80211StatusCode (->frame) to Ieee80211PrimResultCode (->primitive) More...
Processing of different frame types
virtual void	handleAuthenticationFrame (Packet *packet, const Ptr< const Ieee80211MgmtHeader > &header) override
virtual void	handleDeauthenticationFrame (Packet *packet, const Ptr< const Ieee80211MgmtHeader > &header) override
virtual void	handleAssociationRequestFrame (Packet *packet, const Ptr< const Ieee80211MgmtHeader > &header) override
virtual void	handleAssociationResponseFrame (Packet *packet, const Ptr< const Ieee80211MgmtHeader > &header) override
virtual void	handleReassociationRequestFrame (Packet *packet, const Ptr< const Ieee80211MgmtHeader > &header) override
virtual void	handleReassociationResponseFrame (Packet *packet, const Ptr< const Ieee80211MgmtHeader > &header) override
virtual void	handleDisassociationFrame (Packet *packet, const Ptr< const Ieee80211MgmtHeader > &header) override
virtual void	handleBeaconFrame (Packet *packet, const Ptr< const Ieee80211MgmtHeader > &header) override
virtual void	handleProbeRequestFrame (Packet *packet, const Ptr< const Ieee80211MgmtHeader > &header) override
virtual void	handleProbeResponseFrame (Packet *packet, const Ptr< const Ieee80211MgmtHeader > &header) override
Processing of different agent commands
virtual void	processScanCommand (Ieee80211Prim_ScanRequest *ctrl)
virtual void	processAuthenticateCommand (Ieee80211Prim_AuthenticateRequest *ctrl)
virtual void	processDeauthenticateCommand (Ieee80211Prim_DeauthenticateRequest *ctrl)
virtual void	processAssociateCommand (Ieee80211Prim_AssociateRequest *ctrl)
virtual void	processReassociateCommand (Ieee80211Prim_ReassociateRequest *ctrl)
virtual void	processDisassociateCommand (Ieee80211Prim_DisassociateRequest *ctrl)
Protected Member Functions inherited from inet::ieee80211::Ieee80211MgmtBase
virtual void	handleMessageWhenUp (cMessage *msg) override
	Dispatches incoming messages to handleTimer(), handleUpperMessage() or processFrame(). More...
virtual void	sendDown (Packet *frame)
	Utility method for implementing handleUpperMessage(): send message to MAC. More...
virtual void	dropManagementFrame (Packet *frame)
	Utility method to dispose of an unhandled frame. More...
virtual void	processFrame (Packet *packet, const Ptr< const Ieee80211DataOrMgmtHeader > &header)
	Dispatch to frame processing methods according to frame type. More...
virtual bool	isInitializeStage (int stage) const override
	lifecycle support More...
virtual bool	isModuleStartStage (int stage) const override
virtual bool	isModuleStopStage (int stage) const override
virtual void	handleStartOperation (LifecycleOperation *operation) override
virtual void	handleStopOperation (LifecycleOperation *operation) override
virtual void	handleCrashOperation (LifecycleOperation *operation) override
virtual void	start ()
virtual void	stop ()
Protected Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual int	numInitStages () const override
virtual void	refreshDisplay () const override
virtual void	handleMessage (cMessage *msg) override
virtual void	handleMessageWhenDown (cMessage *msg)
virtual bool	handleOperationStage (LifecycleOperation *operation, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
virtual State	getInitialOperationalState () const
	Returns initial operational state: OPERATING or NOT_OPERATING. More...
virtual void	handleActiveOperationTimeout (cMessage *message)
virtual bool	isUp () const
	utility functions More...
virtual bool	isDown () const
virtual void	setOperationalState (State newState)
virtual void	scheduleOperationTimeout (simtime_t timeout)
virtual void	setupActiveOperation (LifecycleOperation *operation, IDoneCallback *doneCallback, State)
virtual void	delayActiveOperationFinish (simtime_t timeout)
virtual void	startActiveOperationExtraTime (simtime_t delay=SIMTIME_ZERO)
virtual void	startActiveOperationExtraTimeOrFinish (simtime_t extraTime)
virtual void	finishActiveOperation ()

Protected Attributes
cModule *	host
int	numChannels
bool	isScanning
ScanningInfo	scanning
AccessPointList	apList
cMessage *	assocTimeoutMsg
AssociatedApInfo	assocAP
Protected Attributes inherited from inet::ieee80211::Ieee80211MgmtBase
ModuleRefByPar< Ieee80211Mib >	mib
ModuleRefByPar< IInterfaceTable >	interfaceTable
NetworkInterface *	myIface = nullptr
long	numMgmtFramesReceived
long	numMgmtFramesDropped
Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState
simtime_t	lastChange
Operation	activeOperation
cMessage *	activeOperationTimeout
cMessage *	activeOperationExtraTimer

Detailed Description

Used in 802.11 infrastructure mode: handles management frames for a station (STA).

See corresponding NED file for a detailed description.

Member Typedef Documentation

AccessPointList

typedef std::list<ApInfo> inet::ieee80211::Ieee80211MgmtSta::AccessPointList

protected

Constructor & Destructor Documentation

Ieee80211MgmtSta()

inet::ieee80211::Ieee80211MgmtSta::Ieee80211MgmtSta ( )

inline

: host(nullptr), numChannels(-1), isScanning(false), assocTimeoutMsg(nullptr) {}

Member Function Documentation

beaconLost()

void inet::ieee80211::Ieee80211MgmtSta::beaconLost ( )

protectedvirtual

Missed a few consecutive beacons.

{
    EV << "Missed a few consecutive beacons -- AP is considered lost\n";
    emit(l2BeaconLostSignal, myIface);
}

changeChannel()

void inet::ieee80211::Ieee80211MgmtSta::changeChannel ( int  channelNum )

protectedvirtual

Utility function: switches to the given radio channel.

{
    EV << "Tuning to channel #" << channelNum << "\n";
 
    Ieee80211ConfigureRadioCommand *configureCommand = new Ieee80211ConfigureRadioCommand();
    configureCommand->setChannelNumber(channelNum);
    auto request = new Request("changeChannel", RADIO_C_CONFIGURE);
    request->setControlInfo(configureCommand);
    send(request, "macOut");
}

clearAPList()

void inet::ieee80211::Ieee80211MgmtSta::clearAPList ( )

protectedvirtual

Utility function: clear the AP list, and cancel any pending authentications.

{
    for (auto& elem : apList)
        if (elem.authTimeoutMsg)
            cancelAndDelete(elem.authTimeoutMsg);
 
    apList.clear();
}

disassociate()

void inet::ieee80211::Ieee80211MgmtSta::disassociate ( )

protectedvirtual

Utility function: Cancel the existing association.

{
    EV << "Disassociating from AP address=" << assocAP.address << "\n";
    ASSERT(mib->bssStationData.isAssociated);
    mib->bssStationData.isAssociated = false;
    cancelAndDelete(assocAP.beaconTimeoutMsg);
    assocAP.beaconTimeoutMsg = nullptr;
    assocAP = AssociatedApInfo(); // clear it
}

getAssociatedAp()

virtual const ApInfo* inet::ieee80211::Ieee80211MgmtSta::getAssociatedAp ( )

inlinevirtual

{ return &assocAP; }

Referenced by inet::visualizer::Ieee80211CanvasVisualizer::refreshDisplay().

handleAssociationRequestFrame()

void inet::ieee80211::Ieee80211MgmtSta::handleAssociationRequestFrame ( Packet *  packet, const Ptr< const Ieee80211MgmtHeader > &  header  )

overrideprotectedvirtual

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    dropManagementFrame(packet);
}

handleAssociationResponseFrame()

void inet::ieee80211::Ieee80211MgmtSta::handleAssociationResponseFrame ( Packet *  packet, const Ptr< const Ieee80211MgmtHeader > &  header  )

overrideprotectedvirtual

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    EV << "Received Association Response frame\n";
 
    if (!assocTimeoutMsg) {
        EV << "No association in progress, ignoring frame\n";
        delete packet;
        return;
    }
 
    // extract frame contents
    const auto& responseBody = packet->peekData<Ieee80211AssociationResponseFrame>();
    MacAddress address = header->getTransmitterAddress();
    int statusCode = responseBody->getStatusCode();
    // TODO short aid;
    // TODO Ieee80211SupportedRatesElement supportedRates;
    delete packet;
 
    // look up AP data structure
    ApInfo *ap = lookupAP(address);
    if (!ap)
        throw cRuntimeError("handleAssociationResponseFrame: AP not known: address=%s", address.str().c_str());
 
    if (mib->bssStationData.isAssociated) {
        EV << "Breaking existing association with AP address=" << assocAP.address << "\n";
        mib->bssStationData.isAssociated = false;
        cancelAndDelete(assocAP.beaconTimeoutMsg);
        assocAP.beaconTimeoutMsg = nullptr;
        assocAP = AssociatedApInfo();
    }
 
    cancelAndDelete(assocTimeoutMsg);
    assocTimeoutMsg = nullptr;
 
    if (statusCode != SC_SUCCESSFUL) {
        EV << "Association failed with AP address=" << ap->address << "\n";
    }
    else {
        EV << "Association successful, AP address=" << ap->address << "\n";
 
        // change our state to "associated"
        mib->bssData.ssid = ap->ssid;
        mib->bssData.bssid = ap->address;
        mib->bssStationData.isAssociated = true;
        (ApInfo&)assocAP = (*ap);
 
        emit(l2AssociatedSignal, myIface, ap);
 
        assocAP.beaconTimeoutMsg = new cMessage("beaconTimeout", MK_BEACON_TIMEOUT);
        scheduleAfter(MAX_BEACONS_MISSED * assocAP.beaconInterval, assocAP.beaconTimeoutMsg);
    }
 
    // report back to agent
    sendAssociationConfirm(ap, statusCodeToPrimResultCode(statusCode));
}

handleAuthenticationFrame()

void inet::ieee80211::Ieee80211MgmtSta::handleAuthenticationFrame ( Packet *  packet, const Ptr< const Ieee80211MgmtHeader > &  header  )

overrideprotectedvirtual

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    const auto& requestBody = packet->peekData<Ieee80211AuthenticationFrame>();
    MacAddress address = header->getTransmitterAddress();
    int frameAuthSeq = requestBody->getSequenceNumber();
    EV << "Received Authentication frame from address=" << address << ", seqNum=" << frameAuthSeq << "\n";
 
    ApInfo *ap = lookupAP(address);
    if (!ap) {
        EV << "AP not known, discarding authentication frame\n";
        delete packet;
        return;
    }
 
    // what if already authenticated with AP
    if (ap->isAuthenticated) {
        EV << "AP already authenticated, ignoring frame\n";
        delete packet;
        return;
    }
 
    // is authentication is in progress with this AP?
    if (!ap->authTimeoutMsg) {
        EV << "No authentication in progress with AP, ignoring frame\n";
        delete packet;
        return;
    }
 
    // check authentication sequence number is OK
    if (frameAuthSeq != ap->authSeqExpected) {
        // wrong sequence number: send error and return
        EV << "Wrong sequence number, " << ap->authSeqExpected << " expected\n";
        const auto& body = makeShared<Ieee80211AuthenticationFrame>();
        body->setStatusCode(SC_AUTH_OUT_OF_SEQ);
        sendManagementFrame("Auth-ERROR", body, ST_AUTHENTICATION, header->getTransmitterAddress());
        delete packet;
 
        // cancel timeout, send error to agent
        cancelAndDelete(ap->authTimeoutMsg);
        ap->authTimeoutMsg = nullptr;
        sendAuthenticationConfirm(ap, PRC_REFUSED); // TODO or what resultCode?
        return;
    }
 
    // check if more exchanges are needed for auth to be complete
    int statusCode = requestBody->getStatusCode();
 
    if (statusCode == SC_SUCCESSFUL && !requestBody->isLast()) {
        EV << "More steps required, sending another Authentication frame\n";
 
        // more steps required, send another Authentication frame
        const auto& body = makeShared<Ieee80211AuthenticationFrame>();
        body->setSequenceNumber(frameAuthSeq + 1);
        body->setStatusCode(SC_SUCCESSFUL);
        // TODO frame length could be increased to account for challenge text length etc.
        sendManagementFrame("Auth", body, ST_AUTHENTICATION, address);
        ap->authSeqExpected += 2;
    }
    else {
        if (statusCode == SC_SUCCESSFUL)
            EV << "Authentication successful\n";
        else
            EV << "Authentication failed\n";
 
        // authentication completed
        ap->isAuthenticated = (statusCode == SC_SUCCESSFUL);
        cancelAndDelete(ap->authTimeoutMsg);
        ap->authTimeoutMsg = nullptr;
        sendAuthenticationConfirm(ap, statusCodeToPrimResultCode(statusCode));
    }
 
    delete packet;
}

handleBeaconFrame()

void inet::ieee80211::Ieee80211MgmtSta::handleBeaconFrame ( Packet *  packet, const Ptr< const Ieee80211MgmtHeader > &  header  )

overrideprotectedvirtual

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    EV << "Received Beacon frame\n";
    const auto& beaconBody = packet->peekData<Ieee80211BeaconFrame>();
    storeAPInfo(packet, header, beaconBody);
 
    // if it is out associate AP, restart beacon timeout
    if (mib->bssStationData.isAssociated && header->getTransmitterAddress() == assocAP.address) {
        EV << "Beacon is from associated AP, restarting beacon timeout timer\n";
        ASSERT(assocAP.beaconTimeoutMsg != nullptr);
        rescheduleAfter(MAX_BEACONS_MISSED * assocAP.beaconInterval, assocAP.beaconTimeoutMsg);
 
//        ApInfo *ap = lookupAP(frame->getTransmitterAddress());
//        ASSERT(ap!=nullptr);
    }
 
    delete packet;
}

handleCommand()

void inet::ieee80211::Ieee80211MgmtSta::handleCommand ( int  msgkind, cObject *  ctrl  )

overrideprotectedvirtual

Implements abstract Ieee80211MgmtBase method.

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    if (auto cmd = dynamic_cast<Ieee80211Prim_ScanRequest *>(ctrl))
        processScanCommand(cmd);
    else if (auto cmd = dynamic_cast<Ieee80211Prim_AuthenticateRequest *>(ctrl))
        processAuthenticateCommand(cmd);
    else if (auto cmd = dynamic_cast<Ieee80211Prim_DeauthenticateRequest *>(ctrl))
        processDeauthenticateCommand(cmd);
    else if (auto cmd = dynamic_cast<Ieee80211Prim_AssociateRequest *>(ctrl))
        processAssociateCommand(cmd);
    else if (auto cmd = dynamic_cast<Ieee80211Prim_ReassociateRequest *>(ctrl))
        processReassociateCommand(cmd);
    else if (auto cmd = dynamic_cast<Ieee80211Prim_DisassociateRequest *>(ctrl))
        processDisassociateCommand(cmd);
    else if (ctrl)
        throw cRuntimeError("handleCommand(): unrecognized control info class `%s'", ctrl->getClassName());
    else
        throw cRuntimeError("handleCommand(): control info is nullptr");
    delete ctrl;
}

handleDeauthenticationFrame()

void inet::ieee80211::Ieee80211MgmtSta::handleDeauthenticationFrame ( Packet *  packet, const Ptr< const Ieee80211MgmtHeader > &  header  )

overrideprotectedvirtual

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    EV << "Received Deauthentication frame\n";
    const MacAddress& address = header->getAddress3(); // source address
    ApInfo *ap = lookupAP(address);
    if (!ap || !ap->isAuthenticated) {
        EV << "Unknown AP, or not authenticated with that AP -- ignoring frame\n";
        delete packet;
        return;
    }
    if (ap->authTimeoutMsg) {
        cancelAndDelete(ap->authTimeoutMsg);
        ap->authTimeoutMsg = nullptr;
        EV << "Cancelling pending authentication\n";
        delete packet;
        return;
    }
 
    EV << "Setting isAuthenticated flag for that AP to false\n";
    ap->isAuthenticated = false;
    delete packet;
}

handleDisassociationFrame()

void inet::ieee80211::Ieee80211MgmtSta::handleDisassociationFrame ( Packet *  packet, const Ptr< const Ieee80211MgmtHeader > &  header  )

overrideprotectedvirtual

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    EV << "Received Disassociation frame\n";
    const MacAddress& address = header->getAddress3(); // source address
 
    if (assocTimeoutMsg) {
        // pending association
        cancelAndDelete(assocTimeoutMsg);
        assocTimeoutMsg = nullptr;
    }
    if (!mib->bssStationData.isAssociated || address != assocAP.address) {
        EV << "Not associated with that AP -- ignoring frame\n";
        delete packet;
        return;
    }
 
    EV << "Setting isAssociated flag to false\n";
    mib->bssStationData.isAssociated = false;
    cancelAndDelete(assocAP.beaconTimeoutMsg);
    assocAP.beaconTimeoutMsg = nullptr;
}

handleProbeRequestFrame()

void inet::ieee80211::Ieee80211MgmtSta::handleProbeRequestFrame ( Packet *  packet, const Ptr< const Ieee80211MgmtHeader > &  header  )

overrideprotectedvirtual

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    dropManagementFrame(packet);
}

handleProbeResponseFrame()

void inet::ieee80211::Ieee80211MgmtSta::handleProbeResponseFrame ( Packet *  packet, const Ptr< const Ieee80211MgmtHeader > &  header  )

overrideprotectedvirtual

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    EV << "Received Probe Response frame\n";
    const auto& probeResponseBody = packet->peekData<Ieee80211ProbeResponseFrame>();
    storeAPInfo(packet, header, probeResponseBody);
    delete packet;
}

handleReassociationRequestFrame()

void inet::ieee80211::Ieee80211MgmtSta::handleReassociationRequestFrame ( Packet *  packet, const Ptr< const Ieee80211MgmtHeader > &  header  )

overrideprotectedvirtual

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    dropManagementFrame(packet);
}

handleReassociationResponseFrame()

void inet::ieee80211::Ieee80211MgmtSta::handleReassociationResponseFrame ( Packet *  packet, const Ptr< const Ieee80211MgmtHeader > &  header  )

overrideprotectedvirtual

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    EV << "Received Reassociation Response frame\n";
    // TODO handle with the same code as Association Response?
}

handleTimer()

void inet::ieee80211::Ieee80211MgmtSta::handleTimer ( cMessage *  msg )

overrideprotectedvirtual

Implements abstract Ieee80211MgmtBase method.

Implements inet::ieee80211::Ieee80211MgmtBase.

{
    if (msg->getKind() == MK_AUTH_TIMEOUT) {
        // authentication timed out
        ApInfo *ap = (ApInfo *)msg->getContextPointer();
        EV << "Authentication timed out, AP address = " << ap->address << "\n";
 
        // send back failure report to agent
        sendAuthenticationConfirm(ap, PRC_TIMEOUT);
    }
    else if (msg->getKind() == MK_ASSOC_TIMEOUT) {
        // association timed out
        ApInfo *ap = (ApInfo *)msg->getContextPointer();
        EV << "Association timed out, AP address = " << ap->address << "\n";
 
        // send back failure report to agent
        sendAssociationConfirm(ap, PRC_TIMEOUT);
    }
    else if (msg->getKind() == MK_SCAN_MAXCHANNELTIME) {
        // go to next channel during scanning
        bool done = scanNextChannel();
        if (done)
            sendScanConfirm(); // send back response to agents' "scan" command
        delete msg;
    }
    else if (msg->getKind() == MK_SCAN_SENDPROBE) {
        // Active Scan: send a probe request, then wait for minChannelTime (11.1.3.2.2)
        delete msg;
        sendProbeRequest();
        cMessage *timerMsg = new cMessage("minChannelTime", MK_SCAN_MINCHANNELTIME);
        scheduleAfter(scanning.minChannelTime, timerMsg); // TODO actually, we should start waiting after ProbeReq actually got transmitted
    }
    else if (msg->getKind() == MK_SCAN_MINCHANNELTIME) {
        // Active Scan: after minChannelTime, possibly listen for the remaining time until maxChannelTime
        delete msg;
        if (scanning.busyChannelDetected) {
            EV << "Busy channel detected during minChannelTime, continuing listening until maxChannelTime elapses\n";
            cMessage *timerMsg = new cMessage("maxChannelTime", MK_SCAN_MAXCHANNELTIME);
            scheduleAfter(scanning.maxChannelTime - scanning.minChannelTime, timerMsg);
        }
        else {
            EV << "Channel was empty during minChannelTime, going to next channel\n";
            bool done = scanNextChannel();
            if (done)
                sendScanConfirm(); // send back response to agents' "scan" command
        }
    }
    else if (msg->getKind() == MK_BEACON_TIMEOUT) {
        // missed a few consecutive beacons
        beaconLost();
    }
    else {
        throw cRuntimeError("internal error: unrecognized timer '%s'", msg->getName());
    }
}

initialize()

void inet::ieee80211::Ieee80211MgmtSta::initialize ( int  stage )

overrideprotectedvirtual

Reimplemented from inet::ieee80211::Ieee80211MgmtBase.

{
    Ieee80211MgmtBase::initialize(stage);
 
    if (stage == INITSTAGE_LOCAL) {
        mib->mode = Ieee80211Mib::INFRASTRUCTURE;
        mib->bssStationData.stationType = Ieee80211Mib::STATION;
        mib->bssStationData.isAssociated = false;
 
        isScanning = false;
        assocTimeoutMsg = nullptr;
        numChannels = par("numChannels");
 
        host = getContainingNode(this);
 
        WATCH(isScanning);
 
        WATCH(scanning);
        WATCH(assocAP);
        WATCH_LIST(apList);
    }
}

lookupAP()

Ieee80211MgmtSta::ApInfo * inet::ieee80211::Ieee80211MgmtSta::lookupAP ( const MacAddress &  address )

protectedvirtual

Utility function: looks up AP in our AP list.

Returns nullptr if not found.

{
    for (auto& elem : apList)
        if (elem.address == address)
            return &(elem);
 
    return nullptr;
}

numInitStages()

virtual int inet::ieee80211::Ieee80211MgmtSta::numInitStages ( ) const

inlineoverrideprotectedvirtual

Reimplemented from inet::ieee80211::Ieee80211MgmtBase.

{ return NUM_INIT_STAGES; }

processAssociateCommand()

void inet::ieee80211::Ieee80211MgmtSta::processAssociateCommand ( Ieee80211Prim_AssociateRequest *  ctrl )

protectedvirtual

{
    const MacAddress& address = ctrl->getAddress();
    ApInfo *ap = lookupAP(address);
    if (!ap)
        throw cRuntimeError("processAssociateCommand: AP not known: address = %s", address.str().c_str());
    startAssociation(ap, ctrl->getTimeout());
}

processAuthenticateCommand()

void inet::ieee80211::Ieee80211MgmtSta::processAuthenticateCommand ( Ieee80211Prim_AuthenticateRequest *  ctrl )

protectedvirtual

{
    const MacAddress& address = ctrl->getAddress();
    ApInfo *ap = lookupAP(address);
    if (!ap)
        throw cRuntimeError("processAuthenticateCommand: AP not known: address = %s", address.str().c_str());
    startAuthentication(ap, ctrl->getTimeout());
}

processDeauthenticateCommand()

void inet::ieee80211::Ieee80211MgmtSta::processDeauthenticateCommand ( Ieee80211Prim_DeauthenticateRequest *  ctrl )

protectedvirtual

{
    const MacAddress& address = ctrl->getAddress();
    ApInfo *ap = lookupAP(address);
    if (!ap)
        throw cRuntimeError("processDeauthenticateCommand: AP not known: address = %s", address.str().c_str());
 
    if (mib->bssStationData.isAssociated && assocAP.address == address)
        disassociate();
 
    if (ap->isAuthenticated)
        ap->isAuthenticated = false;
 
    // cancel possible pending authentication timer
    if (ap->authTimeoutMsg) {
        cancelAndDelete(ap->authTimeoutMsg);
        ap->authTimeoutMsg = nullptr;
    }
 
    // create and send deauthentication request
    const auto& body = makeShared<Ieee80211DeauthenticationFrame>();
    body->setReasonCode(ctrl->getReasonCode());
    sendManagementFrame("Deauth", body, ST_DEAUTHENTICATION, address);
}

processDisassociateCommand()

void inet::ieee80211::Ieee80211MgmtSta::processDisassociateCommand ( Ieee80211Prim_DisassociateRequest *  ctrl )

protectedvirtual

{
    const MacAddress& address = ctrl->getAddress();
 
    if (mib->bssStationData.isAssociated && address == assocAP.address) {
        disassociate();
    }
    else if (assocTimeoutMsg) {
        // pending association
        cancelAndDelete(assocTimeoutMsg);
        assocTimeoutMsg = nullptr;
    }
 
    // create and send disassociation request
    const auto& body = makeShared<Ieee80211DisassociationFrame>();
    body->setReasonCode(ctrl->getReasonCode());
    sendManagementFrame("Disass", body, ST_DISASSOCIATION, address);
}

processReassociateCommand()

void inet::ieee80211::Ieee80211MgmtSta::processReassociateCommand ( Ieee80211Prim_ReassociateRequest *  ctrl )

protectedvirtual

{
    // treat the same way as association
    // TODO refine
    processAssociateCommand(ctrl);
}

processScanCommand()

void inet::ieee80211::Ieee80211MgmtSta::processScanCommand ( Ieee80211Prim_ScanRequest *  ctrl )

protectedvirtual

{
    EV << "Received Scan Request from agent, clearing AP list and starting scanning...\n";
 
    if (isScanning)
        throw cRuntimeError("processScanCommand: scanning already in progress");
    if (mib->bssStationData.isAssociated) {
        disassociate();
    }
    else if (assocTimeoutMsg) {
        EV << "Cancelling ongoing association process\n";
        cancelAndDelete(assocTimeoutMsg);
        assocTimeoutMsg = nullptr;
    }
 
    // clear existing AP list (and cancel any pending authentications) -- we want to start with a clean page
    clearAPList();
 
    // fill in scanning state
    ASSERT(ctrl->getBSSType() == BSSTYPE_INFRASTRUCTURE);
    scanning.bssid = ctrl->getBSSID().isUnspecified() ? MacAddress::BROADCAST_ADDRESS : ctrl->getBSSID();
    scanning.ssid = ctrl->getSSID();
    scanning.activeScan = ctrl->getActiveScan();
    scanning.probeDelay = ctrl->getProbeDelay();
    scanning.channelList.clear();
    scanning.minChannelTime = ctrl->getMinChannelTime();
    scanning.maxChannelTime = ctrl->getMaxChannelTime();
    ASSERT(scanning.minChannelTime <= scanning.maxChannelTime);
 
    // channel list to scan (default: all channels)
    for (size_t i = 0; i < ctrl->getChannelListArraySize(); i++)
        scanning.channelList.push_back(ctrl->getChannelList(i));
    if (scanning.channelList.empty())
        for (int i = 0; i < numChannels; i++)
            scanning.channelList.push_back(i);
 
    // start scanning
    if (scanning.activeScan)
        host->subscribe(IRadio::receptionStateChangedSignal, this);
    scanning.currentChannelIndex = -1; // so we'll start with index==0
    isScanning = true;
    scanNextChannel();
}

receiveSignal()

void inet::ieee80211::Ieee80211MgmtSta::receiveSignal ( cComponent *  source, simsignal_t  signalID, intval_t  value, cObject *  details  )

overrideprotectedvirtual

Called by the signal handler whenever a change occurs we're interested in.

{
    Enter_Method("%s", cComponent::getSignalName(signalID));
 
    // Note that we are only subscribed during scanning!
    if (signalID == IRadio::receptionStateChangedSignal) {
        IRadio::ReceptionState newReceptionState = static_cast<IRadio::ReceptionState>(value);
        if (newReceptionState != IRadio::RECEPTION_STATE_UNDEFINED && newReceptionState != IRadio::RECEPTION_STATE_IDLE) {
            EV << "busy radio channel detected during scanning\n";
            scanning.busyChannelDetected = true;
        }
    }
}

scanNextChannel()

bool inet::ieee80211::Ieee80211MgmtSta::scanNextChannel ( )

protectedvirtual

Switches to the next channel to scan; returns true if done (there wasn't any more channel to scan).

{
    // if we're already at the last channel, we're through
    if (scanning.currentChannelIndex == (int)scanning.channelList.size() - 1) {
        EV << "Finished scanning last channel\n";
        if (scanning.activeScan)
            host->unsubscribe(IRadio::receptionStateChangedSignal, this);
        isScanning = false;
        return true; // we're done
    }
 
    // tune to next channel
    int newChannel = scanning.channelList[++scanning.currentChannelIndex];
    changeChannel(newChannel);
    scanning.busyChannelDetected = false;
 
    if (scanning.activeScan) {
        // Active Scan: first wait probeDelay, then send a probe. Listening
        // for minChannelTime or maxChannelTime takes place after that. (11.1.3.2)
        scheduleAfter(scanning.probeDelay, new cMessage("sendProbe", MK_SCAN_SENDPROBE));
    }
    else {
        // Passive Scan: spend maxChannelTime on the channel (11.1.3.1)
        cMessage *timerMsg = new cMessage("maxChannelTime", MK_SCAN_MAXCHANNELTIME);
        scheduleAfter(scanning.maxChannelTime, timerMsg);
    }
 
    return false;
}

sendAssociationConfirm()

void inet::ieee80211::Ieee80211MgmtSta::sendAssociationConfirm ( ApInfo *  ap, Ieee80211PrimResultCode  resultCode  )

protectedvirtual

Sends back result of association to the agent.

{
    sendConfirm(new Ieee80211Prim_AssociateConfirm(), resultCode);
}

sendAuthenticationConfirm()

void inet::ieee80211::Ieee80211MgmtSta::sendAuthenticationConfirm ( ApInfo *  ap, Ieee80211PrimResultCode  resultCode  )

protectedvirtual

Sends back result of authentication to the agent.

{
    Ieee80211Prim_AuthenticateConfirm *confirm = new Ieee80211Prim_AuthenticateConfirm();
    confirm->setAddress(ap->address);
    sendConfirm(confirm, resultCode);
}

sendConfirm()

void inet::ieee80211::Ieee80211MgmtSta::sendConfirm ( Ieee80211PrimConfirm *  confirm, Ieee80211PrimResultCode  resultCode  )

protectedvirtual

Utility function: sends a confirmation to the agent.

{
    confirm->setResultCode(resultCode);
    cMessage *msg = new cMessage(confirm->getClassName());
    msg->setControlInfo(confirm);
    send(msg, "agentOut");
}

sendManagementFrame()

void inet::ieee80211::Ieee80211MgmtSta::sendManagementFrame ( const char *  name, const Ptr< Ieee80211MgmtFrame > &  body, int  subtype, const MacAddress &  address  )

protectedvirtual

Utility function: sends a management frame.

{
    auto packet = new Packet(name);
    packet->addTag<MacAddressReq>()->setDestAddress(address);
    packet->addTag<Ieee80211SubtypeReq>()->setSubtype(subtype);
    packet->insertAtBack(body);
    sendDown(packet);
}

sendProbeRequest()

void inet::ieee80211::Ieee80211MgmtSta::sendProbeRequest ( )

protectedvirtual

Broadcasts a Probe Request.

{
    EV << "Sending Probe Request, BSSID=" << scanning.bssid << ", SSID=\"" << scanning.ssid << "\"\n";
    const auto& body = makeShared<Ieee80211ProbeRequestFrame>();
    body->setSSID(scanning.ssid.c_str());
    body->setChunkLength(B((2 + scanning.ssid.length()) + (2 + body->getSupportedRates().numRates)));
    sendManagementFrame("ProbeReq", body, ST_PROBEREQUEST, scanning.bssid);
}

sendScanConfirm()

void inet::ieee80211::Ieee80211MgmtSta::sendScanConfirm ( )

protectedvirtual

Sends back result of scanning to the agent.

{
    EV << "Scanning complete, found " << apList.size() << " APs, sending confirmation to agent\n";
 
    // copy apList contents into a ScanConfirm primitive and send it back
    int n = apList.size();
    Ieee80211Prim_ScanConfirm *confirm = new Ieee80211Prim_ScanConfirm();
    confirm->setBssListArraySize(n);
    auto it = apList.begin();
    // TODO filter for req'd bssid and ssid
    for (int i = 0; i < n; i++, it++) {
        ApInfo *ap = &(*it);
        Ieee80211Prim_BssDescription& bss = confirm->getBssListForUpdate(i);
        bss.setChannelNumber(ap->channel);
        bss.setBSSID(ap->address);
        bss.setSSID(ap->ssid.c_str());
        bss.setSupportedRates(ap->supportedRates);
        bss.setBeaconInterval(ap->beaconInterval);
        bss.setRxPower(ap->rxPower);
    }
    sendConfirm(confirm, PRC_SUCCESS);
}

startAssociation()

void inet::ieee80211::Ieee80211MgmtSta::startAssociation ( ApInfo *  ap, simtime_t  timeout  )

protectedvirtual

Utility function: sends association request.

{
    if (mib->bssStationData.isAssociated || assocTimeoutMsg)
        throw cRuntimeError("startAssociation: already associated or association currently in progress");
    if (!ap->isAuthenticated)
        throw cRuntimeError("startAssociation: not yet authenticated with AP address='%s'", ap->address.str().c_str());
 
    // switch to that channel
    changeChannel(ap->channel);
 
    // create and send association request
    const auto& body = makeShared<Ieee80211AssociationRequestFrame>();
 
    // TODO set the following too?
    // string SSID
//    Ieee80211SupportedRatesElement supportedRates;
 
    body->setChunkLength(B(2 + 2 + strlen(body->getSSID()) + 2 + body->getSupportedRates().numRates + 2));
    sendManagementFrame("Assoc", body, ST_ASSOCIATIONREQUEST, ap->address);
 
    // schedule timeout
    ASSERT(assocTimeoutMsg == nullptr);
    assocTimeoutMsg = new cMessage("assocTimeout", MK_ASSOC_TIMEOUT);
    assocTimeoutMsg->setContextPointer(ap);
    scheduleAfter(timeout, assocTimeoutMsg);
}

startAuthentication()

void inet::ieee80211::Ieee80211MgmtSta::startAuthentication ( ApInfo *  ap, simtime_t  timeout  )

protectedvirtual

Utility function: sends authentication request.

{
    if (ap->authTimeoutMsg)
        throw cRuntimeError("startAuthentication: authentication currently in progress with AP address='%s'", ap->address.str().c_str());
    if (ap->isAuthenticated)
        throw cRuntimeError("startAuthentication: already authenticated with AP address='%s'", ap->address.str().c_str());
 
    changeChannel(ap->channel);
 
    EV << "Sending initial Authentication frame with seqNum=1\n";
 
    // create and send first authentication frame
    const auto& body = makeShared<Ieee80211AuthenticationFrame>();
    body->setSequenceNumber(1);
    // TODO frame length could be increased to account for challenge text length etc.
    sendManagementFrame("Auth", body, ST_AUTHENTICATION, ap->address);
 
    ap->authSeqExpected = 2;
 
    // schedule timeout
    ASSERT(ap->authTimeoutMsg == nullptr);
    ap->authTimeoutMsg = new cMessage("authTimeout", MK_AUTH_TIMEOUT);
    ap->authTimeoutMsg->setContextPointer(ap);
    scheduleAfter(timeout, ap->authTimeoutMsg);
}

statusCodeToPrimResultCode()

Ieee80211PrimResultCode inet::ieee80211::Ieee80211MgmtSta::statusCodeToPrimResultCode ( int  statusCode )

protectedvirtual

Utility function: converts Ieee80211StatusCode (->frame) to Ieee80211PrimResultCode (->primitive)

{
    return statusCode == SC_SUCCESSFUL ? PRC_SUCCESS : PRC_REFUSED;
}

storeAPInfo()

void inet::ieee80211::Ieee80211MgmtSta::storeAPInfo ( Packet *  packet, const Ptr< const Ieee80211MgmtHeader > &  header, const Ptr< const Ieee80211BeaconFrame > &  body  )

protectedvirtual

Stores AP info received in a beacon or probe response.

{
    auto address = header->getTransmitterAddress();
    ApInfo *ap = lookupAP(address);
    if (ap) {
        EV << "AP address=" << address << ", SSID=" << body->getSSID() << " already in our AP list, refreshing the info\n";
    }
    else {
        EV << "Inserting AP address=" << address << ", SSID=" << body->getSSID() << " into our AP list\n";
        apList.push_back(ApInfo());
        ap = &apList.back();
    }
 
    ap->channel = body->getChannelNumber();
    ap->address = address;
    ap->ssid = body->getSSID();
    ap->supportedRates = body->getSupportedRates();
    ap->beaconInterval = body->getBeaconInterval();
    auto signalPowerInd = packet->getTag<SignalPowerInd>();
    if (signalPowerInd != nullptr) {
        ap->rxPower = signalPowerInd->getPower().get();
        if (ap->address == assocAP.address)
            assocAP.rxPower = ap->rxPower;
    }
}

Member Data Documentation

apList

AccessPointList inet::ieee80211::Ieee80211MgmtSta::apList

protected

assocAP

AssociatedApInfo inet::ieee80211::Ieee80211MgmtSta::assocAP

protected

assocTimeoutMsg

cMessage* inet::ieee80211::Ieee80211MgmtSta::assocTimeoutMsg

protected

host

cModule* inet::ieee80211::Ieee80211MgmtSta::host

protected

isScanning

bool inet::ieee80211::Ieee80211MgmtSta::isScanning

protected

numChannels

int inet::ieee80211::Ieee80211MgmtSta::numChannels

protected

scanning

ScanningInfo inet::ieee80211::Ieee80211MgmtSta::scanning

protected

---

The documentation for this class was generated from the following files:

• Ieee80211MgmtSta.h
• Ieee80211MgmtSta.cc