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.
The application is distributed in two versions:
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:
To build all targets for this project, use:
The main build targets are:
There is also a tool,
generate_test_uws, which will create some harmless text files that the tool will detect as UwS:
The public 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.
is_internal_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.
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
To check out the internal resources set both of these to True in .gclient:
checkout_src_internal(standard argument defined in DEPS)
checkout_chrome_cleaner_internal(defined in src-internal's DEPS, causes the internal resources to be checked out under
To actually build with the internal resources, also set
is_internal_chrome_cleaner_build to true in args.gn.
The build is controlled by the following arguments that can be set in args.gn:
is_internal_chrome_cleaner_build: If true, GN targets will depend on targets in chrome/chrome_cleaner/internal, otherwise will depend only on public resources.
is_official_chrome_cleaner_build: If true, various development options will be disabled since the build is meant for release to end users.
enable_software_reporter: This is true by default for
is_chrome_brandedbuilds, but can be set to false if a Chrome branded build is needed but Software Reporter execution is not required.
version_path: Paths to resource files that will be used to populate the VERSIONINFO of the executables.
is_internal_chrome_cleaner_buildis set, these are overridden to identify as Google.
Please file bugs / feature requests / inquiries using the Services>SafeBrowsing>ChromeCleanup component for tracking.