Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 1 | /* OpenBSC SMPP 3.4 interface, SMSC-side implementation */ |
| 2 | |
| 3 | /* (C) 2012 by Harald Welte <laforge@gnumonks.org> |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License as published by |
| 7 | * the Free Software Foundation; either version 2 of the License, or |
| 8 | * (at your option) any later version. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License |
| 16 | * along with this program; if not, write to the Free Software |
| 17 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 18 | */ |
| 19 | |
| 20 | |
| 21 | #include <stdio.h> |
| 22 | #include <unistd.h> |
| 23 | #include <string.h> |
| 24 | #include <stdint.h> |
| 25 | #include <errno.h> |
| 26 | |
| 27 | #include <smpp34.h> |
| 28 | #include <smpp34_structs.h> |
| 29 | #include <smpp34_params.h> |
| 30 | |
| 31 | #include <osmocom/core/utils.h> |
| 32 | #include <osmocom/core/msgb.h> |
| 33 | #include <osmocom/core/logging.h> |
| 34 | #include <osmocom/core/talloc.h> |
| 35 | #include <osmocom/gsm/protocol/gsm_04_11.h> |
| 36 | |
| 37 | #include <openbsc/gsm_subscriber.h> |
| 38 | #include <openbsc/debug.h> |
| 39 | #include <openbsc/db.h> |
| 40 | #include <openbsc/gsm_04_11.h> |
Harald Welte | d4bdee7 | 2012-11-08 19:44:08 +0100 | [diff] [blame] | 41 | #include <openbsc/gsm_data.h> |
| 42 | #include <openbsc/signal.h> |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 43 | |
| 44 | #include "smpp_smsc.h" |
| 45 | |
Harald Welte | e94db49 | 2012-11-08 20:11:05 +0100 | [diff] [blame] | 46 | /*! \brief find gsm_subscriber for a given SMPP NPI/TON/Address */ |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 47 | static struct gsm_subscriber *subscr_by_dst(struct gsm_network *net, |
| 48 | uint8_t npi, uint8_t ton, const char *addr) |
| 49 | { |
| 50 | struct gsm_subscriber *subscr = NULL; |
| 51 | |
| 52 | switch (npi) { |
| 53 | case NPI_Land_Mobile_E212: |
| 54 | subscr = subscr_get_by_imsi(net, addr); |
| 55 | break; |
| 56 | case NPI_ISDN_E163_E164: |
| 57 | case NPI_Private: |
| 58 | subscr = subscr_get_by_extension(net, addr); |
| 59 | break; |
| 60 | default: |
| 61 | LOGP(DSMPP, LOGL_NOTICE, "Unsupported NPI: %u\n", npi); |
| 62 | break; |
| 63 | } |
| 64 | |
| 65 | return subscr; |
| 66 | } |
| 67 | |
Harald Welte | e94db49 | 2012-11-08 20:11:05 +0100 | [diff] [blame] | 68 | /*! \brief find a TLV with given tag in list of libsmpp34 TLVs */ |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 69 | struct tlv_t *find_tlv(struct tlv_t *head, uint16_t tag) |
| 70 | { |
| 71 | struct tlv_t *t; |
| 72 | |
| 73 | for (t = head; t != NULL; t = t->next) { |
| 74 | if (t->tag == tag) |
| 75 | return t; |
| 76 | } |
| 77 | return NULL; |
| 78 | } |
| 79 | |
Harald Welte | e94db49 | 2012-11-08 20:11:05 +0100 | [diff] [blame] | 80 | /*! \brief convert from submit_sm_t to gsm_sms */ |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 81 | static int submit_to_sms(struct gsm_sms **psms, struct gsm_network *net, |
| 82 | const struct submit_sm_t *submit) |
| 83 | { |
| 84 | struct gsm_subscriber *dest; |
| 85 | struct gsm_sms *sms; |
| 86 | struct tlv_t *t; |
| 87 | const uint8_t *sms_msg; |
| 88 | unsigned int sms_msg_len; |
| 89 | |
| 90 | dest = subscr_by_dst(net, submit->dest_addr_npi, |
| 91 | submit->dest_addr_ton, |
| 92 | (const char *)submit->destination_addr); |
| 93 | if (!dest) { |
| 94 | LOGP(DSMS, LOGL_NOTICE, "SMPP SUBMIT-SM for unknown subscriber: " |
| 95 | "%s (NPI=%u)\n", submit->destination_addr, |
| 96 | submit->dest_addr_npi); |
| 97 | return ESME_RINVDSTADR; |
| 98 | } |
| 99 | |
| 100 | t = find_tlv(submit->tlv, TLVID_message_payload); |
| 101 | if (t) { |
| 102 | if (submit->sm_length) { |
| 103 | /* ERROR: we cannot have botH! */ |
Harald Welte | 9122c13 | 2012-11-09 19:43:50 +0100 | [diff] [blame] | 104 | LOGP(DSMS, LOGL_ERROR, "SMPP Cannot have payload in " |
| 105 | "TLV _and_ in the header\n"); |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 106 | return ESME_ROPTPARNOTALLWD; |
| 107 | } |
| 108 | sms_msg = t->value.octet; |
| 109 | sms_msg_len = t->length; |
| 110 | } else if (submit->short_message && submit->sm_length) { |
| 111 | sms_msg = submit->short_message; |
| 112 | sms_msg_len = submit->sm_length; |
| 113 | } else { |
| 114 | sms_msg = NULL; |
| 115 | sms_msg_len = 0; |
| 116 | } |
| 117 | |
| 118 | sms = sms_alloc(); |
Harald Welte | d4bdee7 | 2012-11-08 19:44:08 +0100 | [diff] [blame] | 119 | sms->source = SMS_SOURCE_SMPP; |
| 120 | sms->smpp.sequence_nr = submit->sequence_number; |
Harald Welte | 1a2993a | 2012-11-09 19:48:48 +0100 | [diff] [blame^] | 121 | sms->receiver = dest; |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 122 | strncpy(sms->dest_addr, dest->extension, sizeof(sms->dest_addr)-1); |
| 123 | sms->sender = subscr_get_by_id(net, 1); |
| 124 | |
| 125 | if (submit->esm_class & 0x40) |
| 126 | sms->ud_hdr_ind = 1; |
| 127 | |
| 128 | if (submit->esm_class & 0x80) { |
| 129 | sms->reply_path_req = 1; |
| 130 | #warning Implement reply path |
| 131 | } |
| 132 | |
Harald Welte | 9ad0362 | 2012-11-08 22:15:04 +0100 | [diff] [blame] | 133 | if (submit->data_coding == 0x00 || /* SMSC default */ |
| 134 | submit->data_coding == 0x01 || /* GSM default alphabet */ |
| 135 | (submit->data_coding & 0xFC) == 0xF0) { /* 03.38 DCS default */ |
Harald Welte | 9122c13 | 2012-11-09 19:43:50 +0100 | [diff] [blame] | 136 | uint8_t ud_len = 0; |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 137 | sms->data_coding_scheme = GSM338_DCS_1111_7BIT; |
Harald Welte | 9122c13 | 2012-11-09 19:43:50 +0100 | [diff] [blame] | 138 | if (sms->ud_hdr_ind) { |
| 139 | ud_len = *sms_msg + 1; |
| 140 | printf("copying %u bytes user data...\n", ud_len); |
| 141 | memcpy(sms->user_data, sms_msg, |
| 142 | OSMO_MIN(ud_len, sizeof(sms->user_data))); |
| 143 | sms_msg += ud_len; |
| 144 | sms_msg_len -= ud_len; |
| 145 | } |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 146 | strncpy(sms->text, (char *)sms_msg, |
| 147 | OSMO_MIN(sizeof(sms->text)-1, sms_msg_len)); |
Harald Welte | 9122c13 | 2012-11-09 19:43:50 +0100 | [diff] [blame] | 148 | printf("encoding 7bit to offset %u text(%s)\n", ud_len, sms->text); |
| 149 | sms->user_data_len = gsm_7bit_encode(sms->user_data+ud_len, sms->text); |
Harald Welte | 9ad0362 | 2012-11-08 22:15:04 +0100 | [diff] [blame] | 150 | } else if (submit->data_coding == 0x02 || |
| 151 | submit->data_coding == 0x04 || |
| 152 | (submit->data_coding & 0xFC) == 0xF4) { /* 03.38 DCS 8bit */ |
| 153 | /* 8-bit binary */ |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 154 | sms->data_coding_scheme = GSM338_DCS_1111_8BIT_DATA; |
| 155 | memcpy(sms->user_data, sms_msg, sms_msg_len); |
| 156 | sms->user_data_len = sms_msg_len; |
Harald Welte | 9ad0362 | 2012-11-08 22:15:04 +0100 | [diff] [blame] | 157 | } else if (submit->data_coding == 0x80) { |
| 158 | /* UCS-2 */ |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 159 | sms->data_coding_scheme = (2 << 2); |
| 160 | memcpy(sms->user_data, sms_msg, submit->sm_length); |
| 161 | sms->user_data_len = sms_msg_len; |
Harald Welte | 9ad0362 | 2012-11-08 22:15:04 +0100 | [diff] [blame] | 162 | } else { |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 163 | sms_free(sms); |
Harald Welte | 9122c13 | 2012-11-09 19:43:50 +0100 | [diff] [blame] | 164 | LOGP(DSMS, LOGL_ERROR, "SMPP Unknown Data Coding 0x%02x\n", |
| 165 | submit->data_coding); |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 166 | return ESME_RUNKNOWNERR; |
| 167 | } |
| 168 | |
| 169 | *psms = sms; |
| 170 | return ESME_ROK; |
| 171 | } |
| 172 | |
Harald Welte | e94db49 | 2012-11-08 20:11:05 +0100 | [diff] [blame] | 173 | /*! \brief handle incoming libsmpp34 ssubmit_sm_t from remote ESME */ |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 174 | int handle_smpp_submit(struct osmo_esme *esme, struct submit_sm_t *submit, |
| 175 | struct submit_sm_resp_t *submit_r) |
| 176 | { |
| 177 | struct gsm_sms *sms; |
| 178 | int rc = -1; |
| 179 | |
| 180 | rc = submit_to_sms(&sms, esme->smsc->priv, submit); |
| 181 | if (rc != ESME_ROK) { |
| 182 | submit_r->command_status = rc; |
| 183 | return 0; |
| 184 | } |
Harald Welte | e94db49 | 2012-11-08 20:11:05 +0100 | [diff] [blame] | 185 | smpp_esme_get(esme); |
Harald Welte | d4bdee7 | 2012-11-08 19:44:08 +0100 | [diff] [blame] | 186 | sms->smpp.esme = esme; |
Harald Welte | 9ad0362 | 2012-11-08 22:15:04 +0100 | [diff] [blame] | 187 | sms->protocol_id = submit->protocol_id; |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 188 | |
| 189 | switch (submit->esm_class & 3) { |
| 190 | case 0: /* default */ |
| 191 | case 1: /* datagram */ |
| 192 | case 3: /* store-and-forward */ |
| 193 | rc = db_sms_store(sms); |
| 194 | if (rc < 0) { |
| 195 | LOGP(DSMS, LOGL_ERROR, "SMPP SUBMIT-SM: Unable to " |
| 196 | "store SMS in database\n"); |
| 197 | sms_free(sms); |
| 198 | submit_r->command_status = ESME_RSYSERR; |
| 199 | return 0; |
| 200 | } |
| 201 | strcpy((char *)submit_r->message_id, "msg_id_not_implemented"); |
| 202 | LOGP(DSMS, LOGL_INFO, "SMPP SUBMIT-SM: Stored in DB\n"); |
| 203 | rc = 0; |
| 204 | break; |
| 205 | case 2: /* forward (i.e. transaction) mode */ |
Harald Welte | 9122c13 | 2012-11-09 19:43:50 +0100 | [diff] [blame] | 206 | LOGP(DSMS, LOGL_DEBUG, "SMPP SUBMIT-SM: Forwarding in " |
| 207 | "real time (Transaction/Forward mode)\n"); |
Harald Welte | d4bdee7 | 2012-11-08 19:44:08 +0100 | [diff] [blame] | 208 | sms->smpp.transaction_mode = 1; |
| 209 | gsm411_send_sms_subscr(sms->receiver, sms); |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 210 | rc = 1; /* don't send any response yet */ |
| 211 | break; |
| 212 | } |
| 213 | return rc; |
| 214 | } |
| 215 | |
Harald Welte | e94db49 | 2012-11-08 20:11:05 +0100 | [diff] [blame] | 216 | /*! \brief signal handler for status of attempted SMS deliveries */ |
Harald Welte | d4bdee7 | 2012-11-08 19:44:08 +0100 | [diff] [blame] | 217 | static int smpp_sms_cb(unsigned int subsys, unsigned int signal, |
| 218 | void *handler_data, void *signal_data) |
| 219 | { |
| 220 | struct gsm_network *network = handler_data; |
| 221 | struct sms_signal_data *sig_sms = signal_data; |
| 222 | struct gsm_sms *sms = sig_sms->sms; |
| 223 | int rc = 0; |
| 224 | |
| 225 | if (!sms) |
| 226 | return 0; |
| 227 | |
| 228 | if (sms->source != SMS_SOURCE_SMPP) |
| 229 | return 0; |
| 230 | |
| 231 | switch (signal) { |
| 232 | case S_SMS_UNKNOWN_ERROR: |
| 233 | if (sms->smpp.transaction_mode) { |
| 234 | /* Send back the SUBMIT-SM response with apropriate error */ |
| 235 | LOGP(DSMS, LOGL_INFO, "SMPP SUBMIT-SM: Error\n"); |
| 236 | rc = smpp_tx_submit_r(sms->smpp.esme, |
| 237 | sms->smpp.sequence_nr, |
| 238 | ESME_RDELIVERYFAILURE, |
| 239 | sms->smpp.msg_id); |
| 240 | } |
| 241 | break; |
| 242 | case S_SMS_DELIVERED: |
| 243 | /* SMS layer tells us the delivery has been completed */ |
| 244 | if (sms->smpp.transaction_mode) { |
| 245 | /* Send back the SUBMIT-SM response */ |
| 246 | LOGP(DSMS, LOGL_INFO, "SMPP SUBMIT-SM: Success\n"); |
| 247 | rc = smpp_tx_submit_r(sms->smpp.esme, |
| 248 | sms->smpp.sequence_nr, |
| 249 | ESME_ROK, sms->smpp.msg_id); |
| 250 | } |
| 251 | break; |
| 252 | } |
| 253 | |
| 254 | return rc; |
| 255 | } |
| 256 | |
Harald Welte | 8a1b056 | 2012-11-09 12:51:44 +0100 | [diff] [blame] | 257 | /*! \brief signal handler for subscriber related signals */ |
| 258 | static int smpp_subscr_cb(unsigned int subsys, unsigned int signal, |
| 259 | void *handler_data, void *signal_data) |
| 260 | { |
| 261 | struct gsm_subscriber *subscr = signal_data; |
| 262 | struct smsc *smsc = handler_data; |
| 263 | struct osmo_esme *esme; |
| 264 | uint8_t smpp_avail_status; |
| 265 | |
| 266 | /* determine the smpp_avail_status depending on attach/detach */ |
| 267 | switch (signal) { |
| 268 | case S_SUBSCR_ATTACHED: |
| 269 | smpp_avail_status = 0; |
| 270 | break; |
| 271 | case S_SUBSCR_DETACHED: |
| 272 | smpp_avail_status = 2; |
| 273 | break; |
| 274 | default: |
| 275 | return 0; |
| 276 | } |
| 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 | smpp_tx_alert(esme, TON_Subscriber_Number, |
| 284 | NPI_Land_Mobile_E212, subscr->imsi, |
| 285 | smpp_avail_status); |
| 286 | } |
| 287 | |
| 288 | return 0; |
| 289 | } |
| 290 | |
Harald Welte | e94db49 | 2012-11-08 20:11:05 +0100 | [diff] [blame] | 291 | /*! \brief Initialize the OpenBSC SMPP interface */ |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 292 | int smpp_openbsc_init(struct gsm_network *net, uint16_t port) |
| 293 | { |
| 294 | struct smsc *smsc = talloc_zero(net, struct smsc); |
| 295 | int rc; |
| 296 | |
| 297 | smsc->priv = net; |
| 298 | |
| 299 | rc = smpp_smsc_init(smsc, port); |
| 300 | if (rc < 0) |
| 301 | talloc_free(smsc); |
| 302 | |
Harald Welte | d4bdee7 | 2012-11-08 19:44:08 +0100 | [diff] [blame] | 303 | osmo_signal_register_handler(SS_SMS, smpp_sms_cb, net); |
Harald Welte | 8a1b056 | 2012-11-09 12:51:44 +0100 | [diff] [blame] | 304 | osmo_signal_register_handler(SS_SUBSCR, smpp_subscr_cb, smsc); |
Harald Welte | d4bdee7 | 2012-11-08 19:44:08 +0100 | [diff] [blame] | 305 | |
Harald Welte | f1033cc | 2012-11-08 16:14:37 +0100 | [diff] [blame] | 306 | return rc; |
| 307 | } |