GtpLayer.h

Go to the documentation of this file.

#ifndef PACKETPP_GTP_LAYER
#define PACKETPP_GTP_LAYER

#include "Layer.h"



namespace pcpp
{

#pragma pack(push, 1)

    struct gtpv1_header
    {
#if (BYTE_ORDER == LITTLE_ENDIAN)

        uint8_t npduNumberFlag:1,
        sequenceNumberFlag:1,
        extensionHeaderFlag:1,
        reserved:1,
        protocolType:1,
        version:3;
#else

        uint8_t version:3,
        protocolType:1,
        reserved:1,
        extensionHeaderFlag:1,
        sequenceNumberFlag:1,
        npduNumberFlag:1;
#endif

        uint8_t messageType;

        uint16_t messageLength;

        uint32_t teid;
    };

#pragma pack(pop)

    enum GtpV1MessageType
    {
        GtpV1_MessageTypeUnknown = 0,
        GtpV1_EchoRequest = 1,
        GtpV1_EchoResponse = 2,
        GtpV1_VersionNotSupported = 3,
        GtpV1_NodeAliveRequest = 4,
        GtpV1_NodeAliveResponse = 5,
        GtpV1_RedirectionRequest = 6,
        GtpV1_CreatePDPContextRequest = 7,
        GtpV1_CreatePDPContextResponse = 16,
        GtpV1_UpdatePDPContextRequest = 17,
        GtpV1_UpdatePDPContextResponse = 18,
        GtpV1_DeletePDPContextRequest = 19,
        GtpV1_DeletePDPContextResponse = 20,
        GtpV1_InitiatePDPContextActivationRequest = 22,
        GtpV1_InitiatePDPContextActivationResponse = 23,
        GtpV1_ErrorIndication = 26,
        GtpV1_PDUNotificationRequest = 27,
        GtpV1_PDUNotificationResponse = 28,
        GtpV1_PDUNotificationRejectRequest = 29,
        GtpV1_PDUNotificationRejectResponse = 30,
        GtpV1_SupportedExtensionsHeaderNotification = 31,
        GtpV1_SendRoutingforGPRSRequest = 32,
        GtpV1_SendRoutingforGPRSResponse = 33,
        GtpV1_FailureReportRequest = 34,
        GtpV1_FailureReportResponse = 35,
        GtpV1_NoteMSPresentRequest = 36,
        GtpV1_NoteMSPresentResponse = 37,
        GtpV1_IdentificationRequest = 38,
        GtpV1_IdentificationResponse = 39,
        GtpV1_SGSNContextRequest = 50,
        GtpV1_SGSNContextResponse = 51,
        GtpV1_SGSNContextAcknowledge = 52,
        GtpV1_ForwardRelocationRequest = 53,
        GtpV1_ForwardRelocationResponse = 54,
        GtpV1_ForwardRelocationComplete = 55,
        GtpV1_RelocationCancelRequest = 56,
        GtpV1_RelocationCancelResponse = 57,
        GtpV1_ForwardSRNSContext = 58,
        GtpV1_ForwardRelocationCompleteAcknowledge = 59,
        GtpV1_ForwardSRNSContextAcknowledge = 60,
        GtpV1_UERegistrationRequest = 61,
        GtpV1_UERegistrationResponse = 62,
        GtpV1_RANInformationRelay = 70,
        GtpV1_MBMSNotificationRequest = 96,
        GtpV1_MBMSNotificationResponse = 97,
        GtpV1_MBMSNotificationRejectRequest = 98,
        GtpV1_MBMSNotificationRejectResponse = 99,
        GtpV1_CreateMBMSNotificationRequest = 100,
        GtpV1_CreateMBMSNotificationResponse = 101,
        GtpV1_UpdateMBMSNotificationRequest = 102,
        GtpV1_UpdateMBMSNotificationResponse = 103,
        GtpV1_DeleteMBMSNotificationRequest = 104,
        GtpV1_DeleteMBMSNotificationResponse = 105,
        GtpV1_MBMSRegistrationRequest = 112,
        GtpV1_MBMSRegistrationResponse = 113,
        GtpV1_MBMSDeRegistrationRequest = 114,
        GtpV1_MBMSDeRegistrationResponse = 115,
        GtpV1_MBMSSessionStartRequest = 116,
        GtpV1_MBMSSessionStartResponse = 117,
        GtpV1_MBMSSessionStopRequest = 118,
        GtpV1_MBMSSessionStopResponse = 119,
        GtpV1_MBMSSessionUpdateRequest = 120,
        GtpV1_MBMSSessionUpdateResponse = 121,
        GtpV1_MSInfoChangeRequest = 128,
        GtpV1_MSInfoChangeResponse = 129,
        GtpV1_DataRecordTransferRequest = 240,
        GtpV1_DataRecordTransferResponse = 241,
        GtpV1_EndMarker = 254,
        GtpV1_GPDU = 255
    };


