chrome/common/extensions/docs/crx.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/crx.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: fix Created 8 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

« chrome/common/extensions/docs/build/build.py ('K') | « chrome/common/extensions/docs/cookies.html ('k') | chrome/common/extensions/docs/debugger.html » ('j') | chrome/common/extensions/docs/js/api_page_generator.js » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: chrome/common/extensions/docs/crx.html

diff --git a/chrome/common/extensions/docs/crx.html b/chrome/common/extensions/docs/crx.html

deleted file mode 100644

index 3c2f3954555ecc3227f78c43b3f48a4f066e2a06..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/crx.html

+++ /dev/null

@@ -1,385 +0,0 @@

-<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

- 1) The <head> information in this page is significant, should be uniform

- across api docs and should be edited only with knowledge of the

- templating mechanism.

- 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

- browser, it will be re-generated from the template, json schema and

- authored overview content.

- 4) The <body>.innerHTML is also generated by an offline step so that this

- page may easily be indexed by search engines.

---><html xmlns="http://www.w3.org/1999/xhtml"><head>

- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">

- </script>

- <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">

- </script>

- <script type="text/javascript" src="js/api_page_generator.js"></script>

- <script type="text/javascript" src="js/bootstrap.js"></script>

- <script type="text/javascript" src="js/sidebar.js"></script>

- <title>CRX Package Format - Google Chrome Extensions - Google Code</title></head>

- <body> <div id="devModeWarning" class="displayModeWarning">

- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

- </div>

- <div id="branchWarning" class="displayModeWarning">

- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

- It may not work with the stable release of Chrome.</span>

- <select id="branchChooser">

- <option>Choose a different version...

- </option><option value="">Stable

- </option><option value="beta">Beta

- </option><option value="dev">Dev

- </option><option value="trunk">Trunk

- </option></select>

- </div>

- <div id="unofficialWarning" class="displayModeWarning">

- <span>WARNING: This is unofficial documentation. It may not work with the

- current release of Chrome.</span>

- <button id="goToOfficialDocs">Go to the official docs</button>

- </div>

- <div id="gc-container" class="labs">

-

- <!-- In particular, sub-templates that recurse, must be used by allowing

- jstemplate to make a copy of the template in this section which

- are not operated on by way of the jsskip="true" -->

-

- <a id="top"></a>

- <div id="skipto">

- <a href="#gc-pagecontent">Skip to page content</a>

- <a href="#gc-toc">Skip to main navigation</a>

- </div>

-

- <table id="header" width="100%" cellspacing="0" border="0">

- <tbody><tr>

- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>

- <td valign="middle" width="100%" style="padding-left:0.6em;">

- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

- <div id="gsc-search-box">

- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

- <input type="hidden" name="ie" value="UTF-8">

- <input type="text" name="q" value="" size="55">

- <input class="gsc-search-button" type="submit" name="sa" value="Search">

- <br>

- <span class="greytext">e.g. "page action" or "tabs"</span>

- </div>

- </form>

- <script type="text/javascript" src="https://www.google.com/jsapi"></script>

- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

- </td>

- </tr>

- </tbody></table>

- <div id="codesiteContent" class="">

- <a id="gc-topnav-anchor"></a>

- <div id="gc-topnav">

- <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>

- <ul id="home" class="gc-topnav-tabs">

- <li id="home_link">

- <a href="index.html" title="Google Chrome Extensions home page">Home</a>

- </li>

- <li id="docs_link">

- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

- </li>

- <li id="faq_link">

- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

- </li>

- <li id="samples_link">

- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

- </li>

- <li id="group_link">

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- <li id="so_link">

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

- </li>

- </ul>

- </div>

- <div class="g-section g-tpl-170">

-

- <div class="g-unit g-first" id="gc-toc">

- <ul>

- <li><a href="getstarted.html">Getting Started</a></li>

- <li><a href="overview.html">Overview</a></li>

- <li><a href="whats_new.html">What's New?</a></li>

- <li><h2><a href="devguide.html">Developer's Guide</a></h2>

- <ul>

- <li>Browser UI

- <ul>

- <li><a href="browserAction.html">Browser Actions</a></li>

- <li><a href="contextMenus.html">Context Menus</a></li>

- <li><a href="notifications.html">Desktop Notifications</a></li>

- <li><a href="omnibox.html">Omnibox</a></li>

