McCoy

  • Revision slug: McCoy
  • Revision title: McCoy
  • Revision id: 75512
  • Created:
  • Creator: fscholz
  • Is current revision? No
  • Comment interwiki error; 2 words removed

Revision Content

McCoy is an application that allows add-on authors to provide secure updates to their users. Applications periodically look for and install updates to their add-ons. It's important that the update information retrieved has not been tampered with since being written by the add-on author. Specifically, it focuses on the process of digitally signing update manifests so the applications can verify the integrity of a manifest retrieved over normally insecure channels.

If you want to learn about the technical details of McCoy then visit the {{ interwiki('wikimo', 'McCoy', 'project wiki') }}.

Installing McCoy

To use McCoy you need to download and install it. McCoy is provided in the standard package for your operating system, just extract it where you like and run it.

There are some known issues with running McCoy on Linux. It will not run on older versions of Linux and there are known problems even on up to date systems. We hope to resolve this for the next release.

Uninstalling McCoy

To uninstall McCoy simply delete the applications files. The cryptographic keys and other McCoy data are kept in a profile folder separate from the application so you can uninstall and reinstall without losing your precious keys.

Backing up data

If you need to backup your data or move it from one machine to another you need to take a copy of the profile folder. This is located in:

  •  %APPDATA%\Mozilla\McCoy (Windows)
  • ~/.mozilla/mccoy (Linux)
  • ~/Library/Application Support/McCoy (Mac OS X)
It is highly recommended that you back up your profile folder and store it in a safe location whenever you create a new key; without a backup, there is no way to recover your private keys if they are lost!

Running McCoy

To run McCoy simply run the mccoy executable (or the McCoy application on OS X). The first time it runs it will ask you to create a master password. It is strongly recommended that you use a password to protect your McCoy data. Once you have a password set you can change it from the Keys menu and you will have to enter it each time you run McCoy.

Running McCoy from command line

Currently there is no support to run McCoy from command line under Windows, but it is planned to add this support in the future.
However, there are several external and un-official tools which enable running McCoy from command line:

  1. signOnTheLine - an extension to McCoy
    https://fireclipse.svn.sourceforge.net/svnroot/fireclipse/trunk/FireclipseExtensions/chromebug/mccoy/signOnTheLine/
  2. spock - a tool written in ruby
    http://hyperstruct.net/projects/spock
  3. Bug 396525 - patch to McCoy
    https://bugzilla.mozilla.org/show_bug.cgi?id=396525

Signing update manifests

Before you release your add-on

In order to verify the update manifests applications need to already have information from you for how to verify it. This is in the form of the public part of a cryptographic key included in the original add-on you release.

The first step is to create a cryptographic key. Simply click the "Create" toolbar button or select "Create Key" from the "Keys" menu. You should give the key a name that will remind you what you are using it for. It is up to you how you use your keys, either using one key for all add-ons or one key per add-on would seem sensible choices.

Once you have a key you need to add its public part to your add-on's install.rdf file. The simplest way to do this is to select the key then click the Install toolbar button. You must then locate your install.rdf for McCoy and the public part of the key will be added directly to the file. The file will be overwritten so take a backup if you need to.

You can then include this install.rdf in your add-on's xpi and release it.

{{ Note("If you wish to manually add the public key to the <tt>install.rdf</tt> you can right click the key, select \"Copy Public Key\" and then add it to the file as an updateKey entry.") }}

Releasing an update

Once you are ready to release an updated version of your add-on you must create yourself an update.rdf file. You need to use McCoy to sign this file so that the application can verify that it really came from you. Simply select the key you originally added to the add-on's install.rdf, then click the "Sign" toolbar button, select your update.rdf file and the data in it will be signed. It's important to note that if you change any information in the update file then it must be signed again.

{{ Note("The signing is RDF aware, which means that if you reorganized the XML in the file into a more human readable form but the RDF data remained the same then the signature would still be valid.") }}

{{ languages( { "fr": "fr/McCoy", "ja": "ja/McCoy" } ) }}

Revision Source

