GtpLayer.h

Go to the documentation of this file.

#pragma once
 
#include "Layer.h"
#include "TLVData.h"
#include <vector>
#include <bitset>
 
 
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)
    static_assert(sizeof(gtpv1_header) == 8, "gtpv1_header size is not 8 bytes");
 
    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
 
        ~GtpV1Layer() override = default;
 
        GtpV1Layer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)
            : Layer(data, dataLen, prevLayer, packet, 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 reinterpret_cast<gtpv1_header*>(m_Data);
        }
 
        bool getSequenceNumber(uint16_t& seqNumber) const;
 
        bool setSequenceNumber(uint16_t seqNumber);
 
        bool getNpduNumber(uint8_t& npduNum) const;
 
        bool setNpduNumber(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() override;
 
        size_t getHeaderLen() const override;
 
        void computeCalculateFields() override;
 
        std::string toString() const override;
 
        OsiModelLayer getOsiModelLayer() const override
        {
            return OsiModelTransportLayer;
        }
 
        struct SerializedFields : Layer::SerializedFields
        {
            static std::vector<FieldDescriptor> all()
            {
                auto result = Layer::SerializedFields::all();
                std::initializer_list<FieldDescriptor> extra{ Version,         ProtocolType,  MessageType,
                                                              MessageTypeName, MessageLength, Teid,
                                                              SequenceNumber,  NpduNumber,    Extensions };
                std::copy(extra.begin(), extra.end(), std::back_inserter(result));
                return result;
            }
 
            static const FieldDescriptor Version;
            static const FieldDescriptor ProtocolType;
            static const FieldDescriptor MessageType;
            static const FieldDescriptor MessageTypeName;
            static const FieldDescriptor MessageLength;
            static const FieldDescriptor Teid;
            static const FieldDescriptor SequenceNumber;
            static const FieldDescriptor NpduNumber;
            static const FieldDescriptor Extensions;
            static const FieldDescriptor Extension;
        };
 
    protected:
        void serializeLayer(ObjectScope& serializer) const override;
    };
 
    class GtpV2MessageType
    {
    public:
        enum Value : uint8_t
        {
            Unknown = 0,
            EchoRequest = 1,
            EchoResponse = 2,
            VersionNotSupported = 3,
            CreateSessionRequest = 32,
            CreateSessionResponse = 33,
            ModifyBearerRequest = 34,
            ModifyBearerResponse = 35,
            DeleteSessionRequest = 36,
            DeleteSessionResponse = 37,
            ChangeNotificationRequest = 38,
            ChangeNotificationResponse = 39,
            RemoteUEReportNotifications = 40,
            RemoteUEReportAcknowledge = 41,
            ModifyBearerCommand = 64,
            ModifyBearerFailure = 65,
            DeleteBearerCommand = 66,
            DeleteBearerFailure = 67,
            BearerResourceCommand = 68,
            BearerResourceFailure = 69,
            DownlinkDataNotificationFailure = 70,
            TraceSessionActivation = 71,
            TraceSessionDeactivation = 72,
            StopPagingIndication = 73,
            CreateBearerRequest = 95,
            CreateBearerResponse = 96,
            UpdateBearerRequest = 97,
            UpdateBearerResponse = 98,
            DeleteBearerRequest = 99,
            DeleteBearerResponse = 100,
            DeletePDNRequest = 101,
            DeletePDNResponse = 102,
            PGWDownlinkNotification = 103,
            PGWDownlinkAcknowledge = 104,
            IdentificationRequest = 128,
            IdentificationResponse = 129,
            ContextRequest = 130,
            ContextResponse = 131,
            ContextAcknowledge = 132,
            ForwardRelocationRequest = 133,
            ForwardRelocationResponse = 134,
            ForwardRelocationNotification = 135,
            ForwardRelocationAcknowledge = 136,
            ForwardAccessNotification = 137,
            ForwardAccessAcknowledge = 138,
            RelocationCancelRequest = 139,
            RelocationCancelResponse = 140,
            ConfigurationTransferTunnel = 141,
            DetachNotification = 149,
            DetachAcknowledge = 150,
            CSPaging = 151,
            RANInformationRelay = 152,
            AlertMMENotification = 153,
            AlertMMEAcknowledge = 154,
            UEActivityNotification = 155,
            UEActivityAcknowledge = 156,
            ISRStatus = 157,
            CreateForwardingRequest = 160,
            CreateForwardingResponse = 161,
            SuspendNotification = 162,
            SuspendAcknowledge = 163,
            ResumeNotification = 164,
            ResumeAcknowledge = 165,
            CreateIndirectDataTunnelRequest = 166,
            CreateIndirectDataTunnelResponse = 167,
            DeleteIndirectDataTunnelRequest = 168,
            DeleteIndirectDataTunnelResponse = 169,
            ReleaseAccessBearersRequest = 170,
            ReleaseAccessBearersResponse = 171,
            DownlinkDataNotification = 176,
            DownlinkDataAcknowledge = 177,
            PGWRestartNotification = 179,
            PGWRestartAcknowledge = 180,
            UpdatePDNConnectionRequest = 200,
            UpdatePDNConnectionResponse = 201,
            ModifyAccessBearersRequest = 211,
            ModifyAccessBearersResponse = 212,
            MMBSSessionStartRequest = 231,
            MMBSSessionStartResponse = 232,
            MMBSSessionUpdateRequest = 233,
            MMBSSessionUpdateResponse = 234,
            MMBSSessionStopRequest = 235,
            MMBSSessionStopResponse = 236
        };
 
        GtpV2MessageType() = default;
 
        // cppcheck-suppress noExplicitConstructor
        constexpr GtpV2MessageType(Value value) : m_Value(value)
        {}
 
        std::string toString() const;
 
        static GtpV2MessageType fromUintValue(uint8_t value);
 
        // Allow switch and comparisons.
        constexpr operator Value() const
        {
            return m_Value;
        }
 
        // Prevent usage: if(GtpV2MessageType)
        explicit operator bool() const = delete;
 
    private:
        Value m_Value = GtpV2MessageType::Unknown;
    };
 
    class GtpV2InformationElement : public TLVRecord<uint8_t, uint16_t>
    {
    public:
        enum class Type : uint8_t
        {
            Unknown = 0,
            Imsi = 1,
            Cause = 2,
            Recovery = 3,
            StnSr = 51,
            Apn = 71,
            Ambr = 72,
            Ebi = 73,
            IpAddress = 74,
            Mei = 75,
            Msisdn = 76,
            Indication = 77,
            Pco = 78,
            Paa = 79,
            BearerQos = 80,
            FlowQos = 81,
            RatType = 82,
            ServingNetwork = 83,
            BearerTft = 84,
            Tad = 85,
            Uli = 86,
            FTeid = 87,
            Tmsi = 88,
            GlobalCnId = 89,
            S103PdnDataForwardingInfo = 90,
            S1UDataForwardingInfo = 91,
            DelayValue = 92,
            BearerContext = 93,
            ChargingId = 94,
            ChargingCharacteristics = 95,
            TraceInformation = 96,
            BearerFlags = 97,
            PdnType = 99,
            Pti = 100,
            MmContext1 = 103,
            MmContext2 = 104,
            MmContext3 = 105,
            MmContext4 = 106,
            MmContext5 = 107,
            MmContext6 = 108,
            PdnConnection = 109,
            PduNumbers = 110,
            PTmsi = 111,
            PTmsiSignature = 112,
            HopCounter = 113,
            UeTimeZone = 114,
            TraceReference = 115,
            CompleteRequestMessage = 116,
            Guti = 117,
            FContainer = 118,
            FCause = 119,
            PlmnId = 120,
            TargetIdentification = 121,
            PacketFlowId = 123,
            RabContext = 124,
            SourceRncPdcpContextInfo = 125,
            PortNumber = 126,
            ApnRestriction = 127,
            SelectionMode = 128,
            SourceIdentification = 129,
            ChangeReportingAction = 131,
            FqCsid = 132,
            ChannelNeeded = 133,
            EmlppPriority = 134,
            NodeType = 135,
            Fqdn = 136,
            Ti = 137,
            MbmsSessionDuration = 138,
            MbmsServiceArea = 139,
            MbmsSessionIdentifier = 140,
            MbmsFlowIdentifier = 141,
            MbmsIpMulticastDistribution = 142,
            MbmsDistributionAcknowledge = 143,
            RfspIndex = 144,
            Uci = 145,
            CsgInformationReportingAction = 146,
            CsgId = 147,
            Cmi = 148,
            ServiceIndicator = 149,
            DetachType = 150,
            Ldn = 151,
            NodeFeatures = 152,
            MbmsTimeToDataTransfer = 153,
            Throttling = 154,
            Arp = 155,
            EpcTimer = 156,
            SignallingPriorityIndication = 157,
            Tmgi = 158,
            AdditionalMmContextForSrvcc = 159,
            AdditionalFlagsForSrvcc = 160,
            MdtConfiguration = 162,
            Apco = 163,
            AbsoluteTimeOfMbmsDataTransfer = 164,
            HenbInformationReporting = 165,
            Ipv4ConfigurationParameters = 166,
            ChangeToReportFlags = 167,
            ActionIndication = 168,
            TwanIdentifier = 169,
            UliTimestamp = 170,
            MbmsFlags = 171,
            RanNasCause = 172,
            CnOperatorSelectionEntity = 173,
            Twmi = 174,
            NodeNumber = 175,
            NodeIdentifier = 176,
            PresenceReportingAreaAction = 177,
            PresenceReportingAreaInformation = 178,
            TwanIdentifierTimestamp = 179,
            OverloadControlInformation = 180,
            LoadControlInformation = 181,
            Metric = 182,
            SequenceNumber = 183,
            ApnAndRelativeCapacity = 184,
            WlanOffloadabilityIndication = 185,
            PagingAndServiceInformation = 186,
            IntegerNumber = 187,
            MillisecondTimeStamp = 188,
            MonitoringEventInformation = 189,
            EcgiList = 190,
            RemoteUeContext = 191,
            RemoteUserId = 192,
            RemoteUeIpInformation = 193,
            CiotOptimizationsSupportIndication = 194,
            ScefPdnConnection = 195,
            HeaderCompressionConfiguration = 196,
            ExtendedPco = 197,
            ServingPlmnRateControl = 198,
            Counter = 199,
            MappedUeUsageType = 200,
            SecondaryRatUsageDataReport = 201,
            UpFunctionSelectionIndicationFlags = 202,
            MaximumPacketLossRate = 203,
            ApnRateControlStatus = 204,
            ExtendedTraceInformation = 205,
            MonitoringEventExtensionInformation = 206,
            AdditionalRrmPolicyIndex = 207,
            V2xContext = 208,
            Pc5QosParameters = 209,
            ServicesAuthorized = 210,
            BitRate = 211,
            Pc5QosFlow = 212,
            SgiPtpTunnelAddress = 213
        };
 
        explicit GtpV2InformationElement(uint8_t* infoElementRawData) : TLVRecord(infoElementRawData)
        {}
 
        ~GtpV2InformationElement() override = default;
 
        GtpV2InformationElement::Type getIEType();
 
        uint8_t getCRFlag();
 
        uint8_t getInstance();
 
        // implement abstract methods
 
        size_t getValueOffset() const override
        {
            return sizeof(uint8_t);
        }
 
        size_t getTotalSize() const override;
 
        size_t getDataSize() const override;
    };
 
    class GtpV2InformationElementBuilder : public TLVRecordBuilder
    {
    public:
        GtpV2InformationElementBuilder(GtpV2InformationElement::Type infoElementType, const std::bitset<4>& crFlag,
                                       const std::bitset<4>& instance, const std::vector<uint8_t>& infoElementValue);
 
        GtpV2InformationElement build() const;
 
    private:
        std::bitset<4> m_CRFlag;
        std::bitset<4> m_Instance;
    };
 
    class GtpV2Layer : public Layer
    {
    public:
        ~GtpV2Layer() override = default;
 
        GtpV2Layer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)
            : Layer(data, dataLen, prevLayer, packet, GTPv2)
        {}
 
        GtpV2Layer(GtpV2MessageType messageType, uint32_t sequenceNumber, bool setTeid = false, uint32_t teid = 0,
                   bool setMessagePriority = false, std::bitset<4> messagePriority = 0);
 
        static bool isGTPv2Port(uint16_t port)
        {
            return port == 2123;
        }
 
        static bool isDataValid(const uint8_t* data, size_t dataSize);
 
        GtpV2MessageType getMessageType() const;
 
        void setMessageType(const GtpV2MessageType& type);
 
        uint16_t getMessageLength() const;
 
        bool isPiggybacking() const;
 
        std::pair<bool, uint32_t> getTeid() const;
 
        void setTeid(uint32_t teid);
 
        void unsetTeid();
 
        uint32_t getSequenceNumber() const;
 
        void setSequenceNumber(uint32_t sequenceNumber);
 
        std::pair<bool, uint8_t> getMessagePriority() const;
 
        void setMessagePriority(const std::bitset<4>& messagePriority);
 
        void unsetMessagePriority();
 
        GtpV2InformationElement getFirstInformationElement() const;
 
        GtpV2InformationElement getNextInformationElement(GtpV2InformationElement infoElement) const;
 
        GtpV2InformationElement getInformationElement(GtpV2InformationElement::Type infoElementType) const;
 
        size_t getInformationElementCount() const;
 
        GtpV2InformationElement addInformationElement(const GtpV2InformationElementBuilder& infoElementBuilder);
 
        GtpV2InformationElement addInformationElementAfter(const GtpV2InformationElementBuilder& infoElementBuilder,
                                                           GtpV2InformationElement::Type infoElementType);
 
        bool removeInformationElement(GtpV2InformationElement::Type infoElementType);
 
        bool removeAllInformationElements();
 
        // implement abstract methods
 
        void parseNextLayer() override;
 
        size_t getHeaderLen() const override;
 
        void computeCalculateFields() override;
 
        std::string toString() const override;
 
        OsiModelLayer getOsiModelLayer() const override
        {
            return OsiModelTransportLayer;
        }
 
        struct SerializedFields : Layer::SerializedFields
        {
            static std::vector<FieldDescriptor> all()
            {
                auto result = Layer::SerializedFields::all();
                std::initializer_list<FieldDescriptor> extra{
                    MessageType, MessageTypeName, MessageLength,   Piggybacking,
                    Teid,        SequenceNumber,  MessagePriority, InformationElements
                };
                std::copy(extra.begin(), extra.end(), std::back_inserter(result));
                return result;
            }
 
            static const FieldDescriptor MessageType;
            static const FieldDescriptor MessageTypeName;
            static const FieldDescriptor MessageLength;
            static const FieldDescriptor Piggybacking;
            static const FieldDescriptor Teid;
            static const FieldDescriptor SequenceNumber;
            static const FieldDescriptor MessagePriority;
            static const FieldDescriptor InformationElements;
            static const FieldDescriptor InformationElement;
        };
 
    protected:
        void serializeLayer(ObjectScope& serializer) const override;
 
    private:
#pragma pack(push, 1)
        struct gtpv2_basic_header
        {
#if (BYTE_ORDER == LITTLE_ENDIAN)
            uint8_t unused : 2, messagePriorityPresent : 1, teidPresent : 1, piggybacking : 1, version : 3;
#else
            uint8_t version : 3, piggybacking : 1, teidPresent : 1, messagePriorityPresent : 1, unused : 2;
#endif
            uint8_t messageType;
            uint16_t messageLength;
        };
#pragma pack(pop)
 
        TLVRecordReader<GtpV2InformationElement> m_IEReader;
 
        gtpv2_basic_header* getHeader() const
        {
            return reinterpret_cast<gtpv2_basic_header*>(m_Data);
        }
 
        uint8_t* getIEBasePtr() const;
 
        size_t getIEDataLen(const uint8_t* basePtr) const;
 
        GtpV2InformationElement addInformationElementAt(const GtpV2InformationElementBuilder& infoElementBuilder,
                                                        int offset);
    };
}  // namespace pcpp