- <li><a href="options.html">Options Pages</a></li>

- <li><a href="override.html">Override Pages</a></li>

- <li><a href="pageAction.html">Page Actions</a></li>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

- <li><a href="bookmarks.html">Bookmarks</a></li>

- <li><a href="cookies.html">Cookies</a></li>

- <li><a href="devtools.html">Developer Tools</a></li>

- <li><a href="events.html">Events</a></li>

- <li><a href="history.html">History</a></li>

- <li><a href="management.html">Management</a></li>

- <li><a href="tabs.html">Tabs</a></li>

- <li><a href="windows.html">Windows</a></li>

- </ul>

- </li>

- <li>Implementation

- <ul>

- <li><a href="a11y.html">Accessibility</a></li>

- <li><a href="background_pages.html">Background Pages</a></li>

- <li><a href="content_scripts.html">Content Scripts</a></li>

- <li><a href="xhr.html">Cross-Origin XHR</a></li>

- <li><a href="i18n.html">Internationalization</a></li>

- <li><a href="messaging.html">Message Passing</a></li>

- <li><a href="permissions.html">Optional Permissions</a></li>

- <li><a href="npapi.html">NPAPI Plugins</a></li>

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="hosting.html">Hosting</a></li>

- <li><a href="external_extensions.html">Other Deployment Options</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

- <li><h2><a href="tutorials.html">Tutorials</a></h2>

- <ul>

- <li><a href="tut_debugging.html">Debugging</a></li>

- <li><a href="tut_analytics.html">Google Analytics</a></li>

- <li><a href="tut_oauth.html">OAuth</a></li>

- </ul>

- </li>

- <li><h2>Reference</h2>

- <ul>

- <li>Formats

- <ul>

- <li><a href="manifest.html">Manifest Files</a></li>

- <li><a href="match_patterns.html">Match Patterns</a></li>

- </ul>

- </li>

- <li><a href="permission_warnings.html">Permission Warnings</a></li>

- <li><a href="api_index.html">chrome.* APIs</a></li>

- <li><a href="api_other.html">Other APIs</a></li>

- </ul>

- </li>

- <li><h2><a href="samples.html">Samples</a></h2></li>

- <div class="line"> </div>

- <li><h2>More</h2>

- <ul>

- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

- <li><a href="themes.html">Themes</a></li>

- </ul>

- </li>

- </ul>

- </div>

- <script>

- initToggles();

- </script>

- <div class="g-unit" id="gc-pagecontent">

- <div id="pageTitle">

- <h1 class="page_title">CRX Package Format</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#H2-0">Package header</a>

- <ol>

- </ol>

- </li><li>

- <a href="#H2-1">Extension contents</a>

- <ol>

- </ol>

- </li><li>

- <a href="#H2-2">Example</a>

- <ol>

- </ol>

- </li><li>

- <a href="#scripts">Packaging scripts</a>

- <ol>

- <li>

- <a href="#ruby">Ruby</a>

- </li><li>

- <a href="#H3-5">Bash</a>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static"><div id="pageData-name" class="pageData">CRX Package Format</div>

-<div id="pageData-showTOC" class="pageData">true</div>

-<p>

-CRX files are ZIP files with a special header and the <code>.crx</code> file

-extension.

-</p>

-<a name="H2-0"></a><h2>Package header</h2>

-<p>

-The header contains the author's public key and the extension's signature.

-The signature is generated from the ZIP file using SHA-1 with the

-author's private key. The header requires a little-endian byte ordering with

-4-byte alignment. The following table describes the fields of

-the <code>.crx</code> header in order:

-</p>

-<table>

- <tbody><tr>

- <th>Field</th><th>Type</th><th>Length</th><th>Value</th><th>Description</th>

- </tr>

- <tr>

- <td><em>magic number</em></td><td>char[]</td><td>32 bits</td><td>Cr24</td>

- <td>

- Chrome requires this constant at the beginning of every <code>.crx</code>

- package.

- </td>

- </tr>

- <tr>

- <td><em>version</em></td><td>unsigned int</td><td>32 bits</td><td>2</td>

- <td>The version of the <code>*.crx</code> file format used (currently 2).</td>

- </tr>

- <tr>

- <td><em>public key length</em></td><td>unsigned int</td><td>32 bits</td>

- <td><i>pubkey.length</i></td>

- <td>

- The length of the RSA public key in <em>bytes</em>.

