開示事項¶
次の 7 点は審査で論点になるため、本ツールの側から先に開示する。前回残った Office の終了(起動時の確認)・Mark-of-the-Web の解除・検索結果から開くと Excel が前面に出る は利用者の操作に紐づく動作、インデックスが元文書の本文を保持する(情報の集約)・原本の一時コピーと、その回収・透過暗号化の製品が平文で見せたファイルの扱い はツールの性質上避けられない情報の扱い、インストーラー版 はインストーラー版だけに当てはまる動作である。
前回残った Office の終了(起動時の確認)¶
インデックス作成が異常終了すると、画面の無い Excel・Word・PowerPoint のプロセスが残り、メモリを占有し続けることがある。これを止めるために、次に画面を起動したとき、利用者に確認したうえで Stop-Process -Force を実行する(shared/office/office_process.ps1 の stopOfficeProcesses。safety.Tests.ps1 がこの 1 か所だけであることを確かめる)。
- 影響: 強制終了するため、対象プロセスで未保存の内容は失われる。
- 制御: 確認で利用者が[終了する]を選んだときだけ実行される。確認で出した PID のうち、実行の直前にも同じ条件を満たすものだけを止める。自動では実行されない。監視・常駐もしない。[今回は終了しない]を選べば何も止めず、次の起動でもう一度確認する。
- 対象の限定: 対象は、インデックス作成が起動したときにワークスペースへ記録した PID だけである。記録のある Excel(
EXCEL)・Word(WINWORD)・PowerPoint(POWERPNT)で、窓を持たず、起動した側がもう動いていないものに限る。利用者が自分で開いた Office には記録が無いため、確認にも出ず、止めない。 - 照らし直し: 止める直前に、PID のプロセスの名前と起動時刻が記録と同じかをもう一度確かめる。違うとき(PID が別のプロセスに使われたとき)は止めず、そのことを知らせる。
詳細は 前回残った Office の確認 を参照。
Mark-of-the-Web の解除(tebunko.bat)¶
tebunko.bat は PowerShell を 1 回起動し、その中で配布フォルダの scripts 配下の Mark-of-the-Web を解除してから、画面のスクリプトを実行する。
set "PS1=%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe"
if not exist "%PS1%" (
start "" notepad.exe "%~dp0scripts\tebunko\startup\no_powershell.txt"
exit /b 1
)
rem The tool's folder (ends with a backslash), passed to PowerShell by environment.
set "TEBUNKO_ROOT=%~dp0"
rem Step 1: the notepad opener (kept as a single assignment so a test can
rem replace it) and the tool's folder paths, used by every later step.
set "PSCMD=$opener='notepad.exe';$root=$env:TEBUNKO_ROOT;$startup=Join-Path $root 'scripts\tebunko\startup';$gui=Join-Path $root 'scripts\tebunko\gui.ps1';"
rem Step 2: clear Mark-of-the-Web from the scripts folder (see the comment above).
set "PSCMD=%PSCMD%Get-ChildItem -LiteralPath (Join-Path $root 'scripts') -Recurse -File -ErrorAction SilentlyContinue | Unblock-File -ErrorAction SilentlyContinue; "
rem Step 3: run the GUI script, catching a failure from before its own window opens.
set "PSCMD=%PSCMD%try { & ([System.Management.Automation.WildcardPattern]::Escape($gui.Replace('`','``'))) } catch { $err = $_; "
rem Step 4: in the catch, pick the reason (missing gui.ps1, Constrained Language
rem Mode, execution policy, or something else) and its text file.
set "PSCMD=%PSCMD%if (-not (Test-Path -LiteralPath $gui)) { $reason = Join-Path $startup 'missing_files.txt' } elseif ($ExecutionContext.SessionState.LanguageMode -ne 'FullLanguage') { $reason = Join-Path $startup 'constrained_language.txt' } elseif ($err.FullyQualifiedErrorId -like 'UnauthorizedAccess*') { $reason = Join-Path $startup 'execution_policy.txt' } else { $reason = Join-Path $startup 'failed.txt' }; $reasonLines = @(if (Test-Path -LiteralPath $reason) { Get-Content -LiteralPath $reason -Encoding UTF8 } else { @('tebunko could not start.') }); "
rem Step 5: build the record's detail lines (date, tool path, language mode,
rem PowerShell version, execution policy, and the error message).
set "PSCMD=%PSCMD%$detailLines = @(('==== {0} startup ====' -f (Get-Date -Format 'yyyy-MM-dd HH:mm:ss')), ('Tool: {0}' -f $root), ('LanguageMode: {0}' -f $ExecutionContext.SessionState.LanguageMode), ('PSVersion: {0}' -f $PSVersionTable.PSVersion), (Get-ExecutionPolicy -List | Out-String), ('{0}' -f $err.Exception.Message)); $allLines = $reasonLines + '' + $detailLines; "
rem Step 6: write the record in the tool folder (no record if it cannot be written; then the reason is shown), then show it.
set "PSCMD=%PSCMD%$openTarget = $reason; $candidate = Join-Path $root 'startup_error.txt'; try { Set-Content -LiteralPath $candidate -Value $allLines -Encoding UTF8 -ErrorAction Stop; $openTarget = $candidate } catch { }; & $opener $openTarget }"
start "" conhost.exe "%PS1%" -NoProfile -STA -ExecutionPolicy RemoteSigned -WindowStyle Hidden -Command "%PSCMD%"
-Command の中身は 1 行に書かず、意味のまとまりごとに set "PSCMD=..." を積み重ねて組み立てる(tebunko.bat が長い 1 行になって読みにくくならないようにするため)。delayed expansion は使わず(先頭の setlocal EnableExtensions DisableDelayedExpansion で、利用者の設定で有効になっていても無効にする。パスの ! が消えないため)、ツールのフォルダは環境変数 TEBUNKO_ROOT で渡して -Command の文字列には埋め込まない(パスに ' などがあっても PowerShell の構文として読まれない)。各 set は前の行までの %PSCMD% を展開してから文字列を足すだけなので、素直な変数展開で足りる。TEBUNKO_ROOT は、その起動のプロセスの中だけの環境変数で、中身はツールのフォルダのパスだけ。利用者・システムの環境変数は変えず(setx もレジストリも使わず、setlocal で、呼んだ cmd にも残らない)、起動した PowerShell とその子プロセスには引き継がれる。tests/meta/launcher.Tests.ps1 が、組み立てた結果が想定した文字列とちょうど一致することを確かめる。(try/catch の中身は、次の「起動に失敗したときの知らせ」で説明する。)
- 理由: zip で配布したものを展開すると全ファイルに Mark-of-the-Web が付き、実行ポリシー
RemoteSignedでは未署名スクリプトが実行できないため。 - 範囲:
%~dp0scripts(tebunko.batがあるフォルダのscripts)配下のみ。実行するスクリプトはすべてここにある。インデックス(work)には触らない。システム全体やユーザーのドキュメントには影響しない。画面(gui.ps1)も起動時に同じscripts配下に対して同じ解除を行う(ショートカットから直接起動したときのため)。 - 実行ポリシー:
Bypassは使わずRemoteSignedで起動する。恒久的な設定変更(Set-ExecutionPolicy)も行わない。-ExecutionPolicyはこのプロセスだけに効く。理由は次の「RemoteSignedで起動する理由」を参照。 conhost.exeを通す理由: 既定のターミナルが Windows Terminal の場合でも-WindowStyle Hiddenで PowerShell の窓を隠すため(画面の共通仕様)。- 恒久的な解消策: 配布物のカタログ(配布物の完全性(カタログ・ハッシュ一覧・来歴の署名))にコードサイニング証明書で署名すれば、この
Unblock-Fileは不要になり、AllSignedでも動作する。
起動に失敗したときの知らせ(tebunko.bat)¶
制限の強い環境(実行ポリシー・制限言語モード)ほど、gui.ps1 の画面が開く前に起動が止まり、利用者から見て「ダブルクリックしても何も起きない」ことになりやすい。tebunko.bat は、& $gui(画面の起動)を try/catch で包み、失敗したときは理由と記録のファイルの名前を Notepad で示す。インラインの -Command は実行ポリシーの対象外で、制限言語モードでも動くため、この知らせの処理自体は止まらない。
- PowerShell が無い:
%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe(PATH からは探さない。installer\tebunko.csと同じ)が無ければ、PowerShell を起動せずに Notepad で理由を示す。この場面だけは記録が残らない(PowerShell 自体が使えないため)。 - 理由の見分け方:
catchは、gui.ps1が無ければファイル不足、その場の言語モード($ExecutionContext.SessionState.LanguageMode)がFullLanguageでなければ制限言語モード、FullyQualifiedErrorIdがUnauthorizedAccessなら実行ポリシー、それ以外は起動できなかったと分ける。gui.ps1の有無を先に見るのは、無いのに「フォルダの許可を情報システム部門に相談」と案内しないため。許可されていない制限言語モードではgui.ps1の最初の読み込み(paths.ps1のNew-Object)で失敗し、ツールのフォルダを AppLocker・WDAC で許可している PC ではgui.ps1はFullLanguageで動くため、このcatchには来ない(画面が開く)。 - 理由の文言: 日本語の文言は ASCII で書く決まりの
tebunko.batに書けないため、scripts\tebunko\startup\*.txt(BOM 付き UTF-8・CRLF)に分けて置き、Get-Content -Encoding UTF8で読む。 - 記録: 理由の文言と、詳しい情報(日時・エラーの内容・言語モード・
Get-ExecutionPolicy -List・PowerShell の版・ツールの場所)を、ツールのフォルダのstartup_error.txtに書く(%TEMP%や%LOCALAPPDATA%\tebunkoには書かない。ツールのフォルダ自体が%LOCALAPPDATA%\Programs\tebunkoにあるインストーラー版では、その中に書く)。起動の前はワークスペースを決められない(設定を読むにはRemoteSignedで止まる場面がある)ため、ツールのフォルダにする。ツールのフォルダに書けないとき(C:\Program Filesに入れた場合など)は記録を残さず、理由の文言のファイルを Notepad で示すだけにする。ツールの場所(利用者名を含むパス)が記録に入るため、公開の Issue に貼る前に確かめるようトラブルシューティングに書いている。 gui.ps1の失敗の受け方との関係:gui.ps1は、パスの定義(paths.ps1)と記録の部品(startup_error.ps1)をtryの外で先に読み込み、そのあとの読み込み・画面の組み立てをtryの中で行う。tryの中で失敗すると、reportStartupFailureが、writeErrorLogがまだ使えない(app_host.ps1を読み込む前)ときはツールのフォルダのstartup_error.txtに記録し(書き込めなければ記録は残さない)、メッセージボックスを出す。制限言語モード・WPF が読めない場面ではメッセージボックスも出せないため、元の例外を投げ直し、上のcatchが受けて記録のファイルを上書きする(1 か所に記録が 1 件残る)。メッセージボックスを出せたときは、catchには来ない(二重に知らせない)。tryの外にある最初の読み込み(paths.ps1)で失敗したときは、reportStartupFailureを通らず、catchが受ける。インストーラー版tebunko.exeから起動したときは、記録に加えて、tebunko.exeがエラー出力(元の例外の内容)をメッセージで出す。- AppLocker の実行ファイルの規則で
powershell.exe自体が止められた場合:startは起動の失敗を待たないため、tebunko.batは気づけず、何も知らせない(Windows 自身の知らせと、イベントログ(AppLocker)だけが残る)。startを起動の失敗を待つ形にすると、画面を閉じるまでtebunko.batの窓が残ってしまうため、この場面は扱わない。
RemoteSigned で起動する理由¶
Windows のクライアント版(Windows 10 / 11)は、実行ポリシーの既定が Restricted で、.ps1 を 1 つも実行できない。本ツールはスクリプトでできているため、何らかの実行ポリシーを指定しないと起動できない。そこで、起動口(zip 版の tebunko.bat・インストーラー版の tebunko.exe)は、powershell.exe の -ExecutionPolicy RemoteSigned でそのプロセスだけの実行ポリシーを指定する。
- 設定を変えない:
-ExecutionPolicyの指定は、起動したプロセスとその子プロセスだけに効く。PC や利用者の実行ポリシーは書き換えず(Set-ExecutionPolicyを使わない)、管理者権限も要らない。本ツールを終えると元のとおりである。 RemoteSignedを選ぶ理由: 署名の無い手元のスクリプトを実行できる実行ポリシーのうち、いちばん厳しいため。手元のスクリプトは実行し、インターネットから来た(Mark-of-the-Web が付いた)スクリプトは署名が無ければ止める。本ツールのスクリプトは、上のUnblock-Fileで自分のフォルダのscripts配下だけ印を消して実行する。それ以外のダウンロードしたスクリプトは、本ツールのプロセスの中でも今までどおり止まる。- 組織が実行ポリシーを決めている場合: グループポリシーで実行ポリシーを決めている PC(
Get-ExecutionPolicy -ListのMachinePolicyかUserPolicyに値がある)では、そちらが優先され、-ExecutionPolicyの指定は効かない。グループポリシーがAllSignedなら、本ツールは署名するまで起動できない。これは組織の設定を守るための Windows の仕様であり、本ツールから回避はしない。
ほかの実行ポリシーを使わない理由は次のとおり。
| 実行ポリシー | 使わない理由 |
|---|---|
Bypass |
何も止めず、警告も出さない。未署名のスクリプトを Bypass とウィンドウを隠す指定(-WindowStyle Hidden)で動かす形は、マルウェアがよく使う形と同じで、EDR やウイルス対策ソフトに怪しまれやすい |
Unrestricted |
インターネットから来た未署名のスクリプトも、確認を出したうえで実行できてしまう。確認はウィンドウを隠した起動では見えず、処理が止まる |
AllSigned |
すべてのスクリプトに署名が要る。本ツールはまだ署名していない(署名すれば AllSigned でも動く。上の「恒久的な解消策」) |
ログに書く版と環境の情報¶
インデックス作成のログ(indexing_log.txt)の先頭と、画面のエラーの記録(gui_error_log.txt)の、画面を開いて最初の記録の前・ワークスペースを切り替えた後の最初の記録の前・記録を前の分に移した後の最初の記録の前に、不具合の切り分けに使う見出しを書く(getToolDiagnosticHeader)。
| 項目 | 内容 | 調べ方 |
|---|---|---|
| 日時 | UTC との差を含む | DateTimeOffset.Now |
| tebunko の版 | VERSION.txt のタグと、コミットの先頭 7 桁。無ければ 開発版 |
ツールのフォルダの VERSION.txt |
| OS | OSVersion.Version・ntoskrnl.exe のファイルバージョン・64 ビットか |
.NET の Environment・FileVersionInfo |
| PowerShell | 版・64 ビットか・言語モード | $PSVersionTable・$ExecutionContext |
| Office | Excel・Word・PowerPoint の実行ファイルの版・Click-to-Run か MSI か・ビット数。無ければ 見つからない |
Program Files の決まった場所のファイルを FileVersionInfo で読む |
| 表示言語 | 画面の言語 | CurrentUICulture |
- 調べられない項目は
不明と書く。1 項目が調べられなくても、ほかの項目と記録の本体は書く。 - 見出しには、利用者名・コンピューター名・ドメイン名・パス・ネットワークの情報・Office のアカウントを書かない。
- Office は、Windows のあるドライブの
Program Files・Program Files (x86)の決まった場所だけを探す。ほかのドライブに入れた Office や、ほかの版(Office 2010 以前など)は見つからないと出る。 - ログの本体(見出しの後ろ)には、クロール対象フォルダ・ワークスペースのパス(絶対パス)、ファイルの相対パス、エラーの内容がそのまま入る。 利用者名を含むパスが入ることがある。文書の本文は書かない。ログはワークスペースのアクセス権で守られる。外へ渡す(Issue に貼る・メールで送る)ときは、利用者が該当部分を伏せる。
- レジストリ・WMI・COM は使わない。Office は起動せず、ファイルの版を読むだけである。
- ログのファイルは、増え続けないよう世代を決めている(前の分を置き換えられない場面を除く。インデックス作成のログは前回の分を
indexing_log_previous.txtへ、画面のエラーの記録は 1 MB 以上でgui_error_log_previous.txtへ、起動の失敗の記録は 1 MB 以上でstartup_error_previous.txtへ移す)。年月での自動削除はしない。仕様はファイルの読み書き。
インデックスが元文書の本文を保持する(情報の集約)¶
本ツールは全文検索のために、元の文書の本文を平文の TSV として本文インデックス(インデックスのうち work\store\content\ の TSV)に保持する。これはツールの目的そのものであり、避けられない。審査では次の点が論点になる。
| 論点 | 内容 |
|---|---|
| アクセス権の非継承 | インデックスは作成した人の権限で作られる。元のファイルに設定されたアクセス権は引き継がれない。インデックスを置いた場所を読める人は、元のファイルを読む権限が無くても本文を読める |
| 2-gram の索引 | 本文インデックスとは別に、検索の候補を絞るために store\gram\<名前>\ の区画ファイル(.seg)にも、ファイルの相対パスと、本文から作った隣り合う 2 文字の組の値が入る。本文インデックスから作り直せる派生のデータ。仕様は gram 索引 にある |
| 検索結果ファイル | [結果をファイルに出力]で書き出す work\search_results.txt にも本文(該当行)が入る |
| 持ち出し経路 | インデックスのフォルダはコピーして別の PC でも使えるほか、[インデックス管理]の[エクスポート…]で 1 つの zip に書き出し、別の PC・ワークスペースで[インポート…]して使える(インデックスのエクスポート・インポート)。利用者の明示操作だが、設計上の持ち出し経路である。エクスポートした zip には、元のファイルの本文の文字・ファイル名・フォルダの構成・元のフォルダのパスが入るため、元のファイルと同じ扱いで渡す・置く(メールに添付する・共有フォルダに置くときは、元のファイルを渡すときと同じ判断をする) |
| 残留 | work/ を消さない限りインデックスは残る。元のファイルを削除しても、インデックス側の本文は次のインデックス作成まで残る。前の版のワークスペース(index\)は自動で消さず、利用者が消す(前の版の system_index\ は、次のインデックス作成で本ツールが消すが、index\ はそのまま残る) |
運用での対策(導入時に決めることを推奨):
- ワークスペース(既定は
%USERPROFILE%\Documents\tebunko_ws。[設定]で変えられる)のアクセス権を、クロール対象フォルダと同等以上に制限する。 - 権限の異なる利用者が読める共有フォルダに、インデックスをそのまま置かない(ワークスペースを各利用者のローカルに置く)。
- 持ち出し(別 PC へのコピー)の可否を運用ルールで決める。
- ディスク暗号化(BitLocker)を前提にする。
本ツール側では、インデックスの場所をワークスペース配下に限定し、アクセス権の変更(Set-Acl 等)を一切行わない。したがってインデックスの保護はワークスペースのアクセス権で決まる。
原本の一時コピーと、その回収¶
インデックス作成中は、原本のコピーを作業領域(work/tmp/<PC の鍵>/<PID>)に作る(取り込み対象のファイルは書き換えない)。作業領域はワークスペース(本文インデックスと同じ置き場所)の下に限る。機密文書のコピーがシステムの %TEMP% へ出ることは無い。ワークスペースのパスに [ ] が含まれる・長すぎるなど、作業フォルダをワークスペースの下に置けないときは、取り込みをすべてスキップする(どのファイルも中間 TSV などをこの作業領域に作るため、テキストファイルを含めすべての取り込みが対象になる。取り込み一覧に失敗として残る。エラーメッセージ)。
- 通常終了時: ファイルごとに、読み終えたコピーを削除する。インデックス作成の完了時に作業フォルダごと空にする(
removeTmpDir)。 - 異常終了時: 強制終了・停電などでコピーが残ることがある。この場合、次回のインデックス作成開始時に、終了済みのプロセスの作業フォルダをまとめて削除する(
tebunko/indexer/index_migrate.ps1のremoveStaleTmpDirs。インデックス作成の開始時にinitTmpDirが呼ぶ。safety.Tests.ps1の「異常終了で残った作業フォルダを次回起動時に回収する」が確かめる)。前の版(%TEMP%\tebunko\<PID>に一時ファイルを置いていた版)が残したものがあれば、同時に片付ける。 - 残る期間: 異常終了から次回のインデックス作成開始までの間は残る。気になる場合は
work/tmpを手で削除してよい(動作に影響しない)。
透過暗号化の製品が平文で見せたファイルの扱い¶
社内のファイル暗号化製品(透過型。IRM・秘密度ラベルの暗号化とは別の仕組み)が導入されている環境では、その製品が Office を「許可されたアプリ」として登録していることがある。その場合、本ツールが作業領域に作ったコピーを Office が開くと、製品が復号した平文を Office に渡す(暗号化されたファイルの判定の「形式の分からないバイナリ」の予備)。
- 本文はインデックスに平文で入る。これは「インデックスが元文書の本文を保持する(情報の集約)」と同じ性質で、透過暗号化を導入した目的(暗号化されていない経路での漏えい防止)と、本文インデックスに平文で保持することは緊張関係にある。
- 本ツールは製品を判別しない。製品に許可されたアプリかどうかを問い合わせる手段を持たず、結果(読めた・読めなかった)でしか分からない。
- 読めなかった場合は理由付きで失敗にする(
暗号化されているか壊れているため取り込めません。)。中身の分からない暗号文をインデックスに書き込むことはない。 - 運用での対策: 透過暗号化を導入している環境では、対象フォルダを取り込み対象にするかどうかを、インデックスが元文書の本文を保持する(情報の集約)の対策と合わせて判断する。
検索結果から開くと Excel が前面に出る¶
検索結果から元の Excel ファイルを開くときは、Excel を可視化して前面に出す(tebunko/ui/open_source.ps1:437・509)。利用者が開くよう操作したときの動作である。インデクサ側の Office は不可視で動作する。ただし、画面の無い Excel・Word・PowerPoint に利用者が開いたファイルが入ったときは、そのファイルを閉じないよう終了させずに窓を出して利用者に渡す(Office ファイルを開くときの設定。safety.Tests.ps1 が、Visible = $true は open_source.ps1 と、渡す処理(office_app.ps1 の restoreHandedOverApp。handOverApp と retryKeptApps が呼ぶ)にしか無いことを確かめる)。
もらったインデックスの元のフォルダ¶
インデックスは元のフォルダの場所(source_folder.txt・エクスポートの zip の目録)を持つ。コピーや zip で渡ったインデックスの場所は、作った人が書いたものである。検索結果から開くと、その場所のファイルを開くため、利用者の知らない共有フォルダ(\\host\share)が書かれていると、開く操作で Windows がその共有フォルダに接続し、サインイン情報を送ることがある。tebunko 自身は通信しない(ネットワーク通信を行わない)が、接続するのは Windows である。
本ツール側の対策:
- 設定に名前が無いインデックスは、元のフォルダに触れる前(接続の前)に確認する。説明に、ローカルのドライブと分からないとき(共有フォルダなど)はサインイン情報が送られることがある旨を添える。[このフォルダを使う]を選ぶか、[フォルダを選ぶ]で別のフォルダを選ぶまで、接続しない(もらったインデックスの元のフォルダを確かめる)。
- zip からのインポートの確認ダイアログは、元のフォルダがローカルのドライブでなければ(共有フォルダ・デバイス名の形など)、有無を調べるための接続をしない。
- もらったインデックスのマクロを持てる形式(
.xlsm.docmなど)は、読み取り専用で開く。開けなければ開かない。
残るもの:
- 利用者が[このフォルダを使う]を選べば、以後その場所に接続する。心当たりのない場所なら選ばない。
- 読み取り専用で開いても、マクロの実行を止めるのは Office の設定(セキュリティセンター)である。
運用での対策(導入時に決めることを推奨): 組織の外の共有フォルダ(SMB)への通信は、ファイアウォールで制限する。もらったインデックスは、渡した人を確かめてから使う。
インストーラー版¶
配布物は 2 つある。中身のスクリプト(scripts/)は同じで、入れ方と起動口だけが違う。
| 配布物 | 向いている環境 | 実行ファイル |
|---|---|---|
tebunko-<タグ>.zip |
実行ファイルを入れたくない・入れられない環境 | 含まない(起動口は tebunko.bat) |
tebunko-setup-<タグ>.exe |
手軽にインストール・アンインストールしたい環境 | インストーラー自身と、入れる tebunko.exe・uninstall\unins000.exe |
インストーラーは Inno Setup 7 で作る(installer/tebunko.iss・tools/new_installer.ps1)。
- 入れる場所と権限: 既定は管理者権限なしで
%LOCALAPPDATA%\Programs\tebunkoに入れる。管理者は、最初の画面で「すべてのユーザー」を選ぶとC:\Program Files\tebunkoに入れられる。 - 入れるもの:
tebunko.exe・scripts\・LICENSE・VERSION.txt(版とコミットの記録。画面の「バージョン情報」に出す)と、Inno Setup のアンインストーラー(uninstall\unins000.exe・uninstall\unins000.dat。名前は Inno Setup が決め、変える設定が無いため、tebunko のものと分かるようuninstallフォルダに置く)だけ。スタートメニューにショートカットを作る(デスクトップは選んだときだけ)。 - レジストリ: インストーラーが、Windows の「インストールされているアプリ」に出すためのアンインストールの情報(利用者ごとなら
HKCU、すべてのユーザーならHKLMのSoftware\Microsoft\Windows\CurrentVersion\Uninstall\{E2FA5AC9-5A36-41AF-B5E2-B989E2878D3C}_is1)を書く。これ以外のレジストリ、PATH、ファイルの関連付け、サービス、自動起動には触らない(installer.Tests.ps1が[Registry]の節が無いことなどを確かめる)。ツール本体(スクリプト)はレジストリを読み書きしない(検査項目と結果)。 - 起動口
tebunko.exe: 本リポジトリのinstaller/tebunko.cs(約 100 行)を、リリースのときに Windows 標準のcsc.exe(.NET Framework)でビルドする。していることはtebunko.batと同じで、Windows の PowerShell 5.1 でgui.ps1を-ExecutionPolicy RemoteSignedで起動するだけである(Mark-of-the-Web の解除 の「RemoteSignedで起動する理由」)。インストーラーが書いたファイルには Mark-of-the-Web が付かないため、Unblock-Fileはしない。窓のアプリとしてビルドし、PowerShell も窓を作らずに起動する(conhost.exeは要らない)。PowerShell が 0 以外で終わりエラー出力があれば、その内容をメッセージで出す(実行ポリシーや制限言語モードでgui.ps1を読み込めないときに、何も出ずに終わらないようにするため)。エラー出力を受け取るため、画面を閉じるまでtebunko.exeのプロセスも残る(窓は無い)。 - 更新: 新しい版のインストーラーを実行する。前の版の
scripts\を消してから入れるため、前の版にだけあったスクリプトは残らない。setting.configは残る。 - 起動中の更新・削除:
tebunko.exeが起動中はミューテックスtebunko-installed-appを持ち、インストーラーとアンインストーラーはこれを見て、tebunko を閉じるよう求める(Inno Setup のAppMutex)。 - アンインストール: 「設定」→「アプリ」から行う。入れたファイル・ショートカット・アンインストールの情報と、ツールのフォルダの
setting.config・startup_error.txt・startup_error_previous.txt・startup_error_moving.txt(あれば)を消す。インデックス(ワークスペース)は消さない。 ワークスペースは利用者が選んだフォルダのこともあり、中身を確かめずに消すのは危ないためである。インデックスには文書の文字がそのまま入っているため(インデックスが元文書の本文を保持する(情報の集約))、アンインストールの最後に、残っている場所(既定は%USERPROFILE%\Documents\tebunko_ws)を知らせる。 - 無人のインストール:
/VERYSILENT /CURRENTUSER(アンインストールはuninstall\unins000.exe /VERYSILENT)で、画面を出さずに入れる・消すことができる。 - 署名: インストーラーと
tebunko.exeにはまだコード署名が無い。そのため、ダウンロードしたインストーラーを実行すると SmartScreen の「Windows によって PC が保護されました」が出る([詳細情報]→[実行]で進める)。改ざんの確認には、ビルドの来歴の署名と SHA256 を使う(配布物の完全性(カタログ・ハッシュ一覧・来歴の署名))。 - 再現性:
csc.exe(.NET Framework)と Inno Setup はビルドの日時を埋め込むため、同じソースからビルドしてもハッシュは一致しない。zip の中身と同じスクリプトが入っていることは、インストールしたフォルダでカタログ(配布物の完全性(カタログ・ハッシュ一覧・来歴の署名))と比べれば分かる。カタログにあるtebunko.batはインストーラー版に無いため、StatusはValidationFailedになる。tebunko.batを除いて違うファイルが無い(次の結果が空になる)ことを確かめる。
$r = Test-FileCatalog -Path .\scripts -CatalogFilePath <ダウンロードした tebunko.cat> -Detailed
@($r.CatalogItems.Keys + $r.PathItems.Keys | Sort-Object -Unique | Where-Object { $_ -ne 'tebunko.bat' -and $r.CatalogItems[$_] -ne $r.PathItems[$_] })
単一 .ps1 版(試験版)¶
zip・インストーラーに加えて、展開せずに 1 本の .ps1(tebunko-<タグ>.ps1)だけで動く試験版を並べて配る(単一 PowerShell のビルド)。中身のスクリプトは同じ scripts/ から機械的に結合したものである。
tebunko.batに相当する起動口が無い: 自分自身の Mark-of-the-Web を解除する動き(Unblock-File)は持たない。実行ポリシーも指定せず、右クリック[PowerShell で実行]や、呼び出す側が指定したポリシーのまま動く(単一 PowerShell のビルド「実行時の違い」)。- 起動失敗の知らせ方: 画面が開く前の失敗は、zip 版と同じ
reportStartupFailure/writeStartupErrorFile(ツールのフォルダのstartup_error.txt。書けなければ記録を残さない)に記録する。tebunko.batのcatchに相当する外側の受け皿が無いため、単一 .ps1 の起動口(gui.ps1の本体)のtry/catchが直接この関数を呼ぶ。ただしlib.ps1の読み込みはtryの外にあるため、その失敗はreportStartupFailureに届かず、PowerShell の窓に出る。 - 署名・改ざんの確認:
tebunko.catは対象にしない(1 本のファイルのため、配布物の完全性(カタログ・ハッシュ一覧・来歴の署名)の SHA256SUMS.txt と来歴の署名だけで確かめる)。 - 試験版という扱い: 利用者の確かめが済むまでは「試験版」とし、zip 版・インストーラー版と並べて配る。