「Jarファイルへの署名方法」を編集中

'''本記事について'''<br/>
[https://qiita.com/_alice/items/546ab6449ef14571e46c Qiitaの記事]と同一の内容です。<br/>
当Wikiは時々閲覧不能になることがあるため、ミラーとして置いてあることを承知下さいませ。

=はじめに=
MinecraftのMODはjar形式で提供されますが、このjarが読み込まれる際に署名が付いていない旨の警告がログに出力される場合があります。<br/>
本記事はその警告を出なくするため、jarファイルに署名を加える方法を解説します。<br/>

==署名に必要なツール==
*Java Development Kit
*OpenSSL (証明書の作成時のみ)

=証明書の作成=
署名に必要な証明書は、認証局に申請して入手するかOpenSSLやWindows Serverの証明書機関で生成してもかまいません。<br/>
その場合はこの手順はスキップして、フレンドリ名の確認まで飛ばして下さい。<br/>
ここではJDKの機能で証明書を作成します。<br/>
<pre>$ keytool -genkeypair -storetype pkcs12 -keystore 証明書ファイル.p12 -alias フレンドリ名 -keyalg ec -keysize 384 -validity 3650</pre>
<code>keytool</code>の引数の解説は[https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html keytoolのオプション(英語)]または[https://qiita.com/_alice/items/546ab6449ef14571e46c Qiitaの記事]をご覧下さい。<br/>
上記のコマンドを実行すると、楕円曲線暗号の384bitを鍵とした証明書を作成します。<br/>

==パスワードについて==
この際、証明書を使用する際のパスワードを尋ねられます。<br/>
Gradleでビルドと同時に署名を行いたいのであれば、コミットしても問題無いような文字列をパスワードにすると良いでしょう。<br/>
ただし、この場合は'''絶対に証明書をリポジトリにコミットしたりしてはいけません'''。<br/>

==入力項目について==
次に、いくつか入力項目が現れますので、順に追って説明します。
#姓名<br/>ニックネームとかツイッターアカウントの名前とかでかまいません。
#組織単位名<br/>個人の場合は活動のジャンルの名称でいいでしょう。<br/>たとえば、今回作成する証明書はMODのJARファイルに署名するのでmcmodにする、といった具合です。
#組織名<br/>これも個人の場合は姓名と同じにするか、ウェブサイトのドメイン名などでかまいません。
#都市名または地域名<br/>住所を知られたくない場合は適当な地域で。
#都道府県名または州名<br/>4に同じく。
#国コード<br/>日本ならJPになります。
国コードの入力が終わると、<code>[いいえ]:</code>という意味不明なプロンプトが出ますが、これには<code>y</code>だけ入力して下さい。
そうしないと最初からやり直しとなってしまいます。<br/>

==2度目のパスワードについて==
これはそのまま何も入力せずにEnterキーを押して次に進んだ方が混乱が無くて良いと思います。<br/>
<br/>
これで証明書は作成されました。<br/>

=フレンドリ名の確認と設定=
jarファイルへの署名には、証明書の他にフレンドリ名の設定が行われている必要があります。<br/>
<code>keytool</code>で生成した証明書であれば、<code>-alias</code>で指定した名称がフレンドリ名としてファイルに記録されています。<br/>
しかし、それ以外の方法で生成した場合はフレンドリ名の設定が行われていない場合があります。<br/>

==フレンドリ名の確認==
<pre>$ openssl pkcs12 -in 証明書ファイル.p12 -info -nokeys</pre>
これを実行後パスワードを入力して、得られた出力の中に<code>Bag Attributes</code>があるはずです。<br/>
そのすぐ下に<code>friendlyName</code>の項目があれば、フレンドリ名が記録されているのでOKです。<br/>

==フレンドリ名の設定==
フレンドリ名が設定されていない場合は追加します。<br/>
#バックアップ<pre>$ mv 証明書ファイル.p12 証明書ファイル.p12.bak</pre>
#PKCS12から証明書と鍵を取り出す<pre>$ openssl pkcs12 -in 証明書ファイル.p12.bak -info -nodes -out temp.txt</pre>
#取り出した証明書と鍵からフレンドリ名を設定しつつPKCS12を生成<pre>$ openssl pkcs12 -export -in temp.txt -name フレンドリ名 -out 証明書ファイル.p12</pre>注意点として、パスワードは必ず6文字以上にしなければなりません。これはjarsignerの仕様で、これを満たさないパスワードはエラーになってしまうためです。
#後始末<pre>$ rm temp.txt</pre>

=フィンガープリントの確認=
MinecraftのMODのJARファイルを署名付きで公開する場合、必要となってくるのがフィンガープリントの値です。<br/>
フィンガープリントとは、証明書をバイナリデータ(ASN-1形式)で表現したときにそのデータをハッシュ関数で処理した値のことです。<br/>
同じ証明書からは同じフィンガープリントの値が得られるので、期限が切れた等で作り直さない限りはここで調べた値を流用出来ます。<br/>
Minecraft ForgeではSHA-1ハッシュアルゴリズムでのフィンガープリントの値が要求されます。<br/>

==OpenSSLを使用してフィンガープリントを取得==
<pre>$ openssl pkcs12 -in 証明書ファイル.p12 -info -nokeys|openssl x509 -fingerprint -noout</pre>
実行するとパスワードを入力後、フィンガープリントの値が「:」で区切られた16進数表記で出力されます。<br/>

==フィンガープリントの値をMODで記述する文字列にする==
この表記から「:」を削ってつなげた後、大文字を小文字に書き直します。<br/>
これがMOD内に記述するフィンガープリントの値となります。<br/>

=MODのソースコードに記述する=
<code>@Mod</code>アノテーションに<code>certificateFingerprint</code>を書き加え、その後にフィンガープリントの値を文字列として記述します。<br/>
<pre>@Mod(modid = "hogemod",
    /*…中略…*/
    certificateFingerprint = "フィンガープリントの値")
public class HogeMod {
/*…中略…*/
}</pre>

==DummyModContainerを継承したcoremodの場合==
<code>DummyModContainer</code>を継承する場合は<code>@Mod</code>アノテーションを使用できないため、継承クラス内で<code>getSigningCertificate()</code>メソッドをオーバーライドし、クラスの証明書(<code>Certificate</code>)を返します。<br/>
<pre>public class SampleCoreMod extends DummyModContainer {

	private Certificate certificate;

	public SampleCoreMod() {
		super(new ModMetadata());
                /*---中略---*/

                // ClassからCertificatesを取得
		Certificate[] certificates = getClass().getProtectionDomain().getCodeSource().getCertificates();
		certificate = certificates != null ? certificates[0] : null;
	}

	@Override
	@Nullable
	public Certificate getSigningCertificate() {
		// certificateを返す
		return certificate;
	}
}</pre>

==署名が一致しないときの処理==
必須ではありませんが、Forgeのイベントハンドラに署名が一致しなかった場合に呼ばれるものがあります。<br/>
<code>FMLPreInitializationEvent</code>や<code>FMLInitializationEvent</code>と同じように、<code>FMLFingerprintViolationEvent</code>の引数をもつメソッドを<code>@Mod.EventHandler</code>アノテーションを使い宣言します。
<pre>@Mod.EventHandler
public void badSignature(FMLFingerprintViolationEvent event)
{
    System.err.println("署名が一致しません!オリジナルの配布ファイルではありません!");
}</pre>

=JARファイルに署名する=
署名処理を行いますが、これにはコマンドを実行するのとgradleで行わせるの二つの方法があります。<br/>

==コマンドで署名する==
<pre>$ jarsigner -sigalg SHA256withECDSA -digestalg SHA-256 -tsa http://timestamp.digicert.com -keystore 証明書ファイル.p12 署名したいjarファイル フレンドリ名</pre>
<code>jarsigner</code>の引数の解説は[https://docs.oracle.com/javase/8/docs/technotes/tools/unix/jarsigner.html jarsignerのオプション(英語)]または[https://qiita.com/_alice/items/546ab6449ef14571e46c Qiitaの記事]をご覧下さい。<br/>
上記のコマンドを実行すると、証明書のパスワードを尋ねられた後、jar内の各ファイルについてSHA-256ハッシュを計算して、それに証明書の鍵(ECDSA)で署名を行います。<br/>

==Gradleで署名する==
<var>build.gradle</var>の最後に次のコードを追加します。<br/>
<code>ant.signjar</code>に渡す各引数は前項の<code>jarsigner</code>と同じです。<br/>
<pre>task signJar&lt;&lt;{
 ant.signjar(
  jar:jar.archivePath,
  alias:"フレンドリ名",
  keystore:"証明書ファイル.p12",
  storepass:"証明書パスワード",
  sigalg:"SHA256withECDSA",
  digestalg:"SHA-256",
  tsaurl:"http://timestamp.digicert.com"
 )
}

signJar.dependsOn reobfJar
assemble.dependsOn signJar</pre>
この<var>build.gradle</var>を使いビルドを実行すると署名済みJARファイルが生成されます。<br/>

=動作確認=
生成された署名済みjarファイルを<var>mods</var>フォルダーに配置して、ForgeがインストールされたMinecraftを起動します。<br/>
タイトル画面に進んだら、<var>options.txt</var>と同じ階層にある<var>logs\debug.log</var>を開きます。<br/>
正常に署名が認識されていれば、このような文言が現れます。<br/>
<pre>[HH:MM:SS] [main/DEBUG] [FML]: Mod signature data
[HH:MM:SS] [main/DEBUG] [FML]:      Valid Signatures:
…中略…
[HH:MM:SS] [main/DEBUG] [FML]:      (フィンガープリントの値) &lt;MOD ID&gt;    (&lt;MOD名&gt;   &lt;MODバージョン&gt;)   &lt;JARファイル名&gt;
…中略…</pre>