aboutsummaryrefslogtreecommitdiffstats
path: root/libtransport/src/core/packet.cc
blob: 817f8de66ea95e8b00c209074712f671366cfcdc (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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
/*
 * Copyright (c) 2017-2019 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 <hicn/transport/core/packet.h>
#include <hicn/transport/errors/malformed_packet_exception.h>
#include <hicn/transport/utils/hash.h>
#include <hicn/transport/utils/log.h>

extern "C" {
#ifndef _WIN32
TRANSPORT_CLANG_DISABLE_WARNING("-Wextern-c-compat")
#endif
#include <hicn/error.h>
}

namespace transport {

namespace core {

const core::Name Packet::base_name("0::0|0");

Packet::Packet(Format format)
    : packet_(utils::MemBuf::create(getHeaderSizeFromFormat(format, 256))
                  .release()),
      packet_start_(reinterpret_cast<hicn_header_t *>(packet_->writableData())),
      header_head_(packet_.get()),
      payload_head_(nullptr),
      format_(format) {
  if (hicn_packet_init_header(format, packet_start_) < 0) {
    throw errors::RuntimeException("Unexpected error initializing the packet.");
  }

  packet_->append(getHeaderSizeFromFormat(format_));
}

Packet::Packet(MemBufPtr &&buffer)
    : packet_(std::move(buffer)),
      packet_start_(reinterpret_cast<hicn_header_t *>(packet_->writableData())),
      header_head_(packet_.get()),
      payload_head_(nullptr),
      format_(getFormatFromBuffer(packet_->writableData())) {}

Packet::Packet(const uint8_t *buffer, std::size_t size)
    : Packet(MemBufPtr(utils::MemBuf::copyBuffer(buffer, size).release())) {}

Packet::Packet(Packet &&other)
    : packet_(std::move(other.packet_)),
      packet_start_(other.packet_start_),
      header_head_(other.header_head_),
      payload_head_(other.payload_head_),
      format_(other.format_) {
  other.packet_start_ = nullptr;
  other.header_head_ = nullptr;
  other.payload_head_ = nullptr;
  other.format_ = HF_UNSPEC;
}

Packet::~Packet() {}

std::size_t Packet::getHeaderSizeFromFormat(Format format,
                                            size_t signature_size) {
  std::size_t header_length;
  hicn_packet_get_header_length_from_format(format, &header_length);
  int is_ah = _is_ah(format);
  return is_ah * (header_length + signature_size) + (!is_ah) * header_length;
}

std::size_t Packet::getHeaderSizeFromBuffer(Format format,
                                            const uint8_t *buffer) {
  size_t header_length;
  if (hicn_packet_get_header_length(format, (hicn_header_t *)buffer,
                                    &header_length) < 0) {
    throw errors::MalformedPacketException();
  }
  return header_length;
}

bool Packet::isInterest(const uint8_t *buffer) {
  bool is_interest = false;

  if (TRANSPORT_EXPECT_FALSE(hicn_packet_test_ece((const hicn_header_t *)buffer,
                                                  &is_interest) < 0)) {
    throw errors::RuntimeException(
        "Impossible to retrieve ece flag from packet");
  }

  return !is_interest;
}

Packet::Format Packet::getFormatFromBuffer(const uint8_t *buffer) {
  Format format = HF_UNSPEC;

  if (TRANSPORT_EXPECT_FALSE(
          hicn_packet_get_format((const hicn_header_t *)buffer, &format) < 0)) {
    throw errors::MalformedPacketException();
  }

  return format;
}

std::size_t Packet::getPayloadSizeFromBuffer(Format format,
                                             const uint8_t *buffer) {
  std::size_t payload_length;
  if (TRANSPORT_EXPECT_FALSE(
          hicn_packet_get_payload_length(format, (hicn_header_t *)buffer,
                                         &payload_length) < 0)) {
    throw errors::MalformedPacketException();
  }

  return payload_length;
}

void Packet::replace(MemBufPtr &&buffer) {
  packet_ = std::move(buffer);
  packet_start_ = reinterpret_cast<hicn_header_t *>(packet_->writableData());
  header_head_ = packet_.get();
  payload_head_ = nullptr;
  format_ = getFormatFromBuffer(reinterpret_cast<uint8_t *>(packet_start_));
}

std::size_t Packet::payloadSize() const {
  return getPayloadSizeFromBuffer(format_,
                                  reinterpret_cast<uint8_t *>(packet_start_));
}

std::size_t Packet::headerSize() const {
  return getHeaderSizeFromBuffer(format_,
                                 reinterpret_cast<uint8_t *>(packet_start_));
}

Packet &Packet::appendPayload(std::unique_ptr<utils::MemBuf> &&payload) {
  separateHeaderPayload();

  if (!payload_head_) {
    payload_head_ = payload.get();
  }

  header_head_->prependChain(std::move(payload));
  updateLength();
  return *this;
}

Packet &Packet::appendPayload(const uint8_t *buffer, std::size_t length) {
  return appendPayload(utils::MemBuf::copyBuffer(buffer, length));
}

Packet &Packet::appendHeader(std::unique_ptr<utils::MemBuf> &&header) {
  separateHeaderPayload();

  if (!payload_head_) {
    header_head_->prependChain(std::move(header));
  } else {
    payload_head_->prependChain(std::move(header));
  }

  updateLength();
  return *this;
}

Packet &Packet::appendHeader(const uint8_t *buffer, std::size_t length) {
  return appendHeader(utils::MemBuf::copyBuffer(buffer, length));
}

std::unique_ptr<utils::MemBuf> Packet::getPayload() const {
  const_cast<Packet *>(this)->separateHeaderPayload();

  // Hopefully the payload is contiguous
  if (TRANSPORT_EXPECT_FALSE(payload_head_ &&
                             payload_head_->next() != header_head_)) {
    payload_head_->gather(payloadSize());
  }

  return payload_head_->cloneOne();
}

Packet &Packet::updateLength(std::size_t length) {
  std::size_t total_length = length;

  for (utils::MemBuf *current = payload_head_;
       current && current != header_head_; current = current->next()) {
    total_length += current->length();
  }

  if (hicn_packet_set_payload_length(format_, packet_start_, total_length) <
      0) {
    throw errors::RuntimeException("Error setting the packet payload.");
  }

  return *this;
}

PayloadType Packet::getPayloadType() const {
  hicn_payload_type_t ret = HPT_UNSPEC;

  if (hicn_packet_get_payload_type(packet_start_, &ret) < 0) {
    throw errors::RuntimeException("Impossible to retrieve payload type.");
  }

  return PayloadType(ret);
}

Packet &Packet::setPayloadType(PayloadType payload_type) {
  if (hicn_packet_set_payload_type(packet_start_,
                                   hicn_payload_type_t(payload_type)) < 0) {
    throw errors::RuntimeException("Error setting payload type of the packet.");
  }

  return *this;
}

Packet::Format Packet::getFormat() const {
  if (format_ == HF_UNSPEC) {
    if (hicn_packet_get_format(packet_start_, &format_) < 0) {
      throw errors::MalformedPacketException();
    }
  }

  return format_;
}

const std::shared_ptr<utils::MemBuf> Packet::acquireMemBufReference() const {
  return packet_;
}

void Packet::dump() const {
  const_cast<Packet *>(this)->separateHeaderPayload();

  std::cout << "HEADER -- Length: " << headerSize() << std::endl;
  hicn_packet_dump((uint8_t *)header_head_->data(), headerSize());

  std::cout << std::endl << "PAYLOAD -- Length: " << payloadSize() << std::endl;
  for (utils::MemBuf *current = payload_head_;
       current && current != header_head_; current = current->next()) {
    std::cout << "MemBuf Length: " << current->length() << std::endl;
    hicn_packet_dump((uint8_t *)current->data(), current->length());
  }
}

void Packet::setSignatureSize(std::size_t size_bytes) {
  int ret = hicn_packet_set_signature_size(format_, packet_start_, size_bytes);

  if (ret < 0) {
    throw errors::RuntimeException("Packet without Authentication Header.");
  }

  packet_->append(size_bytes);
  updateLength();
}

uint8_t *Packet::getSignature() const {
  uint8_t *signature;
  int ret = hicn_packet_get_signature(format_, packet_start_, &signature);

  if (ret < 0) {
    throw errors::RuntimeException("Packet without Authentication Header.");
  }

  return signature;
}

std::size_t Packet::getSignatureSize() const {
  size_t size_bytes;
  int ret = hicn_packet_get_signature_size(format_, packet_start_, &size_bytes);

  if (ret < 0) {
    throw errors::RuntimeException("Packet without Authentication Header.");
  }

  return size_bytes;
}

void Packet::setSignatureTimestamp(const uint64_t &timestamp) {
  int ret =
      hicn_packet_set_signature_timestamp(format_, packet_start_, timestamp);

  if (ret < 0) {
    throw errors::RuntimeException("Error setting the signature timestamp.");
  }
}

uint64_t Packet::getSignatureTimestamp() const {
  uint64_t return_value;
  int ret = hicn_packet_get_signature_timestamp(format_, packet_start_,
                                                &return_value);

  if (ret < 0) {
    throw errors::RuntimeException("Error getting the signature timestamp.");
  }

  return return_value;
}

void Packet::setValidationAlgorithm(
    const utils::CryptoSuite &validation_algorithm) {
  int ret = hicn_packet_set_validation_algorithm(format_, packet_start_,
                                                 uint8_t(validation_algorithm));

  if (ret < 0) {
    throw errors::RuntimeException("Error setting the validation algorithm.");
  }
}

utils::CryptoSuite Packet::getValidationAlgorithm() const {
  uint8_t return_value;
  int ret = hicn_packet_get_validation_algorithm(format_, packet_start_,
                                                 &return_value);

  if (ret < 0) {
    throw errors::RuntimeException("Error getting the validation algorithm.");
  }

  return utils::CryptoSuite(return_value);
}

void Packet::setKeyId(const utils::KeyId &key_id) {
  int ret = hicn_packet_set_key_id(format_, packet_start_, key_id.first);

  if (ret < 0) {
    throw errors::RuntimeException("Error setting the key id.");
  }
}

utils::KeyId Packet::getKeyId() const {
  utils::KeyId return_value;
  int ret = hicn_packet_get_key_id(format_, packet_start_, &return_value.first,
                                   &return_value.second);

  if (ret < 0) {
    throw errors::RuntimeException("Error getting the validation algorithm.");
  }

  return return_value;
}

utils::CryptoHash Packet::computeDigest(HashAlgorithm algorithm) const {
  utils::CryptoHasher hasher(static_cast<utils::CryptoHashType>(algorithm));
  hasher.init();

  // Copy IP+TCP/ICMP header before zeroing them
  hicn_header_t header_copy;

  hicn_packet_copy_header(format_, packet_start_, &header_copy, false);

  const_cast<Packet *>(this)->resetForHash();

  auto current = header_head_;
  do {
    hasher.updateBytes(current->data(), current->length());
    current = current->next();
  } while (current != header_head_);

  hicn_packet_copy_header(format_, &header_copy, packet_start_, false);

  return hasher.finalize();
}

void Packet::setChecksum() {
  uint16_t partial_csum = 0;

  for (utils::MemBuf *current = header_head_->next();
       current && current != header_head_; current = current->next()) {
    if (partial_csum != 0) {
      partial_csum = ~partial_csum;
    }
    partial_csum = csum(current->data(), current->length(), partial_csum);
  }
  if (hicn_packet_compute_header_checksum(format_, packet_start_,
                                          partial_csum) < 0) {
    throw errors::MalformedPacketException();
  }
}

bool Packet::checkIntegrity() const {
  if (hicn_packet_check_integrity(format_, packet_start_) < 0) {
    return false;
  }

  return true;
}

Packet &Packet::setSyn() {
  if (hicn_packet_set_syn(packet_start_) < 0) {
    throw errors::RuntimeException("Error setting syn bit in the packet.");
  }

  return *this;
}

Packet &Packet::resetSyn() {
  if (hicn_packet_reset_syn(packet_start_) < 0) {
    throw errors::RuntimeException("Error resetting syn bit in the packet.");
  }

  return *this;
}

bool Packet::testSyn() const {
  bool res = false;
  if (hicn_packet_test_syn(packet_start_, &res) < 0) {
    throw errors::RuntimeException("Error testing syn bit in the packet.");
  }

  return res;
}

Packet &Packet::setAck() {
  if (hicn_packet_set_ack(packet_start_) < 0) {
    throw errors::RuntimeException("Error setting ack bit in the packet.");
  }

  return *this;
}

Packet &Packet::resetAck() {
  if (hicn_packet_reset_ack(packet_start_) < 0) {
    throw errors::RuntimeException("Error resetting ack bit in the packet.");
  }

  return *this;
}

bool Packet::testAck() const {
  bool res = false;
  if (hicn_packet_test_ack(packet_start_, &res) < 0) {
    throw errors::RuntimeException("Error testing ack bit in the packet.");
  }

  return res;
}

Packet &Packet::setRst() {
  if (hicn_packet_set_rst(packet_start_) < 0) {
    throw errors::RuntimeException("Error setting rst bit in the packet.");
  }

  return *this;
}

Packet &Packet::resetRst() {
  if (hicn_packet_reset_rst(packet_start_) < 0) {
    throw errors::RuntimeException("Error resetting rst bit in the packet.");
  }

  return *this;
}

bool Packet::testRst() const {
  bool res = false;
  if (hicn_packet_test_rst(packet_start_, &res) < 0) {
    throw errors::RuntimeException("Error testing rst bit in the packet.");
  }

  return res;
}

Packet &Packet::setFin() {
  if (hicn_packet_set_fin(packet_start_) < 0) {
    throw errors::RuntimeException("Error setting fin bit in the packet.");
  }

  return *this;
}

Packet &Packet::resetFin() {
  if (hicn_packet_reset_fin(packet_start_) < 0) {
    throw errors::RuntimeException("Error resetting fin bit in the packet.");
  }

  return *this;
}

bool Packet::testFin() const {
  bool res = false;
  if (hicn_packet_test_fin(packet_start_, &res) < 0) {
    throw errors::RuntimeException("Error testing fin bit in the packet.");
  }

  return res;
}

Packet &Packet::resetFlags() {
  resetSyn();
  resetAck();
  resetRst();
  resetFin();

  return *this;
}

std::string Packet::printFlags() const {
  std::string flags = "";
  if (testSyn()) {
    flags += "S";
  }
  if (testAck()) {
    flags += "A";
  }
  if (testRst()) {
    flags += "R";
  }
  if (testFin()) {
    flags += "F";
  }
  return flags;
}

Packet &Packet::setSrcPort(uint16_t srcPort) {
  if (hicn_packet_set_src_port(packet_start_, srcPort) < 0) {
    throw errors::RuntimeException("Error setting source port in the packet.");
  }

  return *this;
}

Packet &Packet::setDstPort(uint16_t dstPort) {
  if (hicn_packet_set_dst_port(packet_start_, dstPort) < 0) {
    throw errors::RuntimeException(
        "Error setting destination port in the packet.");
  }

  return *this;
}

uint16_t Packet::getSrcPort() const {
  uint16_t port = 0;

  if (hicn_packet_get_src_port(packet_start_, &port) < 0) {
    throw errors::RuntimeException("Error reading source port in the packet.");
  }

  return port;
}

uint16_t Packet::getDstPort() const {
  uint16_t port = 0;

  if (hicn_packet_get_dst_port(packet_start_, &port) < 0) {
    throw errors::RuntimeException(
        "Error reading destination port in the packet.");
  }

  return port;
}

Packet &Packet::setTTL(uint8_t hops) {
  if (hicn_packet_set_hoplimit(packet_start_, hops) < 0) {
    throw errors::RuntimeException("Error setting TTL.");
  }

  return *this;
}

uint8_t Packet::getTTL() const {
  uint8_t hops = 0;
  if (hicn_packet_get_hoplimit(packet_start_, &hops) < 0) {
    throw errors::RuntimeException("Error reading TTL.");
  }

  return hops;
}

void Packet::separateHeaderPayload() {
  if (payload_head_) {
    return;
  }

  int signature_size = 0;
  if (_is_ah(format_)) {
    signature_size = (uint32_t)getSignatureSize();
  }

  auto header_size = getHeaderSizeFromFormat(format_, signature_size);
  auto payload_length = packet_->length() - header_size;

  packet_->trimEnd(packet_->length());

  auto payload = packet_->cloneOne();
  payload_head_ = payload.get();
  payload_head_->advance(header_size);
  payload_head_->append(payload_length);
  packet_->prependChain(std::move(payload));
  packet_->append(header_size);
}

void Packet::resetPayload() {
  if (packet_->isChained()) {
    packet_->separateChain(packet_->next(), packet_->prev());
    payload_head_ = nullptr;
    updateLength();
  }
}

}  // end namespace core

}  // end namespace transport