inet::sctp::SCTPNatHook Class Reference

#include <SCTPNatHook.h>

Inheritance diagram for inet::sctp::SCTPNatHook:

Public Member Functions
	SCTPNatHook ()
virtual	~SCTPNatHook ()
IHook::Result	datagramPreRoutingHook (INetworkDatagram *datagram, const InterfaceEntry *inIE, const InterfaceEntry *&outIE, L3Address &nextHopAddr) override
	This is the first hook called by the network protocol before it routes a datagram that was received from the lower layer. More...
IHook::Result	datagramForwardHook (INetworkDatagram *datagram, const InterfaceEntry *inIE, const InterfaceEntry *&outIE, L3Address &nextHopAddr) override
	This is the second hook called by the network protocol before it sends a datagram to the lower layer. More...
IHook::Result	datagramPostRoutingHook (INetworkDatagram *datagram, const InterfaceEntry *inIE, const InterfaceEntry *&outIE, L3Address &nextHopAddr) override
	This is the last hook called by the network protocol before it sends a datagram to the lower layer. More...
IHook::Result	datagramLocalInHook (INetworkDatagram *datagram, const InterfaceEntry *inIE) override
	This is the last hook called by the network protocol before it sends a datagram to the upper layer. More...
IHook::Result	datagramLocalOutHook (INetworkDatagram *datagram, const InterfaceEntry *&outIE, L3Address &nextHopAddr) override
	This is the first hook called by the network protocol before it routes a datagram that was received from the upper layer. More...

Protected Member Functions
void	initialize () override
void	finish () override
void	sendBackError (IPv4Datagram *dgram)

Protected Attributes
IPv4 *	ipLayer
SCTPNatTable *	natTable
IRoutingTable *	rt
IInterfaceTable *	ift
uint64	nattedPackets

Additional Inherited Members
Private Types inherited from inet::INetfilter::IHook
enum	Type {   PREROUTING, LOCALIN, FORWARD, POSTROUTING,   LOCALOUT }
enum	Result { ACCEPT, DROP, QUEUE, STOLEN }
Private Member Functions inherited from inet::INetfilter::IHook
virtual	~IHook ()

Constructor & Destructor Documentation

inet::sctp::SCTPNatHook::SCTPNatHook

(

)

{
    ipLayer = nullptr;
    natTable = nullptr;
    rt = nullptr;
    ift = nullptr;
    nattedPackets = 0;
}

inet::sctp::SCTPNatHook::~SCTPNatHook ( )

virtual

{
    ipLayer = check_and_cast_nullable<IPv4 *>(getModuleByPath(par("networkProtocolModule")));
    if (ipLayer)
        ipLayer->unregisterHook(0, this);
}

Member Function Documentation

INetfilter::IHook::Result inet::sctp::SCTPNatHook::datagramForwardHook ( INetworkDatagram *  datagram, const InterfaceEntry *  inputInterfaceEntry, const InterfaceEntry *&  outputInterfaceEntry, L3Address &  nextHopAddress  )

overridevirtual

This is the second hook called by the network protocol before it sends a datagram to the lower layer.

This is done after the datagramPreRoutingHook or the datagramLocalInHook is called and the datagram is routed.

Implements inet::INetfilter::IHook.

