eme.rs

 1// Copyright (c) 2017 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 try_from::TryFrom;
 8
 9use minidom::Element;
10
11use error::Error;
12
13use ns;
14
15/// Structure representing an `<encryption xmlns='urn:xmpp:eme:0'/>` element.
16#[derive(Debug, Clone)]
17pub struct ExplicitMessageEncryption {
18    /// Namespace of the encryption scheme used.
19    pub namespace: String,
20
21    /// User-friendly name for the encryption scheme, should be `None` for OTR,
22    /// legacy OpenPGP and OX.
23    pub name: Option<String>,
24}
25
26impl TryFrom<Element> for ExplicitMessageEncryption {
27    type Err = Error;
28
29    fn try_from(elem: Element) -> Result<ExplicitMessageEncryption, Error> {
30        check_self!(elem, "encryption", ns::EME);
31        check_no_children!(elem, "encryption");
32        check_no_unknown_attributes!(elem, "encryption", ["namespace", "name"]);
33        Ok(ExplicitMessageEncryption {
34            namespace: get_attr!(elem, "namespace", required),
35            name: get_attr!(elem, "name", optional),
36        })
37    }
38}
39
40impl From<ExplicitMessageEncryption> for Element {
41    fn from(eme: ExplicitMessageEncryption) -> Element {
42        Element::builder("encryption")
43                .ns(ns::EME)
44                .attr("namespace", eme.namespace)
45                .attr("name", eme.name)
46                .build()
47    }
48}
49
50#[cfg(test)]
51mod tests {
52    use super::*;
53
54    #[test]
55    fn test_simple() {
56        let elem: Element = "<encryption xmlns='urn:xmpp:eme:0' namespace='urn:xmpp:otr:0'/>".parse().unwrap();
57        let encryption = ExplicitMessageEncryption::try_from(elem).unwrap();
58        assert_eq!(encryption.namespace, "urn:xmpp:otr:0");
59        assert_eq!(encryption.name, None);
60
61        let elem: Element = "<encryption xmlns='urn:xmpp:eme:0' namespace='some.unknown.mechanism' name='SuperMechanism'/>".parse().unwrap();
62        let encryption = ExplicitMessageEncryption::try_from(elem).unwrap();
63        assert_eq!(encryption.namespace, "some.unknown.mechanism");
64        assert_eq!(encryption.name, Some(String::from("SuperMechanism")));
65    }
66
67    #[test]
68    fn test_unknown() {
69        let elem: Element = "<replace xmlns='urn:xmpp:message-correct:0'/>".parse().unwrap();
70        let error = ExplicitMessageEncryption::try_from(elem).unwrap_err();
71        let message = match error {
72            Error::ParseError(string) => string,
73            _ => panic!(),
74        };
75        assert_eq!(message, "This is not a encryption element.");
76    }
77
78    #[test]
79    fn test_invalid_child() {
80        let elem: Element = "<encryption xmlns='urn:xmpp:eme:0'><coucou/></encryption>".parse().unwrap();
81        let error = ExplicitMessageEncryption::try_from(elem).unwrap_err();
82        let message = match error {
83            Error::ParseError(string) => string,
84            _ => panic!(),
85        };
86        assert_eq!(message, "Unknown child in encryption element.");
87    }
88
89    #[test]
90    fn test_serialise() {
91        let elem: Element = "<encryption xmlns='urn:xmpp:eme:0' namespace='coucou'/>".parse().unwrap();
92        let eme = ExplicitMessageEncryption { namespace: String::from("coucou"), name: None };
93        let elem2 = eme.into();
94        assert_eq!(elem, elem2);
95    }
96}