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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_testcontentanalysis_h
#define mozilla_testcontentanalysis_h
#include <processthreadsapi.h>
#include <errhandlingapi.h>
#include <vector>
#include "ContentAnalysis.h"
#include "content_analysis/sdk/analysis_client.h"
#include "gtest/gtest.h"
#include "mozilla/media/MediaUtils.h"
#include "mozilla/Services.h"
#include "mozilla/SpinEventLoopUntil.h"
#include "nsCOMArray.h"
#include "nsIContentAnalysis.h"
#include "nsIObserver.h"
#include "nsIObserverService.h"
#include "nsNetUtil.h"
#include "nsString.h"
#include "nsThreadUtils.h"
constexpr const char* kAllowUrlPref =
"browser.contentanalysis.allow_url_regex_list";
constexpr const char* kDenyUrlPref =
"browser.contentanalysis.deny_url_regex_list";
constexpr const char* kPipePathNamePref =
"browser.contentanalysis.pipe_path_name";
constexpr const char* kIsDLPEnabledPref = "browser.contentanalysis.enabled";
constexpr const char* kDefaultResultPref =
"browser.contentanalysis.default_result";
constexpr const char* kTimeoutPref = "browser.contentanalysis.agent_timeout";
constexpr const char* kTimeoutResultPref =
"browser.contentanalysis.timeout_result";
constexpr const char* kClientSignaturePref =
"browser.contentanalysis.client_signature";
constexpr const char* kMaxConnections =
"browser.contentanalysis.max_connections";
struct BoolStruct {
bool mValue = false;
};
struct MozAgentInfo {
PROCESS_INFORMATION processInfo;
std::unique_ptr<content_analysis::sdk::Client> client;
MozAgentInfo() : processInfo{0} {}
void TerminateProcess() {
if (processInfo.hProcess == nullptr) {
return; // No process to terminate.
}
DWORD exitCode = 0;
BOOL result = ::GetExitCodeProcess(processInfo.hProcess, &exitCode);
EXPECT_NE(static_cast<BOOL>(0), result);
EXPECT_EQ(STILL_ACTIVE, exitCode);
BOOL terminateResult = ::TerminateProcess(processInfo.hProcess, 0);
ASSERT_NE(FALSE, terminateResult)
<< "Failed to terminate content_analysis_sdk_agent process";
// Wait for process to exit
const DWORD PROCESS_EXIT_TIMEOUT_IN_MS = 2000;
EXPECT_EQ(WAIT_OBJECT_0, ::WaitForSingleObject(processInfo.hProcess,
PROCESS_EXIT_TIMEOUT_IN_MS))
<< "Failed to wait for content_analysis_sdk_agent process to exit";
CloseHandle(processInfo.hProcess);
processInfo.hProcess = nullptr;
}
};
void GeneratePipeName(const wchar_t* prefix, nsString& pipeName);
void LaunchAgentWithCommandLineArguments(const nsString& cmdLineArguments,
const nsString& pipeName,
MozAgentInfo& agentInfo);
MozAgentInfo LaunchAgentNormal(const wchar_t* aToBlock,
const wchar_t* aToWarn = L"warn");
MozAgentInfo LaunchAgentNormal(const wchar_t* aToBlock, const wchar_t* aToWarn,
const nsString& pipeName);
inline nsCString GenerateUUID() {
nsID id = nsID::GenerateUUID();
return nsCString(id.ToString().get());
}
inline RefPtr<mozilla::CancelableRunnable> QueueTimeoutToMainThread(
RefPtr<mozilla::media::Refcountable<BoolStruct>> aTimedOut) {
RefPtr<mozilla::CancelableRunnable> timer = NS_NewCancelableRunnableFunction(
"timeout", [&] { aTimedOut->mValue = true; });
#if defined(MOZ_ASAN)
// This can be pretty slow on ASAN builds (bug 1895256)
constexpr uint32_t kCATimeout = 25000;
#else
constexpr uint32_t kCATimeout = 10000;
#endif
EXPECT_EQ(NS_OK,
NS_DelayedDispatchToCurrentThread(do_AddRef(timer), kCATimeout));
return timer;
}
inline nsCOMPtr<nsIURI> GetExampleDotComURI() {
nsCOMPtr<nsIURI> uri;
MOZ_ALWAYS_SUCCEEDS(NS_NewURI(getter_AddRefs(uri), "https://example.com"));
return uri;
}
void SendRequestAndExpectResponse(
RefPtr<mozilla::contentanalysis::ContentAnalysis> contentAnalysis,
const nsCOMPtr<nsIContentAnalysisRequest>& request,
mozilla::Maybe<bool> expectedShouldAllow,
mozilla::Maybe<nsIContentAnalysisResponse::Action> expectedAction,
mozilla::Maybe<bool> expectedIsCached);
void SendRequestAndExpectResponseInternal(
RefPtr<mozilla::contentanalysis::ContentAnalysis> contentAnalysis,
const nsCOMPtr<nsIContentAnalysisRequest>& request,
mozilla::Maybe<bool> expectedShouldAllow,
mozilla::Maybe<nsIContentAnalysisResponse::Action> expectedAction,
mozilla::Maybe<bool> expectedIsCached, bool aIsEarlyResponse);
// Sends a request that is expected to return an early result
// because the allow or deny lists will handle it. This means
// this method does not wait for an agent acknowlegement, since
// one will not be sent.
inline void SendRequestAndWaitForEarlyResult(
RefPtr<mozilla::contentanalysis::ContentAnalysis> contentAnalysis,
const nsCOMPtr<nsIContentAnalysisRequest>& request,
mozilla::Maybe<bool> expectedShouldAllow) {
SendRequestAndExpectResponseInternal(contentAnalysis, request,
expectedShouldAllow, mozilla::Nothing(),
mozilla::Nothing(), true);
}
class RawAcknowledgementObserver final : public nsIObserver {
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIOBSERVER
const std::vector<content_analysis::sdk::ContentAnalysisAcknowledgement>&
GetAcknowledgements() {
return mAcknowledgements;
}
private:
~RawAcknowledgementObserver() = default;
std::vector<content_analysis::sdk::ContentAnalysisAcknowledgement>
mAcknowledgements;
};
template <typename T>
inline void ParseFromWideModifiedString(T* aTarget, const char16_t* aData) {
std::wstring dataWideString(reinterpret_cast<const wchar_t*>(aData));
std::vector<uint8_t> dataVector(dataWideString.size());
for (size_t i = 0; i < dataWideString.size(); ++i) {
// Since this data is really bytes and not a null-terminated string, the
// calling code adds 0xFF00 to every member to ensure there are no 0 values.
dataVector[i] = static_cast<uint8_t>(dataWideString[i] - 0xFF00);
}
EXPECT_TRUE(aTarget->ParseFromArray(dataVector.data(), dataVector.size()));
}
#endif
|
