salvo-oapi 0.95.0

OpenApi support for Salvo web framework
Documentation 
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

pub(crate) fn escape_html(value: &str) -> String {
    let mut escaped = String::with_capacity(value.len());
    for ch in value.chars() {
        match ch {
            '&' => escaped.push_str("&"),
            '<' => escaped.push_str("&lt;"),
            '>' => escaped.push_str("&gt;"),
            '"' => escaped.push_str("&quot;"),
            '\'' => escaped.push_str("&#x27;"),
            _ => escaped.push(ch),
        }
    }
    escaped
}

pub(crate) fn json_string(value: &str) -> String {
    script_safe_json(serde_json::to_string(value).unwrap_or_else(|_| "\"\"".to_owned()))
}

/// Escapes characters that could break out of a `<script>` context when serialized
/// JSON is embedded directly into an inline script (`<`, `>`, `&`, U+2028, U+2029).
///
/// Use this for already-serialized JSON values (e.g. a whole config object); for a
/// plain string that still needs quoting use [`json_string`] instead.
pub(crate) fn script_safe_json(json: String) -> String {
    json.replace('<', "\\u003c")
        .replace('>', "\\u003e")
        .replace('&', "\\u0026")
        .replace('\u{2028}', "\\u2028")
        .replace('\u{2029}', "\\u2029")
}

pub(crate) fn style_text(value: &str) -> String {
    value.replace("</", "<\\/")
}

pub(crate) fn keywords_meta(value: &str) -> String {
    let keywords = value
        .split(',')
        .map(str::trim)
        .collect::<Vec<_>>()
        .join(",");
    meta_tag("keywords", &keywords)
}

pub(crate) fn description_meta(value: &str) -> String {
    meta_tag("description", value)
}

fn meta_tag(name: &str, value: &str) -> String {
    format!(
        "<meta name=\"{}\" content=\"{}\">",
        escape_html(name),
        escape_html(value)
    )
}

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

    #[test]
    fn test_escape_html() {
        assert_eq!(
            escape_html(r#"<script a="b">'&</script>"#),
            "&lt;script a=&quot;b&quot;&gt;&#x27;&amp;&lt;/script&gt;"
        );
    }

    #[test]
    fn test_json_string() {
        assert_eq!(json_string(r#"""#), r#""\"""#);
        assert_eq!(
            json_string("</script>&\u{2028}\u{2029}"),
            r#""\u003c/script\u003e\u0026\u2028\u2029""#
        );
    }

    #[test]
    fn test_style_text_breaks_end_tags() {
        assert_eq!(
            style_text("body{color:red}</style><script>alert(1)</script>"),
            "body{color:red}<\\/style><script>alert(1)<\\/script>"
        );
    }

    #[test]
    fn test_keywords_meta_escapes_content() {
        assert_eq!(
            keywords_meta("a,<b>"),
            r#"<meta name="keywords" content="a,&lt;b&gt;">"#
        );
    }
}