Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metadata: escape display name in email addresses #1832

Merged
merged 3 commits into from
Nov 2, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 58 additions & 2 deletions src/metadata.rs
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ impl Metadata21 {
for author in authors {
match (&author.name, &author.email) {
(Some(name), Some(email)) => {
emails.push(format!("{name} <{email}>"));
emails.push(escape_email_with_display_name(name, email));
}
(Some(name), None) => {
names.push(name.as_str());
Expand All @@ -251,7 +251,7 @@ impl Metadata21 {
for maintainer in maintainers {
match (&maintainer.name, &maintainer.email) {
(Some(name), Some(email)) => {
emails.push(format!("{name} <{email}>"));
emails.push(escape_email_with_display_name(name, email));
}
(Some(name), None) => {
names.push(name.as_str());
Expand Down Expand Up @@ -555,6 +555,23 @@ impl Metadata21 {
}
}

/// Escape email addresses with display name if necessary
/// according to RFC 822 Section 3.3. "specials".
fn escape_email_with_display_name(display_name: &str, email: &str) -> String {
if display_name.chars().any(|c| {
matches!(
c,
'(' | ')' | '<' | '>' | '@' | ',' | ';' | ':' | '\\' | '"' | '.' | '[' | ']'
)
}) {
return format!(
"\"{}\" <{email}>",
display_name.replace('\\', "\\\\").replace('\"', "\\\"")
);
}
format!("{display_name} <{email}>")
}

/// Fold long header field according to RFC 5322 section 2.2.3
/// https://datatracker.ietf.org/doc/html/rfc5322#section-2.2.3
fn fold_header(text: &str) -> String {
Expand Down Expand Up @@ -811,4 +828,43 @@ mod test {
assert_eq!(metadata.license_files[2], manifest_dir.join("NOTICE.md"));
assert_eq!(metadata.license_files[3], manifest_dir.join("AUTHORS.txt"));
}

#[test]
fn test_escape_email_with_display_name_without_special_characters() {
let display_name = "Foo Bar !#$%&'*+-/=?^_`{|}~ 123";
let email = "[email protected]";
let result = escape_email_with_display_name(display_name, email);
assert_eq!(
result,
"Foo Bar !#$%&'*+-/=?^_`{|}~ 123 <[email protected]>"
);
}

#[test]
fn test_escape_email_with_display_name_with_special_characters() {
let tests = [
("Foo ( Bar", "\"Foo ( Bar\""),
("Foo ) Bar", "\"Foo ) Bar\""),
("Foo < Bar", "\"Foo < Bar\""),
("Foo > Bar", "\"Foo > Bar\""),
("Foo @ Bar", "\"Foo @ Bar\""),
("Foo , Bar", "\"Foo , Bar\""),
("Foo ; Bar", "\"Foo ; Bar\""),
("Foo : Bar", "\"Foo : Bar\""),
("Foo \\ Bar", "\"Foo \\\\ Bar\""),
("Foo \" Bar", "\"Foo \\\" Bar\""),
("Foo . Bar", "\"Foo . Bar\""),
("Foo [ Bar", "\"Foo [ Bar\""),
("Foo ] Bar", "\"Foo ] Bar\""),
("Foo ) Bar", "\"Foo ) Bar\""),
("Foo ) Bar", "\"Foo ) Bar\""),
("Foo, Bar", "\"Foo, Bar\""),
];
for (display_name, expected_name) in tests {
let email = "[email protected]";
let result = escape_email_with_display_name(display_name, email);
let expected = format!("{expected_name} <{email}>");
assert_eq!(result, expected);
}
}
}
Loading