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> |
| 34 | |
| 35 | static bool is_n_digits(const char *str, int min_digits, int max_digits) |
| 36 | { |
| 37 | int len; |
| 38 | /* Use unsigned char * to avoid a compiler warning of |
| 39 | * "error: array subscript has type 'char' [-Werror=char-subscripts]" */ |
| 40 | const unsigned char *pos = (const unsigned char *)str; |
Neels Hofmeyr | 4b7c791 | 2017-10-07 04:45:01 +0200 | [diff] [blame] | 41 | if (!pos) |
| 42 | return min_digits < 1; |
Neels Hofmeyr | 9cd1e74 | 2017-10-04 03:15:47 +0200 | [diff] [blame] | 43 | for (len = 0; *pos && len < max_digits; len++, pos++) |
| 44 | if (!isdigit(*pos)) |
| 45 | return false; |
| 46 | if (len < min_digits) |
| 47 | return false; |
| 48 | /* With not too many digits, we should have reached *str == nul */ |
| 49 | if (*pos) |
| 50 | return false; |
| 51 | return true; |
| 52 | } |
| 53 | |
| 54 | /*! Determine whether the given IMSI is valid according to 3GPP TS 23.003. |
| 55 | * \param imsi IMSI digits in ASCII string representation. |
| 56 | * \returns true when the IMSI is valid, false for invalid characters or number |
| 57 | * of digits. |
| 58 | */ |
| 59 | bool osmo_imsi_str_valid(const char *imsi) |
| 60 | { |
| 61 | return is_n_digits(imsi, GSM23003_IMSI_MIN_DIGITS, GSM23003_IMSI_MAX_DIGITS); |
| 62 | } |
| 63 | |
| 64 | /*! Determine whether the given MSISDN is valid according to 3GPP TS 23.003. |
| 65 | * \param msisdn MSISDN digits in ASCII string representation. |
| 66 | * \returns true when the MSISDN is valid, false for invalid characters or number |
| 67 | * of digits. |
| 68 | */ |
| 69 | bool osmo_msisdn_str_valid(const char *msisdn) |
| 70 | { |
| 71 | return is_n_digits(msisdn, 1, 15); |
| 72 | } |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 73 | |
| 74 | /*! Return MCC string as standardized 3-digit with leading zeros. |
| 75 | * \param[in] mcc MCC value. |
| 76 | * \returns string in static buffer. |
| 77 | */ |
| 78 | const char *osmo_mcc_name(uint16_t mcc) |
| 79 | { |
| 80 | static char buf[8]; |
| 81 | snprintf(buf, sizeof(buf), "%03u", mcc); |
| 82 | return buf; |
| 83 | } |
| 84 | |
| 85 | /*! Return MNC string as standardized 2- or 3-digit with leading zeros. |
| 86 | * \param[in] mnc MNC value. |
| 87 | * \param[in] mnc_3_digits True if an MNC should fill three digits, only has an effect if MNC < 100. |
| 88 | * \returns string in static buffer. |
| 89 | */ |
| 90 | const char *osmo_mnc_name(uint16_t mnc, bool mnc_3_digits) |
| 91 | { |
| 92 | static char buf[8]; |
| 93 | snprintf(buf, sizeof(buf), "%0*u", mnc_3_digits ? 3 : 2, mnc); |
| 94 | return buf; |
| 95 | } |
| 96 | |
| 97 | static inline void plmn_name(char *buf, size_t buflen, const struct osmo_plmn_id *plmn) |
| 98 | { |
| 99 | snprintf(buf, buflen, "%s-%s", osmo_mcc_name(plmn->mcc), |
| 100 | osmo_mnc_name(plmn->mnc, plmn->mnc_3_digits)); |
| 101 | } |
| 102 | |
| 103 | /*! Return MCC-MNC string as standardized 3-digit-dash-2/3-digit with leading zeros. |
| 104 | * \param[in] plmn MCC-MNC value. |
| 105 | * \returns string in static buffer. |
| 106 | */ |
| 107 | const char *osmo_plmn_name(const struct osmo_plmn_id *plmn) |
| 108 | { |
| 109 | static char buf[16]; |
| 110 | plmn_name(buf, sizeof(buf), plmn); |
| 111 | return buf; |
| 112 | } |
| 113 | |
| 114 | /*! Same as osmo_mcc_mnc_name(), but returning in a different static buffer. |
| 115 | * \param[in] plmn MCC-MNC value. |
| 116 | * \returns string in static buffer. |
| 117 | */ |
| 118 | const char *osmo_plmn_name2(const struct osmo_plmn_id *plmn) |
| 119 | { |
| 120 | static char buf[16]; |
| 121 | plmn_name(buf, sizeof(buf), plmn); |
| 122 | return buf; |
| 123 | } |
| 124 | |
| 125 | /*! Return MCC-MNC-LAC as string, in a static buffer. |
| 126 | * \param[in] lai LAI to encode, the rac member is ignored. |
| 127 | * \returns Static string buffer. |
| 128 | */ |
| 129 | const char *osmo_lai_name(const struct osmo_location_area_id *lai) |
| 130 | { |
| 131 | static char buf[32]; |
| 132 | snprintf(buf, sizeof(buf), "%s-%u", osmo_plmn_name(&lai->plmn), lai->lac); |
| 133 | return buf; |
| 134 | } |
| 135 | |
Neels Hofmeyr | 4349620 | 2018-03-22 14:04:30 +0100 | [diff] [blame] | 136 | static const char *_cgi_name(const struct osmo_cell_global_id *cgi, char *buf, size_t buflen) |
| 137 | { |
| 138 | snprintf(buf, buflen, "%s-%u", osmo_lai_name(&cgi->lai), cgi->cell_identity); |
| 139 | return buf; |
| 140 | } |
| 141 | |
| 142 | /*! Return MCC-MNC-LAC-CI as string, in a static buffer. |
| 143 | * \param[in] cgi CGI to encode. |
| 144 | * \returns Static string buffer. |
| 145 | */ |
| 146 | const char *osmo_cgi_name(const struct osmo_cell_global_id *cgi) |
| 147 | { |
| 148 | static char buf[32]; |
| 149 | return _cgi_name(cgi, buf, sizeof(buf)); |
| 150 | } |
| 151 | |
| 152 | /*! Same as osmo_cgi_name(), but uses a different static buffer. |
| 153 | * Useful for printing two distinct CGIs in the same printf format. |
| 154 | * \param[in] cgi CGI to encode. |
| 155 | * \returns Static string buffer. |
| 156 | */ |
| 157 | const char *osmo_cgi_name2(const struct osmo_cell_global_id *cgi) |
| 158 | { |
| 159 | static char buf[32]; |
| 160 | return _cgi_name(cgi, buf, sizeof(buf)); |
| 161 | } |
| 162 | |
Neels Hofmeyr | c4fce14 | 2018-02-20 13:47:08 +0100 | [diff] [blame] | 163 | static void to_bcd(uint8_t *bcd, uint16_t val) |
| 164 | { |
| 165 | bcd[2] = val % 10; |
| 166 | val = val / 10; |
| 167 | bcd[1] = val % 10; |
| 168 | val = val / 10; |
| 169 | bcd[0] = val % 10; |
| 170 | } |
| 171 | |
| 172 | /* Convert MCC + MNC to BCD representation |
| 173 | * \param[out] bcd_dst caller-allocated memory for output |
| 174 | * \param[in] mcc Mobile Country Code |
| 175 | * \param[in] mnc Mobile Network Code |
| 176 | * \param[in] mnc_3_digits true if the MNC shall have three digits. |
| 177 | * |
| 178 | * Convert given mcc and mnc to BCD and write to *bcd_dst, which must be an |
| 179 | * allocated buffer of (at least) 3 bytes length. Encode the MNC in three |
| 180 | * digits if its integer value is > 99, or if mnc_3_digits is passed true. |
| 181 | * Encode an MNC < 100 with mnc_3_digits passed as true as a three-digit MNC |
| 182 | * with leading zeros in the BCD representation. |
| 183 | */ |
| 184 | void osmo_plmn_to_bcd(uint8_t *bcd_dst, const struct osmo_plmn_id *plmn) |
| 185 | { |
| 186 | uint8_t bcd[3]; |
| 187 | |
| 188 | to_bcd(bcd, plmn->mcc); |
| 189 | bcd_dst[0] = bcd[0] | (bcd[1] << 4); |
| 190 | bcd_dst[1] = bcd[2]; |
| 191 | |
| 192 | to_bcd(bcd, plmn->mnc); |
| 193 | if (plmn->mnc > 99 || plmn->mnc_3_digits) { |
| 194 | bcd_dst[1] |= bcd[2] << 4; |
| 195 | bcd_dst[2] = bcd[0] | (bcd[1] << 4); |
| 196 | } else { |
| 197 | bcd_dst[1] |= 0xf << 4; |
| 198 | bcd_dst[2] = bcd[1] | (bcd[2] << 4); |
| 199 | } |
| 200 | } |
| 201 | |
| 202 | /* Convert given 3-byte BCD buffer to integers and write results to *mcc and |
| 203 | * *mnc. The first three BCD digits result in the MCC and the remaining ones in |
| 204 | * the MNC. Return mnc_3_digits as false if the MNC's most significant digit is encoded as 0xF, true |
| 205 | * otherwise; i.e. true if MNC > 99 or if it is represented with leading zeros instead of 0xF. |
| 206 | * \param[in] bcd_src 3-byte BCD buffer containing MCC+MNC representations. |
| 207 | * \param[out] mcc MCC result buffer, or NULL. |
| 208 | * \param[out] mnc MNC result buffer, or NULL. |
| 209 | * \param[out] mnc_3_digits Result buffer for 3-digit flag, or NULL. |
| 210 | */ |
| 211 | void osmo_plmn_from_bcd(const uint8_t *bcd_src, struct osmo_plmn_id *plmn) |
| 212 | { |
| 213 | plmn->mcc = (bcd_src[0] & 0x0f) * 100 |
| 214 | + (bcd_src[0] >> 4) * 10 |
| 215 | + (bcd_src[1] & 0x0f); |
| 216 | |
| 217 | if ((bcd_src[1] & 0xf0) == 0xf0) { |
| 218 | plmn->mnc = (bcd_src[2] & 0x0f) * 10 |
| 219 | + (bcd_src[2] >> 4); |
| 220 | plmn->mnc_3_digits = false; |
| 221 | } else { |
| 222 | plmn->mnc = (bcd_src[2] & 0x0f) * 100 |
| 223 | + (bcd_src[2] >> 4) * 10 |
| 224 | + (bcd_src[1] >> 4); |
| 225 | plmn->mnc_3_digits = true; |
| 226 | } |
| 227 | } |
Neels Hofmeyr | 721aa6d | 2018-02-20 21:38:00 +0100 | [diff] [blame] | 228 | |
| 229 | /* Convert string to MNC, detecting 3-digit MNC with leading zeros. |
| 230 | * Return mnc_3_digits as false if the MNC's most significant digit is encoded as 0xF, true |
| 231 | * otherwise; i.e. true if MNC > 99 or if it is represented with leading zeros instead of 0xF. |
| 232 | * \param mnc_str[in] String representation of an MNC, with or without leading zeros. |
| 233 | * \param mnc[out] MNC result buffer, or NULL. |
| 234 | * \param[out] mnc_3_digits Result buffer for 3-digit flag, or NULL. |
| 235 | * \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] | 236 | * errors. In case of error, do not modify the out-arguments. |
Neels Hofmeyr | 721aa6d | 2018-02-20 21:38:00 +0100 | [diff] [blame] | 237 | */ |
| 238 | int osmo_mnc_from_str(const char *mnc_str, uint16_t *mnc, bool *mnc_3_digits) |
| 239 | { |
| 240 | long int _mnc = 0; |
| 241 | bool _mnc_3_digits = false; |
| 242 | char *endptr; |
| 243 | int rc = 0; |
| 244 | |
Neels Hofmeyr | 20f7d0e | 2018-03-05 04:19:21 +0100 | [diff] [blame] | 245 | if (!mnc_str || !isdigit(mnc_str[0]) || strlen(mnc_str) > 3) |
| 246 | return -EINVAL; |
| 247 | |
Neels Hofmeyr | 721aa6d | 2018-02-20 21:38:00 +0100 | [diff] [blame] | 248 | errno = 0; |
| 249 | _mnc = strtol(mnc_str, &endptr, 10); |
| 250 | if (errno) |
| 251 | rc = -errno; |
| 252 | else if (*endptr) |
Neels Hofmeyr | 20f7d0e | 2018-03-05 04:19:21 +0100 | [diff] [blame] | 253 | return -EINVAL; |
Neels Hofmeyr | 721aa6d | 2018-02-20 21:38:00 +0100 | [diff] [blame] | 254 | if (_mnc < 0 || _mnc > 999) |
Neels Hofmeyr | 20f7d0e | 2018-03-05 04:19:21 +0100 | [diff] [blame] | 255 | return -ERANGE; |
Neels Hofmeyr | 721aa6d | 2018-02-20 21:38:00 +0100 | [diff] [blame] | 256 | _mnc_3_digits = strlen(mnc_str) > 2; |
| 257 | |
| 258 | if (mnc) |
| 259 | *mnc = (uint16_t)_mnc; |
| 260 | if (mnc_3_digits) |
| 261 | *mnc_3_digits = _mnc_3_digits; |
| 262 | return rc; |
| 263 | } |
| 264 | |
| 265 | /* Compare two MNC with three-digit flag. |
| 266 | * The mnc_3_digits flags passed in only have an effect if the MNC are < 100, i.e. if they would amount |
| 267 | * to a change in leading zeros in a BCD representation. An MNC >= 100 implies three digits, and the flag |
| 268 | * is actually ignored. |
| 269 | * \param a_mnc[in] "Left" side MNC. |
| 270 | * \param a_mnc_3_digits[in] "Left" side three-digits flag. |
| 271 | * \param b_mnc[in] "Right" side MNC. |
| 272 | * \param b_mnc_3_digits[in] "Right" side three-digits flag. |
| 273 | * \returns 0 if the MNC are equal, -1 if a < b or a shorter, 1 if a > b or a longer. */ |
| 274 | int osmo_mnc_cmp(uint16_t a_mnc, bool a_mnc_3_digits, uint16_t b_mnc, bool b_mnc_3_digits) |
| 275 | { |
| 276 | if (a_mnc < b_mnc) |
| 277 | return -1; |
| 278 | if (a_mnc > b_mnc) |
| 279 | return 1; |
| 280 | /* a_mnc == b_mnc, but same amount of leading zeros? */ |
| 281 | if (a_mnc < 100 && a_mnc_3_digits != b_mnc_3_digits) |
| 282 | return a_mnc_3_digits ? 1 : -1; |
| 283 | return 0; |
| 284 | } |
| 285 | |
| 286 | /* Compare two PLMN. |
| 287 | * \param a[in] "Left" side PLMN. |
| 288 | * \param b[in] "Right" side PLMN. |
| 289 | * \returns 0 if the PLMN are equal, -1 if a < b or a shorter, 1 if a > b or a longer. */ |
| 290 | int osmo_plmn_cmp(const struct osmo_plmn_id *a, const struct osmo_plmn_id *b) |
| 291 | { |
| 292 | if (a == b) |
| 293 | return 0; |
| 294 | if (a->mcc < b->mcc) |
| 295 | return -1; |
| 296 | if (a->mcc > b->mcc) |
| 297 | return 1; |
| 298 | return osmo_mnc_cmp(a->mnc, a->mnc_3_digits, b->mnc, b->mnc_3_digits); |
| 299 | } |