<p>Harald Welte has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/10113">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">import gsup_client + oap_client as new libosmo-gsup-client<br><br>This imports the code from osmo-msc 6afef893e17bce67e4d4119acd34d480ed03ba77<br>with minimal changes to make it compile. Symbol renaming ot osmo_<br>prefix is done separately in a follow-up patch to have a as-clean-as-possible<br>import first.<br><br>Change-Id: Ief50054ad135551625b684ed8a0486f7af0b2940<br>---<br>M .gitignore<br>M Makefile.am<br>M configure.ac<br>A include/Makefile.am<br>A include/osmocom/gsupclient/gsup_client.h<br>A include/osmocom/gsupclient/oap_client.h<br>A libosmo-gsup-client.pc.in<br>M src/Makefile.am<br>A src/gsupclient/Makefile.am<br>A src/gsupclient/gsup_client.c<br>A src/gsupclient/gsup_test_client.c<br>A src/gsupclient/oap_client.c<br>12 files changed, 1,132 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-hlr refs/changes/13/10113/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/.gitignore b/.gitignore</span><br><span>index d65cb68..571f5b1 100644</span><br><span>--- a/.gitignore</span><br><span>+++ b/.gitignore</span><br><span>@@ -22,6 +22,8 @@</span><br><span> missing</span><br><span> .deps</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+*.pc</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> src/db_test</span><br><span> src/db_bootstrap.h</span><br><span> src/osmo-hlr</span><br><span>diff --git a/Makefile.am b/Makefile.am</span><br><span>index f5062a2..8e18167 100644</span><br><span>--- a/Makefile.am</span><br><span>+++ b/Makefile.am</span><br><span>@@ -3,6 +3,7 @@</span><br><span> SUBDIRS = \</span><br><span> doc \</span><br><span> src \</span><br><span style="color: hsl(120, 100%, 40%);">+ include \</span><br><span> sql \</span><br><span> tests \</span><br><span> $(NULL)</span><br><span>@@ -11,6 +12,9 @@</span><br><span> .version \</span><br><span> $(NULL)</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+pkgconfigdir = $(libdir)/pkgconfig</span><br><span style="color: hsl(120, 100%, 40%);">+pkgconfig_DATA = libosmo-gsup-client.pc</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> @RELMAKE@</span><br><span> </span><br><span> BUILT_SOURCES = $(top_srcdir)/.version</span><br><span>diff --git a/configure.ac b/configure.ac</span><br><span>index cedba45..16c8b51 100644</span><br><span>--- a/configure.ac</span><br><span>+++ b/configure.ac</span><br><span>@@ -99,6 +99,9 @@</span><br><span> Makefile</span><br><span> doc/Makefile</span><br><span> src/Makefile</span><br><span style="color: hsl(120, 100%, 40%);">+ src/gsupclient/Makefile</span><br><span style="color: hsl(120, 100%, 40%);">+ include/Makefile</span><br><span style="color: hsl(120, 100%, 40%);">+ libosmo-gsup-client.pc</span><br><span> sql/Makefile</span><br><span> tests/Makefile</span><br><span> tests/auc/Makefile</span><br><span>diff --git a/include/Makefile.am b/include/Makefile.am</span><br><span>new file mode 100644</span><br><span>index 0000000..5c3ae02</span><br><span>--- /dev/null</span><br><span>+++ b/include/Makefile.am</span><br><span>@@ -0,0 +1,3 @@</span><br><span style="color: hsl(120, 100%, 40%);">+nobase_include_HEADERS = osmocom/gsupclient/oap_client.h \</span><br><span style="color: hsl(120, 100%, 40%);">+ osmocom/gsupclient/gsup_client.h</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>diff --git a/include/osmocom/gsupclient/gsup_client.h b/include/osmocom/gsupclient/gsup_client.h</span><br><span>new file mode 100644</span><br><span>index 0000000..bc0f35a</span><br><span>--- /dev/null</span><br><span>+++ b/include/osmocom/gsupclient/gsup_client.h</span><br><span>@@ -0,0 +1,66 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/* GPRS Subscriber Update Protocol client */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* (C) 2014 by Sysmocom s.f.m.c. GmbH</span><br><span style="color: hsl(120, 100%, 40%);">+ * All Rights Reserved</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Author: Jacob Erlbeck</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is free software; you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+ * it under the terms of the GNU Affero General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+ * the Free Software Foundation; either version 3 of the License, or</span><br><span style="color: hsl(120, 100%, 40%);">+ * (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+ * but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+ * GNU Affero General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * You should have received a copy of the GNU Affero General Public License</span><br><span style="color: hsl(120, 100%, 40%);">+ * along with this program. If not, see <http://www.gnu.org/licenses/>.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+#pragma once</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/timer.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/gsupclient/oap_client.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* a loss of GSUP between MSC and HLR is considered quite serious, let's try to recover as quickly as</span><br><span style="color: hsl(120, 100%, 40%);">+ * possible. Even one new connection attempt per second should be quite acceptable until the link is</span><br><span style="color: hsl(120, 100%, 40%);">+ * re-established */</span><br><span style="color: hsl(120, 100%, 40%);">+#define GSUP_CLIENT_RECONNECT_INTERVAL 1</span><br><span style="color: hsl(120, 100%, 40%);">+#define GSUP_CLIENT_PING_INTERVAL 20</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb;</span><br><span style="color: hsl(120, 100%, 40%);">+struct ipa_client_conn;</span><br><span style="color: hsl(120, 100%, 40%);">+struct gsup_client;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Expects message in msg->l2h */</span><br><span style="color: hsl(120, 100%, 40%);">+typedef int (*gsup_client_read_cb_t)(struct gsup_client *gsupc,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct gsup_client {</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *unit_name;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ipa_client_conn *link;</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup_client_read_cb_t read_cb;</span><br><span style="color: hsl(120, 100%, 40%);">+ void *data;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ struct oap_client_state oap_state;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_timer_list ping_timer;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_timer_list connect_timer;</span><br><span style="color: hsl(120, 100%, 40%);">+ int is_connected;</span><br><span style="color: hsl(120, 100%, 40%);">+ int got_ipa_pong;</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct gsup_client *gsup_client_create(void *talloc_ctx,</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *unit_name,</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *ip_addr,</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int tcp_port,</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup_client_read_cb_t read_cb,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct oap_client_config *oapc_config);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+void gsup_client_destroy(struct gsup_client *gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+int gsup_client_send(struct gsup_client *gsupc, struct msgb *msg);</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsup_client_msgb_alloc(void);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>diff --git a/include/osmocom/gsupclient/oap_client.h b/include/osmocom/gsupclient/oap_client.h</span><br><span>new file mode 100644</span><br><span>index 0000000..80c86d5</span><br><span>--- /dev/null</span><br><span>+++ b/include/osmocom/gsupclient/oap_client.h</span><br><span>@@ -0,0 +1,82 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/* Osmocom Authentication Protocol API */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* (C) 2015 by Sysmocom s.f.m.c. GmbH</span><br><span style="color: hsl(120, 100%, 40%);">+ * All Rights Reserved</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Author: Neels Hofmeyr</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is free software; you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+ * it under the terms of the GNU Affero General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+ * the Free Software Foundation; either version 3 of the License, or</span><br><span style="color: hsl(120, 100%, 40%);">+ * (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+ * but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+ * GNU Affero General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * You should have received a copy of the GNU Affero General Public License</span><br><span style="color: hsl(120, 100%, 40%);">+ * along with this program. If not, see <http://www.gnu.org/licenses/>.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#pragma once</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <stdint.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb;</span><br><span style="color: hsl(120, 100%, 40%);">+struct osmo_oap_message;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* This is the config part for vty. It is essentially copied in</span><br><span style="color: hsl(120, 100%, 40%);">+ * oap_client_state, where values are copied over once the config is</span><br><span style="color: hsl(120, 100%, 40%);">+ * considered valid. */</span><br><span style="color: hsl(120, 100%, 40%);">+struct oap_client_config {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint16_t client_id;</span><br><span style="color: hsl(120, 100%, 40%);">+ int secret_k_present;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t secret_k[16];</span><br><span style="color: hsl(120, 100%, 40%);">+ int secret_opc_present;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t secret_opc[16];</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* The runtime state of the OAP client. client_id and the secrets are in fact</span><br><span style="color: hsl(120, 100%, 40%);">+ * duplicated from oap_client_config, so that a separate validation of the</span><br><span style="color: hsl(120, 100%, 40%);">+ * config data is possible, and so that only a struct oap_client_state* is</span><br><span style="color: hsl(120, 100%, 40%);">+ * passed around. */</span><br><span style="color: hsl(120, 100%, 40%);">+struct oap_client_state {</span><br><span style="color: hsl(120, 100%, 40%);">+ enum {</span><br><span style="color: hsl(120, 100%, 40%);">+ OAP_UNINITIALIZED = 0, /* just allocated. */</span><br><span style="color: hsl(120, 100%, 40%);">+ OAP_DISABLED, /* disabled by config. */</span><br><span style="color: hsl(120, 100%, 40%);">+ OAP_INITIALIZED, /* enabled, config is valid. */</span><br><span style="color: hsl(120, 100%, 40%);">+ OAP_REQUESTED_CHALLENGE,</span><br><span style="color: hsl(120, 100%, 40%);">+ OAP_SENT_CHALLENGE_RESULT,</span><br><span style="color: hsl(120, 100%, 40%);">+ OAP_REGISTERED</span><br><span style="color: hsl(120, 100%, 40%);">+ } state;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint16_t client_id;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t secret_k[16];</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t secret_opc[16];</span><br><span style="color: hsl(120, 100%, 40%);">+ int registration_failures;</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* From config, initialize state. Return 0 on success. */</span><br><span style="color: hsl(120, 100%, 40%);">+int oap_client_init(struct oap_client_config *config,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct oap_client_state *state);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Construct an OAP registration message and return in *msg_tx. Use</span><br><span style="color: hsl(120, 100%, 40%);">+ * state->client_id and update state->state.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Return 0 on success, or a negative value on error.</span><br><span style="color: hsl(120, 100%, 40%);">+ * If an error is returned, *msg_tx is guaranteed to be NULL. */</span><br><span style="color: hsl(120, 100%, 40%);">+int oap_client_register(struct oap_client_state *state, struct msgb **msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Decode and act on a received OAP message msg_rx. Update state->state. If a</span><br><span style="color: hsl(120, 100%, 40%);">+ * non-NULL pointer is returned in *msg_tx, that msgb should be sent to the OAP</span><br><span style="color: hsl(120, 100%, 40%);">+ * server (and freed) by the caller. The received msg_rx is not freed.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Return 0 on success, or a negative value on error.</span><br><span style="color: hsl(120, 100%, 40%);">+ * If an error is returned, *msg_tx is guaranteed to be NULL. */</span><br><span style="color: hsl(120, 100%, 40%);">+int oap_client_handle(struct oap_client_state *state,</span><br><span style="color: hsl(120, 100%, 40%);">+ const struct msgb *msg_rx, struct msgb **msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Allocate a msgb and in it, return the encoded oap_client_msg. Return</span><br><span style="color: hsl(120, 100%, 40%);">+ * NULL on error. (Like oap_client_encode(), but also allocates a msgb.)</span><br><span style="color: hsl(120, 100%, 40%);">+ * About the name: the idea is do_something(oap_client_encoded(my_struct))</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *oap_client_encoded(const struct osmo_oap_message *oap_client_msg);</span><br><span>diff --git a/libosmo-gsup-client.pc.in b/libosmo-gsup-client.pc.in</span><br><span>new file mode 100644</span><br><span>index 0000000..4210a4a</span><br><span>--- /dev/null</span><br><span>+++ b/libosmo-gsup-client.pc.in</span><br><span>@@ -0,0 +1,11 @@</span><br><span style="color: hsl(120, 100%, 40%);">+prefix=@prefix@</span><br><span style="color: hsl(120, 100%, 40%);">+exec_prefix=@exec_prefix@</span><br><span style="color: hsl(120, 100%, 40%);">+libdir=@libdir@</span><br><span style="color: hsl(120, 100%, 40%);">+includedir=@includedir@</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Name: Osmocom GSUP and OAP Client Library</span><br><span style="color: hsl(120, 100%, 40%);">+Description: C Utility Library</span><br><span style="color: hsl(120, 100%, 40%);">+Version: @VERSION@</span><br><span style="color: hsl(120, 100%, 40%);">+Libs: -L${libdir} @TALLOC_LIBS@ -losmogsm -losmocore</span><br><span style="color: hsl(120, 100%, 40%);">+Cflags: -I${includedir}/</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>diff --git a/src/Makefile.am b/src/Makefile.am</span><br><span>index ea5023d..e4506bb 100644</span><br><span>--- a/src/Makefile.am</span><br><span>+++ b/src/Makefile.am</span><br><span>@@ -1,3 +1,5 @@</span><br><span style="color: hsl(120, 100%, 40%);">+SUBDIRS = gsupclient</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> AM_CFLAGS = \</span><br><span> -Wall \</span><br><span> $(LIBOSMOCORE_CFLAGS) \</span><br><span>diff --git a/src/gsupclient/Makefile.am b/src/gsupclient/Makefile.am</span><br><span>new file mode 100644</span><br><span>index 0000000..4e3a93b</span><br><span>--- /dev/null</span><br><span>+++ b/src/gsupclient/Makefile.am</span><br><span>@@ -0,0 +1,14 @@</span><br><span style="color: hsl(120, 100%, 40%);">+# This is _NOT_ the library release version, it's an API version.</span><br><span style="color: hsl(120, 100%, 40%);">+# Please read chapter "Library interface versions" of the libtool documentation</span><br><span style="color: hsl(120, 100%, 40%);">+# before making any modifications: https://www.gnu.org/software/libtool/manual/html_node/Versioning.html</span><br><span style="color: hsl(120, 100%, 40%);">+LIBVERSION=0:0:0</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+AM_CFLAGS = -Wall $(all_includes) -I$(top_srcdir)/include -I$(top_builddir)/include \</span><br><span style="color: hsl(120, 100%, 40%);">+ $(TALLOC_CFLAGS) $(LIBOSMOCORE_CFLAGS)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+lib_LTLIBRARIES = libosmo-gsup-client.la</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+libosmo_gsup_client_la_SOURCES = gsup_client.c oap_client.c</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+libosmo_gsup_client_la_LDFLAGS = -version-info $(LIBVERSION) -no-undefined</span><br><span style="color: hsl(120, 100%, 40%);">+libosmo_gsup_client_la_LIBADD = $(TALLOC_LIBS) $(LIBOSMOCORE_LIBS)</span><br><span>diff --git a/src/gsupclient/gsup_client.c b/src/gsupclient/gsup_client.c</span><br><span>new file mode 100644</span><br><span>index 0000000..7c2bb49</span><br><span>--- /dev/null</span><br><span>+++ b/src/gsupclient/gsup_client.c</span><br><span>@@ -0,0 +1,344 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/* Generic Subscriber Update Protocol client */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* (C) 2014-2016 by Sysmocom s.f.m.c. GmbH</span><br><span style="color: hsl(120, 100%, 40%);">+ * All Rights Reserved</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Author: Jacob Erlbeck</span><br><span style="color: hsl(120, 100%, 40%);">+ * Author: Neels Hofmeyr</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is free software; you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+ * it under the terms of the GNU Affero General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+ * the Free Software Foundation; either version 3 of the License, or</span><br><span style="color: hsl(120, 100%, 40%);">+ * (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+ * but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+ * GNU Affero General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * You should have received a copy of the GNU Affero General Public License</span><br><span style="color: hsl(120, 100%, 40%);">+ * along with this program. If not, see <http://www.gnu.org/licenses/>.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/gsupclient/gsup_client.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/abis/ipa.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/gsm/protocol/ipaccess.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/msgb.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/logging.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <errno.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <string.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void start_test_procedure(struct gsup_client *gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void gsup_client_send_ping(struct gsup_client *gsupc)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg = gsup_client_msgb_alloc();</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msg->l2h = msgb_put(msg, 1);</span><br><span style="color: hsl(120, 100%, 40%);">+ msg->l2h[0] = IPAC_MSGT_PING;</span><br><span style="color: hsl(120, 100%, 40%);">+ ipa_msg_push_header(msg, IPAC_PROTO_IPACCESS);</span><br><span style="color: hsl(120, 100%, 40%);">+ ipa_client_conn_send(gsupc->link, msg);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static int gsup_client_connect(struct gsup_client *gsupc)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (gsupc->is_connected)</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (osmo_timer_pending(&gsupc->connect_timer)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_DEBUG,</span><br><span style="color: hsl(120, 100%, 40%);">+ "GSUP connect: connect timer already running\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_del(&gsupc->connect_timer);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (osmo_timer_pending(&gsupc->ping_timer)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_DEBUG,</span><br><span style="color: hsl(120, 100%, 40%);">+ "GSUP connect: ping timer already running\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_del(&gsupc->ping_timer);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (ipa_client_conn_clear_queue(gsupc->link) > 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_DEBUG, "GSUP connect: discarded stored messages\n");</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = ipa_client_conn_open(gsupc->link);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc >= 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_NOTICE, "GSUP connecting to %s:%d\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->link->addr, gsupc->link->port);</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_ERROR, "GSUP failed to connect to %s:%d: %s\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->link->addr, gsupc->link->port, strerror(-rc));</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc == -EBADF || rc == -ENOTSOCK || rc == -EAFNOSUPPORT ||</span><br><span style="color: hsl(120, 100%, 40%);">+ rc == -EINVAL)</span><br><span style="color: hsl(120, 100%, 40%);">+ return rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_schedule(&gsupc->connect_timer,</span><br><span style="color: hsl(120, 100%, 40%);">+ GSUP_CLIENT_RECONNECT_INTERVAL, 0);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_INFO, "Scheduled timer to retry GSUP connect to %s:%d\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->link->addr, gsupc->link->port);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void connect_timer_cb(void *gsupc_)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct gsup_client *gsupc = gsupc_;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (gsupc->is_connected)</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup_client_connect(gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void client_send(struct gsup_client *gsupc, int proto_ext,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg_tx)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ ipa_prepend_header_ext(msg_tx, proto_ext);</span><br><span style="color: hsl(120, 100%, 40%);">+ ipa_msg_push_header(msg_tx, IPAC_PROTO_OSMO);</span><br><span style="color: hsl(120, 100%, 40%);">+ ipa_client_conn_send(gsupc->link, msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* msg_tx is now queued and will be freed. */</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void gsup_client_oap_register(struct gsup_client *gsupc)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg_tx;</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = oap_client_register(&gsupc->oap_state, &msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if ((rc < 0) || (!msg_tx)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_ERROR, "GSUP OAP set up, but cannot register.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ client_send(gsupc, IPAC_PROTO_EXT_OAP, msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void gsup_client_updown_cb(struct ipa_client_conn *link, int up)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct gsup_client *gsupc = link->data;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_INFO, "GSUP link to %s:%d %s\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ link->addr, link->port, up ? "UP" : "DOWN");</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->is_connected = up;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (up) {</span><br><span style="color: hsl(120, 100%, 40%);">+ start_test_procedure(gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (gsupc->oap_state.state == OAP_INITIALIZED)</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup_client_oap_register(gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_del(&gsupc->connect_timer);</span><br><span style="color: hsl(120, 100%, 40%);">+ } else {</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_del(&gsupc->ping_timer);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_schedule(&gsupc->connect_timer,</span><br><span style="color: hsl(120, 100%, 40%);">+ GSUP_CLIENT_RECONNECT_INTERVAL, 0);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static int gsup_client_oap_handle(struct gsup_client *gsupc, struct msgb *msg_rx)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg_tx;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* If the oap_state is disabled, this will reject the messages. */</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = oap_client_handle(&gsupc->oap_state, msg_rx, &msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_free(msg_rx);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ return rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (msg_tx)</span><br><span style="color: hsl(120, 100%, 40%);">+ client_send(gsupc, IPAC_PROTO_EXT_OAP, msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static int gsup_client_read_cb(struct ipa_client_conn *link, struct msgb *msg)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ipaccess_head *hh = (struct ipaccess_head *) msg->data;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ipaccess_head_ext *he = (struct ipaccess_head_ext *) msgb_l2(msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ struct gsup_client *gsupc = (struct gsup_client *)link->data;</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ipaccess_unit ipa_dev = {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* see gsup_client_create() on const vs non-const */</span><br><span style="color: hsl(120, 100%, 40%);">+ .unit_name = (char*)gsupc->unit_name,</span><br><span style="color: hsl(120, 100%, 40%);">+ };</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(ipa_dev.unit_name);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msg->l2h = &hh->data[0];</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = ipaccess_bts_handle_ccm(link, &ipa_dev, msg);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_NOTICE,</span><br><span style="color: hsl(120, 100%, 40%);">+ "GSUP received an invalid IPA/CCM message from %s:%d\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ link->addr, link->port);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Link has been closed */</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->is_connected = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_free(msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc == 1) {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t msg_type = *(msg->l2h);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* CCM message */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (msg_type == IPAC_MSGT_PONG) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_DEBUG, "GSUP receiving PONG\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->got_ipa_pong = 1;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_free(msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (hh->proto != IPAC_PROTO_OSMO)</span><br><span style="color: hsl(120, 100%, 40%);">+ goto invalid;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!he || msgb_l2len(msg) < sizeof(*he))</span><br><span style="color: hsl(120, 100%, 40%);">+ goto invalid;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msg->l2h = &he->data[0];</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (he->proto == IPAC_PROTO_EXT_GSUP) {</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(gsupc->read_cb != NULL);</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->read_cb(gsupc, msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* expecting read_cb() to free msg */</span><br><span style="color: hsl(120, 100%, 40%);">+ } else if (he->proto == IPAC_PROTO_EXT_OAP) {</span><br><span style="color: hsl(120, 100%, 40%);">+ return gsup_client_oap_handle(gsupc, msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* gsup_client_oap_handle frees msg */</span><br><span style="color: hsl(120, 100%, 40%);">+ } else</span><br><span style="color: hsl(120, 100%, 40%);">+ goto invalid;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+invalid:</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_NOTICE,</span><br><span style="color: hsl(120, 100%, 40%);">+ "GSUP received an invalid IPA message from %s:%d, size = %d\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ link->addr, link->port, msgb_length(msg));</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_free(msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void ping_timer_cb(void *gsupc_)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct gsup_client *gsupc = gsupc_;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_INFO, "GSUP ping callback (%s, %s PONG)\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->is_connected ? "connected" : "not connected",</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->got_ipa_pong ? "got" : "didn't get");</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (gsupc->got_ipa_pong) {</span><br><span style="color: hsl(120, 100%, 40%);">+ start_test_procedure(gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_NOTICE, "GSUP ping timed out, reconnecting\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ ipa_client_conn_close(gsupc->link);</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->is_connected = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup_client_connect(gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void start_test_procedure(struct gsup_client *gsupc)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_setup(&gsupc->ping_timer, ping_timer_cb, gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->got_ipa_pong = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_schedule(&gsupc->ping_timer, GSUP_CLIENT_PING_INTERVAL, 0);</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_DEBUG, "GSUP sending PING\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup_client_send_ping(gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct gsup_client *gsup_client_create(void *talloc_ctx,</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *unit_name,</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *ip_addr,</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int tcp_port,</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup_client_read_cb_t read_cb,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct oap_client_config *oapc_config)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct gsup_client *gsupc;</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc = talloc_zero(talloc_ctx, struct gsup_client);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* struct ipaccess_unit has a non-const unit_name, so let's copy to be</span><br><span style="color: hsl(120, 100%, 40%);">+ * able to have a non-const unit_name here as well. To not taint the</span><br><span style="color: hsl(120, 100%, 40%);">+ * public gsup_client API, let's store it in a const char* anyway. */</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->unit_name = talloc_strdup(gsupc, unit_name);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(gsupc->unit_name);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* a NULL oapc_config will mark oap_state disabled. */</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = oap_client_init(oapc_config, &gsupc->oap_state);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc != 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ goto failed;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->link = ipa_client_conn_create(gsupc,</span><br><span style="color: hsl(120, 100%, 40%);">+ /* no e1inp */ NULL,</span><br><span style="color: hsl(120, 100%, 40%);">+ 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ ip_addr, tcp_port,</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup_client_updown_cb,</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup_client_read_cb,</span><br><span style="color: hsl(120, 100%, 40%);">+ /* default write_cb */ NULL,</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!gsupc->link)</span><br><span style="color: hsl(120, 100%, 40%);">+ goto failed;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_setup(&gsupc->connect_timer, connect_timer_cb, gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = gsup_client_connect(gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ goto failed;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->read_cb = read_cb;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return gsupc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+failed:</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup_client_destroy(gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+void gsup_client_destroy(struct gsup_client *gsupc)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_del(&gsupc->connect_timer);</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_del(&gsupc->ping_timer);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (gsupc->link) {</span><br><span style="color: hsl(120, 100%, 40%);">+ ipa_client_conn_close(gsupc->link);</span><br><span style="color: hsl(120, 100%, 40%);">+ ipa_client_conn_destroy(gsupc->link);</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc->link = NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ talloc_free(gsupc);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+int gsup_client_send(struct gsup_client *gsupc, struct msgb *msg)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!gsupc || !gsupc->is_connected) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLGSUP, LOGL_ERROR, "GSUP not connected, unable to send %s\n", msgb_hexdump(msg));</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_free(msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ return -ENOTCONN;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ client_send(gsupc, IPAC_PROTO_EXT_GSUP, msg);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsup_client_msgb_alloc(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ return msgb_alloc_headroom(4000, 64, __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span>diff --git a/src/gsupclient/gsup_test_client.c b/src/gsupclient/gsup_test_client.c</span><br><span>new file mode 100644</span><br><span>index 0000000..0ebcd4a</span><br><span>--- /dev/null</span><br><span>+++ b/src/gsupclient/gsup_test_client.c</span><br><span>@@ -0,0 +1,321 @@</span><br><span style="color: hsl(120, 100%, 40%);">+#include <string.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <stdio.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <errno.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <signal.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/linuxlist.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/msgb.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/select.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/application.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/utils.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/logging.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/gsm/gsup.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/msc/gsup_client.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static struct gsup_client *g_gc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/***********************************************************************</span><br><span style="color: hsl(120, 100%, 40%);">+ * IMSI Operation</span><br><span style="color: hsl(120, 100%, 40%);">+ ***********************************************************************/</span><br><span style="color: hsl(120, 100%, 40%);">+static LLIST_HEAD(g_imsi_ops);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct imsi_op_stats {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t num_alloc;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t num_released;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t num_rx_success;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t num_rx_error;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t num_timeout;</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+enum imsi_op_type {</span><br><span style="color: hsl(120, 100%, 40%);">+ IMSI_OP_SAI,</span><br><span style="color: hsl(120, 100%, 40%);">+ IMSI_OP_LU,</span><br><span style="color: hsl(120, 100%, 40%);">+ IMSI_OP_ISD,</span><br><span style="color: hsl(120, 100%, 40%);">+ _NUM_IMSI_OP</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static const struct value_string imsi_op_names[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+ { IMSI_OP_SAI, "SAI" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { IMSI_OP_LU, "LU" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { IMSI_OP_ISD, "ISD" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { 0, NULL }</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static struct imsi_op_stats imsi_op_stats[_NUM_IMSI_OP];</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct imsi_op {</span><br><span style="color: hsl(120, 100%, 40%);">+ struct llist_head list;</span><br><span style="color: hsl(120, 100%, 40%);">+ char imsi[17];</span><br><span style="color: hsl(120, 100%, 40%);">+ enum imsi_op_type type;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_timer_list timer;</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static struct imsi_op *imsi_op_find(const char *imsi,</span><br><span style="color: hsl(120, 100%, 40%);">+ enum imsi_op_type type)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct imsi_op *io;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ llist_for_each_entry(io, &g_imsi_ops, list) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!strcmp(io->imsi, imsi) && io->type == type)</span><br><span style="color: hsl(120, 100%, 40%);">+ return io;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void imsi_op_timer_cb(void *data);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static struct imsi_op *imsi_op_alloc(void *ctx, const char *imsi,</span><br><span style="color: hsl(120, 100%, 40%);">+ enum imsi_op_type type)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct imsi_op *io;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (imsi_op_find(imsi, type))</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ io = talloc_zero(ctx, struct imsi_op);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_STRLCPY_ARRAY(io->imsi, imsi);</span><br><span style="color: hsl(120, 100%, 40%);">+ io->type = type;</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_setup(&io->timer, imsi_op_timer_cb, io);</span><br><span style="color: hsl(120, 100%, 40%);">+ llist_add(&io->list, &g_imsi_ops);</span><br><span style="color: hsl(120, 100%, 40%);">+ imsi_op_stats[type].num_alloc++;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return io;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void imsi_op_release(struct imsi_op *io)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_timer_del(&io->timer);</span><br><span style="color: hsl(120, 100%, 40%);">+ llist_del(&io->list);</span><br><span style="color: hsl(120, 100%, 40%);">+ imsi_op_stats[io->type].num_released++;</span><br><span style="color: hsl(120, 100%, 40%);">+ talloc_free(io);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void imsi_op_timer_cb(void *data)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct imsi_op *io = data;</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("%s: Timer expiration\n", io->imsi);</span><br><span style="color: hsl(120, 100%, 40%);">+ imsi_op_stats[io->type].num_timeout++;</span><br><span style="color: hsl(120, 100%, 40%);">+ imsi_op_release(io);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* allocate + generate + send Send-Auth-Info */</span><br><span style="color: hsl(120, 100%, 40%);">+static int req_auth_info(const char *imsi)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct imsi_op *io = imsi_op_alloc(g_gc, imsi, IMSI_OP_SAI);</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_gsup_message gsup = {0};</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg = msgb_alloc_headroom(1200, 200, __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_STRLCPY_ARRAY(gsup.imsi, io->imsi);</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup.message_type = OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = osmo_gsup_encode(msg, &gsup);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("%s: encoding failure (%s)\n", imsi, strerror(-rc));</span><br><span style="color: hsl(120, 100%, 40%);">+ return rc;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return gsup_client_send(g_gc, msg);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* allocate + generate + send Send-Auth-Info */</span><br><span style="color: hsl(120, 100%, 40%);">+static int req_loc_upd(const char *imsi)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct imsi_op *io = imsi_op_alloc(g_gc, imsi, IMSI_OP_LU);</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_gsup_message gsup = {0};</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg = msgb_alloc_headroom(1200, 200, __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_STRLCPY_ARRAY(gsup.imsi, io->imsi);</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup.message_type = OSMO_GSUP_MSGT_UPDATE_LOCATION_REQUEST;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = osmo_gsup_encode(msg, &gsup);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("%s: encoding failure (%s)\n", imsi, strerror(-rc));</span><br><span style="color: hsl(120, 100%, 40%);">+ return rc;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return gsup_client_send(g_gc, msg);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static int resp_isd(struct imsi_op *io)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_gsup_message gsup = {0};</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg = msgb_alloc_headroom(1200, 200, __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_STRLCPY_ARRAY(gsup.imsi, io->imsi);</span><br><span style="color: hsl(120, 100%, 40%);">+ gsup.message_type = OSMO_GSUP_MSGT_INSERT_DATA_RESULT;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = osmo_gsup_encode(msg, &gsup);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("%s: encoding failure (%s)\n", io->imsi, strerror(-rc));</span><br><span style="color: hsl(120, 100%, 40%);">+ return rc;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ imsi_op_release(io);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return gsup_client_send(g_gc, msg);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* receive an incoming GSUP message */</span><br><span style="color: hsl(120, 100%, 40%);">+static void imsi_op_rx_gsup(struct imsi_op *io, const struct osmo_gsup_message *gsup)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ int is_error = 0, rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (OSMO_GSUP_IS_MSGT_ERROR(gsup->message_type)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ imsi_op_stats[io->type].num_rx_error++;</span><br><span style="color: hsl(120, 100%, 40%);">+ is_error = 1;</span><br><span style="color: hsl(120, 100%, 40%);">+ } else</span><br><span style="color: hsl(120, 100%, 40%);">+ imsi_op_stats[io->type].num_rx_success++;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (io->type) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case IMSI_OP_SAI:</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("%s; SAI Response%s\n", io->imsi, is_error ? ": ERROR" : "");</span><br><span style="color: hsl(120, 100%, 40%);">+ /* now that we have auth tuples, request LU */</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = req_loc_upd(io->imsi);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("Failed to request Location Update for %s\n", io->imsi);</span><br><span style="color: hsl(120, 100%, 40%);">+ imsi_op_release(io);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case IMSI_OP_LU:</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("%s; LU Response%s\n", io->imsi, is_error ? ": ERROR" : "");</span><br><span style="color: hsl(120, 100%, 40%);">+ imsi_op_release(io);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case IMSI_OP_ISD:</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("%s; ISD Request%s\n", io->imsi, is_error ? ": ERROR" : "");</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = resp_isd(io);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("Failed to insert subscriber data for %s\n", io->imsi);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ default:</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("%s: Unknown\n", io->imsi);</span><br><span style="color: hsl(120, 100%, 40%);">+ imsi_op_release(io);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static int op_type_by_gsup_msgt(enum osmo_gsup_message_type msg_type)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (msg_type) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case OSMO_GSUP_MSGT_SEND_AUTH_INFO_RESULT:</span><br><span style="color: hsl(120, 100%, 40%);">+ case OSMO_GSUP_MSGT_SEND_AUTH_INFO_ERROR:</span><br><span style="color: hsl(120, 100%, 40%);">+ return IMSI_OP_SAI;</span><br><span style="color: hsl(120, 100%, 40%);">+ case OSMO_GSUP_MSGT_UPDATE_LOCATION_RESULT:</span><br><span style="color: hsl(120, 100%, 40%);">+ case OSMO_GSUP_MSGT_UPDATE_LOCATION_ERROR:</span><br><span style="color: hsl(120, 100%, 40%);">+ return IMSI_OP_LU;</span><br><span style="color: hsl(120, 100%, 40%);">+ case OSMO_GSUP_MSGT_INSERT_DATA_REQUEST:</span><br><span style="color: hsl(120, 100%, 40%);">+ return IMSI_OP_ISD;</span><br><span style="color: hsl(120, 100%, 40%);">+ default:</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("Unknown GSUP msg_type %u\n", msg_type);</span><br><span style="color: hsl(120, 100%, 40%);">+ return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static int gsupc_read_cb(struct gsup_client *gsupc, struct msgb *msg)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_gsup_message gsup_msg = {0};</span><br><span style="color: hsl(120, 100%, 40%);">+ struct imsi_op *io = NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ DEBUGP(DLGSUP, "Rx GSUP %s\n", msgb_hexdump(msg));</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = osmo_gsup_decode(msgb_l2(msg), msgb_l2len(msg), &gsup_msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ return rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!gsup_msg.imsi[0])</span><br><span style="color: hsl(120, 100%, 40%);">+ return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = op_type_by_gsup_msgt(gsup_msg.message_type);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ return rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (rc) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case IMSI_OP_SAI:</span><br><span style="color: hsl(120, 100%, 40%);">+ case IMSI_OP_LU:</span><br><span style="color: hsl(120, 100%, 40%);">+ io = imsi_op_find(gsup_msg.imsi, rc);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case IMSI_OP_ISD:</span><br><span style="color: hsl(120, 100%, 40%);">+ /* ISD is an inbound transaction */</span><br><span style="color: hsl(120, 100%, 40%);">+ io = imsi_op_alloc(g_gc, gsup_msg.imsi, IMSI_OP_ISD);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!io)</span><br><span style="color: hsl(120, 100%, 40%);">+ return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ imsi_op_rx_gsup(io, &gsup_msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_free(msg);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void print_report(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int i;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ for (i = 0; i < ARRAY_SIZE(imsi_op_stats); i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ struct imsi_op_stats *st = &imsi_op_stats[i];</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *name = get_value_string(imsi_op_names, i);</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("%s: %u alloc, %u released, %u success, %u error , %u tout\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ name, st->num_alloc, st->num_released, st->num_rx_success,</span><br><span style="color: hsl(120, 100%, 40%);">+ st->num_rx_error, st->num_timeout);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void sig_cb(int sig)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (sig) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case SIGINT:</span><br><span style="color: hsl(120, 100%, 40%);">+ print_report();</span><br><span style="color: hsl(120, 100%, 40%);">+ exit(0);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* default categories */</span><br><span style="color: hsl(120, 100%, 40%);">+static struct log_info_cat default_categories[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static const struct log_info gsup_test_client_log_info = {</span><br><span style="color: hsl(120, 100%, 40%);">+ .cat = default_categories,</span><br><span style="color: hsl(120, 100%, 40%);">+ .num_cat = ARRAY_SIZE(default_categories),</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+int main(int argc, char **argv)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned long long i;</span><br><span style="color: hsl(120, 100%, 40%);">+ char *server_host = "127.0.0.1";</span><br><span style="color: hsl(120, 100%, 40%);">+ uint16_t server_port = OSMO_GSUP_PORT;</span><br><span style="color: hsl(120, 100%, 40%);">+ void *ctx = talloc_named_const(NULL, 0, "gsup_test_client");</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_init_logging2(ctx, &gsup_test_client_log_info);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ g_gc = gsup_client_create(ctx, "GSUPTEST", server_host, server_port,</span><br><span style="color: hsl(120, 100%, 40%);">+ gsupc_read_cb, NULL);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ signal(SIGINT, sig_cb);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ for (i = 0; i < 10000; i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned long long imsi = 901790000000000 + i;</span><br><span style="color: hsl(120, 100%, 40%);">+ char imsi_buf[17] = { 0 };</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ snprintf(imsi_buf, sizeof(imsi_buf), "%015llu", imsi);</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = req_auth_info(imsi_buf);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("Failed to request Auth Info for %s\n", imsi_buf);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_select_main(0);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ while (1) {</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_select_main(0);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ print_report();</span><br><span style="color: hsl(120, 100%, 40%);">+ exit(0);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span>diff --git a/src/gsupclient/oap_client.c b/src/gsupclient/oap_client.c</span><br><span>new file mode 100644</span><br><span>index 0000000..9a0b60f</span><br><span>--- /dev/null</span><br><span>+++ b/src/gsupclient/oap_client.c</span><br><span>@@ -0,0 +1,280 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/* Osmocom Authentication Protocol API */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* (C) 2015 by Sysmocom s.f.m.c. GmbH</span><br><span style="color: hsl(120, 100%, 40%);">+ * All Rights Reserved</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Author: Neels Hofmeyr</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is free software; you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+ * it under the terms of the GNU Affero General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+ * the Free Software Foundation; either version 3 of the License, or</span><br><span style="color: hsl(120, 100%, 40%);">+ * (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+ * but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+ * GNU Affero General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * You should have received a copy of the GNU Affero General Public License</span><br><span style="color: hsl(120, 100%, 40%);">+ * along with this program. If not, see <http://www.gnu.org/licenses/>.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <string.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <errno.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/utils.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/logging.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/crypt/auth.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/gsm/oap.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/gsupclient/oap_client.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+int oap_client_init(struct oap_client_config *config,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct oap_client_state *state)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(state->state == OAP_UNINITIALIZED);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!config)</span><br><span style="color: hsl(120, 100%, 40%);">+ goto disable;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (config->client_id == 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ goto disable;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (config->secret_k_present == 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_NOTICE, "OAP: client ID set, but secret K missing.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ goto disable;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (config->secret_opc_present == 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_NOTICE, "OAP: client ID set, but secret OPC missing.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ goto disable;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ state->client_id = config->client_id;</span><br><span style="color: hsl(120, 100%, 40%);">+ memcpy(state->secret_k, config->secret_k, sizeof(state->secret_k));</span><br><span style="color: hsl(120, 100%, 40%);">+ memcpy(state->secret_opc, config->secret_opc, sizeof(state->secret_opc));</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OAP_INITIALIZED;</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+disable:</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OAP_DISABLED;</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* From the given state and received RAND and AUTN octets, validate the</span><br><span style="color: hsl(120, 100%, 40%);">+ * server's authenticity and formulate the matching milenage reply octets in</span><br><span style="color: hsl(120, 100%, 40%);">+ * *tx_xres. The state is not modified.</span><br><span style="color: hsl(120, 100%, 40%);">+ * On success, and if tx_res is not NULL, exactly 8 octets will be written to</span><br><span style="color: hsl(120, 100%, 40%);">+ * *tx_res. If not NULL, tx_res must point at allocated memory of at least 8</span><br><span style="color: hsl(120, 100%, 40%);">+ * octets. The caller will want to send XRES back to the server in a challenge</span><br><span style="color: hsl(120, 100%, 40%);">+ * response message and update the state.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Return 0 on success; -1 if OAP is disabled; -2 if rx_random and rx_autn fail</span><br><span style="color: hsl(120, 100%, 40%);">+ * the authentication check; -3 for any other errors. */</span><br><span style="color: hsl(120, 100%, 40%);">+static int oap_evaluate_challenge(const struct oap_client_state *state,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *rx_random,</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *rx_autn,</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t *tx_xres)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_auth_vector vec;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_sub_auth_data auth = {</span><br><span style="color: hsl(120, 100%, 40%);">+ .type = OSMO_AUTH_TYPE_UMTS,</span><br><span style="color: hsl(120, 100%, 40%);">+ .algo = OSMO_AUTH_ALG_MILENAGE,</span><br><span style="color: hsl(120, 100%, 40%);">+ };</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_static_assert(sizeof(((struct osmo_sub_auth_data*)0)->u.umts.k)</span><br><span style="color: hsl(120, 100%, 40%);">+ == sizeof(state->secret_k), _secret_k_size_match);</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_static_assert(sizeof(((struct osmo_sub_auth_data*)0)->u.umts.opc)</span><br><span style="color: hsl(120, 100%, 40%);">+ == sizeof(state->secret_opc), _secret_opc_size_match);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (state->state) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case OAP_UNINITIALIZED:</span><br><span style="color: hsl(120, 100%, 40%);">+ case OAP_DISABLED:</span><br><span style="color: hsl(120, 100%, 40%);">+ return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ default:</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ memcpy(auth.u.umts.k, state->secret_k, sizeof(auth.u.umts.k));</span><br><span style="color: hsl(120, 100%, 40%);">+ memcpy(auth.u.umts.opc, state->secret_opc, sizeof(auth.u.umts.opc));</span><br><span style="color: hsl(120, 100%, 40%);">+ memset(auth.u.umts.amf, '\0', sizeof(auth.u.umts.amf));</span><br><span style="color: hsl(120, 100%, 40%);">+ auth.u.umts.sqn = 41; /* TODO use incrementing sequence nr */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ memset(&vec, 0, sizeof(vec));</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_auth_gen_vec(&vec, &auth, rx_random);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (vec.res_len != 8) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_ERROR, "OAP: Expected XRES to be 8 octets, got %d\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ vec.res_len);</span><br><span style="color: hsl(120, 100%, 40%);">+ return -3;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (osmo_constant_time_cmp(vec.autn, rx_autn, sizeof(vec.autn)) != 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_ERROR, "OAP: AUTN mismatch!\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_INFO, "OAP: AUTN from server: %s\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_hexdump_nospc(rx_autn, sizeof(vec.autn)));</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_INFO, "OAP: AUTN expected: %s\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_hexdump_nospc(vec.autn, sizeof(vec.autn)));</span><br><span style="color: hsl(120, 100%, 40%);">+ return -2;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (tx_xres != NULL)</span><br><span style="color: hsl(120, 100%, 40%);">+ memcpy(tx_xres, vec.res, 8);</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *oap_client_encoded(const struct osmo_oap_message *oap_msg)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg = msgb_alloc_headroom(1000, 64, __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ osmo_oap_encode(msg, oap_msg);</span><br><span style="color: hsl(120, 100%, 40%);">+ return msg;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Create a new msgb containing an OAP registration message.</span><br><span style="color: hsl(120, 100%, 40%);">+ * On error, return NULL. */</span><br><span style="color: hsl(120, 100%, 40%);">+static struct msgb* oap_msg_register(uint16_t client_id)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_oap_message oap_msg = {0};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (client_id < 1) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_ERROR, "OAP: Invalid client ID: %d\n", client_id);</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ oap_msg.message_type = OAP_MSGT_REGISTER_REQUEST;</span><br><span style="color: hsl(120, 100%, 40%);">+ oap_msg.client_id = client_id;</span><br><span style="color: hsl(120, 100%, 40%);">+ return oap_client_encoded(&oap_msg);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+int oap_client_register(struct oap_client_state *state, struct msgb **msg_tx)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ *msg_tx = oap_msg_register(state->client_id);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!(*msg_tx))</span><br><span style="color: hsl(120, 100%, 40%);">+ return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OAP_REQUESTED_CHALLENGE;</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* Create a new msgb containing an OAP challenge response message.</span><br><span style="color: hsl(120, 100%, 40%);">+ * xres must point at 8 octets to return as challenge response.</span><br><span style="color: hsl(120, 100%, 40%);">+ * On error, return NULL. */</span><br><span style="color: hsl(120, 100%, 40%);">+static struct msgb* oap_msg_challenge_response(uint8_t *xres)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_oap_message oap_reply = {0};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ oap_reply.message_type = OAP_MSGT_CHALLENGE_RESULT;</span><br><span style="color: hsl(120, 100%, 40%);">+ memcpy(oap_reply.xres, xres, sizeof(oap_reply.xres));</span><br><span style="color: hsl(120, 100%, 40%);">+ oap_reply.xres_present = 1;</span><br><span style="color: hsl(120, 100%, 40%);">+ return oap_client_encoded(&oap_reply);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static int handle_challenge(struct oap_client_state *state,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_oap_message *oap_rx,</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb **msg_tx)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t xres[8];</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!(oap_rx->rand_present && oap_rx->autn_present)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_ERROR,</span><br><span style="color: hsl(120, 100%, 40%);">+ "OAP challenge incomplete (rand_present: %d, autn_present: %d)\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ oap_rx->rand_present, oap_rx->autn_present);</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = -2;</span><br><span style="color: hsl(120, 100%, 40%);">+ goto failure;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = oap_evaluate_challenge(state,</span><br><span style="color: hsl(120, 100%, 40%);">+ oap_rx->rand,</span><br><span style="color: hsl(120, 100%, 40%);">+ oap_rx->autn,</span><br><span style="color: hsl(120, 100%, 40%);">+ xres);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ goto failure;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ *msg_tx = oap_msg_challenge_response(xres);</span><br><span style="color: hsl(120, 100%, 40%);">+ if ((*msg_tx) == NULL) {</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ goto failure;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OAP_SENT_CHALLENGE_RESULT;</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+failure:</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(rc < 0);</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OAP_INITIALIZED;</span><br><span style="color: hsl(120, 100%, 40%);">+ return rc;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+int oap_client_handle(struct oap_client_state *state,</span><br><span style="color: hsl(120, 100%, 40%);">+ const struct msgb *msg_rx, struct msgb **msg_tx)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t *data = msgb_l2(msg_rx);</span><br><span style="color: hsl(120, 100%, 40%);">+ size_t data_len = msgb_l2len(msg_rx);</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_oap_message oap_msg = {0};</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ *msg_tx = NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(data);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = osmo_oap_decode(&oap_msg, data, data_len);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_ERROR,</span><br><span style="color: hsl(120, 100%, 40%);">+ "Decoding OAP message failed with error '%s' (%d)\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ get_value_string(gsm48_gmm_cause_names, -rc), -rc);</span><br><span style="color: hsl(120, 100%, 40%);">+ return -10;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (state->state) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case OAP_UNINITIALIZED:</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_ERROR,</span><br><span style="color: hsl(120, 100%, 40%);">+ "Received OAP message %d, but the OAP client is"</span><br><span style="color: hsl(120, 100%, 40%);">+ " not initialized\n", oap_msg.message_type);</span><br><span style="color: hsl(120, 100%, 40%);">+ return -ENOTCONN;</span><br><span style="color: hsl(120, 100%, 40%);">+ case OAP_DISABLED:</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_ERROR,</span><br><span style="color: hsl(120, 100%, 40%);">+ "Received OAP message %d, but the OAP client is"</span><br><span style="color: hsl(120, 100%, 40%);">+ " disabled\n", oap_msg.message_type);</span><br><span style="color: hsl(120, 100%, 40%);">+ return -ENOTCONN;</span><br><span style="color: hsl(120, 100%, 40%);">+ default:</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (oap_msg.message_type) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case OAP_MSGT_CHALLENGE_REQUEST:</span><br><span style="color: hsl(120, 100%, 40%);">+ return handle_challenge(state, &oap_msg, msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ case OAP_MSGT_REGISTER_RESULT:</span><br><span style="color: hsl(120, 100%, 40%);">+ /* successfully registered */</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OAP_REGISTERED;</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ case OAP_MSGT_REGISTER_ERROR:</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_ERROR,</span><br><span style="color: hsl(120, 100%, 40%);">+ "OAP registration failed\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ state->state = OAP_INITIALIZED;</span><br><span style="color: hsl(120, 100%, 40%);">+ if (state->registration_failures < 3) {</span><br><span style="color: hsl(120, 100%, 40%);">+ state->registration_failures++;</span><br><span style="color: hsl(120, 100%, 40%);">+ return oap_client_register(state, msg_tx);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ return -11;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ case OAP_MSGT_REGISTER_REQUEST:</span><br><span style="color: hsl(120, 100%, 40%);">+ case OAP_MSGT_CHALLENGE_RESULT:</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_ERROR,</span><br><span style="color: hsl(120, 100%, 40%);">+ "Received invalid OAP message type for OAP client side: %d\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ (int)oap_msg.message_type);</span><br><span style="color: hsl(120, 100%, 40%);">+ return -12;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ default:</span><br><span style="color: hsl(120, 100%, 40%);">+ LOGP(DLOAP, LOGL_ERROR,</span><br><span style="color: hsl(120, 100%, 40%);">+ "Unknown OAP message type: %d\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ (int)oap_msg.message_type);</span><br><span style="color: hsl(120, 100%, 40%);">+ return -13;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/10113">change 10113</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/10113"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-hlr </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: Ief50054ad135551625b684ed8a0486f7af0b2940 </div>
<div style="display:none"> Gerrit-Change-Number: 10113 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Harald Welte <laforge@gnumonks.org> </div>