{
    SCTPNatEntry *entry;
    SCTPChunk *chunk;
    IPv4Datagram *dgram;

    dgram = dynamic_cast<IPv4Datagram *>(datagram);
    if (!dgram) {
        return INetfilter::IHook::ACCEPT;
    }
    if (SCTPAssociation::getAddressLevel(dgram->getSrcAddress()) != 3) {
        return INetfilter::IHook::ACCEPT;
    }
    natTable->printNatTable();
    SCTPMessage *sctpMsg = check_and_cast<SCTPMessage *>(dgram->getEncapsulatedPacket());
    unsigned int numberOfChunks = sctpMsg->getChunksArraySize();
    if (numberOfChunks == 1)
        chunk = (SCTPChunk *)(sctpMsg->peekFirstChunk());
    else
        chunk = (SCTPChunk *)(sctpMsg->peekLastChunk());
    EV << "findEntry for " << dgram->getSrcAddress() << ":" << sctpMsg->getSrcPort() << " to " << dgram->getDestAddress() << ":" << sctpMsg->getDestPort() << " vTag=" << sctpMsg->getTag() << " natAddr=" << outIE->ipv4Data()->getIPAddress() << "\n";
    if (chunk->getChunkType() == INIT || chunk->getChunkType() == INIT_ACK || chunk->getChunkType() == ASCONF) {
        entry = new SCTPNatEntry();
        entry->setLocalAddress(dgram->getSrcAddress());
        entry->setLocalPort(sctpMsg->getSrcPort());
        entry->setGlobalAddress(dgram->getDestAddress());
        entry->setGlobalPort(sctpMsg->getDestPort());
        entry->setNattedAddress(outIE->ipv4Data()->getIPAddress());
        entry->setNattedPort(sctpMsg->getSrcPort());
        entry->setGlobalVTag(sctpMsg->getTag());
        if (chunk->getChunkType() == INIT) {
            SCTPInitChunk *initChunk = check_and_cast<SCTPInitChunk *>(chunk);
            entry->setLocalVTag(initChunk->getInitTag());
        }
        else if (chunk->getChunkType() == INIT_ACK) {
            SCTPInitAckChunk *initAckChunk = check_and_cast<SCTPInitAckChunk *>(chunk);
            entry->setLocalVTag(initAckChunk->getInitTag());
        }
        else if (chunk->getChunkType() == ASCONF) {
            SCTPAsconfChunk *asconfChunk = check_and_cast<SCTPAsconfChunk *>(chunk);
            entry->setLocalVTag(asconfChunk->getPeerVTag());
        }
        dgram->setSrcAddress(outIE->ipv4Data()->getIPAddress());
        sctpMsg->setSrcPort(entry->getNattedPort());
        natTable->natEntries.push_back(entry);
    }
    else {
        EV << "other chunkType: " << (chunk->getChunkType() == COOKIE_ECHO ? "Cookie_Echo" : "other") << ", VTag=" << sctpMsg->getTag() << "\n";
        entry = natTable->findNatEntry(dgram->getSrcAddress(), sctpMsg->getSrcPort(), dgram->getDestAddress(), sctpMsg->getDestPort(), sctpMsg->getTag());
        if (entry == nullptr) {
            EV << "no entry found\n";
            entry = natTable->findNatEntry(dgram->getSrcAddress(), sctpMsg->getSrcPort(), dgram->getDestAddress(), sctpMsg->getDestPort(), 0);
            if (entry == nullptr) {
                EV << "send back error message dgram=" << dgram << "\n";
                sendBackError(dgram);
                nextHopAddr = dgram->getDestAddress();
                const InterfaceEntry *tmpIE = inIE;
                inIE = outIE;
                outIE = tmpIE;
                return INetfilter::IHook::ACCEPT;
            }
            else {
                EV << "VTag doesn't match: old VTag=" << entry->getLocalVTag() << ", new VTag=" << sctpMsg->getTag() << "\n";
                entry->setLocalVTag(sctpMsg->getTag());
                dgram->setSrcAddress(outIE->ipv4Data()->getIPAddress());
                sctpMsg->setSrcPort(entry->getNattedPort());
                EV << "srcAddress set to " << dgram->getSrcAddress() << ", srcPort set to " << sctpMsg->getSrcPort() << "\n";
            }
        }
        else {
            dgram->setSrcAddress(outIE->ipv4Data()->getIPAddress());
            sctpMsg->setSrcPort(entry->getNattedPort());
            EV << "srcAddress set to " << dgram->getSrcAddress() << ", srcPort set to " << sctpMsg->getSrcPort() << "\n";
        }
    }
    nattedPackets++;
    return INetfilter::IHook::ACCEPT;
}

INetfilter::IHook::Result inet::sctp::SCTPNatHook::datagramLocalInHook ( INetworkDatagram *  datagram, const InterfaceEntry *  inputInterfaceEntry  )

overridevirtual

This is the last hook called by the network protocol before it sends a datagram to the upper layer.

This is done after the datagramPreRoutingHook is called and the datagram is routed.

Implements inet::INetfilter::IHook.

{
    return INetfilter::IHook::ACCEPT;
}

