Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file ipa.c |
| 2 | * OpenBSC Abis input driver for ip.access */ |
| 3 | /* |
| 4 | * (C) 2009-2017 by Harald Welte <laforge@gnumonks.org> |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 5 | * (C) 2010 by Holger Hans Peter Freyther |
| 6 | * (C) 2010 by On-Waves |
| 7 | * |
| 8 | * All Rights Reserved |
| 9 | * |
Harald Welte | e08da97 | 2017-11-13 01:00:26 +0900 | [diff] [blame] | 10 | * SPDX-License-Identifier: GPL-2.0+ |
| 11 | * |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 12 | * This program is free software; you can redistribute it and/or modify |
Harald Welte | fd5ad17 | 2014-10-26 20:47:42 +0100 | [diff] [blame] | 13 | * it under the terms of the GNU General Public License as published by |
| 14 | * the Free Software Foundation; either version 2 of the License, or |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 15 | * (at your option) any later version. |
| 16 | * |
| 17 | * This program is distributed in the hope that it will be useful, |
| 18 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
Harald Welte | fd5ad17 | 2014-10-26 20:47:42 +0100 | [diff] [blame] | 20 | * GNU General Public License for more details. |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 21 | * |
Harald Welte | fd5ad17 | 2014-10-26 20:47:42 +0100 | [diff] [blame] | 22 | * You should have received a copy of the GNU General Public License |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 23 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 24 | * |
| 25 | */ |
| 26 | |
Harald Welte | 20725b9 | 2017-05-15 12:50:04 +0200 | [diff] [blame] | 27 | #include "config.h" |
| 28 | |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 29 | #include <unistd.h> |
| 30 | #include <stdint.h> |
| 31 | #include <errno.h> |
| 32 | #include <stdlib.h> |
| 33 | |
Holger Hans Peter Freyther | ee6652b | 2015-11-09 16:21:19 +0000 | [diff] [blame] | 34 | #include <sys/types.h> |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 35 | |
Harald Welte | 95871da | 2017-05-15 12:11:36 +0200 | [diff] [blame] | 36 | #include <osmocom/core/byteswap.h> |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 37 | #include <osmocom/core/msgb.h> |
| 38 | #include <osmocom/core/talloc.h> |
| 39 | #include <osmocom/core/logging.h> |
| 40 | #include <osmocom/core/macaddr.h> |
| 41 | #include <osmocom/core/select.h> |
| 42 | |
| 43 | #include <osmocom/gsm/tlv.h> |
| 44 | #include <osmocom/gsm/protocol/ipaccess.h> |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 45 | #include <osmocom/gsm/ipa.h> |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 46 | |
Harald Welte | 96e2a00 | 2017-06-12 21:44:18 +0200 | [diff] [blame] | 47 | /*! \addtogroup ipa |
| 48 | * @{ |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 49 | * IPA Multiplex utility routines |
Harald Welte | 96e2a00 | 2017-06-12 21:44:18 +0200 | [diff] [blame] | 50 | */ |
| 51 | |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 52 | #define IPA_ALLOC_SIZE 1200 |
| 53 | |
| 54 | /* |
| 55 | * Common propietary IPA messages: |
| 56 | * - PONG: in reply to PING. |
| 57 | * - ID_REQUEST: first messages once OML has been established. |
| 58 | * - ID_ACK: in reply to ID_ACK. |
| 59 | */ |
| 60 | static const uint8_t ipa_pong_msg[] = { |
| 61 | 0, 1, IPAC_PROTO_IPACCESS, IPAC_MSGT_PONG |
| 62 | }; |
| 63 | |
| 64 | static const uint8_t ipa_id_ack_msg[] = { |
| 65 | 0, 1, IPAC_PROTO_IPACCESS, IPAC_MSGT_ID_ACK |
| 66 | }; |
| 67 | |
| 68 | static const uint8_t ipa_id_req_msg[] = { |
| 69 | 0, 17, IPAC_PROTO_IPACCESS, IPAC_MSGT_ID_GET, |
| 70 | 0x01, IPAC_IDTAG_UNIT, |
| 71 | 0x01, IPAC_IDTAG_MACADDR, |
| 72 | 0x01, IPAC_IDTAG_LOCATION1, |
| 73 | 0x01, IPAC_IDTAG_LOCATION2, |
| 74 | 0x01, IPAC_IDTAG_EQUIPVERS, |
| 75 | 0x01, IPAC_IDTAG_SWVERSION, |
| 76 | 0x01, IPAC_IDTAG_UNITNAME, |
| 77 | 0x01, IPAC_IDTAG_SERNR, |
| 78 | }; |
| 79 | |
| 80 | |
| 81 | static const char *idtag_names[] = { |
| 82 | [IPAC_IDTAG_SERNR] = "Serial_Number", |
| 83 | [IPAC_IDTAG_UNITNAME] = "Unit_Name", |
| 84 | [IPAC_IDTAG_LOCATION1] = "Location_1", |
| 85 | [IPAC_IDTAG_LOCATION2] = "Location_2", |
| 86 | [IPAC_IDTAG_EQUIPVERS] = "Equipment_Version", |
| 87 | [IPAC_IDTAG_SWVERSION] = "Software_Version", |
| 88 | [IPAC_IDTAG_IPADDR] = "IP_Address", |
| 89 | [IPAC_IDTAG_MACADDR] = "MAC_Address", |
| 90 | [IPAC_IDTAG_UNIT] = "Unit_ID", |
| 91 | }; |
| 92 | |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 93 | const char *ipa_ccm_idtag_name(uint8_t tag) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 94 | { |
| 95 | if (tag >= ARRAY_SIZE(idtag_names)) |
| 96 | return "unknown"; |
| 97 | |
| 98 | return idtag_names[tag]; |
| 99 | } |
| 100 | |
Pau Espin Pedrol | deeab47 | 2019-03-27 17:33:17 +0100 | [diff] [blame] | 101 | /*! Parse the payload part of an IPA CCM ID GET, return \ref tlv_parsed format. */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 102 | int ipa_ccm_idtag_parse(struct tlv_parsed *dec, unsigned char *buf, int len) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 103 | { |
Pau Espin Pedrol | deeab47 | 2019-03-27 17:33:17 +0100 | [diff] [blame] | 104 | return ipa_ccm_idtag_parse_off(dec, buf, len, 1); |
Harald Welte | 5a7740d | 2018-08-01 17:29:48 +0200 | [diff] [blame] | 105 | } |
| 106 | |
Pau Espin Pedrol | deeab47 | 2019-03-27 17:33:17 +0100 | [diff] [blame] | 107 | /*! Parse the payload part of an IPA CCM ID GET, return \ref tlv_parsed format. |
| 108 | * WARNING: This function can only parse correctly IPA CCM ID GET/REQUEST |
| 109 | * messages, and only when len_offset is passed value of 1. |
| 110 | * \param[out] dec Caller-provided/allocated output structure for parsed payload |
| 111 | * \param[in] buf Buffer containing the payload (excluding 1 byte msg_type) of the message |
| 112 | * \param[in] len Length of \a buf in octets |
| 113 | * \param[in] len_offset Offset from end of len field to start of value (ommiting tag). Must be 1! |
| 114 | * \returns 0 on success; negative on error |
| 115 | */ |
Harald Welte | 5a7740d | 2018-08-01 17:29:48 +0200 | [diff] [blame] | 116 | int ipa_ccm_idtag_parse_off(struct tlv_parsed *dec, unsigned char *buf, int len, const int len_offset) |
| 117 | { |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 118 | uint8_t t_len; |
| 119 | uint8_t t_tag; |
| 120 | uint8_t *cur = buf; |
| 121 | |
| 122 | memset(dec, 0, sizeof(*dec)); |
| 123 | |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 124 | LOGP(DLMI, LOGL_DEBUG, "Rx IPA CCM ID_GET: "); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 125 | while (len >= 2) { |
| 126 | len -= 2; |
| 127 | t_len = *cur++; |
| 128 | t_tag = *cur++; |
| 129 | |
Harald Welte | 5a7740d | 2018-08-01 17:29:48 +0200 | [diff] [blame] | 130 | if (t_len < len_offset) { |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 131 | LOGPC(DLMI, LOGL_DEBUG, "\n"); |
Harald Welte | 5a7740d | 2018-08-01 17:29:48 +0200 | [diff] [blame] | 132 | LOGP(DLMI, LOGL_ERROR, "minimal offset not included: %d < %d\n", t_len, len_offset); |
| 133 | return -EINVAL; |
| 134 | } |
| 135 | |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 136 | if (t_len > len + 1) { |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 137 | LOGPC(DLMI, LOGL_DEBUG, "\n"); |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 138 | LOGP(DLMI, LOGL_ERROR, "The tag does not fit: %d > %d\n", t_len, len + 1); |
Holger Hans Peter Freyther | f558ed4 | 2015-06-02 15:52:06 +0200 | [diff] [blame] | 139 | return -EINVAL; |
| 140 | } |
| 141 | |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 142 | LOGPC(DLMI, LOGL_DEBUG, "%s='%s' ", ipa_ccm_idtag_name(t_tag), cur); |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 143 | |
Oliver Smith | 27f7b0d | 2019-03-25 13:45:57 +0100 | [diff] [blame] | 144 | dec->lv[t_tag].len = t_len - len_offset; |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 145 | dec->lv[t_tag].val = cur; |
| 146 | |
Harald Welte | 5a7740d | 2018-08-01 17:29:48 +0200 | [diff] [blame] | 147 | cur += t_len - len_offset; |
| 148 | len -= t_len - len_offset; |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 149 | } |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 150 | LOGPC(DLMI, LOGL_DEBUG, "\n"); |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 151 | return 0; |
| 152 | } |
| 153 | |
| 154 | /*! Parse the payload part of an IPA CCM ID GET, return \ref tlv_parsed format. |
| 155 | * The odd payload format of those messages is structured as follows: |
| 156 | * * 8bit length value (length of payload *and tag*) |
| 157 | * * 8bit tag value |
| 158 | * * optional, variable-length payload |
| 159 | * \param[out] dec Caller-provided/allocated output structure for parsed payload |
| 160 | * \param[in] buf Buffer containing the payload (excluding 1 byte msg_type) of the message |
| 161 | * \param[in] len Length of \a buf in octets |
| 162 | * \returns 0 on success; negative on error */ |
| 163 | int ipa_ccm_id_get_parse(struct tlv_parsed *dec, const uint8_t *buf, unsigned int len) |
| 164 | { |
| 165 | uint8_t t_len; |
| 166 | uint8_t t_tag; |
| 167 | const uint8_t *cur = buf; |
| 168 | |
| 169 | memset(dec, 0, sizeof(*dec)); |
| 170 | |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 171 | LOGP(DLMI, LOGL_DEBUG, "Rx IPA CCM ID_GET: "); |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 172 | while (len >= 2) { |
| 173 | len -= 2; |
| 174 | t_len = *cur++; |
| 175 | t_tag = *cur++; |
| 176 | |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 177 | if (t_len > len + 1) { |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 178 | LOGPC(DLMI, LOGL_DEBUG, "\n"); |
Max | 9b4d065 | 2016-11-15 19:21:23 +0100 | [diff] [blame] | 179 | LOGP(DLMI, LOGL_ERROR, "The tag does not fit: %d > %d\n", t_len, len + 1); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 180 | return -EINVAL; |
| 181 | } |
| 182 | |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 183 | LOGPC(DLMI, LOGL_DEBUG, "%s='%s' ", ipa_ccm_idtag_name(t_tag), cur); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 184 | |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 185 | dec->lv[t_tag].len = t_len-1; |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 186 | dec->lv[t_tag].val = cur; |
| 187 | |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 188 | cur += t_len-1; |
| 189 | len -= t_len-1; |
| 190 | } |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 191 | LOGPC(DLMI, LOGL_DEBUG, "\n"); |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 192 | return 0; |
| 193 | } |
| 194 | |
| 195 | /*! Parse the payload part of an IPA CCM ID RESP, return \ref tlv_parsed format. |
| 196 | * The odd payload format of those messages is structured as follows: |
| 197 | * * 16bit length value (length of payload *and tag*) |
| 198 | * * 8bit tag value |
| 199 | * * optional, variable-length payload |
| 200 | * \param[out] dec Caller-provided/allocated output structure for parsed payload |
| 201 | * \param[in] buf Buffer containing the payload (excluding 1 byte msg_type) of the message |
| 202 | * \param[in] len Length of \a buf in octets |
| 203 | * \returns 0 on success; negative on error */ |
| 204 | int ipa_ccm_id_resp_parse(struct tlv_parsed *dec, const uint8_t *buf, unsigned int len) |
| 205 | { |
| 206 | uint8_t t_len; |
| 207 | uint8_t t_tag; |
| 208 | const uint8_t *cur = buf; |
| 209 | |
| 210 | memset(dec, 0, sizeof(*dec)); |
| 211 | |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 212 | LOGP(DLMI, LOGL_DEBUG, "Rx IPA CCM ID_RESP: "); |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 213 | while (len >= 3) { |
| 214 | len -= 3; |
Pau Espin Pedrol | 3cb6851 | 2019-03-27 17:45:00 +0100 | [diff] [blame] | 215 | t_len = osmo_load16be(cur); |
| 216 | cur += 2; |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 217 | t_tag = *cur++; |
| 218 | |
| 219 | if (t_len > len + 1) { |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 220 | LOGPC(DLMI, LOGL_DEBUG, "\n"); |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 221 | LOGP(DLMI, LOGL_ERROR, "The tag does not fit: %d > %d\n", t_len, len + 1); |
| 222 | return -EINVAL; |
| 223 | } |
| 224 | |
| 225 | DEBUGPC(DLMI, "%s='%s' ", ipa_ccm_idtag_name(t_tag), cur); |
| 226 | |
| 227 | dec->lv[t_tag].len = t_len-1; |
| 228 | dec->lv[t_tag].val = cur; |
| 229 | |
| 230 | cur += t_len-1; |
| 231 | len -= t_len-1; |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 232 | } |
Pau Espin Pedrol | 9cc661b | 2020-08-26 13:29:47 +0200 | [diff] [blame] | 233 | LOGPC(DLMI, LOGL_DEBUG, "\n"); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 234 | return 0; |
| 235 | } |
| 236 | |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 237 | int ipa_parse_unitid(const char *str, struct ipaccess_unit *unit_data) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 238 | { |
| 239 | unsigned long ul; |
| 240 | char *endptr; |
| 241 | const char *nptr; |
| 242 | |
| 243 | nptr = str; |
| 244 | ul = strtoul(nptr, &endptr, 10); |
| 245 | if (endptr <= nptr) |
| 246 | return -EINVAL; |
| 247 | unit_data->site_id = ul & 0xffff; |
| 248 | |
| 249 | if (*endptr++ != '/') |
| 250 | return -EINVAL; |
| 251 | |
| 252 | nptr = endptr; |
| 253 | ul = strtoul(nptr, &endptr, 10); |
| 254 | if (endptr <= nptr) |
| 255 | return -EINVAL; |
| 256 | unit_data->bts_id = ul & 0xffff; |
| 257 | |
| 258 | if (*endptr++ != '/') |
| 259 | return -EINVAL; |
| 260 | |
| 261 | nptr = endptr; |
| 262 | ul = strtoul(nptr, &endptr, 10); |
| 263 | if (endptr <= nptr) |
| 264 | return -EINVAL; |
| 265 | unit_data->trx_id = ul & 0xffff; |
| 266 | |
| 267 | return 0; |
| 268 | } |
| 269 | |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 270 | int ipa_ccm_tlv_to_unitdata(struct ipaccess_unit *ud, |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 271 | const struct tlv_parsed *tp) |
| 272 | { |
| 273 | int rc = 0; |
| 274 | |
| 275 | if (TLVP_PRES_LEN(tp, IPAC_IDTAG_SERNR, 1)) |
| 276 | ud->serno = talloc_strdup(ud, (char *) |
| 277 | TLVP_VAL(tp, IPAC_IDTAG_SERNR)); |
| 278 | |
| 279 | if (TLVP_PRES_LEN(tp, IPAC_IDTAG_UNITNAME, 1)) |
| 280 | ud->unit_name = talloc_strdup(ud, (char *) |
| 281 | TLVP_VAL(tp, IPAC_IDTAG_UNITNAME)); |
| 282 | |
| 283 | if (TLVP_PRES_LEN(tp, IPAC_IDTAG_LOCATION1, 1)) |
| 284 | ud->location1 = talloc_strdup(ud, (char *) |
| 285 | TLVP_VAL(tp, IPAC_IDTAG_LOCATION1)); |
| 286 | |
| 287 | if (TLVP_PRES_LEN(tp, IPAC_IDTAG_LOCATION2, 1)) |
| 288 | ud->location2 = talloc_strdup(ud, (char *) |
| 289 | TLVP_VAL(tp, IPAC_IDTAG_LOCATION2)); |
| 290 | |
| 291 | if (TLVP_PRES_LEN(tp, IPAC_IDTAG_EQUIPVERS, 1)) |
| 292 | ud->equipvers = talloc_strdup(ud, (char *) |
| 293 | TLVP_VAL(tp, IPAC_IDTAG_EQUIPVERS)); |
| 294 | |
| 295 | if (TLVP_PRES_LEN(tp, IPAC_IDTAG_SWVERSION, 1)) |
| 296 | ud->swversion = talloc_strdup(ud, (char *) |
| 297 | TLVP_VAL(tp, IPAC_IDTAG_SWVERSION)); |
| 298 | |
| 299 | if (TLVP_PRES_LEN(tp, IPAC_IDTAG_MACADDR, 17)) { |
| 300 | rc = osmo_macaddr_parse(ud->mac_addr, (char *) |
| 301 | TLVP_VAL(tp, IPAC_IDTAG_MACADDR)); |
| 302 | if (rc < 0) |
| 303 | goto out; |
| 304 | } |
| 305 | |
| 306 | if (TLVP_PRES_LEN(tp, IPAC_IDTAG_UNIT, 1)) |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 307 | rc = ipa_parse_unitid((char *) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 308 | TLVP_VAL(tp, IPAC_IDTAG_UNIT), ud); |
| 309 | |
| 310 | out: |
| 311 | return rc; |
| 312 | } |
| 313 | |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 314 | #define IPA_STRING_MAX 64 |
| 315 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 316 | /*! Generate IPA CCM ID RESP based on list of IEs |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 317 | * \param[in] dev Descriptor describing identity data for response |
| 318 | * \param[in] ies_req List of IEIs to include in response |
| 319 | * \param[in] num_ies_req Number of IEIs in \a ies_req |
| 320 | * \returns Message buffer with IPA CCM ID RESP */ |
| 321 | struct msgb *ipa_ccm_make_id_resp(const struct ipaccess_unit *dev, |
| 322 | const uint8_t *ies_req, unsigned int num_ies_req) |
| 323 | { |
| 324 | struct msgb *msg = ipa_msg_alloc(16); |
| 325 | char str[IPA_STRING_MAX]; |
| 326 | unsigned int i; |
| 327 | |
| 328 | if (!msg) |
| 329 | return NULL; |
| 330 | |
| 331 | *msgb_put(msg, 1) = IPAC_MSGT_ID_RESP; |
| 332 | |
| 333 | for (i = 0; i < num_ies_req; i++) { |
| 334 | uint8_t *tag; |
| 335 | |
| 336 | str[0] = '\0'; |
| 337 | switch (ies_req[i]) { |
| 338 | case IPAC_IDTAG_UNIT: |
| 339 | snprintf(str, sizeof(str), "%u/%u/%u", |
| 340 | dev->site_id, dev->bts_id, dev->trx_id); |
| 341 | break; |
| 342 | case IPAC_IDTAG_MACADDR: |
| 343 | snprintf(str, sizeof(str), |
| 344 | "%02x:%02x:%02x:%02x:%02x:%02x", |
| 345 | dev->mac_addr[0], dev->mac_addr[1], |
| 346 | dev->mac_addr[2], dev->mac_addr[3], |
| 347 | dev->mac_addr[4], dev->mac_addr[5]); |
| 348 | break; |
| 349 | case IPAC_IDTAG_LOCATION1: |
| 350 | if (dev->location1) |
Neels Hofmeyr | ebe4ef7 | 2018-07-26 17:12:07 +0200 | [diff] [blame] | 351 | osmo_strlcpy(str, dev->location1, sizeof(str)); |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 352 | break; |
| 353 | case IPAC_IDTAG_LOCATION2: |
| 354 | if (dev->location2) |
Neels Hofmeyr | ebe4ef7 | 2018-07-26 17:12:07 +0200 | [diff] [blame] | 355 | osmo_strlcpy(str, dev->location2, sizeof(str)); |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 356 | break; |
| 357 | case IPAC_IDTAG_EQUIPVERS: |
| 358 | if (dev->equipvers) |
Neels Hofmeyr | ebe4ef7 | 2018-07-26 17:12:07 +0200 | [diff] [blame] | 359 | osmo_strlcpy(str, dev->equipvers, sizeof(str)); |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 360 | break; |
| 361 | case IPAC_IDTAG_SWVERSION: |
| 362 | if (dev->swversion) |
Neels Hofmeyr | ebe4ef7 | 2018-07-26 17:12:07 +0200 | [diff] [blame] | 363 | osmo_strlcpy(str, dev->swversion, sizeof(str)); |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 364 | break; |
| 365 | case IPAC_IDTAG_UNITNAME: |
| 366 | if (dev->unit_name) { |
Neels Hofmeyr | ebe4ef7 | 2018-07-26 17:12:07 +0200 | [diff] [blame] | 367 | snprintf(str, sizeof(str), "%s", dev->unit_name); |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 368 | } else { |
| 369 | snprintf(str, sizeof(str), |
| 370 | "%02x-%02x-%02x-%02x-%02x-%02x", |
| 371 | dev->mac_addr[0], dev->mac_addr[1], |
| 372 | dev->mac_addr[2], dev->mac_addr[3], |
| 373 | dev->mac_addr[4], dev->mac_addr[5]); |
| 374 | } |
| 375 | break; |
| 376 | case IPAC_IDTAG_SERNR: |
| 377 | if (dev->serno) |
Neels Hofmeyr | ebe4ef7 | 2018-07-26 17:12:07 +0200 | [diff] [blame] | 378 | osmo_strlcpy(str, dev->serno, sizeof(str)); |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 379 | break; |
| 380 | default: |
| 381 | LOGP(DLINP, LOGL_NOTICE, |
| 382 | "Unknown ipaccess tag 0x%02x\n", ies_req[i]); |
| 383 | msgb_free(msg); |
| 384 | return NULL; |
| 385 | } |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 386 | |
| 387 | LOGP(DLINP, LOGL_INFO, " tag %d: %s\n", ies_req[i], str); |
| 388 | tag = msgb_put(msg, 3 + strlen(str) + 1); |
| 389 | tag[0] = 0x00; |
| 390 | tag[1] = 1 + strlen(str) + 1; |
| 391 | tag[2] = ies_req[1]; |
| 392 | memcpy(tag + 3, str, strlen(str) + 1); |
| 393 | } |
| 394 | ipa_prepend_header(msg, IPAC_PROTO_IPACCESS); |
| 395 | return msg; |
| 396 | } |
| 397 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 398 | /*! Generate IPA CCM ID RESP based on requets payload |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 399 | * \param[in] dev Descriptor describing identity data for response |
| 400 | * \param[in] data Payload of the IPA CCM ID GET request |
| 401 | * \param[in] len Length of \a data in octets |
| 402 | * \returns Message buffer with IPA CCM ID RESP */ |
| 403 | struct msgb *ipa_ccm_make_id_resp_from_req(const struct ipaccess_unit *dev, |
| 404 | const uint8_t *data, unsigned int len) |
| 405 | { |
| 406 | uint8_t ies[len/2]; |
| 407 | unsigned int num_ies = 0; |
| 408 | const uint8_t *cur = data; |
| 409 | |
Harald Welte | 8a4895c | 2017-04-27 10:25:10 +0200 | [diff] [blame] | 410 | memset(ies, 0, sizeof(ies)); |
| 411 | |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 412 | /* build a array of the IEIs */ |
| 413 | while (len >= 2) { |
| 414 | uint8_t t_len, t_tag; |
| 415 | len -= 2; |
| 416 | t_len = *cur++; |
| 417 | t_tag = *cur++; |
| 418 | |
| 419 | if (t_len > len + 1) { |
Thorsten Alteholz | 5a9dbf8 | 2018-04-08 19:13:25 +0200 | [diff] [blame] | 420 | LOGP(DLINP, LOGL_ERROR, "IPA CCM tag 0x%02x does not fit\n", t_tag); |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 421 | break; |
| 422 | } |
| 423 | |
| 424 | ies[num_ies++] = t_tag; |
| 425 | |
| 426 | cur += t_len; |
Harald Welte | 0b2c0ec | 2018-04-16 22:53:48 +0200 | [diff] [blame] | 427 | /* prevent any unsigned integer underflow due to somebody sending us |
| 428 | * messages with wrong length values */ |
| 429 | if (len <= t_len) |
| 430 | len -= t_len; |
| 431 | else |
| 432 | len = 0; |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 433 | } |
| 434 | return ipa_ccm_make_id_resp(dev, ies, num_ies); |
| 435 | } |
| 436 | |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 437 | int ipa_send(int fd, const void *msg, size_t msglen) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 438 | { |
| 439 | int ret; |
| 440 | |
| 441 | ret = write(fd, msg, msglen); |
| 442 | if (ret < 0) |
Jacob Erlbeck | a6be224 | 2014-12-22 10:58:46 +0100 | [diff] [blame] | 443 | return -errno; |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 444 | if (ret < msglen) { |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 445 | LOGP(DLINP, LOGL_ERROR, "ipa_send: short write\n"); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 446 | return -EIO; |
| 447 | } |
| 448 | return ret; |
| 449 | } |
| 450 | |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 451 | int ipa_ccm_send_pong(int fd) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 452 | { |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 453 | return ipa_send(fd, ipa_pong_msg, sizeof(ipa_pong_msg)); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 454 | } |
| 455 | |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 456 | int ipa_ccm_send_id_ack(int fd) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 457 | { |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 458 | return ipa_send(fd, ipa_id_ack_msg, sizeof(ipa_id_ack_msg)); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 459 | } |
| 460 | |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 461 | int ipa_ccm_send_id_req(int fd) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 462 | { |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 463 | return ipa_send(fd, ipa_id_req_msg, sizeof(ipa_id_req_msg)); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 464 | } |
| 465 | |
| 466 | /* base handling of the ip.access protocol */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 467 | int ipa_ccm_rcvmsg_base(struct msgb *msg, struct osmo_fd *bfd) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 468 | { |
| 469 | uint8_t msg_type = *(msg->l2h); |
| 470 | int ret; |
| 471 | |
| 472 | switch (msg_type) { |
| 473 | case IPAC_MSGT_PING: |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 474 | ret = ipa_ccm_send_pong(bfd->fd); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 475 | if (ret < 0) { |
| 476 | LOGP(DLINP, LOGL_ERROR, "Cannot send PING " |
| 477 | "message. Reason: %s\n", strerror(errno)); |
| 478 | break; |
| 479 | } |
| 480 | ret = 1; |
| 481 | break; |
| 482 | case IPAC_MSGT_PONG: |
| 483 | DEBUGP(DLMI, "PONG!\n"); |
| 484 | ret = 1; |
| 485 | break; |
| 486 | case IPAC_MSGT_ID_ACK: |
| 487 | DEBUGP(DLMI, "ID_ACK? -> ACK!\n"); |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 488 | ret = ipa_ccm_send_id_ack(bfd->fd); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 489 | if (ret < 0) { |
| 490 | LOGP(DLINP, LOGL_ERROR, "Cannot send ID_ACK " |
| 491 | "message. Reason: %s\n", strerror(errno)); |
| 492 | break; |
| 493 | } |
| 494 | ret = 1; |
| 495 | break; |
| 496 | default: |
| 497 | /* This is not an IPA PING, PONG or ID_ACK message */ |
| 498 | ret = 0; |
| 499 | break; |
| 500 | } |
| 501 | return ret; |
| 502 | } |
| 503 | |
| 504 | /* base handling of the ip.access protocol */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 505 | int ipa_ccm_rcvmsg_bts_base(struct msgb *msg, struct osmo_fd *bfd) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 506 | { |
| 507 | uint8_t msg_type = *(msg->l2h); |
| 508 | int ret = 0; |
| 509 | |
| 510 | switch (msg_type) { |
| 511 | case IPAC_MSGT_PING: |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 512 | ret = ipa_ccm_send_pong(bfd->fd); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 513 | if (ret < 0) { |
| 514 | LOGP(DLINP, LOGL_ERROR, "Cannot send PONG " |
| 515 | "message. Reason: %s\n", strerror(errno)); |
| 516 | } |
| 517 | break; |
| 518 | case IPAC_MSGT_PONG: |
| 519 | DEBUGP(DLMI, "PONG!\n"); |
| 520 | break; |
| 521 | case IPAC_MSGT_ID_ACK: |
| 522 | DEBUGP(DLMI, "ID_ACK\n"); |
| 523 | break; |
| 524 | } |
| 525 | return ret; |
| 526 | } |
| 527 | |
| 528 | |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 529 | void ipa_prepend_header_ext(struct msgb *msg, int proto) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 530 | { |
| 531 | struct ipaccess_head_ext *hh_ext; |
| 532 | |
| 533 | /* prepend the osmo ip.access header extension */ |
| 534 | hh_ext = (struct ipaccess_head_ext *) msgb_push(msg, sizeof(*hh_ext)); |
| 535 | hh_ext->proto = proto; |
| 536 | } |
| 537 | |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 538 | void ipa_prepend_header(struct msgb *msg, int proto) |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 539 | { |
| 540 | struct ipaccess_head *hh; |
| 541 | |
| 542 | /* prepend the ip.access header */ |
| 543 | hh = (struct ipaccess_head *) msgb_push(msg, sizeof(*hh)); |
Harald Welte | 95871da | 2017-05-15 12:11:36 +0200 | [diff] [blame] | 544 | hh->len = osmo_htons(msg->len - sizeof(*hh)); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 545 | hh->proto = proto; |
| 546 | } |
| 547 | |
Harald Welte | 20725b9 | 2017-05-15 12:50:04 +0200 | [diff] [blame] | 548 | #ifdef HAVE_SYS_SOCKET_H |
| 549 | #include <sys/socket.h> |
| 550 | |
Pau Espin Pedrol | 8a757d2 | 2018-08-22 14:12:01 +0200 | [diff] [blame] | 551 | /*! Read one ipa message from socket fd without caching not fully received |
| 552 | * messages. See \ref ipa_msg_recv_buffered for further information. |
| 553 | */ |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 554 | int ipa_msg_recv(int fd, struct msgb **rmsg) |
| 555 | { |
| 556 | int rc = ipa_msg_recv_buffered(fd, rmsg, NULL); |
| 557 | if (rc < 0) { |
| 558 | errno = -rc; |
| 559 | rc = -1; |
| 560 | } |
| 561 | return rc; |
| 562 | } |
| 563 | |
Pau Espin Pedrol | 8a757d2 | 2018-08-22 14:12:01 +0200 | [diff] [blame] | 564 | /*! Read one ipa message from socket fd or store part if still not fully received. |
| 565 | * \param[in] fd The fd for the socket to read from. |
| 566 | * \param[out] rmsg internally allocated msgb containing a fully received ipa message. |
| 567 | * \param[inout] tmp_msg internally allocated msgb caching data for not yet fully received message. |
| 568 | * |
| 569 | * As ipa can run on top of stream based protocols such as TCP, there's the |
| 570 | * possibility that such lower layers split ipa messages in several low level |
| 571 | * packets. If a low layer packet is received containing several ipa frames, |
| 572 | * this function will pull from the socket and return only the first one |
| 573 | * available in the stream. As the socket will remain with data, it will |
| 574 | * trigger again during next select() and then this function will fetch the |
| 575 | * next ipa message, and so on. |
| 576 | * |
| 577 | * \returns -EAGAIN and allocated tmp_msg if message was not yet fully |
| 578 | * received. Other negative values indicate an error and cached msgb will be |
| 579 | * freed. 0 if socket is found dead. Positive value indicating l2 msgb len and |
| 580 | * rmsg pointing to internally allocated msgb containing the ipa frame on |
| 581 | * scucess. |
| 582 | */ |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 583 | int ipa_msg_recv_buffered(int fd, struct msgb **rmsg, struct msgb **tmp_msg) |
| 584 | { |
| 585 | struct msgb *msg = tmp_msg ? *tmp_msg : NULL; |
| 586 | struct ipaccess_head *hh; |
| 587 | int len, ret; |
| 588 | int needed; |
| 589 | |
| 590 | if (msg == NULL) { |
| 591 | msg = ipa_msg_alloc(0); |
| 592 | if (msg == NULL) { |
| 593 | ret = -ENOMEM; |
| 594 | goto discard_msg; |
| 595 | } |
| 596 | msg->l1h = msg->tail; |
| 597 | } |
| 598 | |
| 599 | if (msg->l2h == NULL) { |
| 600 | /* first read our 3-byte header */ |
| 601 | needed = sizeof(*hh) - msg->len; |
| 602 | ret = recv(fd, msg->tail, needed, 0); |
| 603 | if (ret == 0) |
| 604 | goto discard_msg; |
| 605 | |
| 606 | if (ret < 0) { |
| 607 | if (errno == EAGAIN || errno == EINTR) |
| 608 | ret = 0; |
| 609 | else { |
| 610 | ret = -errno; |
| 611 | goto discard_msg; |
| 612 | } |
| 613 | } |
| 614 | |
| 615 | msgb_put(msg, ret); |
| 616 | |
| 617 | if (ret < needed) { |
| 618 | if (msg->len == 0) { |
| 619 | ret = -EAGAIN; |
| 620 | goto discard_msg; |
| 621 | } |
| 622 | |
| 623 | LOGP(DLINP, LOGL_INFO, |
Harald Welte | f196a02 | 2014-08-21 09:42:03 +0200 | [diff] [blame] | 624 | "Received part of IPA message header (%d/%zu)\n", |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 625 | msg->len, sizeof(*hh)); |
| 626 | if (!tmp_msg) { |
| 627 | ret = -EIO; |
| 628 | goto discard_msg; |
| 629 | } |
| 630 | *tmp_msg = msg; |
| 631 | return -EAGAIN; |
| 632 | } |
| 633 | |
| 634 | msg->l2h = msg->tail; |
| 635 | } |
| 636 | |
| 637 | hh = (struct ipaccess_head *) msg->data; |
| 638 | |
| 639 | /* then read the length as specified in header */ |
Harald Welte | 95871da | 2017-05-15 12:11:36 +0200 | [diff] [blame] | 640 | len = osmo_ntohs(hh->len); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 641 | |
| 642 | if (len < 0 || IPA_ALLOC_SIZE < len + sizeof(*hh)) { |
| 643 | LOGP(DLINP, LOGL_ERROR, "bad message length of %d bytes, " |
| 644 | "received %d bytes\n", len, msg->len); |
| 645 | ret = -EIO; |
| 646 | goto discard_msg; |
| 647 | } |
| 648 | |
| 649 | needed = len - msgb_l2len(msg); |
| 650 | |
| 651 | if (needed > 0) { |
| 652 | ret = recv(fd, msg->tail, needed, 0); |
| 653 | |
| 654 | if (ret == 0) |
| 655 | goto discard_msg; |
| 656 | |
| 657 | if (ret < 0) { |
| 658 | if (errno == EAGAIN || errno == EINTR) |
| 659 | ret = 0; |
| 660 | else { |
| 661 | ret = -errno; |
| 662 | goto discard_msg; |
| 663 | } |
| 664 | } |
| 665 | |
| 666 | msgb_put(msg, ret); |
| 667 | |
| 668 | if (ret < needed) { |
| 669 | LOGP(DLINP, LOGL_INFO, |
| 670 | "Received part of IPA message L2 data (%d/%d)\n", |
| 671 | msgb_l2len(msg), len); |
| 672 | if (!tmp_msg) { |
| 673 | ret = -EIO; |
| 674 | goto discard_msg; |
| 675 | } |
| 676 | *tmp_msg = msg; |
| 677 | return -EAGAIN; |
| 678 | } |
| 679 | } |
| 680 | |
| 681 | ret = msgb_l2len(msg); |
| 682 | |
| 683 | if (ret == 0) { |
| 684 | LOGP(DLINP, LOGL_INFO, |
| 685 | "Discarding IPA message without payload\n"); |
| 686 | ret = -EAGAIN; |
| 687 | goto discard_msg; |
| 688 | } |
| 689 | |
| 690 | if (tmp_msg) |
| 691 | *tmp_msg = NULL; |
| 692 | *rmsg = msg; |
| 693 | return ret; |
| 694 | |
| 695 | discard_msg: |
| 696 | if (tmp_msg) |
| 697 | *tmp_msg = NULL; |
| 698 | msgb_free(msg); |
| 699 | return ret; |
| 700 | } |
| 701 | |
Harald Welte | 20725b9 | 2017-05-15 12:50:04 +0200 | [diff] [blame] | 702 | #endif /* SYS_SOCKET_H */ |
| 703 | |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 704 | struct msgb *ipa_msg_alloc(int headroom) |
| 705 | { |
| 706 | struct msgb *nmsg; |
| 707 | |
| 708 | headroom += sizeof(struct ipaccess_head); |
| 709 | |
Neels Hofmeyr | 889ab16 | 2017-09-07 20:41:12 +0200 | [diff] [blame] | 710 | nmsg = msgb_alloc_headroom(1200 + headroom, headroom, "IPA Multiplex"); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 711 | if (!nmsg) |
| 712 | return NULL; |
| 713 | return nmsg; |
| 714 | } |
Harald Welte | 96e2a00 | 2017-06-12 21:44:18 +0200 | [diff] [blame] | 715 | |
| 716 | /*! @} */ |