CloudServices/WheresMyFox: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(Redirected page to CloudServices/FindMyDevice)
 
(36 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{draft}}
#REDIRECT [[CloudServices/FindMyDevice]]
<h1><i>Where's My Fox</i></h1>
;To provide a means for users to locate, track and purge devices remotely. We are targeting version 1.4 which is FC on March 17, 2014 (and based on Gecko 30).
==v1.4 Important Dates==
*12/09/13 - Scoping Complete/User Story Freeze (?)
*12/18/13 - Branding/Naming Sign Off
*12/09/13 - Demo Day for WMF working prototype
*03/17/14 - Functional Complete
*06/09/14 - Code Freeze
 
==Important People==
For a list of DRIs and what they own, visit: https://wiki.mozilla.org/CloudServices/WheresMyFox/DRIs
 
==Example Use Cases, MVP User Stories==
1) Albert can't remember the location of his phone. Going to a nearby computer, he logs into WheresMyFox and requests the phone to report it's location. The phone reports that it is nearby, so Albert requests the device to ring. Albert quickly finds that his phone is in his coat pocket.
 
2) Bea discovers that her phone is missing. Using a friends phone, she logs into WheresMyFox and requests the phone to report it's location. She discovers that the phone is currently headed down Broadway, and realizes she has left it in the cab. Realizing that she may never see her phone again, she requests the phone to remotely wipe itself, before calling the cab agency to see if she can recover her device.
 
===WMF Setup Via Firefox Accounts from a Firefox OS Phone===
<onlyinclude>
<bugzilla>
{
    "blocks": "940857",
    "resolution": "---",
    "include_fields": "id, priority, summary, status, assigned_to",
    "order": "bug_id"
}
</bugzilla>
==="Where's My fox" website for Desktop (and Mobile?)===
<onlyinclude>
<bugzilla>
{
    "blocks": "941258",
    "resolution": "---",
    "include_fields": "id, priority, summary, status, assigned_to",
    "order": "bug_id"
}
</bugzilla>
</onlyinclude>
 
==Requirements==
# The user must use a secure credentialing and authorization system to identify self and associate to a device.
## The login system is currently Out of Scope of these requirements, but should be or substantially similar to Firefox Accounts.
## A user may have one or more devices.
## A device shall have a Globally Unique Identifier (WTFID).
## A device shall be associated with a single user.
# Data exchanged between client and server shall be via [http://datatracker.ietf.org/doc/draft-ietf-jose-json-web-signature/ JSON Web Signature format]
## The secret shall be generated and stored on the client, and sent to the server ONLY on initialization.
### The secret shall be a 128bit value.
### The secret shall be stored on the device as long as the WTFID remains unchanged.
### A new WTFID shall require a new secret to be generated and the device to reconnect as if new.
### No data shall be preserved in the case of a WTFID changing.
## Data signatures shall use HMAC SHA-256 or any more secure signing method for any exchange EXCEPT for Initialization.
# A remote wipe operation will format any additional storage (e.g. SD card) on the phone and reset the phone to initial Factory conditions.
# Only allow registered user to display and remotely control devices.
## Login and user authorization is delegated to Persona/FirefoxAccounts
## Control panel is secured by https and session cookie.
# Control panel shall securely send commands to:
## report location on a regular interval (for motion tracking)
### record tracking information keeping latest location for device
### Tracking records expire after 10 minutes, with the exception of the last reported location.
#### Last reported location does not expire.
## play a default audio alarm.
### Alarm will repeatedly play for a user specified period of seconds
## lock a device
### Allow a user to specify a key code if not already present on the device.
## display an optional message
### Messages shall be less than 100 non-control ASCII characters
## remove all user information from a device by performing a factory reset
# Securely display web based UI for device including
## current location
## previously recv'd locations, provided they are different than latest location.
# Allow multiple devices per user.
## ''How long to store data?''
 
==Tracking==
<onlyinclude>
<bugzilla>
{
    "blocks": "938896",
    "resolution": "---",
    "include_fields": "id, priority, summary, status, assigned_to",
    "order": "bug_id"
}
</bugzilla>
 
=Design=
==Points of Contact==
Engineer - <i>Name</i> <i>jr@</i>
==Discussions==
https://etherpad.mozilla.org/wheresmyfox-2013-10-28
==Client API Reference/Documentation==
Client UX was presented by Epic:
 
