EngineeringProductivity/HowTo/SignExtensions

Update: June 2017

In the Add-on manager now checks isInAutomation to see if Firefox is running in the test suite or not. If it is, then the signing checks are bypassed. Meaning that most of this document is now no longer relevant. All new tests should not need to sign an add-on. There might be some old tests that are still affected.

With the new addon signing requirement, working with addons in mozilla-central gets a little more complicated. Anytime an addon is modified, it will need to be version bumped and re-signed. Yes, even if you just want to add a dump statement to debug a try run. Yuck! This guide is intended to provide all the information you need to work with signed addons in mozilla-central. At first, signing will largely be a manual process, but eventually tooling will improve and the process will get easier.

Prerequisites

1. Obtain the signing keys. You'll need LDAP to access them. If you do not have LDAP, unfortunately you will not be able to sign addons in mozilla-central.

2. Install jpm by following the official instructions. Make sure you have at least version 1.0.5 by running:

   $ jpm --version

Note: jpm is one way to sign add-ons, there is also a REST API interface for this, it uses the same keys.

Signing an Addon

You've made changes to an addon, and want to check them into the tree. But automation won't pick your changes up until you've signed it. Here's what you need to do step by step.

1. Bump the version number in install.rdf. It's not possible to sign the same version twice, so each change requires a version bump. If appropriate, you may want to add a new minor version number (e.g x.y.z).

2. If your addon is not generated by the build, skip to step 3. Otherwise, you'll first need to build your addon with `mach build`. After building, cd to the final addon directory (usually in $OBJDIR/dist/xpi-stage).

3. Pack the addon into an xpi. An xpi file is simply a renamed zip file. For example, you could use:

   $ zip -r my-addon.xpi .

4. Sign the addon with jpm and the credentials you obtained from step 1 of the prerequisites:

   $ jpm sign --api-key <amo key> --api-secret <amo secret> --xpi <path to xpi>

5. If validation failed, open the link to see what needs to be changed. If it was successful, you should have a new .xpi file in your working directory. If appropriate, move and/or rename this file to whatever the relevant automation is expecting. If it's not obvious why signing failed, please contact the Add-ons team (usually #amo works). The signing through addons.mozilla.org is a bit stricter about what it accepts than might be needed for mozilla-central.

6. Add the signed addon to your commit:

   $ hg add my-addon-signed.xpi
   $ hg commit -m "Bug 1234567 - Update my-addon.xpi"

Common Footguns

Here are some problems to watch out for:

• If you or someone else previously bumped an addon's version number to test changes on try, but never actually committed the changes, then simply incrementing that addon's version number by one won't work. You'll need the last signed version, which is not necessarily the last checked in version.
• After an addon is signed by one key, it can't later be signed by a second. So it's important to use the shared automation account.
• If you have accidentally signed an add-on yourself, AMO allows an add-on to be shared by multiple owners. Go to addons.mozilla.org > Tools > Manage My Submissions > [Your add-on] > Manage Authors and add "release+signaddons@mozilla.com" as an owner.
• Addons with an application id of "toolkit@mozilla.org" don't currently get signed by design on AMO and jpm won't warn you of this. To fix this, change the application id to Firefox's uuid.

How to Avoid Addon Signing

Signing addons can potentially be a pretty big pain. But with a bit of effort, that pain can be avoided.

Don't use Addons

The best way to avoid the hassle of addon signing, is to not use addons! Often addons are used as a means of running JavaScript in chrome scope. Many years ago they were the only viable option to do this, but that is no longer the case. There are several tools like specialpowers or marionette, that allow chrome privileges to content scopes. So if you find yourself writing an addon simply to execute some chrome JS, do a bit of research and make sure there isn't an easier solution available.

Use Temporary Addons

If you absolutely must use an addon, there is a way to work around signing via temporary addons. Temporary addons have a few limitations:

• They must be bootstrapped
• They'll get uninstalled on Firefox restart
• They can't be installed via the profile (you'll need to be able to run chrome JS)

If those restrictions don't bother you, you can use the `AddonManager.installTemporaryAddon()` API to install them. You'll need a way to run chrome privileged JS to install it. Alternatively, there's also a marionette API to install it. For example:

   from marionette_driver.addons import Addons
   addons = Addons(marionette)
   addons.install('path/to/bootstrapped-addon.xpi', temp=True)

If this is an option for you, the short term hassle may be worth the long term benefit of not having to sign.

Tested unsigned addons in unbranded builds

If need to test unsigned extensions in a build, you can use a build that isn't in either beta or release streams. There are plans to provide unbranded builds for extension providers to use for testing based on beta and release streams, see bug 1186522