「EPUB3トータルデータチェッカー」アップル公証対応しました

2022/11/11

 日本語EPUB3用のバリデーションチェックアプリ『EPUB3トータルデータチェッカー』アップル公証対応しました。

http://sanyoshasmds.xsrv.jp/main/?page_id=184

 これは以前から公開していたものですが、macOSのセキュリティ周りの厳格化改訂によって外部に配布して使用してもらうことが難しくなっていたものです。最初の公開時に簡単な説明は書いているのですが、その後チェック項目を追加したりしたこともありますので以下に改めて説明を書いておきます。

動作環境

 Apple silicon/Intel環境ユニバーサル対応
 macOS 12.6(Apple silicon採用Mac)/ macOS10.14(Intel Mac)にて動作確認済です。内部的にPerlおよびJava(Epubcheckで使います)を使っていますので、そちらの環境次第では正しく動作しないかもしれません。

著作権など

 このアプリケーションソフトの権利はJunTajima/三陽社メディア開発室に帰属します。
 また、内包するライブラリ「epubcheck」に関する権利は、同梱したフォルダ「epubchecklicenses」内テキストの記述に従います。

使い方

 アプリケーションを起動すると出てくるドロップウィンドウ内にepubファイルをドラッグ&ドロップするとepubファイルの各パラメータをチェックし、epubファイルと同じ場所にログファイル「EpubTotalDataCheck.log」を出力します。同名ファイルがすでに存在していた場合はテキスト末尾に追記します。

チェック可能なパラメータ

・SarrogatePair Character Check Result
 UTF-16環境でサロゲートペアとして扱われる文字(Unicodeで基本多言語面外の文字)が入っていないかを見ます。

・Unicode IVS Character Check Result
 Unicode IVS(漢字の異体字セレクタ)の異体字表示文字が入っていないかを見ます。

・Unicode SVS Character Check Result
 Unicode SVS(絵文字など)の異体字表示文字が入っていないかを見ます。

・Irregular Space Character Check Result
 U+2004〜U+200Dの特殊幅スペース文字が入っていないかを見ます。

・Voiced Soundmark Check Result
 濁点半濁点が合字扱いで入っていないかを見ます。macOSがFinder等で濁点半濁点を分離して扱う処理をする(Unicode正規化)ため、そこ由来の文字列が混入していないかを見るためのものです。

・JIS2004Character Check Result
 JIS X 0213:2004(JIS2004)で外字扱いとなる文字が入っていないかを見ます。電書協ガイドではJIS2004内の文字のみを使用するように規定しています。

・Adobe-Japan1-6Character Check Result
 Adobe-Japan1-6で外字扱いとなる文字が入っていないかを見ます。多くのEPUBビューアはAdobe-Japan1-6規格のフォントを採用しているため、そこからはみ出た文字は外字画像等にしないと化けるリスクがあります。

・SVG Wrapping Image Pixel Count Check Result
 SVGラッピング配置ページのViewPort記述サイズと画像の実ピクセル数が一致しているかどうかを見ます。電書協ガイド仕様のフィックス型EPUBおよびKADOKAWAフィックスドハイブリッド仕様のチェック対応です。KADOKAWAの仕様についてはこちらを参照してください。

・ImageFile ColorMode Check Result
 EPUB内で使用されている画像のカラーモードにCMYKが使用されていないかを見ます。

・ImageFile PixelCount Check Result
 EPUB内で画像が400万画素を越える画像が使用されていないかを見ます。「Apple Books アセットガイド」の規約に準じたチェック項目です。

・ImageTagFileName Check Result
 imgタグの属性値srcで指定されている画像ファイル名末尾にスペース文字が入っていないかを見ます。epubcheckでスペースが入っていてもエラー扱いにならなくなったため入れました。

・epubcheckのチェック結果
 epubcheckのチェック結果を出します。

 以上です。なお、epubcheck以外の独自追加項目は通知の性格としてはERRORではなくWARNINGで、制作物の性質上無視してよいと判断できるならそれで構わない性質のものと考えています。ご理解の上でご利用ください。

(2022.11.11)



アップル公証対応その2(.ZIPの場合)

2022/11/10

 その1はこちら。今回はパッケージをpkg形式でなく.zip形式にするためのメモです。

圧縮元の配布フォルダを作る

 署名を済ませたアプリおよびドキュメント類を入れた圧縮元の配布用フォルダを作ります。

圧縮用フォルダの構成例

圧縮用フォルダの構成例

 なお、テスト時に.appファイルのみを入れた状態でZIPパッケージ化したところダウンロード時に.appの中身だけが展開されてしまってアプリとして実行できなくなる現象が見られたのですが、別ファイルを含めてパッケージ化することで回避できたようです。まあこれは圧縮方法の設定がどうこうというよりはブラウザがダウンロード後のファイルをどう扱うかという話のように思います。

ZIPパッケージを作る

 ターミナルで以下のコマンドを使ってリソースフォークごとZIPパッケージ化します。アプリ本体の署名を済ませておくのはpkg形式と同様です。

ZIPパッケージに署名を行う

 ZIPパッケージに署名を行います。キーチェーンアクセスにDeveloper IDが登録されているのが前提です。

アップルの公証サーバにアップロードして登録

 以下のコマンドを実行してアップルの公証サーバに登録します。pkg形式と同じです。App用パスワードについては前回記事を参照のこと。

 公証が通ったかの確認はpkg形式の場合と同様です。メールで通知が来るほかターミナルから確認することもできます。念のためにコマンドは以下。

 なお、アップルは公証の仕組みを切り替える予定のようで、現在altoolで公証を行うと新コマンドのnotarytoolへの移行案内メッセージが出ます。2023年秋には完全切り替えの予定の模様です。流れが速くてなかなかついて行くのが大変です。

(2022.11.10)



Xojoで作成したMac用アプリの公証を通す

2022/10/07

 macOSはセキュリティ強化の取り組みを継続的に強化していますが、macOS 10.15 Catalina以降でついに「アプリのインストール時にアップルのサーバに登録情報を照会しに行き、登録がなければインストールさせない」という処理を「必ず」行うようになったため(それ以前からあるにはありましたが回避方法が用意されていました)、アプリを作って配布する際のハードルがかなり上がりました。Adobeアプリで言うところのプロダクトアクティベートと同種の処理ですが、それをユーザーが作成して配布するアプリにも求めるようになったわけです。私が過去に作って配布していたアプリもこれに引っかかってダウンロードしてもインストールできない状態になっていましたが、アップルのサーバにアプリの情報を申請して登録するための手続き「Notarization/公証」を行い、配布できるようになりましたので以下に覚え書きとしてやり方を書いておきます。

 なお、これはXcode以外のビルド環境(Xojo)でビルドしたアプリを公証に対応させるための話なので、ターミナルのCUI操作で手続きをすることが前提になっています。参考にしたページはこちらなど。情報がほぼそのまま使えて大変有り難かったのですが、一部変更しないと処理が通らなかったり、また個人でフリーウェアを配布する程度の目的だと過剰な部分もありましたので、こちらでもメモを残しておこうと思いました。

Developer登録を済ませる

 開発したアプリを登録するためには申請者がAppleの登録Developerである必要があるので、まず事前にDeveloperの登録手続きを済ませておきます。二段階認証を済ませた端末から申請してDeveloperの年間登録料(2022年現在12,800円)を支払う必要があります(多分クレジットカードとの紐付け必須)。また、政府発行の身分証明書のコピーの送付が最終段階で必要でした(フォームから画像を送る)。会社としての登録の場合にはそれ以外に「D-U-N-S番号」が必要になるようです。詳しくはこちら
 自分の場合はMacのDeveloper.app内から申請して通しました。それ以前にiPhoneから申請したところずっと審査中で止まってしまっていて、あらためてMacから申請し直したらあっさり通ったような経緯です。止まっていた理由は何も表示されないのでよくわかりません。

「App用パスワード」を作っておく

 Xcode以外の環境でビルドしたアプリの登録には「App用パスワード」が必要になるとのことなので事前にこちらにDeveloper登録に使ったApple IDでログインしてApp用パスワードを作っておきます。「+」ボタンをクリックして分類名(任意でよい)を入れ、表示されるパスワードをメモしておきます。

App用パスワード

通知されたパスワードをメモしておく

キーチェーンアクセスで証明書(CSR)を発行しておく

 Macの「キーチェーンアクセス」アプリを開き、ドロップダウンメニューから「証明書アシスタント」「認証局に証明書を要求」を選択します。

認証局に証明書を要求・・・

認証局に証明書を要求・・・

 Apple IDの登録メールアドレス、通称(登録しようとしているアプリの略称など)を入れ、「ディスクに保存」「鍵ペア情報を指定」を選んで「続ける」をクリック。証明書ファイル(以下Apple Developer Programで作る証明書と紛らわしいので「CSRファイル」と呼称する)の保存先を指定し、次の画面で秘密鍵、公開鍵に「2048ビット」「RSA」の設定を選んで保存を実行します。これで指定した場所にCSRファイルが保存されたはずです。

証明書をディスクに保存

証明書をディスクに保存

 なお、この作業中何度かアカウントのログインパスワードの入力を求められましたが、これは環境によって変わるかもしれません。

アプリとインストーラーの証明書を発行する

 まずアプリ本体の証明書を発行します。Apple Developer Programのサイトにログインし、「アカウント」タブから「証明書、ID、プロファイル」「証明書(英語)」を選択し、次画面で「Certificates」の横の「+」ボタンを押して証明書の種類を選びます。

Apple Developer Programサイト

Apple Developer Programサイト

 Xcode以外で作成したアプリを自分のサイト等から配布したい場合は「Developer ID Application」を選んで「Continue」ボタンを押します。App Store経由での配布の場合はここで選ぶ証明書の種類が変わるようです。

発行する証明書の種類を選択

発行する証明書の種類を選択

 次に「Certificates, Identifiers & Profiles」の画面が出るので、画面下の「Choose File」ボタンをクリックし、さきほど作成して保存したCSRファイルを選択してアップロードします。「Profile Type」はよくわからなかったので「Previous Sub-CA」を選びましたが、特に問題なかったようです。「Continue」を押し、次の画面で「Download」をクリックして証明書をダウンロードします。

CSRファイルをアップロードする

CSRファイルをアップロードする

 同じくインストーラの証明書も必要になるので、「証明書、ID、プロファイル」「証明書(英語)」から「Developer ID Installer」を選んで証明書を作ります。CSRファイルは同じもので良いようです。

 ダウンロードした証明書のファイルをダブルクリックするとキーチェーンアクセスに取り込まれますので、その状態にしておきます。

Xojoでデベロッパ署名をいれた状態でアプリをビルドする

 Xojoで配布対象のアプリのビルド元ファイルを開き、発行されたDeveloper IDを「Build Settings」「macOS」内にある「Sign」に記入してアプリをビルドします。

Xojo内で署名を入れてアプリをビルド

Xojo内で署名を入れてアプリをビルド

 Developer IDはキーチェーンアクセスで対象の証明書の項目を見れば確認できるはずです。

Developer IDはキーチェーンアクセスで確認できる

Developer IDはキーチェーンアクセスで確認できる

 テスト時にはこのあとアプリ本体へのコード署名処理でエラーが出てしまって困ったのですが、この形で事前に署名を済ませておいてターミナルでのコード署名処理では署名部分を指定しないことで回避できたようです。
 また、同一の署名がキーチェーンアクセス内に複数あるとエラーになるようです。各アプリごとにアプリとインストーラーの証明書を取得してキーチェーンアクセスに登録する必要は無く、使い回して大丈夫な模様。あるいは公証が終わったらキーチェーンアクセス内の証明書は消す形でしょうか。
 なお余談ですが、パッケージ内に含めたい外部ファイル/フォルダはビルドする前にパーミッションを適切に設定しておかないとインストール後にそれが原因で一部の機能が動かなくなったりします(なった)。ターミナルで

などとやってパーミッションを設定しておきましょう。

配布用ファイル作成作業用のフォルダを作る

 配布用ファイル作成作業用のフォルダを作ります。今回は参照サイトに従ってMacのApplicationsフォルダにインストーラ(.pkg)でインストールする形を取りますので、pkg/Applications/“アプリ名フォルダ”/“アプリ名.App” の構成としました。

パッケージ作成用フォルダ構成例

パッケージ作成用フォルダ構成例

 署名の処理に必要になるentitlements.plistは参照先サイトのものをそのままコピーして保存(文字コードUTF-8指定に注意)。一応以下に同じものを置いておきます。

