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.

Sign up for GitHub

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

Jump to bottom

--json-pp allows writing to non-regular files #3590

Closed
armijnhemel opened this issue Nov 17, 2023 · 2 comments
Closed

--json-pp allows writing to non-regular files #3590

armijnhemel opened this issue Nov 17, 2023 · 2 comments
Labels
bug

Comments

@armijnhemel
Copy link
Contributor

Description

Related to #3588 and #3589

scancode allows writing to device files such as /dev/null without an error. While it is possible to write to device files (as it is basically a black hole) it is possibly not something that was intended. I would have at least expected a warning (I could imagine that sending output to /dev/null could be useful in some test circumstances but it is not normal use of scancode).

How To Reproduce

Write to /dev/null:

$ ./scancode -l scancode --json-pp /dev/null
Setup plugins...
Collect file inventory...
Scan files for: licenses with 1 process(es)...
[####################] 2                  
Scanning done.
Summary:        licenses with 1 process(es)
Errors count:   0
Scan Speed:     1.70 files/sec. 
Initial counts: 1 resource(s): 1 file(s) and 0 directorie(s) 
Final counts:   1 resource(s): 1 file(s) and 0 directorie(s) 
Timings:
  scan_start: 2023-11-17T140919.392112
  scan_end:   2023-11-17T140923.125503
  setup_scan:licenses: 3.14s
  setup: 3.14s
  scan: 0.59s
  total: 3.74s
Removing temporary files...done.

and to /dev/zero:

$ ./scancode -l scancode --json-pp /dev/zero
Setup plugins...
Collect file inventory...
Scan files for: licenses with 1 process(es)...
[####################] 2                  
Scanning done.
Summary:        licenses with 1 process(es)
Errors count:   0
Scan Speed:     1.89 files/sec. 
Initial counts: 1 resource(s): 1 file(s) and 0 directorie(s) 
Final counts:   1 resource(s): 1 file(s) and 0 directorie(s) 
Timings:
  scan_start: 2023-11-17T140929.777710
  scan_end:   2023-11-17T140933.459251
  setup_scan:licenses: 3.15s
  setup: 3.15s
  scan: 0.53s
  total: 3.68s
Removing temporary files...done.

System configuration

For bug reports, it really helps us to know:

  • What OS are you running on? (Windows/MacOS/Linux)
  • What version of scancode-toolkit was used to generate the scan file?
  • What installation method was used to install/run scancode? (pip/source download/other)
This was referenced Nov 17, 2023
Open
Open
Open
@pombredanne
Copy link
Member

Closed in favor of #3596

@pombredanne pombredanne mentioned this issue Nov 22, 2023
Closed
pombredanne added a commit that referenced this issue Nov 24, 2023
@pombredanne
Validate CLI inputs and paths #3596
548b4b3 
This is to ensure that the input are regular files or directories
and that the output are writable files if they pre-exist.

This is a fix for closely related issues:

Referenced-by: #3588
Referenced-by: #3589
Referenced-by: #3590
Referenced-by: #3591
Referenced-by: #3592
Referenced-by: #3593
Referenced-by: #3594
Referenced-by: #3595
Referenced-by: #3596

Reported-by: Armijn Hemel @armijnhemel
Reported-by: Till Jaeger @LeChasseur
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne pombredanne mentioned this issue Nov 24, 2023
Merged
6 tasks
@armijnhemel
Copy link
Contributor Author

This seems to have been fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pombredanne @armijnhemel