INetfilter::IHook::Result inet::sctp::SCTPNatHook::datagramLocalOutHook ( INetworkDatagram *  datagram, const InterfaceEntry *&  outputInterfaceEntry, L3Address &  nextHopAddress  )

overridevirtual

This is the first hook called by the network protocol before it routes a datagram that was received from the upper layer.

The nextHopAddress is ignored when the outputInterfaceEntry is a nullptr. After this is done

Implements inet::INetfilter::IHook.

{
    return INetfilter::IHook::ACCEPT;
}

INetfilter::IHook::Result inet::sctp::SCTPNatHook::datagramPostRoutingHook ( INetworkDatagram *  datagram, const InterfaceEntry *  inputInterfaceEntry, const InterfaceEntry *&  outputInterfaceEntry, L3Address &  nextHopAddress  )

overridevirtual

This is the last hook called by the network protocol before it sends a datagram to the lower layer.

Implements inet::INetfilter::IHook.

{
    return INetfilter::IHook::ACCEPT;
}

INetfilter::IHook::Result inet::sctp::SCTPNatHook::datagramPreRoutingHook ( INetworkDatagram *  datagram, const InterfaceEntry *  inputInterfaceEntry, const InterfaceEntry *&  outputInterfaceEntry, L3Address &  nextHopAddress  )

overridevirtual

This is the first hook called by the network protocol before it routes a datagram that was received from the lower layer.

The nextHopAddress is ignored when the outputInterfaceEntry is nullptr.

Implements inet::INetfilter::IHook.

