stun-types 2.0.1

// Copyright (C) 2020 Matthew Waters <matthew@centricular.com>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//
// SPDX-License-Identifier: MIT OR Apache-2.0

use alloc::borrow::ToOwned;
use alloc::string::String;
use core::convert::TryFrom;

use crate::message::{StunParseError, StunWriteError};

use super::{
    Attribute, AttributeExt, AttributeFromRaw, AttributeStaticType, AttributeType, AttributeWrite,
    AttributeWriteExt, RawAttribute,
};

/// The Software [`Attribute`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Software {
    software: String,
}

impl AttributeStaticType for Software {
    const TYPE: AttributeType = AttributeType(0x8022);
}

impl Attribute for Software {
    fn get_type(&self) -> AttributeType {
        Self::TYPE
    }

    fn length(&self) -> u16 {
        self.software.len() as u16
    }
}

impl AttributeWrite for Software {
    fn to_raw(&self) -> RawAttribute<'_> {
        RawAttribute::new(Software::TYPE, self.software.as_bytes())
    }

    fn write_into_unchecked(&self, dest: &mut [u8]) {
        let len = self.padded_len();
        let offset = self.write_header_unchecked(dest);
        dest[offset..offset + self.software.len()].copy_from_slice(self.software.as_bytes());
        let offset = offset + self.software.len();
        if len > offset {
            dest[offset..len].fill(0);
        }
    }
}

impl AttributeFromRaw<'_> for Software {
    fn from_raw_ref(raw: &RawAttribute) -> Result<Self, StunParseError>
    where
        Self: Sized,
    {
        Self::try_from(raw)
    }
}

impl TryFrom<&RawAttribute<'_>> for Software {
    type Error = StunParseError;

    fn try_from(raw: &RawAttribute) -> Result<Self, Self::Error> {
        raw.check_type_and_len(Self::TYPE, ..=763)?;
        Ok(Self {
            software: core::str::from_utf8(&raw.value)
                .map_err(|_| StunParseError::InvalidAttributeData)?
                .to_owned(),
        })
    }
}

impl Software {
    /// Create a new unknown attributes [`Attribute`].
    ///
    /// # Errors
    ///
    /// If the length of the provided string is too long for the [`Attribute`].
    ///
    /// # Examples
    ///
    /// ```
    /// # use stun_types::attribute::*;
    /// let software = Software::new("stun-types 0.1").unwrap();
    /// assert_eq!(software.software(), "stun-types 0.1");
    /// ```
    pub fn new(software: &str) -> Result<Self, StunWriteError> {
        // TODO: should only allow 128 characters
        if software.len() > 763 {
            return Err(StunWriteError::TooLarge {
                expected: 763,
                actual: software.len(),
            });
        }
        Ok(Self {
            software: software.to_owned(),
        })
    }

    /// The value of the software field.
    ///
    /// # Examples
    ///
    /// ```
    /// # use stun_types::attribute::*;
    /// let software = Software::new("stun-types 0.1").unwrap();
    /// assert_eq!(software.software(), "stun-types 0.1");
    /// ```
    pub fn software(&self) -> &str {
        &self.software
    }
}

impl core::fmt::Display for Software {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{}: '{}'", Software::TYPE, self.software)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use alloc::vec;
    use alloc::vec::Vec;
    use byteorder::{BigEndian, ByteOrder};
    use tracing::trace;

    #[test]
    fn software() {
        let _log = crate::tests::test_init_log();
        let software = Software::new("software").unwrap();
        trace!("{software}");
        assert_eq!(software.software(), "software");
        assert_eq!(software.length() as usize, "software".len());
    }

    #[test]
    fn software_raw() {
        let _log = crate::tests::test_init_log();
        let software = Software::new("software").unwrap();
        let raw = RawAttribute::from(&software);
        trace!("{raw}");
        assert_eq!(raw.get_type(), Software::TYPE);
        let software2 = Software::try_from(&raw).unwrap();
        assert_eq!(software2.software(), "software");
    }

    #[test]
    fn software_raw_wrong_type() {
        let _log = crate::tests::test_init_log();
        let software = Software::new("software").unwrap();
        let raw = RawAttribute::from(&software);

        // provide incorrectly typed data
        let mut data: Vec<_> = raw.into();
        BigEndian::write_u16(&mut data[0..2], 0);
        assert!(matches!(
            Software::try_from(&RawAttribute::from_bytes(data.as_ref()).unwrap()),
            Err(StunParseError::WrongAttributeImplementation)
        ));
    }

    #[test]
    fn software_write_into() {
        let _log = crate::tests::test_init_log();
        let software = Software::new("software").unwrap();
        let raw = RawAttribute::from(&software);

        let mut dest = vec![0; raw.padded_len()];
        software.write_into(&mut dest).unwrap();
        let raw = RawAttribute::from_bytes(&dest).unwrap();
        let software2 = Software::try_from(&raw).unwrap();
        assert_eq!(software2.software(), "software");
    }

    #[test]
    #[should_panic(expected = "out of range")]
    fn software_write_into_unchcked() {
        let _log = crate::tests::test_init_log();
        let software = Software::new("software").unwrap();
        let raw = RawAttribute::from(&software);

        let mut dest = vec![0; raw.padded_len() - 1];
        software.write_into_unchecked(&mut dest);
    }

    #[test]
    fn software_not_utf8() {
        let _log = crate::tests::test_init_log();
        let attr = Software::new("software").unwrap();
        let raw = RawAttribute::from(&attr);
        let mut data = raw.to_bytes();
        data[6] = 0x88;
        assert!(matches!(
            Software::try_from(&RawAttribute::from_bytes(data.as_ref()).unwrap()),
            Err(StunParseError::InvalidAttributeData)
        ));
    }

    #[test]
    fn software_new_too_large() {
        let _log = crate::tests::test_init_log();
        let mut large = String::new();
        for _i in 0..95 {
            large.push_str("abcdefgh");
        }
        large.push_str("abcd");
        assert!(matches!(
            Software::new(&large),
            Err(StunWriteError::TooLarge {
                expected: 763,
                actual: 764
            })
        ));
    }
}