874
edits
Webpagemakerapi: Difference between revisions
→Risk considerations: changed from rel=nofollow to x-robots-tag
(Created page with "= Document Overview = {| |'''Feature/Product:''' || WebPageMaker for Summer Campaign |- |'''Projected Freeze Date:''' || <...") |
(→Risk considerations: changed from rel=nofollow to x-robots-tag) |
||
| (14 intermediate revisions by 3 users not shown) | |||
| Line 6: | Line 6: | ||
|'''Projected Freeze Date:''' || <Placeholder> | |'''Projected Freeze Date:''' || <Placeholder> | ||
|- | |- | ||
|'''Product Champions:''' || [ | |'''Product Champions:''' || [https://mozillians.org/simonwex Simon Wex], [[User:davida|David Ascher]], Michelle Levesque | ||
|- | |- | ||
|'''Privacy Champions:''' || | |'''Privacy Champions:''' || | ||
| Line 16: | Line 16: | ||
Timeline | ==Timeline== | ||
|'''WebPageMaker Checkpoint #2 | {| | ||
|'''WebPageMaker Checkpoint #2''' || All production issues (scalability, privacy standards, etc.) have been resolved. || '''20-May-2012 (*soon*)''' | |||
|} | |||
= Introduction to WebPageMakerAPI's Client -- WebPageMaker = | = Introduction to WebPageMakerAPI's Client -- WebPageMaker = | ||
| Line 29: | Line 31: | ||
* Easily make a new guided learning experience. | * Easily make a new guided learning experience. | ||
For more information on WebPageMaker, see | For more information on WebPageMaker, see [https://etherpad.mozilla.org/webpagemaker-pitch WebPageMaker for Summer Campaign] | ||
= WebPageMakerAPI Overview = | = WebPageMakerAPI Overview = | ||
The API is a two-endpoint HTTP API that accepts (via POST) HTML documents and serves those documents via a short url. The HTML documents are cleaned by | The API is a two-endpoint HTTP API that accepts (via POST) HTML documents and serves those documents via a short url. The HTML documents are cleaned by [http://pypi.python.org/pypi/bleach Bleach] before being served. [https://github.com/mozilla/playdoh Playdoh] is the planned implementation framework. | ||
== API Methods == | |||
These are documented in the [https://github.com/mozilla/webpagemaker/tree/development/webpagemaker/api#readme API README]. | |||
== Stored Data == | |||
End-user created HTML documents are stored in MySQL. | |||
== Risk considerations == | |||
{| class="wikitable" | |||
|- | |||
! Risk | |||
! Mitigation Strategy | |||
|- | |||
| Copyrighted work can be stored and distributed through the API | |||
| | |||
* Documents will require DOCTYPE definitions and syntactically correct HTML | |||
* Documents will be limited to 10,000 characters | |||
|- | |||
| Documents hosted via the API could be used as link farms | |||
| | |||
* Documents will be delivered with a <code>X-Robots-Tag: noindex, nofollow</code> header. | |||
|- | |||
| Javascript could be used in a multitude of ways to compromise client machines | |||
| | |||
* All Javascript will be stripped using Bleach before it is served | |||
|- | |||
| Database insertion could be used as a DOS attack vector | |||
| | |||
* Rate limiting will be implemented along with above size limitations | |||
|} | |||