File: extension_telemetry_file_processor.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (91 lines) | stat: -rw-r--r-- 3,422 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_SAFE_BROWSING_EXTENSION_TELEMETRY_EXTENSION_TELEMETRY_FILE_PROCESSOR_H_
#define CHROME_BROWSER_SAFE_BROWSING_EXTENSION_TELEMETRY_EXTENSION_TELEMETRY_FILE_PROCESSOR_H_

#include "base/containers/flat_set.h"
#include "base/files/file_path.h"
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "base/values.h"

namespace base {
class FilePath;
}  // namespace base

namespace safe_browsing {

// Given an extension root path, the FileProcessor does the following:
//   - Computes and retrieves the installed file hashes
//   - Retrieves the manifest.json file contents
// The FileProcessor is owned and instantiated by ExtensionTelemetryService when
// it is enabled and destroyed when it is disabled. This object lives on a
// different sequence from the ExtensionTelemetryService because it performs
// blocking file read operations.
class ExtensionTelemetryFileProcessor {
 public:
  ExtensionTelemetryFileProcessor();

  ExtensionTelemetryFileProcessor(const ExtensionTelemetryFileProcessor&) =
      delete;
  ExtensionTelemetryFileProcessor& operator=(
      const ExtensionTelemetryFileProcessor&) = delete;

  virtual ~ExtensionTelemetryFileProcessor();

  // Selects and processes installed extension files from the given root
  // directory. Returns files data in a Dict:
  // <file path 1, file hash 1>
  // ...
  // <file path N, file hash N>
  // <manifest.json, file contents>
  // Each file path is relative starting from the extension root. Manifest.json
  // file is unhashed.
  base::Value::Dict ProcessExtension(const base::FilePath& root_dir);

  void SetMaxFilesToProcessForTest(int64_t max_files_to_process);
  void SetMaxFileSizeBytesForTest(int64_t max_file_size);
  void SetMaxFilesToReadForTest(int64_t max_files_to_read);

 protected:
  struct FileExtensionsComparator;

  using SortedFilePaths =
      base::flat_set<base::FilePath, FileExtensionsComparator>;

  // TODO(richche): Process other types of files until |max_files_to_process_|
  // limit is reached.
  // Retrieves installed extension files to process. Applicable files:
  //   - Only JavaScript, HTML, CSS files and sorted in that file type
  //   order
  //   - Ignore empty files
  //   - Ignore files over max_file_size_ limit
  SortedFilePaths RetrieveFilePaths(const base::FilePath& root_dir);

  // Hashes the given list of extension files and returns a Dict of <relative
  // file path, file hash> until |max_files_to_process_| is reached.
  base::Value::Dict ComputeHashes(const base::FilePath& root_dir,
                                  const SortedFilePaths& file_paths);

  // Returns true if a file has JS, HTML, or CSS extension.
  bool IsApplicableType(const base::FilePath& file_path);

  // Max number of files processed per extension.
  size_t max_files_to_process_;

  // Max file size limit for extension files in bytes.
  int64_t max_file_size_;

  // Max number of files read limit enforced in case an extension has too many
  // files.
  int64_t max_files_to_read_;

  SEQUENCE_CHECKER(sequence_checker_);

  base::WeakPtrFactory<ExtensionTelemetryFileProcessor> weak_factory_{this};
};

}  // namespace safe_browsing
#endif  // CHROME_BROWSER_SAFE_BROWSING_EXTENSION_TELEMETRY_EXTENSION_TELEMETRY_FILE_PROCESSOR_H_