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
use core::fmt::{self, Debug};
use alloc::vec::Vec;
use alloc::string::String;

use super::{Result, TlvError};

pub type Tag = usize;
type Tags = Vec<Tag>;

pub enum Value {
    TlvList(Vec<Tlv>),
    Val(Vec<u8>),
    Nothing,
}

pub struct Tlv {
    tag: Tag,
    val: Value,
}

impl Tlv {
    /// Creates Tlv object
    ///
    /// # Examples:
    ///
    /// Create empty primitive TLV:
    ///
    /// ```
    /// # use tlv_parser::tlv::*;
    /// #
    /// let primitive_tlv = Tlv::new(0x01, Value::Nothing).unwrap();
    /// # let constructed_tlv = Tlv::new(0x21, Value::TlvList(vec![primitive_tlv])).unwrap();
    /// #
    /// # assert_eq!(constructed_tlv.to_vec(), vec![0x21, 0x02, 0x01, 0x00]);
    /// ```
    ///
    /// Create constructed TLV incapsulated primitive TLV:
    ///
    /// ```
    /// # use tlv_parser::tlv::*;
    /// #
    /// # let primitive_tlv = Tlv::new(0x01, Value::Nothing).unwrap();
    /// let constructed_tlv = Tlv::new(0x21, Value::TlvList(vec![primitive_tlv])).unwrap();
    /// #
    /// # assert_eq!(constructed_tlv.to_vec(), vec![0x21, 0x02, 0x01, 0x00]);
    /// ```
    pub fn new(tag: Tag, value: Value) -> Result<Tlv> {
        let tlv = Tlv {
            tag,
            val: Value::Nothing,
        };
        match value {
            Value::TlvList(_) => if tlv.is_primitive() {
                Err(TlvError::ValExpected { tag_number: tag })?;
            },
            Value::Val(_) => if !tlv.is_primitive() {
                Err(TlvError::TlvListExpected { tag_number: tag })?;
            },
            _ => (),
        }

        Ok(Tlv {
            tag,
            val: value,
        })
    }

    /// Returns tag number of TLV
    pub fn tag(&self) -> Tag {
        self.tag
    }

    /// Returns length of tag number
    ///
    /// # Examples
    ///
    /// ```
    /// # use tlv_parser::tlv::*;
    /// let tag_len = Tlv::new(0x01, Value::Nothing).unwrap().tag_len();
    /// assert_eq!(tag_len, 1);
    /// ```
    pub fn tag_len(&self) -> usize {
        let mut tag = self.tag;
        let mut len = 0;
        while tag != 0 {
            len += 1;
            tag >>= 8;
        }

        if len == 0 {
            len + 1
        } else {
            len
        }
    }

    /// Returns size of TLV-string in bytes
    ///
    /// # Examples
    ///
    /// ```
    /// # use tlv_parser::tlv::*;
    /// let tlv_len = Tlv::new(0x01, Value::Val(vec![0x02, 0x03])).unwrap().len();
    /// assert_eq!(tlv_len, 4);
    /// ```
    pub fn len(&self) -> usize {
        self.tag_len() + self.val.encode_len().len() + self.val.len()
    }

    /// Returns true if Value of TLV is empty
    pub fn is_empty(&self) -> bool {
        self.val.is_empty()
    }

    /// Returns value if TLV
    pub fn val(&self) -> &Value {
        &self.val
    }

    /// Returns TLV-encoded array of bytes
    ///
    /// # Examples
    ///
    /// ```
    /// # use tlv_parser::tlv::*;
    /// let tlv = Tlv::new(0x21,
    ///     Value::TlvList(vec![
    ///         Tlv::new( 0x01, Value::Val(vec![0xA1, 0xA2])).unwrap(),
    ///         Tlv::new( 0x02, Value::Val(vec![0xB1, 0xB2])).unwrap()])).unwrap();
    /// assert_eq!(tlv.to_vec(), vec![0x21, 0x08, 0x01, 0x02, 0xA1, 0xA2, 0x02, 0x02, 0xB1, 0xB2]);
    /// ```
    pub fn to_vec(&self) -> Vec<u8> {
        let mut out: Vec<u8> = (self.tag as u64)
            .to_be_bytes()
            .iter()
            .skip_while(|&&x| x == 0)
            .cloned()
            .collect();

        out.append(&mut self.val.encode_len());

        match self.val {
            Value::TlvList(ref list) => for x in list.iter() {
                out.append(&mut x.to_vec());
            },
            Value::Val(ref v) => out.extend_from_slice(v),
            Value::Nothing => (),
        };

        out
    }

    /// Parses string like "6F / A5" into Tags
    fn get_path(path: &str) -> Result<Tags> {
        let tags: Result<Vec<_>> = path.chars()
            .filter(|&x| x.is_digit(16) || x == '/')
            .collect::<String>()
            .split('/')
            .map(|x| usize::from_str_radix(&x, 16).map_err(|_| TlvError::TagPathError))
            .collect();

        tags
    }

