Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 1 | /* Point-to-Point (PP) Short Message Service (SMS) |
| 2 | * Support on Mobile Radio Interface |
| 3 | * 3GPP TS 04.11 version 7.1.0 Release 1998 / ETSI TS 100 942 V7.1.0 */ |
| 4 | |
| 5 | /* (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de> |
| 6 | * (C) 2009 by Harald Welte <laforge@gnumonks.org> |
Holger Hans Peter Freyther | 4d7e49b | 2013-05-02 22:37:16 +0200 | [diff] [blame] | 7 | * (C) 2010-2013 by Holger Hans Peter Freyther <zecke@selfish.org> |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 8 | * (C) 2010 by On-Waves |
| 9 | * (C) 2011 by Andreas Eversberg <jolly@eversberg.eu> |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 10 | * (C) 2014 by Alexander Chemeris <Alexander.Chemeris@fairwaves.co> |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 11 | * |
| 12 | * All Rights Reserved |
| 13 | * |
| 14 | * This program is free software; you can redistribute it and/or modify |
| 15 | * it under the terms of the GNU Affero General Public License as published by |
| 16 | * the Free Software Foundation; either version 3 of the License, or |
| 17 | * (at your option) any later version. |
| 18 | * |
| 19 | * This program is distributed in the hope that it will be useful, |
| 20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 22 | * GNU Affero General Public License for more details. |
| 23 | * |
| 24 | * You should have received a copy of the GNU Affero General Public License |
| 25 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 26 | * |
| 27 | */ |
| 28 | |
Harald Welte | 7c8e2cc | 2012-08-29 16:47:30 +0200 | [diff] [blame] | 29 | #include "../../config.h" |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 30 | |
| 31 | #include <time.h> |
| 32 | #include <string.h> |
| 33 | #include <osmocom/core/msgb.h> |
| 34 | #include <osmocom/core/logging.h> |
| 35 | |
| 36 | #include <osmocom/gsm/gsm48.h> |
Holger Hans Peter Freyther | 4d7e49b | 2013-05-02 22:37:16 +0200 | [diff] [blame] | 37 | #include <osmocom/gsm/gsm_utils.h> |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 38 | #include <osmocom/gsm/gsm0411_utils.h> |
Holger Hans Peter Freyther | 4d7e49b | 2013-05-02 22:37:16 +0200 | [diff] [blame] | 39 | #include <osmocom/gsm/protocol/gsm_03_40.h> |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 40 | #include <osmocom/gsm/protocol/gsm_04_11.h> |
| 41 | |
| 42 | #define GSM411_ALLOC_SIZE 1024 |
| 43 | #define GSM411_ALLOC_HEADROOM 128 |
| 44 | |
| 45 | struct msgb *gsm411_msgb_alloc(void) |
| 46 | { |
| 47 | return msgb_alloc_headroom(GSM411_ALLOC_SIZE, GSM411_ALLOC_HEADROOM, |
| 48 | "GSM 04.11"); |
| 49 | } |
| 50 | |
| 51 | /* Turn int into semi-octet representation: 98 => 0x89 */ |
Harald Welte | ad633b0 | 2011-12-01 21:08:19 +0100 | [diff] [blame] | 52 | uint8_t gsm411_bcdify(uint8_t value) |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 53 | { |
| 54 | uint8_t ret; |
| 55 | |
| 56 | ret = value / 10; |
| 57 | ret |= (value % 10) << 4; |
| 58 | |
| 59 | return ret; |
| 60 | } |
| 61 | |
| 62 | /* Turn semi-octet representation into int: 0x89 => 98 */ |
Harald Welte | ad633b0 | 2011-12-01 21:08:19 +0100 | [diff] [blame] | 63 | uint8_t gsm411_unbcdify(uint8_t value) |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 64 | { |
| 65 | uint8_t ret; |
| 66 | |
| 67 | if ((value & 0x0F) > 9 || (value >> 4) > 9) |
| 68 | LOGP(DLSMS, LOGL_ERROR, |
Harald Welte | ad633b0 | 2011-12-01 21:08:19 +0100 | [diff] [blame] | 69 | "gsm411_unbcdify got too big nibble: 0x%02X\n", value); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 70 | |
| 71 | ret = (value&0x0F)*10; |
| 72 | ret += value>>4; |
| 73 | |
| 74 | return ret; |
| 75 | } |
| 76 | |
| 77 | /* Generate 03.40 TP-SCTS */ |
| 78 | void gsm340_gen_scts(uint8_t *scts, time_t time) |
| 79 | { |
| 80 | struct tm *tm = gmtime(&time); |
| 81 | |
Harald Welte | ad633b0 | 2011-12-01 21:08:19 +0100 | [diff] [blame] | 82 | *scts++ = gsm411_bcdify(tm->tm_year % 100); |
| 83 | *scts++ = gsm411_bcdify(tm->tm_mon + 1); |
| 84 | *scts++ = gsm411_bcdify(tm->tm_mday); |
| 85 | *scts++ = gsm411_bcdify(tm->tm_hour); |
| 86 | *scts++ = gsm411_bcdify(tm->tm_min); |
| 87 | *scts++ = gsm411_bcdify(tm->tm_sec); |
Harald Welte | 7c8e2cc | 2012-08-29 16:47:30 +0200 | [diff] [blame] | 88 | #ifdef HAVE_TM_GMTOFF_IN_TM |
Alexander Chemeris | 7fb5e2d | 2014-03-07 21:02:46 +0100 | [diff] [blame^] | 89 | if (tm->tm_gmtoff >= 0) |
| 90 | *scts++ = gsm411_bcdify(tm->tm_gmtoff/(60*15)); |
| 91 | else |
| 92 | *scts++ = gsm411_bcdify(-tm->tm_gmtoff/(60*15)) | 0x80; |
Harald Welte | 7c8e2cc | 2012-08-29 16:47:30 +0200 | [diff] [blame] | 93 | #else |
| 94 | #warning find a portable way to obtain timezone offset |
| 95 | *scts++ = 0; |
| 96 | #endif |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 97 | } |
| 98 | |
| 99 | /* Decode 03.40 TP-SCTS (into utc/gmt timestamp) */ |
| 100 | time_t gsm340_scts(uint8_t *scts) |
| 101 | { |
| 102 | struct tm tm; |
Harald Welte | ad633b0 | 2011-12-01 21:08:19 +0100 | [diff] [blame] | 103 | uint8_t yr = gsm411_unbcdify(*scts++); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 104 | int ofs; |
| 105 | |
| 106 | memset(&tm, 0x00, sizeof(struct tm)); |
| 107 | |
| 108 | if (yr <= 80) |
| 109 | tm.tm_year = 100 + yr; |
| 110 | else |
| 111 | tm.tm_year = yr; |
Harald Welte | ad633b0 | 2011-12-01 21:08:19 +0100 | [diff] [blame] | 112 | tm.tm_mon = gsm411_unbcdify(*scts++) - 1; |
| 113 | tm.tm_mday = gsm411_unbcdify(*scts++); |
| 114 | tm.tm_hour = gsm411_unbcdify(*scts++); |
| 115 | tm.tm_min = gsm411_unbcdify(*scts++); |
| 116 | tm.tm_sec = gsm411_unbcdify(*scts++); |
Harald Welte | 7c8e2cc | 2012-08-29 16:47:30 +0200 | [diff] [blame] | 117 | #ifdef HAVE_TM_GMTOFF_IN_TM |
| 118 | tm.tm_gmtoff = gsm411_unbcdify(*scts++) * 15*60; |
| 119 | #endif |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 120 | |
| 121 | /* according to gsm 03.40 time zone is |
| 122 | "expressed in quarters of an hour" */ |
Harald Welte | ad633b0 | 2011-12-01 21:08:19 +0100 | [diff] [blame] | 123 | ofs = gsm411_unbcdify(*scts++) * 15*60; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 124 | |
| 125 | return mktime(&tm) - ofs; |
| 126 | } |
| 127 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 128 | /* Decode validity period format 'relative'. |
| 129 | * Returns number of seconds relative to a current time. */ |
| 130 | static time_t gsm340_vp_relative(uint8_t *sms_vp) |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 131 | { |
| 132 | /* Chapter 9.2.3.12.1 */ |
| 133 | uint8_t vp; |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 134 | time_t minutes; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 135 | |
| 136 | vp = *(sms_vp); |
| 137 | if (vp <= 143) |
Alexander Chemeris | 36d0fee | 2014-03-07 21:00:19 +0100 | [diff] [blame] | 138 | minutes = (vp + 1) * 5; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 139 | else if (vp <= 167) |
| 140 | minutes = 12*60 + (vp-143) * 30; |
| 141 | else if (vp <= 196) |
Alexander Chemeris | 36d0fee | 2014-03-07 21:00:19 +0100 | [diff] [blame] | 142 | minutes = (vp-166) * 60 * 24; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 143 | else |
Alexander Chemeris | 36d0fee | 2014-03-07 21:00:19 +0100 | [diff] [blame] | 144 | minutes = (vp-192) * 60 * 24 * 7; |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 145 | |
| 146 | /* Convert to seconds */ |
| 147 | return minutes * 60; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 148 | } |
| 149 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 150 | /* Decode validity period format 'absolute'. |
| 151 | * Returns UNIX time. */ |
| 152 | static time_t gsm340_vp_absolute(uint8_t *sms_vp) |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 153 | { |
| 154 | /* Chapter 9.2.3.12.2 */ |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 155 | return gsm340_scts(sms_vp); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 156 | } |
| 157 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 158 | /* Decode validity period format 'relative in integer representation'. |
| 159 | * Returns number of seconds relative to a current time. */ |
| 160 | static time_t gsm340_vp_relative_integer(uint8_t *sms_vp) |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 161 | { |
| 162 | uint8_t vp; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 163 | vp = *(sms_vp); |
| 164 | if (vp == 0) { |
| 165 | LOGP(DLSMS, LOGL_ERROR, |
| 166 | "reserved relative_integer validity period\n"); |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 167 | #warning We should return an RP-Error here. |
| 168 | return SMS_DEFAULT_VALIDITY_PERIOD; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 169 | } |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 170 | return vp; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 171 | } |
| 172 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 173 | /* Decode validity period format 'relative in semi-octet representation'. |
| 174 | * Returns number of seconds relative to a current time. */ |
| 175 | static time_t gsm340_vp_relative_semioctet(uint8_t *sms_vp) |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 176 | { |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 177 | time_t hours, minutes, seconds; |
| 178 | hours = gsm411_unbcdify(*sms_vp++); /* hours */ |
| 179 | minutes = gsm411_unbcdify(*sms_vp++); /* minutes */ |
| 180 | seconds = gsm411_unbcdify(*sms_vp++); /* seconds */ |
| 181 | return hours*60*60 + minutes*60 + seconds; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 182 | } |
| 183 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 184 | /* Decode validity period. Returns absolute UNIX time. */ |
| 185 | time_t gsm340_validity_time(time_t now, uint8_t sms_vpf, uint8_t *sms_vp) |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 186 | { |
| 187 | uint8_t fi; /* functionality indicator */ |
| 188 | |
| 189 | switch (sms_vpf) { |
| 190 | case GSM340_TP_VPF_RELATIVE: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 191 | return now + gsm340_vp_relative(sms_vp); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 192 | case GSM340_TP_VPF_ABSOLUTE: |
| 193 | return gsm340_vp_absolute(sms_vp); |
| 194 | case GSM340_TP_VPF_ENHANCED: |
| 195 | /* Chapter 9.2.3.12.3 */ |
| 196 | fi = *sms_vp++; |
| 197 | /* ignore additional fi */ |
| 198 | if (fi & (1<<7)) sms_vp++; |
| 199 | /* read validity period format */ |
| 200 | switch (fi & 0x7) { |
| 201 | case 0x0: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 202 | return now + SMS_DEFAULT_VALIDITY_PERIOD; /* no vpf specified */ |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 203 | case 0x1: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 204 | return now + gsm340_vp_relative(sms_vp); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 205 | case 0x2: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 206 | return now + gsm340_vp_relative_integer(sms_vp); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 207 | case 0x3: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 208 | return now + gsm340_vp_relative_semioctet(sms_vp); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 209 | default: |
| 210 | /* The GSM spec says that the SC should reject any |
| 211 | unsupported and/or undefined values. FIXME */ |
| 212 | LOGP(DLSMS, LOGL_ERROR, |
| 213 | "Reserved enhanced validity period format\n"); |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 214 | return now + SMS_DEFAULT_VALIDITY_PERIOD; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 215 | } |
| 216 | case GSM340_TP_VPF_NONE: |
| 217 | default: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 218 | return now + SMS_DEFAULT_VALIDITY_PERIOD; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 219 | } |
| 220 | } |
| 221 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 222 | /* Decode validity period. return relative minutes. |
| 223 | * This behaviour is broken, but we're mimicing to it for compatibility. */ |
| 224 | unsigned long gsm340_validity_period(uint8_t sms_vpf, uint8_t *sms_vp) |
| 225 | { |
| 226 | time_t now = time(NULL); |
| 227 | return (gsm340_validity_time(now, sms_vpf, sms_vp) - now) / 60; |
| 228 | } |
| 229 | |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 230 | /* determine coding alphabet dependent on GSM 03.38 Section 4 DCS */ |
| 231 | enum sms_alphabet gsm338_get_sms_alphabet(uint8_t dcs) |
| 232 | { |
| 233 | uint8_t cgbits = dcs >> 4; |
| 234 | enum sms_alphabet alpha = DCS_NONE; |
| 235 | |
| 236 | if ((cgbits & 0xc) == 0) { |
| 237 | if (cgbits & 2) { |
| 238 | LOGP(DLSMS, LOGL_NOTICE, |
| 239 | "Compressed SMS not supported yet\n"); |
| 240 | return 0xffffffff; |
| 241 | } |
| 242 | |
| 243 | switch ((dcs >> 2)&0x03) { |
| 244 | case 0: |
| 245 | alpha = DCS_7BIT_DEFAULT; |
| 246 | break; |
| 247 | case 1: |
| 248 | alpha = DCS_8BIT_DATA; |
| 249 | break; |
| 250 | case 2: |
| 251 | alpha = DCS_UCS2; |
| 252 | break; |
| 253 | } |
| 254 | } else if (cgbits == 0xc || cgbits == 0xd) |
| 255 | alpha = DCS_7BIT_DEFAULT; |
| 256 | else if (cgbits == 0xe) |
| 257 | alpha = DCS_UCS2; |
| 258 | else if (cgbits == 0xf) { |
| 259 | if (dcs & 4) |
| 260 | alpha = DCS_8BIT_DATA; |
| 261 | else |
| 262 | alpha = DCS_7BIT_DEFAULT; |
| 263 | } |
| 264 | |
| 265 | return alpha; |
| 266 | } |
| 267 | |
| 268 | /* generate a TPDU address field compliant with 03.40 sec. 9.1.2.5 */ |
| 269 | int gsm340_gen_oa(uint8_t *oa, unsigned int oa_len, uint8_t type, |
| 270 | uint8_t plan, const char *number) |
| 271 | { |
| 272 | int len_in_bytes; |
| 273 | |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 274 | oa[1] = 0x80 | (type << 4) | plan; |
| 275 | |
Holger Hans Peter Freyther | 4d7e49b | 2013-05-02 22:37:16 +0200 | [diff] [blame] | 276 | if (type == GSM340_TYPE_ALPHA_NUMERIC) { |
| 277 | /* |
| 278 | * TODO/FIXME: what is the 'useful semi-octets' excluding any |
| 279 | * semi octet containing only fill bits. |
| 280 | * The current code picks the number of bytes written by the |
| 281 | * 7bit encoding routines and multiplies it by two. |
| 282 | */ |
| 283 | gsm_7bit_encode_n(&oa[2], oa_len - 2, number, &len_in_bytes); |
| 284 | oa[0] = len_in_bytes * 2; |
| 285 | len_in_bytes += 2; |
| 286 | } else { |
| 287 | /* prevent buffer overflows */ |
| 288 | if (strlen(number) > 20) |
| 289 | number = ""; |
| 290 | len_in_bytes = gsm48_encode_bcd_number(oa, oa_len, 1, number); |
| 291 | /* GSM 03.40 tells us the length is in 'useful semi-octets' */ |
| 292 | oa[0] = strlen(number) & 0xff; |
| 293 | } |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 294 | |
| 295 | return len_in_bytes; |
| 296 | } |
| 297 | |
| 298 | /* Prefix msg with a RP header */ |
| 299 | int gsm411_push_rp_header(struct msgb *msg, uint8_t rp_msg_type, |
| 300 | uint8_t rp_msg_ref) |
| 301 | { |
| 302 | struct gsm411_rp_hdr *rp; |
| 303 | uint8_t len = msg->len; |
| 304 | |
| 305 | /* GSM 04.11 RP-DATA header */ |
| 306 | rp = (struct gsm411_rp_hdr *)msgb_push(msg, sizeof(*rp)); |
| 307 | rp->len = len + 2; |
| 308 | rp->msg_type = rp_msg_type; |
| 309 | rp->msg_ref = rp_msg_ref; /* FIXME: Choose randomly */ |
| 310 | |
| 311 | return 0; |
| 312 | } |
| 313 | |
| 314 | /* Prefix msg with a 04.08/04.11 CP header */ |
| 315 | int gsm411_push_cp_header(struct msgb *msg, uint8_t proto, uint8_t trans, |
| 316 | uint8_t msg_type) |
| 317 | { |
| 318 | struct gsm48_hdr *gh; |
| 319 | |
| 320 | gh = (struct gsm48_hdr *) msgb_push(msg, sizeof(*gh)); |
| 321 | /* Outgoing needs the highest bit set */ |
| 322 | gh->proto_discr = proto | (trans << 4); |
| 323 | gh->msg_type = msg_type; |
| 324 | |
| 325 | return 0; |
| 326 | } |