Neels Hofmeyr | 9cd1e74 | 2017-10-04 03:15:47 +0200 | [diff] [blame] | 1 | /*! \file gsm23003.c |
| 2 | * Utility function implementations related to 3GPP TS 23.003 */ |
| 3 | /* |
Harald Welte | e08da97 | 2017-11-13 01:00:26 +0900 | [diff] [blame] | 4 | * (C) 2017 sysmocom - s.f.m.c. GmbH <info@sysmocom.de> |
| 5 | * Author: Neels Hofmeyr <nhofmeyr@sysmocom.de> |
Neels Hofmeyr | 9cd1e74 | 2017-10-04 03:15:47 +0200 | [diff] [blame] | 6 | * All Rights Reserved |
| 7 | * |
Harald Welte | e08da97 | 2017-11-13 01:00:26 +0900 | [diff] [blame] | 8 | * SPDX-License-Identifier: GPL-2.0+ |
Neels Hofmeyr | 9cd1e74 | 2017-10-04 03:15:47 +0200 | [diff] [blame] | 9 | * |
| 10 | * This program is free software; you can redistribute it and/or modify |
| 11 | * it under the terms of the GNU General Public License as published by |
| 12 | * the Free Software Foundation; either version 2 of the License, or |
| 13 | * (at your option) any later version. |
| 14 | * |
| 15 | * This program is distributed in the hope that it will be useful, |
| 16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 18 | * GNU General Public License for more details. |
| 19 | * |
| 20 | * You should have received a copy of the GNU General Public License along |
| 21 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 22 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 23 | * |
| 24 | */ |
| 25 | |
| 26 | #include <ctype.h> |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 27 | #include <stdio.h> |
Neels Hofmeyr | 721aa6d | 2018-02-20 21:38:00 +0100 | [diff] [blame] | 28 | #include <stdlib.h> |
| 29 | #include <errno.h> |
| 30 | #include <string.h> |
Neels Hofmeyr | 9cd1e74 | 2017-10-04 03:15:47 +0200 | [diff] [blame] | 31 | |
| 32 | #include <osmocom/gsm/gsm23003.h> |
| 33 | #include <osmocom/gsm/protocol/gsm_23_003.h> |
Oliver Smith | 894be2d | 2019-01-11 13:13:37 +0100 | [diff] [blame] | 34 | #include <osmocom/core/utils.h> |
Neels Hofmeyr | 9cd1e74 | 2017-10-04 03:15:47 +0200 | [diff] [blame] | 35 | |
| 36 | static bool is_n_digits(const char *str, int min_digits, int max_digits) |
| 37 | { |
| 38 | int len; |
| 39 | /* Use unsigned char * to avoid a compiler warning of |
| 40 | * "error: array subscript has type 'char' [-Werror=char-subscripts]" */ |
| 41 | const unsigned char *pos = (const unsigned char *)str; |
Neels Hofmeyr | 4b7c791 | 2017-10-07 04:45:01 +0200 | [diff] [blame] | 42 | if (!pos) |
| 43 | return min_digits < 1; |
Neels Hofmeyr | 9cd1e74 | 2017-10-04 03:15:47 +0200 | [diff] [blame] | 44 | for (len = 0; *pos && len < max_digits; len++, pos++) |
| 45 | if (!isdigit(*pos)) |
| 46 | return false; |
| 47 | if (len < min_digits) |
| 48 | return false; |
| 49 | /* With not too many digits, we should have reached *str == nul */ |
| 50 | if (*pos) |
| 51 | return false; |
| 52 | return true; |
| 53 | } |
| 54 | |
| 55 | /*! Determine whether the given IMSI is valid according to 3GPP TS 23.003. |
| 56 | * \param imsi IMSI digits in ASCII string representation. |
| 57 | * \returns true when the IMSI is valid, false for invalid characters or number |
| 58 | * of digits. |
| 59 | */ |
| 60 | bool osmo_imsi_str_valid(const char *imsi) |
| 61 | { |
| 62 | return is_n_digits(imsi, GSM23003_IMSI_MIN_DIGITS, GSM23003_IMSI_MAX_DIGITS); |
| 63 | } |
| 64 | |
| 65 | /*! Determine whether the given MSISDN is valid according to 3GPP TS 23.003. |
| 66 | * \param msisdn MSISDN digits in ASCII string representation. |
| 67 | * \returns true when the MSISDN is valid, false for invalid characters or number |
| 68 | * of digits. |
| 69 | */ |
| 70 | bool osmo_msisdn_str_valid(const char *msisdn) |
| 71 | { |
Oliver Smith | cdac620 | 2019-05-10 11:28:27 +0200 | [diff] [blame] | 72 | return is_n_digits(msisdn, GSM23003_MSISDN_MIN_DIGITS, GSM23003_MSISDN_MAX_DIGITS); |
Neels Hofmeyr | 9cd1e74 | 2017-10-04 03:15:47 +0200 | [diff] [blame] | 73 | } |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 74 | |
Oliver Smith | 894be2d | 2019-01-11 13:13:37 +0100 | [diff] [blame] | 75 | /*! Determine whether the given IMEI is valid according to 3GPP TS 23.003, |
| 76 | * Section 6.2.1. It consists of 14 digits, the 15th check digit is not |
| 77 | * intended for digital transmission. |
| 78 | * \param imei IMEI digits in ASCII string representation. |
| 79 | * \param with_15th_digit when true, expect the 15th digit to be present and |
| 80 | * verify it. |
| 81 | * \returns true when the IMEI is valid, false for invalid characters or number |
| 82 | * of digits. |
| 83 | */ |
| 84 | bool osmo_imei_str_valid(const char *imei, bool with_15th_digit) |
| 85 | { |
| 86 | if (with_15th_digit) |
| 87 | return is_n_digits(imei, 15, 15) && osmo_luhn(imei, 14) == imei[14]; |
| 88 | else |
| 89 | return is_n_digits(imei, 14, 14); |
| 90 | } |
| 91 | |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 92 | /*! Return MCC string as standardized 3-digit with leading zeros. |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 93 | * \param[out] buf caller-allocated output buffer |
| 94 | * \param[in] buf_len size of buf in bytes |
| 95 | * \param[in] mcc MCC value. |
| 96 | * \returns string in user-supplied output buffer |
| 97 | */ |
| 98 | char *osmo_mcc_name_buf(char *buf, size_t buf_len, uint16_t mcc) |
| 99 | { |
| 100 | snprintf(buf, buf_len, "%03u", mcc); |
| 101 | return buf; |
| 102 | } |
| 103 | |
| 104 | /*! Return MCC string as standardized 3-digit with leading zeros. |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 105 | * \param[in] mcc MCC value. |
| 106 | * \returns string in static buffer. |
| 107 | */ |
| 108 | const char *osmo_mcc_name(uint16_t mcc) |
| 109 | { |
Harald Welte | 171ef82 | 2019-03-28 10:49:05 +0100 | [diff] [blame] | 110 | static __thread char buf[8]; |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 111 | return osmo_mcc_name_buf(buf, sizeof(buf), mcc); |
| 112 | } |
| 113 | |
Harald Welte | 179f357 | 2019-03-18 18:38:47 +0100 | [diff] [blame] | 114 | /*! Return MCC string as standardized 3-digit with leading zeros, into a talloc-allocated buffer. |
| 115 | * \param[in] ctx talloc context from which to allocate output buffer |
| 116 | * \param[in] mcc MCC value. |
| 117 | * \returns string in dynamically allocated buffer. |
| 118 | */ |
| 119 | const char *osmo_mcc_name_c(const void *ctx, uint16_t mcc) |
| 120 | { |
| 121 | char *buf = talloc_size(ctx, 8); |
| 122 | if (!buf) |
| 123 | return NULL; |
| 124 | return osmo_mcc_name_buf(buf, 8, mcc); |
| 125 | } |
| 126 | |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 127 | /*! Return MNC string as standardized 2- or 3-digit with leading zeros. |
| 128 | * \param[out] buf caller-allocated output buffer |
| 129 | * \param[in] buf_len size of buf in bytes |
| 130 | * \param[in] mnc MNC value. |
| 131 | * \param[in] mnc_3_digits True if an MNC should fill three digits, only has an effect if MNC < 100. |
| 132 | * \returns string in static buffer. |
| 133 | */ |
| 134 | char *osmo_mnc_name_buf(char *buf, size_t buf_len, uint16_t mnc, bool mnc_3_digits) |
| 135 | { |
| 136 | snprintf(buf, buf_len, "%0*u", mnc_3_digits ? 3 : 2, mnc); |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 137 | return buf; |
| 138 | } |
| 139 | |
Harald Welte | 179f357 | 2019-03-18 18:38:47 +0100 | [diff] [blame] | 140 | /*! Return MNC string as standardized 2- or 3-digit with leading zeros, into a talloc-allocated buffer. |
| 141 | * \param[in] ctx talloc context from which to allocate output buffer |
| 142 | * \param[in] mnc MNC value. |
| 143 | * \param[in] mnc_3_digits True if an MNC should fill three digits, only has an effect if MNC < 100. |
| 144 | * \returns string in dynamically allocated buffer. |
| 145 | */ |
| 146 | char *osmo_mnc_name_c(const void *ctx, uint16_t mnc, bool mnc_3_digits) |
| 147 | { |
| 148 | char *buf = talloc_size(ctx, 8); |
| 149 | if (!buf) |
| 150 | return buf; |
| 151 | return osmo_mnc_name_buf(buf, 8, mnc, mnc_3_digits); |
| 152 | } |
| 153 | |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 154 | /*! Return MNC string as standardized 2- or 3-digit with leading zeros. |
| 155 | * \param[in] mnc MNC value. |
| 156 | * \param[in] mnc_3_digits True if an MNC should fill three digits, only has an effect if MNC < 100. |
| 157 | * \returns string in static buffer. |
| 158 | */ |
| 159 | const char *osmo_mnc_name(uint16_t mnc, bool mnc_3_digits) |
| 160 | { |
Harald Welte | 171ef82 | 2019-03-28 10:49:05 +0100 | [diff] [blame] | 161 | static __thread char buf[8]; |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 162 | return osmo_mnc_name_buf(buf, sizeof(buf), mnc, mnc_3_digits); |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 163 | } |
| 164 | |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 165 | /*! Return MCC-MNC string as standardized 3-digit-dash-2/3-digit with leading zeros. |
| 166 | * \param[out] buf caller-allocated output buffer |
| 167 | * \param[in] buf_len size of buf in bytes |
| 168 | * \param[in] plmn MCC-MNC value. |
| 169 | * \returns string in static buffer. |
| 170 | */ |
| 171 | char *osmo_plmn_name_buf(char *buf, size_t buf_len, const struct osmo_plmn_id *plmn) |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 172 | { |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 173 | char mcc[8], mnc[8]; |
| 174 | snprintf(buf, buf_len, "%s-%s", osmo_mcc_name_buf(mcc, sizeof(mcc), plmn->mcc), |
| 175 | osmo_mnc_name_buf(mnc, sizeof(mnc), plmn->mnc, plmn->mnc_3_digits)); |
| 176 | return buf; |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | /*! Return MCC-MNC string as standardized 3-digit-dash-2/3-digit with leading zeros. |
| 180 | * \param[in] plmn MCC-MNC value. |
| 181 | * \returns string in static buffer. |
| 182 | */ |
| 183 | const char *osmo_plmn_name(const struct osmo_plmn_id *plmn) |
| 184 | { |
Harald Welte | 171ef82 | 2019-03-28 10:49:05 +0100 | [diff] [blame] | 185 | static __thread char buf[16]; |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 186 | return osmo_plmn_name_buf(buf, sizeof(buf), plmn); |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 187 | } |
| 188 | |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 189 | |
Neels Hofmeyr | 6d57c57 | 2019-02-26 21:54:00 +0100 | [diff] [blame] | 190 | /*! Same as osmo_plmn_name(), but returning in a different static buffer. |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 191 | * \param[in] plmn MCC-MNC value. |
| 192 | * \returns string in static buffer. |
| 193 | */ |
| 194 | const char *osmo_plmn_name2(const struct osmo_plmn_id *plmn) |
| 195 | { |
Harald Welte | 171ef82 | 2019-03-28 10:49:05 +0100 | [diff] [blame] | 196 | static __thread char buf[16]; |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 197 | return osmo_plmn_name_buf(buf, sizeof(buf), plmn); |
| 198 | } |
| 199 | |
Harald Welte | 179f357 | 2019-03-18 18:38:47 +0100 | [diff] [blame] | 200 | /*! Return MCC-MNC string as standardized 3-digit-dash-2/3-digit with leading zeros, into |
| 201 | * a dynamically-allocated output buffer. |
| 202 | * \param[in] ctx talloc context from which to allocate output buffer |
| 203 | * \param[in] plmn MCC-MNC value. |
| 204 | * \returns string in dynamically allocated buffer. |
| 205 | */ |
| 206 | char *osmo_plmn_name_c(const void *ctx, const struct osmo_plmn_id *plmn) |
| 207 | { |
| 208 | char *buf = talloc_size(ctx, 16); |
| 209 | if (!buf) |
| 210 | return NULL; |
| 211 | return osmo_plmn_name_buf(buf, 16, plmn); |
| 212 | } |
| 213 | |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 214 | /*! Return MCC-MNC-LAC as string, in caller-provided output buffer. |
| 215 | * \param[out] buf caller-allocated output buffer |
| 216 | * \param[in] buf_len size of buf in bytes |
| 217 | * \param[in] lai LAI to encode, the rac member is ignored. |
| 218 | * \returns buf |
| 219 | */ |
| 220 | char *osmo_lai_name_buf(char *buf, size_t buf_len, const struct osmo_location_area_id *lai) |
| 221 | { |
| 222 | char plmn[16]; |
| 223 | snprintf(buf, buf_len, "%s-%u", osmo_plmn_name_buf(plmn, sizeof(plmn), &lai->plmn), lai->lac); |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 224 | return buf; |
| 225 | } |
| 226 | |
| 227 | /*! Return MCC-MNC-LAC as string, in a static buffer. |
| 228 | * \param[in] lai LAI to encode, the rac member is ignored. |
| 229 | * \returns Static string buffer. |
| 230 | */ |
| 231 | const char *osmo_lai_name(const struct osmo_location_area_id *lai) |
| 232 | { |
Harald Welte | 171ef82 | 2019-03-28 10:49:05 +0100 | [diff] [blame] | 233 | static __thread char buf[32]; |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 234 | return osmo_lai_name_buf(buf, sizeof(buf), lai); |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 235 | } |
| 236 | |
Harald Welte | 179f357 | 2019-03-18 18:38:47 +0100 | [diff] [blame] | 237 | /*! Return MCC-MNC-LAC as string, in a talloc-allocated output buffer. |
| 238 | * \param[in] ctx talloc context from which to allocate output buffer |
| 239 | * \param[in] lai LAI to encode, the rac member is ignored. |
| 240 | * \returns string representation of lai in dynamically allocated buffer. |
| 241 | */ |
| 242 | char *osmo_lai_name_c(const void *ctx, const struct osmo_location_area_id *lai) |
| 243 | { |
| 244 | char *buf = talloc_size(ctx, 32); |
| 245 | if (!buf) |
| 246 | return NULL; |
| 247 | return osmo_lai_name_buf(buf, 32, lai); |
| 248 | } |
| 249 | |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 250 | /*! Return MCC-MNC-LAC-CI as string, in caller-provided output buffer. |
| 251 | * \param[out] buf caller-allocated output buffer |
| 252 | * \param[in] buf_len size of buf in bytes |
| 253 | * \param[in] cgi CGI to encode. |
| 254 | * \returns buf |
| 255 | */ |
| 256 | char *osmo_cgi_name_buf(char *buf, size_t buf_len, const struct osmo_cell_global_id *cgi) |
Neels Hofmeyr | 4349620 | 2018-03-22 14:04:30 +0100 | [diff] [blame] | 257 | { |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 258 | snprintf(buf, buf_len, "%s-%u", osmo_lai_name(&cgi->lai), cgi->cell_identity); |
Neels Hofmeyr | 4349620 | 2018-03-22 14:04:30 +0100 | [diff] [blame] | 259 | return buf; |
| 260 | } |
| 261 | |
| 262 | /*! Return MCC-MNC-LAC-CI as string, in a static buffer. |
| 263 | * \param[in] cgi CGI to encode. |
| 264 | * \returns Static string buffer. |
| 265 | */ |
| 266 | const char *osmo_cgi_name(const struct osmo_cell_global_id *cgi) |
| 267 | { |
Harald Welte | 171ef82 | 2019-03-28 10:49:05 +0100 | [diff] [blame] | 268 | static __thread char buf[32]; |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 269 | return osmo_cgi_name_buf(buf, sizeof(buf), cgi); |
Neels Hofmeyr | 4349620 | 2018-03-22 14:04:30 +0100 | [diff] [blame] | 270 | } |
| 271 | |
| 272 | /*! Same as osmo_cgi_name(), but uses a different static buffer. |
| 273 | * Useful for printing two distinct CGIs in the same printf format. |
| 274 | * \param[in] cgi CGI to encode. |
| 275 | * \returns Static string buffer. |
| 276 | */ |
| 277 | const char *osmo_cgi_name2(const struct osmo_cell_global_id *cgi) |
| 278 | { |
Harald Welte | 171ef82 | 2019-03-28 10:49:05 +0100 | [diff] [blame] | 279 | static __thread char buf[32]; |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 280 | return osmo_cgi_name_buf(buf, sizeof(buf), cgi); |
Neels Hofmeyr | 4349620 | 2018-03-22 14:04:30 +0100 | [diff] [blame] | 281 | } |
| 282 | |
Harald Welte | 179f357 | 2019-03-18 18:38:47 +0100 | [diff] [blame] | 283 | /*! Return MCC-MNC-LAC-CI as string, in a talloc-allocated output buffer. |
| 284 | * \param[in] ctx talloc context from which to allocate output buffer |
| 285 | * \param[in] cgi CGI to encode. |
| 286 | * \returns string representation of CGI in dynamically-allocated buffer. |
| 287 | */ |
| 288 | char *osmo_cgi_name_c(const void *ctx, const struct osmo_cell_global_id *cgi) |
| 289 | { |
| 290 | char *buf = talloc_size(ctx, 32); |
| 291 | return osmo_cgi_name_buf(buf, 32, cgi); |
| 292 | } |
| 293 | |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 294 | static void to_bcd(uint8_t *bcd, uint16_t val) |
| 295 | { |
| 296 | bcd[2] = val % 10; |
| 297 | val = val / 10; |
| 298 | bcd[1] = val % 10; |
| 299 | val = val / 10; |
| 300 | bcd[0] = val % 10; |
| 301 | } |
| 302 | |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 303 | /*! Return string representation of GUMMEI in caller-provided output buffer. |
| 304 | * \param[out] buf pointer to caller-provided output buffer |
| 305 | * \param[in] buf_len size of buf in bytes |
| 306 | * \param[in] gummei GUMMEI to be stringified |
| 307 | * \returns buf |
| 308 | */ |
| 309 | char *osmo_gummei_name_buf(char *buf, size_t buf_len, const struct osmo_gummei *gummei) |
Harald Welte | de1da35 | 2018-10-08 22:27:04 +0200 | [diff] [blame] | 310 | { |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 311 | char plmn[16]; |
| 312 | snprintf(buf, buf_len, "%s-%04x-%02x", osmo_plmn_name_buf(plmn, sizeof(plmn), &gummei->plmn), |
Harald Welte | de1da35 | 2018-10-08 22:27:04 +0200 | [diff] [blame] | 313 | gummei->mme.group_id, gummei->mme.code); |
| 314 | return buf; |
| 315 | } |
| 316 | |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 317 | /*! Return string representation of GUMMEI in static output buffer. |
| 318 | * \param[in] gummei GUMMEI to be stringified |
| 319 | * \returns pointer to static output buffer |
| 320 | */ |
| 321 | const char *osmo_gummei_name(const struct osmo_gummei *gummei) |
| 322 | { |
Harald Welte | 171ef82 | 2019-03-28 10:49:05 +0100 | [diff] [blame] | 323 | static __thread char buf[32]; |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 324 | return osmo_gummei_name_buf(buf, sizeof(buf), gummei); |
| 325 | } |
| 326 | |
Harald Welte | 179f357 | 2019-03-18 18:38:47 +0100 | [diff] [blame] | 327 | /*! Return string representation of GUMMEI in static output buffer. |
| 328 | * \param[out] buf pointer to caller-provided output buffer |
| 329 | * \param[in] buf_len size of buf in bytes |
| 330 | * \param[in] gummei GUMMEI to be stringified |
| 331 | * \returns pointer to static output buffer |
| 332 | */ |
| 333 | char *osmo_gummei_name_c(const void *ctx, const struct osmo_gummei *gummei) |
| 334 | { |
| 335 | char *buf = talloc_size(ctx, 32); |
| 336 | if (!buf) |
| 337 | return NULL; |
| 338 | return osmo_gummei_name_buf(buf, 32, gummei); |
| 339 | } |
Harald Welte | 4a62eda | 2019-03-18 18:27:00 +0100 | [diff] [blame] | 340 | |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 341 | /* Convert MCC + MNC to BCD representation |
| 342 | * \param[out] bcd_dst caller-allocated memory for output |
| 343 | * \param[in] mcc Mobile Country Code |
| 344 | * \param[in] mnc Mobile Network Code |
| 345 | * \param[in] mnc_3_digits true if the MNC shall have three digits. |
| 346 | * |
| 347 | * Convert given mcc and mnc to BCD and write to *bcd_dst, which must be an |
| 348 | * allocated buffer of (at least) 3 bytes length. Encode the MNC in three |
| 349 | * digits if its integer value is > 99, or if mnc_3_digits is passed true. |
| 350 | * Encode an MNC < 100 with mnc_3_digits passed as true as a three-digit MNC |
| 351 | * with leading zeros in the BCD representation. |
| 352 | */ |
| 353 | void osmo_plmn_to_bcd(uint8_t *bcd_dst, const struct osmo_plmn_id *plmn) |
| 354 | { |
| 355 | uint8_t bcd[3]; |
| 356 | |
| 357 | to_bcd(bcd, plmn->mcc); |
| 358 | bcd_dst[0] = bcd[0] | (bcd[1] << 4); |
| 359 | bcd_dst[1] = bcd[2]; |
| 360 | |
| 361 | to_bcd(bcd, plmn->mnc); |
| 362 | if (plmn->mnc > 99 || plmn->mnc_3_digits) { |
| 363 | bcd_dst[1] |= bcd[2] << 4; |
| 364 | bcd_dst[2] = bcd[0] | (bcd[1] << 4); |
| 365 | } else { |
| 366 | bcd_dst[1] |= 0xf << 4; |
| 367 | bcd_dst[2] = bcd[1] | (bcd[2] << 4); |
| 368 | } |
| 369 | } |
| 370 | |
| 371 | /* Convert given 3-byte BCD buffer to integers and write results to *mcc and |
| 372 | * *mnc. The first three BCD digits result in the MCC and the remaining ones in |
| 373 | * the MNC. Return mnc_3_digits as false if the MNC's most significant digit is encoded as 0xF, true |
| 374 | * otherwise; i.e. true if MNC > 99 or if it is represented with leading zeros instead of 0xF. |
| 375 | * \param[in] bcd_src 3-byte BCD buffer containing MCC+MNC representations. |
| 376 | * \param[out] mcc MCC result buffer, or NULL. |
| 377 | * \param[out] mnc MNC result buffer, or NULL. |
| 378 | * \param[out] mnc_3_digits Result buffer for 3-digit flag, or NULL. |
| 379 | */ |
| 380 | void osmo_plmn_from_bcd(const uint8_t *bcd_src, struct osmo_plmn_id *plmn) |
| 381 | { |
| 382 | plmn->mcc = (bcd_src[0] & 0x0f) * 100 |
| 383 | + (bcd_src[0] >> 4) * 10 |
| 384 | + (bcd_src[1] & 0x0f); |
| 385 | |
| 386 | if ((bcd_src[1] & 0xf0) == 0xf0) { |
| 387 | plmn->mnc = (bcd_src[2] & 0x0f) * 10 |
| 388 | + (bcd_src[2] >> 4); |
| 389 | plmn->mnc_3_digits = false; |
| 390 | } else { |
| 391 | plmn->mnc = (bcd_src[2] & 0x0f) * 100 |
| 392 | + (bcd_src[2] >> 4) * 10 |
| 393 | + (bcd_src[1] >> 4); |
| 394 | plmn->mnc_3_digits = true; |
| 395 | } |
| 396 | } |
Neels Hofmeyr | 721aa6d | 2018-02-20 21:38:00 +0100 | [diff] [blame] | 397 | |
| 398 | /* Convert string to MNC, detecting 3-digit MNC with leading zeros. |
| 399 | * Return mnc_3_digits as false if the MNC's most significant digit is encoded as 0xF, true |
| 400 | * otherwise; i.e. true if MNC > 99 or if it is represented with leading zeros instead of 0xF. |
| 401 | * \param mnc_str[in] String representation of an MNC, with or without leading zeros. |
| 402 | * \param mnc[out] MNC result buffer, or NULL. |
| 403 | * \param[out] mnc_3_digits Result buffer for 3-digit flag, or NULL. |
| 404 | * \returns zero on success, -EINVAL in case of surplus characters, negative errno in case of conversion |
Neels Hofmeyr | 20f7d0e | 2018-03-05 04:19:21 +0100 | [diff] [blame] | 405 | * errors. In case of error, do not modify the out-arguments. |
Neels Hofmeyr | 721aa6d | 2018-02-20 21:38:00 +0100 | [diff] [blame] | 406 | */ |
| 407 | int osmo_mnc_from_str(const char *mnc_str, uint16_t *mnc, bool *mnc_3_digits) |
| 408 | { |
| 409 | long int _mnc = 0; |
| 410 | bool _mnc_3_digits = false; |
| 411 | char *endptr; |
| 412 | int rc = 0; |
| 413 | |
Kévin Redon | 1af2cd5 | 2019-05-23 19:00:19 +0200 | [diff] [blame] | 414 | if (!mnc_str || !isdigit((unsigned char)mnc_str[0]) || strlen(mnc_str) > 3) |
Neels Hofmeyr | 20f7d0e | 2018-03-05 04:19:21 +0100 | [diff] [blame] | 415 | return -EINVAL; |
| 416 | |
Neels Hofmeyr | 721aa6d | 2018-02-20 21:38:00 +0100 | [diff] [blame] | 417 | errno = 0; |
| 418 | _mnc = strtol(mnc_str, &endptr, 10); |
| 419 | if (errno) |
| 420 | rc = -errno; |
| 421 | else if (*endptr) |
Neels Hofmeyr | 20f7d0e | 2018-03-05 04:19:21 +0100 | [diff] [blame] | 422 | return -EINVAL; |
Neels Hofmeyr | 721aa6d | 2018-02-20 21:38:00 +0100 | [diff] [blame] | 423 | if (_mnc < 0 || _mnc > 999) |
Neels Hofmeyr | 20f7d0e | 2018-03-05 04:19:21 +0100 | [diff] [blame] | 424 | return -ERANGE; |
Neels Hofmeyr | 721aa6d | 2018-02-20 21:38:00 +0100 | [diff] [blame] | 425 | _mnc_3_digits = strlen(mnc_str) > 2; |
| 426 | |
| 427 | if (mnc) |
| 428 | *mnc = (uint16_t)_mnc; |
| 429 | if (mnc_3_digits) |
| 430 | *mnc_3_digits = _mnc_3_digits; |
| 431 | return rc; |
| 432 | } |
| 433 | |
| 434 | /* Compare two MNC with three-digit flag. |
| 435 | * The mnc_3_digits flags passed in only have an effect if the MNC are < 100, i.e. if they would amount |
| 436 | * to a change in leading zeros in a BCD representation. An MNC >= 100 implies three digits, and the flag |
| 437 | * is actually ignored. |
| 438 | * \param a_mnc[in] "Left" side MNC. |
| 439 | * \param a_mnc_3_digits[in] "Left" side three-digits flag. |
| 440 | * \param b_mnc[in] "Right" side MNC. |
| 441 | * \param b_mnc_3_digits[in] "Right" side three-digits flag. |
| 442 | * \returns 0 if the MNC are equal, -1 if a < b or a shorter, 1 if a > b or a longer. */ |
| 443 | int osmo_mnc_cmp(uint16_t a_mnc, bool a_mnc_3_digits, uint16_t b_mnc, bool b_mnc_3_digits) |
| 444 | { |
| 445 | if (a_mnc < b_mnc) |
| 446 | return -1; |
| 447 | if (a_mnc > b_mnc) |
| 448 | return 1; |
| 449 | /* a_mnc == b_mnc, but same amount of leading zeros? */ |
| 450 | if (a_mnc < 100 && a_mnc_3_digits != b_mnc_3_digits) |
| 451 | return a_mnc_3_digits ? 1 : -1; |
| 452 | return 0; |
| 453 | } |
| 454 | |
| 455 | /* Compare two PLMN. |
| 456 | * \param a[in] "Left" side PLMN. |
| 457 | * \param b[in] "Right" side PLMN. |
| 458 | * \returns 0 if the PLMN are equal, -1 if a < b or a shorter, 1 if a > b or a longer. */ |
| 459 | int osmo_plmn_cmp(const struct osmo_plmn_id *a, const struct osmo_plmn_id *b) |
| 460 | { |
| 461 | if (a == b) |
| 462 | return 0; |
| 463 | if (a->mcc < b->mcc) |
| 464 | return -1; |
| 465 | if (a->mcc > b->mcc) |
| 466 | return 1; |
| 467 | return osmo_mnc_cmp(a->mnc, a->mnc_3_digits, b->mnc, b->mnc_3_digits); |
| 468 | } |
Harald Welte | de1da35 | 2018-10-08 22:27:04 +0200 | [diff] [blame] | 469 | |
Neels Hofmeyr | d01ef75 | 2018-09-21 15:57:26 +0200 | [diff] [blame] | 470 | /* Compare two LAI. |
| 471 | * The order of comparison is MCC, MNC, LAC. See also osmo_plmn_cmp(). |
| 472 | * \param a[in] "Left" side LAI. |
| 473 | * \param b[in] "Right" side LAI. |
| 474 | * \returns 0 if the LAI are equal, -1 if a < b, 1 if a > b. */ |
| 475 | int osmo_lai_cmp(const struct osmo_location_area_id *a, const struct osmo_location_area_id *b) |
| 476 | { |
| 477 | int rc = osmo_plmn_cmp(&a->plmn, &b->plmn); |
| 478 | if (rc) |
| 479 | return rc; |
| 480 | if (a->lac < b->lac) |
| 481 | return -1; |
| 482 | if (a->lac > b->lac) |
| 483 | return 1; |
| 484 | return 0; |
| 485 | } |
| 486 | |
| 487 | /* Compare two CGI. |
| 488 | * The order of comparison is MCC, MNC, LAC, CI. See also osmo_lai_cmp(). |
| 489 | * \param a[in] "Left" side CGI. |
| 490 | * \param b[in] "Right" side CGI. |
| 491 | * \returns 0 if the CGI are equal, -1 if a < b, 1 if a > b. */ |
| 492 | int osmo_cgi_cmp(const struct osmo_cell_global_id *a, const struct osmo_cell_global_id *b) |
| 493 | { |
| 494 | int rc = osmo_lai_cmp(&a->lai, &b->lai); |
| 495 | if (rc) |
| 496 | return rc; |
| 497 | if (a->cell_identity < b->cell_identity) |
| 498 | return -1; |
| 499 | if (a->cell_identity > b->cell_identity) |
| 500 | return 1; |
| 501 | return 0; |
| 502 | } |
| 503 | |
Harald Welte | de1da35 | 2018-10-08 22:27:04 +0200 | [diff] [blame] | 504 | /*! Generate TS 23.003 Section 19.2 Home Network Realm/Domain (text form) |
| 505 | * \param out[out] caller-provided output buffer, at least 33 bytes long |
| 506 | * \param plmn[in] Osmocom representation of PLMN ID (MCC + MNC) |
| 507 | * \returns number of characters printed (excluding NUL); negative on error */ |
| 508 | int osmo_gen_home_network_domain(char *out, const struct osmo_plmn_id *plmn) |
| 509 | { |
| 510 | if (plmn->mcc > 999) |
| 511 | return -EINVAL; |
| 512 | if (plmn->mnc > 999) |
| 513 | return -EINVAL; |
| 514 | return sprintf(out, "epc.mnc%03u.mcc%03u.3gppnetwork.org", plmn->mnc, plmn->mcc); |
| 515 | } |
| 516 | |
| 517 | /*! Parse a TS 23.003 Section 19.2 Home Network Realm/Domain (text form) into a \ref osmo_plmn_id |
| 518 | * \param out[out] caller-allocated output structure |
| 519 | * \param in[in] character string representation to be parsed |
| 520 | * \returns 0 on success; negative on error */ |
| 521 | int osmo_parse_home_network_domain(struct osmo_plmn_id *out, const char *in) |
| 522 | { |
| 523 | int rc; |
| 524 | |
| 525 | memset(out, 0, sizeof(*out)); |
| 526 | rc = sscanf(in, "epc.mnc%03hu.mcc%03hu.3gppnetwork.org", &out->mnc, &out->mcc); |
| 527 | if (rc < 0) |
| 528 | return rc; |
| 529 | if (rc != 2) |
| 530 | return -EINVAL; |
| 531 | return 0; |
| 532 | } |
| 533 | |
| 534 | /*! Generate TS 23.003 Section 19.4.2.4 MME Domain (text form) |
| 535 | * \param out[out] caller-provided output buffer, at least 56 bytes long |
| 536 | * \param gummei[in] Structure representing the Globally Unique MME Identifier |
| 537 | * \returns number of characters printed (excluding NUL); negative on error */ |
| 538 | int osmo_gen_mme_domain(char *out, const struct osmo_gummei *gummei) |
| 539 | { |
| 540 | char domain[GSM23003_HOME_NETWORK_DOMAIN_LEN+1]; |
| 541 | int rc; |
| 542 | rc = osmo_gen_home_network_domain(domain, &gummei->plmn); |
| 543 | if (rc < 0) |
| 544 | return rc; |
| 545 | return sprintf(out, "mmec%02x.mmegi%04x.mme.%s", gummei->mme.code, gummei->mme.group_id, domain); |
| 546 | } |
| 547 | |
| 548 | /*! Parse a TS 23.003 Section 19.4.2.4 MME Domain (text form) into a \ref osmo_gummei |
| 549 | * \param out[out] caller-allocated output GUMMEI structure |
| 550 | * \param in[in] character string representation to be parsed |
| 551 | * \returns 0 on success; negative on error */ |
| 552 | int osmo_parse_mme_domain(struct osmo_gummei *out, const char *in) |
| 553 | { |
| 554 | int rc; |
| 555 | |
| 556 | memset(out, 0, sizeof(*out)); |
| 557 | rc = sscanf(in, "mmec%02hhx.mmegi%04hx.mme.epc.mnc%03hu.mcc%03hu.3gppnetwork.org", |
| 558 | &out->mme.code, &out->mme.group_id, |
| 559 | &out->plmn.mnc, &out->plmn.mcc); |
| 560 | if (rc < 0) |
| 561 | return rc; |
| 562 | if (rc != 4) |
| 563 | return -EINVAL; |
| 564 | return 0; |
| 565 | } |
| 566 | |
| 567 | /*! Generate TS 23.003 Section 19.4.2.4 MME Group Domain (text form) |
| 568 | * \param out[out] caller-provided output buffer, at least 56 bytes long |
| 569 | * \param mmegi[in] MME Group Identifier |
| 570 | * \param plmn[in] Osmocom representation of PLMN ID (MCC + MNC) |
| 571 | * \returns number of characters printed (excluding NUL); negative on error */ |
| 572 | int osmo_gen_mme_group_domain(char *out, uint16_t mmegi, const struct osmo_plmn_id *plmn) |
| 573 | { |
| 574 | char domain[GSM23003_HOME_NETWORK_DOMAIN_LEN+1]; |
| 575 | int rc; |
| 576 | rc = osmo_gen_home_network_domain(domain, plmn); |
| 577 | if (rc < 0) |
| 578 | return rc; |
| 579 | return sprintf(out, "mmegi%04x.mme.%s", mmegi, domain); |
| 580 | } |