etherparse 0.10.0

A library for parsing & writing a bunch of packet based protocols (EthernetII, IPv4, IPv6, UDP, TCP ...).
Documentation
use super::super::*;

use std::io::ErrorKind;

#[test]
fn header_new_raw_and_set_payload() {
    use ValueError::*;
    struct Test {
        payload: &'static [u8],
        expected: Result<(),ValueError>
    }

    let tests = [
        // ok
        Test{payload: &[1,2,3,4,5,6], expected: Ok(()) },
        Test{payload: &[1,2,3,4,5,6,7,8,9,10,11,12,13,14], expected: Ok(()) },
        Test{payload: &[0;0xff*8 + 6], expected: Ok(()) },
        // too small
        Test{payload: &[1,2,3,4,5], expected: Err(Ipv6ExtensionPayloadTooSmall(5)) },
        Test{payload: &[1,2,3,4], expected: Err(Ipv6ExtensionPayloadTooSmall(4)) },
        Test{payload: &[1], expected: Err(Ipv6ExtensionPayloadTooSmall(1)) },
        Test{payload: &[], expected: Err(Ipv6ExtensionPayloadTooSmall(0)) },
        // too large
        Test{payload: &[0;0xff*8 + 7], expected: Err(Ipv6ExtensionPayloadTooLarge(0xff*8 + 7)) },
    ];

    for test in tests.iter() {
        // new_raw
        {
            let actual = Ipv6RawExtensionHeader::new_raw(123, test.payload);
            match &test.expected {
                Ok(_) => {
                    let unpacked = actual.unwrap();
                    assert_eq!(123, unpacked.next_header);
                    assert_eq!(&test.payload[..], unpacked.payload());
                },
                Err(err) => {
                    assert_eq!(Err(err.clone()), actual);
                }
            }
        }
        // set payload
        {
            let mut header = Ipv6RawExtensionHeader::new_raw(123, &[0;6]).unwrap();
            let result = header.set_payload(test.payload);
            match &test.expected {
                Ok(_) => {
                    assert_eq!(Ok(()), result);
                    assert_eq!(test.payload, header.payload());
                },
                Err(err) => {
                    assert_eq!(Err(err.clone()), result);
                    assert_eq!(&[0;6], header.payload());
                }
            }
        }
    }

    // unaligment errors
    {
        let payload = [0;23];
        for i in 7..=23 {
            if 0 != (i - 6) % 8 {
                assert_eq!(
                    Err(Ipv6ExtensionPayloadLengthUnaligned(i)),
                    Ipv6RawExtensionHeader::new_raw(123, &payload[..i])
                );
                {
                    let mut header = Ipv6RawExtensionHeader::new_raw(123, &[0;6]).unwrap();
                    assert_eq!(
                        Err(Ipv6ExtensionPayloadLengthUnaligned(i)),
                        header.set_payload(&payload[..i])
                    );
                    assert_eq!(&[0;6], header.payload());
                }
            }
        }
    }
}

#[test]
fn slice_from_slice() {
    // base test
    let data = {
        let mut data = [0;6*8];
        data[0] = 1; // next header type
        data[1] = 4; // header length
        data
    };
    let actual = Ipv6RawExtensionHeaderSlice::from_slice(&data).unwrap();
    assert_eq!(1, actual.next_header());
    assert_eq!(
        &data[..5*8],
        actual.slice()
    );
    assert_eq!(
        &data[2..5*8],
        actual.payload()
    );

    {
        let header = actual.to_header();
        assert_eq!(1, header.next_header);
        assert_eq!(&data[2..5*8], header.payload());
    }
}

#[test]
fn slice_from_slice_unchecked() {
    let data = {
        let mut data = [0;6*8];
        data[0] = 1; // next header type
        data[1] = 4; // header length
        data
    };
    let header = unsafe {
        Ipv6RawExtensionHeaderSlice::from_slice_unchecked(&data)
    };
    assert_eq!(&data[..5*8], header.slice());
}

#[test]
fn slice_from_slice_error() {
    // errors:
    // length smaller then 8
    {
        assert_matches!(
            Ipv6RawExtensionHeaderSlice::from_slice(&[0;7]),
            Err(ReadError::UnexpectedEndOfSlice(8))
        );
        assert_matches!(
            Ipv6RawExtensionHeader::from_slice(&[0;7]),
            Err(ReadError::UnexpectedEndOfSlice(8))
        );
    }
    // length smaller then spezified size
    {
        let data = {
            let mut data: [u8;4*8 - 1] = [0;4*8 - 1];
            // set length field
            data[1] = 3;
            data
        };
        assert_matches!(
            Ipv6RawExtensionHeaderSlice::from_slice(&data),
            Err(ReadError::UnexpectedEndOfSlice(32))
        );
        assert_matches!(
            Ipv6RawExtensionHeader::from_slice(&data),
            Err(ReadError::UnexpectedEndOfSlice(32))
        );
    }
}