アプリ本体へのコード署名を行う

 以下のコマンドで署名処理を実行します。

 で作成作業フォルダに移動してから

 のコマンドを実行。「replacing existing signature」のメッセージが出ればOK。

 なお、参考にしたページの情報だと-sの後で指定するのが「”Developer ID Application: ${DEVELOPER_ID}”」となっていたのですが、なぜかこの指定だと「--options runtime」「--options というコマンドが見当たらない」という旨のエラーが出てしまっていました。その状態だとHardened Runtime対応がされないので、この後のAppleのサーバへの登録で蹴られます(ました)。理由はわからないのですが「“Developer ID Application”」とだけ入れておけば処理が通る模様。なんでしょうねえ。つまりここではアプリへのDeveloper IDの署名自体は行っていない(ビルド時にXojo内で済ませている)のですが、上記のコマンドの実行は必要です。

 署名ができているかの確認は以下のコマンドで行います。

 署名が確認できればOK。

署名が入っていることを確認

署名が入っていることを確認

インストーラパッケージ(.pkg)の作成

 次はインストーラパッケージの作成です。Dmg形式やZIP形式での配布もできるようなのですが、とりあえず参照先サイトに従ってpkg形式のインストーラを作成することとします。

 まずpkgファイルに含めるファイルを指定するための.plistファイルのひな形を出力します。

 で作成作業用フォルダ内のpkgフォルダに移動後、

 を入れると、packages.plistの名前でひな形が出てきます。

 それを開いて編集するとのことなのですが、参照先サイトに従ってとりあえず「BundleIsRelocatable」の指定を「false」にすることだけしました。以下に一応置いておきます。

 編集が済んだら、以下のコマンドを実行して「インストーラパッケージ」を作成します。

 「--identifier」で指定するリバースドメインはXojoのビルド元ファイルを開いて「Build Settings」「macOS」から「Bundle Identifer」を見れば確認できます。
 「--version」はインストーラのバージョンとのことなので何でもよさげですが、一応アプリのバージョンをそのまま入れました。
 実行すると「.pkg」ファイルが生成されます。

 なお、.pkgファイルを一旦XMLとして出力することでインストーラの内容を編集できるようなのですが、参照したサイトで記述があったタイトルの抜けもこちらの環境では見られなかったので省略しました。pkgutil側でアップデートがあったのかもしれません。

インストーラパッケージに署名を行う

 次にパッケージに署名を行います。以下のコマンドで「署名済のインストーラパッケージ」が作成できます。

 Developer IDは「キーチェーンアクセス」で対象の証明書の項目を見れば確認できます。

 署名できたかの確認は先ほどのアプリの時と同じく pkgutil --check-signature コマンドで

 で実行できます。

アップルの公証サーバにアップロードして登録

 いよいよ最終段階です。以下のコマンドを実行してアップルの公証サーバに登録を行います。

 しばらく経って

 のメッセージが出ればアップロードは完了です。

 このあと公証サーバで処理が行われ、終了後に登録メールアドレスに結果の通知が来ます。

 「Your Mac software was successfully notarized.」の通知が来れば公証は完了。あとは配布するだけです。

公証処理完了の通知メール

公証処理完了の通知メール

 一応ターミナルでの確認方法も書いておきます。

 で確認できます。「Status: success」と出ていればOK。

 なお、参照先サイトにはログに残さないためにApp用パスワードをキーチェーンアクセスに入れておいて指定する方法の記述もありましたが、個人作成フリーウェア程度では必要ないと思われたので割愛しました。

(2022.10.11)

アプリ内同梱ファイルのパーミッションについて追記

(2022.11.10)



プロフィール
Jun Tajima

こちらにて、電子書籍&Web制作を担当しています。
このブログは、EPUB3をはじめとした電子書籍制作担当オペレータからの、「電子書籍の制作時にたとえばこんな問題が出てきていますよ」的な「現地レポート」です。少しでも早い段階で快適な電子書籍閲覧・制作環境が整うことを願って、現場からの声を発信していこうと目論んでおります。

当ブログ内の記事・資料は、私の所属しております組織の許諾を得て掲載していますが、内容は私個人の見解に基づくものであり、所属する組織の見解を代表するものではありません。また、本ブログの情報・ツールを利用したことにより、直接的あるいは間接的に損害や債務が発生した場合でも、私および私の所属する組織は一切の責任を負いかねます。