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 |
| 89 | *scts++ = gsm411_bcdify(tm->tm_gmtoff/(60*15)); |
| 90 | #else |
| 91 | #warning find a portable way to obtain timezone offset |
| 92 | *scts++ = 0; |
| 93 | #endif |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | /* Decode 03.40 TP-SCTS (into utc/gmt timestamp) */ |
| 97 | time_t gsm340_scts(uint8_t *scts) |
| 98 | { |
| 99 | struct tm tm; |
Harald Welte | ad633b0 | 2011-12-01 21:08:19 +0100 | [diff] [blame] | 100 | uint8_t yr = gsm411_unbcdify(*scts++); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 101 | int ofs; |
| 102 | |
| 103 | memset(&tm, 0x00, sizeof(struct tm)); |
| 104 | |
| 105 | if (yr <= 80) |
| 106 | tm.tm_year = 100 + yr; |
| 107 | else |
| 108 | tm.tm_year = yr; |
Harald Welte | ad633b0 | 2011-12-01 21:08:19 +0100 | [diff] [blame] | 109 | tm.tm_mon = gsm411_unbcdify(*scts++) - 1; |
| 110 | tm.tm_mday = gsm411_unbcdify(*scts++); |
| 111 | tm.tm_hour = gsm411_unbcdify(*scts++); |
| 112 | tm.tm_min = gsm411_unbcdify(*scts++); |
| 113 | tm.tm_sec = gsm411_unbcdify(*scts++); |
Harald Welte | 7c8e2cc | 2012-08-29 16:47:30 +0200 | [diff] [blame] | 114 | #ifdef HAVE_TM_GMTOFF_IN_TM |
| 115 | tm.tm_gmtoff = gsm411_unbcdify(*scts++) * 15*60; |
| 116 | #endif |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 117 | |
| 118 | /* according to gsm 03.40 time zone is |
| 119 | "expressed in quarters of an hour" */ |
Harald Welte | ad633b0 | 2011-12-01 21:08:19 +0100 | [diff] [blame] | 120 | ofs = gsm411_unbcdify(*scts++) * 15*60; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 121 | |
| 122 | return mktime(&tm) - ofs; |
| 123 | } |
| 124 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 125 | /* Decode validity period format 'relative'. |
| 126 | * Returns number of seconds relative to a current time. */ |
| 127 | static time_t gsm340_vp_relative(uint8_t *sms_vp) |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 128 | { |
| 129 | /* Chapter 9.2.3.12.1 */ |
| 130 | uint8_t vp; |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 131 | time_t minutes; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 132 | |
| 133 | vp = *(sms_vp); |
| 134 | if (vp <= 143) |
| 135 | minutes = vp + 1 * 5; |
| 136 | else if (vp <= 167) |
| 137 | minutes = 12*60 + (vp-143) * 30; |
| 138 | else if (vp <= 196) |
| 139 | minutes = vp-166 * 60 * 24; |
| 140 | else |
| 141 | minutes = vp-192 * 60 * 24 * 7; |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 142 | |
| 143 | /* Convert to seconds */ |
| 144 | return minutes * 60; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 145 | } |
| 146 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 147 | /* Decode validity period format 'absolute'. |
| 148 | * Returns UNIX time. */ |
| 149 | static time_t gsm340_vp_absolute(uint8_t *sms_vp) |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 150 | { |
| 151 | /* Chapter 9.2.3.12.2 */ |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 152 | return gsm340_scts(sms_vp); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 153 | } |
| 154 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 155 | /* Decode validity period format 'relative in integer representation'. |
| 156 | * Returns number of seconds relative to a current time. */ |
| 157 | static time_t gsm340_vp_relative_integer(uint8_t *sms_vp) |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 158 | { |
| 159 | uint8_t vp; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 160 | vp = *(sms_vp); |
| 161 | if (vp == 0) { |
| 162 | LOGP(DLSMS, LOGL_ERROR, |
| 163 | "reserved relative_integer validity period\n"); |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 164 | #warning We should return an RP-Error here. |
| 165 | return SMS_DEFAULT_VALIDITY_PERIOD; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 166 | } |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 167 | return vp; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 168 | } |
| 169 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 170 | /* Decode validity period format 'relative in semi-octet representation'. |
| 171 | * Returns number of seconds relative to a current time. */ |
| 172 | static time_t gsm340_vp_relative_semioctet(uint8_t *sms_vp) |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 173 | { |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 174 | time_t hours, minutes, seconds; |
| 175 | hours = gsm411_unbcdify(*sms_vp++); /* hours */ |
| 176 | minutes = gsm411_unbcdify(*sms_vp++); /* minutes */ |
| 177 | seconds = gsm411_unbcdify(*sms_vp++); /* seconds */ |
| 178 | return hours*60*60 + minutes*60 + seconds; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 179 | } |
| 180 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 181 | /* Decode validity period. Returns absolute UNIX time. */ |
| 182 | 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] | 183 | { |
| 184 | uint8_t fi; /* functionality indicator */ |
| 185 | |
| 186 | switch (sms_vpf) { |
| 187 | case GSM340_TP_VPF_RELATIVE: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 188 | return now + gsm340_vp_relative(sms_vp); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 189 | case GSM340_TP_VPF_ABSOLUTE: |
| 190 | return gsm340_vp_absolute(sms_vp); |
| 191 | case GSM340_TP_VPF_ENHANCED: |
| 192 | /* Chapter 9.2.3.12.3 */ |
| 193 | fi = *sms_vp++; |
| 194 | /* ignore additional fi */ |
| 195 | if (fi & (1<<7)) sms_vp++; |
| 196 | /* read validity period format */ |
| 197 | switch (fi & 0x7) { |
| 198 | case 0x0: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 199 | return now + SMS_DEFAULT_VALIDITY_PERIOD; /* no vpf specified */ |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 200 | case 0x1: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 201 | return now + gsm340_vp_relative(sms_vp); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 202 | case 0x2: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 203 | return now + gsm340_vp_relative_integer(sms_vp); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 204 | case 0x3: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 205 | return now + gsm340_vp_relative_semioctet(sms_vp); |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 206 | default: |
| 207 | /* The GSM spec says that the SC should reject any |
| 208 | unsupported and/or undefined values. FIXME */ |
| 209 | LOGP(DLSMS, LOGL_ERROR, |
| 210 | "Reserved enhanced validity period format\n"); |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 211 | return now + SMS_DEFAULT_VALIDITY_PERIOD; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 212 | } |
| 213 | case GSM340_TP_VPF_NONE: |
| 214 | default: |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 215 | return now + SMS_DEFAULT_VALIDITY_PERIOD; |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 216 | } |
| 217 | } |
| 218 | |
Alexander Chemeris | e647544 | 2013-11-26 16:43:10 -0600 | [diff] [blame] | 219 | /* Decode validity period. return relative minutes. |
| 220 | * This behaviour is broken, but we're mimicing to it for compatibility. */ |
| 221 | unsigned long gsm340_validity_period(uint8_t sms_vpf, uint8_t *sms_vp) |
| 222 | { |
| 223 | time_t now = time(NULL); |
| 224 | return (gsm340_validity_time(now, sms_vpf, sms_vp) - now) / 60; |
| 225 | } |
| 226 | |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 227 | /* determine coding alphabet dependent on GSM 03.38 Section 4 DCS */ |
| 228 | enum sms_alphabet gsm338_get_sms_alphabet(uint8_t dcs) |
| 229 | { |
| 230 | uint8_t cgbits = dcs >> 4; |
| 231 | enum sms_alphabet alpha = DCS_NONE; |
| 232 | |
| 233 | if ((cgbits & 0xc) == 0) { |
| 234 | if (cgbits & 2) { |
| 235 | LOGP(DLSMS, LOGL_NOTICE, |
| 236 | "Compressed SMS not supported yet\n"); |
| 237 | return 0xffffffff; |
| 238 | } |
| 239 | |
| 240 | switch ((dcs >> 2)&0x03) { |
| 241 | case 0: |
| 242 | alpha = DCS_7BIT_DEFAULT; |
| 243 | break; |
| 244 | case 1: |
| 245 | alpha = DCS_8BIT_DATA; |
| 246 | break; |
| 247 | case 2: |
| 248 | alpha = DCS_UCS2; |
| 249 | break; |
| 250 | } |
| 251 | } else if (cgbits == 0xc || cgbits == 0xd) |
| 252 | alpha = DCS_7BIT_DEFAULT; |
| 253 | else if (cgbits == 0xe) |
| 254 | alpha = DCS_UCS2; |
| 255 | else if (cgbits == 0xf) { |
| 256 | if (dcs & 4) |
| 257 | alpha = DCS_8BIT_DATA; |
| 258 | else |
| 259 | alpha = DCS_7BIT_DEFAULT; |
| 260 | } |
| 261 | |
| 262 | return alpha; |
| 263 | } |
| 264 | |
| 265 | /* generate a TPDU address field compliant with 03.40 sec. 9.1.2.5 */ |
| 266 | int gsm340_gen_oa(uint8_t *oa, unsigned int oa_len, uint8_t type, |
| 267 | uint8_t plan, const char *number) |
| 268 | { |
| 269 | int len_in_bytes; |
| 270 | |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 271 | oa[1] = 0x80 | (type << 4) | plan; |
| 272 | |
Holger Hans Peter Freyther | 4d7e49b | 2013-05-02 22:37:16 +0200 | [diff] [blame] | 273 | if (type == GSM340_TYPE_ALPHA_NUMERIC) { |
| 274 | /* |
| 275 | * TODO/FIXME: what is the 'useful semi-octets' excluding any |
| 276 | * semi octet containing only fill bits. |
| 277 | * The current code picks the number of bytes written by the |
| 278 | * 7bit encoding routines and multiplies it by two. |
| 279 | */ |
| 280 | gsm_7bit_encode_n(&oa[2], oa_len - 2, number, &len_in_bytes); |
| 281 | oa[0] = len_in_bytes * 2; |
| 282 | len_in_bytes += 2; |
| 283 | } else { |
| 284 | /* prevent buffer overflows */ |
| 285 | if (strlen(number) > 20) |
| 286 | number = ""; |
| 287 | len_in_bytes = gsm48_encode_bcd_number(oa, oa_len, 1, number); |
| 288 | /* GSM 03.40 tells us the length is in 'useful semi-octets' */ |
| 289 | oa[0] = strlen(number) & 0xff; |
| 290 | } |
Andreas.Eversberg | d84f47a | 2011-11-06 20:22:12 +0100 | [diff] [blame] | 291 | |
| 292 | return len_in_bytes; |
| 293 | } |
| 294 | |
| 295 | /* Prefix msg with a RP header */ |
| 296 | int gsm411_push_rp_header(struct msgb *msg, uint8_t rp_msg_type, |
| 297 | uint8_t rp_msg_ref) |
| 298 | { |
| 299 | struct gsm411_rp_hdr *rp; |
| 300 | uint8_t len = msg->len; |
| 301 | |
| 302 | /* GSM 04.11 RP-DATA header */ |
| 303 | rp = (struct gsm411_rp_hdr *)msgb_push(msg, sizeof(*rp)); |
| 304 | rp->len = len + 2; |
| 305 | rp->msg_type = rp_msg_type; |
| 306 | rp->msg_ref = rp_msg_ref; /* FIXME: Choose randomly */ |
| 307 | |
| 308 | return 0; |
| 309 | } |
| 310 | |
| 311 | /* Prefix msg with a 04.08/04.11 CP header */ |
| 312 | int gsm411_push_cp_header(struct msgb *msg, uint8_t proto, uint8_t trans, |
| 313 | uint8_t msg_type) |
| 314 | { |
| 315 | struct gsm48_hdr *gh; |
| 316 | |
| 317 | gh = (struct gsm48_hdr *) msgb_push(msg, sizeof(*gh)); |
| 318 | /* Outgoing needs the highest bit set */ |
| 319 | gh->proto_discr = proto | (trans << 4); |
| 320 | gh->msg_type = msg_type; |
| 321 | |
| 322 | return 0; |
| 323 | } |