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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
//* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 ProtocolParser_h__
#define ProtocolParser_h__
#include "HashStore.h"
#include "chromium/safebrowsing.pb.h"
namespace mozilla {
namespace safebrowsing {
/**
* Abstract base class for parsing update data in multiple formats.
*/
class ProtocolParser {
public:
struct ForwardedUpdate {
nsCString table;
nsCString url;
};
ProtocolParser();
virtual ~ProtocolParser();
nsresult Status() const { return mUpdateStatus; }
#ifdef MOZ_SAFEBROWSING_DUMP_FAILED_UPDATES
virtual nsCString GetRawTableUpdates() const { return mPending; }
#endif
virtual void SetCurrentTable(const nsACString& aTable) = 0;
void SetRequestedTables(const nsTArray<nsCString>& aRequestTables) {
mRequestedTables = aRequestTables.Clone();
}
nsresult Begin(const nsACString& aTable,
const nsTArray<nsCString>& aUpdateTables);
virtual nsresult AppendStream(const nsACString& aData) = 0;
uint32_t UpdateWaitSec() { return mUpdateWaitSec; }
// Notify that the inbound data is ready for parsing if progressive
// parsing is not supported, for example in V4.
virtual void End() = 0;
RefPtr<TableUpdate> GetTableUpdate(const nsACString& aTable);
void ForgetTableUpdates() { mTableUpdates.Clear(); }
const TableUpdateArray& GetTableUpdates() { return mTableUpdates; }
// These are only meaningful to V2. Since they were originally public,
// moving them to ProtocolParserV2 requires a dymamic cast in the call
// sites. As a result, we will leave them until we remove support
// for V2 entirely..
virtual const nsTArray<ForwardedUpdate>& Forwards() const {
return mForwards;
}
bool ResetRequested() const { return !mTablesToReset.IsEmpty(); }
const nsTArray<nsCString>& TablesToReset() const { return mTablesToReset; }
protected:
virtual RefPtr<TableUpdate> CreateTableUpdate(
const nsACString& aTableName) const = 0;
nsCString mPending;
nsresult mUpdateStatus;
// Keep track of updates to apply before passing them to the DBServiceWorkers.
TableUpdateArray mTableUpdates;
nsTArray<ForwardedUpdate> mForwards;
// The table names that were requested from the client.
nsTArray<nsCString> mRequestedTables;
// The table names that failed to update and need to be reset.
nsTArray<nsCString> mTablesToReset;
// How long we should wait until the next update.
uint32_t mUpdateWaitSec;
};
/**
* Helpers to parse the "shavar", "digest256" and "simple" list formats.
*/
class ProtocolParserV2 final : public ProtocolParser {
public:
ProtocolParserV2();
virtual ~ProtocolParserV2();
virtual void SetCurrentTable(const nsACString& aTable) override;
virtual nsresult AppendStream(const nsACString& aData) override;
virtual void End() override;
// Update information.
virtual const nsTArray<ForwardedUpdate>& Forwards() const override {
return mForwards;
}
#ifdef MOZ_SAFEBROWSING_DUMP_FAILED_UPDATES
// Unfortunately we have to override to return mRawUpdate which
// will not be modified during the parsing, unlike mPending.
virtual nsCString GetRawTableUpdates() const override { return mRawUpdate; }
#endif
private:
virtual RefPtr<TableUpdate> CreateTableUpdate(
const nsACString& aTableName) const override;
nsresult ProcessControl(bool* aDone);
nsresult ProcessExpirations(const nsCString& aLine);
nsresult ProcessChunkControl(const nsCString& aLine);
nsresult ProcessForward(const nsCString& aLine);
nsresult AddForward(const nsACString& aUrl);
nsresult ProcessChunk(bool* done);
// Remove this, it's only used for testing
nsresult ProcessPlaintextChunk(const nsACString& aChunk);
nsresult ProcessShaChunk(const nsACString& aChunk);
nsresult ProcessHostAdd(const Prefix& aDomain, uint8_t aNumEntries,
const nsACString& aChunk, uint32_t* aStart);
nsresult ProcessHostSub(const Prefix& aDomain, uint8_t aNumEntries,
const nsACString& aChunk, uint32_t* aStart);
nsresult ProcessHostAddComplete(uint8_t aNumEntries, const nsACString& aChunk,
uint32_t* aStart);
nsresult ProcessHostSubComplete(uint8_t numEntries, const nsACString& aChunk,
uint32_t* start);
// Digest chunks are very similar to shavar chunks, except digest chunks
// always contain the full hash, so there is no need for chunk data to
// contain prefix sizes.
nsresult ProcessDigestChunk(const nsACString& aChunk);
nsresult ProcessDigestAdd(const nsACString& aChunk);
nsresult ProcessDigestSub(const nsACString& aChunk);
bool NextLine(nsACString& aLine);
enum ParserState { PROTOCOL_STATE_CONTROL, PROTOCOL_STATE_CHUNK };
ParserState mState;
enum ChunkType {
// Types for shavar tables.
CHUNK_ADD,
CHUNK_SUB,
// Types for digest256 tables. digest256 tables differ in format from
// shavar tables since they only contain complete hashes.
CHUNK_ADD_DIGEST,
CHUNK_SUB_DIGEST
};
struct ChunkState {
ChunkType type;
uint32_t num;
uint32_t hashSize;
uint32_t length;
void Clear() {
num = 0;
hashSize = 0;
length = 0;
}
};
ChunkState mChunkState;
// Updates to apply to the current table being parsed.
RefPtr<TableUpdateV2> mTableUpdate;
#ifdef MOZ_SAFEBROWSING_DUMP_FAILED_UPDATES
nsCString mRawUpdate; // Keep a copy of mPending before it's processed.
#endif
};
// Helpers to parse the "proto" list format.
class ProtocolParserProtobuf final : public ProtocolParser {
public:
typedef FetchThreatListUpdatesResponse_ListUpdateResponse ListUpdateResponse;
typedef google::protobuf::RepeatedPtrField<ThreatEntrySet> ThreatEntrySetList;
public:
ProtocolParserProtobuf();
virtual void SetCurrentTable(const nsACString& aTable) override;
virtual nsresult AppendStream(const nsACString& aData) override;
virtual void End() override;
private:
virtual ~ProtocolParserProtobuf();
virtual RefPtr<TableUpdate> CreateTableUpdate(
const nsACString& aTableName) const override;
// For parsing update info.
nsresult ProcessOneResponse(const ListUpdateResponse& aResponse,
nsACString& aListName);
nsresult ProcessAdditionOrRemoval(TableUpdateV4& aTableUpdate,
const ThreatEntrySetList& aUpdate,
bool aIsAddition);
nsresult ProcessRawAddition(TableUpdateV4& aTableUpdate,
const ThreatEntrySet& aAddition);
nsresult ProcessRawRemoval(TableUpdateV4& aTableUpdate,
const ThreatEntrySet& aRemoval);
nsresult ProcessEncodedAddition(TableUpdateV4& aTableUpdate,
const ThreatEntrySet& aAddition);
nsresult ProcessEncodedRemoval(TableUpdateV4& aTableUpdate,
const ThreatEntrySet& aRemoval);
};
} // namespace safebrowsing
} // namespace mozilla
#endif
|
