blob: 5de13687ae868efe0e116e09458541b91e78328d [file] [log] [blame]
Harald Weltef1033cc2012-11-08 16:14:37 +01001/* OpenBSC SMPP 3.4 interface, SMSC-side implementation */
2
Harald Welte3f786002013-03-13 15:29:27 +01003/* (C) 2012-2013 by Harald Welte <laforge@gnumonks.org>
Harald Weltef1033cc2012-11-08 16:14:37 +01004 *
Harald Welte995ff352013-07-13 16:35:32 +02005 * All Rights Reserved
Harald Weltef1033cc2012-11-08 16:14:37 +01006 *
Harald Welte995ff352013-07-13 16:35:32 +02007 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
Harald Weltef1033cc2012-11-08 16:14:37 +010011 *
Harald Welte995ff352013-07-13 16:35:32 +020012 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
16 *
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
Harald Weltef1033cc2012-11-08 16:14:37 +010019 */
20
21
22#include <stdio.h>
23#include <unistd.h>
24#include <string.h>
25#include <stdint.h>
26#include <errno.h>
27
28#include <smpp34.h>
29#include <smpp34_structs.h>
30#include <smpp34_params.h>
31
32#include <osmocom/core/utils.h>
33#include <osmocom/core/msgb.h>
34#include <osmocom/core/logging.h>
35#include <osmocom/core/talloc.h>
36#include <osmocom/gsm/protocol/gsm_04_11.h>
Harald Welte3f786002013-03-13 15:29:27 +010037#include <osmocom/gsm/protocol/smpp34_osmocom.h>
Harald Weltef1033cc2012-11-08 16:14:37 +010038
39#include <openbsc/gsm_subscriber.h>
40#include <openbsc/debug.h>
41#include <openbsc/db.h>
42#include <openbsc/gsm_04_11.h>
Harald Welted4bdee72012-11-08 19:44:08 +010043#include <openbsc/gsm_data.h>
44#include <openbsc/signal.h>
Harald Welte99e273d2013-07-30 23:39:18 +080045#include <openbsc/transaction.h>
46#include <openbsc/gsm_subscriber.h>
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +020047#include <openbsc/chan_alloc.h>
Harald Welte7b423ed2016-06-19 18:06:02 +020048#include <openbsc/vlr.h>
Harald Weltef1033cc2012-11-08 16:14:37 +010049
50#include "smpp_smsc.h"
51
Harald Welte7b423ed2016-06-19 18:06:02 +020052/*! \brief find vlr_subscr for a given SMPP NPI/TON/Address */
53static struct vlr_subscr *subscr_by_dst(struct gsm_network *net,
54 uint8_t npi, uint8_t ton,
55 const char *addr)
Harald Weltef1033cc2012-11-08 16:14:37 +010056{
Harald Welte7b423ed2016-06-19 18:06:02 +020057 struct vlr_subscr *vsub = NULL;
Harald Weltef1033cc2012-11-08 16:14:37 +010058
59 switch (npi) {
60 case NPI_Land_Mobile_E212:
Harald Welte7b423ed2016-06-19 18:06:02 +020061 vsub = vlr_subscr_find_by_imsi(net->vlr, addr);
Harald Weltef1033cc2012-11-08 16:14:37 +010062 break;
63 case NPI_ISDN_E163_E164:
64 case NPI_Private:
Harald Welte7b423ed2016-06-19 18:06:02 +020065 vsub = vlr_subscr_find_by_msisdn(net->vlr, addr);
Harald Weltef1033cc2012-11-08 16:14:37 +010066 break;
67 default:
68 LOGP(DSMPP, LOGL_NOTICE, "Unsupported NPI: %u\n", npi);
69 break;
70 }
71
Harald Welte7b423ed2016-06-19 18:06:02 +020072 log_set_context(LOG_CTX_VLR_SUBSCR, vsub);
73 return vsub;
Harald Weltef1033cc2012-11-08 16:14:37 +010074}
75
Harald Weltee94db492012-11-08 20:11:05 +010076/*! \brief find a TLV with given tag in list of libsmpp34 TLVs */
Harald Weltee07b6a72012-11-23 19:02:37 +010077static struct tlv_t *find_tlv(struct tlv_t *head, uint16_t tag)
Harald Weltef1033cc2012-11-08 16:14:37 +010078{
79 struct tlv_t *t;
80
81 for (t = head; t != NULL; t = t->next) {
82 if (t->tag == tag)
83 return t;
84 }
85 return NULL;
86}
87
Harald Weltee94db492012-11-08 20:11:05 +010088/*! \brief convert from submit_sm_t to gsm_sms */
Harald Weltef1033cc2012-11-08 16:14:37 +010089static int submit_to_sms(struct gsm_sms **psms, struct gsm_network *net,
90 const struct submit_sm_t *submit)
91{
Harald Welte7b423ed2016-06-19 18:06:02 +020092 struct vlr_subscr *dest;
Harald Weltef1033cc2012-11-08 16:14:37 +010093 struct gsm_sms *sms;
94 struct tlv_t *t;
95 const uint8_t *sms_msg;
96 unsigned int sms_msg_len;
Harald Welte27d5e652013-05-28 20:37:07 +020097 int mode;
Harald Weltef1033cc2012-11-08 16:14:37 +010098
99 dest = subscr_by_dst(net, submit->dest_addr_npi,
100 submit->dest_addr_ton,
101 (const char *)submit->destination_addr);
102 if (!dest) {
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100103 LOGP(DLSMS, LOGL_NOTICE, "SMPP SUBMIT-SM for unknown subscriber: "
Harald Weltef1033cc2012-11-08 16:14:37 +0100104 "%s (NPI=%u)\n", submit->destination_addr,
105 submit->dest_addr_npi);
106 return ESME_RINVDSTADR;
107 }
108
109 t = find_tlv(submit->tlv, TLVID_message_payload);
110 if (t) {
111 if (submit->sm_length) {
Holger Hans Peter Freyther94f83e12014-07-19 19:02:46 +0200112 /* ERROR: we cannot have both! */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100113 LOGP(DLSMS, LOGL_ERROR, "SMPP Cannot have payload in "
Harald Welte9122c132012-11-09 19:43:50 +0100114 "TLV _and_ in the header\n");
Harald Welte7b423ed2016-06-19 18:06:02 +0200115 vlr_subscr_put(dest);
Harald Weltef1033cc2012-11-08 16:14:37 +0100116 return ESME_ROPTPARNOTALLWD;
117 }
118 sms_msg = t->value.octet;
119 sms_msg_len = t->length;
Holger Hans Peter Freythera0735ec2015-02-08 09:53:44 +0100120 } else if (submit->sm_length > 0 && submit->sm_length < 255) {
Harald Weltef1033cc2012-11-08 16:14:37 +0100121 sms_msg = submit->short_message;
122 sms_msg_len = submit->sm_length;
123 } else {
Holger Hans Peter Freythera0735ec2015-02-08 09:53:44 +0100124 LOGP(DLSMS, LOGL_ERROR,
125 "SMPP neither message payload nor valid sm_length.\n");
Harald Welte7b423ed2016-06-19 18:06:02 +0200126 vlr_subscr_put(dest);
Holger Hans Peter Freythera0735ec2015-02-08 09:53:44 +0100127 return ESME_RINVPARLEN;
Harald Weltef1033cc2012-11-08 16:14:37 +0100128 }
129
130 sms = sms_alloc();
Harald Welted4bdee72012-11-08 19:44:08 +0100131 sms->source = SMS_SOURCE_SMPP;
132 sms->smpp.sequence_nr = submit->sequence_number;
Pablo Neira Ayuso92d6dcb2017-08-07 14:01:18 +0100133 sms->status_rep_req = submit->registered_delivery;
Harald Weltec0de14d2012-11-23 23:35:01 +0100134
135 /* fill in the destination address */
Harald Welte1a2993a2012-11-09 19:48:48 +0100136 sms->receiver = dest;
Harald Weltec0de14d2012-11-23 23:35:01 +0100137 sms->dst.ton = submit->dest_addr_ton;
138 sms->dst.npi = submit->dest_addr_npi;
Harald Welte7b423ed2016-06-19 18:06:02 +0200139 osmo_strlcpy(sms->dst.addr, dest->msisdn, sizeof(sms->dst.addr));
Harald Weltec0de14d2012-11-23 23:35:01 +0100140
141 /* fill in the source address */
Harald Weltec0de14d2012-11-23 23:35:01 +0100142 sms->src.ton = submit->source_addr_ton;
143 sms->src.npi = submit->source_addr_npi;
Neels Hofmeyr93bafb62017-01-13 03:12:08 +0100144 osmo_strlcpy(sms->src.addr, (char *)submit->source_addr,
145 sizeof(sms->src.addr));
Harald Weltef1033cc2012-11-08 16:14:37 +0100146
147 if (submit->esm_class & 0x40)
148 sms->ud_hdr_ind = 1;
149
150 if (submit->esm_class & 0x80) {
151 sms->reply_path_req = 1;
152#warning Implement reply path
153 }
154
Harald Welte9ad03622012-11-08 22:15:04 +0100155 if (submit->data_coding == 0x00 || /* SMSC default */
Harald Welte27d5e652013-05-28 20:37:07 +0200156 submit->data_coding == 0x01) { /* GSM default alphabet */
157 sms->data_coding_scheme = GSM338_DCS_1111_7BIT;
158 mode = MODE_7BIT;
159 } else if ((submit->data_coding & 0xFC) == 0xF0) { /* 03.38 DCS default */
160 /* pass DCS 1:1 through from SMPP to GSM */
161 sms->data_coding_scheme = submit->data_coding;
162 mode = MODE_7BIT;
163 } else if (submit->data_coding == 0x02 ||
164 submit->data_coding == 0x04) {
165 /* 8-bit binary */
166 sms->data_coding_scheme = GSM338_DCS_1111_8BIT_DATA;
167 mode = MODE_8BIT;
168 } else if ((submit->data_coding & 0xFC) == 0xF4) { /* 03.38 DCS 8bit */
169 /* pass DCS 1:1 through from SMPP to GSM */
170 sms->data_coding_scheme = submit->data_coding;
171 mode = MODE_8BIT;
Harald Welte7e40be32014-02-21 13:21:03 +0100172 } else if (submit->data_coding == 0x08) {
Harald Welte27d5e652013-05-28 20:37:07 +0200173 /* UCS-2 */
174 sms->data_coding_scheme = (2 << 2);
175 mode = MODE_8BIT;
176 } else {
177 sms_free(sms);
178 LOGP(DLSMS, LOGL_ERROR, "SMPP Unknown Data Coding 0x%02x\n",
179 submit->data_coding);
180 return ESME_RUNKNOWNERR;
181 }
182
Harald Weltec75ed6d2013-05-28 20:58:02 +0200183 if (mode == MODE_7BIT) {
Harald Welteb8a1f962012-11-24 01:37:39 +0100184 uint8_t ud_len = 0, padbits = 0;
Harald Weltef1033cc2012-11-08 16:14:37 +0100185 sms->data_coding_scheme = GSM338_DCS_1111_7BIT;
Harald Welte9122c132012-11-09 19:43:50 +0100186 if (sms->ud_hdr_ind) {
187 ud_len = *sms_msg + 1;
188 printf("copying %u bytes user data...\n", ud_len);
189 memcpy(sms->user_data, sms_msg,
190 OSMO_MIN(ud_len, sizeof(sms->user_data)));
191 sms_msg += ud_len;
192 sms_msg_len -= ud_len;
Harald Welteb8a1f962012-11-24 01:37:39 +0100193 padbits = 7 - (ud_len % 7);
Harald Welte9122c132012-11-09 19:43:50 +0100194 }
Harald Welteb8a1f962012-11-24 01:37:39 +0100195 gsm_septets2octets(sms->user_data+ud_len, sms_msg,
196 sms_msg_len, padbits);
197 sms->user_data_len = (ud_len*8 + padbits)/7 + sms_msg_len;/* SEPTETS */
198 /* FIXME: sms->text */
Harald Welte27d5e652013-05-28 20:37:07 +0200199 } else {
Harald Weltef1033cc2012-11-08 16:14:37 +0100200 memcpy(sms->user_data, sms_msg, sms_msg_len);
201 sms->user_data_len = sms_msg_len;
Harald Weltef1033cc2012-11-08 16:14:37 +0100202 }
203
204 *psms = sms;
205 return ESME_ROK;
206}
207
Harald Weltee94db492012-11-08 20:11:05 +0100208/*! \brief handle incoming libsmpp34 ssubmit_sm_t from remote ESME */
Harald Weltef1033cc2012-11-08 16:14:37 +0100209int handle_smpp_submit(struct osmo_esme *esme, struct submit_sm_t *submit,
210 struct submit_sm_resp_t *submit_r)
211{
212 struct gsm_sms *sms;
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100213 struct gsm_network *net = esme->smsc->priv;
214 struct sms_signal_data sig;
Harald Weltef1033cc2012-11-08 16:14:37 +0100215 int rc = -1;
216
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100217 rc = submit_to_sms(&sms, net, submit);
Harald Weltef1033cc2012-11-08 16:14:37 +0100218 if (rc != ESME_ROK) {
219 submit_r->command_status = rc;
220 return 0;
221 }
Harald Weltee94db492012-11-08 20:11:05 +0100222 smpp_esme_get(esme);
Harald Welted4bdee72012-11-08 19:44:08 +0100223 sms->smpp.esme = esme;
Harald Welte9ad03622012-11-08 22:15:04 +0100224 sms->protocol_id = submit->protocol_id;
Harald Weltef1033cc2012-11-08 16:14:37 +0100225
226 switch (submit->esm_class & 3) {
227 case 0: /* default */
228 case 1: /* datagram */
229 case 3: /* store-and-forward */
230 rc = db_sms_store(sms);
Holger Hans Peter Freyther6a85c152013-01-20 17:21:31 +0100231 sms_free(sms);
232 sms = NULL;
Harald Weltef1033cc2012-11-08 16:14:37 +0100233 if (rc < 0) {
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100234 LOGP(DLSMS, LOGL_ERROR, "SMPP SUBMIT-SM: Unable to "
Harald Weltef1033cc2012-11-08 16:14:37 +0100235 "store SMS in database\n");
Harald Weltef1033cc2012-11-08 16:14:37 +0100236 submit_r->command_status = ESME_RSYSERR;
237 return 0;
238 }
239 strcpy((char *)submit_r->message_id, "msg_id_not_implemented");
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100240 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Stored in DB\n");
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100241
242 memset(&sig, 0, sizeof(sig));
243 osmo_signal_dispatch(SS_SMS, S_SMS_SUBMITTED, &sig);
Harald Weltef1033cc2012-11-08 16:14:37 +0100244 rc = 0;
245 break;
246 case 2: /* forward (i.e. transaction) mode */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100247 LOGP(DLSMS, LOGL_DEBUG, "SMPP SUBMIT-SM: Forwarding in "
Harald Welte9122c132012-11-09 19:43:50 +0100248 "real time (Transaction/Forward mode)\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100249 sms->smpp.transaction_mode = 1;
250 gsm411_send_sms_subscr(sms->receiver, sms);
Harald Weltef1033cc2012-11-08 16:14:37 +0100251 rc = 1; /* don't send any response yet */
252 break;
253 }
254 return rc;
255}
256
Harald Welte7b423ed2016-06-19 18:06:02 +0200257static void alert_all_esme(struct smsc *smsc, struct vlr_subscr *vsub,
Harald Welte045f4022013-07-30 23:45:01 +0800258 uint8_t smpp_avail_status)
259{
260 struct osmo_esme *esme;
261
262 llist_for_each_entry(esme, &smsc->esme_list, list) {
263 /* we currently send an alert notification to each ESME that is
264 * connected, and do not require a (non-existant) delivery
265 * pending flag to be set before, FIXME: make this VTY
266 * configurable */
267 if (esme->acl && esme->acl->deliver_src_imsi) {
268 smpp_tx_alert(esme, TON_Subscriber_Number,
269 NPI_Land_Mobile_E212,
Harald Welte7b423ed2016-06-19 18:06:02 +0200270 vsub->imsi, smpp_avail_status);
Harald Welte045f4022013-07-30 23:45:01 +0800271 } else {
272 smpp_tx_alert(esme, TON_Network_Specific,
273 NPI_ISDN_E163_E164,
Harald Welte7b423ed2016-06-19 18:06:02 +0200274 vsub->msisdn, smpp_avail_status);
Harald Welte045f4022013-07-30 23:45:01 +0800275 }
276 }
277}
278
279
Harald Weltee94db492012-11-08 20:11:05 +0100280/*! \brief signal handler for status of attempted SMS deliveries */
Harald Welted4bdee72012-11-08 19:44:08 +0100281static int smpp_sms_cb(unsigned int subsys, unsigned int signal,
282 void *handler_data, void *signal_data)
283{
Harald Welted4bdee72012-11-08 19:44:08 +0100284 struct sms_signal_data *sig_sms = signal_data;
285 struct gsm_sms *sms = sig_sms->sms;
Harald Welte99e273d2013-07-30 23:39:18 +0800286 struct smsc *smsc = handler_data;
Harald Welted4bdee72012-11-08 19:44:08 +0100287 int rc = 0;
288
289 if (!sms)
290 return 0;
291
292 if (sms->source != SMS_SOURCE_SMPP)
293 return 0;
294
295 switch (signal) {
Harald Welte1aeb2af2013-07-30 22:30:24 +0800296 case S_SMS_MEM_EXCEEDED:
297 /* fall-through: There is no ESME_Rxxx result code to
298 * indicate a MEMORY EXCEEDED in transaction mode back
299 * to the ESME */
Harald Welted4bdee72012-11-08 19:44:08 +0100300 case S_SMS_UNKNOWN_ERROR:
301 if (sms->smpp.transaction_mode) {
302 /* Send back the SUBMIT-SM response with apropriate error */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100303 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Error\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100304 rc = smpp_tx_submit_r(sms->smpp.esme,
305 sms->smpp.sequence_nr,
306 ESME_RDELIVERYFAILURE,
307 sms->smpp.msg_id);
308 }
309 break;
310 case S_SMS_DELIVERED:
311 /* SMS layer tells us the delivery has been completed */
312 if (sms->smpp.transaction_mode) {
313 /* Send back the SUBMIT-SM response */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100314 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Success\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100315 rc = smpp_tx_submit_r(sms->smpp.esme,
316 sms->smpp.sequence_nr,
317 ESME_ROK, sms->smpp.msg_id);
318 }
319 break;
Harald Welte99e273d2013-07-30 23:39:18 +0800320 case S_SMS_SMMA:
Harald Welte7b423ed2016-06-19 18:06:02 +0200321 if (!sig_sms->trans || !sig_sms->trans->vsub) {
Harald Welte99e273d2013-07-30 23:39:18 +0800322 /* SMMA without a subscriber? strange... */
323 LOGP(DLSMS, LOGL_NOTICE, "SMMA without subscriber?\n");
324 break;
325 }
326
Harald Welte99e273d2013-07-30 23:39:18 +0800327 /* There's no real 1:1 match for SMMA in SMPP. However,
328 * an ALERT NOTIFICATION seems to be the most logical
329 * choice */
Harald Welte7b423ed2016-06-19 18:06:02 +0200330 alert_all_esme(smsc, sig_sms->trans->vsub, 0);
Harald Welte99e273d2013-07-30 23:39:18 +0800331 break;
Harald Welted4bdee72012-11-08 19:44:08 +0100332 }
333
334 return rc;
335}
336
Harald Welte8a1b0562012-11-09 12:51:44 +0100337/*! \brief signal handler for subscriber related signals */
338static int smpp_subscr_cb(unsigned int subsys, unsigned int signal,
339 void *handler_data, void *signal_data)
340{
Harald Welte7b423ed2016-06-19 18:06:02 +0200341 struct vlr_subscr *vsub = signal_data;
Harald Welte8a1b0562012-11-09 12:51:44 +0100342 struct smsc *smsc = handler_data;
Harald Welte8a1b0562012-11-09 12:51:44 +0100343 uint8_t smpp_avail_status;
344
345 /* determine the smpp_avail_status depending on attach/detach */
346 switch (signal) {
347 case S_SUBSCR_ATTACHED:
348 smpp_avail_status = 0;
349 break;
350 case S_SUBSCR_DETACHED:
351 smpp_avail_status = 2;
352 break;
353 default:
354 return 0;
355 }
356
Harald Welte7b423ed2016-06-19 18:06:02 +0200357 alert_all_esme(smsc, vsub, smpp_avail_status);
Harald Welte8a1b0562012-11-09 12:51:44 +0100358
359 return 0;
360}
361
Harald Welteb8a1f962012-11-24 01:37:39 +0100362/* GSM 03.38 6.2.1 Character expanding (no decode!) */
363static int gsm_7bit_expand(char *text, const uint8_t *user_data, uint8_t septet_l, uint8_t ud_hdr_ind)
364{
365 int i = 0;
366 int shift = 0;
367 uint8_t c;
368
369 /* skip the user data header */
370 if (ud_hdr_ind) {
371 /* get user data header length + 1 (for the 'user data header length'-field) */
372 shift = ((user_data[0] + 1) * 8) / 7;
373 if ((((user_data[0] + 1) * 8) % 7) != 0)
374 shift++;
375 septet_l = septet_l - shift;
376 }
377
378 for (i = 0; i < septet_l; i++) {
379 c =
380 ((user_data[((i + shift) * 7 + 7) >> 3] <<
381 (7 - (((i + shift) * 7 + 7) & 7))) |
382 (user_data[((i + shift) * 7) >> 3] >>
383 (((i + shift) * 7) & 7))) & 0x7f;
384
385 *(text++) = c;
386 }
387
388 *text = '\0';
389
390 return i;
391}
392
393
Harald Welte3f786002013-03-13 15:29:27 +0100394/* FIXME: libsmpp34 helpers, they should be part of libsmpp34! */
395void append_tlv(tlv_t **req_tlv, uint16_t tag,
396 const uint8_t *data, uint16_t len)
397{
398 tlv_t tlv;
399
400 memset(&tlv, 0, sizeof(tlv));
401 tlv.tag = tag;
402 tlv.length = len;
403 memcpy(tlv.value.octet, data, tlv.length);
404 build_tlv(req_tlv, &tlv);
405}
406void append_tlv_u8(tlv_t **req_tlv, uint16_t tag, uint8_t val)
407{
408 tlv_t tlv;
409
410 memset(&tlv, 0, sizeof(tlv));
411 tlv.tag = tag;
412 tlv.length = 1;
413 tlv.value.val08 = val;
414 build_tlv(req_tlv, &tlv);
415}
416void append_tlv_u16(tlv_t **req_tlv, uint16_t tag, uint16_t val)
417{
418 tlv_t tlv;
419
420 memset(&tlv, 0, sizeof(tlv));
421 tlv.tag = tag;
422 tlv.length = 2;
423 tlv.value.val16 = htons(val);
424 build_tlv(req_tlv, &tlv);
425}
426
Neels Hofmeyr0e5a7c42017-05-08 15:12:20 +0200427#if BEFORE_MSCSPLIT
428/* We currently have no lchan information. Re-add after A-interface, see OS#2390. */
Harald Welte3f786002013-03-13 15:29:27 +0100429/* Append the Osmocom vendor-specific additional TLVs to a SMPP msg */
430static void append_osmo_tlvs(tlv_t **req_tlv, const struct gsm_lchan *lchan)
431{
432 int idx = calc_initial_idx(ARRAY_SIZE(lchan->meas_rep),
433 lchan->meas_rep_idx, 1);
434 const struct gsm_meas_rep *mr = &lchan->meas_rep[idx];
435 const struct gsm_meas_rep_unidir *ul_meas = &mr->ul;
436 const struct gsm_meas_rep_unidir *dl_meas = &mr->dl;
437
438 /* Osmocom vendor-specific SMPP34 extensions */
439 append_tlv_u16(req_tlv, TLVID_osmo_arfcn, lchan->ts->trx->arfcn);
440 if (mr->flags & MEAS_REP_F_MS_L1) {
441 uint8_t ms_dbm;
442 append_tlv_u8(req_tlv, TLVID_osmo_ta, mr->ms_l1.ta);
443 ms_dbm = ms_pwr_dbm(lchan->ts->trx->bts->band, mr->ms_l1.pwr);
444 append_tlv_u8(req_tlv, TLVID_osmo_ms_l1_txpwr, ms_dbm);
Max11e4e412017-04-20 13:07:58 +0200445 } else if (mr->flags & MEAS_REP_F_MS_TO) /* Save Timing Offset field = MS Timing Offset + 63 */
446 append_tlv_u8(req_tlv, TLVID_osmo_ta, mr->ms_timing_offset + 63);
Harald Welte3f786002013-03-13 15:29:27 +0100447
448 append_tlv_u16(req_tlv, TLVID_osmo_rxlev_ul,
449 rxlev2dbm(ul_meas->full.rx_lev));
450 append_tlv_u8(req_tlv, TLVID_osmo_rxqual_ul, ul_meas->full.rx_qual);
451
452 if (mr->flags & MEAS_REP_F_DL_VALID) {
453 append_tlv_u16(req_tlv, TLVID_osmo_rxlev_dl,
454 rxlev2dbm(dl_meas->full.rx_lev));
455 append_tlv_u8(req_tlv, TLVID_osmo_rxqual_dl,
456 dl_meas->full.rx_qual);
457 }
458
Harald Welte7b423ed2016-06-19 18:06:02 +0200459 if (lchan->conn && lchan->conn->vsub) {
460 struct vlr_subscr *vsub = lchan->conn->vsub;
461 size_t imei_len = strlen(vsub->imei);
Harald Welte3f786002013-03-13 15:29:27 +0100462 if (imei_len)
463 append_tlv(req_tlv, TLVID_osmo_imei,
Harald Welte7b423ed2016-06-19 18:06:02 +0200464 (uint8_t *)vsub->imei, imei_len+1);
Harald Welte3f786002013-03-13 15:29:27 +0100465 }
466}
Neels Hofmeyr0e5a7c42017-05-08 15:12:20 +0200467#endif
Harald Welte3f786002013-03-13 15:29:27 +0100468
Keith320960c2017-05-13 23:38:52 +0200469struct {
470 uint32_t smpp_status_code;
471 uint8_t gsm411_cause;
472} smpp_to_gsm411_err_array[] = {
473
474 /* Seems like most phones don't care about the failure cause,
475 * although some will display a different notification for
476 * GSM411_RP_CAUSE_MO_NUM_UNASSIGNED
477 * Some provoke a display of "Try again later"
478 * while others a more definitive "Message sending failed"
479 */
480
481 { ESME_RSYSERR, GSM411_RP_CAUSE_MO_DEST_OUT_OF_ORDER },
482 { ESME_RINVDSTADR, GSM411_RP_CAUSE_MO_NUM_UNASSIGNED },
483 { ESME_RMSGQFUL, GSM411_RP_CAUSE_MO_CONGESTION },
484 { ESME_RINVSRCADR, GSM411_RP_CAUSE_MO_SMS_REJECTED },
485 { ESME_RINVMSGID, GSM411_RP_CAUSE_INV_TRANS_REF }
486};
487
488static int smpp_to_gsm411_err(uint32_t smpp_status_code, int *gsm411_cause)
489{
490 int i;
491 for (i = 0; i < ARRAY_SIZE(smpp_to_gsm411_err_array); i++) {
492 if (smpp_to_gsm411_err_array[i].smpp_status_code != smpp_status_code)
493 continue;
494 *gsm411_cause = smpp_to_gsm411_err_array[i].gsm411_cause;
495 return 0;
496 }
497 return -1;
498}
499
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200500static void smpp_cmd_free(struct osmo_smpp_cmd *cmd)
501{
502 osmo_timer_del(&cmd->response_timer);
503 llist_del(&cmd->list);
Harald Welte7b423ed2016-06-19 18:06:02 +0200504 vlr_subscr_put(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200505 talloc_free(cmd);
506}
507
508void smpp_cmd_flush_pending(struct osmo_esme *esme)
509{
510 struct osmo_smpp_cmd *cmd, *next;
511
512 llist_for_each_entry_safe(cmd, next, &esme->smpp_cmd_list, list)
513 smpp_cmd_free(cmd);
514}
515
516void smpp_cmd_ack(struct osmo_smpp_cmd *cmd)
517{
518 struct gsm_subscriber_connection *conn;
519 struct gsm_trans *trans;
520
Harald Welte7b423ed2016-06-19 18:06:02 +0200521 conn = connection_for_subscr(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200522 if (!conn) {
523 LOGP(DSMPP, LOGL_ERROR, "No connection to subscriber anymore\n");
Pablo Neira Ayuso20515892017-08-07 14:01:01 +0100524 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200525 }
526
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100527 trans = trans_find_by_id(conn, GSM48_PDISC_SMS, cmd->gsm411_trans_id);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200528 if (!trans) {
529 LOGP(DSMPP, LOGL_ERROR, "GSM transaction %u is gone\n",
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100530 cmd->gsm411_trans_id);
Pablo Neira Ayuso20515892017-08-07 14:01:01 +0100531 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200532 }
533
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100534 gsm411_send_rp_ack(trans, cmd->gsm411_msg_ref);
Pablo Neira Ayuso20515892017-08-07 14:01:01 +0100535out:
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200536 smpp_cmd_free(cmd);
537}
538
Keith320960c2017-05-13 23:38:52 +0200539void smpp_cmd_err(struct osmo_smpp_cmd *cmd, uint32_t status)
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200540{
541 struct gsm_subscriber_connection *conn;
542 struct gsm_trans *trans;
Keith320960c2017-05-13 23:38:52 +0200543 int gsm411_cause;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200544
Harald Welte7b423ed2016-06-19 18:06:02 +0200545 conn = connection_for_subscr(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200546 if (!conn) {
547 LOGP(DSMPP, LOGL_ERROR, "No connection to subscriber anymore\n");
Pablo Neira Ayuso20515892017-08-07 14:01:01 +0100548 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200549 }
550
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100551 trans = trans_find_by_id(conn, GSM48_PDISC_SMS, cmd->gsm411_trans_id);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200552 if (!trans) {
553 LOGP(DSMPP, LOGL_ERROR, "GSM transaction %u is gone\n",
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100554 cmd->gsm411_trans_id);
Pablo Neira Ayuso20515892017-08-07 14:01:01 +0100555 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200556 }
557
Keith320960c2017-05-13 23:38:52 +0200558 if (smpp_to_gsm411_err(status, &gsm411_cause) < 0)
559 gsm411_cause = GSM411_RP_CAUSE_MO_NET_OUT_OF_ORDER;
560
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100561 gsm411_send_rp_error(trans, cmd->gsm411_msg_ref, gsm411_cause);
Pablo Neira Ayuso20515892017-08-07 14:01:01 +0100562out:
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200563 smpp_cmd_free(cmd);
564}
565
566static void smpp_deliver_sm_cb(void *data)
567{
Keith320960c2017-05-13 23:38:52 +0200568 smpp_cmd_err(data, ESME_RSYSERR);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200569}
570
571static int smpp_cmd_enqueue(struct osmo_esme *esme,
Harald Welte7b423ed2016-06-19 18:06:02 +0200572 struct vlr_subscr *vsub, struct gsm_sms *sms,
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100573 uint32_t sequence_number)
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200574{
575 struct osmo_smpp_cmd *cmd;
576
577 cmd = talloc_zero(esme, struct osmo_smpp_cmd);
578 if (!cmd)
579 return -1;
580
581 cmd->sequence_nr = sequence_number;
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100582 cmd->gsm411_msg_ref = sms->gsm411.msg_ref;
583 cmd->gsm411_trans_id = sms->gsm411.transaction_id;
Harald Welte7b423ed2016-06-19 18:06:02 +0200584 cmd->vsub = vlr_subscr_get(vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200585
586 /* FIXME: No predefined value for this response_timer as specified by
587 * SMPP 3.4 specs, section 7.2. Make this configurable? Don't forget
588 * lchan keeps busy until we get a reply to this SMPP command. Too high
589 * value may exhaust resources.
590 */
Pablo Neira Ayuso51215762017-05-08 20:57:52 +0200591 osmo_timer_setup(&cmd->response_timer, smpp_deliver_sm_cb, cmd);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200592 osmo_timer_schedule(&cmd->response_timer, 5, 0);
593 llist_add_tail(&cmd->list, &esme->smpp_cmd_list);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200594
595 return 0;
596}
597
598struct osmo_smpp_cmd *smpp_cmd_find_by_seqnum(struct osmo_esme *esme,
599 uint32_t sequence_nr)
600{
601 struct osmo_smpp_cmd *cmd;
602
603 llist_for_each_entry(cmd, &esme->smpp_cmd_list, list) {
604 if (cmd->sequence_nr == sequence_nr)
605 return cmd;
606 }
607 return NULL;
608}
609
Pablo Neira Ayusod11e8f32017-08-07 14:01:15 +0100610/* See SMPP 3.4, Section 5.2.17. registered_delivery (1 byte field). */
611#define SMPP34_NO_DELIVERY_RECEIPT 0x0
612#define SMPP34_DELIVERY_RECEIPT_REQ 0x1
613
Harald Welte3f786002013-03-13 15:29:27 +0100614static int deliver_to_esme(struct osmo_esme *esme, struct gsm_sms *sms,
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100615 struct gsm_subscriber_connection *conn)
Harald Weltee07b6a72012-11-23 19:02:37 +0100616{
617 struct deliver_sm_t deliver;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200618 int mode, ret;
Harald Weltee07b6a72012-11-23 19:02:37 +0100619 uint8_t dcs;
620
621 memset(&deliver, 0, sizeof(deliver));
622 deliver.command_length = 0;
623 deliver.command_id = DELIVER_SM;
624 deliver.command_status = ESME_ROK;
625
626 strcpy((char *)deliver.service_type, "CMT");
627 if (esme->acl && esme->acl->deliver_src_imsi) {
628 deliver.source_addr_ton = TON_Subscriber_Number;
629 deliver.source_addr_npi = NPI_Land_Mobile_E212;
630 snprintf((char *)deliver.source_addr,
631 sizeof(deliver.source_addr), "%s",
Harald Welte7b423ed2016-06-19 18:06:02 +0200632 conn->vsub->imsi);
Harald Weltee07b6a72012-11-23 19:02:37 +0100633 } else {
634 deliver.source_addr_ton = TON_Network_Specific;
635 deliver.source_addr_npi = NPI_ISDN_E163_E164;
636 snprintf((char *)deliver.source_addr,
637 sizeof(deliver.source_addr), "%s",
Harald Welte7b423ed2016-06-19 18:06:02 +0200638 conn->vsub->msisdn);
Harald Weltee07b6a72012-11-23 19:02:37 +0100639 }
640
Harald Weltec0de14d2012-11-23 23:35:01 +0100641 deliver.dest_addr_ton = sms->dst.ton;
642 deliver.dest_addr_npi = sms->dst.npi;
643 memcpy(deliver.destination_addr, sms->dst.addr,
Harald Weltee07b6a72012-11-23 19:02:37 +0100644 sizeof(deliver.destination_addr));
645
646 deliver.esm_class = 1; /* datagram mode */
647 if (sms->ud_hdr_ind)
648 deliver.esm_class |= 0x40;
649 if (sms->reply_path_req)
650 deliver.esm_class |= 0x80;
651
652 deliver.protocol_id = sms->protocol_id;
653 deliver.priority_flag = 0;
Pablo Neira Ayusod11e8f32017-08-07 14:01:15 +0100654 if (sms->status_rep_req)
655 deliver.registered_delivery = SMPP34_DELIVERY_RECEIPT_REQ;
656 else
657 deliver.registered_delivery = SMPP34_NO_DELIVERY_RECEIPT;
Harald Weltee07b6a72012-11-23 19:02:37 +0100658
Harald Weltec75ed6d2013-05-28 20:58:02 +0200659 /* Figure out SMPP DCS from TP-DCS */
Harald Weltee07b6a72012-11-23 19:02:37 +0100660 dcs = sms->data_coding_scheme;
Holger Hans Peter Freythera7328a52013-07-13 17:09:56 +0200661 if (smpp_determine_scheme(dcs, &deliver.data_coding, &mode) == -1)
Harald Weltec75ed6d2013-05-28 20:58:02 +0200662 return -1;
Harald Weltec75ed6d2013-05-28 20:58:02 +0200663
664 /* Transparently pass on DCS via SMPP if requested */
Holger Hans Peter Freyther921b2272013-07-14 08:54:07 +0200665 if (esme->acl && esme->acl->dcs_transparent)
Harald Weltec75ed6d2013-05-28 20:58:02 +0200666 deliver.data_coding = dcs;
667
668 if (mode == MODE_7BIT) {
Harald Weltee07b6a72012-11-23 19:02:37 +0100669 uint8_t *dst = deliver.short_message;
Harald Weltee07b6a72012-11-23 19:02:37 +0100670
671 /* SMPP has this strange notion of putting 7bit SMS in
672 * an octet-aligned mode */
Harald Weltee07b6a72012-11-23 19:02:37 +0100673 if (sms->ud_hdr_ind) {
Harald Welteb8a1f962012-11-24 01:37:39 +0100674 /* length (bytes) of UDH inside UD */
675 uint8_t udh_len = sms->user_data[0] + 1;
676
677 /* copy over the UDH */
678 memcpy(dst, sms->user_data, udh_len);
679 dst += udh_len;
680 deliver.sm_length = udh_len;
Harald Weltee07b6a72012-11-23 19:02:37 +0100681 }
Harald Welteb8a1f962012-11-24 01:37:39 +0100682 /* add decoded text */
683 deliver.sm_length += gsm_7bit_expand((char *)dst, sms->user_data, sms->user_data_len, sms->ud_hdr_ind);
Harald Weltec75ed6d2013-05-28 20:58:02 +0200684 } else {
Harald Weltee07b6a72012-11-23 19:02:37 +0100685 deliver.sm_length = sms->user_data_len;
686 memcpy(deliver.short_message, sms->user_data, deliver.sm_length);
Harald Weltee07b6a72012-11-23 19:02:37 +0100687 }
688
Neels Hofmeyr0e5a7c42017-05-08 15:12:20 +0200689#if BEFORE_MSCSPLIT
690 /* We currently have no lchan information. Re-add after A-interface, see OS#2390. */
Holger Hans Peter Freyther019851a2015-02-08 09:21:04 +0100691 if (esme->acl && esme->acl->osmocom_ext && conn->lchan)
Harald Welte3f786002013-03-13 15:29:27 +0100692 append_osmo_tlvs(&deliver.tlv, conn->lchan);
Neels Hofmeyr0e5a7c42017-05-08 15:12:20 +0200693#endif
Harald Welte3f786002013-03-13 15:29:27 +0100694
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200695 ret = smpp_tx_deliver(esme, &deliver);
696 if (ret < 0)
697 return ret;
698
Harald Welte7b423ed2016-06-19 18:06:02 +0200699 return smpp_cmd_enqueue(esme, conn->vsub, sms,
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100700 deliver.sequence_number);
Harald Weltee07b6a72012-11-23 19:02:37 +0100701}
702
Harald Welte338e3b32012-11-20 22:22:04 +0100703static struct smsc *g_smsc;
704
Holger Hans Peter Freyther42cf2e02015-07-06 16:41:30 +0200705int smpp_route_smpp_first(struct gsm_sms *sms, struct gsm_subscriber_connection *conn)
706{
707 return g_smsc->smpp_first;
708}
709
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200710int smpp_try_deliver(struct gsm_sms *sms,
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100711 struct gsm_subscriber_connection *conn)
Harald Weltee07b6a72012-11-23 19:02:37 +0100712{
713 struct osmo_esme *esme;
714 struct osmo_smpp_addr dst;
Benoit Bolseedc6a7cd2017-07-05 11:46:55 +0200715 int rc;
Harald Weltee07b6a72012-11-23 19:02:37 +0100716
717 memset(&dst, 0, sizeof(dst));
Harald Weltec0de14d2012-11-23 23:35:01 +0100718 dst.ton = sms->dst.ton;
719 dst.npi = sms->dst.npi;
720 memcpy(dst.addr, sms->dst.addr, sizeof(dst.addr));
Harald Weltee07b6a72012-11-23 19:02:37 +0100721
Benoit Bolseedc6a7cd2017-07-05 11:46:55 +0200722 rc = smpp_route(g_smsc, &dst, &esme);
723 if (!rc)
Pablo Neira Ayusoa5d7e612017-08-07 14:01:10 +0100724 rc = deliver_to_esme(esme, sms, conn);
Harald Weltee07b6a72012-11-23 19:02:37 +0100725
Benoit Bolseedc6a7cd2017-07-05 11:46:55 +0200726 return rc;
Harald Weltee07b6a72012-11-23 19:02:37 +0100727}
728
Harald Welte338e3b32012-11-20 22:22:04 +0100729struct smsc *smsc_from_vty(struct vty *v)
730{
731 /* FIXME: this is ugly */
732 return g_smsc;
733}
734
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100735/*! \brief Allocate the OpenBSC SMPP interface struct and init VTY. */
736int smpp_openbsc_alloc_init(void *ctx)
Harald Weltef1033cc2012-11-08 16:14:37 +0100737{
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100738 g_smsc = smpp_smsc_alloc_init(ctx);
739 if (!g_smsc) {
740 LOGP(DSMPP, LOGL_FATAL, "Cannot allocate smsc struct\n");
741 return -1;
742 }
743 return smpp_vty_init();
744}
745
746/*! \brief Launch the OpenBSC SMPP interface with the parameters set from VTY.
747 */
748int smpp_openbsc_start(struct gsm_network *net)
749{
Harald Weltef1033cc2012-11-08 16:14:37 +0100750 int rc;
Harald Welte76afa162013-03-13 15:05:26 +0100751 g_smsc->priv = net;
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100752
753 /* If a VTY configuration has taken place, the values have been stored
754 * in the smsc struct. Otherwise, use the defaults (NULL -> any, 0 ->
755 * default SMPP port, see smpp_smsc_bind()). */
756 rc = smpp_smsc_start(g_smsc, g_smsc->bind_addr, g_smsc->listen_port);
757 if (rc < 0)
758 return rc;
759
760 rc = osmo_signal_register_handler(SS_SMS, smpp_sms_cb, g_smsc);
761 if (rc < 0)
762 return rc;
763 rc = osmo_signal_register_handler(SS_SUBSCR, smpp_subscr_cb, g_smsc);
764 if (rc < 0)
765 return rc;
766
767 return 0;
Harald Welte76afa162013-03-13 15:05:26 +0100768}
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100769