ctrl: completely replace all CTRL commands
The previous commands are not conforming to how the CTRL interface is intended
to work:
SET enable-ps <IMSI>
SET disable-ps <IMSI>
SET status-ps <IMSI>
'status-ps' is a write-only command even though it returns the status.
'enable-ps' / 'disable-ps' indicate the value instead of a variable name of an
entity. The entity <IMSI> takes the place of the variable value.
See also https://lists.osmocom.org/pipermail/openbsc/2017-September/011236.html
Instead, replace with
SET subscriber.by-imsi-123456.ps-enabled {0,1}
GET subscriber.by-imsi-123456.ps-enabled
and also provide further CTRL functions while at it:
{SET,GET} subscriber.by-{imsi,msisdn,id}-123456.{cs,ps}-enabled {0,1}
GET subscriber.by-{imsi,msisdn,id}-123456.{info,info-aud,info-all}
Provide CTRL tests in the form of transcripts.
Adjust tests/test_subscriber.sql to feature nonzero SQN, to see some values for
SQN in the CTRL transcript tests. (This does not affect the VTY tests, because
that creates its own subscribers, and there's no VTY command to set the SQN.)
This is the first time an application uses CTRL_NODE ids that are defined
outside of libosmocore, see 'Depends' below.
Implementation choice: the first idea was to have a '.' between the 'by-xxx'
and the value, like:
subscriber.by-xxx.123456.function
but the difficulty with subscribers is that they are not in RAM, and I can't
just point node_data at a struct instance that is always there (like, say, a
global bts[0] struct in osmo-bsc). Instead, I want to store the selector and
later decide whether to read from the DB or whatever. With a '.' separating
things, the only way in a ctrl function to obtain both 'by-xxx' and '123456'
for picking a subscriber record would be to parse the entire variable path
string elements, including 'subscriber' and 'function', which would then also
clumsily fix at which node level we hook these commands; there could have been
separate CTRL_NODE_SUBSCR_BY_{IMSI,MSISDN,ID} parent nodes, but we cannot
introspect the current parent node dynamically within a ctrl function handler
(plus I'm not sure whether it's possible and a good idea to have the same
command under multiple parent nodes).
Rather than that, I store the 'by-foo-123' token in the node_data pointer to
have both bits of information pointed at by a single pointer; I use the
incoming command parsing to get this token pre-separated from surrounding node
names, and no need to re-allocate it, since the vector of tokens lives until
after command execution is complete. Each leaf command obtains this token from
cmd->node (aka node_data), and feeds this token to a common static function to
parse selector and value from it and to retrieve a subscriber record as needed.
(BTW, I have mentioned on the mailing list that this way might be necessary to
avoid numeric-only CTRL node names, but we don't need to, and that is not at
all related to this choice of structure.)
Depends: libosmocore I1bd62ae0d4eefde7e1517db15a2155640a1bab58
libosmocore Ic9dba0e4a1eb5a7dc3cee2f181b9024ed4fc7005
Change-Id: I98ee6a06b3aa6a67adb868e0b63b0e04eb42eb50
diff --git a/src/ctrl.c b/src/ctrl.c
index b49765d..9297eb8 100644
--- a/src/ctrl.c
+++ b/src/ctrl.c
@@ -21,87 +21,370 @@
*/
#include <stdbool.h>
+#include <errno.h>
+#include <inttypes.h>
+#include <string.h>
-#include <osmocom/ctrl/control_cmd.h>
-#include <osmocom/ctrl/control_if.h>
+#include <osmocom/gsm/gsm23003.h>
#include <osmocom/ctrl/ports.h>
-#include "gsup_server.h"
-#include "logging.h"
-#include "db.h"
#include "hlr.h"
-#include "luop.h"
#include "ctrl.h"
+#include "db.h"
-static int handle_cmd_ps(struct hlr *ctx, struct ctrl_cmd *cmd, bool enable)
+#define SEL_BY "by-"
+#define SEL_BY_IMSI SEL_BY "imsi-"
+#define SEL_BY_MSISDN SEL_BY "msisdn-"
+#define SEL_BY_ID SEL_BY "id-"
+
+#define hexdump_buf(buf) osmo_hexdump_nospc((void*)buf, sizeof(buf))
+
+static bool startswith(const char *str, const char *start)
+{
+ return strncmp(str, start, strlen(start)) == 0;
+}
+
+static int _get_subscriber(struct db_context *dbc,
+ const char *by_selector,
+ struct hlr_subscriber *subscr)
+{
+ const char *val;
+ if (startswith(by_selector, SEL_BY_IMSI)) {
+ val = by_selector + strlen(SEL_BY_IMSI);
+ if (!osmo_imsi_str_valid(val))
+ return -EINVAL;
+ return db_subscr_get_by_imsi(dbc, val, subscr);
+ }
+ if (startswith(by_selector, SEL_BY_MSISDN)) {
+ val = by_selector + strlen(SEL_BY_MSISDN);
+ if (!osmo_msisdn_str_valid(val))
+ return -EINVAL;
+ return db_subscr_get_by_msisdn(dbc, val, subscr);
+ }
+ if (startswith(by_selector, SEL_BY_ID)) {
+ int64_t id;
+ char *endptr;
+ val = by_selector + strlen(SEL_BY_ID);
+ if (*val == '+')
+ return -EINVAL;
+ errno = 0;
+ id = strtoll(val, &endptr, 10);
+ if (errno || *endptr)
+ return -EINVAL;
+ return db_subscr_get_by_id(dbc, id, subscr);
+ }
+ return -ENOTSUP;
+}
+
+static bool get_subscriber(struct db_context *dbc,
+ const char *by_selector,
+ struct hlr_subscriber *subscr,
+ struct ctrl_cmd *cmd)
+{
+ int rc = _get_subscriber(dbc, by_selector, subscr);
+ switch (rc) {
+ case 0:
+ return true;
+ case -ENOTSUP:
+ cmd->reply = "Not a known subscriber 'by-xxx-' selector.";
+ return false;
+ case -EINVAL:
+ cmd->reply = "Invalid value part of 'by-xxx-value' selector.";
+ return false;
+ case -ENOENT:
+ cmd->reply = "No such subscriber.";
+ return false;
+ default:
+ cmd->reply = "An unknown error has occured during get_subscriber().";
+ return false;
+ }
+}
+
+/* Optimization: if a subscriber operation is requested by-imsi, just return
+ * the IMSI right back. */
+static const char *get_subscriber_imsi(struct db_context *dbc,
+ const char *by_selector,
+ struct ctrl_cmd *cmd)
+{
+ static struct hlr_subscriber subscr;
+
+ if (startswith(by_selector, SEL_BY_IMSI))
+ return by_selector + strlen(SEL_BY_IMSI);
+ if (!get_subscriber(dbc, by_selector, &subscr, cmd))
+ return NULL;
+ return subscr.imsi;
+}
+
+/* printf fmt and arg to completely omit a string if it is empty. */
+#define FMT_S "%s%s%s%s"
+#define ARG_S(name, val) \
+ (val) && *(val) ? "\n" : "", \
+ (val) && *(val) ? name : "", \
+ (val) && *(val) ? "\t" : "", \
+ (val) && *(val) ? (val) : "" \
+
+/* printf fmt and arg to completely omit bool of given value. */
+#define FMT_BOOL "%s"
+#define ARG_BOOL(name, val) \
+ val ? "\n" name "\t1" : "\n" name "\t0"
+
+static void print_subscr_info(struct ctrl_cmd *cmd,
+ struct hlr_subscriber *subscr)
+{
+ ctrl_cmd_reply_printf(cmd,
+ "\nid\t%"PRIu64
+ FMT_S
+ FMT_S
+ FMT_BOOL
+ FMT_BOOL
+ FMT_S
+ FMT_S
+ FMT_S
+ FMT_BOOL
+ FMT_BOOL
+ "\nperiodic_lu_timer\t%u"
+ "\nperiodic_rau_tau_timer\t%u"
+ "\nlmsi\t%08x"
+ ,
+ subscr->id,
+ ARG_S("imsi", subscr->imsi),
+ ARG_S("msisdn", subscr->msisdn),
+ ARG_BOOL("nam_cs", subscr->nam_cs),
+ ARG_BOOL("nam_ps", subscr->nam_ps),
+ ARG_S("vlr_number", subscr->vlr_number),
+ ARG_S("sgsn_number", subscr->sgsn_number),
+ ARG_S("sgsn_address", subscr->sgsn_address),
+ ARG_BOOL("ms_purged_cs", subscr->ms_purged_cs),
+ ARG_BOOL("ms_purged_ps", subscr->ms_purged_ps),
+ subscr->periodic_lu_timer,
+ subscr->periodic_rau_tau_timer,
+ subscr->lmsi
+ );
+}
+
+static void print_subscr_info_aud2g(struct ctrl_cmd *cmd, struct osmo_sub_auth_data *aud)
+{
+ if (aud->algo == OSMO_AUTH_ALG_NONE)
+ return;
+ ctrl_cmd_reply_printf(cmd,
+ "\naud2g.algo\t%s"
+ "\naud2g.ki\t%s"
+ ,
+ osmo_auth_alg_name(aud->algo),
+ hexdump_buf(aud->u.gsm.ki));
+}
+
+static void print_subscr_info_aud3g(struct ctrl_cmd *cmd, struct osmo_sub_auth_data *aud)
+{
+ if (aud->algo == OSMO_AUTH_ALG_NONE)
+ return;
+ ctrl_cmd_reply_printf(cmd,
+ "\naud3g.algo\t%s"
+ "\naud3g.k\t%s"
+ ,
+ osmo_auth_alg_name(aud->algo),
+ hexdump_buf(aud->u.umts.k));
+ /* hexdump uses a static string buffer, hence only one hexdump per
+ * printf(). */
+ ctrl_cmd_reply_printf(cmd,
+ "\naud3g.%s\t%s"
+ "\naud3g.ind_bitlen\t%u"
+ "\naud3g.sqn\t%"PRIu64
+ ,
+ aud->u.umts.opc_is_op? "op" : "opc",
+ hexdump_buf(aud->u.umts.opc),
+ aud->u.umts.ind_bitlen,
+ aud->u.umts.sqn);
+}
+
+CTRL_CMD_DEFINE_RO(subscr_info, "info");
+static int get_subscr_info(struct ctrl_cmd *cmd, void *data)
{
struct hlr_subscriber subscr;
+ struct hlr *hlr = data;
+ const char *by_selector = cmd->node;
- if (db_subscr_get_by_imsi(ctx->dbc, cmd->value, &subscr) < 0) {
- cmd->reply = "Subscriber Unknown in HLR";
+ if (!get_subscriber(hlr->dbc, by_selector, &subscr, cmd))
+ return CTRL_CMD_ERROR;
+
+ print_subscr_info(cmd, &subscr);
+
+ return CTRL_CMD_REPLY;
+}
+
+CTRL_CMD_DEFINE_RO(subscr_info_aud, "info-aud");
+static int get_subscr_info_aud(struct ctrl_cmd *cmd, void *data)
+{
+ const char *imsi;
+ struct osmo_sub_auth_data aud2g;
+ struct osmo_sub_auth_data aud3g;
+ struct hlr *hlr = data;
+ const char *by_selector = cmd->node;
+ int rc;
+
+ imsi = get_subscriber_imsi(hlr->dbc, by_selector, cmd);
+ if (!imsi)
+ return CTRL_CMD_ERROR;
+
+ rc = db_get_auth_data(hlr->dbc, imsi, &aud2g, &aud3g, NULL);
+
+ if (rc == -ENOENT) {
+ aud2g.algo = OSMO_AUTH_ALG_NONE;
+ aud3g.algo = OSMO_AUTH_ALG_NONE;
+ } else if (rc) {
+ cmd->reply = "Error retrieving authentication data.";
return CTRL_CMD_ERROR;
}
- if (hlr_subscr_nam(ctx, &subscr, enable, true) < 0) {
- cmd->reply = "Error updating DB";
+ print_subscr_info_aud2g(cmd, &aud2g);
+ print_subscr_info_aud3g(cmd, &aud3g);
+
+ return CTRL_CMD_REPLY;
+}
+
+CTRL_CMD_DEFINE_RO(subscr_info_all, "info-all");
+static int get_subscr_info_all(struct ctrl_cmd *cmd, void *data)
+{
+ struct hlr_subscriber subscr;
+ struct osmo_sub_auth_data aud2g;
+ struct osmo_sub_auth_data aud3g;
+ struct hlr *hlr = data;
+ const char *by_selector = cmd->node;
+ int rc;
+
+ if (!get_subscriber(hlr->dbc, by_selector, &subscr, cmd))
+ return CTRL_CMD_ERROR;
+
+ rc = db_get_auth_data(hlr->dbc, subscr.imsi, &aud2g, &aud3g, NULL);
+
+ if (rc == -ENOENT) {
+ aud2g.algo = OSMO_AUTH_ALG_NONE;
+ aud3g.algo = OSMO_AUTH_ALG_NONE;
+ } else if (rc) {
+ cmd->reply = "Error retrieving authentication data.";
return CTRL_CMD_ERROR;
}
+ print_subscr_info(cmd, &subscr);
+ print_subscr_info_aud2g(cmd, &aud2g);
+ print_subscr_info_aud3g(cmd, &aud3g);
+
+ return CTRL_CMD_REPLY;
+}
+
+static int verify_subscr_cs_ps_enabled(struct ctrl_cmd *cmd, const char *value, void *data)
+{
+ if (!value || !*value
+ || (strcmp(value, "0") && strcmp(value, "1")))
+ return 1;
+ return 0;
+}
+
+static int get_subscr_cs_ps_enabled(struct ctrl_cmd *cmd, void *data,
+ bool is_ps)
+{
+ struct hlr_subscriber subscr;
+ struct hlr *hlr = data;
+ const char *by_selector = cmd->node;
+
+ if (!get_subscriber(hlr->dbc, by_selector, &subscr, cmd))
+ return CTRL_CMD_ERROR;
+
+ cmd->reply = (is_ps ? subscr.nam_ps : subscr.nam_cs)
+ ? "1" : "0";
+ return CTRL_CMD_REPLY;
+}
+
+static int set_subscr_cs_ps_enabled(struct ctrl_cmd *cmd, void *data,
+ bool is_ps)
+{
+ const char *imsi;
+ struct hlr *hlr = data;
+ const char *by_selector = cmd->node;
+
+ imsi = get_subscriber_imsi(hlr->dbc, by_selector, cmd);
+ if (!imsi)
+ return CTRL_CMD_ERROR;
+ if (db_subscr_nam(hlr->dbc, imsi, strcmp(cmd->value, "1") == 0, is_ps))
+ return CTRL_CMD_ERROR;
cmd->reply = "OK";
return CTRL_CMD_REPLY;
}
-CTRL_CMD_DEFINE_WO_NOVRF(enable_ps, "enable-ps");
-static int set_enable_ps(struct ctrl_cmd *cmd, void *data)
+CTRL_CMD_DEFINE(subscr_ps_enabled, "ps-enabled");
+static int verify_subscr_ps_enabled(struct ctrl_cmd *cmd, const char *value, void *data)
{
- return handle_cmd_ps(data, cmd, true);
+ return verify_subscr_cs_ps_enabled(cmd, value, data);
+}
+static int get_subscr_ps_enabled(struct ctrl_cmd *cmd, void *data)
+{
+ return get_subscr_cs_ps_enabled(cmd, data, true);
+}
+static int set_subscr_ps_enabled(struct ctrl_cmd *cmd, void *data)
+{
+ return set_subscr_cs_ps_enabled(cmd, data, true);
}
-CTRL_CMD_DEFINE_WO_NOVRF(disable_ps, "disable-ps");
-static int set_disable_ps(struct ctrl_cmd *cmd, void *data)
+CTRL_CMD_DEFINE(subscr_cs_enabled, "cs-enabled");
+static int verify_subscr_cs_enabled(struct ctrl_cmd *cmd, const char *value, void *data)
{
- return handle_cmd_ps(data, cmd, false);
+ return verify_subscr_cs_ps_enabled(cmd, value, data);
}
-
-CTRL_CMD_DEFINE_WO_NOVRF(status_ps, "status-ps");
-static int set_status_ps(struct ctrl_cmd *cmd, void *data)
+static int get_subscr_cs_enabled(struct ctrl_cmd *cmd, void *data)
{
- struct hlr *ctx = data;
- struct lu_operation *luop = lu_op_alloc(ctx->gs);
- if (!luop) {
- cmd->reply = "Internal HLR error";
- return CTRL_CMD_ERROR;
- }
-
- if (!lu_op_fill_subscr(luop, ctx->dbc, cmd->value)) {
- cmd->reply = "Subscriber Unknown in HLR";
- return CTRL_CMD_ERROR;
- }
-
- cmd->reply = luop->subscr.nam_ps ? "1" : "0";
-
- return CTRL_CMD_REPLY;
+ return get_subscr_cs_ps_enabled(cmd, data, false);
+}
+static int set_subscr_cs_enabled(struct ctrl_cmd *cmd, void *data)
+{
+ return set_subscr_cs_ps_enabled(cmd, data, false);
}
int hlr_ctrl_cmds_install()
{
int rc = 0;
- rc |= ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_enable_ps);
- rc |= ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_disable_ps);
- rc |= ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_status_ps);
+ rc |= ctrl_cmd_install(CTRL_NODE_SUBSCR_BY, &cmd_subscr_info);
+ rc |= ctrl_cmd_install(CTRL_NODE_SUBSCR_BY, &cmd_subscr_info_aud);
+ rc |= ctrl_cmd_install(CTRL_NODE_SUBSCR_BY, &cmd_subscr_info_all);
+ rc |= ctrl_cmd_install(CTRL_NODE_SUBSCR_BY, &cmd_subscr_ps_enabled);
+ rc |= ctrl_cmd_install(CTRL_NODE_SUBSCR_BY, &cmd_subscr_cs_enabled);
return rc;
}
+static int hlr_ctrl_node_lookup(void *data, vector vline, int *node_type,
+ void **node_data, int *i)
+{
+ const char *token = vector_slot(vline, *i);
+
+ switch (*node_type) {
+ case CTRL_NODE_ROOT:
+ if (strcmp(token, "subscriber") != 0)
+ return 0;
+ *node_data = NULL;
+ *node_type = CTRL_NODE_SUBSCR;
+ break;
+ case CTRL_NODE_SUBSCR:
+ if (!startswith(token, "by-"))
+ return 0;
+ *node_data = (void*)token;
+ *node_type = CTRL_NODE_SUBSCR_BY;
+ break;
+ default:
+ return 0;
+ }
+
+ return 1;
+}
+
struct ctrl_handle *hlr_controlif_setup(struct hlr *hlr)
{
int rc;
struct ctrl_handle *hdl = ctrl_interface_setup_dynip2(hlr,
hlr->ctrl_bind_addr,
OSMO_CTRL_PORT_HLR,
- NULL,
- 0);
+ hlr_ctrl_node_lookup,
+ _LAST_CTRL_NODE_HLR);
if (!hdl)
return NULL;