repositorypackage
0.0.17
Repository: https://github.com/tim-ywliu/go-pfcp.git
Documentation: pkg.go.dev
# README
go-pfcp
PFCP implementation in Golang.
What is PFCP?
PFCP(Packet Forwarding Control Protocol) is a signaling protocol used in mobile networking infrastructure(LTE EPC, 5GC) to realize CUPS architecture(Control and User Plane Separation, not a printing system) defined in 3GPP TS29.244.
Are you looking for a GTP implementation in Golang? go-gtp would be the right choice for you :P
Project Status
This project is still WIP.
Implementation of all the messages and IEs defined in TS29.244 V16.7.0(2021-04) has been done, but the exported APIs may still be updated in the future, as they are not tested enough (we add a new tag in that case).
We are now working on implementing networking functionalities (like setting up associations, establish sessions with easy & quick APIs), as well as updating the messages and IE definitions according to the latest specifications.
Getting Started
Installation
go-pfcp supports Go Modules. Just run go mod tidy in your project's directory to collect the required packages automatically.
go mod tidy
Running examples
Exchanging Heartbeat
Small heartbeat client and server examples are available under examples/heartheat. The client sends HeartbeatRequest, and the server responds with HeartbeatResponse.
- run server first,
By default, the server listens on loopback. It can be specified explicitly by the -s flag.
go-pfcp/examples/heartbeat/hb-server$ go run main.go
2019/12/22 20:03:31 waiting for messages to come on: 127.0.0.2:8805
- then run client,
By default, the client sends a Heartbeat to loopback. It can be specified explicitly by the -s flag.
It exits after printing the timestamp in Heartbeat Response from the server.
go-pfcp/examples/heartbeat/hb-client$ go run main.go
2019/12/22 20:03:36 sent Heartbeat Request to: 127.0.0.2:8805
2019/12/22 20:03:36 got Heartbeat Response with TS: 2019-12-22 20:03:36 +0900 JST, from: 127.0.0.2:8805
go-pfcp/examples/heartbeat/hb-client$
go-pfcp/examples/heartbeat/hb-client$ go run main.go
2019/12/22 20:03:40 sent Heartbeat Request to: 127.0.0.2:8805
2019/12/22 20:03:40 got Heartbeat Response with TS: 2019-12-22 20:03:40 +0900 JST, from: 127.0.0.2:8805
- and see the outcome on server
It starts listening again after responding to the client.
go-pfcp/examples/heartbeat/hb-server$ go run main.go
2019/12/22 20:03:31 waiting for messages to come on: 127.0.0.2:8805
2019/12/22 20:03:36 got Heartbeat Request with TS: 2019-12-22 20:03:36 +0900 JST, from: 127.0.0.1:47305
2019/12/22 20:03:36 sent Heartbeat Response to: 127.0.0.1:47305
2019/12/22 20:03:36 waiting for messages to come on: 127.0.0.2:8805
2019/12/22 20:03:40 got Heartbeat Request with TS: 2019-12-22 20:03:40 +0900 JST, from: 127.0.0.1:55395
2019/12/22 20:03:40 sent Heartbeat Response to: 127.0.0.1:55395
2019/12/22 20:03:40 waiting for messages to come on: 127.0.0.2:8805
^Csignal: interrupt
Supported Features
Messages
PFCP Node related messages
| Message Type | Message | Sxa | Sxb | Sxc | N4 | Supported? |
|---|---|---|---|---|---|---|
| 1 | Heartbeat Request | X | X | X | X | Yes |
| 2 | Heartbeat Response | X | X | X | X | Yes |
| 3 | PFD Management Request | - | X | X | X | Yes |
| 4 | PFD Management Response | - | X | X | X | Yes |
| 5 | Association Setup Request | X | X | X | X | Yes |
| 6 | Association Setup Response | X | X | X | X | Yes |
| 7 | Association Update Request | X | X | X | X | Yes |
| 8 | Association Update Response | X | X | X | X | Yes |
| 9 | Association Release Request | X | X | X | X | Yes |
| 10 | Association Release Response | X | X | X | X | Yes |
| 11 | Version Not Supported Response | X | X | X | X | Yes |
| 12 | Node Report Request | X | X | X | X | Yes |
| 13 | Node Report Response | X | X | X | X | Yes |
| 14 | Session Set Deletion Request | X | X | - | Yes | |
| 15 | Session Set Deletion Response | X | X | - | Yes | |
| 16 to 49 | (For future use) | - |
PFCP Session related messages
| Message Type | Message | Sxa | Sxb | Sxc | N4 | Supported? |
|---|---|---|---|---|---|---|
| 50 | Session Establishment Request | X | X | X | X | Yes |
| 51 | Session Establishment Response | X | X | X | X | Yes |
| 52 | Session Modification Request | X | X | X | X | Yes |
| 53 | Session Modification Response | X | X | X | X | Yes |
| 54 | Session Deletion Request | X | X | X | X | Yes |
| 55 | Session Deletion Response | X | X | X | X | Yes |
| 56 | Session Report Request | X | X | X | X | Yes |
| 57 | Session Report Response | X | X | X | X | Yes |
| 58 to 99 | (For future use) | - |
Information Elements
All the IEs are of the same type: ie.IE.
Constructors are available for every type of IEs.
To create CreatePDR IE, use NewCreatePDR(). Parameters for those constructors are implemented as friendly for Gophers as possible. See ie/ie_test.go for detailed (and working) usage.
// returned type and parameters in NewCreatePDR() are all *ie.IE.
createPDR := ie.NewCreatePDR(
ie.NewPDRID(0xffff),
ie.NewPrecedence(0x11111111),
ie.NewPDI(
ie.NewSourceInterface(ie.SrcInterfaceAccess),
ie.NewFTEID(0x01, 0x11111111, net.ParseIP("127.0.0.1"), nil, 0),
ie.NewNetworkInstance("some.instance.example"),
ie.NewRedundantTransmissionParametersInPDI(
ie.NewFTEID(0x01, 0x11111111, net.ParseIP("127.0.0.1"), nil, 0),
ie.NewNetworkInstance("some.instance.example"),
),
ie.NewUEIPAddress(0x02, "127.0.0.1", "", 0),
ie.NewTrafficEndpointID(0x01),
ie.NewSDFFilter("aaaaaaaa", "bb", "cccc", "ddd", 0xffffffff),
ie.NewApplicationID("https://github.com/tim-ywliu/go-pfcp/"),
ie.NewEthernetPDUSessionInformation(0x01),
ie.NewEthernetPacketFilter(
ie.NewEthernetFilterID(0xffffffff),
ie.NewEthernetFilterProperties(0x01),
ie.NewMACAddress(mac1, mac2, mac3, mac4),
ie.NewEthertype(0xffff),
ie.NewCTAG(0x07, 1, 1, 4095),
ie.NewSTAG(0x07, 1, 1, 4095),
ie.NewSDFFilter("aaaaaaaa", "bb", "cccc", "ddd", 0xffffffff),
),
),
ie.NewOuterHeaderRemoval(0x01, 0x02),
ie.NewFARID(0xffffffff),
ie.NewURRID(0xffffffff),
ie.NewQERID(0xffffffff),
ie.NewActivatePredefinedRules("go-pfcp"),
ie.NewActivationTime(time.Date(2019, time.January, 1, 0, 0, 0, 0, time.UTC)),
ie.NewDeactivationTime(time.Date(2019, time.January, 1, 0, 0, 0, 0, time.UTC)),
ie.NewMARID(0x1111),
ie.NewPacketReplicationAndDetectionCarryOnInformation(0x0f),
ie.NewIPMulticastAddressingInfo(
ie.NewIPMulticastAddress(net.ParseIP("127.0.0.1"), nil, net.ParseIP("127.0.0.1"), nil),
ie.NewSourceIPAddress(net.ParseIP("127.0.0.1"), nil, 24),
),
ie.NewUEIPAddressPoolIdentity("go-pfcp"),
)
Or just use ie.New() to create an arbitrary IE(when you don't need constructors or you need to create an enterprise-specific one).
ie := ie.New(ieType, enterpriseID, payload)
Values can be retrieved by calling helper methods on *ie.IE.
For instance, you can immediately get the value in a string by calling NetworkInstance().
ni := ie.NewNetworkInstance("some.instance.example")
v, err := ni.NetworkInstance()
// returns "some.instance.example" if ni is valid. Otherwise it returns error.
For complex IEs like F-TEID, <IE-name> method returns <IE-name>Fields structure.
fteid := ie.NewFTEID(0x01, 0x11111111, net.ParseIP("127.0.0.1"), nil, nil)
f, err := fteid.FTEID()
// returns FTEIDFields struct which contains values in its fields.
teid := f.TEID // has TEID as uint32
v4 := f.IPv4Address // has IPv4 address as net.IP
On grouped IEs, the value (or custom fields) can be retrieved by directly calling such methods.
createPDR := ie.NewCreatePDR(
ie.NewPDRID(0xffff),
// ...
)
v, err := createPDR.PDRID()
// returns 0xffff if createPDR contains PDRID and it is valid. Otherwise it returns error.
List of implemented IEs
IEs are (basically) implemented in conformance with TS29.244 V16.3.1(2020-04).
| IE Type | Information elements | Supported? |
|---|---|---|
| 0 | (Reserved) | - |
| 1 | Create PDR | Yes |
| 2 | PDI | Yes |
| 3 | Create FAR | Yes |
| 4 | Forwarding Parameters | Yes |
| 5 | Duplicating Parameters | Yes |
| 6 | Create URR | Yes |
| 7 | Create QER | Yes |
| 8 | Created PDR | Yes |
| 9 | Update PDR | Yes |
| 10 | Update FAR | Yes |
| 11 | Update Forwarding Parameters | Yes |
| 12 | Update BAR (PFCP Session Report Response) | Yes |
| 13 | Update URR | Yes |
| 14 | Update QER | Yes |
| 15 | Remove PDR | Yes |
| 16 | Remove FAR | Yes |
| 17 | Remove URR | Yes |
| 18 | Remove QER | Yes |
| 19 | Cause | Yes |
| 20 | Source Interface | Yes |
| 21 | F-TEID | Yes |
| 22 | Network Instance | Yes |
| 23 | SDF Filter | Yes |
| 24 | Application ID | Yes |
| 25 | Gate Status | Yes |
| 26 | MBR | Yes |
| 27 | GBR | Yes |
| 28 | QER Correlation ID | Yes |
| 29 | Precedence | Yes |
| 30 | Transport Level Marking | Yes |
| 31 | Volume Threshold | Yes |
| 32 | Time Threshold | Yes |
| 33 | Monitoring Time | Yes |
| 34 | Subsequent Volume Threshold | Yes |
| 35 | Subsequent Time Threshold | Yes |
| 36 | Inactivity Detection Time | Yes |
| 37 | Reporting Triggers | Yes |
| 38 | Redirect Information | Yes |
| 39 | Report Type | Yes |
| 40 | Offending IE | Yes |
| 41 | Forwarding Policy | Yes |
| 42 | Destination Interface | Yes |
| 43 | UP Function Features | Yes |
| 44 | Apply Action | Yes |
| 45 | Downlink Data Service Information | Yes |
| 46 | Downlink Data Notification Delay | Yes |
| 47 | DL Buffering Duration | Yes |
| 48 | DL Buffering Suggested Packet Count | Yes |
| 49 | PFCPSMReq-Flags | Yes |
| 50 | PFCPSRRsp-Flags | Yes |
| 51 | Load Control Information | Yes |
| 52 | Sequence Number | Yes |
| 53 | Metric | Yes |
| 54 | Overload Control Information | Yes |
| 55 | Timer | Yes |
| 56 | Packet Detection Rule ID | Yes |
| 57 | F-SEID | Yes |
| 58 | Application ID's PFDs | Yes |
| 59 | PFD context | Yes |
| 60 | Node ID | Yes |
| 61 | PFD contents | Yes |
| 62 | Measurement Method | Yes |
| 63 | Usage Report Trigger | Yes |
| 64 | Measurement Period | Yes |
| 65 | FQ-CSID | Yes |
| 66 | Volume Measurement | Yes |
| 67 | Duration Measurement | Yes |
| 68 | Application Detection Information | Yes |
| 69 | Time of First Packet | Yes |
| 70 | Time of Last Packet | Yes |
| 71 | Quota Holding Time | Yes |
| 72 | Dropped DL Traffic Threshold | Yes |
| 73 | Volume Quota | Yes |
| 74 | Time Quota | Yes |
| 75 | Start Time | Yes |
| 76 | End Time | Yes |
| 77 | Query URR | Yes |
| 78 | Usage Report (Session Modification Response) | Yes |
| 79 | Usage Report (Session Deletion Response) | Yes |
| 80 | Usage Report (Session Report Request) | Yes |
| 81 | URR ID | Yes |
| 82 | Linked URR ID | Yes |
| 83 | Downlink Data Report | Yes |
| 84 | Outer Header Creation | Yes |
| 85 | Create BAR | Yes |
| 86 | Update BAR (Session Modification Request) | Yes |
| 87 | Remove BAR | Yes |
| 88 | BAR ID | Yes |
| 89 | CP Function Features | Yes |
| 90 | Usage Information | Yes |
| 91 | Application Instance ID | Yes |
| 92 | Flow Information | Yes |
| 93 | UE IP Address | Yes |
| 94 | Packet Rate | Yes |
| 95 | Outer Header Removal | Yes |
| 96 | Recovery Time Stamp | Yes |
| 97 | DL Flow Level Marking | Yes |
| 98 | Header Enrichment | Yes |
| 99 | Error Indication Report | Yes |
| 100 | Measurement Information | Yes |
| 101 | Node Report Type | Yes |
| 102 | User Plane Path Failure Report | Yes |
| 103 | Remote GTP-U Peer | Yes |
| 104 | UR-SEQN | Yes |
| 105 | Update Duplicating Parameters | Yes |
| 106 | Activate Predefined Rules | Yes |
| 107 | Deactivate Predefined Rules | Yes |
| 108 | FAR ID | Yes |
| 109 | QER ID | Yes |
| 110 | OCI Flags | Yes |
| 111 | PFCP Association Release Request | Yes |
| 112 | Graceful Release Period | Yes |
| 113 | PDN Type | Yes |
| 114 | Failed Rule ID | Yes |
| 115 | Time Quota Mechanism | Yes |
| 116 | User Plane IP Resource Information | Yes |
| 117 | User Plane Inactivity Timer | Yes |
| 118 | Aggregated URRs | Yes |
| 119 | Multiplier | Yes |
| 120 | Aggregated URR ID | Yes |
| 121 | Subsequent Volume Quota | Yes |
| 122 | Subsequent Time Quota | Yes |
| 123 | RQI | Yes |
| 124 | QFI | Yes |
| 125 | Query URR Reference | Yes |
| 126 | Additional Usage Reports Information | Yes |
| 127 | Create Traffic Endpoint | Yes |
| 128 | Created Traffic Endpoint | Yes |
| 129 | Update Traffic Endpoint | Yes |
| 130 | Remove Traffic Endpoint | Yes |
| 131 | Traffic Endpoint ID | Yes |
| 132 | Ethernet Packet Filter | Yes |
| 133 | MAC address | Yes |
| 134 | C-TAG | Yes |
| 135 | S-TAG | Yes |
| 136 | Ethertype | Yes |
| 137 | Proxying | Yes |
| 138 | Ethernet Filter ID | Yes |
| 139 | Ethernet Filter Properties | Yes |
| 140 | Suggested Buffering Packets Count | Yes |
| 141 | User ID | Yes |
| 142 | Ethernet PDU Session Information | Yes |
| 143 | Ethernet Traffic Information | Yes |
| 144 | MAC Addresses Detected | Yes |
| 145 | MAC Addresses Removed | Yes |
| 146 | Ethernet Inactivity Timer | Yes |
| 147 | Additional Monitoring Time | Yes |
| 148 | Event Quota | Yes |
| 149 | Event Threshold | Yes |
| 150 | Subsequent Event Quota | Yes |
| 151 | Subsequent Event Threshold | Yes |
| 152 | Trace Information | Yes |
| 153 | Framed-Route | Yes |
| 154 | Framed-Routing | Yes |
| 155 | Framed-IPv6-Route | Yes |
| 156 | Event Time Stamp | Yes |
| 157 | Averaging Window | Yes |
| 158 | Paging Policy Indicator | Yes |
| 159 | APN/DNN | Yes |
| 160 | 3GPP Interface Type | Yes |
| 161 | PFCPSRReq-Flags | Yes |
| 162 | PFCPAUReq-Flags | Yes |
| 163 | Activation Time | Yes |
| 164 | Deactivation Time | Yes |
| 165 | Create MAR | Yes |
| 166 | 3GPP Access Forwarding Action Information | Yes |
| 167 | Non-3GPP Access Forwarding Action Information | Yes |
| 168 | Remove MAR | Yes |
| 169 | Update MAR | Yes |
| 170 | MAR ID | Yes |
| 171 | Steering Functionality | Yes |
| 172 | Steering Mode | Yes |
| 173 | Weight | Yes |
| 174 | Priority | Yes |
| 175 | Update 3GPP Access Forwarding Action Information | Yes |
| 176 | Update Non 3GPP Access Forwarding Action Information | Yes |
| 177 | UE IP address Pool Identity | Yes |
| 178 | Alternative SMF IP Address | Yes |
| 179 | Packet Replication and Detection Carry-On Information | Yes |
| 180 | SMF Set ID | Yes |
| 181 | Quota Validity Time | Yes |
| 182 | Number of Reports | Yes |
| 183 | PFCP Session Retention Information (within PFCP Association Setup Request) | Yes |
| 184 | PFCPASRsp-Flags | Yes |
| 185 | CP PFCP Entity IP Address | Yes |
| 186 | PFCPSEReq-Flags | Yes |
| 187 | User Plane Path Recovery Report | Yes |
| 188 | IP Multicast Addressing Info within PFCP Session Establishment Request | Yes |
| 189 | Join IP Multicast Information IE within Usage Report | Yes |
| 190 | Leave IP Multicast Information IE within Usage Report | Yes |
| 191 | IP Multicast Address | Yes |
| 192 | Source IP Address | Yes |
| 193 | Packet Rate Status | Yes |
| 194 | Create Bridge Info for TSC | Yes |
| 195 | Created Bridge Info for TSC | Yes |
| 196 | DS-TT Port Number | Yes |
| 197 | NW-TT Port Number | Yes |
| 198 | TSN Bridge ID | Yes |
| 199 | TSC Management Information IE within PFCP Session Modification Request | Yes |
| 200 | TSC Management Information IE within PFCP Session Modification Response | Yes |
| 201 | TSC Management Information IE within PFCP Session Report Request | Yes |
| 202 | Port Management Information Container | Yes |
| 203 | Clock Drift Control Information | Yes |
| 204 | Requested Clock Drift Information | Yes |
| 205 | Clock Drift Report | Yes |
| 206 | TSN Time Domain Number | Yes |
| 207 | Time Offset Threshold | Yes |
| 208 | Cumulative rateRatio Threshold | Yes |
| 209 | Time Offset Measurement | Yes |
| 210 | Cumulative rateRatio Measurement | Yes |
| 211 | Remove SRR | Yes |
| 212 | Create SRR | Yes |
| 213 | Update SRR | Yes |
| 214 | Session Report | Yes |
| 215 | SRR ID | Yes |
| 216 | Access Availability Control Information | Yes |
| 217 | Requested Access Availability Information | Yes |
| 218 | Access Availability Report | Yes |
| 219 | Access Availability Information | Yes |
| 220 | Provide ATSSS Control Information | Yes |
| 221 | ATSSS Control Parameters | Yes |
| 222 | MPTCP Control Information | Yes |
| 223 | ATSSS-LL Control Information | Yes |
| 224 | PMF Control Information | Yes |
| 225 | MPTCP Parameters | Yes |
| 226 | ATSSS-LL Parameters | Yes |
| 227 | PMF Parameters | Yes |
| 228 | MPTCP Address Information | Yes |
| 229 | UE Link-Specific IP Address | Yes |
| 230 | PMF Address Information | Yes |
| 231 | ATSSS-LL Information | Yes |
| 232 | Data Network Access Identifier | Yes |
| 233 | UE IP address Pool Information | Yes |
| 234 | Average Packet Delay | Yes |
| 235 | Minimum Packet Delay | Yes |
| 236 | Maximum Packet Delay | Yes |
| 237 | QoS Report Trigger | Yes |
| 238 | GTP-U Path QoS Control Information | Yes |
| 239 | GTP-U Path QoS Report (PFCP Node Report Request) | Yes |
| 240 | QoS Information in GTP-U Path QoS Report | Yes |
| 241 | GTP-U Path Interface Type | Yes |
| 242 | QoS Monitoring per QoS flow Control Information | Yes |
| 243 | Requested QoS Monitoring | Yes |
| 244 | Reporting Frequency | Yes |
| 245 | Packet Delay Thresholds | Yes |
| 246 | Minimum Wait Time | Yes |
| 247 | QoS Monitoring Report | Yes |
| 248 | QoS Monitoring Measurement | Yes |
| 249 | MT-EDT Control Information | Yes |
| 250 | DL Data Packets Size | Yes |
| 251 | QER Control Indications | Yes |
| 252 | Packet Rate Status Report | Yes |
| 253 | NF Instance ID | Yes |
| 254 | Ethernet Context Information | Yes |
| 255 | Redundant Transmission Parameters | Yes |
| 256 | Updated PDR | Yes |
| 257 | S-NSSAI | Yes |
| 258 | IP version | Yes |
| 259 | PFCPASReq-Flags | Yes |
| 260 | Data Status | Yes |
| 261 | Provide RDS configuration information | Yes |
| 262 | RDS configuration information | Yes |
| 263 | Query Packet Rate Status IE within PFCP Session Modification Request | Yes |
| 264 | Packet Rate Status Report IE within PFCP Session Modification Response | Yes |
| 265 | MPTCP Applicable Indication | Yes |
| 266 | Bridge Management Information Container | Yes |
| 267 | UE IP Address Usage Information | Yes |
| 268 | Number of UE IP Addresses | Yes |
| 269 | Validity Timer | Yes |
| 270 | Redundant Transmission Forwarding Parameters | Yes |
| 271 | Transport Delay Reporting | Yes |
| 272 to 32767 | (For future use) | - |
| 32768 to 65535 | Reserved for vendor specific IEs | - |
Author(s)
Yoshiyuki Kurauchi (Website / LinkedIn)
I'm always open to welcome co-authors! Please feel free to talk to me.