Pau Espin Pedrol | 0696c60 | 2021-03-16 14:25:37 +0100 | [diff] [blame] | 1 | # osmo_gsm_tester: specifics for running an Open5GS EPC |
| 2 | # |
| 3 | # Copyright (C) 2021 by sysmocom - s.f.m.c. GmbH |
| 4 | # |
| 5 | # Author: Pau Espin Pedrol <pespin@sysmocom.de> |
| 6 | # |
| 7 | # This program is free software: you can redistribute it and/or modify |
| 8 | # it under the terms of the GNU General Public License as |
| 9 | # published by the Free Software Foundation, either version 3 of the |
| 10 | # License, or (at your option) any later version. |
| 11 | # |
| 12 | # This program is distributed in the hope that it will be useful, |
| 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | # GNU General Public License for more details. |
| 16 | # |
| 17 | # You should have received a copy of the GNU General Public License |
| 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
| 20 | import os |
| 21 | import pprint |
| 22 | import copy |
| 23 | |
| 24 | from ..core import log, util, config, template, process, remote |
| 25 | from ..core import schema |
| 26 | from . import epc |
| 27 | from .pcrf_open5gs import Open5gsPCRF |
| 28 | from .upf_open5gs import Open5gsUPF |
| 29 | from .smf_open5gs import Open5gsSMF |
| 30 | from .hss_open5gs import Open5gsHSS |
| 31 | from .mme_open5gs import Open5gsMME |
| 32 | from .sgwc_open5gs import Open5gsSGWC |
| 33 | from .sgwu_open5gs import Open5gsSGWU |
| 34 | |
| 35 | def on_register_schemas(): |
| 36 | config_schema = { |
| 37 | 'db_host': schema.STR, |
| 38 | } |
| 39 | schema.register_config_schema('epc', config_schema) |
| 40 | |
| 41 | class Open5gsEPC(epc.EPC): |
Pau Espin Pedrol | d776059 | 2021-03-31 13:35:04 +0200 | [diff] [blame] | 42 | ############## |
| 43 | # PROTECTED |
| 44 | ############## |
Pau Espin Pedrol | 0696c60 | 2021-03-16 14:25:37 +0100 | [diff] [blame] | 45 | REMOTE_DIR = '/osmo-gsm-tester-open5gs' |
| 46 | |
| 47 | def __init__(self, testenv, run_node): |
| 48 | super().__init__(testenv, run_node, 'open5gs_epc') |
| 49 | self.run_dir = None |
| 50 | self.pcrf = None |
| 51 | self.upf = None |
| 52 | self.smf = None |
| 53 | self.mme = None |
| 54 | self.hss = None |
| 55 | self.sgwc = None |
| 56 | self.sgwu = None |
| 57 | self.subscriber_list = [] |
| 58 | |
Pau Espin Pedrol | d776059 | 2021-03-31 13:35:04 +0200 | [diff] [blame] | 59 | def configure(self): |
| 60 | values = super().configure(['open5gsepc']) |
| 61 | db_host = values['epc']['db_host'] |
| 62 | db_uri = 'mongodb://'+db_host+'/open5gs' |
| 63 | config.overlay(values, dict(epc=dict(db_uri=db_uri, |
| 64 | tun_addr=self.tun_addr(), |
| 65 | addr_smf=self.priv_addr_smf(), |
| 66 | addr_upf=self.priv_addr_upf(), |
| 67 | addr_sgwc=self.priv_addr_sgwc(), |
| 68 | addr_sgwu=self.priv_addr_sgwu(), |
| 69 | ))) |
| 70 | self.fill_subscribers_mongodb(values['epc']['db_host'], 27017) |
| 71 | self.pcrf = Open5gsPCRF(self.testenv, self) |
| 72 | self.upf = Open5gsUPF(self.testenv, self) |
| 73 | self.smf = Open5gsSMF(self.testenv, self) |
| 74 | self.hss = Open5gsHSS(self.testenv, self) |
| 75 | self.mme = Open5gsMME(self.testenv, self) |
| 76 | self.sgwc = Open5gsSGWC(self.testenv, self) |
| 77 | self.sgwu = Open5gsSGWU(self.testenv, self) |
| 78 | self.pcrf.configure(copy.deepcopy(values)) |
| 79 | self.upf.configure(copy.deepcopy(values)) |
| 80 | self.smf.configure(copy.deepcopy(values)) |
| 81 | self.hss.configure(copy.deepcopy(values)) |
| 82 | self.mme.configure(copy.deepcopy(values)) |
| 83 | self.sgwc.configure(copy.deepcopy(values)) |
| 84 | self.sgwu.configure(copy.deepcopy(values)) |
| 85 | |
| 86 | def gen_priv_addr(self, suffix): |
| 87 | if ':' in self.addr(): |
| 88 | raise log.Error('IPv6 not implemented!') |
| 89 | public_suffix = self.addr()[self.addr().rindex('.')+1:] |
| 90 | return '127.0.' + public_suffix + '.' + str(suffix) |
| 91 | |
| 92 | ######################## |
| 93 | # PUBLIC - INTERNAL API |
| 94 | ######################## |
| 95 | |
Pau Espin Pedrol | 0696c60 | 2021-03-16 14:25:37 +0100 | [diff] [blame] | 96 | def cleanup(self): |
| 97 | if self.pcrf: |
| 98 | self.pcrf.cleanup() |
| 99 | if self.upf: |
| 100 | self.upf.cleanup() |
| 101 | if self.smf: |
| 102 | self.smf.cleanup() |
| 103 | if self.hss: |
| 104 | self.hss.cleanup() |
| 105 | if self.mme: |
| 106 | self.mme.cleanup() |
| 107 | if self.sgwc: |
| 108 | self.sgwc.cleanup() |
| 109 | if self.sgwu: |
| 110 | self.sgwu.cleanup() |
| 111 | |
Pau Espin Pedrol | d776059 | 2021-03-31 13:35:04 +0200 | [diff] [blame] | 112 | def priv_addr_smf(self): |
| 113 | return self.gen_priv_addr(1) |
Pau Espin Pedrol | 0696c60 | 2021-03-16 14:25:37 +0100 | [diff] [blame] | 114 | |
Pau Espin Pedrol | d776059 | 2021-03-31 13:35:04 +0200 | [diff] [blame] | 115 | def priv_addr_upf(self): |
| 116 | return self.gen_priv_addr(2) |
| 117 | |
| 118 | def priv_addr_sgwc(self): |
| 119 | return self.gen_priv_addr(3) |
| 120 | |
| 121 | def priv_addr_sgwu(self): |
| 122 | return self.gen_priv_addr(4) |
| 123 | |
| 124 | ################### |
| 125 | # PUBLIC (test API included) |
| 126 | ################### |
Pau Espin Pedrol | 0696c60 | 2021-03-16 14:25:37 +0100 | [diff] [blame] | 127 | def start(self): |
| 128 | self.log('Starting srsepc') |
| 129 | self.run_dir = util.Dir(self.testenv.test().get_run_dir().new_dir(self.name())) |
| 130 | self.configure() |
| 131 | self.pcrf.start() |
| 132 | self.upf.start() |
| 133 | self.smf.start() |
| 134 | self.hss.start() |
| 135 | self.mme.start() |
| 136 | self.sgwc.start() |
| 137 | self.sgwu.start() |
| 138 | |
| 139 | def subscriber_add(self, modem, msisdn=None, algo_str=None): |
| 140 | if msisdn is None: |
| 141 | msisdn = modem.msisdn() |
| 142 | |
| 143 | if algo_str is None: |
| 144 | algo_str = modem.auth_algo() or 'milenage' |
| 145 | |
| 146 | if algo_str == 'milenage': |
| 147 | if not modem.ki(): |
| 148 | raise log.Error("Auth algo milenage selected but no KI specified") |
| 149 | if not modem.opc(): |
| 150 | raise log.Error("Auth algo milenage selected but no OPC specified") |
| 151 | else: |
| 152 | raise log.Error("Open5Gs only supports auth algo: milenage") |
| 153 | |
| 154 | subscriber_id = len(self.subscriber_list) # list index |
| 155 | self.subscriber_list.append({'id': subscriber_id, 'imsi': modem.imsi(), 'msisdn': msisdn, 'auth_algo': algo_str, 'ki': modem.ki(), 'opc': modem.opc(), 'apn_ipaddr': modem.apn_ipaddr()}) |
| 156 | return subscriber_id |
| 157 | |
| 158 | def fill_subscribers_mongodb(self, server, port): |
| 159 | import pymongo |
| 160 | |
| 161 | myclient = pymongo.MongoClient("mongodb://" + str(server) + ":" + str(port) + "/") |
| 162 | mydb = myclient["open5gs"] |
| 163 | mycol = mydb["subscribers"] |
| 164 | |
| 165 | for s in self.subscriber_list: |
| 166 | self.log('Insert subscriber to DB', msisdn=s['msisdn'], imsi=s['imsi'], subscriber_id=s['id'], |
| 167 | algo_str=s['auth_algo']) |
| 168 | slice_data = [ { \ |
| 169 | "sst": 1, \ |
| 170 | "default_indicator": True, \ |
| 171 | "session": [ \ |
| 172 | { \ |
| 173 | "name": "internet", \ |
| 174 | "type": 3, "pcc_rule": [], "ambr": {"uplink": {"value": 1, "unit": 0}, "downlink": {"value": 1, "unit": 0}}, \ |
| 175 | "qos": { "index": 9, "arp": {"priority_level": 8, "pre_emption_capability": 1, "pre_emption_vulnerability": 1} } \ |
| 176 | } \ |
| 177 | ] \ |
| 178 | } ] |
| 179 | |
| 180 | sub_data = {'imsi': s['imsi'], \ |
| 181 | 'subscribed_rau_tau_timer': 12, \ |
| 182 | 'network_access_mode': 2, \ |
| 183 | 'subscriber_status': 0, \ |
| 184 | "access_restriction_data": 32, \ |
| 185 | 'slice': slice_data, \ |
| 186 | 'ambr': {"uplink": {"value": 1, "unit": 0}, "downlink": {"value": 1, "unit": 0}}, \ |
| 187 | 'security': {'k': s['ki'], 'amf': '8000', 'op': None, 'opc': s['opc']}, |
| 188 | 'schema_version': 1, \ |
| 189 | '__v': 0} |
| 190 | x = mycol.insert_one(sub_data) |
| 191 | self.dbg("Added subscriber with Inserted ID : " + str(x.inserted_id)) |
| 192 | s['inserted_id'] = x.inserted_id |
| 193 | |
| 194 | def enb_is_connected(self, enb): |
| 195 | # Match against sample mmed line: "eNB-S1 accepted[172.18.50.101]:50867" |
| 196 | if not self.mme or not self.mme.running(): |
| 197 | return False |
| 198 | stdout_lines = (self.mme.process.get_stdout() or '').splitlines() |
| 199 | for l in stdout_lines: |
| 200 | if 'eNB' in l and 'accepted' in l and enb.addr() in l: |
| 201 | return True |
| 202 | return False |
| 203 | |
| 204 | def running(self): |
| 205 | return self.pcrf and self.upf and self.smf and self.hss and \ |
| 206 | self.mme and self.sgwc and self.sgwu and \ |
| 207 | self.pcrf.running() and self.upf.running() and self.smf.running() and \ |
| 208 | self.hss.running() and self.mme.running() and self.sgwc.running() and \ |
| 209 | self.sgwu.running() |
| 210 | |
| 211 | def tun_addr(self): |
| 212 | return '172.16.0.1' |
| 213 | |
| 214 | def get_kpis(self): |
| 215 | return {} |
| 216 | |
| 217 | # vim: expandtab tabstop=4 shiftwidth=4 |