<p><strong>McCoy</strong> is an application that allows add-on authors to provide secure updates to their users. Applications periodically look for and install updates to their add-ons. It's important that the update information retrieved has not been tampered with since being written by the add-on author. Specifically, it focuses on the process of digitally signing update manifests so the applications can verify the integrity of a manifest retrieved over normally insecure channels.</p>
<p>If you want to learn about the technical details of McCoy then visit the {{ interwiki('wikimo', 'McCoy', 'project wiki') }}.</p>
<h2 name="Installing_McCoy">Installing McCoy</h2>
<p>To use McCoy you need to download and install it. McCoy is provided in the standard package for your operating system, just extract it where you like and run it.</p>
<ul> <li><a class="external" href="http://www.oxymoronical.com/mccoy/releases/0.5/mccoy-0.5.en-US.win32.zip">mccoy-0.5.en-US.win32.zip</a> (Windows)</li> <li><a class="external" href="http://www.oxymoronical.com/mccoy/releases/0.5/mccoy-0.5.en-US.linux-i686.tar.bz2">mccoy-0.5.en-US.linux-i686.tar.bz2</a> (Linux)</li> <li><a class="external" href="http://www.oxymoronical.com/mccoy/releases/0.5/mccoy-0.5.en-US.mac.dmg">mccoy-0.5.en-US.mac.dmg</a> (Mac OS X Universal)</li>
</ul>
<div class="note">There are some known issues with running McCoy on Linux. It will not run on older versions of Linux and there are known problems even on up to date systems. We hope to resolve this for the next release.</div>
<h2 name="Uninstalling_McCoy">Uninstalling McCoy</h2>
<p>To uninstall McCoy simply delete the applications files. The cryptographic keys and other McCoy data are kept in a profile folder separate from the application so you can uninstall and reinstall without losing your precious keys.</p>
<h2 name="Backing_up_data">Backing up data</h2>
<p>If you need to backup your data or move it from one machine to another you need to take a copy of the profile folder. This is located in:</p>
<ul> <li> %APPDATA%\Mozilla\McCoy (Windows)</li> <li>~/.mozilla/mccoy (Linux)</li> <li>~/Library/Application Support/McCoy (Mac OS X)</li>
</ul>
<div class="note">It is highly recommended that you back up your profile folder and store it in a safe location whenever you create a new key; without a backup, there is no way to recover your private keys if they are lost!</div>
<h2 name="Running_McCoy">Running McCoy</h2>
<p>To run McCoy simply run the <code>mccoy</code> executable (or the McCoy application on OS X). The first time it runs it will ask you to create a master password. It is strongly recommended that you use a password to protect your McCoy data. Once you have a password set you can change it from the <code>Keys</code> menu and you will have to enter it each time you run McCoy.</p>
<h3 name="Running_McCoy_from_command_line">Running McCoy from command line</h3>
<p>Currently there is no support to run McCoy from command line under Windows, but it is planned to add this support in the future.<br>
However, there are several <strong>external</strong> and <strong>un-official</strong> tools which enable running McCoy from command line:</p>
<ol> <li><strong>signOnTheLine</strong> - an extension to McCoy<br> <a class="link-https" href="https://fireclipse.svn.sourceforge.net/svnroot/fireclipse/trunk/FireclipseExtensions/chromebug/mccoy/signOnTheLine/">https://fireclipse.svn.sourceforge.net/svnroot/fireclipse/trunk/FireclipseExtensions/chromebug/mccoy/signOnTheLine/</a></li> <li><strong>spock</strong> - a tool written in ruby<br> <a class="external" href="http://hyperstruct.net/projects/spock">http://hyperstruct.net/projects/spock</a></li> <li><strong>Bug 396525</strong> - patch to McCoy<br> <a class="link-https" href="https://bugzilla.mozilla.org/show_bug.cgi?id=396525" title="https://bugzilla.mozilla.org/show_bug.cgi?id=396525">https://bugzilla.mozilla.org/show_bug.cgi?id=396525</a></li>
</ol>
<h2 name="Signing_update_manifests">Signing update manifests</h2>
<h3 name="Before_you_release_your_add-on">Before you release your add-on</h3>
<p>In order to verify the update manifests applications need to already have information from you for how to verify it. This is in the form of the public part of a cryptographic key included in the original add-on you release.</p>
<p>The first step is to create a cryptographic key. Simply click the "Create" toolbar button or select "Create Key" from the "Keys" menu. You should give the key a name that will remind you what you are using it for. It is up to you how you use your keys, either using one key for all add-ons or one key per add-on would seem sensible choices.</p>
<p>Once you have a key you need to add its public part to your add-on's <code><a href="/en/Install_Manifests" title="en/Install_Manifests">install.rdf</a></code> file. The simplest way to do this is to select the key then click the <code>Install</code> toolbar button. You must then locate your <code>install.rdf</code> for McCoy and the public part of the key will be added directly to the file. The file will be overwritten so take a backup if you need to.</p>
<p>You can then include this <code>install.rdf</code> in your add-on's xpi and release it.</p>
<p>{{ Note("If you wish to manually add the public key to the <tt>install.rdf</tt> you can right click the key, select \"Copy Public Key\" and then add it to the file as an <code><a href='\"en/Install.rdf#updateKey\"'>updateKey</a></code> entry.") }}</p>
<h3 name="Releasing_an_update">Releasing an update</h3>
<p>Once you are ready to release an updated version of your add-on you must create yourself an <code><a href="/en/Extension_Versioning,_Update_and_Compatibility#Update_RDF_Format" title="en/Extension_Versioning,_Update_and_Compatibility#Update_RDF_Format">update.rdf</a></code> file. You need to use McCoy to sign this file so that the application can verify that it really came from you. Simply select the key you originally added to the add-on's <code>install.rdf</code>, then click the "Sign" toolbar button, select your <code>update.rdf</code> file and the data in it will be signed. It's important to note that if you change any information in the update file then it must be signed again.</p>
<p>{{ Note("The signing is RDF aware, which means that if you reorganized the XML in the file into a more human readable form but the RDF data remained the same then the signature would still be valid.") }}</p>
<p>{{ languages( { "fr": "fr/McCoy", "ja": "ja/McCoy" } ) }}</p>
Revert to this revision