Firefox拡張機能を自動的に更新する

記事「 Firefox拡張機能の自動更新 」の翻訳に注目してください。



この記事は古いですが、すべての情報はこの日に関連しています。



もちろん、Firefox拡張機能の開発者は、 公式ストアを通じて拡張機能を配布する場合、拡張機能を無料で自動的に更新できることを知っています。 しかし、拡張機能を自分のサイトでホストしたい場合はどうでしょうか？ 自動更新のサポートをどのように実装しますか？

拡張機能に署名する

Firefoxの3番目のバージョン以降、すべての拡張機能の更新は信頼できるチャネルを通じて提供される必要があります。 拡張機能を独自にホストすることに決めたため、この要件を満たすための2つのオプションがあります。

• セキュア（https）接続を介して更新を提供する
• 拡張機能に電子署名する

最初のオプションは考慮しません-ほとんどの場合、これには追加費用が必要です（SSL証明書を購入し、静的IPを所有する必要があります（私はそれが何であるか理解できませんでしたが、曲から単語を消去しません[おおまかです。Transl。 ）））無料で使いやすく、実装が高速です。 さて、それを使用する方法を学びましょう！

秘密/公開キーのペアを作成する

拡張機能に署名する最初のステップは、秘密/公開キーのペアを作成することです。 Mozillaは、この目的のためにMcCoyユーティリティを提供しています。 世界で最も簡単なユーティリティではないため、以下にその調理方法を示します。

• McCoy Webサイトにアクセスして、適切なパッケージをダウンロードします（Windows、Linux、およびMac OS Xのバージョンがあります）
• 便利なディレクトリにパッケージを展開します
• アプリケーションを実行します。 最初の起動時に、キーを保護するためのマスターパスワードの作成が提案されます。 そのようなパスワードを作成することを強くお勧めします！ McCoyは、再起動するたびに、このパスワードを要求します。
• アプリケーションが実行されている場合は、メニューの[キー]»[新しいキーの作成]を選択します。 キーの正しい名前を入力し、[OK]をクリックします。 サイトで複数の拡張機能をホストする場合でも、1つのキーで十分です。

さて、キーが作成されました。次に、拡張マニフェストを更新する必要があります。

install.rdfを更新する

install.rdfに精通していることを前提としているため、その構造を説明する時間を無駄にしません（そうでない場合は、 こちらにアクセスしてください ）。 例として、 ツールバーチュートリアルの install.rdfを使用します 。 元のバージョンは次のとおりです。

<?xml version="1.0"?> <RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <Description about="urn:mozilla:install-manifest"> <em:id>tuttoolbar@borngeek.com</em:id> <em:name>Tutorial Toolbar</em:name> <em:type>2</em:type> <em:version>1.0</em:version> <em:targetApplication> <Description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minVersion>4.0</em:minVersion> <em:maxVersion>30.*</em:maxVersion> </Description> </em:targetApplication> <em:creator>Jonah Bishop</em:creator> <em:description>An example toolbar extension.</em:description> <em:homepageURL>https://www.borngeek.com/firefox/</em:homepageURL> </Description> </RDF>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このマニフェストにem:updateURL



とem:updateKey



2つの要素を追加する必要があります。 em:updateURL



は、 更新マニフェスト（update.rdf）が配置されているURLを指します。 次のようになります。

 <em:updateURL>http://www.example.com/update.rdf</em:updateURL>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

マニフェストにこの要素が含まれている場合、公式ストアに拡張機能を配置することはできません。



次にem:updateKey



ます。 公開鍵のみが含まれています。 取得するには、McCoyを開き、前に作成したキーを右クリックして、コンテキストメニューで[ 公開キーのコピー ]を選択します。 その後、開始タグと終了タグの間にキーを配置します。

 <em:updateKey> MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDW8qxAeURIMLnHjb KrjR/uqnRsiomahNArMh3KqRLDDmRGCoO21fyHyh5kdgiEL+2Q+sNP z+j5maIG4qePXp7BVp90QMqiGLvl+z4baDOqcNvErN0l8scd8EegXc G7Ofa5Gc5oEU/gItIVR4k9AICyW2pJhe51UPa3UKXDS0v3TwIDAQAB </em:updateKey>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

アブラカダブラ。 幸いなことに、Firefoxは十分にスマートで、 em:updateKey



要素でスペースを使用できるため、install.rdfが読みやすくなります（上記のように、これは既にフォーマットされたバージョンです）。 デフォルトでは、1つの長い文字列がMcCoyからコピーされます。



これら2つの要素を追加すると、install.rdfは次のようになります。

 <?xml version="1.0"?> <RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <Description about="urn:mozilla:install-manifest"> <em:id>tuttoolbar@borngeek.com</em:id> <em:name>Tutorial Toolbar</em:name> <em:type>2</em:type> <em:version>1.0</em:version> <em:targetApplication> <Description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minVersion>4.0</em:minVersion> <em:maxVersion>30.*</em:maxVersion> </Description> </em:targetApplication> <em:creator>Jonah Bishop</em:creator> <em:description>An example toolbar extension.</em:description> <em:homepageURL>https://www.borngeek.com/firefox/</em:homepageURL> <em:updateURL>http://www.example.com/update.rdf</em:updateURL> <em:updateKey> MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDW8qxAeURIMLnHjb KrjR/uqnRsiomahNArMh3KqRLDDmRGCoO21fyHyh5kdgiEL+2Q+sNP z+j5maIG4qePXp7BVp90QMqiGLvl+z4baDOqcNvErN0l8scd8EegXc G7Ofa5Gc5oEU/gItIVR4k9AICyW2pJhe51UPa3UKXDS0v3TwIDAQAB </em:updateKey> </Description> </RDF>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

拡張機能のマニフェストの更新が完了しました！ このステップは一度だけ行う必要があることに注意してください。 つまり、次の更新ごとにこれらの手順を繰り返す必要はありません（update.rdf URLまたはキーを変更しない限り）。 すべて、この段階で、拡張機能をさらに配布するために（ユーザーに配布するために）パックすることはすでに可能です。

update.rdfを作成します

拡張機能自体が完成したので、更新マニフェストを作成します。 このファイル（update.rdf）はサーバー上に存在し、実際、更新を確認するときにユーザーに表示される内容を決定します。 まず、作成するファイルの最終バージョンを簡単に見てみましょう。

 <?xml version="1.0"?> <r:RDF xmlns:r="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns="http://www.mozilla.org/2004/em-rdf#"> <r:Description about="urn:mozilla:extension:tuttoolbar@borngeek.com"> <updates> <r:Seq> <r:li> <r:Description> <version>1.0.2</version> <targetApplication> <r:Description> <id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</id> <minVersion>4.0</minVersion> <maxVersion>30.*</maxVersion> <updateLink>http://www.example.com/downloads/tuttoolbar_1_0_2.xpi</updateLink> <updateHash> sha256:c22ad513c1243959a6d8e6b3cfad18a2a9141306f0165da6b05b008b2042e502 </updateHash> </r:Description> </targetApplication> </r:Description> </r:li> </r:Seq> </updates> </r:Description> </r:RDF>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

行ごとに見て、ここで何が起こっているのかを議論しましょう。 最初に、r：RDF要素が続く標準XMLヘッダーがあります。これは、RDF（リソース記述フレームワーク）ファイルがあることを示しています。 主にr：Description要素に興味があります。 update.rdfで記述する拡張機能ごとに1つの要素が必要です。



（ はい、はい、1つのupdate.rdfで、多くの拡張機能の更新、 拡張機能のバージョン管理、更新と互換性を説明できます[翻訳に注意してください。] ）



次に、最初に記述する必要があるのはabout



属性です。 urn:mozilla:extension



必要で、その後に拡張のGUIDが続きます。 この場合、GUIDはtuttoolbar@borngeek.comです。 念頭に置いてください-メール形式のGUID（ただしd4373b50-43b3-11de-8a39-0800200c9a66のようなもの）がない場合は、中括弧{d4373b50-43b3-11de-8a39-0800200c9a66}



で囲む必要があります。



いくつかの子要素（ updates



、 r:Seq



、 r:li



、およびもう1つのr:Description



）の後、 version



要素で停止します。 これは拡張機能のバージョンで、この場合は1.0.2



です。



次に、拡張機能の対象となるアプリケーション（Firefox）に関する情報があります。 r:Description



囲まれ、非常に重要なid



要素を含むtargetApplication



要素があります。 この要素の値は、Firefox GUIDです。



（ 彼らがbasurmanに書いたのは明らかです。簡潔に-各ターゲットには独自のGUIDがあります-Firefox、Thunderbird、Firefox for Androidには、それぞれ異なるものがあります。 ここで 、拡張機能が動作するアプリケーションを選択してコピーしますGUID： ここでは、いくつかのターゲットのupdate.rdfの例を見ることができます[翻訳に注意してください] ）



この後に、おなじみのminVersion



要素とmaxVersion



要素が続きます。これらの要素は、拡張機能が動作するように設計されているFirefox （または別のターゲット）の最小バージョンと最大バージョンをそれぞれ決定します。 これらの値がinstall.rdfで指定された値と一致することが非常に重要です。



次はupdateLink



要素です。 拡張機能自体のURL（つまり、xpiファイル）を示します。 特に、古いバージョンの拡張機能をサポートしてダウンロードできる場合は、URLが対応するファイルを指していることを確認してください。



さて、最後にupdateHash



要素を待っています。 この要素には、拡張機能（xpiファイル）のsha1、sha256、sha384、またはsha512ハッシュが含まれます。 sha384とsha512には下位互換性の問題があったのでsha256が好きです（ バグ383390を参照してください（ すべてが長い間修正されています）。Linuxを使用している場合は、shaを生成するために必要なものがすべて揃っています。Windowsユーザーは対応するユーティリティをダウンロードできます（ sha256sum）、たとえば、ここ： Cygwin 。ハッシュを取得するには、ターミナルで次のように入力します 。

 sha256sum tuttoolbar_1_0_2.xpi
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

出力は次のようになります。

 c22ad513c1243959a6d8e6b3cfad18a2a9141306f0165da6b05b008b2042e502 *tuttoolbar.xpi
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

16進文字列（スペースまでのすべて）は、暗号化のタイプを示すupdateHash



に入れる必要があるものです。 次のようになります。

 <updateHash> sha256:c22ad513c1243959a6d8e6b3cfad18a2a9141306f0165da6b05b008b2042e502 </updateHash>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

実際にすべて！ 開発版として保存してください！ 個人的にはupdate.rdf.devという名前を使用します。 開発用に別のバージョンを保持する必要があるのはなぜですか？ あなたがこのマニフェストに署名するとき（ そして私たちは署名付きオプションを検討しているためです（ およそTransl。 ））その内容は少し読みにくくなり、さらに編集するのにふさわしくないでしょう。 そのため、開発バージョンを個別に保持し、必要に応じてそのコピーに署名することをお勧めします。

マニフェストに署名する

マニフェストに署名するには、次の簡単な手順を順番に実行します。

• マニフェストの開発者バージョンをコピーし、update.rdfという名前を付けます。 署名するのはこのファイルです
• McCoyがまだ実行されていない場合は起動します
• 署名するキーを選択し、[更新]メニューで[更新マニフェストに署名]を選択します
• 開いたメニューで、作成したupdate.rdfを選択し、[開く]をクリックします

何も起きていないように見えますが、そうではありません！ 私はマッコイにそのような主張をしている-彼は仕事の終わりに何も言わない。 ただし、マニフェストを開くと、少し変更されていることに気付くかもしれません。 実際、これは拡張機能の作業が終了する場所です。今度はサーバーにファイルをアップロードします。

ホストupdate.rdf

ファイルをアップロードする前に、サーバーがrdfおよびxpiファイルをホストできる状態であることを確認する必要があります。 Apacheでは、.htaccessルールを使用してこれを実行できます（IISまたはTomCatでどのように機能するかわかりません。これはApache専用の命令であることに注意してください）。 通常、これらのルールはサイトのルートの.htaccessに配置します-xpiとrdfを移動したい場合に備えて。 ルールは簡単です：

 AddType application/x-xpinstall .xpi AddType text/xml .rdf
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

（ 今ではすでにファッショナブルなnginxです。これを行うために：

 types { application/x-xpinstall xpi; text/xml xml, rdf; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

これを一般的な/etc/nginx/mime.types



またはサーバーの構成に配置します。 [約。 翻訳。] ）



これは、サーバーによるファイルの正しいアップロードに必要です。 これは非常に重要なポイントです！ そうしないと、拡張機能がインストールされず、更新も機能しません。 また、覚えておいてください：何らかの種類のCMS（WordPressなど）を使用する場合は、念のためサイトのルートにこれらのルールを配置することをお勧めします。



すべてを登録したら、適切なアドレスでxpiとupdate.rdfを入力できます。 Update.rdfは、install.rdf拡張機能が指す場所（ em:updateURL



install.rdf拡張機能ファイルのem:updateURL



ある必要があります。 拡張機能自体（.xpi）は、update.rdfが指す場所（ updateLink



タグ）にある必要があります。 混乱しないようにしてください。



それだけです！ 手順は初めて少し混乱しますが、すべてが非常に簡単です。



きれいなコード！