Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Harald Welte | e687be5 | 2016-05-03 18:49:27 +0200 | [diff] [blame] | 3 | #include <stdbool.h> |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 4 | #include <sqlite3.h> |
| 5 | |
Neels Hofmeyr | 00b1d43 | 2017-10-17 01:43:48 +0200 | [diff] [blame] | 6 | struct hlr; |
| 7 | |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 8 | enum stmt_idx { |
Neels Hofmeyr | 4bde949 | 2017-10-06 03:09:34 +0200 | [diff] [blame] | 9 | DB_STMT_SEL_BY_IMSI, |
Neels Hofmeyr | 9c2bbc8 | 2017-10-09 17:30:32 +0200 | [diff] [blame] | 10 | DB_STMT_SEL_BY_MSISDN, |
| 11 | DB_STMT_SEL_BY_ID, |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 12 | DB_STMT_SEL_BY_IMEI, |
Neels Hofmeyr | 4bde949 | 2017-10-06 03:09:34 +0200 | [diff] [blame] | 13 | DB_STMT_UPD_VLR_BY_ID, |
| 14 | DB_STMT_UPD_SGSN_BY_ID, |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 15 | DB_STMT_UPD_IMEI_BY_IMSI, |
Neels Hofmeyr | 4bde949 | 2017-10-06 03:09:34 +0200 | [diff] [blame] | 16 | DB_STMT_AUC_BY_IMSI, |
| 17 | DB_STMT_AUC_UPD_SQN, |
| 18 | DB_STMT_UPD_PURGE_CS_BY_IMSI, |
| 19 | DB_STMT_UPD_PURGE_PS_BY_IMSI, |
Neels Hofmeyr | e8ccd50 | 2017-10-06 04:10:06 +0200 | [diff] [blame] | 20 | DB_STMT_UPD_NAM_PS_BY_IMSI, |
| 21 | DB_STMT_UPD_NAM_CS_BY_IMSI, |
Neels Hofmeyr | f7c3e6e | 2017-10-09 17:55:16 +0200 | [diff] [blame] | 22 | DB_STMT_SUBSCR_CREATE, |
| 23 | DB_STMT_DEL_BY_ID, |
| 24 | DB_STMT_SET_MSISDN_BY_IMSI, |
Neels Hofmeyr | a820ea1 | 2018-12-02 19:46:46 +0100 | [diff] [blame] | 25 | DB_STMT_DELETE_MSISDN_BY_IMSI, |
Neels Hofmeyr | 1332a17 | 2017-10-10 02:25:00 +0200 | [diff] [blame] | 26 | DB_STMT_AUC_2G_INSERT, |
| 27 | DB_STMT_AUC_2G_DELETE, |
| 28 | DB_STMT_AUC_3G_INSERT, |
| 29 | DB_STMT_AUC_3G_DELETE, |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 30 | DB_STMT_SET_LAST_LU_SEEN, |
Oliver Smith | 6b73fd9 | 2019-03-06 13:49:05 +0100 | [diff] [blame] | 31 | DB_STMT_EXISTS_BY_IMSI, |
Vadim Yanitskiy | c13599d | 2019-03-30 17:03:42 +0700 | [diff] [blame] | 32 | DB_STMT_EXISTS_BY_MSISDN, |
Neels Hofmeyr | 4bde949 | 2017-10-06 03:09:34 +0200 | [diff] [blame] | 33 | _NUM_DB_STMT |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 34 | }; |
| 35 | |
| 36 | struct db_context { |
| 37 | char *fname; |
| 38 | sqlite3 *db; |
Neels Hofmeyr | 4bde949 | 2017-10-06 03:09:34 +0200 | [diff] [blame] | 39 | sqlite3_stmt *stmt[_NUM_DB_STMT]; |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 40 | }; |
| 41 | |
Vadim Yanitskiy | fbd736e | 2018-07-31 22:40:30 +0700 | [diff] [blame] | 42 | /* Optional feature to make SQLite3 using talloc */ |
| 43 | #ifdef SQLITE_USE_TALLOC |
| 44 | int db_sqlite3_use_talloc(void *ctx); |
| 45 | #endif |
| 46 | |
Neels Hofmeyr | d7d9697 | 2017-10-06 03:50:30 +0200 | [diff] [blame] | 47 | void db_remove_reset(sqlite3_stmt *stmt); |
Neels Hofmeyr | f314459 | 2017-10-06 03:40:52 +0200 | [diff] [blame] | 48 | bool db_bind_text(sqlite3_stmt *stmt, const char *param_name, const char *text); |
Neels Hofmeyr | 28da26e | 2017-10-06 03:44:57 +0200 | [diff] [blame] | 49 | bool db_bind_int(sqlite3_stmt *stmt, const char *param_name, int nr); |
| 50 | bool db_bind_int64(sqlite3_stmt *stmt, const char *param_name, int64_t nr); |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 51 | void db_close(struct db_context *dbc); |
Stefan Sperling | 8f3a7cc | 2018-11-27 12:10:45 +0100 | [diff] [blame] | 52 | struct db_context *db_open(void *ctx, const char *fname, bool enable_sqlite3_logging, bool allow_upgrades); |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 53 | |
| 54 | #include <osmocom/crypt/auth.h> |
| 55 | |
| 56 | /* obtain the authentication data for a given imsi */ |
| 57 | int db_get_auth_data(struct db_context *dbc, const char *imsi, |
| 58 | struct osmo_sub_auth_data *aud2g, |
| 59 | struct osmo_sub_auth_data *aud3g, |
Neels Hofmeyr | 32633e2 | 2017-10-06 04:26:21 +0200 | [diff] [blame] | 60 | int64_t *subscr_id); |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 61 | |
Neels Hofmeyr | 32633e2 | 2017-10-06 04:26:21 +0200 | [diff] [blame] | 62 | int db_update_sqn(struct db_context *dbc, int64_t id, |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 63 | uint64_t new_sqn); |
| 64 | |
| 65 | int db_get_auc(struct db_context *dbc, const char *imsi, |
Neels Hofmeyr | cab2fcd | 2017-03-15 00:07:43 +0100 | [diff] [blame] | 66 | unsigned int auc_3g_ind, struct osmo_auth_vector *vec, |
| 67 | unsigned int num_vec, const uint8_t *rand_auts, |
| 68 | const uint8_t *auts); |
Harald Welte | e687be5 | 2016-05-03 18:49:27 +0200 | [diff] [blame] | 69 | |
| 70 | #include <osmocom/core/linuxlist.h> |
| 71 | #include <osmocom/gsm/protocol/gsm_23_003.h> |
| 72 | |
| 73 | /* TODO: Get this from somewhere? */ |
| 74 | #define GT_MAX_DIGITS 15 |
| 75 | |
| 76 | struct hlr_subscriber { |
| 77 | struct llist_head list; |
| 78 | |
Neels Hofmeyr | 32633e2 | 2017-10-06 04:26:21 +0200 | [diff] [blame] | 79 | int64_t id; |
Harald Welte | e687be5 | 2016-05-03 18:49:27 +0200 | [diff] [blame] | 80 | char imsi[GSM23003_IMSI_MAX_DIGITS+1]; |
Vadim Yanitskiy | 2e403d6 | 2019-05-25 19:12:33 +0700 | [diff] [blame] | 81 | char msisdn[GSM23003_MSISDN_MAX_DIGITS+1]; |
Harald Welte | e687be5 | 2016-05-03 18:49:27 +0200 | [diff] [blame] | 82 | /* imeisv? */ |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 83 | char imei[GSM23003_IMEI_NUM_DIGITS+1]; |
Neels Hofmeyr | d646207 | 2018-09-28 01:22:15 +0200 | [diff] [blame] | 84 | char vlr_number[32]; |
| 85 | char sgsn_number[32]; |
Harald Welte | e687be5 | 2016-05-03 18:49:27 +0200 | [diff] [blame] | 86 | char sgsn_address[GT_MAX_DIGITS+1]; |
| 87 | /* ggsn number + address */ |
| 88 | /* gmlc number */ |
| 89 | /* smsc number */ |
| 90 | uint32_t periodic_lu_timer; |
| 91 | uint32_t periodic_rau_tau_timer; |
| 92 | bool nam_cs; |
| 93 | bool nam_ps; |
| 94 | uint32_t lmsi; |
| 95 | bool ms_purged_cs; |
| 96 | bool ms_purged_ps; |
Stefan Sperling | 5c14c9c | 2018-12-07 12:30:21 +0100 | [diff] [blame] | 97 | time_t last_lu_seen; |
Harald Welte | e687be5 | 2016-05-03 18:49:27 +0200 | [diff] [blame] | 98 | }; |
| 99 | |
Stefan Sperling | 5c14c9c | 2018-12-07 12:30:21 +0100 | [diff] [blame] | 100 | /* A format string for use with strptime(3). This format string is |
| 101 | * used to parse the last_lu_seen column stored in the HLR database. |
| 102 | * See https://sqlite.org/lang_datefunc.html, function datetime(). */ |
| 103 | #define DB_LAST_LU_SEEN_FMT "%Y-%m-%d %H:%M:%S" |
| 104 | |
Neels Hofmeyr | 1332a17 | 2017-10-10 02:25:00 +0200 | [diff] [blame] | 105 | /* Like struct osmo_sub_auth_data, but the keys are in hexdump representation. |
| 106 | * This is useful because SQLite requires them in hexdump format, and callers |
| 107 | * like the VTY and CTRL interface also have them available as hexdump to begin |
| 108 | * with. In the binary format, a VTY command would first need to hexparse, |
| 109 | * after which the db function would again hexdump, copying to separate |
| 110 | * buffers. The roundtrip can be saved by providing char* to begin with. */ |
| 111 | struct sub_auth_data_str { |
| 112 | enum osmo_sub_auth_type type; |
| 113 | enum osmo_auth_algo algo; |
| 114 | union { |
| 115 | struct { |
| 116 | const char *opc; |
| 117 | const char *k; |
| 118 | uint64_t sqn; |
| 119 | int opc_is_op; |
| 120 | unsigned int ind_bitlen; |
| 121 | } umts; |
| 122 | struct { |
| 123 | const char *ki; |
| 124 | } gsm; |
| 125 | } u; |
| 126 | }; |
| 127 | |
Oliver Smith | cd2af5e | 2019-03-06 13:17:39 +0100 | [diff] [blame] | 128 | #define DB_SUBSCR_FLAG_NAM_CS (1 << 1) |
| 129 | #define DB_SUBSCR_FLAG_NAM_PS (1 << 2) |
| 130 | |
| 131 | int db_subscr_create(struct db_context *dbc, const char *imsi, uint8_t flags); |
Neels Hofmeyr | f7c3e6e | 2017-10-09 17:55:16 +0200 | [diff] [blame] | 132 | int db_subscr_delete_by_id(struct db_context *dbc, int64_t subscr_id); |
| 133 | |
| 134 | int db_subscr_update_msisdn_by_imsi(struct db_context *dbc, const char *imsi, |
| 135 | const char *msisdn); |
Neels Hofmeyr | 1332a17 | 2017-10-10 02:25:00 +0200 | [diff] [blame] | 136 | int db_subscr_update_aud_by_id(struct db_context *dbc, int64_t subscr_id, |
| 137 | const struct sub_auth_data_str *aud); |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 138 | int db_subscr_update_imei_by_imsi(struct db_context *dbc, const char* imsi, const char *imei); |
Neels Hofmeyr | f7c3e6e | 2017-10-09 17:55:16 +0200 | [diff] [blame] | 139 | |
Oliver Smith | 6b73fd9 | 2019-03-06 13:49:05 +0100 | [diff] [blame] | 140 | int db_subscr_exists_by_imsi(struct db_context *dbc, const char *imsi); |
Vadim Yanitskiy | c13599d | 2019-03-30 17:03:42 +0700 | [diff] [blame] | 141 | int db_subscr_exists_by_msisdn(struct db_context *dbc, const char *msisdn); |
Oliver Smith | 6b73fd9 | 2019-03-06 13:49:05 +0100 | [diff] [blame] | 142 | |
Neels Hofmeyr | 518335e | 2017-10-06 03:20:14 +0200 | [diff] [blame] | 143 | int db_subscr_get_by_imsi(struct db_context *dbc, const char *imsi, |
| 144 | struct hlr_subscriber *subscr); |
Neels Hofmeyr | 9c2bbc8 | 2017-10-09 17:30:32 +0200 | [diff] [blame] | 145 | int db_subscr_get_by_msisdn(struct db_context *dbc, const char *msisdn, |
| 146 | struct hlr_subscriber *subscr); |
| 147 | int db_subscr_get_by_id(struct db_context *dbc, int64_t id, |
| 148 | struct hlr_subscriber *subscr); |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 149 | int db_subscr_get_by_imei(struct db_context *dbc, const char *imei, struct hlr_subscriber *subscr); |
Neels Hofmeyr | e8ccd50 | 2017-10-06 04:10:06 +0200 | [diff] [blame] | 150 | int db_subscr_nam(struct db_context *dbc, const char *imsi, bool nam_val, bool is_ps); |
Neels Hofmeyr | dd78305 | 2017-10-09 17:36:08 +0200 | [diff] [blame] | 151 | int db_subscr_lu(struct db_context *dbc, int64_t subscr_id, |
| 152 | const char *vlr_or_sgsn_number, bool is_ps); |
Harald Welte | b18f0e0 | 2016-05-05 21:03:03 +0200 | [diff] [blame] | 153 | |
Neels Hofmeyr | e50121e | 2017-10-09 17:48:51 +0200 | [diff] [blame] | 154 | int db_subscr_purge(struct db_context *dbc, const char *by_imsi, |
| 155 | bool purge_val, bool is_ps); |
Neels Hofmeyr | 00b1d43 | 2017-10-17 01:43:48 +0200 | [diff] [blame] | 156 | |
| 157 | int hlr_subscr_nam(struct hlr *hlr, struct hlr_subscriber *subscr, bool nam_val, bool is_ps); |
Neels Hofmeyr | 73d14af | 2017-10-24 23:26:53 +0200 | [diff] [blame] | 158 | |
| 159 | /*! Call sqlite3_column_text() and copy result to a char[]. |
| 160 | * \param[out] buf A char[] used as sizeof() arg(!) and osmo_strlcpy() target. |
| 161 | * \param[in] stmt An sqlite3_stmt*. |
| 162 | * \param[in] idx Index in stmt's returned columns. |
| 163 | */ |
| 164 | #define copy_sqlite3_text_to_buf(buf, stmt, idx) \ |
| 165 | do { \ |
| 166 | const char *_txt = (const char *) sqlite3_column_text(stmt, idx); \ |
| 167 | osmo_strlcpy(buf, _txt, sizeof(buf)); \ |
| 168 | } while (0) |