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
use derive_builder::Builder;
use serde::de::{SeqAccess, Visitor};
use serde::ser::{SerializeSeq, Serializer};
use serde::{de, Deserialize, Deserializer, Serialize};
use std::fmt;
use std::time::{SystemTime, UNIX_EPOCH};
use super::canonical::*;
use super::crc::*;
use super::dtntime::*;
use super::eid::*;
use super::primary::*;
pub const DTN_VERSION: u32 = 7;
pub type ByteBuffer = Vec<u8>;
pub type DtnVersionType = u32;
pub type CanonicalBlockNumberType = u64;
pub type FragOffsetType = u64;
pub type LifetimeType = u64;
pub type TotalDataLengthType = u64;
#[derive(Debug, Clone)]
pub enum Bp7Error {
CanonicalBlockError(String),
PrimaryBlockError(String),
EIDError(String),
DtnTimeError(String),
CrcError(String),
BundleError(String),
StcpError(String),
BundleControlFlagError(String),
BlockControlFlagError(String),
}
impl fmt::Display for Bp7Error {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{:?}", self)
}
}
pub type Bp7ErrorList = Vec<Bp7Error>;
pub trait Block: Clone {
fn has_crc(&self) -> bool;
fn calculate_crc(&mut self) {
let new_crc = calculate_crc(self);
self.set_crc(new_crc);
}
fn check_crc(&self) -> bool {
check_crc(self)
}
fn reset_crc(&mut self) {
let crc_type = self.crc_type();
let empty = empty_crc(crc_type).unwrap();
self.set_crc(empty);
}
fn set_crc_type(&mut self, crc_type: CRCType);
fn crc_type(&self) -> CRCType;
fn crc(&self) -> &[u8];
fn set_crc(&mut self, crc: ByteBuffer);
fn to_cbor(&self) -> ByteBuffer;
}
pub type BlockControlFlags = u8;
pub const BLOCK_DELETE_BUNDLE: BlockControlFlags = 0x08;
pub const BLOCK_STATUS_REPORT: BlockControlFlags = 0x04;
pub const BLOCK_REMOVE: BlockControlFlags = 0x02;
pub const BLOCK_REPLICATE: BlockControlFlags = 0x01;
pub const BLOCK_CFRESERVED_FIELDS: BlockControlFlags = 0xF0;
pub trait BlockValidation {
fn has(self, flag: BlockControlFlags) -> bool;
fn validation_error(self) -> Option<Bp7Error>;
}
impl BlockValidation for BlockControlFlags {
fn has(self, flag: BlockControlFlags) -> bool {
(self & flag) != 0
}
fn validation_error(self) -> Option<Bp7Error> {
if self.has(BLOCK_CFRESERVED_FIELDS) {
return Some(Bp7Error::BlockControlFlagError(
"Given flag contains reserved bits".to_string(),
));
}
None
}
}
pub type BundleControlFlags = u16;
pub const BUNDLE_STATUS_REQUEST_DELETION: BundleControlFlags = 0x1000;
pub const BUNDLE_STATUS_REQUEST_DELIVERY: BundleControlFlags = 0x0800;
pub const BUNDLE_STATUS_REQUEST_FORWARD: BundleControlFlags = 0x0400;
pub const BUNDLE_STATUS_REQUEST_RECEPTION: BundleControlFlags = 0x0100;
pub const BUNDLE_CONTAINS_MANIFEST: BundleControlFlags = 0x0080;
pub const BUNDLE_REQUEST_STATUS_TIME: BundleControlFlags = 0x0040;
pub const BUNDLE_REQUEST_USER_APPLICATION_ACK: BundleControlFlags = 0x0020;
pub const BUNDLE_MUST_NOT_FRAGMENTED: BundleControlFlags = 0x0004;
pub const BUNDLE_ADMINISTRATIVE_RECORD_PAYLOAD: BundleControlFlags = 0x0002;
pub const BUNDLE_IS_FRAGMENT: BundleControlFlags = 0x0001;
pub const BUNDLE_CFRESERVED_FIELDS: BundleControlFlags = 0xE218;
pub trait BundleValidation {
fn has(self, flag: BundleControlFlags) -> bool;
fn validation_errors(self) -> Option<Bp7ErrorList>;
}
impl BundleValidation for BundleControlFlags {
fn has(self, flag: BundleControlFlags) -> bool {
(self & flag) != 0
}
fn validation_errors(self) -> Option<Bp7ErrorList> {
let mut errors: Bp7ErrorList = Vec::new();
if self.has(BUNDLE_CFRESERVED_FIELDS) {
errors.push(Bp7Error::BundleControlFlagError(
"Given flag contains reserved bits".to_string(),
));
}
if self.has(BUNDLE_IS_FRAGMENT) && self.has(BUNDLE_MUST_NOT_FRAGMENTED) {
errors.push(Bp7Error::BundleControlFlagError(
"Both 'bundle is a fragment' and 'bundle must not be fragmented' flags are set"
.to_string(),
));
}
let admin_rec_check = !self.has(BUNDLE_ADMINISTRATIVE_RECORD_PAYLOAD)
|| (!self.has(BUNDLE_STATUS_REQUEST_RECEPTION)
&& !self.has(BUNDLE_STATUS_REQUEST_FORWARD)
&& !self.has(BUNDLE_STATUS_REQUEST_DELIVERY)
&& !self.has(BUNDLE_STATUS_REQUEST_DELETION));
if !admin_rec_check {
errors.push(Bp7Error::BundleControlFlagError(
"\"payload is administrative record => no status report request flags\" failed"
.to_string(),
))
}
if !errors.is_empty() {
return Some(errors);
}
None
}
}
#[derive(Debug, Clone, PartialEq, Builder)]
#[builder(default)]
pub struct Bundle {
pub primary: PrimaryBlock,
pub canonicals: Vec<CanonicalBlock>,
}
impl Serialize for Bundle {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
let mut seq = serializer.serialize_seq(Some(self.canonicals.len() + 1))?;
seq.serialize_element(&self.primary)?;
for e in &self.canonicals {
seq.serialize_element(&e)?;
}
seq.end()
}
}
impl<'de> Deserialize<'de> for Bundle {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
struct BundleVisitor;
impl<'de> Visitor<'de> for BundleVisitor {
type Value = Bundle;
fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
formatter.write_str("packet")
}
fn visit_seq<V>(self, mut seq: V) -> Result<Self::Value, V::Error>
where
V: SeqAccess<'de>,
{
let primary: PrimaryBlock = seq
.next_element()?
.ok_or_else(|| de::Error::invalid_length(0, &self))?;
let mut canonicals: Vec<CanonicalBlock> = Vec::new();
while let Some(next) = seq.next_element::<CanonicalBlock>()? {
canonicals.push(next);
}
Ok(Bundle {
primary,
canonicals,
})
}
}
deserializer.deserialize_any(BundleVisitor)
}
}
impl Default for Bundle {
fn default() -> Self {
Bundle {
primary: PrimaryBlock::new(),
canonicals: Vec::new(),
}
}
}
impl Bundle {
pub fn new(primary: PrimaryBlock, canonicals: Vec<CanonicalBlock>) -> Bundle {
Bundle {
primary,
canonicals,
}
}
pub fn new_standard_bundle(src: EndpointID, dst: EndpointID, data: ByteBuffer) -> Bundle {
let pblock = crate::primary::PrimaryBlockBuilder::default()
.destination(dst)
.source(src.clone())
.report_to(src)
.creation_timestamp(CreationTimestamp::now())
.lifetime(60 * 60 * 1_000_000)
.build()
.unwrap();
let mut b = crate::bundle::BundleBuilder::default()
.primary(pblock)
.canonicals(vec![
crate::canonical::new_payload_block(0, data),
crate::canonical::new_bundle_age_block(
1,
0,
SystemTime::now()
.duration_since(UNIX_EPOCH)
.expect("Time went backwards")
.as_millis() as u64,
),
])
.build()
.unwrap();
b.set_crc(crate::crc::CRC_32);
b
}
pub fn validation_errors(&self) -> Option<Bp7ErrorList> {
let mut errors: Bp7ErrorList = Vec::new();
if let Some(mut err) = self.primary.validation_errors() {
errors.append(&mut err);
}
for blck in &self.canonicals {
if let Some(mut err) = blck.validation_errors() {
errors.append(&mut err);
}
}
if self
.primary
.bundle_control_flags
.has(BUNDLE_ADMINISTRATIVE_RECORD_PAYLOAD)
|| self.primary.source == DTN_NONE
{
for cb in &self.canonicals {
if cb.block_control_flags.has(BLOCK_STATUS_REPORT) {
errors.push(Bp7Error::BundleError(
"Bundle Processing Control Flags indicate that this bundle's payload is an administrative record or the source node is omitted, but the \"Transmit status report if block cannot be processed\" Block Processing Control Flag was set in a Canonical Block".to_string()
));
}
}
}
let block_numbers = self
.canonicals
.iter()
.map(|e| e.block_number)
.collect::<Vec<CanonicalBlockNumberType>>();
let block_types = self
.canonicals
.iter()
.map(|e| e.block_number)
.collect::<Vec<CanonicalBlockNumberType>>();
if (1..block_numbers.len()).any(|i| block_numbers[i..].contains(&block_numbers[i - 1])) {
errors.push(Bp7Error::BundleError(
"Block numbers occurred multiple times".to_string(),
));
}
if block_types
.iter()
.filter(|&i| *i == BUNDLE_AGE_BLOCK)
.count()
> 1
|| block_types
.iter()
.filter(|&i| *i == PREVIOUS_NODE_BLOCK)
.count()
> 1
|| block_types
.iter()
.filter(|&i| *i == HOP_COUNT_BLOCK)
.count()
> 1
{
errors.push(Bp7Error::BundleError(
"PreviousNode, BundleAge and HopCound blocks must not occure multiple times"
.to_string(),
));
}
if self.primary.creation_timestamp.get_dtntime() == 0
&& !block_types.contains(&BUNDLE_AGE_BLOCK)
{
errors.push(Bp7Error::BundleError(
"Creation Timestamp is zero, but no Bundle Age block is present".to_string(),
));
}
if !errors.is_empty() {
return Some(errors);
}
None
}
pub fn is_administrative_record(&self) -> bool {
self.primary
.bundle_control_flags
.has(BUNDLE_ADMINISTRATIVE_RECORD_PAYLOAD)
}
pub fn set_crc(&mut self, crc_type: CRCType) {
self.primary.set_crc_type(crc_type);
for b in &mut self.canonicals {
b.set_crc_type(crc_type);
}
}
pub fn crc_valid(&self) -> bool {
if !self.primary.check_crc() {
return false;
}
for b in &self.canonicals {
if !b.check_crc() {
return false;
}
}
true
}
pub fn calculate_crc(&mut self) {
self.primary.calculate_crc();
for b in &mut self.canonicals {
b.calculate_crc();
}
}
pub fn extension_block(
&mut self,
block_type: CanonicalBlockType,
) -> Option<(&mut CanonicalBlock)> {
for b in &mut self.canonicals {
if b.block_type == block_type && b.extension_validation_error().is_none() {
return Some(b);
}
}
None
}
pub fn to_cbor(&mut self) -> ByteBuffer {
self.calculate_crc();
let mut bytebuf = serde_cbor::to_vec(&self).expect("Error serializing bundle as cbor.");
bytebuf[0] = 0x9f;
bytebuf.push(0xff);
bytebuf
}
pub fn to_json(&mut self) -> String {
self.calculate_crc();
serde_json::to_string(&self).unwrap()
}
pub fn id(&self) -> String {
let mut id = format!(
"{}-{}-{}-{}",
self.primary.source,
self.primary.creation_timestamp.get_dtntime(),
self.primary.creation_timestamp.get_seqno(),
self.primary.destination
);
if self.primary.has_fragmentation() {
id = format!("{}-{}", id, self.primary.fragmentation_offset);
}
id
}
pub fn update_extensions(&mut self, local_node: EndpointID, residence_time: u64) -> bool {
if let Some(hcblock) = self.extension_block(HOP_COUNT_BLOCK) {
hcblock.hop_count_increase();
if hcblock.hop_count_exceeded() {
return false;
}
}
if let Some(pnblock) = self.extension_block(PREVIOUS_NODE_BLOCK) {
pnblock.previous_node_update(local_node);
}
if let Some(bablock) = self.extension_block(BUNDLE_AGE_BLOCK) {
if let Some(ba_orig) = bablock.bundle_age_get() {
bablock.bundle_age_update(ba_orig + residence_time);
if ba_orig + residence_time > self.primary.lifetime * 1000 {
return false;
}
}
}
!self.primary.is_lifetime_exceeded()
}
}
impl From<ByteBuffer> for Bundle {
fn from(item: ByteBuffer) -> Self {
serde_cbor::from_slice(&item).expect("Decoding Bundle failed")
}
}
impl From<String> for Bundle {
fn from(item: String) -> Self {
serde_json::from_str(&item).expect("Decoding Bundle failed")
}
}
pub fn new_std_payload_bundle(src: EndpointID, dst: EndpointID, data: ByteBuffer) -> Bundle {
let now = CreationTimestamp::now();
let pblock = PrimaryBlockBuilder::default()
.destination(dst)
.source(src.clone())
.report_to(src)
.creation_timestamp(now)
.lifetime(60 * 60 * 1_000_000)
.build()
.unwrap();
let mut b = BundleBuilder::default()
.primary(pblock)
.canonicals(vec![
new_payload_block(0, data),
new_bundle_age_block(1, 0, 0),
])
.build()
.unwrap();
b.set_crc(CRC_32);
b
}