    class GtpV1Layer : public Layer
    {
    private:
        struct gtpv1_header_extra
        {
            uint16_t sequenceNumber;
            uint8_t npduNumber;
            uint8_t nextExtensionHeader;
        };

        gtpv1_header_extra* getHeaderExtra() const;

        void init(GtpV1MessageType messageType, uint32_t teid, bool setSeqNum, uint16_t seqNum, bool setNpduNum, uint8_t npduNum);

    public:

        class GtpExtension
        {
            friend class GtpV1Layer;

        private:
            uint8_t* m_Data;
            size_t m_DataLen;
            uint8_t m_ExtType;

            GtpExtension(uint8_t* data, size_t dataLen, uint8_t type);

            void setNextHeaderType(uint8_t nextHeaderType);

            static GtpExtension createGtpExtension(uint8_t* data, size_t dataLen, uint8_t extType, uint16_t content);
            
        public:

            GtpExtension();

            GtpExtension(const GtpExtension& other);

            GtpExtension& operator=(const GtpExtension& other);

            bool isNull() const;

            uint8_t getExtensionType() const;

            size_t getTotalLength() const;

            size_t getContentLength() const;

            uint8_t* getContent() const;

            uint8_t getNextExtensionHeaderType() const;

            GtpExtension getNextExtension() const;
        }; // GtpExtension

        virtual ~GtpV1Layer() {}

        GtpV1Layer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet) : Layer(data, dataLen, prevLayer, packet) { m_Protocol = GTPv1; }

        GtpV1Layer(GtpV1MessageType messageType, uint32_t teid);

        GtpV1Layer(GtpV1MessageType messageType, uint32_t teid, bool setSeqNum, uint16_t seqNum, bool setNpduNum, uint8_t npduNum);

        static bool isGTPv1(const uint8_t* data, size_t dataSize);

        gtpv1_header* getHeader() const { return (gtpv1_header*)m_Data; }

        bool getSequenceNumber(uint16_t& seqNumber) const;

        bool setSequenceNumber(const uint16_t seqNumber);

        bool getNpduNumber(uint8_t& npduNum) const;

        bool setNpduNumber(const uint8_t npduNum);

        bool getNextExtensionHeaderType(uint8_t& nextExtType) const;

        GtpExtension getNextExtension() const;

        GtpExtension addExtension(uint8_t extensionType, uint16_t extensionContent);

        GtpV1MessageType getMessageType() const;

        std::string getMessageTypeAsString() const;

        bool isGTPUMessage() const;

        bool isGTPCMessage() const;

        static bool isGTPv1Port(uint16_t port) { return port == 2152 /* GTP-U */ || port == 2123 /* GTP-C */; }


        // implement abstract methods

        void parseNextLayer();

        size_t getHeaderLen() const;

        void computeCalculateFields();

        std::string toString() const;

        OsiModelLayer getOsiModelLayer() const { return OsiModelTransportLayer; }
    };
}

#endif //PACKETPP_GTP_LAYER