{
    SCTPNatEntry *entry;
    SCTPChunk *chunk;
    IPv4Datagram *dgram;

    dgram = check_and_cast<IPv4Datagram *>(datagram);
    if (SCTPAssociation::getAddressLevel(dgram->getSrcAddress()) == 3) {
        return INetfilter::IHook::ACCEPT;
    }
    natTable->printNatTable();
    bool local = ((rt->isLocalAddress(dgram->getDestAddress())) && (SCTPAssociation::getAddressLevel(dgram->getSrcAddress()) == 3));
    SCTPMessage *sctpMsg = check_and_cast<SCTPMessage *>(dgram->getEncapsulatedPacket());
    unsigned int numberOfChunks = sctpMsg->getChunksArraySize();
    if (numberOfChunks == 1)
        chunk = (SCTPChunk *)(sctpMsg->peekFirstChunk());
    else
        chunk = (SCTPChunk *)(sctpMsg->peekLastChunk());
    if (!local) {
        entry = natTable->getEntry(dgram->getSrcAddress(), sctpMsg->getSrcPort(), dgram->getDestAddress(), sctpMsg->getDestPort(), sctpMsg->getTag());
        EV << "getEntry for " << dgram->getSrcAddress() << ":" << sctpMsg->getSrcPort() << " to " << dgram->getDestAddress() << ":" << sctpMsg->getDestPort() << " peerVTag=" << sctpMsg->getTag() << "\n";
        uint32 numberOfChunks = sctpMsg->getChunksArraySize();
        if (entry == nullptr) {
            EV << "no entry found\n";
            if (numberOfChunks == 1)
                chunk = (SCTPChunk *)(sctpMsg->peekFirstChunk());
            else
                chunk = (SCTPChunk *)(sctpMsg->peekLastChunk());
            if (chunk->getChunkType() == INIT || chunk->getChunkType() == ASCONF) {
                EV << "could be an Init collision\n";
                entry = natTable->getSpecialEntry(dgram->getSrcAddress(), sctpMsg->getSrcPort(), dgram->getDestAddress(), sctpMsg->getDestPort());
                if (entry != nullptr) {
                    if (chunk->getChunkType() == INIT) {
                        SCTPInitChunk *initChunk = check_and_cast<SCTPInitChunk *>(chunk);
                        entry->setLocalVTag(initChunk->getInitTag());
                        EV << "InitTag=" << initChunk->getInitTag() << "\n";
                    }
                    else if (chunk->getChunkType() == ASCONF) {
                        SCTPAsconfChunk *asconfChunk = check_and_cast<SCTPAsconfChunk *>(chunk);
                        entry->setLocalVTag(asconfChunk->getPeerVTag());
                    }
                    dgram->setDestAddress(entry->getLocalAddress().toIPv4());
                    sctpMsg->setDestPort(entry->getLocalPort());
                    EV << "destAddress set to " << dgram->getDestAddress() << ", destPort set to " << sctpMsg->getDestPort() << "\n";
                }
                else {
                    return INetfilter::IHook::DROP;
                }
            }
            else {
                SCTPChunk *schunk;
                if (numberOfChunks > 0) {
                    EV << "number of chunks=" << numberOfChunks << "\n";
                    for (uint32 i = 0; i < numberOfChunks; i++) {
                        schunk = (SCTPChunk *)(sctpMsg->removeChunk());
                        if (schunk->getChunkType() == DATA)
                            delete (SCTPSimpleMessage *)schunk->decapsulate();
                        EV << "delete chunk " << schunk->getName() << "\n";
                        delete schunk;
                    }
                }
                return INetfilter::IHook::DROP;
            }
        }
        else {
            dgram->setDestAddress(entry->getLocalAddress().toIPv4());
            sctpMsg->setDestPort(entry->getLocalPort());
            if (entry->getGlobalVTag() == 0 && chunk->getChunkType() == INIT_ACK) {
                SCTPInitAckChunk *initAckChunk = check_and_cast<SCTPInitAckChunk *>(chunk);
                entry->setGlobalVTag(initAckChunk->getInitTag());
            }
            EV << "destAddress set to " << dgram->getDestAddress() << ", destPort set to " << sctpMsg->getDestPort() << "\n";
        }
    }
    else {
        if (chunk->getChunkType() == INIT) {
            EV << "getLocALEntry for " << dgram->getSrcAddress() << ":" << sctpMsg->getSrcPort() << " to " << dgram->getDestAddress() << ":" << sctpMsg->getDestPort() << " peerVTag=" << sctpMsg->getTag() << "\n";
            entry = natTable->getLocalInitEntry(dgram->getDestAddress(), sctpMsg->getSrcPort(), sctpMsg->getDestPort());
            if (entry == nullptr) {
                entry = new SCTPNatEntry();
                entry->setLocalAddress(dgram->getSrcAddress());
                entry->setLocalPort(sctpMsg->getSrcPort());
                entry->setGlobalAddress(dgram->getDestAddress());
                entry->setGlobalPort(sctpMsg->getDestPort());
                entry->setNattedPort(sctpMsg->getSrcPort());
                entry->setNattedAddress(dgram->getDestAddress());
                SCTPInitChunk *initChunk = check_and_cast<SCTPInitChunk *>(chunk);
                entry->setGlobalVTag(initChunk->getInitTag());
                natTable->natEntries.push_back(entry);
                EV << "added entry for local deliver\n";
                natTable->printNatTable();
                return INetfilter::IHook::DROP;
            }
            else {
                SCTPNatEntry *entry2 = new SCTPNatEntry();
                entry2->setLocalAddress(dgram->getSrcAddress());
                entry2->setLocalPort(sctpMsg->getSrcPort());
                entry2->setGlobalAddress(entry->getGlobalAddress());
                entry2->setGlobalPort(sctpMsg->getDestPort());
                entry2->setNattedPort(sctpMsg->getSrcPort());
                entry2->setNattedAddress(entry->getGlobalAddress());
                SCTPInitChunk *initChunk = check_and_cast<SCTPInitChunk *>(chunk);
                entry2->setGlobalVTag(initChunk->getInitTag());
                natTable->natEntries.push_back(entry2);
                dgram->setDestAddress(entry->getLocalAddress().toIPv4());
                sctpMsg->setDestPort(entry->getLocalPort());
                dgram->setSrcAddress(entry->getGlobalAddress().toIPv4());
                sctpMsg->setSrcPort(entry->getGlobalPort());
                EV << "added additional entry for local deliver\n";
                natTable->printNatTable();
                EV << "destAddress set to " << dgram->getDestAddress() << ", destPort set to " << sctpMsg->getDestPort() << "\n";
            }
        }
        else {
            EV << "no INIT: destAddr=" << dgram->getDestAddress() << " destPort=" << sctpMsg->getDestPort() << " srcPort=" << sctpMsg->getSrcPort() << " vTag=" << sctpMsg->getTag() << "\n";
            entry = natTable->getLocalEntry(dgram->getDestAddress(), sctpMsg->getSrcPort(), sctpMsg->getDestPort(), sctpMsg->getTag());
            if (entry != nullptr) {
                dgram->setDestAddress(entry->getLocalAddress().toIPv4());
                sctpMsg->setDestPort(entry->getLocalPort());
                dgram->setSrcAddress(entry->getGlobalAddress().toIPv4());
                sctpMsg->setSrcPort(entry->getGlobalPort());
            }
            else {
                EV << "no entry found\n";
                return INetfilter::IHook::DROP;
            }
        }
    }
    nattedPackets++;
    return INetfilter::IHook::ACCEPT;
}

