summaryrefslogtreecommitdiffstats
path: root/lib/src/protocol/tcp.c
blob: 8097cfd127a76b0b123e25a3e30b3e7aca15ccfb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
/*
 * Copyright (c) 2021 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <string.h>
#include <hicn/protocol/tcp.h>
#include <hicn/error.h>
#include <hicn/ops.h>

#define TCP_DEFAULT_SRC_PORT	    0x8000
#define TCP_DEFAULT_DST_PORT	    0x0080
#define TCP_DEFAULT_WINDOW_SIZE	    0 // In [2, 65535]
#define TCP_DEFAULT_HLEN	    20
#define TCP_DEFAULT_DATA_OFFSET_RES (TCP_DEFAULT_HLEN >> 2) << 4
#define TCP_DEFAULT_CWR		    0
#define TCP_DEFAULT_ECE		    0
#define TCP_DEFAULT_URG		    0
#define TCP_DEFAULT_ACK		    0
#define TCP_DEFAULT_PSH		    0
#define TCP_DEFAULT_RST		    0
#define TCP_DEFAULT_SYN		    1
#define TCP_DEFAULT_FIN		    0

DECLARE_get_interest_locator (tcp, UNEXPECTED);
DECLARE_set_interest_locator (tcp, UNEXPECTED);
DECLARE_get_interest_name (tcp, UNEXPECTED);
DECLARE_set_interest_name (tcp, UNEXPECTED);
DECLARE_get_data_locator (tcp, UNEXPECTED);
DECLARE_set_data_locator (tcp, UNEXPECTED);
DECLARE_get_data_name (tcp, UNEXPECTED);
DECLARE_set_data_name (tcp, UNEXPECTED);
DECLARE_get_length (tcp, UNEXPECTED);
DECLARE_get_payload_length (tcp, UNEXPECTED);
DECLARE_set_payload_length (tcp, UNEXPECTED);

static inline void
reset_for_hash (hicn_protocol_t *h)
{
  h->tcp.sport = 0;
  h->tcp.dport = 0;
  h->tcp.seq_ack = 0;
  h->tcp.data_offset_and_reserved = 0;
  h->tcp.flags = 0;
  h->tcp.window = 0;
  h->tcp.csum = 0;
  h->tcp.urg_ptr = 0;
}

static inline int
check_tcp_checksum (u16 csum)
{
  /* As per RFC1624
   * In one's complement, there are two representations of zero: the all
   * zero and the all one bit values, often referred to as +0 and -0.
   * One's complement addition of non-zero inputs can produce -0 as a
   * result, but never +0.  Since there is guaranteed to be at least one
   * non-zero field in the IP header, and the checksum field in the
   * protocol header is the complement of the sum, the checksum field can
   * never contain ~(+0), which is -0 (0xFFFF).  It can, however, contain
   * ~(-0), which is +0 (0x0000).
   */
  if (csum == 0xffff)
    {
      /* Invalid checksum, no need to compute incremental update */
      return HICN_LIB_ERROR_REWRITE_CKSUM_REQUIRED;
    }

  return HICN_LIB_ERROR_NONE;
}

int
tcp_init_packet_header (hicn_type_t type, hicn_protocol_t *h)
{
  h->tcp = (_tcp_header_t){
    .sport = htons (TCP_DEFAULT_SRC_PORT),
    .dport = htons (TCP_DEFAULT_DST_PORT),
    .seq = 0,
    .seq_ack = 0,
    .data_offset_and_reserved = TCP_DEFAULT_DATA_OFFSET_RES,
    .flags = TCP_DEFAULT_CWR << 7 | TCP_DEFAULT_ECE << 6 |
	     TCP_DEFAULT_URG << 5 | TCP_DEFAULT_ACK << 4 |
	     TCP_DEFAULT_PSH << 3 | TCP_DEFAULT_RST << 2 |
	     TCP_DEFAULT_SYN << 1 | TCP_DEFAULT_FIN << 0,
    .window = htons (TCP_DEFAULT_WINDOW_SIZE),
    .csum = 0xffff,
    .urg_ptr = 65000,
  };

  uint8_t ah_flag = type.l2 == IPPROTO_AH ? AH_FLAG : 0;

  h->tcp.flags |= ah_flag;

  return CHILD_OPS (init_packet_header, type, h);
}

int
tcp_is_interest (hicn_type_t type, const hicn_protocol_t *h, int *is_interest)
{
  *is_interest = (h->tcp.flags & HICN_TCP_FLAG_ECE) == 0;
  return HICN_LIB_ERROR_NONE;
}

