blob: e6639ce66002380e55ba12f677a93726f00ec8be [file] [log] [blame]
Harald Welte9b455bf2010-03-14 15:45:01 +08001/* GPRS LLC protocol implementation as per 3GPP TS 04.64 */
2
Harald Weltea2665542010-05-02 09:28:11 +02003/* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org>
Harald Welte9b455bf2010-03-14 15:45:01 +08004 *
5 * All Rights Reserved
6 *
7 * This program is free software; you can redistribute it and/or modify
Harald Welte9af6ddf2011-01-01 15:25:50 +01008 * 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
Harald Welte9b455bf2010-03-14 15:45:01 +080010 * (at your option) any later version.
11 *
12 * 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
Harald Welte9af6ddf2011-01-01 15:25:50 +010015 * GNU Affero General Public License for more details.
Harald Welte9b455bf2010-03-14 15:45:01 +080016 *
Harald Welte9af6ddf2011-01-01 15:25:50 +010017 * 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 Welte9b455bf2010-03-14 15:45:01 +080019 *
20 */
21
22#include <errno.h>
Harald Welteeaa614c2010-05-02 11:26:34 +020023#include <stdint.h>
Max82040102016-07-06 11:59:18 +020024#include <stdbool.h>
Harald Welte9b455bf2010-03-14 15:45:01 +080025
Maxb997f842016-07-06 15:57:01 +020026#include <openssl/rand.h>
27
Pablo Neira Ayuso136f4532011-03-22 16:47:59 +010028#include <osmocom/core/msgb.h>
29#include <osmocom/core/linuxlist.h>
30#include <osmocom/core/timer.h>
31#include <osmocom/core/talloc.h>
Harald Welteea34a4e2012-06-16 14:59:56 +080032#include <osmocom/gprs/gprs_bssgp.h>
Harald Weltea2665542010-05-02 09:28:11 +020033
34#include <openbsc/gsm_data.h>
35#include <openbsc/debug.h>
Harald Welte807a5d82010-06-01 11:53:01 +020036#include <openbsc/gprs_sgsn.h>
37#include <openbsc/gprs_gmm.h>
Harald Welte9b455bf2010-03-14 15:45:01 +080038#include <openbsc/gprs_llc.h>
39#include <openbsc/crc24.h>
Holger Hans Peter Freyther3dccda52011-10-14 23:42:13 +020040#include <openbsc/sgsn.h>
Harald Welte9b455bf2010-03-14 15:45:01 +080041
Holger Hans Peter Freyther964a9b32013-07-30 09:29:27 +020042static struct gprs_llc_llme *llme_alloc(uint32_t tlli);
43
Harald Weltefaa70ff2012-06-17 09:31:16 +080044/* Entry function from upper level (LLC), asking us to transmit a BSSGP PDU
45 * to a remote MS (identified by TLLI) at a BTS identified by its BVCI and NSEI */
46static int _bssgp_tx_dl_ud(struct msgb *msg, struct sgsn_mm_ctx *mmctx)
47{
48 struct bssgp_dl_ud_par dup;
49 const uint8_t qos_profile_default[3] = { 0x00, 0x00, 0x20 };
50
Harald Welte8c004962012-07-04 21:53:12 +020051 memset(&dup, 0, sizeof(dup));
52 /* before we have received some identity from the MS, we might
53 * not yet have a MMC context (e.g. XID negotiation of primarly
54 * LLC connection fro GMM sapi). */
55 if (mmctx) {
56 dup.imsi = mmctx->imsi;
57 dup.drx_parms = mmctx->drx_parms;
58 dup.ms_ra_cap.len = mmctx->ms_radio_access_capa.len;
59 dup.ms_ra_cap.v = mmctx->ms_radio_access_capa.buf;
Holger Hans Peter Freyther7e0fec12013-07-29 10:09:12 +020060
61 /* make sure we only send it to the right llme */
Harald Weltef97ee042015-12-25 19:12:21 +010062 OSMO_ASSERT(msgb_tlli(msg) == mmctx->gb.llme->tlli
63 || msgb_tlli(msg) == mmctx->gb.llme->old_tlli);
Harald Welte8c004962012-07-04 21:53:12 +020064 }
Harald Weltefaa70ff2012-06-17 09:31:16 +080065 memcpy(&dup.qos_profile, qos_profile_default,
66 sizeof(qos_profile_default));
67
Harald Weltece95b272012-06-17 13:04:02 +080068 return bssgp_tx_dl_ud(msg, 1000, &dup);
Harald Weltefaa70ff2012-06-17 09:31:16 +080069}
70
71
Harald Welte1d9d9442010-06-03 07:11:04 +020072/* Section 8.9.9 LLC layer parameter default values */
Daniel Willmann46d13262014-06-27 17:05:48 +020073static const struct gprs_llc_params llc_default_params[NUM_SAPIS] = {
Harald Welte1d9d9442010-06-03 07:11:04 +020074 [1] = {
75 .t200_201 = 5,
76 .n200 = 3,
77 .n201_u = 400,
78 },
79 [2] = {
80 .t200_201 = 5,
81 .n200 = 3,
82 .n201_u = 270,
83 },
84 [3] = {
85 .iov_i_exp = 27,
86 .t200_201 = 5,
87 .n200 = 3,
88 .n201_u = 500,
89 .n201_i = 1503,
90 .mD = 1520,
91 .mU = 1520,
92 .kD = 16,
93 .kU = 16,
94 },
95 [5] = {
96 .iov_i_exp = 27,
97 .t200_201 = 10,
98 .n200 = 3,
99 .n201_u = 500,
100 .n201_i = 1503,
101 .mD = 760,
102 .mU = 760,
103 .kD = 8,
104 .kU = 8,
105 },
106 [7] = {
107 .t200_201 = 20,
108 .n200 = 3,
109 .n201_u = 270,
110 },
111 [8] = {
112 .t200_201 = 20,
113 .n200 = 3,
114 .n201_u = 270,
115 },
116 [9] = {
117 .iov_i_exp = 27,
118 .t200_201 = 20,
119 .n200 = 3,
120 .n201_u = 500,
121 .n201_i = 1503,
122 .mD = 380,
123 .mU = 380,
124 .kD = 4,
125 .kU = 4,
126 },
127 [11] = {
128 .iov_i_exp = 27,
129 .t200_201 = 40,
130 .n200 = 3,
131 .n201_u = 500,
132 .n201_i = 1503,
133 .mD = 190,
134 .mU = 190,
135 .kD = 2,
136 .kU = 2,
137 },
138};
139
Harald Welte807a5d82010-06-01 11:53:01 +0200140LLIST_HEAD(gprs_llc_llmes);
Harald Weltea2665542010-05-02 09:28:11 +0200141void *llc_tall_ctx;
142
143/* lookup LLC Entity based on DLCI (TLLI+SAPI tuple) */
Holger Hans Peter Freyther012a7ee2013-07-29 09:06:46 +0200144static struct gprs_llc_lle *lle_by_tlli_sapi(const uint32_t tlli, uint8_t sapi)
Harald Weltea2665542010-05-02 09:28:11 +0200145{
Harald Welte807a5d82010-06-01 11:53:01 +0200146 struct gprs_llc_llme *llme;
Harald Weltea2665542010-05-02 09:28:11 +0200147
Harald Welte807a5d82010-06-01 11:53:01 +0200148 llist_for_each_entry(llme, &gprs_llc_llmes, list) {
149 if (llme->tlli == tlli || llme->old_tlli == tlli)
150 return &llme->lle[sapi];
Harald Weltea2665542010-05-02 09:28:11 +0200151 }
152 return NULL;
153}
154
Holger Hans Peter Freyther4299c052014-10-02 21:27:24 +0200155struct gprs_llc_lle *gprs_lle_get_or_create(const uint32_t tlli, uint8_t sapi)
156{
157 struct gprs_llc_llme *llme;
158 struct gprs_llc_lle *lle;
159
160 lle = lle_by_tlli_sapi(tlli, sapi);
161 if (lle)
162 return lle;
163
Holger Hans Peter Freyther4299c052014-10-02 21:27:24 +0200164 LOGP(DLLC, LOGL_NOTICE, "LLC: unknown TLLI 0x%08x, "
165 "creating LLME on the fly\n", tlli);
166 llme = llme_alloc(tlli);
167 lle = &llme->lle[sapi];
168 return lle;
169}
170
171struct llist_head *gprs_llme_list(void)
172{
173 return &gprs_llc_llmes;
174}
175
Holger Hans Peter Freyther964a9b32013-07-30 09:29:27 +0200176/* lookup LLC Entity for RX based on DLCI (TLLI+SAPI tuple) */
177static struct gprs_llc_lle *lle_for_rx_by_tlli_sapi(const uint32_t tlli,
178 uint8_t sapi, enum gprs_llc_cmd cmd)
179{
180 struct gprs_llc_lle *lle;
181
182 /* We already know about this TLLI */
183 lle = lle_by_tlli_sapi(tlli, sapi);
184 if (lle)
185 return lle;
186
187 /* Maybe it is a routing area update but we already know this sapi? */
188 if (gprs_tlli_type(tlli) == TLLI_FOREIGN) {
Jacob Erlbeck3fbf0a32016-01-04 18:43:32 +0100189 lle = lle_by_tlli_sapi(tlli, sapi);
Holger Hans Peter Freyther964a9b32013-07-30 09:29:27 +0200190 if (lle) {
191 LOGP(DLLC, LOGL_NOTICE,
192 "LLC RX: Found a local entry for TLLI 0x%08x\n",
193 tlli);
194 return lle;
195 }
196 }
197
198 /* 7.2.1.1 LLC belonging to unassigned TLLI+SAPI shall be discarded,
199 * except UID and XID frames with SAPI=1 */
200 if (sapi == GPRS_SAPI_GMM &&
201 (cmd == GPRS_LLC_XID || cmd == GPRS_LLC_UI)) {
202 struct gprs_llc_llme *llme;
203 /* FIXME: don't use the TLLI but the 0xFFFF unassigned? */
204 llme = llme_alloc(tlli);
Daniel Willmann46553142014-09-03 17:46:44 +0200205 LOGP(DLLC, LOGL_NOTICE, "LLC RX: unknown TLLI 0x%08x, "
Holger Hans Peter Freyther964a9b32013-07-30 09:29:27 +0200206 "creating LLME on the fly\n", tlli);
207 lle = &llme->lle[sapi];
208 return lle;
209 }
210
211 LOGP(DLLC, LOGL_NOTICE,
212 "unknown TLLI(0x%08x)/SAPI(%d): Silently dropping\n",
213 tlli, sapi);
214 return NULL;
215}
216
Harald Welte1d9d9442010-06-03 07:11:04 +0200217static void lle_init(struct gprs_llc_llme *llme, uint8_t sapi)
Harald Weltea2665542010-05-02 09:28:11 +0200218{
Harald Welte807a5d82010-06-01 11:53:01 +0200219 struct gprs_llc_lle *lle = &llme->lle[sapi];
Harald Weltea2665542010-05-02 09:28:11 +0200220
Harald Welte807a5d82010-06-01 11:53:01 +0200221 lle->llme = llme;
222 lle->sapi = sapi;
223 lle->state = GPRS_LLES_UNASSIGNED;
224
Harald Welte1d9d9442010-06-03 07:11:04 +0200225 /* Initialize according to parameters */
226 memcpy(&lle->params, &llc_default_params[sapi], sizeof(lle->params));
Harald Welte807a5d82010-06-01 11:53:01 +0200227}
228
229static struct gprs_llc_llme *llme_alloc(uint32_t tlli)
230{
231 struct gprs_llc_llme *llme;
232 uint32_t i;
233
234 llme = talloc_zero(llc_tall_ctx, struct gprs_llc_llme);
235 if (!llme)
Harald Weltea2665542010-05-02 09:28:11 +0200236 return NULL;
237
Harald Welte807a5d82010-06-01 11:53:01 +0200238 llme->tlli = tlli;
Harald Welte875840c2010-07-01 11:54:31 +0200239 llme->old_tlli = 0xffffffff;
Harald Welte807a5d82010-06-01 11:53:01 +0200240 llme->state = GPRS_LLMS_UNASSIGNED;
Jacob Erlbeck81ffb742015-01-23 11:33:51 +0100241 llme->age_timestamp = GPRS_LLME_RESET_AGE;
Max5aa51962016-07-06 11:33:04 +0200242 llme->cksn = GSM_KEY_SEQ_INVAL;
Harald Weltea2665542010-05-02 09:28:11 +0200243
Harald Welte807a5d82010-06-01 11:53:01 +0200244 for (i = 0; i < ARRAY_SIZE(llme->lle); i++)
245 lle_init(llme, i);
246
247 llist_add(&llme->list, &gprs_llc_llmes);
248
249 return llme;
Harald Weltea2665542010-05-02 09:28:11 +0200250}
251
Harald Weltef7fef482010-06-28 22:18:26 +0200252static void llme_free(struct gprs_llc_llme *llme)
253{
254 llist_del(&llme->list);
255 talloc_free(llme);
256}
257
Holger Hans Peter Freyther744568b2014-04-04 12:47:32 +0200258#if 0
259/* FIXME: Unused code... */
Harald Welte9b455bf2010-03-14 15:45:01 +0800260static void t200_expired(void *data)
261{
262 struct gprs_llc_lle *lle = data;
263
264 /* 8.5.1.3: Expiry of T200 */
265
Harald Welte1d9d9442010-06-03 07:11:04 +0200266 if (lle->retrans_ctr >= lle->params.n200) {
Harald Welte9b455bf2010-03-14 15:45:01 +0800267 /* FIXME: LLGM-STATUS-IND, LL-RELEASE-IND/CNF */
Harald Welte807a5d82010-06-01 11:53:01 +0200268 lle->state = GPRS_LLES_ASSIGNED_ADM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800269 }
270
271 switch (lle->state) {
Harald Welte807a5d82010-06-01 11:53:01 +0200272 case GPRS_LLES_LOCAL_EST:
Harald Welte1ae09c72010-05-13 19:22:55 +0200273 /* FIXME: retransmit SABM */
274 /* FIXME: re-start T200 */
Harald Welte9b455bf2010-03-14 15:45:01 +0800275 lle->retrans_ctr++;
276 break;
Harald Welte807a5d82010-06-01 11:53:01 +0200277 case GPRS_LLES_LOCAL_REL:
Harald Welte1ae09c72010-05-13 19:22:55 +0200278 /* FIXME: retransmit DISC */
279 /* FIXME: re-start T200 */
Harald Welte9b455bf2010-03-14 15:45:01 +0800280 lle->retrans_ctr++;
281 break;
Holger Hans Peter Freyther744568b2014-04-04 12:47:32 +0200282 default:
283 LOGP(DLLC, LOGL_ERROR, "LLC unhandled state: %d\n", lle->state);
284 break;
Harald Welte9b455bf2010-03-14 15:45:01 +0800285 }
286
287}
288
289static void t201_expired(void *data)
290{
291 struct gprs_llc_lle *lle = data;
292
Harald Welte1d9d9442010-06-03 07:11:04 +0200293 if (lle->retrans_ctr < lle->params.n200) {
Harald Welte1ae09c72010-05-13 19:22:55 +0200294 /* FIXME: transmit apropriate supervisory frame (8.6.4.1) */
295 /* FIXME: set timer T201 */
Harald Welte9b455bf2010-03-14 15:45:01 +0800296 lle->retrans_ctr++;
297 }
298}
Holger Hans Peter Freyther744568b2014-04-04 12:47:32 +0200299#endif
Harald Welte9b455bf2010-03-14 15:45:01 +0800300
Harald Welte10997d02010-05-03 12:28:12 +0200301int gprs_llc_tx_u(struct msgb *msg, uint8_t sapi, int command,
302 enum gprs_llc_u_cmd u_cmd, int pf_bit)
303{
304 uint8_t *fcs, *llch;
305 uint8_t addr, ctrl;
306 uint32_t fcs_calc;
307
308 /* Identifiers from UP: (TLLI, SAPI) + (BVCI, NSEI) */
309
310 /* Address Field */
311 addr = sapi & 0xf;
312 if (command)
313 addr |= 0x40;
314
315 /* 6.3 Figure 8 */
316 ctrl = 0xe0 | u_cmd;
317 if (pf_bit)
318 ctrl |= 0x10;
319
320 /* prepend LLC UI header */
321 llch = msgb_push(msg, 2);
322 llch[0] = addr;
323 llch[1] = ctrl;
324
325 /* append FCS to end of frame */
326 fcs = msgb_put(msg, 3);
327 fcs_calc = gprs_llc_fcs(llch, fcs - llch);
328 fcs[0] = fcs_calc & 0xff;
329 fcs[1] = (fcs_calc >> 8) & 0xff;
330 fcs[2] = (fcs_calc >> 16) & 0xff;
331
332 /* Identifiers passed down: (BVCI, NSEI) */
333
Harald Welte1ae09c72010-05-13 19:22:55 +0200334 /* Send BSSGP-DL-UNITDATA.req */
Harald Welteb1fd9022012-06-17 12:16:31 +0800335 return _bssgp_tx_dl_ud(msg, NULL);
Harald Welte10997d02010-05-03 12:28:12 +0200336}
337
338/* Send XID response to LLE */
Harald Welte0c1a3032011-10-16 18:49:05 +0200339static int gprs_llc_tx_xid(struct gprs_llc_lle *lle, struct msgb *msg,
340 int command)
Harald Welte10997d02010-05-03 12:28:12 +0200341{
342 /* copy identifiers from LLE to ensure lower layers can route */
Harald Welte807a5d82010-06-01 11:53:01 +0200343 msgb_tlli(msg) = lle->llme->tlli;
344 msgb_bvci(msg) = lle->llme->bvci;
345 msgb_nsei(msg) = lle->llme->nsei;
Harald Welte10997d02010-05-03 12:28:12 +0200346
Harald Welte0c1a3032011-10-16 18:49:05 +0200347 return gprs_llc_tx_u(msg, lle->sapi, command, GPRS_LLC_U_XID, 1);
Harald Welte10997d02010-05-03 12:28:12 +0200348}
349
Max82040102016-07-06 11:59:18 +0200350/* Transmit a UI frame over the given SAPI:
351 'encryptable' indicates whether particular message can be encrypted according
352 to 3GPP TS 24.008 § 4.7.1.2
353 */
Harald Welte56a01452010-05-31 22:12:30 +0200354int gprs_llc_tx_ui(struct msgb *msg, uint8_t sapi, int command,
Max82040102016-07-06 11:59:18 +0200355 struct sgsn_mm_ctx *mmctx, bool encryptable)
Harald Welte9b455bf2010-03-14 15:45:01 +0800356{
Harald Weltee6afd602010-05-02 11:19:37 +0200357 struct gprs_llc_lle *lle;
Harald Welteeaa614c2010-05-02 11:26:34 +0200358 uint8_t *fcs, *llch;
359 uint8_t addr, ctrl[2];
360 uint32_t fcs_calc;
361 uint16_t nu = 0;
Harald Welted07b4f92010-06-30 23:07:59 +0200362 uint32_t oc;
Harald Welte9b455bf2010-03-14 15:45:01 +0800363
Harald Weltee6afd602010-05-02 11:19:37 +0200364 /* Identifiers from UP: (TLLI, SAPI) + (BVCI, NSEI) */
365
366 /* look-up or create the LL Entity for this (TLLI, SAPI) tuple */
Holger Hans Peter Freyther4299c052014-10-02 21:27:24 +0200367 lle = gprs_lle_get_or_create(msgb_tlli(msg), sapi);
Harald Welte1d9d9442010-06-03 07:11:04 +0200368
369 if (msg->len > lle->params.n201_u) {
370 LOGP(DLLC, LOGL_ERROR, "Cannot Tx %u bytes (N201-U=%u)\n",
371 msg->len, lle->params.n201_u);
Holger Hans Peter Freytherf9ffd1f2014-10-10 17:35:54 +0200372 msgb_free(msg);
Harald Welte1d9d9442010-06-03 07:11:04 +0200373 return -EFBIG;
374 }
375
Max5aa51962016-07-06 11:33:04 +0200376 gprs_llme_copy_key(mmctx, lle->llme);
377
Harald Weltee6afd602010-05-02 11:19:37 +0200378 /* Update LLE's (BVCI, NSEI) tuple */
Harald Welte807a5d82010-06-01 11:53:01 +0200379 lle->llme->bvci = msgb_bvci(msg);
380 lle->llme->nsei = msgb_nsei(msg);
Harald Weltee6afd602010-05-02 11:19:37 +0200381
Harald Welted07b4f92010-06-30 23:07:59 +0200382 /* Obtain current values for N(u) and OC */
Harald Welte6bdee6a2010-05-30 21:51:58 +0200383 nu = lle->vu_send;
Harald Welted07b4f92010-06-30 23:07:59 +0200384 oc = lle->oc_ui_send;
385 /* Increment V(U) */
Harald Welte6bdee6a2010-05-30 21:51:58 +0200386 lle->vu_send = (lle->vu_send + 1) % 512;
Harald Welted07b4f92010-06-30 23:07:59 +0200387 /* Increment Overflow Counter, if needed */
388 if ((lle->vu_send + 1) / 512)
389 lle->oc_ui_send += 512;
Harald Welte6bdee6a2010-05-30 21:51:58 +0200390
Harald Welte9b455bf2010-03-14 15:45:01 +0800391 /* Address Field */
392 addr = sapi & 0xf;
393 if (command)
394 addr |= 0x40;
395
396 /* Control Field */
397 ctrl[0] = 0xc0;
398 ctrl[0] |= nu >> 6;
399 ctrl[1] = (nu << 2) & 0xfc;
400 ctrl[1] |= 0x01; /* Protected Mode */
401
402 /* prepend LLC UI header */
403 llch = msgb_push(msg, 3);
404 llch[0] = addr;
405 llch[1] = ctrl[0];
406 llch[2] = ctrl[1];
407
408 /* append FCS to end of frame */
409 fcs = msgb_put(msg, 3);
410 fcs_calc = gprs_llc_fcs(llch, fcs - llch);
411 fcs[0] = fcs_calc & 0xff;
412 fcs[1] = (fcs_calc >> 8) & 0xff;
413 fcs[2] = (fcs_calc >> 16) & 0xff;
414
Harald Welted07b4f92010-06-30 23:07:59 +0200415 /* encrypt information field + FCS, if needed! */
Max82040102016-07-06 11:59:18 +0200416 if (lle->llme->algo != GPRS_ALGO_GEA0 && encryptable) {
Harald Welted07b4f92010-06-30 23:07:59 +0200417 uint32_t iov_ui = 0; /* FIXME: randomly select for TLLI */
418 uint16_t crypt_len = (fcs + 3) - (llch + 3);
419 uint8_t cipher_out[GSM0464_CIPH_MAX_BLOCK];
420 uint32_t iv;
421 int rc, i;
Alexander Couzens85f8fda2016-05-31 17:37:54 +0200422 uint8_t *kc = lle->llme->kc;
Harald Welted07b4f92010-06-30 23:07:59 +0200423
424 /* Compute the 'Input' Paraemeter */
425 iv = gprs_cipher_gen_input_ui(iov_ui, sapi, nu, oc);
426
427 /* Compute the keystream that we need to XOR with the data */
428 rc = gprs_cipher_run(cipher_out, crypt_len, lle->llme->algo,
429 kc, iv, GPRS_CIPH_SGSN2MS);
430 if (rc < 0) {
431 LOGP(DLLC, LOGL_ERROR, "Error crypting UI frame: %d\n", rc);
Holger Hans Peter Freytherf9ffd1f2014-10-10 17:35:54 +0200432 msgb_free(msg);
Harald Welted07b4f92010-06-30 23:07:59 +0200433 return rc;
434 }
435
436 /* XOR the cipher output with the information field + FCS */
437 for (i = 0; i < crypt_len; i++)
438 *(llch + 3 + i) ^= cipher_out[i];
439
440 /* Mark frame as encrypted */
441 ctrl[1] |= 0x02;
442 }
443
Harald Weltee6afd602010-05-02 11:19:37 +0200444 /* Identifiers passed down: (BVCI, NSEI) */
445
Harald Welte1ae09c72010-05-13 19:22:55 +0200446 /* Send BSSGP-DL-UNITDATA.req */
Harald Weltefaa70ff2012-06-17 09:31:16 +0800447 return _bssgp_tx_dl_ud(msg, mmctx);
Harald Welte9b455bf2010-03-14 15:45:01 +0800448}
449
Harald Welte0c1a3032011-10-16 18:49:05 +0200450/* According to 6.4.1.6 / Figure 11 */
451static int msgb_put_xid_par(struct msgb *msg, uint8_t type, uint8_t length, uint8_t *data)
452{
453 uint8_t header_len = 1;
454 uint8_t *cur;
455
456 /* type is a 5-bit field... */
457 if (type > 0x1f)
458 return -EINVAL;
459
460 if (length > 3)
461 header_len = 2;
462
463 cur = msgb_put(msg, length + header_len);
464
465 /* build the header without or with XL bit */
466 if (length <= 3) {
467 *cur++ = (type << 2) | (length & 3);
468 } else {
469 *cur++ = 0x80 | (type << 2) | (length >> 6);
470 *cur++ = (length << 2);
471 }
472
473 /* copy over the payload of the parameter*/
474 memcpy(cur, data, length);
475
476 return length + header_len;
477}
478
479static void rx_llc_xid(struct gprs_llc_lle *lle,
480 struct gprs_llc_hdr_parsed *gph)
481{
482 /* FIXME: 8.5.3.3: check if XID is invalid */
483 if (gph->is_cmd) {
484 /* FIXME: implement XID negotiation using SNDCP */
485 struct msgb *resp;
486 uint8_t *xid;
487 resp = msgb_alloc_headroom(4096, 1024, "LLC_XID");
488 xid = msgb_put(resp, gph->data_len);
489 memcpy(xid, gph->data, gph->data_len);
490 gprs_llc_tx_xid(lle, resp, 0);
491 } else {
492 /* FIXME: if we had sent a XID reset, send
493 * LLGMM-RESET.conf to GMM */
494 /* FIXME: implement XID negotiation using SNDCP */
495 }
496}
497
Harald Welte9b455bf2010-03-14 15:45:01 +0800498static int gprs_llc_hdr_rx(struct gprs_llc_hdr_parsed *gph,
499 struct gprs_llc_lle *lle)
500{
501 switch (gph->cmd) {
502 case GPRS_LLC_SABM: /* Section 6.4.1.1 */
503 lle->v_sent = lle->v_ack = lle->v_recv = 0;
Harald Welte807a5d82010-06-01 11:53:01 +0200504 if (lle->state == GPRS_LLES_ASSIGNED_ADM) {
Harald Welte9b455bf2010-03-14 15:45:01 +0800505 /* start re-establishment (8.7.1) */
506 }
Harald Welte807a5d82010-06-01 11:53:01 +0200507 lle->state = GPRS_LLES_REMOTE_EST;
Harald Welte9b455bf2010-03-14 15:45:01 +0800508 /* FIXME: Send UA */
Harald Welte807a5d82010-06-01 11:53:01 +0200509 lle->state = GPRS_LLES_ABM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800510 /* FIXME: process data */
511 break;
512 case GPRS_LLC_DISC: /* Section 6.4.1.2 */
513 /* FIXME: Send UA */
514 /* terminate ABM */
Harald Welte807a5d82010-06-01 11:53:01 +0200515 lle->state = GPRS_LLES_ASSIGNED_ADM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800516 break;
517 case GPRS_LLC_UA: /* Section 6.4.1.3 */
Harald Welte807a5d82010-06-01 11:53:01 +0200518 if (lle->state == GPRS_LLES_LOCAL_EST)
519 lle->state = GPRS_LLES_ABM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800520 break;
521 case GPRS_LLC_DM: /* Section 6.4.1.4: ABM cannot be performed */
Harald Welte807a5d82010-06-01 11:53:01 +0200522 if (lle->state == GPRS_LLES_LOCAL_EST)
523 lle->state = GPRS_LLES_ASSIGNED_ADM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800524 break;
525 case GPRS_LLC_FRMR: /* Section 6.4.1.5 */
526 break;
527 case GPRS_LLC_XID: /* Section 6.4.1.6 */
Harald Welte0c1a3032011-10-16 18:49:05 +0200528 rx_llc_xid(lle, gph);
Harald Welte9b455bf2010-03-14 15:45:01 +0800529 break;
Harald Welteebabdea2010-06-01 18:28:10 +0200530 case GPRS_LLC_UI:
Holger Hans Peter Freytherfaf1f642011-06-23 17:53:27 -0400531 if (gprs_llc_is_retransmit(gph->seq_tx, lle->vu_recv)) {
532 LOGP(DLLC, LOGL_NOTICE,
533 "TLLI=%08x dropping UI, N(U=%d) not in window V(URV(UR:%d).\n",
Holger Hans Peter Freyther2788b962010-06-23 09:48:25 +0800534 lle->llme ? lle->llme->tlli : -1,
Harald Welteebabdea2010-06-01 18:28:10 +0200535 gph->seq_tx, lle->vu_recv);
Harald Welteabadd542013-06-21 14:06:18 +0200536
537 /* HACK: non-standard recovery handling. If remote LLE
538 * is re-transmitting the same sequence number for
Harald Welte649e1ff2013-07-21 17:41:46 +0800539 * three times, don't discard the frame but pass it on
Harald Welteabadd542013-06-21 14:06:18 +0200540 * and 'learn' the new sequence number */
541 if (gph->seq_tx != lle->vu_recv_last) {
542 lle->vu_recv_last = gph->seq_tx;
543 lle->vu_recv_duplicates = 0;
544 } else {
545 lle->vu_recv_duplicates++;
546 if (lle->vu_recv_duplicates < 3)
547 return -EIO;
548 LOGP(DLLC, LOGL_NOTICE, "TLLI=%08x recovering "
549 "N(U=%d) after receiving %u duplicates\n",
550 lle->llme ? lle->llme->tlli : -1,
551 gph->seq_tx, lle->vu_recv_duplicates);
552 }
Harald Welteebabdea2010-06-01 18:28:10 +0200553 }
554 /* Increment the sequence number that we expect in the next frame */
555 lle->vu_recv = (gph->seq_tx + 1) % 512;
Harald Welted07b4f92010-06-30 23:07:59 +0200556 /* Increment Overflow Counter */
557 if ((gph->seq_tx + 1) / 512)
558 lle->oc_ui_recv += 512;
Harald Welteebabdea2010-06-01 18:28:10 +0200559 break;
Holger Hans Peter Freyther744568b2014-04-04 12:47:32 +0200560 default:
561 LOGP(DLLC, LOGL_NOTICE, "Unhandled command: %d\n", gph->cmd);
562 break;
Harald Welte9b455bf2010-03-14 15:45:01 +0800563 }
564
565 return 0;
566}
567
Harald Weltea2665542010-05-02 09:28:11 +0200568/* receive an incoming LLC PDU (BSSGP-UL-UNITDATA-IND, 7.2.4.2) */
Harald Welte9b455bf2010-03-14 15:45:01 +0800569int gprs_llc_rcvmsg(struct msgb *msg, struct tlv_parsed *tv)
570{
Holger Hans Peter Freyther3dccda52011-10-14 23:42:13 +0200571 struct gprs_llc_hdr *lh = (struct gprs_llc_hdr *) msgb_llch(msg);
Harald Welte9b455bf2010-03-14 15:45:01 +0800572 struct gprs_llc_hdr_parsed llhp;
Harald Welte10997d02010-05-03 12:28:12 +0200573 struct gprs_llc_lle *lle;
Max82040102016-07-06 11:59:18 +0200574 bool drop_cipherable = false;
Harald Weltea2665542010-05-02 09:28:11 +0200575 int rc = 0;
Harald Welte9b455bf2010-03-14 15:45:01 +0800576
Harald Welte11d7c102010-05-02 11:54:55 +0200577 /* Identifiers from DOWN: NSEI, BVCI, TLLI */
578
Holger Hans Peter Freyther4752e0c2010-05-23 21:33:57 +0800579 memset(&llhp, 0, sizeof(llhp));
Holger Hans Peter Freytherfa848d42010-05-23 21:43:57 +0800580 rc = gprs_llc_hdr_parse(&llhp, (uint8_t *) lh, TLVP_LEN(tv, BSSGP_IE_LLC_PDU));
Harald Welte9b455bf2010-03-14 15:45:01 +0800581 gprs_llc_hdr_dump(&llhp);
Harald Welte1ae09c72010-05-13 19:22:55 +0200582 if (rc < 0) {
Harald Welte1b170d12010-05-13 19:49:06 +0200583 LOGP(DLLC, LOGL_NOTICE, "Error during LLC header parsing\n");
Harald Welte1ae09c72010-05-13 19:22:55 +0200584 return rc;
585 }
586
Harald Welte807a5d82010-06-01 11:53:01 +0200587 switch (gprs_tlli_type(msgb_tlli(msg))) {
588 case TLLI_LOCAL:
589 case TLLI_FOREIGN:
590 case TLLI_RANDOM:
591 case TLLI_AUXILIARY:
592 break;
593 default:
594 LOGP(DLLC, LOGL_ERROR,
595 "Discarding frame with strange TLLI type\n");
596 break;
597 }
598
Harald Weltea2665542010-05-02 09:28:11 +0200599 /* find the LLC Entity for this TLLI+SAPI tuple */
Holger Hans Peter Freyther964a9b32013-07-30 09:29:27 +0200600 lle = lle_for_rx_by_tlli_sapi(msgb_tlli(msg), llhp.sapi, llhp.cmd);
Jacob Erlbeck78ecaf02014-09-05 14:32:36 +0200601 if (!lle) {
602 switch (llhp.sapi) {
603 case GPRS_SAPI_SNDCP3:
604 case GPRS_SAPI_SNDCP5:
605 case GPRS_SAPI_SNDCP9:
606 case GPRS_SAPI_SNDCP11:
607 /* Ask an upper layer for help. */
Maxb997f842016-07-06 15:57:01 +0200608 return gsm0408_gprs_force_reattach_oldmsg(msg,
609 lle->llme);
Jacob Erlbeck78ecaf02014-09-05 14:32:36 +0200610 default:
611 break;
612 }
Holger Hans Peter Freyther964a9b32013-07-30 09:29:27 +0200613 return 0;
Jacob Erlbeck78ecaf02014-09-05 14:32:36 +0200614 }
Harald Weltea2665542010-05-02 09:28:11 +0200615
Jacob Erlbeck81ffb742015-01-23 11:33:51 +0100616 /* reset age computation */
617 lle->llme->age_timestamp = GPRS_LLME_RESET_AGE;
618
Harald Welted07b4f92010-06-30 23:07:59 +0200619 /* decrypt information field + FCS, if needed! */
620 if (llhp.is_encrypted) {
621 uint32_t iov_ui = 0; /* FIXME: randomly select for TLLI */
622 uint16_t crypt_len = llhp.data_len + 3;
623 uint8_t cipher_out[GSM0464_CIPH_MAX_BLOCK];
624 uint32_t iv;
Alexander Couzens85f8fda2016-05-31 17:37:54 +0200625 uint8_t *kc = lle->llme->kc;
Harald Welted07b4f92010-06-30 23:07:59 +0200626 int rc, i;
627
628 if (lle->llme->algo == GPRS_ALGO_GEA0) {
629 LOGP(DLLC, LOGL_NOTICE, "encrypted frame for LLC that "
630 "has no KC/Algo! Dropping.\n");
631 return 0;
632 }
633
634 iv = gprs_cipher_gen_input_ui(iov_ui, lle->sapi, llhp.seq_tx,
635 lle->oc_ui_recv);
636 rc = gprs_cipher_run(cipher_out, crypt_len, lle->llme->algo,
637 kc, iv, GPRS_CIPH_MS2SGSN);
638 if (rc < 0) {
639 LOGP(DLLC, LOGL_ERROR, "Error decrypting frame: %d\n",
640 rc);
641 return rc;
642 }
643
644 /* XOR the cipher output with the information field + FCS */
645 for (i = 0; i < crypt_len; i++)
646 *(llhp.data + i) ^= cipher_out[i];
647 } else {
Max82040102016-07-06 11:59:18 +0200648 if (lle->llme->algo != GPRS_ALGO_GEA0 &&
649 lle->llme->cksn != GSM_KEY_SEQ_INVAL)
650 drop_cipherable = true;
Harald Welted07b4f92010-06-30 23:07:59 +0200651 }
652
653 /* We have to do the FCS check _after_ decryption */
Harald Welte1b8827a2010-06-30 23:15:57 +0200654 llhp.fcs_calc = gprs_llc_fcs((uint8_t *)lh, llhp.crc_length);
Harald Welted07b4f92010-06-30 23:07:59 +0200655 if (llhp.fcs != llhp.fcs_calc) {
656 LOGP(DLLC, LOGL_INFO, "Dropping frame with invalid FCS\n");
657 return -EIO;
658 }
659
Harald Welte10997d02010-05-03 12:28:12 +0200660 /* Update LLE's (BVCI, NSEI) tuple */
Harald Welte807a5d82010-06-01 11:53:01 +0200661 lle->llme->bvci = msgb_bvci(msg);
662 lle->llme->nsei = msgb_nsei(msg);
Harald Welte10997d02010-05-03 12:28:12 +0200663
Harald Welte1ae09c72010-05-13 19:22:55 +0200664 /* Receive and Process the actual LLC frame */
Harald Welte9b455bf2010-03-14 15:45:01 +0800665 rc = gprs_llc_hdr_rx(&llhp, lle);
Harald Welte1ae09c72010-05-13 19:22:55 +0200666 if (rc < 0)
667 return rc;
Harald Welte9b455bf2010-03-14 15:45:01 +0800668
Harald Welte1ae09c72010-05-13 19:22:55 +0200669 /* llhp.data is only set when we need to send LL_[UNIT]DATA_IND up */
Harald Welte22df4ac2015-08-16 15:23:32 +0200670 if (llhp.cmd == GPRS_LLC_UI && llhp.data && llhp.data_len) {
Harald Welte943c5bc2010-04-30 16:33:12 +0200671 msgb_gmmh(msg) = llhp.data;
Harald Welte9b455bf2010-03-14 15:45:01 +0800672 switch (llhp.sapi) {
673 case GPRS_SAPI_GMM:
Harald Welte1ae09c72010-05-13 19:22:55 +0200674 /* send LL_UNITDATA_IND to GMM */
Max82040102016-07-06 11:59:18 +0200675 rc = gsm0408_gprs_rcvmsg_gb(msg, lle->llme,
676 drop_cipherable);
Harald Weltea2665542010-05-02 09:28:11 +0200677 break;
Harald Weltea2665542010-05-02 09:28:11 +0200678 case GPRS_SAPI_SNDCP3:
679 case GPRS_SAPI_SNDCP5:
680 case GPRS_SAPI_SNDCP9:
681 case GPRS_SAPI_SNDCP11:
Harald Welteebabdea2010-06-01 18:28:10 +0200682 /* send LL_DATA_IND/LL_UNITDATA_IND to SNDCP */
683 rc = sndcp_llunitdata_ind(msg, lle, llhp.data, llhp.data_len);
684 break;
Harald Weltea2665542010-05-02 09:28:11 +0200685 case GPRS_SAPI_SMS:
686 /* FIXME */
Harald Welteebabdea2010-06-01 18:28:10 +0200687 case GPRS_SAPI_TOM2:
688 case GPRS_SAPI_TOM8:
689 /* FIXME: send LL_DATA_IND/LL_UNITDATA_IND to TOM */
Harald Weltea2665542010-05-02 09:28:11 +0200690 default:
Harald Weltec6ecafe2010-05-13 19:47:50 +0200691 LOGP(DLLC, LOGL_NOTICE, "Unsupported SAPI %u\n", llhp.sapi);
Harald Weltea2665542010-05-02 09:28:11 +0200692 rc = -EINVAL;
693 break;
Harald Welte9b455bf2010-03-14 15:45:01 +0800694 }
695 }
696
Harald Weltea2665542010-05-02 09:28:11 +0200697 return rc;
Harald Welte9b455bf2010-03-14 15:45:01 +0800698}
Harald Welte807a5d82010-06-01 11:53:01 +0200699
Max5aa51962016-07-06 11:33:04 +0200700/* Propagate crypto parameters MM -> LLME */
701void gprs_llme_copy_key(struct sgsn_mm_ctx *mm, struct gprs_llc_llme *llme)
702{
703 if (!mm)
704 return;
705 if (mm->ciph_algo != GPRS_ALGO_GEA0) {
706 llme->algo = mm->ciph_algo;
707 if (llme->cksn != mm->auth_triplet.key_seq &&
708 mm->auth_triplet.key_seq != GSM_KEY_SEQ_INVAL) {
709 memcpy(llme->kc, mm->auth_triplet.vec.kc,
710 gprs_cipher_key_length(mm->ciph_algo));
711 llme->cksn = mm->auth_triplet.key_seq;
712 }
713 } else
714 llme->cksn = GSM_KEY_SEQ_INVAL;
715}
716
Harald Welte807a5d82010-06-01 11:53:01 +0200717/* 04.64 Chapter 7.2.1.1 LLGMM-ASSIGN */
718int gprs_llgmm_assign(struct gprs_llc_llme *llme,
Max5aa51962016-07-06 11:33:04 +0200719 uint32_t old_tlli, uint32_t new_tlli)
Harald Welte807a5d82010-06-01 11:53:01 +0200720{
721 unsigned int i;
722
723 if (old_tlli == 0xffffffff && new_tlli != 0xffffffff) {
724 /* TLLI Assignment 8.3.1 */
725 /* New TLLI shall be assigned and used when (re)transmitting LLC frames */
726 /* If old TLLI != 0xffffffff was assigned to LLME, then TLLI
727 * old is unassigned. Only TLLI new shall be accepted when
728 * received from peer. */
Harald Welte875840c2010-07-01 11:54:31 +0200729 if (llme->old_tlli != 0xffffffff) {
730 llme->old_tlli = 0xffffffff;
731 llme->tlli = new_tlli;
732 } else {
733 /* If TLLI old == 0xffffffff was assigned to LLME, then this is
734 * TLLI assignmemt according to 8.3.1 */
735 llme->old_tlli = 0xffffffff;
736 llme->tlli = new_tlli;
737 llme->state = GPRS_LLMS_ASSIGNED;
738 /* 8.5.3.1 For all LLE's */
739 for (i = 0; i < ARRAY_SIZE(llme->lle); i++) {
740 struct gprs_llc_lle *l = &llme->lle[i];
741 l->vu_send = l->vu_recv = 0;
742 l->retrans_ctr = 0;
743 l->state = GPRS_LLES_ASSIGNED_ADM;
744 /* FIXME Set parameters according to table 9 */
745 }
Harald Welte807a5d82010-06-01 11:53:01 +0200746 }
747 } else if (old_tlli != 0xffffffff && new_tlli != 0xffffffff) {
748 /* TLLI Change 8.3.2 */
749 /* Both TLLI Old and TLLI New are assigned; use New when
Holger Hans Peter Freyther92aa6bb2013-07-28 20:13:01 +0200750 * (re)transmitting. Accept both Old and New on Rx */
Holger Hans Peter Freytheraa93bac2013-07-31 11:20:37 +0200751 llme->old_tlli = old_tlli;
Harald Welte807a5d82010-06-01 11:53:01 +0200752 llme->tlli = new_tlli;
753 llme->state = GPRS_LLMS_ASSIGNED;
754 } else if (old_tlli != 0xffffffff && new_tlli == 0xffffffff) {
755 /* TLLI Unassignment 8.3.3) */
756 llme->tlli = llme->old_tlli = 0;
757 llme->state = GPRS_LLMS_UNASSIGNED;
758 for (i = 0; i < ARRAY_SIZE(llme->lle); i++) {
759 struct gprs_llc_lle *l = &llme->lle[i];
760 l->state = GPRS_LLES_UNASSIGNED;
761 }
Harald Weltef7fef482010-06-28 22:18:26 +0200762 llme_free(llme);
Harald Welte807a5d82010-06-01 11:53:01 +0200763 } else
764 return -EINVAL;
765
766 return 0;
767}
Harald Welte496aee42010-06-30 19:59:55 +0200768
Max39550252016-06-28 17:39:20 +0200769/* TLLI unassignment */
770int gprs_llgmm_unassign(struct gprs_llc_llme *llme)
771{
Max5aa51962016-07-06 11:33:04 +0200772 return gprs_llgmm_assign(llme, llme->tlli, 0xffffffff);
Max39550252016-06-28 17:39:20 +0200773}
774
Harald Welte0c1a3032011-10-16 18:49:05 +0200775/* Chapter 7.2.1.2 LLGMM-RESET.req */
776int gprs_llgmm_reset(struct gprs_llc_llme *llme)
777{
778 struct msgb *msg = msgb_alloc_headroom(4096, 1024, "LLC_XID");
Jacob Erlbeck25ad52c2014-09-11 14:20:53 +0200779 struct gprs_llc_lle *lle = &llme->lle[1];
Harald Welte0c1a3032011-10-16 18:49:05 +0200780
Maxb997f842016-07-06 15:57:01 +0200781 if (RAND_bytes((uint8_t *) &llme->iov_ui, 4) != 1) {
782 LOGP(DLLC, LOGL_NOTICE, "RAND_bytes failed for LLC XID reset, "
783 "falling back to rand()\n");
784 llme->iov_ui = rand();
785 }
786
Harald Welte0c1a3032011-10-16 18:49:05 +0200787 /* First XID component must be RESET */
788 msgb_put_xid_par(msg, GPRS_LLC_XID_T_RESET, 0, NULL);
789 /* randomly select new IOV-UI */
Maxb997f842016-07-06 15:57:01 +0200790 msgb_put_xid_par(msg, GPRS_LLC_XID_T_IOV_UI, 4, (uint8_t *) &llme->iov_ui);
Harald Welte0c1a3032011-10-16 18:49:05 +0200791
Jacob Erlbeck25ad52c2014-09-11 14:20:53 +0200792 /* Reset some of the LLC parameters. See GSM 04.64, 8.5.3.1 */
793 lle->vu_recv = 0;
794 lle->vu_send = 0;
795 lle->oc_ui_send = 0;
796 lle->oc_ui_recv = 0;
797
Harald Welte0c1a3032011-10-16 18:49:05 +0200798 /* FIXME: Start T200, wait for XID response */
Jacob Erlbeck25ad52c2014-09-11 14:20:53 +0200799 return gprs_llc_tx_xid(lle, msg, 1);
Harald Welte0c1a3032011-10-16 18:49:05 +0200800}
801
Maxb997f842016-07-06 15:57:01 +0200802int gprs_llgmm_reset_oldmsg(struct msgb* oldmsg, uint8_t sapi,
803 struct gprs_llc_llme *llme)
Jacob Erlbeck78ecaf02014-09-05 14:32:36 +0200804{
805 struct msgb *msg = msgb_alloc_headroom(4096, 1024, "LLC_XID");
Maxb997f842016-07-06 15:57:01 +0200806
807 if (RAND_bytes((uint8_t *) &llme->iov_ui, 4) != 1) {
808 LOGP(DLLC, LOGL_NOTICE, "RAND_bytes failed for LLC XID reset, "
809 "falling back to rand()\n");
810 llme->iov_ui = rand();
811 }
Jacob Erlbeck78ecaf02014-09-05 14:32:36 +0200812
813 /* First XID component must be RESET */
814 msgb_put_xid_par(msg, GPRS_LLC_XID_T_RESET, 0, NULL);
815 /* randomly select new IOV-UI */
Maxb997f842016-07-06 15:57:01 +0200816 msgb_put_xid_par(msg, GPRS_LLC_XID_T_IOV_UI, 4, (uint8_t *) &llme->iov_ui);
Jacob Erlbeck78ecaf02014-09-05 14:32:36 +0200817
818 /* FIXME: Start T200, wait for XID response */
819
820 msgb_tlli(msg) = msgb_tlli(oldmsg);
821 msgb_bvci(msg) = msgb_bvci(oldmsg);
822 msgb_nsei(msg) = msgb_nsei(oldmsg);
823
824 return gprs_llc_tx_u(msg, sapi, 1, GPRS_LLC_U_XID, 1);
825}
826
Harald Welte496aee42010-06-30 19:59:55 +0200827int gprs_llc_init(const char *cipher_plugin_path)
828{
829 return gprs_cipher_load(cipher_plugin_path);
830}