void inet::sctp::SCTPNatHook::finish ( )

overrideprotected

{
    if (ipLayer)
        ipLayer->unregisterHook(0, this);
    ipLayer = nullptr;
    EV_INFO<< getFullPath() << ": Natted packets: " << nattedPackets << "\n";
}

void inet::sctp::SCTPNatHook::initialize ( )

overrideprotected

{
    rt = getModuleFromPar<IRoutingTable>(par("routingTableModule"), this);
    ift = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
    ipLayer = getModuleFromPar<IPv4>(par("networkProtocolModule"), this);
    natTable = getModuleFromPar<SCTPNatTable>(par("natTableModule"), this);

    ipLayer->registerHook(0, this);
}

void inet::sctp::SCTPNatHook::sendBackError ( IPv4Datagram *  dgram )

protected

Referenced by datagramForwardHook().

{
    SCTPMessage *sctpmsg = new SCTPMessage();
    sctpmsg->setByteLength(SCTP_COMMON_HEADER);
    SCTPErrorChunk *errorChunk = new SCTPErrorChunk("NatError");
    errorChunk->setChunkType(ERRORTYPE);
    errorChunk->setByteLength(4);
    SCTPSimpleErrorCauseParameter *cause = new SCTPSimpleErrorCauseParameter("Cause");
    cause->setParameterType(MISSING_NAT_ENTRY);
    cause->setByteLength(4);
    cause->encapsulate(dgram->dup());
    errorChunk->setMBit(true);
    errorChunk->setTBit(true);
    errorChunk->addParameters(cause);
    sctpmsg->addChunk(errorChunk);

    SCTPMessage *oldmsg = check_and_cast<SCTPMessage *>(dgram->decapsulate());
    sctpmsg->setSrcPort(oldmsg->getDestPort());
    sctpmsg->setDestPort(oldmsg->getSrcPort());
    sctpmsg->setTag(oldmsg->getTag());
    sctpmsg->setChecksumOk(true);
    dgram->removeControlInfo();
    dgram->setName(sctpmsg->getName());
    dgram->setByteLength(IP_HEADER_BYTES);
    dgram->encapsulate(sctpmsg);
    IPv4Address tmpaddr = dgram->getDestAddress();
    dgram->setDestAddress(dgram->getSrcAddress());
    if (!tmpaddr.isUnspecified())
        dgram->setSrcAddress(tmpaddr);
    dgram->setTransportProtocol(IP_PROT_SCTP);
    delete oldmsg;
}

Member Data Documentation

IInterfaceTable* inet::sctp::SCTPNatHook::ift

protected

Referenced by initialize(), and SCTPNatHook().

IPv4* inet::sctp::SCTPNatHook::ipLayer

protected

Referenced by finish(), initialize(), SCTPNatHook(), and ~SCTPNatHook().

SCTPNatTable* inet::sctp::SCTPNatHook::natTable

protected

Referenced by datagramForwardHook(), datagramPreRoutingHook(), initialize(), and SCTPNatHook().

uint64 inet::sctp::SCTPNatHook::nattedPackets

protected

Referenced by datagramForwardHook(), datagramPreRoutingHook(), finish(), and SCTPNatHook().

IRoutingTable* inet::sctp::SCTPNatHook::rt

protected

Referenced by datagramPreRoutingHook(), initialize(), and SCTPNatHook().

---

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

• SCTPNatHook.h
• SCTPNatHook.cc