File: deep_scanning_metadata.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 (117 lines) | stat: -rw-r--r-- 5,118 bytes parent folder | download | duplicates (3)
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
// Copyright 2025 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_DOWNLOAD_PROTECTION_DEEP_SCANNING_METADATA_H_
#define CHROME_BROWSER_SAFE_BROWSING_DOWNLOAD_PROTECTION_DEEP_SCANNING_METADATA_H_

#include "base/files/file_path.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "chrome/browser/download/download_item_warning_data.h"
#include "chrome/browser/safe_browsing/download_protection/download_protection_util.h"
#include "chrome/browser/safe_browsing/download_protection/download_request_maker.h"
#include "components/download/public/common/download_danger_type.h"
#include "components/download/public/common/download_item.h"
#include "components/enterprise/connectors/core/common.h"
#include "content/public/browser/browser_context.h"
#include "url/gurl.h"

namespace safe_browsing {

// Download metadata interface with the subset of methods needed for safe
// browsing deep scanning operations.
class DeepScanningMetadata {
 public:
  // Wraps a `ScopedObservation` in order to stop observing when the metadata or
  // the observer is destroyed.
  class DownloadScopedObservation {
   public:
    DownloadScopedObservation(DeepScanningMetadata* metadata,
                              download::DownloadItem::Observer* observer);
    ~DownloadScopedObservation();

    void Stop();
    void Observe(download::DownloadItem* source);

   private:
    std::unique_ptr<base::ScopedObservation<download::DownloadItem,
                                            download::DownloadItem::Observer>>
        observation_;
    raw_ptr<DeepScanningMetadata> metadata_;
  };

  virtual ~DeepScanningMetadata() = default;

  // File metadata accessor methods used in deep scanning.
  virtual content::BrowserContext* GetBrowserContext() const = 0;
  virtual safe_browsing::ReferrerChain GetReferrerChain() const = 0;
  virtual const base::FilePath& GetFullPath() const = 0;
  virtual const base::FilePath& GetTargetFilePath() const = 0;
  virtual const std::string& GetHash() const = 0;
  virtual int64_t GetTotalBytes() const = 0;
  virtual std::string GetMimeType() const = 0;
  virtual const GURL& GetURL() const = 0;
  virtual const GURL& GetTabUrl() const = 0;
  virtual bool HasUserGesture() const = 0;
  virtual bool IsObfuscated() const = 0;
  virtual bool IsTopLevelEncryptedArchive() const = 0;
  virtual bool IsForDownloadItem(download::DownloadItem* download) const = 0;

  // Returns danger type before deep scanning begins, and used as a fallback
  // value if deep scanning fails or is interrupted.
  // For `DownloadItem`, danger type is updated with `DownloadCheckResult` when
  // content checks are completed.
  virtual download::DownloadDangerType GetDangerType() const = 0;

  // Converts pre-scan danger type to the corresponding event result.
  virtual enterprise_connectors::EventResult GetPreScanEventResult(
      download::DownloadDangerType danger_type) const = 0;

  // Populates download request fields from download metadata.
  virtual std::unique_ptr<DownloadRequestMaker>
  CreateDownloadRequestFromMetadata(
      scoped_refptr<BinaryFeatureExtractor> binary_feature_extractor) const = 0;

  // Methods currently only relevant to deep scan requests on `DownloadItem`.
  virtual void SetDeepScanTrigger(
      DownloadItemWarningData::DeepScanTrigger trigger) const {}
  virtual void SetHasIncorrectPassword(bool has_incorrect_password) const {}
  virtual void OpenDownload() const {}

  // Show deep scan prompt for password for encrypted archives.
  virtual void PromptForPassword() const {}

  // Attaches file metadata to corresponding scanning response for
  // `DownloadItem`.
  virtual void AddScanResultMetadata(
      const enterprise_connectors::FileMetadata& file_metadata) const {}

  // Makes `observer` start observing this metadata's underlying DownloadItem.
  // Returns a `DownloadScopedObservation` object that will stop the observation
  // when destroyed.
  // IMPORTANT: The returned `DownloadScopedObservation` must be destroyed
  // before this `DeepScanningMetadata` to avoid potential use-after-free
  // issues.
  virtual std::unique_ptr<DownloadScopedObservation> GetDownloadObservation(
      download::DownloadItem::Observer* observer) = 0;

  // Removes the observation from the internal tracking.
  // Called by `DownloadScopedObservation` when it's destroyed.
  virtual void RemoveObservation(download::DownloadItem::Observer* observer) {}

  // Runs download callback with appropriate deep scan result.
  virtual void ProcessScanResult(DownloadCheckResultReason reason,
                                 DownloadCheckResult deep_scan_result) = 0;

 protected:
  // Potentially overrides the deep scan result based on verdict reason and
  // precedence.
  DownloadCheckResult MaybeOverrideScanResult(
      DownloadCheckResultReason reason,
      DownloadCheckResult deep_scan_result);
};

}  // namespace safe_browsing

#endif  // CHROME_BROWSER_SAFE_BROWSING_DOWNLOAD_PROTECTION_DEEP_SCANNING_METADATA_H_