int
tcp_mark_packet_as_interest (hicn_type_t type, hicn_protocol_t *h)
{
  h->tcp.flags &= ~HICN_TCP_FLAG_ECE;
  return HICN_LIB_ERROR_NONE;
}

int
tcp_get_interest_name_suffix (hicn_type_t type, const hicn_protocol_t *h,
			      hicn_name_suffix_t *suffix)
{
  *suffix = ntohl (h->tcp.name_suffix);
  return HICN_LIB_ERROR_NONE;
}

int
tcp_set_interest_name_suffix (hicn_type_t type, hicn_protocol_t *h,
			      const hicn_name_suffix_t *suffix)
{
  int rc = tcp_mark_packet_as_interest (type, h);
  if (rc)
    return rc;

  h->tcp.name_suffix = htonl (*suffix);

  return HICN_LIB_ERROR_NONE;
}

int
tcp_mark_packet_as_data (hicn_type_t type, hicn_protocol_t *h)
{
  h->tcp.flags |= HICN_TCP_FLAG_ECE;
  return HICN_LIB_ERROR_NONE;
}

int
tcp_reset_interest_for_hash (hicn_type_t type, hicn_protocol_t *h)
{
  reset_for_hash (h);
  return CHILD_OPS (reset_interest_for_hash, type, h);
}

int
tcp_get_data_name_suffix (hicn_type_t type, const hicn_protocol_t *h,
			  hicn_name_suffix_t *suffix)
{
  *suffix = ntohl (h->tcp.name_suffix);
  return HICN_LIB_ERROR_NONE;
}

int
tcp_set_data_name_suffix (hicn_type_t type, hicn_protocol_t *h,
			  const hicn_name_suffix_t *suffix)
{
  int rc = tcp_mark_packet_as_data (type, h);
  if (rc)
    return rc;

  h->tcp.name_suffix = htonl (*suffix);
  return HICN_LIB_ERROR_NONE;
}

int
tcp_get_data_pathlabel (hicn_type_t type, const hicn_protocol_t *h,
			u32 *pathlabel)
{
  *pathlabel = h->tcp.seq_ack;
  return HICN_LIB_ERROR_NONE;
}

int
tcp_set_data_pathlabel (hicn_type_t type, hicn_protocol_t *h,
			const u32 pathlabel)
{
  h->tcp.seq_ack = pathlabel;
  return HICN_LIB_ERROR_NONE;
}

int
tcp_update_data_pathlabel (hicn_type_t type, hicn_protocol_t *h,
			   const hicn_faceid_t face_id)
{
  hicn_pathlabel_t pl =
    (hicn_pathlabel_t) (h->tcp.seq_ack >> (32 - HICN_PATH_LABEL_SIZE));

  hicn_pathlabel_t new_pl;

  update_pathlabel (pl, face_id, &new_pl);
  h->tcp.seq_ack = (new_pl << (32 - HICN_PATH_LABEL_SIZE));

  return HICN_LIB_ERROR_NONE;
}

int
tcp_reset_data_for_hash (hicn_type_t type, hicn_protocol_t *h)
{
  reset_for_hash (h);
  return CHILD_OPS (reset_data_for_hash, type, h);
}

int
tcp_get_lifetime (hicn_type_t type, const hicn_protocol_t *h,
		  hicn_lifetime_t *lifetime)
{
  *lifetime = ntohs (h->tcp.urg_ptr)
	      << (h->tcp.data_offset_and_reserved & 0xF);
  return HICN_LIB_ERROR_NONE;
}

int
tcp_set_lifetime (hicn_type_t type, hicn_protocol_t *h,
		  const hicn_lifetime_t lifetime)
{
  u8 multiplier = 0;
  u32 lifetime_scaled = lifetime;

  if (PREDICT_FALSE (lifetime >= HICN_MAX_LIFETIME))
    {
      h->tcp.urg_ptr = htons (HICN_MAX_LIFETIME_SCALED);
      h->tcp.data_offset_and_reserved =
	(h->tcp.data_offset_and_reserved & ~0x0F) |
	HICN_MAX_LIFETIME_MULTIPLIER;
      return HICN_LIB_ERROR_NONE;
    }

  while (lifetime_scaled > HICN_MAX_LIFETIME_SCALED &&
	 multiplier <= HICN_MAX_LIFETIME_MULTIPLIER)
    {
      multiplier++;
      lifetime_scaled = lifetime_scaled >> 1;
    }

  h->tcp.urg_ptr = htons (lifetime_scaled);
  h->tcp.data_offset_and_reserved =
    (h->tcp.data_offset_and_reserved & ~0x0F) | multiplier;

  return HICN_LIB_ERROR_NONE;
}

