tree: b99550dfc9590b2062b9dab982c81929286abe50 [path history] [tgz]
  1. BUILD.gn
  2. DEPS
  3. OWNERS
  4. PRESUBMIT.py
  5. README.md
  6. chrome_cleaner_args.gni
  7. chrome_utils/
  8. cleaner/
  9. components/
  10. constants/
  11. crash/
  12. engines/
  13. executables/
  14. http/
  15. ipc/
  16. logging/
  17. mojom/
  18. os/
  19. parsers/
  20. proto/
  21. pup_data/
  22. scanner/
  23. settings/
  24. strings/
  25. test/
  26. tools/
  27. ui/
  28. zip_archiver/
chrome/chrome_cleaner/README.md

Chrome Cleanup Tool

This directory contains the source code for the Chrome Cleanup Tool, a standalone application distributed to Chrome users to find and remove Unwanted Software (UwS).

The tool and its tests are Windows-only.

Integration with Chrome

The application is distributed in two versions:

  1. A Chrome component named the Software Reporter that finds UwS but does not have the ability to delete anything.
  2. A separate download named Chrome Cleanup Tool that both finds and removes UwS.

The Software Reporter runs in the background and, if it finds UwS that can be removed, reports this to Chrome. Chrome then downloads the full Cleanup Tool and shows a prompt on the settings page asking the user for permission to remove the UwS.

This directory contains the source for both.

Code in Chromium that deals with the Software Reporter Tool and Chrome Cleanup Tool includes:

Internal Resources

If |is_official_chrome_cleaner_build| is set in GN, the build looks for internal resources in the chrome_cleaner/internal directory. These resources are not open source so are only available internally to Google. They include the licensed scanning engine used to find real-world UwS.

Otherwise the build will link to the test scanning engine in chrome/chrome_cleaner/engines/target/test_engine_delegate.cc which only detects test files. This is the default when building on the Chromium buildbots.

To ship a non-test version of the tool, implement EngineDelegate to wrap an engine that can detect and remove UwS. The engine will be run inside a sandbox with low privileges. To perform operations like opening file handles, scanning process memory, and deleting files, the engine will need to call the callbacks passed to EngineDelegate as |privileged_file_calls|, |privileged_scan_calls| and |privileged_removal_calls|.

Status

Code complete. Some tests are still in the Google internal repository.

The unit tests (chrome_cleaner_unittests.exe) are built and executed on the Chromium buildbots. The final binaries (chrome_cleanup_tool.exe and software_reporter_tool.exe) are also built because chrome_cleaner_unittests has an artificial dependency on them, but nothing currently executes them.

TODO(crbug.com/949669): add an integration test that builds and runs the binaries, and remove the artificial dependency.

Contact

joenotcharles@google.com