#[test]
fn extension_from_slice_bad_length() {
    use crate::ip_number::UDP;
    use self::ReadError::*;

    //smaller then minimum extension header size (8 bytes)
    {
        let buffer: [u8; 7] = [
            UDP,2,0,0, 0,0,0
        ];
        assert_matches!(Ipv6RawExtensionHeaderSlice::from_slice(&buffer), 
                        Err(UnexpectedEndOfSlice(8)));
    }
    //smaller then specified size by length field
    {
        let buffer: [u8; 8*3-1] = [
            UDP,2,0,0, 0,0,0,0,
            0,0,0,0,   0,0,0,0,
            0,0,0,0,   0,0,0,
        ];
        // should generate an error
        let slice = Ipv6RawExtensionHeaderSlice::from_slice(&buffer);
        assert_matches!(slice, Err(UnexpectedEndOfSlice(_)));
    }
}

#[test]
fn header_type_supported() {
    use crate::ip_number::*;
    for i in 0..0xffu8 {
        let expected = match i {
            IPV6_HOP_BY_HOP | IPV6_ROUTE | IPV6_DEST_OPTIONS | MOBILITY | HIP | SHIM6 => true,
            _ => false
        };
        assert_eq!(expected, Ipv6RawExtensionHeader::header_type_supported(i));
        assert_eq!(expected, Ipv6RawExtensionHeaderSlice::header_type_supported(i));
    }
}

proptest! {
    #[test]
    fn write_and_read(
        input in ipv6_raw_extension_any()
    ) {
        let mut buffer: Vec<u8> = Vec::new();
        input.write(&mut buffer).unwrap();
        // add some dummy data to check the slice length
        buffer.push(0);
        buffer.push(1);
        {
            let actual = Ipv6RawExtensionHeaderSlice::from_slice(&buffer).unwrap();
            assert_eq!(actual.next_header(), input.next_header);
            assert_eq!(actual.payload(), input.payload());
            assert_eq!(actual.to_header(), input);
            // slice clone & equal check
            assert_eq!(actual, actual.clone());
        }
        {
            let actual = Ipv6RawExtensionHeader::from_slice(&buffer).unwrap();
            assert_eq!(input, actual.0);
            assert_eq!(&buffer[buffer.len() - 2..], actual.1);
        }
        {
            use std::io::Cursor;
            let mut cursor = Cursor::new(&buffer);
            let actual = Ipv6RawExtensionHeader::read(&mut cursor).unwrap();
            assert_eq!(input, actual);
            assert_eq!(cursor.position(), (buffer.len() - 2) as u64);
        }
    }
}

#[test]
fn read_errors() {
    use std::io::Cursor;
    // errors:
    // length smaller then 8
    for i in 0..8 {
        let buffer = [0u8;7];
        let mut cursor = Cursor::new(&buffer[..i]);
        assert_matches!(
            Ipv6RawExtensionHeader::read(&mut cursor),
            Err(ReadError::IoError(_))
        );
    }
    // length smaller then spezified size
    {
        let buffer = {
            let mut buffer: [u8;4*8 - 1] = [0;4*8 - 1];
            // set length field
            buffer[1] = 3;
            buffer
        };
        let mut cursor = Cursor::new(&buffer);
        assert_matches!(
            Ipv6RawExtensionHeader::read(&mut cursor),
            Err(ReadError::IoError(_))
        );
    }
}

proptest! {
    #[test]
    fn write_errors(
        input in ipv6_raw_extension_any()
    ) {
        // check that all possible "not enough data" cases trigger an error on write
        for len in 0..input.header_len()-1 {
            let mut writer = TestWriter::with_max_size(len);
            assert_eq!(
                ErrorKind::UnexpectedEof,
                input.write(&mut writer).unwrap_err().io_error().unwrap().kind()
            );
        }
    }
}

proptest! {
    #[test]
    fn header_len(input in ipv6_raw_extension_any()) {
        assert_eq!(input.header_len(), input.payload().len() + 2);
    }
}

proptest! {
    #[test]
    fn debug(input in ipv6_raw_extension_any()) {
        // debug trait
        {
            assert_eq!(
                &format!("Ipv6RawExtensionHeader {{ next_header: {}, payload: {:?} }}", input.next_header, input.payload()),
                &format!("{:?}", input)
            );
        }
        {
            let buffer = {
                let mut buffer = Vec::with_capacity(input.header_len());
                input.write(&mut buffer).unwrap();
                buffer
            };
            let slice = Ipv6RawExtensionHeaderSlice::from_slice(&buffer).unwrap();
            assert_eq!(
                &format!("Ipv6RawExtensionHeaderSlice {{ slice: {:?} }}", slice.slice()),
                &format!("{:?}", slice)
            );
        }
    }
}

#[test]
fn partial_equal() {
    let a = Ipv6RawExtensionHeader::new_raw(
        123,
        &[
                   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,
        ]
    ).unwrap();
    assert_eq!(a, a);

    // non equal next_header
    {
        let mut b = a.clone();
        b.next_header = 0;
        assert_ne!(a, b);
    }

    // non equal payload data
    {
        let b = Ipv6RawExtensionHeader::new_raw(
            123,
            &[
                       1, 2, 3, 4, 5, 6,
                 7, 8, 9,99,11,12,13,14,
                15,16,17,18,19,20,21,22,
                23,24,25,26,27,28,29,30,
            ]
        ).unwrap();
        assert_ne!(a, b);
    }

    // non equal payload length
    {
        let b = Ipv6RawExtensionHeader::new_raw(
            123,
            &[
                       1, 2, 3, 4, 5, 6,
                 7, 8, 9,10,11,12,13,14,
                15,16,17,18,19,20,21,22,
            ]
        ).unwrap();
        assert_ne!(a, b);
    }
}