- </td>

- </tr>

- <tr>

- <td><em>signature length</em></td><td>unsigned int</td><td>32 bits</td>

- <td><i>sig.length</i></td>

- <td>

- The length of the signature in <em>bytes</em>.

- </td>

- </tr>

- <tr>

- <td><em>public key</em></td><td>byte[]</td><td><i>pubkey.length</i></td>

- <td><i>pubkey.contents</i></td>

- <td>

- The contents of the author's RSA public key, formatted as an X509

- SubjectPublicKeyInfo block.

- </td>

- </tr>

- <tr>

- <td><em>signature</em></td><td>byte[]</td><td><i>sig.length</i></td>

- <td><i>sig.contents</i></td>

- <td>

- The signature of the ZIP content using the author's private key. The

- signature is created using the RSA algorithm with the SHA-1 hash function.

- </td>

- </tr>

-</tbody></table>

-<a name="H2-1"></a><h2>Extension contents</h2>

-<p>

-The extension's ZIP file is appended to the <code>*.crx</code> package after the

-header. This should be the same ZIP file that the signature in the header

-was generated from.

-</p>

-<a name="H2-2"></a><h2>Example</h2>

-<p>

-The following is an example hex dump from the beginning of a <code>.crx</code>

-file.

-</p>

-<pre>43 72 32 34 # "Cr24" -- the magic number

-02 00 00 00 # 2 -- the crx format version number

-A2 00 00 00 # 162 -- length of public key in bytes

-80 00 00 00 # 128 -- length of signature in bytes

-........... # the contents of the public key

-........... # the contents of the signature

-........... # the contents of the zip file

-</pre>

-<h2 id="scripts">Packaging scripts</h2>

-<p>

-Members of the community have written the following scripts to package

-<code>.crx</code> files.

-</p>

-<h3 id="ruby">Ruby</h3>

-<blockquote>

-<a href="http://github.com/Constellation/crxmake">github: crxmake</a>

-</blockquote>

-<a name="H3-5"></a><h3>Bash</h3>

-<pre>#!/bin/bash -e

-# Purpose: Pack a Chromium extension directory into crx format

-if test $# -ne 2; then

- echo "Usage: crxmake.sh <extension dir> <pem path>"

- exit 1

-fi

-dir=$1

-key=$2

-name=$(basename "$dir")

-crx="$name.crx"

-pub="$name.pub"

-sig="$name.sig"

-zip="$name.zip"

-trap 'rm -f "$pub" "$sig" "$zip"' EXIT

-# zip up the crx dir

-cwd=$(pwd -P)

-(cd "$dir" && zip -qr -9 -X "$cwd/$zip" .)

-# signature

-openssl sha1 -sha1 -binary -sign "$key" < "$zip" > "$sig"

-# public key

-openssl rsa -pubout -outform DER < "$key" > "$pub" 2>/dev/null

-byte_swap () {

- # Take "abcdefgh" and return it as "ghefcdab"

- echo "${1:6:2}${1:4:2}${1:2:2}${1:0:2}"

-crmagic_hex="4372 3234" # Cr24

-version_hex="0200 0000" # 2

-pub_len_hex=$(byte_swap $(printf '%08x\n' $(ls -l "$pub" | awk '{print $5}')))

-sig_len_hex=$(byte_swap $(printf '%08x\n' $(ls -l "$sig" | awk '{print $5}')))

- echo "$crmagic_hex $version_hex $pub_len_hex $sig_len_hex" | xxd -r -p

- cat "$pub" "$sig" "$zip"

-) > "$crx"

-echo "Wrote $crx"

-</pre>

-</div>

-

-

- </div>

- </div>

- </div>

- <div id="gc-footer" --="">

- <div class="text">

- <p>

- Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,

- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons

- Attribution 3.0 License</a>, and code samples are licensed under the

- <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.

- </p>

- <p>

- </p>

-

-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>

-<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>

-<script type="text/javascript">

- // chrome doc tracking

- try {

- var engdocs = _gat._getTracker("YT-10763712-2");

- engdocs._trackPageview();

- } catch(err) {}

- // code.google.com site-wide tracking

- try {

- _uacct="UA-18071-1";

- _uanchor=1;

- _uff=0;

- urchinTracker();

- }

- catch(e) {/* urchinTracker not available. */}

-</script>

-

- </div>

- </div>

- </div>

-</body></html>