mirror of
https://gitea.osmocom.org/cellular-infrastructure/osmo-hlr.git
synced 2025-11-03 05:33:28 +00:00
Compare commits
1 Commits
neels/dgsm
...
fixeria/sq
| Author | SHA1 | Date | |
|---|---|---|---|
|
8cdecdd54f |
22
.gitignore
vendored
22
.gitignore
vendored
@@ -2,12 +2,9 @@
|
||||
*.lo
|
||||
*.la
|
||||
*.db
|
||||
*.db-shm
|
||||
*.db-wal
|
||||
*.pyc
|
||||
.*.sw?
|
||||
.version
|
||||
.tarball-version
|
||||
Makefile
|
||||
Makefile.in
|
||||
aclocal.m4
|
||||
@@ -36,12 +33,10 @@ src/osmo-hlr
|
||||
src/osmo-hlr-db-tool
|
||||
src/osmo-euse-demo
|
||||
src/gsupclient/gsup-test-client
|
||||
src/mslookup/osmo-mslookup-client
|
||||
|
||||
tests/atconfig
|
||||
tests/testsuite
|
||||
tests/testsuite.log
|
||||
tests/testsuite.dir
|
||||
|
||||
tests/auc/auc_3g_test
|
||||
tests/auc/auc_ts_55_205_test_sets.c
|
||||
@@ -50,20 +45,3 @@ tests/auc/auc_test
|
||||
tests/gsup_server/gsup_server_test
|
||||
tests/gsup/gsup_test
|
||||
tests/db/db_test
|
||||
tests/hlr_vty_test.db*
|
||||
tests/db_upgrade/*.dump
|
||||
tests/mslookup/mdns_test
|
||||
tests/mslookup/mslookup_client_mdns_test
|
||||
tests/mslookup/mslookup_client_test
|
||||
tests/mslookup/mslookup_test
|
||||
|
||||
# manuals
|
||||
doc/manuals/*.html
|
||||
doc/manuals/*.svg
|
||||
doc/manuals/*.pdf
|
||||
doc/manuals/*__*.png
|
||||
doc/manuals/*.check
|
||||
doc/manuals/generated/
|
||||
doc/manuals/osmomsc-usermanual.xml
|
||||
doc/manuals/common
|
||||
doc/manuals/build
|
||||
|
||||
@@ -5,7 +5,6 @@ SUBDIRS = \
|
||||
src \
|
||||
include \
|
||||
sql \
|
||||
contrib \
|
||||
tests \
|
||||
$(NULL)
|
||||
|
||||
@@ -13,12 +12,8 @@ EXTRA_DIST = \
|
||||
.version \
|
||||
$(NULL)
|
||||
|
||||
AM_DISTCHECK_CONFIGURE_FLAGS = \
|
||||
--with-systemdsystemunitdir=$$dc_install_base/$(systemdsystemunitdir)
|
||||
|
||||
pkgconfigdir = $(libdir)/pkgconfig
|
||||
pkgconfig_DATA = libosmo-gsup-client.pc \
|
||||
libosmo-mslookup.pc
|
||||
pkgconfig_DATA = libosmo-gsup-client.pc
|
||||
|
||||
@RELMAKE@
|
||||
|
||||
|
||||
110
configure.ac
110
configure.ac
@@ -25,11 +25,6 @@ AC_PROG_MKDIR_P
|
||||
AC_PROG_CC
|
||||
AC_PROG_INSTALL
|
||||
|
||||
dnl patching ${archive_cmds} to affect generation of file "libtool" to fix linking with clang
|
||||
AS_CASE(["$LD"],[*clang*],
|
||||
[AS_CASE(["${host_os}"],
|
||||
[*linux*],[archive_cmds='$CC -shared $pic_flag $libobjs $deplibs $compiler_flags $wl-soname $wl$soname -o $lib'])])
|
||||
|
||||
dnl check for pkg-config (explained in detail in libosmocore/configure.ac)
|
||||
AC_PATH_PROG(PKG_CONFIG_INSTALLED, pkg-config, no)
|
||||
if test "x$PKG_CONFIG_INSTALLED" = "xno"; then
|
||||
@@ -39,11 +34,11 @@ PKG_PROG_PKG_CONFIG([0.20])
|
||||
|
||||
PKG_CHECK_MODULES(TALLOC, [talloc >= 2.0.1])
|
||||
|
||||
PKG_CHECK_MODULES(LIBOSMOCORE, libosmocore >= 1.3.0)
|
||||
PKG_CHECK_MODULES(LIBOSMOGSM, libosmogsm >= 1.3.0)
|
||||
PKG_CHECK_MODULES(LIBOSMOVTY, libosmovty >= 1.3.0)
|
||||
PKG_CHECK_MODULES(LIBOSMOCTRL, libosmoctrl >= 1.3.0)
|
||||
PKG_CHECK_MODULES(LIBOSMOABIS, libosmoabis >= 0.6.0)
|
||||
PKG_CHECK_MODULES(LIBOSMOCORE, libosmocore >= 0.11.0)
|
||||
PKG_CHECK_MODULES(LIBOSMOGSM, libosmogsm >= 0.11.0)
|
||||
PKG_CHECK_MODULES(LIBOSMOVTY, libosmovty >= 0.11.0)
|
||||
PKG_CHECK_MODULES(LIBOSMOCTRL, libosmoctrl >= 0.11.0)
|
||||
PKG_CHECK_MODULES(LIBOSMOABIS, libosmoabis >= 0.5.0)
|
||||
|
||||
PKG_CHECK_MODULES(SQLITE3, sqlite3)
|
||||
|
||||
@@ -64,21 +59,6 @@ then
|
||||
CPPFLAGS="$CPPFLAGS -fsanitize=address -fsanitize=undefined"
|
||||
fi
|
||||
|
||||
AC_ARG_ENABLE([sqlite_talloc],
|
||||
AC_HELP_STRING([--enable-sqlite-talloc],
|
||||
[Configure SQLite3 to use talloc memory allocator [default=no]]),
|
||||
[sqlite_talloc="$enableval"],[sqlite_talloc="no"])
|
||||
if test "x$sqlite_talloc" = "xyes" ; then
|
||||
# Older versions of SQLite3 (at least 3.8.2) become unstable with talloc.
|
||||
# Feel free to relax to 3.24.0 > VER > 3.8.2 if it works for you.
|
||||
# FIXME: PKG_CHECK_MODULES() may return cached result here!
|
||||
PKG_CHECK_MODULES(SQLITE3, sqlite3 >= 3.24.0)
|
||||
AC_DEFINE([SQLITE_USE_TALLOC], 1, [Use talloc for SQLite3])
|
||||
fi
|
||||
AC_MSG_CHECKING([whether to use talloc for SQLite3])
|
||||
AC_MSG_RESULT([$sqlite_talloc])
|
||||
AM_CONDITIONAL([DB_SQLITE_DEBUG], [test "x$sqlite_talloc" = "xyes"])
|
||||
|
||||
AC_ARG_ENABLE(werror,
|
||||
[AS_HELP_STRING(
|
||||
[--enable-werror],
|
||||
@@ -112,101 +92,21 @@ AC_MSG_CHECKING([whether to enable VTY/CTRL tests])
|
||||
AC_MSG_RESULT([$enable_ext_tests])
|
||||
AM_CONDITIONAL(ENABLE_EXT_TESTS, test "x$enable_ext_tests" = "xyes")
|
||||
|
||||
# mslookup_client_mdns_test (OS#4385: does not work everywhere)
|
||||
AC_ARG_ENABLE([mslookup_client_mdns_test],
|
||||
AC_HELP_STRING([--enable-mslookup-client-mdns-test],
|
||||
[Include the mslookup_client_mdns_test in make check [default=no]]),
|
||||
[enable_mslookup_client_mdns_test="$enableval"],[enable_mslookup_client_mdns_test="no"])
|
||||
AC_MSG_CHECKING([whether to enable mslookup_client_mdns_test])
|
||||
AC_MSG_RESULT([$enable_mslookup_client_mdns_test])
|
||||
AM_CONDITIONAL(ENABLE_MSLOOKUP_CLIENT_MDNS_TEST, test "x$enable_mslookup_client_mdns_test" = "xyes")
|
||||
|
||||
# Generate manuals
|
||||
AC_ARG_ENABLE(manuals,
|
||||
[AS_HELP_STRING(
|
||||
[--enable-manuals],
|
||||
[Generate manual PDFs [default=no]],
|
||||
)],
|
||||
[osmo_ac_build_manuals=$enableval], [osmo_ac_build_manuals="no"])
|
||||
AM_CONDITIONAL([BUILD_MANUALS], [test x"$osmo_ac_build_manuals" = x"yes"])
|
||||
AC_ARG_VAR(OSMO_GSM_MANUALS_DIR, [path to common osmo-gsm-manuals files, overriding pkg-config and "../osmo-gsm-manuals"
|
||||
fallback])
|
||||
if test x"$osmo_ac_build_manuals" = x"yes"
|
||||
then
|
||||
# Find OSMO_GSM_MANUALS_DIR (env, pkg-conf, fallback)
|
||||
if test -n "$OSMO_GSM_MANUALS_DIR"; then
|
||||
echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (from env)"
|
||||
else
|
||||
OSMO_GSM_MANUALS_DIR="$($PKG_CONFIG osmo-gsm-manuals --variable=osmogsmmanualsdir 2>/dev/null)"
|
||||
if test -n "$OSMO_GSM_MANUALS_DIR"; then
|
||||
echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (from pkg-conf)"
|
||||
else
|
||||
OSMO_GSM_MANUALS_DIR="../osmo-gsm-manuals"
|
||||
echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (fallback)"
|
||||
fi
|
||||
fi
|
||||
if ! test -d "$OSMO_GSM_MANUALS_DIR"; then
|
||||
AC_MSG_ERROR("OSMO_GSM_MANUALS_DIR does not exist! Install osmo-gsm-manuals or set OSMO_GSM_MANUALS_DIR.")
|
||||
fi
|
||||
|
||||
# Find and run check-depends
|
||||
CHECK_DEPENDS="$OSMO_GSM_MANUALS_DIR/check-depends.sh"
|
||||
if ! test -x "$CHECK_DEPENDS"; then
|
||||
CHECK_DEPENDS="osmo-gsm-manuals-check-depends"
|
||||
fi
|
||||
if ! $CHECK_DEPENDS; then
|
||||
AC_MSG_ERROR("missing dependencies for --enable-manuals")
|
||||
fi
|
||||
|
||||
# Put in Makefile with absolute path
|
||||
OSMO_GSM_MANUALS_DIR="$(realpath "$OSMO_GSM_MANUALS_DIR")"
|
||||
AC_SUBST([OSMO_GSM_MANUALS_DIR])
|
||||
fi
|
||||
|
||||
# https://www.freedesktop.org/software/systemd/man/daemon.html
|
||||
AC_ARG_WITH([systemdsystemunitdir],
|
||||
[AS_HELP_STRING([--with-systemdsystemunitdir=DIR], [Directory for systemd service files])],,
|
||||
[with_systemdsystemunitdir=auto])
|
||||
AS_IF([test "x$with_systemdsystemunitdir" = "xyes" -o "x$with_systemdsystemunitdir" = "xauto"], [
|
||||
def_systemdsystemunitdir=$($PKG_CONFIG --variable=systemdsystemunitdir systemd)
|
||||
|
||||
AS_IF([test "x$def_systemdsystemunitdir" = "x"],
|
||||
[AS_IF([test "x$with_systemdsystemunitdir" = "xyes"],
|
||||
[AC_MSG_ERROR([systemd support requested but pkg-config unable to query systemd package])])
|
||||
with_systemdsystemunitdir=no],
|
||||
[with_systemdsystemunitdir="$def_systemdsystemunitdir"])])
|
||||
AS_IF([test "x$with_systemdsystemunitdir" != "xno"],
|
||||
[AC_SUBST([systemdsystemunitdir], [$with_systemdsystemunitdir])])
|
||||
AM_CONDITIONAL([HAVE_SYSTEMD], [test "x$with_systemdsystemunitdir" != "xno"])
|
||||
|
||||
AC_MSG_RESULT([CFLAGS="$CFLAGS"])
|
||||
AC_MSG_RESULT([CPPFLAGS="$CPPFLAGS"])
|
||||
|
||||
AC_OUTPUT(
|
||||
Makefile
|
||||
doc/Makefile
|
||||
doc/examples/Makefile
|
||||
doc/sequence_charts/Makefile
|
||||
src/Makefile
|
||||
src/gsupclient/Makefile
|
||||
src/mslookup/Makefile
|
||||
include/Makefile
|
||||
include/osmocom/Makefile
|
||||
include/osmocom/hlr/Makefile
|
||||
include/osmocom/mslookup/Makefile
|
||||
libosmo-gsup-client.pc
|
||||
libosmo-mslookup.pc
|
||||
sql/Makefile
|
||||
doc/manuals/Makefile
|
||||
contrib/Makefile
|
||||
contrib/systemd/Makefile
|
||||
contrib/dgsm/Makefile
|
||||
tests/Makefile
|
||||
tests/auc/Makefile
|
||||
tests/auc/gen_ts_55_205_test_sets/Makefile
|
||||
tests/gsup_server/Makefile
|
||||
tests/gsup/Makefile
|
||||
tests/db/Makefile
|
||||
tests/db_upgrade/Makefile
|
||||
tests/mslookup/Makefile
|
||||
)
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
SUBDIRS = \
|
||||
systemd \
|
||||
dgsm \
|
||||
$(NULL)
|
||||
@@ -1,6 +0,0 @@
|
||||
EXTRA_DIST = \
|
||||
esme_dgsm.py \
|
||||
freeswitch_dialplan_dgsm.py \
|
||||
osmo-mslookup-pipe.py \
|
||||
osmo-mslookup-socket.py \
|
||||
$(NULL)
|
||||
@@ -1,184 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
SPDX-License-Identifier: MIT
|
||||
Copyright 2019 sysmocom s.f.m.c GmbH <info@sysmocom.de>
|
||||
|
||||
WARNING: this is just a proof-of-concept implementation, it blocks for every
|
||||
received SMPP request and is not suitable for servicing more than one request
|
||||
at a time.
|
||||
|
||||
Based on esme.py from RCCN (license changed with permission from author):
|
||||
https://github.com/Rhizomatica/rccn/blob/master/rccn/esme.py
|
||||
Copyright 2017 keith <keith@rhizomatica.org>
|
||||
|
||||
Forward SMS to the receiver's SMSC, as determined with mslookup.
|
||||
Requires smpplip (pip3 install --user smpplib) and osmo-mslookup-client.
|
||||
|
||||
Example SMPP configuration for osmo-msc.cfg:
|
||||
smpp
|
||||
local-tcp-ip 127.0.0.1 2775
|
||||
policy closed
|
||||
smpp-first
|
||||
# outgoing to esme_dgsm.py
|
||||
esme OSMPP
|
||||
no alert-notifications
|
||||
password foo
|
||||
default-route
|
||||
# incoming from esme_dgsm.py
|
||||
esme ISMPP
|
||||
no alert-notifications
|
||||
password foo
|
||||
"""
|
||||
import argparse
|
||||
import json
|
||||
import logging
|
||||
import smpplib
|
||||
import subprocess
|
||||
import time
|
||||
|
||||
|
||||
def can_handle_pdu(pdu):
|
||||
if not isinstance(pdu, smpplib.command.DeliverSM):
|
||||
logging.info('PDU is not a DeliverSM, ignoring')
|
||||
return False
|
||||
|
||||
if int(pdu.dest_addr_ton) == smpplib.consts.SMPP_TON_INTL:
|
||||
logging.info("Unable to handle SMS for %s: SMPP_TON_INTL" %
|
||||
(pdu.destination_addr))
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def query_mslookup(service_type, id, id_type='msisdn'):
|
||||
query_str = '%s.%s.%s' % (service_type, id, id_type)
|
||||
logging.info('mslookup: ' + query_str)
|
||||
|
||||
result_line = subprocess.check_output(['osmo-mslookup-client', query_str,
|
||||
'-f', 'json'])
|
||||
if isinstance(result_line, bytes):
|
||||
result_line = result_line.decode('ascii')
|
||||
|
||||
logging.info('mslookup result: ' + result_line.rstrip())
|
||||
return json.loads(result_line)
|
||||
|
||||
|
||||
def tx_sms(dst_host, dst_port, source, destination, registered_delivery,
|
||||
unicode_text):
|
||||
smpp_client = smpplib.client.Client(dst_host, dst_port, 90)
|
||||
smpp_client.connect()
|
||||
smpp_client.bind_transceiver(system_id=args.dst_id, password=args.dst_pass)
|
||||
logging.info('Connected to destination SMSC (%s@%s:%s)' % (args.dst_id,
|
||||
dst_host, dst_port))
|
||||
|
||||
pdu = smpp_client.send_message(
|
||||
source_addr_ton=smpplib.consts.SMPP_TON_ALNUM,
|
||||
source_addr_npi=smpplib.consts.SMPP_NPI_UNK,
|
||||
source_addr=source.decode(),
|
||||
dest_addr_ton=smpplib.consts.SMPP_TON_SBSCR,
|
||||
dest_addr_npi=smpplib.consts.SMPP_NPI_ISDN,
|
||||
destination_addr=destination.decode(),
|
||||
short_message=unicode_text,
|
||||
registered_delivery=registered_delivery,
|
||||
)
|
||||
|
||||
smpp_client.unbind()
|
||||
smpp_client.disconnect()
|
||||
del pdu
|
||||
del smpp_client
|
||||
|
||||
|
||||
def rx_deliver_sm(pdu):
|
||||
if not can_handle_pdu(pdu):
|
||||
return smpplib.consts.SMPP_ESME_RSYSERR
|
||||
|
||||
msisdn = pdu.destination_addr.decode()
|
||||
logging.info("Incoming SMS for: " + msisdn)
|
||||
|
||||
if args.sleep:
|
||||
logging.info("Sleeping for %i seconds" % (args.sleep))
|
||||
time.sleep(args.sleep)
|
||||
logging.info("Sleep done")
|
||||
|
||||
if args.always_fail is not None:
|
||||
return args.always_fail
|
||||
|
||||
result = query_mslookup("smpp.sms", msisdn)
|
||||
if 'v4' not in result or not result['v4']:
|
||||
logging.info('No IPv4 result from mslookup! This example only'
|
||||
' makes use of IPv4, dropping.')
|
||||
return smpplib.consts.SMPP_ESME_RSYSERR
|
||||
|
||||
dst_host, dst_port = result['v4']
|
||||
tx_sms(dst_host, dst_port, pdu.source_addr,
|
||||
pdu.destination_addr, int(pdu.registered_delivery),
|
||||
pdu.short_message)
|
||||
|
||||
return smpplib.consts.SMPP_ESME_ROK
|
||||
|
||||
|
||||
def smpp_bind():
|
||||
client = smpplib.client.Client(args.src_host, args.src_port, 90)
|
||||
client.set_message_received_handler(rx_deliver_sm)
|
||||
client.connect()
|
||||
client.bind_transceiver(system_id=args.src_id, password=args.src_pass)
|
||||
logging.info('Connected to source SMSC (%s@%s:%s)' % (args.src_id,
|
||||
args.src_host, args.src_port))
|
||||
logging.info('Waiting for SMS...')
|
||||
client.listen()
|
||||
|
||||
|
||||
def main():
|
||||
global args
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument('--src-host', default='127.0.0.1',
|
||||
help='source SMSC (OsmoMSC) host (default: 127.0.0.1)')
|
||||
parser.add_argument('--src-port', default=2775, type=int,
|
||||
help='source SMSC (OsmoMSC) port (default: 2775)')
|
||||
parser.add_argument('--src-id', default='OSMPP',
|
||||
help='source system id, as configured in osmo-msc.cfg'
|
||||
' (default: OSMPP)')
|
||||
parser.add_argument('--src-pass', default='foo',
|
||||
help='source system password, as configured in'
|
||||
' osmo-msc.cfg (default: foo)')
|
||||
parser.add_argument('--dst-id', default='ISMPP',
|
||||
help='destination system id, as configured in'
|
||||
' osmo-msc.cfg (default: ISMPP)')
|
||||
parser.add_argument('--dst-pass', default='foo',
|
||||
help='destination system password, as configured in'
|
||||
' osmo-msc.cfg (default: foo)')
|
||||
parser.add_argument('--sleep', default=0, type=float,
|
||||
help='sleep time in seconds before forwarding an SMS,'
|
||||
' to test multithreading (default: 0)')
|
||||
parser.add_argument('--always-fail', default=None, metavar='SMPP_ESME_ERRCODE',
|
||||
help='test delivery failure: always return an error code on Deliver-SM,'
|
||||
' pass an smpplib error code name like RDELIVERYFAILURE (see smpplib/consts.py),'
|
||||
' or an SMPP error code in hex digits')
|
||||
args = parser.parse_args()
|
||||
|
||||
logging.basicConfig(level=logging.INFO, format='[%(asctime)s]'
|
||||
' (%(threadName)s) %(message)s', datefmt="%H:%M:%S")
|
||||
|
||||
if args.always_fail:
|
||||
resolved = None
|
||||
name = 'SMPP_ESME_' + args.always_fail
|
||||
if hasattr(smpplib.consts, name):
|
||||
resolved = getattr(smpplib.consts, name)
|
||||
if resolved is None:
|
||||
try:
|
||||
resolved = int(args.always_fail, 16)
|
||||
except ValueError:
|
||||
resolved = None
|
||||
if resolved is None:
|
||||
print('Invalid argument for --always-fail: %r' % args.always_fail)
|
||||
exit(1)
|
||||
args.always_fail = resolved
|
||||
logging.info('--always-fail: returning error code %s to all Deliver-SM' % hex(args.always_fail))
|
||||
|
||||
smpp_bind()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
||||
# vim: expandtab tabstop=4 shiftwidth=4
|
||||
@@ -1,77 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
SPDX-License-Identifier: MIT
|
||||
Copyright 2019 sysmocom s.f.m.c GmbH <info@sysmocom.de>
|
||||
|
||||
This is a freeswitch dialplan implementation, see:
|
||||
https://freeswitch.org/confluence/display/FREESWITCH/mod_python
|
||||
|
||||
Find the right SIP server with mslookup (depending on the destination number)
|
||||
and bridge calls accordingly.
|
||||
"""
|
||||
import json
|
||||
import subprocess
|
||||
|
||||
|
||||
def query_mslookup(service_type, id, id_type='msisdn'):
|
||||
query_str = '%s.%s.%s' % (service_type, id, id_type)
|
||||
print('[dialplan-dgsm] mslookup: ' + query_str)
|
||||
|
||||
result_line = subprocess.check_output([
|
||||
'osmo-mslookup-client', query_str, '-f', 'json'])
|
||||
if isinstance(result_line, bytes):
|
||||
result_line = result_line.decode('ascii')
|
||||
|
||||
print('[dialplan-dgsm] mslookup result: ' + result_line)
|
||||
return json.loads(result_line)
|
||||
|
||||
|
||||
def handler(session, args):
|
||||
""" Handle calls: bridge to the SIP server found with mslookup. """
|
||||
print('[dialplan-dgsm] call handler')
|
||||
msisdn = session.getVariable('destination_number')
|
||||
|
||||
# Run osmo-mslookup-client binary. We have also tried to directly call the
|
||||
# C functions with ctypes but this has lead to hard-to-debug segfaults.
|
||||
try:
|
||||
result = query_mslookup("sip.voice", msisdn)
|
||||
|
||||
# This example only makes use of IPv4
|
||||
if not result['v4']:
|
||||
print('[dialplan-dgsm] no IPv4 result from mslookup')
|
||||
session.hangup('UNALLOCATED_NUMBER')
|
||||
return
|
||||
|
||||
sip_ip, sip_port = result['v4']
|
||||
dial_str = 'sofia/internal/sip:{}@{}:{}'.format(
|
||||
msisdn, sip_ip, sip_port)
|
||||
print('[dialplan-dgsm] dial_str: ' + str(dial_str))
|
||||
|
||||
session.execute('bridge', dial_str)
|
||||
except:
|
||||
print('[dialplan-dgsm]: exception during call handler')
|
||||
session.hangup('UNALLOCATED_NUMBER')
|
||||
|
||||
|
||||
def fsapi(session, stream, env, args):
|
||||
""" Freeswitch refuses to load the module without this. """
|
||||
stream.write(env.serialize())
|
||||
|
||||
|
||||
def main():
|
||||
import argparse
|
||||
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument('id', type=int)
|
||||
parser.add_argument('-i', '--id-type', default='msisdn',
|
||||
help='default: "msisdn"')
|
||||
parser.add_argument('-s', '--service', default='sip.voice',
|
||||
help='default: "sip.voice"')
|
||||
args = parser.parse_args()
|
||||
|
||||
result = query_mslookup(args.service, args.id, args.id_type)
|
||||
print(json.dumps(result))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -1,24 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
# vim: shiftwidth=4 tabstop=4 expandtab
|
||||
import subprocess
|
||||
import json
|
||||
|
||||
def query_mslookup(query_str):
|
||||
result = {'result': 'not-found'}
|
||||
proc = subprocess.Popen(('osmo-mslookup-client', '-f', 'json', query_str),
|
||||
stdout=subprocess.PIPE)
|
||||
for line in iter(proc.stdout.readline,''):
|
||||
if not line:
|
||||
break
|
||||
response = json.loads(line)
|
||||
if response.get('result') == 'result':
|
||||
result = response
|
||||
print('Response: %r' % response)
|
||||
return result
|
||||
|
||||
if __name__ == '__main__':
|
||||
import sys
|
||||
query_str = '1000-5000@sip.voice.12345.msisdn'
|
||||
if len(sys.argv) > 1:
|
||||
query_str = sys.argv[1]
|
||||
print('Final result: %r' % query_mslookup(query_str))
|
||||
@@ -1,35 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
# vim: shiftwidth=4 tabstop=4 expandtab
|
||||
import socket
|
||||
import time
|
||||
|
||||
MSLOOKUP_SOCKET_PATH = '/tmp/mslookup'
|
||||
|
||||
def query_mslookup_socket(query_str, socket_path=MSLOOKUP_SOCKET_PATH):
|
||||
mslookup_socket = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET)
|
||||
mslookup_socket.setblocking(True)
|
||||
mslookup_socket.connect(socket_path)
|
||||
result = {'result': 'not-found'}
|
||||
column_names = mslookup_socket.recv(1024).decode('ascii')
|
||||
if not column_names:
|
||||
return result
|
||||
column_names = column_names.split('\t')
|
||||
mslookup_socket.sendall(query_str.encode('ascii'))
|
||||
while True:
|
||||
csv = mslookup_socket.recv(1024).decode('ascii')
|
||||
if not csv:
|
||||
break
|
||||
response = dict(zip(column_names, csv.split('\t')))
|
||||
if response.get('result') == 'result':
|
||||
result = response
|
||||
print('Response: %r' % response)
|
||||
return result
|
||||
|
||||
if __name__ == '__main__':
|
||||
import sys
|
||||
print(
|
||||
'\nPlease run separately: osmo-mslookup-client --socket /tmp/mslookup -d\n')
|
||||
query_str = '1000-5000@sip.voice.12345.msisdn'
|
||||
if len(sys.argv) > 1:
|
||||
query_str = sys.argv[1]
|
||||
print('Final result: %r' % query_mslookup_socket(query_str))
|
||||
@@ -1,10 +1,5 @@
|
||||
#!/bin/sh
|
||||
# jenkins build helper script for osmo-hlr. This is how we build on jenkins.osmocom.org
|
||||
#
|
||||
# environment variables:
|
||||
# * WITH_MANUALS: build manual PDFs if set to "1"
|
||||
# * PUBLISH: upload manuals after building if set to "1" (ignored without WITH_MANUALS = "1")
|
||||
#
|
||||
|
||||
if ! [ -x "$(command -v osmo-build-dep.sh)" ]; then
|
||||
echo "Error: We need to have scripts/osmo-deps.sh from http://git.osmocom.org/osmo-ci/ in PATH !"
|
||||
@@ -27,18 +22,10 @@ verify_value_string_arrays_are_terminated.py $(find . -name "*.[hc]")
|
||||
|
||||
export PKG_CONFIG_PATH="$inst/lib/pkgconfig:$PKG_CONFIG_PATH"
|
||||
export LD_LIBRARY_PATH="$inst/lib"
|
||||
export PATH="$inst/bin:$PATH"
|
||||
|
||||
osmo-build-dep.sh libosmocore "" ac_cv_path_DOXYGEN=false
|
||||
osmo-build-dep.sh libosmo-abis
|
||||
|
||||
# Additional configure options and depends
|
||||
CONFIG=""
|
||||
if [ "$WITH_MANUALS" = "1" ]; then
|
||||
osmo-build-dep.sh osmo-gsm-manuals
|
||||
CONFIG="--enable-manuals"
|
||||
fi
|
||||
|
||||
set +x
|
||||
echo
|
||||
echo
|
||||
@@ -49,19 +36,9 @@ set -x
|
||||
|
||||
cd "$base"
|
||||
autoreconf --install --force
|
||||
./configure \
|
||||
--enable-sanitize \
|
||||
--enable-external-tests \
|
||||
--enable-mslookup-client-mdns-test \
|
||||
--enable-werror \
|
||||
$CONFIG
|
||||
./configure --enable-sanitize --enable-external-tests --enable-werror
|
||||
$MAKE $PARALLEL_MAKE
|
||||
$MAKE check || cat-testlogs.sh
|
||||
DISTCHECK_CONFIGURE_FLAGS="$CONFIG" $MAKE distcheck || cat-testlogs.sh
|
||||
$MAKE distcheck || cat-testlogs.sh
|
||||
|
||||
if [ "$WITH_MANUALS" = "1" ] && [ "$PUBLISH" = "1" ]; then
|
||||
make -C "$base/doc/manuals" publish
|
||||
fi
|
||||
|
||||
$MAKE maintainer-clean
|
||||
osmo-clean-workspace.sh
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
EXTRA_DIST = osmo-hlr.service
|
||||
|
||||
if HAVE_SYSTEMD
|
||||
systemdsystemunit_DATA = \
|
||||
osmo-hlr.service
|
||||
endif
|
||||
@@ -1,6 +1,5 @@
|
||||
[Unit]
|
||||
Description=Osmocom Home Location Register (OsmoHLR)
|
||||
Documentation=https://osmocom.org/projects/osmo-hlr/wiki/OsmoHLR
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
|
||||
180
debian/changelog
vendored
180
debian/changelog
vendored
@@ -1,183 +1,3 @@
|
||||
osmo-hlr (1.2.0) unstable; urgency=medium
|
||||
|
||||
[ Ruben Undheim ]
|
||||
* Fix test for return codes on mipsel and alpha archs
|
||||
|
||||
[ Thorsten Alteholz ]
|
||||
* fix spelling errors detected by lintian
|
||||
|
||||
[ Pau Espin Pedrol ]
|
||||
* tests: Fix db_test err file to expect error code name instead of value
|
||||
|
||||
[ Oliver Smith ]
|
||||
* tests/test_nodes.vty: check less libosmocore cmds
|
||||
* tests/db_upgrade: disable for old sqlite versions
|
||||
* gitignore: add tests/db_upgrade/*.dump
|
||||
* gsup_client.h: fix license header: GPLv2+
|
||||
* tests/auc: change back to python3
|
||||
|
||||
[ Neels Hofmeyr ]
|
||||
* fix double free in osmo_gsup_client_enc_send()
|
||||
* db upgrade to v2: log version 2, not 1
|
||||
* fix upgrade to version 2: imei column default value
|
||||
* add --db-check option
|
||||
* hlr.sql: move comment
|
||||
* add db_upgrade test
|
||||
* hlr db schema 3: hlr_number -> msc_number
|
||||
* db.c: code dup: add db_run_statements() for arrays of statements
|
||||
* move headers to include/osmocom/hlr
|
||||
* fix upgrade test in presence of ~/.sqliterc
|
||||
* db upgrade: remove some code dup
|
||||
* add osmo_gsup_msgb_alloc()
|
||||
* Makefile convenience: add VTY_TEST var to run only one test
|
||||
* remove gsup_test
|
||||
* test_nodes.vty: tweak: add some '?' checks
|
||||
* db v4: add column last_lu_seen_ps
|
||||
|
||||
[ Harald Welte ]
|
||||
* AUC: Add support for setting the AMF separation bit to '1' for EUTRAN
|
||||
* hlr: exit(2) on unsupported positional arguments on command line
|
||||
|
||||
-- Pau Espin Pedrol <pespin@sysmocom.de> Fri, 03 Jan 2020 12:37:35 +0100
|
||||
|
||||
osmo-hlr (1.1.0) unstable; urgency=medium
|
||||
|
||||
[ Oliver Smith ]
|
||||
* docs: running: document --db-upgrade
|
||||
* Add IMEI column to subscriber table
|
||||
* Optionally store IMEI in subscriber table
|
||||
* VTY tests: fill DB before running test
|
||||
* VTY: integrate IMEI
|
||||
* hlr.c: replace deprecated osmo_gsup_get_err_msg_type()
|
||||
* hlr.c: move hlr_ctx to the top
|
||||
* tests: use -no-install libtool flag to avoid ./lt-* scripts
|
||||
* Cosmetic: gsup_route_find: comment addr, addrlen
|
||||
* USSD: save MO USSD's originating MSC's vlr_number
|
||||
* USSD: don't use gsm0480_msgb_alloc_name()
|
||||
* hlr.c: forward GSUP messages between clients
|
||||
* db_hlr.c: db_subscr_create(): add flags argument
|
||||
* db_hlr.c: add db_subscr_exists_by_imsi()
|
||||
* Create subscribers on demand
|
||||
* Document subscribers create on demand feature
|
||||
* debian: create -doc subpackage with pdf manuals
|
||||
* db_test: set timezone to work around mktime bug
|
||||
* db_hlr: zero-initialize "struct tm"
|
||||
* rx_check_imei_req(): fix IMEI bounds checking
|
||||
* contrib/jenkins.sh: run "make maintainer-clean"
|
||||
* VTY: add subscriber update network-access-mode
|
||||
* manuals: improve subscribers create on demand
|
||||
* gitignore: ignore everything generated in db_test
|
||||
* db_auc.c: verify hex key sizes read from DB
|
||||
|
||||
[ Max ]
|
||||
* Log ip:port when adding GSUP routes
|
||||
* Add link to project wiki to .service file
|
||||
* Enable statsd support
|
||||
|
||||
[ Vadim Yanitskiy ]
|
||||
* hlr.c: properly terminate the process on SIGTERM
|
||||
* hlr.c: fix: also store the session state in read_cb_forward()
|
||||
* hlr.c: fix: properly print the original message type in read_cb_forward()
|
||||
* hlr.c: check the presence of msgb->l2h in read_cb()
|
||||
* hlr.c: fix possible msgb memleaks in read_cb()
|
||||
* db_hlr.c: add db_subscr_exists_by_msisdn()
|
||||
* src/db.h: use GSM23003_MSISDN_MAX_DIGITS for MSISDN buffer size
|
||||
* src/hlr.c: fix deprecation warning: use gsm48_decode_bcd_number2()
|
||||
* hlr_ussd.c: fix: properly pass invokeID in handle_ussd_own_msisdn()
|
||||
* hlr_ussd.c: rx_proc_ss_req(): fix NULL pointer dereference
|
||||
* build: fix mess with 'db_test_SOURCES' and 'db_test_LDADD'
|
||||
* tests/db_test: close the database when test is finished
|
||||
* src/db.c: integrate SQLite3 with talloc allocator
|
||||
|
||||
[ Neels Hofmeyr ]
|
||||
* USSD: fix routing to multiple MSC
|
||||
* fix error logging for GSUP route
|
||||
* add missing error log: invalid IMSI
|
||||
* osmo-hlr: allow configuring db path from cfg file
|
||||
* use new OSMO_IMSI_BUF_SIZE
|
||||
|
||||
[ Daniel Willmann ]
|
||||
* manuals: Add script to update vty/counter documentation from docker
|
||||
* manuals: Update vty documentation
|
||||
|
||||
[ Pau Espin Pedrol ]
|
||||
* Remove undefined param passed to logging_vty_add_cmds
|
||||
* configure.ac: Require libosmocore 1.2.0
|
||||
|
||||
-- Pau Espin Pedrol <pespin@sysmocom.de> Wed, 07 Aug 2019 16:14:23 +0200
|
||||
|
||||
osmo-hlr (1.0.0) unstable; urgency=medium
|
||||
|
||||
[ Stefan Sperling ]
|
||||
* move creation of insert subscriber data messages to a common function
|
||||
|
||||
[ Harald Welte ]
|
||||
* Return proper GSUP error in case of too short IMSI
|
||||
* disable blind subscriber insertion into every VLR/SGSN
|
||||
* gsup_server: Add "priv" pointer and make it point to 'struct hlr'
|
||||
* move osmo_gsup_addr_send() declaration from luop.h to gsup_router.h
|
||||
* gsup_router: Use "#pragma once" and add missing #includes
|
||||
* Add "show gsup-connections" VTY command
|
||||
* import gsup_client.c as new libosmo-gsup-client
|
||||
* gsup_client: rename gsup_client_* to osmo_gsup_client_*
|
||||
* GSUP: Log GSUP route add/remove
|
||||
* hlr: Export + Declare global g_hlr symbol
|
||||
* USSD: Add Core USSD handling + VTY routing config to HLR
|
||||
* USSD: Add basic dispatch + decode of GSUP-encapsulated SS/USSD
|
||||
* hlr_ussd: Introduce LOGPSS() macro
|
||||
* USSD: Send ReturnError component if USSD Code unknown / EUSE disconnected
|
||||
* USSD: Further unification of log output; Use LOGPSS when possible
|
||||
* osmo-hlr.cfg: Don't enable DEBUG logging by default
|
||||
* USSD: Add new "DSS" logging category and use it appropriately
|
||||
* USSD: fix null-pointer deref in "default-route" vty/config cmd
|
||||
* Add osmo-euse-demo as minimalistic test of a External USSD (EUSE) handler
|
||||
* USSD: Add support for internal USSD handlers
|
||||
* debian: Add sub-package for libosmo-gsup-client
|
||||
* pkg-config: Fix libosmo-gsup-client pkg-config file
|
||||
* gitignore: Add .tarball-version
|
||||
* debian: Make libosmo-gsup-client-dev depend on libosmo-gsup-client0
|
||||
* USSD: Fix "ussd default-route"
|
||||
* libosmo-gsup-client: License is GPLv2-or-later
|
||||
* osmo-hlr.cfg: Ensure well-formed config file example
|
||||
* test_nodes.vty: Since libosmocore 1.0.0, we only have one space
|
||||
|
||||
[ Martin Hauke ]
|
||||
* sql/Makefile.am: Make docsdir completely configurable
|
||||
* debian: Fix typo in package description
|
||||
|
||||
[ Pau Espin Pedrol ]
|
||||
* debian: Avoid installing duplicate cfg file in /etc
|
||||
* sql/Makefile: Install hlr_data.sql as example together with hlr.sql
|
||||
* sql/Makefile: Install sql files under doc/.../sql subdir
|
||||
* sql/Makefile: Create empty /var/lib/osmocom directory at install time
|
||||
* Install systemd services with autotools
|
||||
* Move doc/Makefile.am to doc/examples/Makefile.am
|
||||
* Install sample cfg file to /etc/osmocom
|
||||
|
||||
[ Vadim Yanitskiy ]
|
||||
* hlr.c: move deinitialization code from SIGINT handler
|
||||
* hlr.c: free root talloc context on exit
|
||||
* hlr.c: track the use of talloc NULL memory contexts
|
||||
* src/db.c: fix: make sure the database is properly closed
|
||||
* src/db.c: don't ignore the result of db_bootstrap()
|
||||
* hlr_vty_subscr.c: fix subscriber creation command help
|
||||
* Update .gitignore: add missing build products
|
||||
* tests/Makefile.am: also remove temporary sqlite files
|
||||
* hlr_ussd.h: add #pragma once include guard
|
||||
* hlr_ussd.h: use proper libc headers
|
||||
* Update .gitignore: ignore osmo-euse-demo
|
||||
* hlr_ussd.h: drop meaningless forward declaration
|
||||
* USSD/hlr_vty.c: print error if EUSE is not found
|
||||
* hlr_ussd.c: fix: properly print a EUSE / IUSE name
|
||||
* hlr_ussd.c: avoid using CR and NL in IUSE responses
|
||||
|
||||
[ Neels Hofmeyr ]
|
||||
* fix build: adjust test_nodes.vty to logging change
|
||||
* tweak example config
|
||||
* make: always allow running python tests manually
|
||||
|
||||
-- Harald Welte <laforge@gnumonks.org> Sun, 20 Jan 2019 19:29:58 +0100
|
||||
|
||||
osmo-hlr (0.2.1) unstable; urgency=medium
|
||||
|
||||
[ Neels Hofmeyr ]
|
||||
|
||||
61
debian/control
vendored
61
debian/control
vendored
@@ -7,13 +7,12 @@ Build-Depends: debhelper (>= 9),
|
||||
dh-autoreconf,
|
||||
dh-systemd (>= 1.5),
|
||||
autotools-dev,
|
||||
python3-minimal,
|
||||
python-minimal,
|
||||
libosmocore-dev,
|
||||
libosmo-abis-dev,
|
||||
libosmo-netif-dev,
|
||||
libsqlite3-dev,
|
||||
sqlite3,
|
||||
osmo-gsm-manuals-dev
|
||||
sqlite3
|
||||
Standards-Version: 3.9.6
|
||||
Vcs-Browser: http://cgit.osmocom.org/osmo-hlr
|
||||
Vcs-Git: git://git.osmocom.org/osmo-hlr
|
||||
@@ -33,59 +32,3 @@ Priority: extra
|
||||
Depends: osmo-hlr (= ${binary:Version}), ${misc:Depends}
|
||||
Description: Debug symbols for the osmo-hlr
|
||||
Make debugging possible
|
||||
|
||||
Package: libosmo-gsup-client0
|
||||
Section: libs
|
||||
Architecture: any
|
||||
Multi-Arch: same
|
||||
Depends: ${shlibs:Depends},
|
||||
${misc:Depends}
|
||||
Pre-Depends: ${misc:Pre-Depends}
|
||||
Description: Osmocom GSUP (General Subscriber Update Protocol) client library
|
||||
This is a shared library that can be used to implement client programs for
|
||||
the GSUP protocol. The typical GSUP server is OsmoHLR, with OsmoMSC, OsmoSGSN
|
||||
and External USSD Entities (EUSEs) using this library to implement clients.
|
||||
|
||||
Package: libosmo-gsup-client-dev
|
||||
Architecture: any
|
||||
Multi-Arch: same
|
||||
Depends: ${misc:Depends},
|
||||
libosmo-gsup-client0 (= ${binary:Version}),
|
||||
libosmocore-dev
|
||||
Description: Development headers of Osmocom GSUP client library
|
||||
This is a shared library that can be used to implement client programs for
|
||||
the GSUP protocol. The typical GSUP server is OsmoHLR, with OsmoMSC, OsmoSGSN
|
||||
and External USSD Entities (EUSEs) using this library to implement clients.
|
||||
.
|
||||
This package contains the development headers.
|
||||
|
||||
Package: libosmo-mslookup0
|
||||
Section: libs
|
||||
Architecture: any
|
||||
Multi-Arch: same
|
||||
Depends: ${shlibs:Depends},
|
||||
${misc:Depends}
|
||||
Pre-Depends: ${misc:Pre-Depends}
|
||||
Description: Osmocom MS lookup library
|
||||
This shared library contains routines for looking up mobile subscribers.
|
||||
|
||||
Package: libosmo-mslookup-dev
|
||||
Architecture: any
|
||||
Multi-Arch: same
|
||||
Depends: ${misc:Depends},
|
||||
libosmo-mslookup0 (= ${binary:Version}),
|
||||
libosmocore-dev
|
||||
Pre-Depends: ${misc:Pre-Depends}
|
||||
Description: Development headers of Osmocom MS lookup library
|
||||
This shared library contains routines for looking up mobile subscribers.
|
||||
.
|
||||
This package contains the development headers.
|
||||
|
||||
Package: osmo-hlr-doc
|
||||
Architecture: all
|
||||
Section: doc
|
||||
Priority: optional
|
||||
Depends: ${misc:Depends}
|
||||
Description: ${misc:Package} PDF documentation
|
||||
Various manuals: user manual, VTY reference manual and/or
|
||||
protocol/interface manuals.
|
||||
|
||||
5
debian/libosmo-gsup-client-dev.install
vendored
5
debian/libosmo-gsup-client-dev.install
vendored
@@ -1,5 +0,0 @@
|
||||
usr/include/osmocom/gsupclient
|
||||
usr/lib/*/libosmo-gsup-client*.a
|
||||
usr/lib/*/libosmo-gsup-client*.so
|
||||
usr/lib/*/libosmo-gsup-client*.la
|
||||
usr/lib/*/pkgconfig/libosmo-gsup-client.pc
|
||||
1
debian/libosmo-gsup-client0.install
vendored
1
debian/libosmo-gsup-client0.install
vendored
@@ -1 +0,0 @@
|
||||
usr/lib/*/libosmo-gsup-client*.so.*
|
||||
5
debian/libosmo-mslookup-dev.install
vendored
5
debian/libosmo-mslookup-dev.install
vendored
@@ -1,5 +0,0 @@
|
||||
usr/include/osmocom/mslookup
|
||||
usr/lib/*/libosmo-mslookup*.a
|
||||
usr/lib/*/libosmo-mslookup*.so
|
||||
usr/lib/*/libosmo-mslookup*.la
|
||||
usr/lib/*/pkgconfig/libosmo-mslookup.pc
|
||||
1
debian/libosmo-mslookup0.install
vendored
1
debian/libosmo-mslookup0.install
vendored
@@ -1 +0,0 @@
|
||||
usr/lib/*/libosmo-mslookup*.so.*
|
||||
1
debian/osmo-hlr-doc.install
vendored
1
debian/osmo-hlr-doc.install
vendored
@@ -1 +0,0 @@
|
||||
usr/share/doc/osmo-hlr-doc/*.pdf
|
||||
2
debian/osmo-hlr.install
vendored
2
debian/osmo-hlr.install
vendored
@@ -1,5 +1,3 @@
|
||||
/etc/osmocom/osmo-hlr.cfg
|
||||
/lib/systemd/system/osmo-hlr.service
|
||||
/usr/bin/osmo-hlr
|
||||
/usr/bin/osmo-hlr-db-tool
|
||||
/usr/share/doc/osmo-hlr/sql/hlr.sql
|
||||
|
||||
1
debian/osmo-hlr.service
vendored
Symbolic link
1
debian/osmo-hlr.service
vendored
Symbolic link
@@ -0,0 +1 @@
|
||||
../contrib/systemd/osmo-hlr.service
|
||||
7
debian/rules
vendored
7
debian/rules
vendored
@@ -15,10 +15,3 @@ override_dh_strip:
|
||||
# Print test results in case of a failure
|
||||
override_dh_auto_test:
|
||||
dh_auto_test || (find . -name testsuite.log -exec cat {} \; ; false)
|
||||
|
||||
override_dh_auto_configure:
|
||||
dh_auto_configure -- --with-systemdsystemunitdir=/lib/systemd/system --enable-manuals
|
||||
|
||||
# Don't create .pdf.gz files (barely saves space and they can't be opened directly by most pdf readers)
|
||||
override_dh_compress:
|
||||
dh_compress -X.pdf
|
||||
|
||||
@@ -1,5 +1,22 @@
|
||||
SUBDIRS = \
|
||||
examples \
|
||||
manuals \
|
||||
sequence_charts \
|
||||
$(NULL)
|
||||
CFG_FILES = find $(srcdir) -name '*.cfg*' | sed -e 's,^$(srcdir),,'
|
||||
|
||||
dist-hook:
|
||||
for f in $$($(CFG_FILES)); do \
|
||||
j="$(distdir)/$$f" && \
|
||||
mkdir -p "$$(dirname $$j)" && \
|
||||
$(INSTALL_DATA) $(srcdir)/$$f $$j; \
|
||||
done
|
||||
|
||||
install-data-hook:
|
||||
for f in $$($(CFG_FILES)); do \
|
||||
j="$(DESTDIR)$(docdir)/$$f" && \
|
||||
mkdir -p "$$(dirname $$j)" && \
|
||||
$(INSTALL_DATA) $(srcdir)/$$f $$j; \
|
||||
done
|
||||
|
||||
uninstall-hook:
|
||||
@$(PRE_UNINSTALL)
|
||||
for f in $$($(CFG_FILES)); do \
|
||||
j="$(DESTDIR)$(docdir)/$$f" && \
|
||||
$(RM) $$j; \
|
||||
done
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
osmoconfdir = $(sysconfdir)/osmocom
|
||||
osmoconf_DATA = osmo-hlr.cfg
|
||||
|
||||
EXTRA_DIST = osmo-hlr.cfg
|
||||
|
||||
CFG_FILES = find $(srcdir) -name '*.cfg*' | sed -e 's,^$(srcdir),,'
|
||||
|
||||
dist-hook:
|
||||
for f in $$($(CFG_FILES)); do \
|
||||
j="$(distdir)/$$f" && \
|
||||
mkdir -p "$$(dirname $$j)" && \
|
||||
$(INSTALL_DATA) $(srcdir)/$$f $$j; \
|
||||
done
|
||||
|
||||
install-data-hook:
|
||||
for f in $$($(CFG_FILES)); do \
|
||||
j="$(DESTDIR)$(docdir)/examples/$$f" && \
|
||||
mkdir -p "$$(dirname $$j)" && \
|
||||
$(INSTALL_DATA) $(srcdir)/$$f $$j; \
|
||||
done
|
||||
|
||||
uninstall-hook:
|
||||
@$(PRE_UNINSTALL)
|
||||
for f in $$($(CFG_FILES)); do \
|
||||
j="$(DESTDIR)$(docdir)/examples/$$f" && \
|
||||
$(RM) $$j; \
|
||||
done
|
||||
@@ -1,22 +0,0 @@
|
||||
# OsmoHLR example configuration for Distributed GSM (mslookup)
|
||||
hlr
|
||||
gsup
|
||||
# For D-GSM roaming, osmo-hlr's GSUP must listen on a public IP:
|
||||
bind ip 10.9.8.7
|
||||
# Each HLR should identify with a distinct name
|
||||
ipa-name hlr-23
|
||||
mslookup
|
||||
# Bind mslookup mDNS server and client on default multicast address and port:
|
||||
# 239.192.23.42 port 4266
|
||||
mdns bind
|
||||
# Tell the mslookup server in osmo-hlr which IP+ports to return when a
|
||||
# remote voice call or SMS wants to deliver to a local subscriber:
|
||||
server
|
||||
# local osmo-sip-connector SIP port
|
||||
service sip.voice at 10.9.8.7 5060
|
||||
# local osmo-msc SMPP port
|
||||
service smpp.sms at 10.9.8.7 2775
|
||||
# experimental: SMS-over-GSUP: this HLR's GSUP port
|
||||
service gsup.sms at 10.9.8.7 4222
|
||||
# only required if different from above 'gsup'/'bind ip':
|
||||
#service gsup.hlr at 10.9.8.7 4222
|
||||
@@ -2,18 +2,17 @@
|
||||
! OsmoHLR example configuration
|
||||
!
|
||||
log stderr
|
||||
logging filter all 1
|
||||
logging color 1
|
||||
logging print category 1
|
||||
logging print category-hex 0
|
||||
logging print level 1
|
||||
logging print file basename last
|
||||
logging print extended-timestamp 1
|
||||
logging level main notice
|
||||
logging level db notice
|
||||
logging level auc notice
|
||||
logging level ss info
|
||||
logging level linp error
|
||||
logging filter all 1
|
||||
logging color 1
|
||||
logging print category 1
|
||||
logging timestamp 1
|
||||
logging print extended-timestamp 1
|
||||
logging level all notice
|
||||
logging level main notice
|
||||
logging level db notice
|
||||
logging level auc notice
|
||||
logging level ss info
|
||||
logging level linp error
|
||||
!
|
||||
line vty
|
||||
bind 127.0.0.1
|
||||
@@ -23,4 +22,3 @@ hlr
|
||||
gsup
|
||||
bind ip 127.0.0.1
|
||||
ussd route prefix *#100# internal own-msisdn
|
||||
ussd route prefix *#101# internal own-imsi
|
||||
|
||||
@@ -1,66 +0,0 @@
|
||||
EXTRA_DIST = example_subscriber_add_update_delete.vty \
|
||||
example_subscriber_cs_ps_enabled.ctrl \
|
||||
example_subscriber_info.ctrl \
|
||||
osmohlr-usermanual.adoc \
|
||||
osmohlr-usermanual-docinfo.xml \
|
||||
osmohlr-vty-reference.xml \
|
||||
chapters/proxy_cache_attach.msc \
|
||||
chapters/proxy_cache_more_tuples.msc \
|
||||
chapters/proxy_cache_periodic_lu.msc \
|
||||
chapters/proxy_cache_tuple_cache_dry.msc \
|
||||
chapters/proxy_cache_umts_aka_resync.msc \
|
||||
regen_doc.sh \
|
||||
chapters \
|
||||
vty
|
||||
|
||||
if BUILD_MANUALS
|
||||
ASCIIDOC = osmohlr-usermanual.adoc
|
||||
ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc $(srcdir)/*.vty $(srcdir)/*.ctrl $(srcdir)/chapters/*.msc
|
||||
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
|
||||
|
||||
VTY_REFERENCE = osmohlr-vty-reference.xml
|
||||
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
|
||||
|
||||
OSMO_REPOSITORY = osmo-hlr
|
||||
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc
|
||||
endif
|
||||
|
||||
TMP_DB = generated/hlr.db
|
||||
|
||||
update-examples: update-examples-ctrl update-examples-vty
|
||||
|
||||
.PHONY: found-update-deps
|
||||
found-update-deps:
|
||||
@if [ ! -f "$(top_srcdir)/sql/hlr.sql" ]; then \
|
||||
echo "You need to define OSMO_HLR_PATH to point at an osmo-hlr.git"; \
|
||||
exit 1; \
|
||||
fi
|
||||
@if [ -z "$(shell which osmo-hlr)" ]; then \
|
||||
echo "osmo-hlr needs to be installed / available in the PATH"; \
|
||||
exit 1; \
|
||||
fi
|
||||
@if [ -z "$(shell which osmo_verify_transcript_ctrl.py)" ]; then \
|
||||
echo "You need to install git.osmocom.org/python/osmo-python-tests.git"; \
|
||||
exit 1; \
|
||||
fi
|
||||
@if [ -z "$(shell which osmo_verify_transcript_vty.py)" ]; then \
|
||||
echo "You need to install git.osmocom.org/python/osmo-python-tests.git"; \
|
||||
exit 1; \
|
||||
fi
|
||||
|
||||
update-examples-ctrl: found-update-deps
|
||||
mkdir -p generated
|
||||
rm -f "$(TMP_DB)"
|
||||
sqlite3 "$(TMP_DB)" < "$(top_srcdir)/sql/hlr.sql"
|
||||
sqlite3 "$(TMP_DB)" < "$(top_srcdir)/tests/test_subscriber.sql"
|
||||
osmo_verify_transcript_ctrl.py \
|
||||
-r "osmo-hlr -l $(TMP_DB) -c $(top_srcdir)/doc/examples/osmo-hlr.cfg" \
|
||||
-p 4259 --update *.ctrl
|
||||
|
||||
update-examples-vty: found-update-deps
|
||||
mkdir -p generated
|
||||
rm -f "$(TMP_DB)"
|
||||
sqlite3 "$(TMP_DB)" < "$(top_srcdir)/sql/hlr.sql"
|
||||
osmo_verify_transcript_vty.py \
|
||||
-r "osmo-hlr -l $(TMP_DB) -c $(top_srcdir)/doc/examples/osmo-hlr.cfg" \
|
||||
-p 4258 --update *.vty
|
||||
@@ -1,20 +0,0 @@
|
||||
all: \
|
||||
proxy_cache_attach.msc \
|
||||
proxy_cache_more_tuples.msc \
|
||||
proxy_cache_tuple_cache_dry.msc \
|
||||
proxy_cache_periodic_lu.msc \
|
||||
proxy_cache_umts_aka_resync.msc \
|
||||
$(NULL)
|
||||
|
||||
png: \
|
||||
proxy_cache.png \
|
||||
proxy_cache_unused.png \
|
||||
lu_attach_and_periodic.png \
|
||||
$(NULL)
|
||||
|
||||
%.png: %.msc
|
||||
mscgen -T png -o $@ $<
|
||||
|
||||
%.msc: %.ladder
|
||||
@which ladder_to_msc.py || (echo 'PLEASE POINT YOUR $$PATH AT libosmocore/contrib/ladder_to_msc.py' && false)
|
||||
ladder_to_msc.py -i $< -o $@
|
||||
@@ -1,106 +0,0 @@
|
||||
[[hlr-ctrl]]
|
||||
== Control interface
|
||||
|
||||
The actual protocol is described in <<common-control-if>>, the variables common
|
||||
to all programs using it are described in <<ctrl_common_vars>>. This section
|
||||
describes the CTRL interface variables specific to OsmoHLR.
|
||||
|
||||
All subscriber variables are available by different selectors, which are freely
|
||||
interchangeable:
|
||||
|
||||
.Subscriber selectors available on OsmoHLR's Control interface
|
||||
[options="header",width="100%",cols="35%,65%"]
|
||||
|===
|
||||
|Selector|Comment
|
||||
|subscriber.*by-imsi-*'123456'.*|Subscriber selector by IMSI, replace "123456" with the actual IMSI
|
||||
|subscriber.*by-msisdn-*'123456'.*|Subscriber selector by MSISDN
|
||||
|subscriber.*by-id-*'123456'.*|Subscriber selector by database ID
|
||||
|===
|
||||
|
||||
Each of the above selectors feature all of these control variables:
|
||||
|
||||
.Subscriber variables available on OsmoHLR's Control interface
|
||||
[options="header",width="100%",cols="35%,8%,8%,8%,41%"]
|
||||
|===
|
||||
|Name|Access|Trap|Value|Comment
|
||||
|subscriber.by-\*.*info*|R|No||List (short) subscriber information
|
||||
|subscriber.by-\*.*info-aud*|R|No||List subscriber authentication tokens
|
||||
|subscriber.by-\*.*info-all*|R|No||List both 'info' and 'info-aud' in one
|
||||
|subscriber.by-\*.*cs-enabled*|RW|No|'1' or '0'|Enable/disable circuit-switched access
|
||||
|subscriber.by-\*.*ps-enabled*|RW|No|'1' or '0'|Enable/disable packet-switched access
|
||||
|===
|
||||
|
||||
=== subscriber.by-*.info, info-aud, info-all
|
||||
|
||||
Query the HLR database and return current subscriber record, in multiple lines
|
||||
of the format
|
||||
|
||||
----
|
||||
name<tab>value
|
||||
----
|
||||
|
||||
To keep the reply as short as possible, some values are omitted if they are
|
||||
empty. These are the returned values and their presence
|
||||
modalities; for their meaning, see <<subscriber-params>>:
|
||||
|
||||
.Returned values by OsmoHLR's 'info', 'info-all' and 'info-aud' commands
|
||||
[options="header",width="100%",cols="15%,15%,30%,40%"]
|
||||
|===
|
||||
|Returned by 'info-all' and|Name|Format|Presence
|
||||
|'info'|id|-9223372036854775808 .. 9223372036854775807 (usually not negative)|always
|
||||
|'info'|imsi|6 to 15 decimal digits|always
|
||||
|'info'|msisdn|1 to 15 decimal digits|when non-empty
|
||||
|'info'|nam_cs|'1' if CS is enabled, or '0'|always
|
||||
|'info'|nam_ps|'1' if PS is enabled, or '0'|always
|
||||
|'info'|vlr_number|up to 15 decimal digits|when non-empty
|
||||
|'info'|sgsn_number|up to 15 decimal digits|when non-empty
|
||||
|'info'|sgsn_address||when non-empty
|
||||
|'info'|ms_purged_cs|'1' if CS is purged, or '0'|always
|
||||
|'info'|ms_purged_ps|'1' if PS is purged, or '0'|always
|
||||
|'info'|periodic_lu_timer|0..4294967295|always
|
||||
|'info'|periodic_rau_tau_timer|0..4294967295|always
|
||||
|'info'|lmsi|8 hex digits|always
|
||||
|'info-aud'|aud2g.algo|one of 'comp128v1', 'comp128v2', 'comp128v3' or 'xor'|when valid 2G auth data is set
|
||||
|'info-aud'|aud2g.ki|32 hexadecimal digits|when valid 2G auth data is set
|
||||
|'info-aud'|aud3g.algo|so far always 'milenage'|when valid 3G auth data is set
|
||||
|'info-aud'|aud3g.k|32 hexadecimal digits|when valid 3G auth data is set
|
||||
|'info-aud'|aud3g.op|32 hexadecimal digits|when valid 3G auth data is set, *not* when OPC is set
|
||||
|'info-aud'|aud3g.opc|32 hexadecimal digits|when valid 3G auth data is set, *not* when OP is set
|
||||
|'info-aud'|aud3g.ind_bitlen|0..28|when valid 3G auth data is set
|
||||
|'info-aud'|aud3g.sqn|0 .. 18446744073709551615|when valid 3G auth data is set
|
||||
|===
|
||||
|
||||
This is an example Control Interface transcript that illustrates the various
|
||||
'info' commands:
|
||||
|
||||
----
|
||||
include::../example_subscriber_info.ctrl[]
|
||||
----
|
||||
|
||||
=== subscriber.by-*.ps-enabled, cs-enabled
|
||||
|
||||
Disable or enable packet-/circuit-switched access for the given IMSI;
|
||||
|
||||
* 'ps-enabled' switches access to GPRS or UMTS data services,
|
||||
* 'cs-enabled' switches access to voice services.
|
||||
|
||||
When disabled, the next time this subscriber attempts to do a Location Updating
|
||||
GSUP operation for the given domain (i.e. from the SGSN for 'ps-enabled', from
|
||||
the MSC/VLR for 'cs-enabled'), it will be rejected by OsmoHLR. Currently
|
||||
connected GSUP clients will be notified via GSUP when a subscriber is being
|
||||
disabled, so that the subscriber can be dropped in case it is currently
|
||||
attached.
|
||||
|
||||
The current 'ps-enabled'/'cs-enabled' status can be queried by 'GET' commands,
|
||||
and also by looking at 'nam_ps' and 'nam_cs' in a 'subscriber.by-*.info'
|
||||
response.
|
||||
|
||||
A value of "1" indicates that the given domain is enabled, which is the
|
||||
default; a value of "0" disables access.
|
||||
|
||||
This is an example transcript that illustrates 'ps-enabled' and 'cs-enabled'
|
||||
commands:
|
||||
|
||||
----
|
||||
include::../example_subscriber_cs_ps_enabled.ctrl[]
|
||||
----
|
||||
@@ -1,491 +0,0 @@
|
||||
== Distributed GSM / Multicast MS Lookup
|
||||
|
||||
Distributed GSM (D-GSM) allows independent mobile core network stacks to provide voice, SMS and Roaming services to each
|
||||
other, without the need for centralised entities or administration authority, and in a way that is resilient against
|
||||
unstable network links between sites.
|
||||
|
||||
D-GSM aims at communal networks, where several independent sites, let's call them villages, each have a full mobile core
|
||||
network infrastructure. It elegantly provides ad-hoc service for subscribers moving across villages, and allows villages
|
||||
to dynamically join or leave the cooperative network without the need for configuration changes at other sites.
|
||||
|
||||
A challenge for linking separate sites is to find the current location of a subscriber. Typically, in mobile networks, a
|
||||
centralized entity keeps track of where to Page for subscribers. Running several fully independent sites with unreliable
|
||||
links between them makes it hard to provide such centralisation.
|
||||
|
||||
D-GSM finds subscribers by mslookup, a service provided by OsmoHLR, typically using multicast DNS queries. This allows
|
||||
routing Location Updating requests, calls, and SMS to the right site without administrative delay nor the need for a
|
||||
reliable link to a central database.
|
||||
|
||||
D-GSM is highly resilient against single sites or links becoming temporarily unavailable. Service between still
|
||||
reachable sites simply continues; Service to a disconnected site resumes as soon as it becomes reachable again.
|
||||
|
||||
This brings an entirely new paradigm to mobile core network infrastructure: as sites become reachable on the IP network
|
||||
and join the common IP multicast group, services between them become available immediately. Basically, the only premise
|
||||
is that IP routing and multicast works across sites, and that each site uses unique IPA names in the GSUP config.
|
||||
|
||||
This chapter describes how D-GSM and mslookup work, and how to configure sites to use D-GSM, using Osmocom core network
|
||||
infrastructure.
|
||||
|
||||
=== Finding Subscribers: mslookup Clients
|
||||
|
||||
There are two fundamentally distinct subscriber lookups provided by the mslookup service.
|
||||
|
||||
==== Find the Current Location of an MSISDN
|
||||
|
||||
[[fig_dgsm_connect]]
|
||||
.mslookup for connecting subscribers: Alice is visiting village C; a phone call gets routed directly to her current location independently from her resident village infrastructure
|
||||
[graphviz]
|
||||
----
|
||||
digraph G {
|
||||
rankdir=LR
|
||||
|
||||
subgraph cluster_village_b {
|
||||
label="Village B"
|
||||
ms_bob [label="Bob\n(from village B)",shape=box]
|
||||
pbx_b [label="SIP B"]
|
||||
}
|
||||
|
||||
subgraph cluster_village_c {
|
||||
label="Village C"
|
||||
ms_alice [label="Alice\n(from village A)",shape=box]
|
||||
msc_c [label="MSC C"]
|
||||
hlr_c [label="HLR C"]
|
||||
sip_c [label="SIP C"]
|
||||
}
|
||||
|
||||
ms_alice -> msc_c [style=dashed,arrowhead=none]
|
||||
msc_c -> hlr_c [label="attached",style=dashed,arrowhead=none]
|
||||
ms_bob -> pbx_b [label="call Alice"]
|
||||
pbx_b -> hlr_c [label="mslookup by MSISDN",style=dotted,dir=both]
|
||||
pbx_b -> sip_c -> msc_c -> ms_alice [label="call"]
|
||||
}
|
||||
----
|
||||
|
||||
For example, if a subscriber is currently visiting another village, establish a phone call / send SMS towards that
|
||||
village.
|
||||
|
||||
- To deliver a phone call, a SIP agent integrates an mslookup client to request the SIP service of an MSISDN's current
|
||||
location (example: <<dgsm_conf_dialplan>>). It receives an IP address and port to send the SIP Invite to.
|
||||
|
||||
- To deliver an SMS, an ESME integrates an mslookup client to request the SMPP service of an MSISDN's current location
|
||||
(example: <<dgsm_conf_esme_smpp>>).
|
||||
|
||||
The current location of a subscriber may change at any time, and, when moving across locations, a subscriber may
|
||||
suddenly lose reception to the previous location without explicitly detaching. Hence an mslookup request for the current
|
||||
location of an MSISDN may get numerous responses. To find the currently valid location, mslookup includes the age of the
|
||||
subscriber record, i.e. how long ago the subscriber was last reached. The one response with the youngest age reflects
|
||||
the current location.
|
||||
|
||||
In order to evaluate several responses, mslookup always waits for a fixed amount of time (1 second), and then evaluates
|
||||
the available responses.
|
||||
|
||||
Services are not limited to SIP and SMPP, arbitrarily named services can be added to the mslookup configuration.
|
||||
|
||||
.Message sequence for locating an MSISDN to deliver a voice call
|
||||
["mscgen"]
|
||||
----
|
||||
msc {
|
||||
hscale="2";
|
||||
moms[label="MS,BSS\nvillage A"],momsc[label="MSC,MGW\nvillage A"],mosipcon[label="osmo-sip-connector\nvillage A"],mopbx[label="PBX\nvillage A"],mthlr[label="OsmoHLR\nvillage B"],mtsipcon[label="osmo-sip-connector\nvillage B"],mtmsc[label="MGW,MSC\nvillage B"],mtms[label="RAN,MS\nvillage B"];
|
||||
|
||||
moms =>> momsc [label="CC Setup"];
|
||||
momsc =>> mosipcon [label="MNCC_SETUP_IND"];
|
||||
mosipcon =>> mopbx [label="SIP INVITE"];
|
||||
mopbx rbox mopbx [label="dialplan: launch mslookup by MSISDN"];
|
||||
--- [label="multicast-DNS query to all connected sites"];
|
||||
...;
|
||||
mopbx <<= mthlr [label="mDNS response\n(age)"];
|
||||
mopbx rbox mopbx [label="wait ~ 1s for more mDNS responses"];
|
||||
...;
|
||||
mopbx =>> mtsipcon [label="SIP INVITE (MT)"];
|
||||
mtmsc <<= mtsipcon [label="MNCC_SETUP_REQ"];
|
||||
mtms <<= mtmsc [label="Paging (CC)"];
|
||||
moms rbox mtms [label="voice call commences"];
|
||||
|
||||
}
|
||||
----
|
||||
|
||||
==== Find the Home HLR for an IMSI
|
||||
|
||||
[[fig_dgsm_roaming]]
|
||||
.mslookup for Roaming: Alice visits village B; she can attach to the local mobile network, which proxies HLR administration to her home village.
|
||||
[graphviz]
|
||||
----
|
||||
digraph G {
|
||||
rankdir=LR
|
||||
|
||||
subgraph cluster_village_b {
|
||||
label="Village B"
|
||||
|
||||
ms_alice [label="Alice\n(from village A)",shape=box]
|
||||
msc_b [label="MSC B"]
|
||||
hlr_b [label="HLR B"]
|
||||
}
|
||||
|
||||
subgraph cluster_village_a {
|
||||
label="Village A"
|
||||
hlr_alice [label="Alice's home HLR"]
|
||||
}
|
||||
|
||||
ms_alice -> msc_b -> hlr_b [label="Location\nUpdating"]
|
||||
hlr_b -> hlr_alice [label="mslookup by IMSI",style=dotted,dir=both]
|
||||
hlr_b -> hlr_alice [label="GSUP proxy forwarding"]
|
||||
}
|
||||
----
|
||||
|
||||
For example, when attaching to a local network, a local resident gets serviced directly by the local village's HLR,
|
||||
while a visitor from another village gets serviced by the remote village's HLR (Roaming).
|
||||
|
||||
A home HLR typically stays the same for a given IMSI. If the home site is reachable, there should be exactly one
|
||||
response to an mslookup request asking for it. The age of such a home-HLR response is always sent as zero.
|
||||
|
||||
If a response's age is zero, mslookup does not wait for further responses and immediately uses the result.
|
||||
|
||||
If there were more than one HLR accepting service for an IMSI, the one with the shortest response latency is used.
|
||||
|
||||
=== mslookup Configuration
|
||||
|
||||
OsmoHLR the main mslookup agent. It provides the responses for both current location services as well as for locating
|
||||
the fixed home-HLR. But naturally, depending on the mslookup request's purpose, different OsmoHLR instances will respond
|
||||
for a given subscriber.
|
||||
|
||||
- When querying the home HLR, it is always the (typically single) home HLR instance that sends the mslookup response. As
|
||||
soon as it finds the queried IMSI in the local HLR database, an OsmoHLR will respond to home-HLR requests.
|
||||
In <<fig_dgsm_roaming>>, Alice's home HLR responds to the Roaming request ("where is the home HLR?").
|
||||
|
||||
- When querying the location of an MSISDN, it is always the HLR proxy nearest to the servicing MSC that sends the
|
||||
mslookup response. Even though the home HLR keeps the Location Updating record also for Roaming cases, it will only
|
||||
respond to an mslookup service request if the subscriber has attached at a directly connected MSC. If attached at a
|
||||
remote MSC, that MSC's remote HLR will be the GSUP proxy for the home HLR, and the remote HLR is responsible for
|
||||
responding to service requests.
|
||||
In <<fig_dgsm_roaming>>, HLR B is the nearest proxy and will answer all service requests ("where is this MSISDN?").
|
||||
Alice's home HLR will not answer service requests, because it detects that the servicing MSC is connected via another
|
||||
HLR proxy.
|
||||
|
||||
[[dgsm_example_config]]
|
||||
==== Example
|
||||
|
||||
Here is an osmo-hlr.cfg mslookup configuration example for one site, which is explained in subsequent chapters.
|
||||
|
||||
hlr
|
||||
gsup
|
||||
bind ip 10.9.8.7
|
||||
ipa-name hlr-23
|
||||
mslookup
|
||||
mdns bind
|
||||
server
|
||||
service sip.voice at 10.9.8.7 5060
|
||||
service smpp.sms at 10.9.8.7 2775
|
||||
|
||||
OsmoHLR has both an mslookup server and a client.
|
||||
|
||||
- The server responds to incoming service and home-HLR requests, when the local HLR is responsible.
|
||||
- The client is used as GSUP proxy to a remote home HLR (found by mslookup upon a locally unknown IMSI).
|
||||
- The client may also be used for forwarding SMS-over-GSUP.
|
||||
|
||||
The mslookup service can be implemented by various methods.
|
||||
At the time of writing, the only method implemented is mDNS.
|
||||
|
||||
==== mDNS
|
||||
|
||||
The stock mslookup method is mDNS, multicast DNS. It consists of standard DNS encoding according to <<ietf-rfc1035>> and
|
||||
<<ietf-rfc3596>>, but sent and received on IP multicast. In the response, standard A and AAAA records return the
|
||||
service's IP address, while additional TXT records provide the service's port number and the MS attach age.
|
||||
|
||||
TIP: To watch D-GSM mDNS conversations in wireshark, select "udp.port == 4266" (the default mslookup mDNS port
|
||||
number), right click on the packet to "Decode as...", and select "DNS".
|
||||
|
||||
In OsmoHLR, the mDNS server and client are typically both enabled at the same time:
|
||||
|
||||
mslookup
|
||||
mdns bind
|
||||
|
||||
Server and client can also be enabled/disabled individually:
|
||||
|
||||
mslookup
|
||||
server
|
||||
mdns bind
|
||||
client
|
||||
mdns bind
|
||||
|
||||
These examples use the default mslookup multicast IP address and port. It is possible to configure custom IP address and
|
||||
port, but beware that the IP address must be from a multicast range, see <<ietf-rfc5771>>:
|
||||
|
||||
mslookup
|
||||
mdns bind 239.192.23.42 4266
|
||||
|
||||
Domain names generated from mslookup queries (e.g. "sip.voice.123.msisdn") should not collide with IANA permitted
|
||||
domains. Therefore we add the "mdns.osmocom.org" suffix. It can be overridden as follows:
|
||||
|
||||
mslookup
|
||||
mdns domain-suffix mdns.osmocom.org
|
||||
|
||||
==== Server: Site Services
|
||||
|
||||
The mslookup server requires a list of service addresses provided at the local site, in order to respond to service
|
||||
requests matching locally attached subscribers.
|
||||
|
||||
mslookup
|
||||
server
|
||||
service sip.voice at 10.9.8.7 5060
|
||||
service smpp.sms at 10.9.8.7 2775
|
||||
|
||||
In this example:
|
||||
|
||||
- "10.9.8.7 5060" are the IP address and port on which the local site's osmo-sip-connector is bound to receive SIP
|
||||
Invite requests.
|
||||
- "10.9.8.7 2775" are the local site's OsmoMSC SMPP bind address and port.
|
||||
|
||||
Obviously, these IP addresses must be routable back to this site from all other sites. Using link-local or "ANY"
|
||||
addresses, like 127.0.0.1 or 0.0.0.0, will not work here. Instead, each service config requires a public IP address that
|
||||
all remote requestors are able to reach (not necessarily on the host that osmo-hlr is running on).
|
||||
|
||||
If a site has more than one MSC, services can also be configured for each MSC individually, keyed by the IPA unit name
|
||||
that each MSC sends on the GSUP link:
|
||||
|
||||
mslookup
|
||||
server
|
||||
msc ipa-name msc-262-42-0
|
||||
service sip.voice at 10.11.12.13 5060
|
||||
service smpp.sms at 10.11.12.13 2775
|
||||
msc ipa-name msc-901-70-0
|
||||
service sip.voice at 10.9.8.7 5060
|
||||
service smpp.sms at 10.9.8.7 2775
|
||||
|
||||
Here, "msc-262-42-0" is the IPA name of a local OsmoMSC instance. To configure an OsmoMSC's IPA name on the GSUP link,
|
||||
see osmo-msc.cfg, setting `hlr` / `ipa-name`.
|
||||
|
||||
For mslookup service responses, only Location Updatings in the Circuit Switched domain are relevant. OsmoHLR does manage
|
||||
IMSIs attaching in the Packet Switched domain (via an SGSN) similarly to Circuit Switched (via an MSC), but mslookup
|
||||
completely ignores the Packet Switched attach status.
|
||||
|
||||
==== Server: Own GSUP Address
|
||||
|
||||
When responding to home-HLR requests, OsmoHLR implicitly by default responds with its locally configured GSUP bind
|
||||
address (setting `hlr` / `gsup` / `bind ip`). If required, an explicit local GSUP address and port can be configured,
|
||||
for example:
|
||||
|
||||
hlr
|
||||
gsup
|
||||
bind ip 0.0.0.0
|
||||
ipa-name hlr-23
|
||||
mslookup
|
||||
server
|
||||
# osmo-hlr's own GSUP address to send in mslookup responses:
|
||||
service gsup.hlr at 10.9.8.7 4222
|
||||
|
||||
The gsup.hlr service can only be configured globally (because requests come from arbitrary mDNS clients, before a
|
||||
Location Updating has associated the IMSI with the requesting MSC).
|
||||
|
||||
==== Client IPA Naming
|
||||
|
||||
For reliable GSUP proxy routing to a remote HLR (Roaming), it is important that each GSUP client, i.e. each HLR, MSC and
|
||||
SGSN instance, has a unique IPA name.
|
||||
|
||||
Example for configuring an OsmoHLR instance's IPA name:
|
||||
|
||||
hlr
|
||||
gsup
|
||||
ipa-name hlr-23
|
||||
|
||||
Here, "hlr-23" is the unique identification of this OsmoHLR instance across all potentially connected D-GSM sites.
|
||||
|
||||
Furthermore, each MSC and SGSN must have a uniquely distinct IPA name across all sites (here "msc-262-42-0" and
|
||||
"msc-901-70-0" are used as example IPA names for local MSCs).
|
||||
|
||||
When this OsmoHLR connects to a remote HLR, be it for GSUP proxying or SMS-over-GSUP, it communicates its own IPA name
|
||||
(on GSUP link-up) as well as the IPA name of the requesting client MSC/SGSN (as Source Name in each message) to the
|
||||
remote OsmoHLR GSUP server. These names are used to route GSUP responses back to the respective requesting peer.
|
||||
|
||||
If two MSCs were accidentally configured with identical names, a problem will occur as soon as both MSCs attempt to
|
||||
attach to the same OsmoHLR (either directly or via GSUP proxying). The MSC that shows up first will work normally, but
|
||||
any duplicate that shows up later will be rejected, since a route for its name already exists.
|
||||
|
||||
=== Queries
|
||||
|
||||
In URL notation, typical mslookup queries look like:
|
||||
|
||||
gsup.hlr.123456789.imsi
|
||||
sip.voice.123.msisdn
|
||||
smpp.sms.123.msisdn
|
||||
|
||||
A query consists of
|
||||
|
||||
- a service name ("gsup.hlr"),
|
||||
- an id ("123456789"),
|
||||
- the id type ("imsi").
|
||||
|
||||
The calling client also defines a timeout to wait for responses.
|
||||
|
||||
The mslookup ID types are fixed, while service names can be chosen arbitrarily.
|
||||
|
||||
.mslookup ID types, no other ID types are understood by mslookup
|
||||
[options="header",width="100%",cols="20%,80%"]
|
||||
|===
|
||||
|ID Type|Description
|
||||
|imsi|An IMSI as existing in an OsmoHLR subscriber database
|
||||
|msisdn|A phone number as configured in an OsmoHLR subscriber database
|
||||
|===
|
||||
|
||||
.mslookup service name conventions, arbitrary service names can be added as required
|
||||
[options="header",width="100%",cols="20%,20%,60%"]
|
||||
|===
|
||||
|Service Name|Protocol|Description
|
||||
|gsup.hlr | GSUP | Home HLR's GSUP server, to handle Location Updating related procedures
|
||||
|sip.voice | SIP | OsmoSIPConnector, to receive a SIP Invite (MT side of a call)
|
||||
|smpp.sms | SMPP | Destination OsmoMSC (or other SMPP server) to deliver an SMS to the recipient
|
||||
|gsup.sms | GSUP | GSUP peer to deliver an SMS to the recipient using SMS-over-GSUP
|
||||
|===
|
||||
|
||||
Arbitrarily named services can be added to the mslookup configuration and queried by mslookup clients; as soon as a
|
||||
service name is present in osmo-hlr.cfg, it can be queried from any mslookup client.
|
||||
|
||||
Service names should consist of a protocol name (like "sip", "gsup", "english") and an intended action/entity (like
|
||||
"voice", "hlr", "greeting").
|
||||
|
||||
=== Service Client Implementation
|
||||
|
||||
In principle, arbitrary services could query target addresses via mslookup, leaving it up to any and all kinds of
|
||||
clients to find their respective destination addresses. But of course, mslookup was designed with specific services in
|
||||
mind, namely:
|
||||
|
||||
- SIP call agents and
|
||||
- SMS delivery (an ESME or SMSC)
|
||||
|
||||
The following chapters describe examples of setting up a working distributed core network providing SIP voice calls and
|
||||
SMS forwarding across sites.
|
||||
|
||||
==== mslookup Library
|
||||
|
||||
The OsmoHLR provides an mslookup client C library, libosmo-mslookup. Service lookups can be integrated directly
|
||||
in client programs using this library. However, its mDNS implementation requires the libosmocore select() loop, which
|
||||
can be challenging to integrate in practice. An alternative solution is the osmo-mslookup-client tool.
|
||||
|
||||
[[dgsm_osmo_mslookup_client]]
|
||||
==== osmo-mslookup-client
|
||||
|
||||
The mslookup C library is available, but often, a simpler approach for client implementations is desirable:
|
||||
|
||||
- When querying for a service address, the client is typically interested in the single final best result (youngest age
|
||||
/ first responding home HLR).
|
||||
- Voice call and SMS clients typically would block until an mslookup result is known. For example, the FreeSwitch
|
||||
dialplan integration expects a result synchronously, i.e. without waiting for mslookup responses via a select() loop.
|
||||
- Integrating the libosmocore select() loop required for mDNS can break the already existing socket handling in the
|
||||
client program.
|
||||
|
||||
The osmo-mslookup-client cmdline tool provides a trivial way to synchronously acquire the single result for an mslookup
|
||||
request. The service client can invoke an osmo-mslookup-client process per request and read the result from stdout.
|
||||
|
||||
Each invocation obviously spawns a separate process and opens a multicast socket for mDNS. For better scalability,
|
||||
osmo-mslookup-client can also be run as a daemon, providing results via a unix domain socket. Using synchronous write()
|
||||
and recv() allows blocking until a result is received without interfering with the client program's select() setup.
|
||||
|
||||
By itself, osmo-mslookup-client is also helpful as a diagnostic tool:
|
||||
|
||||
----
|
||||
$ osmo-mslookup-client sip.voice.1001.msisdn
|
||||
sip.voice.1001.msisdn ok 10.9.8.7 5060
|
||||
|
||||
$ osmo-mslookup-client gsup.hlr.901700000014701.imsi
|
||||
gsup.hlr.901700000014701.imsi ok 10.9.8.7 4222
|
||||
|
||||
$ osmo-mslookup-client gsup.hlr.111111.imsi
|
||||
gsup.hlr.111111.imsi not-found
|
||||
|
||||
$ osmo-mslookup-client gsup.hlr.1001.msisdn sip.voice.1001.msisdn smpp.sms.1001.msisdn foo.1001.msisdn
|
||||
gsup.hlr.1001.msisdn ok 10.9.8.7 4222
|
||||
foo.1001.msisdn not-found
|
||||
smpp.sms.1001.msisdn ok 10.9.8.7 2775
|
||||
sip.voice.1001.msisdn ok 10.9.8.7 5060
|
||||
|
||||
$ osmo-mslookup-client --csv-headers gsup.hlr.901700000014701.imsi
|
||||
QUERY RESULT V4_IP V4_PORT V6_IP V6_PORT
|
||||
gsup.hlr.901700000014701.imsi ok 10.9.8.7 4222
|
||||
|
||||
$ osmo-mslookup-client -f json gsup.hlr.901700000014701.imsi
|
||||
{"query": "gsup.hlr.901700000014701.imsi", "result": "ok", "v4": ["10.9.8.7", "4222"]}
|
||||
----
|
||||
|
||||
For full help including example client invocations in Python, see the output of:
|
||||
|
||||
osmo-mslookup-client -h
|
||||
|
||||
==== SIP Service Client
|
||||
|
||||
[[dgsm_conf_dialplan]]
|
||||
===== FreeSwitch dialplan.py
|
||||
|
||||
The FreeSWITCH PBX software <<freeswitch_pbx>> offers a Python integration to determine a SIP call recipient by a custom
|
||||
dialplan implementation. An example dialplan implementation for FreeSWITCH that uses D-GSM mslookup is provided in the
|
||||
osmo-hlr source tree under `contrib`, called `freeswitch_dialplan_dgsm.py`.
|
||||
|
||||
To integrate it with your FREESWITCH setup, add a new `extension` block to your `dialplan/public.xml`:
|
||||
|
||||
----
|
||||
<extension name="outbound">
|
||||
<condition field="destination_number" expression=".*">
|
||||
<action application="set" data="hangup_after_bridge=true"/>
|
||||
<action application="set" data="session_in_hangup_hook=true"/>
|
||||
<action application="set" data="ringback=%(2000, 4000, 440.0, 480.0)"/>
|
||||
<action application="python" data="freeswitch_dialplan_dgsm"/>
|
||||
</condition>
|
||||
</extension>
|
||||
----
|
||||
|
||||
Make sure that the dir containing `freeswitch_dialplan_dgsm.py` is in your `PYTHONPATH` environment variable, and start
|
||||
the server:
|
||||
|
||||
----
|
||||
$ export PYTHONPATH="$PYTHONPATH:/home/user/code/osmo-hlr/contrib/dgsm"
|
||||
$ freeswitch -nf -nonat -nonatmap -nocal -nort -c
|
||||
----
|
||||
|
||||
==== SMS Service Client
|
||||
|
||||
[[dgsm_conf_esme_smpp]]
|
||||
===== SMS via SMPP Port
|
||||
|
||||
An example ESME using D-GSM mslookup, `esme_dgsm.py`, is provided in the osmo-hlr source tree under `contrib`. It
|
||||
attaches to OsmoMSC's SMPP port to send SMS to recipients determined by mslookup.
|
||||
|
||||
OsmoMSC should be configured as "smpp-first", so that all SMS routing is determined by mslookup. If configured without
|
||||
smpp-first, OsmoMSC may try to deliver an SMS locally, even though the recipient has recently moved to a different site.
|
||||
|
||||
An example OsmoMSC configuration to work with esme_dgsm.py:
|
||||
|
||||
----
|
||||
smpp
|
||||
local-tcp-ip 127.0.0.1 2775
|
||||
system-id test-msc
|
||||
policy closed
|
||||
smpp-first
|
||||
# outgoing to esme_dgsm.py
|
||||
esme OSMPP
|
||||
no alert-notifications
|
||||
password foo
|
||||
default-route
|
||||
# incoming from esme_dgsm.py
|
||||
esme ISMPP
|
||||
no alert-notifications
|
||||
password foo
|
||||
----
|
||||
|
||||
Launch esme_dgsm.py alongside OsmoMSC:
|
||||
|
||||
----
|
||||
./esme_dgsm.py --src-host 127.0.0.1
|
||||
----
|
||||
|
||||
esme_dgsm.py will be notified via SMPP for each SMS to be delivered, and will forward them either to a remote
|
||||
recipient, or back to the same OsmoMSC, depending on the mslookup result. If the MSISDN is not reachable (or
|
||||
esme_dgsm.py can't handle the message for other reasons), it returns the RSYSERR code back to OsmoMSC.
|
||||
|
||||
Note that the esme_dgsm.py is a proof of concept and should not be used in production. It has several limitations, such
|
||||
as not supporting multipart SMS messages.
|
||||
|
||||
===== SMS-Over-GSUP
|
||||
|
||||
The GSUP protocol defines SMS delivery messages. When OsmoMSC is configured to deliver SMS via GSUP, MO SMS are directly
|
||||
forwarded to the HLR, which will determine where to forward the SMS-over-GSUP messages using its mslookup client.
|
||||
|
||||
FIXME implement this
|
||||
@@ -1,69 +0,0 @@
|
||||
[[overview]]
|
||||
== Overview
|
||||
|
||||
This manual should help you getting started with OsmoHLR. It will cover
|
||||
aspects of configuring and running the OsmoHLR.
|
||||
|
||||
[[intro_overview]]
|
||||
=== About OsmoHLR
|
||||
|
||||
OsmoHLR is Osmocom's minimal implementation of a Home Location Register (HLR)
|
||||
for 2G and 3G GSM and UMTS mobile core networks. Its interfaces are:
|
||||
|
||||
- GSUP, serving towards OsmoMSC and OsmoSGSN;
|
||||
- A local SQLite database;
|
||||
- The Osmocom typical telnet VTY and CTRL interfaces.
|
||||
|
||||
Originally, the OpenBSC project's OsmoNITB all-in-one implementation had an
|
||||
integrated HLR, managing subscribers and SMS in the same local database. Along
|
||||
with the separate OsmoMSC and its new VLR component, OsmoHLR was implemented
|
||||
from scratch to alleviate various shortcomings of the internal HLR:
|
||||
|
||||
- The separate HLR allows using centralized subscriber management for both
|
||||
circuit-switched and packet-switched domains (i.e. one OsmoHLR for both
|
||||
OsmoMSC and OsmoSGSN).
|
||||
|
||||
- VLR and HLR brought full UMTS AKA (Authentication and Key Agreement) support,
|
||||
i.e. Milenage authentication in both the full 3G variant as well as the
|
||||
backwards compatible 2G variant.
|
||||
|
||||
- In contrast to the OsmoNITB, the specific way the new OsmoMSC's VLR accesses
|
||||
OsmoHLR brings fully asynchronous subscriber database access.
|
||||
|
||||
Find the OsmoHLR issue tracker and wiki online at
|
||||
|
||||
- https://osmocom.org/projects/osmo-hlr
|
||||
- https://osmocom.org/projects/osmo-hlr/wiki
|
||||
|
||||
|
||||
[[fig-gsm]]
|
||||
.Typical GSM network architecture used with OsmoHLR
|
||||
[graphviz]
|
||||
----
|
||||
digraph G {
|
||||
rankdir=LR;
|
||||
subgraph cluster_hlr {
|
||||
label = "OsmoHLR";
|
||||
GSUP [label="GSUP server"]
|
||||
DB [label="SQLite DB"]
|
||||
GSUP->DB
|
||||
DB->CTRL [dir="back"]
|
||||
DB->VTY [dir="back"]
|
||||
}
|
||||
|
||||
Admin [label="Admin and\nMaintenance"]
|
||||
SW [label="3rd party software\nintegration"]
|
||||
VTY->Admin [dir="back"]
|
||||
CTRL->SW [dir="back"]
|
||||
|
||||
MSC [label="MSC/VLR"]
|
||||
MSC->GSUP [label="GSUP"]
|
||||
SGSN->GSUP [label="GSUP"]
|
||||
|
||||
BSC->MSC
|
||||
HNBGW->MSC
|
||||
HNBGW->SGSN
|
||||
PCU->SGSN
|
||||
}
|
||||
----
|
||||
|
||||
@@ -1,333 +0,0 @@
|
||||
== Distributed GSM / GSUP Proxy Cache: Remedy Temporary Link Failure to Home HLR
|
||||
|
||||
The aim of the Proxy Cache is to still provide service to roaming subscribers even if the GSUP link to the home HLR is
|
||||
temporarily down or unresponsive.
|
||||
|
||||
If a subscriber from a remote site is currently roaming at this local site, and the link to the subscriber's home HLR
|
||||
has succeeded before, the GSUP proxy cache can try to bridge the time of temporary link failure to that home HLR.
|
||||
|
||||
Tasks to take over from an unreachable home HLR:
|
||||
|
||||
- Cache and send auth tuples on Send Auth Info Request.
|
||||
- Acknowledge periodic Location Updating.
|
||||
- ...?
|
||||
|
||||
=== Design Considerations
|
||||
|
||||
==== Authentication
|
||||
|
||||
The most critical role of the home HLR is providing the Authentication and Key Agreement (AKA) tuples. If the home HLR
|
||||
is not reachable, the lack of fresh authentication challenges would normally cause the subscriber to be rejected. To
|
||||
avoid that, a proxying HLR needs to be able to provide AKA tuples on behalf of the home HLR.
|
||||
|
||||
In short, the strategy of the D-GSM proxy cache is:
|
||||
|
||||
- Try to keep a certain number of unused full UMTS AKA tuples in the proxy cache at all times.
|
||||
- When the MSC requests more tuples, dispense some from the cache, and fill it back up later on, as soon as a good link
|
||||
is available.
|
||||
- When the tuple cache in the proxy HLR runs dry, 3G RAN becomes unusable. But 2G RAN may fall back to GSM AKA, if the
|
||||
proxy HLR configuration permits it: resend previously used GSM AKA auth tuples to the MSC, omitting UMTS AKA items
|
||||
from the Send Auth Info Result, to force the MSC to send a GSM AKA challenge on 2G.
|
||||
|
||||
The remaining part of this section provides detailed reasoning for this strategy.
|
||||
|
||||
The aim is to attach a subscriber without immediate access to the authentication key data.
|
||||
|
||||
Completely switching off authentication would be an option on GERAN (2G), but this would mean complete lack of
|
||||
encryption on the air interface, and is not recommended. On 3G and later, authentication is always mandatory.
|
||||
|
||||
The key data is known only to the USIM and the home HLR. The HLR generates distinct authentication tuples, each
|
||||
containing a cryptographic challenge (RAND, AUTN) and its expected response (SRES, XRES). The MSC consumes one tuple
|
||||
per authentication: it sends the challenge to the subscriber, and compares the response received.
|
||||
|
||||
The proxy could generate fresh tuples if the cryptographic key data (Ki,K,OP/OPC) from the home HLR was shared with the
|
||||
proxy HLR. Distributed GSM does not do this, because:
|
||||
|
||||
- The key data is cryptographically very valuable. If it were leaked, any and all authentication challenges would be
|
||||
fully compromised.
|
||||
|
||||
- In D-GSM, each home site shall retain exclusive authority over the user data. It should not be necessary to share the
|
||||
secret keys with any remote site.
|
||||
|
||||
So, how about resending already used auth tuples to the MSC when no fresh ones are available? Resending identical
|
||||
authentication challenges makes the system vulnerable to relatively trivial replay-attacks, but this may be an
|
||||
acceptable fallback in situations of failing links, if it means being able to provide reliable roaming.
|
||||
|
||||
But, even if a proxying HLR is willing to compromise cryptographic security to improve service, this can only work with
|
||||
GSM AKA:
|
||||
|
||||
- In GSM AKA (so-called 2G auth), tuples may be re-used any amount of times without a strict need to generate more
|
||||
authentication challenges. The SIM will merely calculate the (same) SRES response again, and authentication will
|
||||
succeed. It is bad security to do so, but it is a choice the core network is free to make.
|
||||
|
||||
- UMTS AKA (Milenage or so-called 3G auth, but also used on 2G GERAN) adds mutual authentication, i.e. the core network
|
||||
must prove that it is authentic. Specifically to thwart replay-attacks that would spoof a core network, UMTS AKA
|
||||
contains an ongoing sequence number (SQN) that is woven into the authentication challenge. An SQN may skip forward by
|
||||
a certain number of counts, but it can never move backwards. If a USIM detects a stale SQN, it will request an
|
||||
authentication re-synchronisation (by passing AUTS in an Authentication Failure message), after which a freshly
|
||||
generated UMTS AKA challenge is strictly required -- not possible with an unresponsive home HLR.
|
||||
|
||||
Post-R99 (1999) 2G GERAN networks are capable of UMTS AKA, so, not only 3G, but also the vast majority of 2G networks
|
||||
today use UMTS AKA -- and so does Osmocom, typically. Hence it is desirable to fully support UMTS AKA in D-GSM.
|
||||
|
||||
[options="header"]
|
||||
|===
|
||||
| RAN | authentication is... 2+| available AKA types
|
||||
| GERAN (2G) | optional | GSM AKA | UMTS AKA
|
||||
| UTRAN (3G) | mandatory | - | UMTS AKA
|
||||
|===
|
||||
|
||||
UMTS AKA will not allow re-sending previously used authentication tuples. But a UMTS capable SIM will fall back to GSM
|
||||
AKA if the network sent only a GSM AKA challenge. If the proxy HLR sends only GSM AKA tuples, then the MSC will request
|
||||
GSM authentication, and re-sending old tuples is again possible. However, a USIM will only fall back to GSM AKA if the
|
||||
phone is attaching on a 2G network. For 3G RAN and later, UMTS AKA is mandatory. So, as soon as a site uses 3G or newer
|
||||
RAN technology, there is simply no way to resend previously used authentication tuples.
|
||||
|
||||
The only way to have unused UMTS AKA tuples in the proxy HLR is to already have them stored from an earlier time. The
|
||||
idea is to request more auth tuples in advance whenever the link is available, and cache them in the proxy. When the MSC
|
||||
uses up some tuples from the proxy HLR, the proxy cache can fill up again in its own time, by requesting more tuples
|
||||
from the home HLR at a time of good link. Then, the next time the subscriber needs immediate action, it does not matter
|
||||
whether the home HLR is directly reachable or not.
|
||||
|
||||
In an aside, since OsmoMSC already caches a number of authentication tuples, one option would be to implement this in
|
||||
OsmoMSC, and not in the proxy HLR: the MSC could request new tuples long before its tuple cache runs dry. However, the
|
||||
OsmoMSC VLR state is volatile, and a power cycle of the system would lose the tuple cache; if the home HLR is
|
||||
unreachable at the same time of the power cycle, roaming service would be interrupted. The proxy cache in the HLR is
|
||||
persistent, so roaming can continue immediately after a power cycle, even if the home HLR link is down.
|
||||
|
||||
==== Location Updating
|
||||
|
||||
Any attached subscriber periodically repeats a Location Updating procedure, typically every 15 minutes. If a home HLR is
|
||||
unreachable at the time of the periodic Location Updating, a roaming subscriber would assume that it is detached from
|
||||
the network, even though the local site it is roaming at is still fully operational.
|
||||
|
||||
The aim of D-GSM is to keep subscribers attached even if the remote home HLR is temporarily unreachable. The simplest
|
||||
way to achieve that is by directly responding with a Update Location Result to the MSC.
|
||||
|
||||
In addition to accepting an Update Location, a proxy HLR should also start an Insert Subscriber Data procedure, as a
|
||||
home HLR would do. For a periodic Location Updating, the MSC should already know all of the information that an Insert
|
||||
Subscriber Data would convey (i.e. the MSISDN), and there would be no strict need to resend this data. But if a
|
||||
subscriber quickly detaches and re-attaches (e.g. the device rebooted), the MSC has discarded the subscriber info from
|
||||
the VLR, and hence the proxy HLR should also always perform an Insert Subscriber Data. (On the GSUP wire, a periodic LU
|
||||
is indistinguishable from an IMSI-Attach LU.)
|
||||
|
||||
Furthermore, the longer the proxy HLR's cache keeps a roaming subscriber's data after an IMSI Detach, the longer it is
|
||||
possible for the subscriber to immediately re-attach despite the home HLR being temporarily unreachable.
|
||||
|
||||
If a subscriber has carried out a GSUP Update Location with the proxy HLR while the home HLR was unreachable, it is not
|
||||
strictly necessary to repeat that Update Location message to the home HLR later. The home HLR does keep a timestamped
|
||||
record of an Update Location from a proxy HLR if seen, but that has no visible effect on serving the subscriber:
|
||||
|
||||
- If the home HLR still thinks that the subscriber is currently attached at the home site, it will respond to mslookup
|
||||
requests. But the actual site the subscriber is roaming at will have a younger age, and its mslookup responses will
|
||||
win.
|
||||
|
||||
- If the home HLR has no record of the subscriber being attached recently, or has a record of being attached at another
|
||||
remote site, it does not respond to mslookup requests for that subscriber. If it records the new proxy LU, it still
|
||||
does not respond to mslookup requests since the subscriber is attached remotely, i.e. there is no difference.
|
||||
|
||||
It is thinkable to always handle an Update Location in the proxy HLR, and never even attempt to involve the home HLR in
|
||||
case the proxy cache already has data for a given subscriber, but then the proxy HLR would never notice a changed MSISDN
|
||||
or authorization status for this subscriber. It is best practice to involve the home HLR whenever possible.
|
||||
|
||||
==== IMSI Detach
|
||||
|
||||
If a GSUP client reports a detaching IMSI when the home HLR is not reachable, simply respond with an ack.
|
||||
|
||||
It is not required to signal the home HLR with a detach once the link is back up. A home HLR anyway flags a remotely
|
||||
roaming subscriber as attached-at-a-proxy, and there is literally no difference between telling a home HLR about a
|
||||
detach or not.
|
||||
|
||||
(TODO: is there even a GSUP message that a VLR should send on IMSI Detach? see OS#4374)
|
||||
|
||||
[[proxy_cache_umts_aka_resync]]
|
||||
==== UMTS AKA Resync
|
||||
|
||||
When the SQN between USIM and AUC (subscriber and home HLR) have diverged, the Send Authentication Info Request from the
|
||||
MSC contains an AUTS IE. This means that a resynchronization between USIM and AUC (the home HLR) is necessary. All of
|
||||
the UMTS AKA tuples in the proxy cache are now unusable, and the home HLR must respond with fresh tuples after doing a
|
||||
resync. This also means that either the home HLR must be reachable immediately, or GSM AKA fallback must be allowed for
|
||||
the subscriber to remain in roaming service.
|
||||
|
||||
In short:
|
||||
|
||||
- A UMTS AKA resync is handled similarly to the attaching of a so far unknown subscriber.
|
||||
- With the exception that previous GSM AKA tuples may be available to try a fallback to re-using older tuples.
|
||||
|
||||
Needless to say that avoiding the need for UMTS AKA resynchronization is an important aspect of D-GSM's resilience
|
||||
against unreliable links.
|
||||
|
||||
In UMTS AKA, there is not one single SQN, but there are a number SQN slots, called IND slots or IND buckets. The IND
|
||||
bitlen configured on the USIM determines the amount of slots available. The IND bitlen is usually 5, i.e. 2^5^ = 32
|
||||
slots. Monotonously rising SQN are only strictly enforced within each slot, so that each site should maintain a
|
||||
different IND slot. OsmoHLR determines distinct IND slots based on the IPA unit name. As soon as more than 16 sites
|
||||
(with an MSC and SGSN each) are maintained, IND slots may be shared between distinct sites, and administrative care
|
||||
should be taken to choose wisely which sites share the same slots: those that least share a common user group.
|
||||
|
||||
On 2G RAN, it may be possible to fall back to GSM AKA after a UMTS AKA resync request.
|
||||
TODO: test this
|
||||
|
||||
Either way, the AUTS that was received from the MSC definitely needs to find its way to the home HLR, and, ideally, the
|
||||
immediately returned auth tuples from the home HLR should be used to attach the subscriber.
|
||||
|
||||
=== CS and PS
|
||||
|
||||
Each subscriber may have multiple HLR subscriptions from distinct CN Domain VLRs at any time: Circuit Switched (MSC) and
|
||||
Packet Switched (SGSN) attach separately and perform Update Location Requests that are completely orthogonal, as far as
|
||||
the HLR is concerned.
|
||||
|
||||
Particularly the UMTS AKA tuples, which use distinct IND slots per VLR, need to be cached separately per CN Domain.
|
||||
|
||||
Hence it is not enough to maintain one cache per subscriber. A separate auth tuple cache and Mobility Management state
|
||||
has to be kept for each VLR that is requesting roaming service for a given subscriber.
|
||||
|
||||
=== Intercepting GSUP Conversations
|
||||
|
||||
Taking over GSUP conversations in the proxy HLR is not as trivial as it may sound. Here are potential problems and how
|
||||
to fix them.
|
||||
|
||||
[[proxy_cache_gsup_mm_messages]]
|
||||
==== Which GSUP Conversations to Intercept
|
||||
|
||||
For the purpose of providing highly available roaming despite unreliable links to the home HLR, it suffices to intercept
|
||||
Mobility Management (MM) related GSUP messages, only:
|
||||
|
||||
- Send Auth Info Request / Result
|
||||
- Update Location Request / Result
|
||||
- Insert Subscriber Data Request / Result
|
||||
- PurgeMS Request / Result (?)
|
||||
|
||||
An interesting feature would be to also intercept specific USSD requests, like returning the own MSISDN or IMSI more
|
||||
reliably, or handling services that only make sense when served by the local site. At the time of writing, this is seen
|
||||
as a future extension of D-GSM and not considered for implementation.
|
||||
|
||||
==== Determining Whether a Home HLR is Responsive
|
||||
|
||||
Normally, all GSUP messages are merely routed via the proxy HLR and are handled by the home HLR. The idea is that the
|
||||
proxy HLR jumps in and saves a GSUP conversation when the home HLR is not answering properly.
|
||||
|
||||
The simplest method to decide whether a home HLR is currently connected would be to look at the GSUP client state.
|
||||
However, a local flag that indicates an established GSUP connection does not necessarily mean a reliable link.
|
||||
There are keep-alive messages on the GSUP/IPA link, and a lost connection should reflect in the client state, so that a
|
||||
lost GSUP link definitely indicates an unresponsive home HLR. But for various reasons (e.g. packet loss), the link might
|
||||
look intact, but still a given GSUP message fails to get a response from the home HLR.
|
||||
|
||||
A more resilient method to decide whether a home HLR is responsive is to keep track of every MM related GSUP
|
||||
conversation for each subscriber, and to jump in and take over the GSUP conversation as soon as the response is taking
|
||||
too long to arrive. However, choosing an inadequate timeout period would either mean responding after the MSC has
|
||||
already timed out (too slow), or completely cutting off all responses from a high-latency home HLR (too fast).
|
||||
|
||||
Also, if the proxy HLR has already responded to the MSC, but a slow home HLR's response arrives shortly after,
|
||||
forwarding this late message to the MSC on top of the earlier response to the same request would confuse the GSUP
|
||||
conversation.
|
||||
|
||||
So, the proxy HLR just jumping into the GSUP conversation when a specific delay has passed is fairly complex and error
|
||||
prone. A better idea is to always intercept MM related GSUP conversations:
|
||||
|
||||
[[proxy_cache_gsup_conversations]]
|
||||
==== Solution: Distinct GSUP Conversations
|
||||
|
||||
A solution that avoids all of the above problems is to *always* take over *all* MM related conversations (see
|
||||
<<proxy_cache_gsup_mm_messages>>), as soon as the proxy has sufficient data to service them by itself; at the same time,
|
||||
the proxy HLR should also relay the same requests to the home HLR, and acknowledge its responses, after the fact.
|
||||
|
||||
If the proxy cache already has a complete record of a subscriber, the proxy HLR can always directly accept an Update
|
||||
Location Request, including an Insert Subscriber Data. A prompt response ensures that the MSC does not timeout its GSUP
|
||||
request, and reduces waiting time for the subscriber.
|
||||
|
||||
To ensure that the proxy HLR's data on the subscriber doesn't become stale and diverge from the home HLR, the proxy
|
||||
asynchronously also forwards an Update Location Request to the home HLR. In most normal cases, there will be no
|
||||
surprises, and the home HLR will continue with an Insert Subscriber Data Request containing already known data, and an
|
||||
Update Location Result accepting the LU.
|
||||
|
||||
If the home HLR does not respond, the proxy HLR ignores that fact -- the home HLR is not reachable, and the aim is to
|
||||
continue to service the subscriber for the time being.
|
||||
|
||||
But, should the home HLR's Insert Subscriber Data Request send different data than the proxy cache sees on record, the
|
||||
proxy HLR can trigger another Insert Subscriber Data Request to the MSC, to correct the stale data sent before.
|
||||
|
||||
Similarly, if the home HLR rejects the Update Location Request completely, the proxy HLR can tell the MSC to detach the
|
||||
subscriber with a Cancel Location Request message, as soon as it notices the rejection.
|
||||
|
||||
Note that a UMTS AKA resynchronization request invalidates the entire auth tuple cache and needs to either be sent to
|
||||
the home HLR immediately, if available, or the AUTS from the USIM must later reach the home HLR to obtain fresh UMTS AKA
|
||||
tuples for the cache. See <<proxy_cache_umts_aka_resync>>.
|
||||
|
||||
=== Message Sequences
|
||||
|
||||
==== Normal Roaming Attach
|
||||
|
||||
On first attaching via a proxy HLR, when there is no proxy state for the subscriber yet, the home HLR must be reachable.
|
||||
|
||||
The normal procedure takes place without modification, except that he proxy HLR keeps a copy of the first auth tuples it
|
||||
forwards from the home HLR back to the MSC (marked as used) (1). This is to have auth tuples available for resending
|
||||
already used tuples in a fallback to GSM AKA, in case this is enabled in the proxy HLR config.
|
||||
|
||||
After the Location Updating has completed successfully, the proxy HLR fills up its auth tuple cache by additional Send
|
||||
Auth Info Requests (2). As soon as unused auth tuples become available, the proxy HLR can discard already used tuples
|
||||
from (1).
|
||||
|
||||
.Normal attaching of a subscriber that is roaming here
|
||||
["mscgen"]
|
||||
----
|
||||
include::proxy_cache_attach.msc[]
|
||||
----
|
||||
|
||||
==== MSC Requests More Auth Tuples
|
||||
|
||||
As soon as the MSC has run out of fresh auth tuples, it will ask the HLR proxy for more. Without proxy caching, this
|
||||
request would be directly forwarded to the home HLR. Instead, the proxy HLR finds unused auth tuples in the cache and
|
||||
directly sends those (3). Even if there is a reliable link, the home HLR is not contacted at this point.
|
||||
|
||||
Directly after completing the Send Auth Info Result, the proxy HLR finds that less tuples than requested by the D-GSM
|
||||
configuration are cached, and asks the home HLR for more tuples, to fill up the cache (4). If there currently is no
|
||||
reliable link, this will fail, and the proxy HLR will retry periodically (5) / upon GSUP reconnect.
|
||||
|
||||
.When the MSC has used up all of its auth tuples, but the proxy HLR still has unused auth tuples in the cache
|
||||
["mscgen"]
|
||||
----
|
||||
include::proxy_cache_more_tuples.msc[]
|
||||
----
|
||||
|
||||
==== Running Out of Auth Tuples
|
||||
|
||||
When all fresh tuples from the proxy HLR have been used up, and the home HLR remains unreachable, the proxy HLR normally
|
||||
fails and rejects the subscriber (default configuration).
|
||||
|
||||
If explicitly enabled in the configuration, the proxy HLR will attempt to fall back to GSM AKA and resend already spent
|
||||
tuples, deliberately omitting UMTS AKA parts (6).
|
||||
|
||||
Note that an attempt to refill the tuple cache in the proxy HLR always happens asynchronously. If there are no tuples,
|
||||
that means the link to the home HLR is currently broken, and there is no point in trying to contact it now. Tuples will
|
||||
be obtained as soon as the link is established again.
|
||||
|
||||
.When the MSC has used up all of its auth tuples and the proxy HLR tuple cache is dry
|
||||
["mscgen"]
|
||||
----
|
||||
include::proxy_cache_tuple_cache_dry.msc[]
|
||||
----
|
||||
|
||||
==== Periodic Location Updating
|
||||
|
||||
Each subscriber performs periodic Location Updating to ensure that it is not implicitly detached from the network. When
|
||||
the proxy HLR already has a proxy cache for this subscriber, all information to complete the periodic Location Updating
|
||||
is already known in the proxy HLR. If the link to the home HLR is unresponsive, the proxy HLR mimicks the Insert
|
||||
Subscriber Data Request that the home HLR would normally send, using the cached MSISDN, and then sends the Update
|
||||
Location Result. The subscriber remains attached without a responsive link to the home HLR being required.
|
||||
|
||||
.Periodic Location Updating when the MSC still has unused auth tuples
|
||||
["mscgen"]
|
||||
----
|
||||
include::proxy_cache_periodic_lu.msc[]
|
||||
----
|
||||
|
||||
==== UMTS AKA Resync
|
||||
|
||||
The AUTS from a UMTS AKA resync needs to reach the home HLR sooner or later, and a resync renders all UMTS AKA tuples in
|
||||
the cache stale.
|
||||
|
||||
.Cached tuples become unusable from a UMTS AKA resynchronisation request from the USIM.
|
||||
["mscgen"]
|
||||
----
|
||||
include::proxy_cache_umts_aka_resync.msc[]
|
||||
----
|
||||
@@ -1,39 +0,0 @@
|
||||
{hscale=2}
|
||||
ms = MS,BSS
|
||||
msc = MSC
|
||||
hlr = HLR proxy
|
||||
home = Home HLR
|
||||
|
||||
ms -> msc Location Updating Request (IMSI Attach)
|
||||
msc -> hlr Send Auth Info Request
|
||||
hlr <> hlr No proxy cache data available for this subscriber
|
||||
hlr () home mslookup finds the home HLR
|
||||
hlr -> home Send Auth Info Request
|
||||
hlr <- home Send Auth Info Result
|
||||
with 5 auth tuples
|
||||
hlr () . (1) Keep a copy of the auth tuples
|
||||
msc <- hlr Send Auth Info Result
|
||||
msc () . MSC stores 5 auth tuples,
|
||||
uses the first one now,
|
||||
and keeps the rest for later requests
|
||||
ms () msc Authentication
|
||||
msc -> hlr Update Location Request
|
||||
hlr -> home Update Location Request
|
||||
hlr <- home Insert Subscriber Data Request
|
||||
(with subscriber's MSISDN)
|
||||
hlr () . proxy HLR caches the MSISDN
|
||||
msc <- hlr Insert Subscriber Data Request
|
||||
msc -> hlr Insert Subscriber Data Result
|
||||
hlr -> home Insert Subscriber Data Result
|
||||
hlr <- home Update Location Result
|
||||
msc <- hlr Update Location Result
|
||||
ms <- msc Location Updating Accept
|
||||
hlr <> . After successful Update Location, check the cache
|
||||
hlr () . (2) Ask for more auth tuples to cache
|
||||
(amount of tuples configurable)
|
||||
hlr -> home Send Auth Info Request
|
||||
hlr <- home Send Auth Info Result
|
||||
hlr () . store 5 more tuples
|
||||
hlr -> home Send Auth Info Request
|
||||
hlr <- home Send Auth Info Result
|
||||
hlr () . store yet 5 more tuples
|
||||
@@ -1,33 +0,0 @@
|
||||
msc {
|
||||
hscale="2";
|
||||
ms[label="MS,BSS"],__msc[label="MSC"],hlr[label="HLR proxy"],home[label="Home HLR"];
|
||||
|
||||
ms => __msc [label="Location Updating Request (IMSI Attach)"];
|
||||
__msc => hlr [label="Send Auth Info Request"];
|
||||
hlr abox hlr [label="No proxy cache data available for this subscriber"];
|
||||
hlr rbox home [label="mslookup finds the home HLR"];
|
||||
hlr => home [label="Send Auth Info Request"];
|
||||
hlr <= home [label="Send Auth Info Result\nwith 5 auth tuples"];
|
||||
hlr rbox hlr [label="(1) Keep a copy of the auth tuples"];
|
||||
__msc <= hlr [label="Send Auth Info Result"];
|
||||
__msc rbox __msc [label="MSC stores 5 auth tuples,\nuses the first one now,\nand keeps the rest for later requests"];
|
||||
ms rbox __msc [label="Authentication"];
|
||||
__msc => hlr [label="Update Location Request"];
|
||||
hlr => home [label="Update Location Request"];
|
||||
hlr <= home [label="Insert Subscriber Data Request\n(with subscriber's MSISDN)"];
|
||||
hlr rbox hlr [label="proxy HLR caches the MSISDN"];
|
||||
__msc <= hlr [label="Insert Subscriber Data Request"];
|
||||
__msc => hlr [label="Insert Subscriber Data Result"];
|
||||
hlr => home [label="Insert Subscriber Data Result"];
|
||||
hlr <= home [label="Update Location Result"];
|
||||
__msc <= hlr [label="Update Location Result"];
|
||||
ms <= __msc [label="Location Updating Accept"];
|
||||
hlr abox hlr [label="After successful Update Location, check the cache"];
|
||||
hlr rbox hlr [label="(2) Ask for more auth tuples to cache\n(amount of tuples configurable)"];
|
||||
hlr => home [label="Send Auth Info Request"];
|
||||
hlr <= home [label="Send Auth Info Result"];
|
||||
hlr rbox hlr [label="store 5 more tuples"];
|
||||
hlr => home [label="Send Auth Info Request"];
|
||||
hlr <= home [label="Send Auth Info Result"];
|
||||
hlr rbox hlr [label="store yet 5 more tuples"];
|
||||
}
|
||||
@@ -1,31 +0,0 @@
|
||||
{hscale=2}
|
||||
ms = MS,BSS
|
||||
msc = MSC
|
||||
hlr = HLR proxy
|
||||
home = Home HLR
|
||||
|
||||
ms -> msc CM Service Request / Paging Response
|
||||
msc -> hlr Send Auth Info Request
|
||||
hlr () . Use already set up proxy path
|
||||
hlr <> . there still are unsent auth tuples
|
||||
in the cache
|
||||
hlr () . (3) Send cached, fresh tuples
|
||||
msc <- hlr Send Auth Info Result
|
||||
containing auth tuples
|
||||
from the proxy cache
|
||||
ms () msc Authentication
|
||||
ms () msc Continue the CM Service / Paging action
|
||||
hlr <> . Note that there are no/few unused tuples in the cache, fill up again
|
||||
hlr () . (4) Ask for more auth tuples to cache
|
||||
hlr -> home Send Auth Info Request
|
||||
--- If the home HLR link is not working
|
||||
hlr <> . no link
|
||||
or
|
||||
response timeout
|
||||
hlr () . (5) Set up a timer to retry SAI
|
||||
(a few minutes?)
|
||||
hlr <> . Timer triggers
|
||||
hlr -> home Send Auth Info Request
|
||||
--- If the home HLR link is functional
|
||||
hlr <- home Send Auth Info Result
|
||||
hlr () . store 5 more tuples
|
||||
@@ -1,24 +0,0 @@
|
||||
msc {
|
||||
hscale="2";
|
||||
ms[label="MS,BSS"],__msc[label="MSC"],hlr[label="HLR proxy"],home[label="Home HLR"];
|
||||
|
||||
ms => __msc [label="CM Service Request / Paging Response"];
|
||||
__msc => hlr [label="Send Auth Info Request"];
|
||||
hlr rbox hlr [label="Use already set up proxy path"];
|
||||
hlr abox hlr [label="there still are unsent auth tuples\nin the cache"];
|
||||
hlr rbox hlr [label="(3) Send cached, fresh tuples"];
|
||||
__msc <= hlr [label="Send Auth Info Result\ncontaining auth tuples\nfrom the proxy cache"];
|
||||
ms rbox __msc [label="Authentication"];
|
||||
ms rbox __msc [label="Continue the CM Service / Paging action"];
|
||||
hlr abox hlr [label="Note that there are no/few unused tuples in the cache, fill up again"];
|
||||
hlr rbox hlr [label="(4) Ask for more auth tuples to cache"];
|
||||
hlr => home [label="Send Auth Info Request"];
|
||||
--- [label="If the home HLR link is not working"];
|
||||
hlr abox hlr [label="no link\nor\nresponse timeout"];
|
||||
hlr rbox hlr [label="(5) Set up a timer to retry SAI\n(a few minutes?)"];
|
||||
hlr abox hlr [label="Timer triggers"];
|
||||
hlr => home [label="Send Auth Info Request"];
|
||||
--- [label="If the home HLR link is functional"];
|
||||
hlr <= home [label="Send Auth Info Result"];
|
||||
hlr rbox hlr [label="store 5 more tuples"];
|
||||
}
|
||||
@@ -1,47 +0,0 @@
|
||||
{hscale=2}
|
||||
ms = MS,BSS
|
||||
msc = MSC
|
||||
hlr = HLR proxy
|
||||
home = Home HLR
|
||||
|
||||
ms -> msc Location Updating Request (Periodic)
|
||||
ms () msc Authentication,
|
||||
using the next of 5 auth tuples the MSC has stored
|
||||
msc -> hlr Update Location Request
|
||||
hlr () . Use already set up proxy path
|
||||
hlr <> . (8) proxy cache already has all information to answer
|
||||
msc <- hlr Insert Subscriber Data Request
|
||||
msc -> hlr Insert Subscriber Data Result
|
||||
msc <- hlr Update Location Result
|
||||
ms <- msc Location Updating Accept
|
||||
hlr () . (9) Verify Update Location with home HLR
|
||||
|||
|
||||
--- if the home HLR has no changes and accepts
|
||||
hlr -> home Update Location Request
|
||||
hlr <- home Insert Subscriber Data Request
|
||||
hlr -> home Insert Subscriber Data Result
|
||||
hlr <> . Notice identical MSISDN
|
||||
hlr <- home Update Location Result
|
||||
|||
|
||||
--- if the home HLR is unreachable
|
||||
hlr -> home Update Location Request
|
||||
hlr <> . no link
|
||||
or
|
||||
response timeout
|
||||
hlr () . Don't care, carry on
|
||||
|||
|
||||
--- if the home HLR has a modified MSISDN, and accepts
|
||||
hlr -> home Update Location Request
|
||||
hlr <- home Insert Subscriber Data Request
|
||||
hlr -> home Insert Subscriber Data Result
|
||||
hlr <> . Notice changed MSISDN
|
||||
msc <- hlr Insert Subscriber Data Request
|
||||
msc -> hlr Insert Subscriber Data Result
|
||||
hlr <- home Update Location Result
|
||||
|||
|
||||
--- if the home HLR rejects
|
||||
hlr -> home Update Location Request
|
||||
hlr <- home Update Location Error
|
||||
msc <- hlr Cancel Location Request
|
||||
msc -> hlr Cancel Location Result
|
||||
hlr () . Clear subscriber cache
|
||||
@@ -1,43 +0,0 @@
|
||||
msc {
|
||||
hscale="2";
|
||||
ms[label="MS,BSS"],__msc[label="MSC"],hlr[label="HLR proxy"],home[label="Home HLR"];
|
||||
|
||||
ms => __msc [label="Location Updating Request (Periodic)"];
|
||||
ms rbox __msc [label="Authentication,\nusing the next of 5 auth tuples the MSC has stored"];
|
||||
__msc => hlr [label="Update Location Request"];
|
||||
hlr rbox hlr [label="Use already set up proxy path"];
|
||||
hlr abox hlr [label="(8) proxy cache already has all information to answer"];
|
||||
__msc <= hlr [label="Insert Subscriber Data Request"];
|
||||
__msc => hlr [label="Insert Subscriber Data Result"];
|
||||
__msc <= hlr [label="Update Location Result"];
|
||||
ms <= __msc [label="Location Updating Accept"];
|
||||
hlr rbox hlr [label="(9) Verify Update Location with home HLR"];
|
||||
|||;
|
||||
--- [label="if the home HLR has no changes and accepts"];
|
||||
hlr => home [label="Update Location Request"];
|
||||
hlr <= home [label="Insert Subscriber Data Request"];
|
||||
hlr => home [label="Insert Subscriber Data Result"];
|
||||
hlr abox hlr [label="Notice identical MSISDN"];
|
||||
hlr <= home [label="Update Location Result"];
|
||||
|||;
|
||||
--- [label="if the home HLR is unreachable"];
|
||||
hlr => home [label="Update Location Request"];
|
||||
hlr abox hlr [label="no link\nor\nresponse timeout"];
|
||||
hlr rbox hlr [label="Don't care, carry on"];
|
||||
|||;
|
||||
--- [label="if the home HLR has a modified MSISDN, and accepts"];
|
||||
hlr => home [label="Update Location Request"];
|
||||
hlr <= home [label="Insert Subscriber Data Request"];
|
||||
hlr => home [label="Insert Subscriber Data Result"];
|
||||
hlr abox hlr [label="Notice changed MSISDN"];
|
||||
__msc <= hlr [label="Insert Subscriber Data Request"];
|
||||
__msc => hlr [label="Insert Subscriber Data Result"];
|
||||
hlr <= home [label="Update Location Result"];
|
||||
|||;
|
||||
--- [label="if the home HLR rejects"];
|
||||
hlr => home [label="Update Location Request"];
|
||||
hlr <= home [label="Update Location Error"];
|
||||
__msc <= hlr [label="Cancel Location Request"];
|
||||
__msc => hlr [label="Cancel Location Result"];
|
||||
hlr rbox hlr [label="Clear subscriber cache"];
|
||||
}
|
||||
@@ -1,21 +0,0 @@
|
||||
{hscale=2}
|
||||
ms = MS,BSS
|
||||
msc = MSC
|
||||
hlr = HLR proxy
|
||||
home = Home HLR
|
||||
|
||||
ms -> msc CM Service Request / Paging Response
|
||||
msc -> hlr Send Auth Info Request
|
||||
hlr () . Use already set up proxy path
|
||||
hlr <> . All cached auth tuples have been sent to the MSC before
|
||||
--- If no GSM AKA fallback is allowed
|
||||
msc <- hlr Send Auth Info Error
|
||||
ms () msc Detach
|
||||
--- If GSM AKA fallback is allowed
|
||||
hlr () . (6) Resend only GSM AKA tuples, already sent earlier
|
||||
msc <- hlr Send Auth Info Result
|
||||
containing GSM AKA auth tuples
|
||||
from the proxy cache
|
||||
ms () msc 2G: Authentication
|
||||
3G: Detach
|
||||
ms () msc Continue the CM Service / Paging action
|
||||
@@ -1,17 +0,0 @@
|
||||
msc {
|
||||
hscale="2";
|
||||
ms[label="MS,BSS"],__msc[label="MSC"],hlr[label="HLR proxy"],home[label="Home HLR"];
|
||||
|
||||
ms => __msc [label="CM Service Request / Paging Response"];
|
||||
__msc => hlr [label="Send Auth Info Request"];
|
||||
hlr rbox hlr [label="Use already set up proxy path"];
|
||||
hlr abox hlr [label="All cached auth tuples have been sent to the MSC before"];
|
||||
--- [label="If no GSM AKA fallback is allowed"];
|
||||
__msc <= hlr [label="Send Auth Info Error"];
|
||||
ms rbox __msc [label="Detach"];
|
||||
--- [label="If GSM AKA fallback is allowed"];
|
||||
hlr rbox hlr [label="(6) Resend only GSM AKA tuples, already sent earlier"];
|
||||
__msc <= hlr [label="Send Auth Info Result\ncontaining GSM AKA auth tuples\nfrom the proxy cache"];
|
||||
ms rbox __msc [label="2G: Authentication\n3G: Detach"];
|
||||
ms rbox __msc [label="Continue the CM Service / Paging action"];
|
||||
}
|
||||
@@ -1,55 +0,0 @@
|
||||
{hscale=2}
|
||||
ms = MS,BSS
|
||||
msc = MSC
|
||||
hlr = HLR proxy
|
||||
home = Home HLR
|
||||
|
||||
ms -> msc CM Service Request / Paging Response
|
||||
msc -> hlr Send Auth Info Request
|
||||
hlr <> . there still are unsent auth tuples
|
||||
in the cache
|
||||
hlr () . Send cached, fresh tuples
|
||||
msc <- hlr Send Auth Info Result
|
||||
containing auth tuples
|
||||
from the proxy cache
|
||||
ms <- msc Authentication Request
|
||||
ms -> msc USIM requests UMTS AKA resync
|
||||
Auth Failure with AUTS
|
||||
msc -> hlr Send Auth Info Request
|
||||
containing AUTS IE
|
||||
hlr () . Mark all UMTS AKA tuples as stale
|
||||
--- If the home HLR responds in time
|
||||
hlr -> home Send Auth Info Request
|
||||
hlr <- home Send Auth Info Result
|
||||
with 5 auth tuples
|
||||
hlr () . clear tuple cache, store new tuples
|
||||
msc <- hlr Send Auth Info Result
|
||||
ms () msc Authentication
|
||||
hlr () . fill up the tuple cache as necessary
|
||||
hlr -> home Send Auth Info Request
|
||||
hlr <- home Send Auth Info Result
|
||||
...
|
||||
--- If the home HLR is unreachable
|
||||
hlr -> home Send Auth Info Request
|
||||
hlr <> . no link
|
||||
or
|
||||
response timeout
|
||||
hlr () . Store the AUTS received earlier,
|
||||
and set up a timer to retry SAI
|
||||
(a few minutes?)
|
||||
--- If no GSM AKA fallback is allowed
|
||||
msc <- hlr Send Auth Info Error
|
||||
ms () msc Detach
|
||||
--- If GSM AKA fallback is allowed
|
||||
hlr () . Resend only GSM AKA tuples, already sent earlier
|
||||
msc <- hlr Send Auth Info Result
|
||||
containing GSM AKA auth tuples
|
||||
from the proxy cache
|
||||
ms () msc 2G: Authentication
|
||||
3G: Detach
|
||||
---
|
||||
hlr <> . AUTS timer triggers
|
||||
hlr -> home Send Auth Info Request
|
||||
hlr <- home Send Auth Info Result
|
||||
hlr () . clear tuple cache, store new tuples
|
||||
hlr () . continue to fill up the cache as necessary
|
||||
@@ -1,41 +0,0 @@
|
||||
msc {
|
||||
hscale="2";
|
||||
ms[label="MS,BSS"],__msc[label="MSC"],hlr[label="HLR proxy"],home[label="Home HLR"];
|
||||
|
||||
ms => __msc [label="CM Service Request / Paging Response"];
|
||||
__msc => hlr [label="Send Auth Info Request"];
|
||||
hlr abox hlr [label="there still are unsent auth tuples\nin the cache"];
|
||||
hlr rbox hlr [label="Send cached, fresh tuples"];
|
||||
__msc <= hlr [label="Send Auth Info Result\ncontaining auth tuples\nfrom the proxy cache"];
|
||||
ms <= __msc [label="Authentication Request"];
|
||||
ms => __msc [label="USIM requests UMTS AKA resync\nAuth Failure with AUTS"];
|
||||
__msc => hlr [label="Send Auth Info Request\ncontaining AUTS IE"];
|
||||
hlr rbox hlr [label="Mark all UMTS AKA tuples as stale"];
|
||||
--- [label="If the home HLR responds in time"];
|
||||
hlr => home [label="Send Auth Info Request"];
|
||||
hlr <= home [label="Send Auth Info Result\nwith 5 auth tuples"];
|
||||
hlr rbox hlr [label="clear tuple cache, store new tuples"];
|
||||
__msc <= hlr [label="Send Auth Info Result"];
|
||||
ms rbox __msc [label="Authentication"];
|
||||
hlr rbox hlr [label="fill up the tuple cache as necessary"];
|
||||
hlr => home [label="Send Auth Info Request"];
|
||||
hlr <= home [label="Send Auth Info Result"];
|
||||
...;
|
||||
--- [label="If the home HLR is unreachable"];
|
||||
hlr => home [label="Send Auth Info Request"];
|
||||
hlr abox hlr [label="no link\nor\nresponse timeout"];
|
||||
hlr rbox hlr [label="Store the AUTS received earlier,\nand set up a timer to retry SAI\n(a few minutes?)"];
|
||||
--- [label="If no GSM AKA fallback is allowed"];
|
||||
__msc <= hlr [label="Send Auth Info Error"];
|
||||
ms rbox __msc [label="Detach"];
|
||||
--- [label="If GSM AKA fallback is allowed"];
|
||||
hlr rbox hlr [label="Resend only GSM AKA tuples, already sent earlier"];
|
||||
__msc <= hlr [label="Send Auth Info Result\ncontaining GSM AKA auth tuples\nfrom the proxy cache"];
|
||||
ms rbox __msc [label="2G: Authentication\n3G: Detach"];
|
||||
---;
|
||||
hlr abox hlr [label="AUTS timer triggers"];
|
||||
hlr => home [label="Send Auth Info Request"];
|
||||
hlr <= home [label="Send Auth Info Result"];
|
||||
hlr rbox hlr [label="clear tuple cache, store new tuples"];
|
||||
hlr rbox hlr [label="continue to fill up the cache as necessary"];
|
||||
}
|
||||
@@ -1,87 +0,0 @@
|
||||
== Running OsmoHLR
|
||||
|
||||
The OsmoHLR executable (`osmo-hlr`) offers the following command-line
|
||||
arguments:
|
||||
|
||||
=== SYNOPSIS
|
||||
|
||||
*osmo-hlr* [-h] [-c 'CONFIGFILE'] [-l 'DATABASE'] [-d 'DBGMASK'] [-D] [-s] [-T] [-e 'LOGLEVEL'] [-U] [-V]
|
||||
|
||||
=== OPTIONS
|
||||
|
||||
// Keep the order the same as in osmo-hlr --help!
|
||||
|
||||
*-h, --help*::
|
||||
Print a short help message about the supported options
|
||||
*-c, --config-file 'CONFIGFILE'*::
|
||||
Specify the file and path name of the configuration file to be
|
||||
used. If none is specified, use `osmo-hlr.cfg` in the current
|
||||
working directory.
|
||||
*-l, --database 'DATABASE'*::
|
||||
Specify the file name of the SQLite3 database to use as HLR/AUC
|
||||
storage
|
||||
*-d, --debug 'DBGMASK','DBGLEVELS'*::
|
||||
Set the log subsystems and levels for logging to stderr. This
|
||||
has mostly been superseded by VTY-based logging configuration,
|
||||
see <<logging>> for further information.
|
||||
*-D, --daemonize*::
|
||||
Fork the process as a daemon into background.
|
||||
*-s, --disable-color*::
|
||||
Disable colors for logging to stderr. This has mostly been
|
||||
deprecated by VTY based logging configuration, see <<logging>>
|
||||
for more information.
|
||||
*-T, --timestamp*::
|
||||
Enable time-stamping of log messages to stderr. This has mostly
|
||||
been deprecated by VTY based logging configuration, see
|
||||
<<logging>> for more information.
|
||||
*-e, --log-level 'LOGLEVEL'*::
|
||||
Set the global log level for logging to stderr. This has mostly
|
||||
been deprecated by VTY based logging configuration, see
|
||||
<<logging>> for more information.
|
||||
*-U, --db-upgrade*::
|
||||
Allow HLR database schema upgrades. If OsmoHLR was updated and
|
||||
requires a newer database schema, it will refuse to start unless
|
||||
this option is specified. The updated database can not be
|
||||
downgraded, make backups as necessary.
|
||||
*-V, --version*::
|
||||
Print the compile-time version number of the OsmoHLR program
|
||||
|
||||
=== Bootstrap the Database
|
||||
|
||||
If no database exists yet, OsmoHLR will automatically create and bootstrap a
|
||||
database file with empty tables. If no `-l` command-line option is provided,
|
||||
this database file will be created in the current working directory.
|
||||
|
||||
Alternatively, you may use the `osmo-hlr-db-tool`, which is installed along
|
||||
with `osmo-hlr`, to bootstrap an empty database, or to migrate subscriber data
|
||||
from an old 'OsmoNITB' database. See `osmo-hlr-db-tool --help`.
|
||||
|
||||
=== Multiple instances
|
||||
|
||||
Running multiple instances of `osmo-hlr` on the same computer is possible if
|
||||
all interfaces (VTY, CTRL) are separated using the appropriate configuration
|
||||
options. The IP based interfaces are binding to local host by default. In order
|
||||
to separate the processes, the user has to bind those services to specific but
|
||||
different IP addresses and/or ports.
|
||||
|
||||
The VTY and the Control interface can be bound to IP addresses from the loopback
|
||||
address range, for example:
|
||||
|
||||
----
|
||||
line vty
|
||||
bind 127.0.0.2
|
||||
ctrl
|
||||
bind 127.0.0.2
|
||||
----
|
||||
|
||||
The GSUP interface can be bound to a specific IP address by the following
|
||||
configuration options:
|
||||
|
||||
----
|
||||
hlr
|
||||
gsup
|
||||
bind ip 10.23.42.1
|
||||
----
|
||||
|
||||
NOTE: At the time of writing, OsmoHLR lacks a config option to change the GSUP
|
||||
port, which is by default TCP port 4222.
|
||||
@@ -1,129 +0,0 @@
|
||||
== Managing Subscribers
|
||||
|
||||
Subscribers are kept in a local SQLite database file and can be managed via VTY
|
||||
and CTRL interfaces.
|
||||
|
||||
This section provides some examples; also refer to the OsmoHLR VTY reference
|
||||
manual <<vty-ref-osmohlr>> as well as the Control interface described in
|
||||
<<hlr-ctrl>>.
|
||||
|
||||
=== Example: Add/Update/Delete Subscriber via VTY
|
||||
|
||||
The following telnet VTY session adds a subscriber complete with GSM (2G) and
|
||||
UMTS (3G and 2G) authentication tokens, and finally removes the subscriber
|
||||
again; it assumes that osmo-hlr is running and listening for telnet VTY
|
||||
connections on localhost:
|
||||
|
||||
----
|
||||
$ telnet localhost 4258
|
||||
include::../example_subscriber_add_update_delete.vty[]
|
||||
----
|
||||
|
||||
[[subscriber-params]]
|
||||
=== Subscriber Parameters
|
||||
|
||||
The following parameters are managed for each subscriber of the HLR, modelled
|
||||
roughly after 3GPP TS 23.008, version 13.3.0; note that not all of these
|
||||
parameters are necessarily in active use.
|
||||
|
||||
The `aud3g` table also applies to 2G networks: it provides UMTS AKA tokens for
|
||||
Milenage authentication, which is available both on 3G and 2G networks. On 2G,
|
||||
when both MS and network are R99 capable (like OsmoMSC and OsmoSGSN are), the
|
||||
full UMTS AKA with Milenage keys from `aud_3g`, using AUTN and extended RES
|
||||
tokens, is available. With pre-R99 MS or network configurations, the GSM AKA
|
||||
compatible variant of Milenage, still using the Milenage keys from `aud_3g` but
|
||||
transceiving only RAND and SRES, may be applicable. (See 3GPP TS 33.102, chapter
|
||||
6.8.1, Authentication and key agreement of UMTS subscribers.)
|
||||
|
||||
.OsmoHLR's subscriber parameters
|
||||
[options="header",width="100%",cols="20%,20%,60%"]
|
||||
|===
|
||||
|Name|Example|Description
|
||||
|imsi|901700000014701|identity of the SIM/USIM, 3GPP TS 23.008 chapter 2.1.1.1
|
||||
|msisdn|2342123|number to dial to reach this subscriber (multiple MSISDNs can be stored per subscriber), 3GPP TS 23.008 chapter 2.1.2
|
||||
|imeisv|4234234234234275|identity of the mobile device and software version, 3GPP TS 23.008 chapter 2.2.3
|
||||
|aud2g.algo|comp128v3|Authentication algorithm ID for GSM AKA, corresponds to enum osmo_auth_algo
|
||||
|aud2g.ki||Subscriber's secret key (128bit)
|
||||
|aud3g.algo|milenage|Authentication algorithm ID for UMTS AKA (applies to both 3G and 2G networks), corresponds to enum osmo_auth_algo
|
||||
|aud3g.k|(32 hexadecimal digits)|Subscriber's secret key (128bit)
|
||||
|aud3g.op|(32 hexadecimal digits)|Operator's secret key (128bit)
|
||||
|aud3g.opc|(32 hexadecimal digits)|Secret key derived from OP and K (128bit), alternative to using OP which does not disclose OP to subscribers
|
||||
|aud3g.sqn|123|Sequence number of last used key (64bit unsigned)
|
||||
|aud3g.ind_bitlen|5|Nr of index bits at lower SQN end
|
||||
|apn||
|
||||
|vlr_number||3GPP TS 23.008 chapter 2.4.5
|
||||
|msc_number||3GPP TS 23.008 chapter 2.4.6
|
||||
|sgsn_number||3GPP TS 23.008 chapter 2.4.8.1
|
||||
|sgsn_address||3GPP TS 23.008 chapter 2.13.10
|
||||
|ggsn_number||3GPP TS 23.008 chapter 2.4.8.2
|
||||
|gmlc_number||3GPP TS 23.008 chapter 2.4.9.2
|
||||
|smsc_number||3GPP TS 23.008 chapter 2.4.23
|
||||
|periodic_lu_tmr||3GPP TS 23.008 chapter 2.4.24
|
||||
|periodic_rau_tau_tmr||3GPP TS 23.008 chapter 2.13.115
|
||||
|nam_cs|1|Enable/disable voice access (3GPP TS 23.008 chapter 2.1.1.2: network access mode)
|
||||
|nam_ps|0|Enable/disable data access (3GPP TS 23.008 chapter 2.1.1.2: network access mode)
|
||||
|lmsi||3GPP TS 23.008 chapter 2.1.8
|
||||
|ms_purged_cs|0|3GPP TS 23.008 chapter 2.7.5
|
||||
|ms_purged_ps|1|3GPP TS 23.008 chapter 2.7.6
|
||||
|===
|
||||
|
||||
=== Configuring the Subscribers Create on Demand Feature
|
||||
|
||||
Usually a HLR will only allow mobile equipment (ME) on the network, if the HLR
|
||||
has a subscriber entry with the ME's IMSI. But OsmoHLR can also be configured to
|
||||
automatically create new entries for new IMSIs, with the
|
||||
`subscriber-create-on-demand` VTY option. The obvious use case is creating the
|
||||
new subscriber entry and then allowing the ME to use both the CS
|
||||
(Circuit Switched) and PS (Packet Switched) NAM (Network Access Mode).
|
||||
|
||||
.osmo-hlr.cfg
|
||||
----
|
||||
hlr
|
||||
subscriber-create-on-demand 5 cs+ps
|
||||
----
|
||||
|
||||
On the other hand, operators might only want to give network access to IMSIs, of
|
||||
which they know the owner. In order to do that, one can set the default NAM to
|
||||
`none` and manually approve new subscribers by changing the NAM (e.g. over the
|
||||
VTY, see the example below).
|
||||
|
||||
Oftentimes it is hard to know, which IMSI belongs to which ME, but the IMEI is
|
||||
readily available. If you configure your MSC to send IMEI checking requests to
|
||||
the HLR, before sending location update requests, the subscribers created on
|
||||
demand can also have the IMEI stored in the HLR database. With OsmoMSC, this
|
||||
is done by writing `check-imei-rqd early` in the `msc` section of osmo-msc.cfg.
|
||||
Then enable storing the IMEI when receiving check IMEI requests with
|
||||
`store-imei` in the OsmoHLR configuration.
|
||||
|
||||
.osmo-msc.cfg
|
||||
----
|
||||
msc
|
||||
check-imei-rqd early
|
||||
----
|
||||
|
||||
.osmo-hlr.cfg
|
||||
----
|
||||
hlr
|
||||
subscriber-create-on-demand 5 none
|
||||
store-imei
|
||||
----
|
||||
|
||||
.Example: Enabling CS and PS NAM via VTY for a known IMEI
|
||||
----
|
||||
OsmoHLR> enable
|
||||
OsmoHLR# subscriber imei 35761300444848 show
|
||||
ID: 1
|
||||
IMSI: 123456789023000
|
||||
MSISDN: 58192 <1>
|
||||
IMEI: 35761300444848
|
||||
CS disabled <2>
|
||||
PS disabled <2>
|
||||
OsmoHLR# subscriber imei 35761300444848 update network-access-mode cs+ps
|
||||
OsmoHLR# subscriber imei 35761300444848 show
|
||||
ID: 1
|
||||
IMSI: 123456789023000
|
||||
MSISDN: 58192
|
||||
IMEI: 35761300444848
|
||||
----
|
||||
<1> Randomly generated 5 digit MSISDN
|
||||
<2> Disabled CS and PS NAM prevent the subscriber from accessing the network
|
||||
@@ -1,78 +0,0 @@
|
||||
[[ussd]]
|
||||
== Unstructured Supplementary Services Data (USSD)
|
||||
|
||||
The _Unstructured Supplementary Services Data (USSD)_ is one service within
|
||||
2G/3G networks next to other services such as circuit-switched voice, packet-switched
|
||||
data and SMS (Short Message Service).
|
||||
|
||||
It is on an abstract level quite similar to SMS in that USSD can be used to send
|
||||
textual messages. However, there are the following differences:
|
||||
|
||||
* USSD is between the MS (phone) and an USSD application on the network, while
|
||||
SMS is primarily between two subscribers identified by their MSISDN
|
||||
* USSD is faster, as it doesn't suffer from the complicated three-layer CP/RP/TP
|
||||
protocol stack of SMS with it's acknowledgement of the acknowledged acknowledgement.
|
||||
* USSD is session-oriented, i.e. a dialogue/session between subscriber and application
|
||||
can persist for the transfer of more than one message. The dedicated radio channel
|
||||
on the RAN remains established throughout that dialogue.
|
||||
|
||||
=== USSD in Osmocom
|
||||
|
||||
Until August 2018, OsmoMSC contained some minimalistic internal USSD
|
||||
handling with no
|
||||
ability to attach/extend it with external USSD applications.
|
||||
|
||||
From August 2018 onwards, OsmoMSC doesn't contain any internal USSD
|
||||
handlers/applications anymore. Instead, all USSD is transported to/from
|
||||
OsmoHLR via the GSUP protocol.
|
||||
|
||||
OsmoHLR contains some intenal USSD handlers and can route USSD messages
|
||||
to any number of external USSD entities (EUSEs). The EUSE also use GSUP
|
||||
to communicate USSD from/to OsmoHLR.
|
||||
|
||||
Each EUSE is identified by its name. The name consists of a single-word
|
||||
string preceding a currently fixed ("-00-00-00-00-00-00") suffix.
|
||||
There is no authentication between EUSE and OsmoHLR: Any client program
|
||||
able to connect to the GSUP port of OsmoHLR can register as any EUSE
|
||||
(name).
|
||||
|
||||
NOTE:: We plan to remove the requirement for this suffix as soon as we
|
||||
are done resolving all more important issues.
|
||||
|
||||
=== USSD Configuration
|
||||
|
||||
USSD configuration in OsmoHLR happens within the `hlr` VTY node.
|
||||
|
||||
`euse foobar-00-00-00-00-00-00` defines an EUSE with the given name `foobar`
|
||||
|
||||
`ussd route prefix *123 external foobar-00-00-00-00-00-00` installs a
|
||||
prefix route to the named EUSE. All USSD short codes starting with *123 will be
|
||||
routed to the named EUSE.
|
||||
|
||||
`ussd route prefix *#100# internal own-msisdn` installs a prefix route
|
||||
to the named internal USSD handler. There above command will restore
|
||||
the old behavior, in which *#100# will return a text message containing
|
||||
the subscribers own phone number. There is one other handler called
|
||||
`own-imsi` which will return the IMSI instead of the MSISDN.
|
||||
|
||||
`ussd default-route external foobar-00-00-00-00-00-00` installs a
|
||||
default route to the named EUSE. This means that all USSD codes for
|
||||
which no more specific route exists will be routed to the named EUSE.
|
||||
|
||||
=== Example EUSE program
|
||||
|
||||
We have provided an example EUSE developed in C language using existing
|
||||
Osmocom libraries for GSUP protocol handling and USSD encoding/decoding.
|
||||
It will register as `foobar` EUSE to OsmoHLR on localhost. You can run
|
||||
it on a different machine by specifying e.g. `osmo-euse-demo 1.2.3.4 5678`
|
||||
to make it connect to OsmoHLR on IP address 1.2.3.4 and GSUP/TCP port
|
||||
5678.
|
||||
|
||||
The idea is that you can use this as a template to develop your own USSD
|
||||
applications, or any gateways to other protocols or interfaces.
|
||||
|
||||
You can find it in `osmo-hlr/src/osmo-euse-demo.c` or online by
|
||||
following the link to http://git.osmocom.org/osmo-hlr/tree/src/osmo-euse-demo.c
|
||||
|
||||
This demonstration program will echo back any USSD message sent/routed
|
||||
to it, quoted like _You sent "..."_.
|
||||
@@ -1,34 +0,0 @@
|
||||
OsmoHLR> enable
|
||||
OsmoHLR# subscriber imsi 123456789023000 create
|
||||
% Created subscriber 123456789023000
|
||||
ID: 1
|
||||
IMSI: 123456789023000
|
||||
MSISDN: none
|
||||
|
||||
OsmoHLR# subscriber imsi 123456789023000 update msisdn 423
|
||||
% Updated subscriber IMSI='123456789023000' to MSISDN='423'
|
||||
|
||||
OsmoHLR# subscriber msisdn 423 update aud3g milenage k deaf0ff1ced0d0dabbedd1ced1cef00d opc cededeffacedacefacedbadfadedbeef
|
||||
OsmoHLR# subscriber msisdn 423 show
|
||||
ID: 1
|
||||
IMSI: 123456789023000
|
||||
MSISDN: 423
|
||||
3G auth: MILENAGE
|
||||
K=deaf0ff1ced0d0dabbedd1ced1cef00d
|
||||
OPC=cededeffacedacefacedbadfadedbeef
|
||||
IND-bitlen=5
|
||||
|
||||
OsmoHLR# subscriber msisdn 423 update aud2g comp128v3 ki beefedcafefaceacedaddeddecadefee
|
||||
OsmoHLR# subscriber msisdn 423 show
|
||||
ID: 1
|
||||
IMSI: 123456789023000
|
||||
MSISDN: 423
|
||||
2G auth: COMP128v3
|
||||
KI=beefedcafefaceacedaddeddecadefee
|
||||
3G auth: MILENAGE
|
||||
K=deaf0ff1ced0d0dabbedd1ced1cef00d
|
||||
OPC=cededeffacedacefacedbadfadedbeef
|
||||
IND-bitlen=5
|
||||
|
||||
OsmoHLR# subscriber imsi 123456789023000 delete
|
||||
% Deleted subscriber for IMSI '123456789023000'
|
||||
@@ -1,71 +0,0 @@
|
||||
GET 1 subscriber.by-msisdn-103.info
|
||||
GET_REPLY 1 subscriber.by-msisdn-103.info
|
||||
id 3
|
||||
imsi 901990000000003
|
||||
msisdn 103
|
||||
nam_cs 1
|
||||
nam_ps 1
|
||||
ms_purged_cs 0
|
||||
ms_purged_ps 0
|
||||
periodic_lu_timer 0
|
||||
periodic_rau_tau_timer 0
|
||||
lmsi 00000000
|
||||
|
||||
GET 2 subscriber.by-msisdn-103.ps-enabled
|
||||
GET_REPLY 2 subscriber.by-msisdn-103.ps-enabled 1
|
||||
|
||||
SET 3 subscriber.by-msisdn-103.ps-enabled 0
|
||||
SET_REPLY 3 subscriber.by-msisdn-103.ps-enabled OK
|
||||
|
||||
GET 4 subscriber.by-msisdn-103.ps-enabled
|
||||
GET_REPLY 4 subscriber.by-msisdn-103.ps-enabled 0
|
||||
|
||||
GET 5 subscriber.by-msisdn-103.info
|
||||
GET_REPLY 5 subscriber.by-msisdn-103.info
|
||||
id 3
|
||||
imsi 901990000000003
|
||||
msisdn 103
|
||||
nam_cs 1
|
||||
nam_ps 0
|
||||
ms_purged_cs 0
|
||||
ms_purged_ps 0
|
||||
periodic_lu_timer 0
|
||||
periodic_rau_tau_timer 0
|
||||
lmsi 00000000
|
||||
|
||||
SET 6 subscriber.by-msisdn-103.cs-enabled 0
|
||||
SET_REPLY 6 subscriber.by-msisdn-103.cs-enabled OK
|
||||
|
||||
GET 7 subscriber.by-msisdn-103.cs-enabled
|
||||
GET_REPLY 7 subscriber.by-msisdn-103.cs-enabled 0
|
||||
|
||||
GET 8 subscriber.by-msisdn-103.info
|
||||
GET_REPLY 8 subscriber.by-msisdn-103.info
|
||||
id 3
|
||||
imsi 901990000000003
|
||||
msisdn 103
|
||||
nam_cs 0
|
||||
nam_ps 0
|
||||
ms_purged_cs 0
|
||||
ms_purged_ps 0
|
||||
periodic_lu_timer 0
|
||||
periodic_rau_tau_timer 0
|
||||
lmsi 00000000
|
||||
|
||||
SET 9 subscriber.by-msisdn-103.cs-enabled 1
|
||||
SET_REPLY 9 subscriber.by-msisdn-103.cs-enabled OK
|
||||
SET 10 subscriber.by-msisdn-103.ps-enabled 1
|
||||
SET_REPLY 10 subscriber.by-msisdn-103.ps-enabled OK
|
||||
|
||||
GET 11 subscriber.by-msisdn-103.info
|
||||
GET_REPLY 11 subscriber.by-msisdn-103.info
|
||||
id 3
|
||||
imsi 901990000000003
|
||||
msisdn 103
|
||||
nam_cs 1
|
||||
nam_ps 1
|
||||
ms_purged_cs 0
|
||||
ms_purged_ps 0
|
||||
periodic_lu_timer 0
|
||||
periodic_rau_tau_timer 0
|
||||
lmsi 00000000
|
||||
@@ -1,42 +0,0 @@
|
||||
GET 1 subscriber.by-imsi-901990000000003.info
|
||||
GET_REPLY 1 subscriber.by-imsi-901990000000003.info
|
||||
id 3
|
||||
imsi 901990000000003
|
||||
msisdn 103
|
||||
nam_cs 1
|
||||
nam_ps 1
|
||||
ms_purged_cs 0
|
||||
ms_purged_ps 0
|
||||
periodic_lu_timer 0
|
||||
periodic_rau_tau_timer 0
|
||||
lmsi 00000000
|
||||
|
||||
GET 2 subscriber.by-msisdn-103.info-aud
|
||||
GET_REPLY 2 subscriber.by-msisdn-103.info-aud
|
||||
aud2g.algo COMP128v1
|
||||
aud2g.ki 000102030405060708090a0b0c0d0e0f
|
||||
aud3g.algo MILENAGE
|
||||
aud3g.k 000102030405060708090a0b0c0d0e0f
|
||||
aud3g.opc 101112131415161718191a1b1c1d1e1f
|
||||
aud3g.ind_bitlen 5
|
||||
aud3g.sqn 0
|
||||
|
||||
GET 3 subscriber.by-id-3.info-all
|
||||
GET_REPLY 3 subscriber.by-id-3.info-all
|
||||
id 3
|
||||
imsi 901990000000003
|
||||
msisdn 103
|
||||
nam_cs 1
|
||||
nam_ps 1
|
||||
ms_purged_cs 0
|
||||
ms_purged_ps 0
|
||||
periodic_lu_timer 0
|
||||
periodic_rau_tau_timer 0
|
||||
lmsi 00000000
|
||||
aud2g.algo COMP128v1
|
||||
aud2g.ki 000102030405060708090a0b0c0d0e0f
|
||||
aud3g.algo MILENAGE
|
||||
aud3g.k 000102030405060708090a0b0c0d0e0f
|
||||
aud3g.opc 101112131415161718191a1b1c1d1e1f
|
||||
aud3g.ind_bitlen 5
|
||||
aud3g.sqn 0
|
||||
@@ -1,47 +0,0 @@
|
||||
<revhistory>
|
||||
<revision>
|
||||
<revnumber>1</revnumber>
|
||||
<date>September 18th, 2017</date>
|
||||
<authorinitials>NH</authorinitials>
|
||||
<revremark>
|
||||
Initial version; based on OsmoNITB manual version 2.
|
||||
</revremark>
|
||||
</revision>
|
||||
</revhistory>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<firstname>Neels</firstname>
|
||||
<surname>Hofmeyr</surname>
|
||||
<email>nhofmeyr@sysmocom.de</email>
|
||||
<authorinitials>NH</authorinitials>
|
||||
<affiliation>
|
||||
<shortaffil>sysmocom</shortaffil>
|
||||
<orgname>sysmocom - s.f.m.c. GmbH</orgname>
|
||||
<jobtitle>Senior Developer</jobtitle>
|
||||
</affiliation>
|
||||
</author>
|
||||
</authorgroup>
|
||||
|
||||
<copyright>
|
||||
<year>2017</year>
|
||||
<holder>sysmocom - s.f.m.c. GmbH</holder>
|
||||
</copyright>
|
||||
|
||||
<legalnotice>
|
||||
<para>
|
||||
Permission is granted to copy, distribute and/or modify this
|
||||
document under the terms of the GNU Free Documentation License,
|
||||
Version 1.3 or any later version published by the Free Software
|
||||
Foundation; with the Invariant Sections being just 'Foreword',
|
||||
'Acknowledgements' and 'Preface', with no Front-Cover Texts,
|
||||
and no Back-Cover Texts. A copy of the license is included in
|
||||
the section entitled "GNU Free Documentation License".
|
||||
</para>
|
||||
<para>
|
||||
The Asciidoc source code of this manual can be found at
|
||||
<ulink url="http://git.osmocom.org/osmo-gsm-manuals/">
|
||||
http://git.osmocom.org/osmo-gsm-manuals/
|
||||
</ulink>
|
||||
</para>
|
||||
</legalnotice>
|
||||
@@ -1,40 +0,0 @@
|
||||
:gfdl-enabled:
|
||||
:program-name: OsmoHLR
|
||||
|
||||
OsmoHLR User Manual
|
||||
====================
|
||||
Neels Hofmeyr <nhofmeyr@sysmocom.de>
|
||||
|
||||
|
||||
include::./common/chapters/preface.adoc[]
|
||||
|
||||
include::{srcdir}/chapters/overview.adoc[]
|
||||
|
||||
include::{srcdir}/chapters/running.adoc[]
|
||||
|
||||
include::{srcdir}/chapters/subscribers.adoc[]
|
||||
|
||||
include::{srcdir}/chapters/ussd.adoc[]
|
||||
|
||||
include::./common/chapters/vty.adoc[]
|
||||
|
||||
include::./common/chapters/logging.adoc[]
|
||||
|
||||
include::{srcdir}/chapters/control.adoc[]
|
||||
|
||||
include::./common/chapters/control_if.adoc[]
|
||||
|
||||
include::{srcdir}/chapters/dgsm.adoc[]
|
||||
|
||||
include::{srcdir}/chapters/proxy_cache.adoc[]
|
||||
|
||||
include::./common/chapters/gsup.adoc[]
|
||||
|
||||
include::./common/chapters/port_numbers.adoc[]
|
||||
|
||||
include::./common/chapters/bibliography.adoc[]
|
||||
|
||||
include::./common/chapters/glossary.adoc[]
|
||||
|
||||
include::./common/chapters/gfdl.adoc[]
|
||||
|
||||
@@ -1,38 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
ex:ts=2:sw=42sts=2:et
|
||||
-*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
|
||||
-->
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML 5.0//EN"
|
||||
"http://docbook.org/xml/5.0/dtd/docbook.dtd" [
|
||||
<!ENTITY chapter-vty SYSTEM "./common/chapters/vty.xml" >
|
||||
<!ENTITY sections-vty SYSTEM "generated/docbook_vty.xml" >
|
||||
]>
|
||||
|
||||
<book>
|
||||
<info>
|
||||
<revhistory>
|
||||
<revision>
|
||||
<revnumber>v1</revnumber>
|
||||
<date>18th September 2017</date>
|
||||
<authorinitials>nh</authorinitials>
|
||||
<revremark>Initial</revremark>
|
||||
</revision>
|
||||
</revhistory>
|
||||
|
||||
<title>OsmoHLR VTY Reference</title>
|
||||
|
||||
<copyright>
|
||||
<year>2017</year>
|
||||
</copyright>
|
||||
|
||||
<legalnotice>
|
||||
<para>This work is copyright by <orgname>sysmocom - s.f.m.c. GmbH</orgname>. All rights reserved.
|
||||
</para>
|
||||
</legalnotice>
|
||||
</info>
|
||||
|
||||
<!-- Main chapters-->
|
||||
&chapter-vty;
|
||||
</book>
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
#!/bin/sh -x
|
||||
|
||||
if [ -z "$DOCKER_PLAYGROUND" ]; then
|
||||
echo "You need to set DOCKER_PLAYGROUND"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
SCRIPT=$(realpath "$0")
|
||||
MANUAL_DIR=$(dirname "$SCRIPT")
|
||||
|
||||
COMMIT=${COMMIT:-$(git log -1 --format=format:%H)}
|
||||
|
||||
cd "$DOCKER_PLAYGROUND/scripts" || exit 1
|
||||
|
||||
OSMO_HLR_BRANCH=$COMMIT ./regen_doc.sh osmo-hlr 4258 \
|
||||
"$MANUAL_DIR/chapters/counters_generated.adoc" \
|
||||
"$MANUAL_DIR/vty/hlr_vty_reference.xml"
|
||||
@@ -1,2 +0,0 @@
|
||||
<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
|
||||
</vtydoc>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,39 +0,0 @@
|
||||
all:
|
||||
echo "built only on manual invocation, needs mscgen and dot (graphviz) programs: invoke 'make charts'"
|
||||
|
||||
charts: msc dot
|
||||
|
||||
EXTRA_DIST = \
|
||||
proxy_cache.dot \
|
||||
proxy_cache__mm_fsm.dot \
|
||||
proxy_cache__to_home_hlr_fsm.dot \
|
||||
$(NULL)
|
||||
|
||||
CLEANFILES = \
|
||||
proxy_cache.png \
|
||||
proxy_cache__mm_fsm.png \
|
||||
proxy_cache__to_home_hlr_fsm.png \
|
||||
$(NULL)
|
||||
|
||||
msc: \
|
||||
$(NULL)
|
||||
|
||||
dot: \
|
||||
$(builddir)/proxy_cache.png \
|
||||
$(builddir)/proxy_cache__mm_fsm.png \
|
||||
$(builddir)/proxy_cache__to_home_hlr_fsm.png \
|
||||
$(NULL)
|
||||
|
||||
$(builddir)/%.png: %.msc
|
||||
mscgen -T png -o $@ $<
|
||||
|
||||
$(builddir)/%.msc: $(srcdir)/%.ladder
|
||||
@which ladder_to_msc.py || (echo 'PLEASE POINT YOUR $$PATH AT libosmocore/contrib/ladder_to_msc.py' && false)
|
||||
ladder_to_msc.py -i $< -o $@
|
||||
|
||||
$(builddir)/%.png: $(srcdir)/%.dot
|
||||
dot -Tpng $< > $@
|
||||
|
||||
.PHONY: poll
|
||||
poll:
|
||||
while true; do $(MAKE) msc dot; sleep 1; done
|
||||
@@ -1,19 +0,0 @@
|
||||
digraph G {
|
||||
rankdir=LR
|
||||
labelloc=t;
|
||||
|
||||
msc [label="MS/BSS/MSC"]
|
||||
subgraph cluster_proxy {
|
||||
label="HLR Proxy"
|
||||
proxy_mm [label="Proxy Mobility Management FSM",shape=box3d]
|
||||
proxy_home [label="Proxy to Home HLR FSM",shape=box3d]
|
||||
proxy [label="GSUP Proxy"]
|
||||
proxy_mm -> proxy_home [constraint=false,dir=both,label="(FSM events)"]
|
||||
}
|
||||
hlr [label="Home HLR"]
|
||||
|
||||
msc -> proxy_mm [dir=both,label="MM related GSUP\n (immediate response\n if possible)"]
|
||||
proxy_home -> hlr [dir=both,label="MM related GSUP\n (delayed)"]
|
||||
|
||||
msc -> proxy -> hlr [dir=both,label="non-MM GSUP",style=dashed]
|
||||
}
|
||||
@@ -1,78 +0,0 @@
|
||||
digraph G {
|
||||
rankdir=TB
|
||||
labelloc=t; label="HLR Proxy MM FSM"
|
||||
|
||||
top,top2,top3[shape=invtriangle,label="(1)"]
|
||||
|
||||
top -> READY
|
||||
|
||||
new [label="proxy_cache_subscr_new()\n/ proxy_cache_subscr_from_db()",shape=box]
|
||||
READY [style=bold]
|
||||
HIBERNATE [shape=note,label="Hibernate\n (keep in DB)"]
|
||||
CLEAR [shape=box,label="Clear DB entry\n (discard completely)"]
|
||||
WAIT_AUTH_TUPLES [style=bold]
|
||||
WAIT_SUBSCR_DATA [style=bold]
|
||||
WAIT_GSUP_ISD_RESULT [style=bold]
|
||||
|
||||
home_fsm [label="Proxy to Home HLR FSM",shape=box3d]
|
||||
{rank=same;READY,home_fsm}
|
||||
|
||||
|
||||
new -> {READY,home_fsm}
|
||||
|
||||
READY -> {event_lu_req,event_auth_info_req} [arrowhead=none]
|
||||
|
||||
event_auth_info_req [shape=rarrow,label="Rx GSUP\nSend Auth Info Request\nfrom MSC"]
|
||||
event_auth_info_req -> junction_send_auth_info_req
|
||||
junction_send_auth_info_req [shape=diamond,label="Unused\nauth tuples\navailable?"]
|
||||
junction_send_auth_info_req -> action_send_auth_info [label="yes"]
|
||||
junction_send_auth_info_req -> emit_need_tuples [label="no"]
|
||||
emit_need_tuples [shape=lpromoter,label="emit\n HOME_EV_CHECK_TUPLES\n to Home FSM"]
|
||||
emit_need_tuples->WAIT_AUTH_TUPLES
|
||||
WAIT_AUTH_TUPLES -> rx_ev_rx_auth_tuples [arrowhead=none]
|
||||
rx_ev_rx_auth_tuples [shape=rpromoter,label="receive\n MM_EV_RX_AUTH_TUPLES"]
|
||||
rx_ev_rx_auth_tuples -> action_send_auth_info
|
||||
action_send_auth_info [shape=larrow,label="Tx GSUP\nSend Auth Info Result\nwith fresh auth tuples\n to MSC"]
|
||||
action_send_auth_info -> emit_check_tuples
|
||||
emit_check_tuples [shape=lpromoter,label="emit\n HOME_EV_CHECK_TUPLES\n to Home FSM"]
|
||||
emit_check_tuples -> top2
|
||||
WAIT_AUTH_TUPLES -> junction_check_auth_fallback [label="Timeout",style=dashed]
|
||||
junction_check_auth_fallback -> action_do_auth_fallback [label="yes",style=dashed]
|
||||
action_do_auth_fallback [shape=larrow,label="Tx GSUP\nSend Auth Info Result\nwith recycled auth tuple\n(GSM AKA only)"]
|
||||
junction_check_auth_fallback [shape=diamond,label="Re-usable\nauth tuples\navailable?"]
|
||||
junction_check_auth_fallback -> action_fail_auth [label="no",style=dashed]
|
||||
action_fail_auth [shape=larrow,label="Tx GSUP\nSend Auth Info Error\npending re-connection to\nthe home HLR"]
|
||||
{action_do_auth_fallback,action_fail_auth} -> top2 [style=dashed]
|
||||
|
||||
event_lu_req [shape=rarrow,label="Rx GSUP\nUpdate Location Request\nfrom MSC"]
|
||||
event_lu_req -> emit_lu_req
|
||||
emit_lu_req [shape=lpromoter,label="emit\n HOME_EV_CONFIRM_LU"];
|
||||
emit_lu_req -> junction_check_subscriber_data
|
||||
junction_check_subscriber_data [shape=diamond,label="Subscriber\nData\nknown?"]
|
||||
junction_check_subscriber_data -> WAIT_SUBSCR_DATA [label=no]
|
||||
WAIT_SUBSCR_DATA -> rx_ev_subscr_data [arrowhead=none]
|
||||
rx_ev_subscr_data [shape=rpromoter,label="receive\n MM_EV_RX_SUBSCR_DATA"];
|
||||
rx_ev_subscr_data -> action_subscr_data_req
|
||||
junction_check_subscriber_data -> action_subscr_data_req [label="yes"]
|
||||
action_subscr_data_req [shape=larrow,label="Tx GSUP\n Insert Subscriber Data\n Request to MSC"]
|
||||
action_subscr_data_req -> WAIT_GSUP_ISD_RESULT
|
||||
WAIT_GSUP_ISD_RESULT -> tx_gsup_isd_res [arrowhead=none]
|
||||
tx_gsup_isd_res [shape=rarrow,label="Rx GSUP\n Insert Subscriber Data Result\nfrom MSC"]
|
||||
tx_gsup_isd_res -> top3
|
||||
|
||||
{WAIT_GSUP_ISD_RESULT,WAIT_SUBSCR_DATA} -> action_lu_reject [label="Timeout",style=dashed]
|
||||
action_lu_reject [shape=larrow,label="Tx GSUP\nUpdate Location Error\nto MSC\npending reconnect of home HLR"]
|
||||
action_lu_reject -> top3 [style=dashed]
|
||||
|
||||
READY -> HIBERNATE [label="Timeout"]
|
||||
READY -> rx_ev_subscr_invalid [arrowhead=none]
|
||||
rx_ev_subscr_invalid[shape=rpromoter,label="receive\n MM_EV_SUBSCR_INVALID"]
|
||||
rx_ev_subscr_invalid -> tx_purge_req
|
||||
tx_purge_req [shape=larrow,label="Tx GSUP\nPurge MS Request"]
|
||||
tx_purge_req -> note_purge [style=dotted]
|
||||
note_purge [shape=note,label="Don't care about\nPurge MS Result"]
|
||||
tx_purge_req -> CLEAR
|
||||
{CLEAR,HIBERNATE} -> TERM
|
||||
TERM[shape=octagon][style=bold]
|
||||
|
||||
}
|
||||
@@ -1,97 +0,0 @@
|
||||
digraph G {
|
||||
rankdir=TB
|
||||
labelloc=t; label="HLR Proxy to Home HLR FSM"
|
||||
|
||||
top,to_top1,to_top2,to_top3,to_top4,to_top5[shape=invtriangle,label="(A)"]
|
||||
top->junction_resolve_home_hlr
|
||||
|
||||
at_clear,to_clear1,to_clear2 [shape=invtriangle,label="(X)"]
|
||||
|
||||
mm_fsm [shape=box3d,label="Proxy MM FSM"]
|
||||
mm_fsm -> junction_resolve_home_hlr [style=invisible,arrowhead=none]
|
||||
|
||||
WAIT_HOME_HLR_RESOLVED [style=bold]
|
||||
WAIT_UPDATE_LOCATION_RESULT [style=bold]
|
||||
WAIT_SEND_AUTH_INFO_RESULT [style=bold]
|
||||
IDLE [style=bold]
|
||||
CLEAR [style=bold]
|
||||
|
||||
new [label="proxy_cache_subscr_new()\n/ proxy_cache_subscr_from_db()",shape=box]
|
||||
{
|
||||
rank=same;
|
||||
junction_resolve_home_hlr [shape=diamond,label="Home HLR\n known?"]
|
||||
junction_confirm_home_hlr [shape=diamond,label="mslookup\n for home HLR\n very old?"]
|
||||
junction_update_location [shape=diamond,label="Did MM FSM emit another\n HOME_EV_CONFIRM_LU?"]
|
||||
junction_auth_info [shape=diamond,label="Auth tuple\ncache full of\nfresh tuples?"]
|
||||
}
|
||||
|
||||
new -> {junction_resolve_home_hlr, mm_fsm}
|
||||
|
||||
junction_resolve_home_hlr -> junction_confirm_home_hlr [label="known"]
|
||||
junction_resolve_home_hlr -> action_mslookup [label="wat"]
|
||||
action_mslookup [shape=larrow,label="start mslookup"]
|
||||
action_mslookup -> WAIT_HOME_HLR_RESOLVED
|
||||
WAIT_HOME_HLR_RESOLVED -> rx_mslookup_res [arrowhead=none]
|
||||
rx_mslookup_res [shape=rarrow,label="home HLR\n resolved"]
|
||||
rx_mslookup_res -> to_top1
|
||||
WAIT_HOME_HLR_RESOLVED -> CLEAR [style=dashed,label=Timeout]
|
||||
|
||||
junction_update_location -> action_lu_req [label="need data\n/\nneed to confirm LU"]
|
||||
action_lu_req [shape=larrow,label="Tx GSUP Update Location Req\nto home HLR"]
|
||||
action_lu_req -> WAIT_UPDATE_LOCATION_RESULT
|
||||
WAIT_UPDATE_LOCATION_RESULT->rx_isd [arrowhead=none]
|
||||
rx_isd [shape=rarrow,label="Rx GSUP\n Insert Subscriber\n Data Request\nfrom home HLR"]
|
||||
rx_isd -> emit_rx_subscr_data
|
||||
emit_rx_subscr_data [shape=lpromoter,label="emit\n MM_EV_RX_SUBSCR_DATA"]
|
||||
emit_rx_subscr_data->action_tx_isd_res
|
||||
action_tx_isd_res -> WAIT_UPDATE_LOCATION_RESULT
|
||||
action_tx_isd_res [shape=larrow,label="Tx GSUP Insert Subscriber Data Result\nto home HLR"]
|
||||
WAIT_UPDATE_LOCATION_RESULT -> rx_lu_res [arrowhead=none]
|
||||
rx_lu_res [shape=rarrow,label="Rx GSUP Update\n Location Result\nfrom home HLR"]
|
||||
rx_lu_res -> to_top2
|
||||
junction_update_location -> junction_auth_info [label="data known,\nLU confirmed"]
|
||||
WAIT_UPDATE_LOCATION_RESULT->junction_lu_failed [label="Timeout "]
|
||||
junction_lu_failed [shape=diamond,label="has home HLR\never confirmed\na LU before?"];
|
||||
junction_lu_failed -> to_clear2 [label="never\nconfirmed",style=dashed]
|
||||
junction_lu_failed -> note_lu_failed [label="has\nconfirmed\nbefore"]
|
||||
note_lu_failed [shape=note,label="Home HLR is\ntemporarily unreachable,\n just carry on."]
|
||||
note_lu_failed -> to_top3
|
||||
|
||||
junction_confirm_home_hlr -> action_mslookup_confirm [label="very old"]
|
||||
junction_confirm_home_hlr -> junction_update_location [label="fair enough"]
|
||||
action_mslookup_confirm [shape=larrow,label="start mslookup"]
|
||||
note_mslookup_confirm [shape=note,label="Result evaluated in IDLE state.\nIf no mslookup result comes\n back, the home HLR is\ntemporarily unreachable:\ncontinue anyway.\nThis is sanity checking for\na *modified* home HLR"]
|
||||
action_mslookup_confirm -> note_mslookup_confirm [arrowhead=none,style=dotted]
|
||||
action_mslookup_confirm -> junction_update_location
|
||||
|
||||
junction_auth_info -> action_sai_req [label="need more tuples"]
|
||||
junction_auth_info -> set_idle_timeout [label="cache is fresh"]
|
||||
action_sai_req [shape=larrow,label="Tx GSUP\n Send Auth Info Request\n to home HLR"]
|
||||
action_sai_req -> WAIT_SEND_AUTH_INFO_RESULT
|
||||
WAIT_SEND_AUTH_INFO_RESULT->rx_sai_res[arrowhead=none]
|
||||
rx_sai_res[shape=rarrow,label="Rx GSUP\n Send Auth Info\n Result\nfrom home HLR"]
|
||||
rx_sai_res -> emit_rx_tuples
|
||||
emit_rx_tuples [shape=lpromoter,label="emit\n MM_EV_RX_AUTH_TUPLES"]
|
||||
emit_rx_tuples -> to_top4
|
||||
WAIT_SEND_AUTH_INFO_RESULT->set_idle_timeout[label="Timeout",style=dashed]
|
||||
set_idle_timeout [shape=diamond,label="Select IDLE\n timeout:\nmin(\nretry tuples,\n confirm mslookup)"]
|
||||
set_idle_timeout -> IDLE
|
||||
|
||||
IDLE -> rx_mslookup_confirm_res [arrowhead=none]
|
||||
rx_mslookup_confirm_res [shape=rarrow,label="Rx mslookup result"]
|
||||
rx_mslookup_confirm_res -> junction_compare_home_hlr
|
||||
junction_compare_home_hlr [shape=diamond,label="mslookup result\n matches home HLR\n on record?"]
|
||||
junction_compare_home_hlr -> set_idle_timeout [label="matches"]
|
||||
junction_compare_home_hlr -> to_clear1 [label="mismatch",style=dashed]
|
||||
|
||||
IDLE -> to_top5 [label="Timeout"]
|
||||
IDLE -> {rx_ev_check_tuples,rx_ev_confirm_lu} [arrowhead=none]
|
||||
rx_ev_check_tuples [shape=rpromoter,label="receive\n HOME_EV_CHECK_TUPLES"]
|
||||
rx_ev_confirm_lu [shape=rpromoter,label="receive\n HOME_EV_CONFIRM_LU"]
|
||||
{rx_ev_check_tuples,rx_ev_confirm_lu} -> to_top5
|
||||
|
||||
at_clear -> CLEAR
|
||||
CLEAR -> emit_subscr_invalid -> TERM
|
||||
emit_subscr_invalid [shape=lpromoter,label="emit\n MM_EV_SUBSCR_INVALID"]
|
||||
TERM[shape=octagon][style=bold]
|
||||
}
|
||||
@@ -1,13 +1,2 @@
|
||||
SUBDIRS = osmocom
|
||||
nobase_include_HEADERS = osmocom/gsupclient/gsup_client.h
|
||||
|
||||
nobase_include_HEADERS = \
|
||||
osmocom/gsupclient/gsup_peer_id.h \
|
||||
osmocom/gsupclient/gsup_client.h \
|
||||
osmocom/gsupclient/gsup_req.h \
|
||||
osmocom/mslookup/mdns.h \
|
||||
osmocom/mslookup/mdns_sock.h \
|
||||
osmocom/mslookup/mslookup_client_fake.h \
|
||||
osmocom/mslookup/mslookup_client.h \
|
||||
osmocom/mslookup/mslookup_client_mdns.h \
|
||||
osmocom/mslookup/mslookup.h \
|
||||
$(NULL)
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
SUBDIRS = \
|
||||
hlr \
|
||||
mslookup \
|
||||
$(NULL)
|
||||
@@ -6,24 +6,23 @@
|
||||
* Author: Jacob Erlbeck
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <osmocom/core/timer.h>
|
||||
#include <osmocom/gsm/oap_client.h>
|
||||
#include <osmocom/gsm/ipa.h>
|
||||
#include <osmocom/gsm/gsup.h>
|
||||
|
||||
/* a loss of GSUP between MSC and HLR is considered quite serious, let's try to recover as quickly as
|
||||
* possible. Even one new connection attempt per second should be quite acceptable until the link is
|
||||
@@ -38,10 +37,8 @@ struct osmo_gsup_client;
|
||||
/* Expects message in msg->l2h */
|
||||
typedef int (*osmo_gsup_client_read_cb_t)(struct osmo_gsup_client *gsupc, struct msgb *msg);
|
||||
|
||||
typedef bool (*osmo_gsup_client_up_down_cb_t)(struct osmo_gsup_client *gsupc, bool up);
|
||||
|
||||
struct osmo_gsup_client {
|
||||
const char *unit_name; /* same as ipa_dev->unit_name, for backwards compat */
|
||||
const char *unit_name;
|
||||
|
||||
struct ipa_client_conn *link;
|
||||
osmo_gsup_client_read_cb_t read_cb;
|
||||
@@ -53,39 +50,8 @@ struct osmo_gsup_client {
|
||||
struct osmo_timer_list connect_timer;
|
||||
int is_connected;
|
||||
int got_ipa_pong;
|
||||
|
||||
struct ipaccess_unit *ipa_dev; /* identification information sent to IPA server */
|
||||
|
||||
osmo_gsup_client_up_down_cb_t up_down_cb;
|
||||
};
|
||||
|
||||
struct osmo_gsup_client_config {
|
||||
/*! IP access unit which contains client identification information; must be allocated in talloc_ctx as well to
|
||||
* ensure it lives throughout the lifetime of the connection. */
|
||||
struct ipaccess_unit *ipa_dev;
|
||||
/*! GSUP server IP address to connect to. */
|
||||
const char *ip_addr;
|
||||
/*! GSUP server TCP port to connect to. */
|
||||
unsigned int tcp_port;
|
||||
/*! OPA client configuration, or NULL. */
|
||||
struct osmo_oap_client_config *oapc_config;
|
||||
/*! callback for reading from the GSUP connection. */
|
||||
osmo_gsup_client_read_cb_t read_cb;
|
||||
/*! Invoked when the GSUP link is ready for communication, and when the link drops. */
|
||||
osmo_gsup_client_up_down_cb_t up_down_cb;
|
||||
/*! User data stored in the returned gsupc->data, as context for the callbacks. */
|
||||
void *data;
|
||||
/*! Marker for future extension, always pass this as false. */
|
||||
bool more;
|
||||
};
|
||||
struct osmo_gsup_client *osmo_gsup_client_create3(void *talloc_ctx, struct osmo_gsup_client_config *config);
|
||||
|
||||
struct osmo_gsup_client *osmo_gsup_client_create2(void *talloc_ctx,
|
||||
struct ipaccess_unit *ipa_dev,
|
||||
const char *ip_addr,
|
||||
unsigned int tcp_port,
|
||||
osmo_gsup_client_read_cb_t read_cb,
|
||||
struct osmo_oap_client_config *oapc_config);
|
||||
struct osmo_gsup_client *osmo_gsup_client_create(void *talloc_ctx,
|
||||
const char *unit_name,
|
||||
const char *ip_addr,
|
||||
@@ -95,7 +61,5 @@ struct osmo_gsup_client *osmo_gsup_client_create(void *talloc_ctx,
|
||||
|
||||
void osmo_gsup_client_destroy(struct osmo_gsup_client *gsupc);
|
||||
int osmo_gsup_client_send(struct osmo_gsup_client *gsupc, struct msgb *msg);
|
||||
int osmo_gsup_client_enc_send(struct osmo_gsup_client *gsupc,
|
||||
const struct osmo_gsup_message *gsup_msg);
|
||||
struct msgb *osmo_gsup_client_msgb_alloc(void);
|
||||
|
||||
|
||||
@@ -1,66 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <unistd.h>
|
||||
#include <stdint.h>
|
||||
#include <osmocom/core/utils.h>
|
||||
|
||||
/*! IPA Name: Arbitrary length blob, not necessarily zero-terminated.
|
||||
* In osmo-hlr, struct hlr_subscriber is mostly used as static reference and cannot serve as talloc context, which is
|
||||
* why this is also implemented as a fixed-maximum-size buffer instead of a talloc'd arbitrary sized buffer.
|
||||
* NOTE: The length of val may be extended in the future if it becomes necessary.
|
||||
* At the time of writing, this holds IPA unit name strings of very limited length.
|
||||
*/
|
||||
struct osmo_ipa_name {
|
||||
size_t len;
|
||||
uint8_t val[128];
|
||||
};
|
||||
|
||||
bool osmo_ipa_name_is_empty(struct osmo_ipa_name *ipa_name);
|
||||
int osmo_ipa_name_set(struct osmo_ipa_name *ipa_name, const uint8_t *val, size_t len);
|
||||
int osmo_ipa_name_set_str(struct osmo_ipa_name *ipa_name, const char *str_fmt, ...);
|
||||
int osmo_ipa_name_cmp(const struct osmo_ipa_name *a, const struct osmo_ipa_name *b);
|
||||
const char *osmo_ipa_name_to_str_c(void *ctx, const struct osmo_ipa_name *ipa_name);
|
||||
const char *osmo_ipa_name_to_str(const struct osmo_ipa_name *ipa_name);
|
||||
|
||||
enum osmo_gsup_peer_id_type {
|
||||
OSMO_GSUP_PEER_ID_EMPTY=0,
|
||||
OSMO_GSUP_PEER_ID_IPA_NAME,
|
||||
/* OSMO_GSUP_PEER_ID_GLOBAL_TITLE, <-- currently not implemented, but likely future possibility */
|
||||
};
|
||||
|
||||
extern const struct value_string osmo_gsup_peer_id_type_names[];
|
||||
static inline const char *osmo_gsup_peer_id_type_name(enum osmo_gsup_peer_id_type val)
|
||||
{ return get_value_string(osmo_gsup_peer_id_type_names, val); }
|
||||
|
||||
struct osmo_gsup_peer_id {
|
||||
enum osmo_gsup_peer_id_type type;
|
||||
union {
|
||||
struct osmo_ipa_name ipa_name;
|
||||
};
|
||||
};
|
||||
|
||||
bool osmo_gsup_peer_id_is_empty(struct osmo_gsup_peer_id *gsup_peer_id);
|
||||
int osmo_gsup_peer_id_set(struct osmo_gsup_peer_id *gsup_peer_id, enum osmo_gsup_peer_id_type type,
|
||||
const uint8_t *val, size_t len);
|
||||
int osmo_gsup_peer_id_set_str(struct osmo_gsup_peer_id *gsup_peer_id, enum osmo_gsup_peer_id_type type,
|
||||
const char *str_fmt, ...);
|
||||
int osmo_gsup_peer_id_cmp(const struct osmo_gsup_peer_id *a, const struct osmo_gsup_peer_id *b);
|
||||
const char *osmo_gsup_peer_id_to_str(const struct osmo_gsup_peer_id *gsup_peer_id);
|
||||
const char *osmo_gsup_peer_id_to_str_c(void *ctx, const struct osmo_gsup_peer_id *gsup_peer_id);
|
||||
@@ -1,115 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <osmocom/gsm/gsup.h>
|
||||
#include <osmocom/gsupclient/gsup_peer_id.h>
|
||||
|
||||
struct osmo_gsup_req;
|
||||
|
||||
#define LOG_GSUP_REQ_CAT_SRC(req, subsys, level, file, line, fmt, args...) \
|
||||
LOGPSRC(subsys, level, file, line, "GSUP %u: %s: IMSI-%s %s: " fmt, \
|
||||
(req) ? (req)->nr : 0, \
|
||||
(req) ? osmo_gsup_peer_id_to_str(&(req)->source_name) : "NULL", \
|
||||
(req) ? (req)->gsup.imsi : "NULL", \
|
||||
(req) ? osmo_gsup_message_type_name((req)->gsup.message_type) : "NULL", \
|
||||
##args)
|
||||
#define LOG_GSUP_REQ_CAT(req, subsys, level, fmt, args...) \
|
||||
LOG_GSUP_REQ_CAT_SRC(req, subsys, level, __FILE__, __LINE__, fmt, ##args)
|
||||
|
||||
#define LOG_GSUP_REQ_SRC(req, level, file, line, fmt, args...) \
|
||||
LOG_GSUP_REQ_CAT_SRC(req, DLGSUP, level, file, line, fmt, ##args)
|
||||
|
||||
#define LOG_GSUP_REQ(req, level, fmt, args...) \
|
||||
LOG_GSUP_REQ_SRC(req, level, __FILE__, __LINE__, fmt, ##args)
|
||||
|
||||
typedef void (*osmo_gsup_req_send_response_t)(struct osmo_gsup_req *req, struct osmo_gsup_message *response);
|
||||
|
||||
/* Keep track of an incoming request, to route back a response when it is ready.
|
||||
* Particularly, a GSUP response to a request must contain various bits of information that need to be copied from the
|
||||
* request for proxy/routing to work and for session states to remain valid. That is the main reason why (almost) all
|
||||
* GSUP request/response should go through an osmo_gsup_req, even if it is handled synchronously.
|
||||
*/
|
||||
struct osmo_gsup_req {
|
||||
/* The incoming GSUP message in decoded form. */
|
||||
const struct osmo_gsup_message gsup;
|
||||
|
||||
/* Decoding result code. If decoding failed, this will be != 0. */
|
||||
int decode_rc;
|
||||
|
||||
/* The ultimate source of this message: the source_name form the GSUP message, or, if not present, then the
|
||||
* immediate GSUP peer. GSUP messages going via a proxy reflect the initial source in the source_name.
|
||||
* This source_name is implicitly added to the routes for the conn the message was received on. */
|
||||
struct osmo_gsup_peer_id source_name;
|
||||
|
||||
/* If the source_name is not an immediate GSUP peer, this is set to the closest intermediate peer between here
|
||||
* and source_name. */
|
||||
struct osmo_gsup_peer_id via_proxy;
|
||||
|
||||
/* Identify this request by number, for logging. */
|
||||
unsigned int nr;
|
||||
|
||||
/* osmo_gsup_req can be used by both gsup_server and gsup_client. The individual method of actually sending a
|
||||
* GSUP message is provided by this callback. */
|
||||
osmo_gsup_req_send_response_t send_response_cb;
|
||||
|
||||
/* User supplied data pointer, may be used to provide context to send_response_cb(). */
|
||||
void *cb_data;
|
||||
|
||||
/* List entry that can be used to keep a list of osmo_gsup_req instances; not used directly by osmo_gsup_req.c,
|
||||
* it is up to using implementations to keep a list. If this is non-NULL, osmo_gsup_req_free() calls
|
||||
* llist_del() on this. */
|
||||
struct llist_head entry;
|
||||
|
||||
/* A decoded GSUP message still points into the received msgb. For a decoded osmo_gsup_message to remain valid,
|
||||
* we also need to keep the msgb. */
|
||||
struct msgb *msg;
|
||||
};
|
||||
|
||||
struct osmo_gsup_req *osmo_gsup_req_new(void *ctx, const struct osmo_gsup_peer_id *from_peer, struct msgb *msg,
|
||||
osmo_gsup_req_send_response_t send_response_cb, void *cb_data,
|
||||
struct llist_head *add_to_list);
|
||||
void osmo_gsup_req_free(struct osmo_gsup_req *req);
|
||||
|
||||
/*! Call _osmo_gsup_req_respond() to convey the sender's source file and line in the logs. */
|
||||
#define osmo_gsup_req_respond(REQ, RESPONSE, ERROR, FINAL_RESPONSE) \
|
||||
_osmo_gsup_req_respond(REQ, RESPONSE, ERROR, FINAL_RESPONSE, __FILE__, __LINE__)
|
||||
int _osmo_gsup_req_respond(struct osmo_gsup_req *req, struct osmo_gsup_message *response,
|
||||
bool error, bool final_response, const char *file, int line);
|
||||
|
||||
/*! Call _osmo_gsup_req_respond_msgt() to convey the sender's source file and line in the logs. */
|
||||
#define osmo_gsup_req_respond_msgt(REQ, MESSAGE_TYPE, FINAL_RESPONSE) \
|
||||
_osmo_gsup_req_respond_msgt(REQ, MESSAGE_TYPE, FINAL_RESPONSE, __FILE__, __LINE__)
|
||||
int _osmo_gsup_req_respond_msgt(struct osmo_gsup_req *req, enum osmo_gsup_message_type message_type,
|
||||
bool final_response, const char *file, int line);
|
||||
|
||||
/*! Log an error message, and call _osmo_gsup_req_respond() to convey the sender's source file and line in the logs. */
|
||||
#define osmo_gsup_req_respond_err(REQ, CAUSE, FMT, args...) do { \
|
||||
LOG_GSUP_REQ(REQ, LOGL_ERROR, "%s: " FMT "\n", \
|
||||
get_value_string(gsm48_gmm_cause_names, CAUSE), ##args); \
|
||||
_osmo_gsup_req_respond_err(REQ, CAUSE, __FILE__, __LINE__); \
|
||||
} while(0)
|
||||
void _osmo_gsup_req_respond_err(struct osmo_gsup_req *req, enum gsm48_gmm_cause cause,
|
||||
const char *file, int line);
|
||||
|
||||
int osmo_gsup_make_response(struct osmo_gsup_message *reply,
|
||||
const struct osmo_gsup_message *rx, bool error, bool final_response);
|
||||
|
||||
size_t osmo_gsup_message_to_str_buf(char *buf, size_t bufsize, const struct osmo_gsup_message *msg);
|
||||
char *osmo_gsup_message_to_str_c(void *ctx, const struct osmo_gsup_message *msg);
|
||||
@@ -1,22 +0,0 @@
|
||||
noinst_HEADERS = \
|
||||
auc.h \
|
||||
ctrl.h \
|
||||
db.h \
|
||||
dgsm.h \
|
||||
gsup_router.h \
|
||||
gsup_server.h \
|
||||
hlr.h \
|
||||
hlr_ussd.h \
|
||||
hlr_vty.h \
|
||||
hlr_vty_subscr.h \
|
||||
logging.h \
|
||||
lu_fsm.h \
|
||||
mslookup_server.h \
|
||||
mslookup_server_mdns.h \
|
||||
proxy.h \
|
||||
proxy_mm.h \
|
||||
proxy_db.h \
|
||||
rand.h \
|
||||
remote_hlr.h \
|
||||
timestamp.h \
|
||||
$(NULL)
|
||||
@@ -1,33 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <stdint.h>
|
||||
#include <osmocom/hlr/gsup_server.h>
|
||||
|
||||
struct osmo_ipa_name;
|
||||
|
||||
struct gsup_route {
|
||||
struct llist_head list;
|
||||
|
||||
uint8_t *addr;
|
||||
struct osmo_gsup_conn *conn;
|
||||
};
|
||||
|
||||
struct osmo_gsup_conn *gsup_route_find(struct osmo_gsup_server *gs,
|
||||
const uint8_t *addr, size_t addrlen);
|
||||
struct osmo_gsup_conn *gsup_route_find_by_ipa_name(struct osmo_gsup_server *gs, const struct osmo_ipa_name *ipa_name);
|
||||
|
||||
struct gsup_route *gsup_route_find_by_conn(const struct osmo_gsup_conn *conn);
|
||||
|
||||
/* add a new route for the given address to the given conn */
|
||||
int gsup_route_add_ipa_name(struct osmo_gsup_conn *conn, const struct osmo_ipa_name *ipa_name);
|
||||
int gsup_route_add(struct osmo_gsup_conn *conn, const uint8_t *addr, size_t addrlen);
|
||||
|
||||
/* delete all routes for the given connection */
|
||||
int gsup_route_del_conn(struct osmo_gsup_conn *conn);
|
||||
|
||||
int osmo_gsup_addr_send(struct osmo_gsup_server *gs,
|
||||
const uint8_t *addr, size_t addrlen,
|
||||
struct msgb *msg);
|
||||
int osmo_gsup_send_to_ipa_name(struct osmo_gsup_server *gs, const struct osmo_ipa_name *ipa_name, struct msgb *msg);
|
||||
int osmo_gsup_enc_send_to_ipa_name(struct osmo_gsup_server *gs, const struct osmo_ipa_name *ipa_name,
|
||||
const struct osmo_gsup_message *gsup);
|
||||
@@ -1,121 +0,0 @@
|
||||
/* OsmoHLR generic header */
|
||||
|
||||
/* (C) 2017 sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
* All Rights Reserved
|
||||
*
|
||||
* Author: Max Suraev <msuraev@sysmocom.de>
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <osmocom/core/linuxlist.h>
|
||||
#include <osmocom/gsm/ipa.h>
|
||||
#include <osmocom/core/tdef.h>
|
||||
#include <osmocom/core/sockaddr_str.h>
|
||||
|
||||
#include <osmocom/hlr/dgsm.h>
|
||||
|
||||
#define HLR_DEFAULT_DB_FILE_PATH "hlr.db"
|
||||
|
||||
struct hlr_euse;
|
||||
struct osmo_gsup_conn;
|
||||
enum osmo_gsup_message_type;
|
||||
|
||||
extern struct osmo_tdef g_hlr_tdefs[];
|
||||
|
||||
struct hlr {
|
||||
/* GSUP server pointer */
|
||||
struct osmo_gsup_server *gs;
|
||||
|
||||
/* DB context */
|
||||
char *db_file_path;
|
||||
struct db_context *dbc;
|
||||
|
||||
/* Control Interface */
|
||||
struct ctrl_handle *ctrl;
|
||||
const char *ctrl_bind_addr;
|
||||
|
||||
/* Local bind addr */
|
||||
char *gsup_bind_addr;
|
||||
struct ipaccess_unit gsup_unit_name;
|
||||
|
||||
struct llist_head euse_list;
|
||||
struct hlr_euse *euse_default;
|
||||
|
||||
/* NCSS (call independent) session guard timeout value */
|
||||
int ncss_guard_timeout;
|
||||
|
||||
struct llist_head ussd_routes;
|
||||
|
||||
struct llist_head ss_sessions;
|
||||
|
||||
bool store_imei;
|
||||
|
||||
bool subscr_create_on_demand;
|
||||
/* Bitmask of DB_SUBSCR_FLAG_* */
|
||||
uint8_t subscr_create_on_demand_flags;
|
||||
unsigned int subscr_create_on_demand_rand_msisdn_len;
|
||||
|
||||
struct {
|
||||
bool allow_startup;
|
||||
struct {
|
||||
/* Whether the mslookup server should be active in general (all lookup methods) */
|
||||
bool enable;
|
||||
uint32_t local_attach_max_age;
|
||||
struct llist_head local_site_services;
|
||||
struct {
|
||||
/* Whether the mDNS method of the mslookup server should be active. */
|
||||
bool enable;
|
||||
/* The mDNS bind address and domain suffix as set by the VTY, not necessarily in use. */
|
||||
struct osmo_sockaddr_str bind_addr;
|
||||
char *domain_suffix;
|
||||
struct osmo_mslookup_server_mdns *running;
|
||||
} mdns;
|
||||
} server;
|
||||
|
||||
/* The mslookup client in osmo-hlr is used to find out which remote HLRs service a locally unknown IMSI.
|
||||
* (It may also be used to resolve recipients for SMS-over-GSUP in the future.) */
|
||||
struct {
|
||||
/* Whether to proxy/forward to remote HLRs */
|
||||
bool enable;
|
||||
|
||||
/* If this is set, all GSUP for unknown IMSIs is forwarded directly to this GSUP address,
|
||||
* unconditionally. */
|
||||
struct osmo_sockaddr_str gsup_gateway_proxy;
|
||||
|
||||
/* mslookup client request handling */
|
||||
unsigned int result_timeout_milliseconds;
|
||||
|
||||
struct osmo_mslookup_client *client;
|
||||
struct {
|
||||
/* Whether to use mDNS for IMSI MS Lookup */
|
||||
bool enable;
|
||||
struct osmo_sockaddr_str query_addr;
|
||||
char *domain_suffix;
|
||||
struct osmo_mslookup_client_method *running;
|
||||
} mdns;
|
||||
} client;
|
||||
} mslookup;
|
||||
};
|
||||
|
||||
extern struct hlr *g_hlr;
|
||||
|
||||
struct hlr_subscriber;
|
||||
|
||||
void osmo_hlr_subscriber_update_notify(struct hlr_subscriber *subscr);
|
||||
int hlr_subscr_nam(struct hlr *hlr, struct hlr_subscriber *subscr, bool nam_val, bool is_ps);
|
||||
@@ -1,22 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
void lu_rx_gsup(struct osmo_gsup_req *req);
|
||||
@@ -1,72 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <osmocom/gsupclient/gsup_peer_id.h>
|
||||
#include <osmocom/mslookup/mslookup.h>
|
||||
|
||||
struct osmo_mslookup_query;
|
||||
struct osmo_mslookup_result;
|
||||
|
||||
/*! mslookup service name used for roaming/proxying between osmo-hlr instances. */
|
||||
#define OSMO_MSLOOKUP_SERVICE_HLR_GSUP "gsup.hlr"
|
||||
|
||||
/*! What addresses to return to mslookup queries when a subscriber is attached at the local site.
|
||||
* Mapping of service name to IP address and port. This corresponds to the VTY config for
|
||||
* 'mslookup' / 'server' [/ 'msc MSC-1-2-3'] / 'service sip.voice at 1.2.3.4 1234'.
|
||||
*/
|
||||
struct mslookup_service_host {
|
||||
struct llist_head entry;
|
||||
char service[OSMO_MSLOOKUP_SERVICE_MAXLEN+1];
|
||||
struct osmo_sockaddr_str host_v4;
|
||||
struct osmo_sockaddr_str host_v6;
|
||||
};
|
||||
|
||||
/*! Sets of mslookup_service_host per connected MSC.
|
||||
* When there are more than one MSC connected to this osmo-hlr, this allows keeping separate sets of service addresses
|
||||
* for each MSC. The entry with mslookup_server_msc_wildcard as MSC name is used for all MSCs (if no match for that
|
||||
* particular MSC is found). This corresponds to the VTY config for
|
||||
* 'mslookup' / 'server' / 'msc MSC-1-2-3'.
|
||||
*/
|
||||
struct mslookup_server_msc_cfg {
|
||||
struct llist_head entry;
|
||||
struct osmo_ipa_name name;
|
||||
struct llist_head service_hosts;
|
||||
};
|
||||
|
||||
struct mslookup_service_host *mslookup_server_service_get(const struct osmo_ipa_name *msc_name, const char *service);
|
||||
|
||||
struct mslookup_service_host *mslookup_server_msc_service_get(struct mslookup_server_msc_cfg *msc, const char *service,
|
||||
bool create);
|
||||
int mslookup_server_msc_service_set(struct mslookup_server_msc_cfg *msc, const char *service,
|
||||
const struct osmo_sockaddr_str *addr);
|
||||
int mslookup_server_msc_service_del(struct mslookup_server_msc_cfg *msc, const char *service,
|
||||
const struct osmo_sockaddr_str *addr);
|
||||
|
||||
extern const struct osmo_ipa_name mslookup_server_msc_wildcard;
|
||||
struct mslookup_server_msc_cfg *mslookup_server_msc_get(const struct osmo_ipa_name *msc_name, bool create);
|
||||
|
||||
const struct mslookup_service_host *mslookup_server_get_local_gsup_addr();
|
||||
void mslookup_server_rx(const struct osmo_mslookup_query *query,
|
||||
struct osmo_mslookup_result *result);
|
||||
|
||||
bool subscriber_has_done_lu_here(const struct osmo_mslookup_query *query,
|
||||
uint32_t *lu_age_p, struct osmo_ipa_name *local_msc_name,
|
||||
char *ret_imsi, size_t ret_imsi_len);
|
||||
@@ -1,36 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <osmocom/core/sockaddr_str.h>
|
||||
#include <osmocom/mslookup/mdns_sock.h>
|
||||
|
||||
struct osmo_mslookup_server_mdns {
|
||||
struct osmo_mslookup_server *mslookup;
|
||||
struct osmo_sockaddr_str bind_addr;
|
||||
char *domain_suffix;
|
||||
struct osmo_mdns_sock *sock;
|
||||
};
|
||||
|
||||
struct osmo_mslookup_server_mdns *osmo_mslookup_server_mdns_start(void *ctx, const struct osmo_sockaddr_str *bind_addr,
|
||||
const char *domain_suffix);
|
||||
void osmo_mslookup_server_mdns_stop(struct osmo_mslookup_server_mdns *server);
|
||||
void mslookup_server_mdns_config_apply();
|
||||
@@ -1,100 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <time.h>
|
||||
#include <osmocom/core/sockaddr_str.h>
|
||||
#include <osmocom/core/linuxlist.h>
|
||||
#include <osmocom/core/timer.h>
|
||||
#include <osmocom/gsm/protocol/gsm_23_003.h>
|
||||
#include <osmocom/gsm/gsup.h>
|
||||
#include <osmocom/gsupclient/gsup_peer_id.h>
|
||||
#include <osmocom/hlr/timestamp.h>
|
||||
|
||||
struct osmo_gsup_req;
|
||||
struct remote_hlr;
|
||||
|
||||
struct proxy {
|
||||
struct llist_head subscr_list;
|
||||
struct llist_head pending_gsup_reqs;
|
||||
|
||||
/* When messages arrive back from a remote HLR that this is the proxy for, reach the VLR to forward the response
|
||||
* to via this osmo_gsup_server. */
|
||||
struct osmo_gsup_server *gsup_server_to_vlr;
|
||||
|
||||
/* How long to keep proxy entries without a refresh, in seconds. */
|
||||
uint32_t fresh_time;
|
||||
|
||||
/* How often to garbage collect the proxy cache, period in seconds.
|
||||
* To change this and take effect immediately, rather use proxy_set_gc_period(). */
|
||||
uint32_t gc_period;
|
||||
|
||||
struct osmo_timer_list gc_timer;
|
||||
};
|
||||
|
||||
struct proxy_subscr_domain_state {
|
||||
struct osmo_ipa_name vlr_name;
|
||||
timestamp_t last_lu;
|
||||
|
||||
/* The name from which an Update Location Request was received. Copied to vlr_name as soon as the LU is
|
||||
* completed successfully. */
|
||||
struct osmo_ipa_name vlr_name_preliminary;
|
||||
|
||||
/* Set if this is a middle proxy, i.e. a proxy behind another proxy.
|
||||
* That is mostly to know whether the MS is attached at a local MSC/SGSN or further away.
|
||||
* It could be a boolean, but store the full name for logging. Set only at successful LU acceptance. */
|
||||
struct osmo_ipa_name vlr_via_proxy;
|
||||
};
|
||||
|
||||
struct proxy_subscr {
|
||||
char imsi[GSM23003_IMSI_MAX_DIGITS+1];
|
||||
char msisdn[GSM23003_MSISDN_MAX_DIGITS+1];
|
||||
struct osmo_sockaddr_str remote_hlr_addr;
|
||||
struct proxy_subscr_domain_state cs, ps;
|
||||
struct osmo_fsm_inst *mm_fi;
|
||||
struct osmo_fsm_inst *to_home_fi;
|
||||
};
|
||||
|
||||
void proxy_init(struct osmo_gsup_server *gsup_server_to_vlr);
|
||||
void proxy_del(struct proxy *proxy);
|
||||
void proxy_set_gc_period(struct proxy *proxy, uint32_t gc_period);
|
||||
|
||||
/* The API to access / modify proxy entries keeps the implementation opaque, to make sure that we can easily move proxy
|
||||
* storage to SQLite db. */
|
||||
int proxy_subscr_get_by_imsi(struct proxy_subscr *dst, struct proxy *proxy, const char *imsi);
|
||||
int proxy_subscr_get_by_msisdn(struct proxy_subscr *dst, struct proxy *proxy, const char *msisdn);
|
||||
void proxy_subscrs_get_by_remote_hlr(struct proxy *proxy, const struct osmo_sockaddr_str *remote_hlr_addr,
|
||||
bool (*yield)(struct proxy *proxy, const struct proxy_subscr *subscr, void *data),
|
||||
void *data);
|
||||
int proxy_subscr_create_or_update(struct proxy *proxy, const struct proxy_subscr *proxy_subscr);
|
||||
int proxy_subscr_del(struct proxy *proxy, const char *imsi);
|
||||
|
||||
int proxy_subscr_forward_to_remote_hlr(struct proxy *proxy, const struct proxy_subscr *proxy_subscr,
|
||||
struct osmo_gsup_req *req);
|
||||
void proxy_subscr_forward_to_remote_hlr_resolved(struct proxy *proxy, const struct proxy_subscr *proxy_subscr,
|
||||
struct remote_hlr *remote_hlr, struct osmo_gsup_req *req);
|
||||
|
||||
int proxy_subscr_forward_to_vlr(struct proxy *proxy, const struct proxy_subscr *proxy_subscr,
|
||||
const struct osmo_gsup_message *gsup, struct remote_hlr *from_remote_hlr);
|
||||
|
||||
void proxy_subscr_remote_hlr_resolved(struct proxy *proxy, const struct proxy_subscr *proxy_subscr,
|
||||
const struct osmo_sockaddr_str *remote_hlr_addr);
|
||||
void proxy_subscr_remote_hlr_up(struct proxy *proxy, const struct proxy_subscr *proxy_subscr,
|
||||
struct remote_hlr *remote_hlr);
|
||||
@@ -1,37 +0,0 @@
|
||||
/* Copyright 2020 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* Author: Neels Hofmeyr <neels@hofmeyr.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
/* If a subscriber from a remote site has successfully attached at this local site, and the link to the subscriber's
|
||||
* home HLR has succeeded, this will try to bridge the time of temporary link failure to that home HLR.
|
||||
* Tasks to take over from the unreachable home HLR:
|
||||
* - Resend known auth tuples on OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST.
|
||||
* - ...?
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
/* Data stored per subscriber */
|
||||
struct proxy_broken_link_cache {
|
||||
struct osmo_auth_vector auth_vectors[OSMO_GSUP_MAX_NUM_AUTH_INFO];
|
||||
size_t num_auth_vectors;
|
||||
|
||||
timestamp_t last_update;
|
||||
};
|
||||
@@ -1,54 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <osmocom/core/linuxlist.h>
|
||||
#include <osmocom/hlr/proxy.h>
|
||||
|
||||
enum proxy_mm_fsm_event {
|
||||
PROXY_MM_EV_SUBSCR_INVALID,
|
||||
PROXY_MM_EV_RX_GSUP_LU,
|
||||
PROXY_MM_EV_RX_GSUP_SAI,
|
||||
PROXY_MM_EV_RX_SUBSCR_DATA,
|
||||
PROXY_MM_EV_RX_GSUP_ISD_RESULT,
|
||||
PROXY_MM_EV_RX_AUTH_TUPLES,
|
||||
};
|
||||
|
||||
enum proxy_to_home_fsm_event {
|
||||
PROXY_TO_HOME_EV_HOME_HLR_RESOLVED,
|
||||
PROXY_TO_HOME_EV_RX_INSERT_SUBSCRIBER_DATA_REQ,
|
||||
PROXY_TO_HOME_EV_RX_UPDATE_LOCATION_RESULT,
|
||||
PROXY_TO_HOME_EV_RX_SEND_AUTH_INFO_RESULT,
|
||||
PROXY_TO_HOME_EV_CHECK_TUPLES,
|
||||
PROXY_TO_HOME_EV_CONFIRM_LU,
|
||||
};
|
||||
|
||||
extern struct llist_head proxy_mm_list;
|
||||
|
||||
struct proxy_mm_auth_cache {
|
||||
struct llist_head entry;
|
||||
uint64_t db_id;
|
||||
struct osmo_auth_vector auth_vectors[OSMO_GSUP_MAX_NUM_AUTH_INFO];
|
||||
size_t num_auth_vectors;
|
||||
unsigned int sent_to_vlr_count;
|
||||
};
|
||||
|
||||
struct proxy_mm {
|
||||
struct llist_head entry;
|
||||
struct osmo_gsup_peer_id vlr_name;
|
||||
char imsi[GSM23003_IMSI_MAX_DIGITS+1];
|
||||
bool is_ps;
|
||||
struct osmo_fsm_inst *mm_fi;
|
||||
struct osmo_fsm_inst *to_home_fi;
|
||||
struct llist_head auth_cache;
|
||||
};
|
||||
|
||||
struct proxy_mm *proxy_mm_alloc(const struct osmo_gsup_peer_id *vlr_name,
|
||||
bool is_ps,
|
||||
const char *imsi);
|
||||
|
||||
void proxy_mm_add_auth_vectors(struct proxy_mm *proxy_mm,
|
||||
const struct osmo_auth_vector *auth_vectors, size_t num_auth_vectors);
|
||||
struct proxy_mm_auth_cache *proxy_mm_get_auth_vectors(struct proxy_mm *proxy_mm);
|
||||
void proxy_mm_use_auth_vectors(struct proxy_mm *proxy_mm, struct proxy_mm_auth_cache *ac);
|
||||
void proxy_mm_discard_auth_vectors(struct proxy_mm *proxy_mm, struct proxy_mm_auth_cache *ac);
|
||||
|
||||
bool proxy_mm_subscriber_data_known(const struct proxy_mm *proxy_mm);
|
||||
@@ -1,59 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <osmocom/core/linuxlist.h>
|
||||
#include <osmocom/core/sockaddr_str.h>
|
||||
|
||||
struct osmo_gsup_client;
|
||||
struct osmo_gsup_message;
|
||||
struct osmo_gsup_req;
|
||||
struct msgb;
|
||||
|
||||
#define LOG_REMOTE_HLR(remote_hlr, level, fmt, args...) \
|
||||
LOGP(DDGSM, level, "(Proxy HLR-" OSMO_SOCKADDR_STR_FMT ") " fmt, \
|
||||
OSMO_SOCKADDR_STR_FMT_ARGS((remote_hlr) ? &(remote_hlr)->addr : NULL), ##args)
|
||||
|
||||
#define LOG_REMOTE_HLR_MSG(remote_hlr, gsup_msg, level, fmt, args...) \
|
||||
LOG_REMOTE_HLR(remote_hlr, level, "%s: " fmt, osmo_gsup_message_type_name((gsup_msg)->message_type), ##args)
|
||||
|
||||
/* GSUP client link for proxying to a remote HLR. */
|
||||
struct remote_hlr {
|
||||
struct llist_head entry;
|
||||
struct osmo_sockaddr_str addr;
|
||||
struct osmo_gsup_client *gsupc;
|
||||
struct llist_head pending_up_callbacks;
|
||||
};
|
||||
|
||||
/*! Receive a remote_hlr address when connecting succeeded, or remote_hlr == NULL on error.
|
||||
* \param addr GSUP IP address and port for which the connection was requested.
|
||||
* \param remote_hlr The connected remote_hlr ready for sending, or NULL if connecting failed.
|
||||
* \param data Same a passed to remote_hlr_get_or_connect(). */
|
||||
typedef void (*remote_hlr_connect_result_cb_t)(const struct osmo_sockaddr_str *addr, struct remote_hlr *remote_hlr, void *data);
|
||||
|
||||
struct remote_hlr *remote_hlr_get_or_connect(const struct osmo_sockaddr_str *addr, bool connect,
|
||||
remote_hlr_connect_result_cb_t connect_result_cb, void *data);
|
||||
void remote_hlr_destroy(struct remote_hlr *remote_hlr);
|
||||
int remote_hlr_msgb_send(struct remote_hlr *remote_hlr, struct msgb *msg);
|
||||
void remote_hlr_gsup_forward_to_remote_hlr(struct remote_hlr *remote_hlr, struct osmo_gsup_req *req,
|
||||
struct osmo_gsup_message *modified_gsup);
|
||||
|
||||
bool remote_hlr_is_up(struct remote_hlr *remote_hlr);
|
||||
@@ -1,28 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <sys/time.h>
|
||||
#include <stdbool.h>
|
||||
#include <stdint.h>
|
||||
|
||||
typedef time_t timestamp_t;
|
||||
void timestamp_update(timestamp_t *timestamp);
|
||||
bool timestamp_age(const timestamp_t *timestamp, uint32_t *age);
|
||||
@@ -1,6 +0,0 @@
|
||||
# most headers here are installed, see /include/Makefile.am
|
||||
|
||||
noinst_HEADERS = \
|
||||
mdns_msg.h \
|
||||
mdns_rfc.h \
|
||||
$(NULL)
|
||||
@@ -1,39 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/*! \file mdns.h */
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <osmocom/core/msgb.h>
|
||||
#include <osmocom/mslookup/mslookup.h>
|
||||
|
||||
#define OSMO_MDNS_DOMAIN_SUFFIX_DEFAULT "mdns.osmocom.org"
|
||||
|
||||
struct msgb *osmo_mdns_query_encode(void *ctx, uint16_t packet_id, const struct osmo_mslookup_query *query,
|
||||
const char *domain_suffix);
|
||||
|
||||
struct osmo_mslookup_query *osmo_mdns_query_decode(void *ctx, const uint8_t *data, size_t data_len,
|
||||
uint16_t *packet_id, const char *domain_suffix);
|
||||
|
||||
struct msgb *osmo_mdns_result_encode(void *ctx, uint16_t packet_id, const struct osmo_mslookup_query *query,
|
||||
const struct osmo_mslookup_result *result, const char *domain_suffix);
|
||||
|
||||
int osmo_mdns_result_decode(void *ctx, const uint8_t *data, size_t data_len, uint16_t *packet_id,
|
||||
struct osmo_mslookup_query *query, struct osmo_mslookup_result *result,
|
||||
const char *domain_suffix);
|
||||
@@ -1,54 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdint.h>
|
||||
#include "mdns_rfc.h"
|
||||
|
||||
struct osmo_mdns_record {
|
||||
struct llist_head list;
|
||||
enum osmo_mdns_rfc_record_type type;
|
||||
uint16_t length;
|
||||
uint8_t *data;
|
||||
};
|
||||
|
||||
struct osmo_mdns_msg_request {
|
||||
uint16_t id;
|
||||
char *domain;
|
||||
enum osmo_mdns_rfc_record_type type;
|
||||
};
|
||||
|
||||
struct osmo_mdns_msg_answer {
|
||||
uint16_t id;
|
||||
char *domain;
|
||||
/*! list of osmo_mdns_record. */
|
||||
struct llist_head records;
|
||||
};
|
||||
|
||||
int osmo_mdns_msg_request_encode(void *ctx, struct msgb *msg, const struct osmo_mdns_msg_request *req);
|
||||
struct osmo_mdns_msg_request *osmo_mdns_msg_request_decode(void *ctx, const uint8_t *data, size_t data_len);
|
||||
|
||||
void osmo_mdns_msg_answer_init(struct osmo_mdns_msg_answer *answer);
|
||||
int osmo_mdns_msg_answer_encode(void *ctx, struct msgb *msg, const struct osmo_mdns_msg_answer *ans);
|
||||
struct osmo_mdns_msg_answer *osmo_mdns_msg_answer_decode(void *ctx, const uint8_t *data, size_t data_len);
|
||||
int osmo_mdns_result_from_answer(struct osmo_mslookup_result *result, const struct osmo_mdns_msg_answer *ans);
|
||||
|
||||
struct osmo_mdns_record *osmo_mdns_record_txt_keyval_encode(void *ctx, const char *key, const char *value_fmt, ...);
|
||||
int osmo_mdns_record_txt_keyval_decode(const struct osmo_mdns_record *rec,
|
||||
char *key_buf, size_t key_size, char *value_buf, size_t value_size);
|
||||
@@ -1,113 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <stdint.h>
|
||||
#include <osmocom/core/msgb.h>
|
||||
#include <osmocom/core/endian.h>
|
||||
#include <osmocom/mslookup/mdns.h>
|
||||
|
||||
/* RFC 1035 2.3.4 */
|
||||
#define OSMO_MDNS_RFC_MAX_NAME_LEN 255
|
||||
|
||||
/* RFC 1035 3.3 <character-string> */
|
||||
#define OSMO_MDNS_RFC_MAX_CHARACTER_STRING_LEN 256
|
||||
|
||||
enum osmo_mdns_rfc_record_type {
|
||||
OSMO_MDNS_RFC_RECORD_TYPE_UNKNOWN = 0,
|
||||
|
||||
/* RFC 1035 3.2.2 */
|
||||
OSMO_MDNS_RFC_RECORD_TYPE_A = 1, /* IPv4 address */
|
||||
OSMO_MDNS_RFC_RECORD_TYPE_TXT = 16, /* Text strings */
|
||||
|
||||
/* RFC 3596 2.1 */
|
||||
OSMO_MDNS_RFC_RECORD_TYPE_AAAA = 28, /* IPv6 address */
|
||||
|
||||
/* RFC 1035 3.2.3 */
|
||||
OSMO_MDNS_RFC_RECORD_TYPE_ALL = 255, /* Request only: ask for all */
|
||||
};
|
||||
|
||||
enum osmo_mdns_rfc_class {
|
||||
OSMO_MDNS_RFC_CLASS_UNKNOWN = 0,
|
||||
|
||||
/* RFC 1035 3.2.4 */
|
||||
OSMO_MDNS_RFC_CLASS_IN = 1, /* Internet and IP networks */
|
||||
|
||||
/* RFC 1035 3.2.5 */
|
||||
OSMO_MDNS_RFC_CLASS_ALL = 255, /* Request only: ask for all */
|
||||
};
|
||||
|
||||
/* RFC 1035 4.1.1 */
|
||||
struct osmo_mdns_rfc_header {
|
||||
#if OSMO_IS_LITTLE_ENDIAN
|
||||
uint16_t id;
|
||||
uint8_t rd:1,
|
||||
tc:1,
|
||||
aa:1,
|
||||
opcode:4,
|
||||
qr:1; /* QR (0: query, 1: response) */
|
||||
uint8_t rcode:4,
|
||||
z:3,
|
||||
ra:1;
|
||||
uint16_t qdcount; /* Number of questions */
|
||||
uint16_t ancount; /* Number of answers */
|
||||
uint16_t nscount; /* Number of authority records */
|
||||
uint16_t arcount; /* Number of additional records */
|
||||
#elif OSMO_IS_BIG_ENDIAN
|
||||
/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
|
||||
uint16_t id;
|
||||
uint8_t qr:1, opcode:4, aa:1, tc:1, rd:1;
|
||||
uint8_t ra:1, z:3, rcode:4;
|
||||
uint16_t qdcount;
|
||||
uint16_t ancount;
|
||||
uint16_t nscount;
|
||||
uint16_t arcount;
|
||||
#endif
|
||||
} __attribute__ ((packed));
|
||||
|
||||
/* RFC 1035 4.1.2 */
|
||||
struct osmo_mdns_rfc_question {
|
||||
char *domain; /* Domain to be encoded as qname (e.g. "gsup.hlr.1234567.imsi") */
|
||||
enum osmo_mdns_rfc_record_type qtype;
|
||||
enum osmo_mdns_rfc_class qclass;
|
||||
};
|
||||
|
||||
/* RFC 1035 4.1.3 */
|
||||
struct osmo_mdns_rfc_record {
|
||||
char *domain; /* Domain to be encoded as name (e.g. "gsup.hlr.1234567.imsi") */
|
||||
enum osmo_mdns_rfc_record_type type;
|
||||
enum osmo_mdns_rfc_class class;
|
||||
uint32_t ttl;
|
||||
uint16_t rdlength;
|
||||
uint8_t *rdata;
|
||||
};
|
||||
|
||||
char *osmo_mdns_rfc_qname_encode(void *ctx, const char *domain);
|
||||
char *osmo_mdns_rfc_qname_decode(void *ctx, const char *qname, size_t qname_len);
|
||||
|
||||
void osmo_mdns_rfc_header_encode(struct msgb *msg, const struct osmo_mdns_rfc_header *hdr);
|
||||
int osmo_mdns_rfc_header_decode(const uint8_t *data, size_t data_len, struct osmo_mdns_rfc_header *hdr);
|
||||
|
||||
int osmo_mdns_rfc_question_encode(void *ctx, struct msgb *msg, const struct osmo_mdns_rfc_question *qst);
|
||||
struct osmo_mdns_rfc_question *osmo_mdns_rfc_question_decode(void *ctx, const uint8_t *data, size_t data_len);
|
||||
|
||||
int osmo_mdns_rfc_record_encode(void *ctx, struct msgb *msg, const struct osmo_mdns_rfc_record *rec);
|
||||
struct osmo_mdns_rfc_record *osmo_mdns_rfc_record_decode(void *ctx, const uint8_t *data, size_t data_len,
|
||||
size_t *record_len);
|
||||
@@ -1,33 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <netdb.h>
|
||||
#include <osmocom/core/msgb.h>
|
||||
#include <osmocom/core/select.h>
|
||||
|
||||
struct osmo_mdns_sock {
|
||||
struct osmo_fd osmo_fd;
|
||||
struct addrinfo *ai;
|
||||
};
|
||||
|
||||
struct osmo_mdns_sock *osmo_mdns_sock_init(void *ctx, const char *ip, unsigned int port,
|
||||
int (*cb)(struct osmo_fd *fd, unsigned int what),
|
||||
void *data, unsigned int priv_nr);
|
||||
int osmo_mdns_sock_send(const struct osmo_mdns_sock *mdns_sock, struct msgb *msg);
|
||||
void osmo_mdns_sock_cleanup(struct osmo_mdns_sock *mdns_sock);
|
||||
@@ -1,121 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/*! \defgroup mslookup Distributed GSM: finding subscribers
|
||||
* @{
|
||||
* \file mslookup.h
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <osmocom/core/utils.h>
|
||||
#include <osmocom/core/sockaddr_str.h>
|
||||
#include <osmocom/gsm/protocol/gsm_23_003.h>
|
||||
|
||||
#define OSMO_MSLOOKUP_SERVICE_MAXLEN 64
|
||||
|
||||
bool osmo_mslookup_service_valid(const char *service);
|
||||
|
||||
enum osmo_mslookup_id_type {
|
||||
OSMO_MSLOOKUP_ID_NONE = 0,
|
||||
OSMO_MSLOOKUP_ID_IMSI,
|
||||
OSMO_MSLOOKUP_ID_MSISDN,
|
||||
};
|
||||
|
||||
extern const struct value_string osmo_mslookup_id_type_names[];
|
||||
static inline const char *osmo_mslookup_id_type_name(enum osmo_mslookup_id_type val)
|
||||
{ return get_value_string(osmo_mslookup_id_type_names, val); }
|
||||
|
||||
struct osmo_mslookup_id {
|
||||
enum osmo_mslookup_id_type type;
|
||||
union {
|
||||
char imsi[GSM23003_IMSI_MAX_DIGITS+1];
|
||||
char msisdn[GSM23003_MSISDN_MAX_DIGITS+1];
|
||||
};
|
||||
};
|
||||
|
||||
int osmo_mslookup_id_cmp(const struct osmo_mslookup_id *a, const struct osmo_mslookup_id *b);
|
||||
bool osmo_mslookup_id_valid(const struct osmo_mslookup_id *id);
|
||||
|
||||
enum osmo_mslookup_result_code {
|
||||
OSMO_MSLOOKUP_RC_NONE = 0,
|
||||
/*! An intermediate valid result. The request is still open for more results. */
|
||||
OSMO_MSLOOKUP_RC_RESULT,
|
||||
/*! Returned when the final request timeout has elapsed without results. */
|
||||
OSMO_MSLOOKUP_RC_NOT_FOUND,
|
||||
};
|
||||
|
||||
extern const struct value_string osmo_mslookup_result_code_names[];
|
||||
static inline const char *osmo_mslookup_result_code_name(enum osmo_mslookup_result_code val)
|
||||
{ return get_value_string(osmo_mslookup_result_code_names, val); }
|
||||
|
||||
/*! Information to request from a lookup. */
|
||||
struct osmo_mslookup_query {
|
||||
/*! Which service to request, by freely invented names. For service name conventions (for voice, SMS, HLR,...),
|
||||
* refer to the OsmoHLR user's manual http://ftp.osmocom.org/docs/latest/osmohlr-usermanual.pdf */
|
||||
char service[OSMO_MSLOOKUP_SERVICE_MAXLEN + 1];
|
||||
/*! IMSI or MSISDN to look up. */
|
||||
struct osmo_mslookup_id id;
|
||||
|
||||
/*! Caller provided private data, if desired. */
|
||||
void *priv;
|
||||
};
|
||||
|
||||
/*! Result data as passed back to a lookup client that invoked an osmo_mslookup_client_request. */
|
||||
struct osmo_mslookup_result {
|
||||
/*! Outcome of the request. */
|
||||
enum osmo_mslookup_result_code rc;
|
||||
|
||||
/*! IP address and port to reach the given service via IPv4, if any. */
|
||||
struct osmo_sockaddr_str host_v4;
|
||||
|
||||
/*! IP address and port to reach the given service via IPv6, if any. */
|
||||
struct osmo_sockaddr_str host_v6;
|
||||
|
||||
/*! How long ago the service last verified presence of the subscriber, in seconds, or zero if the presence is
|
||||
* invariable (like the home HLR record for an IMSI).
|
||||
* If a subscriber has recently moved to a different location, we get multiple replies and want to choose the
|
||||
* most recent one. If this were a timestamp, firstly the time zones would need to be taken care of.
|
||||
* Even if we choose UTC, a service provider with an inaccurate date/time would end up affecting the result.
|
||||
* The least susceptible to configuration errors or difference in local and remote clock is a value that
|
||||
* indicates the actual age of the record in seconds. The time that the lookup query took to be answered should
|
||||
* be neglectable here, since we would typically wait one second (or very few seconds) for lookup replies,
|
||||
* while typical Location Updating periods are in the range of 15 minutes. */
|
||||
uint32_t age;
|
||||
|
||||
/*! Whether this is the last result returned for this request. */
|
||||
bool last;
|
||||
};
|
||||
|
||||
int osmo_mslookup_query_init_from_domain_str(struct osmo_mslookup_query *q, const char *domain);
|
||||
|
||||
size_t osmo_mslookup_id_name_buf(char *buf, size_t buflen, const struct osmo_mslookup_id *id);
|
||||
char *osmo_mslookup_id_name_c(void *ctx, const struct osmo_mslookup_id *id);
|
||||
char *osmo_mslookup_id_name_b(char *buf, size_t buflen, const struct osmo_mslookup_id *id);
|
||||
|
||||
size_t osmo_mslookup_result_to_str_buf(char *buf, size_t buflen,
|
||||
const struct osmo_mslookup_query *query,
|
||||
const struct osmo_mslookup_result *result);
|
||||
char *osmo_mslookup_result_name_c(void *ctx,
|
||||
const struct osmo_mslookup_query *query,
|
||||
const struct osmo_mslookup_result *result);
|
||||
char *osmo_mslookup_result_name_b(char *buf, size_t buflen,
|
||||
const struct osmo_mslookup_query *query,
|
||||
const struct osmo_mslookup_result *result);
|
||||
|
||||
/*! @} */
|
||||
@@ -1,132 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <osmocom/core/linuxlist.h>
|
||||
#include <osmocom/core/timer.h>
|
||||
#include <osmocom/core/sockaddr_str.h>
|
||||
#include <osmocom/mslookup/mslookup.h>
|
||||
|
||||
struct osmo_mslookup_client;
|
||||
struct osmo_mslookup_result;
|
||||
|
||||
typedef void (*osmo_mslookup_cb_t)(struct osmo_mslookup_client *client,
|
||||
uint32_t request_handle,
|
||||
const struct osmo_mslookup_query *query,
|
||||
const struct osmo_mslookup_result *result);
|
||||
|
||||
/*! This handling information is passed along with a lookup request.
|
||||
* It tells the osmo_mslookup_client layer how to handle responses received from various mslookup methods (at the time
|
||||
* of writing only mDNS exists as a method, but the intention is to easily allow adding other methods in the future).
|
||||
* This query handling info is not seen by the individual method implementations, to clarify that it is the
|
||||
* osmo_mslookup_client layer that takes care of these details. */
|
||||
struct osmo_mslookup_query_handling {
|
||||
/*! Wait at least this long before returning any results.
|
||||
*
|
||||
* If nonzero, result_cb will be called as soon as this delay has elapsed, either with the so far youngest age
|
||||
* result, or with a "not found yet" result. After this delay has elapsed, receiving results will continue
|
||||
* until result_timeout_milliseconds has elapsed.
|
||||
*
|
||||
* If zero, responses are fed to the result_cb right from the start, every time a younger aged result than
|
||||
* before comes in.
|
||||
*
|
||||
* If a result with age == 0 is received, min_wait_milliseconds is ignored, the result is returned immediately
|
||||
* and listening for responses ends.
|
||||
*
|
||||
* Rationale: If a subscriber has recently moved between sites, multiple results will arrive, and the youngest
|
||||
* age wins. It can make sense to wait a minimum time for responses before determining the winning result.
|
||||
*
|
||||
* However, if no result or no valid result has arrived within a short period, the subscriber may be at a site
|
||||
* that is far away or that is currently experiencing high latency. It is thus a good safety net to still
|
||||
* receive results for an extended period of time.
|
||||
*
|
||||
* For some services, it is possible to establish links to every received result, and whichever link succeeds
|
||||
* will be used (for example for SIP calls: first to pick up the call gets connected, the others are dropped
|
||||
* silently).
|
||||
*/
|
||||
uint32_t min_wait_milliseconds;
|
||||
|
||||
/*! Total time in milliseconds to listen for lookup responses.
|
||||
*
|
||||
* When this timeout elapses, osmo_mslookup_client_request_cancel() is called implicitly; Manually invoking
|
||||
* osmo_mslookup_client_request_cancel() after result_timeout_milliseconds has elapsed is not necessary, but is
|
||||
* still safe to do anyway.
|
||||
*
|
||||
* If zero, min_wait_milliseconds is also used as result_timeout_milliseconds; if that is also zero, a default
|
||||
* timeout value is used.
|
||||
*
|
||||
* If result_timeout_milliseconds <= min_wait_milliseconds, then min_wait_milliseconds is used as
|
||||
* result_timeout_milliseconds, i.e. the timeout triggers as soon as min_wait_milliseconds hits.
|
||||
*
|
||||
* osmo_mslookup_client_request_cancel() can be called any time to end the request.
|
||||
*/
|
||||
uint32_t result_timeout_milliseconds;
|
||||
|
||||
/*! Invoked every time a result with a younger age than the previous result has arrived.
|
||||
* To stop receiving results before result_timeout_milliseconds has elapsed, call
|
||||
* osmo_mslookup_client_request_cancel().
|
||||
*/
|
||||
osmo_mslookup_cb_t result_cb;
|
||||
};
|
||||
|
||||
uint32_t osmo_mslookup_client_request(struct osmo_mslookup_client *client,
|
||||
const struct osmo_mslookup_query *query,
|
||||
const struct osmo_mslookup_query_handling *handling);
|
||||
|
||||
void osmo_mslookup_client_request_cancel(struct osmo_mslookup_client *client, uint32_t request_handle);
|
||||
|
||||
struct osmo_mslookup_client *osmo_mslookup_client_new(void *ctx);
|
||||
bool osmo_mslookup_client_active(struct osmo_mslookup_client *client);
|
||||
void osmo_mslookup_client_free(struct osmo_mslookup_client *client);
|
||||
|
||||
/*! Describe a specific mslookup client method implementation. This struct is only useful for a lookup method
|
||||
* implementation to add itself to an osmo_mslookup_client, see for example osmo_mslookup_client_add_mdns(). */
|
||||
struct osmo_mslookup_client_method {
|
||||
struct llist_head entry;
|
||||
|
||||
/*! Human readable name of this lookup method. */
|
||||
const char *name;
|
||||
|
||||
/*! Private data for the lookup method implementation. */
|
||||
void *priv;
|
||||
|
||||
/*! Backpointer to the client this method is added to. */
|
||||
struct osmo_mslookup_client *client;
|
||||
|
||||
/*! Launch a lookup query. Called from osmo_mslookup_client_request().
|
||||
* The implementation returns results by calling osmo_mslookup_client_rx_result(). */
|
||||
void (*request)(struct osmo_mslookup_client_method *method,
|
||||
const struct osmo_mslookup_query *query,
|
||||
uint32_t request_handle);
|
||||
/*! End a lookup query. Called from osmo_mslookup_client_request_cancel(). It is guaranteed to be called
|
||||
* exactly once per above request() invocation. (The API user is required to invoke
|
||||
* osmo_mslookup_client_request_cancel() exactly once per osmo_mslookup_client_request().) */
|
||||
void (*request_cleanup)(struct osmo_mslookup_client_method *method,
|
||||
uint32_t request_handle);
|
||||
|
||||
/*! The mslookup_client is removing this method, clean up all open requests, lists and allocations. */
|
||||
void (*destruct)(struct osmo_mslookup_client_method *method);
|
||||
};
|
||||
|
||||
void osmo_mslookup_client_method_add(struct osmo_mslookup_client *client,
|
||||
struct osmo_mslookup_client_method *method);
|
||||
bool osmo_mslookup_client_method_del(struct osmo_mslookup_client *client,
|
||||
struct osmo_mslookup_client_method *method);
|
||||
void osmo_mslookup_client_rx_result(struct osmo_mslookup_client *client, uint32_t request_handle,
|
||||
const struct osmo_mslookup_result *result);
|
||||
@@ -1,34 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
/*! MS lookup fake API for testing purposes. */
|
||||
#include <osmocom/mslookup/mslookup_client.h>
|
||||
|
||||
struct osmo_mslookup_fake_response {
|
||||
struct timeval time_to_reply;
|
||||
struct osmo_mslookup_id for_id;
|
||||
const char *for_service;
|
||||
struct osmo_mslookup_result result;
|
||||
bool sent;
|
||||
};
|
||||
|
||||
struct osmo_mslookup_client_method *osmo_mslookup_client_add_fake(struct osmo_mslookup_client *client,
|
||||
struct osmo_mslookup_fake_response *responses,
|
||||
size_t responses_len);
|
||||
@@ -1,38 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
struct osmo_mslookup_client;
|
||||
struct osmo_mslookup_client_method;
|
||||
|
||||
/*! MS Lookup mDNS server bind default IP. Taken from the Administratevly Scoped block, particularly the Organizational
|
||||
* Scoped range, https://tools.ietf.org/html/rfc2365 . */
|
||||
#define OSMO_MSLOOKUP_MDNS_IP4 "239.192.23.42"
|
||||
#define OSMO_MSLOOKUP_MDNS_IP6 "ff08::23:42" // <-- TODO: sane?
|
||||
#define OSMO_MSLOOKUP_MDNS_PORT 4266
|
||||
|
||||
struct osmo_mslookup_client_method *osmo_mslookup_client_add_mdns(struct osmo_mslookup_client *client, const char *ip,
|
||||
uint16_t port, int initial_packet_id,
|
||||
const char *domain_suffix);
|
||||
|
||||
const struct osmo_sockaddr_str *osmo_mslookup_client_method_mdns_get_bind_addr(struct osmo_mslookup_client_method *dns_method);
|
||||
|
||||
const char *osmo_mslookup_client_method_mdns_get_domain_suffix(struct osmo_mslookup_client_method *dns_method);
|
||||
@@ -3,9 +3,9 @@ exec_prefix=@exec_prefix@
|
||||
libdir=@libdir@
|
||||
includedir=@includedir@
|
||||
|
||||
Name: Osmocom GSUP Client Library
|
||||
Name: Osmocom GSUP and OAP Client Library
|
||||
Description: C Utility Library
|
||||
Version: @VERSION@
|
||||
Libs: -L${libdir} -losmo-gsup-client
|
||||
Libs: -L${libdir} @TALLOC_LIBS@ -losmogsm -losmocore
|
||||
Cflags: -I${includedir}/
|
||||
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
prefix=@prefix@
|
||||
exec_prefix=@exec_prefix@
|
||||
libdir=@libdir@
|
||||
includedir=@includedir@
|
||||
|
||||
Name: Osmocom MS Lookup Library
|
||||
Description: C Utility Library
|
||||
Version: @VERSION@
|
||||
Libs: -L${libdir} @TALLOC_LIBS@ -losmogsm -losmo-mslookup -losmocore
|
||||
Cflags: -I${includedir}/
|
||||
|
||||
66
sql/hlr.sql
66
sql/hlr.sql
@@ -1,18 +1,16 @@
|
||||
CREATE TABLE subscriber (
|
||||
CREATE TABLE IF NOT EXISTS subscriber (
|
||||
-- OsmoHLR's DB scheme is modelled roughly after TS 23.008 version 13.3.0
|
||||
id INTEGER PRIMARY KEY,
|
||||
-- Chapter 2.1.1.1
|
||||
imsi VARCHAR(15) UNIQUE NOT NULL,
|
||||
-- Chapter 2.1.2
|
||||
msisdn VARCHAR(15) UNIQUE,
|
||||
-- Chapter 2.2.3: Most recent / current IMEISV
|
||||
-- Chapter 2.2.3: Most recent / current IMEI
|
||||
imeisv VARCHAR,
|
||||
-- Chapter 2.1.9: Most recent / current IMEI
|
||||
imei VARCHAR(14),
|
||||
-- Chapter 2.4.5
|
||||
vlr_number VARCHAR(15),
|
||||
-- Chapter 2.4.6
|
||||
msc_number VARCHAR(15),
|
||||
hlr_number VARCHAR(15),
|
||||
-- Chapter 2.4.8.1
|
||||
sgsn_number VARCHAR(15),
|
||||
-- Chapter 2.13.10
|
||||
@@ -38,78 +36,34 @@ CREATE TABLE subscriber (
|
||||
-- Chapter 2.7.5
|
||||
ms_purged_cs BOOLEAN NOT NULL DEFAULT 0,
|
||||
-- Chapter 2.7.6
|
||||
ms_purged_ps BOOLEAN NOT NULL DEFAULT 0,
|
||||
|
||||
-- Timestamp of last location update seen from subscriber
|
||||
-- The value is a string which encodes a UTC timestamp in granularity of seconds.
|
||||
last_lu_seen TIMESTAMP default NULL,
|
||||
last_lu_seen_ps TIMESTAMP default NULL,
|
||||
|
||||
-- When a LU was received via a proxy, that proxy's hlr_number is stored here,
|
||||
-- while vlr_number reflects the MSC on the far side of that proxy.
|
||||
vlr_via_proxy VARCHAR,
|
||||
sgsn_via_proxy VARCHAR
|
||||
ms_purged_ps BOOLEAN NOT NULL DEFAULT 0
|
||||
);
|
||||
|
||||
CREATE TABLE subscriber_apn (
|
||||
CREATE TABLE IF NOT EXISTS subscriber_apn (
|
||||
subscriber_id INTEGER, -- subscriber.id
|
||||
apn VARCHAR(256) NOT NULL
|
||||
);
|
||||
|
||||
CREATE TABLE subscriber_multi_msisdn (
|
||||
CREATE TABLE IF NOT EXISTS subscriber_multi_msisdn (
|
||||
-- Chapter 2.1.3
|
||||
subscriber_id INTEGER, -- subscriber.id
|
||||
msisdn VARCHAR(15) NOT NULL
|
||||
);
|
||||
|
||||
CREATE TABLE auc_2g (
|
||||
CREATE TABLE IF NOT EXISTS auc_2g (
|
||||
subscriber_id INTEGER PRIMARY KEY, -- subscriber.id
|
||||
algo_id_2g INTEGER NOT NULL, -- enum osmo_auth_algo value
|
||||
ki VARCHAR(32) NOT NULL -- hex string: subscriber's secret key (128bit)
|
||||
);
|
||||
|
||||
CREATE TABLE auc_3g (
|
||||
CREATE TABLE IF NOT EXISTS auc_3g (
|
||||
subscriber_id INTEGER PRIMARY KEY, -- subscriber.id
|
||||
algo_id_3g INTEGER NOT NULL, -- enum osmo_auth_algo value
|
||||
k VARCHAR(32) NOT NULL, -- hex string: subscriber's secret key (128bit)
|
||||
op VARCHAR(32), -- hex string: operator's secret key (128bit)
|
||||
opc VARCHAR(32), -- hex string: derived from OP and K (128bit)
|
||||
sqn INTEGER NOT NULL DEFAULT 0, -- sequence number of key usage
|
||||
-- nr of index bits at lower SQN end
|
||||
ind_bitlen INTEGER NOT NULL DEFAULT 5
|
||||
ind_bitlen INTEGER NOT NULL DEFAULT 5 -- nr of index bits at lower SQN end
|
||||
);
|
||||
|
||||
CREATE TABLE ind (
|
||||
-- 3G auth IND pool to be used for this VLR
|
||||
ind INTEGER PRIMARY KEY,
|
||||
-- VLR identification, usually the GSUP source_name
|
||||
vlr TEXT NOT NULL,
|
||||
UNIQUE (vlr)
|
||||
);
|
||||
|
||||
CREATE TABLE proxy_auth_cache {
|
||||
id INTEGER PRIMARY KEY,
|
||||
vlr TEXT NOT NULL,
|
||||
imsi TEXT NOT NULL,
|
||||
sent_count INTEGER
|
||||
};
|
||||
|
||||
CREATE TABLE proxy_auth_cache_vector {
|
||||
-- belongs to this proxy_auth_cache entry
|
||||
proxy_auth_cache_id INTEGER,
|
||||
rand VARCHAR(32),
|
||||
autn VARCHAR(32),
|
||||
ck VARCHAR(32),
|
||||
ik VARCHAR(32),
|
||||
res VARCHAR(32),
|
||||
kc[8] VARCHAR(16),
|
||||
sres[4] VARCHAR(8),
|
||||
-- enum osmo_sub_auth_type bitmask
|
||||
auth_types INTEGER
|
||||
};
|
||||
|
||||
CREATE UNIQUE INDEX idx_subscr_imsi ON subscriber (imsi);
|
||||
|
||||
-- Set HLR database schema version number
|
||||
-- Note: This constant is currently duplicated in src/db.c and must be kept in sync!
|
||||
PRAGMA user_version = 6;
|
||||
CREATE UNIQUE INDEX IF NOT EXISTS idx_subscr_imsi ON subscriber (imsi);
|
||||
|
||||
@@ -1,7 +1,4 @@
|
||||
SUBDIRS = \
|
||||
gsupclient \
|
||||
mslookup \
|
||||
$(NULL)
|
||||
SUBDIRS = gsupclient
|
||||
|
||||
AM_CFLAGS = \
|
||||
-Wall \
|
||||
@@ -9,18 +6,16 @@ AM_CFLAGS = \
|
||||
$(LIBOSMOGSM_CFLAGS) \
|
||||
$(LIBOSMOVTY_CFLAGS) \
|
||||
$(LIBOSMOCTRL_CFLAGS) \
|
||||
$(LIBOSMOMSLOOKUP_CFLAGS) \
|
||||
$(LIBOSMOABIS_CFLAGS) \
|
||||
$(SQLITE3_CFLAGS) \
|
||||
$(NULL)
|
||||
|
||||
AM_CPPFLAGS = -I$(top_srcdir)/include \
|
||||
-I$(top_builddir)/include \
|
||||
$(NULL)
|
||||
|
||||
EXTRA_DIST = \
|
||||
populate_hlr_db.pl \
|
||||
db_sql2c.sed \
|
||||
db_bootstrap.sed \
|
||||
$(NULL)
|
||||
|
||||
BUILT_SOURCES = \
|
||||
@@ -29,6 +24,18 @@ BUILT_SOURCES = \
|
||||
CLEANFILES = $(BUILT_SOURCES)
|
||||
|
||||
noinst_HEADERS = \
|
||||
auc.h \
|
||||
db.h \
|
||||
hlr.h \
|
||||
luop.h \
|
||||
gsup_router.h \
|
||||
gsup_server.h \
|
||||
logging.h \
|
||||
rand.h \
|
||||
ctrl.h \
|
||||
hlr_vty.h \
|
||||
hlr_vty_subscr.h \
|
||||
hlr_ussd.h \
|
||||
db_bootstrap.h \
|
||||
$(NULL)
|
||||
|
||||
@@ -42,6 +49,7 @@ osmo_hlr_SOURCES = \
|
||||
auc.c \
|
||||
ctrl.c \
|
||||
db.c \
|
||||
luop.c \
|
||||
db_auc.c \
|
||||
db_hlr.c \
|
||||
gsup_router.c \
|
||||
@@ -53,27 +61,13 @@ osmo_hlr_SOURCES = \
|
||||
hlr_vty_subscr.c \
|
||||
gsup_send.c \
|
||||
hlr_ussd.c \
|
||||
proxy.c \
|
||||
proxy_mm.c \
|
||||
proxy_to_home.c \
|
||||
proxy_db.c \
|
||||
dgsm.c \
|
||||
remote_hlr.c \
|
||||
lu_fsm.c \
|
||||
timestamp.c \
|
||||
mslookup_server.c \
|
||||
mslookup_server_mdns.c \
|
||||
dgsm_vty.c \
|
||||
$(NULL)
|
||||
|
||||
osmo_hlr_LDADD = \
|
||||
$(top_builddir)/src/gsupclient/libosmo-gsup-client.la \
|
||||
$(top_builddir)/src/mslookup/libosmo-mslookup.la \
|
||||
$(LIBOSMOCORE_LIBS) \
|
||||
$(LIBOSMOGSM_LIBS) \
|
||||
$(LIBOSMOVTY_LIBS) \
|
||||
$(LIBOSMOCTRL_LIBS) \
|
||||
$(LIBOSMOMSLOOKUP_LIBS) \
|
||||
$(LIBOSMOABIS_LIBS) \
|
||||
$(SQLITE3_LIBS) \
|
||||
$(NULL)
|
||||
@@ -85,7 +79,6 @@ osmo_hlr_db_tool_SOURCES = \
|
||||
logging.c \
|
||||
rand_urandom.c \
|
||||
dbd_decode_binary.c \
|
||||
$(srcdir)/gsupclient/gsup_peer_id.c \
|
||||
$(NULL)
|
||||
|
||||
osmo_hlr_db_tool_LDADD = \
|
||||
@@ -94,6 +87,21 @@ osmo_hlr_db_tool_LDADD = \
|
||||
$(SQLITE3_LIBS) \
|
||||
$(NULL)
|
||||
|
||||
db_test_SOURCES = \
|
||||
auc.c \
|
||||
db.c \
|
||||
db_auc.c \
|
||||
db_test.c \
|
||||
logging.c \
|
||||
rand_fake.c \
|
||||
$(NULL)
|
||||
|
||||
db_test_LDADD = \
|
||||
$(LIBOSMOCORE_LIBS) \
|
||||
$(LIBOSMOGSM_LIBS) \
|
||||
$(SQLITE3_LIBS) \
|
||||
$(NULL)
|
||||
|
||||
osmo_euse_demo_SOURCES = \
|
||||
osmo-euse-demo.c \
|
||||
$(NULL)
|
||||
@@ -104,18 +112,13 @@ osmo_euse_demo_LDADD = \
|
||||
$(LIBOSMOGSM_LIBS) \
|
||||
$(NULL)
|
||||
|
||||
if DB_SQLITE_DEBUG
|
||||
osmo_hlr_SOURCES += db_debug.c
|
||||
osmo_hlr_db_tool_SOURCES += db_debug.c
|
||||
endif
|
||||
|
||||
BOOTSTRAP_SQL = $(top_srcdir)/sql/hlr.sql
|
||||
|
||||
db_bootstrap.h: $(BOOTSTRAP_SQL) $(srcdir)/db_sql2c.sed
|
||||
echo "/* DO NOT EDIT THIS FILE. It is generated from files in osmo-hlr.git/sql/ */" > "$@"
|
||||
db_bootstrap.h: $(BOOTSTRAP_SQL) $(srcdir)/db_bootstrap.sed
|
||||
echo "/* DO NOT EDIT THIS FILE. It is generated from osmo-hlr.git/sql/hlr.sql */" > "$@"
|
||||
echo "#pragma once" >> "$@"
|
||||
echo "static const char *stmt_bootstrap_sql[] = {" >> "$@"
|
||||
cat "$(BOOTSTRAP_SQL)" \
|
||||
| sed -f "$(srcdir)/db_sql2c.sed" \
|
||||
| sed -f "$(srcdir)/db_bootstrap.sed" \
|
||||
>> "$@"
|
||||
echo "};" >> "$@"
|
||||
|
||||
@@ -23,8 +23,8 @@
|
||||
#include <osmocom/core/utils.h>
|
||||
#include <osmocom/crypt/auth.h>
|
||||
|
||||
#include <osmocom/hlr/logging.h>
|
||||
#include <osmocom/hlr/rand.h>
|
||||
#include "logging.h"
|
||||
#include "rand.h"
|
||||
|
||||
#define hexb(buf) osmo_hexdump_nospc((void*)buf, sizeof(buf))
|
||||
#define hex(buf,sz) osmo_hexdump_nospc((void*)buf, sz)
|
||||
|
||||
12
src/ctrl.c
12
src/ctrl.c
@@ -28,9 +28,9 @@
|
||||
#include <osmocom/gsm/gsm23003.h>
|
||||
#include <osmocom/ctrl/ports.h>
|
||||
|
||||
#include <osmocom/hlr/hlr.h>
|
||||
#include <osmocom/hlr/ctrl.h>
|
||||
#include <osmocom/hlr/db.h>
|
||||
#include "hlr.h"
|
||||
#include "ctrl.h"
|
||||
#include "db.h"
|
||||
|
||||
#define SEL_BY "by-"
|
||||
#define SEL_BY_IMSI SEL_BY "imsi-"
|
||||
@@ -95,7 +95,7 @@ static bool get_subscriber(struct db_context *dbc,
|
||||
cmd->reply = "No such subscriber.";
|
||||
return false;
|
||||
default:
|
||||
cmd->reply = "An unknown error has occurred during get_subscriber().";
|
||||
cmd->reply = "An unknown error has occured during get_subscriber().";
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -132,7 +132,7 @@ static void print_subscr_info(struct ctrl_cmd *cmd,
|
||||
struct hlr_subscriber *subscr)
|
||||
{
|
||||
ctrl_cmd_reply_printf(cmd,
|
||||
"\nid\t%" PRIu64
|
||||
"\nid\t%"PRIu64
|
||||
FMT_S
|
||||
FMT_S
|
||||
FMT_BOOL
|
||||
@@ -189,7 +189,7 @@ static void print_subscr_info_aud3g(struct ctrl_cmd *cmd, struct osmo_sub_auth_d
|
||||
ctrl_cmd_reply_printf(cmd,
|
||||
"\naud3g.%s\t%s"
|
||||
"\naud3g.ind_bitlen\t%u"
|
||||
"\naud3g.sqn\t%" PRIu64
|
||||
"\naud3g.sqn\t%"PRIu64
|
||||
,
|
||||
aud->u.umts.opc_is_op? "op" : "opc",
|
||||
hexdump_buf(aud->u.umts.opc),
|
||||
|
||||
530
src/db.c
530
src/db.c
@@ -18,23 +18,21 @@
|
||||
*/
|
||||
|
||||
#include <osmocom/core/utils.h>
|
||||
#include <osmocom/core/talloc.h>
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <sqlite3.h>
|
||||
#include <string.h>
|
||||
#include <malloc.h>
|
||||
|
||||
#include <osmocom/hlr/logging.h>
|
||||
#include <osmocom/hlr/db.h>
|
||||
#include "logging.h"
|
||||
#include "db.h"
|
||||
#include "db_bootstrap.h"
|
||||
|
||||
/* This constant is currently duplicated in sql/hlr.sql and must be kept in sync! */
|
||||
#define CURRENT_SCHEMA_VERSION 6
|
||||
|
||||
#define SEL_COLUMNS \
|
||||
"id," \
|
||||
"imsi," \
|
||||
"msisdn," \
|
||||
"imei," \
|
||||
"vlr_number," \
|
||||
"sgsn_number," \
|
||||
"sgsn_address," \
|
||||
@@ -44,20 +42,14 @@
|
||||
"nam_ps," \
|
||||
"lmsi," \
|
||||
"ms_purged_cs," \
|
||||
"ms_purged_ps," \
|
||||
"last_lu_seen," \
|
||||
"last_lu_seen_ps," \
|
||||
"vlr_via_proxy," \
|
||||
"sgsn_via_proxy"
|
||||
"ms_purged_ps"
|
||||
|
||||
static const char *stmt_sql[] = {
|
||||
[DB_STMT_SEL_BY_IMSI] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE imsi = ?",
|
||||
[DB_STMT_SEL_BY_MSISDN] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE msisdn = ?",
|
||||
[DB_STMT_SEL_BY_ID] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE id = ?",
|
||||
[DB_STMT_SEL_BY_IMEI] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE imei = ?",
|
||||
[DB_STMT_UPD_VLR_BY_ID] = "UPDATE subscriber SET vlr_number = $number, vlr_via_proxy = $proxy WHERE id = $subscriber_id",
|
||||
[DB_STMT_UPD_SGSN_BY_ID] = "UPDATE subscriber SET sgsn_number = $number, sgsn_via_proxy = $proxy WHERE id = $subscriber_id",
|
||||
[DB_STMT_UPD_IMEI_BY_IMSI] = "UPDATE subscriber SET imei = $imei WHERE imsi = $imsi",
|
||||
[DB_STMT_UPD_VLR_BY_ID] = "UPDATE subscriber SET vlr_number = $number WHERE id = $subscriber_id",
|
||||
[DB_STMT_UPD_SGSN_BY_ID] = "UPDATE subscriber SET sgsn_number = $number WHERE id = $subscriber_id",
|
||||
[DB_STMT_AUC_BY_IMSI] =
|
||||
"SELECT id, algo_id_2g, ki, algo_id_3g, k, op, opc, sqn, ind_bitlen"
|
||||
" FROM subscriber"
|
||||
@@ -69,10 +61,9 @@ static const char *stmt_sql[] = {
|
||||
[DB_STMT_UPD_PURGE_PS_BY_IMSI] = "UPDATE subscriber SET ms_purged_ps = $val WHERE imsi = $imsi",
|
||||
[DB_STMT_UPD_NAM_CS_BY_IMSI] = "UPDATE subscriber SET nam_cs = $val WHERE imsi = $imsi",
|
||||
[DB_STMT_UPD_NAM_PS_BY_IMSI] = "UPDATE subscriber SET nam_ps = $val WHERE imsi = $imsi",
|
||||
[DB_STMT_SUBSCR_CREATE] = "INSERT INTO subscriber (imsi, nam_cs, nam_ps) VALUES ($imsi, $nam_cs, $nam_ps)",
|
||||
[DB_STMT_SUBSCR_CREATE] = "INSERT INTO subscriber (imsi) VALUES ($imsi)",
|
||||
[DB_STMT_DEL_BY_ID] = "DELETE FROM subscriber WHERE id = $subscriber_id",
|
||||
[DB_STMT_SET_MSISDN_BY_IMSI] = "UPDATE subscriber SET msisdn = $msisdn WHERE imsi = $imsi",
|
||||
[DB_STMT_DELETE_MSISDN_BY_IMSI] = "UPDATE subscriber SET msisdn = NULL WHERE imsi = $imsi",
|
||||
[DB_STMT_AUC_2G_INSERT] =
|
||||
"INSERT INTO auc_2g (subscriber_id, algo_id_2g, ki)"
|
||||
" VALUES($subscriber_id, $algo_id_2g, $ki)",
|
||||
@@ -81,13 +72,109 @@ static const char *stmt_sql[] = {
|
||||
"INSERT INTO auc_3g (subscriber_id, algo_id_3g, k, op, opc, ind_bitlen)"
|
||||
" VALUES($subscriber_id, $algo_id_3g, $k, $op, $opc, $ind_bitlen)",
|
||||
[DB_STMT_AUC_3G_DELETE] = "DELETE FROM auc_3g WHERE subscriber_id = $subscriber_id",
|
||||
[DB_STMT_SET_LAST_LU_SEEN] = "UPDATE subscriber SET last_lu_seen = datetime($val, 'unixepoch') WHERE id = $subscriber_id",
|
||||
[DB_STMT_SET_LAST_LU_SEEN_PS] = "UPDATE subscriber SET last_lu_seen_ps = datetime($val, 'unixepoch') WHERE id = $subscriber_id",
|
||||
[DB_STMT_EXISTS_BY_IMSI] = "SELECT 1 FROM subscriber WHERE imsi = $imsi",
|
||||
[DB_STMT_EXISTS_BY_MSISDN] = "SELECT 1 FROM subscriber WHERE msisdn = $msisdn",
|
||||
[DB_STMT_IND_ADD] = "INSERT INTO ind (vlr) VALUES ($vlr)",
|
||||
[DB_STMT_IND_SELECT] = "SELECT ind FROM ind WHERE vlr = $vlr",
|
||||
[DB_STMT_IND_DEL] = "DELETE FROM ind WHERE vlr = $vlr",
|
||||
};
|
||||
|
||||
/* Dedicated talloc context for SQLite */
|
||||
static void *db_sqlite_ctx = NULL;
|
||||
/* TEMP: used for memory footprint debugging */
|
||||
static int ctr = 0;
|
||||
|
||||
/* talloc or malloc? */
|
||||
// #define ENABLE_TALLOC
|
||||
|
||||
static void *tall_xMalloc(int size)
|
||||
{
|
||||
#ifdef ENABLE_TALLOC
|
||||
void *p = talloc_size(db_sqlite_ctx, size);
|
||||
int s = talloc_total_size(p);
|
||||
#else
|
||||
void *p = malloc(size);
|
||||
int s = malloc_usable_size(p);
|
||||
#endif
|
||||
/* TEMP: used for memory footprint debugging */
|
||||
printf("[%d] %s size_req=%d vs size_act=%d ptr=%c\n",
|
||||
ctr++, __func__, size, s, p != NULL ? '+' : '!');
|
||||
return p;
|
||||
}
|
||||
|
||||
static void tall_xFree(void *ptr)
|
||||
{
|
||||
#ifdef ENABLE_TALLOC
|
||||
int s = talloc_total_size(ptr);
|
||||
talloc_free(ptr);
|
||||
#else
|
||||
int s = malloc_usable_size(ptr);
|
||||
free(ptr);
|
||||
#endif
|
||||
/* TEMP: used for memory footprint debugging */
|
||||
printf("[%d] %s size=%d\n", ctr++, __func__, s);
|
||||
}
|
||||
|
||||
static void *tall_xRealloc(void *ptr, int size)
|
||||
{
|
||||
#ifdef ENABLE_TALLOC
|
||||
void *p = talloc_realloc_fn(db_sqlite_ctx, ptr, size);
|
||||
int s = talloc_total_size(p);
|
||||
#else
|
||||
void *p = realloc(ptr, size);
|
||||
int s = malloc_usable_size(p);
|
||||
#endif
|
||||
/* TEMP: used for memory footprint debugging */
|
||||
printf("[%d] %s size_req=%d vs size_act=%d ptr=%c\n",
|
||||
ctr++, __func__, size, s, p != NULL ? '+' : '!');
|
||||
return p;
|
||||
}
|
||||
|
||||
static int tall_xSize(void *ptr)
|
||||
{
|
||||
#ifdef ENABLE_TALLOC
|
||||
int s = talloc_total_size(ptr);
|
||||
#else
|
||||
int s = malloc_usable_size(ptr);
|
||||
#endif
|
||||
/* TEMP: used for memory footprint debugging */
|
||||
printf("[%d] %s size=%d\n", ctr++, __func__, s);
|
||||
return s;
|
||||
}
|
||||
|
||||
static int tall_xRoundup(int size)
|
||||
{
|
||||
/**
|
||||
* DUMMY: return size 'as-is'...
|
||||
* AFAIK talloc doesn't round up the allocation size.
|
||||
*/
|
||||
return size;
|
||||
}
|
||||
|
||||
static int tall_xInit(void *data)
|
||||
{
|
||||
/* DUMMY: nothing to initialize */
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void tall_xShutdown(void *data)
|
||||
{
|
||||
/* DUMMY: nothing to deinitialize */
|
||||
}
|
||||
|
||||
/* Interface between SQLite and talloc memory allocator */
|
||||
static const struct sqlite3_mem_methods tall_sqlite_if = {
|
||||
/* Memory allocation function */
|
||||
.xMalloc = &tall_xMalloc,
|
||||
/* Free a prior allocation */
|
||||
.xFree = &tall_xFree,
|
||||
/* Resize an allocation */
|
||||
.xRealloc = &tall_xRealloc,
|
||||
/* Return the size of an allocation */
|
||||
.xSize = &tall_xSize,
|
||||
/* Round up request size to allocation size */
|
||||
.xRoundup = &tall_xRoundup,
|
||||
/* Initialize the memory allocator */
|
||||
.xInit = &tall_xInit,
|
||||
/* Deinitialize the memory allocator */
|
||||
.xShutdown = &tall_xShutdown,
|
||||
/* Argument to xInit() and xShutdown() */
|
||||
.pAppData = NULL,
|
||||
};
|
||||
|
||||
static void sql3_error_log_cb(void *arg, int err_code, const char *msg)
|
||||
@@ -188,25 +275,6 @@ bool db_bind_int64(sqlite3_stmt *stmt, const char *param_name, int64_t nr)
|
||||
return true;
|
||||
}
|
||||
|
||||
bool db_bind_null(sqlite3_stmt *stmt, const char *param_name)
|
||||
{
|
||||
int rc;
|
||||
int idx = param_name ? sqlite3_bind_parameter_index(stmt, param_name) : 1;
|
||||
if (idx < 1) {
|
||||
LOGP(DDB, LOGL_ERROR, "Error composing SQL, cannot bind parameter '%s'\n",
|
||||
param_name);
|
||||
return false;
|
||||
}
|
||||
rc = sqlite3_bind_null(stmt, idx);
|
||||
if (rc != SQLITE_OK) {
|
||||
LOGP(DDB, LOGL_ERROR, "Error binding NULL to SQL parameter %s: %d\n",
|
||||
param_name ? param_name : "#1", rc);
|
||||
db_remove_reset(stmt);
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
void db_close(struct db_context *dbc)
|
||||
{
|
||||
unsigned int i;
|
||||
@@ -227,340 +295,55 @@ void db_close(struct db_context *dbc)
|
||||
talloc_free(dbc);
|
||||
}
|
||||
|
||||
static int db_run_statements(struct db_context *dbc, const char **statements, size_t statements_count)
|
||||
static int db_bootstrap(struct db_context *dbc)
|
||||
{
|
||||
int rc;
|
||||
int i;
|
||||
for (i = 0; i < statements_count; i++) {
|
||||
const char *stmt_str = statements[i];
|
||||
for (i = 0; i < ARRAY_SIZE(stmt_bootstrap_sql); i++) {
|
||||
int rc;
|
||||
sqlite3_stmt *stmt;
|
||||
|
||||
rc = sqlite3_prepare_v2(dbc->db, stmt_str, -1, &stmt, NULL);
|
||||
rc = sqlite3_prepare_v2(dbc->db, stmt_bootstrap_sql[i], -1,
|
||||
&stmt, NULL);
|
||||
if (rc != SQLITE_OK) {
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n", stmt_str);
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n",
|
||||
stmt_bootstrap_sql[i]);
|
||||
return rc;
|
||||
}
|
||||
|
||||
/* execute the statement */
|
||||
rc = sqlite3_step(stmt);
|
||||
db_remove_reset(stmt);
|
||||
sqlite3_finalize(stmt);
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DDB, LOGL_ERROR, "SQL error: (%d) %s, during stmt '%s'",
|
||||
rc, sqlite3_errmsg(dbc->db), stmt_str);
|
||||
LOGP(DDB, LOGL_ERROR, "Cannot bootstrap database: SQL error: (%d) %s,"
|
||||
" during stmt '%s'",
|
||||
rc, sqlite3_errmsg(dbc->db),
|
||||
stmt_bootstrap_sql[i]);
|
||||
return rc;
|
||||
}
|
||||
}
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int db_bootstrap(struct db_context *dbc)
|
||||
{
|
||||
int rc = db_run_statements(dbc, stmt_bootstrap_sql, ARRAY_SIZE(stmt_bootstrap_sql));
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DDB, LOGL_ERROR, "Cannot bootstrap database\n");
|
||||
return rc;
|
||||
}
|
||||
return SQLITE_OK;
|
||||
}
|
||||
|
||||
/* https://www.sqlite.org/fileformat2.html#storage_of_the_sql_database_schema */
|
||||
static bool db_table_exists(struct db_context *dbc, const char *table_name)
|
||||
{
|
||||
const char *table_exists_sql = "SELECT name FROM sqlite_master WHERE type='table' AND name=?";
|
||||
sqlite3_stmt *stmt;
|
||||
int rc;
|
||||
|
||||
rc = sqlite3_prepare_v2(dbc->db, table_exists_sql, -1, &stmt, NULL);
|
||||
if (rc != SQLITE_OK) {
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n", table_exists_sql);
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!db_bind_text(stmt, NULL, table_name))
|
||||
return false;
|
||||
|
||||
rc = sqlite3_step(stmt);
|
||||
db_remove_reset(stmt);
|
||||
sqlite3_finalize(stmt);
|
||||
return (rc == SQLITE_ROW);
|
||||
}
|
||||
|
||||
/* Indicate whether the database is initialized with tables for schema version 0.
|
||||
* We only check for the 'subscriber' table here because Neels said so. */
|
||||
static bool db_is_bootstrapped_v0(struct db_context *dbc)
|
||||
{
|
||||
if (!db_table_exists(dbc, "subscriber")) {
|
||||
LOGP(DDB, LOGL_DEBUG, "Table 'subscriber' not found in database '%s'\n", dbc->fname);
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
static int
|
||||
db_upgrade_v1(struct db_context *dbc)
|
||||
{
|
||||
int rc;
|
||||
const char *statements[] = {
|
||||
"ALTER TABLE subscriber ADD COLUMN last_lu_seen TIMESTAMP default NULL",
|
||||
"PRAGMA user_version = 1",
|
||||
};
|
||||
|
||||
rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements));
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 1\n");
|
||||
return rc;
|
||||
}
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int db_upgrade_v2(struct db_context *dbc)
|
||||
{
|
||||
int rc;
|
||||
const char *statements[] = {
|
||||
"ALTER TABLE subscriber ADD COLUMN imei VARCHAR(14)",
|
||||
"PRAGMA user_version = 2",
|
||||
};
|
||||
|
||||
rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements));
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 2\n");
|
||||
return rc;
|
||||
}
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int db_upgrade_v3(struct db_context *dbc)
|
||||
{
|
||||
int rc;
|
||||
|
||||
/* A newer SQLite version would allow simply 'ATLER TABLE subscriber RENAME COLUMN hlr_number TO msc_number'.
|
||||
* This is a really expensive workaround for that in order to cover earlier SQLite versions as well:
|
||||
* Create a new table with the new column name and copy the data over (https://www.sqlite.org/faq.html#q11).
|
||||
*/
|
||||
#define SUBSCR_V3_CREATE \
|
||||
"(\n" \
|
||||
"-- OsmoHLR's DB scheme is modelled roughly after TS 23.008 version 13.3.0\n" \
|
||||
" id INTEGER PRIMARY KEY,\n" \
|
||||
" -- Chapter 2.1.1.1\n" \
|
||||
" imsi VARCHAR(15) UNIQUE NOT NULL,\n" \
|
||||
" -- Chapter 2.1.2\n" \
|
||||
" msisdn VARCHAR(15) UNIQUE,\n" \
|
||||
" -- Chapter 2.2.3: Most recent / current IMEISV\n" \
|
||||
" imeisv VARCHAR,\n" \
|
||||
" -- Chapter 2.1.9: Most recent / current IMEI\n" \
|
||||
" imei VARCHAR(14),\n" \
|
||||
" -- Chapter 2.4.5\n" \
|
||||
" vlr_number VARCHAR(15),\n" \
|
||||
" -- Chapter 2.4.6\n" \
|
||||
" msc_number VARCHAR(15),\n" \
|
||||
" -- Chapter 2.4.8.1\n" \
|
||||
" sgsn_number VARCHAR(15),\n" \
|
||||
" -- Chapter 2.13.10\n" \
|
||||
" sgsn_address VARCHAR,\n" \
|
||||
" -- Chapter 2.4.8.2\n" \
|
||||
" ggsn_number VARCHAR(15),\n" \
|
||||
" -- Chapter 2.4.9.2\n" \
|
||||
" gmlc_number VARCHAR(15),\n" \
|
||||
" -- Chapter 2.4.23\n" \
|
||||
" smsc_number VARCHAR(15),\n" \
|
||||
" -- Chapter 2.4.24\n" \
|
||||
" periodic_lu_tmr INTEGER,\n" \
|
||||
" -- Chapter 2.13.115\n" \
|
||||
" periodic_rau_tau_tmr INTEGER,\n" \
|
||||
" -- Chapter 2.1.1.2: network access mode\n" \
|
||||
" nam_cs BOOLEAN NOT NULL DEFAULT 1,\n" \
|
||||
" nam_ps BOOLEAN NOT NULL DEFAULT 1,\n" \
|
||||
" -- Chapter 2.1.8\n" \
|
||||
" lmsi INTEGER,\n" \
|
||||
\
|
||||
" -- The below purged flags might not even be stored non-volatile,\n" \
|
||||
" -- refer to TS 23.012 Chapter 3.6.1.4\n" \
|
||||
" -- Chapter 2.7.5\n" \
|
||||
" ms_purged_cs BOOLEAN NOT NULL DEFAULT 0,\n" \
|
||||
" -- Chapter 2.7.6\n" \
|
||||
" ms_purged_ps BOOLEAN NOT NULL DEFAULT 0,\n" \
|
||||
\
|
||||
" -- Timestamp of last location update seen from subscriber\n" \
|
||||
" -- The value is a string which encodes a UTC timestamp in granularity of seconds.\n" \
|
||||
" last_lu_seen TIMESTAMP default NULL\n" \
|
||||
")\n"
|
||||
|
||||
#define SUBSCR_V2_COLUMN_NAMES \
|
||||
"id," \
|
||||
"imsi," \
|
||||
"msisdn," \
|
||||
"imeisv," \
|
||||
"imei," \
|
||||
"vlr_number," \
|
||||
"hlr_number," \
|
||||
"sgsn_number," \
|
||||
"sgsn_address," \
|
||||
"ggsn_number," \
|
||||
"gmlc_number," \
|
||||
"smsc_number," \
|
||||
"periodic_lu_tmr," \
|
||||
"periodic_rau_tau_tmr," \
|
||||
"nam_cs," \
|
||||
"nam_ps," \
|
||||
"lmsi," \
|
||||
"ms_purged_cs," \
|
||||
"ms_purged_ps," \
|
||||
"last_lu_seen"
|
||||
|
||||
#define SUBSCR_V3_COLUMN_NAMES \
|
||||
"id," \
|
||||
"imsi," \
|
||||
"msisdn," \
|
||||
"imeisv," \
|
||||
"imei," \
|
||||
"vlr_number," \
|
||||
"msc_number," \
|
||||
"sgsn_number," \
|
||||
"sgsn_address," \
|
||||
"ggsn_number," \
|
||||
"gmlc_number," \
|
||||
"smsc_number," \
|
||||
"periodic_lu_tmr," \
|
||||
"periodic_rau_tau_tmr," \
|
||||
"nam_cs," \
|
||||
"nam_ps," \
|
||||
"lmsi," \
|
||||
"ms_purged_cs," \
|
||||
"ms_purged_ps," \
|
||||
"last_lu_seen"
|
||||
|
||||
const char *statements[] = {
|
||||
"BEGIN TRANSACTION",
|
||||
"CREATE TEMPORARY TABLE subscriber_backup" SUBSCR_V3_CREATE,
|
||||
"INSERT INTO subscriber_backup SELECT " SUBSCR_V2_COLUMN_NAMES " FROM subscriber",
|
||||
"DROP TABLE subscriber",
|
||||
"CREATE TABLE subscriber" SUBSCR_V3_CREATE,
|
||||
"INSERT INTO subscriber SELECT " SUBSCR_V3_COLUMN_NAMES " FROM subscriber_backup",
|
||||
"DROP TABLE subscriber_backup",
|
||||
"COMMIT",
|
||||
"PRAGMA user_version = 3",
|
||||
};
|
||||
|
||||
rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements));
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 3\n");
|
||||
return rc;
|
||||
}
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int db_upgrade_v4(struct db_context *dbc)
|
||||
{
|
||||
int rc;
|
||||
const char *statements[] = {
|
||||
"ALTER TABLE subscriber ADD COLUMN last_lu_seen_ps TIMESTAMP default NULL",
|
||||
"PRAGMA user_version = 4",
|
||||
};
|
||||
|
||||
rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements));
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 4\n");
|
||||
return rc;
|
||||
}
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int db_upgrade_v5(struct db_context *dbc)
|
||||
{
|
||||
int rc;
|
||||
const char *statements[] = {
|
||||
"ALTER TABLE subscriber ADD COLUMN vlr_via_proxy VARCHAR",
|
||||
"ALTER TABLE subscriber ADD COLUMN sgsn_via_proxy VARCHAR",
|
||||
"PRAGMA user_version = 5",
|
||||
};
|
||||
|
||||
rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements));
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 5\n");
|
||||
return rc;
|
||||
}
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int db_upgrade_v6(struct db_context *dbc)
|
||||
{
|
||||
int rc;
|
||||
const char *statements[] = {
|
||||
"CREATE TABLE ind (\n"
|
||||
" -- 3G auth IND pool to be used for this VLR\n"
|
||||
" ind INTEGER PRIMARY KEY,\n"
|
||||
" -- VLR identification, usually the GSUP source_name\n"
|
||||
" vlr TEXT NOT NULL,\n"
|
||||
" UNIQUE (vlr)\n"
|
||||
")"
|
||||
,
|
||||
"PRAGMA user_version = 6",
|
||||
};
|
||||
|
||||
rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements));
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 6\n");
|
||||
return rc;
|
||||
}
|
||||
return rc;
|
||||
}
|
||||
|
||||
typedef int (*db_upgrade_func_t)(struct db_context *dbc);
|
||||
static db_upgrade_func_t db_upgrade_path[] = {
|
||||
db_upgrade_v1,
|
||||
db_upgrade_v2,
|
||||
db_upgrade_v3,
|
||||
db_upgrade_v4,
|
||||
db_upgrade_v5,
|
||||
db_upgrade_v6,
|
||||
};
|
||||
|
||||
static int db_get_user_version(struct db_context *dbc)
|
||||
{
|
||||
const char *user_version_sql = "PRAGMA user_version";
|
||||
sqlite3_stmt *stmt;
|
||||
int version, rc;
|
||||
|
||||
rc = sqlite3_prepare_v2(dbc->db, user_version_sql, -1, &stmt, NULL);
|
||||
if (rc != SQLITE_OK) {
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n", user_version_sql);
|
||||
return -1;
|
||||
}
|
||||
rc = sqlite3_step(stmt);
|
||||
if (rc == SQLITE_ROW) {
|
||||
version = sqlite3_column_int(stmt, 0);
|
||||
} else {
|
||||
LOGP(DDB, LOGL_ERROR, "SQL statement '%s' failed: %d\n", user_version_sql, rc);
|
||||
version = -1;
|
||||
}
|
||||
|
||||
db_remove_reset(stmt);
|
||||
sqlite3_finalize(stmt);
|
||||
return version;
|
||||
}
|
||||
|
||||
struct db_context *db_open(void *ctx, const char *fname, bool enable_sqlite_logging, bool allow_upgrade)
|
||||
struct db_context *db_open(void *ctx, const char *fname, bool enable_sqlite_logging)
|
||||
{
|
||||
struct db_context *dbc = talloc_zero(ctx, struct db_context);
|
||||
unsigned int i;
|
||||
int rc;
|
||||
bool has_sqlite_config_sqllog = false;
|
||||
int version;
|
||||
|
||||
LOGP(DDB, LOGL_NOTICE, "using database: %s\n", fname);
|
||||
LOGP(DDB, LOGL_INFO, "Compiled against SQLite3 lib version %s\n", SQLITE_VERSION);
|
||||
LOGP(DDB, LOGL_INFO, "Running with SQLite3 lib version %s\n", sqlite3_libversion());
|
||||
|
||||
#ifdef SQLITE_USE_TALLOC
|
||||
db_sqlite_ctx = talloc_named_const(dbc, 0, "SQLite3");
|
||||
|
||||
/* Configure SQLite3 to use talloc memory allocator */
|
||||
rc = db_sqlite3_use_talloc(ctx);
|
||||
if (rc == SQLITE_OK) {
|
||||
LOGP(DDB, LOGL_NOTICE, "SQLite3 is configured to use talloc\n");
|
||||
} else {
|
||||
LOGP(DDB, LOGL_ERROR, "Failed to configure SQLite3 "
|
||||
"to use talloc, using default memory allocator\n");
|
||||
rc = sqlite3_config(SQLITE_CONFIG_MALLOC, &tall_sqlite_if);
|
||||
if (rc != SQLITE_OK) {
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to configure SQLite3 "
|
||||
"to use talloc, using default memory allocator\n");
|
||||
}
|
||||
#endif
|
||||
|
||||
dbc->fname = talloc_strdup(dbc, fname);
|
||||
|
||||
@@ -601,55 +384,14 @@ struct db_context *db_open(void *ctx, const char *fname, bool enable_sqlite_logg
|
||||
|
||||
char *err_msg;
|
||||
rc = sqlite3_exec(dbc->db, "PRAGMA journal_mode=WAL; PRAGMA synchonous = NORMAL;", 0, 0, &err_msg);
|
||||
if (rc != SQLITE_OK) {
|
||||
if (rc != SQLITE_OK)
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to set Write-Ahead Logging: %s\n",
|
||||
err_msg);
|
||||
sqlite3_free(err_msg);
|
||||
}
|
||||
|
||||
version = db_get_user_version(dbc);
|
||||
if (version < 0) {
|
||||
LOGP(DDB, LOGL_ERROR, "Unable to read user version number from database '%s'\n", dbc->fname);
|
||||
goto out_free;
|
||||
}
|
||||
|
||||
/* An empty database will always report version zero. */
|
||||
if (version == 0 && !db_is_bootstrapped_v0(dbc)) {
|
||||
LOGP(DDB, LOGL_NOTICE, "Missing database tables detected; Bootstrapping database '%s'\n", dbc->fname);
|
||||
rc = db_bootstrap(dbc);
|
||||
if (rc != SQLITE_OK) {
|
||||
LOGP(DDB, LOGL_ERROR, "Failed to bootstrap DB: (rc=%d) %s\n",
|
||||
rc, sqlite3_errmsg(dbc->db));
|
||||
goto out_free;
|
||||
}
|
||||
version = CURRENT_SCHEMA_VERSION;
|
||||
}
|
||||
|
||||
LOGP(DDB, LOGL_NOTICE, "Database '%s' has HLR DB schema version %d\n", dbc->fname, version);
|
||||
|
||||
for (; allow_upgrade && (version < ARRAY_SIZE(db_upgrade_path)); version++) {
|
||||
db_upgrade_func_t upgrade_func = db_upgrade_path[version];
|
||||
rc = upgrade_func(dbc);
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DDB, LOGL_ERROR, "Failed to upgrade HLR DB schema to version %d: (rc=%d) %s\n",
|
||||
version+1, rc, sqlite3_errmsg(dbc->db));
|
||||
goto out_free;
|
||||
}
|
||||
LOGP(DDB, LOGL_NOTICE, "Database '%s' has been upgraded to HLR DB schema version %d\n",
|
||||
dbc->fname, version+1);
|
||||
}
|
||||
|
||||
if (version != CURRENT_SCHEMA_VERSION) {
|
||||
if (version < CURRENT_SCHEMA_VERSION) {
|
||||
LOGP(DDB, LOGL_NOTICE, "HLR DB schema version %d is outdated\n", version);
|
||||
if (!allow_upgrade) {
|
||||
LOGP(DDB, LOGL_ERROR, "Not upgrading HLR database to schema version %d; "
|
||||
"use the --db-upgrade option to allow HLR database upgrades\n",
|
||||
CURRENT_SCHEMA_VERSION);
|
||||
}
|
||||
} else
|
||||
LOGP(DDB, LOGL_ERROR, "HLR DB schema version %d is unknown\n", version);
|
||||
|
||||
rc = db_bootstrap(dbc);
|
||||
if (rc != SQLITE_OK) {
|
||||
LOGP(DDB, LOGL_ERROR, "Failed to bootstrap DB: (rc=%d) %s\n",
|
||||
rc, sqlite3_errmsg(dbc->db));
|
||||
goto out_free;
|
||||
}
|
||||
|
||||
|
||||
@@ -3,19 +3,14 @@
|
||||
#include <stdbool.h>
|
||||
#include <sqlite3.h>
|
||||
|
||||
#include <osmocom/gsupclient/gsup_peer_id.h>
|
||||
#include <osmocom/gsm/gsup.h>
|
||||
|
||||
struct hlr;
|
||||
|
||||
enum stmt_idx {
|
||||
DB_STMT_SEL_BY_IMSI,
|
||||
DB_STMT_SEL_BY_MSISDN,
|
||||
DB_STMT_SEL_BY_ID,
|
||||
DB_STMT_SEL_BY_IMEI,
|
||||
DB_STMT_UPD_VLR_BY_ID,
|
||||
DB_STMT_UPD_SGSN_BY_ID,
|
||||
DB_STMT_UPD_IMEI_BY_IMSI,
|
||||
DB_STMT_AUC_BY_IMSI,
|
||||
DB_STMT_AUC_UPD_SQN,
|
||||
DB_STMT_UPD_PURGE_CS_BY_IMSI,
|
||||
@@ -25,18 +20,10 @@ enum stmt_idx {
|
||||
DB_STMT_SUBSCR_CREATE,
|
||||
DB_STMT_DEL_BY_ID,
|
||||
DB_STMT_SET_MSISDN_BY_IMSI,
|
||||
DB_STMT_DELETE_MSISDN_BY_IMSI,
|
||||
DB_STMT_AUC_2G_INSERT,
|
||||
DB_STMT_AUC_2G_DELETE,
|
||||
DB_STMT_AUC_3G_INSERT,
|
||||
DB_STMT_AUC_3G_DELETE,
|
||||
DB_STMT_SET_LAST_LU_SEEN,
|
||||
DB_STMT_SET_LAST_LU_SEEN_PS,
|
||||
DB_STMT_EXISTS_BY_IMSI,
|
||||
DB_STMT_EXISTS_BY_MSISDN,
|
||||
DB_STMT_IND_ADD,
|
||||
DB_STMT_IND_SELECT,
|
||||
DB_STMT_IND_DEL,
|
||||
_NUM_DB_STMT
|
||||
};
|
||||
|
||||
@@ -46,18 +33,12 @@ struct db_context {
|
||||
sqlite3_stmt *stmt[_NUM_DB_STMT];
|
||||
};
|
||||
|
||||
/* Optional feature to make SQLite3 using talloc */
|
||||
#ifdef SQLITE_USE_TALLOC
|
||||
int db_sqlite3_use_talloc(void *ctx);
|
||||
#endif
|
||||
|
||||
void db_remove_reset(sqlite3_stmt *stmt);
|
||||
bool db_bind_text(sqlite3_stmt *stmt, const char *param_name, const char *text);
|
||||
bool db_bind_int(sqlite3_stmt *stmt, const char *param_name, int nr);
|
||||
bool db_bind_int64(sqlite3_stmt *stmt, const char *param_name, int64_t nr);
|
||||
bool db_bind_null(sqlite3_stmt *stmt, const char *param_name);
|
||||
void db_close(struct db_context *dbc);
|
||||
struct db_context *db_open(void *ctx, const char *fname, bool enable_sqlite3_logging, bool allow_upgrades);
|
||||
struct db_context *db_open(void *ctx, const char *fname, bool enable_sqlite3_logging);
|
||||
|
||||
#include <osmocom/crypt/auth.h>
|
||||
|
||||
@@ -73,7 +54,7 @@ int db_update_sqn(struct db_context *dbc, int64_t id,
|
||||
int db_get_auc(struct db_context *dbc, const char *imsi,
|
||||
unsigned int auc_3g_ind, struct osmo_auth_vector *vec,
|
||||
unsigned int num_vec, const uint8_t *rand_auts,
|
||||
const uint8_t *auts, bool separation_bit);
|
||||
const uint8_t *auts);
|
||||
|
||||
#include <osmocom/core/linuxlist.h>
|
||||
#include <osmocom/gsm/protocol/gsm_23_003.h>
|
||||
@@ -86,11 +67,10 @@ struct hlr_subscriber {
|
||||
|
||||
int64_t id;
|
||||
char imsi[GSM23003_IMSI_MAX_DIGITS+1];
|
||||
char msisdn[GSM23003_MSISDN_MAX_DIGITS+1];
|
||||
char msisdn[GT_MAX_DIGITS+1];
|
||||
/* imeisv? */
|
||||
char imei[GSM23003_IMEI_NUM_DIGITS+1];
|
||||
char vlr_number[32];
|
||||
char sgsn_number[32];
|
||||
char vlr_number[GT_MAX_DIGITS+1];
|
||||
char sgsn_number[GT_MAX_DIGITS+1];
|
||||
char sgsn_address[GT_MAX_DIGITS+1];
|
||||
/* ggsn number + address */
|
||||
/* gmlc number */
|
||||
@@ -102,18 +82,8 @@ struct hlr_subscriber {
|
||||
uint32_t lmsi;
|
||||
bool ms_purged_cs;
|
||||
bool ms_purged_ps;
|
||||
time_t last_lu_seen;
|
||||
time_t last_lu_seen_ps;
|
||||
/* talloc'd IPA unit name */
|
||||
struct osmo_ipa_name vlr_via_proxy;
|
||||
struct osmo_ipa_name sgsn_via_proxy;
|
||||
};
|
||||
|
||||
/* A format string for use with strptime(3). This format string is
|
||||
* used to parse the last_lu_seen column stored in the HLR database.
|
||||
* See https://sqlite.org/lang_datefunc.html, function datetime(). */
|
||||
#define DB_LAST_LU_SEEN_FMT "%Y-%m-%d %H:%M:%S"
|
||||
|
||||
/* Like struct osmo_sub_auth_data, but the keys are in hexdump representation.
|
||||
* This is useful because SQLite requires them in hexdump format, and callers
|
||||
* like the VTY and CTRL interface also have them available as hexdump to begin
|
||||
@@ -137,20 +107,13 @@ struct sub_auth_data_str {
|
||||
} u;
|
||||
};
|
||||
|
||||
#define DB_SUBSCR_FLAG_NAM_CS (1 << 1)
|
||||
#define DB_SUBSCR_FLAG_NAM_PS (1 << 2)
|
||||
|
||||
int db_subscr_create(struct db_context *dbc, const char *imsi, uint8_t flags);
|
||||
int db_subscr_create(struct db_context *dbc, const char *imsi);
|
||||
int db_subscr_delete_by_id(struct db_context *dbc, int64_t subscr_id);
|
||||
|
||||
int db_subscr_update_msisdn_by_imsi(struct db_context *dbc, const char *imsi,
|
||||
const char *msisdn);
|
||||
int db_subscr_update_aud_by_id(struct db_context *dbc, int64_t subscr_id,
|
||||
const struct sub_auth_data_str *aud);
|
||||
int db_subscr_update_imei_by_imsi(struct db_context *dbc, const char* imsi, const char *imei);
|
||||
|
||||
int db_subscr_exists_by_imsi(struct db_context *dbc, const char *imsi);
|
||||
int db_subscr_exists_by_msisdn(struct db_context *dbc, const char *msisdn);
|
||||
|
||||
int db_subscr_get_by_imsi(struct db_context *dbc, const char *imsi,
|
||||
struct hlr_subscriber *subscr);
|
||||
@@ -158,17 +121,14 @@ int db_subscr_get_by_msisdn(struct db_context *dbc, const char *msisdn,
|
||||
struct hlr_subscriber *subscr);
|
||||
int db_subscr_get_by_id(struct db_context *dbc, int64_t id,
|
||||
struct hlr_subscriber *subscr);
|
||||
int db_subscr_get_by_imei(struct db_context *dbc, const char *imei, struct hlr_subscriber *subscr);
|
||||
int db_subscr_nam(struct db_context *dbc, const char *imsi, bool nam_val, bool is_ps);
|
||||
int db_subscr_lu(struct db_context *dbc, int64_t subscr_id,
|
||||
const struct osmo_ipa_name *vlr_name, bool is_ps,
|
||||
const struct osmo_ipa_name *via_proxy);
|
||||
const char *vlr_or_sgsn_number, bool is_ps);
|
||||
|
||||
int db_subscr_purge(struct db_context *dbc, const char *by_imsi,
|
||||
bool purge_val, bool is_ps);
|
||||
|
||||
int db_ind(struct db_context *dbc, const struct osmo_gsup_peer_id *vlr, unsigned int *ind);
|
||||
int db_ind_del(struct db_context *dbc, const struct osmo_gsup_peer_id *vlr);
|
||||
int hlr_subscr_nam(struct hlr *hlr, struct hlr_subscriber *subscr, bool nam_val, bool is_ps);
|
||||
|
||||
/*! Call sqlite3_column_text() and copy result to a char[].
|
||||
* \param[out] buf A char[] used as sizeof() arg(!) and osmo_strlcpy() target.
|
||||
@@ -180,14 +140,3 @@ int db_ind_del(struct db_context *dbc, const struct osmo_gsup_peer_id *vlr);
|
||||
const char *_txt = (const char *) sqlite3_column_text(stmt, idx); \
|
||||
osmo_strlcpy(buf, _txt, sizeof(buf)); \
|
||||
} while (0)
|
||||
|
||||
/*! Call sqlite3_column_text() and copy result to a struct osmo_ipa_name.
|
||||
* \param[out] ipa_name A struct osmo_ipa_name* to write to.
|
||||
* \param[in] stmt An sqlite3_stmt*.
|
||||
* \param[in] idx Index in stmt's returned columns.
|
||||
*/
|
||||
#define copy_sqlite3_text_to_ipa_name(ipa_name, stmt, idx) \
|
||||
do { \
|
||||
const char *_txt = (const char *) sqlite3_column_text(stmt, idx); \
|
||||
osmo_ipa_name_set_str(ipa_name, _txt); \
|
||||
} while (0)
|
||||
108
src/db_auc.c
108
src/db_auc.c
@@ -26,10 +26,10 @@
|
||||
|
||||
#include <sqlite3.h>
|
||||
|
||||
#include <osmocom/hlr/logging.h>
|
||||
#include <osmocom/hlr/db.h>
|
||||
#include <osmocom/hlr/auc.h>
|
||||
#include <osmocom/hlr/rand.h>
|
||||
#include "logging.h"
|
||||
#include "db.h"
|
||||
#include "auc.h"
|
||||
#include "rand.h"
|
||||
|
||||
#define LOGAUC(imsi, level, fmt, args ...) LOGP(DAUC, level, "IMSI='%s': " fmt, imsi, ## args)
|
||||
|
||||
@@ -49,7 +49,7 @@ int db_update_sqn(struct db_context *dbc, int64_t subscr_id, uint64_t new_sqn)
|
||||
/* execute the statement */
|
||||
rc = sqlite3_step(stmt);
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot update SQN for subscriber ID=%" PRId64
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot update SQN for subscriber ID=%"PRId64
|
||||
": SQL error: (%d) %s\n",
|
||||
subscr_id, rc, sqlite3_errmsg(dbc->db));
|
||||
ret = -EIO;
|
||||
@@ -59,11 +59,11 @@ int db_update_sqn(struct db_context *dbc, int64_t subscr_id, uint64_t new_sqn)
|
||||
/* verify execution result */
|
||||
rc = sqlite3_changes(dbc->db);
|
||||
if (!rc) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot update SQN for subscriber ID=%" PRId64
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot update SQN for subscriber ID=%"PRId64
|
||||
": no auc_3g entry for such subscriber\n", subscr_id);
|
||||
ret = -ENOENT;
|
||||
} else if (rc != 1) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Update SQN for subscriber ID=%" PRId64
|
||||
LOGP(DAUC, LOGL_ERROR, "Update SQN for subscriber ID=%"PRId64
|
||||
": SQL modified %d rows (expected 1)\n", subscr_id, rc);
|
||||
ret = -EIO;
|
||||
}
|
||||
@@ -73,32 +73,6 @@ out:
|
||||
return ret;
|
||||
}
|
||||
|
||||
/* hexparse a specific column of a sqlite prepared statement into dst (with length check)
|
||||
* returns 0 for success, -EIO on error */
|
||||
static int hexparse_stmt(uint8_t *dst, size_t dst_len, sqlite3_stmt *stmt, int col, const char *col_name,
|
||||
const char *imsi)
|
||||
{
|
||||
const uint8_t *text;
|
||||
size_t col_len;
|
||||
|
||||
/* Bytes are stored as hex strings in database, hence divide length by two */
|
||||
col_len = sqlite3_column_bytes(stmt, col) / 2;
|
||||
|
||||
if (col_len != dst_len) {
|
||||
LOGAUC(imsi, LOGL_ERROR, "Error reading %s, expected length %lu but has length %lu\n", col_name,
|
||||
dst_len, col_len);
|
||||
return -EIO;
|
||||
}
|
||||
|
||||
text = sqlite3_column_text(stmt, col);
|
||||
if (!text) {
|
||||
LOGAUC(imsi, LOGL_ERROR, "Error reading %s\n", col_name);
|
||||
return -EIO;
|
||||
}
|
||||
osmo_hexparse((void *)text, dst, dst_len);
|
||||
return 0;
|
||||
}
|
||||
|
||||
/* obtain the authentication data for a given imsi
|
||||
* returns 0 for success, negative value on error:
|
||||
* -ENOENT if the IMSI is not known, -ENOKEY if the IMSI is known but has no auth data,
|
||||
@@ -139,34 +113,49 @@ int db_get_auth_data(struct db_context *dbc, const char *imsi,
|
||||
/* obtain result values using sqlite3_column_*() */
|
||||
if (sqlite3_column_type(stmt, 1) == SQLITE_INTEGER) {
|
||||
/* we do have some 2G authentication data */
|
||||
if (hexparse_stmt(aud2g->u.gsm.ki, sizeof(aud2g->u.gsm.ki), stmt, 2, "Ki", imsi))
|
||||
goto end_2g;
|
||||
const uint8_t *ki;
|
||||
|
||||
aud2g->algo = sqlite3_column_int(stmt, 1);
|
||||
ki = sqlite3_column_text(stmt, 2);
|
||||
#if 0
|
||||
if (sqlite3_column_bytes(stmt, 2) != sizeof(aud2g->u.gsm.ki)) {
|
||||
LOGAUC(imsi, LOGL_ERROR, "Error reading Ki: %d\n", rc);
|
||||
goto end_2g;
|
||||
}
|
||||
#endif
|
||||
osmo_hexparse((void*)ki, (void*)&aud2g->u.gsm.ki, sizeof(aud2g->u.gsm.ki));
|
||||
aud2g->type = OSMO_AUTH_TYPE_GSM;
|
||||
} else
|
||||
LOGAUC(imsi, LOGL_DEBUG, "No 2G Auth Data\n");
|
||||
end_2g:
|
||||
//end_2g:
|
||||
if (sqlite3_column_type(stmt, 3) == SQLITE_INTEGER) {
|
||||
/* we do have some 3G authentication data */
|
||||
if (hexparse_stmt(aud3g->u.umts.k, sizeof(aud3g->u.umts.k), stmt, 4, "K", imsi)) {
|
||||
const uint8_t *k, *op, *opc;
|
||||
|
||||
aud3g->algo = sqlite3_column_int(stmt, 3);
|
||||
k = sqlite3_column_text(stmt, 4);
|
||||
if (!k) {
|
||||
LOGAUC(imsi, LOGL_ERROR, "Error reading K: %d\n", rc);
|
||||
ret = -EIO;
|
||||
goto out;
|
||||
}
|
||||
aud3g->algo = sqlite3_column_int(stmt, 3);
|
||||
|
||||
osmo_hexparse((void*)k, (void*)&aud3g->u.umts.k, sizeof(aud3g->u.umts.k));
|
||||
/* UMTS Subscribers can have either OP or OPC */
|
||||
if (sqlite3_column_text(stmt, 5)) {
|
||||
if (hexparse_stmt(aud3g->u.umts.opc, sizeof(aud3g->u.umts.opc), stmt, 5, "OP", imsi)) {
|
||||
ret = -EIO;
|
||||
goto out;
|
||||
}
|
||||
aud3g->u.umts.opc_is_op = 1;
|
||||
} else {
|
||||
if (hexparse_stmt(aud3g->u.umts.opc, sizeof(aud3g->u.umts.opc), stmt, 6, "OPC", imsi)) {
|
||||
op = sqlite3_column_text(stmt, 5);
|
||||
if (!op) {
|
||||
opc = sqlite3_column_text(stmt, 6);
|
||||
if (!opc) {
|
||||
LOGAUC(imsi, LOGL_ERROR, "Error reading OPC: %d\n", rc);
|
||||
ret = -EIO;
|
||||
goto out;
|
||||
}
|
||||
osmo_hexparse((void*)opc, (void*)&aud3g->u.umts.opc,
|
||||
sizeof(aud3g->u.umts.opc));
|
||||
aud3g->u.umts.opc_is_op = 0;
|
||||
} else {
|
||||
osmo_hexparse((void*)op, (void*)&aud3g->u.umts.opc,
|
||||
sizeof(aud3g->u.umts.opc));
|
||||
aud3g->u.umts.opc_is_op = 1;
|
||||
}
|
||||
aud3g->u.umts.sqn = sqlite3_column_int64(stmt, 7);
|
||||
aud3g->u.umts.ind_bitlen = sqlite3_column_int(stmt, 8);
|
||||
@@ -189,7 +178,7 @@ out:
|
||||
int db_get_auc(struct db_context *dbc, const char *imsi,
|
||||
unsigned int auc_3g_ind, struct osmo_auth_vector *vec,
|
||||
unsigned int num_vec, const uint8_t *rand_auts,
|
||||
const uint8_t *auts, bool separation_bit)
|
||||
const uint8_t *auts)
|
||||
{
|
||||
struct osmo_sub_auth_data aud2g, aud3g;
|
||||
int64_t subscr_id;
|
||||
@@ -200,22 +189,15 @@ int db_get_auc(struct db_context *dbc, const char *imsi,
|
||||
if (rc)
|
||||
return rc;
|
||||
|
||||
/* modulo by the IND bitlen value range. For example, ind_bitlen == 5 would modulo 32:
|
||||
* 1 << 5 == 0b0100000 == 32
|
||||
* - 1 == 0b0011111 == bitmask of 5 lowest bits
|
||||
* x &= 0b0011111 == modulo 32
|
||||
* Why do this? osmo-hlr cannot possibly choose individual VLR INDs always matching all subscribers' IND_bitlen,
|
||||
* which might vary wildly. Instead, let hlr.c pass in an arbitrarily high number here, and the modulo does a
|
||||
* round-robin if the IND pools that this subscriber has available. */
|
||||
auc_3g_ind &= (1U << aud3g.u.umts.ind_bitlen) - 1;
|
||||
aud3g.u.umts.ind = auc_3g_ind;
|
||||
|
||||
/* the first bit (bit0) cannot be used as AMF anymore, but has been
|
||||
* re-appropriated as the separation bit. See 3GPP TS 33.102 Annex H
|
||||
* together with 3GPP TS 33.401 / 33.402 / 33.501 */
|
||||
aud3g.u.umts.amf[0] = aud3g.u.umts.amf[0] & 0x7f;
|
||||
if (separation_bit)
|
||||
aud3g.u.umts.amf[0] |= 0x80;
|
||||
if (aud3g.type == OSMO_AUTH_TYPE_UMTS
|
||||
&& aud3g.u.umts.ind >= (1U << aud3g.u.umts.ind_bitlen)) {
|
||||
LOGAUC(imsi, LOGL_NOTICE, "3G auth: SQN's IND bitlen %u is"
|
||||
" too small to hold an index of %u. Truncating. This"
|
||||
" may cause numerous additional AUTS resyncing.\n",
|
||||
aud3g.u.umts.ind_bitlen, aud3g.u.umts.ind);
|
||||
aud3g.u.umts.ind &= (1U << aud3g.u.umts.ind_bitlen) - 1;
|
||||
}
|
||||
|
||||
LOGAUC(imsi, LOGL_DEBUG, "Calling to generate %u vectors\n", num_vec);
|
||||
rc = auc_compute_vectors(vec, num_vec, &aud2g, &aud3g, rand_auts, auts);
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Input to this are sql/*.sql files.
|
||||
# Input to this is sql/hlr.sql.
|
||||
#
|
||||
# We want each SQL statement line wrapped in "...\n", and each end (";") to
|
||||
# become a comma:
|
||||
@@ -1,86 +0,0 @@
|
||||
/*
|
||||
* libtalloc based memory allocator for SQLite3.
|
||||
*
|
||||
* (C) 2019 by Vadim Yanitskiy <axilirator@gmail.com>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#include <sqlite3.h>
|
||||
#include <talloc.h>
|
||||
#include <errno.h>
|
||||
|
||||
/* Dedicated talloc context for SQLite */
|
||||
static void *db_sqlite_ctx = NULL;
|
||||
|
||||
static void *tall_xMalloc(int size)
|
||||
{
|
||||
return talloc_size(db_sqlite_ctx, size);
|
||||
}
|
||||
|
||||
static void tall_xFree(void *ptr)
|
||||
{
|
||||
talloc_free(ptr);
|
||||
}
|
||||
|
||||
static void *tall_xRealloc(void *ptr, int size)
|
||||
{
|
||||
return talloc_realloc_fn(db_sqlite_ctx, ptr, size);
|
||||
}
|
||||
|
||||
static int tall_xSize(void *ptr)
|
||||
{
|
||||
return talloc_total_size(ptr);
|
||||
}
|
||||
|
||||
/* DUMMY: talloc doesn't round up the allocation size */
|
||||
static int tall_xRoundup(int size) { return size; }
|
||||
|
||||
/* DUMMY: nothing to initialize */
|
||||
static int tall_xInit(void *data) { return 0; }
|
||||
|
||||
/* DUMMY: nothing to deinitialize */
|
||||
static void tall_xShutdown(void *data) { }
|
||||
|
||||
/* Interface between SQLite and talloc memory allocator */
|
||||
static const struct sqlite3_mem_methods tall_sqlite_if = {
|
||||
/* Memory allocation function */
|
||||
.xMalloc = &tall_xMalloc,
|
||||
/* Free a prior allocation */
|
||||
.xFree = &tall_xFree,
|
||||
/* Resize an allocation */
|
||||
.xRealloc = &tall_xRealloc,
|
||||
/* Return the size of an allocation */
|
||||
.xSize = &tall_xSize,
|
||||
/* Round up request size to allocation size */
|
||||
.xRoundup = &tall_xRoundup,
|
||||
/* Initialize the memory allocator */
|
||||
.xInit = &tall_xInit,
|
||||
/* Deinitialize the memory allocator */
|
||||
.xShutdown = &tall_xShutdown,
|
||||
/* Argument to xInit() and xShutdown() */
|
||||
.pAppData = NULL,
|
||||
};
|
||||
|
||||
int db_sqlite3_use_talloc(void *ctx)
|
||||
{
|
||||
if (db_sqlite_ctx != NULL)
|
||||
return -EEXIST;
|
||||
|
||||
db_sqlite_ctx = talloc_named_const(ctx, 0, "SQLite3");
|
||||
return sqlite3_config(SQLITE_CONFIG_MALLOC, &tall_sqlite_if);
|
||||
}
|
||||
416
src/db_hlr.c
416
src/db_hlr.c
@@ -17,37 +17,30 @@
|
||||
*
|
||||
*/
|
||||
|
||||
#define _POSIX_C_SOURCE 200809L /* for strptime(3) */
|
||||
/* These are needed as well due to the above _POSIX_C_SOURCE definition: */
|
||||
#define _DEFAULT_SOURCE /* for struct timezone */
|
||||
#define _XOPEN_SOURCE /* for clockid_t */
|
||||
|
||||
#include <string.h>
|
||||
#include <errno.h>
|
||||
#include <inttypes.h>
|
||||
#include <time.h>
|
||||
|
||||
#include <osmocom/core/utils.h>
|
||||
#include <osmocom/core/timer.h>
|
||||
#include <osmocom/crypt/auth.h>
|
||||
#include <osmocom/gsm/gsm23003.h>
|
||||
|
||||
#include <sqlite3.h>
|
||||
|
||||
#include <osmocom/hlr/logging.h>
|
||||
#include <osmocom/hlr/hlr.h>
|
||||
#include <osmocom/hlr/db.h>
|
||||
#include <osmocom/gsupclient/gsup_peer_id.h>
|
||||
#include "logging.h"
|
||||
#include "hlr.h"
|
||||
#include "db.h"
|
||||
#include "gsup_server.h"
|
||||
#include "luop.h"
|
||||
|
||||
#define LOGHLR(imsi, level, fmt, args ...) LOGP(DAUC, level, "IMSI='%s': " fmt, imsi, ## args)
|
||||
|
||||
/*! Add new subscriber record to the HLR database.
|
||||
* \param[in,out] dbc database context.
|
||||
* \param[in] imsi ASCII string of IMSI digits, is validated.
|
||||
* \param[in] flags Bitmask of DB_SUBSCR_FLAG_*.
|
||||
* \returns 0 on success, -EINVAL on invalid IMSI, -EIO on database error.
|
||||
*/
|
||||
int db_subscr_create(struct db_context *dbc, const char *imsi, uint8_t flags)
|
||||
int db_subscr_create(struct db_context *dbc, const char *imsi)
|
||||
{
|
||||
sqlite3_stmt *stmt;
|
||||
int rc;
|
||||
@@ -62,10 +55,6 @@ int db_subscr_create(struct db_context *dbc, const char *imsi, uint8_t flags)
|
||||
|
||||
if (!db_bind_text(stmt, "$imsi", imsi))
|
||||
return -EIO;
|
||||
if (!db_bind_int(stmt, "$nam_cs", (flags & DB_SUBSCR_FLAG_NAM_CS) != 0))
|
||||
return -EIO;
|
||||
if (!db_bind_int(stmt, "$nam_ps", (flags & DB_SUBSCR_FLAG_NAM_PS) != 0))
|
||||
return -EIO;
|
||||
|
||||
/* execute the statement */
|
||||
rc = sqlite3_step(stmt);
|
||||
@@ -103,7 +92,7 @@ int db_subscr_delete_by_id(struct db_context *dbc, int64_t subscr_id)
|
||||
rc = sqlite3_step(stmt);
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DAUC, LOGL_ERROR,
|
||||
"Cannot delete subscriber ID=%" PRId64 ": SQL error: (%d) %s\n",
|
||||
"Cannot delete subscriber ID=%"PRId64": SQL error: (%d) %s\n",
|
||||
subscr_id, rc, sqlite3_errmsg(dbc->db));
|
||||
db_remove_reset(stmt);
|
||||
return -EIO;
|
||||
@@ -112,11 +101,11 @@ int db_subscr_delete_by_id(struct db_context *dbc, int64_t subscr_id)
|
||||
/* verify execution result */
|
||||
rc = sqlite3_changes(dbc->db);
|
||||
if (!rc) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot delete: no such subscriber: ID=%" PRId64 "\n",
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot delete: no such subscriber: ID=%"PRId64"\n",
|
||||
subscr_id);
|
||||
ret = -ENOENT;
|
||||
} else if (rc != 1) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Delete subscriber ID=%" PRId64
|
||||
LOGP(DAUC, LOGL_ERROR, "Delete subscriber ID=%"PRId64
|
||||
": SQL modified %d rows (expected 1)\n", subscr_id, rc);
|
||||
ret = -EIO;
|
||||
}
|
||||
@@ -146,8 +135,8 @@ int db_subscr_delete_by_id(struct db_context *dbc, int64_t subscr_id)
|
||||
|
||||
/*! Set a subscriber's MSISDN in the HLR database.
|
||||
* \param[in,out] dbc database context.
|
||||
* \param[in] imsi ASCII string of IMSI digits
|
||||
* \param[in] msisdn ASCII string of MSISDN digits, or NULL to remove the MSISDN.
|
||||
* \param[in] imsi ASCII string of IMSI digits.
|
||||
* \param[in] msisdn ASCII string of MSISDN digits.
|
||||
* \returns 0 on success, -EINVAL in case of invalid MSISDN string, -EIO on
|
||||
* database failure, -ENOENT if no such subscriber exists.
|
||||
*/
|
||||
@@ -157,22 +146,19 @@ int db_subscr_update_msisdn_by_imsi(struct db_context *dbc, const char *imsi,
|
||||
int rc;
|
||||
int ret = 0;
|
||||
|
||||
if (msisdn && !osmo_msisdn_str_valid(msisdn)) {
|
||||
if (!osmo_msisdn_str_valid(msisdn)) {
|
||||
LOGHLR(imsi, LOGL_ERROR,
|
||||
"Cannot update subscriber: invalid MSISDN: '%s'\n",
|
||||
msisdn);
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
sqlite3_stmt *stmt = dbc->stmt[
|
||||
msisdn ? DB_STMT_SET_MSISDN_BY_IMSI : DB_STMT_DELETE_MSISDN_BY_IMSI];
|
||||
sqlite3_stmt *stmt = dbc->stmt[DB_STMT_SET_MSISDN_BY_IMSI];
|
||||
|
||||
if (!db_bind_text(stmt, "$imsi", imsi))
|
||||
return -EIO;
|
||||
if (msisdn) {
|
||||
if (!db_bind_text(stmt, "$msisdn", msisdn))
|
||||
return -EIO;
|
||||
}
|
||||
if (!db_bind_text(stmt, "$msisdn", msisdn))
|
||||
return -EIO;
|
||||
|
||||
/* execute the statement */
|
||||
rc = sqlite3_step(stmt);
|
||||
@@ -326,7 +312,7 @@ int db_subscr_update_aud_by_id(struct db_context *dbc, int64_t subscr_id,
|
||||
* empty, and no entry is not an error then.*/
|
||||
ret = -ENOENT;
|
||||
else if (rc != 1) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Delete subscriber ID=%" PRId64
|
||||
LOGP(DAUC, LOGL_ERROR, "Delete subscriber ID=%"PRId64
|
||||
" from %s: SQL modified %d rows (expected 1)\n",
|
||||
subscr_id, label, rc);
|
||||
ret = -EIO;
|
||||
@@ -391,77 +377,6 @@ out:
|
||||
return ret;
|
||||
}
|
||||
|
||||
/*! Set a subscriber's IMEI in the HLR database.
|
||||
* \param[in,out] dbc database context.
|
||||
* \param[in] imsi ASCII string of IMSI digits
|
||||
* \param[in] imei ASCII string of identifier digits, or NULL to remove the IMEI.
|
||||
* \returns 0 on success, -ENOENT when the given subscriber does not exist,
|
||||
* -EIO on database errors.
|
||||
*/
|
||||
int db_subscr_update_imei_by_imsi(struct db_context *dbc, const char* imsi, const char *imei)
|
||||
{
|
||||
int rc, ret = 0;
|
||||
sqlite3_stmt *stmt = dbc->stmt[DB_STMT_UPD_IMEI_BY_IMSI];
|
||||
|
||||
if (imei && !osmo_imei_str_valid(imei, false)) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot update subscriber IMSI='%s': invalid IMEI: '%s'\n", imsi, imei);
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (!db_bind_text(stmt, "$imsi", imsi))
|
||||
return -EIO;
|
||||
if (imei && !db_bind_text(stmt, "$imei", imei))
|
||||
return -EIO;
|
||||
|
||||
/* execute the statement */
|
||||
rc = sqlite3_step(stmt);
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Update IMEI for subscriber IMSI='%s': SQL Error: %s\n", imsi,
|
||||
sqlite3_errmsg(dbc->db));
|
||||
ret = -EIO;
|
||||
goto out;
|
||||
}
|
||||
|
||||
/* verify execution result */
|
||||
rc = sqlite3_changes(dbc->db);
|
||||
if (!rc) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot update IMEI for subscriber IMSI='%s': no such subscriber\n", imsi);
|
||||
ret = -ENOENT;
|
||||
} else if (rc != 1) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Update IMEI for subscriber IMSI='%s': SQL modified %d rows (expected 1)\n",
|
||||
imsi, rc);
|
||||
ret = -EIO;
|
||||
}
|
||||
|
||||
out:
|
||||
db_remove_reset(stmt);
|
||||
return ret;
|
||||
}
|
||||
|
||||
static void parse_last_lu_seen(time_t *dst, const char *last_lu_seen_str, const char *imsi, const char *label)
|
||||
{
|
||||
struct tm tm = {0};
|
||||
time_t val;
|
||||
if (!last_lu_seen_str || last_lu_seen_str[0] == '\0')
|
||||
return;
|
||||
|
||||
if (strptime(last_lu_seen_str, DB_LAST_LU_SEEN_FMT, &tm) == NULL) {
|
||||
LOGP(DAUC, LOGL_ERROR, "IMSI-%s: Last LU Seen %s: Cannot parse timestamp '%s'\n",
|
||||
imsi, label, last_lu_seen_str);
|
||||
return;
|
||||
}
|
||||
|
||||
errno = 0;
|
||||
val = mktime(&tm);
|
||||
if (val == -1) {
|
||||
LOGP(DAUC, LOGL_ERROR, "IMSI-%s: Last LU Seen %s: Cannot convert timestamp '%s' to time_t: %s\n",
|
||||
imsi, label, last_lu_seen_str, strerror(errno));
|
||||
val = 0;
|
||||
}
|
||||
|
||||
*dst = val;
|
||||
}
|
||||
|
||||
/* Common code for db_subscr_get_by_*() functions. */
|
||||
static int db_sel(struct db_context *dbc, sqlite3_stmt *stmt, struct hlr_subscriber *subscr,
|
||||
const char **err)
|
||||
@@ -489,24 +404,17 @@ static int db_sel(struct db_context *dbc, sqlite3_stmt *stmt, struct hlr_subscri
|
||||
subscr->id = sqlite3_column_int64(stmt, 0);
|
||||
copy_sqlite3_text_to_buf(subscr->imsi, stmt, 1);
|
||||
copy_sqlite3_text_to_buf(subscr->msisdn, stmt, 2);
|
||||
copy_sqlite3_text_to_buf(subscr->imei, stmt, 3);
|
||||
/* FIXME: These should all be BLOBs as they might contain NUL */
|
||||
copy_sqlite3_text_to_buf(subscr->vlr_number, stmt, 4);
|
||||
copy_sqlite3_text_to_buf(subscr->sgsn_number, stmt, 5);
|
||||
copy_sqlite3_text_to_buf(subscr->sgsn_address, stmt, 6);
|
||||
subscr->periodic_lu_timer = sqlite3_column_int(stmt, 7);
|
||||
subscr->periodic_rau_tau_timer = sqlite3_column_int(stmt, 8);
|
||||
subscr->nam_cs = sqlite3_column_int(stmt, 9);
|
||||
subscr->nam_ps = sqlite3_column_int(stmt, 10);
|
||||
subscr->lmsi = sqlite3_column_int(stmt, 11);
|
||||
subscr->ms_purged_cs = sqlite3_column_int(stmt, 12);
|
||||
subscr->ms_purged_ps = sqlite3_column_int(stmt, 13);
|
||||
parse_last_lu_seen(&subscr->last_lu_seen, (const char *)sqlite3_column_text(stmt, 14),
|
||||
subscr->imsi, "CS");
|
||||
parse_last_lu_seen(&subscr->last_lu_seen_ps, (const char *)sqlite3_column_text(stmt, 15),
|
||||
subscr->imsi, "PS");
|
||||
copy_sqlite3_text_to_ipa_name(&subscr->vlr_via_proxy, stmt, 16);
|
||||
copy_sqlite3_text_to_ipa_name(&subscr->sgsn_via_proxy, stmt, 17);
|
||||
copy_sqlite3_text_to_buf(subscr->vlr_number, stmt, 3);
|
||||
copy_sqlite3_text_to_buf(subscr->sgsn_number, stmt, 4);
|
||||
copy_sqlite3_text_to_buf(subscr->sgsn_address, stmt, 5);
|
||||
subscr->periodic_lu_timer = sqlite3_column_int(stmt, 6);
|
||||
subscr->periodic_rau_tau_timer = sqlite3_column_int(stmt, 7);
|
||||
subscr->nam_cs = sqlite3_column_int(stmt, 8);
|
||||
subscr->nam_ps = sqlite3_column_int(stmt, 9);
|
||||
subscr->lmsi = sqlite3_column_int(stmt, 10);
|
||||
subscr->ms_purged_cs = sqlite3_column_int(stmt, 11);
|
||||
subscr->ms_purged_ps = sqlite3_column_int(stmt, 12);
|
||||
|
||||
out:
|
||||
db_remove_reset(stmt);
|
||||
@@ -525,31 +433,6 @@ out:
|
||||
return ret;
|
||||
}
|
||||
|
||||
/*! Check if a subscriber exists in the HLR database.
|
||||
* \param[in, out] dbc database context.
|
||||
* \param[in] imsi ASCII string of IMSI digits.
|
||||
* \returns 0 if it exists, -ENOENT if it does not exist, -EIO on database error.
|
||||
*/
|
||||
int db_subscr_exists_by_imsi(struct db_context *dbc, const char *imsi) {
|
||||
sqlite3_stmt *stmt = dbc->stmt[DB_STMT_EXISTS_BY_IMSI];
|
||||
const char *err;
|
||||
int rc;
|
||||
|
||||
if (!db_bind_text(stmt, NULL, imsi))
|
||||
return -EIO;
|
||||
|
||||
rc = sqlite3_step(stmt);
|
||||
db_remove_reset(stmt);
|
||||
if (rc == SQLITE_ROW)
|
||||
return 0; /* exists */
|
||||
if (rc == SQLITE_DONE)
|
||||
return -ENOENT; /* does not exist */
|
||||
|
||||
err = sqlite3_errmsg(dbc->db);
|
||||
LOGP(DAUC, LOGL_ERROR, "Failed to check if subscriber exists by IMSI='%s': %s\n", imsi, err);
|
||||
return rc;
|
||||
}
|
||||
|
||||
/*! Retrieve subscriber data from the HLR database.
|
||||
* \param[in,out] dbc database context.
|
||||
* \param[in] imsi ASCII string of IMSI digits.
|
||||
@@ -568,39 +451,12 @@ int db_subscr_get_by_imsi(struct db_context *dbc, const char *imsi,
|
||||
return -EIO;
|
||||
|
||||
rc = db_sel(dbc, stmt, subscr, &err);
|
||||
if (rc && rc != -ENOENT)
|
||||
if (rc)
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot read subscriber from db: IMSI='%s': %s\n",
|
||||
imsi, err);
|
||||
return rc;
|
||||
}
|
||||
|
||||
/*! Check if a subscriber exists in the HLR database.
|
||||
* \param[in, out] dbc database context.
|
||||
* \param[in] msisdn ASCII string of MSISDN digits.
|
||||
* \returns 0 if it exists, -ENOENT if it does not exist, -EIO on database error.
|
||||
*/
|
||||
int db_subscr_exists_by_msisdn(struct db_context *dbc, const char *msisdn)
|
||||
{
|
||||
sqlite3_stmt *stmt = dbc->stmt[DB_STMT_EXISTS_BY_MSISDN];
|
||||
const char *err;
|
||||
int rc;
|
||||
|
||||
if (!db_bind_text(stmt, NULL, msisdn))
|
||||
return -EIO;
|
||||
|
||||
rc = sqlite3_step(stmt);
|
||||
db_remove_reset(stmt);
|
||||
if (rc == SQLITE_ROW)
|
||||
return 0; /* exists */
|
||||
if (rc == SQLITE_DONE)
|
||||
return -ENOENT; /* does not exist */
|
||||
|
||||
err = sqlite3_errmsg(dbc->db);
|
||||
LOGP(DAUC, LOGL_ERROR, "Failed to check if subscriber exists "
|
||||
"by MSISDN='%s': %s\n", msisdn, err);
|
||||
return rc;
|
||||
}
|
||||
|
||||
/*! Retrieve subscriber data from the HLR database.
|
||||
* \param[in,out] dbc database context.
|
||||
* \param[in] msisdn ASCII string of MSISDN digits.
|
||||
@@ -619,7 +475,7 @@ int db_subscr_get_by_msisdn(struct db_context *dbc, const char *msisdn,
|
||||
return -EIO;
|
||||
|
||||
rc = db_sel(dbc, stmt, subscr, &err);
|
||||
if (rc && rc != -ENOENT)
|
||||
if (rc)
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot read subscriber from db: MSISDN='%s': %s\n",
|
||||
msisdn, err);
|
||||
return rc;
|
||||
@@ -643,34 +499,12 @@ int db_subscr_get_by_id(struct db_context *dbc, int64_t id,
|
||||
return -EIO;
|
||||
|
||||
rc = db_sel(dbc, stmt, subscr, &err);
|
||||
if (rc && rc != -ENOENT)
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot read subscriber from db: ID=%" PRId64 ": %s\n",
|
||||
if (rc)
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot read subscriber from db: ID=%"PRId64": %s\n",
|
||||
id, err);
|
||||
return rc;
|
||||
}
|
||||
|
||||
/*! Retrieve subscriber data from the HLR database.
|
||||
* \param[in,out] dbc database context.
|
||||
* \param[in] imei ASCII string of identifier digits
|
||||
* \param[out] subscr place retrieved data in this struct.
|
||||
* \returns 0 on success, -ENOENT if no such subscriber was found, -EIO on
|
||||
* database error.
|
||||
*/
|
||||
int db_subscr_get_by_imei(struct db_context *dbc, const char *imei, struct hlr_subscriber *subscr)
|
||||
{
|
||||
sqlite3_stmt *stmt = dbc->stmt[DB_STMT_SEL_BY_IMEI];
|
||||
const char *err;
|
||||
int rc;
|
||||
|
||||
if (!db_bind_text(stmt, NULL, imei))
|
||||
return -EIO;
|
||||
|
||||
rc = db_sel(dbc, stmt, subscr, &err);
|
||||
if (rc && rc != -ENOENT)
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot read subscriber from db: IMEI=%s: %s\n", imei, err);
|
||||
return rc;
|
||||
}
|
||||
|
||||
/*! You should use hlr_subscr_nam() instead; enable or disable PS or CS for a
|
||||
* subscriber without notifying GSUP clients.
|
||||
* \param[in,out] dbc database context.
|
||||
@@ -736,12 +570,10 @@ out:
|
||||
* -EIO on database errors.
|
||||
*/
|
||||
int db_subscr_lu(struct db_context *dbc, int64_t subscr_id,
|
||||
const struct osmo_ipa_name *vlr_name, bool is_ps,
|
||||
const struct osmo_ipa_name *via_proxy)
|
||||
const char *vlr_or_sgsn_number, bool is_ps)
|
||||
{
|
||||
sqlite3_stmt *stmt;
|
||||
int rc, ret = 0;
|
||||
struct timespec localtime;
|
||||
|
||||
stmt = dbc->stmt[is_ps ? DB_STMT_UPD_SGSN_BY_ID
|
||||
: DB_STMT_UPD_VLR_BY_ID];
|
||||
@@ -749,21 +581,13 @@ int db_subscr_lu(struct db_context *dbc, int64_t subscr_id,
|
||||
if (!db_bind_int64(stmt, "$subscriber_id", subscr_id))
|
||||
return -EIO;
|
||||
|
||||
if (!db_bind_text(stmt, "$number", (char*)vlr_name->val))
|
||||
if (!db_bind_text(stmt, "$number", vlr_or_sgsn_number))
|
||||
return -EIO;
|
||||
|
||||
if (via_proxy && via_proxy->len) {
|
||||
if (!db_bind_text(stmt, "$proxy", (char*)via_proxy->val))
|
||||
return -EIO;
|
||||
} else {
|
||||
if (!db_bind_null(stmt, "$proxy"))
|
||||
return -EIO;
|
||||
}
|
||||
|
||||
/* execute the statement */
|
||||
rc = sqlite3_step(stmt);
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Update %s number for subscriber ID=%" PRId64 ": SQL Error: %s\n",
|
||||
LOGP(DAUC, LOGL_ERROR, "Update %s number for subscriber ID=%"PRId64": SQL Error: %s\n",
|
||||
is_ps? "SGSN" : "VLR", subscr_id, sqlite3_errmsg(dbc->db));
|
||||
ret = -EIO;
|
||||
goto out;
|
||||
@@ -772,58 +596,17 @@ int db_subscr_lu(struct db_context *dbc, int64_t subscr_id,
|
||||
/* verify execution result */
|
||||
rc = sqlite3_changes(dbc->db);
|
||||
if (!rc) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot update %s number for subscriber ID=%" PRId64
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot update %s number for subscriber ID=%"PRId64
|
||||
": no such subscriber\n",
|
||||
is_ps? "SGSN" : "VLR", subscr_id);
|
||||
ret = -ENOENT;
|
||||
goto out;
|
||||
} else if (rc != 1) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Update %s number for subscriber ID=%" PRId64
|
||||
LOGP(DAUC, LOGL_ERROR, "Update %s number for subscriber ID=%"PRId64
|
||||
": SQL modified %d rows (expected 1)\n",
|
||||
is_ps? "SGSN" : "VLR", subscr_id, rc);
|
||||
ret = -EIO;
|
||||
goto out;
|
||||
}
|
||||
|
||||
db_remove_reset(stmt);
|
||||
|
||||
if (osmo_clock_gettime(CLOCK_REALTIME, &localtime) != 0) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot get the current time: (%d) %s\n", errno, strerror(errno));
|
||||
ret = -errno;
|
||||
goto out;
|
||||
}
|
||||
|
||||
stmt = dbc->stmt[is_ps? DB_STMT_SET_LAST_LU_SEEN_PS : DB_STMT_SET_LAST_LU_SEEN];
|
||||
|
||||
if (!db_bind_int64(stmt, "$subscriber_id", subscr_id))
|
||||
return -EIO;
|
||||
/* The timestamp will be converted to UTC by SQLite. */
|
||||
if (!db_bind_int64(stmt, "$val", (int64_t)localtime.tv_sec)) {
|
||||
ret = -EIO;
|
||||
goto out;
|
||||
}
|
||||
|
||||
rc = sqlite3_step(stmt);
|
||||
if (rc != SQLITE_DONE) {
|
||||
LOGP(DAUC, LOGL_ERROR,
|
||||
"Cannot update LU timestamp for subscriber ID=%" PRId64 ": SQL error: (%d) %s\n",
|
||||
subscr_id, rc, sqlite3_errmsg(dbc->db));
|
||||
ret = -EIO;
|
||||
goto out;
|
||||
}
|
||||
|
||||
/* verify execution result */
|
||||
rc = sqlite3_changes(dbc->db);
|
||||
if (!rc) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Cannot update LU timestamp for subscriber ID=%" PRId64
|
||||
": no such subscriber\n", subscr_id);
|
||||
ret = -ENOENT;
|
||||
goto out;
|
||||
} else if (rc != 1) {
|
||||
LOGP(DAUC, LOGL_ERROR, "Update LU timestamp for subscriber ID=%" PRId64
|
||||
": SQL modified %d rows (expected 1)\n", subscr_id, rc);
|
||||
ret = -EIO;
|
||||
}
|
||||
out:
|
||||
db_remove_reset(stmt);
|
||||
return ret;
|
||||
@@ -885,105 +668,50 @@ out:
|
||||
return ret;
|
||||
}
|
||||
|
||||
static int _db_ind_run(struct db_context *dbc, sqlite3_stmt *stmt, const char *vlr, bool reset)
|
||||
/*! Update nam_cs/nam_ps in the db and trigger notifications to GSUP clients.
|
||||
* \param[in,out] hlr Global hlr context.
|
||||
* \param[in] subscr Subscriber from a fresh db_subscr_get_by_*() call.
|
||||
* \param[in] nam_val True to enable CS/PS, false to disable.
|
||||
* \param[in] is_ps True to enable/disable PS, false for CS.
|
||||
* \returns 0 on success, ENOEXEC if there is no need to change, a negative
|
||||
* value on error.
|
||||
*/
|
||||
int hlr_subscr_nam(struct hlr *hlr, struct hlr_subscriber *subscr, bool nam_val, bool is_ps)
|
||||
{
|
||||
int rc;
|
||||
struct lu_operation *luop;
|
||||
struct osmo_gsup_conn *co;
|
||||
bool is_val = is_ps? subscr->nam_ps : subscr->nam_cs;
|
||||
|
||||
if (!db_bind_text(stmt, "$vlr", vlr))
|
||||
return -EIO;
|
||||
|
||||
/* execute the statement */
|
||||
rc = sqlite3_step(stmt);
|
||||
if (reset)
|
||||
db_remove_reset(stmt);
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int _db_ind_add(struct db_context *dbc, const char *vlr)
|
||||
{
|
||||
sqlite3_stmt *stmt = dbc->stmt[DB_STMT_IND_ADD];
|
||||
if (_db_ind_run(dbc, stmt, vlr, true) != SQLITE_DONE) {
|
||||
LOGP(DDB, LOGL_ERROR, "Cannot create IND entry for %s\n", osmo_quote_str_c(OTC_SELECT, vlr, -1));
|
||||
return -EIO;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int _db_ind_del(struct db_context *dbc, const char *vlr)
|
||||
{
|
||||
sqlite3_stmt *stmt = dbc->stmt[DB_STMT_IND_DEL];
|
||||
_db_ind_run(dbc, stmt, vlr, true);
|
||||
/* We don't really care about the result. If it didn't exist, then that was the goal anyway. */
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int _db_ind_get(struct db_context *dbc, const char *vlr, unsigned int *ind)
|
||||
{
|
||||
int ret = 0;
|
||||
sqlite3_stmt *stmt = dbc->stmt[DB_STMT_IND_SELECT];
|
||||
int rc = _db_ind_run(dbc, stmt, vlr, false);
|
||||
if (rc == SQLITE_DONE) {
|
||||
/* Does not exist yet */
|
||||
ret = -ENOENT;
|
||||
goto out;
|
||||
} else if (rc != SQLITE_ROW) {
|
||||
LOGP(DDB, LOGL_ERROR, "Error executing SQL: %d\n", rc);
|
||||
ret = -EIO;
|
||||
goto out;
|
||||
if (is_val == nam_val) {
|
||||
LOGHLR(subscr->imsi, LOGL_DEBUG, "Already has the requested value when asked to %s %s\n",
|
||||
nam_val ? "enable" : "disable", is_ps ? "PS" : "CS");
|
||||
return ENOEXEC;
|
||||
}
|
||||
|
||||
OSMO_ASSERT(ind);
|
||||
*ind = sqlite3_column_int64(stmt, 0);
|
||||
out:
|
||||
db_remove_reset(stmt);
|
||||
return ret;
|
||||
}
|
||||
rc = db_subscr_nam(hlr->dbc, subscr->imsi, nam_val, is_ps);
|
||||
if (rc)
|
||||
return rc > 0? -rc : rc;
|
||||
|
||||
int _db_ind(struct db_context *dbc, const struct osmo_gsup_peer_id *vlr,
|
||||
unsigned int *ind, bool del)
|
||||
{
|
||||
const char *vlr_name = NULL;
|
||||
int rc;
|
||||
|
||||
switch (vlr->type) {
|
||||
case OSMO_GSUP_PEER_ID_IPA_NAME:
|
||||
if (vlr->ipa_name.len < 2 || vlr->ipa_name.val[vlr->ipa_name.len - 1] != '\0') {
|
||||
LOGP(DDB, LOGL_ERROR, "Expecting VLR ipa_name to be zero terminated; found %s\n",
|
||||
osmo_ipa_name_to_str(&vlr->ipa_name));
|
||||
return -ENOTSUP;
|
||||
}
|
||||
vlr_name = (const char*)vlr->ipa_name.val;
|
||||
break;
|
||||
default:
|
||||
LOGP(DDB, LOGL_ERROR, "Unsupported osmo_gsup_peer_id type: %s\n",
|
||||
osmo_gsup_peer_id_type_name(vlr->type));
|
||||
return -ENOTSUP;
|
||||
}
|
||||
|
||||
if (del)
|
||||
return _db_ind_del(dbc, vlr_name);
|
||||
|
||||
rc = _db_ind_get(dbc, vlr_name, ind);
|
||||
if (!rc)
|
||||
/* If we're disabling, send a notice out to the GSUP client that is
|
||||
* responsible. Otherwise no need. */
|
||||
if (nam_val)
|
||||
return 0;
|
||||
|
||||
/* Does not exist yet, create. */
|
||||
rc = _db_ind_add(dbc, vlr_name);
|
||||
if (rc) {
|
||||
LOGP(DDB, LOGL_ERROR, "Error creating IND entry for %s\n", osmo_quote_str_c(OTC_SELECT, vlr_name, -1));
|
||||
return rc;
|
||||
/* FIXME: only send to single SGSN where latest update for IMSI came from */
|
||||
llist_for_each_entry(co, &hlr->gs->clients, list) {
|
||||
luop = lu_op_alloc_conn(co);
|
||||
if (!luop) {
|
||||
LOGHLR(subscr->imsi, LOGL_ERROR,
|
||||
"Cannot notify GSUP client, cannot allocate lu_operation,"
|
||||
" for %s:%u\n",
|
||||
co && co->conn && co->conn->server? co->conn->server->addr : "unset",
|
||||
co && co->conn && co->conn->server? co->conn->server->port : 0);
|
||||
continue;
|
||||
}
|
||||
luop->subscr = *subscr;
|
||||
lu_op_tx_del_subscr_data(luop);
|
||||
lu_op_free(luop);
|
||||
}
|
||||
|
||||
/* To be sure, query again from scratch. */
|
||||
return _db_ind_get(dbc, vlr_name, ind);
|
||||
}
|
||||
|
||||
int db_ind(struct db_context *dbc, const struct osmo_gsup_peer_id *vlr, unsigned int *ind)
|
||||
{
|
||||
return _db_ind(dbc, vlr, ind, false);
|
||||
}
|
||||
|
||||
int db_ind_del(struct db_context *dbc, const struct osmo_gsup_peer_id *vlr)
|
||||
{
|
||||
return _db_ind(dbc, vlr, NULL, true);
|
||||
return 0;
|
||||
}
|
||||
|
||||
247
src/dgsm.c
247
src/dgsm.c
@@ -1,247 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#include <errno.h>
|
||||
#include <osmocom/core/logging.h>
|
||||
#include <osmocom/mslookup/mslookup_client.h>
|
||||
#include <osmocom/mslookup/mslookup_client_mdns.h>
|
||||
#include <osmocom/gsupclient/gsup_client.h>
|
||||
#include <osmocom/gsupclient/gsup_peer_id.h>
|
||||
#include <osmocom/hlr/logging.h>
|
||||
#include <osmocom/hlr/hlr.h>
|
||||
#include <osmocom/hlr/db.h>
|
||||
#include <osmocom/hlr/gsup_router.h>
|
||||
#include <osmocom/hlr/gsup_server.h>
|
||||
#include <osmocom/hlr/dgsm.h>
|
||||
#include <osmocom/hlr/proxy.h>
|
||||
#include <osmocom/hlr/remote_hlr.h>
|
||||
#include <osmocom/hlr/mslookup_server.h>
|
||||
#include <osmocom/hlr/mslookup_server_mdns.h>
|
||||
#include <osmocom/hlr/dgsm.h>
|
||||
|
||||
void *dgsm_ctx = NULL;
|
||||
|
||||
static void resolve_hlr_result_cb(struct osmo_mslookup_client *client,
|
||||
uint32_t request_handle,
|
||||
const struct osmo_mslookup_query *query,
|
||||
const struct osmo_mslookup_result *result)
|
||||
{
|
||||
struct proxy *proxy = g_hlr->gs->proxy;
|
||||
struct proxy_subscr proxy_subscr;
|
||||
const struct osmo_sockaddr_str *remote_hlr_addr;
|
||||
|
||||
/* A remote HLR is answering back, indicating that it is the home HLR for a given IMSI.
|
||||
* There should be a mostly empty proxy entry for that IMSI.
|
||||
* Add the remote address data in the proxy. */
|
||||
if (query->id.type != OSMO_MSLOOKUP_ID_IMSI) {
|
||||
LOGP(DDGSM, LOGL_ERROR, "Expected IMSI ID type in mslookup query+result: %s\n",
|
||||
osmo_mslookup_result_name_c(OTC_SELECT, query, result));
|
||||
return;
|
||||
}
|
||||
|
||||
if (result->rc != OSMO_MSLOOKUP_RC_RESULT) {
|
||||
LOG_DGSM(query->id.imsi, LOGL_ERROR, "Failed to resolve remote HLR: %s\n",
|
||||
osmo_mslookup_result_name_c(OTC_SELECT, query, result));
|
||||
proxy_subscr_del(proxy, query->id.imsi);
|
||||
return;
|
||||
}
|
||||
|
||||
if (osmo_sockaddr_str_is_nonzero(&result->host_v4))
|
||||
remote_hlr_addr = &result->host_v4;
|
||||
else if (osmo_sockaddr_str_is_nonzero(&result->host_v6))
|
||||
remote_hlr_addr = &result->host_v6;
|
||||
else {
|
||||
LOG_DGSM(query->id.imsi, LOGL_ERROR, "Invalid address for remote HLR: %s\n",
|
||||
osmo_mslookup_result_name_c(OTC_SELECT, query, result));
|
||||
proxy_subscr_del(proxy, query->id.imsi);
|
||||
return;
|
||||
}
|
||||
|
||||
if (proxy_subscr_get_by_imsi(&proxy_subscr, proxy, query->id.imsi)) {
|
||||
LOG_DGSM(query->id.imsi, LOGL_ERROR, "No proxy entry for mslookup result: %s\n",
|
||||
osmo_mslookup_result_name_c(OTC_SELECT, query, result));
|
||||
return;
|
||||
}
|
||||
|
||||
proxy_subscr_remote_hlr_resolved(proxy, &proxy_subscr, remote_hlr_addr);
|
||||
}
|
||||
|
||||
/* Return true when the message has been handled by D-GSM. */
|
||||
bool dgsm_check_forward_gsup_msg(struct osmo_gsup_req *req)
|
||||
{
|
||||
struct proxy_subscr proxy_subscr;
|
||||
struct proxy *proxy = g_hlr->gs->proxy;
|
||||
struct osmo_mslookup_query query;
|
||||
struct osmo_mslookup_query_handling handling;
|
||||
uint32_t request_handle;
|
||||
|
||||
/* If the IMSI is known in the local HLR, then we won't proxy. */
|
||||
if (db_subscr_exists_by_imsi(g_hlr->dbc, req->gsup.imsi) == 0)
|
||||
return false;
|
||||
|
||||
/* Are we already forwarding this IMSI to a remote HLR? */
|
||||
if (proxy_subscr_get_by_imsi(&proxy_subscr, proxy, req->gsup.imsi) == 0) {
|
||||
proxy_subscr_forward_to_remote_hlr(proxy, &proxy_subscr, req);
|
||||
return true;
|
||||
}
|
||||
|
||||
/* The IMSI is not known locally, so we want to proxy to a remote HLR, but no proxy entry exists yet. We need to
|
||||
* look up the subscriber in remote HLRs via D-GSM mslookup, forward GSUP and reply once a result is back from
|
||||
* there. Defer message and kick off MS lookup. */
|
||||
|
||||
/* Add a proxy entry without a remote address to indicate that we are busy querying for a remote HLR. */
|
||||
proxy_subscr = (struct proxy_subscr){};
|
||||
OSMO_STRLCPY_ARRAY(proxy_subscr.imsi, req->gsup.imsi);
|
||||
if (proxy_subscr_create_or_update(proxy, &proxy_subscr)) {
|
||||
osmo_gsup_req_respond_err(req, GMM_CAUSE_NET_FAIL, "Failed to create proxy entry\n");
|
||||
return true;
|
||||
}
|
||||
|
||||
/* Is a fixed gateway proxy configured? */
|
||||
if (osmo_sockaddr_str_is_nonzero(&g_hlr->mslookup.client.gsup_gateway_proxy)) {
|
||||
proxy_subscr_remote_hlr_resolved(proxy, &proxy_subscr, &g_hlr->mslookup.client.gsup_gateway_proxy);
|
||||
|
||||
/* Proxy database modified, update info */
|
||||
if (proxy_subscr_get_by_imsi(&proxy_subscr, proxy, req->gsup.imsi)) {
|
||||
osmo_gsup_req_respond_err(req, GMM_CAUSE_NET_FAIL, "Internal proxy error\n");
|
||||
return true;
|
||||
}
|
||||
|
||||
proxy_subscr_forward_to_remote_hlr(proxy, &proxy_subscr, req);
|
||||
return true;
|
||||
}
|
||||
|
||||
/* Kick off an mslookup for the remote HLR? This check could be up first on the top, but do it only now so that
|
||||
* if the mslookup client disconnected, we still continue to service open proxy entries. */
|
||||
if (!osmo_mslookup_client_active(g_hlr->mslookup.client.client)) {
|
||||
LOG_GSUP_REQ(req, LOGL_DEBUG, "mslookup client not running, cannot query remote home HLR\n");
|
||||
return false;
|
||||
}
|
||||
|
||||
/* First spool message, then kick off mslookup. If the proxy denies this message type, then don't do anything. */
|
||||
if (proxy_subscr_forward_to_remote_hlr(proxy, &proxy_subscr, req)) {
|
||||
/* If the proxy denied forwarding, an error response was already generated. */
|
||||
return true;
|
||||
}
|
||||
|
||||
query = (struct osmo_mslookup_query){
|
||||
.id = {
|
||||
.type = OSMO_MSLOOKUP_ID_IMSI,
|
||||
},
|
||||
};
|
||||
OSMO_STRLCPY_ARRAY(query.id.imsi, req->gsup.imsi);
|
||||
OSMO_STRLCPY_ARRAY(query.service, OSMO_MSLOOKUP_SERVICE_HLR_GSUP);
|
||||
handling = (struct osmo_mslookup_query_handling){
|
||||
.min_wait_milliseconds = g_hlr->mslookup.client.result_timeout_milliseconds,
|
||||
.result_cb = resolve_hlr_result_cb,
|
||||
};
|
||||
request_handle = osmo_mslookup_client_request(g_hlr->mslookup.client.client, &query, &handling);
|
||||
if (!request_handle) {
|
||||
LOG_DGSM(req->gsup.imsi, LOGL_ERROR, "Error dispatching mslookup query for home HLR: %s\n",
|
||||
osmo_mslookup_result_name_c(OTC_SELECT, &query, NULL));
|
||||
proxy_subscr_del(proxy, req->gsup.imsi);
|
||||
/* mslookup seems to not be working. Try handling it locally. */
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
void dgsm_init(void *ctx)
|
||||
{
|
||||
dgsm_ctx = talloc_named_const(ctx, 0, "dgsm");
|
||||
INIT_LLIST_HEAD(&g_hlr->mslookup.server.local_site_services);
|
||||
|
||||
g_hlr->mslookup.server.local_attach_max_age = 60 * 60;
|
||||
|
||||
g_hlr->mslookup.client.result_timeout_milliseconds = 2000;
|
||||
|
||||
g_hlr->gsup_unit_name.unit_name = "HLR";
|
||||
g_hlr->gsup_unit_name.serno = "unnamed-HLR";
|
||||
g_hlr->gsup_unit_name.swversion = PACKAGE_NAME "-" PACKAGE_VERSION;
|
||||
|
||||
osmo_sockaddr_str_from_str(&g_hlr->mslookup.server.mdns.bind_addr,
|
||||
OSMO_MSLOOKUP_MDNS_IP4, OSMO_MSLOOKUP_MDNS_PORT);
|
||||
osmo_sockaddr_str_from_str(&g_hlr->mslookup.client.mdns.query_addr,
|
||||
OSMO_MSLOOKUP_MDNS_IP4, OSMO_MSLOOKUP_MDNS_PORT);
|
||||
}
|
||||
|
||||
void dgsm_start(void *ctx)
|
||||
{
|
||||
g_hlr->mslookup.client.client = osmo_mslookup_client_new(dgsm_ctx);
|
||||
OSMO_ASSERT(g_hlr->mslookup.client.client);
|
||||
g_hlr->mslookup.allow_startup = true;
|
||||
mslookup_server_mdns_config_apply();
|
||||
dgsm_mdns_client_config_apply();
|
||||
}
|
||||
|
||||
void dgsm_stop()
|
||||
{
|
||||
g_hlr->mslookup.allow_startup = false;
|
||||
mslookup_server_mdns_config_apply();
|
||||
dgsm_mdns_client_config_apply();
|
||||
}
|
||||
|
||||
void dgsm_mdns_client_config_apply(void)
|
||||
{
|
||||
/* Check whether to start/stop/restart mDNS client */
|
||||
const struct osmo_sockaddr_str *current_bind_addr;
|
||||
const char *current_domain_suffix;
|
||||
current_bind_addr = osmo_mslookup_client_method_mdns_get_bind_addr(g_hlr->mslookup.client.mdns.running);
|
||||
current_domain_suffix = osmo_mslookup_client_method_mdns_get_domain_suffix(g_hlr->mslookup.client.mdns.running);
|
||||
|
||||
bool should_run = g_hlr->mslookup.allow_startup
|
||||
&& g_hlr->mslookup.client.enable && g_hlr->mslookup.client.mdns.enable;
|
||||
|
||||
bool should_stop = g_hlr->mslookup.client.mdns.running &&
|
||||
(!should_run
|
||||
|| osmo_sockaddr_str_cmp(&g_hlr->mslookup.client.mdns.query_addr,
|
||||
current_bind_addr)
|
||||
|| strcmp(g_hlr->mslookup.client.mdns.domain_suffix,
|
||||
current_domain_suffix));
|
||||
|
||||
if (should_stop) {
|
||||
osmo_mslookup_client_method_del(g_hlr->mslookup.client.client, g_hlr->mslookup.client.mdns.running);
|
||||
g_hlr->mslookup.client.mdns.running = NULL;
|
||||
LOGP(DDGSM, LOGL_NOTICE, "Stopped mslookup mDNS client\n");
|
||||
}
|
||||
|
||||
if (should_run && !g_hlr->mslookup.client.mdns.running) {
|
||||
g_hlr->mslookup.client.mdns.running =
|
||||
osmo_mslookup_client_add_mdns(g_hlr->mslookup.client.client,
|
||||
g_hlr->mslookup.client.mdns.query_addr.ip,
|
||||
g_hlr->mslookup.client.mdns.query_addr.port,
|
||||
-1,
|
||||
g_hlr->mslookup.client.mdns.domain_suffix);
|
||||
if (!g_hlr->mslookup.client.mdns.running)
|
||||
LOGP(DDGSM, LOGL_ERROR, "Failed to start mslookup mDNS client with target "
|
||||
OSMO_SOCKADDR_STR_FMT "\n",
|
||||
OSMO_SOCKADDR_STR_FMT_ARGS(&g_hlr->mslookup.client.mdns.query_addr));
|
||||
else
|
||||
LOGP(DDGSM, LOGL_NOTICE, "Started mslookup mDNS client, sending mDNS requests to multicast "
|
||||
OSMO_SOCKADDR_STR_FMT "\n",
|
||||
OSMO_SOCKADDR_STR_FMT_ARGS(&g_hlr->mslookup.client.mdns.query_addr));
|
||||
}
|
||||
|
||||
if (g_hlr->mslookup.client.enable && osmo_sockaddr_str_is_nonzero(&g_hlr->mslookup.client.gsup_gateway_proxy))
|
||||
LOGP(DDGSM, LOGL_NOTICE,
|
||||
"mslookup client: all GSUP requests for unknown IMSIs will be forwarded to"
|
||||
" gateway-proxy " OSMO_SOCKADDR_STR_FMT "\n",
|
||||
OSMO_SOCKADDR_STR_FMT_ARGS(&g_hlr->mslookup.client.gsup_gateway_proxy));
|
||||
}
|
||||
580
src/dgsm_vty.c
580
src/dgsm_vty.c
@@ -1,580 +0,0 @@
|
||||
/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
|
||||
*
|
||||
* All Rights Reserved
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
#include <osmocom/vty/vty.h>
|
||||
#include <osmocom/vty/command.h>
|
||||
#include <osmocom/mslookup/mslookup_client_mdns.h>
|
||||
#include <osmocom/mslookup/mdns.h>
|
||||
#include <osmocom/hlr/hlr_vty.h>
|
||||
#include <osmocom/hlr/mslookup_server.h>
|
||||
#include <osmocom/hlr/mslookup_server_mdns.h>
|
||||
#include <osmocom/gsupclient/gsup_peer_id.h>
|
||||
|
||||
struct cmd_node mslookup_node = {
|
||||
MSLOOKUP_NODE,
|
||||
"%s(config-mslookup)# ",
|
||||
1,
|
||||
};
|
||||
|
||||
DEFUN(cfg_mslookup,
|
||||
cfg_mslookup_cmd,
|
||||
"mslookup",
|
||||
"Configure Distributed GSM mslookup")
|
||||
{
|
||||
vty->node = MSLOOKUP_NODE;
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
static int mslookup_server_mdns_bind(struct vty *vty, int argc, const char **argv)
|
||||
{
|
||||
const char *ip_str = argc > 0? argv[0] : g_hlr->mslookup.server.mdns.bind_addr.ip;
|
||||
const char *port_str = argc > 1? argv[1] : NULL;
|
||||
uint16_t port_nr = port_str ? atoi(port_str) : g_hlr->mslookup.server.mdns.bind_addr.port;
|
||||
struct osmo_sockaddr_str addr;
|
||||
if (osmo_sockaddr_str_from_str(&addr, ip_str, port_nr)
|
||||
|| !osmo_sockaddr_str_is_nonzero(&addr)) {
|
||||
vty_out(vty, "%% mslookup server: Invalid mDNS bind address: %s %u%s",
|
||||
ip_str, port_nr, VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
|
||||
g_hlr->mslookup.server.mdns.bind_addr = addr;
|
||||
g_hlr->mslookup.server.mdns.enable = true;
|
||||
g_hlr->mslookup.server.enable = true;
|
||||
mslookup_server_mdns_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
static int mslookup_client_mdns_to(struct vty *vty, int argc, const char **argv)
|
||||
{
|
||||
const char *ip_str = argc > 0? argv[0] : g_hlr->mslookup.client.mdns.query_addr.ip;
|
||||
const char *port_str = argc > 1? argv[1] : NULL;
|
||||
uint16_t port_nr = port_str ? atoi(port_str) : g_hlr->mslookup.client.mdns.query_addr.port;
|
||||
struct osmo_sockaddr_str addr;
|
||||
if (osmo_sockaddr_str_from_str(&addr, ip_str, port_nr)
|
||||
|| !osmo_sockaddr_str_is_nonzero(&addr)) {
|
||||
vty_out(vty, "%% mslookup client: Invalid mDNS target address: %s %u%s",
|
||||
ip_str, port_nr, VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
|
||||
g_hlr->mslookup.client.mdns.query_addr = addr;
|
||||
g_hlr->mslookup.client.mdns.enable = true;
|
||||
g_hlr->mslookup.client.enable = true;
|
||||
dgsm_mdns_client_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
#define MDNS_STR "Multicast DNS related configuration\n"
|
||||
#define MDNS_IP46_STR "multicast IPv4 address like " OSMO_MSLOOKUP_MDNS_IP4 \
|
||||
" or IPv6 address like " OSMO_MSLOOKUP_MDNS_IP6 "\n"
|
||||
#define MDNS_PORT_STR "mDNS UDP Port number\n"
|
||||
#define MDNS_DOMAIN_SUFFIX_STR "mDNS domain suffix (default: " OSMO_MDNS_DOMAIN_SUFFIX_DEFAULT "). This is appended" \
|
||||
" and stripped from mDNS packets during encoding/decoding, so we don't collide with" \
|
||||
" top-level domains administrated by IANA\n"
|
||||
#define IP46_STR "IPv4 address like 1.2.3.4 or IPv6 address like a:b:c:d::1\n"
|
||||
#define PORT_STR "Service-specific port number\n"
|
||||
|
||||
DEFUN(cfg_mslookup_mdns,
|
||||
cfg_mslookup_mdns_cmd,
|
||||
"mdns bind [IP] [<1-65535>]",
|
||||
MDNS_STR
|
||||
"Convenience shortcut: enable and configure both server and client for mDNS mslookup\n"
|
||||
MDNS_IP46_STR MDNS_PORT_STR)
|
||||
{
|
||||
int rc1 = mslookup_server_mdns_bind(vty, argc, argv);
|
||||
int rc2 = mslookup_client_mdns_to(vty, argc, argv);
|
||||
if (rc1 != CMD_SUCCESS)
|
||||
return rc1;
|
||||
return rc2;
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_mdns_domain_suffix,
|
||||
cfg_mslookup_mdns_domain_suffix_cmd,
|
||||
"mdns domain-suffix DOMAIN_SUFFIX",
|
||||
MDNS_STR MDNS_DOMAIN_SUFFIX_STR MDNS_DOMAIN_SUFFIX_STR)
|
||||
{
|
||||
osmo_talloc_replace_string(g_hlr, &g_hlr->mslookup.server.mdns.domain_suffix, argv[0]);
|
||||
osmo_talloc_replace_string(g_hlr, &g_hlr->mslookup.client.mdns.domain_suffix, argv[0]);
|
||||
mslookup_server_mdns_config_apply();
|
||||
dgsm_mdns_client_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_no_mdns,
|
||||
cfg_mslookup_no_mdns_cmd,
|
||||
"no mdns bind",
|
||||
NO_STR "Disable both server and client for mDNS mslookup\n")
|
||||
{
|
||||
g_hlr->mslookup.server.mdns.enable = false;
|
||||
g_hlr->mslookup.client.mdns.enable = false;
|
||||
mslookup_server_mdns_config_apply();
|
||||
dgsm_mdns_client_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
struct cmd_node mslookup_server_node = {
|
||||
MSLOOKUP_SERVER_NODE,
|
||||
"%s(config-mslookup-server)# ",
|
||||
1,
|
||||
};
|
||||
|
||||
DEFUN(cfg_mslookup_server,
|
||||
cfg_mslookup_server_cmd,
|
||||
"server",
|
||||
"Enable and configure Distributed GSM mslookup server")
|
||||
{
|
||||
vty->node = MSLOOKUP_SERVER_NODE;
|
||||
g_hlr->mslookup.server.enable = true;
|
||||
mslookup_server_mdns_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_no_server,
|
||||
cfg_mslookup_no_server_cmd,
|
||||
"no server",
|
||||
NO_STR "Disable Distributed GSM mslookup server")
|
||||
{
|
||||
g_hlr->mslookup.server.enable = false;
|
||||
mslookup_server_mdns_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_server_mdns_bind,
|
||||
cfg_mslookup_server_mdns_bind_cmd,
|
||||
"mdns bind [IP] [<1-65535>]",
|
||||
MDNS_STR
|
||||
"Configure where the mDNS server listens for mslookup requests\n"
|
||||
MDNS_IP46_STR MDNS_PORT_STR)
|
||||
{
|
||||
return mslookup_server_mdns_bind(vty, argc, argv);
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_server_mdns_domain_suffix,
|
||||
cfg_mslookup_server_mdns_domain_suffix_cmd,
|
||||
"mdns domain-suffix DOMAIN_SUFFIX",
|
||||
MDNS_STR
|
||||
MDNS_DOMAIN_SUFFIX_STR
|
||||
MDNS_DOMAIN_SUFFIX_STR)
|
||||
{
|
||||
osmo_talloc_replace_string(g_hlr, &g_hlr->mslookup.server.mdns.domain_suffix, argv[0]);
|
||||
mslookup_server_mdns_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_server_no_mdns_bind,
|
||||
cfg_mslookup_server_no_mdns_bind_cmd,
|
||||
"no mdns bind",
|
||||
NO_STR "Disable server for mDNS mslookup (do not answer remote requests)\n")
|
||||
{
|
||||
g_hlr->mslookup.server.mdns.enable = false;
|
||||
mslookup_server_mdns_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
struct cmd_node mslookup_server_msc_node = {
|
||||
MSLOOKUP_SERVER_MSC_NODE,
|
||||
"%s(config-mslookup-server-msc)# ",
|
||||
1,
|
||||
};
|
||||
|
||||
DEFUN(cfg_mslookup_server_msc,
|
||||
cfg_mslookup_server_msc_cmd,
|
||||
"msc ipa-name .IPA_NAME",
|
||||
"Configure services for individual local MSCs\n"
|
||||
"Identify locally connected MSC by IPA Unit Name\n"
|
||||
"IPA Unit Name of the local MSC to configure\n")
|
||||
{
|
||||
struct osmo_ipa_name msc_name;
|
||||
struct mslookup_server_msc_cfg *msc;
|
||||
osmo_ipa_name_set_str(&msc_name, argv_concat(argv, argc, 0));
|
||||
|
||||
msc = mslookup_server_msc_get(&msc_name, true);
|
||||
if (!msc) {
|
||||
vty_out(vty, "%% Error creating MSC %s%s", osmo_ipa_name_to_str(&msc_name), VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
vty->node = MSLOOKUP_SERVER_MSC_NODE;
|
||||
vty->index = msc;
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
#define SERVICE_NAME_STR \
|
||||
"mslookup service name, e.g. sip.voice or smpp.sms\n"
|
||||
|
||||
static struct mslookup_server_msc_cfg *msc_from_node(struct vty *vty)
|
||||
{
|
||||
switch (vty->node) {
|
||||
case MSLOOKUP_SERVER_NODE:
|
||||
/* On the mslookup.server node, set services on the wildcard msc, without a particular name. */
|
||||
return mslookup_server_msc_get(&mslookup_server_msc_wildcard, true);
|
||||
case MSLOOKUP_SERVER_MSC_NODE:
|
||||
return vty->index;
|
||||
default:
|
||||
return NULL;
|
||||
}
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_server_msc_service,
|
||||
cfg_mslookup_server_msc_service_cmd,
|
||||
"service NAME at IP <1-65535>",
|
||||
"Configure addresses of local services, as sent in replies to remote mslookup requests.\n"
|
||||
SERVICE_NAME_STR "at\n" IP46_STR PORT_STR)
|
||||
{
|
||||
/* If this command is run on the 'server' node, it produces an empty unit name and serves as wildcard for all
|
||||
* MSCs. If on a 'server' / 'msc' node, set services only for that MSC Unit Name. */
|
||||
struct mslookup_server_msc_cfg *msc = msc_from_node(vty);
|
||||
const char *service = argv[0];
|
||||
const char *ip_str = argv[1];
|
||||
const char *port_str = argv[2];
|
||||
struct osmo_sockaddr_str addr;
|
||||
|
||||
if (!msc) {
|
||||
vty_out(vty, "%% Error: no MSC object on this node%s", VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
|
||||
if (osmo_sockaddr_str_from_str(&addr, ip_str, atoi(port_str))
|
||||
|| !osmo_sockaddr_str_is_nonzero(&addr)) {
|
||||
vty_out(vty, "%% mslookup server: Invalid address for service %s: %s %s%s",
|
||||
service, ip_str, port_str, VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
|
||||
if (mslookup_server_msc_service_set(msc, service, &addr)) {
|
||||
vty_out(vty, "%% mslookup server: Error setting service %s to %s %s%s",
|
||||
service, ip_str, port_str, VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
#define NO_SERVICE_AND_NAME_STR NO_STR "Remove one or more service address entries\n" SERVICE_NAME_STR
|
||||
|
||||
DEFUN(cfg_mslookup_server_msc_no_service,
|
||||
cfg_mslookup_server_msc_no_service_cmd,
|
||||
"no service NAME",
|
||||
NO_SERVICE_AND_NAME_STR)
|
||||
{
|
||||
/* If this command is run on the 'server' node, it produces an empty unit name and serves as wildcard for all
|
||||
* MSCs. If on a 'server' / 'msc' node, set services only for that MSC Unit Name. */
|
||||
struct mslookup_server_msc_cfg *msc = msc_from_node(vty);
|
||||
const char *service = argv[0];
|
||||
|
||||
if (!msc) {
|
||||
vty_out(vty, "%% Error: no MSC object on this node%s", VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
|
||||
if (mslookup_server_msc_service_del(msc, service, NULL) < 1) {
|
||||
vty_out(vty, "%% mslookup server: cannot remove service '%s'%s",
|
||||
service, VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_server_msc_no_service_addr,
|
||||
cfg_mslookup_server_msc_no_service_addr_cmd,
|
||||
"no service NAME at IP <1-65535>",
|
||||
NO_SERVICE_AND_NAME_STR "at\n" IP46_STR PORT_STR)
|
||||
{
|
||||
/* If this command is run on the 'server' node, it produces an empty unit name and serves as wildcard for all
|
||||
* MSCs. If on a 'server' / 'msc' node, set services only for that MSC Unit Name. */
|
||||
struct mslookup_server_msc_cfg *msc = msc_from_node(vty);
|
||||
const char *service = argv[0];
|
||||
const char *ip_str = argv[1];
|
||||
const char *port_str = argv[2];
|
||||
struct osmo_sockaddr_str addr;
|
||||
|
||||
if (!msc) {
|
||||
vty_out(vty, "%% Error: no MSC object on this node%s", VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
|
||||
if (osmo_sockaddr_str_from_str(&addr, ip_str, atoi(port_str))
|
||||
|| !osmo_sockaddr_str_is_nonzero(&addr)) {
|
||||
vty_out(vty, "%% mslookup server: Invalid address for 'no service' %s: %s %s%s",
|
||||
service, ip_str, port_str, VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
|
||||
if (mslookup_server_msc_service_del(msc, service, &addr) < 1) {
|
||||
vty_out(vty, "%% mslookup server: cannot remove service '%s' to %s %s%s",
|
||||
service, ip_str, port_str, VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
struct cmd_node mslookup_client_node = {
|
||||
MSLOOKUP_CLIENT_NODE,
|
||||
"%s(config-mslookup-client)# ",
|
||||
1,
|
||||
};
|
||||
|
||||
DEFUN(cfg_mslookup_client,
|
||||
cfg_mslookup_client_cmd,
|
||||
"client",
|
||||
"Enable and configure Distributed GSM mslookup client")
|
||||
{
|
||||
vty->node = MSLOOKUP_CLIENT_NODE;
|
||||
g_hlr->mslookup.client.enable = true;
|
||||
dgsm_mdns_client_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_no_client,
|
||||
cfg_mslookup_no_client_cmd,
|
||||
"no client",
|
||||
NO_STR "Disable Distributed GSM mslookup client")
|
||||
{
|
||||
g_hlr->mslookup.client.enable = false;
|
||||
dgsm_mdns_client_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_client_timeout,
|
||||
cfg_mslookup_client_timeout_cmd,
|
||||
"timeout <1-100000>",
|
||||
"How long should the mslookup client wait for remote responses before evaluating received results\n"
|
||||
"timeout in milliseconds\n")
|
||||
{
|
||||
uint32_t val = atol(argv[0]);
|
||||
g_hlr->mslookup.client.result_timeout_milliseconds = val;
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
#define EXIT_HINT() \
|
||||
if (vty->type != VTY_FILE) \
|
||||
vty_out(vty, "%% 'exit' this node to apply changes%s", VTY_NEWLINE)
|
||||
|
||||
|
||||
DEFUN(cfg_mslookup_client_mdns_bind,
|
||||
cfg_mslookup_client_mdns_bind_cmd,
|
||||
"mdns bind [IP] [<1-65535>]",
|
||||
MDNS_STR
|
||||
"Enable mDNS client, and configure multicast address to send mDNS mslookup requests to\n"
|
||||
MDNS_IP46_STR MDNS_PORT_STR)
|
||||
{
|
||||
return mslookup_client_mdns_to(vty, argc, argv);
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_client_mdns_domain_suffix,
|
||||
cfg_mslookup_client_mdns_domain_suffix_cmd,
|
||||
"mdns domain-suffix DOMAIN_SUFFIX",
|
||||
MDNS_STR
|
||||
MDNS_DOMAIN_SUFFIX_STR
|
||||
MDNS_DOMAIN_SUFFIX_STR)
|
||||
{
|
||||
osmo_talloc_replace_string(g_hlr, &g_hlr->mslookup.client.mdns.domain_suffix, argv[0]);
|
||||
dgsm_mdns_client_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_client_no_mdns_bind,
|
||||
cfg_mslookup_client_no_mdns_bind_cmd,
|
||||
"no mdns bind",
|
||||
NO_STR "Disable mDNS client, do not query remote services by mDNS\n")
|
||||
{
|
||||
g_hlr->mslookup.client.mdns.enable = false;
|
||||
dgsm_mdns_client_config_apply();
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
void config_write_msc_services(struct vty *vty, const char *indent, struct mslookup_server_msc_cfg *msc)
|
||||
{
|
||||
struct mslookup_service_host *e;
|
||||
|
||||
llist_for_each_entry(e, &msc->service_hosts, entry) {
|
||||
if (osmo_sockaddr_str_is_nonzero(&e->host_v4))
|
||||
vty_out(vty, "%sservice %s at %s %u%s", indent, e->service, e->host_v4.ip, e->host_v4.port,
|
||||
VTY_NEWLINE);
|
||||
if (osmo_sockaddr_str_is_nonzero(&e->host_v6))
|
||||
vty_out(vty, "%sservice %s at %s %u%s", indent, e->service, e->host_v6.ip, e->host_v6.port,
|
||||
VTY_NEWLINE);
|
||||
}
|
||||
}
|
||||
|
||||
int config_write_mslookup(struct vty *vty)
|
||||
{
|
||||
if (!g_hlr->mslookup.server.enable
|
||||
&& llist_empty(&g_hlr->mslookup.server.local_site_services)
|
||||
&& !g_hlr->mslookup.client.enable)
|
||||
return CMD_SUCCESS;
|
||||
|
||||
vty_out(vty, "mslookup%s", VTY_NEWLINE);
|
||||
|
||||
if (g_hlr->mslookup.server.enable || !llist_empty(&g_hlr->mslookup.server.local_site_services)) {
|
||||
struct mslookup_server_msc_cfg *msc;
|
||||
|
||||
vty_out(vty, " server%s", VTY_NEWLINE);
|
||||
|
||||
if (g_hlr->mslookup.server.mdns.enable) {
|
||||
vty_out(vty, " mdns bind");
|
||||
if (osmo_sockaddr_str_is_nonzero(&g_hlr->mslookup.server.mdns.bind_addr)) {
|
||||
vty_out(vty, " %s %u",
|
||||
g_hlr->mslookup.server.mdns.bind_addr.ip,
|
||||
g_hlr->mslookup.server.mdns.bind_addr.port);
|
||||
}
|
||||
vty_out(vty, "%s", VTY_NEWLINE);
|
||||
}
|
||||
if (strcmp(g_hlr->mslookup.server.mdns.domain_suffix, OSMO_MDNS_DOMAIN_SUFFIX_DEFAULT))
|
||||
vty_out(vty, " mdns domain-suffix %s%s",
|
||||
g_hlr->mslookup.server.mdns.domain_suffix,
|
||||
VTY_NEWLINE);
|
||||
|
||||
msc = mslookup_server_msc_get(&mslookup_server_msc_wildcard, false);
|
||||
if (msc)
|
||||
config_write_msc_services(vty, " ", msc);
|
||||
|
||||
llist_for_each_entry(msc, &g_hlr->mslookup.server.local_site_services, entry) {
|
||||
if (!osmo_ipa_name_cmp(&mslookup_server_msc_wildcard, &msc->name))
|
||||
continue;
|
||||
vty_out(vty, " msc %s%s", osmo_ipa_name_to_str(&msc->name), VTY_NEWLINE);
|
||||
config_write_msc_services(vty, " ", msc);
|
||||
}
|
||||
|
||||
/* If the server is disabled, still output the above to not lose the service config. */
|
||||
if (!g_hlr->mslookup.server.enable)
|
||||
vty_out(vty, " no server%s", VTY_NEWLINE);
|
||||
}
|
||||
|
||||
if (g_hlr->mslookup.client.enable) {
|
||||
vty_out(vty, " client%s", VTY_NEWLINE);
|
||||
|
||||
if (osmo_sockaddr_str_is_nonzero(&g_hlr->mslookup.client.gsup_gateway_proxy))
|
||||
vty_out(vty, " gateway-proxy %s %u%s",
|
||||
g_hlr->mslookup.client.gsup_gateway_proxy.ip,
|
||||
g_hlr->mslookup.client.gsup_gateway_proxy.port,
|
||||
VTY_NEWLINE);
|
||||
|
||||
if (g_hlr->mslookup.client.mdns.enable
|
||||
&& osmo_sockaddr_str_is_nonzero(&g_hlr->mslookup.client.mdns.query_addr))
|
||||
vty_out(vty, " mdns bind %s %u%s",
|
||||
g_hlr->mslookup.client.mdns.query_addr.ip,
|
||||
g_hlr->mslookup.client.mdns.query_addr.port,
|
||||
VTY_NEWLINE);
|
||||
if (strcmp(g_hlr->mslookup.client.mdns.domain_suffix, OSMO_MDNS_DOMAIN_SUFFIX_DEFAULT))
|
||||
vty_out(vty, " mdns domain-suffix %s%s",
|
||||
g_hlr->mslookup.client.mdns.domain_suffix,
|
||||
VTY_NEWLINE);
|
||||
}
|
||||
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_client_gateway_proxy,
|
||||
cfg_mslookup_client_gateway_proxy_cmd,
|
||||
"gateway-proxy IP [<1-65535>]",
|
||||
"Configure a fixed IP address to send all GSUP requests for unknown IMSIs to, without invoking a lookup for IMSI\n"
|
||||
"IP address of the remote HLR\n" "GSUP port number (omit for default " OSMO_STRINGIFY_VAL(OSMO_GSUP_PORT) ")\n")
|
||||
{
|
||||
const char *ip_str = argv[0];
|
||||
const char *port_str = argc > 1 ? argv[1] : NULL;
|
||||
struct osmo_sockaddr_str addr;
|
||||
|
||||
if (osmo_sockaddr_str_from_str(&addr, ip_str, port_str ? atoi(port_str) : OSMO_GSUP_PORT)
|
||||
|| !osmo_sockaddr_str_is_nonzero(&addr)) {
|
||||
vty_out(vty, "%% mslookup client: Invalid address for gateway-proxy: %s %s%s",
|
||||
ip_str, port_str ? : "", VTY_NEWLINE);
|
||||
return CMD_WARNING;
|
||||
}
|
||||
|
||||
g_hlr->mslookup.client.gsup_gateway_proxy = addr;
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
DEFUN(cfg_mslookup_client_no_gateway_proxy,
|
||||
cfg_mslookup_client_no_gateway_proxy_cmd,
|
||||
"no gateway-proxy",
|
||||
NO_STR "Disable gateway proxy for GSUP with unknown IMSIs\n")
|
||||
{
|
||||
g_hlr->mslookup.client.gsup_gateway_proxy = (struct osmo_sockaddr_str){};
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
DEFUN(do_mslookup_show_services,
|
||||
do_mslookup_show_services_cmd,
|
||||
"show mslookup services",
|
||||
SHOW_STR "Distributed GSM / mslookup related information\n"
|
||||
"List configured service addresses as sent to remote mslookup requests\n")
|
||||
{
|
||||
struct mslookup_server_msc_cfg *msc;
|
||||
const struct mslookup_service_host *local_hlr = mslookup_server_get_local_gsup_addr();
|
||||
|
||||
vty_out(vty, "Local GSUP HLR address returned in mslookup responses for local IMSIs:");
|
||||
if (osmo_sockaddr_str_is_nonzero(&local_hlr->host_v4))
|
||||
vty_out(vty, " " OSMO_SOCKADDR_STR_FMT,
|
||||
OSMO_SOCKADDR_STR_FMT_ARGS(&local_hlr->host_v4));
|
||||
if (osmo_sockaddr_str_is_nonzero(&local_hlr->host_v6))
|
||||
vty_out(vty, " " OSMO_SOCKADDR_STR_FMT,
|
||||
OSMO_SOCKADDR_STR_FMT_ARGS(&local_hlr->host_v6));
|
||||
vty_out(vty, "%s", VTY_NEWLINE);
|
||||
|
||||
msc = mslookup_server_msc_get(&mslookup_server_msc_wildcard, false);
|
||||
if (msc)
|
||||
config_write_msc_services(vty, "", msc);
|
||||
|
||||
llist_for_each_entry(msc, &g_hlr->mslookup.server.local_site_services, entry) {
|
||||
if (!osmo_ipa_name_cmp(&mslookup_server_msc_wildcard, &msc->name))
|
||||
continue;
|
||||
vty_out(vty, "msc ipa-name %s%s", osmo_ipa_name_to_str(&msc->name), VTY_NEWLINE);
|
||||
config_write_msc_services(vty, " ", msc);
|
||||
}
|
||||
return CMD_SUCCESS;
|
||||
}
|
||||
|
||||
void dgsm_vty_init(void)
|
||||
{
|
||||
install_element(CONFIG_NODE, &cfg_mslookup_cmd);
|
||||
|
||||
install_node(&mslookup_node, config_write_mslookup);
|
||||
install_element(MSLOOKUP_NODE, &cfg_mslookup_mdns_cmd);
|
||||
install_element(MSLOOKUP_NODE, &cfg_mslookup_mdns_domain_suffix_cmd);
|
||||
install_element(MSLOOKUP_NODE, &cfg_mslookup_no_mdns_cmd);
|
||||
install_element(MSLOOKUP_NODE, &cfg_mslookup_server_cmd);
|
||||
install_element(MSLOOKUP_NODE, &cfg_mslookup_no_server_cmd);
|
||||
|
||||
install_node(&mslookup_server_node, NULL);
|
||||
install_element(MSLOOKUP_SERVER_NODE, &cfg_mslookup_server_mdns_bind_cmd);
|
||||
install_element(MSLOOKUP_SERVER_NODE, &cfg_mslookup_server_mdns_domain_suffix_cmd);
|
||||
install_element(MSLOOKUP_SERVER_NODE, &cfg_mslookup_server_no_mdns_bind_cmd);
|
||||
install_element(MSLOOKUP_SERVER_NODE, &cfg_mslookup_server_msc_service_cmd);
|
||||
install_element(MSLOOKUP_SERVER_NODE, &cfg_mslookup_server_msc_no_service_cmd);
|
||||
install_element(MSLOOKUP_SERVER_NODE, &cfg_mslookup_server_msc_no_service_addr_cmd);
|
||||
install_element(MSLOOKUP_SERVER_NODE, &cfg_mslookup_server_msc_cmd);
|
||||
|
||||
install_node(&mslookup_server_msc_node, NULL);
|
||||
install_element(MSLOOKUP_SERVER_MSC_NODE, &cfg_mslookup_server_msc_service_cmd);
|
||||
install_element(MSLOOKUP_SERVER_MSC_NODE, &cfg_mslookup_server_msc_no_service_cmd);
|
||||
install_element(MSLOOKUP_SERVER_MSC_NODE, &cfg_mslookup_server_msc_no_service_addr_cmd);
|
||||
|
||||
install_element(MSLOOKUP_NODE, &cfg_mslookup_client_cmd);
|
||||
install_element(MSLOOKUP_NODE, &cfg_mslookup_no_client_cmd);
|
||||
install_node(&mslookup_client_node, NULL);
|
||||
install_element(MSLOOKUP_CLIENT_NODE, &cfg_mslookup_client_timeout_cmd);
|
||||
install_element(MSLOOKUP_CLIENT_NODE, &cfg_mslookup_client_mdns_bind_cmd);
|
||||
install_element(MSLOOKUP_CLIENT_NODE, &cfg_mslookup_client_mdns_domain_suffix_cmd);
|
||||
install_element(MSLOOKUP_CLIENT_NODE, &cfg_mslookup_client_no_mdns_bind_cmd);
|
||||
install_element(MSLOOKUP_CLIENT_NODE, &cfg_mslookup_client_gateway_proxy_cmd);
|
||||
install_element(MSLOOKUP_CLIENT_NODE, &cfg_mslookup_client_no_gateway_proxy_cmd);
|
||||
|
||||
install_element_ve(&do_mslookup_show_services_cmd);
|
||||
}
|
||||
@@ -23,17 +23,17 @@
|
||||
#include <osmocom/core/linuxlist.h>
|
||||
#include <osmocom/core/talloc.h>
|
||||
|
||||
#include <osmocom/hlr/logging.h>
|
||||
#include <osmocom/hlr/gsup_server.h>
|
||||
#include <osmocom/hlr/gsup_router.h>
|
||||
#include "logging.h"
|
||||
#include "gsup_server.h"
|
||||
|
||||
/*! Find a route for the given address.
|
||||
* \param[in] gs gsup server
|
||||
* \param[in] addr IPA name of the client (SGSN, MSC/VLR). Although this is passed like a blob, together with the
|
||||
* length, it must be nul-terminated! This is for legacy reasons, see the discussion here:
|
||||
* https://gerrit.osmocom.org/#/c/osmo-hlr/+/13048/
|
||||
* \param[in] addrlen length of addr, *including the nul-byte* (strlen(addr) + 1).
|
||||
*/
|
||||
struct gsup_route {
|
||||
struct llist_head list;
|
||||
|
||||
uint8_t *addr;
|
||||
struct osmo_gsup_conn *conn;
|
||||
};
|
||||
|
||||
/* find a route for the given address */
|
||||
struct osmo_gsup_conn *gsup_route_find(struct osmo_gsup_server *gs,
|
||||
const uint8_t *addr, size_t addrlen)
|
||||
{
|
||||
@@ -47,47 +47,21 @@ struct osmo_gsup_conn *gsup_route_find(struct osmo_gsup_server *gs,
|
||||
return NULL;
|
||||
}
|
||||
|
||||
struct osmo_gsup_conn *gsup_route_find_by_ipa_name(struct osmo_gsup_server *gs, const struct osmo_ipa_name *ipa_name)
|
||||
{
|
||||
return gsup_route_find(gs, ipa_name->val, ipa_name->len);
|
||||
}
|
||||
|
||||
/*! Find a GSUP connection's route (to read the IPA address from the route).
|
||||
* \param[in] conn GSUP connection
|
||||
* \return GSUP route
|
||||
*/
|
||||
struct gsup_route *gsup_route_find_by_conn(const struct osmo_gsup_conn *conn)
|
||||
{
|
||||
struct gsup_route *gr;
|
||||
|
||||
llist_for_each_entry(gr, &conn->server->routes, list) {
|
||||
if (gr->conn == conn)
|
||||
return gr;
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/* add a new route for the given address to the given conn */
|
||||
int gsup_route_add(struct osmo_gsup_conn *conn, const uint8_t *addr, size_t addrlen)
|
||||
{
|
||||
struct gsup_route *gr;
|
||||
struct osmo_gsup_conn *exists_on_conn;
|
||||
|
||||
/* Check if we already have a route for this address */
|
||||
exists_on_conn = gsup_route_find(conn->server, addr, addrlen);
|
||||
if (exists_on_conn) {
|
||||
if (exists_on_conn != conn)
|
||||
return -EEXIST;
|
||||
return 0;
|
||||
}
|
||||
if (gsup_route_find(conn->server, addr, addrlen))
|
||||
return -EEXIST;
|
||||
|
||||
/* allocate new route and populate it */
|
||||
gr = talloc_zero(conn->server, struct gsup_route);
|
||||
if (!gr)
|
||||
return -ENOMEM;
|
||||
|
||||
LOGP(DMAIN, LOGL_INFO, "Adding GSUP route for %s via %s:%u\n", addr, conn->conn->addr, conn->conn->port);
|
||||
LOGP(DMAIN, LOGL_INFO, "Adding GSUP route for %s\n", addr);
|
||||
|
||||
gr->addr = talloc_memdup(gr, addr, addrlen);
|
||||
gr->conn = conn;
|
||||
@@ -96,11 +70,6 @@ int gsup_route_add(struct osmo_gsup_conn *conn, const uint8_t *addr, size_t addr
|
||||
return 0;
|
||||
}
|
||||
|
||||
int gsup_route_add_ipa_name(struct osmo_gsup_conn *conn, const struct osmo_ipa_name *ipa_name)
|
||||
{
|
||||
return gsup_route_add(conn, ipa_name->val, ipa_name->len);
|
||||
}
|
||||
|
||||
/* delete all routes for the given connection */
|
||||
int gsup_route_del_conn(struct osmo_gsup_conn *conn)
|
||||
{
|
||||
@@ -110,7 +79,7 @@ int gsup_route_del_conn(struct osmo_gsup_conn *conn)
|
||||
llist_for_each_entry_safe(gr, gr2, &conn->server->routes, list) {
|
||||
if (gr->conn == conn) {
|
||||
LOGP(DMAIN, LOGL_INFO, "Removing GSUP route for %s (GSUP disconnect)\n",
|
||||
osmo_quote_str_c(OTC_SELECT, (char*)gr->addr, talloc_total_size(gr->addr)));
|
||||
gr->addr);
|
||||
llist_del(&gr->list);
|
||||
talloc_free(gr);
|
||||
num_deleted++;
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user