    /// Returns value of TLV
    ///
    /// # Example
    ///
    /// ```
    /// # use tlv_parser::tlv::*;
    /// let tlv = Tlv::from_vec(&[0x6F, 0x09, 0xA5, 0x07, 0xBF, 0x0C, 0x04, 0xDF, 0x7F, 0x01, 0x55])
    ///     .unwrap();
    /// if let &Value::Val(ref v) = tlv.find_val("6F / A5 / BF0C / DF7F").unwrap() {
    ///     assert_eq!(*v, vec![0x55]);
    /// }
    /// ```
    pub fn find_val(&self, path: &str) -> Option<&Value> {
        let path = match Tlv::get_path(path) {
            Ok(x) => x,
            _ => return None,
        };

        if path.is_empty() {
            return None;
        }

        if path[0] != self.tag {
            return None;
        }

        if path.len() == 1 {
            return Some(&self.val);
        }

        let mut tlv = self;
        let mut i = 1;

        for tag in path.iter().skip(1) {
            i += 1;

            if let Value::TlvList(ref list) = tlv.val {
                for subtag in list {
                    if *tag != subtag.tag {
                        continue;
                    }

                    if path.len() == i {
                        return Some(&subtag.val);
                    }

                    tlv = subtag;
                    break;
                }
            } else {
                return None;
            }
        }

        None
    }

    /// Reads out tag number
    fn read_tag(iter: &mut ExactSizeIterator<Item = &u8>) -> Result<Tag> {
        let mut tag: usize;

        let first: u8 = iter.next().cloned().ok_or_else(|| TlvError::TruncatedTlv)?;
        tag = first as usize;

        if first & 0x1F == 0x1F {
            // long form - find the end
            for x in &mut *iter {
                tag = tag.checked_shl(8)
                    .ok_or_else(|| TlvError::InvalidTagNumber)?;

                tag |= *x as usize;

                if *x & 0x80 == 0 {
                    break;
                }
            }
        }

        if tag == 0 {
            return Err(TlvError::InvalidTagNumber);
        }

        Ok(tag)
    }

    /// Reads out TLV value's length
    fn read_len(iter: &mut ExactSizeIterator<Item = &u8>) -> Result<usize> {
        let mut len: usize;
        len = *iter.next().ok_or_else(|| TlvError::TruncatedTlv)? as usize;

        if len & 0x80 != 0 {
            let octet_num = len & 0x7F;

            len = 0;
            for x in iter.take(octet_num) {
                len = len.checked_shl(8)
                    .ok_or_else(|| TlvError::InvalidLength)?;

                len |= *x as usize;
            }
        }

        let remain = iter.len();
        if remain < len {
            Err(TlvError::TooShortBody {
                expected: len,
                found: remain,
            })?;
        }

        Ok(len)
    }

    /// Returns true if TLV is primitive
    pub fn is_primitive(&self) -> bool {
        let mask = 0x20 << ((self.tag_len() - 1) * 8);
        self.tag & mask != mask
    }

    /// Initializes Tlv object iterator of Vec<u8>
    fn from_iter(iter: &mut ExactSizeIterator<Item = &u8>) -> Result<Tlv> {
        let tag = Tlv::read_tag(iter)?;
        let len = Tlv::read_len(iter)?;

        let val = &mut iter.take(len);

        let mut tlv = Tlv {
            tag,
            val: Value::Nothing,
        };

        if tlv.is_primitive() {
            tlv.val = Value::Val(val.cloned().collect());
            return Ok(tlv);
        }

        tlv.val = Value::TlvList(vec![]);

        while val.size_hint().0 != 0 {
            if let Value::TlvList(ref mut children) = tlv.val {
                children.push(Tlv::from_iter(val)?);
            }
        }

        Ok(tlv)
    }

    /// Initializes Tlv object from [u8] slice
    ///
    /// # Examples
    ///
    /// ```
    /// # use tlv_parser::tlv::*;
    /// let tlv = Tlv::from_vec(&[0x01, 0x00]).unwrap();
    /// assert_eq!(tlv.tag(), 0x01);
    /// assert_eq!(tlv.tag_len(), 0x01);
    /// assert_eq!(tlv.len(), 0x02);
    /// ```
    pub fn from_vec(slice: &[u8]) -> Result<Tlv> {
        let iter = &mut slice.iter();
        Tlv::from_iter(iter)
    }
}

impl Value {
    /// Returns size of value in bytes
    fn len(&self) -> usize {
        match *self {
            Value::TlvList(ref list) => list.iter().fold(0, |sum, x| sum + x.len()),
            Value::Val(ref v) => v.len(),
            Value::Nothing => 0,
        }
    }

    /// Returns true if Value is empty (len() == 0)
    pub fn is_empty(&self) -> bool {
        match *self {
            Value::TlvList(ref list) => list.is_empty(),
            Value::Val(ref v) => v.is_empty(),
            Value::Nothing => true,
        }
    }

