Skip to content

Latest commit

 

History

History
391 lines (262 loc) · 11.4 KB

CONFIG.md

File metadata and controls

391 lines (262 loc) · 11.4 KB
Raw

erGW configuration (WiP)

Concepts

VRF's

A VRF (Virtual Routing Function) encapsulates a IP routing domin. All devices in a VRF get their IP's from a common pool and are in the same routing domain.

Configuration settings per VRF:

  • IP pool
  • IP routes (from the GGSN to MS)
  • default DNS server
  • default Wins (NBNS) server

The AAA provider can override the DNS and NBNS server settings and assign IP addresses. The assigned IP address has to be reachable through the routes.

Syntax of VRF names

VRF names are use internally and also as Network Instance names in the PFCP protocol. They have to meet the encoding semantics of the PFCP and be identical on the CP and UP node.

3GPP TS 29.244, 8.2.4 Network Instance is a bit vague about the encoding of the network instance identifier. When an APN name is used as name, we can assume DNS label type encoding, however the Domain Name encoding is left open.

The VPP UP uses DNS label encoding in all cases. erGW might someday also work with other GTP UP nodes. It therefore takes a more generic approach. Internally a VRF name (and therefore a Network Instance name) is always a opaque binary. When reading from configuration, supported formats are converted to such a binary.

VRF names specified as Erlang atoms or strings, are converted to binaries, split into DNS label parts and encoded as DNS labels. Names specified as list of binaries are encoded as DNS labels. Names specified as binaries are used as is.

Samples:

Config Network Instance
'epc' <<3, "epc">>
'apn.dns.label' <<3, "apn", 3, "dns", 5, "label">>
"apn.dns.label" <<3, "apn", 3, "dns", 5, "label">>
[<<"apn">>, <<"dns">>, <<"label">>] <<3, "apn", 3, "dns", 5, "label">>
<<"apn.dns.label">> <<"apn.dns.label">>

APN

3GPP TS 23.003, Section 9 defines an APN in terms of selecting a GGSN:

In the GPRS backbone, an Access Point Name (APN) is a reference to a GGSN. To support inter-PLMN roaming, the internal GPRS DNS functionality is used to translate the APN into the IP address of the GGSN.

However, once a GTP tunnel request has been reached a erGW, the APN message element is just a selector to choose the final settings for a given tunnel.

GTP routes

GTP routes are used to map an incomming GTP tunnel/bearer request to a AAA provider. The outcome of the AAA decission then connects the GTP tunnel to a VRF. If the AAA provider does not return a VRF selection, the default VRF for a give APN is used.

The dummy (mock) AAA provider accepts all session and always connects to the default VRF of a APN.

GTP socket

A GTP socket is a GTP-C or GTP-U IP endpoint.

Pictures

Some picture putting the above description into context would be nice.

Socket to VRF wiring:

Alt text

Configuration

The configuration is processed through the Erlang setup application. Therefor variable expansion as described there is available.

