クラウドMacで検証するiOSダウンロードのファイル形式
iOSのダウンロードAPIは成功を返しているのに、プレビュー画面で添付ファイルを開けない。受け取った中身がセッション切れのエラーページだったり、サーバーがすべてのコンテンツを汎用バイナリとして返していたり、ファイルが途中までしかダウンロードされていなかったりします。クラウドMacでこうした問題を再現する際、最初から実際のサービスに接続する必要はありません。まず「何と宣言されているか」「実際には何の形式に見えるか」「最後まで解析できるか」を切り分け、固定のテストデータで3段階の検証を組み立ててから、ダウンロード処理に組み込みます。
受け入れる形式を先に定義する
添付ファイルの受け取り口では、PNG、JPEG、PDFだけを許可するものとします。判定ルールは業務要件に基づく許可リストで決め、ファイル名から推測しないようにします。ファイル名はユーザーに表示しても構いませんが、使用するパーサーの選択に使ったり、そのまま保存先パスの組み立てに使ったりしてはいけません。
検証は、HTTPステータスがAPI仕様に合っていることを確認し、実際の受信バイト数を制限し、レスポンスのMIMEとファイル先頭を照合してから、形式ごとの解析を実行する順に進めます。Content-Length は早期に拒否するための判断材料の一つにすぎません。値が欠けていたり実際より小さかったりするため、累積受信バイト数の上限管理の代わりにはなりません。
ファイル先頭の一致で分かるのは「その形式らしい」ということだけです。完全性の証明でも、安全性の証明でもありません。PNGシグネチャしか入っていないファイルは表示できません。
APIが明示的に汎用バイナリを返す仕様なら、その受け取り口に限って例外を設定できます。ただし、すべてのダウンロードに同じ緩いルールを適用してはいけません。以下の実装は厳格なモードとし、MIMEがない場合や宣言と内容が矛盾する場合は拒否します。
型の判定を純粋関数として切り出す
リモートのmacOSターミナルで type-check.swift を作成し、以下の内容を保存します。この関数が受け取るのは先頭データとMIMEだけです。ネットワーク通信もユーザーディレクトリへのアクセスも行わないため、後からアプリのテストターゲットへ移しやすくなります。コード内のサンプルは分類ルールを検証するためのもので、有効な画像や文書ではありません。
import Foundation
enum FileKind: String {
case png, jpeg, pdf
var mime: String {
switch self {
case .png: return "image/png"
case .jpeg: return "image/jpeg"
case .pdf: return "application/pdf"
}
}
}
enum TypeFailure: Error {
case unknownHeader
case missingMIME
case conflictingMIME
}
func classify(
prefix: Data,
declaredMIME: String?
) throws -> FileKind {
let bytes = Array(prefix.prefix(8))
let kind: FileKind
if bytes.starts(with: [137, 80, 78, 71, 13, 10, 26, 10]) {
kind = .png
} else if bytes.starts(with: [255, 216, 255]) {
kind = .jpeg
} else if bytes.starts(with: Array("%PDF-".utf8)) {
kind = .pdf
} else {
throw TypeFailure.unknownHeader
}
guard let declaredMIME else {
throw TypeFailure.missingMIME
}
let mime = declaredMIME
.split(separator: ";", omittingEmptySubsequences: false)[0]
.trimmingCharacters(in: .whitespacesAndNewlines)
.lowercased()
guard mime == kind.mime else {
throw TypeFailure.conflictingMIME
}
return kind
}
struct Fixture {
let head: [UInt8]
let mime: String?
let expected: FileKind?
}
let fixtures: [Fixture] = [
.init(
head: [137, 80, 78, 71, 13, 10, 26, 10],
mime: "IMAGE/PNG; charset=binary",
expected: .png
),
.init(head: [255, 216, 255], mime: "image/jpeg", expected: .jpeg),
.init(
head: Array("%PDF-1.7".utf8),
mime: "application/pdf",
expected: .pdf
),
.init(
head: Array("<html>error".utf8),
mime: "application/pdf",
expected: nil
),
.init(head: [137, 80, 78], mime: "image/png", expected: nil),
.init(head: [255, 216, 255], mime: "image/png", expected: nil),
.init(head: [255, 216, 255], mime: nil, expected: nil)
]
for (index, fixture) in fixtures.enumerated() {
let actual = try? classify(
prefix: Data(fixture.head),
declaredMIME: fixture.mime
)
guard actual == fixture.expected else {
fatalError("Fixture mismatch at index \(index)")
}
}
xcrun swift type-check.swift を実行します。すべての結果が一致すれば何も出力せず終了し、アサーションが失敗すれば非ゼロの終了コードを返します。ここでヘッダーの文字列を直接使っているのは、大文字・小文字の違いとパラメーター付きの値を検証するためです。アプリ側で正規化済みのMIMEを取得する場合も、原因調査のために元のレスポンスヘッダーを残しておきます。ただし、認証情報を含むフィールドは記録しないでください。
ダウンロードへの組み込みではファイル全体をメモリに読み込まない
ダウンロードタスクを使う場合は、まずタスクのエラー、レスポンスのステータス、一時ファイルの有無を確認します。その後、FileHandle で最大8バイトを読み取り、判定関数に渡します。ハンドルは defer で閉じます。シグネチャを読むだけのために、Data(contentsOf:) でファイル全体を読み込んではいけません。大きな添付ファイルでは、単純な確認処理がメモリ使用量の急増を招きます。
ストリーミングで受信する場合は、先頭8バイトがそろうまでデータを蓄積する必要があります。最初のコールバックにシグネチャ全体が含まれるとは限りません。コールバックで渡されるデータの区切りと、ファイル形式上の区切りは無関係です。分類に必要なデータが足りない場合は待機を続け、8バイトがそろうか転送が終了した時点で判定します。
ダウンロードタスクから渡される一時ファイルは、速やかにアプリ管理下のステージングディレクトリへ移動します。内部用のファイル名を生成し、検証を通過してから正式な保存先へ移します。どの段階で失敗しても、ステージング中のファイルを削除します。ユーザーが指定した名前は、適切に処理したうえで表示用の項目としてのみ使用します。
完全な解析を検証するためのサンプルを追加する
型の判定を通過した画像は、さらにImageIOで画像ソースを作成し、実際に画像を生成する必要があります。サイズを読み取れたり画像ソースを作成できたりしても、その後のデコードが成功するとは限りません。幅、高さ、総ピクセル数、フレーム数を先に制限してから、必要なフレームをデコードします。小さな圧縮ファイルが展開され、巨大なメモリオブジェクトになる事態を防ぐためです。
PDFでは、PDFKitで文書の作成を試み、ページ数、暗号化状態、アクセスが必要なページを確認します。業務要件としてプレビューを生成するなら、対象ページを実際にレンダリングしてください。文書オブジェクトを作成できたからといって、すべてのページが正しく表示できるとは限りません。
有効な実ファイルに加え、先頭部分だけを残したもの、末尾を切り詰めたもの、途中のバイトを書き換えたものを用意します。切り詰めたサンプルが、基盤となるパーサーですべて拒否されるとは限りません。破損を許容して処理できるパーサーもあるため、テストでは「アプリが必要とする操作を完了できるか」を基準にアサートします。1バイトでも変われば必ず失敗する、という前提は置かないでください。
失敗理由を原因特定につながる結果として記録する
プロジェクトのテストターゲットへ組み込んだら、転送失敗、未知の形式、宣言の不一致、上限超過、解析失敗をそれぞれ区別して報告します。すべてを「ファイル破損」にまとめてしまうと、バックエンドのMIME設定ミスとクライアント側のデコード問題を切り分けられなくなります。
回帰テストごとに、サンプルID、実際のバイト数、正規化済みMIME、判定された形式候補、処理段階を記録します。サンプルには、機密情報を含まない人工的に作成したファイルを優先します。失敗した添付ファイルに業務データが含まれる場合、テストレポートと一緒に自動アップロードしてはいけません。
最後に3点を確認します。エラーページがプレビュー処理に渡らないこと、切り詰めたサンプルが完全性を検証済みのファイルとして扱われないこと、失敗経路で正式な添付ファイルが残らないことです。クラウドMacでは固定サンプルとシミュレーター上のフローを実行し、実機で大容量ファイルを扱った際のメモリ使用状況は別途検証します。両者を分けて記録することで、この検証ゲートが何を保証しているのかを把握できます。
よくある質問
MIME宣言と先頭データが違う場合、形式を自動修正してよいですか?
原則は拒否し、不一致の理由を記録します。汎用バイナリのレスポンスを認める場合も、対象の入口だけに例外を設け、先頭検査と完全な解析を必須にします。
先頭データが一致すれば破損していないと判断できますか?
できません。先頭検査は形式の候補を示すだけです。画像は完全なデコード、PDFは解析と必要なページ検証を行ってください。
プロジェクトに合ったMacを選ぶ
ネイティブビルドやシミュレーターでの動作確認が必要なら、Apple Silicon搭載の専有物理Macをレンタルして検証するのがおすすめです。長期にわたって毎日使い、利用場所も固定なら、購入もあわせて検討するとよいでしょう。まずは日単位で試し、継続利用が決まったら月払い・四半期払いを検討できます。
リモートMacをレンタル