    /// Returns bytes array that represents encoded-len
    ///
    /// Note: implements only definite form
    pub fn encode_len(&self) -> Vec<u8> {
        let len = self.len();
        if len <= 0x7f {
            return vec![len as u8];
        }

        let mut out: Vec<u8> = len
            .to_be_bytes()
            .iter()
            .skip_while(|&x| *x == 0)
            .cloned()
            .collect();

        let bytes = out.len() as u8;
        out.insert(0, 0x80 | bytes);
        out
    }
}

impl fmt::Display for Tlv {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "tag={:02X},", self.tag)?;

        let mut p = String::new();
        for _ in 0..12usize.saturating_sub(self.tag_len() * 2 + 5) {
            p.push(' ');
        }

        f.pad(p.as_ref())?;
        write!(f, "len={},", self.val.len())?;

        match self.val {
            Value::Val(_) => {
                let len = self.val.len();
                let mut num1 = 1;
                let mut num2 = 10;

                while len / num2 != 0 {
                    num1 += 1;
                    num2 *= 10;
                }

                let mut p = String::new();
                for _ in 0..10 - (num1 + 5) {
                    p.push(' ');
                }
                f.pad(p.as_ref())?;
            }
            _ => f.pad("")?,
        }

        self.val.fmt(f)?;
        f.pad("")
    }
}

impl fmt::Display for Value {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            Value::TlvList(ref list) => {
                for x in list.iter() {
                    writeln!(f, "{}", x)?;
                }
                Ok(())
            }

            Value::Val(ref v) => {
                write!(f, "val=")?;
                for x in v {
                    write!(f, "{:02X}", x)?;
                }
                write!(f, " ")?;
                for x in v {
                    if *x >= 0x20 && *x < 0x7f {
                        write!(f, "{}", *x as char)?;
                    } else {
                        write!(f, ".")?;
                    }
                }
                Ok(())
            }
            _ => ().fmt(f),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn from_vec_test() {
        // simple two bytes TLV
        let input: Vec<u8> = vec![0x01, 0x02, 0x00, 0x00];
        assert_eq!(Tlv::from_vec(&input).unwrap().to_vec(), input);

        // TLV with two bytes tag
        let input: Vec<u8> = vec![0x9F, 0x02, 0x02, 0x00, 0x00];
        assert_eq!(Tlv::from_vec(&input).unwrap().to_vec(), input);

        // TLV with two bytes length
        let mut input: Vec<u8> = vec![0x9F, 0x02, 0x81, 0x80];
        input.extend_from_slice(&[0; 0x80]);
        assert_eq!(Tlv::from_vec(&input).unwrap().to_vec(), input);

        // TLV with four bytes tag number
        let input: Vec<u8> = vec![0x5f, 0xc8, 0x80, 0x01, 0x02, 0x01, 0x02];
        assert_eq!(Tlv::from_vec(&input).unwrap().to_vec(), input);
    }

    #[test]
    fn to_vec_test() {
        let tlv = Tlv {
            tag: 0x01,
            val: Value::Val(vec![0]),
        };

        assert_eq!(tlv.to_vec(), vec![0x01, 0x01, 0x00]);

        let tlv = Tlv {
            tag: 0x01,
            val: Value::Val(vec![0; 127]),
        };

        assert_eq!(&tlv.to_vec()[0..3], [0x01, 0x7F, 0x00]);

        let tlv = Tlv {
            tag: 0x01,
            val: Value::Val(vec![0; 255]),
        };

        assert_eq!(&tlv.to_vec()[0..4], [0x01, 0x81, 0xFF, 0x00]);

        let tlv = Tlv {
            tag: 0x02,
            val: Value::Val(vec![0; 256]),
        };

        assert_eq!(&tlv.to_vec()[0..4], [0x02, 0x82, 0x01, 0x00]);

        let tlv = Tlv {
            tag: 0x03,
            val: Value::Val(vec![0; 0xffff01]),
        };

        assert_eq!(&tlv.to_vec()[0..5], [0x03, 0x83, 0xFF, 0xFF, 0x01]);
    }

    #[test]
    fn find_val_test() {
        let input: Vec<u8> = vec![0x21, 0x05, 0x22, 0x03, 0x03, 0x01, 0xaa];
        let tlv = Tlv::from_vec(&input).unwrap();

        if let Some(&Value::Val(ref val)) = tlv.find_val("21 / 22 / 03") {
            assert_eq!(*val, vec![0xaa]);
        } else {
            assert!(false);
        }
    }

    #[test]
    fn tag_len_test() {
        let tlv1 = Tlv {
            tag: 0x03,
            val: Value::Nothing,
        };
        let tlv2 = Tlv {
            tag: 0x0303,
            val: Value::Nothing,
        };
        let tlv3 = Tlv {
            tag: 0x030303,
            val: Value::Nothing,
        };
        let tlv4 = Tlv {
            tag: 0x03030303,
            val: Value::Nothing,
        };

        assert_eq!(tlv1.tag_len(), 1);
        assert_eq!(tlv2.tag_len(), 2);
        assert_eq!(tlv3.tag_len(), 3);
        assert_eq!(tlv4.tag_len(), 4);
    }
}