PrimoCache を使って Intel の最新チップセットでも HDD を SSD を使って高速化する

どうもみむらです。
先日 PC が故障しまして第9世代の Intel CPU (i7-9700) を用いて組み直していました。

故障する数日前からビープ音(長音)の連続で起動に失敗したりしていたので
なんか気持ち悪いなとは思っていたのですが。。

テレワークが推奨されており、お仕事に甚大な影響が出ることもありましたので
ツクモ電機さんのレジの横にあるリーダーにクレジットカードをシャコシャコッと何度も差し入れしてきました。。来月の引き落としに今から震えています。

ただ今回買い換えを行ってみて
Intel Smart Response Technology (iSRT, HDD を SSD キャッシュで高速化するやつ) が
Intel Optane Memory との組み合わせ専用かつ、RAID 不可に変更
されており
iSRT を使って RAID-5 を高速化していた身としてはかなりショックでした。。

では iSRT の代替としていいものは無いのかと探していたところ
PrimoCacheという良さそうなものを見つけたので試してみました。


PrimoCacheとは

HDD を SSD でキャッシュして高速化するソフトです。
まさしく Intel の Smart Response Technology で実現していたものを実現してくれます。

ほかにも FuzeDrive (AMD 環境では StoreMI という名前で提供されています) というソフトなどもありますが、いくつか試してみたところ PrimoCache がよさそうな感じでした。

PrimoCache は Romex Software 社の製品で、1つ当たり $29.95 の製品になっています。
https://www.romexsoftware.com/en-us/primo-cache/

なお私自身はメーカーさんから
今回の記事に関して何か支援を受けてはいませんのであしからず。。

PrimoCache の設定をする

左上のボタンを押してドライブを追加します。

図3 : ドライブの追加ボタン

次の画面で「高速化したいドライブ」を選択します。

図4: 高速化したいドライブを設定。今回は Intel RAID 1 ドライブ。

次にキャッシュの方法についての設定です。
Level-1 Cache が “DRAM 上” のキャッシュ、 Level-2 Cache がストレージとなります。

またキャッシュについては文字通り Level1, Level2 の階層構造になっています。

今回の場合は SSD キャッシュのみを有効にするため、
Level-1 Cache は 0MB に設定します。

図5: Level-1 Cache を 0MBに設定する

次に Level-2 Cache を設定するために、画面中央の小さなボタンを押下します。

図6: Level-2 Cache の設定ボタン

ボタンを押下すると次のような画面が表示され
キャッシュ用のドライブを選択する画面になります。

今回は Intel Optane Memory を使うため
INTEL MEMPEK.. で始まるドライブを選択します。

注:もちろん Intel Optane Memory を使わずに通常の SSD でも利用可能です。
注2:認識されている容量が小さい場合は何らかのパーティションを作ってから再試行してみてください。

図7: キャッシュ用ドライブを設定している図¥

設定後、 “Size” を “MAX” に変更し、その横にあるボタンを押下します。

図8: キャッシュ設定を行う

特に何もなければ
“Individual Read/Write Cache Space” のチェックを無効にします。

これが ON の時はそれぞれのキャッシュが設定した割合で行われますが
無効の場合は割合を気にせずに Read / Write キャッシュを行うようになります。

図9: Read/Write Cache の割振設定を無効にする。

最後にお好みで Defer-Write (遅延書き込み) の設定を行います。

遅延書き込みを有効にすると応答速度が速くなりますが、
ディスクへの書き込み(キャッシュ内容の反映)が遅くなります。

図10: 設定がほぼ完了した図

設定が完了したら “Start” を押下します。

画面UI について

稼働を始めると下記のようにキャッシュ率などが表示されます。

図11: 稼働が開始した画面

ある程度動きはじめたら、画面を閉じて仕事に戻りましょう。


冒頭のとおり PC の故障で買い替えたところ
Intel RAID 構成に対する SSD キャッシュが使えなくなって呆然としていたところ
こういうソフトを見つけることができてよかったです。。!

また前回の構成では Intel RAID の RAID-5 だったのですが
iSRT が有効な環境だと最新のマザーボードや mdadm ではマウントできず焦りましたが
dmraid を使うことでマウントができました。

PrimoCache の場合は Intel RAID と SSD Cache が別の機構なため
同じようにマウントできなくなることは(きっと)ないと思いますし安心です・・!

ではでは、素敵なテレワークライフを!

Ubuntu 19.10 で Hyper-V の Enhanced Mode を有効にする (Enable the Enhanced Mode with Ubuntu 19.10)

どうもみむらです。

Ubuntu を Hyper-V で使用していると、
起動時に高確率で GUI 起動待ちになって何も操作できなくなったり
( Ctrl + Alt + Function Key での切り替えしてもログイン画面が出てこない )
そもそも Enhanced Mode が使えなくて色々と不便でしたので、
有効にするスクリプトを作成しました。


Hi I’m Mimura.

I make a script to enable the “Enhanced Mode” on Hyper-V with “Ubuntu 19.10”.
Also, it fix an issue that to fail to start X.


Script:

下記からダウンロードできます。 / you can download from this link:
https://gist.github.com/mimura1133/a6aebf4945b6688d1a5aedffdfa9368c


How does it works / どういう仕組みか:

このスクリプトは、
Microsoft が提供している Enhanced Mode を有効にするスクリプトを元に
作成されています。

https://github.com/microsoft/linux-vm-tools/tree/master/ubuntu/18.04

最近の Ubuntu では Wayland を最初に使用しようと試みます。

上記のスクリプトでは、 Xorg を使うようにできているため、
Wayland を利用しないようにする処理を追加し、
Enhanced Mode を Xorg 経由で使えるようにしました。

# Stop to use wayland.
sed -i_orig -e 's/#WaylandEnable=false/WaylandEnable=false/g' /etc/gdm3/custom.conf

また、どうやら Ubuntu に入っている Wayland と Hyper-V が相性が悪いらしく
時々起動に失敗する(コンソール経由のログインも受け付けない状態になる)のですが
Wayland を無効にすることで、確実に起動できるようにもなります。

(Arch Linux に入れたときには上手く動いていたので、 Ubuntu の問題だと個人的には思ってます..)


this script based on Microsoft’s.
https://github.com/microsoft/linux-vm-tools/tree/master/ubuntu/18.04

Recent versions of ubuntu are try to use a Wayland before using Xorg.
So, I added a code to disable to use Wayland.

# Stop to use wayland.
sed -i_orig -e 's/#WaylandEnable=false/WaylandEnable=false/g' /etc/gdm3/custom.conf

In addition, the Wayland and Hyper-V seem to be incompatible, sometimes fail to boot,
but the issue is fixed at the same time by disabling wayland.


Ubuntu の最新版が Enhanced Mode でサクサク動いて、コピペも出来るようになりますし、
同じように Kal Linux でも Enhanced Mode が使えるようにするものも公開していますので
Linux を Hyper-V で使っている方は、是非お試しくださいませー。

I have also released another versions for Kali Linux.
Please feel free to use the script if you’re using Linux on Hyper-V.

Git Repository (Forked from Microsoft):
https://github.com/mimura1133/linux-vm-tools

SECCON 2019 Final Write-up (Mimura)

みむらです。
先日 SECCON CTF が行われ、司会業しながら問題もひとつ出題させて頂きました。

当日朝来たら「問題名は mimura ね!」となっていました。

みなさんがもしかしたら持たれていたかもしれない、
「なんだよ、自己主張強すぎだろ・・」みたいな認識は誤りです。。(苦笑)

当人も年末に心臓にリアップ(育毛剤)を掛けられた感じで、
それはそれはよい毛が生えた気がします。冗談はこの辺にして。。


Hi, This is Mimura is author of “Mimura” challenge had provided on SECCON 2019 final.

I would have named to my challenge if I knew it will called as my name.
but in fact, I got a strong heart in exchange for the result.

okay, enough with jokes. I’ll start explaing how to solve it:


問題のストーリー / Overview:

パスワードロックされている USB ドングルが渡されるので
上手くパスワードロックを解除して中からフラグ文字列を探すことが目的です。

そのための手としては下記のようなものが考えられます。 (解くために必要な訳ではないです):
・USB ケーブルを接続する
・デバッガに接続する。
・ファームウェアを取り出して解析する。
・改造して書き戻す
・半田ごてで回路を変更する etc…


We provide a usb-key which seems protected by password.
you should find a password and find a flag on this device.

You can.. ( of course, you don’t have to do everything.) :
・Connect to Debugger (Hardware Emulator)
・Connect to PC
・Dumping and Analyse a firmware.
・Rewrite a modified firmware.
・Modify the circuit with soldering iron etc..


どうしてこういう問題を作ろうと思ったか。 / What influenced:

ハードウェアに関する問題を作ろうと思っていて、
ハードウェアロック付きの USB メモリを問題にしたら面白そうと思ったのがきっかけです。

また最近は業務でもハードウェア機器を触ったり色々としていますので
自分の中で作問を通してちょっと無理(学習)をしてみようという気持ちで
マスストレージに挑戦してみようと思いました。


I was influenced by Security USB-Key.

My main job is security researcher and developer, and I have recently been investigating of hardware device.
So, I thought to try to make mass storage device without an OS and growth up my skills.


ステップ1:ハードウェアを繋ごう
Step1 : Let’s connect the device to your machine.

ハードウェアを繋ぐと上記のような2つのデバイスが認識されます。
You will find these devices on your machine when connect the device.


また、マスストレージの方は、それっぽいファイルが保存されているのですが、
“<THIS SECTOR AREA IS PROTECTED BY HARDWARE PROTECTION>” と表示されていて、
内容が読めません。

You can find deleted file that seems would contain a flag data, but it seems protected.


COMのほうはというと、繋ぐとパスワードを要求され、
3回失敗すると、パスワードの受付を一切してくれなくなります。

Let’s check the com port. It looks like we need to input correct password via COM port.
And if you input wrong password three times, the device going to freeze.


ステップ2:デバッガを繋ごう
Step2 : Let’s connect emulator (debugger) to device.

USBポートの真逆の位置に、SWD ポート(デバッガを接続するためのポート)が生えています。
ここに問題と一緒に配布していたケーブルを接続し、デバッガ (STLink) と接続します。

You can find a SWD port that uses for hardware debugging on the other side of USB port.
You need insert a cable which we provided at beginning of the game and connect to the emulator (STLink).


ただそのままでは接続できません。

世の中に売られているハードウェアにおいても、
こういうデバッグポートは何らかの手によって接続できないように作られています。

今回の問題では、本体のプログラムコードの冒頭で SWD ポートを無効にするように
コードを入れておきました。

But… you may can’t connect the device via emulator if just connect.
Most devices disable the debug port (such as SWD, JTAG ICE and so on..) to protect “Intellectual Property” or prevent from illegal use.

Also on this device, I insert a code to disable the SWD port at the beginning of the main program code.


Description of Boot Mode selection (from ST.com, en.CD00164185.pdf)

今回のボードですと、上にジャンパスイッチがありました。

ここをの上のピン (BOOT0) を “0” 以外にすることで、メインファーム(今回の問題のプログラム)以外でシステムが立ち上がるようになるため、
プログラムによって SWD の無効化が行われず、接続可能となりました。

その他の方法としては、上の “RST” と書かれたボタン(リセットボタン)を押し続け
プログラム自体が起動しない状態にして接続するという方法もあります。


You can control the boot mode by Jumper switch.
If you change the BOOT0 pins ( upper pin ) to 1 (such like the photo), you can connect SWD port because the hardware will not run the challenge binary.

In other way, you can connect it with push and hold the RST button until connect the emulator successfully.


Description of Boot Mode selection (from ST.com, en.CD00225773.pdf)
Description of Boot Mode selection (from ST.com, en.CD00225773.pdf)

接続が無事に完了すれば、メモリをダンプするツールを用いて
フラッシュの内容を抜き出します。

アドレスについては、同じようにチップの仕様書を見ると
“Flash memory” は 0x08000000 から 0x080FFFFF にアドレスが設定されていますので、
この範囲を見ながらダンプを行います。

今回の問題では 64K のメモリが積まれていましたので、
Sector 0 から Sector 3 (0x0800FFFF) までがアクセス可能になっているかと思います。

上記の例では STM32 ST-Link Utility を使用しましたが、
その他に使い慣れたプログラマやデバッガをお持ちであればそれを利用したりして
抽出すれば良いと思います。

例えばSTM32 を J-Link 化したあと OpenOCD で接続して、
mdw コマンドで “mdw 0x8000000” として取り出したり
dump_image コマンドで “dump_image dump.bin 0x8000000 0xFFFF” みたいな感じで
抽出するという方法などもあります。


After connection, you can rip the firmware from hardware with writer tool.

According to the peripheral data sheat, You can find that the main firmware saved on a memory of 0x08000000 (Sector 0) to 0x0800FFFF (Sector 3) area.

I used STM32 ST-Link Utility to rip the challenge program binary on this time.
It’s also possible to rip with OpenOCD or similar tools.

if you try to rip with OpenOCD, you can use “mdw” command (i.g. “mdw 0x8000000” ) or “dump_image” command (i.g. “dump_image dump.bin 0x8000000 0xFFFF”)


ステップ3:ファームウェアを解析しよう
Step 3 : Let’s analyse the firmware!

普段は IDA 使いなのですが、
無料の範囲でバッチリできることを確認するために、 Ghidra でやってみます。

パスワードを入力したあとに “Checking…” と出ますので
その文字列の処理を頼りに探してみると 0x80001a8 付近にパスワードの確認処理が見つかります。

ここの処理を見ると下記のルールが現れます:
・1文字目は “O”
・3文字目、7文字目、11文字目は “e”
・9文字目は “a”
・10文字目は “m”

つまり、不明な部分を適当な文字で埋めると “O_e___e_ame!” となります。


Let’s analyse the firmware with Ghidra!

Looking back at the communication via serial port, the string that “checking ..” was appeared after send a password.
At address 0x80001a8, you can find the code.

According the code, you’ll find these rules:
* 1st character is “O”
* 3rd, 7th and 11th character is “e”
* 9th character is “a”
* 10th character is “m”

Therefore, the password will “O_e___e_ame!”. ( I filled unknown character with “_”)


やった!解けました!
Hooray! you did it!!


実は… / It’s hard to say this, but…

・・・ですよね。。すみません。
これなのですが、書き込むリビジョンを間違えてしまいまして、
特定位置の文字列チェックが欠損した版になっていました。
ミスの状態のまま出題を行ってしまい申し訳ありませんんでした。。。

…yes, I know why you’re being wired. It’s a my fail. I’m so sorry.
I had made a mistake that I wrote an another version firmware.
Thus, you would not have found a 2nd, 4th, 5th, 6th and 8th character.

ここで回答を期待していたキーワードは “開け!ゴマ!” です。
アリババと40人の盗賊で登場する話ですが、日本だと「アラジン」とかそういう話でも出てくるので世界一般以上に日本で有名なキーワードなんじゃないかと思います。知りませんけど。。

My expected password is “Open Sesame!”.
This is one of the most famous words from “Alibaba and the Forty Thieves”, I think.


ステップ4:ファイルを取り出そう
Step 4 : Let’s extract the file.

アンロックしてから読み直すと、フラグファイルが見えるようになります。
あとはこれを展開すると、フラグが出てきます。

SECCON{YOU_CAN_ANALYSE_HARDWARE_DEVICE}

After unlocked, let’s try to find a flag file on the storage with Forensics tool.
You can get a flag after by extracting it.

SECCON{YOU_CAN_ANALYSE_HARDWARE_DEVICE}


FAQ / よくある質問

Question:
 試してみたいのですが、評価ボードはもらえますか?
 Can you give me the challenge board?

Answer:
 ごめんなさい。。でももしお会いできる機会があれば、事前にお持ちすることは可能です。
 Sorry. I can’t. but I can show you the board. please feel free to contact me.

Question:
 どうしてパスワードを解除したあとにファイルが表示されないのですか?
 Why didn’t show the file after unlocked?

Answer:
 Windows でテストをした際に、エクスプローラや通常の方法で読み出しに失敗することが何度か確認できており、当該のエラーの解決が間に合わなかったのが理由です。。すみません。。
 I’m sorry again. I found a issue that windows system can’t read FAT12 data correctly, and I couldn’t find a solution before the CTF.


最後に / Summary and digression:

次出すことがあれば、もっとちゃんと自分が納得できる問題を提供したいなと思っており
今回の自分の問題は、ソフトウェアディベロッパとして、ユーザにソフトウェアを提供することのある人間としては、クオリティが低すぎたんじゃないかと自分でも猛省しています。

とはいえ、別件のこともありますし、Twitter で軽く触れたことは自分の意見には間違いないので
機会があれば十分な期間を取った上で、問題のクオリティや出し方(何をすれば良いのかを明瞭にする、問題タイトルをまともなモノにする)を自分の納得できるレベルにして出題してみたいですね。

問題を通してハードウェアに対してちょっとでも興味を向けてもらえる人が増えたなら
(ハードウェアから信頼を築いていく面白さとか、純粋に現実世界と仮想空間が繋がるのたのしい!とか思ってもらえたなら)今回出題して良かったなーと思います。

・・・司会業を当日していながら、色々と申し訳ない気持ちとかがあったのですが、
そういうのはチラ裏で。


I think I could have improved the quality of the challenge If I had more time.
Thus, I need to apologize to the CTF Player.

But fortunately, some CTF players told me the challenge was interesting.
It made me very happy.

so I think I want to create the “CTF challenge” ( the meaning that it meets the criteria for a general CTF challenge) in the hardware genre if next seccon ctf is to be held.


ところで、今回の問題はシンガポールで作っていたのですが、
あの「マリーナベイサンズ銀行」の預金ってどうやったら下ろせるんですかね。

by the way, could you tell me how to withdraw the money at “Marina Bay Sands Bank” if you know.
I think it’s the same way to get points in CTF, but it was very difficult for me….
especially slots….

ではでは! Bye!

iptables から nftables にサクッと切り替える

どうもみむらです。

Red Hat Enterprise Linux 8 になって iptables から nftables に本格的に切り替えが始まりました。
CentOS 8 もこれを受けて nftables への切り替えが必要になってきました。

参考資料:Linuxにおける新たなパケットフィルタリングツール「nftables」入門
https://knowledge.sakura.ad.jp/22636/

firewalld で書いていれば影響を受けないらしいのですが
iptables で直接ルールを書いている人なので、これを機に nftables に変換してしまおうかと。


実はさくっと切り替えられる

とりあえず変換して nftables で管理出来るようになればよいのであれば
下記の2パターンの方法で変換可能です。

パターン1 : iptables-restore-translate で設定ファイルを変換する
パターン2 : iptables を有効にしたあと nft で設定を取り出す

見た限りでは パターン1の方が色んなサイトでも紹介されており
出てくる設定を見ても綺麗な設定に思えるので、推奨なんだと思います。

ただパターン2だと、NAT 設定などもきちんと変換されますので、
急ぎで行いたい場合はパターン2で、
時間があるときは1で変換して、さらに手入れをするのが良いと思います。


1. iptables-restore-translate を使う

iptables の設定ファイル (/etc/sysconfig/iptables, /etc/sysconfig/ip6tables) や
iptables-save の結果を用いて変換をします。

1.1. 設定を保存する

CentOS や RHEL で iptables を直接触っている場合は
/etc/sysconfig/iptables もしくは /etc/sysconfig/ip6tables に保存されていると思いますので
このステップはスキップ可能です。

そうでないばあいで iptables の設定を取り出す必要がある場合は
iptables-save コマンド等で取り出しておきます。

1.2. 変換する

下記のコマンドを使用して iptables の設定を nftables のコマンドに変換して流し込みます。

# iptables-restore-translate -f /etc/sysconfig/iptables   | nft -f - # IPv4
# ip6tables-restore-translate -f /etc/sysconfig/ip6tables | nft -f - # IPv6

1.3. 保存する

下記のコマンドを実行して保存します。

なお下記の保存先は RHEL, CentOS の場合の例です。
お使いのディストリビューションに合わせて適宜変更してください

# nft list ruleset > /etc/sysconfig/nftables.conf

以上で変換が完了します。

この方法で変換した場合、下記のような設定が流し込まれます。
(あくまでも一例です)

# /etc/sysconfig/iptables
*filter
:INPUT DROP [0:0]
:FORWARD DROP [0:0]
:OUTPUT ACCEPT [0:0]
-A INPUT -i lo -j ACCEPT
-A INPUT -p tcp -m state --state RELATED,ESTABLISHED -j ACCEPT
-A INPUT -p tcp -m tcp --dport 80 -j ACCEPT
COMMIT

# iptables-restore-translate -f /etc/sysconfig/iptables
add table ip filter
add chain ip filter INPUT { type filter hook input priority 0; policy drop; }
add chain ip filter FORWARD { type filter hook forward priority 0; policy drop; }
add chain ip filter OUTPUT { type filter hook output priority 0; policy accept; }
add rule ip filter INPUT iifname "lo" counter accept
add rule ip filter INPUT ip protocol tcp ct state related,established  counter accept
add rule ip filter INPUT tcp dport 80 counter accept

# nft list ruleset
table ip filter {
        chain INPUT {
                type filter hook input priority 0; policy drop;
                iifname "lo" counter packets 0 bytes 0 accept
                ip protocol tcp ct state established,related counter packets 0 bytes 0 accept
                tcp dport http counter packets 0 bytes 0 accept
        }

        chain FORWARD {
                type filter hook forward priority 0; policy drop;
        }

        chain OUTPUT {
                type filter hook output priority 0; policy accept;
        }
}

また試してみた範囲では、NAT の処理が上手く変換できないようで
失敗することがありました。

次に紹介する方法では、リスクが少しあるのですが
上手く変換できましたのでご紹介します。


2. iptables を有効にしたあと nft で設定を取り出す

今まで使用していた設定を iptables コマンド経由で有効にしたあと
nft コマンドを用いて現在の設定を nftables 形式で取り出す方法です。

この方法が使えるのは OS に入っている iptables コマンドが
nftables の互換レイヤを使っている場合に限られます。

互換レイヤを利用しているかどうかについては、 “iptables –version” コマンドを実行し
末尾に (nf_tables) が付いているかどうかで判断できます。

# CentOS 7 (iptables)
# iptables --version
iptables v1.4.21

# CentOS 8 (nftables)
# iptables --version
iptables v1.8.2 (nf_tables)

2.1. iptables コマンド経由で設定を有効にする

iptables-restore コマンドを利用して、既存の設定を読み込ませます。

# iptables-restore < /etc/sysconfig/iptables
# ip6tables-restore < /etc/sysconfig/ip6tables

2.2. nft コマンドを使って設定を読み出して保存する

下記のコマンドを実行して保存します。

なお下記の保存先は RHEL, CentOS の場合の例です。
お使いのディストリビューションに合わせて適宜変更してください

# nft list ruleset > /etc/sysconfig/nftables.conf

以上で変換が完了します。

この方法で変換した場合、下記のような設定が流し込まれます。
(あくまでも一例です)

# /etc/sysconfig/iptables
*filter
:INPUT DROP [0:0]
:FORWARD DROP [0:0]
:OUTPUT ACCEPT [0:0]
-A INPUT -i lo -j ACCEPT
-A INPUT -p tcp -m state --state RELATED,ESTABLISHED -j ACCEPT
-A INPUT -p tcp -m tcp --dport 80 -j ACCEPT
COMMIT

# nft list ruleset
table ip filter {
        chain INPUT {
                type filter hook input priority 0; policy drop;
                iifname "lo" counter packets 0 bytes 0 accept
                meta l4proto tcp ct state related,established counter packets 0 bytes 0 accept
                meta l4proto tcp tcp dport 80 counter packets 0 bytes 0 accept
        }

        chain FORWARD {
                type filter hook forward priority 0; policy drop;
        }

        chain OUTPUT {
                type filter hook output priority 0; policy accept;
        }
}

冒頭で書きましたように
iptables-restore-translate を使った場合のほうが綺麗なコードが生成されるようですので
基本的にはこのコマンドを使用して変換した方が良さそうです。

ただ、エラーが出る場合もありますので、
お互いの変換結果を見ながら、手で書き直すぐらいが一番良いのかも知れません(苦笑)


iptables のコマンドを nftables のコマンドに変換する

iptables コマンドの代わりに iptables-translate コマンドを用いる事で
変換結果を得られます。

# iptables-translate -A INPUT -p tcp --dport 80 -j ACCEPT
nft add rule ip filter INPUT tcp dport 80 counter accept

それではよい nftables ライフを!

Fiddler の Inspector プラグインを作ろう

どうもみむらです。

お仕事の関係上、アプリケーションの通信を見ることがありまして。
一般には “Burp” を使うことが多いのですが、
やっぱりサクッと見たいときには Fiddler 先生を使いたくなることがあります。[要出典]

Burp のプラグインを作る話はよくあるのですが Fiddler の話はあまりないのと、
作ってみたらサクッと出来たので記事に纏めてみようかと。


1.プロジェクトを作る

下記のようにまず、 “.NET Framework” の クラスライブラリを作成します。

Fiddler は .NET Framework の 4.6.1 を使用していますので、
バージョンは 4系を選択します。 (4.6.1 か それ以降を選択しておけば OK です)


2.Fiddler を参照に加える

Fiddler.exe を参照に加えます。

通常下記のパスに Fiddler がありますので、こちらを追加します。
%LOCALAPPDATA%\Programs\Fiddler\Fiddler.exe

また、Fiddler の Inspector プラグインはUI に Windows Forms を使用しますので System.Windows.Forms も忘れずに参照に加えます。


3.デバッグの設定をする

プラグインの開発時に F5 でデバッグ出来た方が良いですよね。

プロジェクトの設定の「デバッグ」から
Fiddler.exe (%LOCALAPPDATA%\Programs\Fiddler\Fiddler.exe) を
デバッグプログラムとして指定します。

同様に「ビルド」から、出力先のパスを
お使いのユーザのドキュメントフォルダの “Fiddler2\Inspectors” に出力するようにします。
(%USERPROFILE%\Documents\Fiddler2\Inspectors を展開したパスに保存すれば OK です)


4.Request 側と Response 側のビューのひな形を作る

それでは本題となるビューを作ってみましょう

ビューを作る際は下記のように、レスポンス用とリクエスト用を2つ定義する必要があります。

リクエスト用のビュー

基本的に Inspector2, IRequestInspector2 を継承して作ります。
上記の画像に当該するコードは下記の通りです

using Fiddler;
using System.Windows.Forms;

public class RequestView : Inspector2, IRequestInspector2
{
    /// <summary>
    /// Inspector ビューへの項目の追加やウィンドウの初期化等を行う
    /// </summary>
    /// <param name="o"></param>
    public override void AddToTab(TabPage o)
    {
        o.Text = "さんぷる!";
        o.Controls.Add(new TextBox() {Text = "リクエストヘッダ用!", Dock = DockStyle.Fill, Multiline = true, ReadOnly = true});
    }

    /// <summary>
    /// 項目が必要なくなった場合のクリーンアップ処理を書く (IDisposable の Dispose みたいな)
    /// </summary>
    public void Clear()
    {

    }

    /// <summary>
    /// POST リクエストとして送信されたメッセージ本文
    /// </summary>
    public byte[] body { get; set; }

    /// <summary>
    /// テキストが編集されたかどうかを返す
    /// </summary>
    public bool bDirty { get; }

    /// <summary>
    /// 読み取り専用項目かを取得・設定する
    /// </summary>
    public bool bReadOnly { get; set; }

    /// <summary>
    /// HTTP のリクエストヘッダ
    /// </summary>
    public HTTPRequestHeaders headers { get; set; }

    /// <summary>
    /// Inspector ビュー内の項目の順番(昇順でソートされるため、値が大きければ項目の最後に追加される)
    /// </summary>
    /// <returns>表示順番</returns>
    public override int GetOrder() => 1000;
}

レスポンス用のビュー

レスポンス用の場合は Inspector2, IResponseInspector2 を継承して作ります。
上記の画像に当該するコードは下記の通りです

using Fiddler;
using System.Windows.Forms;

public class ResponseView : Inspector2, IResponseInspector2
{
    /// <summary>
    /// Inspector ビューへの項目の追加やウィンドウの初期化等を行う
    /// </summary>
    /// <param name="o"></param>
    public override void AddToTab(TabPage o)
    {
        o.Text = "さんぷる!";
        o.Controls.Add(new TextBox()
            {Text = "レスポンスヘッダのびゅー!", Dock = DockStyle.Fill, Multiline = true, ReadOnly = true});
    }

    /// <summary>
    /// 項目が必要なくなった場合のクリーンアップ処理を書く (IDisposable の Dispose みたいな)
    /// </summary>
    public void Clear()
    {

    }

    /// <summary>
    /// 受信されたメッセージ本文
    /// </summary>
    public byte[] body { get; set; }

    /// <summary>
    /// テキストが編集されたかどうかを返す
    /// </summary>
    public bool bDirty { get; }

    /// <summary>
    /// 読み取り専用項目かを取得・設定する
    /// </summary>
    public bool bReadOnly { get; set; }

    /// <summary>
    /// HTTP のレスポンスヘッダ
    /// </summary>
    public HTTPResponseHeaders headers { get; set; }

    /// <summary>
    /// Inspector ビュー内の項目の順番(昇順でソートされるため、値が大きければ項目の最後に追加される)
    /// </summary>
    /// <returns>表示順番</returns>
    public override int GetOrder() => 1000;
}

5.Fiddler の RequiredVersion を宣言する

上記の2クラスだけではダメで、必要な Fiddler のバージョンを宣言する必要があります。

どこか1つのソースコードで問題ありませんので、
下記のようにバージョンを宣言するだけのソースコードを作成しましょう。

[assembly: Fiddler.RequiredVersion("2.3.0.0")]

6.実行してみよう

上手くいけば下記のように、「さんぷる!」という名前の項目が追加されて
作成したプラグインが読み込まれるはずです。

画像を編集

7.目的に合わせて拡張しよう

今回の例は Inspector プラグインとして任意のビューを表示するところまでを紹介しました。
ただこれだけではBody の処理や その他のパラメータの処理がかなりおざなりになっています。

そこで下記のような、Request / Response Body のテキストを編集できるサンプルを
下記の GitHub に公開しました。
https://github.com/mimura1133/sample_fiddlerInspector

コードも極力短く、また各パラメータに関しても極力コメントを入れてありますので、
これを踏み台にして独自の Inspector プラグインを作成頂けたら幸いです。


それでは、楽しい Fiddler ライフを!