cdk-common 0.18.0-rc.0

//! Helpers for formatting potentially sensitive values safely.

use url::Url;

const INVALID_URL_FOR_LOGS: &str = "[INVALID URL]";

/// Return a URL suitable for logs and `Debug` output by removing userinfo,
/// query parameters, and fragments.
///
/// Malformed URLs and URL forms whose userinfo cannot be removed are replaced
/// entirely so the original value cannot leak through a fallback path.
pub fn url_for_logs(value: &str) -> String {
    let Ok(mut url) = Url::parse(value) else {
        return INVALID_URL_FOR_LOGS.to_owned();
    };

    if url.set_password(None).is_err() || url.set_username("").is_err() {
        return INVALID_URL_FOR_LOGS.to_owned();
    }

    url.set_query(None);
    url.set_fragment(None);

    url.to_string()
}

#[cfg(test)]
mod tests {
    use super::{url_for_logs, INVALID_URL_FOR_LOGS};

    #[test]
    fn removes_url_credentials() {
        let url = "https://alice:s3cr3t@example.com:8443/api?network=main#tip";

        let logged_url = url_for_logs(url);

        assert_eq!(logged_url, "https://example.com:8443/api");
        assert!(!logged_url.contains("alice"));
        assert!(!logged_url.contains("s3cr3t"));
    }

    #[test]
    fn removes_credentials_from_custom_scheme() {
        let url = "ssl://alice:s3cr3t@example.com:50002";

        assert_eq!(url_for_logs(url), "ssl://example.com:50002");
    }

    #[test]
    fn preserves_ipv6_port_and_path() {
        let url = "https://user:pass@[2001:db8::1]:3002/api";

        assert_eq!(url_for_logs(url), "https://[2001:db8::1]:3002/api");
    }

    #[test]
    fn preserves_url_without_credentials() {
        let url = "https://example.com/api";

        assert_eq!(url_for_logs(url), url);
    }

    #[test]
    fn removes_query_parameters_and_fragments() {
        let url = "https://example.com/api?token=query-secret#fragment-secret";

        let logged_url = url_for_logs(url);

        assert_eq!(logged_url, "https://example.com/api");
        assert!(!logged_url.contains("query-secret"));
        assert!(!logged_url.contains("fragment-secret"));
    }

    #[test]
    fn malformed_url_is_not_logged() {
        let url = "not a URL with user:secret@example.com";

        let logged_url = url_for_logs(url);

        assert_eq!(logged_url, INVALID_URL_FOR_LOGS);
        assert!(!logged_url.contains("secret"));
    }
}