blob: ec1489820a04b59fc29f234a6633fbfb8729bde1 [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;
Pau Espin Pedrol7e16e722017-08-14 21:18:41 +020097 unsigned int sms_msg_len = 0;
Harald Welte2483f1b2016-06-19 18:06:02 +020098 struct vlr_subscr *dest;
Pablo Neira Ayuso9a3ed852017-08-11 12:02:12 +020099 uint16_t msg_ref = 0;
Harald Weltef1033cc2012-11-08 16:14:37 +0100100 struct gsm_sms *sms;
101 struct tlv_t *t;
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 Ayusod7e14da2017-08-11 13:10:48 +0200161 if (submit->esm_class == SMPP34_DELIVERY_ACK)
Pablo Neira Ayusobd71d322017-08-07 14:01:40 +0100162 sms->is_report = true;
163
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200164 if (submit->esm_class & SMPP34_UDHI_IND)
Harald Weltef1033cc2012-11-08 16:14:37 +0100165 sms->ud_hdr_ind = 1;
166
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200167 if (submit->esm_class & SMPP34_REPLY_PATH) {
Harald Weltef1033cc2012-11-08 16:14:37 +0100168 sms->reply_path_req = 1;
169#warning Implement reply path
170 }
171
Harald Welte9ad03622012-11-08 22:15:04 +0100172 if (submit->data_coding == 0x00 || /* SMSC default */
Harald Welte27d5e652013-05-28 20:37:07 +0200173 submit->data_coding == 0x01) { /* GSM default alphabet */
174 sms->data_coding_scheme = GSM338_DCS_1111_7BIT;
175 mode = MODE_7BIT;
176 } else if ((submit->data_coding & 0xFC) == 0xF0) { /* 03.38 DCS default */
177 /* pass DCS 1:1 through from SMPP to GSM */
178 sms->data_coding_scheme = submit->data_coding;
179 mode = MODE_7BIT;
180 } else if (submit->data_coding == 0x02 ||
181 submit->data_coding == 0x04) {
182 /* 8-bit binary */
183 sms->data_coding_scheme = GSM338_DCS_1111_8BIT_DATA;
184 mode = MODE_8BIT;
185 } else if ((submit->data_coding & 0xFC) == 0xF4) { /* 03.38 DCS 8bit */
186 /* pass DCS 1:1 through from SMPP to GSM */
187 sms->data_coding_scheme = submit->data_coding;
188 mode = MODE_8BIT;
Harald Welte7e40be32014-02-21 13:21:03 +0100189 } else if (submit->data_coding == 0x08) {
Harald Welte27d5e652013-05-28 20:37:07 +0200190 /* UCS-2 */
191 sms->data_coding_scheme = (2 << 2);
192 mode = MODE_8BIT;
193 } else {
194 sms_free(sms);
195 LOGP(DLSMS, LOGL_ERROR, "SMPP Unknown Data Coding 0x%02x\n",
196 submit->data_coding);
197 return ESME_RUNKNOWNERR;
198 }
199
Harald Weltec75ed6d2013-05-28 20:58:02 +0200200 if (mode == MODE_7BIT) {
Harald Welteb8a1f962012-11-24 01:37:39 +0100201 uint8_t ud_len = 0, padbits = 0;
Harald Weltef1033cc2012-11-08 16:14:37 +0100202 sms->data_coding_scheme = GSM338_DCS_1111_7BIT;
Harald Welte9122c132012-11-09 19:43:50 +0100203 if (sms->ud_hdr_ind) {
204 ud_len = *sms_msg + 1;
205 printf("copying %u bytes user data...\n", ud_len);
206 memcpy(sms->user_data, sms_msg,
207 OSMO_MIN(ud_len, sizeof(sms->user_data)));
208 sms_msg += ud_len;
209 sms_msg_len -= ud_len;
Harald Welteb8a1f962012-11-24 01:37:39 +0100210 padbits = 7 - (ud_len % 7);
Harald Welte9122c132012-11-09 19:43:50 +0100211 }
Harald Welteb8a1f962012-11-24 01:37:39 +0100212 gsm_septets2octets(sms->user_data+ud_len, sms_msg,
213 sms_msg_len, padbits);
214 sms->user_data_len = (ud_len*8 + padbits)/7 + sms_msg_len;/* SEPTETS */
215 /* FIXME: sms->text */
Harald Welte27d5e652013-05-28 20:37:07 +0200216 } else {
Harald Weltef1033cc2012-11-08 16:14:37 +0100217 memcpy(sms->user_data, sms_msg, sms_msg_len);
218 sms->user_data_len = sms_msg_len;
Harald Weltef1033cc2012-11-08 16:14:37 +0100219 }
220
221 *psms = sms;
222 return ESME_ROK;
223}
224
Harald Weltee94db492012-11-08 20:11:05 +0100225/*! \brief handle incoming libsmpp34 ssubmit_sm_t from remote ESME */
Harald Weltef1033cc2012-11-08 16:14:37 +0100226int handle_smpp_submit(struct osmo_esme *esme, struct submit_sm_t *submit,
227 struct submit_sm_resp_t *submit_r)
228{
229 struct gsm_sms *sms;
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100230 struct gsm_network *net = esme->smsc->priv;
231 struct sms_signal_data sig;
Harald Weltef1033cc2012-11-08 16:14:37 +0100232 int rc = -1;
233
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100234 rc = submit_to_sms(&sms, net, submit);
Harald Weltef1033cc2012-11-08 16:14:37 +0100235 if (rc != ESME_ROK) {
236 submit_r->command_status = rc;
237 return 0;
238 }
Harald Weltee94db492012-11-08 20:11:05 +0100239 smpp_esme_get(esme);
Harald Welted4bdee72012-11-08 19:44:08 +0100240 sms->smpp.esme = esme;
Harald Welte9ad03622012-11-08 22:15:04 +0100241 sms->protocol_id = submit->protocol_id;
Harald Weltef1033cc2012-11-08 16:14:37 +0100242
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200243 switch (submit->esm_class & SMPP34_MSG_MODE_MASK) {
Harald Weltef1033cc2012-11-08 16:14:37 +0100244 case 0: /* default */
245 case 1: /* datagram */
246 case 3: /* store-and-forward */
247 rc = db_sms_store(sms);
Holger Hans Peter Freyther6a85c152013-01-20 17:21:31 +0100248 sms_free(sms);
249 sms = NULL;
Harald Weltef1033cc2012-11-08 16:14:37 +0100250 if (rc < 0) {
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100251 LOGP(DLSMS, LOGL_ERROR, "SMPP SUBMIT-SM: Unable to "
Harald Weltef1033cc2012-11-08 16:14:37 +0100252 "store SMS in database\n");
Harald Weltef1033cc2012-11-08 16:14:37 +0100253 submit_r->command_status = ESME_RSYSERR;
254 return 0;
255 }
256 strcpy((char *)submit_r->message_id, "msg_id_not_implemented");
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100257 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Stored in DB\n");
Holger Hans Peter Freytherb5a4edd2013-01-20 17:43:50 +0100258
259 memset(&sig, 0, sizeof(sig));
260 osmo_signal_dispatch(SS_SMS, S_SMS_SUBMITTED, &sig);
Harald Weltef1033cc2012-11-08 16:14:37 +0100261 rc = 0;
262 break;
263 case 2: /* forward (i.e. transaction) mode */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100264 LOGP(DLSMS, LOGL_DEBUG, "SMPP SUBMIT-SM: Forwarding in "
Harald Welte9122c132012-11-09 19:43:50 +0100265 "real time (Transaction/Forward mode)\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100266 sms->smpp.transaction_mode = 1;
267 gsm411_send_sms_subscr(sms->receiver, sms);
Harald Weltef1033cc2012-11-08 16:14:37 +0100268 rc = 1; /* don't send any response yet */
269 break;
270 }
271 return rc;
272}
273
Harald Welte2483f1b2016-06-19 18:06:02 +0200274static void alert_all_esme(struct smsc *smsc, struct vlr_subscr *vsub,
Harald Welte045f4022013-07-30 23:45:01 +0800275 uint8_t smpp_avail_status)
276{
277 struct osmo_esme *esme;
278
279 llist_for_each_entry(esme, &smsc->esme_list, list) {
280 /* we currently send an alert notification to each ESME that is
281 * connected, and do not require a (non-existant) delivery
282 * pending flag to be set before, FIXME: make this VTY
283 * configurable */
284 if (esme->acl && esme->acl->deliver_src_imsi) {
285 smpp_tx_alert(esme, TON_Subscriber_Number,
286 NPI_Land_Mobile_E212,
Harald Welte2483f1b2016-06-19 18:06:02 +0200287 vsub->imsi, smpp_avail_status);
Harald Welte045f4022013-07-30 23:45:01 +0800288 } else {
289 smpp_tx_alert(esme, TON_Network_Specific,
290 NPI_ISDN_E163_E164,
Harald Welte2483f1b2016-06-19 18:06:02 +0200291 vsub->msisdn, smpp_avail_status);
Harald Welte045f4022013-07-30 23:45:01 +0800292 }
293 }
294}
295
296
Harald Weltee94db492012-11-08 20:11:05 +0100297/*! \brief signal handler for status of attempted SMS deliveries */
Harald Welted4bdee72012-11-08 19:44:08 +0100298static int smpp_sms_cb(unsigned int subsys, unsigned int signal,
299 void *handler_data, void *signal_data)
300{
Harald Welted4bdee72012-11-08 19:44:08 +0100301 struct sms_signal_data *sig_sms = signal_data;
302 struct gsm_sms *sms = sig_sms->sms;
Harald Welte99e273d2013-07-30 23:39:18 +0800303 struct smsc *smsc = handler_data;
Harald Welted4bdee72012-11-08 19:44:08 +0100304 int rc = 0;
305
306 if (!sms)
307 return 0;
308
309 if (sms->source != SMS_SOURCE_SMPP)
310 return 0;
311
312 switch (signal) {
Harald Welte1aeb2af2013-07-30 22:30:24 +0800313 case S_SMS_MEM_EXCEEDED:
314 /* fall-through: There is no ESME_Rxxx result code to
315 * indicate a MEMORY EXCEEDED in transaction mode back
316 * to the ESME */
Harald Welted4bdee72012-11-08 19:44:08 +0100317 case S_SMS_UNKNOWN_ERROR:
318 if (sms->smpp.transaction_mode) {
319 /* Send back the SUBMIT-SM response with apropriate error */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100320 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Error\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100321 rc = smpp_tx_submit_r(sms->smpp.esme,
322 sms->smpp.sequence_nr,
323 ESME_RDELIVERYFAILURE,
324 sms->smpp.msg_id);
325 }
326 break;
327 case S_SMS_DELIVERED:
328 /* SMS layer tells us the delivery has been completed */
329 if (sms->smpp.transaction_mode) {
330 /* Send back the SUBMIT-SM response */
Harald Welte0d0c9ec2012-11-24 11:13:19 +0100331 LOGP(DLSMS, LOGL_INFO, "SMPP SUBMIT-SM: Success\n");
Harald Welted4bdee72012-11-08 19:44:08 +0100332 rc = smpp_tx_submit_r(sms->smpp.esme,
333 sms->smpp.sequence_nr,
334 ESME_ROK, sms->smpp.msg_id);
335 }
336 break;
Harald Welte99e273d2013-07-30 23:39:18 +0800337 case S_SMS_SMMA:
Harald Welte2483f1b2016-06-19 18:06:02 +0200338 if (!sig_sms->trans || !sig_sms->trans->vsub) {
Harald Welte99e273d2013-07-30 23:39:18 +0800339 /* SMMA without a subscriber? strange... */
340 LOGP(DLSMS, LOGL_NOTICE, "SMMA without subscriber?\n");
341 break;
342 }
343
Harald Welte99e273d2013-07-30 23:39:18 +0800344 /* There's no real 1:1 match for SMMA in SMPP. However,
345 * an ALERT NOTIFICATION seems to be the most logical
346 * choice */
Harald Welte2483f1b2016-06-19 18:06:02 +0200347 alert_all_esme(smsc, sig_sms->trans->vsub, 0);
Harald Welte99e273d2013-07-30 23:39:18 +0800348 break;
Harald Welted4bdee72012-11-08 19:44:08 +0100349 }
350
351 return rc;
352}
353
Harald Welte8a1b0562012-11-09 12:51:44 +0100354/*! \brief signal handler for subscriber related signals */
355static int smpp_subscr_cb(unsigned int subsys, unsigned int signal,
356 void *handler_data, void *signal_data)
357{
Harald Welte2483f1b2016-06-19 18:06:02 +0200358 struct vlr_subscr *vsub = signal_data;
Harald Welte8a1b0562012-11-09 12:51:44 +0100359 struct smsc *smsc = handler_data;
Harald Welte8a1b0562012-11-09 12:51:44 +0100360 uint8_t smpp_avail_status;
361
362 /* determine the smpp_avail_status depending on attach/detach */
363 switch (signal) {
364 case S_SUBSCR_ATTACHED:
365 smpp_avail_status = 0;
366 break;
367 case S_SUBSCR_DETACHED:
368 smpp_avail_status = 2;
369 break;
370 default:
371 return 0;
372 }
373
Harald Welte2483f1b2016-06-19 18:06:02 +0200374 alert_all_esme(smsc, vsub, smpp_avail_status);
Harald Welte8a1b0562012-11-09 12:51:44 +0100375
376 return 0;
377}
378
Harald Welteb8a1f962012-11-24 01:37:39 +0100379/* GSM 03.38 6.2.1 Character expanding (no decode!) */
380static int gsm_7bit_expand(char *text, const uint8_t *user_data, uint8_t septet_l, uint8_t ud_hdr_ind)
381{
382 int i = 0;
383 int shift = 0;
384 uint8_t c;
385
386 /* skip the user data header */
387 if (ud_hdr_ind) {
388 /* get user data header length + 1 (for the 'user data header length'-field) */
389 shift = ((user_data[0] + 1) * 8) / 7;
390 if ((((user_data[0] + 1) * 8) % 7) != 0)
391 shift++;
392 septet_l = septet_l - shift;
393 }
394
395 for (i = 0; i < septet_l; i++) {
396 c =
397 ((user_data[((i + shift) * 7 + 7) >> 3] <<
398 (7 - (((i + shift) * 7 + 7) & 7))) |
399 (user_data[((i + shift) * 7) >> 3] >>
400 (((i + shift) * 7) & 7))) & 0x7f;
401
402 *(text++) = c;
403 }
404
405 *text = '\0';
406
407 return i;
408}
409
410
Harald Welte3f786002013-03-13 15:29:27 +0100411/* FIXME: libsmpp34 helpers, they should be part of libsmpp34! */
412void append_tlv(tlv_t **req_tlv, uint16_t tag,
413 const uint8_t *data, uint16_t len)
414{
415 tlv_t tlv;
416
417 memset(&tlv, 0, sizeof(tlv));
418 tlv.tag = tag;
419 tlv.length = len;
420 memcpy(tlv.value.octet, data, tlv.length);
421 build_tlv(req_tlv, &tlv);
422}
423void append_tlv_u8(tlv_t **req_tlv, uint16_t tag, uint8_t val)
424{
425 tlv_t tlv;
426
427 memset(&tlv, 0, sizeof(tlv));
428 tlv.tag = tag;
429 tlv.length = 1;
430 tlv.value.val08 = val;
431 build_tlv(req_tlv, &tlv);
432}
433void append_tlv_u16(tlv_t **req_tlv, uint16_t tag, uint16_t val)
434{
435 tlv_t tlv;
436
437 memset(&tlv, 0, sizeof(tlv));
438 tlv.tag = tag;
439 tlv.length = 2;
440 tlv.value.val16 = htons(val);
441 build_tlv(req_tlv, &tlv);
442}
443
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200444#if BEFORE_MSCSPLIT
445/* We currently have no lchan information. Re-add after A-interface, see OS#2390. */
Harald Welte3f786002013-03-13 15:29:27 +0100446/* Append the Osmocom vendor-specific additional TLVs to a SMPP msg */
447static void append_osmo_tlvs(tlv_t **req_tlv, const struct gsm_lchan *lchan)
448{
449 int idx = calc_initial_idx(ARRAY_SIZE(lchan->meas_rep),
450 lchan->meas_rep_idx, 1);
451 const struct gsm_meas_rep *mr = &lchan->meas_rep[idx];
452 const struct gsm_meas_rep_unidir *ul_meas = &mr->ul;
453 const struct gsm_meas_rep_unidir *dl_meas = &mr->dl;
454
455 /* Osmocom vendor-specific SMPP34 extensions */
456 append_tlv_u16(req_tlv, TLVID_osmo_arfcn, lchan->ts->trx->arfcn);
457 if (mr->flags & MEAS_REP_F_MS_L1) {
458 uint8_t ms_dbm;
459 append_tlv_u8(req_tlv, TLVID_osmo_ta, mr->ms_l1.ta);
460 ms_dbm = ms_pwr_dbm(lchan->ts->trx->bts->band, mr->ms_l1.pwr);
461 append_tlv_u8(req_tlv, TLVID_osmo_ms_l1_txpwr, ms_dbm);
Max11e4e412017-04-20 13:07:58 +0200462 } else if (mr->flags & MEAS_REP_F_MS_TO) /* Save Timing Offset field = MS Timing Offset + 63 */
463 append_tlv_u8(req_tlv, TLVID_osmo_ta, mr->ms_timing_offset + 63);
Harald Welte3f786002013-03-13 15:29:27 +0100464
465 append_tlv_u16(req_tlv, TLVID_osmo_rxlev_ul,
466 rxlev2dbm(ul_meas->full.rx_lev));
467 append_tlv_u8(req_tlv, TLVID_osmo_rxqual_ul, ul_meas->full.rx_qual);
468
469 if (mr->flags & MEAS_REP_F_DL_VALID) {
470 append_tlv_u16(req_tlv, TLVID_osmo_rxlev_dl,
471 rxlev2dbm(dl_meas->full.rx_lev));
472 append_tlv_u8(req_tlv, TLVID_osmo_rxqual_dl,
473 dl_meas->full.rx_qual);
474 }
475
Harald Welte2483f1b2016-06-19 18:06:02 +0200476 if (lchan->conn && lchan->conn->vsub) {
477 struct vlr_subscr *vsub = lchan->conn->vsub;
478 size_t imei_len = strlen(vsub->imei);
Harald Welte3f786002013-03-13 15:29:27 +0100479 if (imei_len)
480 append_tlv(req_tlv, TLVID_osmo_imei,
Harald Welte2483f1b2016-06-19 18:06:02 +0200481 (uint8_t *)vsub->imei, imei_len+1);
Harald Welte3f786002013-03-13 15:29:27 +0100482 }
483}
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200484#endif
Harald Welte3f786002013-03-13 15:29:27 +0100485
Keith320960c2017-05-13 23:38:52 +0200486struct {
487 uint32_t smpp_status_code;
488 uint8_t gsm411_cause;
489} smpp_to_gsm411_err_array[] = {
490
491 /* Seems like most phones don't care about the failure cause,
492 * although some will display a different notification for
493 * GSM411_RP_CAUSE_MO_NUM_UNASSIGNED
494 * Some provoke a display of "Try again later"
495 * while others a more definitive "Message sending failed"
496 */
497
498 { ESME_RSYSERR, GSM411_RP_CAUSE_MO_DEST_OUT_OF_ORDER },
499 { ESME_RINVDSTADR, GSM411_RP_CAUSE_MO_NUM_UNASSIGNED },
500 { ESME_RMSGQFUL, GSM411_RP_CAUSE_MO_CONGESTION },
501 { ESME_RINVSRCADR, GSM411_RP_CAUSE_MO_SMS_REJECTED },
502 { ESME_RINVMSGID, GSM411_RP_CAUSE_INV_TRANS_REF }
503};
504
505static int smpp_to_gsm411_err(uint32_t smpp_status_code, int *gsm411_cause)
506{
507 int i;
508 for (i = 0; i < ARRAY_SIZE(smpp_to_gsm411_err_array); i++) {
509 if (smpp_to_gsm411_err_array[i].smpp_status_code != smpp_status_code)
510 continue;
511 *gsm411_cause = smpp_to_gsm411_err_array[i].gsm411_cause;
512 return 0;
513 }
514 return -1;
515}
516
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200517static void smpp_cmd_free(struct osmo_smpp_cmd *cmd)
518{
519 osmo_timer_del(&cmd->response_timer);
520 llist_del(&cmd->list);
Harald Welte2483f1b2016-06-19 18:06:02 +0200521 vlr_subscr_put(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200522 talloc_free(cmd);
523}
524
525void smpp_cmd_flush_pending(struct osmo_esme *esme)
526{
527 struct osmo_smpp_cmd *cmd, *next;
528
529 llist_for_each_entry_safe(cmd, next, &esme->smpp_cmd_list, list)
530 smpp_cmd_free(cmd);
531}
532
533void smpp_cmd_ack(struct osmo_smpp_cmd *cmd)
534{
535 struct gsm_subscriber_connection *conn;
536 struct gsm_trans *trans;
537
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100538 if (cmd->is_report)
539 goto out;
540
Harald Welte2483f1b2016-06-19 18:06:02 +0200541 conn = connection_for_subscr(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200542 if (!conn) {
543 LOGP(DSMPP, LOGL_ERROR, "No connection to subscriber anymore\n");
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100544 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200545 }
546
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100547 trans = trans_find_by_id(conn, GSM48_PDISC_SMS, cmd->gsm411_trans_id);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200548 if (!trans) {
549 LOGP(DSMPP, LOGL_ERROR, "GSM transaction %u is gone\n",
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100550 cmd->gsm411_trans_id);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100551 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200552 }
553
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100554 gsm411_send_rp_ack(trans, cmd->gsm411_msg_ref);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100555out:
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200556 smpp_cmd_free(cmd);
557}
558
Keith320960c2017-05-13 23:38:52 +0200559void smpp_cmd_err(struct osmo_smpp_cmd *cmd, uint32_t status)
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200560{
561 struct gsm_subscriber_connection *conn;
562 struct gsm_trans *trans;
Keith320960c2017-05-13 23:38:52 +0200563 int gsm411_cause;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200564
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100565 if (cmd->is_report)
566 goto out;
567
Harald Welte2483f1b2016-06-19 18:06:02 +0200568 conn = connection_for_subscr(cmd->vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200569 if (!conn) {
570 LOGP(DSMPP, LOGL_ERROR, "No connection to subscriber anymore\n");
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100571 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200572 }
573
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100574 trans = trans_find_by_id(conn, GSM48_PDISC_SMS, cmd->gsm411_trans_id);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200575 if (!trans) {
576 LOGP(DSMPP, LOGL_ERROR, "GSM transaction %u is gone\n",
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100577 cmd->gsm411_trans_id);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100578 goto out;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200579 }
580
Keith320960c2017-05-13 23:38:52 +0200581 if (smpp_to_gsm411_err(status, &gsm411_cause) < 0)
582 gsm411_cause = GSM411_RP_CAUSE_MO_NET_OUT_OF_ORDER;
583
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100584 gsm411_send_rp_error(trans, cmd->gsm411_msg_ref, gsm411_cause);
Pablo Neira Ayusof00d8102017-08-07 14:01:01 +0100585out:
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200586 smpp_cmd_free(cmd);
587}
588
589static void smpp_deliver_sm_cb(void *data)
590{
Keith320960c2017-05-13 23:38:52 +0200591 smpp_cmd_err(data, ESME_RSYSERR);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200592}
593
594static int smpp_cmd_enqueue(struct osmo_esme *esme,
Harald Welte2483f1b2016-06-19 18:06:02 +0200595 struct vlr_subscr *vsub, struct gsm_sms *sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100596 uint32_t sequence_number)
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200597{
598 struct osmo_smpp_cmd *cmd;
599
600 cmd = talloc_zero(esme, struct osmo_smpp_cmd);
601 if (!cmd)
602 return -1;
603
604 cmd->sequence_nr = sequence_number;
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100605 cmd->is_report = sms->is_report;
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100606 cmd->gsm411_msg_ref = sms->gsm411.msg_ref;
607 cmd->gsm411_trans_id = sms->gsm411.transaction_id;
Harald Welte2483f1b2016-06-19 18:06:02 +0200608 cmd->vsub = vlr_subscr_get(vsub);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200609
610 /* FIXME: No predefined value for this response_timer as specified by
611 * SMPP 3.4 specs, section 7.2. Make this configurable? Don't forget
612 * lchan keeps busy until we get a reply to this SMPP command. Too high
613 * value may exhaust resources.
614 */
Pablo Neira Ayuso51215762017-05-08 20:57:52 +0200615 osmo_timer_setup(&cmd->response_timer, smpp_deliver_sm_cb, cmd);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200616 osmo_timer_schedule(&cmd->response_timer, 5, 0);
617 llist_add_tail(&cmd->list, &esme->smpp_cmd_list);
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200618
619 return 0;
620}
621
622struct osmo_smpp_cmd *smpp_cmd_find_by_seqnum(struct osmo_esme *esme,
623 uint32_t sequence_nr)
624{
625 struct osmo_smpp_cmd *cmd;
626
627 llist_for_each_entry(cmd, &esme->smpp_cmd_list, list) {
628 if (cmd->sequence_nr == sequence_nr)
629 return cmd;
630 }
631 return NULL;
632}
633
Harald Welte3f786002013-03-13 15:29:27 +0100634static int deliver_to_esme(struct osmo_esme *esme, struct gsm_sms *sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100635 struct gsm_subscriber_connection *conn)
Harald Weltee07b6a72012-11-23 19:02:37 +0100636{
637 struct deliver_sm_t deliver;
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200638 int mode, ret;
Harald Weltee07b6a72012-11-23 19:02:37 +0100639 uint8_t dcs;
640
641 memset(&deliver, 0, sizeof(deliver));
642 deliver.command_length = 0;
643 deliver.command_id = DELIVER_SM;
644 deliver.command_status = ESME_ROK;
645
646 strcpy((char *)deliver.service_type, "CMT");
647 if (esme->acl && esme->acl->deliver_src_imsi) {
648 deliver.source_addr_ton = TON_Subscriber_Number;
649 deliver.source_addr_npi = NPI_Land_Mobile_E212;
650 snprintf((char *)deliver.source_addr,
651 sizeof(deliver.source_addr), "%s",
Harald Welte2483f1b2016-06-19 18:06:02 +0200652 conn->vsub->imsi);
Harald Weltee07b6a72012-11-23 19:02:37 +0100653 } else {
654 deliver.source_addr_ton = TON_Network_Specific;
655 deliver.source_addr_npi = NPI_ISDN_E163_E164;
656 snprintf((char *)deliver.source_addr,
657 sizeof(deliver.source_addr), "%s",
Harald Welte2483f1b2016-06-19 18:06:02 +0200658 conn->vsub->msisdn);
Harald Weltee07b6a72012-11-23 19:02:37 +0100659 }
660
Harald Weltec0de14d2012-11-23 23:35:01 +0100661 deliver.dest_addr_ton = sms->dst.ton;
662 deliver.dest_addr_npi = sms->dst.npi;
663 memcpy(deliver.destination_addr, sms->dst.addr,
Harald Weltee07b6a72012-11-23 19:02:37 +0100664 sizeof(deliver.destination_addr));
665
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100666 if (sms->is_report)
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200667 deliver.esm_class = SMPP34_DELIVERY_RECEIPT;
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100668 else
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200669 deliver.esm_class = SMPP34_DATAGRAM_MODE;
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100670
Harald Weltee07b6a72012-11-23 19:02:37 +0100671 if (sms->ud_hdr_ind)
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200672 deliver.esm_class |= SMPP34_UDHI_IND;
Harald Weltee07b6a72012-11-23 19:02:37 +0100673 if (sms->reply_path_req)
Pablo Neira Ayusod7e14da2017-08-11 13:10:48 +0200674 deliver.esm_class |= SMPP34_REPLY_PATH;
Harald Weltee07b6a72012-11-23 19:02:37 +0100675
676 deliver.protocol_id = sms->protocol_id;
677 deliver.priority_flag = 0;
Pablo Neira Ayuso6ceac7c2017-08-07 14:01:15 +0100678 if (sms->status_rep_req)
Pablo Neira Ayuso4f03b472017-08-11 14:36:01 +0200679 deliver.registered_delivery = SMPP34_DELIVERY_RECEIPT_ON;
Harald Weltee07b6a72012-11-23 19:02:37 +0100680
Harald Weltec75ed6d2013-05-28 20:58:02 +0200681 /* Figure out SMPP DCS from TP-DCS */
Harald Weltee07b6a72012-11-23 19:02:37 +0100682 dcs = sms->data_coding_scheme;
Holger Hans Peter Freythera7328a52013-07-13 17:09:56 +0200683 if (smpp_determine_scheme(dcs, &deliver.data_coding, &mode) == -1)
Harald Weltec75ed6d2013-05-28 20:58:02 +0200684 return -1;
Harald Weltec75ed6d2013-05-28 20:58:02 +0200685
686 /* Transparently pass on DCS via SMPP if requested */
Holger Hans Peter Freyther921b2272013-07-14 08:54:07 +0200687 if (esme->acl && esme->acl->dcs_transparent)
Harald Weltec75ed6d2013-05-28 20:58:02 +0200688 deliver.data_coding = dcs;
689
690 if (mode == MODE_7BIT) {
Harald Weltee07b6a72012-11-23 19:02:37 +0100691 uint8_t *dst = deliver.short_message;
Harald Weltee07b6a72012-11-23 19:02:37 +0100692
693 /* SMPP has this strange notion of putting 7bit SMS in
694 * an octet-aligned mode */
Harald Weltee07b6a72012-11-23 19:02:37 +0100695 if (sms->ud_hdr_ind) {
Harald Welteb8a1f962012-11-24 01:37:39 +0100696 /* length (bytes) of UDH inside UD */
697 uint8_t udh_len = sms->user_data[0] + 1;
698
699 /* copy over the UDH */
700 memcpy(dst, sms->user_data, udh_len);
701 dst += udh_len;
702 deliver.sm_length = udh_len;
Harald Weltee07b6a72012-11-23 19:02:37 +0100703 }
Harald Welteb8a1f962012-11-24 01:37:39 +0100704 /* add decoded text */
705 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 +0200706 } else {
Harald Weltee07b6a72012-11-23 19:02:37 +0100707 deliver.sm_length = sms->user_data_len;
708 memcpy(deliver.short_message, sms->user_data, deliver.sm_length);
Harald Weltee07b6a72012-11-23 19:02:37 +0100709 }
710
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200711#if BEFORE_MSCSPLIT
712 /* We currently have no lchan information. Re-add after A-interface, see OS#2390. */
Holger Hans Peter Freyther019851a2015-02-08 09:21:04 +0100713 if (esme->acl && esme->acl->osmocom_ext && conn->lchan)
Harald Welte3f786002013-03-13 15:29:27 +0100714 append_osmo_tlvs(&deliver.tlv, conn->lchan);
Neels Hofmeyre2f24d52017-05-08 15:12:20 +0200715#endif
Harald Welte3f786002013-03-13 15:29:27 +0100716
Pablo Neira Ayusoadae8592017-08-07 14:01:30 +0100717 append_tlv_u16(&deliver.tlv, TLVID_user_message_reference,
718 sms->msg_ref);
719
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200720 ret = smpp_tx_deliver(esme, &deliver);
721 if (ret < 0)
722 return ret;
723
Harald Welte2483f1b2016-06-19 18:06:02 +0200724 return smpp_cmd_enqueue(esme, conn->vsub, sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100725 deliver.sequence_number);
Harald Weltee07b6a72012-11-23 19:02:37 +0100726}
727
Harald Welte338e3b32012-11-20 22:22:04 +0100728static struct smsc *g_smsc;
729
Holger Hans Peter Freyther42cf2e02015-07-06 16:41:30 +0200730int smpp_route_smpp_first(struct gsm_sms *sms, struct gsm_subscriber_connection *conn)
731{
732 return g_smsc->smpp_first;
733}
734
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200735int smpp_try_deliver(struct gsm_sms *sms,
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100736 struct gsm_subscriber_connection *conn)
Harald Weltee07b6a72012-11-23 19:02:37 +0100737{
738 struct osmo_esme *esme;
739 struct osmo_smpp_addr dst;
Benoit Bolseed34ed572017-07-05 11:46:55 +0200740 int rc;
Harald Weltee07b6a72012-11-23 19:02:37 +0100741
742 memset(&dst, 0, sizeof(dst));
Harald Weltec0de14d2012-11-23 23:35:01 +0100743 dst.ton = sms->dst.ton;
744 dst.npi = sms->dst.npi;
745 memcpy(dst.addr, sms->dst.addr, sizeof(dst.addr));
Harald Weltee07b6a72012-11-23 19:02:37 +0100746
Benoit Bolseed34ed572017-07-05 11:46:55 +0200747 rc = smpp_route(g_smsc, &dst, &esme);
748 if (!rc)
Pablo Neira Ayusofdc99662017-08-07 14:01:10 +0100749 rc = deliver_to_esme(esme, sms, conn);
Harald Weltee07b6a72012-11-23 19:02:37 +0100750
Benoit Bolseed34ed572017-07-05 11:46:55 +0200751 return rc;
Harald Weltee07b6a72012-11-23 19:02:37 +0100752}
753
Harald Welte338e3b32012-11-20 22:22:04 +0100754struct smsc *smsc_from_vty(struct vty *v)
755{
756 /* FIXME: this is ugly */
757 return g_smsc;
758}
759
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100760/*! \brief Allocate the OpenBSC SMPP interface struct and init VTY. */
761int smpp_openbsc_alloc_init(void *ctx)
Harald Weltef1033cc2012-11-08 16:14:37 +0100762{
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100763 g_smsc = smpp_smsc_alloc_init(ctx);
764 if (!g_smsc) {
765 LOGP(DSMPP, LOGL_FATAL, "Cannot allocate smsc struct\n");
766 return -1;
767 }
768 return smpp_vty_init();
769}
770
771/*! \brief Launch the OpenBSC SMPP interface with the parameters set from VTY.
772 */
773int smpp_openbsc_start(struct gsm_network *net)
774{
Harald Weltef1033cc2012-11-08 16:14:37 +0100775 int rc;
Harald Welte76afa162013-03-13 15:05:26 +0100776 g_smsc->priv = net;
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100777
778 /* If a VTY configuration has taken place, the values have been stored
779 * in the smsc struct. Otherwise, use the defaults (NULL -> any, 0 ->
780 * default SMPP port, see smpp_smsc_bind()). */
781 rc = smpp_smsc_start(g_smsc, g_smsc->bind_addr, g_smsc->listen_port);
782 if (rc < 0)
783 return rc;
784
785 rc = osmo_signal_register_handler(SS_SMS, smpp_sms_cb, g_smsc);
786 if (rc < 0)
787 return rc;
788 rc = osmo_signal_register_handler(SS_SUBSCR, smpp_subscr_cb, g_smsc);
789 if (rc < 0)
790 return rc;
791
792 return 0;
Harald Welte76afa162013-03-13 15:05:26 +0100793}
Neels Hofmeyr1b0e5542016-02-24 19:15:39 +0100794