PLMN Id

 {plmn_id, {<<"001">>, <<"01">>}

The PLMN identifier is the MCC and MNC of the served network.

  • plmn_id: {plmn_id, {MCC :: binary(), MNC :: binary()}}

GTP socket

 {sockets,
  [{irx, [{type, 'gtp-c'},
      {ip,  {172,20,16,89}},
      {netdev, "grx"},
      freebind
      {netns, "/var/run/netns/grx"}
     ]},
   {grx, [{type, 'gtp-u'},
      {node, 'gtp-u-node@vlx159-tpmd'},
      {name, 'grx'}]}
  ]}

Defines a list of named sockets. The format is (in Erlang type syntax):

  • sockets: {sockets, [socket_definition()]}

  • socket_definition: {socket_name(), [socket_options()]}

  • socket_name: atom()

  • socket_options:

    • {type, 'gtp-c' | 'gtp-u'}

      the type of the socket

    • {ip, inet:ip_address()}

      IP address to bind to, the wildcard IP if allowed

    • {netdev, string()}

      network device to bind this socket to (use for VRF-Lite setups)

    • freebind

      bind to an IP that does not yet and may never exists

    • {netns, string()}

      open the socket in the give network namespace

    • {node, atom()}

      name of a remote node where the GTP-U datapath resides

    • {name, socket_name()}

      name the datapath on a remote node

    • {vrf, vrf_name()}

      name of the VRF this socket is located in, defaults to the name of the socket if not given

Handlers

{handlers,
  [{gn, [{handler, ggsn_gn},
         {protocol, gn},
         {sockets, [irx]},
         {aaa, [{'Username',
                 [{default, ['IMSI', <<"@">>, 'APN']}]}]},

Defines a list of handler's, what reference point that handler is serving, on which sockets, the AAA provider and the defaults AAA attribute mapping.

  • handlers: {handlers, [handler_definition()]}

  • handler_definition: {handler_name(), handler_options}

  • handler_name: atom()

  • handler_options:

    • {handler, atom()}

      the protocol handler module, ergw ships with handlers for Gn, S5/S8 and S2a

    • {protocol, atom()}

      the 3GPP interface that is served by the handler. Versions before 1.12 did derive the protocol from the handler_name. For backward compatibility this option can be omitted it the handler name is 'gn' or 's5s8'.

    • {sockets, [socket_name()]}

      the GTP-C sockets that are served by this handler

    • {aaa, [aaa_options()]}

      mapping rules to derive defaults for some fields before passing them on to the AAA provider

  • aaa_options:

    • {'AAA-Application-Id', atom()}
    • {'Username', mapping_spec()}
    • {'Password', mapping_spec()}

VRF's

 {vrfs,
  [{upstream, [{pools,  [{{10, 180, 0, 1}, {10, 180, 255, 254}, 32},
                         {{16#8001, 0, 0, 0, 0, 0, 0, 0}, {16#8001, 0, 0, 16#FFFF, 0, 0, 0, 0}, 64}
                        ]},
               {'MS-Primary-DNS-Server', {8,8,8,8}},
               {'MS-Secondary-DNS-Server', {8,8,4,4}},
               {'MS-Primary-NBNS-Server', {127,0,0,1}},
               {'MS-Secondary-NBNS-Server', {127,0,0,1}}
              ]}
  ]}

Defines the IP routing domains and their defaults.

  • vrfs: {vrfs, [vrf_definition()]}

  • vrf_definition: {vrf_name(), [vrf_options() | session_defaults()]}

  • vrf_name: atom() | [binary()] | binary() | string()

  • vrf_options:

    • {pools, [vrf_pool()]}

  • vrf_pool: {Start :: ip_address(), End :: ip_address()}

    defines a range of IP addresses (Start to End) for allocation to clients

APN's

 {apns,
  [{[<<"tpip">>, <<"net">>], [{vrf, upstream} | session_defaults()]}]},

Routes provided default mappings of APN's into VRF's. A route is applied after the AAA provider if it did not return a VRF destination for the request. At the very minimum, the catch all APN '_' needs to be configured.

  • routes: {apns, [route_definition()]}

  • route_definition: {apn_name(), [apn_options()]}

  • apn_name: atom()

  • apn_options:

    • {vrf, vrf_name()}

Session Options

Session defaults can be defined at the VRF and APN level. AAA providers can overwrite those defaults. Options defined at an APN will overwrite VRF options and AAA providers will overwrite both.

  • session_defaults:

    • {'MS-Primary-DNS-Server', inet:ip4_address()}

    • {'MS-Secondary-DNS-Server', inet:ip4_address()}

    • {'MS-Primary-NBNS-Server', inet:ip4_address()}

    • {'MS-Secondary-NBNS-Server', inet:ip4_address()}

    • {'DNS-Server-IPv6-Address', [inet:ip6_address()]}

    • {'3GPP-IPv6-DNS-Servers', [inet:ip6_address()]}

Handler Configuration

Protocol handlers can extend the handler configuration with use case specific options.

ggsn_gn_proxy

{handlers,
 [{gn, [{handler, ggsn_gn_proxy},
        {sockets, [irx]},
        {proxy_sockets, ['irx-1']},
        {ggns, {127, 0, 0, 1}},
        {contexts, [{<<"ams">>, [{proxy_sockets, ['irx-ams']}]},
                    {<<"us">>,  [{proxy_sockets, ['irx-us']}]}]}
        ]}]}

  • handler_options:

    • {proxy_sockets, [socket_name()]}

      the default GTP-C socket for forwarding requests

    • {ggsn, inet:ip_address()}

      the default GGSN IP address

    • {contexts, [context()]}

      list of forwarding context. Forwarding can be selected by the proxy data source

  • context: {context_name(), [{proxy_sockets, [socket_name()]}]}

    a context comprises of proxy GTP-c sockets and proxy GTP-u data paths

    • context_name: binary()

      the context name

Operation Modes

PGW with co-located GGSN function

A PGW can be operated with a co-located GGSN function to support 3GPP TS 23.401 Annex D, Interoperation with Gn/Gp SGSNs. In this case the PGW handles the Gn/Gp and the S8/S5 protocol. The GTP sockets can not be shared with an independent GGSN instance.

Sample handler configuration:

{handlers,
 [{gn, [{handler, pgw_s5s8},
        {sockets, [irx]}
       ]},
  {s5s8, [{handler, pgw_s5s8},
          {sockets, [irx]}
         ]}]}

NAPTR records for APN's on such a gateway should use "Service Parameters" of "x-3gpp-pgw:x-s5-gtp", "x-3gpp-pgw:x-s8-gtp", "x-3gpp-pgw:x-gn" and "x-3gpp-pgw:x-gp"

PGW

Sample handler configuration for a S5/S8 only PGW

{handlers,
 [{s5s8, [{handler, pgw_s5s8},
          {sockets, [irx]}
         ]}]}

NAPTR records for APN's on such a gateway should use "Service Parameters" of "x-3gpp-pgw:x-s5-gtp" and "x-3gpp-pgw:x-s8-gtp"

GGSN

Sample handler configuration for Gn/Gp only GGSN

{handlers,
 [{gn, [{handler, ggsn_gn},
        {sockets, [irx]}
       ]}]}

NAPTR records for APN's on such a gateway should use "Service Parameters" of "x-3gpp-ggsn:x-gn" and "x-3gpp-ggsn:x-gp"

PGW and GGSN sharing the same GTP port

NOTE: 3GPP TS 23.401 Annex D, Interoperation with Gn/Gp SGSNs is not supported in this configuration.

Sample handler configuration:

{handlers,
 [{gn, [{handler, ggsn_gn},
        {sockets, [irx]}
       ]},
  {s5s8, [{handler, pgw_s5s8},
          {sockets, [irx]}
         ]}]}

NAPTR records for APN's on such a gateway should use "Service Parameters" of "x-3gpp-ggsn:x-gn", "x-3gpp-ggsn:x-gp", "x-3gpp-pgw:x-s5-gtp" and "x-3gpp-pgw:x-s8-gtp". "Service Parameters" of "x-3gpp-pgw:x-gn" and "x-3gpp-pgw:x-gp" should not be used.

Rate Limiting

erGW uses the Erlang jobs to apply rate limiting to all incoming GTP messages.

GTP messages are classified into create, delete and other classes. Each class has its own rules. Messages exceeding the configured rate are rejected with No resources available.

It is recommended to configure the delete class with a counter queuing class that will limit the delete messages per second but not drop them.

The internal default correspond to this setup:

{jobs, [{queues,
         [{path_restart,
           [{path_restart, [{standard_counter, 100}]},
            {create, [{standard_rate, 100}, {max_size, 10}]},
            {delete, [{standard_counter, 100}]},
            {other, [{standard_rate, 100}, {max_size, 10}]}
           ]}
         ]}
       ]}