https://www.dropbox.com/sh/uaxlhzz211br438/rH2UA0Tf6_/WIMF_3.0.pdf
 
==Server API Reference/Documentation==
 
API calls will be a combination of REST calls and BOSH where possible. This avoids some of the issues with the fragility of websockets in areas where connectivity is sub-optimal or sporadic.
 
In addition, packet identifiers have been reduced as much as possible. This is to both reduce bandwidth costs as well as require less time to exchange data.
 
To reduce risk of injection attacks, calls will use [https://github.com/hueniverse/hawk Hawk] to sign requests (unless otherwise specified).
 
=== Data Schema ===
Since each server system will be unique, it does not make sense to strictly specify the data storage method. Instead an example storage mechanism will be offered to illustrate how the server would manage data.
 
A simple storage object would be keyed off of the <i>ID</i> returned in the <code>/$v/init</code> call.
 
    <i>key</i> => {"lastPosition":{"lat":<i>lat</i>,            // The last position reported by track
                            "lon":<i>lon</i>,
                            "alt":<i>altitude?</i>,      // Optional "altitude", if provided
                            "tim":<i>UTC</i>},            // UTC Timestamp
            "previousPositions":[{<i>position</i>},...],  // the last 5? position reports for the device
            "state":"<i>(rtn)</i>",                      // the state the server thinks the device is in
            "lockable"<sup>1</sup>:True|False,                // does the device have a user supplied key code<sup>1</sup>
            "lastExchange":<i>UTC</i>,                    // last time an exchange happened
            "secret":<i>HawkSecret</i>,
            "pendingCommand": {<i>outboundCommand</i>}
            }
   
    <i>user</i> => ["<i>key</i>:<i>name</i>",...]               // A list of known keys & user friendly names for devices
 
<sup>1</sup>Note: this should be queried on device. User might set a passcode while the device is active or between updates.
 
=== API ===
Unless otherwise specified, all exchanged blocks are in JSON format and signed using
[https://github.com/hueniverse/hawk HAWK] (not shown here for simplicity).
 
Standard HTTP responses apply (401, 500, 301)
 
==== POST /$v/register ====
Registers the existence of a device.
 
The POSTed JSON payload contains the following fields:
 
<table border=0 cellspacing=0 cellpadding=15>
<tr bgcolor="aaaaa">
  <th>key</th><th>value</th>
</tr>
<tr>
  <td valign="top">'''assert'''</td><td>A Firefox Accounts user assertion</td>
</tr>
<tr bgcolor="eeeee">
  <td valign="top">'''pushurl'''</td><td>The SimplePush channel URL that the server should use to notify the device that it has a new instruction. See <some simplepush link> for more details on acquiring a SimplePush channel.</td>
</tr>
<tr>
  <td valign="top">'''secret'''</td><td>a HAWK valid secret hash key for the device. This is used to sign the JSON responses.</td>
</tr>
<tr bgcolor="eeeee">
  <td valign="top">'''deviceid'''</td><td>The previous deviceid returned by the server from a register call. Used to overwrite a previous pushurl for this device if the SimplePush channel has changed.</td>
</tr>
</table>
 
 
reply from server:
 
<table border=0 cellspacing=0 cellpadding=15>
<tr bgcolor="aaaaa">
  <td>'''key'''</td><td>'''value'''</td>
</tr>
<tr>
  <td valign="top"> '''deviceid'''</td><td>The unique id for this device. This id should be used in all future requests to the server, including any needed reregistration. </td>
</tr>
</table> 
 
 
After a device has registered for the first time, it should immediately call
POST /$v/cmd/$deviceUniqueId with a response as though it had just received a tracking call of:
 
    {"t":{"p":1,"d":1}}
 
==== POST /<version>/cmd/<deviceid> ====
 
A request to the server for any new commands. If the device has just completed a command, the POST body will contain the appropriate information with the results from the last command (see below).
 
The server response consists of a list of commands, of the format
 
<pre>"<command name/short code>":{<command parameters>}</pre>
 
Multiple commands may be combined into a single server response.
 
 
<table border=0 cellpadding=15 cellspacing=0>
<tr bgcolor="aaaaaa">
<th valign=top>Command Name</th><th valign=top>Short Code</th><th valign=top>Additional parameters</th><th valign=top>Details</th>
</tr>
<tr>
  <td>lock</td><td>l</td><td>"c": <lock code></td><td>Specify the lock code to use, if no device lock code is present. If a lock code already exists on the device, lock the device with the
device's lock code.</td>
</tr>
<tr bgcolor="eeeee">
  <td>message</td><td>m</td><td>"m": <message><br>"n": <phone number></td><td>Displays <message> on the device including the contact <phone number>. Contact numbers are limited to 25 characters in the set <code>0123456789 +-()</code>. Messages are limited to 100 standard (non-control) ASCII characters</td>
</tr>
<tr>
  <td>ring</td><td>r</td><td>"d": <duration><br>"p": <period></td><td>Cause the device to ring every <period> seconds for the specified duration. Specifying a duration of 0 cancels any previous ring commands.</td>
</tr>
<tr bgcolor="eeeee">
  <td>track</td><td>t</td><td>"d": <duration><br>"p": <period></td><td>Begin active location tracking on the device, reporting the devices position every <period> seconds for <duration> seconds. See below for the response format for this report. Specifying a duration of 0 stops the device from reporting
its location.</td>
</tr>
<tr>
  <td>erase</td><td>e</td><td></td><td>Erase the device. This performs a factory reset.</td>
</tr>
</table>
 
 
''' Client Responses '''
 
A successful client payload will, for each command in the previous request, be formatted:
 
<pre>"<device command>":{"ok": "true", <additional response values>}</pre>
 
If one of the commands results in an error, the response for that command is
 
<pre>"<device command>":{"ok": "false", "error": "<error details>"}</pre>
 
At this time, the only additional response values are defined for the '''track''' command, and are as follows:
 
<table border=0 cellpadding=15 cellspacing=0>
<tr bgcolor="aaaaaa">
<th valign=top>Key</th><th valign=top>Value</th>
</tr>
<tr>
  <td>la</td><td>The current latitude of the device</td>
</tr>
<tr bgcolor="eeeee">
  <td>lo</td><td>The current longitude of the device</td>
</tr>
<tr>
  <td>ti</td><td>The current UTC time</td>
</tr>
<tr bgcolor="eeeee">
  <td>key</td><td>A boolean defining whether or not a lock key is currently set on the phone.</td>
</tr>
</table>
 
If, for whatever reason, the user has not activated or authorized geo-location for
a device, the "la"/"lo" values may be specified as 0.
 
==== Response Codes ====
 
If the <deviceid> in the URL or payload is unknown, or the HAWK wrapper fails, the URL will return a 401, requiring the device to re-register. Other HTTP response codes (500, 301, 200, etc) perform as per normal.
 
==Platform Requirements==
<i>What are the things this needs (OS, language, databases, etc.)?</i>
 
==Libraries Required==
<i>List of external project dependencies. (Stuff that's not pulled in via the installation script)</i>
* http://godoc.org/github.com/tent/hawk-go
 
==Code Repository==
<i>Links to the published code bases</i>
==Release Schedule==
<i>Predicted code delivery dates</i>
 
=QA=
==Points of Contact==
Engineer - <i>Ed Wong</i> <i>edwong@</i>
 
==Test Framework==
=Security and Privacy=
Tracking bug: [https://bugzilla.mozilla.org/show_bug.cgi?id=935724 935724]
 
* Bug 935725 - Security Review: Where's My Fox
* Bug 935726 - Legal Review: Where's My Fox
* Bug 935727 - Privacy-Technical Review: Where's My Fox
* Bug 935728 - Privacy-Policy Review: Where's My Fox
==Points of Contact==
Legal - udevi@
 
 
==Questionnaire Answers==
===1.1 Goal of Feature ===
===2. Potential Threat Vectors and Mitigation Points===
==Review Status==
https://bugzilla.mozilla.org/show_bug.cgi?id=935725
 
see https://wiki.mozilla.org/Security/Reviews
==Issues and Resolutions==
 
=Operations=
 
==Points of Contact==
==Deployment Architecture==
''Bugzilla Tracking # '' -
==Escalation Paths==
==Lifespan Support Plans==
=Logging and Metrics=
==Points of Contact==
==Tracking Element Definitions==
==Data Retention Plans==
==Dashboard URL==
=Customer Support=
==Points of Contact==
==Sumo Tags==
==Review Meeting==

Latest revision as of 20:42, 11 August 2014

Redirect to:

Retrieved from "https://wiki.allizom.org/index.php?title=CloudServices/WheresMyFox&oldid=1004702"