xmpp_parsers/
bob.rs

1// Copyright (c) 2019 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7use alloc::borrow::Cow;
8use core::str::FromStr;
9
10use xso::{error::Error, text::Base64, AsXml, AsXmlText, FromXml, FromXmlText};
11
12use crate::hashes::{Algo, Hash};
13use crate::ns;
14use minidom::IntoAttributeValue;
15
16/// A Content-ID, as defined in RFC2111.
17///
18/// The text value SHOULD be of the form algo+hash@bob.xmpp.org, this struct
19/// enforces that format.
20#[derive(Clone, Debug, PartialEq)]
21pub struct ContentId {
22    hash: Hash,
23}
24
25impl FromStr for ContentId {
26    type Err = Error;
27
28    fn from_str(s: &str) -> Result<Self, Error> {
29        let temp: Vec<_> = s.splitn(2, '@').collect();
30        let temp: Vec<_> = match temp[..] {
31            [lhs, rhs] => {
32                if rhs != "bob.xmpp.org" {
33                    return Err(Error::Other("Wrong domain for cid URI."));
34                }
35                lhs.splitn(2, '+').collect()
36            }
37            _ => return Err(Error::Other("Missing @ in cid URI.")),
38        };
39        let (algo, hex) = match temp[..] {
40            [lhs, rhs] => {
41                let algo = match lhs {
42                    "sha1" => Algo::Sha_1,
43                    "sha256" => Algo::Sha_256,
44                    _ => unimplemented!(),
45                };
46                (algo, rhs)
47            }
48            _ => return Err(Error::Other("Missing + in cid URI.")),
49        };
50        let hash = Hash::from_hex(algo, hex).map_err(Error::text_parse_error)?;
51        Ok(ContentId { hash })
52    }
53}
54
55impl FromXmlText for ContentId {
56    fn from_xml_text(value: String) -> Result<Self, Error> {
57        value.parse().map_err(Error::text_parse_error)
58    }
59}
60
61impl AsXmlText for ContentId {
62    fn as_xml_text(&self) -> Result<Cow<'_, str>, Error> {
63        let algo = match self.hash.algo {
64            Algo::Sha_1 => "sha1",
65            Algo::Sha_256 => "sha256",
66            _ => unimplemented!(),
67        };
68        Ok(Cow::Owned(format!(
69            "{}+{}@bob.xmpp.org",
70            algo,
71            self.hash.to_hex()
72        )))
73    }
74}
75
76impl IntoAttributeValue for ContentId {
77    fn into_attribute_value(self) -> Option<String> {
78        let algo = match self.hash.algo {
79            Algo::Sha_1 => "sha1",
80            Algo::Sha_256 => "sha256",
81            _ => unimplemented!(),
82        };
83        Some(format!("{}+{}@bob.xmpp.org", algo, self.hash.to_hex()))
84    }
85}
86
87/// Request for an uncached cid file.
88#[derive(FromXml, AsXml, PartialEq, Debug, Clone)]
89#[xml(namespace = ns::BOB, name = "data")]
90pub struct Data {
91    /// The cid in question.
92    #[xml(attribute)]
93    pub cid: ContentId,
94
95    /// How long to cache it (in seconds).
96    #[xml(attribute(default, name = "max-age"))]
97    pub max_age: Option<usize>,
98
99    /// The MIME type of the data being transmitted.
100    ///
101    /// See the [IANA MIME Media Types Registry][1] for a list of
102    /// registered types, but unregistered or yet-to-be-registered are
103    /// accepted too.
104    ///
105    /// [1]: <https://www.iana.org/assignments/media-types/media-types.xhtml>
106    #[xml(attribute(default, name = "type"))]
107    pub type_: Option<String>,
108
109    /// The actual data.
110    #[xml(text = Base64)]
111    pub data: Vec<u8>,
112}
113
114#[cfg(test)]
115mod tests {
116    use super::*;
117    use minidom::Element;
118    use xso::error::FromElementError;
119
120    #[cfg(target_pointer_width = "32")]
121    #[test]
122    fn test_size() {
123        assert_size!(ContentId, 24);
124        assert_size!(Data, 56);
125    }
126
127    #[cfg(target_pointer_width = "64")]
128    #[test]
129    fn test_size() {
130        assert_size!(ContentId, 48);
131        assert_size!(Data, 112);
132    }
133
134    #[test]
135    fn test_simple() {
136        let cid: ContentId = "sha1+8f35fef110ffc5df08d579a50083ff9308fb6242@bob.xmpp.org"
137            .parse()
138            .unwrap();
139        assert_eq!(cid.hash.algo, Algo::Sha_1);
140        assert_eq!(
141            cid.hash.hash,
142            b"\x8f\x35\xfe\xf1\x10\xff\xc5\xdf\x08\xd5\x79\xa5\x00\x83\xff\x93\x08\xfb\x62\x42"
143        );
144        assert_eq!(
145            cid.into_attribute_value().unwrap(),
146            "sha1+8f35fef110ffc5df08d579a50083ff9308fb6242@bob.xmpp.org"
147        );
148
149        let elem: Element = "<data xmlns='urn:xmpp:bob' cid='sha1+8f35fef110ffc5df08d579a50083ff9308fb6242@bob.xmpp.org'/>".parse().unwrap();
150        let data = Data::try_from(elem).unwrap();
151        assert_eq!(data.cid.hash.algo, Algo::Sha_1);
152        assert_eq!(
153            data.cid.hash.hash,
154            b"\x8f\x35\xfe\xf1\x10\xff\xc5\xdf\x08\xd5\x79\xa5\x00\x83\xff\x93\x08\xfb\x62\x42"
155        );
156        assert!(data.max_age.is_none());
157        assert!(data.type_.is_none());
158        assert!(data.data.is_empty());
159    }
160
161    #[test]
162    fn invalid_cid() {
163        let error = "Hello world!".parse::<ContentId>().unwrap_err();
164        let message = match error {
165            Error::Other(string) => string,
166            _ => panic!(),
167        };
168        assert_eq!(message, "Missing @ in cid URI.");
169
170        let error = "Hello world@bob.xmpp.org".parse::<ContentId>().unwrap_err();
171        let message = match error {
172            Error::Other(string) => string,
173            _ => panic!(),
174        };
175        assert_eq!(message, "Missing + in cid URI.");
176
177        let error = "sha1+1234@coucou.linkmauve.fr"
178            .parse::<ContentId>()
179            .unwrap_err();
180        let message = match error {
181            Error::Other(string) => string,
182            _ => panic!(),
183        };
184        assert_eq!(message, "Wrong domain for cid URI.");
185
186        let error = "sha1+invalid@bob.xmpp.org"
187            .parse::<ContentId>()
188            .unwrap_err();
189        let message = match error {
190            Error::TextParseError(error) if error.is::<core::num::ParseIntError>() => error,
191            _ => panic!(),
192        };
193        assert_eq!(message.to_string(), "invalid digit found in string");
194    }
195
196    #[test]
197    #[cfg_attr(feature = "disable-validation", should_panic = "Result::unwrap_err")]
198    fn unknown_child() {
199        let elem: Element = "<data xmlns='urn:xmpp:bob' cid='sha1+8f35fef110ffc5df08d579a50083ff9308fb6242@bob.xmpp.org'><coucou/></data>"
200            .parse()
201            .unwrap();
202        let error = Data::try_from(elem).unwrap_err();
203        let message = match error {
204            FromElementError::Invalid(Error::Other(string)) => string,
205            _ => panic!(),
206        };
207        assert_eq!(message, "Unknown child in Data element.");
208    }
209}
xmpp_parsers/bob.rs

xmpp_parsers/
bob.rs
