rust-lang / rust-lang/rust

Carriage return without line feed can be used to hide malicious code

Open
#151,473 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-diagnostics A-lints A-parser C-discussion I-lang-radar T-compiler T-lang
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

The issue is basically in the title: rustc parses a carriage return ("\r") as a proper whitespace token. However, on some platforms/systems (for example cat in my linux terminal), the carriage return is interpreted as simply returning the cursor to the beginning of the line and overwriting what follows.

Hence the following file:

fn do_something_very_bad() {
     todo!()
}

fn main() {
     do_something_very_bad();\r    // No need to worry here, this looks very innocuous, I think nothing bad will happen
     println!("Oh hi! You should definitely run this very innocuous binary");
}

is displayed as

fn do_something_very_bad() {
     todo!()
}

fn main() {
     // No need to worry here, this looks very innocuous, I think nothing bad will happen
     println!("Oh hi! You should definitely run this very innocuous binary");
}

The security team and I agree that this does not qualify as a security issue.

In the past, we have added lint to safe-guard against CVE-2021-42574 (https://blog.rust-lang.org/2021/11/01/cve-2021-42574/), which is similar and was treated as a security issue. However to quote Pietro: "the main reason we treated [CVE-2021-42574] that way back then was that editors and code review tools didn't handle it at all, while most editors and code review sites seem to handle \r gracefully".

We may be opening a can of worm by trying to properly handle all Unicode messes that may lead to wrong displays of code across all possible systems allowing to read code, but I think it it nonetheless worth it to have the possibility of a discussion.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how rustc tokenizes carriage returns and the existing lint added for CVE-2021-42574. The issue names no files or tests and leaves the desired handling open for discussion; done would require an agreed approach and corresponding validation for carriage-return source files.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.