summaryrefslogtreecommitdiffstats
path: root/toolkit/components/url-classifier/chromium/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'toolkit/components/url-classifier/chromium/README.txt')
-rw-r--r--toolkit/components/url-classifier/chromium/README.txt41
1 files changed, 41 insertions, 0 deletions
diff --git a/toolkit/components/url-classifier/chromium/README.txt b/toolkit/components/url-classifier/chromium/README.txt
new file mode 100644
index 0000000000..e4d4285804
--- /dev/null
+++ b/toolkit/components/url-classifier/chromium/README.txt
@@ -0,0 +1,41 @@
+# Overview
+
+'safebrowsing.proto' is modified from [1] with the following changes:
+
+- Added "package mozilla.safebrowsing;"
+- Added more threatHit information
+
+##################################
+ // Client-reported identification.
+ optional ClientInfo client_info = 5;
+
+ // Details about the user that encountered the threat.
+ message UserInfo {
+ // The UN M.49 region code associated with the user's location.
+ optional string region_code = 1;
+
+ // Unique ID stable over a week or two
+ optional bytes user_id = 2;
+ }
+
+ // Details about the user that encountered the threat.
+ optional UserInfo user_info = 6;
+####################################
+
+to avoid naming pollution. We use this source file along with protobuf compiler (protoc) to generate safebrowsing.pb.h/cc for safebrowsing v4 update and hash completion. The current generated files are compiled by protoc 2.6.1 since the protobuf library in gecko is not upgraded to 3.0 yet.
+
+# Update
+
+If you want to update to the latest upstream version,
+
+1. Checkout the latest one in [2]
+2. Use protoc to generate safebrowsing.pb.h and safebrowsing.pb.cc. For example,
+
+$ protoc -I=. --cpp_out="../protobuf/" safebrowsing.proto
+
+(Note that we should use protoc v2.6.1 [3] to compile. You can find the compiled protoc in [4] if you don't have one.)
+
+[1] https://chromium.googlesource.com/chromium/src.git/+/9c4485f1ce7cac7ae82f7a4ae36ccc663afe806c/components/safe_browsing_db/safebrowsing.proto
+[2] https://chromium.googlesource.com/chromium/src.git/+/master/components/safe_browsing_db/safebrowsing.proto
+[3] https://github.com/google/protobuf/releases/tag/v2.6.1
+[4] https://repo1.maven.org/maven2/com/google/protobuf/protoc