ipfs/kubo

Escape paths in `ipfs ls`

Open

#5887 opened on Jan 2, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wanted

Description

Running ipfs object patch add-link QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn $(echo -e '\e[1;1H\e[44;37m\e[K\e[2;1HHI\e[34m_\e[37mTHERE!\e[3;1H\e[K\e[49;39m') QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn gets us a really fun hash - QmUKpty1aF3ak42WTnebPsGkYyq6A6g9Jt2fYpanwzk6tx.

ipfs ls on that hash will print HI THERE on a blue background.

We should detect \e (and other characters like space) and escape it in cli encoder

Contributor guide

Tech stack
go
Domain
clisecurity
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingunderstanding of terminal escape sequences
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue is about escaping escape sequences (like \e) in the CLI output of `ipfs ls`. The fix likely involves modifying the CLI encoder in the go ipfs codebase, possibly in the `core/commands/ls.go` or related files. Look for where the output string is formatted and ensure that characters like \e (0x1b) are escaped before printing. A maintainer may need to confirm the desired approach (e.g., using fmt.Sprintf or a sanitization function). No existing PRs or comments provide further direction.