go-gtp

module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 3, 2019 License: MIT

README

go-gtp: GTP in Golang

Package gtp provides simple and painless handling of GTP(GPRS Tunneling Protocol), implemented in the Go Programming Language.

CircleCI GoDoc Go Report Card GitHub

Features

  • No platform-specific codes inside, so it works almost everywhere Golang works.
  • Flexible enough to control everything in GTP protocol.;
    • For developing mobile core network nodes (see examples).
    • For developing testing tools like traffic simulators or fuzzers.
  • Many helpers kind to developers provided, like session, bearer, and TEID associations.
  • Easy handling of multiple connections with fixed IP and Port with UDP (or other net.PacketConn).

Getting Started

Prerequisites

The following packages should be installed before starting.

go get -u github.com/pkg/errors
go get -u github.com/google/go-cmp/cmp
go get -u github.com/pascaldekloe/goe/verify
Running examples

Examples works as it is by go build and executing coomands in the following way.

  1. Open four terminals on a machine and start capturing on loopback interface.

  2. Start P-GW on terminal #1 and #2

// on terminal #1
./pgw

// on terminal #2
./pgw -s5c 127.0.0.53:2123 -s5u 127.0.0.5:2152
  1. Start S-GW on terminal #3
// on terminal #3
./sgw
  1. Start MME on terminal #4
// on terminal #4
./mme
  1. You will see the nodes exchanging Create Session and Modify Bearer on C-Plane, and ICMP Echo on U-Plane afterwards.
Developing by your own

Each version has net.PacketConn-like APIs and GTP-specific ones which is often version-specific. The basic idea behind the current implementation is;

  • Dial() or ListenAndServe() to create a connection(Conn) between nodes.
  • Register handlers to the Conn for specific messages with AddHandler(), which allows users to handle the messages coming from the remote endpoint as flexible as possible, with less pain.
  • CreateXXX() to create session or PDP context with arbitrary IEs given. Session/PDP context is structured and they also have some helpers like AddTEID() to handle known TEID properly.

For the detailed usage of specific version, see README.md under each version's directory.

Version Details
GTPv0 README.md
GTPv1 README.md
GTPv2 README.md

Supported Features

Note that "supported" means that the package provides helpers which makes it easier to handle. In other words, even if a message/IE is not marked as "Yes", you can make it work with some additional effort.

Your contribution is welcome to implement helpers for all the types, of course!

Version Messages IEs Networking (state machine) Details
GTPv0 35.7% 78.8% not implemented yet Supported Features
GTPv1 19.0% 19.5% v1-U is functional,
v1-C is not implemented yet
Supported Features
GTPv2 27.0% 41.8% almost functional Supported Features
GTP'
(Prime)
N/A N/A N/A not planned

Disclaimer

This is still an experimental project. Any part of implementations(including exported APIs) may be changed before released as v1.0.0.

Author(s)

Yoshiyuki Kurauchi (Twitter / LinkedIn)

I'm always open to welcome co-authors! Please feel free to talk to me.

LICENSE

MIT

Directories

Path Synopsis
examples
gw-tester/enb module
gw-tester/mme module
gw-tester/pgw module
gw-tester/sgw module
gtp
Package gtp provides simple and painless handling of GTP(GPRS Tunneling Protocol), implemented in the Go Programming Language.
Package gtp provides simple and painless handling of GTP(GPRS Tunneling Protocol), implemented in the Go Programming Language.
examples/mme command
Command mme is a reference implementation of MME with go-gtp.
Command mme is a reference implementation of MME with go-gtp.
examples/pgw command
Command pgw is a dead simple implementation of P-GW only with GTP-related features.
Command pgw is a dead simple implementation of P-GW only with GTP-related features.
examples/sgw command
Command sgw is a dead simple implementation of S-GW only with GTP-related features.
Command sgw is a dead simple implementation of S-GW only with GTP-related features.
utils
Package utils provides some utilities which might be useful specifically for GTP(or other telco protocols).
Package utils provides some utilities which might be useful specifically for GTP(or other telco protocols).
v0
Package v0 provides the simple and painless handling of GTPv1-C and GTPv1-U protocol in pure Golang.
Package v0 provides the simple and painless handling of GTPv1-C and GTPv1-U protocol in pure Golang.
v0/ies
Package ies provides encoding/decoding feature of GTPv0 Information Elements.
Package ies provides encoding/decoding feature of GTPv0 Information Elements.
v0/messages
Package messages provides encoding/decoding feature of GTPv0 protocol.
Package messages provides encoding/decoding feature of GTPv0 protocol.
v0/testutils
Package testutils is an internal package to be used for unit tests.
Package testutils is an internal package to be used for unit tests.
v1
Package v1 provides the simple and painless handling of GTPv1-C and GTPv1-U protocol in pure Golang.
Package v1 provides the simple and painless handling of GTPv1-C and GTPv1-U protocol in pure Golang.
v1/ies
Package ies provides encoding/decoding feature of GTPv1 Information Elements.
Package ies provides encoding/decoding feature of GTPv1 Information Elements.
v1/messages
Package messages provides encoding/decoding feature of GTPv1 protocol.
Package messages provides encoding/decoding feature of GTPv1 protocol.
v1/testutils
Package testutils is an internal package to be used for unit tests.
Package testutils is an internal package to be used for unit tests.
v2
Package v2 provides the simple and painless handling of GTPv2-C protocol in pure Golang.
Package v2 provides the simple and painless handling of GTPv2-C protocol in pure Golang.
v2/ies
Package ies provides encoding/decoding feature of GTPv2 Information Elements.
Package ies provides encoding/decoding feature of GTPv2 Information Elements.
v2/messages
Package messages provides encoding/decoding feature of GTPv2 protocol.
Package messages provides encoding/decoding feature of GTPv2 protocol.
v2/testutils
Package testutils is an internal package to be used for unit tests.
Package testutils is an internal package to be used for unit tests.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL