Bug 1258565 - Add documentation about addon malware telemetry. r=bsmedberg
authorAndy McKay <amckay@mozilla.com>
Wed, 21 Sep 2016 15:04:00 -0400
changeset 314860 6a52aa73d6ea6c19b379894f17928fe80e05f63b
parent 314859 9456e0185872a6262940f549aa50e67072de26cc
child 314861 772130b85f12d3567b221f665c6181a56c72a3a8
push id30735
push usercbook@mozilla.com
push dateThu, 22 Sep 2016 09:55:35 +0000
treeherdermozilla-central@f0e6cc636021 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersbsmedberg
bugs1258565
milestone52.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1258565 - Add documentation about addon malware telemetry. r=bsmedberg
toolkit/components/telemetry/docs/data/addons-malware-ping.rst
toolkit/components/telemetry/docs/data/index.rst
new file mode 100644
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/addons-malware-ping.rst
@@ -0,0 +1,42 @@
+
+Add-ons malware ping
+====================
+
+This ping is generated by an add-on created by Mozilla and shipped to users on older versions of Firefox (44-46). The ping contains information about the profile that might have been altered by a third party malicious add-on.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      type: "malware-addon-states",
+      ...
+      clientId: <UUID>,
+      environment: { ... },
+      // Common ping data.
+      payload: {
+        // True if the blocklist was disabled at startup time.
+        blocklistDisabled: <bool>,
+        // True if the malicious add-on exists and is enabled. False if it
+        // exists and is disabled or null if the add-on was not found.
+        mainAddonActive: <bool | null>,
+        // A value of the malicious add-on block list state, or null if the
+        // add-on was not found.
+        mainAddonBlocked: <int | null>,
+        // True if a malicious user.js file was found in the profile.
+        foundUserJS: <bool>,
+        // If a malicious secmodd.db file was found the extension ID that the // file contained..
+        secmoddAddon: <string | null>, .
+        // A list of IDs for extensions which were hidden by malicious CSS.
+        hiddenAddons: [
+          <string>,
+          ...
+        ],
+        // A mapping of installed add-on IDs with known malicious
+        // update URL patterns to their exact update URLs.
+        updateURLs: {
+          <extensionID>: <updateURL>,
+          ...
+        }
+      }
+    }
--- a/toolkit/components/telemetry/docs/data/index.rst
+++ b/toolkit/components/telemetry/docs/data/index.rst
@@ -8,10 +8,11 @@ Data documentation
    :glob:
 
    common-ping
    environment
    main-ping
    deletion-ping
    crash-ping
    *-ping
+   addons-malware-ping
 
 The `mozilla-pipeline-schemas repository <https://github.com/mozilla-services/mozilla-pipeline-schemas/>`_ contains schemas for some of the pings.