mz_ore/
url.rs

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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License in the LICENSE file at the
// root of this repository, or online at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! URL utilities.

use std::fmt;
use std::ops::Deref;
use std::str::FromStr;

#[cfg(feature = "proptest")]
use proptest::prelude::{Arbitrary, BoxedStrategy, Strategy};
use serde::{Deserialize, Serialize};
use url::Url;

/// A URL that redacts its password when formatted.
#[derive(Clone, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct SensitiveUrl(pub Url);

impl SensitiveUrl {
    /// Converts into the underlying URL with the password redacted if it
    /// exists.
    pub fn into_redacted(mut self) -> Url {
        if self.0.password().is_some() {
            self.0.set_password(Some("<redacted>")).unwrap();
        }
        self.0
    }

    /// Formats as a string without redacting the password.
    pub fn to_string_unredacted(&self) -> String {
        self.0.to_string()
    }
}

impl fmt::Display for SensitiveUrl {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.clone().into_redacted().fmt(f)
    }
}

impl fmt::Debug for SensitiveUrl {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.clone().into_redacted().fmt(f)
    }
}

impl FromStr for SensitiveUrl {
    type Err = url::ParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(Self(Url::from_str(s)?))
    }
}

impl Deref for SensitiveUrl {
    type Target = Url;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

#[cfg(feature = "cli")]
#[derive(Clone, Debug)]
/// clap parser for SensitiveUrl
pub struct SensitiveUrlParser;

#[cfg(feature = "cli")]
impl clap::builder::TypedValueParser for SensitiveUrlParser {
    type Value = SensitiveUrl;

    fn parse_ref(
        &self,
        cmd: &clap::Command,
        arg: Option<&clap::Arg>,
        value: &std::ffi::OsStr,
    ) -> Result<Self::Value, clap::Error> {
        let s = value
            .to_str()
            .ok_or_else(|| clap::Error::new(clap::error::ErrorKind::InvalidUtf8).with_cmd(cmd))?;
        let url = s.parse().map_err(|_e| {
            let mut err = clap::Error::new(clap::error::ErrorKind::ValueValidation);
            if let Some(arg) = arg {
                err.insert(
                    clap::error::ContextKind::InvalidArg,
                    clap::error::ContextValue::String(arg.to_string()),
                );
            }
            err.insert(
                clap::error::ContextKind::InvalidValue,
                clap::error::ContextValue::String("<redacted>".to_string()),
            );
            // TODO: waiting on https://github.com/clap-rs/clap/issues/5065
            // to be resolved
            // err.set_source(e);
            err
        })?;
        Ok(SensitiveUrl(url))
    }
}

#[cfg(feature = "cli")]
impl clap::builder::ValueParserFactory for SensitiveUrl {
    type Parser = SensitiveUrlParser;

    fn value_parser() -> Self::Parser {
        SensitiveUrlParser
    }
}

#[cfg(feature = "proptest")]
impl Arbitrary for SensitiveUrl {
    type Parameters = ();
    type Strategy = BoxedStrategy<Self>;

    fn arbitrary_with(_: Self::Parameters) -> Self::Strategy {
        proptest::sample::select(vec![
            SensitiveUrl::from_str("http://user:pass@example.com").unwrap(),
            SensitiveUrl::from_str("http://user@example.com").unwrap(),
            SensitiveUrl::from_str("http://example.com").unwrap(),
        ])
        .boxed()
    }
}