blob: 1ffb0cd87527b009745a31d67d8ad23433b3cf8b [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 Welte2483f1b2016-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 Welte2483f1b2016-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 Welte2483f1b2016-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 Welte2483f1b2016-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 Welte2483f1b2016-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 Welte2483f1b2016-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
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +020076static int smpp34_submit_tlv_msg_payload(const struct tlv_t *t,
77 const struct submit_sm_t *submit,
78 const uint8_t **sms_msg,
79 unsigned int *sms_msg_len)
Harald Weltef1033cc2012-11-08 16:14:37 +010080{
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +020081 if (submit->sm_length) {
82 LOGP(DLSMS, LOGL_ERROR,
83 "SMPP cannot have payload in TLV _and_ in the header\n");
84 return -1;
Harald Weltef1033cc2012-11-08 16:14:37 +010085 }
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +020086 *sms_msg = t->value.octet;
87 *sms_msg_len = t->length;
88
89 return 0;
Harald Weltef1033cc2012-11-08 16:14:37 +010090}
91
Harald Weltee94db492012-11-08 20:11:05 +010092/*! \brief convert from submit_sm_t to gsm_sms */
Harald Weltef1033cc2012-11-08 16:14:37 +010093static int submit_to_sms(struct gsm_sms **psms, struct gsm_network *net,
94 const struct submit_sm_t *submit)
95{
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +020096 const uint8_t *sms_msg = NULL;
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 Weltef1033cc2012-11-08 16:14:37 +0100101 unsigned int sms_msg_len;
Harald Welte27d5e652013-05-28 20:37:07 +0200102 int mode;
Harald Weltef1033cc2012-11-08 16:14:37 +0100103
104 dest = subscr_by_dst(net, submit->dest_addr_npi,
105 submit->dest_addr_ton,
106 (const char *)submit->destination_addr);
107 if (!dest) {
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100108 LOGP(DLSMS, LOGL_NOTICE, "SMPP SUBMIT-SM for unknown subscriber: "
Harald Weltef1033cc2012-11-08 16:14:37 +0100109 "%s (NPI=%u)\n", submit->destination_addr,
110 submit->dest_addr_npi);
111 return ESME_RINVDSTADR;
112 }
113
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +0200114 smpp34_tlv_for_each(t, submit->tlv) {
115 switch (t->tag) {
116 case TLVID_message_payload:
117 if (smpp34_submit_tlv_msg_payload(t, submit, &sms_msg,
118 &sms_msg_len) < 0) {
119 vlr_subscr_put(dest);
120 return ESME_ROPTPARNOTALLWD;
121 }
122 break;
123 case TLVID_user_message_reference:
124 msg_ref = ntohs(t->value.val16);
125 break;
126 default:
127 break;
Harald Weltef1033cc2012-11-08 16:14:37 +0100128 }
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +0200129 }
130
131 if (!sms_msg) {
132 if (submit->sm_length > 0 && submit->sm_length < 255) {
133 sms_msg = submit->short_message;
134 sms_msg_len = submit->sm_length;
135 } else {
136 LOGP(DLSMS, LOGL_ERROR,
137 "SMPP neither message payload nor valid sm_length.\n");
138 vlr_subscr_put(dest);
139 return ESME_RINVPARLEN;
140 }
Harald Weltef1033cc2012-11-08 16:14:37 +0100141 }
142
143 sms = sms_alloc();
Harald Welted4bdee72012-11-08 19:44:08 +0100144 sms->source = SMS_SOURCE_SMPP;
145 sms->smpp.sequence_nr = submit->sequence_number;
Pablo Neira Ayuso791bdf72017-08-07 14:01:18 +0100146 sms->status_rep_req = submit->registered_delivery;
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +0200147 sms->msg_ref = msg_ref;
Harald Weltec0de14d2012-11-23 23:35:01 +0100148
149 /* fill in the destination address */
Harald Welte1a2993a2012-11-09 19:48:48 +0100150 sms->receiver = dest;
Harald Weltec0de14d2012-11-23 23:35:01 +0100151 sms->dst.ton = submit->dest_addr_ton;
152 sms->dst.npi = submit->dest_addr_npi;
Harald Welte2483f1b2016-06-19 18:06:02 +0200153 osmo_strlcpy(sms->dst.addr, dest->msisdn, sizeof(sms->dst.addr));
Harald Weltec0de14d2012-11-23 23:35:01 +0100154
155 /* fill in the source address */
Harald Weltec0de14d2012-11-23 23:35:01 +0100156 sms->src.ton = submit->source_addr_ton;
157 sms->src.npi = submit->source_addr_npi;
Neels Hofmeyr93bafb62017-01-13 03:12:08 +0100158 osmo_strlcpy(sms->src.addr, (char *)submit->source_addr,
159 sizeof(sms->src.addr));
Harald Weltef1033cc2012-11-08 16:14:37 +0100160
Pablo Neira Ayusobd71d322017-08-07 14:01:40 +0100161 /* This is a Delivery Acknowledgment. */
162 if (submit->esm_class == 0x08)
163 sms->is_report = true;
164
Harald Weltef1033cc2012-11-08 16:14:37 +0100165 if (submit->esm_class & 0x40)
166 sms->ud_hdr_ind = 1;
167
168 if (submit->esm_class & 0x80) {
169 sms->reply_path_req = 1;
170#warning Implement reply path
171 }
172
Harald Welte9ad03622012-11-08 22:15:04 +0100173 if (submit->data_coding == 0x00 || /* SMSC default */
Harald Welte27d5e652013-05-28 20:37:07 +0200174 submit->data_coding == 0x01) { /* GSM default alphabet */
175 sms->data_coding_scheme = GSM338_DCS_1111_7BIT;
176 mode = MODE_7BIT;
177 } else if ((submit->data_coding & 0xFC) == 0xF0) { /* 03.38 DCS default */
178 /* pass DCS 1:1 through from SMPP to GSM */
179 sms->data_coding_scheme = submit->data_coding;
180 mode = MODE_7BIT;
181 } else if (submit->data_coding == 0x02 ||
182 submit->data_coding == 0x04) {
183 /* 8-bit binary */
184 sms->data_coding_scheme = GSM338_DCS_1111_8BIT_DATA;
185 mode = MODE_8BIT;
186 } else if ((submit->data_coding & 0xFC) == 0xF4) { /* 03.38 DCS 8bit */
187 /* pass DCS 1:1 through from SMPP to GSM */
188 sms->data_coding_scheme = submit->data_coding;
189 mode = MODE_8BIT;
Harald Welte7e40be32014-02-21 13:21:03 +0100190 } else if (submit->data_coding == 0x08) {
Harald Welte27d5e652013-05-28 20:37:07 +0200191 /* UCS-2 */
192 sms->data_coding_scheme = (2 << 2);
193 mode = MODE_8BIT;
194 } else {
195 sms_free(sms);
196 LOGP(DLSMS, LOGL_ERROR, "SMPP Unknown Data Coding 0x%02x\n",
197 submit->data_coding);
198 return ESME_RUNKNOWNERR;
199 }
200
Harald Weltec75ed6d2013-05-28 20:58:02 +0200201 if (mode == MODE_7BIT) {
Harald Welteb8a1f962012-11-24 01:37:39 +0100202 uint8_t ud_len = 0, padbits = 0;
Harald Weltef1033cc2012-11-08 16:14:37 +0100203 sms->data_coding_scheme = GSM338_DCS_1111_7BIT;
Harald Welte9122c132012-11-09 19:43:50 +0100204 if (sms->ud_hdr_ind) {
205 ud_len = *sms_msg + 1;
206 printf("copying %u bytes user data...\n", ud_len);
207 memcpy(sms->user_data, sms_msg,
208 OSMO_MIN(ud_len, sizeof(sms->user_data)));
209 sms_msg += ud_len;
210 sms_msg_len -= ud_len;
Harald Welteb8a1f962012-11-24 01:37:39 +0100211 padbits = 7 - (ud_len % 7);
Harald Welte9122c132012-11-09 19:43:50 +0100212 }
Harald Welteb8a1f962012-11-24 01:37:39 +0100213 gsm_septets2octets(sms->user_data+ud_len, sms_msg,
214 sms_msg_len, padbits);
215 sms->user_data_len = (ud_len*8 + padbits)/7 + sms_msg_len;/* SEPTETS */
216 /* FIXME: sms->text */
Harald Welte27d5e652013-05-28 20:37:07 +0200217 } else {
Harald Weltef1033cc2012-11-08 16:14:37 +0100218 memcpy(sms->user_data, sms_msg, sms_msg_len);
219 sms->user_data_len = sms_msg_len;
Harald Weltef1033cc2012-11-08 16:14:37 +0100220 }
221
222 *psms = sms;
223 return ESME_ROK;
224}
225
Harald Weltee94db492012-11-08 20:11:05 +0100226/*! \brief handle incoming libsmpp34 ssubmit_sm_t from remote ESME */
Harald Weltef1033cc2012-11-08 16:14:37 +0100227int handle_smpp_submit(struct osmo_esme *esme, struct submit_sm_t *submit,
228 struct submit_sm_resp_t *submit_r)
229{
230 struct gsm_sms *sms;
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100231 struct gsm_network *net = esme->smsc->priv;
232 struct sms_signal_data sig;
Harald Weltef1033cc2012-11-08 16:14:37 +0100233 int rc = -1;
234
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100235 rc = submit_to_sms(&sms, net, submit);
Harald Weltef1033cc2012-11-08 16:14:37 +0100236 if (rc != ESME_ROK) {
237 submit_r->command_status = rc;
238 return 0;
239 }
Harald Weltee94db492012-11-08 20:11:05 +0100240 smpp_esme_get(esme);
Harald Welted4bdee72012-11-08 19:44:08 +0100241 sms->smpp.esme = esme;
Harald Welte9ad03622012-11-08 22:15:04 +0100242 sms->protocol_id = submit->protocol_id;
Harald Weltef1033cc2012-11-08 16:14:37 +0100243
244 switch (submit->esm_class & 3) {
245 case 0: /* default */
246 case 1: /* datagram */
247 case 3: /* store-and-forward */
248 rc = db_sms_store(sms);
Holger Hans Peter Freyther6a85c152013-01-20 17:21:31 +0100249 sms_free(sms);
250 sms = NULL;
Harald Weltef1033cc2012-11-08 16:14:37 +0100251 if (rc < 0) {
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100252 LOGP(DLSMS, LOGL_ERROR, "SMPP SUBMIT-SM: Unable to "
Harald Weltef1033cc2012-11-08 16:14:37 +0100253 "store SMS in database\n");
Harald Weltef1033cc2012-11-08 16:14:37 +0100254 submit_r->command_status = ESME_RSYSERR;
255 return 0;
256 }
257 strcpy((char *)submit_r->message_id, "msg_id_not_implemented");
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100258 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Stored in DB\n");
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100259
260 memset(&sig, 0, sizeof(sig));
261 osmo_signal_dispatch(SS_SMS, S_SMS_SUBMITTED, &sig);
Harald Weltef1033cc2012-11-08 16:14:37 +0100262 rc = 0;
263 break;
264 case 2: /* forward (i.e. transaction) mode */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100265 LOGP(DLSMS, LOGL_DEBUG, "SMPP SUBMIT-SM: Forwarding in "
Harald Welte9122c132012-11-09 19:43:50 +0100266 "real time (Transaction/Forward mode)\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100267 sms->smpp.transaction_mode = 1;
268 gsm411_send_sms_subscr(sms->receiver, sms);
Harald Weltef1033cc2012-11-08 16:14:37 +0100269 rc = 1; /* don't send any response yet */
270 break;
271 }
272 return rc;
273}
274
Harald Welte2483f1b2016-06-19 18:06:02 +0200275static void alert_all_esme(struct smsc *smsc, struct vlr_subscr *vsub,
Harald Welte045f4022013-07-30 23:45:01 +0800276 uint8_t smpp_avail_status)
277{
278 struct osmo_esme *esme;
279
280 llist_for_each_entry(esme, &smsc->esme_list, list) {
281 /* we currently send an alert notification to each ESME that is
282 * connected, and do not require a (non-existant) delivery
283 * pending flag to be set before, FIXME: make this VTY
284 * configurable */
285 if (esme->acl && esme->acl->deliver_src_imsi) {
286 smpp_tx_alert(esme, TON_Subscriber_Number,
287 NPI_Land_Mobile_E212,
Harald Welte2483f1b2016-06-19 18:06:02 +0200288 vsub->imsi, smpp_avail_status);
Harald Welte045f4022013-07-30 23:45:01 +0800289 } else {
290 smpp_tx_alert(esme, TON_Network_Specific,
291 NPI_ISDN_E163_E164,
Harald Welte2483f1b2016-06-19 18:06:02 +0200292 vsub->msisdn, smpp_avail_status);
Harald Welte045f4022013-07-30 23:45:01 +0800293 }
294 }
295}
296
297
Harald Weltee94db492012-11-08 20:11:05 +0100298/*! \brief signal handler for status of attempted SMS deliveries */
Harald Welted4bdee72012-11-08 19:44:08 +0100299static int smpp_sms_cb(unsigned int subsys, unsigned int signal,
300 void *handler_data, void *signal_data)
301{
Harald Welted4bdee72012-11-08 19:44:08 +0100302 struct sms_signal_data *sig_sms = signal_data;
303 struct gsm_sms *sms = sig_sms->sms;
Harald Welte99e273d2013-07-30 23:39:18 +0800304 struct smsc *smsc = handler_data;
Harald Welted4bdee72012-11-08 19:44:08 +0100305 int rc = 0;
306
307 if (!sms)
308 return 0;
309
310 if (sms->source != SMS_SOURCE_SMPP)
311 return 0;
312
313 switch (signal) {
Harald Welte1aeb2af2013-07-30 22:30:24 +0800314 case S_SMS_MEM_EXCEEDED:
315 /* fall-through: There is no ESME_Rxxx result code to
316 * indicate a MEMORY EXCEEDED in transaction mode back
317 * to the ESME */
Harald Welted4bdee72012-11-08 19:44:08 +0100318 case S_SMS_UNKNOWN_ERROR:
319 if (sms->smpp.transaction_mode) {
320 /* Send back the SUBMIT-SM response with apropriate error */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100321 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Error\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100322 rc = smpp_tx_submit_r(sms->smpp.esme,
323 sms->smpp.sequence_nr,
324 ESME_RDELIVERYFAILURE,
325 sms->smpp.msg_id);
326 }
327 break;
328 case S_SMS_DELIVERED:
329 /* SMS layer tells us the delivery has been completed */
330 if (sms->smpp.transaction_mode) {
331 /* Send back the SUBMIT-SM response */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100332 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Success\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100333 rc = smpp_tx_submit_r(sms->smpp.esme,
334 sms->smpp.sequence_nr,
335 ESME_ROK, sms->smpp.msg_id);
336 }
337 break;
Harald Welte99e273d2013-07-30 23:39:18 +0800338 case S_SMS_SMMA:
Harald Welte2483f1b2016-06-19 18:06:02 +0200339 if (!sig_sms->trans || !sig_sms->trans->vsub) {
Harald Welte99e273d2013-07-30 23:39:18 +0800340 /* SMMA without a subscriber? strange... */
341 LOGP(DLSMS, LOGL_NOTICE, "SMMA without subscriber?\n");
342 break;
343 }
344
Harald Welte99e273d2013-07-30 23:39:18 +0800345 /* There's no real 1:1 match for SMMA in SMPP. However,
346 * an ALERT NOTIFICATION seems to be the most logical
347 * choice */
Harald Welte2483f1b2016-06-19 18:06:02 +0200348 alert_all_esme(smsc, sig_sms->trans->vsub, 0);
Harald Welte99e273d2013-07-30 23:39:18 +0800349 break;
Harald Welted4bdee72012-11-08 19:44:08 +0100350 }
351
352 return rc;
353}
354
Harald Welte8a1b0562012-11-09 12:51:44 +0100355/*! \brief signal handler for subscriber related signals */
356static int smpp_subscr_cb(unsigned int subsys, unsigned int signal,
357 void *handler_data, void *signal_data)
358{
Harald Welte2483f1b2016-06-19 18:06:02 +0200359 struct vlr_subscr *vsub = signal_data;
Harald Welte8a1b0562012-11-09 12:51:44 +0100360 struct smsc *smsc = handler_data;
Harald Welte8a1b0562012-11-09 12:51:44 +0100361 uint8_t smpp_avail_status;
362
363 /* determine the smpp_avail_status depending on attach/detach */
364 switch (signal) {
365 case S_SUBSCR_ATTACHED:
366 smpp_avail_status = 0;
367 break;
368 case S_SUBSCR_DETACHED:
369 smpp_avail_status = 2;
370 break;
371 default:
372 return 0;
373 }
374
Harald Welte2483f1b2016-06-19 18:06:02 +0200375 alert_all_esme(smsc, vsub, smpp_avail_status);
Harald Welte8a1b0562012-11-09 12:51:44 +0100376
377 return 0;
378}
379
Harald Welteb8a1f962012-11-24 01:37:39 +0100380/* GSM 03.38 6.2.1 Character expanding (no decode!) */
381static int gsm_7bit_expand(char *text, const uint8_t *user_data, uint8_t septet_l, uint8_t ud_hdr_ind)
382{
383 int i = 0;
384 int shift = 0;
385 uint8_t c;
386
387 /* skip the user data header */
388 if (ud_hdr_ind) {
389 /* get user data header length + 1 (for the 'user data header length'-field) */
390 shift = ((user_data[0] + 1) * 8) / 7;
391 if ((((user_data[0] + 1) * 8) % 7) != 0)
392 shift++;
393 septet_l = septet_l - shift;
394 }
395
396 for (i = 0; i < septet_l; i++) {
397 c =
398 ((user_data[((i + shift) * 7 + 7) >> 3] <<
399 (7 - (((i + shift) * 7 + 7) & 7))) |
400 (user_data[((i + shift) * 7) >> 3] >>
401 (((i + shift) * 7) & 7))) & 0x7f;
402
403 *(text++) = c;
404 }
405
406 *text = '\0';
407
408 return i;
409}
410
411
Harald Welte3f786002013-03-13 15:29:27 +0100412/* FIXME: libsmpp34 helpers, they should be part of libsmpp34! */
413void append_tlv(tlv_t **req_tlv, uint16_t tag,
414 const uint8_t *data, uint16_t len)
415{
416 tlv_t tlv;
417
418 memset(&tlv, 0, sizeof(tlv));
419 tlv.tag = tag;
420 tlv.length = len;
421 memcpy(tlv.value.octet, data, tlv.length);
422 build_tlv(req_tlv, &tlv);
423}
424void append_tlv_u8(tlv_t **req_tlv, uint16_t tag, uint8_t val)
425{
426 tlv_t tlv;
427
428 memset(&tlv, 0, sizeof(tlv));
429 tlv.tag = tag;
430 tlv.length = 1;
431 tlv.value.val08 = val;
432 build_tlv(req_tlv, &tlv);
433}
434void append_tlv_u16(tlv_t **req_tlv, uint16_t tag, uint16_t val)
435{
436 tlv_t tlv;
437
438 memset(&tlv, 0, sizeof(tlv));
439 tlv.tag = tag;
440 tlv.length = 2;
441 tlv.value.val16 = htons(val);
442 build_tlv(req_tlv, &tlv);
443}
444
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200445#if BEFORE_MSCSPLIT
446/* We currently have no lchan information. Re-add after A-interface, see OS#2390. */
Harald Welte3f786002013-03-13 15:29:27 +0100447/* Append the Osmocom vendor-specific additional TLVs to a SMPP msg */
448static void append_osmo_tlvs(tlv_t **req_tlv, const struct gsm_lchan *lchan)
449{
450 int idx = calc_initial_idx(ARRAY_SIZE(lchan->meas_rep),
451 lchan->meas_rep_idx, 1);
452 const struct gsm_meas_rep *mr = &lchan->meas_rep[idx];
453 const struct gsm_meas_rep_unidir *ul_meas = &mr->ul;
454 const struct gsm_meas_rep_unidir *dl_meas = &mr->dl;
455
456 /* Osmocom vendor-specific SMPP34 extensions */
457 append_tlv_u16(req_tlv, TLVID_osmo_arfcn, lchan->ts->trx->arfcn);
458 if (mr->flags & MEAS_REP_F_MS_L1) {
459 uint8_t ms_dbm;
460 append_tlv_u8(req_tlv, TLVID_osmo_ta, mr->ms_l1.ta);
461 ms_dbm = ms_pwr_dbm(lchan->ts->trx->bts->band, mr->ms_l1.pwr);
462 append_tlv_u8(req_tlv, TLVID_osmo_ms_l1_txpwr, ms_dbm);
Max11e4e412017-04-20 13:07:58 +0200463 } else if (mr->flags & MEAS_REP_F_MS_TO) /* Save Timing Offset field = MS Timing Offset + 63 */
464 append_tlv_u8(req_tlv, TLVID_osmo_ta, mr->ms_timing_offset + 63);
Harald Welte3f786002013-03-13 15:29:27 +0100465
466 append_tlv_u16(req_tlv, TLVID_osmo_rxlev_ul,
467 rxlev2dbm(ul_meas->full.rx_lev));
468 append_tlv_u8(req_tlv, TLVID_osmo_rxqual_ul, ul_meas->full.rx_qual);
469
470 if (mr->flags & MEAS_REP_F_DL_VALID) {
471 append_tlv_u16(req_tlv, TLVID_osmo_rxlev_dl,
472 rxlev2dbm(dl_meas->full.rx_lev));
473 append_tlv_u8(req_tlv, TLVID_osmo_rxqual_dl,
474 dl_meas->full.rx_qual);
475 }
476
Harald Welte2483f1b2016-06-19 18:06:02 +0200477 if (lchan->conn && lchan->conn->vsub) {
478 struct vlr_subscr *vsub = lchan->conn->vsub;
479 size_t imei_len = strlen(vsub->imei);
Harald Welte3f786002013-03-13 15:29:27 +0100480 if (imei_len)
481 append_tlv(req_tlv, TLVID_osmo_imei,
Harald Welte2483f1b2016-06-19 18:06:02 +0200482 (uint8_t *)vsub->imei, imei_len+1);
Harald Welte3f786002013-03-13 15:29:27 +0100483 }
484}
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200485#endif
Harald Welte3f786002013-03-13 15:29:27 +0100486
Keith320960c2017-05-13 23:38:52 +0200487struct {
488 uint32_t smpp_status_code;
489 uint8_t gsm411_cause;
490} smpp_to_gsm411_err_array[] = {
491
492 /* Seems like most phones don't care about the failure cause,
493 * although some will display a different notification for
494 * GSM411_RP_CAUSE_MO_NUM_UNASSIGNED
495 * Some provoke a display of "Try again later"
496 * while others a more definitive "Message sending failed"
497 */
498
499 { ESME_RSYSERR, GSM411_RP_CAUSE_MO_DEST_OUT_OF_ORDER },
500 { ESME_RINVDSTADR, GSM411_RP_CAUSE_MO_NUM_UNASSIGNED },
501 { ESME_RMSGQFUL, GSM411_RP_CAUSE_MO_CONGESTION },
502 { ESME_RINVSRCADR, GSM411_RP_CAUSE_MO_SMS_REJECTED },
503 { ESME_RINVMSGID, GSM411_RP_CAUSE_INV_TRANS_REF }
504};
505
506static int smpp_to_gsm411_err(uint32_t smpp_status_code, int *gsm411_cause)
507{
508 int i;
509 for (i = 0; i < ARRAY_SIZE(smpp_to_gsm411_err_array); i++) {
510 if (smpp_to_gsm411_err_array[i].smpp_status_code != smpp_status_code)
511 continue;
512 *gsm411_cause = smpp_to_gsm411_err_array[i].gsm411_cause;
513 return 0;
514 }
515 return -1;
516}
517
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200518static void smpp_cmd_free(struct osmo_smpp_cmd *cmd)
519{
520 osmo_timer_del(&cmd->response_timer);
521 llist_del(&cmd->list);
Harald Welte2483f1b2016-06-19 18:06:02 +0200522 vlr_subscr_put(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200523 talloc_free(cmd);
524}
525
526void smpp_cmd_flush_pending(struct osmo_esme *esme)
527{
528 struct osmo_smpp_cmd *cmd, *next;
529
530 llist_for_each_entry_safe(cmd, next, &esme->smpp_cmd_list, list)
531 smpp_cmd_free(cmd);
532}
533
534void smpp_cmd_ack(struct osmo_smpp_cmd *cmd)
535{
536 struct gsm_subscriber_connection *conn;
537 struct gsm_trans *trans;
538
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100539 if (cmd->is_report)
540 goto out;
541
Harald Welte2483f1b2016-06-19 18:06:02 +0200542 conn = connection_for_subscr(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200543 if (!conn) {
544 LOGP(DSMPP, LOGL_ERROR, "No connection to subscriber anymore\n");
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100545 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200546 }
547
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100548 trans = trans_find_by_id(conn, GSM48_PDISC_SMS, cmd->gsm411_trans_id);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200549 if (!trans) {
550 LOGP(DSMPP, LOGL_ERROR, "GSM transaction %u is gone\n",
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100551 cmd->gsm411_trans_id);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100552 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200553 }
554
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100555 gsm411_send_rp_ack(trans, cmd->gsm411_msg_ref);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100556out:
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200557 smpp_cmd_free(cmd);
558}
559
Keith320960c2017-05-13 23:38:52 +0200560void smpp_cmd_err(struct osmo_smpp_cmd *cmd, uint32_t status)
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200561{
562 struct gsm_subscriber_connection *conn;
563 struct gsm_trans *trans;
Keith320960c2017-05-13 23:38:52 +0200564 int gsm411_cause;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200565
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100566 if (cmd->is_report)
567 goto out;
568
Harald Welte2483f1b2016-06-19 18:06:02 +0200569 conn = connection_for_subscr(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200570 if (!conn) {
571 LOGP(DSMPP, LOGL_ERROR, "No connection to subscriber anymore\n");
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100572 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200573 }
574
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100575 trans = trans_find_by_id(conn, GSM48_PDISC_SMS, cmd->gsm411_trans_id);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200576 if (!trans) {
577 LOGP(DSMPP, LOGL_ERROR, "GSM transaction %u is gone\n",
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100578 cmd->gsm411_trans_id);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100579 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200580 }
581
Keith320960c2017-05-13 23:38:52 +0200582 if (smpp_to_gsm411_err(status, &gsm411_cause) < 0)
583 gsm411_cause = GSM411_RP_CAUSE_MO_NET_OUT_OF_ORDER;
584
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100585 gsm411_send_rp_error(trans, cmd->gsm411_msg_ref, gsm411_cause);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100586out:
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200587 smpp_cmd_free(cmd);
588}
589
590static void smpp_deliver_sm_cb(void *data)
591{
Keith320960c2017-05-13 23:38:52 +0200592 smpp_cmd_err(data, ESME_RSYSERR);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200593}
594
595static int smpp_cmd_enqueue(struct osmo_esme *esme,
Harald Welte2483f1b2016-06-19 18:06:02 +0200596 struct vlr_subscr *vsub, struct gsm_sms *sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100597 uint32_t sequence_number)
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200598{
599 struct osmo_smpp_cmd *cmd;
600
601 cmd = talloc_zero(esme, struct osmo_smpp_cmd);
602 if (!cmd)
603 return -1;
604
605 cmd->sequence_nr = sequence_number;
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100606 cmd->is_report = sms->is_report;
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100607 cmd->gsm411_msg_ref = sms->gsm411.msg_ref;
608 cmd->gsm411_trans_id = sms->gsm411.transaction_id;
Harald Welte2483f1b2016-06-19 18:06:02 +0200609 cmd->vsub = vlr_subscr_get(vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200610
611 /* FIXME: No predefined value for this response_timer as specified by
612 * SMPP 3.4 specs, section 7.2. Make this configurable? Don't forget
613 * lchan keeps busy until we get a reply to this SMPP command. Too high
614 * value may exhaust resources.
615 */
Pablo Neira Ayuso51215762017-05-08 20:57:52 +0200616 osmo_timer_setup(&cmd->response_timer, smpp_deliver_sm_cb, cmd);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200617 osmo_timer_schedule(&cmd->response_timer, 5, 0);
618 llist_add_tail(&cmd->list, &esme->smpp_cmd_list);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200619
620 return 0;
621}
622
623struct osmo_smpp_cmd *smpp_cmd_find_by_seqnum(struct osmo_esme *esme,
624 uint32_t sequence_nr)
625{
626 struct osmo_smpp_cmd *cmd;
627
628 llist_for_each_entry(cmd, &esme->smpp_cmd_list, list) {
629 if (cmd->sequence_nr == sequence_nr)
630 return cmd;
631 }
632 return NULL;
633}
634
Pablo Neira Ayuso6ceac7c2017-08-07 14:01:15 +0100635/* See SMPP 3.4, Section 5.2.17. registered_delivery (1 byte field). */
636#define SMPP34_NO_DELIVERY_RECEIPT 0x0
637#define SMPP34_DELIVERY_RECEIPT_REQ 0x1
638
Harald Welte3f786002013-03-13 15:29:27 +0100639static int deliver_to_esme(struct osmo_esme *esme, struct gsm_sms *sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100640 struct gsm_subscriber_connection *conn)
Harald Weltee07b6a72012-11-23 19:02:37 +0100641{
642 struct deliver_sm_t deliver;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200643 int mode, ret;
Harald Weltee07b6a72012-11-23 19:02:37 +0100644 uint8_t dcs;
645
646 memset(&deliver, 0, sizeof(deliver));
647 deliver.command_length = 0;
648 deliver.command_id = DELIVER_SM;
649 deliver.command_status = ESME_ROK;
650
651 strcpy((char *)deliver.service_type, "CMT");
652 if (esme->acl && esme->acl->deliver_src_imsi) {
653 deliver.source_addr_ton = TON_Subscriber_Number;
654 deliver.source_addr_npi = NPI_Land_Mobile_E212;
655 snprintf((char *)deliver.source_addr,
656 sizeof(deliver.source_addr), "%s",
Harald Welte2483f1b2016-06-19 18:06:02 +0200657 conn->vsub->imsi);
Harald Weltee07b6a72012-11-23 19:02:37 +0100658 } else {
659 deliver.source_addr_ton = TON_Network_Specific;
660 deliver.source_addr_npi = NPI_ISDN_E163_E164;
661 snprintf((char *)deliver.source_addr,
662 sizeof(deliver.source_addr), "%s",
Harald Welte2483f1b2016-06-19 18:06:02 +0200663 conn->vsub->msisdn);
Harald Weltee07b6a72012-11-23 19:02:37 +0100664 }
665
Harald Weltec0de14d2012-11-23 23:35:01 +0100666 deliver.dest_addr_ton = sms->dst.ton;
667 deliver.dest_addr_npi = sms->dst.npi;
668 memcpy(deliver.destination_addr, sms->dst.addr,
Harald Weltee07b6a72012-11-23 19:02:37 +0100669 sizeof(deliver.destination_addr));
670
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100671 /* Short message contains a delivery receipt? Sect. 5.2.12. */
672 if (sms->is_report)
673 deliver.esm_class = 0x04;
674 else
675 deliver.esm_class = 1; /* datagram mode */
676
Harald Weltee07b6a72012-11-23 19:02:37 +0100677 if (sms->ud_hdr_ind)
678 deliver.esm_class |= 0x40;
679 if (sms->reply_path_req)
680 deliver.esm_class |= 0x80;
681
682 deliver.protocol_id = sms->protocol_id;
683 deliver.priority_flag = 0;
Pablo Neira Ayuso6ceac7c2017-08-07 14:01:15 +0100684 if (sms->status_rep_req)
685 deliver.registered_delivery = SMPP34_DELIVERY_RECEIPT_REQ;
686 else
687 deliver.registered_delivery = SMPP34_NO_DELIVERY_RECEIPT;
Harald Weltee07b6a72012-11-23 19:02:37 +0100688
Harald Weltec75ed6d2013-05-28 20:58:02 +0200689 /* Figure out SMPP DCS from TP-DCS */
Harald Weltee07b6a72012-11-23 19:02:37 +0100690 dcs = sms->data_coding_scheme;
Holger Hans Peter Freythera7328a52013-07-13 17:09:56 +0200691 if (smpp_determine_scheme(dcs, &deliver.data_coding, &mode) == -1)
Harald Weltec75ed6d2013-05-28 20:58:02 +0200692 return -1;
Harald Weltec75ed6d2013-05-28 20:58:02 +0200693
694 /* Transparently pass on DCS via SMPP if requested */
Holger Hans Peter Freyther921b2272013-07-14 08:54:07 +0200695 if (esme->acl && esme->acl->dcs_transparent)
Harald Weltec75ed6d2013-05-28 20:58:02 +0200696 deliver.data_coding = dcs;
697
698 if (mode == MODE_7BIT) {
Harald Weltee07b6a72012-11-23 19:02:37 +0100699 uint8_t *dst = deliver.short_message;
Harald Weltee07b6a72012-11-23 19:02:37 +0100700
701 /* SMPP has this strange notion of putting 7bit SMS in
702 * an octet-aligned mode */
Harald Weltee07b6a72012-11-23 19:02:37 +0100703 if (sms->ud_hdr_ind) {
Harald Welteb8a1f962012-11-24 01:37:39 +0100704 /* length (bytes) of UDH inside UD */
705 uint8_t udh_len = sms->user_data[0] + 1;
706
707 /* copy over the UDH */
708 memcpy(dst, sms->user_data, udh_len);
709 dst += udh_len;
710 deliver.sm_length = udh_len;
Harald Weltee07b6a72012-11-23 19:02:37 +0100711 }
Harald Welteb8a1f962012-11-24 01:37:39 +0100712 /* add decoded text */
713 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 +0200714 } else {
Harald Weltee07b6a72012-11-23 19:02:37 +0100715 deliver.sm_length = sms->user_data_len;
716 memcpy(deliver.short_message, sms->user_data, deliver.sm_length);
Harald Weltee07b6a72012-11-23 19:02:37 +0100717 }
718
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200719#if BEFORE_MSCSPLIT
720 /* We currently have no lchan information. Re-add after A-interface, see OS#2390. */
Holger Hans Peter Freyther019851a2015-02-08 09:21:04 +0100721 if (esme->acl && esme->acl->osmocom_ext && conn->lchan)
Harald Welte3f786002013-03-13 15:29:27 +0100722 append_osmo_tlvs(&deliver.tlv, conn->lchan);
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200723#endif
Harald Welte3f786002013-03-13 15:29:27 +0100724
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100725 append_tlv_u16(&deliver.tlv, TLVID_user_message_reference,
726 sms->msg_ref);
727
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200728 ret = smpp_tx_deliver(esme, &deliver);
729 if (ret < 0)
730 return ret;
731
Harald Welte2483f1b2016-06-19 18:06:02 +0200732 return smpp_cmd_enqueue(esme, conn->vsub, sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100733 deliver.sequence_number);
Harald Weltee07b6a72012-11-23 19:02:37 +0100734}
735
Harald Welte338e3b32012-11-20 22:22:04 +0100736static struct smsc *g_smsc;
737
Holger Hans Peter Freyther42cf2e02015-07-06 16:41:30 +0200738int smpp_route_smpp_first(struct gsm_sms *sms, struct gsm_subscriber_connection *conn)
739{
740 return g_smsc->smpp_first;
741}
742
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200743int smpp_try_deliver(struct gsm_sms *sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100744 struct gsm_subscriber_connection *conn)
Harald Weltee07b6a72012-11-23 19:02:37 +0100745{
746 struct osmo_esme *esme;
747 struct osmo_smpp_addr dst;
Benoit Bolseed34ed572017-07-05 11:46:55 +0200748 int rc;
Harald Weltee07b6a72012-11-23 19:02:37 +0100749
750 memset(&dst, 0, sizeof(dst));
Harald Weltec0de14d2012-11-23 23:35:01 +0100751 dst.ton = sms->dst.ton;
752 dst.npi = sms->dst.npi;
753 memcpy(dst.addr, sms->dst.addr, sizeof(dst.addr));
Harald Weltee07b6a72012-11-23 19:02:37 +0100754
Benoit Bolseed34ed572017-07-05 11:46:55 +0200755 rc = smpp_route(g_smsc, &dst, &esme);
756 if (!rc)
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100757 rc = deliver_to_esme(esme, sms, conn);
Harald Weltee07b6a72012-11-23 19:02:37 +0100758
Benoit Bolseed34ed572017-07-05 11:46:55 +0200759 return rc;
Harald Weltee07b6a72012-11-23 19:02:37 +0100760}
761
Harald Welte338e3b32012-11-20 22:22:04 +0100762struct smsc *smsc_from_vty(struct vty *v)
763{
764 /* FIXME: this is ugly */
765 return g_smsc;
766}
767
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100768/*! \brief Allocate the OpenBSC SMPP interface struct and init VTY. */
769int smpp_openbsc_alloc_init(void *ctx)
Harald Weltef1033cc2012-11-08 16:14:37 +0100770{
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100771 g_smsc = smpp_smsc_alloc_init(ctx);
772 if (!g_smsc) {
773 LOGP(DSMPP, LOGL_FATAL, "Cannot allocate smsc struct\n");
774 return -1;
775 }
776 return smpp_vty_init();
777}
778
779/*! \brief Launch the OpenBSC SMPP interface with the parameters set from VTY.
780 */
781int smpp_openbsc_start(struct gsm_network *net)
782{
Harald Weltef1033cc2012-11-08 16:14:37 +0100783 int rc;
Harald Welte76afa162013-03-13 15:05:26 +0100784 g_smsc->priv = net;
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100785
786 /* If a VTY configuration has taken place, the values have been stored
787 * in the smsc struct. Otherwise, use the defaults (NULL -> any, 0 ->
788 * default SMPP port, see smpp_smsc_bind()). */
789 rc = smpp_smsc_start(g_smsc, g_smsc->bind_addr, g_smsc->listen_port);
790 if (rc < 0)
791 return rc;
792
793 rc = osmo_signal_register_handler(SS_SMS, smpp_sms_cb, g_smsc);
794 if (rc < 0)
795 return rc;
796 rc = osmo_signal_register_handler(SS_SUBSCR, smpp_subscr_cb, g_smsc);
797 if (rc < 0)
798 return rc;
799
800 return 0;
Harald Welte76afa162013-03-13 15:05:26 +0100801}
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100802