int
tcp_update_checksums (hicn_type_t type, hicn_protocol_t *h, u16 partial_csum,
		      size_t payload_length)
{
  h->tcp.csum = 0;

  if (PREDICT_TRUE (partial_csum != 0))
    {
      partial_csum = ~partial_csum;
    }

  h->tcp.csum = csum (h, TCP_HDRLEN + payload_length, partial_csum);

  return CHILD_OPS (update_checksums, type, h, 0, payload_length);
}

int
tcp_verify_checksums (hicn_type_t type, hicn_protocol_t *h, u16 partial_csum,
		      size_t payload_length)
{
  if (PREDICT_TRUE (partial_csum != 0))
    {
      partial_csum = ~partial_csum;
    }

  if (csum (h, TCP_HDRLEN + payload_length, partial_csum) != 0)
    return HICN_LIB_ERROR_CORRUPTED_PACKET;
  return CHILD_OPS (verify_checksums, type, h, 0, payload_length);
}

#define TCP_OFFSET_MASK		       13
#define TCP_OFFSET_DATA_OFFSET	       12
#define TCP_OFFSET_IN_BITS_DATA_OFFSET 0
#define TCP_OFFSET_IN_BITS_RESERVED    4
#define TCP_OFFSET_IN_BITS_NS	       7

#define TCP_DEFAULT_SRC_PORT	0x8000
#define TCP_DEFAULT_DST_PORT	0x0080
#define TCP_DEFAULT_WINDOW_SIZE 0 // In [2, 65535]
#define TCP_DEFAULT_DATA_OFFSET                                               \
  5 // Size of the TCP header in words (= 4 bytes). Must be greater or equal
    // than 5.
#define TCP_DEFAULT_CWR 0
#define TCP_DEFAULT_ECE 0
#define TCP_DEFAULT_URG 0
#define TCP_DEFAULT_ACK 0
#define TCP_DEFAULT_PSH 0
#define TCP_DEFAULT_RST 0
#define TCP_DEFAULT_SYN 1
#define TCP_DEFAULT_FIN 0

int
tcp_rewrite_interest (hicn_type_t type, hicn_protocol_t *h,
		      const ip_address_t *addr_new, ip_address_t *addr_old)
{
  u16 *tcp_checksum = &(h->tcp.csum);
  int ret = check_tcp_checksum (*tcp_checksum);

  if (ret)
    {
      return ret;
    }

  /*
   * Padding fields are set to zero so we can apply checksum on the
   * whole struct by interpreting it as IPv6 in all cases
   *
   * v4 code would be:
   * csum = ip_csum_sub_even (*tcp_checksum, h->ipv4.saddr.as_u32);
   * csum = ip_csum_add_even (csum, h->ipv4.saddr.as_u32);
   */
  ip_csum_t csum =
    ip_csum_sub_even (*tcp_checksum, (ip_csum_t) (h->ipv6.saddr.as_u64[0]));
  csum = ip_csum_sub_even (csum, (ip_csum_t) (h->ipv6.saddr.as_u64[1]));
  csum = ip_csum_add_even (csum, (ip_csum_t) (h->ipv6.saddr.as_u64[0]));
  csum = ip_csum_add_even (csum, (ip_csum_t) (h->ipv6.saddr.as_u64[1]));

  *tcp_checksum = ip_csum_fold (csum);

  return HICN_LIB_ERROR_NONE;
}

int
tcp_rewrite_data (hicn_type_t type, hicn_protocol_t *h,
		  const ip_address_t *addr_new, ip_address_t *addr_old,
		  const hicn_faceid_t face_id, u8 reset_pl)
{

  u16 *tcp_checksum = &(h->tcp.csum);
  int ret = check_tcp_checksum (*tcp_checksum);

  /*
   * update path label
   */
  u16 old_pl = h->tcp.seq_ack;
  if (reset_pl)
    h->tcp.seq_ack = 0;
  tcp_update_data_pathlabel (type, h, face_id);

  if (ret)
    {
      return ret;
    }

  /*
   * Padding fields are set to zero so we can apply checksum on the
   * whole struct by interpreting it as IPv6 in all cases
   *
   * v4 code would be:
   * csum = ip_csum_sub_even (*tcp_checksum, h->ipv4.saddr.as_u32);
   * csum = ip_csum_add_even (csum, h->ipv4.saddr.as_u32);
   */
  ip_csum_t csum =
    ip_csum_sub_even (*tcp_checksum, (ip_csum_t) (addr_old->v6.as_u64[0]));
  csum =
    ip_csum_sub_even (*tcp_checksum, (ip_csum_t) (addr_old->v6.as_u64[1]));
  csum = ip_csum_add_even (csum, (ip_csum_t) (addr_new->v6.as_u64[0]));
  csum = ip_csum_add_even (csum, (ip_csum_t) (addr_new->v6.as_u64[1]));

  csum = ip_csum_sub_even (csum, old_pl);
  csum = ip_csum_add_even (csum, h->tcp.seq_ack);

  *tcp_checksum = ip_csum_fold (csum);

  return HICN_LIB_ERROR_NONE;
}

