blob: 4e2fb556a25d48b5f841c975352ceab5eb62cfca [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
Neels Hofmeyr90843962017-09-04 15:04:35 +020039#include <osmocom/msc/gsm_subscriber.h>
40#include <osmocom/msc/debug.h>
41#include <osmocom/msc/db.h>
42#include <osmocom/msc/gsm_04_11.h>
43#include <osmocom/msc/gsm_data.h>
44#include <osmocom/msc/signal.h>
45#include <osmocom/msc/transaction.h>
46#include <osmocom/msc/gsm_subscriber.h>
Neels Hofmeyr90843962017-09-04 15:04:35 +020047#include <osmocom/msc/vlr.h>
Harald Weltef1033cc2012-11-08 16:14:37 +010048
49#include "smpp_smsc.h"
50
Harald Welte2483f1b2016-06-19 18:06:02 +020051/*! \brief find vlr_subscr for a given SMPP NPI/TON/Address */
52static struct vlr_subscr *subscr_by_dst(struct gsm_network *net,
53 uint8_t npi, uint8_t ton,
54 const char *addr)
Harald Weltef1033cc2012-11-08 16:14:37 +010055{
Harald Welte2483f1b2016-06-19 18:06:02 +020056 struct vlr_subscr *vsub = NULL;
Harald Weltef1033cc2012-11-08 16:14:37 +010057
58 switch (npi) {
59 case NPI_Land_Mobile_E212:
Harald Welte2483f1b2016-06-19 18:06:02 +020060 vsub = vlr_subscr_find_by_imsi(net->vlr, addr);
Harald Weltef1033cc2012-11-08 16:14:37 +010061 break;
62 case NPI_ISDN_E163_E164:
63 case NPI_Private:
Harald Welte2483f1b2016-06-19 18:06:02 +020064 vsub = vlr_subscr_find_by_msisdn(net->vlr, addr);
Harald Weltef1033cc2012-11-08 16:14:37 +010065 break;
66 default:
67 LOGP(DSMPP, LOGL_NOTICE, "Unsupported NPI: %u\n", npi);
68 break;
69 }
70
Harald Welte2483f1b2016-06-19 18:06:02 +020071 log_set_context(LOG_CTX_VLR_SUBSCR, vsub);
72 return vsub;
Harald Weltef1033cc2012-11-08 16:14:37 +010073}
74
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +020075static int smpp34_submit_tlv_msg_payload(const struct tlv_t *t,
76 const struct submit_sm_t *submit,
77 const uint8_t **sms_msg,
78 unsigned int *sms_msg_len)
Harald Weltef1033cc2012-11-08 16:14:37 +010079{
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +020080 if (submit->sm_length) {
81 LOGP(DLSMS, LOGL_ERROR,
82 "SMPP cannot have payload in TLV _and_ in the header\n");
83 return -1;
Harald Weltef1033cc2012-11-08 16:14:37 +010084 }
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +020085 *sms_msg = t->value.octet;
86 *sms_msg_len = t->length;
87
88 return 0;
Harald Weltef1033cc2012-11-08 16:14:37 +010089}
90
Harald Weltee94db492012-11-08 20:11:05 +010091/*! \brief convert from submit_sm_t to gsm_sms */
Harald Weltef1033cc2012-11-08 16:14:37 +010092static int submit_to_sms(struct gsm_sms **psms, struct gsm_network *net,
93 const struct submit_sm_t *submit)
94{
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +020095 const uint8_t *sms_msg = NULL;
Pau Espin Pedrol7e16e722017-08-14 21:18:41 +020096 unsigned int sms_msg_len = 0;
Harald Welte2483f1b2016-06-19 18:06:02 +020097 struct vlr_subscr *dest;
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +020098 uint16_t msg_ref = 0;
Harald Weltef1033cc2012-11-08 16:14:37 +010099 struct gsm_sms *sms;
100 struct tlv_t *t;
Harald Welte27d5e652013-05-28 20:37:07 +0200101 int mode;
Harald Weltef1033cc2012-11-08 16:14:37 +0100102
103 dest = subscr_by_dst(net, submit->dest_addr_npi,
104 submit->dest_addr_ton,
105 (const char *)submit->destination_addr);
106 if (!dest) {
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100107 LOGP(DLSMS, LOGL_NOTICE, "SMPP SUBMIT-SM for unknown subscriber: "
Harald Weltef1033cc2012-11-08 16:14:37 +0100108 "%s (NPI=%u)\n", submit->destination_addr,
109 submit->dest_addr_npi);
110 return ESME_RINVDSTADR;
111 }
112
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +0200113 smpp34_tlv_for_each(t, submit->tlv) {
114 switch (t->tag) {
115 case TLVID_message_payload:
116 if (smpp34_submit_tlv_msg_payload(t, submit, &sms_msg,
117 &sms_msg_len) < 0) {
118 vlr_subscr_put(dest);
119 return ESME_ROPTPARNOTALLWD;
120 }
121 break;
122 case TLVID_user_message_reference:
Pau Espin Pedrold5c43392017-08-18 12:26:23 +0200123 msg_ref = t->value.val16;
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +0200124 break;
125 default:
126 break;
Harald Weltef1033cc2012-11-08 16:14:37 +0100127 }
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +0200128 }
129
130 if (!sms_msg) {
131 if (submit->sm_length > 0 && submit->sm_length < 255) {
132 sms_msg = submit->short_message;
133 sms_msg_len = submit->sm_length;
134 } else {
135 LOGP(DLSMS, LOGL_ERROR,
136 "SMPP neither message payload nor valid sm_length.\n");
137 vlr_subscr_put(dest);
138 return ESME_RINVPARLEN;
139 }
Harald Weltef1033cc2012-11-08 16:14:37 +0100140 }
141
142 sms = sms_alloc();
Harald Welted4bdee72012-11-08 19:44:08 +0100143 sms->source = SMS_SOURCE_SMPP;
144 sms->smpp.sequence_nr = submit->sequence_number;
Pablo Neira Ayuso791bdf72017-08-07 14:01:18 +0100145 sms->status_rep_req = submit->registered_delivery;
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +0200146 sms->msg_ref = msg_ref;
Harald Weltec0de14d2012-11-23 23:35:01 +0100147
148 /* fill in the destination address */
Harald Welte1a2993a2012-11-09 19:48:48 +0100149 sms->receiver = dest;
Harald Weltec0de14d2012-11-23 23:35:01 +0100150 sms->dst.ton = submit->dest_addr_ton;
151 sms->dst.npi = submit->dest_addr_npi;
Harald Welte2483f1b2016-06-19 18:06:02 +0200152 osmo_strlcpy(sms->dst.addr, dest->msisdn, sizeof(sms->dst.addr));
Harald Weltec0de14d2012-11-23 23:35:01 +0100153
154 /* fill in the source address */
Harald Weltec0de14d2012-11-23 23:35:01 +0100155 sms->src.ton = submit->source_addr_ton;
156 sms->src.npi = submit->source_addr_npi;
Neels Hofmeyr93bafb62017-01-13 03:12:08 +0100157 osmo_strlcpy(sms->src.addr, (char *)submit->source_addr,
158 sizeof(sms->src.addr));
Harald Weltef1033cc2012-11-08 16:14:37 +0100159
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200160 if (submit->esm_class == SMPP34_DELIVERY_ACK)
Pablo Neira Ayusobd71d322017-08-07 14:01:40 +0100161 sms->is_report = true;
162
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200163 if (submit->esm_class & SMPP34_UDHI_IND)
Harald Weltef1033cc2012-11-08 16:14:37 +0100164 sms->ud_hdr_ind = 1;
165
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200166 if (submit->esm_class & SMPP34_REPLY_PATH) {
Harald Weltef1033cc2012-11-08 16:14:37 +0100167 sms->reply_path_req = 1;
168#warning Implement reply path
169 }
170
Harald Welte9ad03622012-11-08 22:15:04 +0100171 if (submit->data_coding == 0x00 || /* SMSC default */
Harald Welte27d5e652013-05-28 20:37:07 +0200172 submit->data_coding == 0x01) { /* GSM default alphabet */
173 sms->data_coding_scheme = GSM338_DCS_1111_7BIT;
174 mode = MODE_7BIT;
175 } else if ((submit->data_coding & 0xFC) == 0xF0) { /* 03.38 DCS default */
176 /* pass DCS 1:1 through from SMPP to GSM */
177 sms->data_coding_scheme = submit->data_coding;
178 mode = MODE_7BIT;
179 } else if (submit->data_coding == 0x02 ||
180 submit->data_coding == 0x04) {
181 /* 8-bit binary */
182 sms->data_coding_scheme = GSM338_DCS_1111_8BIT_DATA;
183 mode = MODE_8BIT;
184 } else if ((submit->data_coding & 0xFC) == 0xF4) { /* 03.38 DCS 8bit */
185 /* pass DCS 1:1 through from SMPP to GSM */
186 sms->data_coding_scheme = submit->data_coding;
187 mode = MODE_8BIT;
Harald Welte7e40be32014-02-21 13:21:03 +0100188 } else if (submit->data_coding == 0x08) {
Harald Welte27d5e652013-05-28 20:37:07 +0200189 /* UCS-2 */
190 sms->data_coding_scheme = (2 << 2);
191 mode = MODE_8BIT;
192 } else {
193 sms_free(sms);
194 LOGP(DLSMS, LOGL_ERROR, "SMPP Unknown Data Coding 0x%02x\n",
195 submit->data_coding);
196 return ESME_RUNKNOWNERR;
197 }
198
Harald Weltec75ed6d2013-05-28 20:58:02 +0200199 if (mode == MODE_7BIT) {
Harald Welteb8a1f962012-11-24 01:37:39 +0100200 uint8_t ud_len = 0, padbits = 0;
Harald Weltef1033cc2012-11-08 16:14:37 +0100201 sms->data_coding_scheme = GSM338_DCS_1111_7BIT;
Harald Welte9122c132012-11-09 19:43:50 +0100202 if (sms->ud_hdr_ind) {
203 ud_len = *sms_msg + 1;
204 printf("copying %u bytes user data...\n", ud_len);
205 memcpy(sms->user_data, sms_msg,
206 OSMO_MIN(ud_len, sizeof(sms->user_data)));
207 sms_msg += ud_len;
208 sms_msg_len -= ud_len;
Harald Welteb8a1f962012-11-24 01:37:39 +0100209 padbits = 7 - (ud_len % 7);
Harald Welte9122c132012-11-09 19:43:50 +0100210 }
Harald Welteb8a1f962012-11-24 01:37:39 +0100211 gsm_septets2octets(sms->user_data+ud_len, sms_msg,
212 sms_msg_len, padbits);
213 sms->user_data_len = (ud_len*8 + padbits)/7 + sms_msg_len;/* SEPTETS */
214 /* FIXME: sms->text */
Harald Welte27d5e652013-05-28 20:37:07 +0200215 } else {
Harald Weltef1033cc2012-11-08 16:14:37 +0100216 memcpy(sms->user_data, sms_msg, sms_msg_len);
217 sms->user_data_len = sms_msg_len;
Harald Weltef1033cc2012-11-08 16:14:37 +0100218 }
219
220 *psms = sms;
221 return ESME_ROK;
222}
223
Harald Weltee94db492012-11-08 20:11:05 +0100224/*! \brief handle incoming libsmpp34 ssubmit_sm_t from remote ESME */
Harald Weltef1033cc2012-11-08 16:14:37 +0100225int handle_smpp_submit(struct osmo_esme *esme, struct submit_sm_t *submit,
226 struct submit_sm_resp_t *submit_r)
227{
228 struct gsm_sms *sms;
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100229 struct gsm_network *net = esme->smsc->priv;
230 struct sms_signal_data sig;
Harald Weltef1033cc2012-11-08 16:14:37 +0100231 int rc = -1;
232
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100233 rc = submit_to_sms(&sms, net, submit);
Harald Weltef1033cc2012-11-08 16:14:37 +0100234 if (rc != ESME_ROK) {
235 submit_r->command_status = rc;
236 return 0;
237 }
Harald Weltee94db492012-11-08 20:11:05 +0100238 smpp_esme_get(esme);
Harald Welted4bdee72012-11-08 19:44:08 +0100239 sms->smpp.esme = esme;
Harald Welte9ad03622012-11-08 22:15:04 +0100240 sms->protocol_id = submit->protocol_id;
Harald Weltef1033cc2012-11-08 16:14:37 +0100241
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200242 switch (submit->esm_class & SMPP34_MSG_MODE_MASK) {
Harald Weltef1033cc2012-11-08 16:14:37 +0100243 case 0: /* default */
244 case 1: /* datagram */
245 case 3: /* store-and-forward */
246 rc = db_sms_store(sms);
Holger Hans Peter Freyther6a85c152013-01-20 17:21:31 +0100247 sms_free(sms);
248 sms = NULL;
Harald Weltef1033cc2012-11-08 16:14:37 +0100249 if (rc < 0) {
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100250 LOGP(DLSMS, LOGL_ERROR, "SMPP SUBMIT-SM: Unable to "
Harald Weltef1033cc2012-11-08 16:14:37 +0100251 "store SMS in database\n");
Harald Weltef1033cc2012-11-08 16:14:37 +0100252 submit_r->command_status = ESME_RSYSERR;
253 return 0;
254 }
255 strcpy((char *)submit_r->message_id, "msg_id_not_implemented");
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100256 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Stored in DB\n");
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100257
258 memset(&sig, 0, sizeof(sig));
259 osmo_signal_dispatch(SS_SMS, S_SMS_SUBMITTED, &sig);
Harald Weltef1033cc2012-11-08 16:14:37 +0100260 rc = 0;
261 break;
262 case 2: /* forward (i.e. transaction) mode */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100263 LOGP(DLSMS, LOGL_DEBUG, "SMPP SUBMIT-SM: Forwarding in "
Harald Welte9122c132012-11-09 19:43:50 +0100264 "real time (Transaction/Forward mode)\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100265 sms->smpp.transaction_mode = 1;
266 gsm411_send_sms_subscr(sms->receiver, sms);
Harald Weltef1033cc2012-11-08 16:14:37 +0100267 rc = 1; /* don't send any response yet */
268 break;
269 }
270 return rc;
271}
272
Harald Welte2483f1b2016-06-19 18:06:02 +0200273static void alert_all_esme(struct smsc *smsc, struct vlr_subscr *vsub,
Harald Welte045f4022013-07-30 23:45:01 +0800274 uint8_t smpp_avail_status)
275{
276 struct osmo_esme *esme;
277
278 llist_for_each_entry(esme, &smsc->esme_list, list) {
279 /* we currently send an alert notification to each ESME that is
280 * connected, and do not require a (non-existant) delivery
281 * pending flag to be set before, FIXME: make this VTY
282 * configurable */
283 if (esme->acl && esme->acl->deliver_src_imsi) {
284 smpp_tx_alert(esme, TON_Subscriber_Number,
285 NPI_Land_Mobile_E212,
Harald Welte2483f1b2016-06-19 18:06:02 +0200286 vsub->imsi, smpp_avail_status);
Harald Welte045f4022013-07-30 23:45:01 +0800287 } else {
288 smpp_tx_alert(esme, TON_Network_Specific,
289 NPI_ISDN_E163_E164,
Harald Welte2483f1b2016-06-19 18:06:02 +0200290 vsub->msisdn, smpp_avail_status);
Harald Welte045f4022013-07-30 23:45:01 +0800291 }
292 }
293}
294
295
Harald Weltee94db492012-11-08 20:11:05 +0100296/*! \brief signal handler for status of attempted SMS deliveries */
Harald Welted4bdee72012-11-08 19:44:08 +0100297static int smpp_sms_cb(unsigned int subsys, unsigned int signal,
298 void *handler_data, void *signal_data)
299{
Harald Welted4bdee72012-11-08 19:44:08 +0100300 struct sms_signal_data *sig_sms = signal_data;
301 struct gsm_sms *sms = sig_sms->sms;
Harald Welte99e273d2013-07-30 23:39:18 +0800302 struct smsc *smsc = handler_data;
Harald Welted4bdee72012-11-08 19:44:08 +0100303 int rc = 0;
304
305 if (!sms)
306 return 0;
307
308 if (sms->source != SMS_SOURCE_SMPP)
309 return 0;
310
311 switch (signal) {
Harald Welte1aeb2af2013-07-30 22:30:24 +0800312 case S_SMS_MEM_EXCEEDED:
313 /* fall-through: There is no ESME_Rxxx result code to
314 * indicate a MEMORY EXCEEDED in transaction mode back
315 * to the ESME */
Harald Welted4bdee72012-11-08 19:44:08 +0100316 case S_SMS_UNKNOWN_ERROR:
317 if (sms->smpp.transaction_mode) {
318 /* Send back the SUBMIT-SM response with apropriate error */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100319 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Error\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100320 rc = smpp_tx_submit_r(sms->smpp.esme,
321 sms->smpp.sequence_nr,
322 ESME_RDELIVERYFAILURE,
323 sms->smpp.msg_id);
324 }
325 break;
326 case S_SMS_DELIVERED:
327 /* SMS layer tells us the delivery has been completed */
328 if (sms->smpp.transaction_mode) {
329 /* Send back the SUBMIT-SM response */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100330 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Success\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100331 rc = smpp_tx_submit_r(sms->smpp.esme,
332 sms->smpp.sequence_nr,
333 ESME_ROK, sms->smpp.msg_id);
334 }
335 break;
Harald Welte99e273d2013-07-30 23:39:18 +0800336 case S_SMS_SMMA:
Harald Welte2483f1b2016-06-19 18:06:02 +0200337 if (!sig_sms->trans || !sig_sms->trans->vsub) {
Harald Welte99e273d2013-07-30 23:39:18 +0800338 /* SMMA without a subscriber? strange... */
339 LOGP(DLSMS, LOGL_NOTICE, "SMMA without subscriber?\n");
340 break;
341 }
342
Harald Welte99e273d2013-07-30 23:39:18 +0800343 /* There's no real 1:1 match for SMMA in SMPP. However,
344 * an ALERT NOTIFICATION seems to be the most logical
345 * choice */
Harald Welte2483f1b2016-06-19 18:06:02 +0200346 alert_all_esme(smsc, sig_sms->trans->vsub, 0);
Harald Welte99e273d2013-07-30 23:39:18 +0800347 break;
Harald Welted4bdee72012-11-08 19:44:08 +0100348 }
349
350 return rc;
351}
352
Harald Welte8a1b0562012-11-09 12:51:44 +0100353/*! \brief signal handler for subscriber related signals */
354static int smpp_subscr_cb(unsigned int subsys, unsigned int signal,
355 void *handler_data, void *signal_data)
356{
Harald Welte2483f1b2016-06-19 18:06:02 +0200357 struct vlr_subscr *vsub = signal_data;
Harald Welte8a1b0562012-11-09 12:51:44 +0100358 struct smsc *smsc = handler_data;
Harald Welte8a1b0562012-11-09 12:51:44 +0100359 uint8_t smpp_avail_status;
360
361 /* determine the smpp_avail_status depending on attach/detach */
362 switch (signal) {
363 case S_SUBSCR_ATTACHED:
364 smpp_avail_status = 0;
365 break;
366 case S_SUBSCR_DETACHED:
367 smpp_avail_status = 2;
368 break;
369 default:
370 return 0;
371 }
372
Harald Welte2483f1b2016-06-19 18:06:02 +0200373 alert_all_esme(smsc, vsub, smpp_avail_status);
Harald Welte8a1b0562012-11-09 12:51:44 +0100374
375 return 0;
376}
377
Harald Welteb8a1f962012-11-24 01:37:39 +0100378/* GSM 03.38 6.2.1 Character expanding (no decode!) */
379static int gsm_7bit_expand(char *text, const uint8_t *user_data, uint8_t septet_l, uint8_t ud_hdr_ind)
380{
381 int i = 0;
382 int shift = 0;
383 uint8_t c;
384
385 /* skip the user data header */
386 if (ud_hdr_ind) {
387 /* get user data header length + 1 (for the 'user data header length'-field) */
388 shift = ((user_data[0] + 1) * 8) / 7;
389 if ((((user_data[0] + 1) * 8) % 7) != 0)
390 shift++;
391 septet_l = septet_l - shift;
392 }
393
394 for (i = 0; i < septet_l; i++) {
395 c =
396 ((user_data[((i + shift) * 7 + 7) >> 3] <<
397 (7 - (((i + shift) * 7 + 7) & 7))) |
398 (user_data[((i + shift) * 7) >> 3] >>
399 (((i + shift) * 7) & 7))) & 0x7f;
400
401 *(text++) = c;
402 }
403
404 *text = '\0';
405
406 return i;
407}
408
409
Harald Welte3f786002013-03-13 15:29:27 +0100410/* FIXME: libsmpp34 helpers, they should be part of libsmpp34! */
411void append_tlv(tlv_t **req_tlv, uint16_t tag,
412 const uint8_t *data, uint16_t len)
413{
414 tlv_t tlv;
415
416 memset(&tlv, 0, sizeof(tlv));
417 tlv.tag = tag;
418 tlv.length = len;
419 memcpy(tlv.value.octet, data, tlv.length);
420 build_tlv(req_tlv, &tlv);
421}
422void append_tlv_u8(tlv_t **req_tlv, uint16_t tag, uint8_t val)
423{
424 tlv_t tlv;
425
426 memset(&tlv, 0, sizeof(tlv));
427 tlv.tag = tag;
428 tlv.length = 1;
429 tlv.value.val08 = val;
430 build_tlv(req_tlv, &tlv);
431}
432void append_tlv_u16(tlv_t **req_tlv, uint16_t tag, uint16_t val)
433{
434 tlv_t tlv;
435
436 memset(&tlv, 0, sizeof(tlv));
437 tlv.tag = tag;
438 tlv.length = 2;
Pau Espin Pedrold5c43392017-08-18 12:26:23 +0200439 tlv.value.val16 = val;
Harald Welte3f786002013-03-13 15:29:27 +0100440 build_tlv(req_tlv, &tlv);
441}
442
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200443#if BEFORE_MSCSPLIT
444/* We currently have no lchan information. Re-add after A-interface, see OS#2390. */
Harald Welte3f786002013-03-13 15:29:27 +0100445/* Append the Osmocom vendor-specific additional TLVs to a SMPP msg */
446static void append_osmo_tlvs(tlv_t **req_tlv, const struct gsm_lchan *lchan)
447{
448 int idx = calc_initial_idx(ARRAY_SIZE(lchan->meas_rep),
449 lchan->meas_rep_idx, 1);
450 const struct gsm_meas_rep *mr = &lchan->meas_rep[idx];
451 const struct gsm_meas_rep_unidir *ul_meas = &mr->ul;
452 const struct gsm_meas_rep_unidir *dl_meas = &mr->dl;
453
454 /* Osmocom vendor-specific SMPP34 extensions */
455 append_tlv_u16(req_tlv, TLVID_osmo_arfcn, lchan->ts->trx->arfcn);
456 if (mr->flags & MEAS_REP_F_MS_L1) {
457 uint8_t ms_dbm;
458 append_tlv_u8(req_tlv, TLVID_osmo_ta, mr->ms_l1.ta);
459 ms_dbm = ms_pwr_dbm(lchan->ts->trx->bts->band, mr->ms_l1.pwr);
460 append_tlv_u8(req_tlv, TLVID_osmo_ms_l1_txpwr, ms_dbm);
Max11e4e412017-04-20 13:07:58 +0200461 } else if (mr->flags & MEAS_REP_F_MS_TO) /* Save Timing Offset field = MS Timing Offset + 63 */
462 append_tlv_u8(req_tlv, TLVID_osmo_ta, mr->ms_timing_offset + 63);
Harald Welte3f786002013-03-13 15:29:27 +0100463
464 append_tlv_u16(req_tlv, TLVID_osmo_rxlev_ul,
465 rxlev2dbm(ul_meas->full.rx_lev));
466 append_tlv_u8(req_tlv, TLVID_osmo_rxqual_ul, ul_meas->full.rx_qual);
467
468 if (mr->flags & MEAS_REP_F_DL_VALID) {
469 append_tlv_u16(req_tlv, TLVID_osmo_rxlev_dl,
470 rxlev2dbm(dl_meas->full.rx_lev));
471 append_tlv_u8(req_tlv, TLVID_osmo_rxqual_dl,
472 dl_meas->full.rx_qual);
473 }
474
Harald Welte2483f1b2016-06-19 18:06:02 +0200475 if (lchan->conn && lchan->conn->vsub) {
476 struct vlr_subscr *vsub = lchan->conn->vsub;
477 size_t imei_len = strlen(vsub->imei);
Harald Welte3f786002013-03-13 15:29:27 +0100478 if (imei_len)
479 append_tlv(req_tlv, TLVID_osmo_imei,
Harald Welte2483f1b2016-06-19 18:06:02 +0200480 (uint8_t *)vsub->imei, imei_len+1);
Harald Welte3f786002013-03-13 15:29:27 +0100481 }
482}
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200483#endif
Harald Welte3f786002013-03-13 15:29:27 +0100484
Keith320960c2017-05-13 23:38:52 +0200485struct {
486 uint32_t smpp_status_code;
487 uint8_t gsm411_cause;
488} smpp_to_gsm411_err_array[] = {
489
490 /* Seems like most phones don't care about the failure cause,
491 * although some will display a different notification for
492 * GSM411_RP_CAUSE_MO_NUM_UNASSIGNED
493 * Some provoke a display of "Try again later"
494 * while others a more definitive "Message sending failed"
495 */
496
497 { ESME_RSYSERR, GSM411_RP_CAUSE_MO_DEST_OUT_OF_ORDER },
498 { ESME_RINVDSTADR, GSM411_RP_CAUSE_MO_NUM_UNASSIGNED },
499 { ESME_RMSGQFUL, GSM411_RP_CAUSE_MO_CONGESTION },
500 { ESME_RINVSRCADR, GSM411_RP_CAUSE_MO_SMS_REJECTED },
501 { ESME_RINVMSGID, GSM411_RP_CAUSE_INV_TRANS_REF }
502};
503
504static int smpp_to_gsm411_err(uint32_t smpp_status_code, int *gsm411_cause)
505{
506 int i;
507 for (i = 0; i < ARRAY_SIZE(smpp_to_gsm411_err_array); i++) {
508 if (smpp_to_gsm411_err_array[i].smpp_status_code != smpp_status_code)
509 continue;
510 *gsm411_cause = smpp_to_gsm411_err_array[i].gsm411_cause;
511 return 0;
512 }
513 return -1;
514}
515
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200516static void smpp_cmd_free(struct osmo_smpp_cmd *cmd)
517{
518 osmo_timer_del(&cmd->response_timer);
519 llist_del(&cmd->list);
Harald Welte2483f1b2016-06-19 18:06:02 +0200520 vlr_subscr_put(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200521 talloc_free(cmd);
522}
523
524void smpp_cmd_flush_pending(struct osmo_esme *esme)
525{
526 struct osmo_smpp_cmd *cmd, *next;
527
528 llist_for_each_entry_safe(cmd, next, &esme->smpp_cmd_list, list)
529 smpp_cmd_free(cmd);
530}
531
532void smpp_cmd_ack(struct osmo_smpp_cmd *cmd)
533{
534 struct gsm_subscriber_connection *conn;
535 struct gsm_trans *trans;
536
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100537 if (cmd->is_report)
538 goto out;
539
Harald Welte2483f1b2016-06-19 18:06:02 +0200540 conn = connection_for_subscr(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200541 if (!conn) {
542 LOGP(DSMPP, LOGL_ERROR, "No connection to subscriber anymore\n");
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100543 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200544 }
545
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100546 trans = trans_find_by_id(conn, GSM48_PDISC_SMS, cmd->gsm411_trans_id);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200547 if (!trans) {
548 LOGP(DSMPP, LOGL_ERROR, "GSM transaction %u is gone\n",
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100549 cmd->gsm411_trans_id);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100550 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200551 }
552
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100553 gsm411_send_rp_ack(trans, cmd->gsm411_msg_ref);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100554out:
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200555 smpp_cmd_free(cmd);
556}
557
Keith320960c2017-05-13 23:38:52 +0200558void smpp_cmd_err(struct osmo_smpp_cmd *cmd, uint32_t status)
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200559{
560 struct gsm_subscriber_connection *conn;
561 struct gsm_trans *trans;
Keith320960c2017-05-13 23:38:52 +0200562 int gsm411_cause;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200563
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100564 if (cmd->is_report)
565 goto out;
566
Harald Welte2483f1b2016-06-19 18:06:02 +0200567 conn = connection_for_subscr(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200568 if (!conn) {
569 LOGP(DSMPP, LOGL_ERROR, "No connection to subscriber anymore\n");
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100570 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200571 }
572
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100573 trans = trans_find_by_id(conn, GSM48_PDISC_SMS, cmd->gsm411_trans_id);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200574 if (!trans) {
575 LOGP(DSMPP, LOGL_ERROR, "GSM transaction %u is gone\n",
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100576 cmd->gsm411_trans_id);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100577 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200578 }
579
Keith320960c2017-05-13 23:38:52 +0200580 if (smpp_to_gsm411_err(status, &gsm411_cause) < 0)
581 gsm411_cause = GSM411_RP_CAUSE_MO_NET_OUT_OF_ORDER;
582
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100583 gsm411_send_rp_error(trans, cmd->gsm411_msg_ref, gsm411_cause);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100584out:
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200585 smpp_cmd_free(cmd);
586}
587
588static void smpp_deliver_sm_cb(void *data)
589{
Keith320960c2017-05-13 23:38:52 +0200590 smpp_cmd_err(data, ESME_RSYSERR);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200591}
592
593static int smpp_cmd_enqueue(struct osmo_esme *esme,
Harald Welte2483f1b2016-06-19 18:06:02 +0200594 struct vlr_subscr *vsub, struct gsm_sms *sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100595 uint32_t sequence_number)
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200596{
597 struct osmo_smpp_cmd *cmd;
598
599 cmd = talloc_zero(esme, struct osmo_smpp_cmd);
600 if (!cmd)
601 return -1;
602
603 cmd->sequence_nr = sequence_number;
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100604 cmd->is_report = sms->is_report;
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100605 cmd->gsm411_msg_ref = sms->gsm411.msg_ref;
606 cmd->gsm411_trans_id = sms->gsm411.transaction_id;
Harald Welte2483f1b2016-06-19 18:06:02 +0200607 cmd->vsub = vlr_subscr_get(vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200608
609 /* FIXME: No predefined value for this response_timer as specified by
610 * SMPP 3.4 specs, section 7.2. Make this configurable? Don't forget
611 * lchan keeps busy until we get a reply to this SMPP command. Too high
612 * value may exhaust resources.
613 */
Pablo Neira Ayuso51215762017-05-08 20:57:52 +0200614 osmo_timer_setup(&cmd->response_timer, smpp_deliver_sm_cb, cmd);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200615 osmo_timer_schedule(&cmd->response_timer, 5, 0);
616 llist_add_tail(&cmd->list, &esme->smpp_cmd_list);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200617
618 return 0;
619}
620
621struct osmo_smpp_cmd *smpp_cmd_find_by_seqnum(struct osmo_esme *esme,
622 uint32_t sequence_nr)
623{
624 struct osmo_smpp_cmd *cmd;
625
626 llist_for_each_entry(cmd, &esme->smpp_cmd_list, list) {
627 if (cmd->sequence_nr == sequence_nr)
628 return cmd;
629 }
630 return NULL;
631}
632
Harald Welte3f786002013-03-13 15:29:27 +0100633static int deliver_to_esme(struct osmo_esme *esme, struct gsm_sms *sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100634 struct gsm_subscriber_connection *conn)
Harald Weltee07b6a72012-11-23 19:02:37 +0100635{
636 struct deliver_sm_t deliver;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200637 int mode, ret;
Harald Weltee07b6a72012-11-23 19:02:37 +0100638 uint8_t dcs;
639
640 memset(&deliver, 0, sizeof(deliver));
641 deliver.command_length = 0;
642 deliver.command_id = DELIVER_SM;
643 deliver.command_status = ESME_ROK;
644
645 strcpy((char *)deliver.service_type, "CMT");
646 if (esme->acl && esme->acl->deliver_src_imsi) {
647 deliver.source_addr_ton = TON_Subscriber_Number;
648 deliver.source_addr_npi = NPI_Land_Mobile_E212;
649 snprintf((char *)deliver.source_addr,
650 sizeof(deliver.source_addr), "%s",
Harald Welte2483f1b2016-06-19 18:06:02 +0200651 conn->vsub->imsi);
Harald Weltee07b6a72012-11-23 19:02:37 +0100652 } else {
653 deliver.source_addr_ton = TON_Network_Specific;
654 deliver.source_addr_npi = NPI_ISDN_E163_E164;
655 snprintf((char *)deliver.source_addr,
656 sizeof(deliver.source_addr), "%s",
Harald Welte2483f1b2016-06-19 18:06:02 +0200657 conn->vsub->msisdn);
Harald Weltee07b6a72012-11-23 19:02:37 +0100658 }
659
Harald Weltec0de14d2012-11-23 23:35:01 +0100660 deliver.dest_addr_ton = sms->dst.ton;
661 deliver.dest_addr_npi = sms->dst.npi;
662 memcpy(deliver.destination_addr, sms->dst.addr,
Harald Weltee07b6a72012-11-23 19:02:37 +0100663 sizeof(deliver.destination_addr));
664
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100665 if (sms->is_report)
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200666 deliver.esm_class = SMPP34_DELIVERY_RECEIPT;
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100667 else
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200668 deliver.esm_class = SMPP34_DATAGRAM_MODE;
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100669
Harald Weltee07b6a72012-11-23 19:02:37 +0100670 if (sms->ud_hdr_ind)
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200671 deliver.esm_class |= SMPP34_UDHI_IND;
Harald Weltee07b6a72012-11-23 19:02:37 +0100672 if (sms->reply_path_req)
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200673 deliver.esm_class |= SMPP34_REPLY_PATH;
Harald Weltee07b6a72012-11-23 19:02:37 +0100674
675 deliver.protocol_id = sms->protocol_id;
676 deliver.priority_flag = 0;
Pablo Neira Ayuso6ceac7c2017-08-07 14:01:15 +0100677 if (sms->status_rep_req)
Pablo Neira Ayuso4f03b472017-08-11 14:36:01 +0200678 deliver.registered_delivery = SMPP34_DELIVERY_RECEIPT_ON;
Harald Weltee07b6a72012-11-23 19:02:37 +0100679
Harald Weltec75ed6d2013-05-28 20:58:02 +0200680 /* Figure out SMPP DCS from TP-DCS */
Harald Weltee07b6a72012-11-23 19:02:37 +0100681 dcs = sms->data_coding_scheme;
Holger Hans Peter Freythera7328a52013-07-13 17:09:56 +0200682 if (smpp_determine_scheme(dcs, &deliver.data_coding, &mode) == -1)
Harald Weltec75ed6d2013-05-28 20:58:02 +0200683 return -1;
Harald Weltec75ed6d2013-05-28 20:58:02 +0200684
685 /* Transparently pass on DCS via SMPP if requested */
Holger Hans Peter Freyther921b2272013-07-14 08:54:07 +0200686 if (esme->acl && esme->acl->dcs_transparent)
Harald Weltec75ed6d2013-05-28 20:58:02 +0200687 deliver.data_coding = dcs;
688
689 if (mode == MODE_7BIT) {
Harald Weltee07b6a72012-11-23 19:02:37 +0100690 uint8_t *dst = deliver.short_message;
Harald Weltee07b6a72012-11-23 19:02:37 +0100691
692 /* SMPP has this strange notion of putting 7bit SMS in
693 * an octet-aligned mode */
Harald Weltee07b6a72012-11-23 19:02:37 +0100694 if (sms->ud_hdr_ind) {
Harald Welteb8a1f962012-11-24 01:37:39 +0100695 /* length (bytes) of UDH inside UD */
696 uint8_t udh_len = sms->user_data[0] + 1;
697
698 /* copy over the UDH */
699 memcpy(dst, sms->user_data, udh_len);
700 dst += udh_len;
701 deliver.sm_length = udh_len;
Harald Weltee07b6a72012-11-23 19:02:37 +0100702 }
Harald Welteb8a1f962012-11-24 01:37:39 +0100703 /* add decoded text */
704 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 +0200705 } else {
Harald Weltee07b6a72012-11-23 19:02:37 +0100706 deliver.sm_length = sms->user_data_len;
707 memcpy(deliver.short_message, sms->user_data, deliver.sm_length);
Harald Weltee07b6a72012-11-23 19:02:37 +0100708 }
709
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200710#if BEFORE_MSCSPLIT
711 /* We currently have no lchan information. Re-add after A-interface, see OS#2390. */
Holger Hans Peter Freyther019851a2015-02-08 09:21:04 +0100712 if (esme->acl && esme->acl->osmocom_ext && conn->lchan)
Harald Welte3f786002013-03-13 15:29:27 +0100713 append_osmo_tlvs(&deliver.tlv, conn->lchan);
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200714#endif
Harald Welte3f786002013-03-13 15:29:27 +0100715
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100716 append_tlv_u16(&deliver.tlv, TLVID_user_message_reference,
717 sms->msg_ref);
718
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200719 ret = smpp_tx_deliver(esme, &deliver);
720 if (ret < 0)
721 return ret;
722
Harald Welte2483f1b2016-06-19 18:06:02 +0200723 return smpp_cmd_enqueue(esme, conn->vsub, sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100724 deliver.sequence_number);
Harald Weltee07b6a72012-11-23 19:02:37 +0100725}
726
Harald Welte338e3b32012-11-20 22:22:04 +0100727static struct smsc *g_smsc;
728
Holger Hans Peter Freyther42cf2e02015-07-06 16:41:30 +0200729int smpp_route_smpp_first(struct gsm_sms *sms, struct gsm_subscriber_connection *conn)
730{
731 return g_smsc->smpp_first;
732}
733
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200734int smpp_try_deliver(struct gsm_sms *sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100735 struct gsm_subscriber_connection *conn)
Harald Weltee07b6a72012-11-23 19:02:37 +0100736{
737 struct osmo_esme *esme;
738 struct osmo_smpp_addr dst;
Benoit Bolseed34ed572017-07-05 11:46:55 +0200739 int rc;
Harald Weltee07b6a72012-11-23 19:02:37 +0100740
741 memset(&dst, 0, sizeof(dst));
Harald Weltec0de14d2012-11-23 23:35:01 +0100742 dst.ton = sms->dst.ton;
743 dst.npi = sms->dst.npi;
744 memcpy(dst.addr, sms->dst.addr, sizeof(dst.addr));
Harald Weltee07b6a72012-11-23 19:02:37 +0100745
Benoit Bolseed34ed572017-07-05 11:46:55 +0200746 rc = smpp_route(g_smsc, &dst, &esme);
747 if (!rc)
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100748 rc = deliver_to_esme(esme, sms, conn);
Harald Weltee07b6a72012-11-23 19:02:37 +0100749
Benoit Bolseed34ed572017-07-05 11:46:55 +0200750 return rc;
Harald Weltee07b6a72012-11-23 19:02:37 +0100751}
752
Harald Welte338e3b32012-11-20 22:22:04 +0100753struct smsc *smsc_from_vty(struct vty *v)
754{
755 /* FIXME: this is ugly */
756 return g_smsc;
757}
758
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100759/*! \brief Allocate the OpenBSC SMPP interface struct and init VTY. */
760int smpp_openbsc_alloc_init(void *ctx)
Harald Weltef1033cc2012-11-08 16:14:37 +0100761{
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100762 g_smsc = smpp_smsc_alloc_init(ctx);
763 if (!g_smsc) {
764 LOGP(DSMPP, LOGL_FATAL, "Cannot allocate smsc struct\n");
765 return -1;
766 }
767 return smpp_vty_init();
768}
769
770/*! \brief Launch the OpenBSC SMPP interface with the parameters set from VTY.
771 */
772int smpp_openbsc_start(struct gsm_network *net)
773{
Harald Weltef1033cc2012-11-08 16:14:37 +0100774 int rc;
Harald Welte76afa162013-03-13 15:05:26 +0100775 g_smsc->priv = net;
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100776
777 /* If a VTY configuration has taken place, the values have been stored
778 * in the smsc struct. Otherwise, use the defaults (NULL -> any, 0 ->
779 * default SMPP port, see smpp_smsc_bind()). */
780 rc = smpp_smsc_start(g_smsc, g_smsc->bind_addr, g_smsc->listen_port);
781 if (rc < 0)
782 return rc;
783
784 rc = osmo_signal_register_handler(SS_SMS, smpp_sms_cb, g_smsc);
785 if (rc < 0)
786 return rc;
787 rc = osmo_signal_register_handler(SS_SUBSCR, smpp_subscr_cb, g_smsc);
788 if (rc < 0)
789 return rc;
790
791 return 0;
Harald Welte76afa162013-03-13 15:05:26 +0100792}
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100793