71fd0b42f2
## Issue Addressed N/A ## Proposed Changes Fix clippy lints for latest rust version 1.63. I have allowed the [derive_partial_eq_without_eq](https://rust-lang.github.io/rust-clippy/master/index.html#derive_partial_eq_without_eq) lint as satisfying this lint would result in more code that we might not want and I feel it's not required. Happy to fix this lint across lighthouse if required though.
121 lines
3.2 KiB
Rust
121 lines
3.2 KiB
Rust
use serde::{de, Deserialize, Deserializer, Serialize, Serializer};
|
|
use std::fmt;
|
|
use std::str::FromStr;
|
|
use url::Url;
|
|
|
|
#[derive(Debug)]
|
|
pub enum SensitiveError {
|
|
InvalidUrl(String),
|
|
ParseError(url::ParseError),
|
|
RedactError(String),
|
|
}
|
|
|
|
impl fmt::Display for SensitiveError {
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
write!(f, "{:?}", self)
|
|
}
|
|
}
|
|
|
|
// Wrapper around Url which provides a custom `Display` implementation to protect user secrets.
|
|
#[derive(Clone, PartialEq)]
|
|
pub struct SensitiveUrl {
|
|
pub full: Url,
|
|
pub redacted: String,
|
|
}
|
|
|
|
impl fmt::Display for SensitiveUrl {
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
self.redacted.fmt(f)
|
|
}
|
|
}
|
|
|
|
impl fmt::Debug for SensitiveUrl {
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
self.redacted.fmt(f)
|
|
}
|
|
}
|
|
|
|
impl AsRef<str> for SensitiveUrl {
|
|
fn as_ref(&self) -> &str {
|
|
self.redacted.as_str()
|
|
}
|
|
}
|
|
|
|
impl Serialize for SensitiveUrl {
|
|
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
|
where
|
|
S: Serializer,
|
|
{
|
|
serializer.serialize_str(self.full.as_ref())
|
|
}
|
|
}
|
|
|
|
impl<'de> Deserialize<'de> for SensitiveUrl {
|
|
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
|
where
|
|
D: Deserializer<'de>,
|
|
{
|
|
let s: String = Deserialize::deserialize(deserializer)?;
|
|
SensitiveUrl::parse(&s)
|
|
.map_err(|e| de::Error::custom(format!("Failed to deserialize sensitive URL {:?}", e)))
|
|
}
|
|
}
|
|
|
|
impl FromStr for SensitiveUrl {
|
|
type Err = SensitiveError;
|
|
|
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
|
Self::parse(s)
|
|
}
|
|
}
|
|
|
|
impl SensitiveUrl {
|
|
pub fn parse(url: &str) -> Result<Self, SensitiveError> {
|
|
let surl = Url::parse(url).map_err(SensitiveError::ParseError)?;
|
|
SensitiveUrl::new(surl)
|
|
}
|
|
|
|
fn new(full: Url) -> Result<Self, SensitiveError> {
|
|
let mut redacted = full.clone();
|
|
redacted
|
|
.path_segments_mut()
|
|
.map_err(|_| SensitiveError::InvalidUrl("URL cannot be a base.".to_string()))?
|
|
.clear();
|
|
redacted.set_query(None);
|
|
|
|
if redacted.has_authority() {
|
|
redacted.set_username("").map_err(|_| {
|
|
SensitiveError::RedactError("Unable to redact username.".to_string())
|
|
})?;
|
|
redacted.set_password(None).map_err(|_| {
|
|
SensitiveError::RedactError("Unable to redact password.".to_string())
|
|
})?;
|
|
}
|
|
|
|
Ok(Self {
|
|
full,
|
|
redacted: redacted.to_string(),
|
|
})
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn redact_remote_url() {
|
|
let full = "https://project:secret@example.com/example?somequery";
|
|
let surl = SensitiveUrl::parse(full).unwrap();
|
|
assert_eq!(surl.to_string(), "https://example.com/");
|
|
assert_eq!(surl.full.to_string(), full);
|
|
}
|
|
#[test]
|
|
fn redact_localhost_url() {
|
|
let full = "http://localhost:5052/";
|
|
let surl = SensitiveUrl::parse(full).unwrap();
|
|
assert_eq!(surl.to_string(), "http://localhost:5052/");
|
|
assert_eq!(surl.full.to_string(), full);
|
|
}
|
|
}
|