int
tcp_get_current_header_length (hicn_type_t type, const hicn_protocol_t *h,
			       size_t *header_length)
{
  *header_length = TCP_HDRLEN;
  return HICN_LIB_ERROR_NONE;
}

int
tcp_get_header_length (hicn_type_t type, const hicn_protocol_t *h,
		       size_t *header_length)
{
  size_t child_header_length = 0;
  int rc = CHILD_OPS (get_header_length, type, h, &child_header_length);
  if (rc < 0)
    return rc;

  *header_length = TCP_HDRLEN + child_header_length;
  return HICN_LIB_ERROR_NONE;
}

int
tcp_get_signature_size (hicn_type_t type, const hicn_protocol_t *h,
			size_t *signature_size)
{
  return CHILD_OPS (get_signature_size, type, h, signature_size);
}

int
tcp_set_signature_size (hicn_type_t type, hicn_protocol_t *h,
			size_t signature_size)
{
  return CHILD_OPS (set_signature_size, type, h, signature_size);
}

int
tcp_set_signature_padding (hicn_type_t type, hicn_protocol_t *h,
			   size_t padding)
{
  return CHILD_OPS (set_signature_padding, type, h, padding);
}

int
tcp_get_signature_padding (hicn_type_t type, const hicn_protocol_t *h,
			   size_t *padding)
{
  return CHILD_OPS (get_signature_padding, type, h, padding);
}

int
tcp_set_signature_timestamp (hicn_type_t type, hicn_protocol_t *h,
			     uint64_t signature_timestamp)
{
  return CHILD_OPS (set_signature_timestamp, type, h, signature_timestamp);
}

int
tcp_get_signature_timestamp (hicn_type_t type, const hicn_protocol_t *h,
			     uint64_t *signature_timestamp)
{
  return CHILD_OPS (get_signature_timestamp, type, h, signature_timestamp);
}

int
tcp_set_validation_algorithm (hicn_type_t type, hicn_protocol_t *h,
			      uint8_t validation_algorithm)
{
  return CHILD_OPS (set_validation_algorithm, type, h, validation_algorithm);
}

int
tcp_get_validation_algorithm (hicn_type_t type, const hicn_protocol_t *h,
			      uint8_t *validation_algorithm)
{
  return CHILD_OPS (get_validation_algorithm, type, h, validation_algorithm);
}

int
tcp_set_key_id (hicn_type_t type, hicn_protocol_t *h, uint8_t *key_id)
{
  return CHILD_OPS (set_key_id, type, h, key_id);
}

int
tcp_get_key_id (hicn_type_t type, hicn_protocol_t *h, uint8_t **key_id,
		uint8_t *key_id_size)
{
  return CHILD_OPS (get_key_id, type, h, key_id, key_id_size);
}

int
tcp_get_signature (hicn_type_t type, hicn_protocol_t *h, uint8_t **signature)
{
  return CHILD_OPS (get_signature, type, h, signature);
}

int
tcp_get_payload_type (hicn_type_t type, const hicn_protocol_t *h,
		      hicn_payload_type_t *payload_type)
{
  *payload_type = ((h->tcp.flags & HICN_TCP_FLAG_URG) == HICN_TCP_FLAG_URG);
  return HICN_LIB_ERROR_NONE;
}

int
tcp_set_payload_type (hicn_type_t type, hicn_protocol_t *h,
		      hicn_payload_type_t payload_type)
{
  if (payload_type != HPT_DATA && payload_type != HPT_MANIFEST)
    return HICN_LIB_ERROR_INVALID_PARAMETER;

  if (payload_type)
    h->tcp.flags |= HICN_TCP_FLAG_URG;
  else
    h->tcp.flags &= ~HICN_TCP_FLAG_URG;

  return HICN_LIB_ERROR_NONE;
}

int
tcp_is_last_data (hicn_type_t type, const hicn_protocol_t *h, int *is_last)
{
  *is_last = (h->tcp.flags & HICN_TCP_FLAG_RST) == HICN_TCP_FLAG_RST;
  return HICN_LIB_ERROR_NONE;
}

int
tcp_set_last_data (hicn_type_t type, hicn_protocol_t *h)
{
  h->tcp.flags |= HICN_TCP_FLAG_RST;
  return HICN_LIB_ERROR_NONE;
}

DECLARE_HICN_OPS (tcp);

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */