@jsakamoto

Win32 ネイティブアプリを ClickOnce で配布する方法

ClickOnce とは、文字どおり、Windows OS 上において、IE 又は Edge 上で開いたリンクから、アプリのダウンロード～インストール～実行までを1回のクリックで賄う技術・実行基盤だ。
※現実にはセキュリティ警告などに応答する必要があるケースが多々あり、1回のクリックでは済まず、数回のクリックが必要になることがままある...。

なお、ClickOnce にて配布できるプログラムは、.NET Framework 上で動くマネージドなアプリのみとされている。

しかしところで、先日のブログ記事で紹介した「Switch to Demo for Presentation」というアプリは、Win32 API 直接呼び出しの C/C++ で書かれた Win32 ネイティブアプリなのだが、これが ClickOnce でも配布している。

ClickOnce Get
http://j.mp/clickonceget

ClickOnce では .NET マネージドアプリしか配布できないといっているのに、Win32 ネイティブな「Switch to Demo for Presentation」が ClickOnce 配布できているのは一体どういう仕掛けか。

種明かしはあっけなく...

タネはどうということはない。

単純に、.NET な "ブートストラップ" としてのアプリに、Win32 ネイティブアプリの実行ファイルを "添付" しているだけだ。

テクニックもハックも何もない。

.NET アプリは、ClickOnce 配布で同梱されている、この本命の Win32 ネイティブアプリを起動するだけなのである。
Win32 ネイティブアプリ「Foo.exe」を ClickOnce 配布するための、追加の .NET アプリのコードはこんな感じ。

static void Main()

{

  var baseDir = AppDomain.CurrentDomain.BaseDirectory;

  var exePath = Path.Combine(baseDir, "foo.exe");

  Process.Start(exePath);

}

そして、この .NET アプリのプロジェクトに、"リンクとして追加" で本命の "Foo.exe" をプロジェクトアイテムに追加し、ビルドアクションを「コンテンツ」にしておく。ビルドアクションを「コンテンツ」とすることで、この .NET アプリを ClickOnce として発行した際に、"Foo.exe" も発行パッケージに収録され、ClickOnce 配布時に同梱されるのだ。

以上で、Win32 ネイティブアプリも、.NET アプリへの添付という技法によって、ClickOnce で配布/実行されるように仕立てることができる。

...こんな話題が何の参考になるか怪しいものだが、念のため、Visual Studio プロジェクト一式を GitHub にサンプルコードとして公開してある。

Sample Code - How to deploy Win32 native application as "ClickOnce"
https://github.com/sample-by-jsakamoto/HowToDeployWin32NativeAppAsClickOnce

Switch to Demo for Presentation は、ちょっと違う実装

なお、「Switch to Demo for Presentation」実装当時はこの仕掛けがよくわかっていなかったため、.NET なブートストラップアプリに「Switch to Demo for Presentation」Win32 ネイティブアプリ本体を、"リソースとして埋め込み" し、ブートストラップ起動時に埋め込みリソースから「Switch to Demo for Presentation」.exe ファイルのバイナリを読みだして、ファイルに吐き出して実行していた。

「Switch to Demo for Presentation」のソースコード一式も GitHub 上で公開してある。

Switch to Demo for Presentation
https://github.com/jsakamoto/Switch-to-Demo-for-Presentation

いずれにせよ、.NET なブートストラップアプリに Win32 ネイティブアプリの実行ファイルを "添付" しているという仕組みには変わりない。

色々ツッコミありそうですが...

なお、そこまでして ClickOnce 配布するなら、はじめから .NET アプリとして作ればいいのでは...というツッコミは至極ごもっともである。

ただ、以前の投稿で書いたとおり、これは 20年以上前の実装で今でも動くアプリが書ける Win32 API の息の長さをネタにした技術デモを兼ねてもいるという特殊事情があるのでご承知の程。
　

ILSpy を ClickOnce 化してみた

Windows OS における、.NET 関連のとある開発者向けツールの話題。

ILSpy とは?

ILSpy とは、.NET におけるビルド済みアセンブリなどを "逆コンパイル" して、C# などの言語のソースコードとして見せてくれるツール。

ILSPy
http://ilspy.net/

同類のツールとしては、Telerik の JustDecompile とか、redgate の .NET Reflector とかが思いつく。

JustDecompile
http://www.telerik.com/products/decompiler.aspx

.NET Reflector
http://www.red-gate.com/products/dotnet-development/reflector/

そんなに頻繁に出番があるツールではないのだけれども、最近だと、F# コンパイラが吐きだしたアセンブリが C# などからはどう見えるか、とかいう場面で使ったりした。

.NET Reflector は有償化したいっぽうで、自分の用途では有償版に価格に見合う価値を見いだせず、無償で使わせてもらえる ILSpy と JustDecompile の二択、というのが自分の印象だ。

(ちなみに自分は ILSpy と JustDecompile の両方をインストールして両者を適宜利用している)

だけどインストールが面倒くさい...

そんな "逆コンパイラ" である ILSpy と JustDecompile であるが、インストールが少しばかり面倒くさい。

ILSpyの場合

「ILSpyなんて、GitHub のページからZip済みバイナリをダウンロードして解凍するだけなのに、いったい何が難しいの!?」といわれるかもしれない。
しかし問題はそこじゃないのだ。

ILSpy を "インストール" したならば、Winキーを押してスタートメニューを表示させ、そこで「I」「L」くらいまで打鍵したら検索結果候補に ILSpy が浮上してきてそのまま Enter 打鍵で起動させたいじゃないですか。

しかし「Zip ファイルをダウンロードして解凍」であれば、さらにそこからスタートメニューへの登録が必要となる。

もっと細かいことを言えば、Zipファイルをダウンロードするところまではいいんだが、それを「どこに解凍するか」で迷いが生じてしまう。

他の人に ILSpy を使ってもらいたい必要が出てきてインストールしてもらうときがもっともだ。
「これ、どこに解凍したらいいんですかね?」
毎回、この質問に答えるのは、なかなかどうして、面倒なものだ。

最近なら、Windows 向けパッケージマネージャである Chocolatey を利用することで、「cinst ilpsy」でインストールできてしまうようだが、それとて、まずは Chocolatey クライアントのインストールから始めねばならない。
やっぱり面倒。
(自分は Chocolatey クライアント、インストールして便利に使わせていただいてますが)

JustDecompileなら...

JustDecompileならインストーラが付いているのでこんな面倒はない。

だがしかし、無償で使わせてくれる代わりにユーザー登録が必要だったりする。

もちろん、これほどのツールを無償で使わせてくれるのだから、ユーザー登録したり使用状況をレポートしたりなど協力を惜しむ必要はない。

ただ、他の人に使ってもらうときに、
「え、ユーザー登録必要なんですか?」
と怯まれてしまうことがある。
事情を承知してもらうのが、なかなかどうして、面倒なものだ。

さらにアップデートが...

ILSpy と JustDecompile は両者とも、起動時などに新しいバージョンがリリースされてないかチェックしてくれる機能がある。

だがしかし、所詮 ILSpy は最新版がリリースされていることを検出したところで、その最新版の Zip ファイルをダウンロードするだけなのだ。
(そもそも前回のUpdateが2年前とかいう話もあるがそれは別の話題)

JustDecompile は Update の頻度がもう少し高いが、こちらも最新版のインストーラをダウンロードしてくるだけにとどまっている。
まぁ、ダウンロードされたインストーラを起動すればいいだけなので手間のうちではないかもしれないが。

なので ClickOnce にしてみた

ということで、いい加減、フラストレーションも溜まってきたので、ILSpy を ClickOnce 化することにした。

ILSpy は MIT License　にて、GitHub にてソース公開されている。

https://github.com/icsharpcode/ILSpy

これを GitHub 上で fork、自分の手元の開発環境へ clone し、Visual Studio で若干のプロジェクト構成を行ってから ( ソースコードの変更は一切必要ない )、「発行」を実施すればOK。

https://github.com/jsakamoto/ILSpy/commits/pack-for-clickonceget

先日立ち上げたサイト "ClickConce Get" に登録しておいた。

ClickOnce Get
http://clickonceget.azurewebsites.net/

これで今後は、下記 URL を Internet Explorer で開くことで、
クリック一発でダウンロードからインストール、スタートメニューへの登録まで
すべて行ってくれる。

http://clickonceget.azurewebsites.net/app/ILSpy

(IE以外の任意のブラウザでもかまわないが、それだと、いったん .application ファイルのダウンロードになって、そのダウンロードし終えた .application ファイルを開く、という手順が必要。)

さらに、これは ClickOnce 技術による配布技法なので、今後もし新バージョンがリリースされたなら、次回 ILSpy 起動時に自動で更新の検出とユーザーへの確認、さらに、そのままインプレースでの更新が行われる。
(細かいことを言えば、上記配布サイトにUpしたパッケージは、7日に1回の頻度での更新チェックとするよう構成してあるので、"次回起動時" は正確ではない)

ちょっと言い過ぎました

...とまぁ、いいことずくしのような ClickOnce 化。

しかし大変残念ながら、実は大きな難点もある。

今日時点では開発用のテンポラリな電子証明書で署名してあるだけなので、
一見、インストールできないかのようなメッセージが表示される
のだ。セキュリティ上の措置なのでもっともなことである。

このメッセージの詳細をクリックするとようやく、危険を承知でこんな野良署名されたアプリをインストールするかどうかの確認メッセージボックスが表示されて、ここで OK を押すことでインストールが実行される。
ちゃんとした電証明書を入手して電子署名しておくのがいいのだとは思う。
だけど、そのような電子証明書の入手費用もばかにならないはず。
(といいつつ、実はコード署名のためのそれなりの証明書入手費用は知らなかったりする(!))
たかだか今回のようなシナリオのためだけに、そのような費用を支払うのも気が進まない。

なので本件の対応は当面見送りだ。

そして ClickOnce Get に潜む闇と罠...

そもそも、ClickOnce Get サイト自体、
どうやってマルウェアが潜んでいないことを保証するのか
これといった手だてがない。

アプリを配布する人はちゃんとした電子証明書で電子署名したものを Upload する & 利用する人はしかるべき署名されたものしかインストールしない、というくらいしか今は思いつかない。
そしてそんなことを書いている矢先に、サイト開設した本人からして、テンポラリ署名で済ましたものを Up している始末だ。

大体、今回は自分で ILSpy を ClickOnce 化して自分で ClickOnce Get に up したから自分では安全だとわかっている。

だがしかし、
誰かが ILSpy というパッケージ名でマルウェアを ClickOnce Get に up してたらどうだろう?
これは結構怖い話だ。

結局のところ、ClickOnce Get は自分のために開設したサイトであって、自分が用意した ClickOnce パッケージを配置できれば十分、と思っていたため、あんまり深く考えていなかったのだけれども、なかなかどうして、これは深い問題・課題だ。
　

まとめ

とうことで、最後は救いの見えない暗い話(!?)になってしまったが、それでも「まぁ、彼が自分で用意したパッケージだっていうなら、それを信じて、ClickOnce Get の ILSpy、使ってみるか。面倒ないし。」ということで、自分だけでなくどなたかの役に立てば幸いである。

おまけ

なお、ClickOnce Get は GPLV2 License で GitHub でソース公開済みであり、且つ、自分でオレオレ ClickOnce Get サイトを構築するのは自由である。

Microsoft Azure Websites の、PaaS でありながらファイルシステムは永続化される特徴を活かし、データベースを使わずファイルシステムだけで動作するので、git clone して自前の Azure Websites に git push すれば動き出す（GitHub 認証のためのキー設定は必要）。

認証部分を改造して、自分だけがコンテンツ設置できるオレオレ ClickOnce Get サイトを立てて、自分が信頼置けるパッケージのみを自分で配置して、限定されたメンバの間でのみ活用するとかありかもしれない。
　

ClickOnce アプリケーションを登録、配布する Web サイトを作ってみた

ClickOnce とは?

ClickOnce とは、Windows OS における .NET Framework 製のデスクトップ GUI アプリケーション (いわゆる ".exe") を、インターネット上で公開・配布する技術。

ブラウザで開いた Web ページ上のリンククリック一発で、ダウンロードからインストール、スタートメニューへの登録と実行までを行ってしまう、.NET Framework の機能だ。

Zip アーカイブでの配布と異なり、

• ダウンロードしたZipアーカイブをどこかにいったん保存したり、
• それをどこかに解凍したり、
• そうしてようやくインストーラを起動したり、
• そしてインストールが終わったら、それら解凍したファイルや元々の Zip アーカイブなどのゴミを削除したり、

といった手間がない。

また、いちどインストールされたら終わりというのではなく、もし配布元でアプリのバージョンアップが行われていたら、次回起動時に自動で新バージョンにアップグレードしたりできる優れものなのだ。

使われてるの?

Windows OS から Google Chrome ブラウザをインストールしたことのある人は、下記のダイアログを見たことがあると思う。
実はこれ、Google Chrome ブラウザのインストーラのダウンロードから実行までを、ClickOnce テクノロジによって、クリック1回で実行できるように実装されていたものなのだ。

他にもプログラマ向けのツールとして NuGet Package Explorer が ClickOnce テクノロジで配布されていたりもする。

どうやって Web サイト上に設置する?

アプリを ClickOnce テクノロジで Web サイト上から配置するには、所定の仕様・形態で ClickOnce 用に "パッケージ" したファイル群を、普通に静的ファイルとして HTTP 経由でダウンロードできるようにしておけばよい。

ClickOnce の仕組みにおいて、Web　サーバー側にはなんのマジックもない。
Windows OS の IIS でなくとも、Linux 上の Apache だろうと nginx だろうと何だろうと、とにかく HTTP でファイルを GET できるようになっていればよい。

だがしかし、ここで一つ落とし穴がある。

ClickOnce 用にパッケージすると、ブートストラップファイルとして拡張子が .application のファイルが用意される。
これを Web 上に公開する際、この拡張子 .application のダウンロード時の content-type 応答ヘッダが、"application/x-ms-application" でないとならないのだ。

この仕様(制約?)のおかげで、GitHub や DropBox などから ClickOnce アプリケーションを配布することができない。
(これらの Web サイト経由で .application　を取得すると、content-type が application/octet-stream になってしまう)

ファイル拡張子に応じた content-type を自分で設定できる Web サーバー、Web サイトを持つ必要がある。
ちょっとばかり面倒な話だ。

CodePlex を使えば配布できるけど...

GitHub や Bitbucket のような、オープンソースのリポジトリサービスの一種である CodePlex では、実は、ClickOnce アプリケーションを配布することができる。
参考: https://codeplex.codeplex.com/wikipage?title=ClickOnce

先述の NuGet Package Explorer も CodePlex から配布されている。

しかし ClickOnce アプリケーションの配布のためだけに CodePlex を使わせてもらうのも後ろめたい。

今更だがサイト作ってみた。利用は無料。

ということで、とても今更感があるのだが、ClickOnce アプリケーションを自由にアップロード・配布するための Web サイト、"ClickOnce Get" を作ってみた。

ClickOnce Get
http://clickonceget.azurewebsites.net/

ご自身で作成された ClickOnce アプリケーションをアップロード・配布する場合でも、利用は無償。

なぜなら、このサイトをホストしているのは、C# や Node.js、PHP の PaaS (自分は詳しくないが Python と Java も動くらしい) である Microsoft Azure Websites の無料プランだから。

ただし無料プランの制約として、ある一定の CPU 使用量・通信量を超えると、一定時間、サイトが停止させられる可能性はあるので注意されたし。
(とはいえ、この ClickOnce Get のようなマイナー感満載のサイトであれば、この制約にひっかかることはあまり考えられない)

C# + ASP.NET 製、ほんの少し AnugularJS 添え。ソース公開してます。

実装は C# + ASP.NET MVC & ASP.NET WebAPI。
クライアント側の JavaScript フレームワークとしてちょっぴり AngularJS を使い、TypeScript でクライアント側動作を記述した。

ソースは GitHub で公開してある。

https://github.com/jsakamoto/clickonce-get

Azure Websites は Web サーバー上のファイルも永続化されるという（ただし無料プランでは Web サイトのコンテンツや Azure の管理領域なども含めて諸々 1GB まで）、PaaS のくせにうれしい仕様（インスタンスが再起動しても Web アプリがサーバー上に保存したファイルは失われない!）なので、これを活かし、データベースは使用していない。

データベース未使用なので、Visual Studio など C# + ASP.NET の開発環境をお持ちなら、git clone したら即座にビルド、実行、配置することができる。

同じ Azure Websites にオレオレ ClickOnce Get サイトを立てたいだけなら、手元の開発環境でビルドする必要すらない。
git clone したら、立て続けに、自分のアカウントで用意した Azure Websites のサイトに git push することで、Azure Websotes 上でビルドしてくれる。

このシナリオだけ考えるなら、git すら不要だ。
ブラウザにて GitHub 上で fork し、その fork したリポジトリを、同じくブラウザから Azure Websites の管理画面にてフックすればよい。

まとめ

Windows OS 用のデスクトップアプリといっても、今は Windows ストアアプリの時代に、今さら ClickOnce なんてどうよ、という気がしないでもない。

また、ダウンロードからインストールまでの手間を不要とするなら、コンソールアプリや非.NETアプリも CUI 経由でインストールできる Chocolatey や OneGet の時代なのかもしれない。

正直、5年前にこのようなサイトを作るべきだったとも思う。

とはいえ、ClickOnce はいまだにサポート継続されている技術でもある。

自分のとある用途（詳しくは後日）のために作ったサイトではあるが、自分以外にもどなたかに使いでがあれば幸いである。

追伸

言い忘れていたが、この ClickOnce Get の実装、OWIN ベースでの GitHub アカウントによる認証を行う最小のサンプルにもなっている。

アカウント情報をサイト上に永続化しない実装でもあるので、ご参考まで。